Skip to content

README.md

Latest commit

 

History

History
313 lines (219 loc) · 13.1 KB

README.md

File metadata and controls

313 lines (219 loc) · 13.1 KB

Files

Overview

Available Operations

list

List files.

Scopes: files:read files:write

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use Polar;

$sdk = Polar\Polar::builder()
    ->setSecurity(
        '<YOUR_BEARER_TOKEN_HERE>'
    )
    ->build();



$responses = $sdk->files->list(
    organizationId: '1dbfc517-0bbf-4301-9ba8-555ca42b9737',
    page: 1,
    limit: 10

);


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

Parameters

Parameter Type Required Description
organizationId string|array|null ➖ Filter by organization ID.
ids string|array|null ➖ Filter by file ID.
page ?int ➖ Page number, defaults to 1.
limit ?int ➖ Size of a page, defaults to 10. Maximum is 100.

Response

?Operations\FilesListResponse

Errors

Error Type Status Code Content Type
Errors\HTTPValidationError 422 application/json
Errors\APIException 4XX, 5XX */*

create

Create a file.

Scopes: files:write

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use Polar;
use Polar\Models\Components;

$sdk = Polar\Polar::builder()
    ->setSecurity(
        '<YOUR_BEARER_TOKEN_HERE>'
    )
    ->build();

$request = new Components\DownloadableFileCreate(
    organizationId: '1dbfc517-0bbf-4301-9ba8-555ca42b9737',
    name: '<value>',
    mimeType: '<value>',
    size: 612128,
    upload: new Components\S3FileCreateMultipart(
        parts: [],
    ),
);

$response = $sdk->files->create(
    request: $request
);

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

Parameters

Parameter Type Required Description
$request Components\DownloadableFileCreate|Components\ProductMediaFileCreate|Components\OrganizationAvatarFileCreate ✔️ The request object to use for the request.

Response

?Operations\FilesCreateResponse

Errors

Error Type Status Code Content Type
Errors\HTTPValidationError 422 application/json
Errors\APIException 4XX, 5XX */*

uploaded

Complete a file upload.

Scopes: files:write

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use Polar;
use Polar\Models\Components;

$sdk = Polar\Polar::builder()
    ->setSecurity(
        '<YOUR_BEARER_TOKEN_HERE>'
    )
    ->build();

$fileUploadCompleted = new Components\FileUploadCompleted(
    id: '<id>',
    path: '/boot',
    parts: [
        new Components\S3FileUploadCompletedPart(
            number: 979613,
            checksumEtag: '<value>',
            checksumSha256Base64: '<value>',
        ),
        new Components\S3FileUploadCompletedPart(
            number: 979613,
            checksumEtag: '<value>',
            checksumSha256Base64: '<value>',
        ),
        new Components\S3FileUploadCompletedPart(
            number: 979613,
            checksumEtag: '<value>',
            checksumSha256Base64: '<value>',
        ),
    ],
);

$response = $sdk->files->uploaded(
    id: '<value>',
    fileUploadCompleted: $fileUploadCompleted

);

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

Parameters

Parameter Type Required Description
id string ✔️ The file ID.
fileUploadCompleted Components\FileUploadCompleted ✔️ N/A

Response

?Operations\FilesUploadedResponse

Errors

Error Type Status Code Content Type
Errors\NotPermitted 403 application/json
Errors\ResourceNotFound 404 application/json
Errors\HTTPValidationError 422 application/json
Errors\APIException 4XX, 5XX */*

delete

Delete a file.

Scopes: files:write

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use Polar;

$sdk = Polar\Polar::builder()
    ->setSecurity(
        '<YOUR_BEARER_TOKEN_HERE>'
    )
    ->build();



$response = $sdk->files->delete(
    id: '<value>'
);

if ($response->statusCode === 200) {
    // handle response
}

Parameters

Parameter Type Required Description
id string ✔️ N/A

Response

?Operations\FilesDeleteResponse

Errors

Error Type Status Code Content Type
Errors\NotPermitted 403 application/json
Errors\ResourceNotFound 404 application/json
Errors\HTTPValidationError 422 application/json
Errors\APIException 4XX, 5XX */*

update

Update a file.

Scopes: files:write

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use Polar;
use Polar\Models\Components;

$sdk = Polar\Polar::builder()
    ->setSecurity(
        '<YOUR_BEARER_TOKEN_HERE>'
    )
    ->build();

$filePatch = new Components\FilePatch();

$response = $sdk->files->update(
    id: '<value>',
    filePatch: $filePatch

);

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

Parameters

Parameter Type Required Description
id string ✔️ The file ID.
filePatch Components\FilePatch ✔️ N/A

Response

?Operations\FilesUpdateResponse

Errors

Error Type Status Code Content Type
Errors\NotPermitted 403 application/json
Errors\ResourceNotFound 404 application/json
Errors\HTTPValidationError 422 application/json
Errors\APIException 4XX, 5XX */*