CC-32421 Add integration guides for Merchant B2B Contracts and Merchant B2B Contract Requests features

_includes/pbc/all/install-features/202404.0/install-the-comments-merchant-b2b-contract-requests-feature.md

@@ -0,0 +1,127 @@
+This document describes how to install the Comments + Merchant B2B Contract Requests feature.
+
+## Install feature core
+
+Follow the steps below to install the Comments + Merchant B2B Contract Requests feature core.
+
+## Prerequisites
+
+Install the required features:
+
+| NAME                           | VERSION          | INSTALLATION GUIDE                                                                                                                                                                             |
+|--------------------------------|------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| Comments                       | {{page.version}} | [Install the Comments feature](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-comments-feature.html)                              |
+| Merchant B2B Contract Requests | {{page.version}} | [Install the Merchant B2B Contract Requests feature](/docs/pbc/all/merchant-management/{{page.version}}/base-shop/install-and-upgrade/install-the-merchant-b2b-contract-requests-feature.html) |
+
+### 1) Install the required modules
+
+Install the required modules using Composer:
+
+```bash
+composer require spryker/comment-merchant-relation-request-connector: "^1.0.0" --update-with-dependencies
+```
+
+{% info_block warningBox "Verification" %}
+
+Make sure the following modules have been installed:
+
+| MODULE                                  | EXPECTED DIRECTORY                                         |
+|-----------------------------------------|------------------------------------------------------------|
+| CommentMerchantRelationRequestConnector | vendor/spryker/comment-merchant-relation-request-connector |
+
+{% endinfo_block %}
+
+### 2) Set up transfer objects
+
+Generate transfer changes:
+
+```bash
+console transfer:generate
+```
+
+{% info_block warningBox "Verification" %}
+
+Make sure the following changes have been applied in transfer objects:
+
+| Transfer                              | Type     | Event   | Path                                                          |
+|---------------------------------------|----------|---------|---------------------------------------------------------------|
+| MerchantRelationRequest.commentThread | property | created | src/Generated/Shared/Transfer/MerchantRelationRequestTransfer |
+| MerchantRelationship.commentThread    | property | created | src/Generated/Shared/Transfer/MerchantRelationshipTransfer    |
+
+{% endinfo_block %}
+
+### 3) Set up behavior
+
+Enable the following behaviors by registering the plugins:
+
+| PLUGIN                                                  | SPECIFICATION                                                                          | PREREQUISITES | NAMESPACE                                                                                        |
+|---------------------------------------------------------|----------------------------------------------------------------------------------------|---------------|--------------------------------------------------------------------------------------------------|
+| CommentThreadMerchantRelationRequestExpanderPlugin      | Populates `MerchantRelationRequestTransfer.commentThread` with a related comment thread. |               | Spryker\Zed\CommentMerchantRelationRequestConnector\Communication\Plugin\MerchantRelationRequest |
+| CopyCommentThreadToMerchantRelationshipPostCreatePlugin | Copies a comment thread from a merchant relation request to a merchant relationship.         |               | Spryker\Zed\CommentMerchantRelationRequestConnector\Communication\Plugin\MerchantRelationship    |
+
+**src/Pyz/Zed/MerchantRelationRequest/MerchantRelationRequestDependencyProvider.php**
+
+```php
+<?php
+
+namespace Pyz\Zed\MerchantRelationRequest;
+
+use Spryker\Zed\CommentMerchantRelationRequestConnector\Communication\Plugin\MerchantRelationRequest\CommentThreadMerchantRelationRequestExpanderPlugin;
+use Spryker\Zed\MerchantRelationRequest\MerchantRelationRequestDependencyProvider as SprykerMerchantRelationRequestDependencyProvider;
+
+class MerchantRelationRequestDependencyProvider extends SprykerMerchantRelationRequestDependencyProvider
+{
+    /**
+     * @return list<\Spryker\Zed\MerchantRelationRequestExtension\Dependency\Plugin\MerchantRelationRequestExpanderPluginInterface>
+     */
+    protected function getMerchantRelationRequestExpanderPlugins(): array
+    {
+        return [
+            new CommentThreadMerchantRelationRequestExpanderPlugin(),
+        ];
+    }
+}
+```
+
+{% info_block warningBox "Verification" %}
+
+1. In the Merchant Portal, go to **B2B Contracts** > **Merchant Relation Requests**
+2. Select a merchant relation request.
+  Make sure you can see, add, edit and delete comments.
+
+{% endinfo_block %}
+
+**src/Pyz/Zed/MerchantRelationship/MerchantRelationshipDependencyProvider.php**
+
+```php
+<?php
+
+namespace Pyz\Zed\MerchantRelationship;
+
+use Spryker\Zed\CommentMerchantRelationRequestConnector\Communication\Plugin\MerchantRelationship\CopyCommentThreadToMerchantRelationshipPostCreatePlugin;
+use Spryker\Zed\MerchantRelationship\MerchantRelationshipDependencyProvider as SprykerMerchantRelationshipDependencyProvider;
+
+class MerchantRelationshipDependencyProvider extends SprykerMerchantRelationshipDependencyProvider
+{
+    /**
+     * @return array<\Spryker\Zed\MerchantRelationshipExtension\Dependency\Plugin\MerchantRelationshipPostCreatePluginInterface>
+     */
+    protected function getMerchantRelationshipPostCreatePlugins(): array
+    {
+        return [
+            new CopyCommentThreadToMerchantRelationshipPostCreatePlugin(),
+        ];
+    }
+}
+```
+
+{% info_block warningBox "Verification" %}
+
+1. In the Merchant Portal, go to **B2B Contracts** > **Merchant Relation Requests**.
+2. Select a pending merchant relation request.
+3. Add some comments.
+4. Approve the merchant relation request.
+5. Go to **B2B Contracts** > **Merchant Relations** and select the merchant relation you've created.
+    Make sure you can see the comments copied from the merchant relation request.
+
+{% endinfo_block %}

