Inheritance diagram for IntegrationServiceInterface:
Public Member Functions | |
| create (array $integrationData) | |
| get ($integrationId) | |
| findByName ($integrationName) | |
| findByConsumerId ($consumerId) | |
| findActiveIntegrationByConsumerId ($consumerId) | |
| update (array $integrationData) | |
| delete ($integrationId) | |
| getSelectedResources ($integrationId) | |
Detailed Description
Integration Service Interface
@api
- Since
- 100.0.2
Definition at line 16 of file IntegrationServiceInterface.php.
Member Function Documentation
◆ create()
| create | ( | array | $integrationData | ) |
Create a new Integration
- Parameters
-
array $integrationData
- Returns
- IntegrationModel
- Exceptions
-
Implemented in IntegrationService.
◆ delete()
| delete | ( | $integrationId | ) |
Delete an Integration.
- Parameters
-
int $integrationId
- Returns
- array Integration data
- Exceptions
-
Implemented in IntegrationService.
◆ findActiveIntegrationByConsumerId()
| findActiveIntegrationByConsumerId | ( | $consumerId | ) |
Get the details of an active Integration by consumer_id.
- Parameters
-
int $consumerId
- Returns
- IntegrationModel
Implemented in IntegrationService.
◆ findByConsumerId()
| findByConsumerId | ( | $consumerId | ) |
Get the details of an Integration by consumer_id.
- Parameters
-
int $consumerId
- Returns
- IntegrationModel
Implemented in IntegrationService.
◆ findByName()
| findByName | ( | $integrationName | ) |
Find Integration by name.
- Parameters
-
string $integrationName
- Returns
- IntegrationModel
Implemented in IntegrationService.
◆ get()
| get | ( | $integrationId | ) |
Get the details of a specific Integration.
- Parameters
-
int $integrationId
- Returns
- IntegrationModel
- Exceptions
-
Implemented in IntegrationService.
◆ getSelectedResources()
| getSelectedResources | ( | $integrationId | ) |
Return an array of selected resources for an integration.
- Parameters
-
int $integrationId
- Returns
- array
Implemented in IntegrationService.
◆ update()
| update | ( | array | $integrationData | ) |
Update an Integration.
- Parameters
-
array $integrationData
- Returns
- IntegrationModel
- Exceptions
-
Implemented in IntegrationService.
The documentation for this interface was generated from the following file:
- vendor/magento/module-integration/Api/IntegrationServiceInterface.php