Merge pull request #22 from talon-one/sc-37693-update-php-sdk

v7.0.0

composer.json

@@ -1,7 +1,7 @@
 {
     "name": "talon-one/talon-one-client",
     "type": "library",
-    "version": "6.0.0",
+    "version": "7.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/AccountDashboardStatistic.md

@@ -8,7 +8,6 @@ Name | Type | Description | Notes
 **discounts** | [**\TalonOne\Client\Model\AccountDashboardStatisticDiscount[]**](AccountDashboardStatisticDiscount.md) | Aggregated statistic for account discount. | [optional] 
 **loyaltyPoints** | [**\TalonOne\Client\Model\AccountDashboardStatisticLoyaltyPoints[]**](AccountDashboardStatisticLoyaltyPoints.md) | Aggregated statistic for account loyalty points. | [optional] 
 **referrals** | [**\TalonOne\Client\Model\AccountDashboardStatisticReferrals[]**](AccountDashboardStatisticReferrals.md) | Aggregated statistic for account referrals. | [optional] 
-**apiCalls** | [**\TalonOne\Client\Model\AccountDashboardStatisticApiCalls[]**](AccountDashboardStatisticApiCalls.md) | Aggregated statistic for the number of account API calls. | [optional] 
 **campaigns** | [**\TalonOne\Client\Model\AccountDashboardStatisticCampaigns**](AccountDashboardStatisticCampaigns.md) |  | 
 
 [[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/Achievement.md

@@ -0,0 +1,22 @@
+# # Achievement
+
+## 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 internal name of the achievement used in API requests.  **Note**: The name should start with a letter. This cannot be changed after the achievement has been created. | 
+**title** | **string** | The display name for the achievement in the Campaign Manager. | 
+**description** | **string** | A description of the achievement. | 
+**target** | **float** | The required number of actions or the transactional milestone to complete the achievement. | 
+**period** | **string** | The relative duration after which the achievement ends and resets for a particular customer profile.  **Note**: The `period` does not start when the achievement is created.  The period is a **positive real number** followed by one letter indicating the time unit.  Examples: `30s`, `40m`, `1h`, `5D`, `7W`, `10M`, `15Y`.  Available units:  - `s`: seconds - `m`: minutes - `h`: hours - `D`: days - `W`: weeks - `M`: months - `Y`: years  You can also round certain units down to the beginning of period and up to the end of period.: - `_D` for rounding down days only. Signifies the start of the day. Example: `30D_D` - `_U` for rounding up days, weeks, months and years. Signifies the end of the day, week, month or year. Example: `23W_U`  **Note**: You can either use the round down and round up option or set an absolute period. | 
+**periodEndOverride** | [**\TalonOne\Client\Model\TimePoint**](TimePoint.md) |  | [optional] 
+**campaignId** | **int** | ID of the campaign, to which the achievement belongs to | 
+**userId** | **int** | ID of the user that created this achievement. | 
+**createdBy** | **string** | Name of the user that created the achievement.  **Note**: This is not available if the user has been deleted. | 
+**hasProgress** | **bool** | Indicates if a customer has made progress in the achievement. | [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/AchievementAdditionalProperties.md

@@ -0,0 +1,14 @@
+# # AchievementAdditionalProperties
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**campaignId** | **int** | ID of the campaign, to which the achievement belongs to | 
+**userId** | **int** | ID of the user that created this achievement. | 
+**createdBy** | **string** | Name of the user that created the achievement.  **Note**: This is not available if the user has been deleted. | 
+**hasProgress** | **bool** | Indicates if a customer has made progress in the achievement. | [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/AchievementProgress.md

@@ -0,0 +1,20 @@
+# # AchievementProgress
+
+## Properties
+
+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. | 
+**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] 
+**progress** | **float** | The current progress of the customer in the achievement. | 
+**startDate** | [**\DateTime**](\DateTime.md) | Timestamp at which the customer started the achievement. | 
+**completionDate** | [**\DateTime**](\DateTime.md) | Timestamp at which point the customer completed the achievement. | [optional] 
+**endDate** | [**\DateTime**](\DateTime.md) | Timestamp at which point the achievement ends and resets for the customer. | 
+
+[[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/AddItemCatalogAction.md

@@ -7,7 +7,8 @@ Name | Type | Description | Notes
 **sku** | **string** | The unique SKU of the item to add. | 
 **price** | **float** | Price of the item. | [optional] 
 **attributes** | [**object**](.md) | The attributes of the item to add. | [optional] 
-**replaceIfExists** | **bool** | Indicates whether to replace the attributes of the item if the same SKU exists. | [optional] [default to false]
+**product** | [**\TalonOne\Client\Model\Product**](Product.md) |  | [optional] 
+**replaceIfExists** | **bool** | Indicates whether to replace the attributes of the item if the same SKU exists.  **Note**: When set to `true`:   - If you do not provide a new `price` value, the existing `price` value is retained.   - If you do not provide a new `product` value, the `product` value is set to `null`. | [optional] [default to false]
 
 [[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/AdditionalCampaignProperties.md

@@ -25,6 +25,7 @@ Name | Type | Description | Notes
 **createdBy** | **string** | Name of the user who created this campaign if available. | [optional] 
 **updatedBy** | **string** | Name of the user who last updated this campaign if available. | [optional] 
 **templateId** | **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. | 
 
 [[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/ApplicationAPIKey.md

@@ -4,9 +4,11 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**title** | **string** | Title for API Key. | 
-**expires** | [**\DateTime**](\DateTime.md) | The date the API key expired. | 
+**title** | **string** | Title of the API key. | 
+**expires** | [**\DateTime**](\DateTime.md) | The date the API key expires. | 
 **platform** | **string** | 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** | **string** | 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** | **int** | 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** | **int** | ID of the API Key. | 
 **createdBy** | **int** | ID of user who created. | 
 **accountID** | **int** | ID of account the key is used for. | 

docs/Model/ApplicationAnalyticsDataPoint.md

@@ -0,0 +1,18 @@
+# # ApplicationAnalyticsDataPoint
+
+## Properties
+
+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] 
+**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] 
+
+[[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

@@ -0,0 +1,12 @@
+# # ApplicationAnalyticsDataPointAvgItemsPerSession
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**total** | **float** |  | [optional] 
+**influenced** | **float** |  | [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/ApplicationAnalyticsDataPointAvgSessionValue.md

@@ -0,0 +1,12 @@
+# # ApplicationAnalyticsDataPointAvgSessionValue
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**total** | **float** |  | [optional] 
+**influenced** | **float** |  | [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/ApplicationAnalyticsDataPointSessionsCount.md

@@ -0,0 +1,12 @@
+# # ApplicationAnalyticsDataPointSessionsCount
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**total** | **float** |  | [optional] 
+**influenced** | **float** |  | [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/ApplicationAnalyticsDataPointTotalRevenue.md

@@ -0,0 +1,12 @@
+# # ApplicationAnalyticsDataPointTotalRevenue
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**total** | **float** |  | [optional] 
+**influenced** | **float** |  | [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/ApplicationCampaignAnalytics.md

@@ -0,0 +1,25 @@
+# # ApplicationCampaignAnalytics
+
+## Properties
+
+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] 
+
+[[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/ApplicationCampaignAnalyticsAvgItemsPerSession.md

@@ -0,0 +1,13 @@
+# # ApplicationCampaignAnalyticsAvgItemsPerSession
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | **float** |  | [optional] 
+**uplift** | **float** |  | [optional] 
+**trend** | **float** |  | [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/ApplicationCampaignAnalyticsAvgSessionValue.md

@@ -0,0 +1,13 @@
+# # ApplicationCampaignAnalyticsAvgSessionValue
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | **float** |  | [optional] 
+**uplift** | **float** |  | [optional] 
+**trend** | **float** |  | [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/ApplicationCampaignAnalyticsCouponsCount.md

@@ -0,0 +1,12 @@
+# # ApplicationCampaignAnalyticsCouponsCount
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | **float** |  | [optional] 
+**trend** | **float** |  | [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/ApplicationCampaignAnalyticsSessionsCount.md

@@ -0,0 +1,13 @@
+# # ApplicationCampaignAnalyticsSessionsCount
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | **float** |  | [optional] 
+**influenceRate** | **float** |  | [optional] 
+**trend** | **float** |  | [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/ApplicationCampaignAnalyticsTotalDiscounts.md

@@ -0,0 +1,12 @@
+# # ApplicationCampaignAnalyticsTotalDiscounts
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | **float** |  | [optional] 
+**trend** | **float** |  | [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/ApplicationCampaignAnalyticsTotalRevenue.md

@@ -0,0 +1,13 @@
+# # ApplicationCampaignAnalyticsTotalRevenue
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | **float** |  | [optional] 
+**influenceRate** | **float** |  | [optional] 
+**trend** | **float** |  | [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/ApplicationCustomer.md

@@ -14,7 +14,7 @@ Name | Type | Description | Notes
 **loyaltyMemberships** | [**\TalonOne\Client\Model\LoyaltyMembership[]**](LoyaltyMembership.md) | **DEPRECATED** A list of loyalty programs joined by the customer. | [optional] 
 **audienceMemberships** | [**\TalonOne\Client\Model\AudienceMembership[]**](AudienceMembership.md) | The audiences the customer belongs to. | [optional] 
 **lastActivity** | [**\DateTime**](\DateTime.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** | **bool** | Shows whether the customer is part of a sandbox or live Application. See the [docs](https://docs.talon.one/docs/product/applications/overview#application-environments). | [optional] 
+**sandbox** | **bool** | An indicator of whether the customer is part of a sandbox or live Application. See the [docs](https://docs.talon.one/docs/product/applications/overview#application-environments). | [optional] 
 **advocateIntegrationId** | **string** | The Integration ID of the Customer Profile that referred this Customer in the Application. | [optional] 
 
 [[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/AudienceAnalytics.md

@@ -5,7 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **audienceId** | **int** | The ID of the audience. | [optional] 
-**membersCount** | **int** | The count of members under a single audience. | [optional] 
+**membersCount** | **int** | The member count of the audience. | [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)