_includes/pbc/all/install-features/202404.0/install-the-comments-merchant-b2b-contracts-feature.md

@@ -0,0 +1,90 @@
+This document describes how to install the Comments + Merchant B2B Contracts feature.
+
+## Prerequisites
+
+Install the required features:
+
+| NAME                                | VERSION          | INSTALLATION GUIDE                                                                                                                                                             |
+|-------------------------------------|------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| Comments                            | {{page.version}} | [Install the Comments feature](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-comments-feature.html)              |
+| Merchant B2B Contracts              | {{page.version}} | [Install the Merchant B2B Contracts feature](/docs/pbc/all/merchant-management/{{page.version}}/base-shop/install-and-upgrade/install-the-merchant-b2b-contracts-feature.html) |
+
+## 1) Install the required modules
+
+Install the required modules using Composer:
+
+```bash
+composer require spryker/comment-merchant-relationship-connector: "^1.0.0" --update-with-dependencies
+```
+
+{% info_block warningBox "Verification" %}
+
+Make sure the following modules have been installed:
+
+| MODULE                               | EXPECTED DIRECTORY                                     |
+|--------------------------------------|--------------------------------------------------------|
+| CommentMerchantRelationshipConnector | vendor/spryker/comment-merchant-relationship-connector |
+
+{% endinfo_block %}
+
+## 2) Set up transfer objects
+
+Generate transfer changes:
+
+```bash
+console transfer:generate
+```
+
+{% info_block warningBox "Verification" %}
+
+Make sure the following changes have been applied in transfer objects:
+
+| Transfer                           | Type     | Event   | Path                                                       |
+|------------------------------------|----------|---------|------------------------------------------------------------|
+| MerchantRelationship.commentThread | property | created | src/Generated/Shared/Transfer/MerchantRelationshipTransfer |
+
+{% endinfo_block %}
+
+## 3) Set up behavior
+
+Enable the following behaviors by registering the plugins:
+
+| PLUGIN                                          | SPECIFICATION                                                                       | PREREQUISITES | NAMESPACE                                                                                  |
+|-------------------------------------------------|-------------------------------------------------------------------------------------|---------------|--------------------------------------------------------------------------------------------|
+| CommentThreadMerchantRelationshipExpanderPlugin | Populates `MerchantRelationshipTransfer.commentThread` with a related comment thread. |               | Spryker\Zed\CommentMerchantRelationshipConnector\Communication\Plugin\MerchantRelationship |
+
+**src/Pyz/Zed/MerchantRelationship/MerchantRelationshipDependencyProvider.php**
+
+```php
+<?php
+
+namespace Pyz\Zed\MerchantRelationship;
+
+use Spryker\Zed\CommentMerchantRelationshipConnector\Communication\Plugin\MerchantRelationship\CommentThreadMerchantRelationshipExpanderPlugin;
+use Spryker\Zed\MerchantRelationship\MerchantRelationshipDependencyProvider as SprykerMerchantRelationshipDependencyProvider;
+
+class MerchantRelationshipDependencyProvider extends SprykerMerchantRelationshipDependencyProvider
+{
+    /**
+     * @return array<\Spryker\Zed\MerchantRelationshipExtension\Dependency\Plugin\MerchantRelationshipExpanderPluginInterface>
+     */
+    protected function getMerchantRelationshipExpanderPlugins(): array
+    {
+        return [
+            new CommentThreadMerchantRelationshipExpanderPlugin(),
+        ];
+    }
+}
+```
+
+{% info_block warningBox "Verification" %}
+
+1. In the Back Office, go to **Marketplace** > **Merchant Relations**
+2. Click **Edit** next to any merchant relation.
+    Make sure you can see, add, edit, and delete comments.
+
+1. In the Merchant Portal, go to **B2B Contracts** > **Merchant Relations**
+2. Select a merchant relation.
+    Make sure you can see, add, edit, and delete comments.
+
+{% endinfo_block %}

