Struct Workspace

Source

pub struct Workspace {
    pub id: String,
    pub name: String,
    pub created_at: String,
    pub archived_at: Option<String>,
    pub display_color: String,
    pub workspace_type: String,
}

Expand description

A workspace available through the Anthropic Admin API.

Fields§

§id: String

Unique workspace identifier

§name: String

Name of the workspace

§created_at: String

RFC 3339 datetime string representing the time at which the workspace was created

§archived_at: Option<String>

RFC 3339 datetime string indicating when the workspace was archived, or null if the workspace is not archived

§display_color: String

Hex color code representing the workspace in the Anthropic Console

§workspace_type: String

Object type (always “workspace” for Workspaces)

Implementations§

Source §

impl Workspace

Source

pub fn builder(workspace_id: impl Into<String>) -> WorkspaceBuilder

Creates a builder for getting a specific workspace.

§Example

let credentials = Credentials::from_env();

let workspace = Workspace::builder("workspace_123456789")
    .credentials(credentials)
    .create()
    .await?;

Source

pub async fn create(request: WorkspaceRequest) -> ApiResponseOrError<Self>

Gets information about a specific workspace.

§Example

let credentials = Credentials::from_env();
let request = WorkspaceRequest {
    workspace_id: "workspace_123456789".to_string(),
    credentials: Some(credentials),
};

let workspace = Workspace::create(request).await?;

Source

pub fn create_builder() -> WorkspaceCreateBuilder

Creates a builder for creating a new workspace.

§Example

let credentials = Credentials::from_env();

let new_workspace = Workspace::create_builder()
    .credentials(credentials)
    .name("My New Workspace")
    .create()
    .await?;

Source

pub async fn create_new( request: WorkspaceCreateRequest, ) -> ApiResponseOrError<Self>

Creates a new workspace with the given request parameters.

§Example

let credentials = Credentials::from_env();
let request = WorkspaceCreateRequest {
    name: "My New Workspace".to_string(),
    credentials: Some(credentials),
};

let new_workspace = Workspace::create_new(request).await?;

Source

pub fn update_builder(workspace_id: impl Into<String>) -> WorkspaceUpdateBuilder

Creates a builder for updating a workspace.

§Example

let credentials = Credentials::from_env();

let updated_workspace = Workspace::update_builder("workspace_123456789")
    .credentials(credentials)
    .name("Updated Workspace Name")
    .create()
    .await?;

Source

pub async fn update(request: WorkspaceUpdateRequest) -> ApiResponseOrError<Self>

Updates a workspace with the given request parameters.

§Example

let credentials = Credentials::from_env();
let request = WorkspaceUpdateRequest {
    workspace_id: "workspace_123456789".to_string(),
    name: "Updated Workspace Name".to_string(),
    credentials: Some(credentials),
};

let updated_workspace = Workspace::update(request).await?;

Source

pub fn archive_builder( workspace_id: impl Into<String>, ) -> WorkspaceArchiveBuilder

Creates a builder for archiving a workspace.

§Example

let credentials = Credentials::from_env();

let archived_workspace = Workspace::archive_builder("workspace_123456789")
    .credentials(credentials)
    .create()
    .await?;

Source

pub async fn archive( request: WorkspaceArchiveRequest, ) -> ApiResponseOrError<Self>

Archives a workspace with the given request parameters.

§Example

let credentials = Credentials::from_env();
let request = WorkspaceArchiveRequest {
    workspace_id: "workspace_123456789".to_string(),
    credentials: Some(credentials),
};

let archived_workspace = Workspace::archive(request).await?;