README.md

Workspaces

(workspaces())

Overview

REST APIs for managing Workspaces (speakeasy tenancy)

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
• setFeatureFlags - Set workspace feature flags
• update - Update workspace details
• updateSettings - Update workspace settings

create

Creates a workspace

Example Usage

package hello.world;

import dev.speakeasyapi.javaclientsdk.RyanTest;
import dev.speakeasyapi.javaclientsdk.models.errors.Error;
import dev.speakeasyapi.javaclientsdk.models.operations.CreateWorkspaceResponse;
import dev.speakeasyapi.javaclientsdk.models.shared.Security;
import dev.speakeasyapi.javaclientsdk.models.shared.Workspace;
import java.lang.Exception;
import java.time.OffsetDateTime;

public class Application {

    public static void main(String[] args) throws Error, Exception {

        RyanTest sdk = RyanTest.builder()
                .security(Security.builder()
                    .apiKey("<YOUR_API_KEY_HERE>")
                    .build())
            .build();

        Workspace req = Workspace.builder()
                .createdAt(OffsetDateTime.parse("2023-06-18T07:14:55.338Z"))
                .id("<id>")
                .name("<value>")
                .organizationId("<id>")
                .slug("<value>")
                .updatedAt(OffsetDateTime.parse("2023-12-01T17:06:07.804Z"))
                .verified(true)
                .build();

        CreateWorkspaceResponse res = sdk.workspaces().create()
                .request(req)
                .call();

        if (res.workspace().isPresent()) {
            // handle response
        }
    }
}

Parameters

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

Response

CreateWorkspaceResponse

Errors

Error Type	Status Code	Content Type
models/errors/Error	4XX	application/json
models/errors/SDKError	5XX	*/*

createToken

Create a token for a particular workspace

Example Usage

package hello.world;

import dev.speakeasyapi.javaclientsdk.RyanTest;
import dev.speakeasyapi.javaclientsdk.models.errors.Error;
import dev.speakeasyapi.javaclientsdk.models.operations.CreateWorkspaceTokenRequest;
import dev.speakeasyapi.javaclientsdk.models.operations.CreateWorkspaceTokenResponse;
import dev.speakeasyapi.javaclientsdk.models.shared.Security;
import dev.speakeasyapi.javaclientsdk.models.shared.WorkspaceToken;
import java.lang.Exception;
import java.time.OffsetDateTime;

public class Application {

    public static void main(String[] args) throws Error, Exception {

        RyanTest sdk = RyanTest.builder()
                .security(Security.builder()
                    .apiKey("<YOUR_API_KEY_HERE>")
                    .build())
            .build();

        CreateWorkspaceTokenRequest req = CreateWorkspaceTokenRequest.builder()
                .workspaceToken(WorkspaceToken.builder()
                    .alg("<value>")
                    .createdAt(OffsetDateTime.parse("2022-08-16T02:33:00.784Z"))
                    .id("<id>")
                    .key("<key>")
                    .name("<value>")
                    .workspaceId("<id>")
                    .build())
                .workspaceId("<id>")
                .build();

        CreateWorkspaceTokenResponse res = sdk.workspaces().createToken()
                .request(req)
                .call();

        // handle response
    }
}

Parameters

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

Response

CreateWorkspaceTokenResponse

Errors

Error Type	Status Code	Content Type
models/errors/Error	4XX	application/json
models/errors/SDKError	5XX	*/*

deleteToken

Delete a token for a particular workspace

Example Usage

package hello.world;

import dev.speakeasyapi.javaclientsdk.RyanTest;
import dev.speakeasyapi.javaclientsdk.models.errors.Error;
import dev.speakeasyapi.javaclientsdk.models.operations.DeleteWorkspaceTokenRequest;
import dev.speakeasyapi.javaclientsdk.models.operations.DeleteWorkspaceTokenResponse;
import dev.speakeasyapi.javaclientsdk.models.shared.Security;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws Error, Exception {

        RyanTest sdk = RyanTest.builder()
                .security(Security.builder()
                    .apiKey("<YOUR_API_KEY_HERE>")
                    .build())
            .build();

        DeleteWorkspaceTokenRequest req = DeleteWorkspaceTokenRequest.builder()
                .tokenID("<id>")
                .workspaceId("<id>")
                .build();

        DeleteWorkspaceTokenResponse res = sdk.workspaces().deleteToken()
                .request(req)
                .call();

        // handle response
    }
}

