README.md

Workspaces

(workspaces)

Overview

Available Operations

• create - Create a workspace
• createToken - Create a token for a particular workspace
• deleteToken - Delete a token for a particular workspace
• get - Get workspace by context
• getAll - Get workspaces for a user
• getByID - Get workspace
• getFeatureFlags - Get workspace feature flags
• getSettings - Get workspace settings
• getTeam - Get team members for a particular workspace
• getTokens - Get tokens for a particular workspace
• grantAccess - Grant a user access to a particular workspace
• revokeAccess - Revoke a user's access to a particular workspace
• update - Update workspace details
• updateSettings - Update workspace settings

create

Creates a workspace

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use Speakeasy\SpeakeasyClientSDK;
use Speakeasy\SpeakeasyClientSDK\Models\Shared;
use Speakeasy\SpeakeasyClientSDK\Utils;

$security = new Shared\Security(
    apiKey: '<YOUR_API_KEY_HERE>',
);

$sdk = SpeakeasyClientSDK\SDK::builder()->setSecurity($security)->build();

$request = new Shared\Workspace(
    createdAt: Utils\Utils::parseDateTime('2023-06-18T07:14:55.338Z'),
    id: '<id>',
    name: '<value>',
    organizationId: '<id>',
    slug: '<value>',
    updatedAt: Utils\Utils::parseDateTime('2023-12-01T17:06:07.804Z'),
    verified: false,
);

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

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

Parameters

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

Response

?Operations\CreateWorkspaceResponse

Errors

Error Type	Status Code	Content Type
Errorors\Error	4XX	application/json
Errorors\SDKException	5XX	*/*

createToken

Create a token for a particular workspace

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use Speakeasy\SpeakeasyClientSDK;
use Speakeasy\SpeakeasyClientSDK\Models\Operations;
use Speakeasy\SpeakeasyClientSDK\Models\Shared;
use Speakeasy\SpeakeasyClientSDK\Utils;

$security = new Shared\Security(
    apiKey: '<YOUR_API_KEY_HERE>',
);

$sdk = SpeakeasyClientSDK\SDK::builder()->setSecurity($security)->build();

$request = new Operations\CreateWorkspaceTokenRequest(
    workspaceToken: new Shared\WorkspaceToken(
        alg: '<value>',
        createdAt: Utils\Utils::parseDateTime('2022-08-16T02:33:00.784Z'),
        id: '<id>',
        key: '<key>',
        name: '<value>',
        workspaceId: '<id>',
    ),
    workspaceId: '<id>',
);

$response = $sdk->workspaces->createToken(
    request: $request
);

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

Parameters

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

Response

?Operations\CreateWorkspaceTokenResponse

Errors

Error Type	Status Code	Content Type
Errorors\Error	4XX	application/json
Errorors\SDKException	5XX	*/*

deleteToken

Delete a token for a particular workspace

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use Speakeasy\SpeakeasyClientSDK;
use Speakeasy\SpeakeasyClientSDK\Models\Operations;
use Speakeasy\SpeakeasyClientSDK\Models\Shared;

$security = new Shared\Security(
    apiKey: '<YOUR_API_KEY_HERE>',
);

$sdk = SpeakeasyClientSDK\SDK::builder()->setSecurity($security)->build();

$request = new Operations\DeleteWorkspaceTokenRequest(
    tokenID: '<id>',
    workspaceId: '<id>',
);

$response = $sdk->workspaces->deleteToken(
    request: $request
);

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

Parameters

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

Response

?Operations\DeleteWorkspaceTokenResponse

Errors

Error Type	Status Code	Content Type
Errorors\Error	4XX	application/json
Errorors\SDKException	5XX	*/*

get

Get information about a particular workspace by context.

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use Speakeasy\SpeakeasyClientSDK;
use Speakeasy\SpeakeasyClientSDK\Models\Shared;

$security = new Shared\Security(
    apiKey: '<YOUR_API_KEY_HERE>',
);

$sdk = SpeakeasyClientSDK\SDK::builder()->setSecurity($security)->build();



$response = $sdk->workspaces->get(

);

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

Response

?Operations\GetWorkspaceByContextResponse

Errors

Error Type	Status Code	Content Type
Errorors\Error	4XX	application/json
Errorors\SDKException	5XX	*/*

getAll

Returns a list of workspaces a user has access too

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use Speakeasy\SpeakeasyClientSDK;
use Speakeasy\SpeakeasyClientSDK\Models\Shared;

