Merge pull request #20 from talon-one/sc-30044-add-getloyaltyprogramp…

…rofilepoints-endpoint

chore: update php sdk

composer.json

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

@@ -23,6 +23,7 @@ Name | Type | Description | Notes
 **webhooks** | **int** | Total number of webhooks in the account. | 
 **loyaltyPrograms** | **int** | Total number of all loyalty programs in the account. | 
 **liveLoyaltyPrograms** | **int** | Total number of live loyalty programs in the account. | 
+**lastUpdatedAt** | [**\DateTime**](\DateTime.md) | The point in time when the analytics numbers were updated last. | 
 
 [[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/AccountDashboardStatisticCampaigns.md

@@ -5,7 +5,8 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **live** | **int** | Number of campaigns that are active and live (across all Applications). | 
-**endingSoon** | **int** | Campaigns with a schedule ending in 7 days or with only 10% of budget left. | 
+**endingSoon** | **int** | Campaigns scheduled to expire sometime in the next 7 days. | 
+**lowOnBudget** | **int** | Campaigns with less than 10% of budget left. | 
 
 [[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/AddLoyaltyPoints.md

@@ -6,9 +6,9 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **points** | **float** | Amount of loyalty points. | 
 **name** | **string** | Name / reason for the point addition. | [optional] 
-**validityDuration** | **string** | 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`.  Available units:  - `s`: seconds - `m`: minutes - `h`: hours - `D`: days - `W`: weeks - `M`: months  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 and months. Signifies the end of the day, week, or month.  If passed, `validUntil` should be omitted. | [optional] 
+**validityDuration** | **string** | 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.  If passed, `validUntil` should be omitted. | [optional] 
 **validUntil** | [**\DateTime**](\DateTime.md) | Date and time when points should expire. The value should be provided in RFC 3339 format. If passed, `validityDuration` should be omitted. | [optional] 
-**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`.  Available units:  - `s`: seconds - `m`: minutes - `h`: hours - `D`: days - `W`: weeks - `M`: months  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 and months. Signifies the end of the day, week, or month. | [optional] 
+**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** | [**\DateTime**](\DateTime.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** | **int** | ID of the Application that is connected to the loyalty program. It is displayed in your Talon.One deployment URL. | [optional] 

docs/Model/AddLoyaltyPointsEffectProps.md

@@ -14,7 +14,7 @@ Name | Type | Description | Notes
 **expiryDate** | [**\DateTime**](\DateTime.md) | Date after which points will expire. | [optional] 
 **transactionUUID** | **string** | The identifier of this addition in the loyalty ledger. | 
 **cartItemPosition** | **float** | The index of the item in the cart items list on which the loyal points addition should be applied. | [optional] 
-**cartItemSubPosition** | **float** | The sub position is triggered when application flattening is enabled. It indicates to which item the loyalty points addition applies, for cart items with `quantity` > 1. | [optional] 
+**cartItemSubPosition** | **float** | 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** | **int** | 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] 

docs/Model/AddToAudienceEffectProps.md

@@ -0,0 +1,14 @@
+# # AddToAudienceEffectProps
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**audienceId** | **int** | 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** | **int** | The internal ID of the customer profile. | [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/AdditionalCampaignProperties.md

@@ -0,0 +1,31 @@
+# # AdditionalCampaignProperties
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**budgets** | [**\TalonOne\Client\Model\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. | 
+**couponRedemptionCount** | **int** | This property is **deprecated**. The count should be available under *budgets* property. Number of coupons redeemed in the campaign. | [optional] 
+**referralRedemptionCount** | **int** | This property is **deprecated**. The count should be available under *budgets* property. Number of referral codes redeemed in the campaign. | [optional] 
+**discountCount** | **float** | This property is **deprecated**. The count should be available under *budgets* property. Total amount of discounts redeemed in the campaign. | [optional] 
+**discountEffectCount** | **int** | This property is **deprecated**. The count should be available under *budgets* property. Total number of times discounts were redeemed in this campaign. | [optional] 
+**couponCreationCount** | **int** | This property is **deprecated**. The count should be available under *budgets* property. Total number of coupons created by rules in this campaign. | [optional] 
+**customEffectCount** | **int** | 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** | **int** | This property is **deprecated**. The count should be available under *budgets* property. Total number of referrals created by rules in this campaign. | [optional] 
+**addFreeItemEffectCount** | **int** | 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** | **int** | This property is **deprecated**. The count should be available under *budgets* property. Total number of giveaways awarded by rules in this campaign. | [optional] 
+**createdLoyaltyPointsCount** | **float** | 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** | **int** | 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** | **float** | 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** | **int** | 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** | **int** | This property is **deprecated**. The count should be available under *budgets* property. Total number of webhooks triggered by rules in this campaign. | [optional] 
+**reservecouponEffectCount** | **int** | 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** | [**\DateTime**](\DateTime.md) | Timestamp of the most recent event received by this campaign. | [optional] 
+**updated** | [**\DateTime**](\DateTime.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** | **int** | The ID of the Campaign Template this Campaign was created from. | [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/Application.md

@@ -15,15 +15,14 @@ Name | Type | Description | Notes
 **caseSensitivity** | **string** | The case sensitivity behavior to check coupon codes in the campaigns of this Application. | [optional] 
 **attributes** | [**object**](.md) | Arbitrary properties associated with this campaign. | [optional] 
 **limits** | [**\TalonOne\Client\Model\LimitConfig[]**](LimitConfig.md) | Default limits for campaigns created in this application. | [optional] 
-**campaignPriority** | **string** | Default [priority](https://docs.talon.one/docs/product/applications/setting-up-campaign-priorities) for campaigns created in this Application. | [optional] [default to 'universal']
-**exclusiveCampaignsStrategy** | **string** | The strategy used when choosing exclusive campaigns for evaluation. | [optional] [default to 'listOrder']
 **defaultDiscountScope** | **string** | The default scope to apply `setDiscount` effects on if no scope was provided with the effect. | [optional] 
 **enableCascadingDiscounts** | **bool** | Indicates if discounts should cascade for this Application. | [optional] 
-**enableFlattenedCartItems** | **bool** | Indicates if cart items of quantity larger than one should be separated into different items of quantity one. See the [docs](https://docs.talon.one/docs/product/campaigns/campaign-evaluation#flattening). | [optional] 
+**enableFlattenedCartItems** | **bool** | Indicates if cart items of quantity larger than one should be separated into different items of quantity one. | [optional] 
 **attributesSettings** | [**\TalonOne\Client\Model\AttributesSettings**](AttributesSettings.md) |  | [optional] 
 **sandbox** | **bool** | Indicates if this is a live or sandbox Application. | [optional] 
 **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] 
 **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/ApplicationCustomer.md

@@ -13,7 +13,7 @@ Name | Type | Description | Notes
 **totalSales** | **float** | 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** | [**\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. | 
+**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] 
 **advocateIntegrationId** | **string** | The Integration ID of the Customer Profile that referred this Customer in the Application. | [optional] 
 

docs/Model/ApplicationEvent.md

@@ -8,6 +8,8 @@ Name | Type | Description | Notes
 **created** | [**\DateTime**](\DateTime.md) | The time this entity was created. | 
 **applicationId** | **int** | The ID of the application that owns this entity. | 
 **profileId** | **int** | The globally unique Talon.One ID of the customer that created this entity. | [optional] 
+**storeId** | **int** | 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** | **int** | 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. | 

docs/Model/ApplicationNotification.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**event** | **string** | Event type. It can be one of the following: ['campaign_priorities_changed'] | 
+**event** | **string** | Event type. It can be one of the following: ['campaign_evaluation_tree_changed'] | 
 
 [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)