Parameters

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

Response

DeleteWorkspaceTokenResponse

Errors

Error Type	Status Code	Content Type
models/errors/Error	4XX	application/json
models/errors/SDKError	5XX	*/*

get

Get information about a particular workspace by context.

Example Usage

package hello.world;

import dev.speakeasyapi.javaclientsdk.RyanTest;
import dev.speakeasyapi.javaclientsdk.models.errors.Error;
import dev.speakeasyapi.javaclientsdk.models.operations.GetWorkspaceByContextResponse;
import dev.speakeasyapi.javaclientsdk.models.shared.Security;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws Error, Exception {

        RyanTest sdk = RyanTest.builder()
                .security(Security.builder()
                    .apiKey("<YOUR_API_KEY_HERE>")
                    .build())
            .build();

        GetWorkspaceByContextResponse res = sdk.workspaces().get()
                .call();

        if (res.workspaceAndOrganization().isPresent()) {
            // handle response
        }
    }
}

Response

GetWorkspaceByContextResponse

Errors

Error Type	Status Code	Content Type
models/errors/Error	4XX	application/json
models/errors/SDKError	5XX	*/*

getAll

Returns a list of workspaces a user has access too

Example Usage

package hello.world;

import dev.speakeasyapi.javaclientsdk.RyanTest;
import dev.speakeasyapi.javaclientsdk.models.errors.Error;
import dev.speakeasyapi.javaclientsdk.models.operations.GetWorkspacesResponse;
import dev.speakeasyapi.javaclientsdk.models.shared.Security;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws Error, Exception {

        RyanTest sdk = RyanTest.builder()
                .security(Security.builder()
                    .apiKey("<YOUR_API_KEY_HERE>")
                    .build())
            .build();

        GetWorkspacesResponse res = sdk.workspaces().getAll()
                .call();

        if (res.workspaces().isPresent()) {
            // handle response
        }
    }
}

Response

GetWorkspacesResponse

Errors

Error Type	Status Code	Content Type
models/errors/Error	4XX	application/json
models/errors/SDKError	5XX	*/*

getByID

Get information about a particular workspace.

Example Usage

package hello.world;

import dev.speakeasyapi.javaclientsdk.RyanTest;
import dev.speakeasyapi.javaclientsdk.models.errors.Error;
import dev.speakeasyapi.javaclientsdk.models.operations.GetWorkspaceRequest;
import dev.speakeasyapi.javaclientsdk.models.operations.GetWorkspaceResponse;
import dev.speakeasyapi.javaclientsdk.models.shared.Security;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws Error, Exception {

        RyanTest sdk = RyanTest.builder()
                .security(Security.builder()
                    .apiKey("<YOUR_API_KEY_HERE>")
                    .build())
            .build();

        GetWorkspaceRequest req = GetWorkspaceRequest.builder()
                .workspaceId("<id>")
                .build();

        GetWorkspaceResponse res = sdk.workspaces().getByID()
                .request(req)
                .call();

        if (res.workspace().isPresent()) {
            // handle response
        }
    }
}

Parameters

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

Response

GetWorkspaceResponse

Errors

Error Type	Status Code	Content Type
models/errors/Error	4XX	application/json
models/errors/SDKError	5XX	*/*

getFeatureFlags

Get workspace feature flags

Example Usage

package hello.world;

