Skip to content

README.md

Latest commit

 

History

History
326 lines (242 loc) · 16.8 KB

README.md

File metadata and controls

326 lines (242 loc) · 16.8 KB

Accounting.Attachments

Overview

Available Operations

list

List Attachments

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\AccountingAttachmentsAllRequest(
    referenceType: Components\AttachmentReferenceType::Invoice,
    referenceId: '123456',
    serviceId: 'salesforce',
    companyId: '12345',
    fields: 'id,updated_at',
);

$responses = $sdk->accounting->attachments->list(
    request: $request
);


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

Parameters

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

Response

?Operations\AccountingAttachmentsAllResponse

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

upload

Upload attachment

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\AccountingAttachmentsUploadRequest(
    referenceType: Components\AttachmentReferenceType::Invoice,
    referenceId: '12345',
    xApideckMetadata: '{"name":"document.pdf","description":"Invoice attachment"}',
    serviceId: 'salesforce',
    requestBody: '0xF6a0e3a2dC',
);

$response = $sdk->accounting->attachments->upload(
    request: $request
);

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

Parameters

Parameter Type Required Description
$request Operations\AccountingAttachmentsUploadRequest ✔️ The request object to use for the request.
$serverURL string ➖ An optional server URL to use.

Response

?Operations\AccountingAttachmentsUploadResponse

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 Attachment

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\AccountingAttachmentsOneRequest(
    referenceType: Components\AttachmentReferenceType::Invoice,
    referenceId: '123456',
    id: '<id>',
    serviceId: 'salesforce',
    companyId: '12345',
    fields: 'id,updated_at',
);

$response = $sdk->accounting->attachments->get(
    request: $request
);

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

Parameters

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

Response

?Operations\AccountingAttachmentsOneResponse

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

delete

Delete Attachment

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\AccountingAttachmentsDeleteRequest(
    referenceType: Components\AttachmentReferenceType::Invoice,
    referenceId: '123456',
    id: '<id>',
    serviceId: 'salesforce',
);

$response = $sdk->accounting->attachments->delete(
    request: $request
);

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

Parameters

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

Response

?Operations\AccountingAttachmentsDeleteResponse

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

download

Download Attachment

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\AccountingAttachmentsDownloadRequest(
    referenceType: Components\AttachmentReferenceType::Invoice,
    referenceId: '123456',
    id: '<id>',
    serviceId: 'salesforce',
    companyId: '12345',
    fields: 'id,updated_at',
);

$response = $sdk->accounting->attachments->download(
    request: $request
);

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

Parameters

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

Response

?Operations\AccountingAttachmentsDownloadResponse

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