68 lines
2.2 KiB
Markdown
Executable File
68 lines
2.2 KiB
Markdown
Executable File
# Mage2 Module JR ReportIntegration
|
|
|
|
``jr/module-reportintegration``
|
|
|
|
- [Main Functionalities](#markdown-header-main-functionalities)
|
|
- [Installation](#markdown-header-installation)
|
|
- [Configuration](#markdown-header-configuration)
|
|
- [Specifications](#markdown-header-specifications)
|
|
- [Attributes](#markdown-header-attributes)
|
|
|
|
|
|
## Main Functionalities
|
|
JR
|
|
|
|
## Installation
|
|
\* = in production please use the `--keep-generated` option
|
|
|
|
### Type 1: Zip file
|
|
|
|
- Unzip the zip file in `app/code/JR`
|
|
- Enable the module by running `php bin/magento module:enable JR_ReportIntegration`
|
|
- Apply database updates by running `php bin/magento setup:upgrade`\*
|
|
- Flush the cache by running `php bin/magento cache:flush`
|
|
|
|
### Type 2: Composer
|
|
|
|
- Make the module available in a composer repository for example:
|
|
- private repository `repo.magento.com`
|
|
- public repository `packagist.org`
|
|
- public github repository as vcs
|
|
- Add the composer repository to the configuration by running `composer config repositories.repo.magento.com composer https://repo.magento.com/`
|
|
- Install the module composer by running `composer require jr/module-reportintegration`
|
|
- enable the module by running `php bin/magento module:enable JR_ReportIntegration`
|
|
- apply database updates by running `php bin/magento setup:upgrade`\*
|
|
- Flush the cache by running `php bin/magento cache:flush`
|
|
|
|
|
|
## Configuration
|
|
|
|
|
|
|
|
|
|
## Specifications
|
|
|
|
- API Endpoint
|
|
- POST - JR\ReportIntegration\Api\Model\InternalAccountsManagementInterface > JR\ReportIntegration\Model\InternalAccountsManagement
|
|
|
|
- API Endpoint
|
|
- POST - JR\ReportIntegration\Api\Model\DisableAccountsManagementInterface > JR\ReportIntegration\Model\DisableAccountsManagement
|
|
|
|
- API Endpoint
|
|
- POST - JR\ReportIntegration\Api\Model\SetOfficeManagementInterface > JR\ReportIntegration\Model\SetOfficeManagement
|
|
|
|
- API Endpoint
|
|
- POST - JR\ReportIntegration\Api\Model\SetSalesManagementInterface > JR\ReportIntegration\Model\SetSalesManagement
|
|
|
|
- API Endpoint
|
|
- POST - JR\ReportIntegration\Api\Model\ConfirmManagementInterface > JR\ReportIntegration\Model\ConfirmManagement
|
|
|
|
- API Endpoint
|
|
- POST - JR\ReportIntegration\Api\Model\DenyManagementInterface > JR\ReportIntegration\Model\DenyManagement
|
|
|
|
|
|
## Attributes
|
|
|
|
|
|
|