Merge pull request #37 from talon-one/update_sdk

9.0.0
talon-one · Sep 25, 2024 · e221622 · e221622
2 parents 9e84202 + 9312214
commit e221622
Show file tree

Hide file tree

Showing 765 changed files with 12,722 additions and 6,204 deletions.
diff --git a/.travis.yml b/.travis.yml
@@ -1,11 +1,5 @@
 language: node_js
 cache: npm
 node_js:
-  - "14.15.4"
-  - "12.20.1"
-  - "10.13.0"
-  - "8.11.0"
-  - "8.9.0"
   - "6"
   - "6.1"
-  - "5.11"
diff --git a/README.md b/README.md
diff --git a/docs/AccountDashboardStatisticApiCalls.md b/docs/AccountDashboardStatisticApiCalls.md
diff --git a/docs/AchievementProgress.md b/docs/AchievementProgress.md
@@ -7,6 +7,7 @@ Name | Type | Description | Notes
 **achievementId** | **Number** | 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** | **Number** | The ID of the campaign the achievement belongs to. | 
 **status** | **String** | The status of the achievement. | 
 **target** | **Number** | The required number of actions or the transactional milestone to complete the achievement. | [optional] 

diff --git a/docs/AdditionalCampaignProperties.md b/docs/AdditionalCampaignProperties.md
@@ -26,6 +26,7 @@ Name | Type | Description | Notes
 **updatedBy** | **String** | Name of the user who last updated this campaign if available. | [optional] 
 **templateId** | **Number** | The ID of the Campaign Template this Campaign was created from. | [optional] 
 **frontendState** | **String** | A campaign state described exactly as in the Campaign Manager. | 
+**storesImported** | **Boolean** | Indicates whether the linked stores were imported via a CSV file. | 
 
 
 
@@ -38,8 +39,6 @@ Name | Type | Description | Notes
 
 * `running` (value: `"running"`)
 
-* `draft` (value: `"draft"`)
-
 * `disabled` (value: `"disabled"`)
 
 * `archived` (value: `"archived"`)

diff --git a/docs/AnalyticsDataPoint.md b/docs/AnalyticsDataPoint.md
@@ -0,0 +1,10 @@
+# TalonOne.AnalyticsDataPoint
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**total** | **Number** |  | 
+**influenced** | **Number** |  | 
+
+
diff --git a/docs/AnalyticsDataPointWithTrend.md b/docs/AnalyticsDataPointWithTrend.md
@@ -0,0 +1,10 @@
+# TalonOne.AnalyticsDataPointWithTrend
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | **Number** |  | 
+**trend** | **Number** |  | 
+
+
diff --git a/docs/AnalyticsDataPointWithTrendAndInfluencedRate.md b/docs/AnalyticsDataPointWithTrendAndInfluencedRate.md
@@ -0,0 +1,11 @@
+# TalonOne.AnalyticsDataPointWithTrendAndInfluencedRate
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | **Number** |  | 
+**influencedRate** | **Number** |  | 
+**trend** | **Number** |  | 
+
+
diff --git a/docs/AnalyticsDataPointWithTrendAndUplift.md b/docs/AnalyticsDataPointWithTrendAndUplift.md
@@ -0,0 +1,11 @@
+# TalonOne.AnalyticsDataPointWithTrendAndUplift
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | **Number** |  | 
+**uplift** | **Number** |  | 
+**trend** | **Number** |  | 
+
+
diff --git a/docs/Application.md b/docs/Application.md
@@ -23,6 +23,8 @@ Name | Type | Description | Notes
 **enablePartialDiscounts** | **Boolean** | Indicates if this Application supports partial discounts. | [optional] 
 **defaultDiscountAdditionalCostPerItemScope** | **String** | The default scope to apply &#x60;setDiscountPerItem&#x60; effects on if no scope was provided with the effect.  | [optional] 
 **defaultEvaluationGroupId** | **Number** | 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** | **Number** | 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** | [**[LoyaltyProgram]**](LoyaltyProgram.md) | An array containing all the loyalty programs to which this application is subscribed. | 
 
 

