Skip to content

Latest commit

 

History

History
63 lines (41 loc) · 2.49 KB

README.md

File metadata and controls

63 lines (41 loc) · 2.49 KB
Raw

ConnectorDocs

(connector->connectorDocs)

Overview

Available Operations

  • get - Get Connector Doc content

get

Get Connector Doc content

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use Apideck\Unify;

$security = '<YOUR_BEARER_TOKEN_HERE>';

$sdk = Unify\Apideck::builder()
    ->setConsumerId('test-consumer')
    ->setAppId('dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX')
    ->setSecurity($security)->build();



$response = $sdk->connector->connectorDocs->get(
    id: '<id>',
    docId: 'application_owner+oauth_credentials',
    appId: 'dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX'

);

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

Parameters

Parameter Type Required Description Example
id string ✔️ ID of the record you are acting upon.
docId string ✔️ ID of the Doc application_owner+oauth_credentials
appId ?string ➖ The ID of your Unify application dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX

Response

?Operations\ConnectorConnectorDocsOneResponse

Errors

Error Type Status Code Content Type
Errors\UnauthorizedResponse 401 application/json
Errors\PaymentRequiredResponse 402 application/json
Errors\NotFoundResponse 404 application/json
Errors\APIException 4XX, 5XX */*