import dev.speakeasyapi.javaclientsdk.RyanTest;
import dev.speakeasyapi.javaclientsdk.models.errors.Error;
import dev.speakeasyapi.javaclientsdk.models.operations.GetWorkspaceFeatureFlagsRequest;
import dev.speakeasyapi.javaclientsdk.models.operations.GetWorkspaceFeatureFlagsResponse;
import dev.speakeasyapi.javaclientsdk.models.shared.Security;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws Error, Exception {

        RyanTest sdk = RyanTest.builder()
                .security(Security.builder()
                    .apiKey("<YOUR_API_KEY_HERE>")
                    .build())
            .build();

        GetWorkspaceFeatureFlagsRequest req = GetWorkspaceFeatureFlagsRequest.builder()
                .workspaceId("<id>")
                .build();

        GetWorkspaceFeatureFlagsResponse res = sdk.workspaces().getFeatureFlags()
                .request(req)
                .call();

        if (res.workspaceFeatureFlagResponse().isPresent()) {
            // handle response
        }
    }
}

Parameters

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

Response

GetWorkspaceFeatureFlagsResponse

Errors

Error Type	Status Code	Content Type
models/errors/Error	5XX	application/json
models/errors/SDKError	4XX	*/*

getSettings

Get settings about a particular workspace.

Example Usage

package hello.world;

import dev.speakeasyapi.javaclientsdk.RyanTest;
import dev.speakeasyapi.javaclientsdk.models.errors.Error;
import dev.speakeasyapi.javaclientsdk.models.operations.GetWorkspaceSettingsRequest;
import dev.speakeasyapi.javaclientsdk.models.operations.GetWorkspaceSettingsResponse;
import dev.speakeasyapi.javaclientsdk.models.shared.Security;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws Error, Exception {

        RyanTest sdk = RyanTest.builder()
                .security(Security.builder()
                    .apiKey("<YOUR_API_KEY_HERE>")
                    .build())
            .build();

        GetWorkspaceSettingsRequest req = GetWorkspaceSettingsRequest.builder()
                .workspaceId("<id>")
                .build();

        GetWorkspaceSettingsResponse res = sdk.workspaces().getSettings()
                .request(req)
                .call();

        if (res.workspaceSettings().isPresent()) {
            // handle response
        }
    }
}

Parameters

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

Response

GetWorkspaceSettingsResponse

Errors

Error Type	Status Code	Content Type
models/errors/Error	4XX	application/json
models/errors/SDKError	5XX	*/*

getTeam

Get team members for a particular workspace

Example Usage

package hello.world;

import dev.speakeasyapi.javaclientsdk.RyanTest;
import dev.speakeasyapi.javaclientsdk.models.errors.Error;
import dev.speakeasyapi.javaclientsdk.models.operations.GetWorkspaceTeamRequest;
import dev.speakeasyapi.javaclientsdk.models.operations.GetWorkspaceTeamResponse;
import dev.speakeasyapi.javaclientsdk.models.shared.Security;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws Error, Exception {

        RyanTest sdk = RyanTest.builder()
                .security(Security.builder()
                    .apiKey("<YOUR_API_KEY_HERE>")
                    .build())
            .build();

        GetWorkspaceTeamRequest req = GetWorkspaceTeamRequest.builder()
                .workspaceId("<id>")
                .build();

        GetWorkspaceTeamResponse res = sdk.workspaces().getTeam()
                .request(req)
                .call();

        if (res.workspaceTeamResponse().isPresent()) {
            // handle response
        }
    }
}

Parameters

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

Response

GetWorkspaceTeamResponse

Errors

Error Type	Status Code	Content Type
models/errors/Error	4XX	application/json
models/errors/SDKError	5XX	*/*

getTokens

Get tokens for a particular workspace

Example Usage

package hello.world;

import dev.speakeasyapi.javaclientsdk.RyanTest;
import dev.speakeasyapi.javaclientsdk.models.errors.Error;
import dev.speakeasyapi.javaclientsdk.models.operations.GetWorkspaceTokensRequest;
import dev.speakeasyapi.javaclientsdk.models.operations.GetWorkspaceTokensResponse;
import dev.speakeasyapi.javaclientsdk.models.shared.Security;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws Error, Exception {

        RyanTest sdk = RyanTest.builder()
                .security(Security.builder()
                    .apiKey("<YOUR_API_KEY_HERE>")
                    .build())
            .build();

        GetWorkspaceTokensRequest req = GetWorkspaceTokensRequest.builder()
                .workspaceId("<id>")
                .build();

        GetWorkspaceTokensResponse res = sdk.workspaces().getTokens()
                .request(req)
                .call();

        if (res.classes().isPresent()) {
            // handle response
        }
    }
}

Parameters

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

Response

GetWorkspaceTokensResponse

Errors

Error Type	Status Code	Content Type
models/errors/Error	4XX	application/json
models/errors/SDKError	5XX	*/*