diff --git a/docs/ApplicationAnalyticsDataPoint.md b/docs/ApplicationAnalyticsDataPoint.md
@@ -4,12 +4,12 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**startTime** | **Date** | The start of the aggregation time frame in UTC. | [optional] 
-**endTime** | **Date** | The end of the aggregation time frame in UTC. | [optional] 
-**totalRevenue** | [**ApplicationAnalyticsDataPointTotalRevenue**](ApplicationAnalyticsDataPointTotalRevenue.md) |  | [optional] 
-**sessionsCount** | [**ApplicationAnalyticsDataPointSessionsCount**](ApplicationAnalyticsDataPointSessionsCount.md) |  | [optional] 
-**avgItemsPerSession** | [**ApplicationAnalyticsDataPointAvgItemsPerSession**](ApplicationAnalyticsDataPointAvgItemsPerSession.md) |  | [optional] 
-**avgSessionValue** | [**ApplicationAnalyticsDataPointAvgSessionValue**](ApplicationAnalyticsDataPointAvgSessionValue.md) |  | [optional] 
+**startTime** | **Date** | The start of the aggregation time frame in UTC. | 
+**endTime** | **Date** | The end of the aggregation time frame in UTC. | 
+**totalRevenue** | [**AnalyticsDataPoint**](AnalyticsDataPoint.md) |  | [optional] 
+**sessionsCount** | [**AnalyticsDataPoint**](AnalyticsDataPoint.md) |  | [optional] 
+**avgItemsPerSession** | [**AnalyticsDataPoint**](AnalyticsDataPoint.md) |  | [optional] 
+**avgSessionValue** | [**AnalyticsDataPoint**](AnalyticsDataPoint.md) |  | [optional] 
 **totalDiscounts** | **Number** | The total value of discounts given for cart items in influenced sessions. | [optional] 
 **couponsCount** | **Number** | The number of times a coupon was successfully redeemed in influenced sessions. | [optional] 
 

