Skip to main content

SandboxWorkspaceService

nominal_api::endpoints::scout::sandbox::api

Trait SandboxWorkspaceService 

Source 
pub trait SandboxWorkspaceService {
    // Required methods
    fn get_demo_workbooks(
        &self,
        auth_: BearerToken,
        workspace_rid: WorkspaceRid,
    ) -> Result<GetDemoWorkbooksResponse, Error>;
    fn set_demo_workbooks(
        &self,
        auth_: BearerToken,
        workspace_rid: WorkspaceRid,
        request: SetDemoWorkbooksRequest,
    ) -> Result<(), Error>;
    fn add_demo_workbooks(
        &self,
        auth_: BearerToken,
        workspace_rid: WorkspaceRid,
        request: AddDemoWorkbooksRequest,
    ) -> Result<(), Error>;
}
Expand description

Service for managing demo workbooks in sandbox workspaces. All endpoints validate that the provided workspace has the human-readable ID “sandbox”.

Required Methods§

Source

fn get_demo_workbooks( &self, auth_: BearerToken, workspace_rid: WorkspaceRid, ) -> Result<GetDemoWorkbooksResponse, Error>

Returns the list of demo workbook RIDs for the given sandbox workspace.

Source

fn set_demo_workbooks( &self, auth_: BearerToken, workspace_rid: WorkspaceRid, request: SetDemoWorkbooksRequest, ) -> Result<(), Error>

Sets the list of demo workbook RIDs for the given sandbox workspace, replacing any existing entries.

Source

fn add_demo_workbooks( &self, auth_: BearerToken, workspace_rid: WorkspaceRid, request: AddDemoWorkbooksRequest, ) -> Result<(), Error>

Appends workbooks to the existing demo workbook list. If archiveOnLabelConflict is true, existing workbooks with an exact label-set match are archived instead of raising an error. Partial (subset/superset) conflicts always raise an error.

Implementors§