Skip to content

Latest commit

 

History

History
576 lines (407 loc) · 18.4 KB

IntegrationApi.md

File metadata and controls

576 lines (407 loc) · 18.4 KB
Raw

Swagger\Client\IntegrationApi

All URIs are relative to https://localhost:20000/api/3.1

Method HTTP request Description
acceptIntegrationHubLegalAgreement POST /integration_hubs/{integration_hub_id}/accept_legal_agreement Accept Integration Hub Legal Agreement
allIntegrationHubs GET /integration_hubs Get All Integration Hubs
allIntegrations GET /integrations Get All Integrations
createIntegrationHub POST /integration_hubs Create Integration Hub
deleteIntegrationHub DELETE /integration_hubs/{integration_hub_id} Delete Integration Hub
fetchIntegrationForm POST /integrations/{integration_id}/form Fetch Remote Integration Form
integration GET /integrations/{integration_id} Get Integration
integrationHub GET /integration_hubs/{integration_hub_id} Get Integration Hub
testIntegration POST /integrations/{integration_id}/test Test integration
updateIntegration PATCH /integrations/{integration_id} Update Integration
updateIntegrationHub PATCH /integration_hubs/{integration_hub_id} Update Integration Hub

acceptIntegrationHubLegalAgreement

\Swagger\Client\Model\IntegrationHub acceptIntegrationHubLegalAgreement($integration_hub_id)

Accept Integration Hub Legal Agreement

Accepts the legal agreement for a given integration hub. This only works for integration hubs that have legal_agreement_required set to true and legal_agreement_signed set to false.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Swagger\Client\Api\IntegrationApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$integration_hub_id = "integration_hub_id_example"; // string | Id of integration_hub

