Skip to content

Latest commit

 

History

History
238 lines (168 loc) · 10.1 KB

README.md

File metadata and controls

238 lines (168 loc) · 10.1 KB

Folders

(folders)

Overview

Available Operations

  • create - Create a new folder
  • delete - Delete a folder
  • list - Retrieve a list of folders
  • update - Update a folder

create

Create a new folder for the authenticated workspace.

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use Dub;
use Dub\Models\Operations;

$sdk = Dub\Dub::builder()
    ->setSecurity(
        'DUB_API_KEY'
    )
    ->build();

$request = new Operations\CreateFolderRequestBody(
    name: '<value>',
);

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

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

Parameters

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

Response

?Operations\CreateFolderResponse

Errors

Error Type Status Code Content Type
Errors\BadRequest 400 application/json
Errors\Unauthorized 401 application/json
Errors\Forbidden 403 application/json
Errors\NotFound 404 application/json
Errors\Conflict 409 application/json
Errors\InviteExpired 410 application/json
Errors\UnprocessableEntity 422 application/json
Errors\RateLimitExceeded 429 application/json
Errors\InternalServerError 500 application/json
Errors\SDKException 4XX, 5XX */*

delete

Delete a folder from the workspace. All existing links will still work, but they will no longer be associated with this folder.

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use Dub;

$sdk = Dub\Dub::builder()
    ->setSecurity(
        'DUB_API_KEY'
    )
    ->build();



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

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

Parameters

Parameter Type Required Description
id string ✔️ The ID of the folder to delete.

Response

?Operations\DeleteFolderResponse

Errors

Error Type Status Code Content Type
Errors\BadRequest 400 application/json
Errors\Unauthorized 401 application/json
Errors\Forbidden 403 application/json
Errors\NotFound 404 application/json
Errors\Conflict 409 application/json
Errors\InviteExpired 410 application/json
Errors\UnprocessableEntity 422 application/json
Errors\RateLimitExceeded 429 application/json
Errors\InternalServerError 500 application/json
Errors\SDKException 4XX, 5XX */*

list

Retrieve a list of folders for the authenticated workspace.

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use Dub;

$sdk = Dub\Dub::builder()
    ->setSecurity(
        'DUB_API_KEY'
    )
    ->build();



$response = $sdk->folders->list(
    search: '<value>'
);

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

Parameters

Parameter Type Required Description
search ?string ➖ The search term to filter the folders by.

Response

?Operations\ListFoldersResponse

Errors

Error Type Status Code Content Type
Errors\BadRequest 400 application/json
Errors\Unauthorized 401 application/json
Errors\Forbidden 403 application/json
Errors\NotFound 404 application/json
Errors\Conflict 409 application/json
Errors\InviteExpired 410 application/json
Errors\UnprocessableEntity 422 application/json
Errors\RateLimitExceeded 429 application/json
Errors\InternalServerError 500 application/json
Errors\SDKException 4XX, 5XX */*

update

Update a folder in the workspace.

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use Dub;
use Dub\Models\Operations;

$sdk = Dub\Dub::builder()
    ->setSecurity(
        'DUB_API_KEY'
    )
    ->build();

$requestBody = new Operations\UpdateFolderRequestBody();

$response = $sdk->folders->update(
    id: '<id>',
    requestBody: $requestBody

);

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

Parameters

Parameter Type Required Description
id string ✔️ The ID of the folder to update.
requestBody ?Operations\UpdateFolderRequestBody ➖ N/A

Response

?Operations\UpdateFolderResponse

Errors

Error Type Status Code Content Type
Errors\BadRequest 400 application/json
Errors\Unauthorized 401 application/json
Errors\Forbidden 403 application/json
Errors\NotFound 404 application/json
Errors\Conflict 409 application/json
Errors\InviteExpired 410 application/json
Errors\UnprocessableEntity 422 application/json
Errors\RateLimitExceeded 429 application/json
Errors\InternalServerError 500 application/json
Errors\SDKException 4XX, 5XX */*