grantAccess

Grant a user access to a particular workspace

Example Usage

package hello.world;

import dev.speakeasyapi.javaclientsdk.RyanTest;
import dev.speakeasyapi.javaclientsdk.models.errors.Error;
import dev.speakeasyapi.javaclientsdk.models.operations.GrantUserAccessToWorkspaceRequest;
import dev.speakeasyapi.javaclientsdk.models.operations.GrantUserAccessToWorkspaceResponse;
import dev.speakeasyapi.javaclientsdk.models.shared.Security;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws Error, Exception {

        RyanTest sdk = RyanTest.builder()
                .security(Security.builder()
                    .apiKey("<YOUR_API_KEY_HERE>")
                    .build())
            .build();

        GrantUserAccessToWorkspaceRequest req = GrantUserAccessToWorkspaceRequest.builder()
                .email("[email protected]")
                .workspaceId("<id>")
                .build();

        GrantUserAccessToWorkspaceResponse res = sdk.workspaces().grantAccess()
                .request(req)
                .call();

        if (res.workspaceInviteResponse().isPresent()) {
            // handle response
        }
    }
}

Parameters

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

Response

GrantUserAccessToWorkspaceResponse

Errors

Error Type	Status Code	Content Type
models/errors/Error	4XX	application/json
models/errors/SDKError	5XX	*/*

revokeAccess

Revoke a user's access to a particular workspace

Example Usage

package hello.world;

import dev.speakeasyapi.javaclientsdk.RyanTest;
import dev.speakeasyapi.javaclientsdk.models.errors.Error;
import dev.speakeasyapi.javaclientsdk.models.operations.RevokeUserAccessToWorkspaceRequest;
import dev.speakeasyapi.javaclientsdk.models.operations.RevokeUserAccessToWorkspaceResponse;
import dev.speakeasyapi.javaclientsdk.models.shared.Security;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws Error, Exception {

        RyanTest sdk = RyanTest.builder()
                .security(Security.builder()
                    .apiKey("<YOUR_API_KEY_HERE>")
                    .build())
            .build();

        RevokeUserAccessToWorkspaceRequest req = RevokeUserAccessToWorkspaceRequest.builder()
                .userId("<id>")
                .workspaceId("<id>")
                .build();

        RevokeUserAccessToWorkspaceResponse res = sdk.workspaces().revokeAccess()
                .request(req)
                .call();

        // handle response
    }
}

Parameters

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

Response

RevokeUserAccessToWorkspaceResponse

Errors

Error Type	Status Code	Content Type
models/errors/Error	4XX	application/json
models/errors/SDKError	5XX	*/*

setFeatureFlags

Set workspace feature flags

Example Usage

package hello.world;

import dev.speakeasyapi.javaclientsdk.RyanTest;
import dev.speakeasyapi.javaclientsdk.models.errors.Error;
import dev.speakeasyapi.javaclientsdk.models.operations.SetWorkspaceFeatureFlagsResponse;
import dev.speakeasyapi.javaclientsdk.models.shared.Security;
import dev.speakeasyapi.javaclientsdk.models.shared.WorkspaceFeatureFlag;
import dev.speakeasyapi.javaclientsdk.models.shared.WorkspaceFeatureFlagRequest;
import java.lang.Exception;
import java.util.List;

public class Application {

    public static void main(String[] args) throws Error, Exception {

        RyanTest sdk = RyanTest.builder()
                .security(Security.builder()
                    .apiKey("<YOUR_API_KEY_HERE>")
                    .build())
            .build();

        WorkspaceFeatureFlagRequest req = WorkspaceFeatureFlagRequest.builder()
                .featureFlags(List.of(
                    WorkspaceFeatureFlag.SKIP_SCHEMA_REGISTRY,
                    WorkspaceFeatureFlag.WEBHOOKS))
                .build();

        SetWorkspaceFeatureFlagsResponse res = sdk.workspaces().setFeatureFlags()
                .request(req)
                .call();

        if (res.workspaceFeatureFlagResponse().isPresent()) {
            // handle response
        }
    }
}