_includes/pbc/all/install-features/202404.0/install-the-comments-spryker-core-back-office-feature.md

@@ -0,0 +1,113 @@
+This document describes how to install the Comments + Spryker Core Back Office feature.
+
+## Prerequisites
+
+Install the required features:
+
+| NAME                     | VERSION          | INSTALLATION GUIDE                                                                                                                                                |
+|--------------------------|------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| Comments                 | {{page.version}} | [Install the Comments feature](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-comments-feature.html) |
+| Spryker Core Back Office | {{page.version}} | [Install the Spryker Core Back Office feature](/docs/scos/dev/feature-integration-guides/{{page.version}}/spryker-core-back-office-feature-integration.html)      |
+
+## 1) Install the required modules
+
+Install the required modules using Composer:
+
+```bash
+composer require spryker/comment-user-connector: "^1.0.0" --update-with-dependencies
+```
+
+{% info_block warningBox "Verification" %}
+
+Make sure the following modules have been installed:
+
+| MODULE                         | EXPECTED DIRECTORY                               |
+|--------------------------------|--------------------------------------------------|
+| CommentUserConnector           | vendor/spryker/comment-user-connector            |
+
+{% endinfo_block %}
+
+### 3) Set up database schema and transfer objects
+
+Apply database changes and generate entity and transfer changes:
+
+```bash
+console propel:install
+console transfer:generate
+```
+
+{% info_block warningBox "Verification" %}
+
+Make sure the following changes have been applied in the database:
+
+| DATABASE ENTITY     | TYPE   | EVENT   |
+|---------------------|--------|---------|
+| spy_comment.fk_user | column | created |
+
+{% endinfo_block %}
+
+{% info_block warningBox "Verification" %}
+
+Make sure the following changes have been applied in transfer objects:
+
+| Transfer       | Type     | Event   | Path                                          |
+|----------------|----------|---------|-----------------------------------------------|
+| Comment.fkUser | property | created | src/Generated/Shared/Transfer/CommentTransfer |
+| Comment.user   | property | created | src/Generated/Shared/Transfer/CommentTransfer |
+
+{% endinfo_block %}
+
+### 3) Set up behavior
+
+Enable the following behaviors by registering the plugins:
+
+| PLUGIN                                    | SPECIFICATION                                                                     | PREREQUISITES | NAMESPACE                                                     |
+|-------------------------------------------|-----------------------------------------------------------------------------------|---------------|---------------------------------------------------------------|
+| UserCommentAuthorValidationStrategyPlugin | Validates a comment author when `CommentTransfer.fkUser` is provided.               |               | Spryker\Zed\CommentUserConnector\Communication\Plugin\Comment |
+| UserCommentExpanderPlugin                 | Expands `CommentTransfer` with `UserTransfer` if `CommentTransfer.fkUser` is set. |               | Spryker\Zed\CommentUserConnector\Communication\Plugin\Comment |
+
+**src/Pyz/Zed/Comment/CommentDependencyProvider.php**
+
+```php
+<?php
+
+namespace Pyz\Zed\Comment;
+
+use Spryker\Zed\Comment\CommentDependencyProvider as SprykerCommentDependencyProvider;
+use Spryker\Zed\CommentUserConnector\Communication\Plugin\Comment\UserCommentAuthorValidationStrategyPlugin;
+use Spryker\Zed\CommentUserConnector\Communication\Plugin\Comment\UserCommentExpanderPlugin;
+
+class CommentDependencyProvider extends SprykerCommentDependencyProvider
+{
+    /**
+     * @return list<\Spryker\Zed\CommentExtension\Dependency\Plugin\CommentAuthorValidatorStrategyPluginInterface>
+     */
+    protected function getCommentAuthorValidatorStrategyPlugins(): array
+    {
+        return [
+            new UserCommentAuthorValidationStrategyPlugin(),
+        ];
+    }
+
+    /**
+     * @return list<\Spryker\Zed\CommentExtension\Dependency\Plugin\CommentExpanderPluginInterface>
+     */
+    protected function getCommentExpanderPlugins(): array
+    {
+        return [
+            new UserCommentExpanderPlugin(),
+        ];
+    }
+}
+```
+
+{% info_block warningBox "Verification" %}
+
+1. In the Back Office, go to **Marketplace** > **Merchant Relations**.
+2. Click **Edit** next to a merchant relation.
+3. Write a comment and click **Save**.
+    Make sure the user's information is displayed under the saved comment.
+
+
+
+{% endinfo_block %}