try {
    $result = $apiInstance->acceptIntegrationHubLegalAgreement($integration_hub_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling IntegrationApi->acceptIntegrationHubLegalAgreement: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
integration_hub_id string Id of integration_hub

Return type

\Swagger\Client\Model\IntegrationHub

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

allIntegrationHubs

\Swagger\Client\Model\IntegrationHub[] allIntegrationHubs($fields)

Get All Integration Hubs

Get information about all Integration Hubs.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Swagger\Client\Api\IntegrationApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$fields = "fields_example"; // string | Requested fields.

try {
    $result = $apiInstance->allIntegrationHubs($fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling IntegrationApi->allIntegrationHubs: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
fields string Requested fields. [optional]

Return type

\Swagger\Client\Model\IntegrationHub[]

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

allIntegrations

\Swagger\Client\Model\Integration[] allIntegrations($fields, $integration_hub_id)

Get All Integrations

Get information about all Integrations.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Swagger\Client\Api\IntegrationApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$fields = "fields_example"; // string | Requested fields.
$integration_hub_id = "integration_hub_id_example"; // string | Filter to a specific provider

try {
    $result = $apiInstance->allIntegrations($fields, $integration_hub_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling IntegrationApi->allIntegrations: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
fields string Requested fields. [optional]
integration_hub_id string Filter to a specific provider [optional]

Return type

\Swagger\Client\Model\Integration[]

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

createIntegrationHub

\Swagger\Client\Model\IntegrationHub createIntegrationHub($body, $fields)

Create Integration Hub

Create a new Integration Hub. This API is rate limited to prevent it from being used for SSRF attacks

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Swagger\Client\Api\IntegrationApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$body = new \Swagger\Client\Model\IntegrationHub(); // \Swagger\Client\Model\IntegrationHub | Integration Hub
$fields = "fields_example"; // string | Requested fields.

try {
    $result = $apiInstance->createIntegrationHub($body, $fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling IntegrationApi->createIntegrationHub: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
body \Swagger\Client\Model\IntegrationHub Integration Hub
fields string Requested fields. [optional]

Return type

\Swagger\Client\Model\IntegrationHub

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deleteIntegrationHub

string deleteIntegrationHub($integration_hub_id)

Delete Integration Hub

Delete a Integration Hub.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Swagger\Client\Api\IntegrationApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$integration_hub_id = "integration_hub_id_example"; // string | Id of integration_hub

try {
    $result = $apiInstance->deleteIntegrationHub($integration_hub_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling IntegrationApi->deleteIntegrationHub: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
integration_hub_id string Id of integration_hub

Return type

string

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

fetchIntegrationForm

\Swagger\Client\Model\DataActionForm fetchIntegrationForm($integration_id, $body)

Fetch Remote Integration Form

Returns the Integration form for presentation to the user.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Swagger\Client\Api\IntegrationApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$integration_id = "integration_id_example"; // string | Id of integration
$body = new \stdClass; // object | Integration Form Request

try {
    $result = $apiInstance->fetchIntegrationForm($integration_id, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling IntegrationApi->fetchIntegrationForm: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
integration_id string Id of integration
body object Integration Form Request [optional]

Return type

\Swagger\Client\Model\DataActionForm

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

integration

\Swagger\Client\Model\Integration integration($integration_id, $fields)

Get Integration

Get information about a Integration.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Swagger\Client\Api\IntegrationApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$integration_id = "integration_id_example"; // string | Id of integration
$fields = "fields_example"; // string | Requested fields.

try {
    $result = $apiInstance->integration($integration_id, $fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling IntegrationApi->integration: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
integration_id string Id of integration
fields string Requested fields. [optional]

Return type

\Swagger\Client\Model\Integration

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

integrationHub

\Swagger\Client\Model\IntegrationHub integrationHub($integration_hub_id, $fields)

Get Integration Hub

Get information about a Integration Hub.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Swagger\Client\Api\IntegrationApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$integration_hub_id = "integration_hub_id_example"; // string | Id of integration_hub
$fields = "fields_example"; // string | Requested fields.

try {
    $result = $apiInstance->integrationHub($integration_hub_id, $fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling IntegrationApi->integrationHub: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
integration_hub_id string Id of integration_hub
fields string Requested fields. [optional]

Return type

\Swagger\Client\Model\IntegrationHub

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

testIntegration

\Swagger\Client\Model\IntegrationTestResult testIntegration($integration_id)

Test integration

Tests the integration to make sure all the settings are working.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Swagger\Client\Api\IntegrationApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$integration_id = "integration_id_example"; // string | Id of integration

try {
    $result = $apiInstance->testIntegration($integration_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling IntegrationApi->testIntegration: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
integration_id string Id of integration

Return type

\Swagger\Client\Model\IntegrationTestResult

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updateIntegration

\Swagger\Client\Model\Integration updateIntegration($integration_id, $body, $fields)

Update Integration

Update parameters on a Integration.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Swagger\Client\Api\IntegrationApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$integration_id = "integration_id_example"; // string | Id of integration
$body = new \Swagger\Client\Model\Integration(); // \Swagger\Client\Model\Integration | Integration
$fields = "fields_example"; // string | Requested fields.

try {
    $result = $apiInstance->updateIntegration($integration_id, $body, $fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling IntegrationApi->updateIntegration: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
integration_id string Id of integration
body \Swagger\Client\Model\Integration Integration
fields string Requested fields. [optional]

Return type

\Swagger\Client\Model\Integration

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updateIntegrationHub

\Swagger\Client\Model\IntegrationHub updateIntegrationHub($integration_hub_id, $body, $fields)

Update Integration Hub

Update a Integration Hub definition. This API is rate limited to prevent it from being used for SSRF attacks

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Swagger\Client\Api\IntegrationApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$integration_hub_id = "integration_hub_id_example"; // string | Id of integration_hub
$body = new \Swagger\Client\Model\IntegrationHub(); // \Swagger\Client\Model\IntegrationHub | Integration Hub
$fields = "fields_example"; // string | Requested fields.

try {
    $result = $apiInstance->updateIntegrationHub($integration_hub_id, $body, $fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling IntegrationApi->updateIntegrationHub: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
integration_hub_id string Id of integration_hub
body \Swagger\Client\Model\IntegrationHub Integration Hub
fields string Requested fields. [optional]

Return type

\Swagger\Client\Model\IntegrationHub

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]