-
Performance tips
-
- - Updating a customer session returns a response with the new integration state. Use the `responseContent` property to save yourself extra API calls.
- For example, you can get the customer profile details directly without extra requests.
- - We recommend sending requests sequentially. See [Managing parallel requests](https://docs.talon.one/docs/dev/getting-started/integration-tutorial#managing-parallel-requests).
-
\n
Performance tips
\n\
+ \n - Updating a customer session returns a response with the new integration\
+ \ state. Use the `responseContent` property to save yourself extra API calls.\n\
+ \ For example, you can get the customer profile details directly without\
+ \ extra requests.\n - We recommend sending requests sequentially. See [Managing\
+ \ parallel requests](https://docs.talon.one/docs/dev/getting-started/integration-tutorial#managing-parallel-requests).\n\
+
Performance tips
@@ -687,7 +682,6 @@ paths:
name: audienceId
required: true
schema:
- format: int64
type: integer
responses:
"204":
@@ -729,7 +723,6 @@ paths:
name: audienceId
required: true
schema:
- format: int64
type: integer
requestBody:
content:
@@ -776,7 +769,6 @@ paths:
name: audienceId
required: true
schema:
- format: int64
type: integer
responses:
"204":
@@ -857,7 +849,6 @@ paths:
name: audienceId
required: true
schema:
- format: int64
type: integer
requestBody:
content:
@@ -910,7 +901,6 @@ paths:
name: loyaltyProgramId
required: true
schema:
- format: int64
type: integer
- description: |
Identifier of the loyalty card. You can get the identifier with
@@ -981,9 +971,10 @@ paths:
Important
- 1. `profileId` is required even though the schema does not say it.
+ 1. `profileId` is required even though the schema does not specify it.
1. If the customer profile ID is new, a new profile is automatically created but the `customer_profile_created` [built-in event ](https://docs.talon.one/docs/dev/concepts/entities/events) is **not** triggered.
1. We recommend sending requests sequentially. See [Managing parallel requests](https://docs.talon.one/docs/dev/getting-started/integration-tutorial#managing-parallel-requests).
+ 1. [Archived campaigns](https://docs.talon.one/docs/product/campaigns/managing-campaigns#archiving-a-campaign) are not considered in rule evaluation.
operationId: trackEventV2
@@ -1501,7 +1492,6 @@ paths:
name: pageSize
schema:
default: 1000
- format: int64
maximum: 1000
minimum: 1
type: integer
@@ -1510,7 +1500,6 @@ paths:
in: query
name: skip
schema:
- format: int64
type: integer
responses:
"200":
@@ -1566,7 +1555,6 @@ paths:
name: achievementId
required: true
schema:
- format: int64
type: integer
- description: |
Filter by customer progress status in the achievement.
@@ -1601,7 +1589,6 @@ paths:
name: pageSize
schema:
default: 1000
- format: int64
maximum: 1000
minimum: 1
type: integer
@@ -1610,7 +1597,6 @@ paths:
in: query
name: skip
schema:
- format: int64
type: integer
responses:
"200":
@@ -1657,7 +1643,6 @@ paths:
name: loyaltyProgramId
required: true
schema:
- format: int64
type: integer
- description: |
Identifier of the loyalty card. You can get the identifier with
@@ -1742,7 +1727,6 @@ paths:
name: loyaltyProgramId
required: true
schema:
- format: int64
type: integer
- description: |
The integration identifier for this customer profile. Must be:
@@ -1837,7 +1821,6 @@ paths:
name: loyaltyProgramId
required: true
schema:
- format: int64
type: integer
- description: |
Identifier of the loyalty card. You can get the identifier with
@@ -1899,7 +1882,6 @@ paths:
name: pageSize
schema:
default: 50
- format: int64
maximum: 1000
minimum: 1
type: integer
@@ -1908,7 +1890,6 @@ paths:
in: query
name: skip
schema:
- format: int64
type: integer
responses:
"200":
@@ -1959,7 +1940,6 @@ paths:
name: loyaltyProgramId
required: true
schema:
- format: int64
type: integer
- description: |
The integration identifier for this customer profile. Must be:
@@ -2019,7 +1999,6 @@ paths:
name: pageSize
schema:
default: 50
- format: int64
maximum: 1000
minimum: 1
type: integer
@@ -2028,7 +2007,6 @@ paths:
in: query
name: skip
schema:
- format: int64
type: integer
responses:
"200":
@@ -2079,7 +2057,6 @@ paths:
name: loyaltyProgramId
required: true
schema:
- format: int64
type: integer
- description: |
Identifier of the loyalty card. You can get the identifier with
@@ -2114,7 +2091,6 @@ paths:
name: pageSize
schema:
default: 50
- format: int64
maximum: 1000
minimum: 1
type: integer
@@ -2123,7 +2099,6 @@ paths:
in: query
name: skip
schema:
- format: int64
type: integer
responses:
"200":
@@ -2174,7 +2149,6 @@ paths:
name: loyaltyProgramId
required: true
schema:
- format: int64
type: integer
- description: |
The integration identifier for this customer profile. Must be:
@@ -2207,7 +2181,6 @@ paths:
name: pageSize
schema:
default: 50
- format: int64
maximum: 1000
minimum: 1
type: integer
@@ -2216,7 +2189,6 @@ paths:
in: query
name: skip
schema:
- format: int64
type: integer
responses:
"200":
@@ -2259,7 +2231,6 @@ paths:
name: pageSize
schema:
default: 1000
- format: int64
maximum: 1000
minimum: 1
type: integer
@@ -2268,7 +2239,6 @@ paths:
in: query
name: skip
schema:
- format: int64
type: integer
- description: |
The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`.
@@ -2300,7 +2270,6 @@ paths:
name: applicationId
required: true
schema:
- format: int64
type: integer
responses:
"200":
@@ -2324,7 +2293,6 @@ paths:
name: pageSize
schema:
default: 1000
- format: int64
maximum: 1000
minimum: 1
type: integer
@@ -2333,7 +2301,6 @@ paths:
in: query
name: skip
schema:
- format: int64
type: integer
- description: |
The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`.
@@ -2349,7 +2316,6 @@ paths:
name: applicationId
required: true
schema:
- format: int64
type: integer
- description: |
Filter results by the state of the campaign.
@@ -2404,19 +2370,16 @@ paths:
in: query
name: campaignGroupId
schema:
- format: int64
type: integer
- description: The ID of the campaign template this campaign was created from.
in: query
name: templateId
schema:
- format: int64
type: integer
- description: Filter results to campaigns linked to the specified store ID.
in: query
name: storeId
schema:
- format: int64
type: integer
responses:
"200":
@@ -2446,7 +2409,6 @@ paths:
name: applicationId
required: true
schema:
- format: int64
type: integer
- description: The ID of the campaign. It is displayed in your Talon.One deployment
URL.
@@ -2454,7 +2416,6 @@ paths:
name: campaignId
required: true
schema:
- format: int64
type: integer
responses:
"204":
@@ -2474,7 +2435,6 @@ paths:
name: applicationId
required: true
schema:
- format: int64
type: integer
- description: The ID of the campaign. It is displayed in your Talon.One deployment
URL.
@@ -2482,7 +2442,6 @@ paths:
name: campaignId
required: true
schema:
- format: int64
type: integer
responses:
"200":
@@ -2508,7 +2467,6 @@ paths:
name: applicationId
required: true
schema:
- format: int64
type: integer
- description: The ID of the campaign. It is displayed in your Talon.One deployment
URL.
@@ -2516,7 +2474,6 @@ paths:
name: campaignId
required: true
schema:
- format: int64
type: integer
requestBody:
content:
@@ -2549,7 +2506,6 @@ paths:
name: applicationId
required: true
schema:
- format: int64
type: integer
- description: The ID of the campaign. It is displayed in your Talon.One deployment
URL.
@@ -2557,7 +2513,6 @@ paths:
name: campaignId
required: true
schema:
- format: int64
type: integer
requestBody:
content:
@@ -2590,7 +2545,6 @@ paths:
name: pageSize
schema:
default: 1000
- format: int64
maximum: 1000
minimum: 1
type: integer
@@ -2599,7 +2553,6 @@ paths:
in: query
name: skip
schema:
- format: int64
type: integer
- description: |
The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`.
@@ -2615,7 +2568,6 @@ paths:
name: applicationId
required: true
schema:
- format: int64
type: integer
- description: |
Filter results by the state of the campaign.
@@ -2670,7 +2622,6 @@ paths:
name: pageSize
schema:
default: 1000
- format: int64
maximum: 1000
minimum: 1
type: integer
@@ -2679,7 +2630,6 @@ paths:
in: query
name: skip
schema:
- format: int64
type: integer
- description: |
The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`.
@@ -2695,7 +2645,6 @@ paths:
name: applicationId
required: true
schema:
- format: int64
type: integer
- description: The ID of the campaign. It is displayed in your Talon.One deployment
URL.
@@ -2703,7 +2652,6 @@ paths:
name: campaignId
required: true
schema:
- format: int64
type: integer
responses:
"200":
@@ -2727,7 +2675,6 @@ paths:
name: applicationId
required: true
schema:
- format: int64
type: integer
- description: The ID of the campaign. It is displayed in your Talon.One deployment
URL.
@@ -2735,14 +2682,12 @@ paths:
name: campaignId
required: true
schema:
- format: int64
type: integer
- description: The ID of the ruleset.
in: path
name: rulesetId
required: true
schema:
- format: int64
type: integer
responses:
"200":
@@ -2766,7 +2711,6 @@ paths:
name: applicationId
required: true
schema:
- format: int64
type: integer
- description: The ID of the campaign. It is displayed in your Talon.One deployment
URL.
@@ -2774,7 +2718,6 @@ paths:
name: campaignId
required: true
schema:
- format: int64
type: integer
- description: Filter results performing case-insensitive matching against the
coupon code. Both the code and the query are folded to remove all non-alpha-numeric
@@ -2863,7 +2806,6 @@ paths:
in: query
name: referralId
schema:
- format: int64
type: integer
- description: |
Filter results by match with a profile ID specified in the coupon's `RecipientIntegrationId` field.
@@ -2907,7 +2849,6 @@ paths:
name: applicationId
required: true
schema:
- format: int64
type: integer
- description: The ID of the campaign. It is displayed in your Talon.One deployment
URL.
@@ -2915,7 +2856,6 @@ paths:
name: campaignId
required: true
schema:
- format: int64
type: integer
requestBody:
content:
@@ -2966,7 +2906,6 @@ paths:
name: applicationId
required: true
schema:
- format: int64
type: integer
- description: The ID of the campaign. It is displayed in your Talon.One deployment
URL.
@@ -2974,7 +2913,6 @@ paths:
name: campaignId
required: true
schema:
- format: int64
type: integer
requestBody:
content:
@@ -3013,7 +2951,6 @@ paths:
name: applicationId
required: true
schema:
- format: int64
type: integer
- description: The ID of the campaign. It is displayed in your Talon.One deployment
URL.
@@ -3021,7 +2958,6 @@ paths:
name: campaignId
required: true
schema:
- format: int64
type: integer
requestBody:
content:
@@ -3060,7 +2996,6 @@ paths:
name: applicationId
required: true
schema:
- format: int64
type: integer
- description: The ID of the campaign. It is displayed in your Talon.One deployment
URL.
@@ -3068,7 +3003,6 @@ paths:
name: campaignId
required: true
schema:
- format: int64
type: integer
requestBody:
content:
@@ -3102,7 +3036,6 @@ paths:
name: applicationId
required: true
schema:
- format: int64
type: integer
- description: The ID of the campaign. It is displayed in your Talon.One deployment
URL.
@@ -3110,7 +3043,6 @@ paths:
name: campaignId
required: true
schema:
- format: int64
type: integer
requestBody:
content:
@@ -3144,7 +3076,6 @@ paths:
name: pageSize
schema:
default: 1000
- format: int64
maximum: 1000
minimum: 1
type: integer
@@ -3153,7 +3084,6 @@ paths:
in: query
name: skip
schema:
- format: int64
type: integer
- description: |
The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`.
@@ -3169,7 +3099,6 @@ paths:
name: applicationId
required: true
schema:
- format: int64
type: integer
- description: The ID of the campaign. It is displayed in your Talon.One deployment
URL.
@@ -3177,7 +3106,6 @@ paths:
name: campaignId
required: true
schema:
- format: int64
type: integer
- description: Filter results performing case-insensitive matching against the
coupon code. Both the code and the query are folded to remove all non-alpha-numeric
@@ -3237,7 +3165,6 @@ paths:
in: query
name: referralId
schema:
- format: int64
type: integer
- description: Filter results by match with a profile ID specified in the coupon's
RecipientIntegrationId field.
@@ -3318,7 +3245,6 @@ paths:
name: applicationId
required: true
schema:
- format: int64
type: integer
- description: The ID of the campaign. It is displayed in your Talon.One deployment
URL.
@@ -3326,7 +3252,6 @@ paths:
name: campaignId
required: true
schema:
- format: int64
type: integer
- description: |
The internal ID of the coupon code. You can find this value in the `id` property from the
@@ -3362,7 +3287,6 @@ paths:
name: applicationId
required: true
schema:
- format: int64
type: integer
- description: The ID of the campaign. It is displayed in your Talon.One deployment
URL.
@@ -3370,7 +3294,6 @@ paths:
name: campaignId
required: true
schema:
- format: int64
type: integer
- description: |
The internal ID of the coupon code. You can find this value in the `id` property from the
@@ -3417,7 +3340,6 @@ paths:
name: pageSize
schema:
default: 1000
- format: int64
maximum: 1000
minimum: 1
type: integer
@@ -3426,7 +3348,6 @@ paths:
in: query
name: skip
schema:
- format: int64
type: integer
- description: |
The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`.
@@ -3442,7 +3363,6 @@ paths:
name: applicationId
required: true
schema:
- format: int64
type: integer
- description: The ID of the campaign. It is displayed in your Talon.One deployment
URL.
@@ -3450,7 +3370,6 @@ paths:
name: campaignId
required: true
schema:
- format: int64
type: integer
- description: Filter results performing case-insensitive matching against the
coupon code. Both the code and the query are folded to remove all non-alpha-numeric
@@ -3499,7 +3418,6 @@ paths:
in: query
name: referralId
schema:
- format: int64
type: integer
- description: Filter results by match with a profile ID specified in the coupon's
RecipientIntegrationId field.
@@ -3556,7 +3474,6 @@ paths:
name: pageSize
schema:
default: 1000
- format: int64
maximum: 1000
minimum: 1
type: integer
@@ -3565,7 +3482,6 @@ paths:
in: query
name: skip
schema:
- format: int64
type: integer
- description: |
The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`.
@@ -3581,7 +3497,6 @@ paths:
name: applicationId
required: true
schema:
- format: int64
type: integer
- description: Filter results performing case-insensitive matching against the
coupon code. Both the code and the query are folded to remove all non-alpha-numeric
@@ -3630,7 +3545,6 @@ paths:
in: query
name: referralId
schema:
- format: int64
type: integer
- description: Filter results by match with a profile ID specified in the coupon's
RecipientIntegrationId field.
@@ -3701,7 +3615,6 @@ paths:
name: applicationId
required: true
schema:
- format: int64
type: integer
- description: The ID of the campaign. It is displayed in your Talon.One deployment
URL.
@@ -3709,7 +3622,6 @@ paths:
name: campaignId
required: true
schema:
- format: int64
type: integer
- description: The ID of the referral code.
in: path
@@ -3735,7 +3647,6 @@ paths:
name: applicationId
required: true
schema:
- format: int64
type: integer
- description: The ID of the campaign. It is displayed in your Talon.One deployment
URL.
@@ -3743,7 +3654,6 @@ paths:
name: campaignId
required: true
schema:
- format: int64
type: integer
- description: The ID of the referral code.
in: path
@@ -3781,7 +3691,6 @@ paths:
name: pageSize
schema:
default: 1000
- format: int64
maximum: 1000
minimum: 1
type: integer
@@ -3790,7 +3699,6 @@ paths:
in: query
name: skip
schema:
- format: int64
type: integer
- description: |
The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`.
@@ -3806,7 +3714,6 @@ paths:
name: applicationId
required: true
schema:
- format: int64
type: integer
- description: The ID of the campaign. It is displayed in your Talon.One deployment
URL.
@@ -3814,7 +3721,6 @@ paths:
name: campaignId
required: true
schema:
- format: int64
type: integer
- description: Filter results performing case-insensitive matching against the
referral code. Both the code and the query are folded to remove all non-alpha-numeric
@@ -3885,7 +3791,6 @@ paths:
name: pageSize
schema:
default: 1000
- format: int64
maximum: 1000
minimum: 1
type: integer
@@ -3894,7 +3799,6 @@ paths:
in: query
name: skip
schema:
- format: int64
type: integer
- description: |
The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`.
@@ -3925,7 +3829,6 @@ paths:
name: campaignGroupId
required: true
schema:
- format: int64
type: integer
responses:
"200":
@@ -3948,7 +3851,6 @@ paths:
name: pageSize
schema:
default: 1000
- format: int64
maximum: 1000
minimum: 1
type: integer
@@ -3957,7 +3859,6 @@ paths:
in: query
name: skip
schema:
- format: int64
type: integer
- description: |
The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`.
@@ -3992,7 +3893,6 @@ paths:
in: query
name: userId
schema:
- format: int64
type: integer
responses:
"200":
@@ -4021,7 +3921,6 @@ paths:
name: applicationId
required: true
schema:
- format: int64
type: integer
requestBody:
content:
@@ -4075,7 +3974,6 @@ paths:
name: loyaltyProgramId
required: true
schema:
- format: int64
type: integer
responses:
"200":
@@ -4105,7 +4003,6 @@ paths:
name: loyaltyProgramId
required: true
schema:
- format: int64
type: integer
- description: The ID of the subledger by which we filter the data.
in: query
@@ -4202,8 +4099,15 @@ paths:
name: loyaltyProgramId
required: true
schema:
- format: int64
type: integer
+ - description: |
+ Indicates whether the points import triggers notifications about its effects. For example, a notification is sent if the import upgrades a customer's tier or offsets their negative points balance.
+
+ This parameter is optional and defaults to `true`.
+ in: query
+ name: notificationsEnabled
+ schema:
+ type: boolean
requestBody:
content:
multipart/form-data:
@@ -4266,7 +4170,6 @@ paths:
name: loyaltyProgramId
required: true
schema:
- format: int64
type: integer
requestBody:
content:
@@ -4637,7 +4540,6 @@ paths:
name: loyaltyProgramId
required: true
schema:
- format: int64
type: integer
responses:
"200":
@@ -4782,7 +4684,6 @@ paths:
name: loyaltyProgramId
required: true
schema:
- format: int64
type: integer
- description: |
Filter results by loyalty transaction type:
@@ -4831,7 +4732,6 @@ paths:
name: pageSize
schema:
default: 50
- format: int64
maximum: 50
minimum: 1
type: integer
@@ -4840,7 +4740,6 @@ paths:
in: query
name: skip
schema:
- format: int64
type: integer
responses:
"200":
@@ -4900,7 +4799,6 @@ paths:
name: loyaltyProgramId
required: true
schema:
- format: int64
type: integer
requestBody:
content:
@@ -4955,7 +4853,6 @@ paths:
name: loyaltyProgramId
required: true
schema:
- format: int64
type: integer
requestBody:
content:
@@ -5020,7 +4917,6 @@ paths:
name: loyaltyProgramId
required: true
schema:
- format: int64
type: integer
- description: |
Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value.
@@ -5069,7 +4965,6 @@ paths:
name: pageSize
schema:
default: 1000
- format: int64
maximum: 1000
minimum: 1
type: integer
@@ -5078,7 +4973,6 @@ paths:
in: query
name: skip
schema:
- format: int64
type: integer
- description: |
The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`.
@@ -5095,7 +4989,6 @@ paths:
name: loyaltyProgramId
required: true
schema:
- format: int64
type: integer
- description: The card code by which to filter loyalty cards in the response.
in: query
@@ -5107,7 +5000,6 @@ paths:
in: query
name: profileId
schema:
- format: int64
minimum: 1
type: integer
- description: Filter results by loyalty card batch ID.
@@ -5156,7 +5048,6 @@ paths:
name: loyaltyProgramId
required: true
schema:
- format: int64
type: integer
requestBody:
content:
@@ -5217,7 +5108,6 @@ paths:
name: loyaltyProgramId
required: true
schema:
- format: int64
type: integer
- description: Filter results by loyalty card batch ID.
in: query
@@ -5268,7 +5158,6 @@ paths:
name: loyaltyProgramId
required: true
schema:
- format: int64
type: integer
- description: |
Identifier of the loyalty card. You can get the identifier with
@@ -5310,7 +5199,6 @@ paths:
name: loyaltyProgramId
required: true
schema:
- format: int64
type: integer
- description: |
Identifier of the loyalty card. You can get the identifier with
@@ -5362,7 +5250,6 @@ paths:
name: loyaltyProgramId
required: true
schema:
- format: int64
type: integer
- description: |
Identifier of the loyalty card. You can get the identifier with
@@ -5424,7 +5311,6 @@ paths:
name: loyaltyProgramId
required: true
schema:
- format: int64
type: integer
- description: |
Identifier of the loyalty card. You can get the identifier with
@@ -5483,7 +5369,6 @@ paths:
name: loyaltyProgramId
required: true
schema:
- format: int64
type: integer
- description: |
Identifier of the loyalty card. You can get the identifier with
@@ -5544,7 +5429,6 @@ paths:
name: loyaltyProgramId
required: true
schema:
- format: int64
type: integer
- description: |
Identifier of the loyalty card. You can get the identifier with
@@ -5626,7 +5510,6 @@ paths:
name: loyaltyProgramId
required: true
schema:
- format: int64
type: integer
- description: |
Identifier of the loyalty card. You can get the identifier with
@@ -5666,7 +5549,6 @@ paths:
name: pageSize
schema:
default: 1000
- format: int64
maximum: 1000
minimum: 1
type: integer
@@ -5675,7 +5557,6 @@ paths:
in: query
name: skip
schema:
- format: int64
type: integer
- description: The ID of the subledger by which we filter the data.
in: query
@@ -5723,7 +5604,6 @@ paths:
name: loyaltyProgramId
required: true
schema:
- format: int64
type: integer
- description: |
Identifier of the loyalty card. You can get the identifier with
@@ -5807,7 +5687,6 @@ paths:
name: poolId
required: true
schema:
- format: int64
type: integer
requestBody:
content:
@@ -5858,7 +5737,6 @@ paths:
name: poolId
required: true
schema:
- format: int64
type: integer
- description: Timestamp that filters the results to only contain giveaways
created before this date. Must be an RFC3339 timestamp string.
@@ -5902,7 +5780,6 @@ paths:
name: pageSize
schema:
default: 1000
- format: int64
maximum: 1000
minimum: 1
type: integer
@@ -5911,7 +5788,6 @@ paths:
in: query
name: skip
schema:
- format: int64
type: integer
- description: |
The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`.
@@ -6016,7 +5892,6 @@ paths:
name: collectionId
required: true
schema:
- format: int64
type: integer
responses:
"204":
@@ -6042,7 +5917,6 @@ paths:
name: collectionId
required: true
schema:
- format: int64
type: integer
responses:
"200":
@@ -6072,7 +5946,6 @@ paths:
name: collectionId
required: true
schema:
- format: int64
type: integer
requestBody:
content:
@@ -6125,7 +5998,6 @@ paths:
name: pageSize
schema:
default: 1000
- format: int64
maximum: 1000
minimum: 1
type: integer
@@ -6134,7 +6006,6 @@ paths:
in: query
name: skip
schema:
- format: int64
type: integer
- description: The ID of the collection. You can get it with the [List collections
in account](#operation/listAccountCollections) endpoint.
@@ -6142,7 +6013,6 @@ paths:
name: collectionId
required: true
schema:
- format: int64
type: integer
responses:
"200":
@@ -6172,14 +6042,12 @@ paths:
name: applicationId
required: true
schema:
- format: int64
type: integer
- description: The number of items in the response.
in: query
name: pageSize
schema:
default: 1000
- format: int64
maximum: 1000
minimum: 1
type: integer
@@ -6188,7 +6056,6 @@ paths:
in: query
name: skip
schema:
- format: int64
type: integer
- description: |
The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`.
@@ -6240,7 +6107,6 @@ paths:
name: applicationId
required: true
schema:
- format: int64
type: integer
- description: The ID of the campaign. It is displayed in your Talon.One deployment
URL.
@@ -6248,14 +6114,12 @@ paths:
name: campaignId
required: true
schema:
- format: int64
type: integer
- description: The number of items in the response.
in: query
name: pageSize
schema:
default: 1000
- format: int64
maximum: 1000
minimum: 1
type: integer
@@ -6264,7 +6128,6 @@ paths:
in: query
name: skip
schema:
- format: int64
type: integer
- description: |
The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`.
@@ -6315,7 +6178,6 @@ paths:
name: applicationId
required: true
schema:
- format: int64
type: integer
- description: The ID of the campaign. It is displayed in your Talon.One deployment
URL.
@@ -6323,7 +6185,6 @@ paths:
name: campaignId
required: true
schema:
- format: int64
type: integer
requestBody:
content:
@@ -6356,7 +6217,6 @@ paths:
name: applicationId
required: true
schema:
- format: int64
type: integer
- description: The ID of the campaign. It is displayed in your Talon.One deployment
URL.
@@ -6364,7 +6224,6 @@ paths:
name: campaignId
required: true
schema:
- format: int64
type: integer
- description: The ID of the collection. You can get it with the [List collections
in Application](#operation/listCollectionsInApplication) endpoint.
@@ -6372,7 +6231,6 @@ paths:
name: collectionId
required: true
schema:
- format: int64
type: integer
responses:
"204":
@@ -6398,7 +6256,6 @@ paths:
name: applicationId
required: true
schema:
- format: int64
type: integer
- description: The ID of the campaign. It is displayed in your Talon.One deployment
URL.
@@ -6406,7 +6263,6 @@ paths:
name: campaignId
required: true
schema:
- format: int64
type: integer
- description: The ID of the collection. You can get it with the [List collections
in Application](#operation/listCollectionsInApplication) endpoint.
@@ -6414,7 +6270,6 @@ paths:
name: collectionId
required: true
schema:
- format: int64
type: integer
responses:
"200":
@@ -6443,7 +6298,6 @@ paths:
name: applicationId
required: true
schema:
- format: int64
type: integer
- description: The ID of the campaign. It is displayed in your Talon.One deployment
URL.
@@ -6451,7 +6305,6 @@ paths:
name: campaignId
required: true
schema:
- format: int64
type: integer
- description: The ID of the collection. You can get it with the [List collections
in Application](#operation/listCollectionsInApplication) endpoint.
@@ -6459,7 +6312,6 @@ paths:
name: collectionId
required: true
schema:
- format: int64
type: integer
requestBody:
content:
@@ -6519,7 +6371,6 @@ paths:
name: collectionId
required: true
schema:
- format: int64
type: integer
requestBody:
content:
@@ -6586,7 +6437,6 @@ paths:
name: applicationId
required: true
schema:
- format: int64
type: integer
- description: The ID of the campaign. It is displayed in your Talon.One deployment
URL.
@@ -6594,7 +6444,6 @@ paths:
name: campaignId
required: true
schema:
- format: int64
type: integer
- description: The ID of the collection. You can get it with the [List collections
in Application](#operation/listCollectionsInApplication) endpoint.
@@ -6602,7 +6451,6 @@ paths:
name: collectionId
required: true
schema:
- format: int64
type: integer
requestBody:
content:
@@ -6645,7 +6493,6 @@ paths:
name: collectionId
required: true
schema:
- format: int64
type: integer
responses:
"200":
@@ -6685,7 +6532,6 @@ paths:
name: applicationId
required: true
schema:
- format: int64
type: integer
- description: The ID of the campaign. It is displayed in your Talon.One deployment
URL.
@@ -6693,7 +6539,6 @@ paths:
name: campaignId
required: true
schema:
- format: int64
type: integer
- description: The ID of the collection. You can get it with the [List collections
in Application](#operation/listCollectionsInApplication) endpoint.
@@ -6701,7 +6546,6 @@ paths:
name: collectionId
required: true
schema:
- format: int64
type: integer
responses:
"200":
@@ -6743,7 +6587,6 @@ paths:
name: applicationId
required: true
schema:
- format: int64
type: integer
responses:
"200":
@@ -6768,7 +6611,6 @@ paths:
name: applicationId
required: true
schema:
- format: int64
type: integer
- description: Only return results where the request path matches the given
regular expression.
@@ -6825,7 +6667,6 @@ paths:
name: pageSize
schema:
default: 1000
- format: int64
maximum: 1000
minimum: 1
type: integer
@@ -6834,7 +6675,6 @@ paths:
in: query
name: skip
schema:
- format: int64
type: integer
- description: |
The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`.
@@ -6866,7 +6706,6 @@ paths:
name: applicationId
required: true
schema:
- format: int64
type: integer
- description: The ID of the campaign. It is displayed in your Talon.One deployment
URL.
@@ -6874,7 +6713,6 @@ paths:
name: campaignId
required: true
schema:
- format: int64
type: integer
- description: |
Only return results from after this timestamp.
@@ -6933,7 +6771,6 @@ paths:
name: applicationId
required: true
schema:
- format: int64
type: integer
- description: Filter results performing an exact matching against the profile
integration identifier.
@@ -6946,7 +6783,6 @@ paths:
name: pageSize
schema:
default: 1000
- format: int64
maximum: 1000
minimum: 1
type: integer
@@ -6955,7 +6791,6 @@ paths:
in: query
name: skip
schema:
- format: int64
type: integer
- description: |
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.
@@ -6991,14 +6826,12 @@ paths:
name: applicationId
required: true
schema:
- format: int64
type: integer
- description: The number of items in the response.
in: query
name: pageSize
schema:
default: 1000
- format: int64
maximum: 1000
minimum: 1
type: integer
@@ -7007,7 +6840,6 @@ paths:
in: query
name: skip
schema:
- format: int64
type: integer
- description: |
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.
@@ -7051,7 +6883,6 @@ paths:
name: pageSize
schema:
default: 1000
- format: int64
maximum: 1000
minimum: 1
type: integer
@@ -7060,7 +6891,6 @@ paths:
in: query
name: skip
schema:
- format: int64
type: integer
- description: Indicates whether you are pointing to a sandbox or live customer.
in: query
@@ -7111,7 +6941,6 @@ paths:
name: customerId
required: true
schema:
- format: int64
type: integer
responses:
"200":
@@ -7134,7 +6963,6 @@ paths:
name: pageSize
schema:
default: 1000
- format: int64
maximum: 1000
minimum: 1
type: integer
@@ -7143,7 +6971,6 @@ paths:
in: query
name: skip
schema:
- format: int64
type: integer
- description: Indicates whether you are pointing to a sandbox or live customer.
in: query
@@ -7174,7 +7001,6 @@ paths:
name: applicationId
required: true
schema:
- format: int64
type: integer
- description: |
The value of the `id` property of a customer profile. Get it with the
@@ -7183,7 +7009,6 @@ paths:
name: customerId
required: true
schema:
- format: int64
type: integer
responses:
"200":
@@ -7208,7 +7033,6 @@ paths:
name: pageSize
schema:
default: 1000
- format: int64
maximum: 1000
minimum: 1
type: integer
@@ -7217,7 +7041,6 @@ paths:
in: query
name: skip
schema:
- format: int64
type: integer
- description: |
The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`.
@@ -7257,7 +7080,6 @@ paths:
name: applicationId
required: true
schema:
- format: int64
type: integer
- description: Only return reports matching the customer name.
in: query
@@ -7302,7 +7124,6 @@ paths:
name: pageSize
schema:
default: 1000
- format: int64
maximum: 1000
minimum: 1
type: integer
@@ -7311,7 +7132,6 @@ paths:
in: query
name: skip
schema:
- format: int64
type: integer
- description: |
Only return results from after this timestamp.
@@ -7343,7 +7163,6 @@ paths:
name: applicationId
required: true
schema:
- format: int64
type: integer
- description: |
The value of the `id` property of a customer profile. Get it with the
@@ -7352,7 +7171,6 @@ paths:
name: customerId
required: true
schema:
- format: int64
type: integer
responses:
"200":
@@ -7375,7 +7193,6 @@ paths:
name: pageSize
schema:
default: 1000
- format: int64
maximum: 1000
minimum: 1
type: integer
@@ -7384,7 +7201,6 @@ paths:
in: query
name: skip
schema:
- format: int64
type: integer
- description: |
The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`.
@@ -7400,7 +7216,6 @@ paths:
name: applicationId
required: true
schema:
- format: int64
type: integer
- description: |
The value of the `id` property of a customer profile. Get it with the
@@ -7409,7 +7224,6 @@ paths:
name: customerId
required: true
schema:
- format: int64
type: integer
responses:
"200":
@@ -7433,7 +7247,6 @@ paths:
name: pageSize
schema:
default: 1000
- format: int64
maximum: 1000
minimum: 1
type: integer
@@ -7442,7 +7255,6 @@ paths:
in: query
name: skip
schema:
- format: int64
type: integer
- description: |
The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`.
@@ -7508,7 +7320,6 @@ paths:
name: applicationId
required: true
schema:
- format: int64
type: integer
responses:
"200":
@@ -7534,7 +7345,6 @@ paths:
name: applicationId
required: true
schema:
- format: int64
type: integer
- description: |
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.
@@ -7542,7 +7352,6 @@ paths:
name: sessionId
required: true
schema:
- format: int64
type: integer
responses:
"200":
@@ -7566,7 +7375,6 @@ paths:
name: pageSize
schema:
default: 1000
- format: int64
maximum: 1000
minimum: 1
type: integer
@@ -7575,7 +7383,6 @@ paths:
in: query
name: skip
schema:
- format: int64
type: integer
- description: |
The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`.
@@ -7654,7 +7461,6 @@ paths:
name: applicationId
required: true
schema:
- format: int64
type: integer
responses:
"200":
@@ -7680,7 +7486,6 @@ paths:
name: pageSize
schema:
default: 1000
- format: int64
maximum: 1000
minimum: 1
type: integer
@@ -7689,7 +7494,6 @@ paths:
in: query
name: skip
schema:
- format: int64
type: integer
- description: |
The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`.
@@ -7705,7 +7509,6 @@ paths:
name: applicationId
required: true
schema:
- format: int64
type: integer
responses:
"200":
@@ -7729,7 +7532,6 @@ paths:
name: pageSize
schema:
default: 1000
- format: int64
maximum: 1000
minimum: 1
type: integer
@@ -7738,7 +7540,6 @@ paths:
in: query
name: skip
schema:
- format: int64
type: integer
- description: |
The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`.
@@ -7813,14 +7614,12 @@ paths:
name: audienceId
required: true
schema:
- format: int64
type: integer
- description: The number of items in the response.
in: query
name: pageSize
schema:
default: 1000
- format: int64
maximum: 1000
minimum: 1
type: integer
@@ -7829,7 +7628,6 @@ paths:
in: query
name: skip
schema:
- format: int64
type: integer
- description: |
The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`.
@@ -7887,7 +7685,6 @@ paths:
name: audienceId
required: true
schema:
- format: int64
type: integer
requestBody:
content:
@@ -7944,7 +7741,6 @@ paths:
name: audienceId
required: true
schema:
- format: int64
type: integer
responses:
"200":
@@ -7987,7 +7783,6 @@ paths:
name: pageSize
schema:
default: 1000
- format: int64
maximum: 1000
minimum: 1
type: integer
@@ -7996,7 +7791,6 @@ paths:
in: query
name: skip
schema:
- format: int64
type: integer
- description: |
The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`.
@@ -8012,7 +7806,6 @@ paths:
name: applicationId
required: true
schema:
- format: int64
type: integer
- description: |
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.
@@ -8051,7 +7844,6 @@ paths:
name: pageSize
schema:
default: 1000
- format: int64
maximum: 1000
minimum: 1
type: integer
@@ -8060,7 +7852,6 @@ paths:
in: query
name: skip
schema:
- format: int64
type: integer
- description: |
The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`.
@@ -8134,7 +7925,6 @@ paths:
name: attributeId
required: true
schema:
- format: int64
type: integer
responses:
"200":
@@ -8163,7 +7953,6 @@ paths:
name: attributeId
required: true
schema:
- format: int64
type: integer
requestBody:
content:
@@ -8216,7 +8005,6 @@ paths:
name: attributeId
required: true
schema:
- format: int64
type: integer
requestBody:
content:
@@ -8269,14 +8057,12 @@ paths:
name: catalogId
required: true
schema:
- format: int64
type: integer
- description: The number of items in the response.
in: query
name: pageSize
schema:
default: 1000
- format: int64
maximum: 1000
minimum: 1
type: integer
@@ -8285,7 +8071,6 @@ paths:
in: query
name: skip
schema:
- format: int64
type: integer
- description: |
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.
@@ -8297,7 +8082,7 @@ paths:
schema:
type: boolean
- description: Filter results by one or more SKUs. Must be exact match.
- explode: false
+ explode: true
in: query
name: sku
schema:
@@ -8306,7 +8091,7 @@ paths:
type: array
style: form
- description: Filter results by one or more product names. Must be exact match.
- explode: false
+ explode: true
in: query
name: productNames
schema:
@@ -8582,7 +8367,6 @@ paths:
name: catalogId
required: true
schema:
- format: int64
type: integer
requestBody:
content:
@@ -8635,7 +8419,6 @@ paths:
name: pageSize
schema:
default: 1000
- format: int64
maximum: 1000
minimum: 1
type: integer
@@ -8644,7 +8427,6 @@ paths:
in: query
name: skip
schema:
- format: int64
type: integer
- description: |
The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`.
@@ -8703,7 +8485,6 @@ paths:
name: additionalCostId
required: true
schema:
- format: int64
type: integer
responses:
"200":
@@ -8727,7 +8508,6 @@ paths:
name: additionalCostId
required: true
schema:
- format: int64
type: integer
requestBody:
content:
@@ -8775,7 +8555,6 @@ paths:
name: pageSize
schema:
default: 1000
- format: int64
maximum: 1000
minimum: 1
type: integer
@@ -8784,7 +8563,6 @@ paths:
in: query
name: skip
schema:
- format: int64
type: integer
- description: Filter results by creation type.
in: query
@@ -8806,7 +8584,6 @@ paths:
in: query
name: outgoingIntegrationsTypeId
schema:
- format: int64
type: integer
- description: Filter results performing case-insensitive matching against the
webhook title.
@@ -8836,7 +8613,6 @@ paths:
name: webhookId
required: true
schema:
- format: int64
type: integer
responses:
"200":
@@ -8861,7 +8637,6 @@ paths:
name: pageSize
schema:
default: 1000
- format: int64
maximum: 1000
minimum: 1
type: integer
@@ -8870,7 +8645,6 @@ paths:
in: query
name: skip
schema:
- format: int64
type: integer
- description: |
The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`.
@@ -8935,7 +8709,6 @@ paths:
name: pageSize
schema:
default: 1000
- format: int64
maximum: 1000
minimum: 1
type: integer
@@ -8944,7 +8717,6 @@ paths:
in: query
name: skip
schema:
- format: int64
type: integer
- description: |
The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`.
@@ -9038,6 +8810,8 @@ paths:
- LoyaltyPointsDeducted
- LoyaltyPointsExpiring
- LoyaltyPointsPendingToActive
+ - LoyaltyAddedDeductedPointsBalances
+ - LoyaltyCardAddedDeductedPointsBalances
- TierWillDowngrade
- TierUpgrade
- TierDowngrade
@@ -9118,13 +8892,11 @@ paths:
in: query
name: loyaltyProgramId
schema:
- format: int64
type: integer
- description: Filter results by response status code.
in: query
name: responseCode
schema:
- format: int64
type: integer
- description: Filter results by webhook ID (include up to 30 values, separated
by a comma).
@@ -9166,7 +8938,6 @@ paths:
name: pageSize
schema:
default: 1000
- format: int64
maximum: 1000
minimum: 1
type: integer
@@ -9175,7 +8946,6 @@ paths:
in: query
name: skip
schema:
- format: int64
type: integer
- description: |
The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`.
@@ -9236,7 +9006,6 @@ paths:
name: applicationId
required: true
schema:
- format: int64
type: integer
- description: The ID of the campaign. It is displayed in your Talon.One deployment
URL.
@@ -9244,7 +9013,6 @@ paths:
name: campaignId
required: true
schema:
- format: int64
type: integer
- description: |
An indicator of whether to skip duplicate coupon values instead of causing an error.
@@ -9316,7 +9084,6 @@ paths:
name: applicationId
required: true
schema:
- format: int64
type: integer
- description: Filter results by campaign ID.
in: query
@@ -9378,7 +9145,6 @@ paths:
in: query
name: referralId
schema:
- format: int64
type: integer
- description: Filter results by match with a profile id specified in the coupon's
RecipientIntegrationId field.
@@ -9468,7 +9234,6 @@ paths:
name: applicationId
required: true
schema:
- format: int64
type: integer
- description: Filter results by campaign ID.
in: query
@@ -9571,7 +9336,6 @@ paths:
name: applicationId
required: true
schema:
- format: int64
type: integer
- description: Filter results by campaign ID.
in: query
@@ -9619,7 +9383,7 @@ paths:
description: |
Download a CSV file containing the customer sessions that match the request.
- **Important:** Archived sessions cannot be exported. See the [retention policy](https://docs.talon.one/docs/product/server-infrastructure-and-data-retention#data-retention-policy).
+ **Important:** Archived sessions cannot be exported. See the [retention policy](https://docs.talon.one/docs/dev/server-infrastructure-and-data-retention).
**Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/).
@@ -9651,7 +9415,6 @@ paths:
name: applicationId
required: true
schema:
- format: int64
type: integer
- description: Filter results comparing the parameter value, expected to be
an RFC3339 timestamp string.
@@ -9745,7 +9508,6 @@ paths:
name: applicationId
required: true
schema:
- format: int64
type: integer
- description: The ID of the campaign. It is displayed in your Talon.One deployment
URL.
@@ -9753,7 +9515,6 @@ paths:
name: campaignId
required: true
schema:
- format: int64
type: integer
requestBody:
content:
@@ -9787,7 +9548,6 @@ paths:
name: pageSize
schema:
default: 1000
- format: int64
maximum: 1000
minimum: 1
type: integer
@@ -9796,7 +9556,6 @@ paths:
in: query
name: skip
schema:
- format: int64
type: integer
- description: |
The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`.
@@ -9827,7 +9586,6 @@ paths:
name: userId
required: true
schema:
- format: int64
type: integer
responses:
"204":
@@ -9847,7 +9605,6 @@ paths:
name: userId
required: true
schema:
- format: int64
type: integer
responses:
"200":
@@ -9869,7 +9626,6 @@ paths:
name: userId
required: true
schema:
- format: int64
type: integer
requestBody:
content:
@@ -9907,6 +9663,156 @@ paths:
tags:
- management
x-accepts: application/json
+ /v1/provisioning/scim/Groups:
+ get:
+ description: |-
+ Retrieve a paginated list of groups created using the SCIM protocol with an identity provider, for example, Microsoft Entra ID.
+ In Talon.One, a `Group` corresponds to a [role](https://docs.talon.one/docs/product/account/account-settings/managing-roles), and `members` are the [users](https://docs.talon.one/docs/product/account/account-settings/managing-users) assigned to that role.
+ operationId: scimGetGroups
+ responses:
+ "200":
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ScimGroupsListResponse'
+ description: List of SCIM groups
+ summary: List SCIM groups
+ tags:
+ - management
+ x-accepts: application/json
+ post:
+ description: |-
+ Create a new Talon.One group using the SCIM Group provisioning protocol with an identity provider, for example, Microsoft Entra ID, and assign members from the payload to the new group.
+ In Talon.One, a `Group` corresponds to a [role](https://docs.talon.one/docs/product/account/account-settings/managing-roles), and `members` are the [users](https://docs.talon.one/docs/product/account/account-settings/managing-users) assigned to that role.
+ operationId: scimCreateGroup
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ScimBaseGroup'
+ description: body
+ required: true
+ responses:
+ "201":
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ScimGroup'
+ description: Created
+ summary: Create SCIM group
+ tags:
+ - management
+ x-codegen-request-body-name: body
+ x-contentType: application/json
+ x-accepts: application/json
+ /v1/provisioning/scim/Groups/{groupId}:
+ delete:
+ description: |-
+ Delete a specific group created using the SCIM provisioning protocol with an identity provider, for example, Microsoft Entra ID.
+ In Talon.One, a `Group` corresponds to a [role](https://docs.talon.one/docs/product/account/account-settings/managing-roles), and `members` are the [users](https://docs.talon.one/docs/product/account/account-settings/managing-users) assigned to that role.
+ operationId: scimDeleteGroup
+ parameters:
+ - description: The ID of the group.
+ in: path
+ name: groupId
+ required: true
+ schema:
+ type: integer
+ responses:
+ "204":
+ content: {}
+ description: No Content
+ summary: Delete SCIM group
+ tags:
+ - management
+ x-accepts: application/json
+ get:
+ description: |-
+ Retrieve data for a specific group created using the SCIM provisioning protocol with an identity provider, for example, Microsoft Entra ID.
+ In Talon.One, a `Group` corresponds to a [role](https://docs.talon.one/docs/product/account/account-settings/managing-roles), and `members` are the [users](https://docs.talon.one/docs/product/account/account-settings/managing-users) assigned to that role.
+ operationId: scimGetGroup
+ parameters:
+ - description: The ID of the group.
+ in: path
+ name: groupId
+ required: true
+ schema:
+ type: integer
+ responses:
+ "200":
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ScimGroup'
+ description: Group details
+ summary: Get SCIM group
+ tags:
+ - management
+ x-accepts: application/json
+ patch:
+ description: |
+ Update certain attributes of a group created using the SCIM provisioning protocol with an identity provider, for example, Microsoft Entra ID. This endpoint allows for selective adding, removing, or replacing of specific group attributes while other attributes remain unchanged.
+ In Talon.One, a `Group` corresponds to a [role](https://docs.talon.one/docs/product/account/account-settings/managing-roles), and `members` are the [users](https://docs.talon.one/docs/product/account/account-settings/managing-users) assigned to that role.
+ operationId: scimPatchGroup
+ parameters:
+ - description: The ID of the group.
+ in: path
+ name: groupId
+ required: true
+ schema:
+ type: integer
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ScimPatchRequest'
+ description: body
+ required: true
+ responses:
+ "200":
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ScimGroup'
+ description: Group details
+ summary: Update SCIM group attributes
+ tags:
+ - management
+ x-codegen-request-body-name: body
+ x-contentType: application/json
+ x-accepts: application/json
+ put:
+ description: |
+ Update the details of a specific group created using the SCIM provisioning protocol with an identity provider, for example, Microsoft Entra ID. This endpoint replaces all attributes of the given group with the attributes provided in the request payload.
+ In Talon.One, a `Group` corresponds to a [role](https://docs.talon.one/docs/product/account/account-settings/managing-roles), and `members` are the [users](https://docs.talon.one/docs/product/account/account-settings/managing-users) assigned to that role.
+ operationId: scimReplaceGroupAttributes
+ parameters:
+ - description: The ID of the group.
+ in: path
+ name: groupId
+ required: true
+ schema:
+ type: integer
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ScimBaseGroup'
+ description: body
+ required: true
+ responses:
+ "200":
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ScimGroup'
+ description: Group details
+ summary: Update SCIM group
+ tags:
+ - management
+ x-codegen-request-body-name: body
+ x-contentType: application/json
+ x-accepts: application/json
/v1/provisioning/scim/Users:
get:
description: Retrieve a paginated list of users that have been provisioned using
@@ -9959,7 +9865,6 @@ paths:
name: userId
required: true
schema:
- format: int64
type: integer
responses:
"204":
@@ -9980,7 +9885,6 @@ paths:
name: userId
required: true
schema:
- format: int64
type: integer
responses:
"200":
@@ -10005,7 +9909,6 @@ paths:
name: userId
required: true
schema:
- format: int64
type: integer
requestBody:
content:
@@ -10039,7 +9942,6 @@ paths:
name: userId
required: true
schema:
- format: int64
type: integer
requestBody:
content:
@@ -10212,7 +10114,6 @@ paths:
name: pageSize
schema:
default: 1000
- format: int64
maximum: 1000
minimum: 1
type: integer
@@ -10221,7 +10122,6 @@ paths:
in: query
name: skip
schema:
- format: int64
type: integer
- description: |
The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`.
@@ -10246,7 +10146,6 @@ paths:
in: query
name: userId
schema:
- format: int64
type: integer
- description: Filter results comparing the parameter value, expected to be
an RFC3339 timestamp string, to the change creation timestamp. You can use
@@ -10277,7 +10176,6 @@ paths:
in: query
name: managementKeyId
schema:
- format: int64
type: integer
- description: When this flag is set to false, the state without the change
will not be returned. The default value is true.
@@ -10417,7 +10315,6 @@ paths:
name: accountId
required: true
schema:
- format: int64
type: integer
responses:
"200":
@@ -10444,7 +10341,6 @@ paths:
name: accountId
required: true
schema:
- format: int64
type: integer
responses:
"200":
@@ -10516,7 +10412,6 @@ paths:
name: pageSize
schema:
default: 1000
- format: int64
maximum: 1000
minimum: 1
type: integer
@@ -10525,7 +10420,6 @@ paths:
in: query
name: skip
schema:
- format: int64
type: integer
- description: Filter results by Application ID.
in: query
@@ -10536,7 +10430,6 @@ paths:
in: query
name: campaignId
schema:
- format: int64
type: integer
- description: The name of the entity type that was exported.
in: query
@@ -10592,7 +10485,6 @@ paths:
name: roleId
required: true
schema:
- format: int64
type: integer
responses:
"200":
@@ -10617,7 +10509,6 @@ paths:
name: roleId
required: true
schema:
- format: int64
type: integer
requestBody:
content:
@@ -10650,14 +10541,12 @@ paths:
name: applicationId
required: true
schema:
- format: int64
type: integer
- description: The number of items in the response.
in: query
name: pageSize
schema:
default: 1000
- format: int64
maximum: 1000
minimum: 1
type: integer
@@ -10666,7 +10555,6 @@ paths:
in: query
name: skip
schema:
- format: int64
type: integer
- description: |
The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`.
@@ -10726,7 +10614,6 @@ paths:
name: applicationId
required: true
schema:
- format: int64
type: integer
requestBody:
content:
@@ -10772,7 +10659,6 @@ paths:
name: applicationId
required: true
schema:
- format: int64
type: integer
- description: |
The ID of the store.
@@ -10806,7 +10692,6 @@ paths:
name: applicationId
required: true
schema:
- format: int64
type: integer
- description: |
The ID of the store.
@@ -10843,7 +10728,6 @@ paths:
name: applicationId
required: true
schema:
- format: int64
type: integer
- description: |
The ID of the store.
@@ -10903,7 +10787,6 @@ paths:
name: applicationId
required: true
schema:
- format: int64
type: integer
- description: The ID of the campaign. It is displayed in your Talon.One deployment
URL.
@@ -10911,7 +10794,6 @@ paths:
name: campaignId
required: true
schema:
- format: int64
type: integer
responses:
"200":
@@ -10954,7 +10836,6 @@ paths:
name: applicationId
required: true
schema:
- format: int64
type: integer
- description: The ID of the campaign. It is displayed in your Talon.One deployment
URL.
@@ -10962,7 +10843,6 @@ paths:
name: campaignId
required: true
schema:
- format: int64
type: integer
responses:
"204":
@@ -11009,7 +10889,6 @@ paths:
name: applicationId
required: true
schema:
- format: int64
type: integer
- description: The ID of the campaign. It is displayed in your Talon.One deployment
URL.
@@ -11017,7 +10896,6 @@ paths:
name: campaignId
required: true
schema:
- format: int64
type: integer
requestBody:
content:
@@ -11058,6 +10936,377 @@ paths:
- management
x-contentType: multipart/form-data
x-accepts: application/json
+ /v1/applications/{applicationId}/campaigns/{campaignId}/stores/budgets:
+ delete:
+ description: Delete the store budgets for a given campaign.
+ operationId: deleteCampaignStoreBudgets
+ 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 action that this budget is limiting.
+ in: query
+ name: action
+ schema:
+ enum:
+ - setDiscount
+ type: string
+ - description: |
+ The period to which the limit applies.
+
+ **Note**: For budgets with no period, set this to `overall`.
+ in: query
+ name: period
+ schema:
+ enum:
+ - overall
+ - daily
+ - weekly
+ - monthly
+ - yearly
+ type: string
+ responses:
+ "204":
+ content: {}
+ description: Deleted
+ "400":
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Bad request
+ summary: Delete campaign store budgets
+ tags:
+ - management
+ x-accepts: application/json
+ get:
+ description: Return the store budget limits for a given campaign.
+ operationId: listCampaignStoreBudgetLimits
+ 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 action that this budget is limiting.
+ in: query
+ name: action
+ schema:
+ enum:
+ - setDiscount
+ type: string
+ - description: |
+ The period to which the limit applies.
+
+ **Note**: For budgets with no period, set this to `overall`.
+ in: query
+ name: period
+ schema:
+ enum:
+ - overall
+ - daily
+ - weekly
+ - monthly
+ - yearly
+ type: string
+ responses:
+ "200":
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/inline_response_200_48'
+ description: OK
+ "400":
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Bad request
+ "401":
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Unauthorized - Invalid API key
+ "404":
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Not found
+ summary: List campaign store budget limits
+ tags:
+ - management
+ x-accepts: application/json
+ post:
+ description: Create a new store budget for a given campaign.
+ operationId: createCampaignStoreBudget
+ 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/NewCampaignStoreBudget'
+ description: body
+ required: true
+ responses:
+ "201":
+ content: {}
+ description: Created
+ "400":
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Bad request
+ "409":
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Conflict
+ summary: Create campaign store budget
+ tags:
+ - management
+ x-codegen-request-body-name: body
+ x-contentType: application/json
+ x-accepts: application/json
+ /v1/applications/{applicationId}/campaigns/{campaignId}/stores/budgets/summary:
+ get:
+ description: Fetch a summary of all store budget information for a given campaign.
+ operationId: summarizeCampaignStoreBudget
+ 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
+ responses:
+ "200":
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/inline_response_200_49'
+ description: OK
+ "400":
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Bad request
+ "401":
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Unauthorized - Invalid API key
+ "404":
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Not found
+ summary: Get summary of campaign store budgets
+ tags:
+ - management
+ x-accepts: application/json
+ /v1/applications/{applicationId}/campaigns/{campaignId}/stores/budgets/import:
+ post:
+ description: |
+ Upload a CSV file containing store budgets for a given campaign.
+
+ Send the file as multipart data.
+
+ The CSV file **must** only contain the following columns:
+ - `store_integration_id`: The identifier of the store.
+ - `limit`: The budget limit for the store.
+
+ The import **replaces** the previous list of store budgets.
+ operationId: importCampaignStoreBudget
+ 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 action that this budget is limiting.
+ in: query
+ name: action
+ schema:
+ enum:
+ - setDiscount
+ type: string
+ - description: |
+ The period to which the limit applies.
+
+ **Note**: For budgets with no period, set this to `overall`.
+ in: query
+ name: period
+ schema:
+ enum:
+ - overall
+ - daily
+ - weekly
+ - monthly
+ - yearly
+ type: string
+ requestBody:
+ content:
+ multipart/form-data:
+ schema:
+ properties:
+ upFile:
+ description: The file containing the data that is being imported.
+ format: csv
+ type: string
+ responses:
+ "201":
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Import'
+ description: Created
+ "400":
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Bad request
+ summary: Import campaign store budgets
+ tags:
+ - management
+ x-contentType: multipart/form-data
+ x-accepts: application/json
+ /v1/applications/{applicationId}/campaigns/{campaignId}/stores/budgets/export:
+ get:
+ description: |
+ Download a CSV file containing the store budgets for a given campaign.
+
+ **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/).
+
+ The CSV file contains the following columns:
+
+ - `store_integration_id`: The identifier of the store.
+ - `limit`: The budget limit for the store.
+ operationId: exportCampaignStoreBudgets
+ 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 action that this budget is limiting.
+ in: query
+ name: action
+ schema:
+ enum:
+ - setDiscount
+ type: string
+ - description: |
+ The period to which the limit applies.
+
+ **Note**: For budgets with no period, set this to `overall`.
+ in: query
+ name: period
+ schema:
+ enum:
+ - overall
+ - daily
+ - weekly
+ - monthly
+ - yearly
+ type: string
+ responses:
+ "200":
+ content:
+ application/csv:
+ schema:
+ format: csv
+ type: string
+ description: OK
+ "400":
+ content:
+ application/csv:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Bad request
+ "401":
+ content:
+ application/csv:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Unauthorized - Invalid API key
+ "404":
+ content:
+ application/csv:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Not found
+ summary: Export campaign store budgets
+ tags:
+ - management
+ x-accepts: application/csv
/v1/applications/{applicationId}/campaigns/{campaignId}/achievements:
get:
description: List all the achievements for a specific campaign.
@@ -11069,7 +11318,6 @@ paths:
name: applicationId
required: true
schema:
- format: int64
type: integer
- description: The ID of the campaign. It is displayed in your Talon.One deployment
URL.
@@ -11077,14 +11325,12 @@ paths:
name: campaignId
required: true
schema:
- format: int64
type: integer
- description: The number of items in the response.
in: query
name: pageSize
schema:
default: 50
- format: int64
maximum: 50
minimum: 1
type: integer
@@ -11093,7 +11339,6 @@ paths:
in: query
name: skip
schema:
- format: int64
type: integer
- description: |
Filter by the display name for the achievement in the campaign manager.
@@ -11108,7 +11353,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/inline_response_200_48'
+ $ref: '#/components/schemas/inline_response_200_50'
description: OK
summary: List achievements
tags:
@@ -11124,7 +11369,6 @@ paths:
name: applicationId
required: true
schema:
- format: int64
type: integer
- description: The ID of the campaign. It is displayed in your Talon.One deployment
URL.
@@ -11132,7 +11376,6 @@ paths:
name: campaignId
required: true
schema:
- format: int64
type: integer
requestBody:
content:
@@ -11180,7 +11423,6 @@ paths:
name: applicationId
required: true
schema:
- format: int64
type: integer
- description: The ID of the campaign. It is displayed in your Talon.One deployment
URL.
@@ -11188,7 +11430,6 @@ paths:
name: campaignId
required: true
schema:
- format: int64
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)
@@ -11197,7 +11438,6 @@ paths:
name: achievementId
required: true
schema:
- format: int64
type: integer
responses:
"204":
@@ -11229,7 +11469,6 @@ paths:
name: applicationId
required: true
schema:
- format: int64
type: integer
- description: The ID of the campaign. It is displayed in your Talon.One deployment
URL.
@@ -11237,7 +11476,6 @@ paths:
name: campaignId
required: true
schema:
- format: int64
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)
@@ -11246,7 +11484,6 @@ paths:
name: achievementId
required: true
schema:
- format: int64
type: integer
responses:
"200":
@@ -11281,7 +11518,6 @@ paths:
name: applicationId
required: true
schema:
- format: int64
type: integer
- description: The ID of the campaign. It is displayed in your Talon.One deployment
URL.
@@ -11289,7 +11525,6 @@ paths:
name: campaignId
required: true
schema:
- format: int64
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)
@@ -11298,7 +11533,6 @@ paths:
name: achievementId
required: true
schema:
- format: int64
type: integer
requestBody:
content:
@@ -11360,7 +11594,6 @@ paths:
name: applicationId
required: true
schema:
- format: int64
type: integer
- description: The ID of the campaign. It is displayed in your Talon.One deployment
URL.
@@ -11368,7 +11601,6 @@ paths:
name: campaignId
required: true
schema:
- format: int64
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)
@@ -11377,7 +11609,6 @@ paths:
name: achievementId
required: true
schema:
- format: int64
type: integer
responses:
"200":
@@ -11421,7 +11652,6 @@ paths:
name: applicationId
required: true
schema:
- format: int64
type: integer
- description: |
The integration identifier for this customer profile. Must be:
@@ -11439,7 +11669,6 @@ paths:
name: pageSize
schema:
default: 50
- format: int64
maximum: 50
minimum: 1
type: integer
@@ -11448,7 +11677,6 @@ paths:
in: query
name: skip
schema:
- format: int64
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)
@@ -11456,7 +11684,6 @@ paths:
in: query
name: achievementId
schema:
- format: int64
type: integer
- description: Filter results by the `title` of an achievement.
in: query
@@ -11468,7 +11695,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/inline_response_200_49'
+ $ref: '#/components/schemas/inline_response_200_51'
description: OK
"400":
content:
@@ -11503,7 +11730,6 @@ components:
description: The globally unique Talon.One ID of the session where this
entity was created.
example: 2
- format: int64
type: integer
required:
- sessionId
@@ -11512,7 +11738,6 @@ components:
properties:
totalResultSize:
example: 1
- format: int64
type: integer
data:
items:
@@ -11526,7 +11751,6 @@ components:
properties:
totalResultSize:
example: 1
- format: int64
type: integer
data:
items:
@@ -11539,9 +11763,8 @@ components:
CampaignCollection:
properties:
id:
- description: Internal ID of this entity.
+ description: The internal ID of this entity.
example: 6
- format: int64
type: integer
created:
description: The time this entity was created.
@@ -11551,7 +11774,6 @@ components:
accountId:
description: The ID of the account that owns this entity.
example: 3886
- format: int64
type: integer
modified:
description: The time this entity was last modified.
@@ -11571,22 +11793,18 @@ components:
modifiedBy:
description: ID of the user who last updated this effect if available.
example: 48
- format: int64
type: integer
createdBy:
description: ID of the user who created this effect.
example: 134
- format: int64
type: integer
applicationId:
description: The ID of the Application that owns this entity.
example: 1
- format: int64
type: integer
campaignId:
description: The ID of the campaign that owns this entity.
example: 7
- format: int64
type: integer
payload:
description: The content of the collection.
@@ -11608,9 +11826,8 @@ components:
CampaignCollectionWithoutPayload:
properties:
id:
- description: Internal ID of this entity.
+ description: The internal ID of this entity.
example: 6
- format: int64
type: integer
created:
description: The time this entity was created.
@@ -11620,7 +11837,6 @@ components:
accountId:
description: The ID of the account that owns this entity.
example: 3886
- format: int64
type: integer
modified:
description: The time this entity was last modified.
@@ -11640,22 +11856,18 @@ components:
modifiedBy:
description: ID of the user who last updated this effect if available.
example: 48
- format: int64
type: integer
createdBy:
description: ID of the user who created this effect.
example: 134
- format: int64
type: integer
applicationId:
description: The ID of the Application that owns this entity.
example: 1
- format: int64
type: integer
campaignId:
description: The ID of the campaign that owns this entity.
example: 7
- format: int64
type: integer
required:
- accountId
@@ -11670,16 +11882,14 @@ components:
campaignGroups:
description: The IDs of the campaign groups that own this entity.
items:
- format: int64
type: integer
type: array
type: object
CampaignStoreBudget:
properties:
id:
- description: Internal ID of this entity.
+ description: The internal ID of this entity.
example: 6
- format: int64
type: integer
created:
description: The time this entity was created.
@@ -11689,11 +11899,9 @@ components:
campaignId:
description: The ID of the campaign that owns this entity.
example: 322
- format: int64
type: integer
storeId:
description: The ID of the store.
- format: int64
type: integer
limits:
description: The set of budget limits for stores linked to the campaign.
@@ -11759,9 +11967,8 @@ components:
CouponCreationJob:
properties:
id:
- description: Internal ID of this entity.
+ description: The internal ID of this entity.
example: 6
- format: int64
type: integer
created:
description: The time this entity was created.
@@ -11771,24 +11978,20 @@ components:
campaignId:
description: The ID of the campaign that owns this entity.
example: 211
- format: int64
title: Campaign ID
type: integer
applicationId:
description: The ID of the Application that owns this entity.
example: 322
- format: int64
type: integer
accountId:
description: The ID of the account that owns this entity.
example: 3886
- format: int64
type: integer
usageLimit:
description: |
The number of times the coupon code can be redeemed. `0` means unlimited redemptions but any campaign usage limits will still apply.
example: 100
- format: int64
maximum: 999999
minimum: 0
type: integer
@@ -11796,14 +11999,13 @@ components:
description: |
The total discount value that the code can give. Typically used to represent a gift card value.
example: 30.0
- maximum: 999999
+ maximum: 1E+15
minimum: 0
type: number
reservationLimit:
description: |
The number of reservations that can be made with this coupon code.
example: 45
- format: int64
maximum: 999999
minimum: 0
type: integer
@@ -11821,7 +12023,6 @@ components:
numberOfCoupons:
description: The number of new coupon codes to generate for the campaign.
example: 200000
- format: int64
maximum: 5E+6
minimum: 1
type: integer
@@ -11851,13 +12052,11 @@ components:
description: The number of coupon codes that were already created for this
request.
example: 1000000
- format: int64
title: Created Amount
type: integer
failCount:
description: The number of times this job failed.
example: 10
- format: int64
title: Fail Count
type: integer
errors:
@@ -11873,7 +12072,6 @@ components:
createdBy:
description: ID of the user who created this effect.
example: 1
- format: int64
title: Created By
type: integer
communicated:
@@ -11885,14 +12083,12 @@ components:
description: The number of times an attempt to create a chunk of coupons
was made during the processing of the job.
example: 0
- format: int64
title: Iterations
type: integer
chunkSize:
description: The number of coupons that will be created in a single transactions.
Coupons will be created in chunks until arriving at the requested amount.
example: 20000
- format: int64
title: Chunk size
type: integer
required:
@@ -11916,9 +12112,8 @@ components:
CouponDeletionJob:
properties:
id:
- description: Internal ID of this entity.
+ description: The internal ID of this entity.
example: 6
- format: int64
type: integer
created:
description: The time this entity was created.
@@ -11928,12 +12123,10 @@ components:
applicationId:
description: The ID of the Application that owns this entity.
example: 322
- format: int64
type: integer
accountId:
description: The ID of the account that owns this entity.
example: 3886
- format: int64
type: integer
filters:
$ref: '#/components/schemas/CouponDeletionFilters'
@@ -11951,13 +12144,11 @@ components:
description: The number of coupon codes that were already deleted for this
request.
example: 1000000
- format: int64
title: Deleted Amount
type: integer
failCount:
description: The number of times this job failed.
example: 10
- format: int64
title: Fail Count
type: integer
errors:
@@ -11972,7 +12163,6 @@ components:
createdBy:
description: ID of the user who created this effect.
example: 1
- format: int64
title: Created By
type: integer
communicated:
@@ -11982,7 +12172,6 @@ components:
type: boolean
campaignIDs:
items:
- format: int64
title: Campaign ID
type: integer
type: array
@@ -12053,11 +12242,9 @@ components:
properties:
RoleID:
description: ID of role.
- format: int64
type: integer
UserID:
description: ID of User.
- format: int64
type: integer
required:
- RoleID
@@ -12081,18 +12268,15 @@ components:
description: The ID of the Application to which the catalog items labels
belongs.
example: 322
- format: int64
type: integer
currentBatch:
description: The batch number of the notification. Notifications might be
sent in different batches.
example: 1
- format: int64
type: integer
totalBatches:
description: The total number of batches for the notification.
example: 10
- format: int64
type: integer
trigger:
$ref: '#/components/schemas/StrikethroughTrigger'
@@ -12125,7 +12309,6 @@ components:
- 2
- 3
items:
- format: int64
type: integer
type: array
type: object
@@ -12134,9 +12317,8 @@ components:
Entity:
properties:
id:
- description: Internal ID of this entity.
+ description: The internal ID of this entity.
example: 6
- format: int64
type: integer
created:
description: The time this entity was created.
@@ -12169,7 +12351,6 @@ components:
applicationId:
description: The ID of the Application that owns this entity.
example: 322
- format: int64
type: integer
required:
- applicationId
@@ -12205,7 +12386,6 @@ components:
- 10
- 12
items:
- format: int64
type: integer
title: Campaigns to evaluate
type: array
@@ -12232,6 +12412,30 @@ components:
required:
- price
type: object
+ PriceDetail:
+ properties:
+ price:
+ description: The value of this price type.
+ example: 90.0
+ format: float
+ type: number
+ adjustmentReferenceId:
+ description: The reference identifier of the selected price adjustment for
+ this SKU.
+ example: 68851723-e6fa-488f-ace9-112581e6c19b
+ format: uuid
+ type: string
+ adjustmentEffectiveFrom:
+ description: The date and time from which the price adjustment is effective.
+ example: 2025-05-25T00:00:00Z
+ format: date-time
+ type: string
+ adjustmentEffectiveUntil:
+ description: The date and time until which the price adjustment is effective.
+ example: 2025-05-30T00:00:00Z
+ format: date-time
+ type: string
+ type: object
CartItem:
example:
remainingQuantity: 1
@@ -12241,19 +12445,31 @@ components:
returnedQuantity: 1
length: 1.4658129805029452
weight: 1130.0
+ adjustmentReferenceId: 68851723-e6fa-488f-ace9-112581e6c19b
+ adjustmentEffectiveFrom: 2021-09-12T10:12:42Z
catalogItemID: 5
additionalCosts:
shipping:
price: 9
price: 99.99
+ selectedPriceType: member
name: Air Glide
width: 6.027456183070403
attributes:
image: 11.jpeg
material: leather
+ adjustmentEffectiveUntil: 2021-09-12T10:12:42Z
position: 5.962133916683182
sku: SKU1241028
category: shoes
+ prices:
+ member:
+ price: 90
+ adjustmentReferenceId: 68851723-e6fa-488f-ace9-112581e6c19b
+ effectiveFrom: 2025-05-25T00:00:00Z
+ effectiveUntil: 2025-05-30T00:00:00Z
+ base:
+ price: 100
height: 0.8008281904610115
properties:
name:
@@ -12273,7 +12489,6 @@ components:
if you provide a quantity greater than 1, the item will be split in as many items as the provided quantity.
This will impact the number of **per-item** effects triggered from your campaigns.
example: 1
- format: int64
minimum: 1
title: Quantity of item
type: integer
@@ -12281,14 +12496,12 @@ components:
description: Number of returned items, calculated internally based on returns
of this item.
example: 1
- format: int64
title: Returned quantity of item
type: integer
remainingQuantity:
description: Remaining quantity of the item, calculated internally based
on returns of this item.
example: 1
- format: int64
title: Remaining quantity of item
type: integer
price:
@@ -12349,10 +12562,54 @@ components:
price: 9
type: object
catalogItemID:
- description: The [catalog item ID](https://docs.talon.one/docs/product/account/dev-tools/managing-cart-item-catalogs/#synchronizing-a-cart-item-catalog).
- format: int64
+ description: The catalog item ID.
title: The catalog item ID
type: integer
+ selectedPriceType:
+ description: The selected price type for this cart item (e.g. the price
+ for members only).
+ example: member
+ title: The selected price type
+ type: string
+ adjustmentReferenceId:
+ description: The reference identifier of the selected price adjustment for
+ this cart item. This is only returned if the `selectedPrice` resulted
+ from a price adjustment.
+ example: 68851723-e6fa-488f-ace9-112581e6c19b
+ format: uuid
+ title: The reference identifier of the selected price adjustment
+ type: string
+ adjustmentEffectiveFrom:
+ description: The date and time from which the price adjustment is effective.
+ This is only returned if the `selectedPrice` resulted from a price adjustment
+ that contains this field.
+ example: 2021-09-12T10:12:42Z
+ format: date-time
+ title: The date and time from which the price adjustment is effective
+ type: string
+ adjustmentEffectiveUntil:
+ description: The date and time until which the price adjustment is effective.
+ This is only returned if the `selectedPrice` resulted from a price adjustment
+ that contains this field.
+ example: 2021-09-12T10:12:42Z
+ format: date-time
+ title: The date and time until which the price adjustment is effective
+ type: string
+ prices:
+ additionalProperties:
+ $ref: '#/components/schemas/PriceDetail'
+ description: |
+ A map of keys and values representing the price types and related price adjustment details for this cart item.
+ The keys correspond to the `priceType` names.
+ example:
+ member:
+ price: 90
+ adjustmentReferenceId: 68851723-e6fa-488f-ace9-112581e6c19b
+ effectiveFrom: 2025-05-25T00:00:00Z
+ effectiveUntil: 2025-05-30T00:00:00Z
+ base:
+ price: 100
+ type: object
required:
- quantity
- sku
@@ -12386,19 +12643,31 @@ components:
returnedQuantity: 1
length: 1.4658129805029452
weight: 1130.0
+ adjustmentReferenceId: 68851723-e6fa-488f-ace9-112581e6c19b
+ adjustmentEffectiveFrom: 2021-09-12T10:12:42Z
catalogItemID: 5
additionalCosts:
shipping:
price: 9
price: 99.99
+ selectedPriceType: member
name: Air Glide
width: 6.027456183070403
attributes:
image: 11.jpeg
material: leather
+ adjustmentEffectiveUntil: 2021-09-12T10:12:42Z
position: 5.962133916683182
sku: SKU1241028
category: shoes
+ prices:
+ member:
+ price: 90
+ adjustmentReferenceId: 68851723-e6fa-488f-ace9-112581e6c19b
+ effectiveFrom: 2025-05-25T00:00:00Z
+ effectiveUntil: 2025-05-30T00:00:00Z
+ base:
+ price: 100
height: 0.8008281904610115
- remainingQuantity: 1
product:
@@ -12407,19 +12676,31 @@ components:
returnedQuantity: 1
length: 1.4658129805029452
weight: 1130.0
+ adjustmentReferenceId: 68851723-e6fa-488f-ace9-112581e6c19b
+ adjustmentEffectiveFrom: 2021-09-12T10:12:42Z
catalogItemID: 5
additionalCosts:
shipping:
price: 9
price: 99.99
+ selectedPriceType: member
name: Air Glide
width: 6.027456183070403
attributes:
image: 11.jpeg
material: leather
+ adjustmentEffectiveUntil: 2021-09-12T10:12:42Z
position: 5.962133916683182
sku: SKU1241028
category: shoes
+ prices:
+ member:
+ price: 90
+ adjustmentReferenceId: 68851723-e6fa-488f-ace9-112581e6c19b
+ effectiveFrom: 2025-05-25T00:00:00Z
+ effectiveUntil: 2025-05-30T00:00:00Z
+ base:
+ price: 100
height: 0.8008281904610115
properties:
profileId:
@@ -12445,7 +12726,6 @@ components:
- 10
- 12
items:
- format: int64
type: integer
title: Campaigns to evaluate
type: array
@@ -12591,19 +12871,31 @@ components:
returnedQuantity: 1
length: 1.4658129805029452
weight: 1130.0
+ adjustmentReferenceId: 68851723-e6fa-488f-ace9-112581e6c19b
+ adjustmentEffectiveFrom: 2021-09-12T10:12:42Z
catalogItemID: 5
additionalCosts:
shipping:
price: 9
price: 99.99
+ selectedPriceType: member
name: Air Glide
width: 6.027456183070403
attributes:
image: 11.jpeg
material: leather
+ adjustmentEffectiveUntil: 2021-09-12T10:12:42Z
position: 5.962133916683182
sku: SKU1241028
category: shoes
+ prices:
+ member:
+ price: 90
+ adjustmentReferenceId: 68851723-e6fa-488f-ace9-112581e6c19b
+ effectiveFrom: 2025-05-25T00:00:00Z
+ effectiveUntil: 2025-05-30T00:00:00Z
+ base:
+ price: 100
height: 0.8008281904610115
- remainingQuantity: 1
product:
@@ -12612,28 +12904,39 @@ components:
returnedQuantity: 1
length: 1.4658129805029452
weight: 1130.0
+ adjustmentReferenceId: 68851723-e6fa-488f-ace9-112581e6c19b
+ adjustmentEffectiveFrom: 2021-09-12T10:12:42Z
catalogItemID: 5
additionalCosts:
shipping:
price: 9
price: 99.99
+ selectedPriceType: member
name: Air Glide
width: 6.027456183070403
attributes:
image: 11.jpeg
material: leather
+ adjustmentEffectiveUntil: 2021-09-12T10:12:42Z
position: 5.962133916683182
sku: SKU1241028
category: shoes
+ prices:
+ member:
+ price: 90
+ adjustmentReferenceId: 68851723-e6fa-488f-ace9-112581e6c19b
+ effectiveFrom: 2025-05-25T00:00:00Z
+ effectiveUntil: 2025-05-30T00:00:00Z
+ base:
+ price: 100
height: 0.8008281904610115
updated: 2020-02-08T14:15:22Z
firstSession: true
cartItemTotal: 99.99
properties:
id:
- description: Internal ID of this entity.
+ description: The internal ID of this entity.
example: 6
- format: int64
type: integer
created:
description: The time this entity was created.
@@ -12649,7 +12952,6 @@ components:
applicationId:
description: The ID of the Application that owns this entity.
example: 322
- format: int64
type: integer
profileId:
description: |
@@ -12674,7 +12976,6 @@ components:
- 10
- 12
items:
- format: int64
type: integer
title: Campaigns to evaluate
type: array
@@ -12835,19 +13136,16 @@ components:
campaignId:
description: The ID of the campaign that triggered this effect.
example: 244
- format: int64
type: integer
rulesetId:
description: The ID of the ruleset that was active in the campaign when
this effect was triggered.
example: 73
- format: int64
type: integer
ruleIndex:
description: The position of the rule that triggered this effect within
the ruleset.
example: 2
- format: int64
type: integer
ruleName:
description: The name of the rule that triggered this effect.
@@ -12861,24 +13159,20 @@ components:
description: The ID of the coupon that was being evaluated when this effect
was triggered.
example: 4928
- format: int64
type: integer
triggeredForCatalogItem:
description: The ID of the catalog item that was being evaluated when this
effect was triggered.
example: 786
- format: int64
type: integer
conditionIndex:
description: The index of the condition that was triggered.
example: 786
- format: int64
type: integer
evaluationGroupID:
description: The ID of the evaluation group. For more information, see [Managing
campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation).
example: 3
- format: int64
type: integer
evaluationGroupMode:
description: The evaluation mode of the evaluation group. For more information,
@@ -12889,14 +13183,28 @@ components:
description: The revision ID of the campaign that was used when triggering
the effect.
example: 1
- format: int64
type: integer
campaignRevisionVersionId:
description: The revision version ID of the campaign that was used when
triggering the effect.
example: 5
- format: int64
type: integer
+ selectedPriceType:
+ description: The selected price type for the SKU targeted by this effect.
+ example: member
+ type: string
+ selectedPrice:
+ description: The value of the selected price type to apply to the SKU targeted
+ by this effect, before any discounts are applied.
+ example: 100.0
+ type: number
+ adjustmentReferenceId:
+ description: The reference identifier of the selected price adjustment for
+ this SKU. This is only returned if the `selectedPrice` resulted from a
+ price adjustment.
+ example: 68851723-e6fa-488f-ace9-112581e6c19b
+ format: uuid
+ type: string
required:
- campaignId
- effectType
@@ -12933,7 +13241,6 @@ components:
properties:
id:
description: The id of the referral code that was redeemed.
- format: int64
type: integer
value:
description: The referral code that was redeemed.
@@ -12956,11 +13263,9 @@ components:
conditionIndex:
description: The index of the condition that caused the rejection of the
coupon.
- format: int64
type: integer
effectIndex:
description: The index of the effect that caused the rejection of the coupon.
- format: int64
type: integer
details:
description: More details about the failure.
@@ -12987,11 +13292,9 @@ components:
conditionIndex:
description: The index of the condition that caused the rejection of the
referral.
- format: int64
type: integer
effectIndex:
description: The index of the effect that caused the rejection of the referral.
- format: int64
type: integer
details:
description: More details about the failure.
@@ -13099,7 +13402,6 @@ components:
bundleIndex:
description: The position of the bundle in a list of item bundles created
from the same bundle definition.
- format: int64
type: integer
bundleName:
description: The name of the bundle definition.
@@ -13128,7 +13430,6 @@ components:
type: string
additionalCostId:
description: The ID of the additional cost.
- format: int64
type: integer
additionalCost:
description: The name of the additional cost.
@@ -13177,7 +13478,6 @@ components:
type: string
programId:
description: The ID of the loyalty program where these points were added.
- format: int64
type: integer
subLedgerId:
description: The ID of the subledger within the loyalty program where these
@@ -13223,7 +13523,6 @@ components:
bundleIndex:
description: The position of the bundle in a list of item bundles created
from the same bundle definition.
- format: int64
type: integer
bundleName:
description: The name of the bundle definition.
@@ -13248,7 +13547,6 @@ components:
type: string
programId:
description: The ID of the loyalty program where these points were added.
- format: int64
type: integer
subLedgerId:
description: The ID of the subledger within the loyalty program where these
@@ -13289,7 +13587,6 @@ components:
type: string
programId:
description: The ID of the loyalty program where these points were added.
- format: int64
type: integer
subLedgerId:
description: The ID of the subledger within the loyalty program where these
@@ -13324,7 +13621,6 @@ components:
type: string
desiredQuantity:
description: The original quantity in case a partial reward was applied.
- format: int64
type: integer
required:
- name
@@ -13413,7 +13709,6 @@ components:
type: number
additionalCostId:
description: The ID of the additional cost that was rolled back.
- format: int64
type: integer
additionalCost:
description: The name of the additional cost that was rolled back.
@@ -13436,7 +13731,6 @@ components:
programId:
description: The ID of the loyalty program where the points were originally
added.
- format: int64
type: integer
subLedgerId:
description: The ID of the subledger within the loyalty program where these
@@ -13483,7 +13777,6 @@ components:
properties:
programId:
description: The ID of the loyalty program where these points were reimbursed.
- format: int64
type: integer
subLedgerId:
description: The ID of the subledger within the loyalty program where these
@@ -13555,7 +13848,6 @@ components:
poolId:
description: The ID of the giveaways pool the code was taken from.
example: 2
- format: int64
type: integer
poolName:
description: The name of the giveaways pool the code was taken from.
@@ -13569,7 +13861,6 @@ components:
giveawayId:
description: The internal ID for the giveaway that was awarded.
example: 5
- format: int64
type: integer
code:
description: The giveaway code that was awarded.
@@ -13591,7 +13882,6 @@ components:
poolId:
description: The ID of the giveaways pool the code will be taken from.
example: 2
- format: int64
type: integer
poolName:
description: The name of the giveaways pool the code will be taken from.
@@ -13624,7 +13914,6 @@ components:
effectId:
description: The ID of the custom effect that was triggered.
example: 1
- format: int64
type: integer
name:
description: The type of the custom effect.
@@ -13644,7 +13933,6 @@ components:
description: The position of the bundle in a list of item bundles created
from the same bundle definition.
example: 1
- format: int64
type: integer
bundleName:
description: The name of the bundle definition.
@@ -13671,7 +13959,6 @@ components:
type: string
additionalCostId:
description: The ID of the additional cost.
- format: int64
type: integer
value:
description: The total monetary value of the discount.
@@ -13725,7 +14012,6 @@ components:
audienceId:
description: The internal ID of the audience.
example: 10
- format: int64
type: integer
audienceName:
description: The name of the audience.
@@ -13739,7 +14025,6 @@ components:
profileId:
description: The internal ID of the customer profile.
example: 150
- format: int64
type: integer
type: object
RemoveFromAudienceEffectProps:
@@ -13749,7 +14034,6 @@ components:
audienceId:
description: The internal ID of the audience.
example: 10
- format: int64
type: integer
audienceName:
description: The name of the audience.
@@ -13763,7 +14047,6 @@ components:
profileId:
description: The internal ID of the customer profile.
example: 150
- format: int64
type: integer
type: object
IncreaseAchievementProgressEffectProps:
@@ -13774,7 +14057,6 @@ components:
achievementId:
description: The internal ID of the achievement.
example: 10
- format: int64
type: integer
achievementName:
description: The name of the achievement.
@@ -13782,7 +14064,6 @@ components:
type: string
progressTrackerId:
description: The internal ID of the achievement progress tracker.
- format: int64
type: integer
delta:
description: The value by which the customer's current progress in the achievement
@@ -13815,7 +14096,6 @@ components:
achievementId:
description: The internal ID of the achievement.
example: 10
- format: int64
type: integer
achievementName:
description: The name of the achievement.
@@ -13823,7 +14103,6 @@ components:
type: string
progressTrackerId:
description: The internal ID of the achievement progress tracker.
- format: int64
type: integer
decreaseProgressBy:
description: The value by which the customer's current progress in the achievement
@@ -13843,6 +14122,58 @@ components:
- progressTrackerId
- target
type: object
+ ExtendLoyaltyPointsExpiryDateEffectProps:
+ description: |
+ The properties specific to the "extendLoyaltyPointsExpiryDate" effect. This gets triggered when a validated rule contains the "extend expiry date" effect. The current expiry date gets extended by the time frame given in the effect.
+ properties:
+ programId:
+ description: ID of the loyalty program that contains these points.
+ type: integer
+ subLedgerId:
+ description: API name of the loyalty program subledger that contains these
+ points. added.
+ type: string
+ extensionDuration:
+ description: |
+ Time frame by which the expiry date extends.
+
+ The time format is either:
+ - immediate, or
+ - an **integer** followed by a letter indicating the time unit.
+
+ Examples: `immediate`, `30s`, `40m`, `1h`, `5D`, `7W`, `10M`, `15Y`.
+
+ Available units:
+
+ - `s`: seconds
+ - `m`: minutes
+ - `h`: hours
+ - `D`: days
+ - `W`: weeks
+ - `M`: months
+ - `Y`: years
+
+ You can round certain units up or down:
+ - `_D` for rounding down days only. Signifies the start of the day.
+ - `_U` for rounding up days, weeks, months and years. Signifies the end of the day, week, month or year.
+ example: 12h
+ type: string
+ transactionUUIDs:
+ description: The list of identifiers of transactions affected affected by
+ the extension.
+ items:
+ type: string
+ type: array
+ previousExpirationDate:
+ description: Expiry date before applying the extension.
+ format: date-time
+ type: string
+ required:
+ - extensionDuration
+ - previousExpirationDate
+ - programId
+ - subLedgerId
+ type: object
EffectProps:
description: The properties of the effect. See [API effects](https://docs.talon.one/docs/dev/integration-api/api-effects).
type: object
@@ -13857,9 +14188,12 @@ components:
conditionIndex: 786
evaluationGroupMode: stackable
effectType: rejectCoupon
+ adjustmentReferenceId: 68851723-e6fa-488f-ace9-112581e6c19b
props: '{}'
+ selectedPrice: 100.0
evaluationGroupID: 3
triggeredForCatalogItem: 786
+ selectedPriceType: member
campaignRevisionId: 1
ruleName: Give 20% discount
triggeredByCoupon: 4928
@@ -13867,19 +14201,16 @@ components:
campaignId:
description: The ID of the campaign that triggered this effect.
example: 244
- format: int64
type: integer
rulesetId:
description: The ID of the ruleset that was active in the campaign when
this effect was triggered.
example: 73
- format: int64
type: integer
ruleIndex:
description: The position of the rule that triggered this effect within
the ruleset.
example: 2
- format: int64
type: integer
ruleName:
description: The name of the rule that triggered this effect.
@@ -13893,24 +14224,20 @@ components:
description: The ID of the coupon that was being evaluated when this effect
was triggered.
example: 4928
- format: int64
type: integer
triggeredForCatalogItem:
description: The ID of the catalog item that was being evaluated when this
effect was triggered.
example: 786
- format: int64
type: integer
conditionIndex:
description: The index of the condition that was triggered.
example: 786
- format: int64
type: integer
evaluationGroupID:
description: The ID of the evaluation group. For more information, see [Managing
campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation).
example: 3
- format: int64
type: integer
evaluationGroupMode:
description: The evaluation mode of the evaluation group. For more information,
@@ -13921,14 +14248,28 @@ components:
description: The revision ID of the campaign that was used when triggering
the effect.
example: 1
- format: int64
type: integer
campaignRevisionVersionId:
description: The revision version ID of the campaign that was used when
triggering the effect.
example: 5
- format: int64
type: integer
+ selectedPriceType:
+ description: The selected price type for the SKU targeted by this effect.
+ example: member
+ type: string
+ selectedPrice:
+ description: The value of the selected price type to apply to the SKU targeted
+ by this effect, before any discounts are applied.
+ example: 100.0
+ type: number
+ adjustmentReferenceId:
+ description: The reference identifier of the selected price adjustment for
+ this SKU. This is only returned if the `selectedPrice` resulted from a
+ price adjustment.
+ example: 68851723-e6fa-488f-ace9-112581e6c19b
+ format: uuid
+ type: string
props:
description: The properties of the effect. See [API effects](https://docs.talon.one/docs/dev/integration-api/api-effects).
type: object
@@ -13950,9 +14291,12 @@ components:
conditionIndex: 786
evaluationGroupMode: stackable
effectType: rejectCoupon
+ adjustmentReferenceId: 68851723-e6fa-488f-ace9-112581e6c19b
props: '{}'
+ selectedPrice: 100.0
evaluationGroupID: 3
triggeredForCatalogItem: 786
+ selectedPriceType: member
campaignRevisionId: 1
ruleName: Give 20% discount
triggeredByCoupon: 4928
@@ -13963,9 +14307,12 @@ components:
conditionIndex: 786
evaluationGroupMode: stackable
effectType: rejectCoupon
+ adjustmentReferenceId: 68851723-e6fa-488f-ace9-112581e6c19b
props: '{}'
+ selectedPrice: 100.0
evaluationGroupID: 3
triggeredForCatalogItem: 786
+ selectedPriceType: member
campaignRevisionId: 1
ruleName: Give 20% discount
triggeredByCoupon: 4928
@@ -14002,19 +14349,31 @@ components:
returnedQuantity: 1
length: 1.4658129805029452
weight: 1130.0
+ adjustmentReferenceId: 68851723-e6fa-488f-ace9-112581e6c19b
+ adjustmentEffectiveFrom: 2021-09-12T10:12:42Z
catalogItemID: 5
additionalCosts:
shipping:
price: 9
price: 99.99
+ selectedPriceType: member
name: Air Glide
width: 6.027456183070403
attributes:
image: 11.jpeg
material: leather
+ adjustmentEffectiveUntil: 2021-09-12T10:12:42Z
position: 5.962133916683182
sku: SKU1241028
category: shoes
+ prices:
+ member:
+ price: 90
+ adjustmentReferenceId: 68851723-e6fa-488f-ace9-112581e6c19b
+ effectiveFrom: 2025-05-25T00:00:00Z
+ effectiveUntil: 2025-05-30T00:00:00Z
+ base:
+ price: 100
height: 0.8008281904610115
- remainingQuantity: 1
product:
@@ -14023,19 +14382,31 @@ components:
returnedQuantity: 1
length: 1.4658129805029452
weight: 1130.0
+ adjustmentReferenceId: 68851723-e6fa-488f-ace9-112581e6c19b
+ adjustmentEffectiveFrom: 2021-09-12T10:12:42Z
catalogItemID: 5
additionalCosts:
shipping:
price: 9
price: 99.99
+ selectedPriceType: member
name: Air Glide
width: 6.027456183070403
attributes:
image: 11.jpeg
material: leather
+ adjustmentEffectiveUntil: 2021-09-12T10:12:42Z
position: 5.962133916683182
sku: SKU1241028
category: shoes
+ prices:
+ member:
+ price: 90
+ adjustmentReferenceId: 68851723-e6fa-488f-ace9-112581e6c19b
+ effectiveFrom: 2025-05-25T00:00:00Z
+ effectiveUntil: 2025-05-30T00:00:00Z
+ base:
+ price: 100
height: 0.8008281904610115
updated: 2020-02-08T14:15:22Z
firstSession: true
@@ -14108,7 +14479,6 @@ components:
type: array
StatusCode:
description: The error code
- format: int64
type: integer
type: object
IntegrationRequest:
@@ -14143,19 +14513,31 @@ components:
returnedQuantity: 1
length: 1.4658129805029452
weight: 1130.0
+ adjustmentReferenceId: 68851723-e6fa-488f-ace9-112581e6c19b
+ adjustmentEffectiveFrom: 2021-09-12T10:12:42Z
catalogItemID: 5
additionalCosts:
shipping:
price: 9
price: 99.99
+ selectedPriceType: member
name: Air Glide
width: 6.027456183070403
attributes:
image: 11.jpeg
material: leather
+ adjustmentEffectiveUntil: 2021-09-12T10:12:42Z
position: 5.962133916683182
sku: SKU1241028
category: shoes
+ prices:
+ member:
+ price: 90
+ adjustmentReferenceId: 68851723-e6fa-488f-ace9-112581e6c19b
+ effectiveFrom: 2025-05-25T00:00:00Z
+ effectiveUntil: 2025-05-30T00:00:00Z
+ base:
+ price: 100
height: 0.8008281904610115
- remainingQuantity: 1
product:
@@ -14164,19 +14546,31 @@ components:
returnedQuantity: 1
length: 1.4658129805029452
weight: 1130.0
+ adjustmentReferenceId: 68851723-e6fa-488f-ace9-112581e6c19b
+ adjustmentEffectiveFrom: 2021-09-12T10:12:42Z
catalogItemID: 5
additionalCosts:
shipping:
price: 9
price: 99.99
+ selectedPriceType: member
name: Air Glide
width: 6.027456183070403
attributes:
image: 11.jpeg
material: leather
+ adjustmentEffectiveUntil: 2021-09-12T10:12:42Z
position: 5.962133916683182
sku: SKU1241028
category: shoes
+ prices:
+ member:
+ price: 90
+ adjustmentReferenceId: 68851723-e6fa-488f-ace9-112581e6c19b
+ effectiveFrom: 2025-05-25T00:00:00Z
+ effectiveUntil: 2025-05-30T00:00:00Z
+ base:
+ price: 100
height: 0.8008281904610115
responseContent:
- customerSession
@@ -14210,6 +14604,21 @@ components:
required:
- customerSession
type: object
+ CustomerProfileEntity:
+ properties:
+ id:
+ description: The internal ID of the customer profile.
+ example: 6
+ type: integer
+ created:
+ description: The time the customer profile was created.
+ example: 2020-06-10T09:05:27.993483Z
+ format: date-time
+ type: string
+ required:
+ - created
+ - id
+ type: object
NewCustomerProfile:
properties:
attributes:
@@ -14234,7 +14643,6 @@ components:
loyaltyProgramId:
description: The ID of the loyalty program belonging to this entity.
example: 323414846
- format: int64
title: Loyalty program ID
type: integer
required:
@@ -14248,7 +14656,6 @@ components:
id:
description: The ID of the audience belonging to this entity.
example: 2
- format: int64
title: Audience ID
type: integer
name:
@@ -14285,9 +14692,8 @@ components:
id: 2
properties:
id:
- description: Internal ID of this entity.
+ description: The internal ID of the customer profile.
example: 6
- format: int64
type: integer
created:
description: The time this entity was created.
@@ -14310,14 +14716,12 @@ components:
accountId:
description: The ID of the Talon.One account that owns this profile.
example: 31
- format: int64
title: Profile belongs to Account
type: integer
closedSessions:
- description: The total amount of closed sessions by a customer. A closed
- session is a successful purchase.
+ description: The total number of closed sessions. Does not include closed
+ sessions that have been cancelled or reopened. See the [docs](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions#customer-session-states).
example: 3
- format: int64
title: Closed sessions
type: integer
totalSales:
@@ -14419,9 +14823,8 @@ components:
referenceId: 6
properties:
id:
- description: Internal ID of this entity.
+ description: The internal ID of this entity.
example: 6
- format: int64
type: integer
created:
description: The time this entity was created.
@@ -14437,22 +14840,18 @@ components:
type: string
accountId:
description: The ID of the Talon.One account that owns this profile.
- format: int64
type: integer
loyaltyProgramId:
description: ID of the ledger.
example: 323414846
- format: int64
type: integer
eventId:
description: ID of the related event.
example: 3
- format: int64
type: integer
amount:
description: Amount of loyalty points.
example: 100
- format: int64
type: integer
reason:
description: reason for awarding/deducting points.
@@ -14465,7 +14864,6 @@ components:
type: string
referenceId:
description: The ID of the balancing ledgerEntry.
- format: int64
type: integer
required:
- accountId
@@ -14489,11 +14887,9 @@ components:
properties:
campaignId:
example: 244
- format: int64
type: integer
couponId:
example: 4928
- format: int64
type: integer
reason:
enum:
@@ -14526,10 +14922,8 @@ components:
referralId: 5
properties:
campaignId:
- format: int64
type: integer
referralId:
- format: int64
type: integer
reason:
enum:
@@ -14633,9 +15027,8 @@ components:
type: pageViewed
properties:
id:
- description: Internal ID of this entity.
+ description: The internal ID of this entity.
example: 6
- format: int64
type: integer
created:
description: The time this entity was created.
@@ -14645,7 +15038,6 @@ components:
applicationId:
description: The ID of the Application that owns this entity.
example: 322
- format: int64
type: integer
profileId:
description: |
@@ -14708,7 +15100,6 @@ components:
programID:
description: The ID of the loyalty program that owns this entity.
example: 125
- format: int64
type: integer
programName:
description: The integration name of the loyalty program that owns this
@@ -14818,11 +15209,9 @@ components:
required:
- currentBalance
- expiredBalance
- - negativeBalance
- pendingBalance
- spentBalance
- tentativeCurrentBalance
- - tentativeNegativeBalance
type: object
Tier:
example:
@@ -14835,7 +15224,6 @@ components:
id:
description: The internal ID of the tier.
example: 11
- format: int64
type: integer
name:
description: The name of the tier.
@@ -14944,11 +15332,9 @@ components:
required:
- currentBalance
- expiredBalance
- - negativeBalance
- pendingBalance
- spentBalance
- tentativeCurrentBalance
- - tentativeNegativeBalance
type: object
LoyaltyCard:
example:
@@ -15005,9 +15391,8 @@ components:
status: active
properties:
id:
- description: Internal ID of this entity.
+ description: The internal ID of this entity.
example: 6
- format: int64
type: integer
created:
description: The time this entity was created.
@@ -15017,7 +15402,6 @@ components:
programID:
description: The ID of the loyalty program that owns this entity.
example: 125
- format: int64
type: integer
programName:
description: The integration name of the loyalty program that owns this
@@ -15050,7 +15434,6 @@ components:
description: |
The max amount of customer profiles that can be linked to the card. 0 means unlimited.
example: 111
- format: int64
minimum: 0
type: integer
profiles:
@@ -15141,7 +15524,6 @@ components:
id:
description: The internal ID of loyalty program.
example: 5
- format: int64
type: integer
title:
description: Visible name of loyalty program.
@@ -15352,7 +15734,6 @@ components:
description: |
The number of times a referral code can be used. `0` means no limit but any campaign usage limits will still apply.
example: 1
- format: int64
maximum: 999999
minimum: 0
title: Referral code Usage Limit
@@ -15386,7 +15767,6 @@ components:
description: |
The number of times a referral code can be used. `0` means no limit but any campaign usage limits will still apply.
example: 1
- format: int64
maximum: 999999
minimum: 0
title: Referral code Usage Limit
@@ -15395,7 +15775,6 @@ components:
description: ID of the campaign from which the referral received the referral
code.
example: 78
- format: int64
title: Referral's Campaign ID
type: integer
advocateProfileIntegrationId:
@@ -15424,7 +15803,6 @@ components:
importId:
description: The ID of the Import which created this referral.
example: 4
- format: int64
type: integer
type: object
Referral:
@@ -15445,9 +15823,8 @@ components:
startDate: 2020-11-10T23:00:00Z
properties:
id:
- description: Internal ID of this entity.
+ description: The internal ID of this entity.
example: 6
- format: int64
type: integer
created:
description: The time this entity was created.
@@ -15471,7 +15848,6 @@ components:
description: |
The number of times a referral code can be used. `0` means no limit but any campaign usage limits will still apply.
example: 1
- format: int64
maximum: 999999
minimum: 0
title: Referral code Usage Limit
@@ -15480,7 +15856,6 @@ components:
description: ID of the campaign from which the referral received the referral
code.
example: 78
- format: int64
title: Referral's Campaign ID
type: integer
advocateProfileIntegrationId:
@@ -15503,7 +15878,6 @@ components:
importId:
description: The ID of the Import which created this referral.
example: 4
- format: int64
type: integer
code:
description: The referral code.
@@ -15515,7 +15889,6 @@ components:
description: The number of times this referral code has been successfully
used.
example: 1
- format: int64
title: Referral code Usages
type: integer
batchId:
@@ -15553,9 +15926,8 @@ components:
startDate: 2020-11-10T23:00:00Z
properties:
id:
- description: Internal ID of this entity.
+ description: The internal ID of this entity.
example: 6
- format: int64
type: integer
created:
description: The time this entity was created.
@@ -15579,7 +15951,6 @@ components:
description: |
The number of times a referral code can be used. `0` means no limit but any campaign usage limits will still apply.
example: 1
- format: int64
maximum: 999999
minimum: 0
title: Referral code Usage Limit
@@ -15588,7 +15959,6 @@ components:
description: ID of the campaign from which the referral received the referral
code.
example: 78
- format: int64
title: Referral's Campaign ID
type: integer
advocateProfileIntegrationId:
@@ -15611,7 +15981,6 @@ components:
importId:
description: The ID of the Import which created this referral.
example: 4
- format: int64
type: integer
code:
description: The referral code.
@@ -15623,7 +15992,6 @@ components:
description: The number of times this referral code has been successfully
used.
example: 1
- format: int64
title: Referral code Usages
type: integer
batchId:
@@ -15646,12 +16014,26 @@ components:
- usageCounter
- usageLimit
type: object
+ CouponEntity:
+ properties:
+ id:
+ description: The internal ID of the coupon.
+ example: 6
+ type: integer
+ created:
+ description: The time the coupon was created.
+ example: 2020-06-10T09:05:27.993483Z
+ format: date-time
+ type: string
+ required:
+ - created
+ - id
+ type: object
CampaignEntity:
properties:
campaignId:
description: The ID of the campaign that owns this entity.
example: 211
- format: int64
title: Campaign ID
type: integer
required:
@@ -15672,7 +16054,6 @@ components:
description: |
The number of times the coupon code can be redeemed. `0` means unlimited redemptions but any campaign usage limits will still apply.
example: 100
- format: int64
maximum: 999999
minimum: 0
type: integer
@@ -15680,14 +16061,13 @@ components:
description: |
The total discount value that the code can give. Typically used to represent a gift card value.
example: 30.0
- maximum: 999999
+ maximum: 1E+15
minimum: 0
type: number
reservationLimit:
description: |
The number of reservations that can be made with this coupon code.
example: 45
- format: int64
maximum: 999999
minimum: 0
type: integer
@@ -15802,19 +16182,17 @@ components:
isReservationMandatory: false
properties:
id:
- description: Internal ID of this entity.
+ description: The internal ID of the coupon.
example: 6
- format: int64
type: integer
created:
- description: The time this entity was created.
+ description: The time the coupon was created.
example: 2020-06-10T09:05:27.993483Z
format: date-time
type: string
campaignId:
description: The ID of the campaign that owns this entity.
example: 211
- format: int64
title: Campaign ID
type: integer
value:
@@ -15827,7 +16205,6 @@ components:
description: |
The number of times the coupon code can be redeemed. `0` means unlimited redemptions but any campaign usage limits will still apply.
example: 100
- format: int64
maximum: 999999
minimum: 0
type: integer
@@ -15835,14 +16212,13 @@ components:
description: |
The total discount value that the code can give. Typically used to represent a gift card value.
example: 30.0
- maximum: 999999
+ maximum: 1E+15
minimum: 0
type: number
reservationLimit:
description: |
The number of reservations that can be made with this coupon code.
example: 45
- format: int64
maximum: 999999
minimum: 0
type: integer
@@ -15870,7 +16246,6 @@ components:
usageCounter:
description: The number of times the coupon has been successfully redeemed.
example: 10
- format: int64
title: Total coupon redemptions
type: integer
discountCounter:
@@ -15898,7 +16273,6 @@ components:
description: The integration ID of the referring customer (if any) for whom
this coupon was created as an effect.
example: 326632952
- format: int64
title: Advocate ID
type: integer
recipientIntegrationId:
@@ -15911,7 +16285,6 @@ components:
importId:
description: The ID of the Import which created this coupon.
example: 4
- format: int64
title: Import ID
type: integer
reservation:
@@ -15986,19 +16359,17 @@ components:
isReservationMandatory: false
properties:
id:
- description: Internal ID of this entity.
+ description: The internal ID of the coupon.
example: 6
- format: int64
type: integer
created:
- description: The time this entity was created.
+ description: The time the coupon was created.
example: 2020-06-10T09:05:27.993483Z
format: date-time
type: string
campaignId:
description: The ID of the campaign that owns this entity.
example: 211
- format: int64
title: Campaign ID
type: integer
value:
@@ -16011,7 +16382,6 @@ components:
description: |
The number of times the coupon code can be redeemed. `0` means unlimited redemptions but any campaign usage limits will still apply.
example: 100
- format: int64
maximum: 999999
minimum: 0
type: integer
@@ -16019,14 +16389,13 @@ components:
description: |
The total discount value that the code can give. Typically used to represent a gift card value.
example: 30.0
- maximum: 999999
+ maximum: 1E+15
minimum: 0
type: number
reservationLimit:
description: |
The number of reservations that can be made with this coupon code.
example: 45
- format: int64
maximum: 999999
minimum: 0
type: integer
@@ -16054,7 +16423,6 @@ components:
usageCounter:
description: The number of times the coupon has been successfully redeemed.
example: 10
- format: int64
title: Total coupon redemptions
type: integer
discountCounter:
@@ -16082,7 +16450,6 @@ components:
description: The integration ID of the referring customer (if any) for whom
this coupon was created as an effect.
example: 326632952
- format: int64
title: Advocate ID
type: integer
recipientIntegrationId:
@@ -16095,7 +16462,6 @@ components:
importId:
description: The ID of the Import which created this coupon.
example: 4
- format: int64
title: Import ID
type: integer
reservation:
@@ -16128,7 +16494,6 @@ components:
profileRedemptionCount:
description: The number of times the coupon was redeemed by the profile.
example: 5
- format: int64
title: Coupon redemptions for the profile
type: integer
required:
@@ -16145,7 +16510,6 @@ components:
id:
description: Unique ID for this entity.
example: 4
- format: int64
type: integer
created:
description: The exact moment this entity was created.
@@ -16161,7 +16525,6 @@ components:
userId:
description: The ID of the user associated with this entity.
example: 388
- format: int64
type: integer
required:
- userId
@@ -16304,7 +16667,6 @@ components:
[ID of Ruleset](https://docs.talon.one/management-api#operation/getRulesets) this
campaign applies on customer session evaluation.
example: 6
- format: int64
type: integer
tags:
description: A list of tags for the campaign.
@@ -16348,7 +16710,6 @@ components:
- 1
- 3
items:
- format: int64
type: integer
type: array
type:
@@ -16375,7 +16736,6 @@ components:
- 2
- 3
items:
- format: int64
type: integer
type: array
required:
@@ -16432,14 +16792,12 @@ components:
This property is **deprecated**. The count should be available under *budgets* property.
Number of coupons redeemed in the campaign.
example: 163
- format: int64
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
- format: int64
type: integer
discountCount:
description: |
@@ -16452,42 +16810,36 @@ components:
This property is **deprecated**. The count should be available under *budgets* property.
Total number of times discounts were redeemed in this campaign.
example: 343
- format: int64
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
- format: int64
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
- format: int64
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
- format: int64
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
- format: int64
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
- format: int64
type: integer
createdLoyaltyPointsCount:
description: |
@@ -16500,7 +16852,6 @@ components:
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
- format: int64
type: integer
redeemedLoyaltyPointsCount:
description: |
@@ -16513,21 +16864,18 @@ components:
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
- format: int64
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
- format: int64
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
- format: int64
type: integer
lastActivity:
description: Timestamp of the most recent event received by this campaign.
@@ -16551,7 +16899,6 @@ components:
templateId:
description: The ID of the Campaign Template this Campaign was created from.
example: 3
- format: int64
type: integer
frontendState:
description: The campaign state displayed in the Campaign Manager.
@@ -16575,7 +16922,6 @@ components:
- 100
- 215
items:
- format: int64
type: integer
type: array
required:
@@ -16595,31 +16941,26 @@ components:
description: |
ID of the revision that was last activated on this campaign.
example: 6
- format: int64
type: integer
activeRevisionVersionId:
description: |
ID of the revision version that is active on the campaign.
example: 6
- format: int64
type: integer
version:
description: |
Incrementing number representing how many revisions have been activated on this campaign, starts from 0 for a new campaign.
example: 6
- format: int64
type: integer
currentRevisionId:
description: |
ID of the revision currently being modified for the campaign.
example: 6
- format: int64
type: integer
currentRevisionVersionId:
description: |
ID of the latest version applied on the current revision.
example: 6
- format: int64
type: integer
stageRevision:
default: false
@@ -16786,7 +17127,6 @@ components:
id:
description: Unique ID for this entity.
example: 4
- format: int64
type: integer
created:
description: The exact moment this entity was created.
@@ -16796,12 +17136,10 @@ components:
applicationId:
description: The ID of the Application that owns this entity.
example: 322
- format: int64
type: integer
userId:
description: The ID of the user associated with this entity.
example: 388
- format: int64
type: integer
name:
description: A user-facing name for this campaign.
@@ -16843,7 +17181,6 @@ components:
[ID of Ruleset](https://docs.talon.one/management-api#operation/getRulesets) this
campaign applies on customer session evaluation.
example: 6
- format: int64
type: integer
tags:
description: A list of tags for the campaign.
@@ -16887,7 +17224,6 @@ components:
- 1
- 3
items:
- format: int64
type: integer
type: array
type:
@@ -16914,7 +17250,6 @@ components:
- 2
- 3
items:
- format: int64
type: integer
type: array
budgets:
@@ -16931,14 +17266,12 @@ components:
This property is **deprecated**. The count should be available under *budgets* property.
Number of coupons redeemed in the campaign.
example: 163
- format: int64
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
- format: int64
type: integer
discountCount:
description: |
@@ -16951,42 +17284,36 @@ components:
This property is **deprecated**. The count should be available under *budgets* property.
Total number of times discounts were redeemed in this campaign.
example: 343
- format: int64
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
- format: int64
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
- format: int64
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
- format: int64
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
- format: int64
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
- format: int64
type: integer
createdLoyaltyPointsCount:
description: |
@@ -16999,7 +17326,6 @@ components:
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
- format: int64
type: integer
redeemedLoyaltyPointsCount:
description: |
@@ -17012,21 +17338,18 @@ components:
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
- format: int64
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
- format: int64
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
- format: int64
type: integer
lastActivity:
description: Timestamp of the most recent event received by this campaign.
@@ -17050,7 +17373,6 @@ components:
templateId:
description: The ID of the Campaign Template this Campaign was created from.
example: 3
- format: int64
type: integer
frontendState:
description: The campaign state displayed in the Campaign Manager.
@@ -17074,7 +17396,6 @@ components:
- 100
- 215
items:
- format: int64
type: integer
type: array
revisionFrontendState:
@@ -17088,31 +17409,26 @@ components:
description: |
ID of the revision that was last activated on this campaign.
example: 6
- format: int64
type: integer
activeRevisionVersionId:
description: |
ID of the revision version that is active on the campaign.
example: 6
- format: int64
type: integer
version:
description: |
Incrementing number representing how many revisions have been activated on this campaign, starts from 0 for a new campaign.
example: 6
- format: int64
type: integer
currentRevisionId:
description: |
ID of the revision currently being modified for the campaign.
example: 6
- format: int64
type: integer
currentRevisionVersionId:
description: |
ID of the latest version applied on the current revision.
example: 6
- format: int64
type: integer
stageRevision:
default: false
@@ -17155,20 +17471,17 @@ components:
properties:
campaignID:
description: The ID of the campaign that contains the rule that failed.
- format: int64
type: integer
campaignName:
description: The name of the campaign that contains the rule that failed.
type: string
rulesetID:
description: The ID of the ruleset that contains the rule that failed.
- format: int64
type: integer
couponID:
description: The ID of the coupon that was being evaluated at the time of
the rule failure.
example: 4928
- format: int64
type: integer
couponValue:
description: The code of the coupon that was being evaluated at the time
@@ -17177,7 +17490,6 @@ components:
referralID:
description: The ID of the referral that was being evaluated at the time
of the rule failure.
- format: int64
type: integer
referralValue:
description: The code of the referral that was being evaluated at the time
@@ -17185,18 +17497,15 @@ components:
type: string
ruleIndex:
description: The index of the rule that failed within the ruleset.
- format: int64
type: integer
ruleName:
description: The name of the rule that failed within the ruleset.
type: string
conditionIndex:
description: The index of the condition that failed.
- format: int64
type: integer
effectIndex:
description: The index of the effect that failed.
- format: int64
type: integer
details:
description: More details about the failure.
@@ -17205,7 +17514,6 @@ components:
description: The ID of the evaluation group. For more information, see [Managing
campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation).
example: 3
- format: int64
type: integer
evaluationGroupMode:
description: The evaluation mode of the evaluation group. For more information,
@@ -17234,9 +17542,8 @@ components:
startDate: 2000-01-23T04:56:07.000+00:00
properties:
id:
- description: Internal ID of this entity.
+ description: The internal ID of this entity.
example: 6
- format: int64
type: integer
created:
description: The time this entity was created.
@@ -17250,7 +17557,6 @@ components:
poolId:
description: The ID of the pool to return giveaway codes from.
example: 1
- format: int64
type: integer
startDate:
description: Timestamp at which point the giveaway becomes valid.
@@ -17271,7 +17577,6 @@ components:
importId:
description: The ID of the Import which created this giveaway.
example: 4
- format: int64
type: integer
profileIntegrationId:
description: The third-party integration ID of the customer profile that
@@ -17282,7 +17587,6 @@ components:
description: The internal ID of the customer profile that was awarded the
giveaway, if the giveaway was awarded and an internal ID exists.
example: 1
- format: int64
type: integer
required:
- code
@@ -17295,7 +17599,6 @@ components:
accountId:
description: The ID of the account that owns this entity.
example: 3886
- format: int64
type: integer
required:
- accountId
@@ -17309,13 +17612,11 @@ components:
description: The index of the cart item in the provided customer session's
`cartItems` property.
example: 2
- format: int64
type: integer
quantity:
description: |
Number of cart items to return.
example: 1
- format: int64
type: integer
required:
- position
@@ -17355,9 +17656,8 @@ components:
applicationId: 322
properties:
id:
- description: Internal ID of this entity.
+ description: The internal ID of this entity.
example: 6
- format: int64
type: integer
created:
description: The time this entity was created.
@@ -17367,12 +17667,10 @@ components:
applicationId:
description: The ID of the Application that owns this entity.
example: 322
- format: int64
type: integer
accountId:
description: The ID of the account that owns this entity.
example: 3886
- format: int64
type: integer
returnedCartItems:
description: List of cart items to be returned.
@@ -17382,13 +17680,11 @@ components:
eventId:
description: The event ID of that was generated for this return.
example: 123
- format: int64
title: Event ID
type: integer
sessionId:
description: The internal ID of the session this return was requested on.
example: 123
- format: int64
title: Session ID
type: integer
sessionIntegrationId:
@@ -17401,7 +17697,6 @@ components:
profileId:
description: The internal ID of the profile this return was requested on.
example: 123
- format: int64
title: Profile ID
type: integer
profileIntegrationId:
@@ -17414,7 +17709,6 @@ components:
createdBy:
description: ID of the user who requested this return.
example: 123
- format: int64
title: Created By
type: integer
required:
@@ -17721,9 +18015,12 @@ components:
conditionIndex: 786
evaluationGroupMode: stackable
effectType: rejectCoupon
+ adjustmentReferenceId: 68851723-e6fa-488f-ace9-112581e6c19b
props: '{}'
+ selectedPrice: 100.0
evaluationGroupID: 3
triggeredForCatalogItem: 786
+ selectedPriceType: member
campaignRevisionId: 1
ruleName: Give 20% discount
triggeredByCoupon: 4928
@@ -17734,9 +18031,12 @@ components:
conditionIndex: 786
evaluationGroupMode: stackable
effectType: rejectCoupon
+ adjustmentReferenceId: 68851723-e6fa-488f-ace9-112581e6c19b
props: '{}'
+ selectedPrice: 100.0
evaluationGroupID: 3
triggeredForCatalogItem: 786
+ selectedPriceType: member
campaignRevisionId: 1
ruleName: Give 20% discount
triggeredByCoupon: 4928
@@ -18163,19 +18463,31 @@ components:
returnedQuantity: 1
length: 1.4658129805029452
weight: 1130.0
+ adjustmentReferenceId: 68851723-e6fa-488f-ace9-112581e6c19b
+ adjustmentEffectiveFrom: 2021-09-12T10:12:42Z
catalogItemID: 5
additionalCosts:
shipping:
price: 9
price: 99.99
+ selectedPriceType: member
name: Air Glide
width: 6.027456183070403
attributes:
image: 11.jpeg
material: leather
+ adjustmentEffectiveUntil: 2021-09-12T10:12:42Z
position: 5.962133916683182
sku: SKU1241028
category: shoes
+ prices:
+ member:
+ price: 90
+ adjustmentReferenceId: 68851723-e6fa-488f-ace9-112581e6c19b
+ effectiveFrom: 2025-05-25T00:00:00Z
+ effectiveUntil: 2025-05-30T00:00:00Z
+ base:
+ price: 100
height: 0.8008281904610115
- remainingQuantity: 1
product:
@@ -18184,19 +18496,31 @@ components:
returnedQuantity: 1
length: 1.4658129805029452
weight: 1130.0
+ adjustmentReferenceId: 68851723-e6fa-488f-ace9-112581e6c19b
+ adjustmentEffectiveFrom: 2021-09-12T10:12:42Z
catalogItemID: 5
additionalCosts:
shipping:
price: 9
price: 99.99
+ selectedPriceType: member
name: Air Glide
width: 6.027456183070403
attributes:
image: 11.jpeg
material: leather
+ adjustmentEffectiveUntil: 2021-09-12T10:12:42Z
position: 5.962133916683182
sku: SKU1241028
category: shoes
+ prices:
+ member:
+ price: 90
+ adjustmentReferenceId: 68851723-e6fa-488f-ace9-112581e6c19b
+ effectiveFrom: 2025-05-25T00:00:00Z
+ effectiveUntil: 2025-05-30T00:00:00Z
+ base:
+ price: 100
height: 0.8008281904610115
updated: 2020-02-08T14:15:22Z
firstSession: true
@@ -18426,9 +18750,12 @@ components:
conditionIndex: 786
evaluationGroupMode: stackable
effectType: rejectCoupon
+ adjustmentReferenceId: 68851723-e6fa-488f-ace9-112581e6c19b
props: '{}'
+ selectedPrice: 100.0
evaluationGroupID: 3
triggeredForCatalogItem: 786
+ selectedPriceType: member
campaignRevisionId: 1
ruleName: Give 20% discount
triggeredByCoupon: 4928
@@ -18439,9 +18766,12 @@ components:
conditionIndex: 786
evaluationGroupMode: stackable
effectType: rejectCoupon
+ adjustmentReferenceId: 68851723-e6fa-488f-ace9-112581e6c19b
props: '{}'
+ selectedPrice: 100.0
evaluationGroupID: 3
triggeredForCatalogItem: 786
+ selectedPriceType: member
campaignRevisionId: 1
ruleName: Give 20% discount
triggeredByCoupon: 4928
@@ -18469,7 +18799,6 @@ components:
- 2
- 4
items:
- format: int64
type: integer
title: Audiences to join
type: array
@@ -18478,7 +18807,6 @@ components:
example:
- 7
items:
- format: int64
type: integer
title: Audiences to leave
type: array
@@ -18523,7 +18851,6 @@ components:
- 10
- 12
items:
- format: int64
type: integer
title: Campaigns to evaluate
type: array
@@ -18559,9 +18886,12 @@ components:
conditionIndex: 786
evaluationGroupMode: stackable
effectType: rejectCoupon
+ adjustmentReferenceId: 68851723-e6fa-488f-ace9-112581e6c19b
props: '{}'
+ selectedPrice: 100.0
evaluationGroupID: 3
triggeredForCatalogItem: 786
+ selectedPriceType: member
campaignRevisionId: 1
ruleName: Give 20% discount
triggeredByCoupon: 4928
@@ -18572,9 +18902,12 @@ components:
conditionIndex: 786
evaluationGroupMode: stackable
effectType: rejectCoupon
+ adjustmentReferenceId: 68851723-e6fa-488f-ace9-112581e6c19b
props: '{}'
+ selectedPrice: 100.0
evaluationGroupID: 3
triggeredForCatalogItem: 786
+ selectedPriceType: member
campaignRevisionId: 1
ruleName: Give 20% discount
triggeredByCoupon: 4928
@@ -19496,12 +19829,10 @@ components:
accountId:
description: The ID of the account that owns this entity.
example: 3886
- format: int64
type: integer
id:
- description: Internal ID of this entity.
+ description: The internal ID of this entity.
example: 6
- format: int64
type: integer
created:
description: The time this entity was created.
@@ -19594,7 +19925,6 @@ components:
description: The ID of the audience. You get it via the `id` property when
[creating an audience](#operation/createAudienceV2).
example: 748
- format: int64
type: integer
required:
- action
@@ -19636,6 +19966,42 @@ components:
required:
- integrationId
type: object
+ IntegrationCustomerProfileAudienceRequestItem:
+ properties:
+ action:
+ description: |
+ Defines the action to perform:
+ - `add`: Adds the customer profile to the audience.
+
+ **Note**: If the customer profile does not exist, it will be created. The profile will not be visible in any Application
+ until a session or profile update is received for that profile.
+ - `delete`: Removes the customer profile from the audience.
+ enum:
+ - add
+ - delete
+ example: add
+ type: string
+ profileIntegrationId:
+ description: The ID of this customer profile in the third-party integration.
+ example: R195412
+ maxLength: 1000
+ type: string
+ integrationId:
+ description: The ID of this audience in the third-party integration.
+ example: 382370BKDB946
+ type: string
+ required:
+ - action
+ - integrationId
+ - profileIntegrationId
+ type: object
+ IntegrationCustomerProfileAudienceRequest:
+ properties:
+ data:
+ items:
+ $ref: '#/components/schemas/IntegrationCustomerProfileAudienceRequestItem'
+ type: array
+ type: object
NewAttribute:
example:
editable: true
@@ -19751,7 +20117,6 @@ components:
- 4
- 9
items:
- format: int64
type: integer
type: array
subscribedCatalogsIds:
@@ -19760,7 +20125,6 @@ components:
- 2
- 5
items:
- format: int64
type: integer
type: array
allowedSubscriptions:
@@ -19820,9 +20184,8 @@ components:
entity: Event
properties:
id:
- description: Internal ID of this entity.
+ description: The internal ID of this entity.
example: 6
- format: int64
type: integer
created:
description: The time this entity was created.
@@ -19832,7 +20195,6 @@ components:
accountId:
description: The ID of the account that owns this entity.
example: 3886
- format: int64
type: integer
entity:
description: The name of the entity that can have this attribute. When creating
@@ -19921,7 +20283,6 @@ components:
- 4
- 9
items:
- format: int64
type: integer
type: array
subscribedCatalogsIds:
@@ -19930,7 +20291,6 @@ components:
- 2
- 5
items:
- format: int64
type: integer
type: array
allowedSubscriptions:
@@ -19950,7 +20310,6 @@ components:
type: array
eventTypeId:
example: 22
- format: int64
type: integer
required:
- accountId
@@ -19964,128 +20323,6 @@ components:
- title
- type
type: object
- EventV2:
- properties:
- profileId:
- description: |
- ID of the customer profile set by your integration layer.
-
- **Note:** If the customer does not yet have a known `profileId`, we recommend you use a guest `profileId`.
- example: URNGV8294NV
- type: string
- storeIntegrationId:
- description: The integration ID of the store. You choose this ID when you
- create a store.
- example: STORE-001
- maxLength: 1000
- minLength: 1
- type: string
- evaluableCampaignIds:
- description: |
- 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.
- example:
- - 10
- - 12
- items:
- format: int64
- type: integer
- title: Campaigns to evaluate
- type: array
- type:
- description: |
- A string representing the event name. Must not be a reserved event name. You create this value when you [create an attribute](https://docs.talon.one/docs/dev/concepts/entities/events#creating-a-custom-event) of type `event` in the Campaign Manager.
- example: pageViewed
- minLength: 1
- title: Event Type
- type: string
- attributes:
- description: Arbitrary additional JSON properties associated with the event.
- They must be created in the Campaign Manager before setting them with
- this property. See [creating custom attributes](https://docs.talon.one/docs/product/account/dev-tools/managing-attributes#creating-a-custom-attribute).
- example:
- myAttribute: myValue
- properties: {}
- type: object
- required:
- - type
- type: object
- IntegrationEventV2Request:
- example:
- storeIntegrationId: STORE-001
- profileId: URNGV8294NV
- evaluableCampaignIds:
- - 10
- - 12
- attributes:
- myAttribute: myValue
- type: pageViewed
- responseContent:
- - triggeredCampaigns
- - customerProfile
- properties:
- profileId:
- description: |
- ID of the customer profile set by your integration layer.
-
- **Note:** If the customer does not yet have a known `profileId`, we recommend you use a guest `profileId`.
- example: URNGV8294NV
- type: string
- storeIntegrationId:
- description: The integration ID of the store. You choose this ID when you
- create a store.
- example: STORE-001
- maxLength: 1000
- minLength: 1
- type: string
- evaluableCampaignIds:
- description: |
- 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.
- example:
- - 10
- - 12
- items:
- format: int64
- type: integer
- title: Campaigns to evaluate
- type: array
- type:
- description: |
- A string representing the event name. Must not be a reserved event name. You create this value when you [create an attribute](https://docs.talon.one/docs/dev/concepts/entities/events#creating-a-custom-event) of type `event` in the Campaign Manager.
- example: pageViewed
- minLength: 1
- title: Event Type
- type: string
- attributes:
- description: Arbitrary additional JSON properties associated with the event.
- They must be created in the Campaign Manager before setting them with
- this property. See [creating custom attributes](https://docs.talon.one/docs/product/account/dev-tools/managing-attributes#creating-a-custom-attribute).
- example:
- myAttribute: myValue
- properties: {}
- type: object
- responseContent:
- description: |
- Optional list of requested information to be present on the response related to the tracking custom event.
- example:
- - triggeredCampaigns
- - customerProfile
- items:
- enum:
- - customerProfile
- - triggeredCampaigns
- - loyalty
- - event
- - awardedGiveaways
- - ruleFailureReasons
- type: string
- type: array
- required:
- - type
- type: object
GetIntegrationCouponRequest:
properties:
campaignIds:
@@ -20095,13 +20332,10 @@ components:
- 2
- 3
items:
- format: int64
type: integer
type: array
limit:
- default: 10
description: The maximum number of coupons included in the response.
- format: int64
maximum: 1E+3
minimum: 1
type: integer
@@ -20147,19 +20381,17 @@ components:
isReservationMandatory: false
properties:
id:
- description: Internal ID of this entity.
+ description: The internal ID of the coupon.
example: 6
- format: int64
type: integer
created:
- description: The time this entity was created.
+ description: The time the coupon was created.
example: 2020-06-10T09:05:27.993483Z
format: date-time
type: string
campaignId:
description: The ID of the campaign that owns this entity.
example: 211
- format: int64
title: Campaign ID
type: integer
value:
@@ -20172,7 +20404,6 @@ components:
description: |
The number of times the coupon code can be redeemed. `0` means unlimited redemptions but any campaign usage limits will still apply.
example: 100
- format: int64
maximum: 999999
minimum: 0
type: integer
@@ -20180,14 +20411,13 @@ components:
description: |
The total discount value that the code can give. Typically used to represent a gift card value.
example: 30.0
- maximum: 999999
+ maximum: 1E+15
minimum: 0
type: number
reservationLimit:
description: |
The number of reservations that can be made with this coupon code.
example: 45
- format: int64
maximum: 999999
minimum: 0
type: integer
@@ -20215,7 +20445,6 @@ components:
usageCounter:
description: The number of times the coupon has been successfully redeemed.
example: 10
- format: int64
title: Total coupon redemptions
type: integer
discountCounter:
@@ -20243,7 +20472,6 @@ components:
description: The integration ID of the referring customer (if any) for whom
this coupon was created as an effect.
example: 326632952
- format: int64
title: Advocate ID
type: integer
recipientIntegrationId:
@@ -20256,7 +20484,6 @@ components:
importId:
description: The ID of the Import which created this coupon.
example: 4
- format: int64
title: Import ID
type: integer
reservation:
@@ -20289,7 +20516,6 @@ components:
profileRedemptionCount:
description: The number of times the coupon was redeemed by the profile.
example: 5
- format: int64
title: Number of coupon usages per profile
type: integer
state:
@@ -20315,6 +20541,136 @@ components:
- usageLimit
- value
type: object
+ EventV2:
+ properties:
+ profileId:
+ description: |
+ ID of the customer profile set by your integration layer.
+
+ **Note:** If the customer does not yet have a known `profileId`, we recommend you use a guest `profileId`.
+ example: URNGV8294NV
+ type: string
+ storeIntegrationId:
+ description: The integration ID of the store. You choose this ID when you
+ create a store.
+ example: STORE-001
+ maxLength: 1000
+ minLength: 1
+ type: string
+ evaluableCampaignIds:
+ description: |
+ 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.
+ example:
+ - 10
+ - 12
+ items:
+ type: integer
+ title: Campaigns to evaluate
+ type: array
+ type:
+ description: |
+ A string representing the event name. Must not be a reserved event name. You create this value when you [create an attribute](https://docs.talon.one/docs/dev/concepts/entities/events#creating-a-custom-event) of type `event` in the Campaign Manager.
+ example: pageViewed
+ minLength: 1
+ title: Event Type
+ type: string
+ attributes:
+ description: Arbitrary additional JSON properties associated with the event.
+ They must be created in the Campaign Manager before setting them with
+ this property. See [creating custom attributes](https://docs.talon.one/docs/product/account/dev-tools/managing-attributes#creating-a-custom-attribute).
+ example:
+ myAttribute: myValue
+ properties: {}
+ type: object
+ required:
+ - type
+ type: object
+ IntegrationEventV2Request:
+ example:
+ loyaltyCards:
+ - loyalty-card-1
+ storeIntegrationId: STORE-001
+ profileId: URNGV8294NV
+ evaluableCampaignIds:
+ - 10
+ - 12
+ attributes:
+ myAttribute: myValue
+ type: pageViewed
+ responseContent:
+ - triggeredCampaigns
+ - customerProfile
+ properties:
+ profileId:
+ description: |
+ ID of the customer profile set by your integration layer.
+
+ **Note:** If the customer does not yet have a known `profileId`, we recommend you use a guest `profileId`.
+ example: URNGV8294NV
+ type: string
+ storeIntegrationId:
+ description: The integration ID of the store. You choose this ID when you
+ create a store.
+ example: STORE-001
+ maxLength: 1000
+ minLength: 1
+ type: string
+ evaluableCampaignIds:
+ description: |
+ 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.
+ example:
+ - 10
+ - 12
+ items:
+ type: integer
+ title: Campaigns to evaluate
+ type: array
+ type:
+ description: |
+ A string representing the event name. Must not be a reserved event name. You create this value when you [create an attribute](https://docs.talon.one/docs/dev/concepts/entities/events#creating-a-custom-event) of type `event` in the Campaign Manager.
+ example: pageViewed
+ minLength: 1
+ title: Event Type
+ type: string
+ attributes:
+ description: Arbitrary additional JSON properties associated with the event.
+ They must be created in the Campaign Manager before setting them with
+ this property. See [creating custom attributes](https://docs.talon.one/docs/product/account/dev-tools/managing-attributes#creating-a-custom-attribute).
+ example:
+ myAttribute: myValue
+ properties: {}
+ type: object
+ loyaltyCards:
+ description: Identifier of the loyalty card used during this event.
+ example:
+ - loyalty-card-1
+ items:
+ type: string
+ maxItems: 1
+ type: array
+ responseContent:
+ description: |
+ Optional list of requested information to be present on the response related to the tracking custom event.
+ example:
+ - triggeredCampaigns
+ - customerProfile
+ items:
+ enum:
+ - customerProfile
+ - triggeredCampaigns
+ - loyalty
+ - event
+ - awardedGiveaways
+ - ruleFailureReasons
+ type: string
+ type: array
+ required:
+ - type
+ type: object
AddLoyaltyPoints:
description: Points to add.
example:
@@ -20412,7 +20768,6 @@ components:
description: ID of the Application that is connected to the loyalty program.
It is displayed in your Talon.One deployment URL.
example: 322
- format: int64
type: integer
required:
- points
@@ -20543,12 +20898,10 @@ components:
campaigns will be added unless a different group is selected when creating
the campaign.
example: 3
- format: int64
type: integer
defaultCartItemFilterId:
description: The ID of the default Cart-Item-Filter for this application.
example: 3
- format: int64
type: integer
enableCampaignStateManagement:
description: |
@@ -20579,7 +20932,6 @@ components:
- 132
- 97
items:
- format: int64
type: integer
type: array
defaultValidity:
@@ -20607,7 +20959,6 @@ components:
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
- format: int64
minimum: 0
type: integer
sandbox:
@@ -20716,9 +21067,8 @@ components:
description: A tier in a loyalty program.
properties:
id:
- description: Internal ID of this entity.
+ description: The internal ID of this entity.
example: 6
- format: int64
type: integer
created:
description: The time this entity was created.
@@ -20728,7 +21078,6 @@ components:
programID:
description: The ID of the loyalty program that owns this entity.
example: 125
- format: int64
type: integer
programName:
description: The integration name of the loyalty program that owns this
@@ -20846,7 +21195,6 @@ components:
id:
description: The ID of loyalty program.
example: 139
- format: int64
type: integer
created:
description: The time this entity was created.
@@ -20868,7 +21216,6 @@ components:
- 132
- 97
items:
- format: int64
type: integer
type: array
defaultValidity:
@@ -20896,7 +21243,6 @@ components:
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
- format: int64
minimum: 0
type: integer
sandbox:
@@ -20986,7 +21332,6 @@ components:
accountID:
description: The ID of the Talon.One account that owns this program.
example: 1
- format: int64
type: integer
name:
description: The internal name for the Loyalty Program. This is an immutable
@@ -21277,9 +21622,8 @@ components:
enablePartialDiscounts: false
properties:
id:
- description: Internal ID of this entity.
+ description: The internal ID of this entity.
example: 6
- format: int64
type: integer
created:
description: The time this entity was created.
@@ -21294,7 +21638,6 @@ components:
accountId:
description: The ID of the account that owns this entity.
example: 3886
- format: int64
type: integer
name:
description: The name of this application.
@@ -21375,12 +21718,10 @@ components:
campaigns will be added unless a different group is selected when creating
the campaign.
example: 3
- format: int64
type: integer
defaultCartItemFilterId:
description: The ID of the default Cart-Item-Filter for this application.
example: 3
- format: int64
type: integer
enableCampaignStateManagement:
description: |
@@ -21456,9 +21797,8 @@ components:
MultipleAudiencesItem:
properties:
id:
- description: Internal ID of this entity.
+ description: The internal ID of this entity.
example: 6
- format: int64
type: integer
created:
description: The time this entity was created.
@@ -21497,7 +21837,6 @@ components:
accountId:
description: The ID of the account that owns this entity.
example: 3886
- format: int64
type: integer
audiences:
items:
@@ -21592,7 +21931,6 @@ components:
applicationId:
description: The ID of the Application that owns this entity.
example: 322
- format: int64
type: integer
profileId:
description: |
@@ -21764,9 +22102,12 @@ components:
conditionIndex: 786
evaluationGroupMode: stackable
effectType: rejectCoupon
+ adjustmentReferenceId: 68851723-e6fa-488f-ace9-112581e6c19b
props: '{}'
+ selectedPrice: 100.0
evaluationGroupID: 3
triggeredForCatalogItem: 786
+ selectedPriceType: member
campaignRevisionId: 1
ruleName: Give 20% discount
triggeredByCoupon: 4928
@@ -21777,9 +22118,12 @@ components:
conditionIndex: 786
evaluationGroupMode: stackable
effectType: rejectCoupon
+ adjustmentReferenceId: 68851723-e6fa-488f-ace9-112581e6c19b
props: '{}'
+ selectedPrice: 100.0
evaluationGroupID: 3
triggeredForCatalogItem: 786
+ selectedPriceType: member
campaignRevisionId: 1
ruleName: Give 20% discount
triggeredByCoupon: 4928
@@ -22540,7 +22884,6 @@ components:
description: |
The number of times a referral code can be used. `0` means no limit but any campaign usage limits will still apply.
example: 1
- format: int64
maximum: 999999
minimum: 0
title: Referral code Usage Limit
@@ -22549,7 +22892,6 @@ components:
description: The ID of the campaign from which the referral received the
referral code.
example: 45
- format: int64
title: Referral's Campaign ID
type: integer
advocateProfileIntegrationIds:
@@ -22720,7 +23062,6 @@ components:
achievementId:
description: The internal ID of the achievement.
example: 3
- format: int64
type: integer
name:
description: |
@@ -22742,7 +23083,6 @@ components:
campaignId:
description: The ID of the campaign the achievement belongs to.
example: 3
- format: int64
type: integer
target:
description: The required number of actions or the transactional milestone
@@ -22754,9 +23094,11 @@ components:
The policy that determines if and how the achievement recurs.
- `no_recurrence`: The achievement can be completed only once.
- `on_expiration`: The achievement resets after it expires and becomes available again.
+ - `on_completion`: When the customer progress status reaches `completed`, the achievement resets and becomes available again.
enum:
- no_recurrence
- on_expiration
+ - on_completion
example: no_recurrence
type: string
achievementActivationPolicy:
@@ -23161,7 +23503,6 @@ components:
**Note**: Only applicable if the period is set to `Y`.
example: 11
- format: int64
maximum: 12
minimum: 1
type: integer
@@ -23171,7 +23512,6 @@ components:
**Note**: Only applicable if the period is set to `Y` or `M`.
example: 23
- format: int64
maximum: 31
minimum: 1
type: integer
@@ -23180,24 +23520,20 @@ components:
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`.
- format: int64
maximum: 7
minimum: 1
type: integer
hour:
description: The achievement ends and resets at this hour.
example: 23
- format: int64
type: integer
minute:
description: The achievement ends and resets at this minute.
example: 59
- format: int64
type: integer
second:
description: The achievement ends and resets at this second.
example: 59
- format: int64
type: integer
required:
- hour
@@ -23266,9 +23602,11 @@ components:
The policy that determines if and how the achievement recurs.
- `no_recurrence`: The achievement can be completed only once.
- `on_expiration`: The achievement resets after it expires and becomes available again.
+ - `on_completion`: When the customer progress status reaches `completed`, the achievement resets and becomes available again.
enum:
- no_recurrence
- on_expiration
+ - on_completion
example: no_recurrence
type: string
activationPolicy:
@@ -23374,9 +23712,11 @@ components:
The policy that determines if and how the achievement recurs.
- `no_recurrence`: The achievement can be completed only once.
- `on_expiration`: The achievement resets after it expires and becomes available again.
+ - `on_completion`: When the customer progress status reaches `completed`, the achievement resets and becomes available again.
enum:
- no_recurrence
- on_expiration
+ - on_completion
example: no_recurrence
type: string
activationPolicy:
@@ -23438,9 +23778,8 @@ components:
status: active
properties:
id:
- description: Internal ID of this entity.
+ description: The internal ID of this entity.
example: 6
- format: int64
type: integer
created:
description: The time this entity was created.
@@ -23507,9 +23846,11 @@ components:
The policy that determines if and how the achievement recurs.
- `no_recurrence`: The achievement can be completed only once.
- `on_expiration`: The achievement resets after it expires and becomes available again.
+ - `on_completion`: When the customer progress status reaches `completed`, the achievement resets and becomes available again.
enum:
- no_recurrence
- on_expiration
+ - on_completion
example: no_recurrence
type: string
activationPolicy:
@@ -23539,7 +23880,6 @@ components:
campaignId:
description: The ID of the campaign the achievement belongs to.
example: 1
- format: int64
type: integer
status:
description: The status of the achievement.
@@ -23813,7 +24153,6 @@ components:
programId:
description: ID of the loyalty program.
example: 324
- format: int64
type: integer
cardIdentifier:
description: |
@@ -23870,13 +24209,11 @@ components:
id:
description: ID of the loyalty ledger transaction.
example: 123
- format: int64
type: integer
rulesetId:
description: The ID of the ruleset containing the rule that triggered this
effect.
example: 11
- format: int64
type: integer
ruleName:
description: The name of the rule that triggered this effect.
@@ -23928,7 +24265,6 @@ components:
programId:
description: ID of the loyalty program.
example: 324
- format: int64
type: integer
customerSessionId:
description: ID of the customer session where the transaction occurred.
@@ -23978,13 +24314,11 @@ components:
id:
description: ID of the loyalty ledger transaction.
example: 123
- format: int64
type: integer
rulesetId:
description: The ID of the ruleset containing the rule that triggered this
effect.
example: 11
- format: int64
type: integer
ruleName:
description: The name of the rule that triggered this effect.
@@ -24020,7 +24354,6 @@ components:
id:
description: ID of the transaction that adds loyalty points.
example: 123
- format: int64
type: integer
created:
description: Date and time the loyalty card points were added.
@@ -24029,7 +24362,6 @@ components:
programId:
description: ID of the loyalty program.
example: 324
- format: int64
type: integer
customerProfileID:
description: Integration ID of the customer profile linked to the card.
@@ -24095,7 +24427,6 @@ components:
id:
description: ID of the transaction that adds loyalty points.
example: 123
- format: int64
type: integer
created:
description: Date and time the loyalty points were added.
@@ -24104,7 +24435,6 @@ components:
programId:
description: ID of the loyalty program.
example: 324
- format: int64
type: integer
customerSessionId:
description: ID of the customer session where points were added.
@@ -24280,7 +24610,6 @@ components:
[ID of Ruleset](https://docs.talon.one/management-api#operation/getRulesets) this
campaign applies on customer session evaluation.
example: 6
- format: int64
type: integer
tags:
description: A list of tags for the campaign.
@@ -24324,7 +24653,6 @@ components:
- 1
- 3
items:
- format: int64
type: integer
type: array
type:
@@ -24351,14 +24679,12 @@ components:
- 2
- 3
items:
- format: int64
type: integer
type: array
evaluationGroupId:
description: The ID of the campaign evaluation group the campaign belongs
to.
example: 2
- format: int64
title: Evaluation Group ID
type: integer
required:
@@ -24374,7 +24700,6 @@ components:
description: Unique ID for this entity. Not to be confused with the Integration
ID, which is set by your integration layer and used in most endpoints.
example: 6
- format: int64
type: integer
required:
- id
@@ -24418,7 +24743,6 @@ components:
activeRulesetId:
description: The ID of the ruleset this campaign template will use.
example: 5
- format: int64
nullable: true
type: integer
tags:
@@ -24457,28 +24781,21 @@ components:
description: Unique ID for this entity. Not to be confused with the Integration
ID, which is set by your integration layer and used in most endpoints.
example: 6
- format: int64
type: integer
accountId:
- format: int64
type: integer
applicationId:
- format: int64
type: integer
campaignId:
- format: int64
type: integer
created:
format: date-time
type: string
createdBy:
- format: int64
type: integer
revisionId:
- format: int64
type: integer
version:
- format: int64
type: integer
name:
description: A user-facing name for this campaign.
@@ -24511,7 +24828,6 @@ components:
activeRulesetId:
description: The ID of the ruleset this campaign template will use.
example: 5
- format: int64
nullable: true
type: integer
tags:
@@ -24559,31 +24875,25 @@ components:
description: Unique ID for this entity. Not to be confused with the Integration
ID, which is set by your integration layer and used in most endpoints.
example: 6
- format: int64
type: integer
activateAt:
format: date-time
type: string
accountId:
- format: int64
type: integer
applicationId:
- format: int64
type: integer
campaignId:
- format: int64
type: integer
created:
format: date-time
type: string
createdBy:
- format: int64
type: integer
activatedAt:
format: date-time
type: string
activatedBy:
- format: int64
type: integer
currentVersion:
$ref: '#/components/schemas/RevisionVersion'
@@ -24605,7 +24915,6 @@ components:
- 2
- 3
items:
- format: int64
type: integer
maxItems: 5
type: array
@@ -24629,7 +24938,6 @@ components:
description: The ID of the parent group that contains the campaign evaluation
group.
example: 2
- format: int64
minimum: 1
type: integer
description:
@@ -24669,7 +24977,6 @@ components:
applicationId:
description: The ID of the Application that owns this entity.
example: 322
- format: int64
type: integer
name:
description: The name of the campaign evaluation group.
@@ -24679,7 +24986,6 @@ components:
description: The ID of the parent group that contains the campaign evaluation
group.
example: 2
- format: int64
minimum: 1
type: integer
description:
@@ -24711,7 +25017,6 @@ components:
description: Unique ID for this entity. Not to be confused with the Integration
ID, which is set by your integration layer and used in most endpoints.
example: 6
- format: int64
type: integer
required:
- applicationId
@@ -24732,7 +25037,6 @@ components:
description: The ID of the parent group that contains the campaign evaluation
group.
example: 2
- format: int64
minimum: 1
type: integer
description:
@@ -24793,7 +25097,6 @@ components:
type: array
groupId:
description: The ID of the campaign set.
- format: int64
type: integer
locked:
description: An indicator of whether the campaign set is locked for modification.
@@ -24835,7 +25138,6 @@ components:
type: string
campaignId:
description: ID of the campaign
- format: int64
type: integer
required:
- campaignId
@@ -24854,17 +25156,14 @@ components:
applicationId:
description: The ID of the Application that owns this entity.
example: 322
- format: int64
type: integer
id:
- description: Internal ID of this entity.
+ description: The internal ID of this entity.
example: 6
- format: int64
type: integer
version:
description: Version of the campaign set.
example: 3
- format: int64
minimum: 1
type: integer
set:
@@ -24884,12 +25183,10 @@ components:
applicationId:
description: The ID of the Application that owns this entity.
example: 322
- format: int64
type: integer
version:
description: Version of the campaign set.
example: 2
- format: int64
minimum: 1
type: integer
set:
@@ -25056,7 +25353,6 @@ components:
[ID of Ruleset](https://docs.talon.one/management-api#operation/getRulesets) this
campaign applies on customer session evaluation.
example: 2
- format: int64
type: integer
tags:
description: A list of tags for the campaign.
@@ -25100,14 +25396,12 @@ components:
- 1
- 3
items:
- format: int64
type: integer
type: array
evaluationGroupId:
description: The ID of the campaign evaluation group the campaign belongs
to.
example: 2
- format: int64
type: integer
type:
default: advanced
@@ -25133,7 +25427,6 @@ components:
- 2
- 3
items:
- format: int64
type: integer
type: array
required:
@@ -25170,7 +25463,6 @@ components:
- 2
- 3
items:
- format: int64
type: integer
type: array
description:
@@ -25203,7 +25495,6 @@ components:
description: The ID of the campaign evaluation group the campaign belongs
to.
example: 2
- format: int64
type: integer
required:
- applicationIds
@@ -25218,7 +25509,22 @@ components:
- 2
- 3
items:
- format: int64
+ type: integer
+ maxItems: 5
+ type: array
+ required:
+ - userIds
+ type: object
+ CampaignDeactivationRequest:
+ properties:
+ userIds:
+ description: The list of IDs of the users receiving the deactivation request
+ emails.
+ example:
+ - 1
+ - 2
+ - 3
+ items:
type: integer
maxItems: 5
type: array
@@ -25242,7 +25548,6 @@ components:
- 2
- 3
items:
- format: int64
type: integer
maxItems: 50
type: array
@@ -25262,7 +25567,6 @@ components:
id:
description: Unique ID for this entity.
example: 6
- format: int64
type: integer
name:
description: Name of the outgoing integration.
@@ -25383,17 +25687,14 @@ components:
id:
description: Unique ID for this entity.
example: 6
- format: int64
type: integer
accountId:
description: The ID of the account to which this configuration belongs.
example: 3886
- format: int64
type: integer
typeId:
description: The outgoing integration type ID.
example: 12
- format: int64
type: integer
policy:
description: The outgoing integration policy specific to each integration
@@ -25410,12 +25711,10 @@ components:
id:
description: Unique ID for this entity.
example: 6
- format: int64
type: integer
integrationType:
description: Unique ID of outgoing integration type.
example: 2
- format: int64
type: integer
title:
description: The title of the integration template.
@@ -25480,12 +25779,10 @@ components:
id:
description: Unique ID for this entity.
example: 6
- format: int64
type: integer
integrationType:
description: Unique ID of outgoing integration type.
example: 2
- format: int64
type: integer
title:
description: The title of the integration template.
@@ -25559,7 +25856,6 @@ components:
- 2
- 3
items:
- format: int64
type: integer
type: array
required:
@@ -25616,7 +25912,6 @@ components:
type: string
picklistID:
description: ID of the picklist linked to a template.
- format: int64
type: integer
restrictedByPicklist:
description: Whether or not this attribute's value is restricted by picklist
@@ -25634,7 +25929,6 @@ components:
The IDs of the Applications in which this webhook is available.
An empty array means the webhook is available in `All Applications`.
items:
- format: int64
type: integer
type: array
title:
@@ -25646,6 +25940,10 @@ components:
description: A description of the webhook.
example: A webhook to send a coupon to the user.
type: string
+ draft:
+ description: Indicates if the webhook is a draft.
+ example: false
+ type: boolean
verb:
description: API method for this webhook.
enum:
@@ -25686,6 +25984,7 @@ components:
type: boolean
required:
- applicationIds
+ - draft
- enabled
- headers
- params
@@ -25698,12 +25997,9 @@ components:
headers:
- '{"Authorization": "Basic bmF2ZWVua3VtYXIU="}'
- '{"Content-Type": "application/json"}'
- payload: "{\n\t\"message\": \"${message}\"\n}"
created: 2020-06-10T09:05:27.993483Z
verb: POST
- modified: 2021-09-12T10:12:42Z
description: A webhook to send a coupon to the user.
- id: 6
title: Send message
params: []
url: www.my-company.com/my-endpoint-name
@@ -25711,11 +26007,14 @@ components:
applicationIds:
- 0
- 0
+ payload: "{\n\t\"message\": \"${message}\"\n}"
+ draft: false
+ modified: 2021-09-12T10:12:42Z
+ id: 6
properties:
id:
- description: Internal ID of this entity.
+ description: The internal ID of this entity.
example: 6
- format: int64
type: integer
created:
description: The time this entity was created.
@@ -25732,7 +26031,6 @@ components:
The IDs of the Applications in which this webhook is available.
An empty array means the webhook is available in `All Applications`.
items:
- format: int64
type: integer
type: array
title:
@@ -25744,6 +26042,10 @@ components:
description: A description of the webhook.
example: A webhook to send a coupon to the user.
type: string
+ draft:
+ description: Indicates if the webhook is a draft.
+ example: false
+ type: boolean
verb:
description: API method for this webhook.
enum:
@@ -25785,6 +26087,7 @@ components:
required:
- applicationIds
- created
+ - draft
- enabled
- headers
- id
@@ -25798,7 +26101,6 @@ components:
properties:
amount:
description: The amount of period.
- format: int64
minimum: 0
type: integer
period:
@@ -25831,11 +26133,9 @@ components:
example: true
type: boolean
batchSize:
- default: 1000
description: The required size of each batch of data. This value applies
only when `batchingEnabled` is `true`.
example: 1000
- format: int64
type: integer
required:
- name
@@ -25845,7 +26145,6 @@ components:
properties:
amount:
description: The amount of period.
- format: int64
minimum: 1
type: integer
period:
@@ -25878,11 +26177,9 @@ components:
example: true
type: boolean
batchSize:
- default: 1000
description: The required size of each batch of data. This value applies
only when `batchingEnabled` is `true`.
example: 1000
- format: int64
type: integer
required:
- name
@@ -25892,7 +26189,6 @@ components:
properties:
amount:
description: The amount of period.
- format: int64
minimum: 1
type: integer
period:
@@ -25925,11 +26221,9 @@ components:
example: true
type: boolean
batchSize:
- default: 1000
description: The required size of each batch of data. This value applies
only when `batchingEnabled` is `true`.
example: 1000
- format: int64
type: integer
required:
- name
@@ -25979,6 +26273,50 @@ components:
- name
- scopes
type: object
+ AddedDeductedPointsBalancesNotificationPolicy:
+ properties:
+ name:
+ description: Notification name.
+ example: Christmas Sale
+ minLength: 1
+ type: string
+ scopes:
+ items:
+ enum:
+ - all
+ - campaign_manager
+ - management_api
+ - rule_engine
+ type: string
+ maxItems: 4
+ minItems: 1
+ type: array
+ required:
+ - name
+ - scopes
+ type: object
+ CardAddedDeductedPointsBalancesNotificationPolicy:
+ properties:
+ name:
+ description: Notification name.
+ example: Christmas Sale
+ minLength: 1
+ type: string
+ scopes:
+ items:
+ enum:
+ - all
+ - campaign_manager
+ - management_api
+ - rule_engine
+ type: string
+ maxItems: 4
+ minItems: 1
+ type: array
+ required:
+ - name
+ - scopes
+ type: object
CouponsNotificationPolicy:
properties:
name:
@@ -26008,11 +26346,9 @@ components:
example: true
type: boolean
batchSize:
- default: 1000
description: The required size of each batch of data. This value applies
only when `batchingEnabled` is `true`.
example: 1000
- format: int64
type: integer
required:
- name
@@ -26028,7 +26364,6 @@ components:
aheadOfDaysTrigger:
description: The number of days in advance that strikethrough pricing updates
should be sent.
- format: int64
maximum: 3E+1
minimum: 1
type: integer
@@ -26048,11 +26383,9 @@ components:
example: false
type: boolean
batchSize:
- default: 1000
description: The required size of each batch of data. This value applies
only when `batchingEnabled` is `true`.
example: 1000
- format: int64
type: integer
required:
- name
@@ -26070,11 +26403,9 @@ components:
example: false
type: boolean
batchSize:
- default: 5
description: The required size of each batch of data. This value applies
only when `batchingEnabled` is `true`.
example: 5
- format: int64
type: integer
required:
- name
@@ -26092,11 +26423,9 @@ components:
example: false
type: boolean
batchSize:
- default: 1000
description: The required size of each batch of data. This value applies
only when `batchingEnabled` is `true`.
example: 1000
- format: int64
type: integer
required:
- name
@@ -26114,11 +26443,9 @@ components:
example: false
type: boolean
batchSize:
- default: 1000
description: The required size of each batch of data. This value applies
only when `batchingEnabled` is `true`.
example: 1000
- format: int64
type: integer
required:
- name
@@ -26127,7 +26454,6 @@ components:
properties:
amount:
description: The amount of period.
- format: int64
type: integer
period:
description: Notification period indicated by a letter; "w" means week,
@@ -26153,11 +26479,9 @@ components:
example: false
type: boolean
batchSize:
- default: 1000
description: The required size of each batch of data. This value applies
only when `batchingEnabled` is `true`.
example: 1000
- format: int64
type: integer
triggers:
items:
@@ -26209,9 +26533,8 @@ components:
BaseNotificationWebhook:
properties:
id:
- description: Internal ID of this entity.
+ description: The internal ID of this entity.
example: 6
- format: int64
type: integer
created:
description: The time this entity was created.
@@ -26260,7 +26583,6 @@ components:
id:
description: Unique ID for this entity.
example: 6
- format: int64
minimum: 1
type: integer
type:
@@ -26269,6 +26591,8 @@ components:
- campaign
- loyalty_added_deducted_points
- card_added_deducted_points
+ - loyalty_added_deducted_points_balances
+ - loyalty_card_added_deducted_points_balances
- coupon
- expiring_coupons
- expiring_points
@@ -26338,7 +26662,6 @@ components:
effectId:
description: ID of the effect.
example: 1
- format: int64
type: integer
name:
description: The type of the custom effect.
@@ -26362,19 +26685,16 @@ components:
campaignId:
description: The ID of the campaign that effect belongs to.
example: 3
- format: int64
type: integer
rulesetId:
description: The ID of the ruleset containing the rule that triggered this
effect.
example: 11
- format: int64
type: integer
ruleIndex:
description: The position of the rule that triggered this effect within
the ruleset.
example: 2
- format: int64
type: integer
ruleName:
description: The name of the rule that triggered this effect.
@@ -26409,7 +26729,6 @@ components:
campaignsIDs:
description: The campaign IDs that got fetched for the evaluation process.
items:
- format: int64
type: integer
type: array
effects:
@@ -26419,6 +26738,97 @@ components:
$ref: '#/components/schemas/StrikethroughEffect'
type: array
type: object
+ PriceType:
+ properties:
+ id:
+ description: The internal ID of this entity.
+ example: 6
+ type: integer
+ created:
+ description: The time this entity was created.
+ example: 2020-06-10T09:05:27.993483Z
+ format: date-time
+ type: string
+ accountId:
+ description: The ID of the account that owns this price type.
+ example: 1
+ type: integer
+ name:
+ description: The API name of the price type. This is an immutable value.
+ example: member
+ pattern: ^[A-Za-z]\w*$
+ type: string
+ title:
+ description: The title of the price type.
+ example: Member Price
+ type: string
+ description:
+ description: The description of the price type.
+ example: Price available exclusively to members.
+ type: string
+ modified:
+ description: The date and time when the price type was last modified.
+ example: 2021-09-12T10:12:42Z
+ format: date-time
+ type: string
+ subscribedCatalogsIds:
+ description: A list of the IDs of the catalogs that are subscribed to this
+ price type.
+ example:
+ - 1
+ - 2
+ - 3
+ items:
+ type: integer
+ type: array
+ targetedAudiencesIds:
+ description: A list of the IDs of the audiences that are targeted by this
+ price type.
+ example:
+ - 1
+ - 2
+ - 3
+ items:
+ type: integer
+ type: array
+ required:
+ - created
+ - id
+ - modified
+ - name
+ - subscribedCatalogsIds
+ - targetedAudiencesIds
+ - title
+ type: object
+ NewPriceType:
+ properties:
+ name:
+ description: The API name of the price type. This is an immutable value.
+ example: member
+ pattern: ^[A-Za-z]\w*$
+ type: string
+ title:
+ description: The title of the price type.
+ example: Member Price
+ type: string
+ description:
+ description: The description of the price type.
+ example: Price available exclusively to members.
+ type: string
+ targetedAudiencesIds:
+ description: A list of the IDs of the audiences that are targeted by this
+ price type.
+ example:
+ - 1
+ - 2
+ - 3
+ items:
+ type: integer
+ type: array
+ required:
+ - name
+ - title
+ type: object
NewMessageTest:
properties:
type:
@@ -26427,6 +26837,8 @@ components:
- campaign
- loyalty_added_deducted_points
- card_added_deducted_points
+ - loyalty_added_deducted_points_balances
+ - loyalty_card_added_deducted_points_balances
- coupon
- expiring_coupons
- expiring_points
@@ -26494,7 +26906,6 @@ components:
httpStatus:
description: The returned http status code.
example: 200
- format: int64
type: integer
required:
- httpResponse
@@ -26514,9 +26925,12 @@ components:
type: object
Binding:
example:
+ attributeId: 100
+ minValue: 0.0
expression:
- string1
- string2
+ maxValue: 19.9
valueType: string
name: my property
type: templateParameter
@@ -26551,6 +26965,19 @@ components:
- `boolean`
example: string
type: string
+ minValue:
+ description: The minimum value allowed for this placeholder.
+ example: 0.0
+ type: number
+ maxValue:
+ description: The maximum value allowed for this placeholder.
+ example: 19.9
+ type: number
+ attributeId:
+ description: Id of the attribute attached to the placeholder.
+ example: 100
+ title: Attribute ID
+ type: integer
required:
- expression
- name
@@ -26573,15 +27000,21 @@ components:
- 10
- 100
bindings:
- - expression:
+ - attributeId: 100
+ minValue: 0.0
+ expression:
- string1
- string2
+ maxValue: 19.9
valueType: string
name: my property
type: templateParameter
- - expression:
+ - attributeId: 100
+ minValue: 0.0
+ expression:
- string1
- string2
+ maxValue: 19.9
valueType: string
name: my property
type: templateParameter
@@ -26709,15 +27142,21 @@ components:
- 10
- 100
bindings:
- - expression:
+ - attributeId: 100
+ minValue: 0.0
+ expression:
- string1
- string2
+ maxValue: 19.9
valueType: string
name: my property
type: templateParameter
- - expression:
+ - attributeId: 100
+ minValue: 0.0
+ expression:
- string1
- string2
+ maxValue: 19.9
valueType: string
name: my property
type: templateParameter
@@ -26741,15 +27180,21 @@ components:
- 10
- 100
bindings:
- - expression:
+ - attributeId: 100
+ minValue: 0.0
+ expression:
- string1
- string2
+ maxValue: 19.9
valueType: string
name: my property
type: templateParameter
- - expression:
+ - attributeId: 100
+ minValue: 0.0
+ expression:
- string1
- string2
+ maxValue: 19.9
valueType: string
name: my property
type: templateParameter
@@ -26775,15 +27220,21 @@ components:
- 10
- 100
bindings:
- - expression:
+ - attributeId: 100
+ minValue: 0.0
+ expression:
- string1
- string2
+ maxValue: 19.9
valueType: string
name: my property
type: templateParameter
- - expression:
+ - attributeId: 100
+ minValue: 0.0
+ expression:
- string1
- string2
+ maxValue: 19.9
valueType: string
name: my property
type: templateParameter
@@ -26807,15 +27258,21 @@ components:
- 10
- 100
bindings:
- - expression:
+ - attributeId: 100
+ minValue: 0.0
+ expression:
- string1
- string2
+ maxValue: 19.9
valueType: string
name: my property
type: templateParameter
- - expression:
+ - attributeId: 100
+ minValue: 0.0
+ expression:
- string1
- string2
+ maxValue: 19.9
valueType: string
name: my property
type: templateParameter
@@ -26827,9 +27284,8 @@ components:
userId: 388
properties:
id:
- description: Internal ID of this entity.
+ description: The internal ID of this entity.
example: 6
- format: int64
type: integer
created:
description: The time this entity was created.
@@ -26839,7 +27295,6 @@ components:
userId:
description: The ID of the user associated with this entity.
example: 388
- format: int64
type: integer
rules:
description: Set of rules to apply.
@@ -26872,13 +27327,11 @@ components:
campaignId:
description: The ID of the campaign that owns this entity.
example: 320
- format: int64
title: Campaign ID
type: integer
templateId:
description: The ID of the campaign template that owns this entity.
example: 3
- format: int64
title: Campaign Template ID
type: integer
activatedAt:
@@ -26906,7 +27359,6 @@ components:
description: |
The number of times the coupon code can be redeemed. `0` means unlimited redemptions but any campaign usage limits will still apply.
example: 100
- format: int64
maximum: 999999
minimum: 0
type: integer
@@ -26914,14 +27366,13 @@ components:
description: |
The total discount value that the code can give. Typically used to represent a gift card value.
example: 30.0
- maximum: 999999
+ maximum: 1E+15
minimum: 0
type: number
reservationLimit:
description: |
The number of reservations that can be made with this coupon code.
example: 45
- format: int64
maximum: 999999
minimum: 0
type: integer
@@ -26986,7 +27437,6 @@ components:
description: |
The number of times the coupon code can be redeemed. `0` means unlimited redemptions but any campaign usage limits will still apply.
example: 100
- format: int64
maximum: 999999
minimum: 0
type: integer
@@ -26994,14 +27444,13 @@ components:
description: |
The total discount value that the code can give. Typically used to represent a gift card value.
example: 30.0
- maximum: 999999
+ maximum: 1E+15
minimum: 0
type: number
reservationLimit:
description: |
The number of reservations that can be made with this coupon code.
example: 45
- format: int64
maximum: 999999
minimum: 0
type: integer
@@ -27030,7 +27479,6 @@ components:
description: The number of new coupon codes to generate for the campaign.
Must be at least 1.
example: 1
- format: int64
type: integer
uniquePrefix:
description: |
@@ -27132,7 +27580,6 @@ components:
description: |
The number of times the coupon code can be redeemed. `0` means unlimited redemptions but any campaign usage limits will still apply.
example: 100
- format: int64
maximum: 999999
minimum: 0
type: integer
@@ -27140,14 +27587,13 @@ components:
description: |
The total discount value that the code can give. Typically used to represent a gift card value.
example: 30.0
- maximum: 999999
+ maximum: 1E+15
minimum: 0
type: number
reservationLimit:
description: |
The number of reservations that can be made with this coupon code.
example: 45
- format: int64
maximum: 999999
minimum: 0
type: integer
@@ -27277,7 +27723,6 @@ components:
description: |
The number of times the coupon code can be redeemed. `0` means unlimited redemptions but any campaign usage limits will still apply.
example: 100
- format: int64
maximum: 999999
minimum: 0
type: integer
@@ -27285,14 +27730,13 @@ components:
description: |
The total discount value that the code can give. Typically used to represent a gift card value.
example: 30.0
- maximum: 999999
+ maximum: 1E+15
minimum: 0
type: number
reservationLimit:
description: |
The number of reservations that can be made with this coupon code.
example: 45
- format: int64
maximum: 999999
minimum: 0
type: integer
@@ -27310,7 +27754,6 @@ components:
numberOfCoupons:
description: The number of new coupon codes to generate for the campaign.
example: 200000
- format: int64
maximum: 5E+6
minimum: 1
type: integer
@@ -27418,7 +27861,6 @@ components:
referralId:
description: Filter the results by matching them with the ID of a referral.
This filter shows the coupons created by redeeming a referral code.
- format: int64
type: integer
expiresAfter:
description: Filter results comparing the parameter value, expected to be
@@ -27464,7 +27906,6 @@ components:
description: Unique ID for this entity. Not to be confused with the Integration
ID, which is set by your integration layer and used in most endpoints.
example: 6
- format: int64
type: integer
required:
- id
@@ -27475,7 +27916,6 @@ components:
$ref: '#/components/schemas/CouponDeletionFilters'
campaignids:
items:
- format: int64
type: integer
type: array
required:
@@ -27509,7 +27949,6 @@ components:
description: |
The number of times the coupon code can be redeemed. `0` means unlimited redemptions but any campaign usage limits will still apply.
example: 100
- format: int64
maximum: 999999
minimum: 0
type: integer
@@ -27517,14 +27956,13 @@ components:
description: |
The total discount value that the code can give. Typically used to represent a gift card value.
example: 30.0
- maximum: 999999
+ maximum: 1E+15
minimum: 0
type: number
reservationLimit:
description: |
The number of reservations that can be made with this coupon code.
example: 45
- format: int64
maximum: 999999
minimum: 0
type: integer
@@ -27611,7 +28049,6 @@ components:
description: |
The number of times a referral code can be used. This can be set to 0 for no limit, but any campaign usage limits will still apply.
example: 1
- format: int64
maximum: 999999
minimum: 0
title: Referral code Usage Limit
@@ -27650,7 +28087,6 @@ components:
description: |
The number of times a referral code can be used. This can be set to 0 for no limit, but any campaign usage limits will still apply.
example: 1
- format: int64
maximum: 999999
minimum: 0
title: Referral code Usage Limit
@@ -27679,7 +28115,6 @@ components:
- 2
- 3
items:
- format: int64
type: integer
type: array
campaignIds:
@@ -27690,7 +28125,6 @@ components:
- 6
- 8
items:
- format: int64
type: integer
type: array
required:
@@ -27715,9 +28149,8 @@ components:
- 8
properties:
id:
- description: Internal ID of this entity.
+ description: The internal ID of this entity.
example: 6
- format: int64
type: integer
created:
description: The time this entity was created.
@@ -27732,7 +28165,6 @@ components:
accountId:
description: The ID of the account that owns this entity.
example: 3886
- format: int64
type: integer
name:
description: The name of the campaign access group.
@@ -27751,7 +28183,6 @@ components:
- 2
- 3
items:
- format: int64
type: integer
type: array
campaignIds:
@@ -27762,7 +28193,6 @@ components:
- 6
- 8
items:
- format: int64
type: integer
type: array
required:
@@ -27791,7 +28221,6 @@ components:
- 2
- 3
items:
- format: int64
type: integer
type: array
campaignIds:
@@ -27802,7 +28231,6 @@ components:
- 6
- 8
items:
- format: int64
type: integer
type: array
required:
@@ -27811,9 +28239,8 @@ components:
Role:
properties:
id:
- description: Internal ID of this entity.
+ description: The internal ID of this entity.
example: 6
- format: int64
type: integer
created:
description: The time this entity was created.
@@ -27828,14 +28255,12 @@ components:
accountId:
description: The ID of the account that owns this entity.
example: 3886
- format: int64
type: integer
campaignGroupID:
description: |
The ID of the [Campaign Group](https://docs.talon.one/docs/product/account/account-settings/managing-campaign-groups)
this role was created for.
example: 3
- format: int64
type: integer
name:
description: Name of the role.
@@ -27853,7 +28278,6 @@ components:
- 475
- 18
items:
- format: int64
type: integer
type: array
acl:
@@ -27880,7 +28304,6 @@ components:
description: |
The number of reservations that can be made with this coupon code.
example: 45
- format: int64
maximum: 999999
minimum: 0
type: integer
@@ -27973,7 +28396,6 @@ components:
attributeId:
description: ID of the corresponding attribute.
example: 42
- format: int64
type: integer
required:
- description
@@ -28038,7 +28460,6 @@ components:
activeRulesetId:
description: The ID of the ruleset this campaign template will use.
example: 5
- format: int64
type: integer
tags:
description: A list of tags for the campaign template.
@@ -28086,7 +28507,6 @@ components:
- 2
- 3
items:
- format: int64
type: integer
type: array
campaignCollections:
@@ -28098,7 +28518,6 @@ components:
defaultCampaignGroupId:
description: The default campaign group ID.
example: 42
- format: int64
type: integer
campaignType:
default: advanced
@@ -28261,9 +28680,8 @@ components:
updated: 2022-08-24T14:15:22Z
properties:
id:
- description: Internal ID of this entity.
+ description: The internal ID of this entity.
example: 6
- format: int64
type: integer
created:
description: The time this entity was created.
@@ -28273,12 +28691,10 @@ components:
accountId:
description: The ID of the account that owns this entity.
example: 3886
- format: int64
type: integer
userId:
description: The ID of the user associated with this entity.
example: 388
- format: int64
type: integer
name:
description: The campaign template name.
@@ -28318,7 +28734,6 @@ components:
activeRulesetId:
description: The ID of the ruleset this campaign template will use.
example: 5
- format: int64
type: integer
tags:
description: A list of tags for the campaign template.
@@ -28369,7 +28784,6 @@ components:
- 2
- 3
items:
- format: int64
type: integer
type: array
campaignCollections:
@@ -28381,7 +28795,6 @@ components:
defaultCampaignGroupId:
description: The default campaign group ID.
example: 42
- format: int64
type: integer
campaignType:
default: advanced
@@ -28412,7 +28825,6 @@ components:
- 2
- 3
items:
- format: int64
type: integer
type: array
isUserFavorite:
@@ -28512,7 +28924,6 @@ components:
defaultCampaignGroupId:
description: The default campaign group ID.
example: 42
- format: int64
type: integer
campaignType:
default: advanced
@@ -28554,15 +28965,21 @@ components:
limit: 1000.0
action: createCoupon
templateParamValues:
- - expression:
+ - attributeId: 100
+ minValue: 0.0
+ expression:
- string1
- string2
+ maxValue: 19.9
valueType: string
name: my property
type: templateParameter
- - expression:
+ - attributeId: 100
+ minValue: 0.0
+ expression:
- string1
- string2
+ maxValue: 19.9
valueType: string
name: my property
type: templateParameter
@@ -28588,7 +29005,6 @@ components:
description: The ID of the Campaign Template which will be used in order
to create the Campaign.
example: 4
- format: int64
type: integer
campaignAttributesOverrides:
description: Custom Campaign Attributes. If the Campaign Template defines
@@ -28614,7 +29030,6 @@ components:
- 1
- 3
items:
- format: int64
type: integer
type: array
tags:
@@ -28632,7 +29047,6 @@ components:
description: The ID of the campaign evaluation group the campaign belongs
to.
example: 2
- format: int64
type: integer
linkedStoreIds:
description: |
@@ -28646,7 +29060,6 @@ components:
- 2
- 3
items:
- format: int64
type: integer
type: array
required:
@@ -28673,7 +29086,6 @@ components:
- 2
- 3
items:
- format: int64
type: integer
type: array
type: object
@@ -28698,7 +29110,6 @@ components:
- 2
- 3
items:
- format: int64
type: integer
type: array
name:
@@ -28728,9 +29139,8 @@ components:
applicationId: 1
properties:
id:
- description: Internal ID of this entity.
+ description: The internal ID of this entity.
example: 6
- format: int64
type: integer
created:
description: The time this entity was created.
@@ -28740,7 +29150,6 @@ components:
accountId:
description: The ID of the account that owns this entity.
example: 3886
- format: int64
type: integer
modified:
description: The time this entity was last modified.
@@ -28759,7 +29168,6 @@ components:
- 2
- 3
items:
- format: int64
type: integer
type: array
name:
@@ -28771,22 +29179,18 @@ components:
modifiedBy:
description: ID of the user who last updated this effect if available.
example: 48
- format: int64
type: integer
createdBy:
description: ID of the user who created this effect.
example: 134
- format: int64
type: integer
applicationId:
description: The ID of the Application that owns this entity.
example: 1
- format: int64
type: integer
campaignId:
description: The ID of the campaign that owns this entity.
example: 7
- format: int64
type: integer
required:
- accountId
@@ -28817,9 +29221,8 @@ components:
applicationId: 1
properties:
id:
- description: Internal ID of this entity.
+ description: The internal ID of this entity.
example: 6
- format: int64
type: integer
created:
description: The time this entity was created.
@@ -28829,7 +29232,6 @@ components:
accountId:
description: The ID of the account that owns this entity.
example: 3886
- format: int64
type: integer
modified:
description: The time this entity was last modified.
@@ -28848,7 +29250,6 @@ components:
- 2
- 3
items:
- format: int64
type: integer
type: array
name:
@@ -28860,22 +29261,18 @@ components:
modifiedBy:
description: ID of the user who last updated this effect if available.
example: 48
- format: int64
type: integer
createdBy:
description: ID of the user who created this effect.
example: 134
- format: int64
type: integer
applicationId:
description: The ID of the Application that owns this entity.
example: 1
- format: int64
type: integer
campaignId:
description: The ID of the campaign that owns this entity.
example: 7
- format: int64
type: integer
payload:
description: The content of the collection.
@@ -28955,15 +29352,21 @@ components:
- 10
- 100
bindings:
- - expression:
+ - attributeId: 100
+ minValue: 0.0
+ expression:
- string1
- string2
+ maxValue: 19.9
valueType: string
name: my property
type: templateParameter
- - expression:
+ - attributeId: 100
+ minValue: 0.0
+ expression:
- string1
- string2
+ maxValue: 19.9
valueType: string
name: my property
type: templateParameter
@@ -28987,15 +29390,21 @@ components:
- 10
- 100
bindings:
- - expression:
+ - attributeId: 100
+ minValue: 0.0
+ expression:
- string1
- string2
+ maxValue: 19.9
valueType: string
name: my property
type: templateParameter
- - expression:
+ - attributeId: 100
+ minValue: 0.0
+ expression:
- string1
- string2
+ maxValue: 19.9
valueType: string
name: my property
type: templateParameter
@@ -29021,15 +29430,21 @@ components:
- 10
- 100
bindings:
- - expression:
+ - attributeId: 100
+ minValue: 0.0
+ expression:
- string1
- string2
+ maxValue: 19.9
valueType: string
name: my property
type: templateParameter
- - expression:
+ - attributeId: 100
+ minValue: 0.0
+ expression:
- string1
- string2
+ maxValue: 19.9
valueType: string
name: my property
type: templateParameter
@@ -29053,15 +29468,21 @@ components:
- 10
- 100
bindings:
- - expression:
+ - attributeId: 100
+ minValue: 0.0
+ expression:
- string1
- string2
+ maxValue: 19.9
valueType: string
name: my property
type: templateParameter
- - expression:
+ - attributeId: 100
+ minValue: 0.0
+ expression:
- string1
- string2
+ maxValue: 19.9
valueType: string
name: my property
type: templateParameter
@@ -29255,7 +29676,6 @@ components:
- 132
- 97
items:
- format: int64
type: integer
type: array
defaultValidity:
@@ -29283,7 +29703,6 @@ components:
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
- format: int64
minimum: 0
type: integer
sandbox:
@@ -29420,7 +29839,6 @@ components:
- 132
- 97
items:
- format: int64
type: integer
type: array
defaultValidity:
@@ -29448,7 +29866,6 @@ components:
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
- format: int64
minimum: 0
type: integer
sandbox:
@@ -29547,7 +29964,6 @@ components:
id:
description: The internal ID of the tier.
example: 6
- format: int64
type: integer
name:
description: The name of the tier.
@@ -29657,9 +30073,8 @@ components:
entity: AttributeAllowedList
properties:
id:
- description: Internal ID of this entity.
+ description: The internal ID of this entity.
example: 6
- format: int64
type: integer
created:
description: The time this entity was created.
@@ -29669,12 +30084,10 @@ components:
accountId:
description: The ID of the account that owns this entity.
example: 3886
- format: int64
type: integer
userId:
description: The ID of the user associated with this entity.
example: 388
- format: int64
type: integer
entity:
description: |
@@ -29684,7 +30097,6 @@ components:
amount:
description: The number of values that were imported.
example: 10
- format: int64
minimum: 0
type: integer
required:
@@ -29721,21 +30133,18 @@ components:
type: string
programID:
example: 5
- format: int64
type: integer
customerProfileID:
example: URNGV8294NV
type: string
cardID:
example: 241
- format: int64
type: integer
customerSessionID:
example: t2gy5s-47274
type: string
eventID:
example: 5
- format: int64
type: integer
type:
description: |
@@ -29771,7 +30180,6 @@ components:
description: This is the ID of the user who created this entry, if the addition
or subtraction was done manually.
example: 499
- format: int64
type: integer
archived:
description: Indicates if the entry belongs to the archived session.
@@ -30267,7 +30675,6 @@ components:
applicationId:
description: ID of the Application that is connected to the loyalty program.
example: 322
- format: int64
type: integer
required:
- points
@@ -30298,17 +30705,14 @@ components:
id:
description: ID of the loyalty ledger transaction.
example: 123
- format: int64
type: integer
programId:
description: ID of the loyalty program.
example: 324
- format: int64
type: integer
campaignId:
description: ID of the campaign.
example: 324
- format: int64
type: integer
created:
description: Date and time the loyalty transaction occurred.
@@ -30374,13 +30778,11 @@ components:
importId:
description: ID of the import where the transaction occurred.
example: 4
- format: int64
type: integer
userId:
description: ID of the user who manually added or deducted points. Applies
only to manual transactions.
example: 5
- format: int64
type: integer
userEmail:
description: The email of the Campaign Manager account that manually added
@@ -30391,7 +30793,6 @@ components:
description: ID of the ruleset containing the rule that triggered the effect.
Applies only for transactions that resulted from a customer session.
example: 11
- format: int64
type: integer
ruleName:
description: Name of the rule that triggered the effect. Applies only for
@@ -30459,7 +30860,6 @@ components:
numberOfCards:
description: Number of loyalty cards in the batch.
example: 5000
- format: int64
type: integer
batchId:
description: ID of the loyalty card batch.
@@ -30489,7 +30889,6 @@ components:
numberOfCardsGenerated:
description: Number of loyalty cards in the batch.
example: 5000
- format: int64
type: integer
batchId:
description: ID of the loyalty card batch.
@@ -30556,7 +30955,6 @@ components:
programId:
description: ID of the loyalty program.
example: 324
- format: int64
type: integer
cardIdentifier:
description: |
@@ -30568,13 +30966,11 @@ components:
applicationId:
description: The ID of the Application that owns this entity.
example: 322
- format: int64
type: integer
sessionId:
description: |
The **internal** ID of the session.
example: 233
- format: int64
type: integer
customerSessionId:
description: ID of the customer session where the transaction occurred.
@@ -30624,7 +31020,6 @@ components:
id:
description: ID of the loyalty ledger entry.
example: 123
- format: int64
type: integer
required:
- amount
@@ -30675,7 +31070,6 @@ components:
- 2
- 4
items:
- format: int64
type: integer
type: array
sandbox:
@@ -30692,9 +31086,8 @@ components:
description: Giveaways pools is an entity for managing multiple similar giveaways.
properties:
id:
- description: Internal ID of this entity.
+ description: The internal ID of this entity.
example: 6
- format: int64
type: integer
created:
description: The time this entity was created.
@@ -30704,7 +31097,6 @@ components:
accountId:
description: The ID of the account that owns this entity.
example: 3886
- format: int64
type: integer
name:
description: The name of this giveaways pool.
@@ -30721,7 +31113,6 @@ components:
- 2
- 4
items:
- format: int64
type: integer
type: array
sandbox:
@@ -30736,11 +31127,9 @@ components:
type: string
createdBy:
description: ID of the user who created this giveaways pool.
- format: int64
type: integer
modifiedBy:
description: ID of the user who last updated this giveaways pool if available.
- format: int64
type: integer
required:
- accountId
@@ -30755,23 +31144,19 @@ components:
campaignId:
description: The ID of the campaign that owns this entity.
example: 211
- format: int64
title: Campaign ID
type: integer
applicationId:
description: The ID of the Application that owns this entity.
example: 322
- format: int64
type: integer
accountId:
description: The ID of the account that owns this entity.
example: 3886
- format: int64
type: integer
id:
description: Unique ID for this entity.
example: 6
- format: int64
type: integer
action:
description: The limitable action of the limit counter.
@@ -30780,7 +31165,6 @@ components:
profileId:
description: The profile ID for which this limit counter is used.
example: 335
- format: int64
type: integer
profileIntegrationId:
description: The profile integration ID for which this limit counter is
@@ -30791,7 +31175,6 @@ components:
couponId:
description: The internal coupon ID for which this limit counter is used.
example: 34
- format: int64
type: integer
couponValue:
description: The coupon value for which this limit counter is used.
@@ -30800,7 +31183,6 @@ components:
referralId:
description: The referral ID for which this limit counter is used.
example: 4
- format: int64
type: integer
referralValue:
description: The referral value for which this limit counter is used.
@@ -30836,7 +31218,6 @@ components:
applicationIds:
description: The IDs of the Applications that are related to this entity.
items:
- format: int64
type: integer
minItems: 1
type: array
@@ -30848,7 +31229,6 @@ components:
applicationIds:
description: The IDs of the Applications that are related to this entity.
items:
- format: int64
type: integer
minItems: 1
type: array
@@ -30888,9 +31268,8 @@ components:
CustomEffect:
properties:
id:
- description: Internal ID of this entity.
+ description: The internal ID of this entity.
example: 6
- format: int64
type: integer
created:
description: The time this entity was created.
@@ -30900,7 +31279,6 @@ components:
accountId:
description: The ID of the account that owns this entity.
example: 3886
- format: int64
type: integer
modified:
description: The time this entity was last modified.
@@ -30910,7 +31288,6 @@ components:
applicationIds:
description: The IDs of the Applications that are related to this entity.
items:
- format: int64
type: integer
minItems: 1
type: array
@@ -30943,12 +31320,10 @@ components:
modifiedBy:
description: ID of the user who last updated this effect if available.
example: 334
- format: int64
type: integer
createdBy:
description: ID of the user who created this effect.
example: 216
- format: int64
type: integer
required:
- accountId
@@ -30993,9 +31368,8 @@ components:
Picklist:
properties:
id:
- description: Internal ID of this entity.
+ description: The internal ID of this entity.
example: 6
- format: int64
type: integer
created:
description: The time this entity was created.
@@ -31025,17 +31399,14 @@ components:
modifiedBy:
description: ID of the user who last updated this effect if available.
example: 124
- format: int64
type: integer
createdBy:
description: ID of the user who created this effect.
example: 134
- format: int64
type: integer
accountId:
description: The ID of the account that owns this entity.
example: 3886
- format: int64
type: integer
imported:
description: Imported flag shows that a picklist is imported by a CSV file
@@ -31177,15 +31548,12 @@ components:
properties:
live:
description: Number of campaigns that are active and live (across all Applications).
- format: int64
type: integer
endingSoon:
description: Campaigns scheduled to expire sometime in the next 7 days.
- format: int64
type: integer
lowOnBudget:
description: Campaigns with less than 10% of budget left.
- format: int64
type: integer
required:
- endingSoon
@@ -31224,7 +31592,6 @@ components:
id:
description: ID of the SAML login endpoint.
example: 2
- format: int64
type: integer
name:
description: ID of the SAML service.
@@ -31244,7 +31611,6 @@ components:
accountId:
description: The ID of the account that owns this entity.
example: 3885
- format: int64
type: integer
name:
description: ID of the SAML service.
@@ -31288,7 +31654,6 @@ components:
accountId:
description: The ID of the account that owns this entity.
example: 3885
- format: int64
type: integer
name:
description: ID of the SAML service.
@@ -31317,9 +31682,8 @@ components:
This is most often the SP Entity ID of your application. When not specified, the ACS URL will be used.
type: string
id:
- description: Internal ID of this entity.
+ description: The internal ID of this entity.
example: 6
- format: int64
type: integer
created:
description: The time this entity was created.
@@ -31347,7 +31711,6 @@ components:
accountId:
description: The ID of the account that owns this entity.
example: 3885
- format: int64
type: integer
name:
description: ID of the SAML service.
@@ -31440,12 +31803,10 @@ components:
userId:
description: The ID of the user.
example: 109
- format: int64
type: integer
accountId:
description: The ID of the account.
example: 31
- format: int64
type: integer
token:
description: The two-factor authentication token created during sign-in.
@@ -31471,7 +31832,6 @@ components:
userId:
description: The ID of the user of this session.
example: 109
- format: int64
type: integer
token:
description: The token to use as a bearer token to query Management API
@@ -31558,7 +31918,6 @@ components:
status:
description: HTTP status code of response.
example: 200
- format: int64
type: integer
method:
description: HTTP method of request.
@@ -31622,7 +31981,6 @@ components:
- 1
- 2
items:
- format: int64
type: integer
type: array
webhooks:
@@ -31631,7 +31989,6 @@ components:
- 3
- 4
items:
- format: int64
type: integer
type: array
type: object
@@ -31701,56 +32058,44 @@ components:
type: number
campaignFreeItems:
description: Amount of free items given in the campaign.
- format: int64
type: integer
totalCampaignFreeItems:
description: Amount of free items given in the campaign since it began.
example: 86
- format: int64
type: integer
couponRedemptions:
description: Number of coupon redemptions in the campaign.
- format: int64
type: integer
totalCouponRedemptions:
description: Number of coupon redemptions in the campaign since it began.
- format: int64
type: integer
couponRolledbackRedemptions:
description: Number of coupon redemptions that have been rolled back (due
to canceling closed session) in the campaign.
- format: int64
type: integer
totalCouponRolledbackRedemptions:
description: Number of coupon redemptions that have been rolled back (due
to canceling closed session) in the campaign since it began.
- format: int64
type: integer
referralRedemptions:
description: Number of referral redemptions in the campaign.
- format: int64
type: integer
totalReferralRedemptions:
description: Number of referral redemptions in the campaign since it began.
- format: int64
type: integer
couponsCreated:
description: Number of coupons created in the campaign by the rule engine.
- format: int64
type: integer
totalCouponsCreated:
description: Number of coupons created in the campaign by the rule engine
since it began.
- format: int64
type: integer
referralsCreated:
description: Number of referrals created in the campaign by the rule engine.
- format: int64
type: integer
totalReferralsCreated:
description: Number of referrals created in the campaign by the rule engine
since it began.
- format: int64
type: integer
addedLoyaltyPoints:
description: Number of added loyalty points in the campaign in a specific
@@ -31824,9 +32169,8 @@ components:
id: 2
properties:
id:
- description: Internal ID of this entity.
+ description: The internal ID of the customer profile.
example: 6
- format: int64
type: integer
created:
description: The time this entity was created.
@@ -31849,14 +32193,12 @@ components:
accountId:
description: The ID of the Talon.One account that owns this profile.
example: 31
- format: int64
title: Profile belongs to Account
type: integer
closedSessions:
- description: The total amount of closed sessions by a customer. A closed
- session is a successful purchase.
+ description: The total number of closed sessions. Does not include closed
+ sessions that have been cancelled or reopened. See the [docs](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions#customer-session-states).
example: 3
- format: int64
title: Closed sessions
type: integer
totalSales:
@@ -31936,7 +32278,6 @@ components:
type: array
profileIDs:
items:
- format: int64
type: integer
type: array
type: object
@@ -31973,7 +32314,6 @@ components:
type: string
customerId:
description: The internal Talon.One ID of the customer.
- format: int64
type: integer
lastActivity:
description: The last activity of the customer.
@@ -31981,15 +32321,12 @@ components:
type: string
couponRedemptions:
description: Number of coupon redemptions in all customer campaigns.
- format: int64
type: integer
couponUseAttempts:
description: Number of coupon use attempts in all customer campaigns.
- format: int64
type: integer
couponFailedAttempts:
description: Number of failed coupon use attempts in all customer campaigns.
- format: int64
type: integer
accruedDiscounts:
description: Number of accrued discounts in all customer campaigns.
@@ -31999,11 +32336,9 @@ components:
type: number
totalOrders:
description: Number of orders in all customer campaigns.
- format: int64
type: integer
totalOrdersNoCoupon:
description: Number of orders without coupon used in all customer campaigns.
- format: int64
type: integer
campaignName:
description: The name of the campaign this customer belongs to.
@@ -32035,23 +32370,18 @@ components:
properties:
acceptedCoupons:
description: Total accepted coupons for this customer.
- format: int64
type: integer
createdCoupons:
description: Total created coupons for this customer.
- format: int64
type: integer
freeItems:
description: Total free items given to this customer.
- format: int64
type: integer
totalOrders:
description: Total orders made by this customer.
- format: int64
type: integer
totalDiscountedOrders:
description: Total orders made by this customer that had a discount.
- format: int64
type: integer
totalRevenue:
description: Total Revenue across all closed sessions.
@@ -32074,7 +32404,6 @@ components:
description: The globally unique Talon.One ID of the customer that created
this entity.
example: 138
- format: int64
type: integer
type: object
ApplicationSession:
@@ -32102,19 +32431,31 @@ components:
returnedQuantity: 1
length: 1.4658129805029452
weight: 1130.0
+ adjustmentReferenceId: 68851723-e6fa-488f-ace9-112581e6c19b
+ adjustmentEffectiveFrom: 2021-09-12T10:12:42Z
catalogItemID: 5
additionalCosts:
shipping:
price: 9
price: 99.99
+ selectedPriceType: member
name: Air Glide
width: 6.027456183070403
attributes:
image: 11.jpeg
material: leather
+ adjustmentEffectiveUntil: 2021-09-12T10:12:42Z
position: 5.962133916683182
sku: SKU1241028
category: shoes
+ prices:
+ member:
+ price: 90
+ adjustmentReferenceId: 68851723-e6fa-488f-ace9-112581e6c19b
+ effectiveFrom: 2025-05-25T00:00:00Z
+ effectiveUntil: 2025-05-30T00:00:00Z
+ base:
+ price: 100
height: 0.8008281904610115
- remainingQuantity: 1
product:
@@ -32123,25 +32464,36 @@ components:
returnedQuantity: 1
length: 1.4658129805029452
weight: 1130.0
+ adjustmentReferenceId: 68851723-e6fa-488f-ace9-112581e6c19b
+ adjustmentEffectiveFrom: 2021-09-12T10:12:42Z
catalogItemID: 5
additionalCosts:
shipping:
price: 9
price: 99.99
+ selectedPriceType: member
name: Air Glide
width: 6.027456183070403
attributes:
image: 11.jpeg
material: leather
+ adjustmentEffectiveUntil: 2021-09-12T10:12:42Z
position: 5.962133916683182
sku: SKU1241028
category: shoes
+ prices:
+ member:
+ price: 90
+ adjustmentReferenceId: 68851723-e6fa-488f-ace9-112581e6c19b
+ effectiveFrom: 2025-05-25T00:00:00Z
+ effectiveUntil: 2025-05-30T00:00:00Z
+ base:
+ price: 100
height: 0.8008281904610115
properties:
id:
- description: Internal ID of this entity.
+ description: The internal ID of this entity.
example: 6
- format: int64
type: integer
created:
description: The time this entity was created.
@@ -32164,13 +32516,11 @@ components:
applicationId:
description: The ID of the Application that owns this entity.
example: 322
- format: int64
type: integer
profileId:
description: The globally unique Talon.One ID of the customer that created
this entity.
example: 138
- format: int64
type: integer
profileintegrationid:
description: Integration ID of the customer for the session.
@@ -32247,7 +32597,6 @@ components:
properties:
storeId:
description: The ID of the store.
- format: int64
type: integer
type: object
ApplicationEvent:
@@ -32260,9 +32609,12 @@ components:
conditionIndex: 786
evaluationGroupMode: stackable
effectType: rejectCoupon
+ adjustmentReferenceId: 68851723-e6fa-488f-ace9-112581e6c19b
props: '{}'
+ selectedPrice: 100.0
evaluationGroupID: 3
triggeredForCatalogItem: 786
+ selectedPriceType: member
campaignRevisionId: 1
ruleName: Give 20% discount
triggeredByCoupon: 4928
@@ -32273,9 +32625,12 @@ components:
conditionIndex: 786
evaluationGroupMode: stackable
effectType: rejectCoupon
+ adjustmentReferenceId: 68851723-e6fa-488f-ace9-112581e6c19b
props: '{}'
+ selectedPrice: 100.0
evaluationGroupID: 3
triggeredForCatalogItem: 786
+ selectedPriceType: member
campaignRevisionId: 1
ruleName: Give 20% discount
triggeredByCoupon: 4928
@@ -32319,9 +32674,8 @@ components:
campaignName: campaignName
properties:
id:
- description: Internal ID of this entity.
+ description: The internal ID of this entity.
example: 6
- format: int64
type: integer
created:
description: The time this entity was created.
@@ -32331,17 +32685,14 @@ components:
applicationId:
description: The ID of the Application that owns this entity.
example: 322
- format: int64
type: integer
profileId:
description: The globally unique Talon.One ID of the customer that created
this entity.
example: 138
- format: int64
type: integer
storeId:
description: The ID of the store.
- format: int64
type: integer
storeIntegrationId:
description: The integration ID of the store. You choose this ID when you
@@ -32353,7 +32704,6 @@ components:
sessionId:
description: The globally unique Talon.One ID of the session that contains
this event.
- format: int64
type: integer
type:
description: A string representing the event. Must not be a reserved event
@@ -32392,20 +32742,17 @@ components:
audienceId:
description: The ID of the audience.
example: 1
- format: int64
type: integer
membersCount:
description: The member count of the audience.
example: 1234
- format: int64
type: integer
type: object
AudienceCustomer:
properties:
id:
- description: Internal ID of this entity.
+ description: The internal ID of the customer profile.
example: 6
- format: int64
type: integer
created:
description: The time this entity was created.
@@ -32428,14 +32775,12 @@ components:
accountId:
description: The ID of the Talon.One account that owns this profile.
example: 31
- format: int64
title: Profile belongs to Account
type: integer
closedSessions:
- description: The total amount of closed sessions by a customer. A closed
- session is a successful purchase.
+ description: The total number of closed sessions. Does not include closed
+ sessions that have been cancelled or reopened. See the [docs](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions#customer-session-states).
example: 3
- format: int64
title: Closed sessions
type: integer
totalSales:
@@ -32487,7 +32832,6 @@ components:
- 2
- 3
items:
- format: int64
type: integer
type: array
connectedAudiences:
@@ -32498,7 +32842,6 @@ components:
- 2
- 3
items:
- format: int64
type: integer
type: array
required:
@@ -32523,7 +32866,6 @@ components:
applicationId:
description: The ID of the Application that owns this entity.
example: 322
- format: int64
type: integer
sessionId:
description: Integration ID of the session in which the customer redeemed
@@ -32647,9 +32989,8 @@ components:
TemplateDef:
properties:
id:
- description: Internal ID of this entity.
+ description: The internal ID of this entity.
example: 6
- format: int64
type: integer
created:
description: The time this entity was created.
@@ -32659,7 +33000,6 @@ components:
applicationId:
description: The ID of the Application that owns this entity.
example: 322
- format: int64
type: integer
title:
description: Campaigner-friendly name for the template that will be shown
@@ -32713,12 +33053,10 @@ components:
campaignId:
description: The ID of the campaign the achievement belongs to.
example: 1
- format: int64
type: integer
userId:
description: ID of the user that created this achievement.
example: 1234
- format: int64
type: integer
createdBy:
description: |
@@ -32769,9 +33107,8 @@ components:
status: inprogress
properties:
id:
- description: Internal ID of this entity.
+ description: The internal ID of this entity.
example: 6
- format: int64
type: integer
created:
description: The time this entity was created.
@@ -32838,9 +33175,11 @@ components:
The policy that determines if and how the achievement recurs.
- `no_recurrence`: The achievement can be completed only once.
- `on_expiration`: The achievement resets after it expires and becomes available again.
+ - `on_completion`: When the customer progress status reaches `completed`, the achievement resets and becomes available again.
enum:
- no_recurrence
- on_expiration
+ - on_completion
example: no_recurrence
type: string
activationPolicy:
@@ -32870,12 +33209,10 @@ components:
campaignId:
description: The ID of the campaign the achievement belongs to.
example: 1
- format: int64
type: integer
userId:
description: ID of the user that created this achievement.
example: 1234
- format: int64
type: integer
createdBy:
description: |
@@ -32939,7 +33276,6 @@ components:
- 3
- 13
items:
- format: int64
type: integer
type: array
type:
@@ -32974,9 +33310,8 @@ components:
type: session
properties:
id:
- description: Internal ID of this entity.
+ description: The internal ID of this entity.
example: 6
- format: int64
type: integer
created:
description: The time this entity was created.
@@ -32986,7 +33321,6 @@ components:
accountId:
description: The ID of the account that owns this entity.
example: 3886
- format: int64
type: integer
name:
description: The internal name used in API requests.
@@ -33011,7 +33345,6 @@ components:
- 3
- 13
items:
- format: int64
type: integer
type: array
type:
@@ -33049,18 +33382,15 @@ components:
description: The ID of the expression that the Application cart item filter
uses.
example: 1
- format: int64
type: integer
modifiedBy:
description: The ID of the user who last updated the Application cart item
filter.
example: 334
- format: int64
type: integer
createdBy:
description: The ID of the user who created the Application cart item filter.
example: 216
- format: int64
type: integer
modified:
description: Timestamp of the most recent update to the Application cart
@@ -33073,9 +33403,8 @@ components:
ApplicationCIF:
properties:
id:
- description: Internal ID of this entity.
+ description: The internal ID of this entity.
example: 6
- format: int64
type: integer
created:
description: The time this entity was created.
@@ -33094,18 +33423,15 @@ components:
description: The ID of the expression that the Application cart item filter
uses.
example: 1
- format: int64
type: integer
modifiedBy:
description: The ID of the user who last updated the Application cart item
filter.
example: 334
- format: int64
type: integer
createdBy:
description: The ID of the user who created the Application cart item filter.
example: 216
- format: int64
type: integer
modified:
description: Timestamp of the most recent update to the Application cart
@@ -33115,7 +33441,6 @@ components:
applicationId:
description: The ID of the Application that owns this entity.
example: 322
- format: int64
type: integer
required:
- applicationId
@@ -33126,9 +33451,8 @@ components:
Environment:
properties:
id:
- description: Internal ID of this entity.
+ description: The internal ID of this entity.
example: 6
- format: int64
type: integer
created:
description: The time this entity was created.
@@ -33138,7 +33462,6 @@ components:
applicationId:
description: The ID of the Application that owns this entity.
example: 322
- format: int64
type: integer
slots:
description: The slots defined for this application.
@@ -33202,6 +33525,11 @@ components:
items:
$ref: '#/components/schemas/ApplicationCIF'
type: array
+ priceTypes:
+ description: The price types that this Application can use.
+ items:
+ $ref: '#/components/schemas/PriceType'
+ type: array
required:
- applicationId
- created
@@ -33320,7 +33648,6 @@ components:
type: string
campaignsCount:
description: The number of campaigns that refer to the attribute.
- format: int64
type: integer
exampleValue:
description: Examples of values that can be assigned to the attribute.
@@ -33365,7 +33692,6 @@ components:
- 2
- 3
items:
- format: int64
type: integer
type: array
required:
@@ -33388,9 +33714,8 @@ components:
version: 6
properties:
id:
- description: Internal ID of this entity.
+ description: The internal ID of this entity.
example: 6
- format: int64
type: integer
created:
description: The time this entity was created.
@@ -33400,7 +33725,6 @@ components:
accountId:
description: The ID of the account that owns this entity.
example: 3886
- format: int64
type: integer
modified:
description: The time this entity was last modified.
@@ -33423,18 +33747,15 @@ components:
- 2
- 3
items:
- format: int64
type: integer
type: array
version:
description: The current version of this catalog.
example: 6
- format: int64
type: integer
createdBy:
description: The ID of user who created this catalog.
example: 6
- format: int64
type: integer
required:
- accountId
@@ -33455,7 +33776,6 @@ components:
attributeid:
description: The ID of the attribute of the item.
example: 6
- format: int64
type: integer
name:
description: The name of the attribute.
@@ -33487,9 +33807,8 @@ components:
version: 5
properties:
id:
- description: Internal ID of this entity.
+ description: The internal ID of this entity.
example: 6
- format: int64
type: integer
created:
description: The time this entity was created.
@@ -33508,12 +33827,10 @@ components:
catalogid:
description: The ID of the catalog the item belongs to.
example: 6
- format: int64
type: integer
version:
description: The version of the catalog item.
example: 5
- format: int64
minimum: 1
type: integer
attributes:
@@ -33657,6 +33974,61 @@ components:
$ref: '#/components/schemas/CatalogActionFilter'
type: array
type: object
+ NewPriceAdjustment:
+ properties:
+ priceType:
+ description: The price type (e.g. the price for members only) to apply to
+ a given SKU.
+ example: member
+ type: string
+ price:
+ description: The value of the price type applied to the SKU. When set to
+ `null`, the defined price type no longer applies to the SKU.
+ example: 100.0
+ nullable: true
+ type: number
+ referenceId:
+ description: A unique reference identifier, e.g. a UUID.
+ example: 68851723-e6fa-488f-ace9-112581e6c19b
+ type: string
+ calculatedAt:
+ description: The time at which this price was calculated. If provided, this
+ is used to determine the most recent price adjustment to choose if price
+ adjustments overlap. Defaults to internal creation time if not provided.
+ example: 2021-09-12T10:12:42Z
+ format: date-time
+ type: string
+ effectiveFrom:
+ description: The date and time from which the price adjustment is effective.
+ example: 2021-09-12T10:12:42Z
+ format: date-time
+ type: string
+ effectiveUntil:
+ description: The date and time until which the price adjustment is effective.
+ example: 2021-09-12T10:12:42Z
+ format: date-time
+ type: string
+ required:
+ - priceType
+ - referenceId
+ type: object
+ AddPriceAdjustmentCatalogAction:
+ description: |
+ The specific properties of the "ADD_PRICE_ADJUSTMENT" catalog sync action.
+ properties:
+ sku:
+ description: The SKU of the item for which the price is being adjusted.
+ example: SKU1241028
+ type: string
+ adjustments:
+ description: A list of adjustments to apply to a given item.
+ items:
+ $ref: '#/components/schemas/NewPriceAdjustment'
+ type: array
+ required:
+ - adjustments
+ - sku
+ type: object
CatalogActionPayload:
type: object
CatalogAction:
@@ -33674,6 +34046,7 @@ components:
- PATCH_MANY
- REMOVE
- REMOVE_MANY
+ - ADD_PRICE_ADJUSTMENT
example: ADD
type: string
payload:
@@ -33706,7 +34079,6 @@ components:
version:
description: The version number of the catalog to apply the actions on.
example: 244
- format: int64
minimum: 1
type: integer
required:
@@ -33731,13 +34103,13 @@ components:
outgoingIntegrationTypeId: 1
outgoingIntegrationTypeName: Braze
payload: "{\n\t\"message\": \"${message}\"\n}"
+ draft: false
modified: 2021-09-12T10:12:42Z
id: 6
properties:
id:
- description: Internal ID of this entity.
+ description: The internal ID of this entity.
example: 6
- format: int64
type: integer
created:
description: The time this entity was created.
@@ -33754,7 +34126,6 @@ components:
The IDs of the Applications in which this webhook is available.
An empty array means the webhook is available in `All Applications`.
items:
- format: int64
type: integer
type: array
title:
@@ -33766,6 +34137,10 @@ components:
description: A description of the webhook.
example: A webhook to send a coupon to the user.
type: string
+ draft:
+ description: Indicates if the webhook is a draft.
+ example: false
+ type: boolean
verb:
description: API method for this webhook.
enum:
@@ -33807,12 +34182,10 @@ components:
outgoingIntegrationTemplateId:
description: Identifier of the outgoing integration template.
example: 1
- format: int64
type: integer
outgoingIntegrationTypeId:
description: Identifier of the outgoing integration type.
example: 1
- format: int64
type: integer
outgoingIntegrationTypeName:
description: Name of the outgoing integration.
@@ -33821,6 +34194,7 @@ components:
required:
- applicationIds
- created
+ - draft
- enabled
- headers
- id
@@ -33830,6 +34204,112 @@ components:
- url
- verb
type: object
+ WebhookAuthenticationWebhookRef:
+ properties:
+ id:
+ description: The internal ID of this entity.
+ example: 6
+ type: integer
+ title:
+ description: The title of the webhook authentication.
+ example: Send message
+ pattern: ^[A-Za-z][A-Za-z0-9_.!~*'() -]*$
+ type: string
+ description:
+ description: A description of the webhook authentication.
+ example: A webhook to send a coupon to the user.
+ type: string
+ required:
+ - id
+ - title
+ type: object
+ WebhookAuthenticationDataBasic:
+ properties:
+ username:
+ description: The Basic HTTP username.
+ type: string
+ password:
+ description: The Basic HTTP password.
+ type: string
+ required:
+ - password
+ - username
+ type: object
+ WebhookAuthenticationDataCustom:
+ properties:
+ headers:
+ additionalProperties:
+ type: string
+ type: object
+ required:
+ - headers
+ type: object
+ WebhookAuthenticationBase:
+ properties:
+ name:
+ description: The name of the webhook authentication.
+ example: My basic auth
+ type: string
+ type:
+ enum:
+ - basic
+ - custom
+ type: string
+ data:
+ type: object
+ required:
+ - data
+ - name
+ - type
+ type: object
+ WebhookAuthentication:
+ properties:
+ createdBy:
+ description: The name of the user who created the webhook authentication.
+ type: string
+ modifiedBy:
+ description: The name of the user who last modified the webhook authentication.
+ type: string
+ webhooks:
+ items:
+ $ref: '#/components/schemas/WebhookAuthenticationWebhookRef'
+ type: array
+ name:
+ description: The name of the webhook authentication.
+ example: My basic auth
+ type: string
+ type:
+ enum:
+ - basic
+ - custom
+ type: string
+ data:
+ type: object
+ id:
+ description: The internal ID of this entity.
+ example: 6
+ type: integer
+ created:
+ description: The time this entity was created.
+ example: 2020-06-10T09:05:27.993483Z
+ format: date-time
+ type: string
+ modified:
+ description: The time this entity was last modified.
+ example: 2021-09-12T10:12:42Z
+ format: date-time
+ type: string
+ required:
+ - created
+ - createdBy
+ - data
+ - id
+ - modified
+ - modifiedBy
+ - name
+ - type
+ - webhooks
+ type: object
WebhookActivationLogEntry:
description: Log of activated webhooks.
example:
@@ -33847,17 +34327,14 @@ components:
webhookId:
description: ID of the webhook that triggered the request.
example: 1
- format: int64
type: integer
applicationId:
description: ID of the application that triggered the webhook.
example: 13
- format: int64
type: integer
campaignId:
description: ID of the campaign that triggered the webhook.
example: 86
- format: int64
type: integer
created:
description: Timestamp of request
@@ -33900,12 +34377,10 @@ components:
webhookId:
description: ID of the webhook that triggered the request.
example: 5
- format: int64
type: integer
applicationId:
description: ID of the application that triggered the webhook.
example: 12
- format: int64
type: integer
url:
description: The target URL of the request.
@@ -33925,7 +34400,6 @@ components:
status:
description: HTTP status code of response.
example: 204
- format: int64
type: integer
requestTime:
description: Timestamp of request
@@ -33987,7 +34461,6 @@ components:
status:
description: HTTP status code of the response.
example: 200
- format: int64
type: integer
type: object
MessageLogEntry:
@@ -34029,7 +34502,6 @@ components:
notificationId:
description: ID of the notification.
example: 101
- format: int64
type: integer
notificationName:
description: The name of the notification.
@@ -34038,7 +34510,6 @@ components:
webhookId:
description: ID of the webhook.
example: 101
- format: int64
type: integer
webhookName:
description: The name of the webhook.
@@ -34069,19 +34540,16 @@ components:
applicationId:
description: Identifier of the Application.
example: 5
- format: int64
minimum: 1
type: integer
loyaltyProgramId:
description: Identifier of the loyalty program.
example: 2
- format: int64
minimum: 1
type: integer
campaignId:
description: Identifier of the campaign.
example: 2
- format: int64
minimum: 1
type: integer
required:
@@ -34183,9 +34651,8 @@ components:
title: Survey Completed
properties:
id:
- description: Internal ID of this entity.
+ description: The internal ID of this entity.
example: 6
- format: int64
type: integer
created:
description: The time this entity was created.
@@ -34247,9 +34714,8 @@ components:
additionalAttributes: {}
properties:
id:
- description: Internal ID of this entity.
+ description: The internal ID of this entity.
example: 6
- format: int64
type: integer
created:
description: The time this entity was created.
@@ -34269,7 +34735,6 @@ components:
accountId:
description: The ID of the account that owns this entity.
example: 3886
- format: int64
type: integer
name:
description: Name of the user.
@@ -34305,7 +34770,6 @@ components:
example:
- 71
items:
- format: int64
type: integer
type: array
authMethod:
@@ -34393,7 +34857,6 @@ components:
- 1
- 3
items:
- format: int64
type: integer
type: array
applicationNotificationSubscriptions:
@@ -34454,6 +34917,158 @@ components:
required:
- data
type: object
+ ScimGroupMember:
+ description: Member of the SCIM group. In Talon.One, the member is a [user](https://docs.talon.one/docs/product/account/account-settings/managing-users)
+ assigned to a specific role.
+ example:
+ display: john.doe@example.com
+ value: "258"
+ properties:
+ value:
+ description: Unique identifier of the member.
+ example: "258"
+ type: string
+ display:
+ description: Identifier of the user. This is usually an email address.
+ example: john.doe@example.com
+ type: string
+ type: object
+ ScimBaseGroup:
+ description: Define the schema for base fields in a group using the SCIM provisioning
+ protocol. Talon.One uses this schema to create roles.
+ example:
+ displayName: Manager
+ members:
+ - display: john.doe@example.com
+ value: "258"
+ - display: john.doe@example.com
+ value: "258"
+ properties:
+ displayName:
+ description: Display name of the group (Talon.One role).
+ example: Manager
+ type: string
+ members:
+ description: List of members to assign to the new Talon.One role.
+ items:
+ $ref: '#/components/schemas/ScimGroupMember'
+ type: array
+ type: object
+ ScimGroup:
+ description: |-
+ Define the schema for groups created using the SCIM provisioning protocol.
+ In Talon.One, a `Group` corresponds to a [role](https://docs.talon.one/docs/product/account/account-settings/managing-roles), and `members` are the [users](https://docs.talon.one/docs/product/account/account-settings/managing-users) assigned to that role.
+ example:
+ displayName: Manager
+ members:
+ - display: john.doe@example.com
+ value: "258"
+ - display: john.doe@example.com
+ value: "258"
+ id: "359"
+ properties:
+ displayName:
+ description: Display name of the group (Talon.One role).
+ example: Manager
+ type: string
+ members:
+ description: List of members to assign to the new Talon.One role.
+ items:
+ $ref: '#/components/schemas/ScimGroupMember'
+ type: array
+ id:
+ description: ID of the group.
+ example: "359"
+ type: string
+ required:
+ - id
+ type: object
+ ScimGroupsListResponse:
+ description: |-
+ List of groups created using the SCIM provisioning protocol with an identity provider, for example, Microsoft Entra ID.
+ In Talon.One, a `Group` corresponds to a [role](https://docs.talon.one/docs/product/account/account-settings/managing-roles), and `members` are the [users](https://docs.talon.one/docs/product/account/account-settings/managing-users) assigned to that role.
+ example:
+ Resources:
+ - displayName: Manager Role
+ id: "283"
+ meta:
+ resourceType: Group
+ created: 2024-06-25T17:43:46+02:00
+ members:
+ - value: "15"
+ display: john.doe@example.com
+ schemas:
+ - urn:ietf:params:scim:schemas:core:2.0:Group
+ schemas:
+ - urn:ietf:params:scim:api:messages:2.0:ListResponse
+ totalResults: 1
+ properties:
+ Resources:
+ items:
+ $ref: '#/components/schemas/ScimGroup'
+ type: array
+ schemas:
+ description: SCIM schema for the given resource.
+ items:
+ example: urn:ietf:params:scim:api:messages:2.0:ListResponse
+ type: string
+ type: array
+ totalResults:
+ description: Number of results in the response.
+ type: integer
+ required:
+ - Resources
+ type: object
+ ScimPatchOperation:
+ description: Patch operation that is used to update the information.
+ example:
+ op: add
+ path: nickName
+ value: John
+ properties:
+ op:
+ description: The method that should be used in the operation.
+ enum:
+ - add
+ - remove
+ - replace
+ type: string
+ path:
+ description: The path specifying the attribute that should be updated.
+ type: string
+ value:
+ description: The value that should be updated. Required if `op` is `add`
+ or `replace`.
+ type: string
+ required:
+ - op
+ type: object
+ ScimPatchRequest:
+ description: SCIM Patch request
+ example:
+ Operations:
+ - op: replace
+ path: active
+ value: test
+ - op: add
+ path: nickName
+ value: johndoe
+ schemas:
+ - urn:ietf:params:scim:api:messages:2.0:PatchOp
+ properties:
+ schemas:
+ description: SCIM schema for the given resource.
+ items:
+ example: urn:ietf:params:scim:api:messages:2.0:PatchOp
+ type: string
+ type: array
+ Operations:
+ items:
+ $ref: '#/components/schemas/ScimPatchOperation'
+ type: array
+ required:
+ - Operations
+ type: object
ScimBaseUser:
description: Schema definition for base user fields, provisioned using the SCIM
protocol and used by Talon.One.
@@ -34564,61 +35179,10 @@ components:
type: array
totalResults:
description: Number of total results in the response.
- format: int64
type: integer
required:
- Resources
type: object
- ScimPatchOperation:
- description: Patch operation that is used to update the information.
- example:
- op: add
- path: nickName
- value: John
- properties:
- op:
- description: The method that should be used in the operation.
- enum:
- - add
- - remove
- - replace
- type: string
- path:
- description: The path specifying the attribute that should be updated.
- type: string
- value:
- description: The value that should be updated. Required if `op` is `add`
- or `replace`.
- type: string
- required:
- - op
- type: object
- ScimPatchRequest:
- description: SCIM Patch request
- example:
- Operations:
- - op: replace
- path: active
- value: test
- - op: add
- path: nickName
- value: johndoe
- schemas:
- - urn:ietf:params:scim:api:messages:2.0:PatchOp
- properties:
- schemas:
- description: SCIM schema for the given resource.
- items:
- example: urn:ietf:params:scim:api:messages:2.0:PatchOp
- type: string
- type: array
- Operations:
- items:
- $ref: '#/components/schemas/ScimPatchOperation'
- type: array
- required:
- - Operations
- type: object
ScimResource:
description: Resource definition for the SCIM provisioning protocol.
example:
@@ -34766,7 +35330,6 @@ components:
type: array
totalResults:
description: Number of total results in the response.
- format: int64
type: integer
required:
- Resources
@@ -34879,9 +35442,8 @@ components:
managementKeyId: 3
properties:
id:
- description: Internal ID of this entity.
+ description: The internal ID of this entity.
example: 6
- format: int64
type: integer
created:
description: The time this entity was created.
@@ -34891,12 +35453,10 @@ components:
userId:
description: The ID of the user associated with this entity.
example: 388
- format: int64
type: integer
applicationId:
description: ID of application associated with change.
example: 359
- format: int64
type: integer
entity:
description: API endpoint on which the change was initiated.
@@ -34924,7 +35484,6 @@ components:
managementKeyId:
description: ID of management key used to perform changes.
example: 3
- format: int64
type: integer
required:
- created
@@ -34960,7 +35519,6 @@ components:
description: A list of the IDs of the roles assigned to the user.
items:
example: 13
- format: int64
type: integer
type: array
acl:
@@ -35114,9 +35672,8 @@ components:
userLimit: 6
properties:
id:
- description: Internal ID of this entity.
+ description: The internal ID of this entity.
example: 6
- format: int64
type: integer
created:
description: The time this entity was created.
@@ -35153,37 +35710,29 @@ components:
type: string
applicationLimit:
description: The maximum number of Applications covered by your plan.
- format: int64
type: integer
userLimit:
description: The maximum number of Campaign Manager Users covered by your
plan.
- format: int64
type: integer
campaignLimit:
description: The maximum number of Campaigns covered by your plan.
- format: int64
type: integer
apiLimit:
description: The maximum number of Integration API calls covered by your
plan per billing period.
- format: int64
type: integer
applicationCount:
description: The current number of Applications in your account.
- format: int64
type: integer
userCount:
description: The current number of Campaign Manager Users in your account.
- format: int64
type: integer
campaignsActiveCount:
description: The current number of active Campaigns in your account.
- format: int64
type: integer
campaignsInactiveCount:
description: The current number of inactive Campaigns in your account.
- format: int64
type: integer
attributes:
description: Arbitrary properties associated with this campaign.
@@ -35228,97 +35777,78 @@ components:
applications:
description: Total number of applications in the account.
example: 11
- format: int64
type: integer
liveApplications:
description: Total number of live applications in the account.
example: 6
- format: int64
type: integer
sandboxApplications:
description: Total number of sandbox applications in the account.
example: 2
- format: int64
type: integer
campaigns:
description: Total number of campaigns in the account.
example: 35
- format: int64
type: integer
activeCampaigns:
description: Total number of active campaigns in the account.
example: 15
- format: int64
type: integer
liveActiveCampaigns:
description: Total number of active campaigns in live applications in the
account.
example: 10
- format: int64
type: integer
coupons:
description: Total number of coupons in the account.
example: 850
- format: int64
type: integer
activeCoupons:
description: Total number of active coupons in the account.
example: 650
- format: int64
type: integer
expiredCoupons:
description: Total number of expired coupons in the account.
example: 200
- format: int64
type: integer
referralCodes:
description: Total number of referral codes in the account.
example: 500
- format: int64
type: integer
activeReferralCodes:
description: Total number of active referral codes in the account.
example: 100
- format: int64
type: integer
expiredReferralCodes:
description: Total number of expired referral codes in the account.
example: 400
- format: int64
type: integer
activeRules:
description: Total number of active rules in the account.
example: 35
- format: int64
type: integer
users:
description: Total number of users in the account.
- format: int64
type: integer
roles:
description: Total number of roles in the account.
example: 10
- format: int64
type: integer
customAttributes:
description: Total number of custom attributes in the account.
example: 18
- format: int64
type: integer
webhooks:
description: Total number of webhooks in the account.
example: 2
- format: int64
type: integer
loyaltyPrograms:
description: Total number of all loyalty programs in the account.
example: 5
- format: int64
type: integer
liveLoyaltyPrograms:
description: Total number of live loyalty programs in the account.
example: 5
- format: int64
type: integer
lastUpdatedAt:
description: The point in time when the analytics numbers were updated last.
@@ -35351,48 +35881,37 @@ components:
properties:
liveApplications:
description: Total number of allowed live applications in the account.
- format: int64
type: integer
sandboxApplications:
description: Total number of allowed sandbox applications in the account.
- format: int64
type: integer
activeCampaigns:
description: Total number of allowed active campaigns in live applications
in the account.
- format: int64
type: integer
coupons:
description: Total number of allowed coupons in the account.
- format: int64
type: integer
referralCodes:
description: Total number of allowed referral codes in the account.
- format: int64
type: integer
activeRules:
description: Total number of allowed active rulesets in the account.
- format: int64
type: integer
liveLoyaltyPrograms:
description: Total number of allowed live loyalty programs in the account.
- format: int64
type: integer
sandboxLoyaltyPrograms:
description: Total number of allowed sandbox loyalty programs in the account.
- format: int64
type: integer
webhooks:
description: Total number of allowed webhooks in the account.
- format: int64
type: integer
users:
description: Total number of allowed users in the account.
- format: int64
type: integer
apiVolume:
description: Allowed volume of API requests to the account.
- format: int64
type: integer
promotionTypes:
description: Array of promotion types that are employed in the account.
@@ -35423,9 +35942,8 @@ components:
entity: Coupon
properties:
id:
- description: Internal ID of this entity.
+ description: The internal ID of this entity.
example: 6
- format: int64
type: integer
created:
description: The time this entity was created.
@@ -35435,12 +35953,10 @@ components:
accountId:
description: The ID of the account that owns this entity.
example: 3886
- format: int64
type: integer
userId:
description: The ID of the user associated with this entity.
example: 388
- format: int64
type: integer
entity:
description: The name of the entity that was exported.
@@ -35469,7 +35985,6 @@ components:
ManagerConfig:
properties:
schemaVersion:
- format: int64
type: integer
required:
- schemaVersion
@@ -35479,27 +35994,21 @@ components:
properties:
disabled:
description: Number of disabled campaigns.
- format: int64
type: integer
staged:
description: Number of staged campaigns.
- format: int64
type: integer
scheduled:
description: Number of scheduled campaigns.
- format: int64
type: integer
running:
description: Number of running campaigns.
- format: int64
type: integer
expired:
description: Number of expired campaigns.
- format: int64
type: integer
archived:
description: Number of archived campaigns.
- format: int64
type: integer
required:
- archived
@@ -35536,7 +36045,6 @@ components:
- 475
- 18
items:
- format: int64
type: integer
type: array
type: object
@@ -35563,7 +36071,6 @@ components:
- 475
- 18
items:
- format: int64
type: integer
type: array
required:
@@ -35581,7 +36088,6 @@ components:
- 475
- 18
items:
- format: int64
type: integer
type: array
roles:
@@ -35590,7 +36096,6 @@ components:
- 128
- 147
items:
- format: int64
type: integer
type: array
required:
@@ -35851,7 +36356,6 @@ components:
- 10
- 12
items:
- format: int64
type: integer
type: array
type: object
@@ -35905,9 +36409,8 @@ components:
id: 6
properties:
id:
- description: Internal ID of this entity.
+ description: The internal ID of this entity.
example: 6
- format: int64
type: integer
created:
description: The time this entity was created.
@@ -35922,7 +36425,6 @@ components:
accountId:
description: The ID of the account that owns this entity.
example: 3886
- format: int64
type: integer
name:
description: Name of the role.
@@ -35941,7 +36443,6 @@ components:
- 10
- 12
items:
- format: int64
type: integer
type: array
required:
@@ -35969,7 +36470,6 @@ components:
- 10
- 12
items:
- format: int64
type: integer
type: array
required:
@@ -36019,7 +36519,6 @@ components:
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
- format: int64
type: integer
required:
- expires
@@ -36068,27 +36567,22 @@ components:
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
- format: int64
type: integer
id:
description: ID of the API Key.
example: 34
- format: int64
type: integer
createdBy:
description: ID of user who created.
example: 280
- format: int64
type: integer
accountID:
description: ID of account the key is used for.
example: 13
- format: int64
type: integer
applicationID:
description: ID of application the key is used for.
example: 54
- format: int64
type: integer
created:
description: The date the API key was created.
@@ -36147,27 +36641,22 @@ components:
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
- format: int64
type: integer
id:
description: ID of the API Key.
example: 34
- format: int64
type: integer
createdBy:
description: ID of user who created.
example: 280
- format: int64
type: integer
accountID:
description: ID of account the key is used for.
example: 13
- format: int64
type: integer
applicationID:
description: ID of application the key is used for.
example: 54
- format: int64
type: integer
created:
description: The date the API key was created.
@@ -36194,7 +36683,6 @@ components:
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
- format: int64
type: integer
required:
- timeOffset
@@ -36203,7 +36691,6 @@ components:
properties:
id:
description: id of the notification.
- format: int64
type: integer
name:
description: name of the notification.
@@ -36225,7 +36712,6 @@ components:
notificationId:
description: The ID of the notification.
example: 1
- format: int64
type: integer
notificationName:
description: The name of the notification.
@@ -36236,7 +36722,6 @@ components:
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
- format: int64
type: integer
enabled:
description: Indicates whether the notification is activated.
@@ -36286,7 +36771,6 @@ components:
- 2
- 3
items:
- format: int64
type: integer
type: array
required:
@@ -36319,23 +36803,19 @@ components:
- 2
- 3
items:
- format: int64
type: integer
type: array
id:
description: ID of the management key.
example: 34
- format: int64
type: integer
createdBy:
description: ID of the user who created it.
example: 280
- format: int64
type: integer
accountID:
description: ID of account the key is used for.
example: 13
- format: int64
type: integer
created:
description: The date the management key was created.
@@ -36381,23 +36861,19 @@ components:
- 2
- 3
items:
- format: int64
type: integer
type: array
id:
description: ID of the management key.
example: 34
- format: int64
type: integer
createdBy:
description: ID of the user who created it.
example: 280
- format: int64
type: integer
accountID:
description: ID of account the key is used for.
example: 13
- format: int64
type: integer
created:
description: The date the management key was created.
@@ -36431,7 +36907,6 @@ components:
description: Unique ID for this entity. Not to be confused with the Integration
ID, which is set by your integration layer and used in most endpoints.
example: 6
- format: int64
type: integer
created:
example: 2021-07-20T22:00:00Z
@@ -36440,11 +36915,9 @@ components:
createdBy:
description: The ID of the user who created the value map.
example: 216
- format: int64
type: integer
campaignId:
example: 244
- format: int64
type: integer
required:
- campaignId
@@ -36532,9 +37005,8 @@ components:
updated: 2021-09-23T10:12:42Z
properties:
id:
- description: Internal ID of this entity.
+ description: The internal ID of this entity.
example: 6
- format: int64
type: integer
created:
description: The time this entity was created.
@@ -36571,7 +37043,6 @@ components:
applicationId:
description: The ID of the Application that owns this entity.
example: 322
- format: int64
type: integer
updated:
description: Timestamp of the most recent update on this entity.
@@ -36586,7 +37057,6 @@ components:
- 6
- 8
items:
- format: int64
type: integer
type: array
required:
@@ -36604,7 +37074,6 @@ components:
description: The ID of the campaign that references the application cart
item filter.
example: 1
- format: int64
type: integer
campaignName:
description: A user-facing name for this campaign.
@@ -36619,7 +37088,6 @@ components:
description: The ID of the Application Cart Item Filter that is referenced
by a campaign.
example: 322
- format: int64
type: integer
campaigns:
description: Campaigns that reference a speciifc Application Cart Item Filter.
@@ -36637,13 +37105,11 @@ components:
description: The ID of the expression that the Application cart item filter
uses.
example: 1
- format: int64
type: integer
modifiedBy:
description: The ID of the user who last updated the Application cart item
filter.
example: 334
- format: int64
type: integer
modified:
description: Timestamp of the most recent update to the Application cart
@@ -36656,12 +37122,10 @@ components:
cartItemFilterId:
description: The ID of the Application cart item filter.
example: 216
- format: int64
type: integer
createdBy:
description: The ID of the user who created the Application cart item filter.
example: 216
- format: int64
type: integer
expression:
description: Arbitrary additional JSON data associated with the Application
@@ -36687,9 +37151,8 @@ components:
ApplicationCIFExpression:
properties:
id:
- description: Internal ID of this entity.
+ description: The internal ID of this entity.
example: 6
- format: int64
type: integer
created:
description: The time this entity was created.
@@ -36699,12 +37162,10 @@ components:
cartItemFilterId:
description: The ID of the Application cart item filter.
example: 216
- format: int64
type: integer
createdBy:
description: The ID of the user who created the Application cart item filter.
example: 216
- format: int64
type: integer
expression:
description: Arbitrary additional JSON data associated with the Application
@@ -36729,7 +37190,6 @@ components:
applicationId:
description: The ID of the Application that owns this entity.
example: 322
- format: int64
type: integer
required:
- applicationId
@@ -36737,9 +37197,12 @@ components:
- id
type: object
ListCampaignStoreBudgetsStore:
+ example:
+ name: name
+ integrationId: integrationId
+ id: 0
properties:
id:
- format: int64
type: integer
integrationId:
type: string
@@ -36751,11 +37214,18 @@ components:
- name
type: object
ListCampaignStoreBudgets:
+ example:
+ period: period
+ limit: 6
+ action: action
+ store:
+ name: name
+ integrationId: integrationId
+ id: 0
properties:
store:
$ref: '#/components/schemas/ListCampaignStoreBudgetsStore'
limit:
- format: int64
type: integer
action:
type: string
@@ -36767,13 +37237,15 @@ components:
- store
type: object
NewCampaignStoreBudgetStoreLimit:
+ example:
+ limit: 1000.0
+ storeId: 17
properties:
storeId:
description: |
The ID of the store.
You can get this ID with the [List stores](#tag/Stores/operation/listStores) endpoint.
example: 17
- format: int64
type: integer
limit:
description: The value to set for the limit.
@@ -36784,6 +37256,14 @@ components:
- storeId
type: object
NewCampaignStoreBudget:
+ example:
+ period: daily
+ action: setDiscount
+ storeLimits:
+ - limit: 1000.0
+ storeId: 17
+ - limit: 1000.0
+ storeId: 17
properties:
action:
enum:
@@ -36806,6 +37286,11 @@ components:
- storeLimits
type: object
SummaryCampaignStoreBudget:
+ example:
+ period: overall
+ imported: true
+ storeCount: 0
+ action: redeemCoupon
properties:
action:
enum:
@@ -36834,7 +37319,6 @@ components:
- yearly
type: string
storeCount:
- format: int64
type: integer
imported:
type: boolean
@@ -36921,9 +37405,11 @@ components:
The policy that determines if and how the achievement recurs.
- `no_recurrence`: The achievement can be completed only once.
- `on_expiration`: The achievement resets after it expires and becomes available again.
+ - `on_completion`: When the customer progress status reaches `completed`, the achievement resets and becomes available again.
enum:
- no_recurrence
- on_expiration
+ - on_completion
example: no_recurrence
type: string
activationPolicy:
@@ -37054,7 +37540,6 @@ components:
campaignId:
description: The ID of the campaign.
example: 1
- format: int64
type: integer
campaignName:
description: The name of the campaign.
@@ -37109,7 +37594,6 @@ components:
productId:
description: The ID of the product.
example: 1
- format: int64
type: integer
value:
description: The string matching the given value. Either a product name
@@ -37120,7 +37604,6 @@ components:
description: The ID of the SKU linked to a product. If empty, this is an
product.
example: 1
- format: int64
type: integer
required:
- value
@@ -37130,7 +37613,6 @@ components:
id:
description: The ID of the product.
example: 1
- format: int64
type: integer
name:
description: The name of the product.
@@ -37140,7 +37622,6 @@ components:
description: |
The ID of the catalog. You can find the ID in the Campaign Manager in **Account** > **Tools** > **Cart item catalogs**.
example: 1
- format: int64
type: integer
unitsSold:
$ref: '#/components/schemas/AnalyticsDataPointWithTrend'
@@ -37165,7 +37646,6 @@ components:
productId:
description: The ID of the product.
example: 1
- format: int64
type: integer
productName:
description: The name of the product.
@@ -37195,7 +37675,6 @@ components:
id:
description: The ID of the SKU linked to the application.
example: 1
- format: int64
type: integer
sku:
description: The SKU linked to the application.
@@ -37252,7 +37731,6 @@ components:
properties:
rulesetID:
description: ID of a ruleset.
- format: int64
type: integer
currency:
description: Currency for the campaign.
@@ -37265,7 +37743,6 @@ components:
properties:
rulesetID:
description: ID of a ruleset.
- format: int64
type: integer
required:
- rulesetID
@@ -37303,7 +37780,6 @@ components:
applicationId:
description: The ID of the Application whose campaign evaluation tree changed.
example: 78
- format: int64
type: integer
oldEvaluationTree:
$ref: '#/components/schemas/CampaignSet'
@@ -37367,7 +37843,6 @@ components:
description: The ID of the campaign evaluation group the campaign belongs
to.
example: 2
- format: int64
type: integer
groupName:
description: The name of the campaign evaluation group the campaign belongs
@@ -37377,7 +37852,6 @@ components:
position:
description: The position of the campaign node in its parent group.
example: 2
- format: int64
type: integer
required:
- groupId
@@ -37440,7 +37914,6 @@ components:
id:
description: The ID of the event that triggered the strikethrough labeling.
example: 1
- format: int64
type: integer
type:
description: The type of event that triggered the strikethrough labeling.
@@ -37478,12 +37951,10 @@ components:
id:
description: The ID of the event that triggered the strikethrough labeling.
example: 1
- format: int64
type: integer
catalogId:
description: The ID of the catalog that the changed item belongs to.
example: 10
- format: int64
type: integer
sku:
description: The unique SKU of the changed item.
@@ -37492,7 +37963,6 @@ components:
version:
description: The version of the changed item.
example: 6
- format: int64
minimum: 1
type: integer
price:
@@ -37551,7 +38021,6 @@ components:
properties:
totalResultSize:
example: 1
- format: int64
type: integer
data:
items:
@@ -37609,7 +38078,6 @@ components:
properties:
totalResultSize:
example: 1
- format: int64
type: integer
data:
items:
@@ -37675,7 +38143,6 @@ components:
properties:
totalResultSize:
example: 1
- format: int64
type: integer
data:
items:
@@ -37701,7 +38168,6 @@ components:
properties:
totalResultSize:
example: 1
- format: int64
type: integer
data:
items:
@@ -38275,7 +38741,6 @@ components:
properties:
totalResultSize:
example: 1
- format: int64
type: integer
data:
items:
@@ -38595,7 +39060,6 @@ components:
properties:
totalResultSize:
example: 1
- format: int64
type: integer
data:
items:
@@ -38630,15 +39094,21 @@ components:
- 10
- 100
bindings:
- - expression:
+ - attributeId: 100
+ minValue: 0.0
+ expression:
- string1
- string2
+ maxValue: 19.9
valueType: string
name: my property
type: templateParameter
- - expression:
+ - attributeId: 100
+ minValue: 0.0
+ expression:
- string1
- string2
+ maxValue: 19.9
valueType: string
name: my property
type: templateParameter
@@ -38662,15 +39132,21 @@ components:
- 10
- 100
bindings:
- - expression:
+ - attributeId: 100
+ minValue: 0.0
+ expression:
- string1
- string2
+ maxValue: 19.9
valueType: string
name: my property
type: templateParameter
- - expression:
+ - attributeId: 100
+ minValue: 0.0
+ expression:
- string1
- string2
+ maxValue: 19.9
valueType: string
name: my property
type: templateParameter
@@ -38696,15 +39172,21 @@ components:
- 10
- 100
bindings:
- - expression:
+ - attributeId: 100
+ minValue: 0.0
+ expression:
- string1
- string2
+ maxValue: 19.9
valueType: string
name: my property
type: templateParameter
- - expression:
+ - attributeId: 100
+ minValue: 0.0
+ expression:
- string1
- string2
+ maxValue: 19.9
valueType: string
name: my property
type: templateParameter
@@ -38728,15 +39210,21 @@ components:
- 10
- 100
bindings:
- - expression:
+ - attributeId: 100
+ minValue: 0.0
+ expression:
- string1
- string2
+ maxValue: 19.9
valueType: string
name: my property
type: templateParameter
- - expression:
+ - attributeId: 100
+ minValue: 0.0
+ expression:
- string1
- string2
+ maxValue: 19.9
valueType: string
name: my property
type: templateParameter
@@ -38769,15 +39257,21 @@ components:
- 10
- 100
bindings:
- - expression:
+ - attributeId: 100
+ minValue: 0.0
+ expression:
- string1
- string2
+ maxValue: 19.9
valueType: string
name: my property
type: templateParameter
- - expression:
+ - attributeId: 100
+ minValue: 0.0
+ expression:
- string1
- string2
+ maxValue: 19.9
valueType: string
name: my property
type: templateParameter
@@ -38801,15 +39295,21 @@ components:
- 10
- 100
bindings:
- - expression:
+ - attributeId: 100
+ minValue: 0.0
+ expression:
- string1
- string2
+ maxValue: 19.9
valueType: string
name: my property
type: templateParameter
- - expression:
+ - attributeId: 100
+ minValue: 0.0
+ expression:
- string1
- string2
+ maxValue: 19.9
valueType: string
name: my property
type: templateParameter
@@ -38835,15 +39335,21 @@ components:
- 10
- 100
bindings:
- - expression:
+ - attributeId: 100
+ minValue: 0.0
+ expression:
- string1
- string2
+ maxValue: 19.9
valueType: string
name: my property
type: templateParameter
- - expression:
+ - attributeId: 100
+ minValue: 0.0
+ expression:
- string1
- string2
+ maxValue: 19.9
valueType: string
name: my property
type: templateParameter
@@ -38867,15 +39373,21 @@ components:
- 10
- 100
bindings:
- - expression:
+ - attributeId: 100
+ minValue: 0.0
+ expression:
- string1
- string2
+ maxValue: 19.9
valueType: string
name: my property
type: templateParameter
- - expression:
+ - attributeId: 100
+ minValue: 0.0
+ expression:
- string1
- string2
+ maxValue: 19.9
valueType: string
name: my property
type: templateParameter
@@ -38889,7 +39401,6 @@ components:
properties:
totalResultSize:
example: 1
- format: int64
type: integer
data:
items:
@@ -38969,7 +39480,6 @@ components:
properties:
totalResultSize:
example: 1
- format: int64
type: integer
data:
items:
@@ -39137,7 +39647,6 @@ components:
properties:
totalResultSize:
example: 1
- format: int64
type: integer
data:
items:
@@ -39612,7 +40121,6 @@ components:
properties:
totalResultSize:
example: 1
- format: int64
type: integer
data:
items:
@@ -39654,7 +40162,6 @@ components:
properties:
totalResultSize:
example: 1
- format: int64
type: integer
data:
items:
@@ -39916,7 +40423,6 @@ components:
type: boolean
totalResultSize:
example: 1
- format: int64
type: integer
data:
items:
@@ -40037,7 +40543,6 @@ components:
properties:
totalResultSize:
example: 1
- format: int64
type: integer
data:
items:
@@ -40098,7 +40603,6 @@ components:
properties:
totalResultSize:
example: 1
- format: int64
type: integer
hasMore:
type: boolean
@@ -40161,7 +40665,6 @@ components:
hasMore:
type: boolean
totalResultSize:
- format: int64
type: integer
data:
items:
@@ -40220,7 +40723,6 @@ components:
hasMore:
type: boolean
totalResultSize:
- format: int64
type: integer
data:
items:
@@ -40350,19 +40852,31 @@ components:
returnedQuantity: 1
length: 1.4658129805029452
weight: 1130.0
+ adjustmentReferenceId: 68851723-e6fa-488f-ace9-112581e6c19b
+ adjustmentEffectiveFrom: 2021-09-12T10:12:42Z
catalogItemID: 5
additionalCosts:
shipping:
price: 9
price: 99.99
+ selectedPriceType: member
name: Air Glide
width: 6.027456183070403
attributes:
image: 11.jpeg
material: leather
+ adjustmentEffectiveUntil: 2021-09-12T10:12:42Z
position: 5.962133916683182
sku: SKU1241028
category: shoes
+ prices:
+ member:
+ price: 90
+ adjustmentReferenceId: 68851723-e6fa-488f-ace9-112581e6c19b
+ effectiveFrom: 2025-05-25T00:00:00Z
+ effectiveUntil: 2025-05-30T00:00:00Z
+ base:
+ price: 100
height: 0.8008281904610115
- remainingQuantity: 1
product:
@@ -40371,19 +40885,31 @@ components:
returnedQuantity: 1
length: 1.4658129805029452
weight: 1130.0
+ adjustmentReferenceId: 68851723-e6fa-488f-ace9-112581e6c19b
+ adjustmentEffectiveFrom: 2021-09-12T10:12:42Z
catalogItemID: 5
additionalCosts:
shipping:
price: 9
price: 99.99
+ selectedPriceType: member
name: Air Glide
width: 6.027456183070403
attributes:
image: 11.jpeg
material: leather
+ adjustmentEffectiveUntil: 2021-09-12T10:12:42Z
position: 5.962133916683182
sku: SKU1241028
category: shoes
+ prices:
+ member:
+ price: 90
+ adjustmentReferenceId: 68851723-e6fa-488f-ace9-112581e6c19b
+ effectiveFrom: 2025-05-25T00:00:00Z
+ effectiveUntil: 2025-05-30T00:00:00Z
+ base:
+ price: 100
height: 0.8008281904610115
- coupon: BKDB946
created: 2020-02-07T08:15:22Z
@@ -40408,19 +40934,31 @@ components:
returnedQuantity: 1
length: 1.4658129805029452
weight: 1130.0
+ adjustmentReferenceId: 68851723-e6fa-488f-ace9-112581e6c19b
+ adjustmentEffectiveFrom: 2021-09-12T10:12:42Z
catalogItemID: 5
additionalCosts:
shipping:
price: 9
price: 99.99
+ selectedPriceType: member
name: Air Glide
width: 6.027456183070403
attributes:
image: 11.jpeg
material: leather
+ adjustmentEffectiveUntil: 2021-09-12T10:12:42Z
position: 5.962133916683182
sku: SKU1241028
category: shoes
+ prices:
+ member:
+ price: 90
+ adjustmentReferenceId: 68851723-e6fa-488f-ace9-112581e6c19b
+ effectiveFrom: 2025-05-25T00:00:00Z
+ effectiveUntil: 2025-05-30T00:00:00Z
+ base:
+ price: 100
height: 0.8008281904610115
- remainingQuantity: 1
product:
@@ -40429,19 +40967,31 @@ components:
returnedQuantity: 1
length: 1.4658129805029452
weight: 1130.0
+ adjustmentReferenceId: 68851723-e6fa-488f-ace9-112581e6c19b
+ adjustmentEffectiveFrom: 2021-09-12T10:12:42Z
catalogItemID: 5
additionalCosts:
shipping:
price: 9
price: 99.99
+ selectedPriceType: member
name: Air Glide
width: 6.027456183070403
attributes:
image: 11.jpeg
material: leather
+ adjustmentEffectiveUntil: 2021-09-12T10:12:42Z
position: 5.962133916683182
sku: SKU1241028
category: shoes
+ prices:
+ member:
+ price: 90
+ adjustmentReferenceId: 68851723-e6fa-488f-ace9-112581e6c19b
+ effectiveFrom: 2025-05-25T00:00:00Z
+ effectiveUntil: 2025-05-30T00:00:00Z
+ base:
+ price: 100
height: 0.8008281904610115
hasMore: true
properties:
@@ -40464,9 +41014,12 @@ components:
conditionIndex: 786
evaluationGroupMode: stackable
effectType: rejectCoupon
+ adjustmentReferenceId: 68851723-e6fa-488f-ace9-112581e6c19b
props: '{}'
+ selectedPrice: 100.0
evaluationGroupID: 3
triggeredForCatalogItem: 786
+ selectedPriceType: member
campaignRevisionId: 1
ruleName: Give 20% discount
triggeredByCoupon: 4928
@@ -40477,9 +41030,12 @@ components:
conditionIndex: 786
evaluationGroupMode: stackable
effectType: rejectCoupon
+ adjustmentReferenceId: 68851723-e6fa-488f-ace9-112581e6c19b
props: '{}'
+ selectedPrice: 100.0
evaluationGroupID: 3
triggeredForCatalogItem: 786
+ selectedPriceType: member
campaignRevisionId: 1
ruleName: Give 20% discount
triggeredByCoupon: 4928
@@ -40529,9 +41085,12 @@ components:
conditionIndex: 786
evaluationGroupMode: stackable
effectType: rejectCoupon
+ adjustmentReferenceId: 68851723-e6fa-488f-ace9-112581e6c19b
props: '{}'
+ selectedPrice: 100.0
evaluationGroupID: 3
triggeredForCatalogItem: 786
+ selectedPriceType: member
campaignRevisionId: 1
ruleName: Give 20% discount
triggeredByCoupon: 4928
@@ -40542,9 +41101,12 @@ components:
conditionIndex: 786
evaluationGroupMode: stackable
effectType: rejectCoupon
+ adjustmentReferenceId: 68851723-e6fa-488f-ace9-112581e6c19b
props: '{}'
+ selectedPrice: 100.0
evaluationGroupID: 3
triggeredForCatalogItem: 786
+ selectedPriceType: member
campaignRevisionId: 1
ruleName: Give 20% discount
triggeredByCoupon: 4928
@@ -40606,7 +41168,6 @@ components:
properties:
totalResultSize:
example: 1
- format: int64
type: integer
data:
items:
@@ -40645,7 +41206,6 @@ components:
type: boolean
totalResultSize:
example: 1
- format: int64
type: integer
data:
items:
@@ -40747,7 +41307,6 @@ components:
type: boolean
totalResultSize:
example: 1
- format: int64
type: integer
data:
items:
@@ -40820,7 +41379,6 @@ components:
properties:
totalResultSize:
example: 1
- format: int64
type: integer
data:
items:
@@ -40869,7 +41427,6 @@ components:
type: boolean
totalResultSize:
example: 1
- format: int64
type: integer
data:
items:
@@ -40904,7 +41461,6 @@ components:
properties:
totalResultSize:
example: 1
- format: int64
type: integer
data:
items:
@@ -40933,6 +41489,7 @@ components:
outgoingIntegrationTypeId: 1
outgoingIntegrationTypeName: Braze
payload: "{\n\t\"message\": \"${message}\"\n}"
+ draft: false
modified: 2021-09-12T10:12:42Z
id: 6
- headers:
@@ -40952,13 +41509,13 @@ components:
outgoingIntegrationTypeId: 1
outgoingIntegrationTypeName: Braze
payload: "{\n\t\"message\": \"${message}\"\n}"
+ draft: false
modified: 2021-09-12T10:12:42Z
id: 6
totalResultSize: 1
properties:
totalResultSize:
example: 1
- format: int64
type: integer
data:
items:
@@ -40984,7 +41541,6 @@ components:
properties:
totalResultSize:
example: 1
- format: int64
type: integer
data:
items:
@@ -41026,7 +41582,6 @@ components:
properties:
totalResultSize:
example: 1
- format: int64
type: integer
data:
items:
@@ -41052,7 +41607,6 @@ components:
properties:
totalResultSize:
example: 1
- format: int64
type: integer
data:
items:
@@ -41106,7 +41660,6 @@ components:
properties:
totalResultSize:
example: 1
- format: int64
type: integer
data:
items:
@@ -41157,7 +41710,6 @@ components:
properties:
totalResultSize:
example: 1
- format: int64
type: integer
hasMore:
type: boolean
@@ -41186,7 +41738,6 @@ components:
properties:
totalResultSize:
example: 1
- format: int64
type: integer
data:
items:
@@ -41294,7 +41845,6 @@ components:
properties:
totalResultSize:
example: 1
- format: int64
type: integer
data:
items:
@@ -41341,7 +41891,6 @@ components:
type: boolean
totalResultSize:
example: 1
- format: int64
type: integer
data:
items:
@@ -41350,6 +41899,44 @@ components:
required:
- data
inline_response_200_48:
+ example:
+ data:
+ - period: period
+ limit: 6
+ action: action
+ store:
+ name: name
+ integrationId: integrationId
+ id: 0
+ - period: period
+ limit: 6
+ action: action
+ store:
+ name: name
+ integrationId: integrationId
+ id: 0
+ properties:
+ data:
+ items:
+ $ref: '#/components/schemas/ListCampaignStoreBudgets'
+ type: array
+ inline_response_200_49:
+ example:
+ data:
+ - period: overall
+ imported: true
+ storeCount: 0
+ action: redeemCoupon
+ - period: overall
+ imported: true
+ storeCount: 0
+ action: redeemCoupon
+ properties:
+ data:
+ items:
+ $ref: '#/components/schemas/SummaryCampaignStoreBudget'
+ type: array
+ inline_response_200_50:
example:
data:
- period: 1Y
@@ -41406,7 +41993,7 @@ components:
type: array
required:
- data
- inline_response_200_49:
+ inline_response_200_51:
example:
data:
- endDate: 2000-01-23T04:56:07.000+00:00
@@ -41499,12 +42086,10 @@ components:
maxOperations:
description: The maximum number of individual operations that can be included
in a single bulk request.
- format: int64
type: integer
maxPayloadSize:
description: The maximum size, in bytes, of the entire payload for a bulk
operation request.
- format: int64
type: integer
supported:
description: Indicates whether the SCIM service provider supports bulk operations.
@@ -41523,7 +42108,6 @@ components:
maxResults:
description: The maximum number of resources that can be returned in a single
filtered query response.
- format: int64
type: integer
supported:
description: Indicates whether the SCIM service provider supports filtering
diff --git a/build.gradle b/build.gradle
index 6aaaca43..ab112bb3 100644
--- a/build.gradle
+++ b/build.gradle
@@ -3,7 +3,7 @@ apply plugin: 'eclipse'
apply plugin: 'java'
group = 'one.talon'
-version = '12.0.0'
+version = '0.0.0'
buildscript {
repositories {
@@ -102,7 +102,7 @@ dependencies {
compile "com.google.code.findbugs:jsr305:3.0.2"
compile 'com.squareup.okhttp3:okhttp:3.14.7'
compile 'com.squareup.okhttp3:logging-interceptor:3.14.7'
- compile 'com.google.code.gson:gson:2.13.0'
+ compile 'com.google.code.gson:gson:2.8.6'
compile 'io.gsonfire:gson-fire:1.8.4'
compile group: 'org.apache.commons', name: 'commons-lang3', version: '3.10'
compile 'org.threeten:threetenbp:1.4.3'
diff --git a/build.sbt b/build.sbt
index 0f1d76e2..ff48a2a9 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 := "12.0.0",
+ version := "0.0.0",
scalaVersion := "2.11.4",
scalacOptions ++= Seq("-feature"),
javacOptions in compile ++= Seq("-Xlint:deprecation"),
diff --git a/docs/AccessLogEntry.md b/docs/AccessLogEntry.md
index 18bd6335..ace849e4 100644
--- a/docs/AccessLogEntry.md
+++ b/docs/AccessLogEntry.md
@@ -8,7 +8,7 @@ Log of application accesses.
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**uuid** | **String** | UUID reference of request. |
-**status** | **Long** | HTTP status code of response. |
+**status** | **Integer** | HTTP status code of response. |
**method** | **String** | HTTP method of request. |
**requestUri** | **String** | target URI of request |
**time** | [**OffsetDateTime**](OffsetDateTime.md) | timestamp of request |
diff --git a/docs/Account.md b/docs/Account.md
index a7225212..f7fe8398 100644
--- a/docs/Account.md
+++ b/docs/Account.md
@@ -6,7 +6,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**id** | **Long** | Internal ID of this entity. |
+**id** | **Integer** | The 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. |
**companyName** | **String** | |
@@ -15,14 +15,14 @@ Name | Type | Description | Notes
**billingEmail** | **String** | The billing email address associated with your company account. |
**planName** | **String** | The name of your booked plan. | [optional]
**planExpires** | [**OffsetDateTime**](OffsetDateTime.md) | The point in time at which your current plan expires. | [optional]
-**applicationLimit** | **Long** | The maximum number of Applications covered by your plan. | [optional]
-**userLimit** | **Long** | The maximum number of Campaign Manager Users covered by your plan. | [optional]
-**campaignLimit** | **Long** | The maximum number of Campaigns covered by your plan. | [optional]
-**apiLimit** | **Long** | The maximum number of Integration API calls covered by your plan per billing period. | [optional]
-**applicationCount** | **Long** | The current number of Applications in your account. |
-**userCount** | **Long** | The current number of Campaign Manager Users in your account. |
-**campaignsActiveCount** | **Long** | The current number of active Campaigns in your account. |
-**campaignsInactiveCount** | **Long** | The current number of inactive Campaigns in your account. |
+**applicationLimit** | **Integer** | The maximum number of Applications covered by your plan. | [optional]
+**userLimit** | **Integer** | The maximum number of Campaign Manager Users covered by your plan. | [optional]
+**campaignLimit** | **Integer** | The maximum number of Campaigns covered by your plan. | [optional]
+**apiLimit** | **Integer** | The maximum number of Integration API calls covered by your plan per billing period. | [optional]
+**applicationCount** | **Integer** | The current number of Applications in your account. |
+**userCount** | **Integer** | The current number of Campaign Manager Users in your account. |
+**campaignsActiveCount** | **Integer** | The current number of active Campaigns in your account. |
+**campaignsInactiveCount** | **Integer** | The current number of inactive Campaigns in your account. |
**attributes** | [**Object**](.md) | Arbitrary properties associated with this campaign. | [optional]
diff --git a/docs/AccountAdditionalCost.md b/docs/AccountAdditionalCost.md
index b33ce618..6859bbd6 100644
--- a/docs/AccountAdditionalCost.md
+++ b/docs/AccountAdditionalCost.md
@@ -6,13 +6,13 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**id** | **Long** | Internal ID of this entity. |
+**id** | **Integer** | The internal ID of this entity. |
**created** | [**OffsetDateTime**](OffsetDateTime.md) | The time this entity was created. |
-**accountId** | **Long** | The ID of the account that owns this entity. |
+**accountId** | **Integer** | The ID of the account that owns this entity. |
**name** | **String** | The internal name used in API requests. |
**title** | **String** | The human-readable name for the additional cost that will be shown in the Campaign Manager. Like `name`, the combination of entity and title must also be unique. |
**description** | **String** | A description of this additional cost. |
-**subscribedApplicationsIds** | **List<Long>** | A list of the IDs of the applications that are subscribed to this additional cost. | [optional]
+**subscribedApplicationsIds** | **List<Integer>** | A list of the IDs of the applications that are subscribed to this additional cost. | [optional]
**type** | [**TypeEnum**](#TypeEnum) | The type of additional cost. Possible value: - `session`: Additional cost will be added per session. - `item`: Additional cost will be added per item. - `both`: Additional cost will be added per item and session. | [optional]
diff --git a/docs/AccountAnalytics.md b/docs/AccountAnalytics.md
index 4021c107..7ed9e219 100644
--- a/docs/AccountAnalytics.md
+++ b/docs/AccountAnalytics.md
@@ -6,25 +6,25 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**applications** | **Long** | Total number of applications in the account. |
-**liveApplications** | **Long** | Total number of live applications in the account. |
-**sandboxApplications** | **Long** | Total number of sandbox applications in the account. |
-**campaigns** | **Long** | Total number of campaigns in the account. |
-**activeCampaigns** | **Long** | Total number of active campaigns in the account. |
-**liveActiveCampaigns** | **Long** | Total number of active campaigns in live applications in the account. |
-**coupons** | **Long** | Total number of coupons in the account. |
-**activeCoupons** | **Long** | Total number of active coupons in the account. |
-**expiredCoupons** | **Long** | Total number of expired coupons in the account. |
-**referralCodes** | **Long** | Total number of referral codes in the account. |
-**activeReferralCodes** | **Long** | Total number of active referral codes in the account. |
-**expiredReferralCodes** | **Long** | Total number of expired referral codes in the account. |
-**activeRules** | **Long** | Total number of active rules in the account. |
-**users** | **Long** | Total number of users in the account. |
-**roles** | **Long** | Total number of roles in the account. |
-**customAttributes** | **Long** | Total number of custom attributes in the account. |
-**webhooks** | **Long** | Total number of webhooks in the account. |
-**loyaltyPrograms** | **Long** | Total number of all loyalty programs in the account. |
-**liveLoyaltyPrograms** | **Long** | Total number of live loyalty programs in the account. |
+**applications** | **Integer** | Total number of applications in the account. |
+**liveApplications** | **Integer** | Total number of live applications in the account. |
+**sandboxApplications** | **Integer** | Total number of sandbox applications in the account. |
+**campaigns** | **Integer** | Total number of campaigns in the account. |
+**activeCampaigns** | **Integer** | Total number of active campaigns in the account. |
+**liveActiveCampaigns** | **Integer** | Total number of active campaigns in live applications in the account. |
+**coupons** | **Integer** | Total number of coupons in the account. |
+**activeCoupons** | **Integer** | Total number of active coupons in the account. |
+**expiredCoupons** | **Integer** | Total number of expired coupons in the account. |
+**referralCodes** | **Integer** | Total number of referral codes in the account. |
+**activeReferralCodes** | **Integer** | Total number of active referral codes in the account. |
+**expiredReferralCodes** | **Integer** | Total number of expired referral codes in the account. |
+**activeRules** | **Integer** | Total number of active rules in the account. |
+**users** | **Integer** | Total number of users in the account. |
+**roles** | **Integer** | Total number of roles in the account. |
+**customAttributes** | **Integer** | Total number of custom attributes in the account. |
+**webhooks** | **Integer** | Total number of webhooks in the account. |
+**loyaltyPrograms** | **Integer** | Total number of all loyalty programs in the account. |
+**liveLoyaltyPrograms** | **Integer** | Total number of live loyalty programs in the account. |
**lastUpdatedAt** | [**OffsetDateTime**](OffsetDateTime.md) | The point in time when the analytics numbers were updated last. |
diff --git a/docs/AccountDashboardStatisticCampaigns.md b/docs/AccountDashboardStatisticCampaigns.md
index 19c0b8fc..a727d02a 100644
--- a/docs/AccountDashboardStatisticCampaigns.md
+++ b/docs/AccountDashboardStatisticCampaigns.md
@@ -6,9 +6,9 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**live** | **Long** | Number of campaigns that are active and live (across all Applications). |
-**endingSoon** | **Long** | Campaigns scheduled to expire sometime in the next 7 days. |
-**lowOnBudget** | **Long** | Campaigns with less than 10% of budget left. |
+**live** | **Integer** | Number of campaigns that are active and live (across all Applications). |
+**endingSoon** | **Integer** | Campaigns scheduled to expire sometime in the next 7 days. |
+**lowOnBudget** | **Integer** | Campaigns with less than 10% of budget left. |
diff --git a/docs/AccountEntity.md b/docs/AccountEntity.md
index 6b677e46..51f7598c 100644
--- a/docs/AccountEntity.md
+++ b/docs/AccountEntity.md
@@ -6,7 +6,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**accountId** | **Long** | The ID of the account that owns this entity. |
+**accountId** | **Integer** | The ID of the account that owns this entity. |
diff --git a/docs/AccountLimits.md b/docs/AccountLimits.md
index 3b1f4c78..945c85d7 100644
--- a/docs/AccountLimits.md
+++ b/docs/AccountLimits.md
@@ -6,17 +6,17 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**liveApplications** | **Long** | Total number of allowed live applications in the account. |
-**sandboxApplications** | **Long** | Total number of allowed sandbox applications in the account. |
-**activeCampaigns** | **Long** | Total number of allowed active campaigns in live applications in the account. |
-**coupons** | **Long** | Total number of allowed coupons in the account. |
-**referralCodes** | **Long** | Total number of allowed referral codes in the account. |
-**activeRules** | **Long** | Total number of allowed active rulesets in the account. |
-**liveLoyaltyPrograms** | **Long** | Total number of allowed live loyalty programs in the account. |
-**sandboxLoyaltyPrograms** | **Long** | Total number of allowed sandbox loyalty programs in the account. |
-**webhooks** | **Long** | Total number of allowed webhooks in the account. |
-**users** | **Long** | Total number of allowed users in the account. |
-**apiVolume** | **Long** | Allowed volume of API requests to the account. |
+**liveApplications** | **Integer** | Total number of allowed live applications in the account. |
+**sandboxApplications** | **Integer** | Total number of allowed sandbox applications in the account. |
+**activeCampaigns** | **Integer** | Total number of allowed active campaigns in live applications in the account. |
+**coupons** | **Integer** | Total number of allowed coupons in the account. |
+**referralCodes** | **Integer** | Total number of allowed referral codes in the account. |
+**activeRules** | **Integer** | Total number of allowed active rulesets in the account. |
+**liveLoyaltyPrograms** | **Integer** | Total number of allowed live loyalty programs in the account. |
+**sandboxLoyaltyPrograms** | **Integer** | Total number of allowed sandbox loyalty programs in the account. |
+**webhooks** | **Integer** | Total number of allowed webhooks in the account. |
+**users** | **Integer** | Total number of allowed users in the account. |
+**apiVolume** | **Integer** | Allowed volume of API requests to the account. |
**promotionTypes** | **List<String>** | Array of promotion types that are employed in the account. |
diff --git a/docs/Achievement.md b/docs/Achievement.md
index 31fac2fc..7adeb2e2 100644
--- a/docs/Achievement.md
+++ b/docs/Achievement.md
@@ -6,7 +6,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**id** | **Long** | Internal ID of this entity. |
+**id** | **Integer** | The internal ID of this entity. |
**created** | [**OffsetDateTime**](OffsetDateTime.md) | The time this entity was created. |
**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. |
@@ -14,12 +14,12 @@ Name | Type | Description | Notes
**target** | [**BigDecimal**](BigDecimal.md) | The required number of actions or the transactional milestone to complete the achievement. |
**period** | **String** | The relative duration after which the achievement ends and resets for a particular customer profile. **Note**: The `period` does not start when the achievement is created. The period is a **positive real number** followed by one letter indicating the time unit. Examples: `30s`, `40m`, `1h`, `5D`, `7W`, `10M`, `15Y`. Available units: - `s`: seconds - `m`: minutes - `h`: hours - `D`: days - `W`: weeks - `M`: months - `Y`: years You can also round certain units down to the beginning of period and up to the end of period.: - `_D` for rounding down days only. Signifies the start of the day. Example: `30D_D` - `_U` for rounding up days, weeks, months and years. Signifies the end of the day, week, month or year. Example: `23W_U` **Note**: You can either use the round down and round up option or set an absolute period. | [optional]
**periodEndOverride** | [**TimePoint**](TimePoint.md) | | [optional]
-**recurrencePolicy** | [**RecurrencePolicyEnum**](#RecurrencePolicyEnum) | The policy that determines if and how the achievement recurs. - `no_recurrence`: The achievement can be completed only once. - `on_expiration`: The achievement resets after it expires and becomes available again. | [optional]
+**recurrencePolicy** | [**RecurrencePolicyEnum**](#RecurrencePolicyEnum) | The policy that determines if and how the achievement recurs. - `no_recurrence`: The achievement can be completed only once. - `on_expiration`: The achievement resets after it expires and becomes available again. - `on_completion`: When the customer progress status reaches `completed`, the achievement resets and becomes available again. | [optional]
**activationPolicy** | [**ActivationPolicyEnum**](#ActivationPolicyEnum) | The policy that determines how the achievement starts, ends, or resets. - `user_action`: The achievement ends or resets relative to when the customer started the achievement. - `fixed_schedule`: The achievement starts, ends, or resets for all customers following a fixed schedule. | [optional]
**fixedStartDate** | [**OffsetDateTime**](OffsetDateTime.md) | The achievement's start date when `activationPolicy` is set to `fixed_schedule`. **Note:** It must be an RFC3339 timestamp string. | [optional]
**endDate** | [**OffsetDateTime**](OffsetDateTime.md) | The achievement's end date. If defined, customers cannot participate in the achievement after this date. **Note:** It must be an RFC3339 timestamp string. | [optional]
-**campaignId** | **Long** | The ID of the campaign the achievement belongs to. |
-**userId** | **Long** | ID of the user that created this achievement. |
+**campaignId** | **Integer** | The ID of the campaign 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. | [optional]
**hasProgress** | **Boolean** | Indicates if a customer has made progress in the achievement. | [optional]
**status** | [**StatusEnum**](#StatusEnum) | The status of the achievement. | [optional]
@@ -32,6 +32,7 @@ Name | Value
---- | -----
NO_RECURRENCE | "no_recurrence"
ON_EXPIRATION | "on_expiration"
+ON_COMPLETION | "on_completion"
diff --git a/docs/AchievementAdditionalProperties.md b/docs/AchievementAdditionalProperties.md
index c0e74bd4..ee0d3e2c 100644
--- a/docs/AchievementAdditionalProperties.md
+++ b/docs/AchievementAdditionalProperties.md
@@ -6,8 +6,8 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**campaignId** | **Long** | The ID of the campaign the achievement belongs to. |
-**userId** | **Long** | ID of the user that created this achievement. |
+**campaignId** | **Integer** | The ID of the campaign 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. | [optional]
**hasProgress** | **Boolean** | Indicates if a customer has made progress in the achievement. | [optional]
**status** | [**StatusEnum**](#StatusEnum) | The status of the achievement. | [optional]
diff --git a/docs/AchievementBase.md b/docs/AchievementBase.md
index 049729a0..20c9d4ce 100644
--- a/docs/AchievementBase.md
+++ b/docs/AchievementBase.md
@@ -12,7 +12,7 @@ Name | Type | Description | Notes
**target** | [**BigDecimal**](BigDecimal.md) | The required number of actions or the transactional milestone to complete the achievement. | [optional]
**period** | **String** | The relative duration after which the achievement ends and resets for a particular customer profile. **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. | [optional]
**periodEndOverride** | [**TimePoint**](TimePoint.md) | | [optional]
-**recurrencePolicy** | [**RecurrencePolicyEnum**](#RecurrencePolicyEnum) | The policy that determines if and how the achievement recurs. - `no_recurrence`: The achievement can be completed only once. - `on_expiration`: The achievement resets after it expires and becomes available again. | [optional]
+**recurrencePolicy** | [**RecurrencePolicyEnum**](#RecurrencePolicyEnum) | The policy that determines if and how the achievement recurs. - `no_recurrence`: The achievement can be completed only once. - `on_expiration`: The achievement resets after it expires and becomes available again. - `on_completion`: When the customer progress status reaches `completed`, the achievement resets and becomes available again. | [optional]
**activationPolicy** | [**ActivationPolicyEnum**](#ActivationPolicyEnum) | The policy that determines how the achievement starts, ends, or resets. - `user_action`: The achievement ends or resets relative to when the customer started the achievement. - `fixed_schedule`: The achievement starts, ends, or resets for all customers following a fixed schedule. | [optional]
**fixedStartDate** | [**OffsetDateTime**](OffsetDateTime.md) | The achievement's start date when `activationPolicy` is set to `fixed_schedule`. **Note:** It must be an RFC3339 timestamp string. | [optional]
**endDate** | [**OffsetDateTime**](OffsetDateTime.md) | The achievement's end date. If defined, customers cannot participate in the achievement after this date. **Note:** It must be an RFC3339 timestamp string. | [optional]
@@ -25,6 +25,7 @@ Name | Value
---- | -----
NO_RECURRENCE | "no_recurrence"
ON_EXPIRATION | "on_expiration"
+ON_COMPLETION | "on_completion"
diff --git a/docs/AchievementProgressWithDefinition.md b/docs/AchievementProgressWithDefinition.md
index adc274ab..93d47acc 100644
--- a/docs/AchievementProgressWithDefinition.md
+++ b/docs/AchievementProgressWithDefinition.md
@@ -12,13 +12,13 @@ Name | Type | Description | Notes
**startDate** | [**OffsetDateTime**](OffsetDateTime.md) | Timestamp at which the customer started the achievement. | [optional]
**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. | [optional]
-**achievementId** | **Long** | The internal ID of the achievement. |
+**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. |
**description** | **String** | The description of the achievement in the Campaign Manager. |
-**campaignId** | **Long** | The ID of the campaign the achievement belongs to. |
+**campaignId** | **Integer** | The ID of the campaign the achievement belongs to. |
**target** | [**BigDecimal**](BigDecimal.md) | The required number of actions or the transactional milestone to complete the achievement. | [optional]
-**achievementRecurrencePolicy** | [**AchievementRecurrencePolicyEnum**](#AchievementRecurrencePolicyEnum) | The policy that determines if and how the achievement recurs. - `no_recurrence`: The achievement can be completed only once. - `on_expiration`: The achievement resets after it expires and becomes available again. |
+**achievementRecurrencePolicy** | [**AchievementRecurrencePolicyEnum**](#AchievementRecurrencePolicyEnum) | The policy that determines if and how the achievement recurs. - `no_recurrence`: The achievement can be completed only once. - `on_expiration`: The achievement resets after it expires and becomes available again. - `on_completion`: When the customer progress status reaches `completed`, the achievement resets and becomes available again. |
**achievementActivationPolicy** | [**AchievementActivationPolicyEnum**](#AchievementActivationPolicyEnum) | The policy that determines how the achievement starts, ends, or resets. - `user_action`: The achievement ends or resets relative to when the customer started the achievement. - `fixed_schedule`: The achievement starts, ends, or resets for all customers following a fixed schedule. |
**achievementFixedStartDate** | [**OffsetDateTime**](OffsetDateTime.md) | The achievement's start date when `achievementActivationPolicy` is equal to `fixed_schedule`. **Note:** It is an RFC3339 timestamp string. | [optional]
**achievementEndDate** | [**OffsetDateTime**](OffsetDateTime.md) | The achievement's end date. If defined, customers cannot participate in the achievement after this date. **Note:** It is an RFC3339 timestamp string. | [optional]
@@ -42,6 +42,7 @@ Name | Value
---- | -----
NO_RECURRENCE | "no_recurrence"
ON_EXPIRATION | "on_expiration"
+ON_COMPLETION | "on_completion"
diff --git a/docs/AchievementStatusEntry.md b/docs/AchievementStatusEntry.md
index fa44fd9f..7c87feba 100644
--- a/docs/AchievementStatusEntry.md
+++ b/docs/AchievementStatusEntry.md
@@ -6,7 +6,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**id** | **Long** | Internal ID of this entity. |
+**id** | **Integer** | The internal ID of this entity. |
**created** | [**OffsetDateTime**](OffsetDateTime.md) | The time this entity was created. |
**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. |
@@ -14,11 +14,11 @@ Name | Type | Description | Notes
**target** | [**BigDecimal**](BigDecimal.md) | The required number of actions or the transactional milestone to complete the achievement. |
**period** | **String** | The relative duration after which the achievement ends and resets for a particular customer profile. **Note**: The `period` does not start when the achievement is created. The period is a **positive real number** followed by one letter indicating the time unit. Examples: `30s`, `40m`, `1h`, `5D`, `7W`, `10M`, `15Y`. Available units: - `s`: seconds - `m`: minutes - `h`: hours - `D`: days - `W`: weeks - `M`: months - `Y`: years You can also round certain units down to the beginning of period and up to the end of period.: - `_D` for rounding down days only. Signifies the start of the day. Example: `30D_D` - `_U` for rounding up days, weeks, months and years. Signifies the end of the day, week, month or year. Example: `23W_U` **Note**: You can either use the round down and round up option or set an absolute period. | [optional]
**periodEndOverride** | [**TimePoint**](TimePoint.md) | | [optional]
-**recurrencePolicy** | [**RecurrencePolicyEnum**](#RecurrencePolicyEnum) | The policy that determines if and how the achievement recurs. - `no_recurrence`: The achievement can be completed only once. - `on_expiration`: The achievement resets after it expires and becomes available again. | [optional]
+**recurrencePolicy** | [**RecurrencePolicyEnum**](#RecurrencePolicyEnum) | The policy that determines if and how the achievement recurs. - `no_recurrence`: The achievement can be completed only once. - `on_expiration`: The achievement resets after it expires and becomes available again. - `on_completion`: When the customer progress status reaches `completed`, the achievement resets and becomes available again. | [optional]
**activationPolicy** | [**ActivationPolicyEnum**](#ActivationPolicyEnum) | The policy that determines how the achievement starts, ends, or resets. - `user_action`: The achievement ends or resets relative to when the customer started the achievement. - `fixed_schedule`: The achievement starts, ends, or resets for all customers following a fixed schedule. | [optional]
**fixedStartDate** | [**OffsetDateTime**](OffsetDateTime.md) | The achievement's start date when `activationPolicy` is set to `fixed_schedule`. **Note:** It must be an RFC3339 timestamp string. | [optional]
**endDate** | [**OffsetDateTime**](OffsetDateTime.md) | The achievement's end date. If defined, customers cannot participate in the achievement after this date. **Note:** It must be an RFC3339 timestamp string. | [optional]
-**campaignId** | **Long** | The ID of the campaign the achievement belongs to. | [optional]
+**campaignId** | **Integer** | The ID of the campaign the achievement belongs to. | [optional]
**status** | [**StatusEnum**](#StatusEnum) | The status of the achievement. | [optional]
**currentProgress** | [**AchievementProgress**](AchievementProgress.md) | | [optional]
@@ -30,6 +30,7 @@ Name | Value
---- | -----
NO_RECURRENCE | "no_recurrence"
ON_EXPIRATION | "on_expiration"
+ON_COMPLETION | "on_completion"
diff --git a/docs/AddFreeItemEffectProps.md b/docs/AddFreeItemEffectProps.md
index 602629d9..21b04439 100644
--- a/docs/AddFreeItemEffectProps.md
+++ b/docs/AddFreeItemEffectProps.md
@@ -9,7 +9,7 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**sku** | **String** | SKU of the item that needs to be added. |
**name** | **String** | The name / description of the effect |
-**desiredQuantity** | **Long** | The original quantity in case a partial reward was applied. | [optional]
+**desiredQuantity** | **Integer** | The original quantity in case a partial reward was applied. | [optional]
diff --git a/docs/AddLoyaltyPoints.md b/docs/AddLoyaltyPoints.md
index c7b8a9bb..bf2da991 100644
--- a/docs/AddLoyaltyPoints.md
+++ b/docs/AddLoyaltyPoints.md
@@ -14,7 +14,7 @@ Name | Type | Description | Notes
**pendingDuration** | **String** | The amount of time before the points are considered valid. The time format is either: - `immediate` or, - an **integer** followed by one letter indicating the time unit. Examples: `immediate`, `30s`, `40m`, `1h`, `5D`, `7W`, `10M`, `15Y`. Available units: - `s`: seconds - `m`: minutes - `h`: hours - `D`: days - `W`: weeks - `M`: months - `Y`: years You can round certain units up or down: - `_D` for rounding down days only. Signifies the start of the day. - `_U` for rounding up days, weeks, months and years. Signifies the end of the day, week, month or year. | [optional]
**pendingUntil** | [**OffsetDateTime**](OffsetDateTime.md) | Date and time after the points are considered valid. The value should be provided in RFC 3339 format. If passed, `pendingDuration` should be omitted. | [optional]
**subledgerId** | **String** | ID of the subledger the points are added to. If there is no existing subledger with this ID, the subledger is created automatically. | [optional]
-**applicationId** | **Long** | ID of the Application that is connected to the loyalty program. It is displayed in your Talon.One deployment URL. | [optional]
+**applicationId** | **Integer** | ID of the Application that is connected to the loyalty program. It is displayed in your Talon.One deployment URL. | [optional]
diff --git a/docs/AddLoyaltyPointsEffectProps.md b/docs/AddLoyaltyPointsEffectProps.md
index ada3b99d..2757cd22 100644
--- a/docs/AddLoyaltyPointsEffectProps.md
+++ b/docs/AddLoyaltyPointsEffectProps.md
@@ -8,7 +8,7 @@ The properties specific to the \"addLoyaltyPoints\" effect. This gets triggered
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **String** | The name / description of this loyalty point addition. |
-**programId** | **Long** | The ID of the loyalty program where these points were added. |
+**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. |
**value** | [**BigDecimal**](BigDecimal.md) | The amount of points that were added. |
**desiredValue** | [**BigDecimal**](BigDecimal.md) | The original amount of loyalty points to be awarded. | [optional]
@@ -19,7 +19,7 @@ Name | Type | Description | Notes
**cartItemPosition** | [**BigDecimal**](BigDecimal.md) | The index of the item in the cart items list on which the loyal points addition should be applied. | [optional]
**cartItemSubPosition** | [**BigDecimal**](BigDecimal.md) | For cart items with `quantity` > 1, the sub position indicates to which item the loyalty points addition is applied. | [optional]
**cardIdentifier** | **String** | The alphanumeric identifier of the loyalty card. | [optional]
-**bundleIndex** | **Long** | The position of the bundle in a list of item bundles created from the same bundle definition. | [optional]
+**bundleIndex** | **Integer** | The position of the bundle in a list of item bundles created from the same bundle definition. | [optional]
**bundleName** | **String** | The name of the bundle definition. | [optional]
diff --git a/docs/AddPriceAdjustmentCatalogAction.md b/docs/AddPriceAdjustmentCatalogAction.md
new file mode 100644
index 00000000..329d41a2
--- /dev/null
+++ b/docs/AddPriceAdjustmentCatalogAction.md
@@ -0,0 +1,14 @@
+
+
+# AddPriceAdjustmentCatalogAction
+
+The specific properties of the \"ADD_PRICE_ADJUSTMENT\" catalog sync action.
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**sku** | **String** | The SKU of the item for which the price is being adjusted. |
+**adjustments** | [**List<NewPriceAdjustment>**](NewPriceAdjustment.md) | A list of adjustments to apply to a given item. |
+
+
+
diff --git a/docs/AddToAudienceEffectProps.md b/docs/AddToAudienceEffectProps.md
index e75e7fbc..47a83438 100644
--- a/docs/AddToAudienceEffectProps.md
+++ b/docs/AddToAudienceEffectProps.md
@@ -7,10 +7,10 @@ The properties specific to the \"addToAudience\" effect. This gets triggered whe
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**audienceId** | **Long** | The internal ID of the audience. | [optional]
+**audienceId** | **Integer** | The internal ID of the audience. | [optional]
**audienceName** | **String** | The name of the audience. | [optional]
**profileIntegrationId** | **String** | The ID of the customer profile in the third-party integration platform. | [optional]
-**profileId** | **Long** | The internal ID of the customer profile. | [optional]
+**profileId** | **Integer** | The internal ID of the customer profile. | [optional]
diff --git a/docs/AddedDeductedPointsBalancesNotificationPolicy.md b/docs/AddedDeductedPointsBalancesNotificationPolicy.md
new file mode 100644
index 00000000..6d029fbf
--- /dev/null
+++ b/docs/AddedDeductedPointsBalancesNotificationPolicy.md
@@ -0,0 +1,24 @@
+
+
+# AddedDeductedPointsBalancesNotificationPolicy
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | Notification name. |
+**scopes** | [**List<ScopesEnum>**](#List<ScopesEnum>) | |
+
+
+
+## Enum: List<ScopesEnum>
+
+Name | Value
+---- | -----
+ALL | "all"
+CAMPAIGN_MANAGER | "campaign_manager"
+MANAGEMENT_API | "management_api"
+RULE_ENGINE | "rule_engine"
+
+
+
diff --git a/docs/AdditionalCampaignProperties.md b/docs/AdditionalCampaignProperties.md
index 341deb1a..639d47cc 100644
--- a/docs/AdditionalCampaignProperties.md
+++ b/docs/AdditionalCampaignProperties.md
@@ -7,29 +7,29 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**budgets** | [**List<CampaignBudget>**](CampaignBudget.md) | A list of all the budgets that are defined by this campaign and their usage. **Note:** Budgets that are not defined do not appear in this list and their usage is not counted until they are defined. | [optional]
-**couponRedemptionCount** | **Long** | This property is **deprecated**. The count should be available under *budgets* property. Number of coupons redeemed in the campaign. | [optional]
-**referralRedemptionCount** | **Long** | This property is **deprecated**. The count should be available under *budgets* property. Number of referral codes redeemed in the campaign. | [optional]
+**couponRedemptionCount** | **Integer** | This property is **deprecated**. The count should be available under *budgets* property. Number of coupons redeemed in the campaign. | [optional]
+**referralRedemptionCount** | **Integer** | This property is **deprecated**. The count should be available under *budgets* property. Number of referral codes redeemed in the campaign. | [optional]
**discountCount** | [**BigDecimal**](BigDecimal.md) | This property is **deprecated**. The count should be available under *budgets* property. Total amount of discounts redeemed in the campaign. | [optional]
-**discountEffectCount** | **Long** | This property is **deprecated**. The count should be available under *budgets* property. Total number of times discounts were redeemed in this campaign. | [optional]
-**couponCreationCount** | **Long** | This property is **deprecated**. The count should be available under *budgets* property. Total number of coupons created by rules in this campaign. | [optional]
-**customEffectCount** | **Long** | This property is **deprecated**. The count should be available under *budgets* property. Total number of custom effects triggered by rules in this campaign. | [optional]
-**referralCreationCount** | **Long** | This property is **deprecated**. The count should be available under *budgets* property. Total number of referrals created by rules in this campaign. | [optional]
-**addFreeItemEffectCount** | **Long** | 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. | [optional]
-**awardedGiveawaysCount** | **Long** | This property is **deprecated**. The count should be available under *budgets* property. Total number of giveaways awarded by rules in this campaign. | [optional]
+**discountEffectCount** | **Integer** | This property is **deprecated**. The count should be available under *budgets* property. Total number of times discounts were redeemed in this campaign. | [optional]
+**couponCreationCount** | **Integer** | This property is **deprecated**. The count should be available under *budgets* property. Total number of coupons created by rules in this campaign. | [optional]
+**customEffectCount** | **Integer** | This property is **deprecated**. The count should be available under *budgets* property. Total number of custom effects triggered by rules in this campaign. | [optional]
+**referralCreationCount** | **Integer** | This property is **deprecated**. The count should be available under *budgets* property. Total number of referrals created by rules in this campaign. | [optional]
+**addFreeItemEffectCount** | **Integer** | 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. | [optional]
+**awardedGiveawaysCount** | **Integer** | This property is **deprecated**. The count should be available under *budgets* property. Total number of giveaways awarded by rules in this campaign. | [optional]
**createdLoyaltyPointsCount** | [**BigDecimal**](BigDecimal.md) | This property is **deprecated**. The count should be available under *budgets* property. Total number of loyalty points created by rules in this campaign. | [optional]
-**createdLoyaltyPointsEffectCount** | **Long** | 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. | [optional]
+**createdLoyaltyPointsEffectCount** | **Integer** | 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. | [optional]
**redeemedLoyaltyPointsCount** | [**BigDecimal**](BigDecimal.md) | This property is **deprecated**. The count should be available under *budgets* property. Total number of loyalty points redeemed by rules in this campaign. | [optional]
-**redeemedLoyaltyPointsEffectCount** | **Long** | 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. | [optional]
-**callApiEffectCount** | **Long** | This property is **deprecated**. The count should be available under *budgets* property. Total number of webhooks triggered by rules in this campaign. | [optional]
-**reservecouponEffectCount** | **Long** | This property is **deprecated**. The count should be available under *budgets* property. Total number of reserve coupon effects triggered by rules in this campaign. | [optional]
+**redeemedLoyaltyPointsEffectCount** | **Integer** | 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. | [optional]
+**callApiEffectCount** | **Integer** | This property is **deprecated**. The count should be available under *budgets* property. Total number of webhooks triggered by rules in this campaign. | [optional]
+**reservecouponEffectCount** | **Integer** | This property is **deprecated**. The count should be available under *budgets* property. Total number of reserve coupon effects triggered by rules in this campaign. | [optional]
**lastActivity** | [**OffsetDateTime**](OffsetDateTime.md) | Timestamp of the most recent event received by this campaign. | [optional]
**updated** | [**OffsetDateTime**](OffsetDateTime.md) | 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. | [optional]
**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** | **Long** | The ID of the Campaign Template this Campaign was created from. | [optional]
+**templateId** | **Integer** | The ID of the Campaign Template this Campaign was created from. | [optional]
**frontendState** | [**FrontendStateEnum**](#FrontendStateEnum) | The campaign state displayed in the Campaign Manager. |
**storesImported** | **Boolean** | Indicates whether the linked stores were imported via a CSV file. |
-**valueMapsIds** | **List<Long>** | A list of value map IDs for the campaign. | [optional]
+**valueMapsIds** | **List<Integer>** | A list of value map IDs for the campaign. | [optional]
diff --git a/docs/AnalyticsProduct.md b/docs/AnalyticsProduct.md
index fc08da1b..b42d1478 100644
--- a/docs/AnalyticsProduct.md
+++ b/docs/AnalyticsProduct.md
@@ -6,9 +6,9 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**id** | **Long** | The ID of the product. |
+**id** | **Integer** | The ID of the product. |
**name** | **String** | The name of the product. |
-**catalogId** | **Long** | The ID of the catalog. You can find the ID in the Campaign Manager in **Account** > **Tools** > **Cart item catalogs**. |
+**catalogId** | **Integer** | The ID of the catalog. You can find the ID in the Campaign Manager in **Account** > **Tools** > **Cart item catalogs**. |
**unitsSold** | [**AnalyticsDataPointWithTrend**](AnalyticsDataPointWithTrend.md) | | [optional]
diff --git a/docs/AnalyticsSKU.md b/docs/AnalyticsSKU.md
index c0590672..8b1bf70f 100644
--- a/docs/AnalyticsSKU.md
+++ b/docs/AnalyticsSKU.md
@@ -6,7 +6,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**id** | **Long** | The ID of the SKU linked to the application. |
+**id** | **Integer** | The ID of the SKU linked to the application. |
**sku** | **String** | The SKU linked to the application. |
**lastUpdated** | [**OffsetDateTime**](OffsetDateTime.md) | Values in UTC for the date the SKU linked to the product was last updated. | [optional]
**unitsSold** | [**AnalyticsDataPointWithTrend**](AnalyticsDataPointWithTrend.md) | | [optional]
diff --git a/docs/Application.md b/docs/Application.md
index 8a48a665..f3e5787f 100644
--- a/docs/Application.md
+++ b/docs/Application.md
@@ -6,10 +6,10 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**id** | **Long** | Internal ID of this entity. |
+**id** | **Integer** | The 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. |
-**accountId** | **Long** | The ID of the account that owns this entity. |
+**accountId** | **Integer** | The ID of the account that owns this entity. |
**name** | **String** | The name of this application. |
**description** | **String** | A longer description of the application. | [optional]
**timezone** | **String** | A string containing an IANA timezone descriptor. |
@@ -24,8 +24,8 @@ Name | Type | Description | Notes
**sandbox** | **Boolean** | Indicates if this is a live or sandbox Application. | [optional]
**enablePartialDiscounts** | **Boolean** | Indicates if this Application supports partial discounts. | [optional]
**defaultDiscountAdditionalCostPerItemScope** | [**DefaultDiscountAdditionalCostPerItemScopeEnum**](#DefaultDiscountAdditionalCostPerItemScopeEnum) | The default scope to apply `setDiscountPerItem` effects on if no scope was provided with the effect. | [optional]
-**defaultEvaluationGroupId** | **Long** | The ID of the default campaign evaluation group to which new campaigns will be added unless a different group is selected when creating the campaign. | [optional]
-**defaultCartItemFilterId** | **Long** | The ID of the default Cart-Item-Filter for this application. | [optional]
+**defaultEvaluationGroupId** | **Integer** | The ID of the default campaign evaluation group to which new campaigns will be added unless a different group is selected when creating the campaign. | [optional]
+**defaultCartItemFilterId** | **Integer** | The ID of the default Cart-Item-Filter for this application. | [optional]
**enableCampaignStateManagement** | **Boolean** | Indicates whether the campaign staging and revisions feature is enabled for the Application. **Important:** After this feature is enabled, it cannot be disabled. | [optional]
**loyaltyPrograms** | [**List<LoyaltyProgram>**](LoyaltyProgram.md) | An array containing all the loyalty programs to which this application is subscribed. |
diff --git a/docs/ApplicationAPIKey.md b/docs/ApplicationAPIKey.md
index bf35028a..8a7622e3 100644
--- a/docs/ApplicationAPIKey.md
+++ b/docs/ApplicationAPIKey.md
@@ -10,11 +10,11 @@ Name | Type | Description | Notes
**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** | **Long** | 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** | **Long** | ID of the API Key. |
-**createdBy** | **Long** | ID of user who created. |
-**accountID** | **Long** | ID of account the key is used for. |
-**applicationID** | **Long** | ID of application the key is used for. |
+**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. |
+**applicationID** | **Integer** | ID of application the key is used for. |
**created** | [**OffsetDateTime**](OffsetDateTime.md) | The date the API key was created. |
diff --git a/docs/ApplicationCIF.md b/docs/ApplicationCIF.md
index 0ca112c6..c57d6ba3 100644
--- a/docs/ApplicationCIF.md
+++ b/docs/ApplicationCIF.md
@@ -6,15 +6,15 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**id** | **Long** | Internal ID of this entity. |
+**id** | **Integer** | The internal ID of this entity. |
**created** | [**OffsetDateTime**](OffsetDateTime.md) | The time this entity was created. |
**name** | **String** | The name of the Application cart item filter used in API requests. |
**description** | **String** | A short description of the Application cart item filter. | [optional]
-**activeExpressionId** | **Long** | The ID of the expression that the Application cart item filter uses. | [optional]
-**modifiedBy** | **Long** | The ID of the user who last updated the Application cart item filter. | [optional]
-**createdBy** | **Long** | The ID of the user who created the Application cart item filter. | [optional]
+**activeExpressionId** | **Integer** | The ID of the expression that the Application cart item filter uses. | [optional]
+**modifiedBy** | **Integer** | The ID of the user who last updated the Application cart item filter. | [optional]
+**createdBy** | **Integer** | The ID of the user who created the Application cart item filter. | [optional]
**modified** | [**OffsetDateTime**](OffsetDateTime.md) | Timestamp of the most recent update to the Application cart item filter. | [optional]
-**applicationId** | **Long** | The ID of the Application that owns this entity. |
+**applicationId** | **Integer** | The ID of the Application that owns this entity. |
diff --git a/docs/ApplicationCIFExpression.md b/docs/ApplicationCIFExpression.md
index 47591c76..cc645ee7 100644
--- a/docs/ApplicationCIFExpression.md
+++ b/docs/ApplicationCIFExpression.md
@@ -6,12 +6,12 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**id** | **Long** | Internal ID of this entity. |
+**id** | **Integer** | The internal ID of this entity. |
**created** | [**OffsetDateTime**](OffsetDateTime.md) | The time this entity was created. |
-**cartItemFilterId** | **Long** | The ID of the Application cart item filter. | [optional]
-**createdBy** | **Long** | The ID of the user who created the Application cart item filter. | [optional]
+**cartItemFilterId** | **Integer** | The ID of the Application cart item filter. | [optional]
+**createdBy** | **Integer** | The ID of the user who created the Application cart item filter. | [optional]
**expression** | **List<Object>** | Arbitrary additional JSON data associated with the Application cart item filter. | [optional]
-**applicationId** | **Long** | The ID of the Application that owns this entity. |
+**applicationId** | **Integer** | The ID of the Application that owns this entity. |
diff --git a/docs/ApplicationCIFReferences.md b/docs/ApplicationCIFReferences.md
index 1e847b33..6b32b1c8 100644
--- a/docs/ApplicationCIFReferences.md
+++ b/docs/ApplicationCIFReferences.md
@@ -6,7 +6,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**applicationCartItemFilterId** | **Long** | The ID of the Application Cart Item Filter that is referenced by a campaign. | [optional]
+**applicationCartItemFilterId** | **Integer** | The ID of the Application Cart Item Filter that is referenced by a campaign. | [optional]
**campaigns** | [**List<CampaignDetail>**](CampaignDetail.md) | Campaigns that reference a speciifc Application Cart Item Filter. | [optional]
diff --git a/docs/ApplicationCampaignAnalytics.md b/docs/ApplicationCampaignAnalytics.md
index 94aa70c3..b7cdda8d 100644
--- a/docs/ApplicationCampaignAnalytics.md
+++ b/docs/ApplicationCampaignAnalytics.md
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**startTime** | [**OffsetDateTime**](OffsetDateTime.md) | The start of the aggregation time frame in UTC. |
**endTime** | [**OffsetDateTime**](OffsetDateTime.md) | The end of the aggregation time frame in UTC. |
-**campaignId** | **Long** | The ID of the campaign. |
+**campaignId** | **Integer** | The ID of the campaign. |
**campaignName** | **String** | The name of the campaign. |
**campaignTags** | **List<String>** | A list of tags for the campaign. |
**campaignState** | [**CampaignStateEnum**](#CampaignStateEnum) | The state of the campaign. **Note:** A disabled or archived campaign is not evaluated for rules or coupons. |
diff --git a/docs/ApplicationCampaignStats.md b/docs/ApplicationCampaignStats.md
index a1125f33..6427b729 100644
--- a/docs/ApplicationCampaignStats.md
+++ b/docs/ApplicationCampaignStats.md
@@ -7,12 +7,12 @@ Provides statistics regarding an application's campaigns.
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**disabled** | **Long** | Number of disabled campaigns. |
-**staged** | **Long** | Number of staged campaigns. |
-**scheduled** | **Long** | Number of scheduled campaigns. |
-**running** | **Long** | Number of running campaigns. |
-**expired** | **Long** | Number of expired campaigns. |
-**archived** | **Long** | Number of archived campaigns. |
+**disabled** | **Integer** | Number of disabled campaigns. |
+**staged** | **Integer** | Number of staged campaigns. |
+**scheduled** | **Integer** | Number of scheduled campaigns. |
+**running** | **Integer** | Number of running campaigns. |
+**expired** | **Integer** | Number of expired campaigns. |
+**archived** | **Integer** | Number of archived campaigns. |
diff --git a/docs/ApplicationCustomer.md b/docs/ApplicationCustomer.md
index fe05c12d..d924d1f0 100644
--- a/docs/ApplicationCustomer.md
+++ b/docs/ApplicationCustomer.md
@@ -6,12 +6,12 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**id** | **Long** | Internal ID of this entity. |
+**id** | **Integer** | The internal ID of the customer profile. |
**created** | [**OffsetDateTime**](OffsetDateTime.md) | The time this entity was created. |
**integrationId** | **String** | The integration ID set by your integration layer. |
**attributes** | [**Object**](.md) | Arbitrary properties associated with this item. |
-**accountId** | **Long** | The ID of the Talon.One account that owns this profile. |
-**closedSessions** | **Long** | The total amount of closed sessions by a customer. A closed session is a successful purchase. |
+**accountId** | **Integer** | The ID of the Talon.One account that owns this profile. |
+**closedSessions** | **Integer** | The total number of closed sessions. Does not include closed sessions that have been cancelled or reopened. See the [docs](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions#customer-session-states). |
**totalSales** | [**BigDecimal**](BigDecimal.md) | The total amount of money spent by the customer **before** discounts are applied. The total sales amount excludes the following: - Cancelled or reopened sessions. - Returned items. |
**loyaltyMemberships** | [**List<LoyaltyMembership>**](LoyaltyMembership.md) | **DEPRECATED** A list of loyalty programs joined by the customer. | [optional]
**audienceMemberships** | [**List<AudienceMembership>**](AudienceMembership.md) | The audiences the customer belongs to. | [optional]
diff --git a/docs/ApplicationCustomerEntity.md b/docs/ApplicationCustomerEntity.md
index 65584939..1f4aa81a 100644
--- a/docs/ApplicationCustomerEntity.md
+++ b/docs/ApplicationCustomerEntity.md
@@ -6,7 +6,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**profileId** | **Long** | The globally unique Talon.One ID of the customer that created this entity. | [optional]
+**profileId** | **Integer** | The globally unique Talon.One ID of the customer that created this entity. | [optional]
diff --git a/docs/ApplicationEntity.md b/docs/ApplicationEntity.md
index be4d1e7e..36ea30be 100644
--- a/docs/ApplicationEntity.md
+++ b/docs/ApplicationEntity.md
@@ -6,7 +6,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**applicationId** | **Long** | The ID of the Application that owns this entity. |
+**applicationId** | **Integer** | The ID of the Application that owns this entity. |
diff --git a/docs/ApplicationEvent.md b/docs/ApplicationEvent.md
index a4012c5f..3497b31a 100644
--- a/docs/ApplicationEvent.md
+++ b/docs/ApplicationEvent.md
@@ -6,13 +6,13 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**id** | **Long** | Internal ID of this entity. |
+**id** | **Integer** | The internal ID of this entity. |
**created** | [**OffsetDateTime**](OffsetDateTime.md) | The time this entity was created. |
-**applicationId** | **Long** | The ID of the Application that owns this entity. |
-**profileId** | **Long** | The globally unique Talon.One ID of the customer that created this entity. | [optional]
-**storeId** | **Long** | The ID of the store. | [optional]
+**applicationId** | **Integer** | The ID of the Application that owns this entity. |
+**profileId** | **Integer** | The globally unique Talon.One ID of the customer that created this entity. | [optional]
+**storeId** | **Integer** | The ID of the store. | [optional]
**storeIntegrationId** | **String** | The integration ID of the store. You choose this ID when you create a store. | [optional]
-**sessionId** | **Long** | The globally unique Talon.One ID of the session that contains this event. | [optional]
+**sessionId** | **Integer** | The globally unique Talon.One ID of the session that contains this event. | [optional]
**type** | **String** | A string representing the event. Must not be a reserved event name. |
**attributes** | [**Object**](.md) | Additional JSON serialized data associated with the event. |
**effects** | [**List<Effect>**](Effect.md) | An array containing the effects that were applied as a result of this event. |
diff --git a/docs/ApplicationReferee.md b/docs/ApplicationReferee.md
index ff135584..46322b37 100644
--- a/docs/ApplicationReferee.md
+++ b/docs/ApplicationReferee.md
@@ -6,7 +6,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**applicationId** | **Long** | The ID of the Application that owns this entity. |
+**applicationId** | **Integer** | The ID of the Application that owns this entity. |
**sessionId** | **String** | Integration ID of the session in which the customer redeemed the referral. |
**advocateIntegrationId** | **String** | Integration ID of the Advocate's Profile. |
**friendIntegrationId** | **String** | Integration ID of the Friend's Profile. |
diff --git a/docs/ApplicationSession.md b/docs/ApplicationSession.md
index 63cc076c..a9c19379 100644
--- a/docs/ApplicationSession.md
+++ b/docs/ApplicationSession.md
@@ -6,12 +6,12 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**id** | **Long** | Internal ID of this entity. |
+**id** | **Integer** | The internal ID of this entity. |
**created** | [**OffsetDateTime**](OffsetDateTime.md) | The time this entity was created. |
**integrationId** | **String** | The integration ID set by your integration layer. |
**storeIntegrationId** | **String** | The integration ID of the store. You choose this ID when you create a store. | [optional]
-**applicationId** | **Long** | The ID of the Application that owns this entity. |
-**profileId** | **Long** | The globally unique Talon.One ID of the customer that created this entity. | [optional]
+**applicationId** | **Integer** | The ID of the Application that owns this entity. |
+**profileId** | **Integer** | The globally unique Talon.One ID of the customer that created this entity. | [optional]
**profileintegrationid** | **String** | Integration ID of the customer for the session. | [optional]
**coupon** | **String** | Any coupon code entered. |
**referral** | **String** | Any referral code entered. |
diff --git a/docs/ApplicationSessionEntity.md b/docs/ApplicationSessionEntity.md
index 09f6ebc8..e41ccf7e 100644
--- a/docs/ApplicationSessionEntity.md
+++ b/docs/ApplicationSessionEntity.md
@@ -6,7 +6,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**sessionId** | **Long** | The globally unique Talon.One ID of the session where this entity was created. |
+**sessionId** | **Integer** | The globally unique Talon.One ID of the session where this entity was created. |
diff --git a/docs/ApplicationStoreEntity.md b/docs/ApplicationStoreEntity.md
index e33fc69e..672fa75b 100644
--- a/docs/ApplicationStoreEntity.md
+++ b/docs/ApplicationStoreEntity.md
@@ -6,7 +6,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**storeId** | **Long** | The ID of the store. | [optional]
+**storeId** | **Integer** | The ID of the store. | [optional]
diff --git a/docs/AsyncCouponDeletionJobResponse.md b/docs/AsyncCouponDeletionJobResponse.md
index d0f114d7..440aad48 100644
--- a/docs/AsyncCouponDeletionJobResponse.md
+++ b/docs/AsyncCouponDeletionJobResponse.md
@@ -6,7 +6,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**id** | **Long** | Unique ID for this entity. Not to be confused with the Integration ID, which is set by your integration layer and used in most endpoints. |
+**id** | **Integer** | Unique ID for this entity. Not to be confused with the Integration ID, which is set by your integration layer and used in most endpoints. |
diff --git a/docs/Attribute.md b/docs/Attribute.md
index 1ec79752..50e5e14e 100644
--- a/docs/Attribute.md
+++ b/docs/Attribute.md
@@ -6,9 +6,9 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**id** | **Long** | Internal ID of this entity. |
+**id** | **Integer** | The internal ID of this entity. |
**created** | [**OffsetDateTime**](OffsetDateTime.md) | The time this entity was created. |
-**accountId** | **Long** | The ID of the account that owns this entity. |
+**accountId** | **Integer** | The ID of the account that owns this entity. |
**entity** | [**EntityEnum**](#EntityEnum) | The name of the entity that can have this attribute. When creating or updating the entities of a given type, you can include an `attributes` object with keys corresponding to the `name` of the custom attributes for that type. |
**eventType** | **String** | | [optional]
**name** | **String** | The attribute name that will be used in API requests and Talang. E.g. if `name == \"region\"` then you would set the region attribute by including an `attributes.region` property in your request payload. |
@@ -19,10 +19,10 @@ Name | Type | Description | Notes
**hasAllowedList** | **Boolean** | Whether or not this attribute has an allowed list of values associated with it. | [optional]
**restrictedBySuggestions** | **Boolean** | Whether or not this attribute's value is restricted by suggestions (`suggestions` property) or by an allowed list of value (`hasAllowedList` property). | [optional]
**editable** | **Boolean** | Whether or not this attribute can be edited. |
-**subscribedApplicationsIds** | **List<Long>** | A list of the IDs of the applications where this attribute is available. | [optional]
-**subscribedCatalogsIds** | **List<Long>** | A list of the IDs of the catalogs where this attribute is available. | [optional]
+**subscribedApplicationsIds** | **List<Integer>** | A list of the IDs of the applications where this attribute is available. | [optional]
+**subscribedCatalogsIds** | **List<Integer>** | A list of the IDs of the catalogs where this attribute is available. | [optional]
**allowedSubscriptions** | [**List<AllowedSubscriptionsEnum>**](#List<AllowedSubscriptionsEnum>) | A list of allowed subscription types for this attribute. **Note:** This only applies to attributes associated with the `CartItem` entity. | [optional]
-**eventTypeId** | **Long** | | [optional]
+**eventTypeId** | **Integer** | | [optional]
diff --git a/docs/Audience.md b/docs/Audience.md
index 082417a3..6fafba4a 100644
--- a/docs/Audience.md
+++ b/docs/Audience.md
@@ -6,8 +6,8 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**accountId** | **Long** | The ID of the account that owns this entity. |
-**id** | **Long** | Internal ID of this entity. |
+**accountId** | **Integer** | The ID of the account that owns this entity. |
+**id** | **Integer** | The internal ID of this entity. |
**created** | [**OffsetDateTime**](OffsetDateTime.md) | The time this entity was created. |
**name** | **String** | The human-friendly display name for this audience. |
**sandbox** | **Boolean** | Indicates if this is a live or sandbox Application. | [optional]
diff --git a/docs/AudienceAnalytics.md b/docs/AudienceAnalytics.md
index 08b874c0..e2307465 100644
--- a/docs/AudienceAnalytics.md
+++ b/docs/AudienceAnalytics.md
@@ -7,8 +7,8 @@ The audiences and their member count.
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**audienceId** | **Long** | The ID of the audience. | [optional]
-**membersCount** | **Long** | The member count of the audience. | [optional]
+**audienceId** | **Integer** | The ID of the audience. | [optional]
+**membersCount** | **Integer** | The member count of the audience. | [optional]
diff --git a/docs/AudienceCustomer.md b/docs/AudienceCustomer.md
index 4f6a02d8..6ac026f3 100644
--- a/docs/AudienceCustomer.md
+++ b/docs/AudienceCustomer.md
@@ -6,19 +6,19 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**id** | **Long** | Internal ID of this entity. |
+**id** | **Integer** | The internal ID of the customer profile. |
**created** | [**OffsetDateTime**](OffsetDateTime.md) | The time this entity was created. |
**integrationId** | **String** | The integration ID set by your integration layer. |
**attributes** | [**Object**](.md) | Arbitrary properties associated with this item. |
-**accountId** | **Long** | The ID of the Talon.One account that owns this profile. |
-**closedSessions** | **Long** | The total amount of closed sessions by a customer. A closed session is a successful purchase. |
+**accountId** | **Integer** | The ID of the Talon.One account that owns this profile. |
+**closedSessions** | **Integer** | The total number of closed sessions. Does not include closed sessions that have been cancelled or reopened. See the [docs](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions#customer-session-states). |
**totalSales** | [**BigDecimal**](BigDecimal.md) | The total amount of money spent by the customer **before** discounts are applied. The total sales amount excludes the following: - Cancelled or reopened sessions. - Returned items. |
**loyaltyMemberships** | [**List<LoyaltyMembership>**](LoyaltyMembership.md) | **DEPRECATED** A list of loyalty programs joined by the customer. | [optional]
**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** | An indicator of whether the customer is part of a sandbox or live Application. See the [docs](https://docs.talon.one/docs/product/applications/overview#application-environments). | [optional]
-**connectedApplicationsIds** | **List<Long>** | A list of the IDs of the Applications that are connected to this customer profile. | [optional]
-**connectedAudiences** | **List<Long>** | A list of the IDs of the audiences that are connected to this customer profile. | [optional]
+**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/AudienceMembership.md b/docs/AudienceMembership.md
index c4d1aa78..11333372 100644
--- a/docs/AudienceMembership.md
+++ b/docs/AudienceMembership.md
@@ -6,7 +6,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**id** | **Long** | The ID of the audience belonging to this entity. |
+**id** | **Integer** | The ID of the audience belonging to this entity. |
**name** | **String** | The Name of the audience belonging to this entity. |
diff --git a/docs/AwardGiveawayEffectProps.md b/docs/AwardGiveawayEffectProps.md
index 9b68d10c..75585efd 100644
--- a/docs/AwardGiveawayEffectProps.md
+++ b/docs/AwardGiveawayEffectProps.md
@@ -7,10 +7,10 @@ The properties specific to the \"awardGiveaway\" effect. This effect contains in
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**poolId** | **Long** | The ID of the giveaways pool the code was taken from. |
+**poolId** | **Integer** | The ID of the giveaways pool the code was taken from. |
**poolName** | **String** | The name of the giveaways pool the code was taken from. |
**recipientIntegrationId** | **String** | The integration ID of the profile that was awarded the giveaway. |
-**giveawayId** | **Long** | The internal ID for the giveaway that was awarded. |
+**giveawayId** | **Integer** | The internal ID for the giveaway that was awarded. |
**code** | **String** | The giveaway code that was awarded. |
diff --git a/docs/BaseCampaign.md b/docs/BaseCampaign.md
index cb1bf76c..bf4ec0da 100644
--- a/docs/BaseCampaign.md
+++ b/docs/BaseCampaign.md
@@ -12,15 +12,15 @@ Name | Type | Description | Notes
**endTime** | [**OffsetDateTime**](OffsetDateTime.md) | Timestamp when the campaign will become inactive. | [optional]
**attributes** | [**Object**](.md) | Arbitrary properties associated with this campaign. | [optional]
**state** | [**StateEnum**](#StateEnum) | A disabled or archived campaign is not evaluated for rules or coupons. |
-**activeRulesetId** | **Long** | [ID of Ruleset](https://docs.talon.one/management-api#operation/getRulesets) this campaign applies on customer session evaluation. | [optional]
+**activeRulesetId** | **Integer** | [ID of Ruleset](https://docs.talon.one/management-api#operation/getRulesets) this campaign applies on customer session evaluation. | [optional]
**tags** | **List<String>** | A list of tags for the campaign. |
**features** | [**List<FeaturesEnum>**](#List<FeaturesEnum>) | The features enabled in this campaign. |
**couponSettings** | [**CodeGeneratorSettings**](CodeGeneratorSettings.md) | | [optional]
**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<Long>** | The IDs of the [campaign groups](https://docs.talon.one/docs/product/account/managing-campaign-groups) this campaign belongs to. | [optional]
+**campaignGroups** | **List<Integer>** | The IDs of the [campaign groups](https://docs.talon.one/docs/product/account/managing-campaign-groups) this campaign belongs to. | [optional]
**type** | [**TypeEnum**](#TypeEnum) | The campaign type. Possible type values: - `cartItem`: Type of campaign that can apply effects only to cart items. - `advanced`: Type of campaign that can apply effects to customer sessions and cart items. | [optional]
-**linkedStoreIds** | **List<Long>** | A list of store IDs that you want to link to the campaign. **Note:** Campaigns with linked store IDs will only be evaluated when there is a [customer session update](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) that references a linked store. | [optional]
+**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]
diff --git a/docs/BaseLoyaltyProgram.md b/docs/BaseLoyaltyProgram.md
index 3ad90ab1..117e9fc8 100644
--- a/docs/BaseLoyaltyProgram.md
+++ b/docs/BaseLoyaltyProgram.md
@@ -8,11 +8,11 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**title** | **String** | The display title for the Loyalty Program. | [optional]
**description** | **String** | Description of our Loyalty Program. | [optional]
-**subscribedApplications** | **List<Long>** | A list containing the IDs of all applications that are subscribed to this Loyalty Program. | [optional]
+**subscribedApplications** | **List<Integer>** | A list containing the IDs of all applications that are subscribed to this Loyalty Program. | [optional]
**defaultValidity** | **String** | 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. | [optional]
**defaultPending** | **String** | 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. | [optional]
**allowSubledger** | **Boolean** | Indicates if this program supports subledgers inside the program. | [optional]
-**usersPerCardLimit** | **Long** | 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]
+**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]
**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]
**tiersExpirationPolicy** | [**TiersExpirationPolicyEnum**](#TiersExpirationPolicyEnum) | The policy that defines how tier expiration, used to reevaluate the customer's current tier, is determined. - `tier_start_date`: The tier expiration is relative to when the customer joined the current tier. - `program_join_date`: The tier expiration is relative to when the customer joined the loyalty program. - `customer_attribute`: The tier expiration is determined by a custom customer attribute. - `absolute_expiration`: The tier is reevaluated at the start of each tier cycle. For this policy, it is required to provide a `tierCycleStartDate`. | [optional]
diff --git a/docs/BaseNotification.md b/docs/BaseNotification.md
index 47d86cd7..bae205ec 100644
--- a/docs/BaseNotification.md
+++ b/docs/BaseNotification.md
@@ -9,7 +9,7 @@ Name | Type | Description | Notes
**policy** | [**Object**](.md) | Indicates which notification properties to apply. |
**enabled** | **Boolean** | Indicates whether the notification is activated. | [optional]
**webhook** | [**BaseNotificationWebhook**](BaseNotificationWebhook.md) | |
-**id** | **Long** | Unique ID for this entity. |
+**id** | **Integer** | Unique ID for this entity. |
**type** | [**TypeEnum**](#TypeEnum) | The notification type. |
@@ -21,6 +21,8 @@ Name | Value
CAMPAIGN | "campaign"
LOYALTY_ADDED_DEDUCTED_POINTS | "loyalty_added_deducted_points"
CARD_ADDED_DEDUCTED_POINTS | "card_added_deducted_points"
+LOYALTY_ADDED_DEDUCTED_POINTS_BALANCES | "loyalty_added_deducted_points_balances"
+LOYALTY_CARD_ADDED_DEDUCTED_POINTS_BALANCES | "loyalty_card_added_deducted_points_balances"
COUPON | "coupon"
EXPIRING_COUPONS | "expiring_coupons"
EXPIRING_POINTS | "expiring_points"
diff --git a/docs/BaseNotificationWebhook.md b/docs/BaseNotificationWebhook.md
index 2328c9fe..ad4943bd 100644
--- a/docs/BaseNotificationWebhook.md
+++ b/docs/BaseNotificationWebhook.md
@@ -6,7 +6,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**id** | **Long** | Internal ID of this entity. |
+**id** | **Integer** | The 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. |
**url** | **String** | API URL for the given webhook-based notification. |
diff --git a/docs/BaseSamlConnection.md b/docs/BaseSamlConnection.md
index 292970d1..6f133dda 100644
--- a/docs/BaseSamlConnection.md
+++ b/docs/BaseSamlConnection.md
@@ -6,7 +6,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**accountId** | **Long** | The ID of the account that owns this entity. |
+**accountId** | **Integer** | The ID of the account that owns this entity. |
**name** | **String** | ID of the SAML service. |
**enabled** | **Boolean** | Determines if this SAML connection active. |
**issuer** | **String** | Identity Provider Entity ID. |
diff --git a/docs/Binding.md b/docs/Binding.md
index 013c57ca..688dfea6 100644
--- a/docs/Binding.md
+++ b/docs/Binding.md
@@ -10,6 +10,9 @@ Name | Type | Description | Notes
**type** | **String** | The kind of binding. Possible values are: - `bundle` - `cartItemFilter` - `subledgerBalance` - `templateParameter` | [optional]
**expression** | **List<Object>** | A Talang expression that will be evaluated and its result attached to the name of the binding. |
**valueType** | **String** | Can be one of the following: - `string` - `number` - `boolean` | [optional]
+**minValue** | [**BigDecimal**](BigDecimal.md) | The minimum value allowed for this placeholder. | [optional]
+**maxValue** | [**BigDecimal**](BigDecimal.md) | The maximum value allowed for this placeholder. | [optional]
+**attributeId** | **Integer** | Id of the attribute attached to the placeholder. | [optional]
diff --git a/docs/BulkApplicationNotification.md b/docs/BulkApplicationNotification.md
index 79e14da5..b016460d 100644
--- a/docs/BulkApplicationNotification.md
+++ b/docs/BulkApplicationNotification.md
@@ -6,7 +6,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**totalResultSize** | **Long** | |
+**totalResultSize** | **Integer** | |
**data** | [**List<ApplicationNotification>**](ApplicationNotification.md) | |
diff --git a/docs/BulkCampaignNotification.md b/docs/BulkCampaignNotification.md
index b87c67ff..41e12e06 100644
--- a/docs/BulkCampaignNotification.md
+++ b/docs/BulkCampaignNotification.md
@@ -6,7 +6,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**totalResultSize** | **Long** | |
+**totalResultSize** | **Integer** | |
**data** | [**List<CampaignNotification>**](CampaignNotification.md) | |
diff --git a/docs/BulkOperationOnCampaigns.md b/docs/BulkOperationOnCampaigns.md
index fa94453b..7eb0ecb7 100644
--- a/docs/BulkOperationOnCampaigns.md
+++ b/docs/BulkOperationOnCampaigns.md
@@ -7,7 +7,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**operation** | [**OperationEnum**](#OperationEnum) | The operation to perform on the specified campaign IDs. |
-**campaignIds** | **List<Long>** | The list of campaign IDs on which the operation will be performed. |
+**campaignIds** | **List<Integer>** | The list of campaign IDs on which the operation will be performed. |
**activateAt** | [**OffsetDateTime**](OffsetDateTime.md) | Timestamp when the revisions are finalized after the `activate_revision` operation. The current time is used when left blank. **Note:** It must be an RFC3339 timestamp string. | [optional]
diff --git a/docs/Campaign.md b/docs/Campaign.md
index b4db452e..992e00ba 100644
--- a/docs/Campaign.md
+++ b/docs/Campaign.md
@@ -6,55 +6,55 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**id** | **Long** | Unique ID for this entity. |
+**id** | **Integer** | Unique ID for this entity. |
**created** | [**OffsetDateTime**](OffsetDateTime.md) | The exact moment this entity was created. |
-**applicationId** | **Long** | The ID of the Application that owns this entity. |
-**userId** | **Long** | The ID of the user associated with this entity. |
+**applicationId** | **Integer** | The ID of the Application that owns this entity. |
+**userId** | **Integer** | The ID of the user associated with this entity. |
**name** | **String** | A user-facing name for this campaign. |
**description** | **String** | A detailed description of the campaign. |
**startTime** | [**OffsetDateTime**](OffsetDateTime.md) | Timestamp when the campaign will become active. | [optional]
**endTime** | [**OffsetDateTime**](OffsetDateTime.md) | Timestamp when the campaign will become inactive. | [optional]
**attributes** | [**Object**](.md) | Arbitrary properties associated with this campaign. | [optional]
**state** | [**StateEnum**](#StateEnum) | A disabled or archived campaign is not evaluated for rules or coupons. |
-**activeRulesetId** | **Long** | [ID of Ruleset](https://docs.talon.one/management-api#operation/getRulesets) this campaign applies on customer session evaluation. | [optional]
+**activeRulesetId** | **Integer** | [ID of Ruleset](https://docs.talon.one/management-api#operation/getRulesets) this campaign applies on customer session evaluation. | [optional]
**tags** | **List<String>** | A list of tags for the campaign. |
**features** | [**List<FeaturesEnum>**](#List<FeaturesEnum>) | The features enabled in this campaign. |
**couponSettings** | [**CodeGeneratorSettings**](CodeGeneratorSettings.md) | | [optional]
**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<Long>** | The IDs of the [campaign groups](https://docs.talon.one/docs/product/account/managing-campaign-groups) this campaign belongs to. | [optional]
+**campaignGroups** | **List<Integer>** | The IDs of the [campaign groups](https://docs.talon.one/docs/product/account/managing-campaign-groups) this campaign belongs to. | [optional]
**type** | [**TypeEnum**](#TypeEnum) | The campaign type. Possible type values: - `cartItem`: Type of campaign that can apply effects only to cart items. - `advanced`: Type of campaign that can apply effects to customer sessions and cart items. |
-**linkedStoreIds** | **List<Long>** | A list of store IDs that you want to link to the campaign. **Note:** Campaigns with linked store IDs will only be evaluated when there is a [customer session update](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) that references a linked store. | [optional]
+**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. | [optional]
-**couponRedemptionCount** | **Long** | This property is **deprecated**. The count should be available under *budgets* property. Number of coupons redeemed in the campaign. | [optional]
-**referralRedemptionCount** | **Long** | This property is **deprecated**. The count should be available under *budgets* property. Number of referral codes redeemed in the campaign. | [optional]
+**couponRedemptionCount** | **Integer** | This property is **deprecated**. The count should be available under *budgets* property. Number of coupons redeemed in the campaign. | [optional]
+**referralRedemptionCount** | **Integer** | This property is **deprecated**. The count should be available under *budgets* property. Number of referral codes redeemed in the campaign. | [optional]
**discountCount** | [**BigDecimal**](BigDecimal.md) | This property is **deprecated**. The count should be available under *budgets* property. Total amount of discounts redeemed in the campaign. | [optional]
-**discountEffectCount** | **Long** | This property is **deprecated**. The count should be available under *budgets* property. Total number of times discounts were redeemed in this campaign. | [optional]
-**couponCreationCount** | **Long** | This property is **deprecated**. The count should be available under *budgets* property. Total number of coupons created by rules in this campaign. | [optional]
-**customEffectCount** | **Long** | This property is **deprecated**. The count should be available under *budgets* property. Total number of custom effects triggered by rules in this campaign. | [optional]
-**referralCreationCount** | **Long** | This property is **deprecated**. The count should be available under *budgets* property. Total number of referrals created by rules in this campaign. | [optional]
-**addFreeItemEffectCount** | **Long** | 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. | [optional]
-**awardedGiveawaysCount** | **Long** | This property is **deprecated**. The count should be available under *budgets* property. Total number of giveaways awarded by rules in this campaign. | [optional]
+**discountEffectCount** | **Integer** | This property is **deprecated**. The count should be available under *budgets* property. Total number of times discounts were redeemed in this campaign. | [optional]
+**couponCreationCount** | **Integer** | This property is **deprecated**. The count should be available under *budgets* property. Total number of coupons created by rules in this campaign. | [optional]
+**customEffectCount** | **Integer** | This property is **deprecated**. The count should be available under *budgets* property. Total number of custom effects triggered by rules in this campaign. | [optional]
+**referralCreationCount** | **Integer** | This property is **deprecated**. The count should be available under *budgets* property. Total number of referrals created by rules in this campaign. | [optional]
+**addFreeItemEffectCount** | **Integer** | 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. | [optional]
+**awardedGiveawaysCount** | **Integer** | This property is **deprecated**. The count should be available under *budgets* property. Total number of giveaways awarded by rules in this campaign. | [optional]
**createdLoyaltyPointsCount** | [**BigDecimal**](BigDecimal.md) | This property is **deprecated**. The count should be available under *budgets* property. Total number of loyalty points created by rules in this campaign. | [optional]
-**createdLoyaltyPointsEffectCount** | **Long** | 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. | [optional]
+**createdLoyaltyPointsEffectCount** | **Integer** | 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. | [optional]
**redeemedLoyaltyPointsCount** | [**BigDecimal**](BigDecimal.md) | This property is **deprecated**. The count should be available under *budgets* property. Total number of loyalty points redeemed by rules in this campaign. | [optional]
-**redeemedLoyaltyPointsEffectCount** | **Long** | 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. | [optional]
-**callApiEffectCount** | **Long** | This property is **deprecated**. The count should be available under *budgets* property. Total number of webhooks triggered by rules in this campaign. | [optional]
-**reservecouponEffectCount** | **Long** | This property is **deprecated**. The count should be available under *budgets* property. Total number of reserve coupon effects triggered by rules in this campaign. | [optional]
+**redeemedLoyaltyPointsEffectCount** | **Integer** | 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. | [optional]
+**callApiEffectCount** | **Integer** | This property is **deprecated**. The count should be available under *budgets* property. Total number of webhooks triggered by rules in this campaign. | [optional]
+**reservecouponEffectCount** | **Integer** | This property is **deprecated**. The count should be available under *budgets* property. Total number of reserve coupon effects triggered by rules in this campaign. | [optional]
**lastActivity** | [**OffsetDateTime**](OffsetDateTime.md) | Timestamp of the most recent event received by this campaign. | [optional]
**updated** | [**OffsetDateTime**](OffsetDateTime.md) | 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. | [optional]
**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** | **Long** | The ID of the Campaign Template this Campaign was created from. | [optional]
+**templateId** | **Integer** | The ID of the Campaign Template this Campaign was created from. | [optional]
**frontendState** | [**FrontendStateEnum**](#FrontendStateEnum) | The campaign state displayed in the Campaign Manager. |
**storesImported** | **Boolean** | Indicates whether the linked stores were imported via a CSV file. |
-**valueMapsIds** | **List<Long>** | A list of value map IDs for the campaign. | [optional]
+**valueMapsIds** | **List<Integer>** | A list of value map IDs for the campaign. | [optional]
**revisionFrontendState** | [**RevisionFrontendStateEnum**](#RevisionFrontendStateEnum) | The campaign revision state displayed in the Campaign Manager. | [optional]
-**activeRevisionId** | **Long** | ID of the revision that was last activated on this campaign. | [optional]
-**activeRevisionVersionId** | **Long** | ID of the revision version that is active on the campaign. | [optional]
-**version** | **Long** | Incrementing number representing how many revisions have been activated on this campaign, starts from 0 for a new campaign. | [optional]
-**currentRevisionId** | **Long** | ID of the revision currently being modified for the campaign. | [optional]
-**currentRevisionVersionId** | **Long** | ID of the latest version applied on the current revision. | [optional]
+**activeRevisionId** | **Integer** | ID of the revision that was last activated on this campaign. | [optional]
+**activeRevisionVersionId** | **Integer** | ID of the revision version that is active on the campaign. | [optional]
+**version** | **Integer** | Incrementing number representing how many revisions have been activated on this campaign, starts from 0 for a new campaign. | [optional]
+**currentRevisionId** | **Integer** | ID of the revision currently being modified for the campaign. | [optional]
+**currentRevisionVersionId** | **Integer** | ID of the latest version applied on the current revision. | [optional]
**stageRevision** | **Boolean** | Flag for determining whether we use current revision when sending requests with staging API key. | [optional]
diff --git a/docs/CampaignActivationRequest.md b/docs/CampaignActivationRequest.md
index 48874ee8..0eac1a96 100644
--- a/docs/CampaignActivationRequest.md
+++ b/docs/CampaignActivationRequest.md
@@ -6,7 +6,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**userIds** | **List<Long>** | The list of IDs of the users who will receive the activation request. |
+**userIds** | **List<Integer>** | The list of IDs of the users who will receive the activation request. |
diff --git a/docs/CampaignAnalytics.md b/docs/CampaignAnalytics.md
index a411fe50..6db38b31 100644
--- a/docs/CampaignAnalytics.md
+++ b/docs/CampaignAnalytics.md
@@ -15,18 +15,18 @@ Name | Type | Description | Notes
**totalCampaignDiscountCosts** | [**BigDecimal**](BigDecimal.md) | Amount of cost caused by discounts given in the campaign since it began. |
**campaignRefundedDiscounts** | [**BigDecimal**](BigDecimal.md) | Amount of discounts rolledback due to refund in the campaign. |
**totalCampaignRefundedDiscounts** | [**BigDecimal**](BigDecimal.md) | Amount of discounts rolledback due to refund in the campaign since it began. |
-**campaignFreeItems** | **Long** | Amount of free items given in the campaign. |
-**totalCampaignFreeItems** | **Long** | Amount of free items given in the campaign since it began. |
-**couponRedemptions** | **Long** | Number of coupon redemptions in the campaign. |
-**totalCouponRedemptions** | **Long** | Number of coupon redemptions in the campaign since it began. |
-**couponRolledbackRedemptions** | **Long** | Number of coupon redemptions that have been rolled back (due to canceling closed session) in the campaign. |
-**totalCouponRolledbackRedemptions** | **Long** | Number of coupon redemptions that have been rolled back (due to canceling closed session) in the campaign since it began. |
-**referralRedemptions** | **Long** | Number of referral redemptions in the campaign. |
-**totalReferralRedemptions** | **Long** | Number of referral redemptions in the campaign since it began. |
-**couponsCreated** | **Long** | Number of coupons created in the campaign by the rule engine. |
-**totalCouponsCreated** | **Long** | Number of coupons created in the campaign by the rule engine since it began. |
-**referralsCreated** | **Long** | Number of referrals created in the campaign by the rule engine. |
-**totalReferralsCreated** | **Long** | Number of referrals created in the campaign by the rule engine since it began. |
+**campaignFreeItems** | **Integer** | Amount of free items given in the campaign. |
+**totalCampaignFreeItems** | **Integer** | Amount of free items given in the campaign since it began. |
+**couponRedemptions** | **Integer** | Number of coupon redemptions in the campaign. |
+**totalCouponRedemptions** | **Integer** | Number of coupon redemptions in the campaign since it began. |
+**couponRolledbackRedemptions** | **Integer** | Number of coupon redemptions that have been rolled back (due to canceling closed session) in the campaign. |
+**totalCouponRolledbackRedemptions** | **Integer** | Number of coupon redemptions that have been rolled back (due to canceling closed session) in the campaign since it began. |
+**referralRedemptions** | **Integer** | Number of referral redemptions in the campaign. |
+**totalReferralRedemptions** | **Integer** | Number of referral redemptions in the campaign since it began. |
+**couponsCreated** | **Integer** | Number of coupons created in the campaign by the rule engine. |
+**totalCouponsCreated** | **Integer** | Number of coupons created in the campaign by the rule engine since it began. |
+**referralsCreated** | **Integer** | Number of referrals created in the campaign by the rule engine. |
+**totalReferralsCreated** | **Integer** | Number of referrals created in the campaign by the rule engine since it began. |
**addedLoyaltyPoints** | [**BigDecimal**](BigDecimal.md) | Number of added loyalty points in the campaign in a specific interval. |
**totalAddedLoyaltyPoints** | [**BigDecimal**](BigDecimal.md) | Number of added loyalty points in the campaign since it began. |
**deductedLoyaltyPoints** | [**BigDecimal**](BigDecimal.md) | Number of deducted loyalty points in the campaign in a specific interval. |
diff --git a/docs/CampaignCollection.md b/docs/CampaignCollection.md
index 3ba437f1..9c817f6a 100644
--- a/docs/CampaignCollection.md
+++ b/docs/CampaignCollection.md
@@ -6,16 +6,16 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**id** | **Long** | Internal ID of this entity. |
+**id** | **Integer** | The internal ID of this entity. |
**created** | [**OffsetDateTime**](OffsetDateTime.md) | The time this entity was created. |
-**accountId** | **Long** | The ID of the account that owns this entity. |
+**accountId** | **Integer** | The ID of the account that owns this entity. |
**modified** | [**OffsetDateTime**](OffsetDateTime.md) | The time this entity was last modified. |
**description** | **String** | A short description of the purpose of this collection. | [optional]
**name** | **String** | The name of this collection. |
-**modifiedBy** | **Long** | ID of the user who last updated this effect if available. | [optional]
-**createdBy** | **Long** | ID of the user who created this effect. |
-**applicationId** | **Long** | The ID of the Application that owns this entity. | [optional]
-**campaignId** | **Long** | The ID of the campaign that owns this entity. | [optional]
+**modifiedBy** | **Integer** | ID of the user who last updated this effect if available. | [optional]
+**createdBy** | **Integer** | ID of the user who created this effect. |
+**applicationId** | **Integer** | The ID of the Application that owns this entity. | [optional]
+**campaignId** | **Integer** | The ID of the campaign that owns this entity. | [optional]
**payload** | **List<String>** | The content of the collection. | [optional]
diff --git a/docs/CampaignCollectionWithoutPayload.md b/docs/CampaignCollectionWithoutPayload.md
index eb6aa0a8..91e0318e 100644
--- a/docs/CampaignCollectionWithoutPayload.md
+++ b/docs/CampaignCollectionWithoutPayload.md
@@ -6,16 +6,16 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**id** | **Long** | Internal ID of this entity. |
+**id** | **Integer** | The internal ID of this entity. |
**created** | [**OffsetDateTime**](OffsetDateTime.md) | The time this entity was created. |
-**accountId** | **Long** | The ID of the account that owns this entity. |
+**accountId** | **Integer** | The ID of the account that owns this entity. |
**modified** | [**OffsetDateTime**](OffsetDateTime.md) | The time this entity was last modified. |
**description** | **String** | A short description of the purpose of this collection. | [optional]
**name** | **String** | The name of this collection. |
-**modifiedBy** | **Long** | ID of the user who last updated this effect if available. | [optional]
-**createdBy** | **Long** | ID of the user who created this effect. |
-**applicationId** | **Long** | The ID of the Application that owns this entity. | [optional]
-**campaignId** | **Long** | The ID of the campaign that owns this entity. | [optional]
+**modifiedBy** | **Integer** | ID of the user who last updated this effect if available. | [optional]
+**createdBy** | **Integer** | ID of the user who created this effect. |
+**applicationId** | **Integer** | The ID of the Application that owns this entity. | [optional]
+**campaignId** | **Integer** | The ID of the campaign that owns this entity. | [optional]
diff --git a/docs/CampaignCopy.md b/docs/CampaignCopy.md
index 49e0267a..9970c410 100644
--- a/docs/CampaignCopy.md
+++ b/docs/CampaignCopy.md
@@ -7,12 +7,12 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **String** | Name of the copied campaign (Defaults to \"Copy of original campaign name\"). | [optional]
-**applicationIds** | **List<Long>** | Application IDs of the applications to which a campaign should be copied to. |
+**applicationIds** | **List<Integer>** | Application IDs of the applications to which a campaign should be copied to. |
**description** | **String** | A detailed description of the campaign. | [optional]
**startTime** | [**OffsetDateTime**](OffsetDateTime.md) | Timestamp when the campaign will become active. | [optional]
**endTime** | [**OffsetDateTime**](OffsetDateTime.md) | Timestamp when the campaign will become inactive. | [optional]
**tags** | **List<String>** | A list of tags for the campaign. | [optional]
-**evaluationGroupId** | **Long** | The ID of the campaign evaluation group the campaign belongs to. | [optional]
+**evaluationGroupId** | **Integer** | The ID of the campaign evaluation group the campaign belongs to. | [optional]
diff --git a/docs/CampaignDeactivationRequest.md b/docs/CampaignDeactivationRequest.md
new file mode 100644
index 00000000..8b466b22
--- /dev/null
+++ b/docs/CampaignDeactivationRequest.md
@@ -0,0 +1,12 @@
+
+
+# CampaignDeactivationRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**userIds** | **List<Integer>** | The list of IDs of the users receiving the deactivation request emails. |
+
+
+
diff --git a/docs/CampaignDetail.md b/docs/CampaignDetail.md
index 9dc7c68b..4364170a 100644
--- a/docs/CampaignDetail.md
+++ b/docs/CampaignDetail.md
@@ -6,7 +6,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**campaignId** | **Long** | The ID of the campaign that references the application cart item filter. | [optional]
+**campaignId** | **Integer** | The ID of the campaign that references the application cart item filter. | [optional]
**campaignName** | **String** | A user-facing name for this campaign. | [optional]
diff --git a/docs/CampaignEntity.md b/docs/CampaignEntity.md
index 5d848d21..877cfe4e 100644
--- a/docs/CampaignEntity.md
+++ b/docs/CampaignEntity.md
@@ -6,7 +6,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**campaignId** | **Long** | The ID of the campaign that owns this entity. |
+**campaignId** | **Integer** | The ID of the campaign that owns this entity. |
diff --git a/docs/CampaignEvaluationGroup.md b/docs/CampaignEvaluationGroup.md
index a7dad089..0a04730e 100644
--- a/docs/CampaignEvaluationGroup.md
+++ b/docs/CampaignEvaluationGroup.md
@@ -6,14 +6,14 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**applicationId** | **Long** | The ID of the Application that owns this entity. |
+**applicationId** | **Integer** | The ID of the Application that owns this entity. |
**name** | **String** | The name of the campaign evaluation group. |
-**parentId** | **Long** | The ID of the parent group that contains the campaign evaluation group. |
+**parentId** | **Integer** | The ID of the parent group that contains the campaign evaluation group. |
**description** | **String** | A description of the campaign evaluation group. | [optional]
**evaluationMode** | [**EvaluationModeEnum**](#EvaluationModeEnum) | The mode by which campaigns in the campaign evaluation group are evaluated. |
**evaluationScope** | [**EvaluationScopeEnum**](#EvaluationScopeEnum) | The evaluation scope of the campaign evaluation group. |
**locked** | **Boolean** | An indicator of whether the campaign evaluation group is locked for modification. |
-**id** | **Long** | Unique ID for this entity. Not to be confused with the Integration ID, which is set by your integration layer and used in most endpoints. |
+**id** | **Integer** | Unique ID for this entity. Not to be confused with the Integration ID, which is set by your integration layer and used in most endpoints. |
diff --git a/docs/CampaignEvaluationPosition.md b/docs/CampaignEvaluationPosition.md
index 5f2fb0be..961997e1 100644
--- a/docs/CampaignEvaluationPosition.md
+++ b/docs/CampaignEvaluationPosition.md
@@ -7,9 +7,9 @@ The campaign position within the evaluation tree.
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**groupId** | **Long** | The ID of the campaign evaluation group the campaign belongs to. |
+**groupId** | **Integer** | The ID of the campaign evaluation group the campaign belongs to. |
**groupName** | **String** | The name of the campaign evaluation group the campaign belongs to. |
-**position** | **Long** | The position of the campaign node in its parent group. |
+**position** | **Integer** | The position of the campaign node in its parent group. |
diff --git a/docs/CampaignEvaluationTreeChangedNotification.md b/docs/CampaignEvaluationTreeChangedNotification.md
index 5713d5d1..3821ce17 100644
--- a/docs/CampaignEvaluationTreeChangedNotification.md
+++ b/docs/CampaignEvaluationTreeChangedNotification.md
@@ -7,7 +7,7 @@ Notification about an Application whose campaign evaluation tree changed.
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**applicationId** | **Long** | The ID of the Application whose campaign evaluation tree changed. |
+**applicationId** | **Integer** | The ID of the Application whose campaign evaluation tree changed. |
**oldEvaluationTree** | [**CampaignSet**](CampaignSet.md) | | [optional]
**evaluationTree** | [**CampaignSet**](CampaignSet.md) | |
diff --git a/docs/CampaignGroup.md b/docs/CampaignGroup.md
index 49f7bae8..f5fff0f6 100644
--- a/docs/CampaignGroup.md
+++ b/docs/CampaignGroup.md
@@ -6,14 +6,14 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**id** | **Long** | Internal ID of this entity. |
+**id** | **Integer** | The 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. |
-**accountId** | **Long** | The ID of the account that owns this entity. |
+**accountId** | **Integer** | The ID of the account that owns this entity. |
**name** | **String** | The name of the campaign access group. |
**description** | **String** | A longer description of the campaign access group. | [optional]
-**subscribedApplicationsIds** | **List<Long>** | A list of IDs of the Applications that this campaign access group is enabled for. | [optional]
-**campaignIds** | **List<Long>** | A list of IDs of the campaigns that are part 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/CampaignGroupEntity.md b/docs/CampaignGroupEntity.md
index 9ea91d60..4187641b 100644
--- a/docs/CampaignGroupEntity.md
+++ b/docs/CampaignGroupEntity.md
@@ -6,7 +6,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**campaignGroups** | **List<Long>** | The IDs of the campaign groups that own this entity. | [optional]
+**campaignGroups** | **List<Integer>** | The IDs of the campaign groups that own this entity. | [optional]
diff --git a/docs/CampaignNotificationPolicy.md b/docs/CampaignNotificationPolicy.md
index 6b8c0fad..111c2979 100644
--- a/docs/CampaignNotificationPolicy.md
+++ b/docs/CampaignNotificationPolicy.md
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **String** | Notification name. |
**batchingEnabled** | **Boolean** | Indicates whether batching is activated. | [optional]
-**batchSize** | **Long** | The required size of each batch of data. This value applies only when `batchingEnabled` is `true`. | [optional]
+**batchSize** | **Integer** | The required size of each batch of data. This value applies only when `batchingEnabled` is `true`. | [optional]
diff --git a/docs/CampaignSet.md b/docs/CampaignSet.md
index 24275c4d..ff6ccdaf 100644
--- a/docs/CampaignSet.md
+++ b/docs/CampaignSet.md
@@ -6,9 +6,9 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**applicationId** | **Long** | The ID of the Application that owns this entity. |
-**id** | **Long** | Internal ID of this entity. |
-**version** | **Long** | Version of the campaign set. |
+**applicationId** | **Integer** | The ID of the Application that owns this entity. |
+**id** | **Integer** | The internal ID of this entity. |
+**version** | **Integer** | Version of the campaign set. |
**set** | [**CampaignSetBranchNode**](CampaignSetBranchNode.md) | |
**updatedBy** | **String** | Name of the user who last updated this campaign set, if available. | [optional]
diff --git a/docs/CampaignSetBranchNode.md b/docs/CampaignSetBranchNode.md
index 00aad37e..5773bc22 100644
--- a/docs/CampaignSetBranchNode.md
+++ b/docs/CampaignSetBranchNode.md
@@ -10,7 +10,7 @@ Name | Type | Description | Notes
**name** | **String** | Name of the set. |
**operator** | [**OperatorEnum**](#OperatorEnum) | An indicator of how the set operates on its elements. |
**elements** | [**List<CampaignSetNode>**](CampaignSetNode.md) | Child elements of this set. |
-**groupId** | **Long** | The ID of the campaign set. |
+**groupId** | **Integer** | The ID of the campaign set. |
**locked** | **Boolean** | An indicator of whether the campaign set is locked for modification. |
**description** | **String** | A description of the campaign set. | [optional]
**evaluationMode** | [**EvaluationModeEnum**](#EvaluationModeEnum) | The mode by which campaigns in the campaign evaluation group are evaluated. |
diff --git a/docs/CampaignSetLeafNode.md b/docs/CampaignSetLeafNode.md
index 27bef4ae..4676b637 100644
--- a/docs/CampaignSetLeafNode.md
+++ b/docs/CampaignSetLeafNode.md
@@ -7,7 +7,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**type** | [**TypeEnum**](#TypeEnum) | Indicates the node type. |
-**campaignId** | **Long** | ID of the campaign |
+**campaignId** | **Integer** | ID of the campaign |
diff --git a/docs/CampaignStoreBudget.md b/docs/CampaignStoreBudget.md
index a7f3bd54..283266bd 100644
--- a/docs/CampaignStoreBudget.md
+++ b/docs/CampaignStoreBudget.md
@@ -6,10 +6,10 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**id** | **Long** | Internal ID of this entity. |
+**id** | **Integer** | The internal ID of this entity. |
**created** | [**OffsetDateTime**](OffsetDateTime.md) | The time this entity was created. |
-**campaignId** | **Long** | The ID of the campaign that owns this entity. |
-**storeId** | **Long** | The ID of the store. |
+**campaignId** | **Integer** | The ID of the campaign that owns this entity. |
+**storeId** | **Integer** | The ID of the store. |
**limits** | [**List<CampaignStoreBudgetLimitConfig>**](CampaignStoreBudgetLimitConfig.md) | The set of budget limits for stores linked to the campaign. |
diff --git a/docs/CampaignTemplate.md b/docs/CampaignTemplate.md
index 6d3b0b7f..cba5c9ba 100644
--- a/docs/CampaignTemplate.md
+++ b/docs/CampaignTemplate.md
@@ -6,17 +6,17 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**id** | **Long** | Internal ID of this entity. |
+**id** | **Integer** | The internal ID of this entity. |
**created** | [**OffsetDateTime**](OffsetDateTime.md) | The time this entity was created. |
-**accountId** | **Long** | The ID of the account that owns this entity. |
-**userId** | **Long** | The ID of the user associated with this entity. |
+**accountId** | **Integer** | The ID of the account that owns this entity. |
+**userId** | **Integer** | The ID of the user associated with this entity. |
**name** | **String** | The campaign template name. |
**description** | **String** | Customer-facing text that explains the objective of the template. |
**instructions** | **String** | Customer-facing text that explains how to use the template. For example, you can use this property to explain the available attributes of this template, and how they can be modified when a user uses this template to create a new campaign. |
**campaignAttributes** | [**Object**](.md) | The campaign attributes that campaigns created from this template will have by default. | [optional]
**couponAttributes** | [**Object**](.md) | The campaign attributes that coupons created from this template will have by default. | [optional]
**state** | [**StateEnum**](#StateEnum) | Only campaign templates in 'available' state may be used to create campaigns. |
-**activeRulesetId** | **Long** | The ID of the ruleset this campaign template will use. | [optional]
+**activeRulesetId** | **Integer** | The ID of the ruleset this campaign template will use. | [optional]
**tags** | **List<String>** | A list of tags for the campaign template. | [optional]
**features** | [**List<FeaturesEnum>**](#List<FeaturesEnum>) | A list of features for the campaign template. | [optional]
**couponSettings** | [**CodeGeneratorSettings**](CodeGeneratorSettings.md) | | [optional]
@@ -24,13 +24,13 @@ Name | Type | Description | Notes
**referralSettings** | [**CodeGeneratorSettings**](CodeGeneratorSettings.md) | | [optional]
**limits** | [**List<TemplateLimitConfig>**](TemplateLimitConfig.md) | The set of limits that operate for this campaign template. | [optional]
**templateParams** | [**List<CampaignTemplateParams>**](CampaignTemplateParams.md) | Fields which can be used to replace values in a rule. | [optional]
-**applicationsIds** | **List<Long>** | A list of IDs of the Applications that are subscribed to this campaign template. |
+**applicationsIds** | **List<Integer>** | A list of IDs of the Applications that are subscribed to this campaign template. |
**campaignCollections** | [**List<CampaignTemplateCollection>**](CampaignTemplateCollection.md) | The campaign collections from the blueprint campaign for the template. | [optional]
-**defaultCampaignGroupId** | **Long** | The default campaign group ID. | [optional]
+**defaultCampaignGroupId** | **Integer** | The default campaign group ID. | [optional]
**campaignType** | [**CampaignTypeEnum**](#CampaignTypeEnum) | 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. |
**updated** | [**OffsetDateTime**](OffsetDateTime.md) | Timestamp of the most recent update to the campaign template or any of its elements. | [optional]
**updatedBy** | **String** | Name of the user who last updated this campaign template, if available. | [optional]
-**validApplicationIds** | **List<Long>** | The IDs of the Applications that are related to this entity. |
+**validApplicationIds** | **List<Integer>** | The IDs of the Applications that are related to this entity. |
**isUserFavorite** | **Boolean** | A flag indicating whether the user marked the template as a favorite. | [optional]
diff --git a/docs/CampaignTemplateCouponReservationSettings.md b/docs/CampaignTemplateCouponReservationSettings.md
index ff0d40f4..d04b8952 100644
--- a/docs/CampaignTemplateCouponReservationSettings.md
+++ b/docs/CampaignTemplateCouponReservationSettings.md
@@ -6,7 +6,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**reservationLimit** | **Long** | The number of reservations that can be made with this coupon code. | [optional]
+**reservationLimit** | **Integer** | The number of reservations that can be made with this coupon code. | [optional]
**isReservationMandatory** | **Boolean** | An indication of whether the code can be redeemed only if it has been reserved first. | [optional]
diff --git a/docs/CampaignTemplateParams.md b/docs/CampaignTemplateParams.md
index 76dfb911..d78a9cb2 100644
--- a/docs/CampaignTemplateParams.md
+++ b/docs/CampaignTemplateParams.md
@@ -9,7 +9,7 @@ Name | Type | Description | Notes
**name** | **String** | Name of the campaign template parameter. |
**type** | [**TypeEnum**](#TypeEnum) | Defines the type of parameter value. |
**description** | **String** | Explains the meaning of this template parameter and the placeholder value that will define it. It is used on campaign creation from this template. |
-**attributeId** | **Long** | ID of the corresponding attribute. | [optional]
+**attributeId** | **Integer** | ID of the corresponding attribute. | [optional]
diff --git a/docs/CampaignVersions.md b/docs/CampaignVersions.md
index ebbf96c5..cb06e69a 100644
--- a/docs/CampaignVersions.md
+++ b/docs/CampaignVersions.md
@@ -7,11 +7,11 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**revisionFrontendState** | [**RevisionFrontendStateEnum**](#RevisionFrontendStateEnum) | The campaign revision state displayed in the Campaign Manager. | [optional]
-**activeRevisionId** | **Long** | ID of the revision that was last activated on this campaign. | [optional]
-**activeRevisionVersionId** | **Long** | ID of the revision version that is active on the campaign. | [optional]
-**version** | **Long** | Incrementing number representing how many revisions have been activated on this campaign, starts from 0 for a new campaign. | [optional]
-**currentRevisionId** | **Long** | ID of the revision currently being modified for the campaign. | [optional]
-**currentRevisionVersionId** | **Long** | ID of the latest version applied on the current revision. | [optional]
+**activeRevisionId** | **Integer** | ID of the revision that was last activated on this campaign. | [optional]
+**activeRevisionVersionId** | **Integer** | ID of the revision version that is active on the campaign. | [optional]
+**version** | **Integer** | Incrementing number representing how many revisions have been activated on this campaign, starts from 0 for a new campaign. | [optional]
+**currentRevisionId** | **Integer** | ID of the revision currently being modified for the campaign. | [optional]
+**currentRevisionVersionId** | **Integer** | ID of the latest version applied on the current revision. | [optional]
**stageRevision** | **Boolean** | Flag for determining whether we use current revision when sending requests with staging API key. | [optional]
diff --git a/docs/CardAddedDeductedPointsBalancesNotificationPolicy.md b/docs/CardAddedDeductedPointsBalancesNotificationPolicy.md
new file mode 100644
index 00000000..26c3c7f5
--- /dev/null
+++ b/docs/CardAddedDeductedPointsBalancesNotificationPolicy.md
@@ -0,0 +1,24 @@
+
+
+# CardAddedDeductedPointsBalancesNotificationPolicy
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | Notification name. |
+**scopes** | [**List<ScopesEnum>**](#List<ScopesEnum>) | |
+
+
+
+## Enum: List<ScopesEnum>
+
+Name | Value
+---- | -----
+ALL | "all"
+CAMPAIGN_MANAGER | "campaign_manager"
+MANAGEMENT_API | "management_api"
+RULE_ENGINE | "rule_engine"
+
+
+
diff --git a/docs/CardExpiringPointsNotificationPolicy.md b/docs/CardExpiringPointsNotificationPolicy.md
index 4cf701b7..c3fb6db4 100644
--- a/docs/CardExpiringPointsNotificationPolicy.md
+++ b/docs/CardExpiringPointsNotificationPolicy.md
@@ -9,7 +9,7 @@ Name | Type | Description | Notes
**name** | **String** | Notification name. |
**triggers** | [**List<CardExpiringPointsNotificationTrigger>**](CardExpiringPointsNotificationTrigger.md) | |
**batchingEnabled** | **Boolean** | Indicates whether batching is activated. | [optional]
-**batchSize** | **Long** | The required size of each batch of data. This value applies only when `batchingEnabled` is `true`. | [optional]
+**batchSize** | **Integer** | The required size of each batch of data. This value applies only when `batchingEnabled` is `true`. | [optional]
diff --git a/docs/CardExpiringPointsNotificationTrigger.md b/docs/CardExpiringPointsNotificationTrigger.md
index 0e73922c..27e5bcf3 100644
--- a/docs/CardExpiringPointsNotificationTrigger.md
+++ b/docs/CardExpiringPointsNotificationTrigger.md
@@ -6,7 +6,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**amount** | **Long** | The amount of period. |
+**amount** | **Integer** | The amount of period. |
**period** | [**PeriodEnum**](#PeriodEnum) | Notification period indicated by a letter; \"w\" means week, \"d\" means day. |
diff --git a/docs/CardLedgerPointsEntryIntegrationAPI.md b/docs/CardLedgerPointsEntryIntegrationAPI.md
index 1afef1ff..a91e1fe5 100644
--- a/docs/CardLedgerPointsEntryIntegrationAPI.md
+++ b/docs/CardLedgerPointsEntryIntegrationAPI.md
@@ -7,9 +7,9 @@ Loyalty card points with start and expiry dates.
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**id** | **Long** | ID of the transaction that adds loyalty points. |
+**id** | **Integer** | ID of the transaction that adds loyalty points. |
**created** | [**OffsetDateTime**](OffsetDateTime.md) | Date and time the loyalty card points were added. |
-**programId** | **Long** | ID of the loyalty program. |
+**programId** | **Integer** | ID of the loyalty program. |
**customerProfileID** | **String** | Integration ID of the customer profile linked to the card. | [optional]
**customerSessionId** | **String** | ID of the customer session where points were added. | [optional]
**name** | **String** | Name or reason of the transaction that adds loyalty points. |
diff --git a/docs/CardLedgerTransactionLogEntry.md b/docs/CardLedgerTransactionLogEntry.md
index 464d557a..0d4dc900 100644
--- a/docs/CardLedgerTransactionLogEntry.md
+++ b/docs/CardLedgerTransactionLogEntry.md
@@ -8,10 +8,10 @@ Log entry for a given loyalty card transaction.
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**created** | [**OffsetDateTime**](OffsetDateTime.md) | Date and time the loyalty card transaction occurred. |
-**programId** | **Long** | ID of the loyalty program. |
+**programId** | **Integer** | ID of the loyalty program. |
**cardIdentifier** | **String** | The alphanumeric identifier of the loyalty card. |
-**applicationId** | **Long** | The ID of the Application that owns this entity. | [optional]
-**sessionId** | **Long** | The **internal** ID of the session. | [optional]
+**applicationId** | **Integer** | The ID of the Application that owns this entity. | [optional]
+**sessionId** | **Integer** | The **internal** ID of the session. | [optional]
**customerSessionId** | **String** | ID of the customer session where the transaction occurred. | [optional]
**type** | [**TypeEnum**](#TypeEnum) | Type of transaction. Possible values: - `addition`: Signifies added points. - `subtraction`: Signifies deducted points. |
**name** | **String** | Name or reason of the loyalty ledger transaction. |
@@ -19,7 +19,7 @@ Name | Type | Description | Notes
**expiryDate** | **String** | Date when points expire. Possible values are: - `unlimited`: Points have no expiration date. - `timestamp value`: Points become active from the given date. |
**subledgerId** | **String** | ID of the subledger. |
**amount** | [**BigDecimal**](BigDecimal.md) | Amount of loyalty points added or deducted in the transaction. |
-**id** | **Long** | ID of the loyalty ledger entry. |
+**id** | **Integer** | ID of the loyalty ledger entry. |
diff --git a/docs/CardLedgerTransactionLogEntryIntegrationAPI.md b/docs/CardLedgerTransactionLogEntryIntegrationAPI.md
index 5314c9d9..b707d2c7 100644
--- a/docs/CardLedgerTransactionLogEntryIntegrationAPI.md
+++ b/docs/CardLedgerTransactionLogEntryIntegrationAPI.md
@@ -8,7 +8,7 @@ Log entry for a given loyalty card transaction.
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**created** | [**OffsetDateTime**](OffsetDateTime.md) | Date and time the loyalty card transaction occurred. |
-**programId** | **Long** | ID of the loyalty program. |
+**programId** | **Integer** | ID of the loyalty program. |
**cardIdentifier** | **String** | The alphanumeric identifier of the loyalty card. |
**customerSessionId** | **String** | ID of the customer session where the transaction occurred. | [optional]
**type** | [**TypeEnum**](#TypeEnum) | Type of transaction. Possible values: - `addition`: Signifies added points. - `subtraction`: Signifies deducted points. |
@@ -17,8 +17,8 @@ Name | Type | Description | Notes
**expiryDate** | **String** | Date when points expire. Possible values are: - `unlimited`: Points have no expiration date. - `timestamp value`: Points expire on the given date. |
**subledgerId** | **String** | ID of the subledger. |
**amount** | [**BigDecimal**](BigDecimal.md) | Amount of loyalty points added or deducted in the transaction. |
-**id** | **Long** | ID of the loyalty ledger transaction. |
-**rulesetId** | **Long** | The ID of the ruleset containing the rule that triggered this effect. | [optional]
+**id** | **Integer** | ID of the loyalty ledger transaction. |
+**rulesetId** | **Integer** | The ID of the ruleset containing the rule that triggered this effect. | [optional]
**ruleName** | **String** | The name of the rule that triggered this effect. | [optional]
diff --git a/docs/CartItem.md b/docs/CartItem.md
index fff32208..9c9cdf3f 100644
--- a/docs/CartItem.md
+++ b/docs/CartItem.md
@@ -8,9 +8,9 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **String** | Name of item. | [optional]
**sku** | **String** | Stock keeping unit of item. |
-**quantity** | **Long** | Number of units of this item. Due to [cart item flattening](https://docs.talon.one/docs/product/rules/understanding-cart-item-flattening), if you provide a quantity greater than 1, the item will be split in as many items as the provided quantity. This will impact the number of **per-item** effects triggered from your campaigns. |
-**returnedQuantity** | **Long** | Number of returned items, calculated internally based on returns of this item. | [optional]
-**remainingQuantity** | **Long** | Remaining quantity of the item, calculated internally based on returns of this item. | [optional]
+**quantity** | **Integer** | Number of units of this item. Due to [cart item flattening](https://docs.talon.one/docs/product/rules/understanding-cart-item-flattening), if you provide a quantity greater than 1, the item will be split in as many items as the provided quantity. This will impact the number of **per-item** effects triggered from your campaigns. |
+**returnedQuantity** | **Integer** | Number of returned items, calculated internally based on returns of this item. | [optional]
+**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]
@@ -21,7 +21,12 @@ Name | Type | Description | Notes
**position** | [**BigDecimal**](BigDecimal.md) | Position of the Cart Item in the Cart (calculated internally). | [optional]
**attributes** | [**Object**](.md) | Use this property to set a value for the attributes of your choice. [Attributes](https://docs.talon.one/docs/dev/concepts/attributes) represent any information to attach to this cart item. Custom _cart item_ attributes must be created in the Campaign Manager before you set them with this property. **Note:** Any previously defined attributes that you do not include in the array will be removed. | [optional]
**additionalCosts** | [**Map<String, AdditionalCost>**](AdditionalCost.md) | Use this property to set a value for the additional costs of this item, such as a shipping cost. They must be created in the Campaign Manager before you set them with this property. See [Managing additional costs](https://docs.talon.one/docs/product/account/dev-tools/managing-additional-costs). | [optional]
-**catalogItemID** | **Long** | The [catalog item ID](https://docs.talon.one/docs/product/account/dev-tools/managing-cart-item-catalogs/#synchronizing-a-cart-item-catalog). | [optional]
+**catalogItemID** | **Integer** | The catalog item ID. | [optional]
+**selectedPriceType** | **String** | The selected price type for this cart item (e.g. the price for members only). | [optional]
+**adjustmentReferenceId** | [**UUID**](UUID.md) | The reference identifier of the selected price adjustment for this cart item. This is only returned if the `selectedPrice` resulted from a price adjustment. | [optional]
+**adjustmentEffectiveFrom** | [**OffsetDateTime**](OffsetDateTime.md) | The date and time from which the price adjustment is effective. This is only returned if the `selectedPrice` resulted from a price adjustment that contains this field. | [optional]
+**adjustmentEffectiveUntil** | [**OffsetDateTime**](OffsetDateTime.md) | The date and time until which the price adjustment is effective. This is only returned if the `selectedPrice` resulted from a price adjustment that contains this field. | [optional]
+**prices** | [**Map<String, PriceDetail>**](PriceDetail.md) | A map of keys and values representing the price types and related price adjustment details for this cart item. The keys correspond to the `priceType` names. | [optional]
diff --git a/docs/Catalog.md b/docs/Catalog.md
index cb2cf8cc..a539de3e 100644
--- a/docs/Catalog.md
+++ b/docs/Catalog.md
@@ -6,15 +6,15 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**id** | **Long** | Internal ID of this entity. |
+**id** | **Integer** | The internal ID of this entity. |
**created** | [**OffsetDateTime**](OffsetDateTime.md) | The time this entity was created. |
-**accountId** | **Long** | The ID of the account that owns this entity. |
+**accountId** | **Integer** | The ID of the account that owns this entity. |
**modified** | [**OffsetDateTime**](OffsetDateTime.md) | The time this entity was last modified. |
**name** | **String** | The cart item catalog name. |
**description** | **String** | A description of this cart item catalog. |
-**subscribedApplicationsIds** | **List<Long>** | A list of the IDs of the applications that are subscribed to this catalog. | [optional]
-**version** | **Long** | The current version of this catalog. |
-**createdBy** | **Long** | The ID of user who created this catalog. |
+**subscribedApplicationsIds** | **List<Integer>** | A list of the IDs of the applications that are subscribed to this catalog. | [optional]
+**version** | **Integer** | The current version of this catalog. |
+**createdBy** | **Integer** | The ID of user who created this catalog. |
diff --git a/docs/CatalogAction.md b/docs/CatalogAction.md
index 9ed94318..d6c78874 100644
--- a/docs/CatalogAction.md
+++ b/docs/CatalogAction.md
@@ -21,6 +21,7 @@ PATCH | "PATCH"
PATCH_MANY | "PATCH_MANY"
REMOVE | "REMOVE"
REMOVE_MANY | "REMOVE_MANY"
+ADD_PRICE_ADJUSTMENT | "ADD_PRICE_ADJUSTMENT"
diff --git a/docs/CatalogItem.md b/docs/CatalogItem.md
index 1a4f3020..8af62b4c 100644
--- a/docs/CatalogItem.md
+++ b/docs/CatalogItem.md
@@ -6,12 +6,12 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**id** | **Long** | Internal ID of this entity. |
+**id** | **Integer** | The internal ID of this entity. |
**created** | [**OffsetDateTime**](OffsetDateTime.md) | The time this entity was created. |
**sku** | **String** | The stock keeping unit of the item. |
**price** | [**BigDecimal**](BigDecimal.md) | Price of the item. | [optional]
-**catalogid** | **Long** | The ID of the catalog the item belongs to. |
-**version** | **Long** | The version of the catalog item. |
+**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/CatalogSyncRequest.md b/docs/CatalogSyncRequest.md
index 94bafcc3..575f85b9 100644
--- a/docs/CatalogSyncRequest.md
+++ b/docs/CatalogSyncRequest.md
@@ -7,7 +7,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**actions** | [**List<CatalogAction>**](CatalogAction.md) | |
-**version** | **Long** | The version number of the catalog to apply the actions on. | [optional]
+**version** | **Integer** | The version number of the catalog to apply the actions on. | [optional]
diff --git a/docs/CatalogsStrikethroughNotificationPolicy.md b/docs/CatalogsStrikethroughNotificationPolicy.md
index e73851ab..1cac89d4 100644
--- a/docs/CatalogsStrikethroughNotificationPolicy.md
+++ b/docs/CatalogsStrikethroughNotificationPolicy.md
@@ -7,7 +7,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **String** | Notification name. |
-**aheadOfDaysTrigger** | **Long** | The number of days in advance that strikethrough pricing updates should be sent. | [optional]
+**aheadOfDaysTrigger** | **Integer** | The number of days in advance that strikethrough pricing updates should be sent. | [optional]
diff --git a/docs/Change.md b/docs/Change.md
index 40a62011..33108895 100644
--- a/docs/Change.md
+++ b/docs/Change.md
@@ -6,14 +6,14 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**id** | **Long** | Internal ID of this entity. |
+**id** | **Integer** | The internal ID of this entity. |
**created** | [**OffsetDateTime**](OffsetDateTime.md) | The time this entity was created. |
-**userId** | **Long** | The ID of the user associated with this entity. |
-**applicationId** | **Long** | ID of application associated with change. | [optional]
+**userId** | **Integer** | The ID of the user associated with this entity. |
+**applicationId** | **Integer** | ID of application associated with change. | [optional]
**entity** | **String** | API endpoint on which the change was initiated. |
**old** | [**Object**](.md) | Resource before the change occurred. | [optional]
**_new** | [**Object**](.md) | Resource after the change occurred. | [optional]
-**managementKeyId** | **Long** | ID of management key used to perform changes. | [optional]
+**managementKeyId** | **Integer** | ID of management key used to perform changes. | [optional]
diff --git a/docs/ChangeLoyaltyTierLevelEffectProps.md b/docs/ChangeLoyaltyTierLevelEffectProps.md
index f9356324..d1047ef5 100644
--- a/docs/ChangeLoyaltyTierLevelEffectProps.md
+++ b/docs/ChangeLoyaltyTierLevelEffectProps.md
@@ -8,7 +8,7 @@ The properties specific to the \"changeLoyaltyTierLevel\" effect. This is trigge
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**ruleTitle** | **String** | The title of the rule that triggered the tier upgrade. |
-**programId** | **Long** | The ID of the loyalty program where these points were added. |
+**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. | [optional]
**newTierName** | **String** | The name of the tier to which the user has been upgraded. |
diff --git a/docs/Collection.md b/docs/Collection.md
index 87327e1a..df905e80 100644
--- a/docs/Collection.md
+++ b/docs/Collection.md
@@ -6,17 +6,17 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**id** | **Long** | Internal ID of this entity. |
+**id** | **Integer** | The internal ID of this entity. |
**created** | [**OffsetDateTime**](OffsetDateTime.md) | The time this entity was created. |
-**accountId** | **Long** | The ID of the account that owns this entity. |
+**accountId** | **Integer** | The ID of the account that owns this entity. |
**modified** | [**OffsetDateTime**](OffsetDateTime.md) | The time this entity was last modified. |
**description** | **String** | A short description of the purpose of this collection. | [optional]
-**subscribedApplicationsIds** | **List<Long>** | A list of the IDs of the Applications where this collection is enabled. | [optional]
+**subscribedApplicationsIds** | **List<Integer>** | A list of the IDs of the Applications where this collection is enabled. | [optional]
**name** | **String** | The name of this collection. |
-**modifiedBy** | **Long** | ID of the user who last updated this effect if available. | [optional]
-**createdBy** | **Long** | ID of the user who created this effect. |
-**applicationId** | **Long** | The ID of the Application that owns this entity. | [optional]
-**campaignId** | **Long** | The ID of the campaign that owns this entity. | [optional]
+**modifiedBy** | **Integer** | ID of the user who last updated this effect if available. | [optional]
+**createdBy** | **Integer** | ID of the user who created this effect. |
+**applicationId** | **Integer** | The ID of the Application that owns this entity. | [optional]
+**campaignId** | **Integer** | The ID of the campaign that owns this entity. | [optional]
**payload** | **List<String>** | The content of the collection. | [optional]
diff --git a/docs/CollectionWithoutPayload.md b/docs/CollectionWithoutPayload.md
index 76426dc8..e93d029e 100644
--- a/docs/CollectionWithoutPayload.md
+++ b/docs/CollectionWithoutPayload.md
@@ -6,17 +6,17 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**id** | **Long** | Internal ID of this entity. |
+**id** | **Integer** | The internal ID of this entity. |
**created** | [**OffsetDateTime**](OffsetDateTime.md) | The time this entity was created. |
-**accountId** | **Long** | The ID of the account that owns this entity. |
+**accountId** | **Integer** | The ID of the account that owns this entity. |
**modified** | [**OffsetDateTime**](OffsetDateTime.md) | The time this entity was last modified. |
**description** | **String** | A short description of the purpose of this collection. | [optional]
-**subscribedApplicationsIds** | **List<Long>** | A list of the IDs of the Applications where this collection is enabled. | [optional]
+**subscribedApplicationsIds** | **List<Integer>** | A list of the IDs of the Applications where this collection is enabled. | [optional]
**name** | **String** | The name of this collection. |
-**modifiedBy** | **Long** | ID of the user who last updated this effect if available. | [optional]
-**createdBy** | **Long** | ID of the user who created this effect. |
-**applicationId** | **Long** | The ID of the Application that owns this entity. | [optional]
-**campaignId** | **Long** | The ID of the campaign that owns this entity. | [optional]
+**modifiedBy** | **Integer** | ID of the user who last updated this effect if available. | [optional]
+**createdBy** | **Integer** | ID of the user who created this effect. |
+**applicationId** | **Integer** | The ID of the Application that owns this entity. | [optional]
+**campaignId** | **Integer** | The ID of the campaign that owns this entity. | [optional]
diff --git a/docs/Coupon.md b/docs/Coupon.md
index 913e2a3c..e7ff4d98 100644
--- a/docs/Coupon.md
+++ b/docs/Coupon.md
@@ -6,24 +6,24 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**id** | **Long** | Internal ID of this entity. |
-**created** | [**OffsetDateTime**](OffsetDateTime.md) | The time this entity was created. |
-**campaignId** | **Long** | The ID of the campaign that owns this entity. |
+**id** | **Integer** | The internal ID of the coupon. |
+**created** | [**OffsetDateTime**](OffsetDateTime.md) | The time the coupon was created. |
+**campaignId** | **Integer** | The ID of the campaign that owns this entity. |
**value** | **String** | The coupon code. |
-**usageLimit** | **Long** | The number of times the coupon code can be redeemed. `0` means unlimited redemptions but any campaign usage limits will still apply. |
+**usageLimit** | **Integer** | The number of times the coupon code can be redeemed. `0` means unlimited redemptions but any campaign usage limits will still apply. |
**discountLimit** | [**BigDecimal**](BigDecimal.md) | The total discount value that the code can give. Typically used to represent a gift card value. | [optional]
-**reservationLimit** | **Long** | The number of reservations that can be made with this coupon code. | [optional]
+**reservationLimit** | **Integer** | The number of reservations that can be made with this coupon code. | [optional]
**startDate** | [**OffsetDateTime**](OffsetDateTime.md) | Timestamp at which point the coupon becomes valid. | [optional]
**expiryDate** | [**OffsetDateTime**](OffsetDateTime.md) | Expiration date of the coupon. Coupon never expires if this is omitted. | [optional]
**limits** | [**List<LimitConfig>**](LimitConfig.md) | Limits configuration for a coupon. These limits will override the limits set from the campaign. **Note:** Only usable when creating a single coupon which is not tied to a specific recipient. Only per-profile limits are allowed to be configured. | [optional]
-**usageCounter** | **Long** | The number of times the coupon has been successfully redeemed. |
+**usageCounter** | **Integer** | The number of times the coupon has been successfully redeemed. |
**discountCounter** | [**BigDecimal**](BigDecimal.md) | The amount of discounts given on rules redeeming this coupon. Only usable if a coupon discount budget was set for this coupon. | [optional]
**discountRemainder** | [**BigDecimal**](BigDecimal.md) | The remaining discount this coupon can give. | [optional]
**reservationCounter** | [**BigDecimal**](BigDecimal.md) | The number of times this coupon has been reserved. | [optional]
**attributes** | [**Object**](.md) | Custom attributes associated with this coupon. | [optional]
-**referralId** | **Long** | The integration ID of the referring customer (if any) for whom this coupon was created as an effect. | [optional]
+**referralId** | **Integer** | The integration ID of the referring customer (if any) for whom this coupon was created as an effect. | [optional]
**recipientIntegrationId** | **String** | The Integration ID of the customer that is allowed to redeem this coupon. | [optional]
-**importId** | **Long** | The ID of the Import which created this coupon. | [optional]
+**importId** | **Integer** | The ID of the Import which created this coupon. | [optional]
**reservation** | **Boolean** | Defines the reservation type: - `true`: The coupon can be reserved for multiple customers. - `false`: The coupon can be reserved only for one customer. It is a personal code. | [optional]
**batchId** | **String** | The id of the batch the coupon belongs to. | [optional]
**isReservationMandatory** | **Boolean** | An indication of whether the code can be redeemed only if it has been reserved first. | [optional]
diff --git a/docs/CouponConstraints.md b/docs/CouponConstraints.md
index d5c7d44a..199de7ac 100644
--- a/docs/CouponConstraints.md
+++ b/docs/CouponConstraints.md
@@ -6,9 +6,9 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**usageLimit** | **Long** | The number of times the coupon code can be redeemed. `0` means unlimited redemptions but any campaign usage limits will still apply. | [optional]
+**usageLimit** | **Integer** | The number of times the coupon code can be redeemed. `0` means unlimited redemptions but any campaign usage limits will still apply. | [optional]
**discountLimit** | [**BigDecimal**](BigDecimal.md) | The total discount value that the code can give. Typically used to represent a gift card value. | [optional]
-**reservationLimit** | **Long** | The number of reservations that can be made with this coupon code. | [optional]
+**reservationLimit** | **Integer** | The number of reservations that can be made with this coupon code. | [optional]
**startDate** | [**OffsetDateTime**](OffsetDateTime.md) | Timestamp at which point the coupon becomes valid. | [optional]
**expiryDate** | [**OffsetDateTime**](OffsetDateTime.md) | Expiration date of the coupon. Coupon never expires if this is omitted. | [optional]
diff --git a/docs/CouponCreationJob.md b/docs/CouponCreationJob.md
index ef1e7721..e8c828aa 100644
--- a/docs/CouponCreationJob.md
+++ b/docs/CouponCreationJob.md
@@ -6,28 +6,28 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**id** | **Long** | Internal ID of this entity. |
+**id** | **Integer** | The internal ID of this entity. |
**created** | [**OffsetDateTime**](OffsetDateTime.md) | The time this entity was created. |
-**campaignId** | **Long** | The ID of the campaign that owns this entity. |
-**applicationId** | **Long** | The ID of the Application that owns this entity. |
-**accountId** | **Long** | The ID of the account that owns this entity. |
-**usageLimit** | **Long** | The number of times the coupon code can be redeemed. `0` means unlimited redemptions but any campaign usage limits will still apply. |
+**campaignId** | **Integer** | The ID of the campaign that owns this entity. |
+**applicationId** | **Integer** | The ID of the Application that owns this entity. |
+**accountId** | **Integer** | The ID of the account that owns this entity. |
+**usageLimit** | **Integer** | The number of times the coupon code can be redeemed. `0` means unlimited redemptions but any campaign usage limits will still apply. |
**discountLimit** | [**BigDecimal**](BigDecimal.md) | The total discount value that the code can give. Typically used to represent a gift card value. | [optional]
-**reservationLimit** | **Long** | The number of reservations that can be made with this coupon code. | [optional]
+**reservationLimit** | **Integer** | The number of reservations that can be made with this coupon code. | [optional]
**startDate** | [**OffsetDateTime**](OffsetDateTime.md) | Timestamp at which point the coupon becomes valid. | [optional]
**expiryDate** | [**OffsetDateTime**](OffsetDateTime.md) | Expiration date of the coupon. Coupon never expires if this is omitted. | [optional]
-**numberOfCoupons** | **Long** | The number of new coupon codes to generate for the campaign. |
+**numberOfCoupons** | **Integer** | The number of new coupon codes to generate for the campaign. |
**couponSettings** | [**CodeGeneratorSettings**](CodeGeneratorSettings.md) | | [optional]
**attributes** | [**Object**](.md) | Arbitrary properties associated with coupons. |
**batchId** | **String** | The batch ID coupons created by this job will bear. |
**status** | **String** | The current status of this request. Possible values: - `pending verification` - `pending` - `completed` - `failed` - `coupon pattern full` |
-**createdAmount** | **Long** | The number of coupon codes that were already created for this request. |
-**failCount** | **Long** | The number of times this job failed. |
+**createdAmount** | **Integer** | The number of coupon codes that were already created for this request. |
+**failCount** | **Integer** | The number of times this job failed. |
**errors** | **List<String>** | An array of individual problems encountered during the request. |
-**createdBy** | **Long** | ID of the user who created this effect. |
+**createdBy** | **Integer** | ID of the user who created this effect. |
**communicated** | **Boolean** | Whether or not the user that created this job was notified of its final state. |
-**chunkExecutionCount** | **Long** | The number of times an attempt to create a chunk of coupons was made during the processing of the job. |
-**chunkSize** | **Long** | The number of coupons that will be created in a single transactions. Coupons will be created in chunks until arriving at the requested amount. | [optional]
+**chunkExecutionCount** | **Integer** | The number of times an attempt to create a chunk of coupons was made during the processing of the job. |
+**chunkSize** | **Integer** | The number of coupons that will be created in a single transactions. Coupons will be created in chunks until arriving at the requested amount. | [optional]
diff --git a/docs/CouponDeletionFilters.md b/docs/CouponDeletionFilters.md
index a3fc139b..ca21fae6 100644
--- a/docs/CouponDeletionFilters.md
+++ b/docs/CouponDeletionFilters.md
@@ -17,7 +17,7 @@ Name | Type | Description | Notes
**exactMatch** | **Boolean** | Filter results to an exact case-insensitive matching against the coupon code | [optional]
**value** | **String** | Filter results by the coupon code | [optional]
**batchId** | **String** | Filter results by batches of coupons | [optional]
-**referralId** | **Long** | Filter the results by matching them with the ID of a referral. This filter shows the coupons created by redeeming a referral code. | [optional]
+**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]
**expiresAfter** | [**OffsetDateTime**](OffsetDateTime.md) | 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**](OffsetDateTime.md) | 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]
diff --git a/docs/CouponDeletionJob.md b/docs/CouponDeletionJob.md
index 96dafc44..949b4d98 100644
--- a/docs/CouponDeletionJob.md
+++ b/docs/CouponDeletionJob.md
@@ -6,18 +6,18 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**id** | **Long** | Internal ID of this entity. |
+**id** | **Integer** | The internal ID of this entity. |
**created** | [**OffsetDateTime**](OffsetDateTime.md) | The time this entity was created. |
-**applicationId** | **Long** | The ID of the Application that owns this entity. |
-**accountId** | **Long** | The ID of the account that owns this entity. |
+**applicationId** | **Integer** | The ID of the Application that owns this entity. |
+**accountId** | **Integer** | The ID of the account that owns this entity. |
**filters** | [**CouponDeletionFilters**](CouponDeletionFilters.md) | |
**status** | **String** | The current status of this request. Possible values: - `not_ready` - `pending` - `completed` - `failed` |
-**deletedAmount** | **Long** | The number of coupon codes that were already deleted for this request. | [optional]
-**failCount** | **Long** | The number of times this job failed. |
+**deletedAmount** | **Integer** | The number of coupon codes that were already deleted for this request. | [optional]
+**failCount** | **Integer** | The number of times this job failed. |
**errors** | **List<String>** | An array of individual problems encountered during the request. |
-**createdBy** | **Long** | ID of the user who created this effect. |
+**createdBy** | **Integer** | ID of the user who created this effect. |
**communicated** | **Boolean** | Indicates whether the user that created this job was notified of its final state. |
-**campaignIDs** | **List<Long>** | | [optional]
+**campaignIDs** | **List<Integer>** | | [optional]
diff --git a/docs/CouponEntity.md b/docs/CouponEntity.md
new file mode 100644
index 00000000..525f0f33
--- /dev/null
+++ b/docs/CouponEntity.md
@@ -0,0 +1,13 @@
+
+
+# CouponEntity
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | The internal ID of the coupon. |
+**created** | [**OffsetDateTime**](OffsetDateTime.md) | The time the coupon was created. |
+
+
+
diff --git a/docs/CouponRejectionReason.md b/docs/CouponRejectionReason.md
index 97d21790..f5d5698c 100644
--- a/docs/CouponRejectionReason.md
+++ b/docs/CouponRejectionReason.md
@@ -7,8 +7,8 @@ Holds a reference to the campaign, the coupon and the reason for which that coup
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**campaignId** | **Long** | |
-**couponId** | **Long** | |
+**campaignId** | **Integer** | |
+**couponId** | **Integer** | |
**reason** | [**ReasonEnum**](#ReasonEnum) | |
diff --git a/docs/CouponsNotificationPolicy.md b/docs/CouponsNotificationPolicy.md
index d8334096..0b0175c0 100644
--- a/docs/CouponsNotificationPolicy.md
+++ b/docs/CouponsNotificationPolicy.md
@@ -10,7 +10,7 @@ Name | Type | Description | Notes
**scopes** | [**List<ScopesEnum>**](#List<ScopesEnum>) | |
**batchingEnabled** | **Boolean** | Indicates whether batching is activated. | [optional]
**includeData** | **Boolean** | Indicates whether to include all generated coupons. If `false`, only the `batchId` of the generated coupons is included. | [optional]
-**batchSize** | **Long** | The required size of each batch of data. This value applies only when `batchingEnabled` is `true`. | [optional]
+**batchSize** | **Integer** | The required size of each batch of data. This value applies only when `batchingEnabled` is `true`. | [optional]
diff --git a/docs/CreateAchievement.md b/docs/CreateAchievement.md
index 89b8f9c0..1fbfb220 100644
--- a/docs/CreateAchievement.md
+++ b/docs/CreateAchievement.md
@@ -12,7 +12,7 @@ Name | Type | Description | Notes
**target** | [**BigDecimal**](BigDecimal.md) | The required number of actions or the transactional milestone to complete the achievement. |
**period** | **String** | The relative duration after which the achievement ends and resets for a particular customer profile. **Note**: The `period` does not start when the achievement is created. The period is a **positive real number** followed by one letter indicating the time unit. Examples: `30s`, `40m`, `1h`, `5D`, `7W`, `10M`, `15Y`. Available units: - `s`: seconds - `m`: minutes - `h`: hours - `D`: days - `W`: weeks - `M`: months - `Y`: years You can also round certain units down to the beginning of period and up to the end of period.: - `_D` for rounding down days only. Signifies the start of the day. Example: `30D_D` - `_U` for rounding up days, weeks, months and years. Signifies the end of the day, week, month or year. Example: `23W_U` **Note**: You can either use the round down and round up option or set an absolute period. | [optional]
**periodEndOverride** | [**TimePoint**](TimePoint.md) | | [optional]
-**recurrencePolicy** | [**RecurrencePolicyEnum**](#RecurrencePolicyEnum) | The policy that determines if and how the achievement recurs. - `no_recurrence`: The achievement can be completed only once. - `on_expiration`: The achievement resets after it expires and becomes available again. | [optional]
+**recurrencePolicy** | [**RecurrencePolicyEnum**](#RecurrencePolicyEnum) | The policy that determines if and how the achievement recurs. - `no_recurrence`: The achievement can be completed only once. - `on_expiration`: The achievement resets after it expires and becomes available again. - `on_completion`: When the customer progress status reaches `completed`, the achievement resets and becomes available again. | [optional]
**activationPolicy** | [**ActivationPolicyEnum**](#ActivationPolicyEnum) | The policy that determines how the achievement starts, ends, or resets. - `user_action`: The achievement ends or resets relative to when the customer started the achievement. - `fixed_schedule`: The achievement starts, ends, or resets for all customers following a fixed schedule. | [optional]
**fixedStartDate** | [**OffsetDateTime**](OffsetDateTime.md) | The achievement's start date when `activationPolicy` is set to `fixed_schedule`. **Note:** It must be an RFC3339 timestamp string. | [optional]
**endDate** | [**OffsetDateTime**](OffsetDateTime.md) | The achievement's end date. If defined, customers cannot participate in the achievement after this date. **Note:** It must be an RFC3339 timestamp string. | [optional]
@@ -25,6 +25,7 @@ Name | Value
---- | -----
NO_RECURRENCE | "no_recurrence"
ON_EXPIRATION | "on_expiration"
+ON_COMPLETION | "on_completion"
diff --git a/docs/CreateApplicationAPIKey.md b/docs/CreateApplicationAPIKey.md
index d34444c6..0d8ced5d 100644
--- a/docs/CreateApplicationAPIKey.md
+++ b/docs/CreateApplicationAPIKey.md
@@ -10,7 +10,7 @@ Name | Type | Description | Notes
**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** | **Long** | 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]
+**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]
diff --git a/docs/CreateManagementKey.md b/docs/CreateManagementKey.md
index c1978a7e..d513ee45 100644
--- a/docs/CreateManagementKey.md
+++ b/docs/CreateManagementKey.md
@@ -9,7 +9,7 @@ Name | Type | Description | Notes
**name** | **String** | Name for management key. |
**expiryDate** | [**OffsetDateTime**](OffsetDateTime.md) | The date the management key expires. |
**endpoints** | [**List<Endpoint>**](Endpoint.md) | The list of endpoints that can be accessed with the key |
-**allowedApplicationIds** | **List<Long>** | A list of Application IDs that you can access with the management key. An empty or missing list means the management key can be used for all Applications in the account. | [optional]
+**allowedApplicationIds** | **List<Integer>** | A list of Application IDs that you can access with the management key. An empty or missing list means the management key can be used for all Applications in the account. | [optional]
diff --git a/docs/CreateTemplateCampaign.md b/docs/CreateTemplateCampaign.md
index 2d9afa5b..6a446708 100644
--- a/docs/CreateTemplateCampaign.md
+++ b/docs/CreateTemplateCampaign.md
@@ -8,14 +8,14 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **String** | A user-facing name for this campaign. |
**description** | **String** | A detailed description of the campaign. | [optional]
-**templateId** | **Long** | The ID of the Campaign Template which will be used in order to create the Campaign. |
+**templateId** | **Integer** | The ID of the Campaign Template which will be used in order to create the Campaign. |
**campaignAttributesOverrides** | [**Object**](.md) | Custom Campaign Attributes. If the Campaign Template defines the same values, they will be overridden. | [optional]
**templateParamValues** | [**List<Binding>**](Binding.md) | Actual values to replace the template placeholder values in the Ruleset bindings. Values for all Template Parameters must be provided. | [optional]
**limitOverrides** | [**List<LimitConfig>**](LimitConfig.md) | Limits for this Campaign. If the Campaign Template or Application define default values for the same limits, they will be overridden. | [optional]
-**campaignGroups** | **List<Long>** | The IDs of the [campaign groups](https://docs.talon.one/docs/product/account/account-settings/managing-campaign-groups) this campaign belongs to. | [optional]
+**campaignGroups** | **List<Integer>** | The IDs of the [campaign groups](https://docs.talon.one/docs/product/account/account-settings/managing-campaign-groups) this campaign belongs to. | [optional]
**tags** | **List<String>** | A list of tags for the campaign. If the campaign template has tags, they will be overridden by this list. | [optional]
-**evaluationGroupId** | **Long** | The ID of the campaign evaluation group the campaign belongs to. | [optional]
-**linkedStoreIds** | **List<Long>** | 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. | [optional]
+**evaluationGroupId** | **Integer** | The ID of the campaign evaluation group the campaign belongs to. | [optional]
+**linkedStoreIds** | **List<Integer>** | 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. | [optional]
diff --git a/docs/CustomEffect.md b/docs/CustomEffect.md
index 51032138..091933dc 100644
--- a/docs/CustomEffect.md
+++ b/docs/CustomEffect.md
@@ -6,11 +6,11 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**id** | **Long** | Internal ID of this entity. |
+**id** | **Integer** | The internal ID of this entity. |
**created** | [**OffsetDateTime**](OffsetDateTime.md) | The time this entity was created. |
-**accountId** | **Long** | The ID of the account that owns this entity. |
+**accountId** | **Integer** | The ID of the account that owns this entity. |
**modified** | [**OffsetDateTime**](OffsetDateTime.md) | The time this entity was last modified. |
-**applicationIds** | **List<Long>** | The IDs of the Applications that are related to this entity. |
+**applicationIds** | **List<Integer>** | The IDs of the Applications that are related to this entity. |
**isPerItem** | **Boolean** | Indicates if this effect is per item or not. | [optional]
**name** | **String** | The name of this effect. |
**title** | **String** | The title of this effect. |
@@ -18,8 +18,8 @@ Name | Type | Description | Notes
**description** | **String** | The description of this effect. | [optional]
**enabled** | **Boolean** | Determines if this effect is active. |
**params** | [**List<TemplateArgDef>**](TemplateArgDef.md) | Array of template argument definitions. | [optional]
-**modifiedBy** | **Long** | ID of the user who last updated this effect if available. | [optional]
-**createdBy** | **Long** | ID of the user who created this effect. |
+**modifiedBy** | **Integer** | ID of the user who last updated this effect if available. | [optional]
+**createdBy** | **Integer** | ID of the user who created this effect. |
diff --git a/docs/CustomEffectProps.md b/docs/CustomEffectProps.md
index 2209dfc1..aa4a5a5f 100644
--- a/docs/CustomEffectProps.md
+++ b/docs/CustomEffectProps.md
@@ -7,11 +7,11 @@ Effect containing custom payload.
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**effectId** | **Long** | The ID of the custom effect that was triggered. |
+**effectId** | **Integer** | The ID of the custom effect that was triggered. |
**name** | **String** | The type of the custom effect. |
**cartItemPosition** | [**BigDecimal**](BigDecimal.md) | The index of the item in the cart item list to which the custom effect is applied. | [optional]
**cartItemSubPosition** | [**BigDecimal**](BigDecimal.md) | For cart items with quantity > 1, the sub position indicates to which item unit the custom effect is applied. | [optional]
-**bundleIndex** | **Long** | The position of the bundle in a list of item bundles created from the same bundle definition. | [optional]
+**bundleIndex** | **Integer** | The position of the bundle in a list of item bundles created from the same bundle definition. | [optional]
**bundleName** | **String** | The name of the bundle definition. | [optional]
**payload** | [**Object**](.md) | The JSON payload of the custom effect. |
diff --git a/docs/CustomerActivityReport.md b/docs/CustomerActivityReport.md
index 80bb8134..c84488ce 100644
--- a/docs/CustomerActivityReport.md
+++ b/docs/CustomerActivityReport.md
@@ -10,15 +10,15 @@ Name | Type | Description | Notes
**integrationId** | **String** | The integration ID set by your integration layer. |
**created** | [**OffsetDateTime**](OffsetDateTime.md) | The time this entity was created. |
**name** | **String** | The name for this customer profile. |
-**customerId** | **Long** | The internal Talon.One ID of the customer. |
+**customerId** | **Integer** | The internal Talon.One ID of the customer. |
**lastActivity** | [**OffsetDateTime**](OffsetDateTime.md) | The last activity of the customer. | [optional]
-**couponRedemptions** | **Long** | Number of coupon redemptions in all customer campaigns. |
-**couponUseAttempts** | **Long** | Number of coupon use attempts in all customer campaigns. |
-**couponFailedAttempts** | **Long** | Number of failed coupon use attempts in all customer campaigns. |
+**couponRedemptions** | **Integer** | Number of coupon redemptions in all customer campaigns. |
+**couponUseAttempts** | **Integer** | Number of coupon use attempts in all customer campaigns. |
+**couponFailedAttempts** | **Integer** | Number of failed coupon use attempts in all customer campaigns. |
**accruedDiscounts** | [**BigDecimal**](BigDecimal.md) | Number of accrued discounts in all customer campaigns. |
**accruedRevenue** | [**BigDecimal**](BigDecimal.md) | Amount of accrued revenue in all customer campaigns. |
-**totalOrders** | **Long** | Number of orders in all customer campaigns. |
-**totalOrdersNoCoupon** | **Long** | Number of orders without coupon used in all customer campaigns. |
+**totalOrders** | **Integer** | Number of orders in all customer campaigns. |
+**totalOrdersNoCoupon** | **Integer** | Number of orders without coupon used in all customer campaigns. |
**campaignName** | **String** | The name of the campaign this customer belongs to. |
diff --git a/docs/CustomerAnalytics.md b/docs/CustomerAnalytics.md
index bd4e1e06..1bf509a2 100644
--- a/docs/CustomerAnalytics.md
+++ b/docs/CustomerAnalytics.md
@@ -7,11 +7,11 @@ A summary report of customer activity for a given time range.
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**acceptedCoupons** | **Long** | Total accepted coupons for this customer. |
-**createdCoupons** | **Long** | Total created coupons for this customer. |
-**freeItems** | **Long** | Total free items given to this customer. |
-**totalOrders** | **Long** | Total orders made by this customer. |
-**totalDiscountedOrders** | **Long** | Total orders made by this customer that had a discount. |
+**acceptedCoupons** | **Integer** | Total accepted coupons for this customer. |
+**createdCoupons** | **Integer** | Total created coupons for this customer. |
+**freeItems** | **Integer** | Total free items given to this customer. |
+**totalOrders** | **Integer** | Total orders made by this customer. |
+**totalDiscountedOrders** | **Integer** | Total orders made by this customer that had a discount. |
**totalRevenue** | [**BigDecimal**](BigDecimal.md) | Total Revenue across all closed sessions. |
**totalDiscounts** | [**BigDecimal**](BigDecimal.md) | The sum of discounts that were given across all closed sessions. |
diff --git a/docs/CustomerProfile.md b/docs/CustomerProfile.md
index 06fafffa..d6574584 100644
--- a/docs/CustomerProfile.md
+++ b/docs/CustomerProfile.md
@@ -6,12 +6,12 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**id** | **Long** | Internal ID of this entity. |
+**id** | **Integer** | The internal ID of the customer profile. |
**created** | [**OffsetDateTime**](OffsetDateTime.md) | The time this entity was created. |
**integrationId** | **String** | The integration ID set by your integration layer. |
**attributes** | [**Object**](.md) | Arbitrary properties associated with this item. |
-**accountId** | **Long** | The ID of the Talon.One account that owns this profile. |
-**closedSessions** | **Long** | The total amount of closed sessions by a customer. A closed session is a successful purchase. |
+**accountId** | **Integer** | The ID of the Talon.One account that owns this profile. |
+**closedSessions** | **Integer** | The total number of closed sessions. Does not include closed sessions that have been cancelled or reopened. See the [docs](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions#customer-session-states). |
**totalSales** | [**BigDecimal**](BigDecimal.md) | The total amount of money spent by the customer **before** discounts are applied. The total sales amount excludes the following: - Cancelled or reopened sessions. - Returned items. |
**loyaltyMemberships** | [**List<LoyaltyMembership>**](LoyaltyMembership.md) | **DEPRECATED** A list of loyalty programs joined by the customer. | [optional]
**audienceMemberships** | [**List<AudienceMembership>**](AudienceMembership.md) | The audiences the customer belongs to. | [optional]
diff --git a/docs/CustomerProfileAudienceRequestItem.md b/docs/CustomerProfileAudienceRequestItem.md
index 6cad277b..35b4a2ec 100644
--- a/docs/CustomerProfileAudienceRequestItem.md
+++ b/docs/CustomerProfileAudienceRequestItem.md
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**action** | [**ActionEnum**](#ActionEnum) | Defines the action to perform: - `add`: Adds the customer profile to the audience. **Note**: If the customer profile does not exist, it will be created. The profile will not be visible in any Application until a session or profile update is received for that profile. - `delete`: Removes the customer profile from the audience. |
**profileIntegrationId** | **String** | The ID of this customer profile in the third-party integration. |
-**audienceId** | **Long** | The ID of the audience. You get it via the `id` property when [creating an audience](#operation/createAudienceV2). |
+**audienceId** | **Integer** | The ID of the audience. You get it via the `id` property when [creating an audience](#operation/createAudienceV2). |
diff --git a/docs/CustomerProfileEntity.md b/docs/CustomerProfileEntity.md
new file mode 100644
index 00000000..b16fb76f
--- /dev/null
+++ b/docs/CustomerProfileEntity.md
@@ -0,0 +1,13 @@
+
+
+# CustomerProfileEntity
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | The internal ID of the customer profile. |
+**created** | [**OffsetDateTime**](OffsetDateTime.md) | The time the customer profile was created. |
+
+
+
diff --git a/docs/CustomerProfileIntegrationRequestV2.md b/docs/CustomerProfileIntegrationRequestV2.md
index 67166c88..8ce26dcd 100644
--- a/docs/CustomerProfileIntegrationRequestV2.md
+++ b/docs/CustomerProfileIntegrationRequestV2.md
@@ -8,7 +8,7 @@ The body of a V2 integration API request (customer profile update). Next to the
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**attributes** | [**Object**](.md) | Arbitrary properties associated with this item. | [optional]
-**evaluableCampaignIds** | **List<Long>** | When using the `dry` query parameter, use this property to list the campaign to be evaluated by the Rule Engine. These campaigns will be evaluated, even if they are disabled, allowing you to test specific campaigns before activating them. | [optional]
+**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]
**audiencesChanges** | [**ProfileAudiencesChanges**](ProfileAudiencesChanges.md) | | [optional]
**responseContent** | [**List<ResponseContentEnum>**](#List<ResponseContentEnum>) | Extends the response with the chosen data entities. Use this property to get as much data as you need in one _Update customer profile_ request instead of sending extra requests to other endpoints. | [optional]
diff --git a/docs/CustomerProfileSearchQuery.md b/docs/CustomerProfileSearchQuery.md
index 7a45d762..12512698 100644
--- a/docs/CustomerProfileSearchQuery.md
+++ b/docs/CustomerProfileSearchQuery.md
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**attributes** | [**Object**](.md) | Properties to match against a customer profile. All provided attributes will be exactly matched against profile attributes. | [optional]
**integrationIDs** | **List<String>** | | [optional]
-**profileIDs** | **List<Long>** | | [optional]
+**profileIDs** | **List<Integer>** | | [optional]
diff --git a/docs/CustomerSession.md b/docs/CustomerSession.md
index 00870960..2cbb2691 100644
--- a/docs/CustomerSession.md
+++ b/docs/CustomerSession.md
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**integrationId** | **String** | The integration ID set by your integration layer. |
**created** | [**OffsetDateTime**](OffsetDateTime.md) | The time this entity was created. |
-**applicationId** | **Long** | The ID of the Application that owns this entity. |
+**applicationId** | **Integer** | The ID of the Application that owns this entity. |
**profileId** | **String** | ID of the customer profile set by your integration layer. **Note:** If the customer does not yet have a known `profileId`, we recommend you use a guest `profileId`. |
**coupon** | **String** | Any coupon code entered. |
**referral** | **String** | Any referral code entered. |
diff --git a/docs/CustomerSessionV2.md b/docs/CustomerSessionV2.md
index c8657440..44970cec 100644
--- a/docs/CustomerSessionV2.md
+++ b/docs/CustomerSessionV2.md
@@ -7,13 +7,13 @@ The representation of the customer session.
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**id** | **Long** | Internal ID of this entity. |
+**id** | **Integer** | The internal ID of this entity. |
**created** | [**OffsetDateTime**](OffsetDateTime.md) | The time this entity was created. |
**integrationId** | **String** | The integration ID set by your integration layer. |
-**applicationId** | **Long** | The ID of the Application that owns this entity. |
+**applicationId** | **Integer** | The ID of the Application that owns this entity. |
**profileId** | **String** | ID of the customer profile set by your integration layer. **Note:** If the customer does not yet have a known `profileId`, we recommend you use a guest `profileId`. |
**storeIntegrationId** | **String** | The integration ID of the store. You choose this ID when you create a store. | [optional]
-**evaluableCampaignIds** | **List<Long>** | When using the `dry` query parameter, use this property to list the campaign to be evaluated by the Rule Engine. These campaigns will be evaluated, even if they are disabled, allowing you to test specific campaigns before activating them. | [optional]
+**evaluableCampaignIds** | **List<Integer>** | When using the `dry` query parameter, use this property to list the campaign to be evaluated by the Rule Engine. These campaigns will be evaluated, even if they are disabled, allowing you to test specific campaigns before activating them. | [optional]
**couponCodes** | **List<String>** | Any coupon codes entered. **Important - for requests only**: - If you [create a coupon budget](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets/#budget-types) for your campaign, ensure the session contains a coupon code by the time you close it. - In requests where `dry=false`, providing an empty array discards any previous coupons. To avoid this, omit the parameter entirely. | [optional]
**referralCode** | **String** | Any referral code entered. **Important - for requests only**: - If you [create a referral budget](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets/#budget-types) for your campaign, ensure the session contains a referral code by the time you close it. - In requests where `dry=false`, providing an empty value discards the previous referral code. To avoid this, omit the parameter entirely. | [optional]
**loyaltyCards** | **List<String>** | Identifier of a loyalty card. | [optional]
diff --git a/docs/DeductLoyaltyPoints.md b/docs/DeductLoyaltyPoints.md
index 06b9129b..e1508003 100644
--- a/docs/DeductLoyaltyPoints.md
+++ b/docs/DeductLoyaltyPoints.md
@@ -10,7 +10,7 @@ Name | Type | Description | Notes
**points** | [**BigDecimal**](BigDecimal.md) | Amount of loyalty points. |
**name** | **String** | Name / reason for the point deduction. | [optional]
**subledgerId** | **String** | ID of the subledger the points are deducted from. | [optional]
-**applicationId** | **Long** | ID of the Application that is connected to the loyalty program. | [optional]
+**applicationId** | **Integer** | ID of the Application that is connected to the loyalty program. | [optional]
diff --git a/docs/DeductLoyaltyPointsEffectProps.md b/docs/DeductLoyaltyPointsEffectProps.md
index 0fd8df94..cd34b15f 100644
--- a/docs/DeductLoyaltyPointsEffectProps.md
+++ b/docs/DeductLoyaltyPointsEffectProps.md
@@ -8,7 +8,7 @@ The properties specific to the \"deductLoyaltyPoints\" effect. This gets trigger
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**ruleTitle** | **String** | The title of the rule that contained triggered this points deduction. |
-**programId** | **Long** | The ID of the loyalty program where these points were added. |
+**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. |
**value** | [**BigDecimal**](BigDecimal.md) | The amount of points that were deducted. |
**transactionUUID** | **String** | The identifier of this deduction in the loyalty ledger. |
diff --git a/docs/Effect.md b/docs/Effect.md
index 5ba627e5..b30fa2b6 100644
--- a/docs/Effect.md
+++ b/docs/Effect.md
@@ -7,18 +7,21 @@ A generic effect that is fired by a triggered campaign. The props property will
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**campaignId** | **Long** | The ID of the campaign that triggered this effect. |
-**rulesetId** | **Long** | The ID of the ruleset that was active in the campaign when this effect was triggered. |
-**ruleIndex** | **Long** | The position of the rule that triggered this effect within the ruleset. |
+**campaignId** | **Integer** | The ID of the campaign that triggered this effect. |
+**rulesetId** | **Integer** | The ID of the ruleset that was active in the campaign when this effect was triggered. |
+**ruleIndex** | **Integer** | The position of the rule that triggered this effect within the ruleset. |
**ruleName** | **String** | The name of the rule that triggered this effect. |
**effectType** | **String** | The type of effect that was triggered. See [API effects](https://docs.talon.one/docs/dev/integration-api/api-effects). |
-**triggeredByCoupon** | **Long** | The ID of the coupon that was being evaluated when this effect was triggered. | [optional]
-**triggeredForCatalogItem** | **Long** | The ID of the catalog item that was being evaluated when this effect was triggered. | [optional]
-**conditionIndex** | **Long** | The index of the condition that was triggered. | [optional]
-**evaluationGroupID** | **Long** | The ID of the evaluation group. For more information, see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation). | [optional]
+**triggeredByCoupon** | **Integer** | The ID of the coupon that was being evaluated when this effect was triggered. | [optional]
+**triggeredForCatalogItem** | **Integer** | The ID of the catalog item that was being evaluated when this effect was triggered. | [optional]
+**conditionIndex** | **Integer** | The index of the condition that was triggered. | [optional]
+**evaluationGroupID** | **Integer** | The ID of the evaluation group. For more information, see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation). | [optional]
**evaluationGroupMode** | **String** | The evaluation mode of the evaluation group. For more information, see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation). | [optional]
-**campaignRevisionId** | **Long** | The revision ID of the campaign that was used when triggering the effect. | [optional]
-**campaignRevisionVersionId** | **Long** | The revision version ID of the campaign that was used when triggering the effect. | [optional]
+**campaignRevisionId** | **Integer** | The revision ID of the campaign that was used when triggering the effect. | [optional]
+**campaignRevisionVersionId** | **Integer** | The revision version ID of the campaign that was used when triggering the effect. | [optional]
+**selectedPriceType** | **String** | The selected price type for the SKU targeted by this effect. | [optional]
+**selectedPrice** | [**BigDecimal**](BigDecimal.md) | The value of the selected price type to apply to the SKU targeted by this effect, before any discounts are applied. | [optional]
+**adjustmentReferenceId** | [**UUID**](UUID.md) | The reference identifier of the selected price adjustment for this SKU. This is only returned if the `selectedPrice` resulted from a price adjustment. | [optional]
**props** | [**Object**](.md) | The properties of the effect. See [API effects](https://docs.talon.one/docs/dev/integration-api/api-effects). |
diff --git a/docs/EffectEntity.md b/docs/EffectEntity.md
index 28953626..11617e78 100644
--- a/docs/EffectEntity.md
+++ b/docs/EffectEntity.md
@@ -7,18 +7,21 @@ Definition of all properties that are present on all effects, independent of the
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**campaignId** | **Long** | The ID of the campaign that triggered this effect. |
-**rulesetId** | **Long** | The ID of the ruleset that was active in the campaign when this effect was triggered. |
-**ruleIndex** | **Long** | The position of the rule that triggered this effect within the ruleset. |
+**campaignId** | **Integer** | The ID of the campaign that triggered this effect. |
+**rulesetId** | **Integer** | The ID of the ruleset that was active in the campaign when this effect was triggered. |
+**ruleIndex** | **Integer** | The position of the rule that triggered this effect within the ruleset. |
**ruleName** | **String** | The name of the rule that triggered this effect. |
**effectType** | **String** | The type of effect that was triggered. See [API effects](https://docs.talon.one/docs/dev/integration-api/api-effects). |
-**triggeredByCoupon** | **Long** | The ID of the coupon that was being evaluated when this effect was triggered. | [optional]
-**triggeredForCatalogItem** | **Long** | The ID of the catalog item that was being evaluated when this effect was triggered. | [optional]
-**conditionIndex** | **Long** | The index of the condition that was triggered. | [optional]
-**evaluationGroupID** | **Long** | The ID of the evaluation group. For more information, see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation). | [optional]
+**triggeredByCoupon** | **Integer** | The ID of the coupon that was being evaluated when this effect was triggered. | [optional]
+**triggeredForCatalogItem** | **Integer** | The ID of the catalog item that was being evaluated when this effect was triggered. | [optional]
+**conditionIndex** | **Integer** | The index of the condition that was triggered. | [optional]
+**evaluationGroupID** | **Integer** | The ID of the evaluation group. For more information, see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation). | [optional]
**evaluationGroupMode** | **String** | The evaluation mode of the evaluation group. For more information, see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation). | [optional]
-**campaignRevisionId** | **Long** | The revision ID of the campaign that was used when triggering the effect. | [optional]
-**campaignRevisionVersionId** | **Long** | The revision version ID of the campaign that was used when triggering the effect. | [optional]
+**campaignRevisionId** | **Integer** | The revision ID of the campaign that was used when triggering the effect. | [optional]
+**campaignRevisionVersionId** | **Integer** | The revision version ID of the campaign that was used when triggering the effect. | [optional]
+**selectedPriceType** | **String** | The selected price type for the SKU targeted by this effect. | [optional]
+**selectedPrice** | [**BigDecimal**](BigDecimal.md) | The value of the selected price type to apply to the SKU targeted by this effect, before any discounts are applied. | [optional]
+**adjustmentReferenceId** | [**UUID**](UUID.md) | The reference identifier of the selected price adjustment for this SKU. This is only returned if the `selectedPrice` resulted from a price adjustment. | [optional]
diff --git a/docs/Entity.md b/docs/Entity.md
index 707445ec..24aba8df 100644
--- a/docs/Entity.md
+++ b/docs/Entity.md
@@ -6,7 +6,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**id** | **Long** | Internal ID of this entity. |
+**id** | **Integer** | The internal ID of this entity. |
**created** | [**OffsetDateTime**](OffsetDateTime.md) | The time this entity was created. |
diff --git a/docs/EntityWithTalangVisibleID.md b/docs/EntityWithTalangVisibleID.md
index 1d74f55f..be250ce5 100644
--- a/docs/EntityWithTalangVisibleID.md
+++ b/docs/EntityWithTalangVisibleID.md
@@ -6,7 +6,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**id** | **Long** | Unique ID for this entity. |
+**id** | **Integer** | Unique ID for this entity. |
**created** | [**OffsetDateTime**](OffsetDateTime.md) | The exact moment this entity was created. |
diff --git a/docs/Environment.md b/docs/Environment.md
index a617508a..68ef9c55 100644
--- a/docs/Environment.md
+++ b/docs/Environment.md
@@ -6,9 +6,9 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**id** | **Long** | Internal ID of this entity. |
+**id** | **Integer** | The internal ID of this entity. |
**created** | [**OffsetDateTime**](OffsetDateTime.md) | The time this entity was created. |
-**applicationId** | **Long** | The ID of the Application that owns this entity. |
+**applicationId** | **Integer** | The ID of the Application that owns this entity. |
**slots** | [**List<SlotDef>**](SlotDef.md) | The slots defined for this application. |
**functions** | [**List<FunctionDef>**](FunctionDef.md) | The functions defined for this application. |
**templates** | [**List<TemplateDef>**](TemplateDef.md) | The templates defined for this application. |
@@ -21,6 +21,7 @@ Name | Type | Description | Notes
**audiences** | [**List<Audience>**](Audience.md) | The audiences contained in the account which the application belongs to. | [optional]
**collections** | [**List<Collection>**](Collection.md) | The account-level collections that the application is subscribed to. | [optional]
**applicationCartItemFilters** | [**List<ApplicationCIF>**](ApplicationCIF.md) | The cart item filters belonging to the Application. | [optional]
+**priceTypes** | [**List<PriceType>**](PriceType.md) | The price types that this Application can use. | [optional]
diff --git a/docs/ErrorResponseWithStatus.md b/docs/ErrorResponseWithStatus.md
index f8ba17a6..4508f3e8 100644
--- a/docs/ErrorResponseWithStatus.md
+++ b/docs/ErrorResponseWithStatus.md
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**message** | **String** | | [optional]
**errors** | [**List<APIError>**](APIError.md) | An array of individual problems encountered during the request. | [optional]
-**statusCode** | **Long** | The error code | [optional]
+**statusCode** | **Integer** | The error code | [optional]
diff --git a/docs/EvaluableCampaignIds.md b/docs/EvaluableCampaignIds.md
index 006899ec..dfc4ee15 100644
--- a/docs/EvaluableCampaignIds.md
+++ b/docs/EvaluableCampaignIds.md
@@ -6,7 +6,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**evaluableCampaignIds** | **List<Long>** | When using the `dry` query parameter, use this property to list the campaign to be evaluated by the Rule Engine. These campaigns will be evaluated, even if they are disabled, allowing you to test specific campaigns before activating them. | [optional]
+**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]
diff --git a/docs/Event.md b/docs/Event.md
index 20a703c3..fe6aab0e 100644
--- a/docs/Event.md
+++ b/docs/Event.md
@@ -6,9 +6,9 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**id** | **Long** | Internal ID of this entity. |
+**id** | **Integer** | The internal ID of this entity. |
**created** | [**OffsetDateTime**](OffsetDateTime.md) | The time this entity was created. |
-**applicationId** | **Long** | The ID of the Application that owns this entity. |
+**applicationId** | **Integer** | The ID of the Application that owns this entity. |
**profileId** | **String** | ID of the customer profile set by your integration layer. **Note:** If the customer does not yet have a known `profileId`, we recommend you use a guest `profileId`. | [optional]
**storeIntegrationId** | **String** | The integration ID of the store. You choose this ID when you create a store. | [optional]
**type** | **String** | A string representing the event. Must not be a reserved event name. |
diff --git a/docs/EventType.md b/docs/EventType.md
index e0a406be..deaadaa0 100644
--- a/docs/EventType.md
+++ b/docs/EventType.md
@@ -6,7 +6,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**id** | **Long** | Internal ID of this entity. |
+**id** | **Integer** | The internal ID of this entity. |
**created** | [**OffsetDateTime**](OffsetDateTime.md) | The time this entity was created. |
**title** | **String** | The human-friendly name for this event type. |
**name** | **String** | The integration name for this event type. This will be used in URLs and cannot be changed after an event type has been created. |
diff --git a/docs/EventV2.md b/docs/EventV2.md
index 190c1e92..2a692493 100644
--- a/docs/EventV2.md
+++ b/docs/EventV2.md
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**profileId** | **String** | ID of the customer profile set by your integration layer. **Note:** If the customer does not yet have a known `profileId`, we recommend you use a guest `profileId`. | [optional]
**storeIntegrationId** | **String** | The integration ID of the store. You choose this ID when you create a store. | [optional]
-**evaluableCampaignIds** | **List<Long>** | When using the `dry` query parameter, use this property to list the campaign to be evaluated by the Rule Engine. These campaigns will be evaluated, even if they are disabled, allowing you to test specific campaigns before activating them. | [optional]
+**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]
**type** | **String** | A string representing the event name. Must not be a reserved event name. You create this value when you [create an attribute](https://docs.talon.one/docs/dev/concepts/entities/events#creating-a-custom-event) of type `event` in the Campaign Manager. |
**attributes** | [**Object**](.md) | Arbitrary additional JSON properties associated with the event. They must be created in the Campaign Manager before setting them with this property. See [creating custom attributes](https://docs.talon.one/docs/product/account/dev-tools/managing-attributes#creating-a-custom-attribute). | [optional]
diff --git a/docs/ExpiringCouponsNotificationPolicy.md b/docs/ExpiringCouponsNotificationPolicy.md
index cd500043..94c154e0 100644
--- a/docs/ExpiringCouponsNotificationPolicy.md
+++ b/docs/ExpiringCouponsNotificationPolicy.md
@@ -9,7 +9,7 @@ Name | Type | Description | Notes
**name** | **String** | Notification name. |
**triggers** | [**List<ExpiringCouponsNotificationTrigger>**](ExpiringCouponsNotificationTrigger.md) | |
**batchingEnabled** | **Boolean** | Indicates whether batching is activated. | [optional]
-**batchSize** | **Long** | The required size of each batch of data. This value applies only when `batchingEnabled` is `true`. | [optional]
+**batchSize** | **Integer** | The required size of each batch of data. This value applies only when `batchingEnabled` is `true`. | [optional]
diff --git a/docs/ExpiringCouponsNotificationTrigger.md b/docs/ExpiringCouponsNotificationTrigger.md
index 041eb082..92660fa2 100644
--- a/docs/ExpiringCouponsNotificationTrigger.md
+++ b/docs/ExpiringCouponsNotificationTrigger.md
@@ -6,7 +6,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**amount** | **Long** | The amount of period. |
+**amount** | **Integer** | The amount of period. |
**period** | [**PeriodEnum**](#PeriodEnum) | Notification period indicated by a letter; \"w\" means week, \"d\" means day. |
diff --git a/docs/ExpiringPointsNotificationPolicy.md b/docs/ExpiringPointsNotificationPolicy.md
index bb70889a..d32e5cc9 100644
--- a/docs/ExpiringPointsNotificationPolicy.md
+++ b/docs/ExpiringPointsNotificationPolicy.md
@@ -9,7 +9,7 @@ Name | Type | Description | Notes
**name** | **String** | Notification name. |
**triggers** | [**List<ExpiringPointsNotificationTrigger>**](ExpiringPointsNotificationTrigger.md) | |
**batchingEnabled** | **Boolean** | Indicates whether batching is activated. | [optional]
-**batchSize** | **Long** | The required size of each batch of data. This value applies only when `batchingEnabled` is `true`. | [optional]
+**batchSize** | **Integer** | The required size of each batch of data. This value applies only when `batchingEnabled` is `true`. | [optional]
diff --git a/docs/ExpiringPointsNotificationTrigger.md b/docs/ExpiringPointsNotificationTrigger.md
index b998f680..2dbe548e 100644
--- a/docs/ExpiringPointsNotificationTrigger.md
+++ b/docs/ExpiringPointsNotificationTrigger.md
@@ -6,7 +6,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**amount** | **Long** | The amount of period. |
+**amount** | **Integer** | The amount of period. |
**period** | [**PeriodEnum**](#PeriodEnum) | Notification period indicated by a letter; \"w\" means week, \"d\" means day. |
diff --git a/docs/Export.md b/docs/Export.md
index 669afcbd..37b23cc9 100644
--- a/docs/Export.md
+++ b/docs/Export.md
@@ -6,10 +6,10 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**id** | **Long** | Internal ID of this entity. |
+**id** | **Integer** | The internal ID of this entity. |
**created** | [**OffsetDateTime**](OffsetDateTime.md) | The time this entity was created. |
-**accountId** | **Long** | The ID of the account that owns this entity. |
-**userId** | **Long** | The ID of the user associated with this entity. |
+**accountId** | **Integer** | The ID of the account that owns this entity. |
+**userId** | **Integer** | The ID of the user associated with this entity. |
**entity** | [**EntityEnum**](#EntityEnum) | The name of the entity that was exported. |
**filter** | [**Object**](.md) | Map of keys and values that were used to filter the exported rows. |
diff --git a/docs/ExtendLoyaltyPointsExpiryDateEffectProps.md b/docs/ExtendLoyaltyPointsExpiryDateEffectProps.md
new file mode 100644
index 00000000..3ccce28a
--- /dev/null
+++ b/docs/ExtendLoyaltyPointsExpiryDateEffectProps.md
@@ -0,0 +1,17 @@
+
+
+# ExtendLoyaltyPointsExpiryDateEffectProps
+
+The properties specific to the \"extendLoyaltyPointsExpiryDate\" effect. This gets triggered when a validated rule contains the \"extend expiry date\" effect. The current expiry date gets extended by the time frame given in the effect.
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**programId** | **Integer** | ID of the loyalty program that contains these points. |
+**subLedgerId** | **String** | API name of the loyalty program subledger that contains these points. added. |
+**extensionDuration** | **String** | Time frame by which the expiry date extends. The time format is either: - immediate, or - an **integer** followed by a letter indicating the time unit. Examples: `immediate`, `30s`, `40m`, `1h`, `5D`, `7W`, `10M`, `15Y`. Available units: - `s`: seconds - `m`: minutes - `h`: hours - `D`: days - `W`: weeks - `M`: months - `Y`: years You can round certain units up or down: - `_D` for rounding down days only. Signifies the start of the day. - `_U` for rounding up days, weeks, months and years. Signifies the end of the day, week, month or year. |
+**transactionUUIDs** | **List<String>** | The list of identifiers of transactions affected affected by the extension. | [optional]
+**previousExpirationDate** | [**OffsetDateTime**](OffsetDateTime.md) | Expiry date before applying the extension. |
+
+
+
diff --git a/docs/GenerateCampaignDescription.md b/docs/GenerateCampaignDescription.md
index dfbc8adc..09e950ee 100644
--- a/docs/GenerateCampaignDescription.md
+++ b/docs/GenerateCampaignDescription.md
@@ -6,7 +6,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**rulesetID** | **Long** | ID of a ruleset. |
+**rulesetID** | **Integer** | ID of a ruleset. |
**currency** | **String** | Currency for the campaign. |
diff --git a/docs/GenerateCampaignTags.md b/docs/GenerateCampaignTags.md
index 729ac14f..29620daa 100644
--- a/docs/GenerateCampaignTags.md
+++ b/docs/GenerateCampaignTags.md
@@ -6,7 +6,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**rulesetID** | **Long** | ID of a ruleset. |
+**rulesetID** | **Integer** | ID of a ruleset. |
diff --git a/docs/GetIntegrationCouponRequest.md b/docs/GetIntegrationCouponRequest.md
index 78a2f60b..c52da1eb 100644
--- a/docs/GetIntegrationCouponRequest.md
+++ b/docs/GetIntegrationCouponRequest.md
@@ -6,8 +6,8 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**campaignIds** | **List<Long>** | A list of IDs of the campaigns to get coupons from. |
-**limit** | **Long** | The maximum number of coupons included in the response. |
+**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/Giveaway.md b/docs/Giveaway.md
index 8ff6f2c6..bbe41739 100644
--- a/docs/Giveaway.md
+++ b/docs/Giveaway.md
@@ -6,17 +6,17 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**id** | **Long** | Internal ID of this entity. |
+**id** | **Integer** | The internal ID of this entity. |
**created** | [**OffsetDateTime**](OffsetDateTime.md) | The time this entity was created. |
**code** | **String** | The code value of this giveaway. |
-**poolId** | **Long** | The ID of the pool to return giveaway codes from. |
+**poolId** | **Integer** | The ID of the pool to return giveaway codes from. |
**startDate** | [**OffsetDateTime**](OffsetDateTime.md) | Timestamp at which point the giveaway becomes valid. | [optional]
**endDate** | [**OffsetDateTime**](OffsetDateTime.md) | Timestamp at which point the giveaway becomes invalid. | [optional]
**attributes** | [**Object**](.md) | Arbitrary properties associated with this giveaway. | [optional]
**used** | **Boolean** | Indicates whether this giveaway code was given before. | [optional]
-**importId** | **Long** | The ID of the Import which created this giveaway. | [optional]
+**importId** | **Integer** | The ID of the Import which created this giveaway. | [optional]
**profileIntegrationId** | **String** | The third-party integration ID of the customer profile that was awarded the giveaway, if the giveaway was awarded. | [optional]
-**profileId** | **Long** | The internal ID of the customer profile that was awarded the giveaway, if the giveaway was awarded and an internal ID exists. | [optional]
+**profileId** | **Integer** | The internal ID of the customer profile that was awarded the giveaway, if the giveaway was awarded and an internal ID exists. | [optional]
diff --git a/docs/GiveawaysPool.md b/docs/GiveawaysPool.md
index 426f6637..d60f3556 100644
--- a/docs/GiveawaysPool.md
+++ b/docs/GiveawaysPool.md
@@ -7,16 +7,16 @@ Giveaways pools is an entity for managing multiple similar giveaways.
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**id** | **Long** | Internal ID of this entity. |
+**id** | **Integer** | The internal ID of this entity. |
**created** | [**OffsetDateTime**](OffsetDateTime.md) | The time this entity was created. |
-**accountId** | **Long** | The ID of the account that owns this entity. |
+**accountId** | **Integer** | The ID of the account that owns this entity. |
**name** | **String** | The name of this giveaways pool. |
**description** | **String** | The description of this giveaways pool. | [optional]
-**subscribedApplicationsIds** | **List<Long>** | A list of the IDs of the applications that this giveaways pool is enabled for. | [optional]
+**subscribedApplicationsIds** | **List<Integer>** | A list of the IDs of the applications that this giveaways pool is enabled for. | [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. |
**modified** | [**OffsetDateTime**](OffsetDateTime.md) | Timestamp of the most recent update to the giveaways pool. | [optional]
-**createdBy** | **Long** | ID of the user who created this giveaways pool. |
-**modifiedBy** | **Long** | ID of the user who last updated this giveaways pool if available. | [optional]
+**createdBy** | **Integer** | ID of the user who created this giveaways pool. |
+**modifiedBy** | **Integer** | ID of the user who last updated this giveaways pool if available. | [optional]
diff --git a/docs/HiddenConditionsEffects.md b/docs/HiddenConditionsEffects.md
index 837e2f97..c5807e96 100644
--- a/docs/HiddenConditionsEffects.md
+++ b/docs/HiddenConditionsEffects.md
@@ -9,8 +9,8 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**builtInEffects** | **List<String>** | List of hidden built-in effects. | [optional]
**conditions** | **List<String>** | List of hidden conditions. | [optional]
-**customEffects** | **List<Long>** | List of the IDs of hidden custom effects. | [optional]
-**webhooks** | **List<Long>** | List of the IDs of hidden webhooks. | [optional]
+**customEffects** | **List<Integer>** | List of the IDs of hidden custom effects. | [optional]
+**webhooks** | **List<Integer>** | List of the IDs of hidden webhooks. | [optional]
diff --git a/docs/IdentifiableEntity.md b/docs/IdentifiableEntity.md
index 1b7f7ee3..a4f78340 100644
--- a/docs/IdentifiableEntity.md
+++ b/docs/IdentifiableEntity.md
@@ -6,7 +6,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**id** | **Long** | Unique ID for this entity. Not to be confused with the Integration ID, which is set by your integration layer and used in most endpoints. |
+**id** | **Integer** | Unique ID for this entity. Not to be confused with the Integration ID, which is set by your integration layer and used in most endpoints. |
diff --git a/docs/ImportEntity.md b/docs/ImportEntity.md
index e3c2a4b3..418b1708 100644
--- a/docs/ImportEntity.md
+++ b/docs/ImportEntity.md
@@ -6,7 +6,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**importId** | **Long** | The ID of the Import which created this referral. | [optional]
+**importId** | **Integer** | The ID of the Import which created this referral. | [optional]
diff --git a/docs/IncreaseAchievementProgressEffectProps.md b/docs/IncreaseAchievementProgressEffectProps.md
index 93c88f38..b0e7992e 100644
--- a/docs/IncreaseAchievementProgressEffectProps.md
+++ b/docs/IncreaseAchievementProgressEffectProps.md
@@ -7,9 +7,9 @@ The properties specific to the \"increaseAchievementProgress\" effect. This gets
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**achievementId** | **Long** | The internal ID of the achievement. |
+**achievementId** | **Integer** | The internal ID of the achievement. |
**achievementName** | **String** | The name of the achievement. |
-**progressTrackerId** | **Long** | The internal ID of the achievement progress tracker. | [optional]
+**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 target value to complete the achievement. |
diff --git a/docs/InlineResponse200.md b/docs/InlineResponse200.md
index b91a6717..2f5a9a3d 100644
--- a/docs/InlineResponse200.md
+++ b/docs/InlineResponse200.md
@@ -6,7 +6,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**totalResultSize** | **Long** | |
+**totalResultSize** | **Integer** | |
**data** | [**List<CustomerProfile>**](CustomerProfile.md) | |
diff --git a/docs/InlineResponse2001.md b/docs/InlineResponse2001.md
index 63fd5662..6b209555 100644
--- a/docs/InlineResponse2001.md
+++ b/docs/InlineResponse2001.md
@@ -6,7 +6,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**totalResultSize** | **Long** | |
+**totalResultSize** | **Integer** | |
**data** | [**List<AchievementStatusEntry>**](AchievementStatusEntry.md) | |
diff --git a/docs/InlineResponse20010.md b/docs/InlineResponse20010.md
index e3f25d69..fbe81327 100644
--- a/docs/InlineResponse20010.md
+++ b/docs/InlineResponse20010.md
@@ -6,7 +6,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**totalResultSize** | **Long** | |
+**totalResultSize** | **Integer** | |
**data** | [**List<Coupon>**](Coupon.md) | |
diff --git a/docs/InlineResponse20013.md b/docs/InlineResponse20013.md
index 69a43ac4..28c9e417 100644
--- a/docs/InlineResponse20013.md
+++ b/docs/InlineResponse20013.md
@@ -6,7 +6,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**totalResultSize** | **Long** | |
+**totalResultSize** | **Integer** | |
**data** | [**List<CampaignGroup>**](CampaignGroup.md) | |
diff --git a/docs/InlineResponse20015.md b/docs/InlineResponse20015.md
index 80e9704d..7c533913 100644
--- a/docs/InlineResponse20015.md
+++ b/docs/InlineResponse20015.md
@@ -6,7 +6,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**totalResultSize** | **Long** | |
+**totalResultSize** | **Integer** | |
**data** | [**List<LoyaltyProgram>**](LoyaltyProgram.md) | |
diff --git a/docs/InlineResponse20016.md b/docs/InlineResponse20016.md
index 83a15fbb..0f1a3f5b 100644
--- a/docs/InlineResponse20016.md
+++ b/docs/InlineResponse20016.md
@@ -6,7 +6,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**totalResultSize** | **Long** | |
+**totalResultSize** | **Integer** | |
**data** | [**List<LoyaltyDashboardData>**](LoyaltyDashboardData.md) | |
diff --git a/docs/InlineResponse2002.md b/docs/InlineResponse2002.md
index e6049688..fbeb9c67 100644
--- a/docs/InlineResponse2002.md
+++ b/docs/InlineResponse2002.md
@@ -6,7 +6,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**totalResultSize** | **Long** | |
+**totalResultSize** | **Integer** | |
**data** | [**List<AchievementProgress>**](AchievementProgress.md) | |
diff --git a/docs/InlineResponse20020.md b/docs/InlineResponse20020.md
index f6179802..73cf2e6f 100644
--- a/docs/InlineResponse20020.md
+++ b/docs/InlineResponse20020.md
@@ -7,7 +7,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**hasMore** | **Boolean** | | [optional]
-**totalResultSize** | **Long** | | [optional]
+**totalResultSize** | **Integer** | | [optional]
**data** | [**List<CollectionWithoutPayload>**](CollectionWithoutPayload.md) | |
diff --git a/docs/InlineResponse20023.md b/docs/InlineResponse20023.md
index 5dd633aa..cf263cd4 100644
--- a/docs/InlineResponse20023.md
+++ b/docs/InlineResponse20023.md
@@ -6,7 +6,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**totalResultSize** | **Long** | |
+**totalResultSize** | **Integer** | |
**data** | [**List<CampaignAnalytics>**](CampaignAnalytics.md) | |
diff --git a/docs/InlineResponse20024.md b/docs/InlineResponse20024.md
index 53aee5a1..3069eab1 100644
--- a/docs/InlineResponse20024.md
+++ b/docs/InlineResponse20024.md
@@ -6,7 +6,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**totalResultSize** | **Long** | | [optional]
+**totalResultSize** | **Integer** | | [optional]
**hasMore** | **Boolean** | | [optional]
**data** | [**List<ApplicationCustomer>**](ApplicationCustomer.md) | |
diff --git a/docs/InlineResponse20025.md b/docs/InlineResponse20025.md
index 5ef800ec..40220f63 100644
--- a/docs/InlineResponse20025.md
+++ b/docs/InlineResponse20025.md
@@ -7,7 +7,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**hasMore** | **Boolean** | | [optional]
-**totalResultSize** | **Long** | | [optional]
+**totalResultSize** | **Integer** | | [optional]
**data** | [**List<ApplicationCustomer>**](ApplicationCustomer.md) | |
diff --git a/docs/InlineResponse20026.md b/docs/InlineResponse20026.md
index d783ea33..a598d4f5 100644
--- a/docs/InlineResponse20026.md
+++ b/docs/InlineResponse20026.md
@@ -7,7 +7,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**hasMore** | **Boolean** | | [optional]
-**totalResultSize** | **Long** | | [optional]
+**totalResultSize** | **Integer** | | [optional]
**data** | [**List<CustomerProfile>**](CustomerProfile.md) | |
diff --git a/docs/InlineResponse20031.md b/docs/InlineResponse20031.md
index 7312e701..8c8fad3b 100644
--- a/docs/InlineResponse20031.md
+++ b/docs/InlineResponse20031.md
@@ -6,7 +6,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**totalResultSize** | **Long** | |
+**totalResultSize** | **Integer** | |
**data** | **List<String>** | |
diff --git a/docs/InlineResponse20032.md b/docs/InlineResponse20032.md
index a727b244..b04d3548 100644
--- a/docs/InlineResponse20032.md
+++ b/docs/InlineResponse20032.md
@@ -7,7 +7,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**hasMore** | **Boolean** | | [optional]
-**totalResultSize** | **Long** | | [optional]
+**totalResultSize** | **Integer** | | [optional]
**data** | [**List<Audience>**](Audience.md) | |
diff --git a/docs/InlineResponse20035.md b/docs/InlineResponse20035.md
index 4f0dfdf4..aa4c8bd3 100644
--- a/docs/InlineResponse20035.md
+++ b/docs/InlineResponse20035.md
@@ -7,7 +7,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**hasMore** | **Boolean** | | [optional]
-**totalResultSize** | **Long** | | [optional]
+**totalResultSize** | **Integer** | | [optional]
**data** | [**List<ApplicationReferee>**](ApplicationReferee.md) | |
diff --git a/docs/InlineResponse20036.md b/docs/InlineResponse20036.md
index 4fbbf04d..c35fa228 100644
--- a/docs/InlineResponse20036.md
+++ b/docs/InlineResponse20036.md
@@ -6,7 +6,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**totalResultSize** | **Long** | |
+**totalResultSize** | **Integer** | |
**data** | [**List<Attribute>**](Attribute.md) | |
diff --git a/docs/InlineResponse20037.md b/docs/InlineResponse20037.md
index f7e3566a..ff316f17 100644
--- a/docs/InlineResponse20037.md
+++ b/docs/InlineResponse20037.md
@@ -7,7 +7,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**hasMore** | **Boolean** | | [optional]
-**totalResultSize** | **Long** | | [optional]
+**totalResultSize** | **Integer** | | [optional]
**data** | [**List<CatalogItem>**](CatalogItem.md) | |
diff --git a/docs/InlineResponse20038.md b/docs/InlineResponse20038.md
index 807b6eb1..2c337da8 100644
--- a/docs/InlineResponse20038.md
+++ b/docs/InlineResponse20038.md
@@ -6,7 +6,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**totalResultSize** | **Long** | |
+**totalResultSize** | **Integer** | |
**data** | [**List<AccountAdditionalCost>**](AccountAdditionalCost.md) | |
diff --git a/docs/InlineResponse20039.md b/docs/InlineResponse20039.md
index df470b34..88c8ef31 100644
--- a/docs/InlineResponse20039.md
+++ b/docs/InlineResponse20039.md
@@ -6,7 +6,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**totalResultSize** | **Long** | |
+**totalResultSize** | **Integer** | |
**data** | [**List<WebhookWithOutgoingIntegrationDetails>**](WebhookWithOutgoingIntegrationDetails.md) | |
diff --git a/docs/InlineResponse20040.md b/docs/InlineResponse20040.md
index b3860e5b..2c3f8170 100644
--- a/docs/InlineResponse20040.md
+++ b/docs/InlineResponse20040.md
@@ -6,7 +6,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**totalResultSize** | **Long** | |
+**totalResultSize** | **Integer** | |
**data** | [**List<WebhookActivationLogEntry>**](WebhookActivationLogEntry.md) | |
diff --git a/docs/InlineResponse20041.md b/docs/InlineResponse20041.md
index 396d94c9..0b439bc3 100644
--- a/docs/InlineResponse20041.md
+++ b/docs/InlineResponse20041.md
@@ -6,7 +6,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**totalResultSize** | **Long** | |
+**totalResultSize** | **Integer** | |
**data** | [**List<WebhookLogEntry>**](WebhookLogEntry.md) | |
diff --git a/docs/InlineResponse20042.md b/docs/InlineResponse20042.md
index 56ff961a..288c66e5 100644
--- a/docs/InlineResponse20042.md
+++ b/docs/InlineResponse20042.md
@@ -6,7 +6,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**totalResultSize** | **Long** | |
+**totalResultSize** | **Integer** | |
**data** | [**List<EventType>**](EventType.md) | |
diff --git a/docs/InlineResponse20043.md b/docs/InlineResponse20043.md
index 4d69f414..2fa864b7 100644
--- a/docs/InlineResponse20043.md
+++ b/docs/InlineResponse20043.md
@@ -6,7 +6,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**totalResultSize** | **Long** | |
+**totalResultSize** | **Integer** | |
**data** | [**List<User>**](User.md) | |
diff --git a/docs/InlineResponse20044.md b/docs/InlineResponse20044.md
index 5af1b6d0..5cb71ae6 100644
--- a/docs/InlineResponse20044.md
+++ b/docs/InlineResponse20044.md
@@ -6,7 +6,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**totalResultSize** | **Long** | | [optional]
+**totalResultSize** | **Integer** | | [optional]
**hasMore** | **Boolean** | | [optional]
**data** | [**List<Change>**](Change.md) | |
diff --git a/docs/InlineResponse20045.md b/docs/InlineResponse20045.md
index 3712756c..c909fc95 100644
--- a/docs/InlineResponse20045.md
+++ b/docs/InlineResponse20045.md
@@ -6,7 +6,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**totalResultSize** | **Long** | |
+**totalResultSize** | **Integer** | |
**data** | [**List<Export>**](Export.md) | |
diff --git a/docs/InlineResponse20046.md b/docs/InlineResponse20046.md
index 20110f99..4571d938 100644
--- a/docs/InlineResponse20046.md
+++ b/docs/InlineResponse20046.md
@@ -6,7 +6,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**totalResultSize** | **Long** | |
+**totalResultSize** | **Integer** | |
**data** | [**List<RoleV2>**](RoleV2.md) | |
diff --git a/docs/InlineResponse20047.md b/docs/InlineResponse20047.md
index c994c7d7..d151232d 100644
--- a/docs/InlineResponse20047.md
+++ b/docs/InlineResponse20047.md
@@ -7,7 +7,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**hasMore** | **Boolean** | | [optional]
-**totalResultSize** | **Long** | | [optional]
+**totalResultSize** | **Integer** | | [optional]
**data** | [**List<Store>**](Store.md) | |
diff --git a/docs/InlineResponse20048.md b/docs/InlineResponse20048.md
index c7e4b31e..e614c01b 100644
--- a/docs/InlineResponse20048.md
+++ b/docs/InlineResponse20048.md
@@ -6,8 +6,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**hasMore** | **Boolean** | | [optional]
-**data** | [**List<Achievement>**](Achievement.md) | |
+**data** | [**List<ListCampaignStoreBudgets>**](ListCampaignStoreBudgets.md) | | [optional]
diff --git a/docs/InlineResponse20049.md b/docs/InlineResponse20049.md
index 6e71e2ee..11e9d0a2 100644
--- a/docs/InlineResponse20049.md
+++ b/docs/InlineResponse20049.md
@@ -6,8 +6,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**hasMore** | **Boolean** | |
-**data** | [**List<AchievementProgressWithDefinition>**](AchievementProgressWithDefinition.md) | |
+**data** | [**List<SummaryCampaignStoreBudget>**](SummaryCampaignStoreBudget.md) | | [optional]
diff --git a/docs/InlineResponse20050.md b/docs/InlineResponse20050.md
new file mode 100644
index 00000000..eca147aa
--- /dev/null
+++ b/docs/InlineResponse20050.md
@@ -0,0 +1,13 @@
+
+
+# InlineResponse20050
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**hasMore** | **Boolean** | | [optional]
+**data** | [**List<Achievement>**](Achievement.md) | |
+
+
+
diff --git a/docs/InlineResponse20051.md b/docs/InlineResponse20051.md
new file mode 100644
index 00000000..836b7a79
--- /dev/null
+++ b/docs/InlineResponse20051.md
@@ -0,0 +1,13 @@
+
+
+# InlineResponse20051
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**hasMore** | **Boolean** | |
+**data** | [**List<AchievementProgressWithDefinition>**](AchievementProgressWithDefinition.md) | |
+
+
+
diff --git a/docs/InlineResponse2007.md b/docs/InlineResponse2007.md
index 9eb0b785..bc41ed7b 100644
--- a/docs/InlineResponse2007.md
+++ b/docs/InlineResponse2007.md
@@ -6,7 +6,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**totalResultSize** | **Long** | |
+**totalResultSize** | **Integer** | |
**data** | [**List<Application>**](Application.md) | |
diff --git a/docs/InlineResponse2008.md b/docs/InlineResponse2008.md
index ad294e9b..30e0574d 100644
--- a/docs/InlineResponse2008.md
+++ b/docs/InlineResponse2008.md
@@ -6,7 +6,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**totalResultSize** | **Long** | |
+**totalResultSize** | **Integer** | |
**data** | [**List<Campaign>**](Campaign.md) | |
diff --git a/docs/InlineResponse2009.md b/docs/InlineResponse2009.md
index 9f44a248..51f8fdf8 100644
--- a/docs/InlineResponse2009.md
+++ b/docs/InlineResponse2009.md
@@ -6,7 +6,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**totalResultSize** | **Long** | |
+**totalResultSize** | **Integer** | |
**data** | [**List<Ruleset>**](Ruleset.md) | |
diff --git a/docs/InlineResponse201.md b/docs/InlineResponse201.md
index 13137f39..814dcb6c 100644
--- a/docs/InlineResponse201.md
+++ b/docs/InlineResponse201.md
@@ -6,7 +6,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**totalResultSize** | **Long** | |
+**totalResultSize** | **Integer** | |
**data** | [**List<Referral>**](Referral.md) | |
diff --git a/docs/IntegrationApi.md b/docs/IntegrationApi.md
index 0cbf44e3..7e2800c9 100644
--- a/docs/IntegrationApi.md
+++ b/docs/IntegrationApi.md
@@ -372,7 +372,7 @@ public class Example {
//api_key_v1.setApiKeyPrefix("Token");
IntegrationApi apiInstance = new IntegrationApi(defaultClient);
- Long audienceId = 56L; // Long | The ID of the audience.
+ Integer audienceId = 56; // Integer | The ID of the audience.
try {
apiInstance.deleteAudienceMembershipsV2(audienceId);
} catch (ApiException e) {
@@ -391,7 +391,7 @@ public class Example {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **audienceId** | **Long**| The ID of the audience. |
+ **audienceId** | **Integer**| The ID of the audience. |
### Return type cool
@@ -445,7 +445,7 @@ public class Example {
//api_key_v1.setApiKeyPrefix("Token");
IntegrationApi apiInstance = new IntegrationApi(defaultClient);
- Long audienceId = 56L; // Long | The ID of the audience.
+ Integer audienceId = 56; // Integer | The ID of the audience.
try {
apiInstance.deleteAudienceV2(audienceId);
} catch (ApiException e) {
@@ -464,7 +464,7 @@ public class Example {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **audienceId** | **Long**| The ID of the audience. |
+ **audienceId** | **Integer**| The ID of the audience. |
### Return type cool
@@ -668,7 +668,7 @@ public class Example {
//api_key_v1.setApiKeyPrefix("Token");
IntegrationApi apiInstance = new IntegrationApi(defaultClient);
- Long loyaltyProgramId = 56L; // Long | Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
+ 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.
GenerateLoyaltyCard body = new GenerateLoyaltyCard(); // GenerateLoyaltyCard | body
try {
LoyaltyCard result = apiInstance.generateLoyaltyCard(loyaltyProgramId, body);
@@ -689,7 +689,7 @@ public class Example {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **loyaltyProgramId** | **Long**| Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. |
+ **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. |
**body** | [**GenerateLoyaltyCard**](GenerateLoyaltyCard.md)| body |
### Return type cool
@@ -745,12 +745,12 @@ public class Example {
IntegrationApi apiInstance = new IntegrationApi(defaultClient);
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.
- Long achievementId = 56L; // Long | The achievement identifier.
+ Integer achievementId = 56; // Integer | The achievement identifier.
List