README.md

Crm.Lists

Overview

Available Operations

• list - List lists
• get - Get list

list

List lists

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\CrmListsAllRequest(
    serviceId: 'salesforce',
    passThrough: [
        'search' => 'San Francisco',
    ],
    fields: 'id,updated_at',
);

$responses = $sdk->crm->lists->list(
    request: $request
);


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

Parameters

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

Response

?Operations\CrmListsAllResponse

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 list

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\CrmListsOneRequest(
    id: '<id>',
    serviceId: 'salesforce',
    fields: 'id,updated_at',
);

$response = $sdk->crm->lists->get(
    request: $request
);

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

Parameters

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

Response

?Operations\CrmListsOneResponse

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	*/*