diff --git a/docs/ApplicationAnalyticsDataPointAvgItemsPerSession.md b/docs/ApplicationAnalyticsDataPointAvgItemsPerSession.md
diff --git a/docs/ApplicationAnalyticsDataPointAvgSessionValue.md b/docs/ApplicationAnalyticsDataPointAvgSessionValue.md
diff --git a/docs/ApplicationAnalyticsDataPointSessionsCount.md b/docs/ApplicationAnalyticsDataPointSessionsCount.md
diff --git a/docs/ApplicationAnalyticsDataPointTotalRevenue.md b/docs/ApplicationAnalyticsDataPointTotalRevenue.md
diff --git a/docs/ApplicationCIF.md b/docs/ApplicationCIF.md
@@ -0,0 +1,17 @@
+# TalonOne.ApplicationCIF
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Number** | Internal ID of this entity. | 
+**created** | **Date** | 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** | **Number** | The ID of the expression that the Application cart item filter uses. | [optional] 
+**modifiedBy** | **Number** | The ID of the user who last updated the Application cart item filter. | [optional] 
+**createdBy** | **Number** | The ID of the user who created the Application cart item filter. | [optional] 
+**modified** | **Date** | Timestamp of the most recent update to the Application cart item filter. | [optional] 
+**applicationId** | **Number** | The ID of the application that owns this entity. | 
+
+
diff --git a/docs/ApplicationCIFExpression.md b/docs/ApplicationCIFExpression.md
@@ -0,0 +1,14 @@
+# TalonOne.ApplicationCIFExpression
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Number** | Internal ID of this entity. | 
+**created** | **Date** | The time this entity was created. | 
+**cartItemFilterId** | **Number** | The ID of the Application cart item filter. | [optional] 
+**createdBy** | **Number** | The ID of the user who created the Application cart item filter. | [optional] 
+**expression** | **[Object]** | Arbitrary additional JSON data associated with the Application cart item filter. | [optional] 
+**applicationId** | **Number** | The ID of the application that owns this entity. | 
+
+
diff --git a/docs/ApplicationCampaignAnalytics.md b/docs/ApplicationCampaignAnalytics.md
@@ -4,28 +4,29 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**startTime** | **Date** | The start of the aggregation time frame in UTC. | [optional] 
-**endTime** | **Date** | The end of the aggregation time frame in UTC. | [optional] 
-**campaignId** | **Number** | The ID of the campaign. | [optional] 
-**campaignName** | **String** | The name of the campaign. | [optional] 
-**campaignTags** | **[String]** | A list of tags for the campaign. | [optional] 
-**campaignState** | **String** | The state of the campaign.  **Note:** A disabled or archived campaign is not evaluated for rules or coupons.  | [optional] [default to &#39;enabled&#39;]
-**campaignActiveRulesetId** | **Number** | The [ID of the ruleset](https://docs.talon.one/management-api#operation/getRulesets) this campaign applies on customer session evaluation.  | [optional] 
-**campaignStartTime** | **Date** | Date and time when the campaign becomes active. | [optional] 
-**campaignEndTime** | **Date** | Date and time when the campaign becomes inactive. | [optional] 
-**totalRevenue** | [**ApplicationCampaignAnalyticsTotalRevenue**](ApplicationCampaignAnalyticsTotalRevenue.md) |  | [optional] 
-**sessionsCount** | [**ApplicationCampaignAnalyticsSessionsCount**](ApplicationCampaignAnalyticsSessionsCount.md) |  | [optional] 
-**avgItemsPerSession** | [**ApplicationCampaignAnalyticsAvgItemsPerSession**](ApplicationCampaignAnalyticsAvgItemsPerSession.md) |  | [optional] 
-**avgSessionValue** | [**ApplicationCampaignAnalyticsAvgSessionValue**](ApplicationCampaignAnalyticsAvgSessionValue.md) |  | [optional] 
-**totalDiscounts** | [**ApplicationCampaignAnalyticsTotalDiscounts**](ApplicationCampaignAnalyticsTotalDiscounts.md) |  | [optional] 
-**couponsCount** | [**ApplicationCampaignAnalyticsCouponsCount**](ApplicationCampaignAnalyticsCouponsCount.md) |  | [optional] 
+**startTime** | **Date** | The start of the aggregation time frame in UTC. | 
+**endTime** | **Date** | The end of the aggregation time frame in UTC. | 
+**campaignId** | **Number** | The ID of the campaign. | 
+**campaignName** | **String** | The name of the campaign. | 
+**campaignTags** | **[String]** | A list of tags for the campaign. | 
+**campaignState** | **String** | The state of the campaign.  **Note:** A disabled or archived campaign is not evaluated for rules or coupons.  | 
+**totalRevenue** | [**AnalyticsDataPointWithTrendAndInfluencedRate**](AnalyticsDataPointWithTrendAndInfluencedRate.md) |  | [optional] 
+**sessionsCount** | [**AnalyticsDataPointWithTrendAndInfluencedRate**](AnalyticsDataPointWithTrendAndInfluencedRate.md) |  | [optional] 
+**avgItemsPerSession** | [**AnalyticsDataPointWithTrendAndUplift**](AnalyticsDataPointWithTrendAndUplift.md) |  | [optional] 
+**avgSessionValue** | [**AnalyticsDataPointWithTrendAndUplift**](AnalyticsDataPointWithTrendAndUplift.md) |  | [optional] 
+**totalDiscounts** | [**AnalyticsDataPointWithTrend**](AnalyticsDataPointWithTrend.md) |  | [optional] 
+**couponsCount** | [**AnalyticsDataPointWithTrend**](AnalyticsDataPointWithTrend.md) |  | [optional] 
 
 
 
 ## Enum: CampaignStateEnum
 
 
-* `enabled` (value: `"enabled"`)
+* `expired` (value: `"expired"`)
+
+* `scheduled` (value: `"scheduled"`)
+
+* `running` (value: `"running"`)
 
 * `disabled` (value: `"disabled"`)
 

diff --git a/docs/ApplicationCampaignAnalyticsAvgItemsPerSession.md b/docs/ApplicationCampaignAnalyticsAvgItemsPerSession.md
diff --git a/docs/ApplicationCampaignAnalyticsAvgSessionValue.md b/docs/ApplicationCampaignAnalyticsAvgSessionValue.md
diff --git a/docs/ApplicationCampaignAnalyticsCouponsCount.md b/docs/ApplicationCampaignAnalyticsCouponsCount.md
diff --git a/docs/ApplicationCampaignAnalyticsSessionsCount.md b/docs/ApplicationCampaignAnalyticsSessionsCount.md
diff --git a/docs/ApplicationCampaignAnalyticsTotalDiscounts.md b/docs/ApplicationCampaignAnalyticsTotalDiscounts.md
diff --git a/docs/ApplicationCampaignAnalyticsTotalRevenue.md b/docs/ApplicationCampaignAnalyticsTotalRevenue.md
diff --git a/docs/ApplicationCampaignStats.md b/docs/ApplicationCampaignStats.md
@@ -4,7 +4,6 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**draft** | **Number** | Number of draft campaigns. | 
 **disabled** | **Number** | Number of disabled campaigns. | 
 **scheduled** | **Number** | Number of scheduled campaigns. | 
 **running** | **Number** | Number of running campaigns. | 

diff --git a/docs/AsyncCouponDeletionJobResponse.md b/docs/AsyncCouponDeletionJobResponse.md
@@ -0,0 +1,9 @@
+# TalonOne.AsyncCouponDeletionJobResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Number** | 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
@@ -27,8 +27,6 @@ Name | Type | Description | Notes
 ## Enum: EntityEnum
 
 
-* `Account` (value: `"Account"`)
-
 * `Application` (value: `"Application"`)
 
 * `Campaign` (value: `"Campaign"`)