$security = new Shared\Security(
    apiKey: '<YOUR_API_KEY_HERE>',
);

$sdk = SpeakeasyClientSDK\SDK::builder()->setSecurity($security)->build();



$response = $sdk->workspaces->getAll(

);

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

Response

?Operations\GetWorkspacesResponse

Errors

Error Type	Status Code	Content Type
Errorors\Error	4XX	application/json
Errorors\SDKException	5XX	*/*

getByID

Get information about a particular workspace.

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use Speakeasy\SpeakeasyClientSDK;
use Speakeasy\SpeakeasyClientSDK\Models\Operations;
use Speakeasy\SpeakeasyClientSDK\Models\Shared;

$security = new Shared\Security(
    apiKey: '<YOUR_API_KEY_HERE>',
);

$sdk = SpeakeasyClientSDK\SDK::builder()->setSecurity($security)->build();

$request = new Operations\GetWorkspaceRequest(
    workspaceId: '<id>',
);

$response = $sdk->workspaces->getByID(
    request: $request
);

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

Parameters

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

Response

?Operations\GetWorkspaceResponse

Errors

Error Type	Status Code	Content Type
Errorors\Error	4XX	application/json
Errorors\SDKException	5XX	*/*

getFeatureFlags

Get workspace feature flags

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use Speakeasy\SpeakeasyClientSDK;
use Speakeasy\SpeakeasyClientSDK\Models\Operations;
use Speakeasy\SpeakeasyClientSDK\Models\Shared;

$security = new Shared\Security(
    apiKey: '<YOUR_API_KEY_HERE>',
);

$sdk = SpeakeasyClientSDK\SDK::builder()->setSecurity($security)->build();

$request = new Operations\GetWorkspaceFeatureFlagsRequest(
    workspaceId: '<id>',
);

$response = $sdk->workspaces->getFeatureFlags(
    request: $request
);

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

Parameters

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

Response

?Operations\GetWorkspaceFeatureFlagsResponse

Errors

Error Type	Status Code	Content Type
Errorors\Error	5XX	application/json
Errorors\SDKException	4XX	*/*

getSettings

Get settings about a particular workspace.

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use Speakeasy\SpeakeasyClientSDK;
use Speakeasy\SpeakeasyClientSDK\Models\Operations;
use Speakeasy\SpeakeasyClientSDK\Models\Shared;

$security = new Shared\Security(
    apiKey: '<YOUR_API_KEY_HERE>',
);

$sdk = SpeakeasyClientSDK\SDK::builder()->setSecurity($security)->build();

$request = new Operations\GetWorkspaceSettingsRequest(
    workspaceId: '<id>',
);

$response = $sdk->workspaces->getSettings(
    request: $request
);

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

Parameters

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

Response

?Operations\GetWorkspaceSettingsResponse

Errors

Error Type	Status Code	Content Type
Errorors\Error	4XX	application/json
Errorors\SDKException	5XX	*/*

getTeam

Get team members for a particular workspace

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use Speakeasy\SpeakeasyClientSDK;
use Speakeasy\SpeakeasyClientSDK\Models\Operations;
use Speakeasy\SpeakeasyClientSDK\Models\Shared;

$security = new Shared\Security(
    apiKey: '<YOUR_API_KEY_HERE>',
);

$sdk = SpeakeasyClientSDK\SDK::builder()->setSecurity($security)->build();

$request = new Operations\GetWorkspaceTeamRequest(
    workspaceId: '<id>',
);

$response = $sdk->workspaces->getTeam(
    request: $request
);

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

Parameters

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

Response

?Operations\GetWorkspaceTeamResponse

Errors

Error Type	Status Code	Content Type
Errorors\Error	4XX	application/json
Errorors\SDKException	5XX	*/*

getTokens

Get tokens for a particular workspace

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use Speakeasy\SpeakeasyClientSDK;
use Speakeasy\SpeakeasyClientSDK\Models\Operations;
use Speakeasy\SpeakeasyClientSDK\Models\Shared;

$security = new Shared\Security(
    apiKey: '<YOUR_API_KEY_HERE>',
);

$sdk = SpeakeasyClientSDK\SDK::builder()->setSecurity($security)->build();

$request = new Operations\GetWorkspaceTokensRequest(
    workspaceId: '<id>',
);

$response = $sdk->workspaces->getTokens(
    request: $request
);

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

Parameters

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

Response

?Operations\GetWorkspaceTokensResponse

Errors

Error Type	Status Code	Content Type
Errorors\Error	4XX	application/json
Errorors\SDKException	5XX	*/*

