Studio

SDK reference for studio — Manage Studio sessions and inspect project workspaces.

Manage Studio sessions and inspect project workspaces.

workspace

POST

Usage:

const result = await swirls.client.studio.workspace({
  organizationId: '...',
})

Input:

Parameter	Type	Required	Description
`organizationId`	`string`	Yes

Output:

Field	Type	Description
`clients`	`object[]`
`applications`	`object[]`
`requests`	`object[]`

createClient

POST

Usage:

const result = await swirls.client.studio.createClient({
  organizationId: '...',
  id: '...',
  data: {},
})

Input:

Parameter	Type	Required
`organizationId`	`string`	Yes
`id`	`string`	Yes
`data`	`object`	Yes

Output:

Field	Type	Description
`name`	`string`
`contactName`	`string`
`contactEmail`	`"" \| string`
`notes`	`string`
`id`	`string`
`orgId`	`string`
`userId`	`string`
`createdAt`	`unknown`
`updatedAt`	`unknown`
`revision`	`number`

updateClient

POST

Usage:

const result = await swirls.client.studio.updateClient({
  organizationId: '...',
  id: '...',
  revision: 1,
  data: {},
})

Input:

Parameter	Type	Required
`organizationId`	`string`	Yes
`id`	`string`	Yes
`revision`	`number`	Yes
`data`	`object`	Yes

Output:

Field	Type	Description
`name`	`string`
`contactName`	`string`
`contactEmail`	`"" \| string`
`notes`	`string`
`id`	`string`
`orgId`	`string`
`userId`	`string`
`createdAt`	`unknown`
`updatedAt`	`unknown`
`revision`	`number`

createApplication

POST

Usage:

const result = await swirls.client.studio.createApplication({
  organizationId: '...',
  id: '...',
  data: {},
})

Input:

Parameter	Type	Required
`organizationId`	`string`	Yes
`id`	`string`	Yes
`data`	`object`	Yes

Output:

Field	Type	Description
`name`	`string`
`clientId`	`string \| null`
`description`	`string`
`stage`	`"planning" \| "building" \| "review" \| "live" \| "archived"`
`kitId`	`"client-onboarding" \| "change-orders" \| "service-desk" \| "sales-handoff" \| "internal-knowledge" \| "custom-application"`
`brief`	`object`
`repositoryUrl`	`"" \| string`
`liveUrl`	`"" \| string`
`id`	`string`
`orgId`	`string`
`userId`	`string`
`createdAt`	`unknown`
`updatedAt`	`unknown`
`revision`	`number`

updateApplication

POST

Usage:

const result = await swirls.client.studio.updateApplication({
  organizationId: '...',
  id: '...',
  revision: 1,
  data: {},
})

Input:

Parameter	Type	Required
`organizationId`	`string`	Yes
`id`	`string`	Yes
`revision`	`number`	Yes
`data`	`object`	Yes

Output:

Field	Type	Description
`name`	`string`
`clientId`	`string \| null`
`description`	`string`
`stage`	`"planning" \| "building" \| "review" \| "live" \| "archived"`
`kitId`	`"client-onboarding" \| "change-orders" \| "service-desk" \| "sales-handoff" \| "internal-knowledge" \| "custom-application"`
`brief`	`object`
`repositoryUrl`	`"" \| string`
`liveUrl`	`"" \| string`
`id`	`string`
`orgId`	`string`
`userId`	`string`
`createdAt`	`unknown`
`updatedAt`	`unknown`
`revision`	`number`

requestHelp

POST

Usage:

const result = await swirls.client.studio.requestHelp({
  organizationId: '...',
  id: '...',
  applicationId: '...',
  kind: '...',
  title: '...',
  details: '...',
})

Input:

Parameter	Type	Required
`organizationId`	`string`	Yes
`id`	`string`	Yes
`applicationId`	`string`	Yes
`kind`	`"engineering" \| "launch" \| "operations"`	Yes
`title`	`string`	Yes
`details`	`string`	Yes

Output:

Field	Type	Description
`id`	`string`
`orgId`	`string`
`userId`	`string`
`createdAt`	`unknown`
`updatedAt`	`unknown`
`revision`	`number`
`applicationId`	`string`
`kind`	`"engineering" \| "launch" \| "operations"`
`title`	`string`
`details`	`string`
`status`	`"submitted" \| "reviewing" \| "scheduled" \| "in_progress" \| "completed" \| "cancelled"`
`assignedTo`	`string \| null`

cancelRequest

POST

Usage:

const result = await swirls.client.studio.cancelRequest({
  organizationId: '...',
  id: '...',
  revision: 1,
})

Input:

Parameter	Type	Required
`organizationId`	`string`	Yes
`id`	`string`	Yes
`revision`	`number`	Yes

Output:

Field	Type	Description
`id`	`string`
`orgId`	`string`
`userId`	`string`
`createdAt`	`unknown`
`updatedAt`	`unknown`
`revision`	`number`
`applicationId`	`string`
`kind`	`"engineering" \| "launch" \| "operations"`
`title`	`string`
`details`	`string`
`status`	`"submitted" \| "reviewing" \| "scheduled" \| "in_progress" \| "completed" \| "cancelled"`
`assignedTo`	`string \| null`

workspace

createClient

updateClient

createApplication

updateApplication

requestHelp

cancelRequest

On this page