diff --git a/app/code/Magento/LoginAsCustomer/README.md b/app/code/Magento/LoginAsCustomer/README.md index 17d37bf553278..bdc57c3bd41cc 100644 --- a/app/code/Magento/LoginAsCustomer/README.md +++ b/app/code/Magento/LoginAsCustomer/README.md @@ -1,3 +1,15 @@ # Magento_LoginAsCustomer module -The Magento_LoginAsCustomer module is responsible for ability to login into customer account using the admin panel. +This module is responsible for ability to login into customer account using the admin panel. + +## Installation + +The Magento_LoginAsCustomer module creates the `login_as_customer` table in the database. + +For information about a module installation in Magento 2, see [Enable or disable modules](https://devdocs.magento.com/guides/v2.4/install-gde/install/cli/install-cli-subcommands-enable.html). + +## Additional information + +This module is a part of Login As Customer feature. + +[Learn more about Login As Customer feature](https://docs.magento.com/user-guide/customers/login-as-customer.html) diff --git a/app/code/Magento/LoginAsCustomerAdminUi/README.md b/app/code/Magento/LoginAsCustomerAdminUi/README.md index 8c7e3483b3874..4ae940d51a242 100644 --- a/app/code/Magento/LoginAsCustomerAdminUi/README.md +++ b/app/code/Magento/LoginAsCustomerAdminUi/README.md @@ -1,3 +1,11 @@ -# Magento_LoginAsCustomerSales module +# Magento_LoginAsCustomerAdminUi module -The Magento_LoginAsCustomerAdminUi module provides UI for Admin Panel +This module provides UI for Admin Panel for Login As Customer functionality. + +[The Magento dependency injection mechanism](http://devdocs.magento.com/guides/v2.4/extension-dev-guide/depend-inj.html) enables you to override the functionality of the Magento_LoginAsCustomerAdminUi module. + +## Additional information + +This module is a part of Login As Customer feature. + +[Learn more about Login As Customer feature](https://docs.magento.com/user-guide/customers/login-as-customer.html). diff --git a/app/code/Magento/LoginAsCustomerApi/README.md b/app/code/Magento/LoginAsCustomerApi/README.md index caf2f23b49f43..af329b244418b 100644 --- a/app/code/Magento/LoginAsCustomerApi/README.md +++ b/app/code/Magento/LoginAsCustomerApi/README.md @@ -1,3 +1,57 @@ -# Magento_LoginAsCustomer module +# Magento_LoginAsCustomerApi module -The Magento_LoginAsCustomerApi module provides API for ability to login into customer account for an admin user. +This module provides API for ability to login into customer account for an admin user. + +### Public APIs + +- `\Magento\LoginAsCustomerApi\Api\Data\AuthenticationDataInterface`: + - contains authentication data + +-`\Magento\LoginAsCustomerApi\Api\Data\IsLoginAsCustomerEnabledForCustomerResultInterface`: + - contains the result of the check whether the login as customer is enabled + +- `\Magento\LoginAsCustomerApi\Api\AuthenticateCustomerBySecretInterface`: + - authenticate a customer by secret + +- `\Magento\LoginAsCustomerApi\Api\ConfigInterface`: + - check if Login as Customer extension is enabled + - check if store view manual choice is enabled + - get authentication data expiration time (in seconds) + +- `\Magento\LoginAsCustomerApi\Api\DeleteAuthenticationDataForUserInterface`: + - delete authentication data by user id + +- `\Magento\LoginAsCustomerApi\Api\GenerateAuthenticationSecretInterface`: + - generate authentication secret + +- `\Magento\LoginAsCustomerApi\Api\GetAuthenticationDataBySecretInterface`: + - get authentication data by secret + +- `\Magento\LoginAsCustomerApi\Api\GetLoggedAsCustomerAdminIdInterface`: + - get id of admin logged as customer + +- `\Magento\LoginAsCustomerApi\Api\GetLoggedAsCustomerCustomerIdInterface`: + - get id of customer admin is logged as + +- `\Magento\LoginAsCustomerApi\Api\IsLoginAsCustomerEnabledForCustomerInterface`: + - check if login as customer functionality is enabled for customer + +- `\Magento\LoginAsCustomerApi\Api\IsLoginAsCustomerSessionActiveInterface`: + - check if Login as Customer session is still active + +- `\Magento\LoginAsCustomerApi\Api\SaveAuthenticationDataInterface`: + - save authentication data. Return secret key + +- `\Magento\LoginAsCustomerApi\Api\SetLoggedAsCustomerAdminIdInterface`: + - set id of admin logged as customer + +- `\Magento\LoginAsCustomerApi\Api\SetLoggedAsCustomerCustomerIdInterface`: + - set id of customer admin is logged as + +For information about a public API in Magento 2, see [Public interfaces & APIs](http://devdocs.magento.com/guides/v2.4/extension-dev-guide/api-concepts.html). + +## Additional information + +This module is a part of Login As Customer feature. + +[Learn more about Login As Customer feature](https://docs.magento.com/user-guide/customers/login-as-customer.html). diff --git a/app/code/Magento/LoginAsCustomerAssistance/README.md b/app/code/Magento/LoginAsCustomerAssistance/README.md index b43dd6c8db43a..8575763f075b8 100644 --- a/app/code/Magento/LoginAsCustomerAssistance/README.md +++ b/app/code/Magento/LoginAsCustomerAssistance/README.md @@ -1,3 +1,15 @@ # Magento_LoginAsCustomerAssistance module -The Magento_LoginAsCustomerAssistance module provides possibility to enable/disable LoginAsCustomer functionality per Customer. +This module provides possibility to enable/disable LoginAsCustomer functionality per Customer. + +## Installation + +The Magento_LoginAsCustomerAssistance module creates the `login_as_customer_assistance_allowed` table in the database. + +For information about a module installation in Magento 2, see [Enable or disable modules](https://devdocs.magento.com/guides/v2.4/install-gde/install/cli/install-cli-subcommands-enable.html). + +## Additional information + +This module is a part of Login As Customer feature. + +[Learn more about Login As Customer feature](https://docs.magento.com/user-guide/customers/login-as-customer.html). diff --git a/app/code/Magento/LoginAsCustomerFrontendUi/README.md b/app/code/Magento/LoginAsCustomerFrontendUi/README.md index cade295cf3a94..f822a71e87d35 100644 --- a/app/code/Magento/LoginAsCustomerFrontendUi/README.md +++ b/app/code/Magento/LoginAsCustomerFrontendUi/README.md @@ -1,3 +1,9 @@ -# Magento_LoginAsCustomerSales module +# Magento_LoginAsCustomerFrontendUi module -The Magento_LoginAsCustomerFrontendUi module provides UI for Storefront +This module provides UI for Storefront for Login As Customer functionality. + +## Additional information + +This module is a part of Login As Customer feature. + +[Learn more about Login As Customer feature](https://docs.magento.com/user-guide/customers/login-as-customer.html). diff --git a/app/code/Magento/LoginAsCustomerGraphQl/README.md b/app/code/Magento/LoginAsCustomerGraphQl/README.md index 4bedf92dfc238..9e8c7ba71b6c5 100755 --- a/app/code/Magento/LoginAsCustomerGraphQl/README.md +++ b/app/code/Magento/LoginAsCustomerGraphQl/README.md @@ -1,3 +1,22 @@ -# LoginAsCustomerGraphQl +# Magento_LoginAsCustomerGraphQl module -**LoginAsCustomerGraphQl** provides flexible login as a customer so a merchant or merchant admin can log into an end customer's account to assist them with their account. +This module provides flexible login as a customer using GraphQl so a merchant or merchant admin can log into an end customer's account to assist them with their account. + +## Installation + +Before installing this module, note that the Magento_GroupedProductGraphQl is dependent on the following modules: + +- Magento_LoginAsCustomerApi +- Magento_Customer +- Magento_Store +- Magento_CatalogGraphQlr + +For information about a module installation in Magento 2, see [Enable or disable modules](https://devdocs.magento.com/guides/v2.4/install-gde/install/cli/install-cli-subcommands-enable.html). + +## Additional information + +This module is a part of Login As Customer feature. + +[Learn more about Login As Customer feature](https://docs.magento.com/user-guide/customers/login-as-customer.html). + +You can get more information about [GraphQl In Magento 2](https://devdocs.magento.com/guides/v2.4/graphql). diff --git a/app/code/Magento/LoginAsCustomerLog/README.md b/app/code/Magento/LoginAsCustomerLog/README.md index c8e546ae07f00..88d843df2ae0a 100644 --- a/app/code/Magento/LoginAsCustomerLog/README.md +++ b/app/code/Magento/LoginAsCustomerLog/README.md @@ -1,3 +1,46 @@ # Magento_LoginAsCustomerLog module -The Magento_LoginAsCustomerLog module provides log for Login as Customer functionality +This module provides log for Login as Customer functionality + +## Installation + +The Magento_LoginAsCustomerLog module creates the `magento_login_as_customer_log` table in the database. + +For information about a module installation in Magento 2, see [Enable or disable modules](https://devdocs.magento.com/guides/v2.4/install-gde/install/cli/install-cli-subcommands-enable.html). + +### Layouts + +This module introduces the following layouts in the `view/adminhtml/layout` directory: +- `loginascustomer_log_log_index` + +For more information about a layout in Magento 2, see the [Layout documentation](https://devdocs.magento.com/guides/v2.4/frontend-dev-guide/layouts/layout-overview.html). + +### UI components + +You can extend log listing updates using the configuration files located in the directories +- `view/adminhtml/ui_component`: + - `login_as_customer_log_listing` + +For information about a UI component in Magento 2, see [Overview of UI components](http://devdocs.magento.com/guides/v2.4/ui_comp_guide/bk-ui_comps.html). + +### Public APIs + +- `\Magento\LoginAsCustomerLog\Api\Data\LogInterface` + - login as customer log data + +- `\Magento\LoginAsCustomerLog\Api\Data\LogSearchResultsInterface` + - login as customer log entity search results data + +- `\Magento\LoginAsCustomerLog\Api\GetLogsListInterface`: + - get login as customer log list considering search criteria + +- `\Magento\LoginAsCustomerLog\Api\SaveLogsInterface`: + - save login as custom logs entities + +For information about a public API in Magento 2, see [Public interfaces & APIs](http://devdocs.magento.com/guides/v2.4/extension-dev-guide/api-concepts.html). + +## Additional information + +This module is a part of Login As Customer feature. + +[Learn more about Login As Customer feature](https://docs.magento.com/user-guide/customers/login-as-customer.html). diff --git a/app/code/Magento/LoginAsCustomerPageCache/README.md b/app/code/Magento/LoginAsCustomerPageCache/README.md index 91fa43fb4e833..298c6bdbb4c64 100644 --- a/app/code/Magento/LoginAsCustomerPageCache/README.md +++ b/app/code/Magento/LoginAsCustomerPageCache/README.md @@ -1,3 +1,9 @@ -# LoginAsCustomerPageCache module +# Magento_LoginAsCustomerPageCache module -The Magento_LoginAsCustomerPageCache module provides adaptation to PageCache functionality +This module provides adaptation to PageCache functionality for Login as Customer functionality. + +## Additional information + +This module is a part of Login As Customer feature. + +[Learn more about Login As Customer feature](https://docs.magento.com/user-guide/customers/login-as-customer.html). diff --git a/app/code/Magento/LoginAsCustomerQuote/README.md b/app/code/Magento/LoginAsCustomerQuote/README.md index fa1daddfceb36..7e3ee95478b9b 100644 --- a/app/code/Magento/LoginAsCustomerQuote/README.md +++ b/app/code/Magento/LoginAsCustomerQuote/README.md @@ -1,3 +1,9 @@ # Magento_LoginAsCustomerQuote module The Magento_LoginAsCustomerQuote module is responsible for communication between Magento_LoginAsCustomer and shopping cart state. + +## Additional information + +This module is a part of Login As Customer feature. + +[Learn more about Login As Customer feature](https://docs.magento.com/user-guide/customers/login-as-customer.html). diff --git a/app/code/Magento/LoginAsCustomerSales/README.md b/app/code/Magento/LoginAsCustomerSales/README.md index 1aee19ba53e96..342872a7362ec 100644 --- a/app/code/Magento/LoginAsCustomerSales/README.md +++ b/app/code/Magento/LoginAsCustomerSales/README.md @@ -1,3 +1,9 @@ # Magento_LoginAsCustomerSales module -The Magento_LoginAsCustomerSales module is responsible for communication between Magento_LoginAsCustomer and order placement. +This module is responsible for communication between Magento_LoginAsCustomer and order placement. + +## Additional information + +This module is a part of Login As Customer feature. + +[Learn more about Login As Customer feature](https://docs.magento.com/user-guide/customers/login-as-customer.html). diff --git a/app/code/Magento/Marketplace/README.md b/app/code/Magento/Marketplace/README.md index 758e449ac226b..c942a830c1dd3 100644 --- a/app/code/Magento/Marketplace/README.md +++ b/app/code/Magento/Marketplace/README.md @@ -1 +1,21 @@ -The Magento_Marketplace module allows to display partners of Magento in the backend. \ No newline at end of file +# Magento_Marketplace module + +This module allows to display partners of Magento in the backend. + +## Installation + +For information about a module installation in Magento 2, see [Enable or disable modules](https://devdocs.magento.com/guides/v2.4/install-gde/install/cli/install-cli-subcommands-enable.html). + +## Extensibility + +Extension developers can interact with the Magento_Marketplace module. For more information about the Magento extension mechanism, see [Magento plugins](http://devdocs.magento.com/guides/v2.4/extension-dev-guide/plugins.html). + +[The Magento dependency injection mechanism](http://devdocs.magento.com/guides/v2.4/extension-dev-guide/depend-inj.html) enables you to override the functionality of the Magento_Marketplace module. + +### Layouts + +This module introduces the following layouts in the `view/adminhtml/layout` directory: +- `marketplace_index_index` +- `marketplace_partners_index` + +For more information about a layout in Magento 2, see the [Layout documentation](https://devdocs.magento.com/guides/v2.4/frontend-dev-guide/layouts/layout-overview.html).