grantAccess

Grant a user access to a particular workspace

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use Speakeasy\SpeakeasyClientSDK;
use Speakeasy\SpeakeasyClientSDK\Models\Operations;
use Speakeasy\SpeakeasyClientSDK\Models\Shared;

$security = new Shared\Security(
    apiKey: '<YOUR_API_KEY_HERE>',
);

$sdk = SpeakeasyClientSDK\SDK::builder()->setSecurity($security)->build();

$request = new Operations\GrantUserAccessToWorkspaceRequest(
    email: '[email protected]',
    workspaceId: '<id>',
);

$response = $sdk->workspaces->grantAccess(
    request: $request
);

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

Parameters

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

Response

?Operations\GrantUserAccessToWorkspaceResponse

Errors

Error Type	Status Code	Content Type
Errorors\Error	4XX	application/json
Errorors\SDKException	5XX	*/*

revokeAccess

Revoke a user's access to a particular workspace

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use Speakeasy\SpeakeasyClientSDK;
use Speakeasy\SpeakeasyClientSDK\Models\Operations;
use Speakeasy\SpeakeasyClientSDK\Models\Shared;

$security = new Shared\Security(
    apiKey: '<YOUR_API_KEY_HERE>',
);

$sdk = SpeakeasyClientSDK\SDK::builder()->setSecurity($security)->build();

$request = new Operations\RevokeUserAccessToWorkspaceRequest(
    userId: '<id>',
    workspaceId: '<id>',
);

$response = $sdk->workspaces->revokeAccess(
    request: $request
);

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

Parameters

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

Response

?Operations\RevokeUserAccessToWorkspaceResponse

Errors

Error Type	Status Code	Content Type
Errorors\Error	4XX	application/json
Errorors\SDKException	5XX	*/*

update

Update information about a particular workspace.

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use Speakeasy\SpeakeasyClientSDK;
use Speakeasy\SpeakeasyClientSDK\Models\Operations;
use Speakeasy\SpeakeasyClientSDK\Models\Shared;
use Speakeasy\SpeakeasyClientSDK\Utils;

$security = new Shared\Security(
    apiKey: '<YOUR_API_KEY_HERE>',
);

$sdk = SpeakeasyClientSDK\SDK::builder()->setSecurity($security)->build();

$request = new Operations\UpdateWorkspaceDetailsRequest(
    workspace: new Shared\Workspace(
        createdAt: Utils\Utils::parseDateTime('2024-07-28T19:04:48.565Z'),
        id: '<id>',
        name: '<value>',
        organizationId: '<id>',
        slug: '<value>',
        updatedAt: Utils\Utils::parseDateTime('2023-10-17T10:52:42.015Z'),
        verified: false,
    ),
    workspaceId: '<id>',
);

$response = $sdk->workspaces->update(
    request: $request
);

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

Parameters

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

Response

?Operations\UpdateWorkspaceDetailsResponse

Errors

Error Type	Status Code	Content Type
Errorors\Error	4XX	application/json
Errorors\SDKException	5XX	*/*

updateSettings

Update settings about a particular workspace.

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use Speakeasy\SpeakeasyClientSDK;
use Speakeasy\SpeakeasyClientSDK\Models\Operations;
use Speakeasy\SpeakeasyClientSDK\Models\Shared;
use Speakeasy\SpeakeasyClientSDK\Utils;

$security = new Shared\Security(
    apiKey: '<YOUR_API_KEY_HERE>',
);

$sdk = SpeakeasyClientSDK\SDK::builder()->setSecurity($security)->build();

$request = new Operations\UpdateWorkspaceSettingsRequest(
    workspaceSettings: new Shared\WorkspaceSettings(
        createdAt: Utils\Utils::parseDateTime('2022-07-05T11:43:28.305Z'),
        updatedAt: Utils\Utils::parseDateTime('2023-05-15T05:39:21.874Z'),
        webhookUrl: 'https://grown-pharmacopoeia.net',
        workspaceId: '<id>',
    ),
    workspaceId: '<id>',
);

$response = $sdk->workspaces->updateSettings(
    request: $request
);

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

Parameters

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

Response

?Operations\UpdateWorkspaceSettingsResponse

Errors

Error Type	Status Code	Content Type
Errorors\Error	4XX	application/json
Errorors\SDKException	5XX	*/*