Skip to content

README.md

Latest commit

 

History

History
137 lines (98 loc) · 7.54 KB

README.md

File metadata and controls

137 lines (98 loc) · 7.54 KB

Connectors

Overview

Retrieve metadata for connectors.

Available Operations

listConnectorsMeta

List Connector Meta Information

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use StackOne\client;
use StackOne\client\Models\Components;

$sdk = client\StackOne::builder()
    ->setSecurity(
        new Components\Security(
            username: '',
            password: '',
        )
    )
    ->build();



$response = $sdk->connectors->listConnectorsMeta(
    include: 'field_path,unmapped_fields,resources,inactive,webhooks,static_fields'
);

if ($response->connectorsMetas !== null) {
    // handle response
}

Parameters

Parameter Type Required Description Example
include ?string ➖ The comma separated list of data that will be included in the response field_path,unmapped_fields,resources,inactive,webhooks,static_fields

Response

?Operations\StackoneListConnectorsMetaResponse

Errors

Error Type Status Code Content Type
Errors\BadRequestResponse 400 application/json
Errors\UnauthorizedResponse 401 application/json
Errors\ForbiddenResponse 403 application/json
Errors\NotFoundResponse 404 application/json
Errors\RequestTimedOutResponse 408 application/json
Errors\ConflictResponse 409 application/json
Errors\UnprocessableEntityResponse 422 application/json
Errors\TooManyRequestsResponse 429 application/json
Errors\InternalServerErrorResponse 500 application/json
Errors\NotImplementedResponse 501 application/json
Errors\BadGatewayResponse 502 application/json
Errors\SDKException 4XX, 5XX */*

getConnectorMeta

Get Connector Meta Information

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use StackOne\client;
use StackOne\client\Models\Components;

$sdk = client\StackOne::builder()
    ->setSecurity(
        new Components\Security(
            username: '',
            password: '',
        )
    )
    ->build();



$response = $sdk->connectors->getConnectorMeta(
    provider: '<value>',
    include: 'field_path,unmapped_fields,resources,inactive,webhooks,static_fields'

);

if ($response->connectorsMeta !== null) {
    // handle response
}

Parameters

Parameter Type Required Description Example
provider string ✔️ N/A
include ?string ➖ The comma separated list of data that will be included in the response field_path,unmapped_fields,resources,inactive,webhooks,static_fields

Response

?Operations\StackoneGetConnectorMetaResponse

Errors

Error Type Status Code Content Type
Errors\BadRequestResponse 400 application/json
Errors\UnauthorizedResponse 401 application/json
Errors\ForbiddenResponse 403 application/json
Errors\NotFoundResponse 404 application/json
Errors\RequestTimedOutResponse 408 application/json
Errors\ConflictResponse 409 application/json
Errors\UnprocessableEntityResponse 422 application/json
Errors\TooManyRequestsResponse 429 application/json
Errors\InternalServerErrorResponse 500 application/json
Errors\NotImplementedResponse 501 application/json
Errors\BadGatewayResponse 502 application/json
Errors\SDKException 4XX, 5XX */*