README.md

Workspaces

(workspaces)

Overview

Available Operations

• get - Retrieve a workspace
• update - Update a workspace

get

Retrieve a workspace for the authenticated user.

Example Usage

require 'dub'


s = ::OpenApiSDK::Dub.new
s.config_security(
  ::OpenApiSDK::Shared::Security.new(
    token: "DUB_API_KEY",
  )
)


req = ::OpenApiSDK::Operations::GetWorkspaceRequest.new(
  id_or_slug: "<value>",
)
    
res = s.workspaces.get(req)

if ! res.workspace_schema.nil?
  # handle response
end

Parameters

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

Response

T.nilable(::OpenApiSDK::Operations::GetWorkspaceResponse)

update

Update a workspace by ID or slug.

Example Usage

require 'dub'


s = ::OpenApiSDK::Dub.new
s.config_security(
  ::OpenApiSDK::Shared::Security.new(
    token: "DUB_API_KEY",
  )
)

    
res = s.workspaces.update(id_or_slug="<value>", request_body=::OpenApiSDK::Operations::UpdateWorkspaceRequestBody.new())

if ! res.workspace_schema.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
id_or_slug	::String	✔️	The ID or slug of the workspace to update.
request_body	T.nilable(::OpenApiSDK::Operations::UpdateWorkspaceRequestBody)	➖	N/A

Response

T.nilable(::OpenApiSDK::Operations::UpdateWorkspaceResponse)