v4.0.0: Collection Items, Catalog Sync Loyalty Transactions retrieval…

… & Guzzle's v7 adjustments (#15)

## v4.0.0

New features support:
 - [Partial Returns](https://docs.talon.one/docs/product/applications/displaying-customer-sessions#returning-individual-cart-items)
 - [Collection Items](https://docs.talon.one/docs/product/campaigns/managing-collections)
 - [Catalog Sync](https://docs.talon.one/docs/product/campaigns/managing-collections)
 - [Effects in getCustomerSession](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/getCustomerSession)
 - [Loyalty Transactions retrieval](https://docs.talon.one/integration-api#tag/Loyalty/operation/getLoyaltyTransactions)
 - and more...
 
### ⚠️ Upgrade Guzzle dependency to `^7`

Please note that starting version 4.0.0, we have updated the dependency of `guzzlehttp/guzzle` from `>= 5.3` --> `^7`, this is the reason we have also bumped a major version of the library itself.
The code is now adjusted to use now guzzle's new functions when building parameters similarly to the development versions [3.5.0](https://packagist.org/packages/talon-one/talon-one-client#v3.5.0.x-dev) and [3.6.0](https://packagist.org/packages/talon-one/talon-one-client#v3.6.0.x-dev).

If you have already update the dependency in your code to one of those versions, upgrading to v4.0.0 **should impose no more further changes**.

## Commit Summary

* Initial Commit
* Fix guzzlehttp dependency and references
* Fix minor mistakes in readme examples
* Fix async coupons name conflicts
* Make it v4.0.0.0

composer.json

@@ -1,30 +1,30 @@
 {
     "name": "talon-one/talon-one-client",
     "type": "library",
-    "version": "3.4.0",
-    "description": "The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns.",
+    "version": "4.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 are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}`",
     "keywords": [
         "talon-one",
         "openapi-generator",
         "sdk",
         "rest",
         "api"
     ],
-    "homepage": "https://developers.talon.one/SDKs/PHP",
+    "homepage": "https://docs.talon.one/docs/dev/sdks/php",
     "license": "MIT",
     "authors": [
         {
             "name": "Talon.One Developers",
             "email": "[email protected]",
-            "homepage": "https://developers.talon.one"
+            "homepage": "https://docs.talon.one"
         }
     ],
     "require": {
         "php": ">=7.1",
         "ext-curl": "*",
         "ext-json": "*",
         "ext-mbstring": "*",
-        "guzzlehttp/guzzle": ">= 5.3"
+        "guzzlehttp/guzzle": "^7"
     },
     "require-dev": {
         "phpunit/phpunit": "^7.4",

docs/Model/AcceptCouponEffectProps.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**value** | **string** | The coupon code that was accepted | 
+**value** | **string** | The coupon code that was accepted. | 
 
 [[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/AcceptReferralEffectProps.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**value** | **string** | The referral code that was accepted | 
+**value** | **string** | The referral code that was accepted. | 
 
 [[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/AccessLogEntry.md

@@ -4,9 +4,9 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**uuid** | **string** | UUID reference of request | 
-**status** | **int** | HTTP status code of response | 
-**method** | **string** | HTTP method of request | 
+**uuid** | **string** | UUID reference of request. | 
+**status** | **int** | HTTP status code of response. | 
+**method** | **string** | HTTP method of request. | 
 **requestUri** | **string** | target URI of request | 
 **time** | [**\DateTime**](\DateTime.md) | timestamp of request | 
 **requestPayload** | **string** | payload of request | 

docs/Model/Account.md

@@ -4,12 +4,12 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **int** | Unique ID for this entity. | 
+**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. | 
 **created** | [**\DateTime**](\DateTime.md) | The exact moment this entity was created. | 
 **modified** | [**\DateTime**](\DateTime.md) | The exact moment this entity was last modified. | 
 **companyName** | **string** |  | 
-**domainName** | **string** | Subdomain Name for yourcompany.talon.one | 
-**state** | **string** | State of the account (active, deactivated) | 
+**domainName** | **string** | Subdomain Name for yourcompany.talon.one. | 
+**state** | **string** | State of the account (active, deactivated). | 
 **billingEmail** | **string** | The billing email address associated with your company account. | 
 **planName** | **string** | The name of your booked plan. | [optional] 
 **planExpires** | [**\DateTime**](\DateTime.md) | The point in time at which your current plan expires. | [optional] 
@@ -21,7 +21,7 @@ Name | Type | Description | Notes
 **userCount** | **int** | The current number of Campaign Manager Users in your account. | 
 **campaignsActiveCount** | **int** | The current number of active Campaigns in your account. | 
 **campaignsInactiveCount** | **int** | The current number of inactive Campaigns in your account. | 
-**attributes** | [**object**](.md) | Arbitrary properties associated with this campaign | [optional] 
+**attributes** | [**object**](.md) | Arbitrary properties associated with this campaign. | [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/AccountAdditionalCost.md

@@ -4,13 +4,14 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **int** | Unique ID for this entity. | 
+**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. | 
 **created** | [**\DateTime**](\DateTime.md) | The exact moment this entity was created. | 
 **accountId** | **int** | The ID of the account that owns this entity. | 
 **name** | **string** | The additional cost name that will be used in API requests and Talang. E.g. if `name == \"shipping\"` then you would set the shipping additional cost by including an `additionalCosts.shipping` property in your request payload. | 
 **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** | **int[]** | A list of the IDs of the applications that are subscribed to this additional cost | [optional] 
+**subscribedApplicationsIds** | **int[]** | A list of the IDs of the applications that are subscribed to this additional cost. | [optional] 
+**type** | **string** | The type of additional cost. The following options can be chosen: - `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] [default to 'session']
 
 [[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/AccountAnalytics.md

@@ -4,24 +4,25 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**applications** | **int** | Total number of applications in the account | 
-**liveApplications** | **int** | Total number of live applications in the account | 
-**sandboxApplications** | **int** | Total number of sandbox applications in the account | 
-**campaigns** | **int** | Total number of campaigns in the account | 
-**activeCampaigns** | **int** | Total number of active campaigns in the account | 
-**liveActiveCampaigns** | **int** | Total number of active campaigns in live applications in the account | 
-**coupons** | **int** | Total number of coupons in the account | 
-**activeCoupons** | **int** | Total number of active coupons in the account | 
-**expiredCoupons** | **int** | Total number of expired coupons in the account | 
-**referralCodes** | **int** | Total number of referral codes in the account | 
-**activeReferralCodes** | **int** | Total number of active referral codes in the account | 
-**expiredReferralCodes** | **int** | Total number of expired referral codes in the account | 
-**activeRules** | **int** | Total number of active rules in the account | 
-**users** | **int** | Total number of users in the account | 
-**roles** | **int** | Total number of roles in the account | 
-**customAttributes** | **int** | Total number of custom attributes in the account | 
-**webhooks** | **int** | Total number of webhooks in the account | 
-**loyaltyPrograms** | **int** | Total number of loyalty programs in the account | 
+**applications** | **int** | Total number of applications in the account. | 
+**liveApplications** | **int** | Total number of live applications in the account. | 
+**sandboxApplications** | **int** | Total number of sandbox applications in the account. | 
+**campaigns** | **int** | Total number of campaigns in the account. | 
+**activeCampaigns** | **int** | Total number of active campaigns in the account. | 
+**liveActiveCampaigns** | **int** | Total number of active campaigns in live applications in the account. | 
+**coupons** | **int** | Total number of coupons in the account. | 
+**activeCoupons** | **int** | Total number of active coupons in the account. | 
+**expiredCoupons** | **int** | Total number of expired coupons in the account. | 
+**referralCodes** | **int** | Total number of referral codes in the account. | 
+**activeReferralCodes** | **int** | Total number of active referral codes in the account. | 
+**expiredReferralCodes** | **int** | Total number of expired referral codes in the account. | 
+**activeRules** | **int** | Total number of active rules in the account. | 
+**users** | **int** | Total number of users in the account. | 
+**roles** | **int** | Total number of roles in the account. | 
+**customAttributes** | **int** | Total number of custom attributes in the account. | 
+**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. | 
 
 [[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/AccountLimits.md

@@ -4,18 +4,18 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**liveApplications** | **int** | Total number of allowed live applications in the account | 
-**sandboxApplications** | **int** | Total number of allowed sandbox applications in the account | 
-**activeCampaigns** | **int** | Total number of allowed active campaigns in live applications in the account | 
-**coupons** | **int** | Total number of allowed coupons in the account | 
-**referralCodes** | **int** | Total number of allowed referral codes in the account | 
-**activeRules** | **int** | Total number of allowed active rulesets in the account | 
-**liveLoyaltyPrograms** | **int** | Total number of allowed live loyalty programs in the account | 
-**sandboxLoyaltyPrograms** | **int** | Total number of allowed sandbox loyalty programs in the account | 
-**webhooks** | **int** | Total number of allowed webhooks in the account | 
-**users** | **int** | Total number of allowed users in the account | 
-**apiVolume** | **int** | Allowed volume of API requests to the account | 
-**promotionTypes** | **string[]** | Array of promotion types that are employed in the account | 
+**liveApplications** | **int** | Total number of allowed live applications in the account. | 
+**sandboxApplications** | **int** | Total number of allowed sandbox applications in the account. | 
+**activeCampaigns** | **int** | Total number of allowed active campaigns in live applications in the account. | 
+**coupons** | **int** | Total number of allowed coupons in the account. | 
+**referralCodes** | **int** | Total number of allowed referral codes in the account. | 
+**activeRules** | **int** | Total number of allowed active rulesets in the account. | 
+**liveLoyaltyPrograms** | **int** | Total number of allowed live loyalty programs in the account. | 
+**sandboxLoyaltyPrograms** | **int** | Total number of allowed sandbox loyalty programs in the account. | 
+**webhooks** | **int** | Total number of allowed webhooks in the account. | 
+**users** | **int** | Total number of allowed users in the account. | 
+**apiVolume** | **int** | Allowed volume of API requests to the account. | 
+**promotionTypes** | **string[]** | Array of promotion types that are employed in the account. | 
 
 [[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/AddFreeItemEffectProps.md

@@ -4,8 +4,8 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**sku** | **string** | SKU of the item that needs to be added | 
-**name** | **string** | The name/description of the effect | 
+**sku** | **string** | SKU of the item that needs to be added. | 
+**name** | **string** | The name/description of the effect. | 
 
 [[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

@@ -0,0 +1,14 @@
+# # AddItemCatalogAction
+
+## Properties
+
+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]
+
+[[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/AddLoyaltyPointsEffectProps.md

@@ -4,14 +4,18 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**name** | **string** | The name/description of this loyalty point addition | 
-**programId** | **int** | 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** | **float** | The amount of points that were added | 
-**recipientIntegrationId** | **string** | The user for whom these points were added | 
-**startDate** | [**\DateTime**](\DateTime.md) | Date after which points will be valid | [optional] 
-**expiryDate** | [**\DateTime**](\DateTime.md) | Date after which points will expire | [optional] 
-**transactionUUID** | **string** | The identifier of this addition in the loyalty ledger | 
+**name** | **string** | The reason of the point addition. | 
+**programId** | **int** | 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** | **float** | The amount of points that were added. | 
+**desiredValue** | **float** | The original amount of loyalty points to be awarded. | [optional] 
+**recipientIntegrationId** | **string** | The user for whom these points were added. | 
+**startDate** | [**\DateTime**](\DateTime.md) | Date after which points will be valid. | [optional] 
+**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] 
+**cardIdentifier** | **string** | The card on which these points were added. | [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)