Skip to content

README.md

Latest commit

 

History

History
136 lines (100 loc) · 6.56 KB

README.md

File metadata and controls

136 lines (100 loc) · 6.56 KB

IssueTracking.Collections

Overview

Available Operations

  • list - List Collections
  • get - Get Collection

list

List Collections

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use Apideck\Unify;
use Apideck\Unify\Models\Components;
use Apideck\Unify\Models\Operations;

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

$request = new Operations\IssueTrackingCollectionsAllRequest(
    serviceId: 'salesforce',
    sort: new Components\CollectionsSort(
        by: Components\CollectionsSortBy::Name,
        direction: Components\SortDirection::Desc,
    ),
    passThrough: [
        'search' => 'San Francisco',
    ],
    fields: 'id,updated_at',
);

$responses = $sdk->issueTracking->collections->list(
    request: $request
);


foreach ($responses as $response) {
    if ($response->httpMeta->response->getStatusCode() === 200) {
        // handle response
    }
}

Parameters

Parameter Type Required Description
$request Operations\IssueTrackingCollectionsAllRequest ✔️ The request object to use for the request.

Response

?Operations\IssueTrackingCollectionsAllResponse

Errors

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

get

Get Collection

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use Apideck\Unify;
use Apideck\Unify\Models\Operations;

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

$request = new Operations\IssueTrackingCollectionsOneRequest(
    collectionId: 'apideck-io',
    serviceId: 'salesforce',
    fields: 'id,updated_at',
);

$response = $sdk->issueTracking->collections->get(
    request: $request
);

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

Parameters

Parameter Type Required Description
$request Operations\IssueTrackingCollectionsOneRequest ✔️ The request object to use for the request.

Response

?Operations\IssueTrackingCollectionsOneResponse

Errors

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