From 021db64f7926749fc421092d6bf70de081f250f0 Mon Sep 17 00:00:00 2001
From: dima-uryvskiy <dima-uryvskiyy@rambler.ru>
Date: Tue, 3 Aug 2021 15:20:20 +0300
Subject: [PATCH] Add doc for project

---
 doc/1.Setup/Settings .md  |  3 +++
 doc/1.Setup/User roles.md | 33 +++++++++++++++++++++++++++++++++
 doc/README.md             |  1 +
 3 files changed, 37 insertions(+)
 create mode 100644 doc/1.Setup/Settings .md
 create mode 100644 doc/1.Setup/User roles.md
 create mode 100644 doc/README.md

diff --git a/doc/1.Setup/Settings .md b/doc/1.Setup/Settings .md
new file mode 100644
index 0000000..0bf7e32
--- /dev/null
+++ b/doc/1.Setup/Settings .md	
@@ -0,0 +1,3 @@
+
+# Settings
+
diff --git a/doc/1.Setup/User roles.md b/doc/1.Setup/User roles.md
new file mode 100644
index 0000000..78e90dd
--- /dev/null
+++ b/doc/1.Setup/User roles.md	
@@ -0,0 +1,33 @@
+# User roles
+
+С версии `4.3.7` опция `"Роли клиентов"` была удалена из настроек модуля. Сейчас выгружаются пользователи со всеми доступными ролями в CMS.
+Добавили фильтр `retailcrm_customer_roles` для корректировки выгружаемых пользователей.
+
+## Пример работы фильтра
+В приведенном ниже примере показано, как возможно корректировать роли выгружаемых пользователей:
+
+```php
+<?php
+
+add_filter('retailcrm_customer_roles', 'editCustomerRoles', 10, 1);
+
+function editCustomerRoles($roles)
+{
+    if (isset($roles['customer'])) {
+        unset($roles['customer']);
+    }
+    
+    return $roles;
+}
+```
+
+## Описание работы функционала
+У каждого зарегистрированного пользователя в WP есть роль. Роль отображает права пользователя на сайте. Ниже приведены основные кейсы работы с пользователями:
+
+* Пользователь "гость (клиент без регистрации)" создает заказ. Заказ корректно выгрузился в CRM, клиент был создан без externalId. Если этот "гость" создаст еще один заказ, то заказ корректно выгрузится и установится связь с этим клиентом (будет произведен поиск по email).
+* Создали пользователя, например с ролью "Подписчик", он корректно выгрузился в CRM, есть externalId и данные по клиенту, только те, что указаны при создании в админке WP. Данный пользователь оформляет заказ, заказ корректно выгрузился в CRM и связался с клиентом, клиенту добавилась данные: телефон, адрес. Обновление данных пользователя происходит корректно (будет произведен поиск по externalId).
+* Функционал корректно работает и для корпоративных клиентов.
+* Запустили архивную выгрузку, данные выгрузились корректно, все заказы, все клиенты без дублей.
+* Запретили через фильтр передавать пользователей с ролью "Клиент", такие пользователи в CRM выгружаться не будут.
+* Создали заказ для пользователя с ролью "Клиент", заказ выгрузился в CRM, так же создался клиент без externalId, модуль воспринимает таких клиентов как "гостей". Данное поведение считается корректным тк мы не выгружаем пользователей с определенной ролью, но они создаются с заказов (заказы мы передаем). 
+
diff --git a/doc/README.md b/doc/README.md
new file mode 100644
index 0000000..ee19679
--- /dev/null
+++ b/doc/README.md
@@ -0,0 +1 @@
+# Developers documentation