Merge pull request #26 from talon-one/sc-42164-update-php-sdk

9.0.0

composer.json

@@ -1,7 +1,7 @@
 {
     "name": "talon-one/talon-one-client",
     "type": "library",
-    "version": "8.0.0",
+    "version": "9.0.0",
     "description": "Use the Talon.One API to integrate with your application and to manage applications and campaigns:  - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns.  ## Determining the base URL of the endpoints  The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`",
     "keywords": [
         "talon-one",

docs/Model/AchievementProgress.md

@@ -7,6 +7,7 @@ Name | Type | Description | Notes
 **achievementId** | **int** | 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** | **int** | The ID of the campaign the achievement belongs to. | 
 **status** | **string** | The status of the achievement. | 
 **target** | **float** | The required number of actions or the transactional milestone to complete the achievement. | [optional] 

docs/Model/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** | **int** | 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** | **bool** | Indicates whether the linked stores were imported via a CSV file. | 
 
 [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
 

docs/Model/CampaignSetIDs.md → docs/Model/AnalyticsDataPoint.md

@@ -1,10 +1,11 @@
-# # CampaignSetIDs
+# # AnalyticsDataPoint
 
 ## Properties
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**campaignId** | **int** | ID of the campaign | [optional] 
+**total** | **float** |  | 
+**influenced** | **float** |  | 
 
 [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
 

docs/Model/ApplicationCampaignAnalyticsCouponsCount.md → docs/Model/AnalyticsDataPointWithTrend.md

@@ -1,11 +1,11 @@
-# # ApplicationCampaignAnalyticsCouponsCount
+# # AnalyticsDataPointWithTrend
 
 ## Properties
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**value** | **float** |  | [optional] 
-**trend** | **float** |  | [optional] 
+**value** | **float** |  | 
+**trend** | **float** |  | 
 
 [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
 

docs/Model/ApplicationAnalyticsDataPointAvgItemsPerSession.md → docs/Model/AnalyticsDataPointWithTrendAndInfluencedRate.md

@@ -1,11 +1,12 @@
-# # ApplicationAnalyticsDataPointAvgItemsPerSession
+# # AnalyticsDataPointWithTrendAndInfluencedRate
 
 ## Properties
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**total** | **float** |  | [optional] 
-**influenced** | **float** |  | [optional] 
+**value** | **float** |  | 
+**influencedRate** | **float** |  | 
+**trend** | **float** |  | 
 
 [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
 

docs/Model/AnalyticsDataPointWithTrendAndUplift.md

@@ -0,0 +1,13 @@
+# # AnalyticsDataPointWithTrendAndUplift
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | **float** |  | 
+**uplift** | **float** |  | 
+**trend** | **float** |  | 
+
+[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
+
+

docs/Model/Application.md

@@ -23,6 +23,8 @@ Name | Type | Description | Notes
 **enablePartialDiscounts** | **bool** | Indicates if this Application supports partial discounts. | [optional] 
 **defaultDiscountAdditionalCostPerItemScope** | **string** | The default scope to apply `setDiscountPerItem` effects on if no scope was provided with the effect. | [optional] 
 **defaultEvaluationGroupId** | **int** | 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** | **int** | The ID of the default Cart-Item-Filter for this application. | [optional] 
+**enableCampaignStateManagement** | **bool** | 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** | [**\TalonOne\Client\Model\LoyaltyProgram[]**](LoyaltyProgram.md) | An array containing all the loyalty programs to which this application is subscribed. | 
 
 [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)

docs/Model/ApplicationAnalyticsDataPoint.md

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

docs/Model/ApplicationCIF.md

@@ -0,0 +1,19 @@
+# # ApplicationCIF
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **int** | Internal ID of this entity. | 
+**created** | [**\DateTime**](\DateTime.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** | **int** | The ID of the expression that the Application cart item filter uses. | [optional] 
+**modifiedBy** | **int** | The ID of the user who last updated the Application cart item filter. | [optional] 
+**createdBy** | **int** | The ID of the user who created the Application cart item filter. | [optional] 
+**modified** | [**\DateTime**](\DateTime.md) | Timestamp of the most recent update to the Application cart item filter. | [optional] 
+**applicationId** | **int** | The ID of the application that owns this entity. | 
+
+[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
+
+

docs/Model/NotificationWebhook.md → docs/Model/ApplicationCIFExpression.md

@@ -1,15 +1,15 @@
-# # NotificationWebhook
+# # ApplicationCIFExpression
 
 ## Properties
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **id** | **int** | Internal ID of this entity. | 
 **created** | [**\DateTime**](\DateTime.md) | The time this entity was created. | 
-**modified** | [**\DateTime**](\DateTime.md) | The time this entity was last modified. | 
+**cartItemFilterId** | **int** | The ID of the Application cart item filter. | [optional] 
+**createdBy** | **int** | 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** | **int** | The ID of the application that owns this entity. | 
-**url** | **string** | API URL for the given webhook-based notification. | 
-**headers** | **string[]** | List of API HTTP headers for the given webhook-based notification. | 
 
 [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
 

docs/Model/ApplicationCampaignAnalytics.md

@@ -4,21 +4,18 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**startTime** | [**\DateTime**](\DateTime.md) | The start of the aggregation time frame in UTC. | [optional] 
-**endTime** | [**\DateTime**](\DateTime.md) | The end of the aggregation time frame in UTC. | [optional] 
-**campaignId** | **int** | 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 'enabled']
-**campaignActiveRulesetId** | **int** | The [ID of the ruleset](https://docs.talon.one/management-api#operation/getRulesets) this campaign applies on customer session evaluation. | [optional] 
-**campaignStartTime** | [**\DateTime**](\DateTime.md) | Date and time when the campaign becomes active. | [optional] 
-**campaignEndTime** | [**\DateTime**](\DateTime.md) | Date and time when the campaign becomes inactive. | [optional] 
-**totalRevenue** | [**\TalonOne\Client\Model\ApplicationCampaignAnalyticsTotalRevenue**](ApplicationCampaignAnalyticsTotalRevenue.md) |  | [optional] 
-**sessionsCount** | [**\TalonOne\Client\Model\ApplicationCampaignAnalyticsSessionsCount**](ApplicationCampaignAnalyticsSessionsCount.md) |  | [optional] 
-**avgItemsPerSession** | [**\TalonOne\Client\Model\ApplicationCampaignAnalyticsAvgItemsPerSession**](ApplicationCampaignAnalyticsAvgItemsPerSession.md) |  | [optional] 
-**avgSessionValue** | [**\TalonOne\Client\Model\ApplicationCampaignAnalyticsAvgSessionValue**](ApplicationCampaignAnalyticsAvgSessionValue.md) |  | [optional] 
-**totalDiscounts** | [**\TalonOne\Client\Model\ApplicationCampaignAnalyticsTotalDiscounts**](ApplicationCampaignAnalyticsTotalDiscounts.md) |  | [optional] 
-**couponsCount** | [**\TalonOne\Client\Model\ApplicationCampaignAnalyticsCouponsCount**](ApplicationCampaignAnalyticsCouponsCount.md) |  | [optional] 
+**startTime** | [**\DateTime**](\DateTime.md) | The start of the aggregation time frame in UTC. | 
+**endTime** | [**\DateTime**](\DateTime.md) | The end of the aggregation time frame in UTC. | 
+**campaignId** | **int** | 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** | [**\TalonOne\Client\Model\AnalyticsDataPointWithTrendAndInfluencedRate**](AnalyticsDataPointWithTrendAndInfluencedRate.md) |  | [optional] 
+**sessionsCount** | [**\TalonOne\Client\Model\AnalyticsDataPointWithTrendAndInfluencedRate**](AnalyticsDataPointWithTrendAndInfluencedRate.md) |  | [optional] 
+**avgItemsPerSession** | [**\TalonOne\Client\Model\AnalyticsDataPointWithTrendAndUplift**](AnalyticsDataPointWithTrendAndUplift.md) |  | [optional] 
+**avgSessionValue** | [**\TalonOne\Client\Model\AnalyticsDataPointWithTrendAndUplift**](AnalyticsDataPointWithTrendAndUplift.md) |  | [optional] 
+**totalDiscounts** | [**\TalonOne\Client\Model\AnalyticsDataPointWithTrend**](AnalyticsDataPointWithTrend.md) |  | [optional] 
+**couponsCount** | [**\TalonOne\Client\Model\AnalyticsDataPointWithTrend**](AnalyticsDataPointWithTrend.md) |  | [optional] 
 
 [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
 

docs/Model/ApplicationCampaignStats.md

@@ -4,7 +4,6 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**draft** | **int** | Number of draft campaigns. | 
 **disabled** | **int** | Number of disabled campaigns. | 
 **scheduled** | **int** | Number of scheduled campaigns. | 
 **running** | **int** | Number of running campaigns. | 

docs/Model/AccountDashboardStatisticApiCalls.md → docs/Model/AsyncCouponDeletionJobResponse.md

@@ -1,11 +1,10 @@
-# # AccountDashboardStatisticApiCalls
+# # AsyncCouponDeletionJobResponse
 
 ## Properties
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**total** | **float** | Total number of API calls received. | 
-**datetime** | [**\DateTime**](\DateTime.md) | Values aggregated for the specified date. | 
+**id** | **int** | 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. | 
 
 [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)