Merge pull request #49 from BitBagCommerce/feature/manual

Update documentation with User.com API usage, cookie domain handling,…

Author: tomkalon

doc/adjustments.md

@@ -10,6 +10,11 @@ There is designated validator to check if request payload contains required fiel
 If there will be any field added by User.com, you can adjust this validator to check if this field is present in request payload.
 Also, in `BitBag\SyliusUserComPlugin\Assigner\AgreementsAssigner` you can adjust existing logic to assign agreements to customer in a way that suits your needs.
 
+The endpoint is exposed in `Swagger` under `UserComAgreements`, making it easy to test and explore directly from the API documentation.
+
+>If you use several channels, remember to select one of the available channels using the get method and parameters before using the API:
+`?_channel_code=CHANNEL_CODE`
+
 ```php
 public function assign(CustomerInterface $customer, array $agreements): void
     {

doc/functionalities.md

@@ -31,3 +31,8 @@ The **BitBagSyliusUserComPlugin** integrates **User.com** with Sylius-based stor
 
 ### 7. User information object 
 - you can use `user_com_customer_info` in browser console to check currently logged in customer data
+
+### 8. Webhook Endpoint: Updating User Marketing Consents
+- Exposes a dedicated endpoint for handling User.com webhooks (`UserComAgreements` in `Swagger`),
+allowing the update of user marketing consents. By default, it manages the `subscribedToNewsletter` flag,
+but the mechanism is fully extensible to support additional types of consents.”

doc/installation.md

@@ -8,8 +8,13 @@
         USER_COM_FRONTEND_API_KEY=""
         USER_COM_ENCRYPTION_KEY=your-32-character-long-key
         USER_COM_ENCRYPTION_IV=your-16-character-long-iv
+        USER_COM_COOKIE_DOMAIN=""
         MESSENGER_USER_COM_ASYNCHRONOUS_DSN=""
     ```
+   - You can find the `USER_COM_FRONTEND_API_KEY` in the User.Com integration guide for `Google Tag Manager (Settings->Setup & Integrations)`. 
+   - `USER_COM_COOKIE_DOMAIN` is optional, if not set, cookies will be set for the current domain.
+
+
 3. Add plugin dependencies to `config/bundles.php` file. Make sure that none of the bundles are duplicated.
     ```php
     return [