Parameters

Parameter	Type	Required	Description
request	WorkspaceFeatureFlagRequest	✔️	The request object to use for the request.

Response

SetWorkspaceFeatureFlagsResponse

Errors

Error Type	Status Code	Content Type
models/errors/Error	5XX	application/json
models/errors/SDKError	4XX	*/*

update

Update information about a particular workspace.

Example Usage

package hello.world;

import dev.speakeasyapi.javaclientsdk.RyanTest;
import dev.speakeasyapi.javaclientsdk.models.errors.Error;
import dev.speakeasyapi.javaclientsdk.models.operations.UpdateWorkspaceDetailsRequest;
import dev.speakeasyapi.javaclientsdk.models.operations.UpdateWorkspaceDetailsResponse;
import dev.speakeasyapi.javaclientsdk.models.shared.Security;
import dev.speakeasyapi.javaclientsdk.models.shared.Workspace;
import java.lang.Exception;
import java.time.OffsetDateTime;

public class Application {

    public static void main(String[] args) throws Error, Exception {

        RyanTest sdk = RyanTest.builder()
                .security(Security.builder()
                    .apiKey("<YOUR_API_KEY_HERE>")
                    .build())
            .build();

        UpdateWorkspaceDetailsRequest req = UpdateWorkspaceDetailsRequest.builder()
                .workspace(Workspace.builder()
                    .createdAt(OffsetDateTime.parse("2024-07-28T19:04:48.565Z"))
                    .id("<id>")
                    .name("<value>")
                    .organizationId("<id>")
                    .slug("<value>")
                    .updatedAt(OffsetDateTime.parse("2023-10-17T10:52:42.015Z"))
                    .verified(true)
                    .build())
                .workspaceId("<id>")
                .build();

        UpdateWorkspaceDetailsResponse res = sdk.workspaces().update()
                .request(req)
                .call();

        // handle response
    }
}

Parameters

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

Response

UpdateWorkspaceDetailsResponse

Errors

Error Type	Status Code	Content Type
models/errors/Error	4XX	application/json
models/errors/SDKError	5XX	*/*

updateSettings

Update settings about a particular workspace.

Example Usage

package hello.world;

import dev.speakeasyapi.javaclientsdk.RyanTest;
import dev.speakeasyapi.javaclientsdk.models.errors.Error;
import dev.speakeasyapi.javaclientsdk.models.operations.UpdateWorkspaceSettingsRequest;
import dev.speakeasyapi.javaclientsdk.models.operations.UpdateWorkspaceSettingsResponse;
import dev.speakeasyapi.javaclientsdk.models.shared.Security;
import dev.speakeasyapi.javaclientsdk.models.shared.WorkspaceSettings;
import java.lang.Exception;
import java.time.OffsetDateTime;

public class Application {

    public static void main(String[] args) throws Error, Exception {

        RyanTest sdk = RyanTest.builder()
                .security(Security.builder()
                    .apiKey("<YOUR_API_KEY_HERE>")
                    .build())
            .build();

        UpdateWorkspaceSettingsRequest req = UpdateWorkspaceSettingsRequest.builder()
                .workspaceSettings(WorkspaceSettings.builder()
                    .createdAt(OffsetDateTime.parse("2022-07-05T11:43:28.305Z"))
                    .updatedAt(OffsetDateTime.parse("2023-05-15T05:39:21.874Z"))
                    .webhookUrl("https://grown-pharmacopoeia.net")
                    .workspaceId("<id>")
                    .build())
                .workspaceId("<id>")
                .build();

        UpdateWorkspaceSettingsResponse res = sdk.workspaces().updateSettings()
                .request(req)
                .call();

        // handle response
    }
}

Parameters

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

Response

UpdateWorkspaceSettingsResponse

Errors

Error Type	Status Code	Content Type
models/errors/Error	4XX	application/json
models/errors/SDKError	5XX	*/*