_includes/pbc/all/install-features/202404.0/install-the-company-account-merchant-b2b-contract-requests-feature.md

@@ -0,0 +1,51 @@
+This document describes how to install the Company Account + Merchant B2B Contract Requests feature.
+
+## Prerequisites
+
+Install the required features:
+
+| NAME                           | VERSION          | INSTALLATION GUIDE                                                                                                                                                                             |
+|--------------------------------|------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| Company Account                | {{page.version}} | [Install the Company Account feature](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-company-account-feature.html) |
+| Merchant B2B Contract Requests | {{page.version}} | [Install the Merchant B2B Contract Requests feature](/docs/pbc/all/merchant-management/{{page.version}}/base-shop/install-and-upgrade/install-the-merchant-b2b-contract-requests-feature.html) |
+
+## 1) Set up behavior
+
+Enable the following behaviors by registering the plugins:
+
+| PLUGIN                                                                  | SPECIFICATION                                                                                      | PREREQUISITES | NAMESPACE                                                                   |
+|-------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------|---------------|-----------------------------------------------------------------------------|
+| AssigneeCompanyBusinessUnitAddressMerchantRelationRequestExpanderPlugin | Expands `MerchantRelationRequestCollectionTransfer` with an assignee company business unit addresses. |               | Spryker\Zed\CompanyUnitAddress\Communication\Plugin\MerchantRelationRequest |
+
+**src/Pyz/Zed/MerchantRelationRequest/MerchantRelationRequestDependencyProvider.php**
+
+```php
+<?php
+
+namespace Pyz\Zed\MerchantRelationRequest;
+
+use Spryker\Zed\CompanyUnitAddress\Communication\Plugin\MerchantRelationRequest\AssigneeCompanyBusinessUnitAddressMerchantRelationRequestExpanderPlugin;
+use Spryker\Zed\MerchantRelationRequest\MerchantRelationRequestDependencyProvider as SprykerMerchantRelationRequestDependencyProvider;
+
+class MerchantRelationRequestDependencyProvider extends SprykerMerchantRelationRequestDependencyProvider
+{
+    /**
+     * @return list<\Spryker\Zed\MerchantRelationRequestExtension\Dependency\Plugin\MerchantRelationRequestExpanderPluginInterface>
+     */
+    protected function getMerchantRelationRequestExpanderPlugins(): array
+    {
+        return [
+            new AssigneeCompanyBusinessUnitAddressMerchantRelationRequestExpanderPlugin(),
+        ];
+    }
+}
+```
+
+{% info_block warningBox "Verification" %}
+
+
+1. In the Merchant Portal, go to **B2B Contracts** > **Merchant Relation Requests**.
+2. Select a merchant relation request.
+  Make sure that, in the **Company Details** section, business units with their names and addresses are displayed.
+
+{% endinfo_block %}