Class: GravityRailClient

Defined in: packages/sdk/src/client/client.ts:98

GravityRailClient provides a unified interface to all public Gravity Rail API endpoints.

Methods are organized by domain and bound to their respective API modules. See the bindings directory for the organization of methods by domain.

This class excludes admin/superuser methods. The full client including admin functionality (ApiClient) lives in the private @gravity-rail/client package and extends this class.

Implements

• TasksBindings
• ChatsBindings
• CallsBindings
• DataTypesBindings
• DevicesBindings
• MembersBindings
• WorkspacesBindings
• AuthBindings
• SitesBindings
• FilesBindings
• ProjectsBindings
• EventsBindings
• ExperimentsBindings
• WorkflowsBindings
• CalendarsBindings
• CommunicationsBindings
• ToolkitsBindings
• BillingBindings
• AppsBindings
• IntegrationsBindings
• AgentTasksBindings
• AgentsBindings
• PronunciationsBindings
• QualificationsBindings
• PersonasBindings
• QueriesBindings
• CustomersBindings
• ResellersBindings
• DashboardsBindings
• ActivityBindings
• MotdBindings
• TrackedLinksBindings
• JourneysBindings
• OperatorBindings
• OrgBindings
• AccessGrantsBindings
• InterventionRequestsBindings
• PromptsBindings
• SupportRequestsBindings

Constructors

Constructor

new GravityRailClient(apiKey, baseUrl, customFetch?): GravityRailClient

Defined in: packages/sdk/src/client/client.ts:1306

Parameters

apiKey

string | undefined

baseUrl

string

customFetch?

{(input, init?): Promise<Response>; (input, init?): Promise<Response>; }

Returns

GravityRailClient

Properties

acceptInvitation()

acceptInvitation: (requestId) => Promise<InvitationResponse>

Defined in: packages/sdk/src/client/client.ts:642

Accept an invitation by ID (for invitees accepting their own invitations) Works for both organization and workspace invitations.

Parameters

requestId

number

Returns

Promise<InvitationResponse>

Implementation of

WorkspacesBindings.acceptInvitation

---

activateWorkflowRevision()

activateWorkflowRevision: (wid, workflowId, revisionId, data) => Promise<WorkflowRevisionSummaryResponse>

Defined in: packages/sdk/src/client/client.ts:852

Point the workflow's active pointer at a chosen revision (pointer flip only).

The target may be any of the workflow's published revisions. Activating the draft requires allowDraft: true and a UI warning confirmation.

Parameters

wid

string

workflowId

string | number

revisionId

string | number

data?

ActivateWorkflowRevisionRequest = {}

Returns

Promise<WorkflowRevisionSummaryResponse>

Implementation of

WorkflowsBindings.activateWorkflowRevision

---

addEmailSenderAsMember()

addEmailSenderAsMember: (wid, inboxId, emailId, body) => Promise<WorkspaceMemberResponse>

Defined in: packages/sdk/src/client/client.ts:931

Make a stored email's sender a Member of this workspace.

The explicit alternative to auto-signup for inboxes that accept non-member mail. Requires members:write AND inboxes:read. Responds 409 when a Member already holds the address — gate the call on Email.senderIsMember rather than discovering it from the error.

Parameters

wid

string

inboxId

number

emailId

number

body

AddEmailSenderAsMemberRequest

Returns

Promise<WorkspaceMemberResponse>

Implementation of

CommunicationsBindings.addEmailSenderAsMember

---

addGroupMember()

addGroupMember: (wid, groupId, data) => Promise<OperatorGroupMemberResponse>

Defined in: packages/sdk/src/client/client.ts:507

Add a member to an operator group.

Parameters

wid

string

groupId

number

data

AddGroupMemberRequest

Returns

Promise<OperatorGroupMemberResponse>

Implementation of

OperatorBindings.addGroupMember

---

addWorkspaceToSubscription()

addWorkspaceToSubscription: (subscriptionId, data) => Promise<AddWorkspaceResponse>

Defined in: packages/sdk/src/client/client.ts:1005

Provision a new workspace under an existing org subscription.

No product or period: the organization already holds the plan and the new workspace bills through it. Returns before the workspace exists — provisioning: true means poll for it.

Parameters

subscriptionId

number

data

name?

string

slug?

string

template_workspace_uuid?

string

Returns

Promise<AddWorkspaceResponse>

Implementation of

BillingBindings.addWorkspaceToSubscription

---

advanceStep()

advanceStep: (wid, journeyId, stepUuid, data) => Promise<MemberJourneyStep>

Defined in: packages/sdk/src/client/client.ts:478

Advance a journey step in the current execution context.

Parameters

wid

string

journeyId

number

stepUuid

string

data?

AdvanceStepFormData = {}

Returns

Promise<MemberJourneyStep>

Implementation of

JourneysBindings.advanceStep

---

approveWorkspaceInvitation()

approveWorkspaceInvitation: (workspaceUuid, invitationId) => Promise<InvitationResponse>

Defined in: packages/sdk/src/client/client.ts:638

Approve an invitation (grant access) - requires workspace admin permission.

Parameters

workspaceUuid

string

invitationId

number

Returns

Promise<InvitationResponse>

Implementation of

WorkspacesBindings.approveWorkspaceInvitation

---

archiveAgent()

archiveAgent: (wid, id) => Promise<AgentResponse>

Defined in: packages/sdk/src/client/client.ts:353

Archive an agent, hiding it from default listings.

Parameters

wid

string

id

number

Returns

Promise<AgentResponse>

Implementation of

AgentsBindings.archiveAgent

---

archiveChat()

archiveChat: (wid, id) => Promise<void>

Defined in: packages/sdk/src/client/client.ts:179

Archive a chat.

Parameters

wid

string

id

number

Returns

Promise<void>

Implementation of

ChatsBindings.archiveChat

---

archiveDataType()

archiveDataType: (wid, id) => Promise<{ status: string; }>

Defined in: packages/sdk/src/client/client.ts:241

Archive a data type, hiding it from default listings.

Parameters

wid

string

id

number

Returns

Promise<{ status: string; }>

Implementation of

DataTypesBindings.archiveDataType

---

archiveJourney()

archiveJourney: (wid, journeyId) => Promise<{ status: string; }>

Defined in: packages/sdk/src/client/client.ts:458

Archive a journey (soft delete).

Parameters

wid

string

journeyId

number

Returns

Promise<{ status: string; }>

Implementation of

JourneysBindings.archiveJourney

---

archiveMember()

archiveMember: (wid, memberId) => Promise<WorkspaceMemberResponse>

Defined in: packages/sdk/src/client/client.ts:284

Archive a workspace member.

Parameters

wid

string

memberId

number

Returns

Promise<WorkspaceMemberResponse>

Implementation of

MembersBindings.archiveMember

---

archiveMemberRelationship()

archiveMemberRelationship: (wid, memberId, relationshipId) => Promise<MemberRelationshipResponse>

Defined in: packages/sdk/src/client/client.ts:337

Parameters

wid

string

memberId

number

relationshipId

number

Returns

Promise<MemberRelationshipResponse>

Implementation of

MembersBindings.archiveMemberRelationship

---

archivePersona()

archivePersona: (wid, id) => Promise<Persona>

Defined in: packages/sdk/src/client/client.ts:382

Parameters

wid

string

id

number

Returns

Promise<Persona>

Implementation of

PersonasBindings.archivePersona

---

archivePhoneNumber()

archivePhoneNumber: (wid, id) => Promise<PhoneNumber>

Defined in: packages/sdk/src/client/client.ts:909

Archive a phone number, releasing the Twilio number back to the pool.

Parameters

wid

string

id

number

Returns

Promise<PhoneNumber>

Implementation of

CommunicationsBindings.archivePhoneNumber

---

archiveStep()

archiveStep: (wid, journeyId, stepUuid) => Promise<{ status: string; }>

Defined in: packages/sdk/src/client/client.ts:461

Archive a step (soft delete).

Parameters

wid

string

journeyId

number

stepUuid

string

Returns

Promise<{ status: string; }>

Implementation of

JourneysBindings.archiveStep

---

archiveTask()

archiveTask: (wid, id) => Promise<Task>

Defined in: packages/sdk/src/client/client.ts:152

Archive a task, hiding it from default listings.

Parameters

wid

string

id

number

Returns

Promise<Task>

Implementation of

TasksBindings.archiveTask

---

archiveWorkflow()

archiveWorkflow: (wid, id) => Promise<{ status: string; }>

Defined in: packages/sdk/src/client/client.ts:831

Archive a workflow.

Parameters

wid

string

id

number

Returns

Promise<{ status: string; }>

Implementation of

WorkflowsBindings.archiveWorkflow

---

attachMyCustomerPaymentMethod()

attachMyCustomerPaymentMethod: (uuid, paymentMethodId, setAsDefault) => Promise<{ message: string; paymentMethodId: string; success: boolean; type: string; }>

Defined in: packages/sdk/src/client/client.ts:1276

Parameters

uuid

string

paymentMethodId

string

setAsDefault?

boolean = false

Returns

Promise<{ message: string; paymentMethodId: string; success: boolean; type: string; }>

Implementation of

CustomersBindings.attachMyCustomerPaymentMethod

---

authorize()

authorize: (request) => Promise<AuthorizeResponse>

Defined in: packages/sdk/src/client/client.ts:1042

Parameters

request

AuthorizeRequest

Returns

Promise<AuthorizeResponse>

Implementation of

AppsBindings.authorize

---

authorizeMondayConnection()

authorizeMondayConnection: (wid) => Promise<{ authorizeUrl: string; }>

Defined in: packages/sdk/src/client/client.ts:1060

Parameters

wid

string

Returns

Promise<{ authorizeUrl: string; }>

Implementation of

IntegrationsBindings.authorizeMondayConnection

---

autoCreateDataTypeFromBoard()

autoCreateDataTypeFromBoard: (wid, boardId) => Promise<{ dataTypeId: number; dataTypeName: string; fieldCount: number; warnings?: string[]; }>

Defined in: packages/sdk/src/client/client.ts:1078

Parameters

wid

string

boardId

string

Returns

Promise<{ dataTypeId: number; dataTypeName: string; fieldCount: number; warnings?: string[]; }>

Implementation of

IntegrationsBindings.autoCreateDataTypeFromBoard

---

blockWorkspaceInvitation()

blockWorkspaceInvitation: (workspaceUuid, invitationId) => Promise<InvitationResponse>

Defined in: packages/sdk/src/client/client.ts:640

Block an invitation - requires workspace admin permission.

Parameters

workspaceUuid

string

invitationId

number

Returns

Promise<InvitationResponse>

Implementation of

WorkspacesBindings.blockWorkspaceInvitation

---

bookHealthieAppointment()

bookHealthieAppointment: (wid, request) => Promise<BookingResultResponse>

Defined in: packages/sdk/src/client/client.ts:1174

Parameters

wid

string

request

BookAppointmentRequest

Returns

Promise<BookingResultResponse>

Implementation of

IntegrationsBindings.bookHealthieAppointment

---

buildSiteSource()

buildSiteSource: (wid, siteId) => Promise<SiteSourcePublishResponse>

Defined in: packages/sdk/src/client/client.ts:712

Build a site's source without publishing.

Parameters

wid

string

siteId

number

Returns

Promise<SiteSourcePublishResponse>

Implementation of

SitesBindings.buildSiteSource

---

buildWorkspace()

buildWorkspace: (wid, builderId, params) => Promise<BuildWorkspaceResponse>

Defined in: packages/sdk/src/client/client.ts:858

Build and import a workflow from a builder template in one step. Returns the created workflow ID and UUID.

Parameters

wid

string

builderId

string

params

Record<string, unknown>

Returns

Promise<BuildWorkspaceResponse>

Implementation of

WorkflowsBindings.buildWorkspace

---

bulkCreateMembers()

bulkCreateMembers: (wid, request) => Promise<BulkCreateMembersResponse>

Defined in: packages/sdk/src/client/client.ts:287

Bulk-create members in a workspace.

Parameters

wid

string

request

BulkCreateMembersRequest

Returns

Promise<BulkCreateMembersResponse>

Implementation of

MembersBindings.bulkCreateMembers

---

bulkLinkMembersToHubspot()

bulkLinkMembersToHubspot: (wid, data) => Promise<{ linked: number; }>

Defined in: packages/sdk/src/client/client.ts:1220

Parameters

wid

string

data

BulkLinkHubspotRequest

Returns

Promise<{ linked: number; }>

Implementation of

IntegrationsBindings.bulkLinkMembersToHubspot

---

bulkLinkMembersToMonday()

bulkLinkMembersToMonday: (wid, data) => Promise<{ linked: number; }>

Defined in: packages/sdk/src/client/client.ts:1074

Parameters

wid

string

data

BulkLinkMondayRequest

Returns

Promise<{ linked: number; }>

Implementation of

IntegrationsBindings.bulkLinkMembersToMonday

---

bulkLinkMembersToSalesforce()

bulkLinkMembersToSalesforce: (wid, data) => Promise<{ linked: number; }>

Defined in: packages/sdk/src/client/client.ts:1198

Parameters

wid

string

data

BulkLinkSalesforceRequest

Returns

Promise<{ linked: number; }>

Implementation of

IntegrationsBindings.bulkLinkMembersToSalesforce

---

cancelAgentTask()

cancelAgentTask: (wid, taskUuid) => Promise<CancelAgentTaskResponse>

Defined in: packages/sdk/src/client/client.ts:344

Parameters

wid

string

taskUuid

string

Returns

Promise<CancelAgentTaskResponse>

Implementation of

AgentTasksBindings.cancelAgentTask

---

cancelAssignment()

cancelAssignment: (wid, id, data?) => Promise<Assignment>

Defined in: packages/sdk/src/client/client.ts:698

Cancel an active assignment with an optional reason.

Parameters

wid

string

id

number

data?

reason?

string

Returns

Promise<Assignment>

Implementation of

AuthBindings.cancelAssignment

---

cancelBusinessProfile()

cancelBusinessProfile: (orgUuid, legalEntityUuid?) => Promise<BusinessProfileCancelResponse>

Defined in: packages/sdk/src/client/client.ts:614

Cancel an in-flight Twilio review. Resets the cached profile state to draft so the user can edit and resubmit.

Parameters

orgUuid

string

legalEntityUuid?

string | null

Returns

Promise<BusinessProfileCancelResponse>

Implementation of

OrgBindings.cancelBusinessProfile

---

cancelCalendarEvent()

cancelCalendarEvent: (wid, eventId, reason?) => Promise<EventResponse>

Defined in: packages/sdk/src/client/client.ts:884

Cancel a calendar event with an optional reason.

Parameters

wid

string

eventId

number

reason?

string

Returns

Promise<EventResponse>

Implementation of

CalendarsBindings.cancelCalendarEvent

---

cancelChatCallback()

cancelChatCallback: (wid, chatId, callbackId) => Promise<ScheduledCallbackResponse>

Defined in: packages/sdk/src/client/client.ts:171

Cancel a pending scheduled callback on a chat.

Parameters

wid

string

chatId

number

callbackId

number

Returns

Promise<ScheduledCallbackResponse>

Implementation of

ChatsBindings.cancelChatCallback

---

cancelCredentialChange()

cancelCredentialChange: (requestId) => Promise<CancelCredentialChangeResponse>

Defined in: packages/sdk/src/client/client.ts:683

Cancel a pending credential change request.

Parameters

requestId

number

Returns

Promise<CancelCredentialChangeResponse>

Implementation of

AuthBindings.cancelCredentialChange

---

cancelCredentialUpdateInvite()

cancelCredentialUpdateInvite: (wid, inviteId) => Promise<CancelCredentialChangeInviteResponse>

Defined in: packages/sdk/src/client/client.ts:320

Cancel a pending credential update invitation. Admin-only.

Parameters

wid

string

inviteId

number

Returns

Promise<CancelCredentialChangeInviteResponse>

Implementation of

MembersBindings.cancelCredentialUpdateInvite

---

cancelSubscription()

cancelSubscription: (subscriptionId) => Promise<void>

Defined in: packages/sdk/src/client/client.ts:1002

Cancel an active subscription.

Parameters

subscriptionId

number

Returns

Promise<void>

Implementation of

BillingBindings.cancelSubscription

---

changePassword()

changePassword: (currentPassword, newPassword) => Promise<{ message: string; success: boolean; }>

Defined in: packages/sdk/src/client/client.ts:658

Change the current account password by providing the existing password.

Parameters

currentPassword

string

newPassword

string

Returns

Promise<{ message: string; success: boolean; }>

Implementation of

AuthBindings.changePassword

---

checkAvailability()

checkAvailability: (wid, calendarId, check) => Promise<AvailabilityResponse>

Defined in: packages/sdk/src/client/client.ts:878

Check availability for a time range on a calendar.

Parameters

wid

string

calendarId

number

check

AvailabilityCheck

Returns

Promise<AvailabilityResponse>

Implementation of

CalendarsBindings.checkAvailability

---

checkSiteDomainAvailability()

checkSiteDomainAvailability: (wid, domain, siteUuid) => Promise<{ result: boolean; }>

Defined in: packages/sdk/src/client/client.ts:705

Check whether a custom domain is available for a site.

Parameters

wid

string

domain

string

siteUuid?

string | null

Returns

Promise<{ result: boolean; }>

Implementation of

SitesBindings.checkSiteDomainAvailability

---

checkSiteSlugAvailability()

checkSiteSlugAvailability: (wid, slug, siteUuid) => Promise<SiteSlugAvailability>

Defined in: packages/sdk/src/client/client.ts:704

Check whether a site slug is available for use.

Parameters

wid

string

slug

string

siteUuid?

string | null

Returns

Promise<SiteSlugAvailability>

Implementation of

SitesBindings.checkSiteSlugAvailability

---

claimDevicePairing()

claimDevicePairing: (body) => Promise<DeviceResponse>

Defined in: packages/sdk/src/client/client.ts:989

Claim a pairing code shown on a companion device for the current Account.

Parameters

body

ClaimDevicePairingRequest

Returns

Promise<DeviceResponse>

Implementation of

DevicesBindings.claimDevicePairing

---

clearConnectionMemberExclusion()

clearConnectionMemberExclusion: (wid, connectionId, memberId, options?) => Promise<{ cleared: boolean; connectionId: number; memberId: number; scope: string; }>

Defined in: packages/sdk/src/client/client.ts:1239

Clear a manual-unlink exclusion for a member on a connection so subsequent outbound syncs stop silently skipping them. Idempotent: returns cleared=false when no matching exclusion exists. boardId is only meaningful for multi-scope connectors (Monday).

Parameters

wid

string

connectionId

number

memberId

number

options?

boardId?

string

Returns

Promise<{ cleared: boolean; connectionId: number; memberId: number; scope: string; }>

Implementation of

IntegrationsBindings.clearConnectionMemberExclusion

---

clearMemberSwitch()

clearMemberSwitch: (wid) => Promise<WorkspaceMemberResponse>

Defined in: packages/sdk/src/client/client.ts:274

Clear the member switch and return to the authenticated member.

Parameters

wid

string

Returns

Promise<WorkspaceMemberResponse>

Implementation of

MembersBindings.clearMemberSwitch

---

clearMemberWorkflowVoice()

clearMemberWorkflowVoice: (wid, memberId, workflowId) => Promise<ClearWorkflowVoiceResponse>

Defined in: packages/sdk/src/client/client.ts:271

Clear the member's preferred voice for one workflow (Custom Voice).

Parameters

wid

string

memberId

number

workflowId

number

Returns

Promise<ClearWorkflowVoiceResponse>

Implementation of

MembersBindings.clearMemberWorkflowVoice

---

clearTrackedLinkDestinations()

clearTrackedLinkDestinations: (wid) => Promise<TrackedLinkPurgeResponse>

Defined in: packages/sdk/src/client/client.ts:444

Delete every destination, its links, and its clicks. Irreversible.

Parameters

wid

string

Returns

Promise<TrackedLinkPurgeResponse>

Implementation of

TrackedLinksBindings.clearTrackedLinkDestinations

---

clickWorkspaceSupportRequestResource()

clickWorkspaceSupportRequestResource: (workspaceUuid, uuid, resourceUuid, data) => Promise<SupportRequest>

Defined in: packages/sdk/src/client/client.ts:1304

Record a click on a pushed resource (Proactive Support). For a manager_prompt, pass the Manager Chat UUID it opened so the resource→chat linkage is preserved.

Parameters

workspaceUuid

string

uuid

string

resourceUuid

string

data?

RecordResourceClickRequest = {}

Returns

Promise<SupportRequest>

Implementation of

SupportRequestsBindings.clickWorkspaceSupportRequestResource

---

cloneDataType()

cloneDataType: (wid, id, data) => Promise<DataTypeResponse>

Defined in: packages/sdk/src/client/client.ts:243

Clone a data type with a new name and slug.

Parameters

wid

string

id

number

data

name

string

slug

string

Returns

Promise<DataTypeResponse>

Implementation of

DataTypesBindings.cloneDataType

---

cloneJourneyAsV2()

cloneJourneyAsV2: (wid, id) => Promise<JourneyRead>

Defined in: packages/sdk/src/client/client.ts:455

Copy a supported legacy definition into a separate draft V2 Journey.

Parameters

wid

string

id

number

Returns

Promise<JourneyRead>

Implementation of

JourneysBindings.cloneJourneyAsV2

---

cloneTask()

cloneTask: (wid, taskId, name, slug?) => Promise<Task>

Defined in: packages/sdk/src/client/client.ts:154

Clone a task with all its dependencies including abilities.

This creates a complete copy of the task on the backend, including:

• Task properties (name, description, prompt, etc.)
• File associations
• Data type associations
• Event rules
• Abilities (task-scoped)

Parameters

wid

string

taskId

number

name

string

slug?

string

Returns

Promise<Task>

Implementation of

TasksBindings.cloneTask

---

cloneWorkflow()

cloneWorkflow: (wid, id, data) => Promise<WorkflowDetail>

Defined in: packages/sdk/src/client/client.ts:833

Clone a workflow with a new name.

Parameters

wid

string

id

number

data

name

string

Returns

Promise<WorkflowDetail>

Implementation of

WorkflowsBindings.cloneWorkflow

---

closeWorkspaceSupportRequest()

closeWorkspaceSupportRequest: (workspaceUuid, uuid, data) => Promise<SupportRequest>

Defined in: packages/sdk/src/client/client.ts:1302

Parameters

workspaceUuid

string

uuid

string

data?

CloseSupportRequestRequest = {}

Returns

Promise<SupportRequest>

Implementation of

SupportRequestsBindings.closeWorkspaceSupportRequest

---

commentOnOrgSupportRequest()

commentOnOrgSupportRequest: (orgUuid, uuid, data) => Promise<SupportRequest>

Defined in: packages/sdk/src/client/client.ts:1297

Parameters

orgUuid

string

uuid

string

data

CreateSupportRequestCommentRequest

Returns

Promise<SupportRequest>

Implementation of

SupportRequestsBindings.commentOnOrgSupportRequest

---

commentOnSupportRequest()

commentOnSupportRequest: (uuid, data) => Promise<SupportRequest>

Defined in: packages/sdk/src/client/client.ts:1293

Parameters

uuid

string

data

CreateSupportRequestCommentRequest

Returns

Promise<SupportRequest>

Implementation of

SupportRequestsBindings.commentOnSupportRequest

---

commentOnWorkspaceSupportRequest()

commentOnWorkspaceSupportRequest: (workspaceUuid, uuid, data) => Promise<SupportRequest>

Defined in: packages/sdk/src/client/client.ts:1301

Parameters

workspaceUuid

string

uuid

string

data

CreateSupportRequestCommentRequest

Returns

Promise<SupportRequest>

Implementation of

SupportRequestsBindings.commentOnWorkspaceSupportRequest

---

completeDiscordLink()

completeDiscordLink: (wid, data) => Promise<CompleteDiscordLinkResponse>

Defined in: packages/sdk/src/client/client.ts:1094

Complete an authenticated Discord account link (GH #20196).

POST-only. Exchanges the one-time opaque handle (issued by the OAuth callback and carried in the ?discord_link_handle= return param) for a persisted MemberCredential. Requires an authenticated, step-up-protected session with apps:write; a 401 insufficient_user_authentication triggers the SDK's enhanced-auth (step-up) retry automatically.

Parameters

wid

string

data

CompleteDiscordLinkRequest

Returns

Promise<CompleteDiscordLinkResponse>

Implementation of

IntegrationsBindings.completeDiscordLink

---

computeChatMetrics()

computeChatMetrics: (wid, data) => Promise<ComputeChatMetricsResponse>

Defined in: packages/sdk/src/client/client.ts:394

On-demand compute of enabled chat-source metrics for one chat.

Parameters

wid

string

data

ComputeChatMetricsRequest

Returns

Promise<ComputeChatMetricsResponse>

---

configureConfluence()

configureConfluence: (wid, data) => Promise<ConfluenceConnectionStatus>

Defined in: packages/sdk/src/client/client.ts:1177

Parameters

wid

string

data

ConfigureConfluenceRequest

Returns

Promise<ConfluenceConnectionStatus>

Implementation of

IntegrationsBindings.configureConfluence

---

configureDocumoFax()

configureDocumoFax: (wid, data) => Promise<DocumoFaxConnectionResponse>

Defined in: packages/sdk/src/client/client.ts:1155

Parameters

wid

string

data

ConfigureDocumoFaxRequest

Returns

Promise<DocumoFaxConnectionResponse>

Implementation of

IntegrationsBindings.configureDocumoFax

---

configureHealthie()

configureHealthie: (wid, data) => Promise<HealthieConnectionStatus>

Defined in: packages/sdk/src/client/client.ts:1161

Parameters

wid

string

data

ConfigureHealthieRequest

Returns

Promise<HealthieConnectionStatus>

Implementation of

IntegrationsBindings.configureHealthie

---

configureHubspot()

configureHubspot: (wid, data) => Promise<HubspotConnectionStatus>

Defined in: packages/sdk/src/client/client.ts:1211

Parameters

wid

string

data

ConfigureHubspotRequest

Returns

Promise<HubspotConnectionStatus>

Implementation of

IntegrationsBindings.configureHubspot

---

configureMondayConnection()

configureMondayConnection: (wid, data) => Promise<MondayConnectionStatus>

Defined in: packages/sdk/src/client/client.ts:1058

Parameters

wid

string

data

clientId

string

clientSecret

string

signingSecret?

string

Returns

Promise<MondayConnectionStatus>

Implementation of

IntegrationsBindings.configureMondayConnection

---

configurePatientSync()

configurePatientSync: (wid, data) => Promise<PatientSyncConnectionStatus>

Defined in: packages/sdk/src/client/client.ts:1158

Create or update the workspace's PatientSync connection (singleton).

Parameters

wid

string

data

ConfigurePatientSyncRequest

Returns

Promise<PatientSyncConnectionStatus>

Implementation of

IntegrationsBindings.configurePatientSync

---

configureSalesforce()

configureSalesforce: (wid, data) => Promise<SalesforceConnectionStatus>

Defined in: packages/sdk/src/client/client.ts:1189

Parameters

wid

string

data

ConfigureSalesforceRequest

Returns

Promise<SalesforceConnectionStatus>

Implementation of

IntegrationsBindings.configureSalesforce

---

confirmCredentialChangeInvite()

confirmCredentialChangeInvite: (token) => Promise<CredentialChangeInviteConfirmResponse>

Defined in: packages/sdk/src/client/client.ts:685

Confirm a credential change invitation. The user must be logged in and be the target of the invitation.

Parameters

token

string

Returns

Promise<CredentialChangeInviteConfirmResponse>

Implementation of

AuthBindings.confirmCredentialChangeInvite

---

convertEmail()

convertEmail: (wid, inboxId, emailId, format) => Promise<EmailConversionResponse>

Defined in: packages/sdk/src/client/client.ts:932

Convert an email to text, markdown, or PDF format.

Parameters

wid

string

inboxId

number

emailId

number

format?

"text" | "markdown" | "pdf"

Returns

Promise<EmailConversionResponse>

Implementation of

CommunicationsBindings.convertEmail

---

convertFile()

convertFile: (wid, fileId, format) => Promise<ConvertedFileResponse>

Defined in: packages/sdk/src/client/client.ts:764

Convert a file to the specified format (text, markdown, or PDF).

Parameters

wid

string

fileId

number

format?

"text" | "markdown" | "pdf"

Returns

Promise<ConvertedFileResponse>

Implementation of

FilesBindings.convertFile

---

convertWorkflowStartTaskOpeningMessage()

convertWorkflowStartTaskOpeningMessage: (wid, id, expectedRuleId) => Promise<OpeningTurnConversionResponse>

Defined in: packages/sdk/src/client/client.ts:822

Parameters

wid

string

id

string | number

expectedRuleId

number

Returns

Promise<OpeningTurnConversionResponse>

Implementation of

WorkflowsBindings.convertWorkflowStartTaskOpeningMessage

---

createAbility()

createAbility: (wid, body) => Promise<AbilityResponse>

Defined in: packages/sdk/src/client/client.ts:158

Create (enable) a configured ability on a workflow or task scope.

Parameters

wid

string

body

Record<string, unknown>

Returns

Promise<AbilityResponse>

Implementation of

TasksBindings.createAbility

---

createAccessGrant()

createAccessGrant: (wid, data) => Promise<AccessGrant>

Defined in: packages/sdk/src/client/client.ts:518

Create a new access grant for a resource.

Parameters

wid

string

data

CreateAccessGrantRequest

Returns

Promise<AccessGrant>

Implementation of

AccessGrantsBindings.createAccessGrant

---

createAccount()

createAccount: (email, password, name?, organizationUuid?) => Promise<VerifyCodeResponse>

Defined in: packages/sdk/src/client/client.ts:666

Sign up a new account with email and password.

Parameters

email

string

password

string

name?

string

organizationUuid?

string

Returns

Promise<VerifyCodeResponse>

Implementation of

AuthBindings.createAccount

---

createAgent()

createAgent: (wid, agent) => Promise<AgentResponse>

Defined in: packages/sdk/src/client/client.ts:350

Create a new agent in a workspace.

Parameters

wid

string

agent

CreateAgentRequest

Returns

Promise<AgentResponse>

Implementation of

AgentsBindings.createAgent

---

createApiKey()

createApiKey: (wid, apiKey) => Promise<ApiKeyCreated>

Defined in: packages/sdk/src/client/client.ts:995

Create a new API key for a workspace.

Parameters

wid

string

apiKey

ApiKeyFormData

Returns

Promise<ApiKeyCreated>

Implementation of

BillingBindings.createApiKey

---

createApp()

createApp: (request) => Promise<App>

Defined in: packages/sdk/src/client/client.ts:1023

Create a new app

Parameters

request

CreateAppRequest

Returns

Promise<App>

Implementation of

AppsBindings.createApp

---

createAssignment()

createAssignment: (wid, data) => Promise<Assignment>

Defined in: packages/sdk/src/client/client.ts:695

Create a new assignment for a member.

Parameters

wid

string

data

CreateAssignmentFormData

Returns

Promise<Assignment>

Implementation of

AuthBindings.createAssignment

---

createBuilder()

createBuilder: (request) => Promise<BuilderResponse>

Defined in: packages/sdk/src/client/client.ts:1032

Create a new builder

Parameters

request

CreateBuilderRequest

Returns

Promise<BuilderResponse>

Implementation of

AppsBindings.createBuilder

---

createCalendar()

createCalendar: (wid, calendar) => Promise<Calendar>

Defined in: packages/sdk/src/client/client.ts:871

Create a new calendar in the workspace.

Parameters

wid

string

calendar

CalendarFormData

Returns

Promise<Calendar>

Implementation of

CalendarsBindings.createCalendar

---

createCalendarEvent()

createCalendarEvent: (wid, event) => Promise<EventResponse>

Defined in: packages/sdk/src/client/client.ts:882

Create a new calendar event.

Parameters

wid

string

event

CalendarEventFormData

Returns

Promise<EventResponse>

Implementation of

CalendarsBindings.createCalendarEvent

---

createCalendarEventType()

createCalendarEventType: (wid, eventType) => Promise<EventTypeResponse>

Defined in: packages/sdk/src/client/client.ts:889

Create a new calendar event type.

Parameters

wid

string

eventType

CalendarEventTypeFormData

Returns

Promise<EventTypeResponse>

Implementation of

CalendarsBindings.createCalendarEventType

---

createCalendarSchedule()

createCalendarSchedule: (wid, calendarId, schedule) => Promise<CalendarSchedule>

Defined in: packages/sdk/src/client/client.ts:875

Create a new schedule for a calendar.

Parameters

wid

string

calendarId

number

schedule

CalendarScheduleFormData

Returns

Promise<CalendarSchedule>

Implementation of

CalendarsBindings.createCalendarSchedule

---

createChat()

createChat: (wid, chat) => Promise<ChatResponse>

Defined in: packages/sdk/src/client/client.ts:181

Create a new chat.

Parameters

wid

string

chat

ChatFormData

Returns

Promise<ChatResponse>

Implementation of

ChatsBindings.createChat

---

createChatCompletion()

createChatCompletion: (wid, chatId, data) => Promise<{ choices: object[]; created: number; id: string; model: string; object: string; usage?: { completion_tokens: number; prompt_tokens: number; total_tokens: number; }; }>

Defined in: packages/sdk/src/client/client.ts:200

Create a chat completion using the OpenAI-compatible API (used by eval scripts).

Parameters

wid

string

chatId

number

data

messages

object[]

model?

string

Returns

Promise<{ choices: object[]; created: number; id: string; model: string; object: string; usage?: { completion_tokens: number; prompt_tokens: number; total_tokens: number; }; }>

Implementation of

ChatsBindings.createChatCompletion

---

createChatFilter()

createChatFilter: (wid, filter) => Promise<ChatFilterResponse>

Defined in: packages/sdk/src/client/client.ts:215

Create a new chat filter.

Parameters

wid

string

filter

ChatFilterFormData

Returns

Promise<ChatFilterResponse>

Implementation of

ChatsBindings.createChatFilter

---

createChatInteractionSession()

createChatInteractionSession: (wid, chatId, request) => Promise<InteractionSessionResponse>

Defined in: packages/sdk/src/client/client.ts:182

Start an interaction within an existing Chat without changing its channel.

Parameters

wid

string

chatId

number

request

CreateInteractionSessionRequest

Returns

Promise<InteractionSessionResponse>

Implementation of

ChatsBindings.createChatInteractionSession

---

createChatLabel()

createChatLabel: (wid, label) => Promise<ChatLabelResponse>

Defined in: packages/sdk/src/client/client.ts:209

Create a new chat label.

Parameters

wid

string

label

ChatLabelFormData

Returns

Promise<ChatLabelResponse>

Implementation of

ChatsBindings.createChatLabel

---

createCheckoutSession()

createCheckoutSession: (productId, planPeriod, options) => Promise<CheckoutSessionResponse>

Defined in: packages/sdk/src/client/client.ts:1007

Create a Stripe Checkout session to purchase an organization plan. Returns the checkout URL to open in a browser. The organization, billing customer, and subscription are created on payment by the checkout completion handler.

Parameters

productId

number

planPeriod?

CreateCheckoutSessionRequestPlanPeriod = 'month'

options?

CheckoutSessionOptions = {}

Returns

Promise<CheckoutSessionResponse>

Implementation of

BillingBindings.createCheckoutSession

---

createClientWorkspace()

createClientWorkspace: (wid, data) => Promise<ClientWorkspace>

Defined in: packages/sdk/src/client/client.ts:557

Create a new client workspace under a reseller workspace.

Parameters

wid

string

data

name

string

slug?

string

Returns

Promise<ClientWorkspace>

Implementation of

WorkspacesBindings.createClientWorkspace

---

createConnection()

createConnection: (wid, journeyId, data) => Promise<JourneyStepConnectionAuthoringResponse>

Defined in: packages/sdk/src/client/client.ts:463

Create a connection (DAG edge) between two steps.

Parameters

wid

string

journeyId

number

data

JourneyStepConnectionFormData

Returns

Promise<JourneyStepConnectionAuthoringResponse>

Implementation of

JourneysBindings.createConnection

---

createContactPermission()

createContactPermission: (wid, body) => Promise<{ channel: string; channelNote: string | null; consentDate: string | null; decision: string; destination: string; id: number; memberId: number | null; recordedAt: string; recordedBy: string; source: string; }>

Defined in: packages/sdk/src/client/client.ts:339

Parameters

wid

string

body

channel

"sms" | "voice"

channelNote?

string | null

consentDate?

string | null

decision

"revoked" | "granted"

destination

string

Returns

Promise<{ channel: string; channelNote: string | null; consentDate: string | null; decision: string; destination: string; id: number; memberId: number | null; recordedAt: string; recordedBy: string; source: string; }>

Implementation of

MembersBindings.createContactPermission

---

createCustomTool()

createCustomTool: (wid, toolkitId, data) => Promise<CustomTool>

Defined in: packages/sdk/src/client/client.ts:966

Create a new custom tool in a toolkit

Parameters

wid

string

toolkitId

number

data

CustomToolFormData

Returns

Promise<CustomTool>

Implementation of

ToolkitsBindings.createCustomTool

---

createCustomToolkit()

createCustomToolkit: (wid, data) => Promise<CustomToolkit>

Defined in: packages/sdk/src/client/client.ts:961

Create a new custom toolkit

Parameters

wid

string

data

CustomToolkitFormData

Returns

Promise<CustomToolkit>

Implementation of

ToolkitsBindings.createCustomToolkit

---

createDashboard()

createDashboard: (wid, body) => Promise<DashboardResponse>

Defined in: packages/sdk/src/client/client.ts:399

Create a named dashboard, optionally with an initial widget list.

Parameters

wid

string

body

CreateDashboardRequest

Returns

Promise<DashboardResponse>

Implementation of

DashboardsBindings.createDashboard

---

createDataRecord()

createDataRecord: (wid, dataTypeId, record) => Promise<DataRecordResponse>

Defined in: packages/sdk/src/client/client.ts:246

Create a new data record under the specified data type.

Parameters

wid

string

dataTypeId

number

record

DataRecordFormData

Returns

Promise<DataRecordResponse>

Implementation of

DataTypesBindings.createDataRecord

---

createDataRecordFilter()

createDataRecordFilter: (wid, data) => Promise<DataRecordFilterResponse>

Defined in: packages/sdk/src/client/client.ts:259

Create a new saved data-record filter.

Parameters

wid

string

data

DataRecordFilterFormData

Returns

Promise<DataRecordFilterResponse>

Implementation of

DataTypesBindings.createDataRecordFilter

---

createDataType()

createDataType: (wid, dataType) => Promise<DataTypeResponse>

Defined in: packages/sdk/src/client/client.ts:238

Create a new data type definition in the workspace.

Parameters

wid

string

dataType

DataTypeFormData

Returns

Promise<DataTypeResponse>

Implementation of

DataTypesBindings.createDataType

---

createDeviceOrderCheckoutSession()

createDeviceOrderCheckoutSession: (productId, options) => Promise<DeviceOrderCheckoutResponse>

Defined in: packages/sdk/src/client/client.ts:1011

Purchase one physical companion device (one-time payment; Stripe collects the shipping address in hosted Checkout).

Parameters

productId

number

options?

DeviceOrderCheckoutOptions = {}

Returns

Promise<DeviceOrderCheckoutResponse>

Implementation of

BillingBindings.createDeviceOrderCheckoutSession

---

createDiscordBot()

createDiscordBot: (wid, data) => Promise<DiscordBot>

Defined in: packages/sdk/src/client/client.ts:1084

Create a new Discord bot configuration.

Parameters

wid

string

data

CreateDiscordBotRequest

Returns

Promise<DiscordBot>

Implementation of

IntegrationsBindings.createDiscordBot

---

createEventRule()

createEventRule: (wid, rule) => Promise<EventRuleResponse>

Defined in: packages/sdk/src/client/client.ts:798

Create a new event rule in the workspace.

Parameters

wid

string

rule

EventRuleFormData

Returns

Promise<EventRuleResponse>

Implementation of

EventsBindings.createEventRule

---

createExperiment()

createExperiment: (wid, data) => Promise<Experiment>

Defined in: packages/sdk/src/client/client.ts:489

Create a draft experiment.

Parameters

wid

string

data

ExperimentFormData

Returns

Promise<Experiment>

Implementation of

ExperimentsBindings.createExperiment

---

createExperimentAssignment()

createExperimentAssignment: (wid, experimentId, data) => Promise<MemberExperimentAssignment>

Defined in: packages/sdk/src/client/client.ts:497

Manually assign a member to an experiment (optional group, or weighted random).

Parameters

wid

string

experimentId

number

data

groupId?

number | null

memberId

number

Returns

Promise<MemberExperimentAssignment>

Implementation of

ExperimentsBindings.createExperimentAssignment

---

createExperimentGroup()

createExperimentGroup: (wid, experimentId, data) => Promise<ExperimentGroup>

Defined in: packages/sdk/src/client/client.ts:492

Create a group within an experiment.

Parameters

wid

string

experimentId

number

data

ExperimentGroupFormData

Returns

Promise<ExperimentGroup>

Implementation of

ExperimentsBindings.createExperimentGroup

---

createFhirConnection()

createFhirConnection: (wid, data) => Promise<FhirConnection>

Defined in: packages/sdk/src/client/client.ts:1121

Create a new FHIR connection configuration.

Parameters

wid

string

data

CreateFhirConnectionRequest

Returns

Promise<FhirConnection>

Implementation of

IntegrationsBindings.createFhirConnection

---

createFile()

createFile: (wid, file) => Promise<File>

Defined in: packages/sdk/src/client/client.ts:756

Create a new file record in the workspace.

Parameters

wid

string

file

FileFormData

Returns

Promise<File>

Implementation of

FilesBindings.createFile

---

createFileLabel()

createFileLabel: (wid, label) => Promise<FileLabelResponse>

Defined in: packages/sdk/src/client/client.ts:776

Create a new file label in the workspace.

Parameters

wid

string

label

FileLabelFormData

Returns

Promise<FileLabelResponse>

Implementation of

FilesBindings.createFileLabel

---

createFolder()

createFolder: (wid, directory) => Promise<FileFolderResponse>

Defined in: packages/sdk/src/client/client.ts:768

Create a new folder in the workspace.

Parameters

wid

string

directory

FileFolderFormData

Returns

Promise<FileFolderResponse>

Implementation of

FilesBindings.createFolder

---

createGlobalApiKey()

createGlobalApiKey: (apiKey) => Promise<ApiKeyCreated>

Defined in: packages/sdk/src/client/client.ts:998

Create a new account-level API key.

Parameters

apiKey

ApiKeyFormData

Returns

Promise<ApiKeyCreated>

Implementation of

BillingBindings.createGlobalApiKey

---

createGoal()

createGoal: (wid, journeyId, data) => Promise<JourneyGoalAuthoringResponse>

Defined in: packages/sdk/src/client/client.ts:466

Create a goal for a journey.

Parameters

wid

string

journeyId

number

data

JourneyGoalFormData

Returns

Promise<JourneyGoalAuthoringResponse>

Implementation of

JourneysBindings.createGoal

---

createInbox()

createInbox: (wid, inbox) => Promise<Inbox>

Defined in: packages/sdk/src/client/client.ts:924

Create a new inbox.

Parameters

wid

string

inbox

InboxCreateRequest

Returns

Promise<Inbox>

Implementation of

CommunicationsBindings.createInbox

---

createInquiry()

createInquiry: (data) => Promise<InquiryResponse>

Defined in: packages/sdk/src/client/client.ts:1035

Create a new inquiry (public endpoint)

Parameters

data

businessName?

string = ...

businessNumber?

string = ...

cellNumber?

string = ...

country?

string = ...

documentId?

string = ...

Marketing-document slug (whitepaper downloads) — lowercase kebab-case, mirrors the API validator.

email?

string = ...

inquiryType

"other" | "builder" | "customer" | "partner" | "demo_request" | "waitlist" | "whitepaper" = ...

message?

string = ...

name?

string = ...

productId?

number = ...

recaptchaToken?

string = ...

requiresBaa?

boolean = ...

The submitter ticked "we plan to use Gravity Rail with healthcare information and will need a BAA" (#20152). A self-declared sales-routing signal — it confers no PHI authorization, which is an explicit property of orgs and workspaces and never inferred from a marketing form.

source?

"contact" | "demo" | "whitepaper" | "gap_zero" | "waitlist_updates" | "about_contact" | "concierge_error" | "concierge_anonymous" | "get_started" = ...

Per-form lead source (GRA-6765) — closed enum mirroring the API validator, so gap-zero / generic-contact / concierge / etc. are distinguishable in the funnel event and Slack notification. Never free text.

state?

string = ...

Returns

Promise<InquiryResponse>

Implementation of

AppsBindings.createInquiry

---

createJourney()

createJourney: (wid, data) => Promise<JourneyRead>

Defined in: packages/sdk/src/client/client.ts:456

Create a new journey. Returns the READ projection (JourneyRead).

Parameters

wid

string

data

JourneyFormData

Returns

Promise<JourneyRead>

Implementation of

JourneysBindings.createJourney

---

createJourneyNote()

createJourneyNote: (wid, journeyId, data) => Promise<JourneyNoteResponse>

Defined in: packages/sdk/src/client/client.ts:482

Create a note on a journey.

Parameters

wid

string

journeyId

number

data

JourneyNoteFormData

Returns

Promise<JourneyNoteResponse>

Implementation of

JourneysBindings.createJourneyNote

---

createLegalEntity()

createLegalEntity: (orgUuid, data) => Promise<LegalEntitySummary>

Defined in: packages/sdk/src/client/client.ts:617

Create a legal entity. Its business profile is edited via the entity-scoped business-profile methods.

Parameters

orgUuid

string

data

CreateLegalEntityRequest

Returns

Promise<LegalEntitySummary>

Implementation of

OrgBindings.createLegalEntity

---

createMcpServer()

createMcpServer: (wid, data) => Promise<McpServerResponse>

Defined in: packages/sdk/src/client/client.ts:971

Create a new MCP server

Parameters

wid

string

data

McpServerFormData

Returns

Promise<McpServerResponse>

Implementation of

ToolkitsBindings.createMcpServer

---

createMemberCheckoutSession()

createMemberCheckoutSession: (productId, planPeriod, options) => Promise<MemberCheckoutSessionResponse>

Defined in: packages/sdk/src/client/client.ts:1008

Purchase a role-granting membership in an existing workspace.

Parameters

productId

number

planPeriod?

"month" | "quarter" | "year"

options?

MemberCheckoutSessionOptions = {}

Returns

Promise<MemberCheckoutSessionResponse>

Implementation of

BillingBindings.createMemberCheckoutSession

---

createMemberField()

createMemberField: (wid, memberId, request) => Promise<MemberFieldResponse>

Defined in: packages/sdk/src/client/client.ts:315

Create a new field for a member. User-created fields have no service and can be modified/deleted.

Parameters

wid

string

memberId

number

request

CreateMemberFieldRequest

Returns

Promise<MemberFieldResponse>

Implementation of

MembersBindings.createMemberField

---

createMemberFilter()

createMemberFilter: (wid, data) => Promise<MemberFilterResponse>

Defined in: packages/sdk/src/client/client.ts:294

Create a new saved member filter.

Parameters

wid

string

data

MemberFilterFormData

Returns

Promise<MemberFilterResponse>

Implementation of

MembersBindings.createMemberFilter

---

createMemberLabel()

createMemberLabel: (wid, label) => Promise<MemberLabelResponse>

Defined in: packages/sdk/src/client/client.ts:301

Create a new member label.

Parameters

wid

string

label

MemberLabelFormData

Returns

Promise<MemberLabelResponse>

Implementation of

MembersBindings.createMemberLabel

---

createMemberMemory()

createMemberMemory: (wid, memberId, body) => Promise<GeneratedMemoryResponse>

Defined in: packages/sdk/src/client/client.ts:330

Parameters

wid

string

memberId

number

body

content?

string | null

description

string

key

string

priority?

number

Returns

Promise<GeneratedMemoryResponse>

Implementation of

MembersBindings.createMemberMemory

---

createMemberPortalSession()

createMemberPortalSession: (options) => Promise<MemberPortalSessionResponse>

Defined in: packages/sdk/src/client/client.ts:1009

Open Stripe's hosted membership-management portal.

Parameters

options

MemberPortalSessionOptions

Returns

Promise<MemberPortalSessionResponse>

Implementation of

BillingBindings.createMemberPortalSession

---

createMemberRelationship()

createMemberRelationship: (wid, memberId, body) => Promise<MemberRelationshipResponse>

Defined in: packages/sdk/src/client/client.ts:336

Parameters

wid

string

memberId

number

body

CreateMemberRelationshipRequest

Returns

Promise<MemberRelationshipResponse>

Implementation of

MembersBindings.createMemberRelationship

---

createMemberRole()

createMemberRole: (wid, memberRole) => Promise<MemberRoleResponse>

Defined in: packages/sdk/src/client/client.ts:307

Create a new member role.

Parameters

wid

string

memberRole

MemberRoleFormData

Returns

Promise<MemberRoleResponse>

Implementation of

MembersBindings.createMemberRole

---

createMenuItem()

createMenuItem: (wid, siteId, item) => Promise<MenuItemResponse>

Defined in: packages/sdk/src/client/client.ts:740

Create a new menu item in a site's navigation.

Parameters

wid

string

siteId

number

item

MenuItemFormData

Returns

Promise<MenuItemResponse>

Implementation of

SitesBindings.createMenuItem

---

createMetric()

createMetric: (wid, data) => Promise<MetricResponse>

Defined in: packages/sdk/src/client/client.ts:389

Parameters

wid

string

data

CreateMetricRequest

Returns

Promise<MetricResponse>

---

createMyCustomerPortalSession()

createMyCustomerPortalSession: (uuid, returnUrl?) => Promise<{ portalUrl: string; }>

Defined in: packages/sdk/src/client/client.ts:1272

Parameters

uuid

string

returnUrl?

string

Returns

Promise<{ portalUrl: string; }>

Implementation of

CustomersBindings.createMyCustomerPortalSession

---

createMyCustomerSetupIntent()

createMyCustomerSetupIntent: (uuid) => Promise<{ clientSecret: string; setupIntentId: string; status: string; }>

Defined in: packages/sdk/src/client/client.ts:1274

Parameters

uuid

string

Returns

Promise<{ clientSecret: string; setupIntentId: string; status: string; }>

Implementation of

CustomersBindings.createMyCustomerSetupIntent

---

createMyPronunciation()

createMyPronunciation: (data) => Promise<PronunciationEntryResponse>

Defined in: packages/sdk/src/client/client.ts:1259

Create a personal pronunciation entry for the current user.

Parameters

data

Pick<CreatePronunciationEntryFormData, "term" | "respelling">

Returns

Promise<PronunciationEntryResponse>

Implementation of

PronunciationsBindings.createMyPronunciation

---

createNotificationRule()

createNotificationRule: (wid, rule) => Promise<NotificationRule>

Defined in: packages/sdk/src/client/client.ts:942

Create a new notification rule.

Parameters

wid

string

rule

NotificationRuleCreate

Returns

Promise<NotificationRule>

Implementation of

CommunicationsBindings.createNotificationRule

---

createOperatorGroup()

createOperatorGroup: (wid, data) => Promise<OperatorGroup>

Defined in: packages/sdk/src/client/client.ts:504

Create a new operator group.

Parameters

wid

string

data

CreateOperatorGroupRequest

Returns

Promise<OperatorGroup>

Implementation of

OperatorBindings.createOperatorGroup

---

createOrganizationWorkspace()

createOrganizationWorkspace: (orgIdOrUuid, data) => Promise<OrgWorkspace>

Defined in: packages/sdk/src/client/client.ts:622

Create a workspace in an organization.

Parameters

orgIdOrUuid

string | number

data

OrgCreateWorkspaceFormData

Returns

Promise<OrgWorkspace>

Implementation of

OrgBindings.createOrganizationWorkspace

---

createOrgDomainSiteChildHost()

createOrgDomainSiteChildHost: (orgIdOrUuid, parentDomainUuid, request) => Promise<SiteChildHostResponse>

Defined in: packages/sdk/src/client/client.ts:607

Create one child host beneath a child-hosting parent domain.

The child gets its own CloudFront tenant and managed certificate and needs no customer DNS: the parent's wildcard CNAME already routes it.

Parameters

orgIdOrUuid

string | number

parentDomainUuid

string

request

SiteChildHostCreateRequest

Returns

Promise<SiteChildHostResponse>

Implementation of

OrgBindings.createOrgDomainSiteChildHost

---

createOrgSupportRequest()

createOrgSupportRequest: (orgUuid, data) => Promise<SupportRequest>

Defined in: packages/sdk/src/client/client.ts:1296

Parameters

orgUuid

string

data

CreateSupportRequestRequest

Returns

Promise<SupportRequest>

Implementation of

SupportRequestsBindings.createOrgSupportRequest

---

createPage()

createPage: (wid, siteId, page) => Promise<PageResponse>

Defined in: packages/sdk/src/client/client.ts:734

Create a new page within a site.

Parameters

wid

string

siteId

number

page

PageFormData

Returns

Promise<PageResponse>

Implementation of

SitesBindings.createPage

---

createPersona()

createPersona: (wid, data) => Promise<Persona>

Defined in: packages/sdk/src/client/client.ts:380

Parameters

wid

string

data

CreatePersonaRequest

Returns

Promise<Persona>

Implementation of

PersonasBindings.createPersona

---

createPhoneNumber()

createPhoneNumber: (wid, phoneNumber) => Promise<PhoneNumber>

Defined in: packages/sdk/src/client/client.ts:906

Create a new phone number record.

Parameters

wid

string

phoneNumber

PhoneNumberFormData

Returns

Promise<PhoneNumber>

Implementation of

CommunicationsBindings.createPhoneNumber

---

createProduct()

createProduct: (wid, product) => Promise<Product>

Defined in: packages/sdk/src/client/client.ts:569

Create a new product for a reseller workspace.

Parameters

wid

string

product

any

Returns

Promise<Product>

Implementation of

WorkspacesBindings.createProduct

---

createPronunciationEntry()

createPronunciationEntry: (orgUuid, data) => Promise<PronunciationEntryResponse>

Defined in: packages/sdk/src/client/client.ts:1253

Create a new pronunciation entry for an organization.

Parameters

orgUuid

string

data

CreatePronunciationEntryFormData

Returns

Promise<PronunciationEntryResponse>

Implementation of

PronunciationsBindings.createPronunciationEntry

---

createRoutine()

createRoutine: (wid, routine) => Promise<RoutineResponse>

Defined in: packages/sdk/src/client/client.ts:807

Create a new routine.

Parameters

wid

string

routine

CreateRoutineRequest

Returns

Promise<RoutineResponse>

Implementation of

EventsBindings.createRoutine

---

createScenario()

createScenario: (wid, qualificationId, data) => Promise<Scenario>

Defined in: packages/sdk/src/client/client.ts:361

Parameters

wid

string

qualificationId

number

data

CreateScenarioRequest

Returns

Promise<Scenario>

Implementation of

QualificationsBindings.createScenario

---

createSignup()

createSignup: (wid, data) => Promise<CreateSignupResponse>

Defined in: packages/sdk/src/client/client.ts:665

Create a new signup with member and data records for a workspace.

Parameters

wid

string

data

data?

Record<string, { externalId?: string; values: Record<string, any>; }>

member?

{ description?: string; email?: string; name?: string; phone?: string; role?: string; tosAccepted?: boolean; }

member.description?

string

member.email?

string

member.name?

string

member.phone?

string

member.role?

string

member.tosAccepted?

boolean

origin?

string

Returns

Promise<CreateSignupResponse>

Implementation of

AuthBindings.createSignup

---

createSite()

createSite: (wid, site) => Promise<Site>

Defined in: packages/sdk/src/client/client.ts:728

Create a new site in the workspace.

Parameters

wid

string

site

SiteFormData

Returns

Promise<Site>

Implementation of

SitesBindings.createSite

---

createSiteSource()

createSiteSource: (wid, siteId) => Promise<SiteSource>

Defined in: packages/sdk/src/client/client.ts:711

Create a site's source tree with starter files if it does not exist.

Parameters

wid

string

siteId

number

Returns

Promise<SiteSource>

Implementation of

SitesBindings.createSiteSource

---

createSlackApp()

createSlackApp: (wid, data) => Promise<SlackApp>

Defined in: packages/sdk/src/client/client.ts:1100

Create a new Slack app configuration.

Parameters

wid

string

data

CreateSlackAppRequest

Returns

Promise<SlackApp>

Implementation of

IntegrationsBindings.createSlackApp

---

createStep()

createStep: (wid, journeyId, data) => Promise<JourneyStepAuthoringResponse>

Defined in: packages/sdk/src/client/client.ts:459

Create a step within a journey.

Parameters

wid

string

journeyId

number

data

JourneyStepFormData

Returns

Promise<JourneyStepAuthoringResponse>

Implementation of

JourneysBindings.createStep

---

createSupervisor()

createSupervisor: (wid, supervisor) => Promise<CustomTool>

Defined in: packages/sdk/src/client/client.ts:864

Create a new supervisor in a workspace.

Parameters

wid

string

supervisor

SupervisorFormData

Returns

Promise<CustomTool>

Implementation of

WorkflowsBindings.createSupervisor

---

createSupportRequest()

createSupportRequest: (data) => Promise<SupportRequest>

Defined in: packages/sdk/src/client/client.ts:1292

Parameters

data

CreateSupportRequestRequest

Returns

Promise<SupportRequest>

Implementation of

SupportRequestsBindings.createSupportRequest

---

createTask()

createTask: (wid, task) => Promise<Task>

Defined in: packages/sdk/src/client/client.ts:149

Create a new task in a workspace.

Parameters

wid

string

task

TaskFormData

Returns

Promise<Task>

Implementation of

TasksBindings.createTask

---

createTeamsApp()

createTeamsApp: (wid, data) => Promise<TeamsAppResponse>

Defined in: packages/sdk/src/client/client.ts:1110

Parameters

wid

string

data

CreateTeamsAppRequest

Returns

Promise<TeamsAppResponse>

Implementation of

IntegrationsBindings.createTeamsApp

---

createTrackedLinkDestination()

createTrackedLinkDestination: (wid, data) => Promise<TrackedLinkDestinationResponse>

Defined in: packages/sdk/src/client/client.ts:441

Register a destination an author can reference as {{links.<key>}}.

The URL is deduplicated server-side, so registering one the workspace already knows adopts that destination — including a row the retired auto-harvest left unnamed, whose click history then carries forward under the new key. Registering a URL that already has a different key is a 409: renaming is what updateTrackedLinkDestination is for.

Keys use the same grammar as snippet keys: lowercase letters, digits, underscores and dots, starting with a letter (intake_form, docs.privacy). No hyphens — Jinja2 reads links.spring-2026 as subtraction.

Parameters

wid

string

data

CreateTrackedLinkDestinationRequest

Returns

Promise<TrackedLinkDestinationResponse>

Implementation of

TrackedLinksBindings.createTrackedLinkDestination

---

createWorkflow()

createWorkflow: (wid, workflow) => Promise<WorkflowDetail>

Defined in: packages/sdk/src/client/client.ts:827

Create a new workflow in a workspace.

Parameters

wid

string

workflow

WorkflowFormData

Returns

Promise<WorkflowDetail>

Implementation of

WorkflowsBindings.createWorkflow

---

createWorkflowContributor()

createWorkflowContributor: (wid, workflowId, data) => Promise<WorkflowContributorResponse>

Defined in: packages/sdk/src/client/client.ts:846

Add a contributor to a workflow.

Parameters

wid

string

workflowId

number

data

CreateWorkflowContributorRequest

Returns

Promise<WorkflowContributorResponse>

Implementation of

WorkflowsBindings.createWorkflowContributor

---

createWorkflowFromTemplate()

createWorkflowFromTemplate: (wid, templateUuid, data) => Promise<WorkflowDetail>

Defined in: packages/sdk/src/client/client.ts:835

Create a new workflow from a template.

Parameters

wid

string

templateUuid

string

data

CreateWorkflowFromTemplateFormData

Returns

Promise<WorkflowDetail>

Implementation of

WorkflowsBindings.createWorkflowFromTemplate

---

createWorkflowNote()

createWorkflowNote: (wid, workflowId, data, query?) => Promise<WorkflowNoteResponse>

Defined in: packages/sdk/src/client/client.ts:841

Create a new note on a workflow's draft (or a pinned draft revision).

Parameters

wid

string

workflowId

number

data

WorkflowNoteFormData

query?

WorkflowNotesQuery

Returns

Promise<WorkflowNoteResponse>

Implementation of

WorkflowsBindings.createWorkflowNote

---

createWorkflowOutboundVoiceChat()

createWorkflowOutboundVoiceChat: (wid, input) => Promise<ChatResponse>

Defined in: packages/sdk/src/client/client.ts:184

Create a workflow assignment chat on phone-voice and initiate an outbound call to the member (same as POST /chats with channel phone-voice + send_initial_message).

Parameters

wid

string

input

CreatePhoneVoiceOutboundChatInput

Returns

Promise<ChatResponse>

Implementation of

ChatsBindings.createWorkflowOutboundVoiceChat

---

createWorkspace()

createWorkspace: (workspace) => Promise<Workspace>

Defined in: packages/sdk/src/client/client.ts:538

Create a new workspace.

Parameters

workspace

WorkspaceFormData

Returns

Promise<Workspace>

Implementation of

WorkspacesBindings.createWorkspace

---

createWorkspaceMember()

createWorkspaceMember: (wid, data) => Promise<WorkspaceMemberResponse>

Defined in: packages/sdk/src/client/client.ts:281

Create a new workspace member.

Parameters

wid

string

data

CreateWorkspaceMemberRequest

Returns

Promise<WorkspaceMemberResponse>

Implementation of

MembersBindings.createWorkspaceMember

---

createWorkspaceSupportRequest()

createWorkspaceSupportRequest: (workspaceUuid, data) => Promise<SupportRequest>

Defined in: packages/sdk/src/client/client.ts:1300

Parameters

workspaceUuid

string

data

CreateSupportRequestRequest

Returns

Promise<SupportRequest>

Implementation of

SupportRequestsBindings.createWorkspaceSupportRequest

---

declineInvitation()

declineInvitation: (requestId) => Promise<InvitationResponse>

Defined in: packages/sdk/src/client/client.ts:643

Decline an invitation by ID (for invitees declining their own invitations) Works for both organization and workspace invitations.

Parameters

requestId

number

Returns

Promise<InvitationResponse>

Implementation of

WorkspacesBindings.declineInvitation

---

deleteAbility()

deleteAbility: (wid, abilityUuid) => Promise<void>

Defined in: packages/sdk/src/client/client.ts:160

Delete a configured ability instance by UUID.

Parameters

wid

string

abilityUuid

string

Returns

Promise<void>

Implementation of

TasksBindings.deleteAbility

---

deleteAgent()

deleteAgent: (wid, id, force?) => Promise<void>

Defined in: packages/sdk/src/client/client.ts:352

Delete an agent by ID, optionally forcing deletion of agents with active references.

Parameters

wid

string

id

number

force?

boolean

Returns

Promise<void>

Implementation of

AgentsBindings.deleteAgent

---

deleteApp()

deleteApp: (appId) => Promise<{ message: string; }>

Defined in: packages/sdk/src/client/client.ts:1027

Delete an app

Parameters

appId

string

Returns

Promise<{ message: string; }>

Implementation of

AppsBindings.deleteApp

---

deleteAssignment()

deleteAssignment: (wid, id) => Promise<void>

Defined in: packages/sdk/src/client/client.ts:692

Delete an assignment by ID.

Parameters

wid

string

id

number

Returns

Promise<void>

Implementation of

AuthBindings.deleteAssignment

---

deleteBuilder()

deleteBuilder: (builderId) => Promise<{ message: string; }>

Defined in: packages/sdk/src/client/client.ts:1034

Delete a builder

Parameters

builderId

string

Returns

Promise<{ message: string; }>

Implementation of

AppsBindings.deleteBuilder

---

deleteCalendar()

deleteCalendar: (wid, id) => Promise<void>

Defined in: packages/sdk/src/client/client.ts:873

Delete a calendar by ID.

Parameters

wid

string

id

number

Returns

Promise<void>

Implementation of

CalendarsBindings.deleteCalendar

---

deleteCalendarEvent()

deleteCalendarEvent: (wid, eventId) => Promise<void>

Defined in: packages/sdk/src/client/client.ts:885

Delete a calendar event by ID.

Parameters

wid

string

eventId

number

Returns

Promise<void>

Implementation of

CalendarsBindings.deleteCalendarEvent

---

deleteCalendarEventType()

deleteCalendarEventType: (wid, id) => Promise<void>

Defined in: packages/sdk/src/client/client.ts:891

Delete a calendar event type by ID.

Parameters

wid

string

id

number

Returns

Promise<void>

Implementation of

CalendarsBindings.deleteCalendarEventType

---

deleteCalendarSchedule()

deleteCalendarSchedule: (wid, calendarId, scheduleId) => Promise<void>

Defined in: packages/sdk/src/client/client.ts:877

Delete a calendar schedule.

Parameters

wid

string

calendarId

number

scheduleId

number

Returns

Promise<void>

Implementation of

CalendarsBindings.deleteCalendarSchedule

---

deleteChat()

deleteChat: (wid, id, reason?) => Promise<void>

Defined in: packages/sdk/src/client/client.ts:185

Delete a chat, optionally providing a reason.

Parameters

wid

string

id

number

reason?

string

Returns

Promise<void>

Implementation of

ChatsBindings.deleteChat

---

deleteChatFilter()

deleteChatFilter: (wid, id) => Promise<void>

Defined in: packages/sdk/src/client/client.ts:217

Delete a chat filter.

Parameters

wid

string

id

number

Returns

Promise<void>

Implementation of

ChatsBindings.deleteChatFilter

---

deleteChatLabel()

deleteChatLabel: (wid, id) => Promise<void>

Defined in: packages/sdk/src/client/client.ts:211

Delete a chat label.

Parameters

wid

string

id

number

Returns

Promise<void>

Implementation of

ChatsBindings.deleteChatLabel

---

deleteClientWorkspace()

deleteClientWorkspace: (wid, workspaceId) => Promise<{ message: string; }>

Defined in: packages/sdk/src/client/client.ts:560

Delete a client workspace.

Parameters

wid

string

workspaceId

number

Returns

Promise<{ message: string; }>

Implementation of

WorkspacesBindings.deleteClientWorkspace

---

deleteConfluence()

deleteConfluence: (wid) => Promise<{ status: string; }>

Defined in: packages/sdk/src/client/client.ts:1183

Parameters

wid

string

Returns

Promise<{ status: string; }>

Implementation of

IntegrationsBindings.deleteConfluence

---

deleteConnection()

deleteConnection: (wid, journeyId, connectionId) => Promise<{ status: string; }>

Defined in: packages/sdk/src/client/client.ts:465

Delete a connection by ID.

Parameters

wid

string

journeyId

number

connectionId

number

Returns

Promise<{ status: string; }>

Implementation of

JourneysBindings.deleteConnection

---

deleteCustomTool()

deleteCustomTool: (wid, toolkitId, toolId) => Promise<{ status: string; }>

Defined in: packages/sdk/src/client/client.ts:968

Delete a custom tool

Parameters

wid

string

toolkitId

number

toolId

number

Returns

Promise<{ status: string; }>

Implementation of

ToolkitsBindings.deleteCustomTool

---

deleteCustomToolkit()

deleteCustomToolkit: (wid, toolkitId) => Promise<{ status: string; }>

Defined in: packages/sdk/src/client/client.ts:963

Delete a custom toolkit

Parameters

wid

string

toolkitId

number

Returns

Promise<{ status: string; }>

Implementation of

ToolkitsBindings.deleteCustomToolkit

---

deleteDashboard()

deleteDashboard: (wid, id) => Promise<void>

Defined in: packages/sdk/src/client/client.ts:401

Delete a dashboard.

Parameters

wid

string

id

number

Returns

Promise<void>

Implementation of

DashboardsBindings.deleteDashboard

---

deleteDataRecord()

deleteDataRecord: (wid, dataTypeId, recordId) => Promise<void>

Defined in: packages/sdk/src/client/client.ts:248

Delete a data record by ID.

Parameters

wid

string

dataTypeId

number

recordId

number

Returns

Promise<void>

Implementation of

DataTypesBindings.deleteDataRecord

---

deleteDataRecordFilter()

deleteDataRecordFilter: (wid, filterId) => Promise<void>

Defined in: packages/sdk/src/client/client.ts:261

Delete a saved data-record filter.

Parameters

wid

string

filterId

number

Returns

Promise<void>

Implementation of

DataTypesBindings.deleteDataRecordFilter

---

deleteDataType()

deleteDataType: (wid, id) => Promise<void>

Defined in: packages/sdk/src/client/client.ts:240

Delete a data type definition by ID.

Parameters

wid

string

id

number

Returns

Promise<void>

Implementation of

DataTypesBindings.deleteDataType

---

deleteDiscordBot()

deleteDiscordBot: (wid, botId) => Promise<void>

Defined in: packages/sdk/src/client/client.ts:1086

Delete a Discord bot configuration.

Parameters

wid

string

botId

number

Returns

Promise<void>

Implementation of

IntegrationsBindings.deleteDiscordBot

---

deleteEnrollment()

deleteEnrollment: (wid, journeyId, memberId) => Promise<void>

Defined in: packages/sdk/src/client/client.ts:473

Hard-delete a canceled enrollment so the member can be re-enrolled fresh.

Parameters

wid

string

journeyId

number

memberId

number

Returns

Promise<void>

Implementation of

JourneysBindings.deleteEnrollment

---

deleteEventRule()

deleteEventRule: (wid, id) => Promise<void>

Defined in: packages/sdk/src/client/client.ts:800

Delete an event rule by ID.

Parameters

wid

string

id

number

Returns

Promise<void>

Implementation of

EventsBindings.deleteEventRule

---

deleteExperiment()

deleteExperiment: (wid, experimentId) => Promise<{ status: string; }>

Defined in: packages/sdk/src/client/client.ts:491

Hard-delete a draft experiment, or archive otherwise.

Parameters

wid

string

experimentId

number

Returns

Promise<{ status: string; }>

Implementation of

ExperimentsBindings.deleteExperiment

---

deleteExperimentAssignment()

deleteExperimentAssignment: (wid, experimentId, memberId) => Promise<{ status: string; }>

Defined in: packages/sdk/src/client/client.ts:499

Remove a member's assignment from an experiment.

Parameters

wid

string

experimentId

number

memberId

number

Returns

Promise<{ status: string; }>

Implementation of

ExperimentsBindings.deleteExperimentAssignment

---

deleteExperimentGroup()

deleteExperimentGroup: (wid, experimentId, groupId) => Promise<{ status: string; }>

Defined in: packages/sdk/src/client/client.ts:494

Delete a group that has no member assignments.

Parameters

wid

string

experimentId

number

groupId

number

Returns

Promise<{ status: string; }>

Implementation of

ExperimentsBindings.deleteExperimentGroup

---

deleteFhirConnection()

deleteFhirConnection: (wid, connectionId) => Promise<void>

Defined in: packages/sdk/src/client/client.ts:1123

Delete a FHIR connection configuration.

Parameters

wid

string

connectionId

number

Returns

Promise<void>

Implementation of

IntegrationsBindings.deleteFhirConnection

---

deleteFile()

deleteFile: (wid, id) => Promise<void>

Defined in: packages/sdk/src/client/client.ts:759

Delete a file by ID.

Parameters

wid

string

id

number

Returns

Promise<void>

Implementation of

FilesBindings.deleteFile

---

deleteFileLabel()

deleteFileLabel: (wid, id) => Promise<void>

Defined in: packages/sdk/src/client/client.ts:778

Delete a file label by ID.

Parameters

wid

string

id

number

Returns

Promise<void>

Implementation of

FilesBindings.deleteFileLabel

---

deleteFolder()

deleteFolder: (wid, id) => Promise<void>

Defined in: packages/sdk/src/client/client.ts:770

Delete a folder by ID.

Parameters

wid

string

id

number

Returns

Promise<void>

Implementation of

FilesBindings.deleteFolder

---

deleteGoal()

deleteGoal: (wid, journeyId, goalUuid) => Promise<{ status: string; }>

Defined in: packages/sdk/src/client/client.ts:468

Delete a goal.

Parameters

wid

string

journeyId

number

goalUuid

string

Returns

Promise<{ status: string; }>

Implementation of

JourneysBindings.deleteGoal

---

deleteHubspot()

deleteHubspot: (wid) => Promise<{ status: string; }>

Defined in: packages/sdk/src/client/client.ts:1217

Parameters

wid

string

Returns

Promise<{ status: string; }>

Implementation of

IntegrationsBindings.deleteHubspot

---

deleteInbox()

deleteInbox: (wid, id) => Promise<void>

Defined in: packages/sdk/src/client/client.ts:926

Delete an inbox.

Parameters

wid

string

id

number

Returns

Promise<void>

Implementation of

CommunicationsBindings.deleteInbox

---

deleteInquiry()

deleteInquiry: (inquiryId) => Promise<void>

Defined in: packages/sdk/src/client/client.ts:1040

Delete an inquiry (superuser only)

Parameters

inquiryId

number

Returns

Promise<void>

Implementation of

AppsBindings.deleteInquiry

---

deleteJourneyNote()

deleteJourneyNote: (wid, journeyId, noteId) => Promise<void>

Defined in: packages/sdk/src/client/client.ts:484

Delete a journey note.

Parameters

wid

string

journeyId

number

noteId

number

Returns

Promise<void>

Implementation of

JourneysBindings.deleteJourneyNote

---

deleteMcpServer()

deleteMcpServer: (wid, serverId) => Promise<{ message: string; }>

Defined in: packages/sdk/src/client/client.ts:973

Delete an MCP server

Parameters

wid

string

serverId

number

Returns

Promise<{ message: string; }>

Implementation of

ToolkitsBindings.deleteMcpServer

---

deleteMember()

deleteMember: (wid, memberId, options?) => Promise<void>

Defined in: packages/sdk/src/client/client.ts:283

Delete a workspace member, optionally forcing removal of associated data.

Parameters

wid

string

memberId

number

options?

force?

boolean

Returns

Promise<void>

Implementation of

MembersBindings.deleteMember

---

deleteMemberField()

deleteMemberField: (wid, memberId, fieldId) => Promise<void>

Defined in: packages/sdk/src/client/client.ts:317

Delete a member field. Only user-created fields (no service_id) can be deleted.

Parameters

wid

string

memberId

number

fieldId

number

Returns

Promise<void>

Implementation of

MembersBindings.deleteMemberField

---

deleteMemberFilter()

deleteMemberFilter: (wid, filterId) => Promise<void>

Defined in: packages/sdk/src/client/client.ts:296

Delete a saved member filter.

Parameters

wid

string

filterId

number

Returns

Promise<void>

Implementation of

MembersBindings.deleteMemberFilter

---

deleteMemberLabel()

deleteMemberLabel: (wid, id) => Promise<void>

Defined in: packages/sdk/src/client/client.ts:303

Delete a member label.

Parameters

wid

string

id

number

Returns

Promise<void>

Implementation of

MembersBindings.deleteMemberLabel

---

deleteMemberMemory()

deleteMemberMemory: (wid, memberId, memoryKey, options?) => Promise<void>

Defined in: packages/sdk/src/client/client.ts:331

Parameters

wid

string

memberId

number

memoryKey

string

options?

type?

MemoryType

Returns

Promise<void>

Implementation of

MembersBindings.deleteMemberMemory

---

deleteMemberRole()

deleteMemberRole: (wid, id) => Promise<void>

Defined in: packages/sdk/src/client/client.ts:309

Delete a member role. Default roles (systemKey set) return 403.

Parameters

wid

string

id

number

Returns

Promise<void>

Implementation of

MembersBindings.deleteMemberRole

---

deleteMenuItem()

deleteMenuItem: (wid, siteId, itemId) => Promise<void>

Defined in: packages/sdk/src/client/client.ts:742

Delete a menu item from a site's navigation.

Parameters

wid

string

siteId

number

itemId

number

Returns

Promise<void>

Implementation of

SitesBindings.deleteMenuItem

---

deleteMetric()

deleteMetric: (wid, id) => Promise<void>

Defined in: packages/sdk/src/client/client.ts:391

Soft-archive a metric (observations retained).

Parameters

wid

string

id

number

Returns

Promise<void>

---

deleteMondayConnection()

deleteMondayConnection: (wid) => Promise<{ status: string; }>

Defined in: packages/sdk/src/client/client.ts:1065

Parameters

wid

string

Returns

Promise<{ status: string; }>

Implementation of

IntegrationsBindings.deleteMondayConnection

---

deleteMyPronunciation()

deleteMyPronunciation: (id) => Promise<void>

Defined in: packages/sdk/src/client/client.ts:1261

Delete a personal pronunciation entry.

Parameters

id

number

Returns

Promise<void>

Implementation of

PronunciationsBindings.deleteMyPronunciation

---

deleteNotificationRule()

deleteNotificationRule: (wid, ruleId) => Promise<{ message: string; }>

Defined in: packages/sdk/src/client/client.ts:944

Delete a notification rule.

Parameters

wid

string

ruleId

number

Returns

Promise<{ message: string; }>

Implementation of

CommunicationsBindings.deleteNotificationRule

---

deleteOperatorGroup()

deleteOperatorGroup: (wid, groupId) => Promise<void>

Defined in: packages/sdk/src/client/client.ts:506

Delete an operator group.

Parameters

wid

string

groupId

number

Returns

Promise<void>

Implementation of

OperatorBindings.deleteOperatorGroup

---

deleteOrgDomain()

deleteOrgDomain: (orgIdOrUuid, domainUuid) => Promise<void>

Defined in: packages/sdk/src/client/client.ts:599

Delete a registered organization domain.

Parameters

orgIdOrUuid

string | number

domainUuid

string

Returns

Promise<void>

Implementation of

OrgBindings.deleteOrgDomain

---

deletePage()

deletePage: (wid, siteId, pageId) => Promise<void>

Defined in: packages/sdk/src/client/client.ts:736

Delete a page from a site.

Parameters

wid

string

siteId

number

pageId

number

Returns

Promise<void>

Implementation of

SitesBindings.deletePage

---

deletePatientSyncConnection()

deletePatientSyncConnection: (wid) => Promise<void>

Defined in: packages/sdk/src/client/client.ts:1160

Delete the workspace's PatientSync connection.

Parameters

wid

string

Returns

Promise<void>

Implementation of

IntegrationsBindings.deletePatientSyncConnection

---

deletePersona()

deletePersona: (wid, id) => Promise<void>

Defined in: packages/sdk/src/client/client.ts:384

Parameters

wid

string

id

number

Returns

Promise<void>

Implementation of

PersonasBindings.deletePersona

---

deletePlatformApp()

deletePlatformApp: (wid, appUuid, hard) => Promise<{ deleted?: boolean; disabled?: boolean; uuid: string; }>

Defined in: packages/sdk/src/client/client.ts:1247

Disable (soft) or delete (hard) a platform app connection.

Parameters

wid

string

appUuid

string

hard?

boolean = false

Returns

Promise<{ deleted?: boolean; disabled?: boolean; uuid: string; }>

Implementation of

IntegrationsBindings.deletePlatformApp

---

deleteProduct()

deleteProduct: (wid, id) => Promise<{ message: string; }>

Defined in: packages/sdk/src/client/client.ts:571

Delete a product from a reseller workspace.

Parameters

wid

string

id

number

Returns

Promise<{ message: string; }>

Implementation of

WorkspacesBindings.deleteProduct

---

deletePronunciationEntry()

deletePronunciationEntry: (orgUuid, id) => Promise<void>

Defined in: packages/sdk/src/client/client.ts:1255

Delete a pronunciation entry from an organization.

Parameters

orgUuid

string

id

number

Returns

Promise<void>

Implementation of

PronunciationsBindings.deletePronunciationEntry

---

deleteRoutine()

deleteRoutine: (wid, id) => Promise<void>

Defined in: packages/sdk/src/client/client.ts:809

Delete a routine by ID.

Parameters

wid

string

id

number

Returns

Promise<void>

Implementation of

EventsBindings.deleteRoutine

---

deleteSalesforce()

deleteSalesforce: (wid) => Promise<{ status: string; }>

Defined in: packages/sdk/src/client/client.ts:1195

Parameters

wid

string

Returns

Promise<{ status: string; }>

Implementation of

IntegrationsBindings.deleteSalesforce

---

deleteScenario()

deleteScenario: (wid, scenarioId) => Promise<void>

Defined in: packages/sdk/src/client/client.ts:364

Parameters

wid

string

scenarioId

number

Returns

Promise<void>

Implementation of

QualificationsBindings.deleteScenario

---

deleteSite()

deleteSite: (wid, id) => Promise<void>

Defined in: packages/sdk/src/client/client.ts:730

Delete a site by ID.

Parameters

wid

string

id

number

Returns

Promise<void>

Implementation of

SitesBindings.deleteSite

---

deleteSlackApp()

deleteSlackApp: (wid, appId) => Promise<void>

Defined in: packages/sdk/src/client/client.ts:1102

Delete a Slack app configuration.

Parameters

wid

string

appId

number

Returns

Promise<void>

Implementation of

IntegrationsBindings.deleteSlackApp

---

deleteSupervisor()

deleteSupervisor: (wid, id) => Promise<void>

Defined in: packages/sdk/src/client/client.ts:866

Delete a supervisor by ID.

Parameters

wid

string

id

number

Returns

Promise<void>

Implementation of

WorkflowsBindings.deleteSupervisor

---

deleteTask()

deleteTask: (wid, id) => Promise<void>

Defined in: packages/sdk/src/client/client.ts:151

Delete a task by ID.

Parameters

wid

string

id

number

Returns

Promise<void>

Implementation of

TasksBindings.deleteTask

---

deleteTeamsApp()

deleteTeamsApp: (wid, appId) => Promise<void>

Defined in: packages/sdk/src/client/client.ts:1112

Parameters

wid

string

appId

number

Returns

Promise<void>

Implementation of

IntegrationsBindings.deleteTeamsApp

---

deleteTrackedLinkDestination()

deleteTrackedLinkDestination: (wid, destinationId) => Promise<TrackedLinkPurgeResponse>

Defined in: packages/sdk/src/client/client.ts:443

Delete one destination: its short links stop resolving and its recorded clicks are removed.

Turning the workspace setting off only stops NEW links being minted — links already delivered to members keep working. This is the deliberate way to break them.

Parameters

wid

string

destinationId

number

Returns

Promise<TrackedLinkPurgeResponse>

Implementation of

TrackedLinksBindings.deleteTrackedLinkDestination

---

deleteWidgetDomain()

deleteWidgetDomain: (wid, orgDomainUuid) => Promise<void>

Defined in: packages/sdk/src/client/client.ts:592

Remove this workspace's widget entry for a domain (disables all widgets).

Parameters

wid

string

orgDomainUuid

string

Returns

Promise<void>

Implementation of

WorkspacesBindings.deleteWidgetDomain

---

deleteWorkflow()

deleteWorkflow: (wid, id, cascade) => Promise<{ deletedTaskCount: number; status: string; }>

Defined in: packages/sdk/src/client/client.ts:830

Delete a workflow, optionally cascading to delete its tasks.

Parameters

wid

string

id

number

cascade?

boolean = false

Returns

Promise<{ deletedTaskCount: number; status: string; }>

Implementation of

WorkflowsBindings.deleteWorkflow

---

deleteWorkflowContributor()

deleteWorkflowContributor: (wid, workflowId, contributorId) => Promise<{ success: boolean; }>

Defined in: packages/sdk/src/client/client.ts:848

Remove a contributor from a workflow.

Parameters

wid

string

workflowId

number

contributorId

number

Returns

Promise<{ success: boolean; }>

Implementation of

WorkflowsBindings.deleteWorkflowContributor

---

deleteWorkflowNote()

deleteWorkflowNote: (wid, workflowId, noteId, query?) => Promise<void>

Defined in: packages/sdk/src/client/client.ts:843

Delete a workflow note by ID.

Parameters

wid

string

workflowId

number

noteId

number

query?

WorkflowNotesQuery

Returns

Promise<void>

Implementation of

WorkflowsBindings.deleteWorkflowNote

---

deleteWorkspace()

deleteWorkspace: (wid) => Promise<void>

Defined in: packages/sdk/src/client/client.ts:540

Delete a workspace.

Parameters

wid

string

Returns

Promise<void>

Implementation of

WorkspacesBindings.deleteWorkspace

---

deleteWorkspaceInvitation()

deleteWorkspaceInvitation: (requestId) => Promise<{ message: string; }>

Defined in: packages/sdk/src/client/client.ts:635

Parameters

requestId

number

Returns

Promise<{ message: string; }>

Implementation of

WorkspacesBindings.deleteWorkspaceInvitation

---

deleteWorkspaceInvitationAdmin()

deleteWorkspaceInvitationAdmin: (workspaceUuid, invitationId) => Promise<{ message: string; }>

Defined in: packages/sdk/src/client/client.ts:636

Delete an invitation (requires workspace admin permission). Uses the workspace-scoped route: DELETE /api/v2/w/{workspaceUuid}/invitations/{id}

Parameters

workspaceUuid

string

invitationId

number

Returns

Promise<{ message: string; }>

Implementation of

WorkspacesBindings.deleteWorkspaceInvitationAdmin

---

denyWorkspaceInvitation()

denyWorkspaceInvitation: (workspaceUuid, invitationId) => Promise<InvitationResponse>

Defined in: packages/sdk/src/client/client.ts:639

Deny an invitation - requires workspace admin permission.

Parameters

workspaceUuid

string

invitationId

number

Returns

Promise<InvitationResponse>

Implementation of

WorkspacesBindings.denyWorkspaceInvitation

---

describeSalesforceObject()

describeSalesforceObject: (wid, sobject) => Promise<{ fields: SalesforceDescribeField[]; }>

Defined in: packages/sdk/src/client/client.ts:1205

Parameters

wid

string

sobject

string

Returns

Promise<{ fields: SalesforceDescribeField[]; }>

Implementation of

IntegrationsBindings.describeSalesforceObject

---

detachMyCustomerPaymentMethod()

detachMyCustomerPaymentMethod: (uuid, paymentMethodId) => Promise<{ message: string; success: boolean; }>

Defined in: packages/sdk/src/client/client.ts:1277

Parameters

uuid

string

paymentMethodId

string

Returns

Promise<{ message: string; success: boolean; }>

Implementation of

CustomersBindings.detachMyCustomerPaymentMethod

---

diffWorkflowRevisions()

diffWorkflowRevisions: (wid, workflowId, revisionId, against?) => Promise<WorkflowRevisionDiffResponse>

Defined in: packages/sdk/src/client/client.ts:854

Compare two revisions of the same workflow.

against is a revision id or UUID; when omitted the diff compares the named revision against the workflow's draft. Tasks are matched by stable lineage, so a rename reads as a changed name field.

Parameters

wid

string

workflowId

string | number

revisionId

string | number

against?

string | number

Returns

Promise<WorkflowRevisionDiffResponse>

Implementation of

WorkflowsBindings.diffWorkflowRevisions

---

disableConfluence()

disableConfluence: (wid) => Promise<ConfluenceConnectionStatus>

Defined in: packages/sdk/src/client/client.ts:1181

Parameters

wid

string

Returns

Promise<ConfluenceConnectionStatus>

Implementation of

IntegrationsBindings.disableConfluence

---

disableCustomToolkit()

disableCustomToolkit: (wid, toolkitId) => Promise<CustomToolkit>

Defined in: packages/sdk/src/client/client.ts:965

Disable a custom toolkit

Parameters

wid

string

toolkitId

number

Returns

Promise<CustomToolkit>

Implementation of

ToolkitsBindings.disableCustomToolkit

---

disableHubspot()

disableHubspot: (wid) => Promise<HubspotConnectionStatus>

Defined in: packages/sdk/src/client/client.ts:1215

Parameters

wid

string

Returns

Promise<HubspotConnectionStatus>

Implementation of

IntegrationsBindings.disableHubspot

---

disableMcpServer()

disableMcpServer: (wid, serverId) => Promise<McpServerResponse>

Defined in: packages/sdk/src/client/client.ts:975

Disable an MCP server

Parameters

wid

string

serverId

number

Returns

Promise<McpServerResponse>

Implementation of

ToolkitsBindings.disableMcpServer

---

disableMondayConnection()

disableMondayConnection: (wid) => Promise<MondayConnectionStatus>

Defined in: packages/sdk/src/client/client.ts:1063

Parameters

wid

string

Returns

Promise<MondayConnectionStatus>

Implementation of

IntegrationsBindings.disableMondayConnection

---

disableOrgDomainEmail()

disableOrgDomainEmail: (orgIdOrUuid, domainUuid, confirm) => Promise<EmailDisableResponse>

Defined in: packages/sdk/src/client/client.ts:603

Disable email support for an org domain.

Parameters

orgIdOrUuid

string | number

domainUuid

string

confirm?

boolean = false

Returns

Promise<EmailDisableResponse>

Implementation of

OrgBindings.disableOrgDomainEmail

---

disableOrgDomainSite()

disableOrgDomainSite: (orgIdOrUuid, domainUuid, confirm) => Promise<SiteDisableResponse>

Defined in: packages/sdk/src/client/client.ts:610

Disable custom site routing for an org domain.

Parameters

orgIdOrUuid

string | number

domainUuid

string

confirm?

boolean = false

Returns

Promise<SiteDisableResponse>

Implementation of

OrgBindings.disableOrgDomainSite

---

disableSalesforce()

disableSalesforce: (wid) => Promise<SalesforceConnectionStatus>

Defined in: packages/sdk/src/client/client.ts:1193

Parameters

wid

string

Returns

Promise<SalesforceConnectionStatus>

Implementation of

IntegrationsBindings.disableSalesforce

---

disableTwoFactorMethod()

disableTwoFactorMethod: (methodId) => Promise<TwoFactorOperationResponse>

Defined in: packages/sdk/src/client/client.ts:677

Disable a specific two-factor authentication method.

Parameters

methodId

number

Returns

Promise<TwoFactorOperationResponse>

Implementation of

AuthBindings.disableTwoFactorMethod

---

disconnectConfluence()

disconnectConfluence: (wid) => Promise<ConfluenceConnectionStatus>

Defined in: packages/sdk/src/client/client.ts:1180

Parameters

wid

string

Returns

Promise<ConfluenceConnectionStatus>

Implementation of

IntegrationsBindings.disconnectConfluence

---

disconnectHubspot()

disconnectHubspot: (wid) => Promise<HubspotConnectionStatus>

Defined in: packages/sdk/src/client/client.ts:1214

Parameters

wid

string

Returns

Promise<HubspotConnectionStatus>

Implementation of

IntegrationsBindings.disconnectHubspot

---

disconnectMondayConnection()

disconnectMondayConnection: (wid) => Promise<{ status: string; }>

Defined in: packages/sdk/src/client/client.ts:1062

Parameters

wid

string

Returns

Promise<{ status: string; }>

Implementation of

IntegrationsBindings.disconnectMondayConnection

---

disconnectOAuthProvider()

disconnectOAuthProvider: (providerSlug, credentialUuid?) => Promise<void>

Defined in: packages/sdk/src/client/client.ts:1048

Parameters

providerSlug

OAuthProviderSlug

credentialUuid?

string

Returns

Promise<void>

Implementation of

AppsBindings.disconnectOAuthProvider

---

disconnectSalesforce()

disconnectSalesforce: (wid) => Promise<SalesforceConnectionStatus>

Defined in: packages/sdk/src/client/client.ts:1192

Parameters

wid

string

Returns

Promise<SalesforceConnectionStatus>

Implementation of

IntegrationsBindings.disconnectSalesforce

---

discordLinkPreflight()

discordLinkPreflight: (wid) => Promise<void>

Defined in: packages/sdk/src/client/client.ts:1095

Step-up preflight for the Discord account-link flow (GH #20196).

A no-side-effect GET enforcing the same authenticated, stepped-up apps:write session as authorize/complete-link. Call this through the client before the full-page navigation to /oauth/authorize: a 401 insufficient_user_authentication triggers the SDK's enhanced-auth (step-up) modal + retry, so a below-assurance session is prompted here rather than hitting a raw 401 on a top-level browser navigation. Resolves (204) once the session is sufficiently assured.

Parameters

wid

string

Returns

Promise<void>

Implementation of

IntegrationsBindings.discordLinkPreflight

---

discoverOAuthMetadata()

discoverOAuthMetadata: (wid, data) => Promise<{ error?: string; metadata?: any; success: boolean; }>

Defined in: packages/sdk/src/client/client.ts:980

Discover OAuth metadata for an authorization server

Parameters

wid

string

data

oauthServerUrl

string

Returns

Promise<{ error?: string; metadata?: any; success: boolean; }>

Implementation of

ToolkitsBindings.discoverOAuthMetadata

---

dismissAllNotifications()

dismissAllNotifications: (wid) => Promise<{ dismissedCount: number; }>

Defined in: packages/sdk/src/client/client.ts:555

Dismiss all notifications for the current user in a workspace.

Parameters

wid

string

Returns

Promise<{ dismissedCount: number; }>

Implementation of

WorkspacesBindings.dismissAllNotifications

---

dismissNotification()

dismissNotification: (wid, id) => Promise<NotificationResponse>

Defined in: packages/sdk/src/client/client.ts:554

Dismiss a single notification.

Parameters

wid

string

id

number

Returns

Promise<NotificationResponse>

Implementation of

WorkspacesBindings.dismissNotification

---

downloadEmailAttachment()

downloadEmailAttachment: (wid, inboxId, emailId, attachmentId) => Promise<ArrayBuffer>

Defined in: packages/sdk/src/client/client.ts:933

Download an email attachment as raw bytes.

Parameters

wid

string

inboxId

number

emailId

number

attachmentId

string

Returns

Promise<ArrayBuffer>

Implementation of

CommunicationsBindings.downloadEmailAttachment

---

downloadFilesZip()

downloadFilesZip: (wid, fileIds, folderIds) => Promise<Blob>

Defined in: packages/sdk/src/client/client.ts:755

Download the given files + folders (folders recursively) as a single ZIP. Returns the raw archive bytes for the caller to save.

Parameters

wid

string

fileIds

number[]

folderIds

number[]

Returns

Promise<Blob>

Implementation of

FilesBindings.downloadFilesZip

---

downloadSiteSourceZip()

downloadSiteSourceZip: (wid, siteId) => Promise<Blob>

Defined in: packages/sdk/src/client/client.ts:716

Export the site's source tree as a ZIP archive (editor-gated server-side). Returns the raw archive bytes for the caller to save.

Parameters

wid

string

siteId

number

Returns

Promise<Blob>

Implementation of

SitesBindings.downloadSiteSourceZip

---

editWorkflowRevisionAsDraft()

editWorkflowRevisionAsDraft: (wid, workflowId, revisionId, data) => Promise<WorkflowRevisionSummaryResponse>

Defined in: packages/sdk/src/client/client.ts:855

Branch a published revision into the workflow's draft ("edit this revision"): the draft becomes a fresh clone of the named published revision. Pass discardDraftChanges to replace a dirty draft.

Parameters

wid

string

workflowId

string | number

revisionId

string | number

data?

EditRevisionAsDraftRequest = {}

Returns

Promise<WorkflowRevisionSummaryResponse>

Implementation of

WorkflowsBindings.editWorkflowRevisionAsDraft

---

emailPasswordLogin()

emailPasswordLogin: (email, password, organizationUuid?) => Promise<VerifyCodeResponse>

Defined in: packages/sdk/src/client/client.ts:652

Log in with email and password credentials.

Parameters

email

string

password

string

organizationUuid?

string

Returns

Promise<VerifyCodeResponse>

Implementation of

AuthBindings.emailPasswordLogin

---

emailPasswordSignup()

emailPasswordSignup: (email, password, name?, organizationUuid?) => Promise<VerifyCodeResponse>

Defined in: packages/sdk/src/client/client.ts:653

Sign up a new account with email and password.

Parameters

email

string

password

string

name?

string

organizationUuid?

string

Returns

Promise<VerifyCodeResponse>

Implementation of

AuthBindings.emailPasswordSignup

---

enableConfluence()

enableConfluence: (wid) => Promise<ConfluenceConnectionStatus>

Defined in: packages/sdk/src/client/client.ts:1182

Parameters

wid

string

Returns

Promise<ConfluenceConnectionStatus>

Implementation of

IntegrationsBindings.enableConfluence

---

enableCustomToolkit()

enableCustomToolkit: (wid, toolkitId) => Promise<CustomToolkit>

Defined in: packages/sdk/src/client/client.ts:964

Enable a custom toolkit

Parameters

wid

string

toolkitId

number

Returns

Promise<CustomToolkit>

Implementation of

ToolkitsBindings.enableCustomToolkit

---

enableHubspot()

enableHubspot: (wid) => Promise<HubspotConnectionStatus>

Defined in: packages/sdk/src/client/client.ts:1216

Parameters

wid

string

Returns

Promise<HubspotConnectionStatus>

Implementation of

IntegrationsBindings.enableHubspot

---

enableMcpServer()

enableMcpServer: (wid, serverId) => Promise<McpServerResponse>

Defined in: packages/sdk/src/client/client.ts:974

Enable an MCP server

Parameters

wid

string

serverId

number

Returns

Promise<McpServerResponse>

Implementation of

ToolkitsBindings.enableMcpServer

---

enableMondayConnection()

enableMondayConnection: (wid) => Promise<MondayConnectionStatus>

Defined in: packages/sdk/src/client/client.ts:1064

Parameters

wid

string

Returns

Promise<MondayConnectionStatus>

Implementation of

IntegrationsBindings.enableMondayConnection

---

enableOrgDomainEmail()

enableOrgDomainEmail: (orgIdOrUuid, domainUuid) => Promise<EmailDomainConfig>

Defined in: packages/sdk/src/client/client.ts:600

Enable email DNS provisioning for a verified org domain.

Parameters

orgIdOrUuid

string | number

domainUuid

string

Returns

Promise<EmailDomainConfig>

Implementation of

OrgBindings.enableOrgDomainEmail

---

enableOrgDomainSite()

enableOrgDomainSite: (orgIdOrUuid, domainUuid, options) => Promise<SiteDomainConfig>

Defined in: packages/sdk/src/client/client.ts:604

Enable custom site routing for a verified org domain.

Pass { childHosting: true } to enable the domain as a parent instead: it publishes one *.<domain> wildcard CNAME, serves nothing at its own name, and hosts are added beneath it afterwards. The mode is fixed at enable — disable and re-enable to change it.

The request always carries a JSON body, {} by default: the route requires one as a CSRF barrier.

Parameters

orgIdOrUuid

string | number

domainUuid

string

options?

childHosting?

boolean

Returns

Promise<SiteDomainConfig>

Implementation of

OrgBindings.enableOrgDomainSite

---

enablePlatformApp()

enablePlatformApp: (wid, data) => Promise<PlatformAppConnectionResponse>

Defined in: packages/sdk/src/client/client.ts:1244

Enable a platform app connection in the workspace.

Parameters

wid

string

data

CreateAppConnectionRequest

Returns

Promise<PlatformAppConnectionResponse>

Implementation of

IntegrationsBindings.enablePlatformApp

---

enableSalesforce()

enableSalesforce: (wid) => Promise<SalesforceConnectionStatus>

Defined in: packages/sdk/src/client/client.ts:1194

Parameters

wid

string

Returns

Promise<SalesforceConnectionStatus>

Implementation of

IntegrationsBindings.enableSalesforce

---

endTestChatRun()

endTestChatRun: (wid, runId) => Promise<TestChatRun>

Defined in: packages/sdk/src/client/client.ts:369

Manually end a test chat run (for human-driven runs, which have no simulator workflow to mark them completed).

Parameters

wid

string

runId

number

Returns

Promise<TestChatRun>

Implementation of

QualificationsBindings.endTestChatRun

---

enrichInquiry()

enrichInquiry: (inquiryUuid, data) => Promise<InquiryResponse>

Defined in: packages/sdk/src/client/client.ts:1036

Enrich an existing inquiry with additional fields (public endpoint). Uses the inquiry UUID (from cookie) to identify the inquiry.

Parameters

inquiryUuid

string

data

EnrichInquiryRequest

Returns

Promise<InquiryResponse>

Implementation of

AppsBindings.enrichInquiry

---

enrollMembers()

enrollMembers: (wid, journeyId, data) => Promise<MemberJourney[]>

Defined in: packages/sdk/src/client/client.ts:470

Enroll one or more members in a journey.

Parameters

wid

string

journeyId

number

data

EnrollMemberFormData

Returns

Promise<MemberJourney[]>

Implementation of

JourneysBindings.enrollMembers

---

evaluateTestChatRun()

evaluateTestChatRun: (wid, runId) => Promise<void>

Defined in: packages/sdk/src/client/client.ts:368

Parameters

wid

string

runId

number

Returns

Promise<void>

Implementation of

QualificationsBindings.evaluateTestChatRun

---

exchangeOAuthToken()

exchangeOAuthToken: (request) => Promise<TokenResponse>

Defined in: packages/sdk/src/client/client.ts:1043

Parameters

request

TokenRequest

Returns

Promise<TokenResponse>

Implementation of

AppsBindings.exchangeOAuthToken

---

exchangeToken()

exchangeToken: (token) => Promise<{ token: string; }>

Defined in: packages/sdk/src/client/client.ts:663

Exchange a cross-domain token for an authenticated session token.

Parameters

token

string

Returns

Promise<{ token: string; }>

Implementation of

AuthBindings.exchangeToken

---

executeAssignmentTool()

executeAssignmentTool: (wid, assignmentId, toolName, parameters) => Promise<ExecuteToolResponse>

Defined in: packages/sdk/src/client/client.ts:700

Execute a tool within an assignment context.

Parameters

wid

string

assignmentId

number

toolName

string

parameters?

Record<string, unknown> = {}

Returns

Promise<ExecuteToolResponse>

Implementation of

AuthBindings.executeAssignmentTool

---

expireAnonymousMember()

expireAnonymousMember: (wid, resolutionId, request?) => Promise<AnonymousMemberResolutionResponse>

Defined in: packages/sdk/src/client/client.ts:326

Expire an anonymous member without resolving to a real member. This archives the anonymous member without merging their data.

Parameters

wid

string

resolutionId

number

request?

ExpireAnonymousMemberRequest

Returns

Promise<AnonymousMemberResolutionResponse>

Implementation of

MembersBindings.expireAnonymousMember

---

exportChat()

exportChat: (wid, chatId, format) => Promise<Blob>

Defined in: packages/sdk/src/client/client.ts:202

Export a single chat in the specified format as a downloadable blob.

Parameters

wid

string

chatId

number

format?

"jsonl" = 'jsonl'

Returns

Promise<Blob>

Implementation of

ChatsBindings.exportChat

---

exportChats()

exportChats: (wid, options) => Promise<Blob>

Defined in: packages/sdk/src/client/client.ts:201

Export multiple chats as a downloadable blob.

Parameters

wid

string

options?

GetChatsOptions = {}

Returns

Promise<Blob>

Implementation of

ChatsBindings.exportChats

---

exportInquiriesCsv()

exportInquiriesCsv: (statusFilter?) => Promise<Blob>

Defined in: packages/sdk/src/client/client.ts:1041

Export inquiries to CSV with optional status filtering (superuser only)

Parameters

statusFilter?

string

Returns

Promise<Blob>

Implementation of

AppsBindings.exportInquiriesCsv

---

exportMembers()

exportMembers: (wid, selectedFields, selectedDataTypes, memberType?) => Promise<Blob>

Defined in: packages/sdk/src/client/client.ts:290

Export members as a downloadable file with selected fields and data types.

Parameters

wid

string

selectedFields

string[]

selectedDataTypes

number[]

memberType?

"member" | "anonymous" | "test"

Returns

Promise<Blob>

Implementation of

MembersBindings.exportMembers

---

exportPhoneNumberOutboundAnalyticsCsv()

exportPhoneNumberOutboundAnalyticsCsv: (wid, id, options) => Promise<Blob>

Defined in: packages/sdk/src/client/client.ts:913

Export outbound-call analytics as a CSV blob (respecting the current filters + raw state). The server returns HTTP 400 when the result set exceeds its export cap; that message is surfaced to the caller via ApiError so the UI can toast it.

Parameters

wid

string

id

number

options

analyticsSessionId

string

filters?

OutboundCallAnalyticsFilters

raw?

boolean

sort?

OutboundCallAnalyticsSortKey

sortDirection?

"asc" | "desc"

Returns

Promise<Blob>

Implementation of

CommunicationsBindings.exportPhoneNumberOutboundAnalyticsCsv

---

exportPronunciationEntries()

exportPronunciationEntries: (orgUuid) => Promise<object[]>

Defined in: packages/sdk/src/client/client.ts:1256

Export all pronunciation entries for an organization as term/respelling pairs.

Parameters

orgUuid

string

Returns

Promise<object[]>

Implementation of

PronunciationsBindings.exportPronunciationEntries

---

exportWorkspace()

exportWorkspace: (wid, workflowId?, scope?, exclude?) => Promise<WorkspaceExportData>

Defined in: packages/sdk/src/client/client.ts:572

Export workspace configuration, optionally scoped to a single workflow or workflows-only.

Parameters

wid

string

workflowId?

number

Export a single workflow by ID

scope?

"workflows"

Export scope ("workflows" for all workflows only). Cannot be combined with workflowId.

exclude?

string

Comma-separated entity categories to exclude (e.g. "channels")

Returns

Promise<WorkspaceExportData>

Implementation of

WorkspacesBindings.exportWorkspace

---

exportWorkspaceZip()

exportWorkspaceZip: (wid, workflowId?, scope?, exclude?) => Promise<ArrayBuffer>

Defined in: packages/sdk/src/client/client.ts:573

Download a workspace export ZIP (export.json + file blobs).

Parameters

wid

string

workflowId?

number

scope?

"workflows"

exclude?

string

Returns

Promise<ArrayBuffer>

Implementation of

WorkspacesBindings.exportWorkspaceZip

---

fetchVoicemailAudio()

fetchVoicemailAudio: (wid, phoneNumberId, voicemailId) => Promise<ArrayBuffer>

Defined in: packages/sdk/src/client/client.ts:917

Fetch voicemail audio through the authenticated client path.

Parameters

wid

string

phoneNumberId

number

voicemailId

number

Returns

Promise<ArrayBuffer>

Implementation of

CommunicationsBindings.fetchVoicemailAudio

---

fhirBackfillEncounterSync()

fhirBackfillEncounterSync: (wid, connectionId, data) => Promise<EncounterSyncRunResponse>

Defined in: packages/sdk/src/client/client.ts:1148

Parameters

wid

string

connectionId

number

data

TriggerConnectionBackfillRequest

Returns

Promise<EncounterSyncRunResponse>

Implementation of

IntegrationsBindings.fhirBackfillEncounterSync

---

fhirCheckPatientLinks()

fhirCheckPatientLinks: (wid, connectionId, data) => Promise<FhirPatientLinkCheckResponse>

Defined in: packages/sdk/src/client/client.ts:1132

Bounded, read-only check of which external patient IDs are already linked on this connection. PHI-minimal: sends/returns external patient IDs only — never demographics.

Parameters

wid

string

connectionId

number

data

CheckFhirPatientLinksRequest

Returns

Promise<FhirPatientLinkCheckResponse>

Implementation of

IntegrationsBindings.fhirCheckPatientLinks

---

fhirCreateEncounter()

fhirCreateEncounter: (wid, connectionId, data) => Promise<FhirMethodResponse>

Defined in: packages/sdk/src/client/client.ts:1130

Create a telephone encounter for a patient via the FHIR connection.

Parameters

wid

string

connectionId

number

data

FhirCreateEncounterRequest

Returns

Promise<FhirMethodResponse>

Implementation of

IntegrationsBindings.fhirCreateEncounter

---

fhirCsvImportApply()

fhirCsvImportApply: (wid, connectionId, file, columns?) => Promise<Response>

Defined in: packages/sdk/src/client/client.ts:1140

Parameters

wid

string

connectionId

number

file

File

columns?

birthdateColumn?

string

identifierColumn

string

Returns

Promise<Response>

Implementation of

IntegrationsBindings.fhirCsvImportApply

---

fhirCsvImportInspect()

fhirCsvImportInspect: (wid, connectionId, file) => Promise<FhirCsvInspectResponse>

Defined in: packages/sdk/src/client/client.ts:1137

Parameters

wid

string

connectionId

number

file

File

Returns

Promise<FhirCsvInspectResponse>

Implementation of

IntegrationsBindings.fhirCsvImportInspect

---

fhirFetchCareTeam()

fhirFetchCareTeam: (wid, connectionId, data) => Promise<FhirMethodResponse>

Defined in: packages/sdk/src/client/client.ts:1128

Fetch care team for a patient via the FHIR connection.

Parameters

wid

string

connectionId

number

data

FhirFetchCareTeamRequest

Returns

Promise<FhirMethodResponse>

Implementation of

IntegrationsBindings.fhirFetchCareTeam

---

fhirFetchEncounters()

fhirFetchEncounters: (wid, connectionId, data) => Promise<FhirMethodResponse>

Defined in: packages/sdk/src/client/client.ts:1129

Fetch encounters for a patient via the FHIR connection.

Parameters

wid

string

connectionId

number

data

FhirFetchEncountersRequest

Returns

Promise<FhirMethodResponse>

Implementation of

IntegrationsBindings.fhirFetchEncounters

---

fhirGetCsvImportRunItems()

fhirGetCsvImportRunItems: (wid, connectionId, runId, limit) => Promise<FhirCsvImportRunItem[]>

Defined in: packages/sdk/src/client/client.ts:1142

Parameters

wid

string

connectionId

number

runId

string

limit?

number = 500

Returns

Promise<FhirCsvImportRunItem[]>

Implementation of

IntegrationsBindings.fhirGetCsvImportRunItems

---

fhirGetCsvImportRuns()

fhirGetCsvImportRuns: (wid, connectionId, limit) => Promise<FhirCsvImportRunSummary[]>

Defined in: packages/sdk/src/client/client.ts:1141

Parameters

wid

string

connectionId

number

limit?

number = 20

Returns

Promise<FhirCsvImportRunSummary[]>

Implementation of

IntegrationsBindings.fhirGetCsvImportRuns

---

fhirGetCsvImportSettings()

fhirGetCsvImportSettings: (wid, connectionId) => Promise<FhirCsvImportSettings>

Defined in: packages/sdk/src/client/client.ts:1138

Parameters

wid

string

connectionId

number

Returns

Promise<FhirCsvImportSettings>

Implementation of

IntegrationsBindings.fhirGetCsvImportSettings

---

fhirGetEncounterSyncRuns()

fhirGetEncounterSyncRuns: (wid, connectionId, limit) => Promise<EncounterSyncHistoryItem[]>

Defined in: packages/sdk/src/client/client.ts:1146

Parameters

wid

string

connectionId

number

limit?

number = 20

Returns

Promise<EncounterSyncHistoryItem[]>

Implementation of

IntegrationsBindings.fhirGetEncounterSyncRuns

---

fhirGetEncounterSyncStatus()

fhirGetEncounterSyncStatus: (wid, connectionId) => Promise<EncounterSyncStatusResponse>

Defined in: packages/sdk/src/client/client.ts:1143

Parameters

wid

string

connectionId

number

Returns

Promise<EncounterSyncStatusResponse>

Implementation of

IntegrationsBindings.fhirGetEncounterSyncStatus

---

fhirImportPatient()

fhirImportPatient: (wid, connectionId, data) => Promise<FhirMethodResponse>

Defined in: packages/sdk/src/client/client.ts:1136

Parameters

wid

string

connectionId

number

data

memberRoleId?

number

patientId

string

Returns

Promise<FhirMethodResponse>

Implementation of

IntegrationsBindings.fhirImportPatient

---

fhirLinkMember()

fhirLinkMember: (wid, connectionId, data) => Promise<FhirMethodResponse>

Defined in: packages/sdk/src/client/client.ts:1133

Parameters

wid

string

connectionId

number

data

memberId

number

patientId

string

Returns

Promise<FhirMethodResponse>

Implementation of

IntegrationsBindings.fhirLinkMember

---

fhirListLinkedMembers()

fhirListLinkedMembers: (wid, connectionId, params?) => Promise<PaginatedResponse<FhirLinkedMember>>

Defined in: packages/sdk/src/client/client.ts:1131

Parameters

wid

string

connectionId

number

params?

page?

number

pageSize?

number

search?

string

Returns

Promise<PaginatedResponse<FhirLinkedMember>>

Implementation of

IntegrationsBindings.fhirListLinkedMembers

---

fhirRefreshEncounterPatient()

fhirRefreshEncounterPatient: (wid, connectionId, data) => Promise<EncounterSyncRunResponse>

Defined in: packages/sdk/src/client/client.ts:1147

Parameters

wid

string

connectionId

number

data

TriggerPatientRefreshRequest

Returns

Promise<EncounterSyncRunResponse>

Implementation of

IntegrationsBindings.fhirRefreshEncounterPatient

---

fhirRunEncounterSync()

fhirRunEncounterSync: (wid, connectionId) => Promise<EncounterSyncRunResponse>

Defined in: packages/sdk/src/client/client.ts:1145

Parameters

wid

string

connectionId

number

Returns

Promise<EncounterSyncRunResponse>

Implementation of

IntegrationsBindings.fhirRunEncounterSync

---

fhirSearchLocations()

fhirSearchLocations: (wid, connectionId, data) => Promise<FhirMethodResponse>

Defined in: packages/sdk/src/client/client.ts:1127

Search for locations via the FHIR connection.

Parameters

wid

string

connectionId

number

data

FhirSearchLocationsRequest

Returns

Promise<FhirMethodResponse>

Implementation of

IntegrationsBindings.fhirSearchLocations

---

fhirSearchPatients()

fhirSearchPatients: (wid, connectionId, data) => Promise<FhirMethodResponse>

Defined in: packages/sdk/src/client/client.ts:1125

Search for patients via the FHIR connection.

Parameters

wid

string

connectionId

number

data

FhirSearchPatientsRequest

Returns

Promise<FhirMethodResponse>

Implementation of

IntegrationsBindings.fhirSearchPatients

---

fhirSearchPractitioners()

fhirSearchPractitioners: (wid, connectionId, data) => Promise<FhirMethodResponse>

Defined in: packages/sdk/src/client/client.ts:1126

Search for practitioners via the FHIR connection.

Parameters

wid

string

connectionId

number

data

FhirSearchPractitionersRequest

Returns

Promise<FhirMethodResponse>

Implementation of

IntegrationsBindings.fhirSearchPractitioners

---

fhirSyncMember()

fhirSyncMember: (wid, connectionId, memberId) => Promise<FhirMethodResponse>

Defined in: packages/sdk/src/client/client.ts:1135

Parameters

wid

string

connectionId

number

memberId

number

Returns

Promise<FhirMethodResponse>

Implementation of

IntegrationsBindings.fhirSyncMember

---

fhirUnlinkMember()

fhirUnlinkMember: (wid, connectionId, memberId) => Promise<FhirMethodResponse>

Defined in: packages/sdk/src/client/client.ts:1134

Parameters

wid

string

connectionId

number

memberId

number

Returns

Promise<FhirMethodResponse>

Implementation of

IntegrationsBindings.fhirUnlinkMember

---

fhirUpdateCsvImportSettings()

fhirUpdateCsvImportSettings: (wid, connectionId, data) => Promise<FhirCsvImportSettings>

Defined in: packages/sdk/src/client/client.ts:1139

Parameters

wid

string

connectionId

number

data

UpdateFhirCsvImportSettingsRequest

Returns

Promise<FhirCsvImportSettings>

Implementation of

IntegrationsBindings.fhirUpdateCsvImportSettings

---

fhirUpdateEncounterSync()

fhirUpdateEncounterSync: (wid, connectionId, data) => Promise<EncounterSyncStatusResponse>

Defined in: packages/sdk/src/client/client.ts:1144

Parameters

wid

string

connectionId

number

data

UpdateEncounterSyncRequest

Returns

Promise<EncounterSyncStatusResponse>

Implementation of

IntegrationsBindings.fhirUpdateEncounterSync

---

findOrCreateDMChat()

findOrCreateDMChat: (wid, memberId) => Promise<ChatResponse>

Defined in: packages/sdk/src/client/client.ts:203

Find or create a DM chat with a specific member. Returns the Chat object for the DM conversation.

Parameters

wid

string

memberId

number

Returns

Promise<ChatResponse>

Implementation of

ChatsBindings.findOrCreateDMChat

---

generateFileUploadUrl()

generateFileUploadUrl: (wid, request) => Promise<FileUploadResponse>

Defined in: packages/sdk/src/client/client.ts:765

Generate a pre-signed upload URL for uploading file content.

Parameters

wid

string

request

FileUploadRequest

Returns

Promise<FileUploadResponse>

Implementation of

FilesBindings.generateFileUploadUrl

---

generateICalToken()

generateICalToken: (wid, calendarId, regenerate) => Promise<ICalFeedTokenResponse>

Defined in: packages/sdk/src/client/client.ts:892

Generate or regenerate an iCal feed token for a calendar.

Parameters

wid

string

calendarId

number

regenerate?

boolean = false

Returns

Promise<ICalFeedTokenResponse>

Implementation of

CalendarsBindings.generateICalToken

---

generateRecoveryCodes()

generateRecoveryCodes: (data) => Promise<RecoveryCodesResponse>

Defined in: packages/sdk/src/client/client.ts:676

Generate new two-factor recovery codes, invalidating any existing ones.

Parameters

data?

GenerateRecoveryCodesRequest = {}

Returns

Promise<RecoveryCodesResponse>

Implementation of

AuthBindings.generateRecoveryCodes

---

generateSiteMediaUploadUrl()

generateSiteMediaUploadUrl: (wid, siteId, uploadRequest) => Promise<FileUploadResponse>

Defined in: packages/sdk/src/client/client.ts:744

Generate a pre-signed upload URL for site media content.

Parameters

wid

string

siteId

number

uploadRequest

FileUploadRequest

Returns

Promise<FileUploadResponse>

Implementation of

SitesBindings.generateSiteMediaUploadUrl

---

getA2PCampaignConfig()

getA2PCampaignConfig: (orgUuid, brandUuid) => Promise<A2PCampaignConfigResponse>

Defined in: packages/sdk/src/client/client.ts:624

Fetch a brand's resolved A2P campaign config. The response carries both the raw overrides and the resolved payload (defaults + overrides) the editor previews — including the canonical SMS consent text.

Parameters

orgUuid

string

brandUuid

string

Returns

Promise<A2PCampaignConfigResponse>

Implementation of

OrgBindings.getA2PCampaignConfig

---

getAbilityType()

getAbilityType: (wid, slug) => Promise<AbilityTypeResponse>

Defined in: packages/sdk/src/client/client.ts:156

Get the full spec for a single ability type by slug.

Parameters

wid

string

slug

string

Returns

Promise<AbilityTypeResponse>

Implementation of

TasksBindings.getAbilityType

---

getAbilityTypes()

getAbilityTypes: (wid, options) => Promise<AbilityTypesResponse>

Defined in: packages/sdk/src/client/client.ts:155

List available ability types from the registry. Pass includeSystem to also return auto-injected system abilities.

Parameters

wid

string

options?

includeSystem?

boolean

Returns

Promise<AbilityTypesResponse>

Implementation of

TasksBindings.getAbilityTypes

---

getAccessGrant()

getAccessGrant: (wid, uuid) => Promise<AccessGrant>

Defined in: packages/sdk/src/client/client.ts:517

Get a single access grant by UUID.

Parameters

wid

string

uuid

string

Returns

Promise<AccessGrant>

Implementation of

AccessGrantsBindings.getAccessGrant

---

getAccessGrants()

getAccessGrants: (wid, params?) => Promise<PaginatedResponse<AccessGrant>>

Defined in: packages/sdk/src/client/client.ts:521

List all access grants with optional filtering by status, resource type, and resource ID.

Parameters

wid

string

params?

page?

number

pageSize?

number

resourceId?

number

resourceType?

string

status?

string

Returns

Promise<PaginatedResponse<AccessGrant>>

Implementation of

AccessGrantsBindings.getAccessGrants

---

getActivityCapabilities()

getActivityCapabilities: () => Promise<ActivityCapabilitiesResponse>

Defined in: packages/sdk/src/client/client.ts:414

What this caller's estate admits, so a client renders honest controls.

Account mount only, and deliberately so: the org and workspace mounts answer the same question through the surfaces that already serve their membership. Not an authorization decision — every read re-derives that.

Returns

Promise<ActivityCapabilitiesResponse>

Implementation of

ActivityBindings.getActivityCapabilities

---

getActivityCounts()

getActivityCounts: (request) => Promise<ActivityCountsResponse>

Defined in: packages/sdk/src/client/client.ts:413

The account mount's badge numbers.

Parameters

request?

ActivityCountsRequest = {}

Returns

Promise<ActivityCountsResponse>

Implementation of

ActivityBindings.getActivityCounts

---

getAgent()

getAgent: (wid, id) => Promise<AgentResponse>

Defined in: packages/sdk/src/client/client.ts:349

Get a single agent by ID.

Parameters

wid

string

id

number

Returns

Promise<AgentResponse>

Implementation of

AgentsBindings.getAgent

---

getAgentModeAttention()

getAgentModeAttention: (wid) => Promise<AgentModeAttentionItem[]>

Defined in: packages/sdk/src/client/client.ts:526

List every visible Chat that currently needs attention in Agent Mode.

Parameters

wid

string

Returns

Promise<AgentModeAttentionItem[]>

Implementation of

InterventionRequestsBindings.getAgentModeAttention

---

getAgents()

getAgents: (wid, options) => Promise<PaginatedResponse<AgentResponse>>

Defined in: packages/sdk/src/client/client.ts:348

List agents in a workspace with optional pagination, sorting, and search.

Parameters

wid

string

options?

includeArchived?

boolean

owner?

AgentOwnerFilter

page?

number

pageSize?

number

search?

string

sortBy?

AgentSortField

sortOrder?

SortOrder

Returns

Promise<PaginatedResponse<AgentResponse>>

Implementation of

AgentsBindings.getAgents

---

getAgentTask()

getAgentTask: (wid, taskUuid) => Promise<AgentTaskResponse>

Defined in: packages/sdk/src/client/client.ts:343

Parameters

wid

string

taskUuid

string

Returns

Promise<AgentTaskResponse>

Implementation of

AgentTasksBindings.getAgentTask

---

getAgentTaskMessages()

getAgentTaskMessages: (wid, taskUuid, params?) => Promise<AgentTaskMessageResponse[]>

Defined in: packages/sdk/src/client/client.ts:345

Parameters

wid

string

taskUuid

string

params?

GetAgentTaskMessagesParams

Returns

Promise<AgentTaskMessageResponse[]>

Implementation of

AgentTasksBindings.getAgentTaskMessages

---

getAgentTasks()

getAgentTasks: (wid, params?) => Promise<AgentTaskResponse[]>

Defined in: packages/sdk/src/client/client.ts:342

Parameters

wid

string

params?

ListAgentTasksParams

Returns

Promise<AgentTaskResponse[]>

Implementation of

AgentTasksBindings.getAgentTasks

---

getAIUsageReport()

getAIUsageReport: (wid, params?) => Promise<AIUsageReport>

Defined in: packages/sdk/src/client/client.ts:1015

Get AI model usage report for a workspace within an optional date range.

Parameters

wid

string

params?

AIUsageReportParams

Returns

Promise<AIUsageReport>

Implementation of

BillingBindings.getAIUsageReport

---

getAllModels()

getAllModels: (provider?, includeUnavailable) => Promise<AllModelsResponse>

Defined in: packages/sdk/src/client/client.ts:958

Get all AI models with full metadata including multipliers Returns models grouped by type (chat, realtime, image, stt, tts)

Parameters

provider?

string

includeUnavailable?

boolean = false

Returns

Promise<AllModelsResponse>

Implementation of

ToolkitsBindings.getAllModels

---

getAnonymousResolution()

getAnonymousResolution: (wid, resolutionId) => Promise<AnonymousMemberResolutionResponse>

Defined in: packages/sdk/src/client/client.ts:324

Get a single anonymous member resolution by ID.

Parameters

wid

string

resolutionId

number

Returns

Promise<AnonymousMemberResolutionResponse>

Implementation of

MembersBindings.getAnonymousResolution

---

getAnonymousResolutions()

getAnonymousResolutions: (wid, options?) => Promise<PendingAnonymousMembersResponse>

Defined in: packages/sdk/src/client/client.ts:323

List anonymous member resolutions with filtering and pagination. Returns pending resolutions by default.

Parameters

wid

string

options?

page?

number

pageSize?

number

status?

"pending" | "expired" | "resolved"

Returns

Promise<PendingAnonymousMembersResponse>

Implementation of

MembersBindings.getAnonymousResolutions

---

getApiKeys()

getApiKeys: (wid) => Promise<ApiKey[]>

Defined in: packages/sdk/src/client/client.ts:994

List all API keys for a workspace.

Parameters

wid

string

Returns

Promise<ApiKey[]>

Implementation of

BillingBindings.getApiKeys

---

getApp()

getApp: (appId) => Promise<App>

Defined in: packages/sdk/src/client/client.ts:1024

Get details of a specific app

Parameters

appId

string

Returns

Promise<App>

Implementation of

AppsBindings.getApp

---

getAppByClientId()

getAppByClientId: (clientId) => Promise<App>

Defined in: packages/sdk/src/client/client.ts:1025

Get app by client ID (for OAuth flows)

Parameters

clientId

string

Returns

Promise<App>

Implementation of

AppsBindings.getAppByClientId

---

getArchiveBlockers()

getArchiveBlockers: (wid, id) => Promise<ArchiveBlockersResponse>

Defined in: packages/sdk/src/client/client.ts:908

Get archive blockers for a phone number.

Parameters

wid

string

id

number

Returns

Promise<ArchiveBlockersResponse>

Implementation of

CommunicationsBindings.getArchiveBlockers

---

getAssignment()

getAssignment: (wid, id) => Promise<Assignment>

Defined in: packages/sdk/src/client/client.ts:689

Get a single assignment by ID.

Parameters

wid

string

id

number

Returns

Promise<Assignment>

Implementation of

AuthBindings.getAssignment

---

getAssignmentCelContext()

getAssignmentCelContext: (wid, assignmentId) => Promise<Record<string, unknown>>

Defined in: packages/sdk/src/client/client.ts:697

Get the CEL expression evaluation context for an assignment.

Parameters

wid

string

assignmentId

number

Returns

Promise<Record<string, unknown>>

Implementation of

AuthBindings.getAssignmentCelContext

---

getAssignmentMessages()

getAssignmentMessages: (wid, id) => Promise<ChatMessage[]>

Defined in: packages/sdk/src/client/client.ts:690

Get all chat messages for an assignment.

Parameters

wid

string

id

number

Returns

Promise<ChatMessage[]>

Implementation of

AuthBindings.getAssignmentMessages

---

getAssignments()

getAssignments: (wid, options) => Promise<PaginatedResponse<Assignment>>

Defined in: packages/sdk/src/client/client.ts:688

List assignments with optional filtering, pagination, and sorting.

Parameters

wid

string

options?

AssignmentsQueryParams = {}

Returns

Promise<PaginatedResponse<Assignment>>

Implementation of

AuthBindings.getAssignments

---

getAssignmentTask()

getAssignmentTask: (wid, id, assignmentTaskId) => Promise<AssignmentTaskResponse>

Defined in: packages/sdk/src/client/client.ts:693

Get a specific task within an assignment.

Parameters

wid

string

id

number

assignmentTaskId

number

Returns

Promise<AssignmentTaskResponse>

Implementation of

AuthBindings.getAssignmentTask

---

getAssignmentTaskDetail()

getAssignmentTaskDetail: (wid, assignmentId) => Promise<OperatorTaskDetailResponse>

Defined in: packages/sdk/src/client/client.ts:696

Get the current task detail for an assignment from the operator perspective.

Parameters

wid

string

assignmentId

number

Returns

Promise<OperatorTaskDetailResponse>

Implementation of

AuthBindings.getAssignmentTaskDetail

---

getAssignmentTools()

getAssignmentTools: (wid, assignmentId) => Promise<ToolsResponse>

Defined in: packages/sdk/src/client/client.ts:699

List available tools for an assignment.

Parameters

wid

string

assignmentId

number

Returns

Promise<ToolsResponse>

Implementation of

AuthBindings.getAssignmentTools

---

getAvailableActions()

getAvailableActions: (wid) => Promise<EventActionMappingsResponse>

Defined in: packages/sdk/src/client/client.ts:795

Get the available action types that can be used in event rules.

Parameters

wid

string

Returns

Promise<EventActionMappingsResponse>

Implementation of

EventsBindings.getAvailableActions

---

getAvailablePhoneNumbers()

getAvailablePhoneNumbers: (wid) => Promise<object[]>

Defined in: packages/sdk/src/client/client.ts:903

List phone numbers available for provisioning.

Parameters

wid

string

Returns

Promise<object[]>

Implementation of

CommunicationsBindings.getAvailablePhoneNumbers

---

getAvailableScopes()

getAvailableScopes: () => Promise<ScopesListResponse>

Defined in: packages/sdk/src/client/client.ts:1044

Returns

Promise<ScopesListResponse>

Implementation of

AppsBindings.getAvailableScopes

---

getAvailableSlots()

getAvailableSlots: (wid, calendarId, request) => Promise<AvailableSlotsResponse>

Defined in: packages/sdk/src/client/client.ts:879

Get available booking slots for a calendar within a date range.

Parameters

wid

string

calendarId

number

request

AvailableSlotsRequest

Returns

Promise<AvailableSlotsResponse>

Implementation of

CalendarsBindings.getAvailableSlots

---

getAvailableWorkspaceFeatures()

getAvailableWorkspaceFeatures: () => Promise<WorkspaceFeatureInfo[]>

Defined in: packages/sdk/src/client/client.ts:548

List all available workspace feature flags from the registry.

Returns

Promise<WorkspaceFeatureInfo[]>

Implementation of

WorkspacesBindings.getAvailableWorkspaceFeatures

---

getBuilder()

getBuilder: (builderId) => Promise<BuilderResponse>

Defined in: packages/sdk/src/client/client.ts:1030

Get a specific builder by UUID

Parameters

builderId

string

Returns

Promise<BuilderResponse>

Implementation of

AppsBindings.getBuilder

---

getBuilderApps()

getBuilderApps: (builderId) => Promise<AppListResponse>

Defined in: packages/sdk/src/client/client.ts:1031

Get apps for a specific builder

Parameters

builderId

string

Returns

Promise<AppListResponse>

Implementation of

AppsBindings.getBuilderApps

---

getBusinessHoursStatus()

getBusinessHoursStatus: (wid) => Promise<{ isBusinessHours: boolean; }>

Defined in: packages/sdk/src/client/client.ts:547

Check whether the workspace is currently within business hours.

Parameters

wid

string

Returns

Promise<{ isBusinessHours: boolean; }>

Implementation of

WorkspacesBindings.getBusinessHoursStatus

---

getBusinessProfile()

getBusinessProfile: (orgUuid, legalEntityUuid?) => Promise<BusinessProfile>

Defined in: packages/sdk/src/client/client.ts:611

Live fetch of the org's Twilio Customer Profile + related entities.

Response carries both the lifecycle status and the compliance evaluationStatus. Twilio models lifecycle and evaluation as two separate enums on two separate resources, so the Submit-button gate is evaluationStatus === 'compliant' — never status === 'compliant', which is impossible (lifecycle status is one of draft / pending-review / in-review / twilio-approved / twilio-rejected).

Parameters

orgUuid

string

legalEntityUuid?

string | null

Returns

Promise<BusinessProfile>

Implementation of

OrgBindings.getBusinessProfile

---

getCalendar()

getCalendar: (wid, id, includeSchedules?) => Promise<Calendar>

Defined in: packages/sdk/src/client/client.ts:870

Get a single calendar by ID, optionally including its schedules.

Parameters

wid

string

id

number

includeSchedules?

boolean

Returns

Promise<Calendar>

Implementation of

CalendarsBindings.getCalendar

---

getCalendarEvent()

getCalendarEvent: (wid, eventId) => Promise<EventResponse>

Defined in: packages/sdk/src/client/client.ts:881

Get a single calendar event by ID.

Parameters

wid

string

eventId

number

Returns

Promise<EventResponse>

Implementation of

CalendarsBindings.getCalendarEvent

---

getCalendarEvents()

getCalendarEvents: (wid, options) => Promise<PaginatedResponse<EventResponse>>

Defined in: packages/sdk/src/client/client.ts:880

List calendar events with optional filtering by date range, status, and member.

Parameters

wid

string

options?

CalendarEventsQueryParams = {}

Returns

Promise<PaginatedResponse<EventResponse>>

Implementation of

CalendarsBindings.getCalendarEvents

---

getCalendarEventType()

getCalendarEventType: (wid, id) => Promise<EventTypeResponse>

Defined in: packages/sdk/src/client/client.ts:888

Get a single calendar event type by ID.

Parameters

wid

string

id

number

Returns

Promise<EventTypeResponse>

Implementation of

CalendarsBindings.getCalendarEventType

---

getCalendarEventTypes()

getCalendarEventTypes: (wid, options?) => Promise<PaginatedResponse<EventTypeResponse>>

Defined in: packages/sdk/src/client/client.ts:887

List all calendar event types in the workspace.

Parameters

wid

string

options?

page?

number

pageSize?

number

Returns

Promise<PaginatedResponse<EventTypeResponse>>

Implementation of

CalendarsBindings.getCalendarEventTypes

---

getCalendars()

getCalendars: (wid, params?) => Promise<PaginatedResponse<Calendar>>

Defined in: packages/sdk/src/client/client.ts:869

List calendars in a workspace with optional pagination.

Parameters

wid

string

params?

includeSchedules?

boolean

page?

number

pageSize?

number

Returns

Promise<PaginatedResponse<Calendar>>

Implementation of

CalendarsBindings.getCalendars

---

getCalendarSchedules()

getCalendarSchedules: (wid, calendarId) => Promise<CalendarSchedule[]>

Defined in: packages/sdk/src/client/client.ts:874

List all schedules for a calendar.

Parameters

wid

string

calendarId

number

Returns

Promise<CalendarSchedule[]>

Implementation of

CalendarsBindings.getCalendarSchedules

---

getCallRecordingDownloadUrl()

getCallRecordingDownloadUrl: (wid, chatId, options) => Promise<CallRecordingDownloadUrlResponse>

Defined in: packages/sdk/src/client/client.ts:225

Get a single short-lived presigned URL to download the complete call recording as one WAV file. The first request assembles + caches the full-call WAV; later requests reuse it.

Parameters

wid

string

chatId

number

options?

expiresIn?

number

Returns

Promise<CallRecordingDownloadUrlResponse>

Implementation of

CallsBindings.getCallRecordingDownloadUrl

---

getCelContext()

getCelContext: (wid, request) => Promise<CELContextResponse>

Defined in: packages/sdk/src/client/client.ts:226

Get available CEL context for expression editing.

Returns variables, custom functions, and operators appropriate for the given context (event type, data type, context type, etc.).

Parameters

wid

string

request

CELContextRequest

Returns

Promise<CELContextResponse>

Implementation of

CallsBindings.getCelContext

---

getCharlestonTestDeliveryRecipients()

getCharlestonTestDeliveryRecipients: (wid) => Promise<CharlestonTestDeliveryRecipientOption[]>

Defined in: packages/sdk/src/client/client.ts:161

List recipient-directory rows approved for Charleston PMD test delivery (CS-150). Returns only {recipientKey, displayLabel} for active, test-delivery-allowed rows with a device id — never the PatientSync recipient_id. Scoped to agents:write + the charleston_nephrology_pmd_paging feature; used by the ability-config test-delivery dropdown. Kept on the ability-configuration API (not generic DataRecords) because the actual ability-editor scopes do not guarantee generic record access.

Parameters

wid

string

Returns

Promise<CharlestonTestDeliveryRecipientOption[]>

Implementation of

TasksBindings.getCharlestonTestDeliveryRecipients

---

getChat()

getChat: (wid, id) => Promise<ChatResponse>

Defined in: packages/sdk/src/client/client.ts:165

Get a single chat by ID.

Parameters

wid

string

id

number

Returns

Promise<ChatResponse>

Implementation of

ChatsBindings.getChat

---

getChatAssignmentTasks()

getChatAssignmentTasks: (wid, chatId) => Promise<object[]>

Defined in: packages/sdk/src/client/client.ts:199

Get assignment tasks linked to a chat.

Parameters

wid

string

chatId

number

Returns

Promise<object[]>

Implementation of

ChatsBindings.getChatAssignmentTasks

---

getChatBrowserLiveView()

getChatBrowserLiveView: (wid, chatId) => Promise<BrowserLiveViewResponse | null>

Defined in: packages/sdk/src/client/client.ts:166

Get a short-lived, interactive AgentCore browser view for this Chat.

The signed URL is deliberately response-local. Callers must keep it in memory only and request a fresh value when reopening the view.

Parameters

wid

string

chatId

number

Returns

Promise<BrowserLiveViewResponse | null>

Implementation of

ChatsBindings.getChatBrowserLiveView

---

getChatCallbacks()

getChatCallbacks: (wid, chatId) => Promise<ScheduledCallbackListResponse>

Defined in: packages/sdk/src/client/client.ts:169

List scheduled callbacks for a chat (newest first).

Parameters

wid

string

chatId

number

Returns

Promise<ScheduledCallbackListResponse>

Implementation of

ChatsBindings.getChatCallbacks

---

getChatEhrWritebackOutcomes()

getChatEhrWritebackOutcomes: (wid, chatId, options) => Promise<EhrWritebackOutcomeListResponse>

Defined in: packages/sdk/src/client/client.ts:170

List EHR write-back outcomes for a chat (newest first).

Operator surface: the endpoint requires chats:read in addition to the chat's own object authorization, so a chat owner reading their own chat does not reach it. The response carries IDs and closed-vocabulary codes only — no note body, summary, member fields, or provider messages.

Parameters

wid

string

chatId

number

options?

cursor?

string

limit?

number

Returns

Promise<EhrWritebackOutcomeListResponse>

Implementation of

ChatsBindings.getChatEhrWritebackOutcomes

---

getChatEmails()

getChatEmails: (wid, inboxId, chatId, options) => Promise<ChatEmailsResponse>

Defined in: packages/sdk/src/client/client.ts:936

List emails associated with a chat with pagination.

Parameters

wid

string

inboxId

number

chatId

number

options?

includeAttachments?

boolean

page?

number

pageSize?

number

Returns

Promise<ChatEmailsResponse>

Implementation of

CommunicationsBindings.getChatEmails

---

getChatFeedback()

getChatFeedback: (wid, chatId, options) => Promise<WorkflowFeedbackListResponse>

Defined in: packages/sdk/src/client/client.ts:198

List durable feedback rows for a chat (thumbs, explicit, supervisor, extracted).

Parameters

wid

string

chatId

number

options?

GetWorkflowFeedbackOptions = {}

Returns

Promise<WorkflowFeedbackListResponse>

Implementation of

ChatsBindings.getChatFeedback

---

getChatFilter()

getChatFilter: (wid, id) => Promise<ChatFilterResponse>

Defined in: packages/sdk/src/client/client.ts:213

Get a chat filter by ID.

Parameters

wid

string

id

number

Returns

Promise<ChatFilterResponse>

Implementation of

ChatsBindings.getChatFilter

---

getChatFilterByUuid()

getChatFilterByUuid: (wid, uuid) => Promise<ChatFilterResponse>

Defined in: packages/sdk/src/client/client.ts:214

Get a chat filter by UUID.

Parameters

wid

string

uuid

string

Returns

Promise<ChatFilterResponse>

Implementation of

ChatsBindings.getChatFilterByUuid

---

getChatFilterCount()

getChatFilterCount: (wid, filterId) => Promise<{ count: number; }>

Defined in: packages/sdk/src/client/client.ts:218

Get the count of chats matching a saved filter.

Parameters

wid

string

filterId

number

Returns

Promise<{ count: number; }>

Implementation of

ChatsBindings.getChatFilterCount

---

getChatFilters()

getChatFilters: (wid) => Promise<ChatFilterResponse[]>

Defined in: packages/sdk/src/client/client.ts:212

List all chat filters in a workspace.

Parameters

wid

string

Returns

Promise<ChatFilterResponse[]>

Implementation of

ChatsBindings.getChatFilters

---

getChatLabel()

getChatLabel: (wid, id) => Promise<ChatLabelResponse>

Defined in: packages/sdk/src/client/client.ts:207

Get a chat label by ID.

Parameters

wid

string

id

number

Returns

Promise<ChatLabelResponse>

Implementation of

ChatsBindings.getChatLabel

---

getChatLabelByUuid()

getChatLabelByUuid: (wid, uuid) => Promise<ChatLabelResponse>

Defined in: packages/sdk/src/client/client.ts:208

Get a chat label by UUID.

Parameters

wid

string

uuid

string

Returns

Promise<ChatLabelResponse>

Implementation of

ChatsBindings.getChatLabelByUuid

---

getChatLabels()

getChatLabels: (wid) => Promise<ChatLabelResponse[]>

Defined in: packages/sdk/src/client/client.ts:206

List all chat labels in a workspace.

Parameters

wid

string

Returns

Promise<ChatLabelResponse[]>

Implementation of

ChatsBindings.getChatLabels

---

getChatMachineResources()

getChatMachineResources: (wid, chatId) => Promise<ChatMachineResourcesResponse>

Defined in: packages/sdk/src/client/client.ts:167

Which machine resources this Chat is running right now.

Infrastructure state only — no Chat content — so it is safe to poll while a Chat is open.

Parameters

wid

string

chatId

number

Returns

Promise<ChatMachineResourcesResponse>

Implementation of

ChatsBindings.getChatMachineResources

---

getChatMessages()

getChatMessages: (wid, id, limit?, offset?, before?) => Promise<ChatMessage[]>

Defined in: packages/sdk/src/client/client.ts:191

List messages in a chat with optional pagination. id is the numeric chat id (documented) or the chat uuid (accepted).

Parameters

wid

string

id

string | number

limit?

number

offset?

number

before?

string

Returns

Promise<ChatMessage[]>

Implementation of

ChatsBindings.getChatMessages

---

getChatModelOverride()

getChatModelOverride: (wid, id) => Promise<ChatModelOverrideResponse>

Defined in: packages/sdk/src/client/client.ts:187

Get per-chat model provenance for the Chat sidebar's model summary area: the effective chat + realtime models, the agent's current default (the reset/inherit target), and pinned/matches flags.

Parameters

wid

string

id

number

Returns

Promise<ChatModelOverrideResponse>

Implementation of

ChatsBindings.getChatModelOverride

---

getChatModels()

getChatModels: (provider?) => Promise<AIModelsResponse>

Defined in: packages/sdk/src/client/client.ts:952

Get available chat AI models

Parameters

provider?

string

Returns

Promise<AIModelsResponse>

Implementation of

ToolkitsBindings.getChatModels

---

getChatPhoneCalls()

getChatPhoneCalls: (wid, chatId) => Promise<PhoneCall[]>

Defined in: packages/sdk/src/client/client.ts:205

Get phone calls associated with a chat.

Parameters

wid

string

chatId

number

Returns

Promise<PhoneCall[]>

Implementation of

ChatsBindings.getChatPhoneCalls

---

getChats()

getChats: (wid, options) => Promise<PaginatedResponse<ChatResponse>>

Defined in: packages/sdk/src/client/client.ts:164

List chats with optional filtering, sorting, and pagination.

Parameters

wid

string

options?

GetChatsOptions = {}

Returns

Promise<PaginatedResponse<ChatResponse>>

Implementation of

ChatsBindings.getChats

---

getChatsDailyCreationStats()

getChatsDailyCreationStats: (wid, options?) => Promise<{ dailyStats: object[]; }>

Defined in: packages/sdk/src/client/client.ts:177

Get daily chat creation statistics with optional filtering.

Parameters

wid

string

options?

archived?

boolean

isTest?

boolean

Returns

Promise<{ dailyStats: object[]; }>

Implementation of

ChatsBindings.getChatsDailyCreationStats

---

getChatSkills()

getChatSkills: (wid, chatId) => Promise<{ enabledToolkitTools?: string[]; loadedSkills: string[]; revealedSkills: string[]; }>

Defined in: packages/sdk/src/client/client.ts:174

Get loaded and revealed skills for a chat.

Parameters

wid

string

chatId

number

Returns

Promise<{ enabledToolkitTools?: string[]; loadedSkills: string[]; revealedSkills: string[]; }>

Implementation of

ChatsBindings.getChatSkills

---

getChatsNeedsResponse()

getChatsNeedsResponse: (wid) => Promise<number[]>

Defined in: packages/sdk/src/client/client.ts:176

List chat IDs that need a response.

Parameters

wid

string

Returns

Promise<number[]>

Implementation of

ChatsBindings.getChatsNeedsResponse

---

getChatTodos()

getChatTodos: (wid, chatId) => Promise<{ todos: TodoItemResponse[]; }>

Defined in: packages/sdk/src/client/client.ts:173

Get todo items extracted from a chat.

Parameters

wid

string

chatId

number

Returns

Promise<{ todos: TodoItemResponse[]; }>

Implementation of

ChatsBindings.getChatTodos

---

getChatTokenUsage()

getChatTokenUsage: (wid, chatId) => Promise<ChatTokenUsageResponse>

Defined in: packages/sdk/src/client/client.ts:172

Get token usage statistics for a chat.

Parameters

wid

string

chatId

number

Returns

Promise<ChatTokenUsageResponse>

Implementation of

ChatsBindings.getChatTokenUsage

---

getChatToolCallMessages()

getChatToolCallMessages: (wid, chatId, callId, limit, offset) => Promise<ChatMessage[]>

Defined in: packages/sdk/src/client/client.ts:193

List messages associated with a specific tool call in a chat.

Parameters

wid

string

chatId

number

callId

string

limit?

number = 100

offset?

number = 0

Returns

Promise<ChatMessage[]>

Implementation of

ChatsBindings.getChatToolCallMessages

---

getChatTools()

getChatTools: (wid, chatId) => Promise<ToolsResponse>

Defined in: packages/sdk/src/client/client.ts:194

Get the tools available in a chat.

Parameters

wid

string

chatId

number

Returns

Promise<ToolsResponse>

Implementation of

ChatsBindings.getChatTools

---

getCheckoutAttemptStatus()

getCheckoutAttemptStatus: (attemptId) => Promise<CheckoutAttemptStatusResponse>

Defined in: packages/sdk/src/client/client.ts:1013

Read one authenticated, server-owned checkout attempt.

Parameters

attemptId

string

Returns

Promise<CheckoutAttemptStatusResponse>

Implementation of

BillingBindings.getCheckoutAttemptStatus

---

getChildThreadMessages()

getChildThreadMessages: (wid, chatId, messageUuid, limit, offset) => Promise<ChatMessage[]>

Defined in: packages/sdk/src/client/client.ts:192

List the background-work thread hanging off a message.

When a tool trajectory outgrows its turn it detaches and runs in the background (ADR-11 / forked trajectories), writing its messages as a child thread parented at the fork point. Main-history reads exclude them, so this is how the "show work" affordance fetches them — lazily, only when a message with a non-zero childMessageCount is expanded. Returns the thread in chronological order, empty when there is none.

messageUuid is the fork point's ChatMessage.id.

Parameters

wid

string

chatId

string | number

messageUuid

string

limit?

number = 200

offset?

number = 0

Returns

Promise<ChatMessage[]>

Implementation of

ChatsBindings.getChildThreadMessages

---

getClientWorkspace()

getClientWorkspace: (wid, workspaceId) => Promise<ClientWorkspace>

Defined in: packages/sdk/src/client/client.ts:558

Get a single client workspace by ID.

Parameters

wid

string

workspaceId

number

Returns

Promise<ClientWorkspace>

Implementation of

WorkspacesBindings.getClientWorkspace

---

getConfigurationHealth()

getConfigurationHealth: (wid, options?) => Promise<ConfigHealthCollection>

Defined in: packages/sdk/src/client/client.ts:404

Current saved-configuration health across every family (Workflow configuration, Journey authoring, Workflow access, Routine → Workflow access, and the workspace lint).

Requires ALL of workflows:read, journeys:read, automations:read, datatypes:read, members:read, and member_roles:read — a pruned subset would render as "all configuration is healthy".

page/pageSize bound the response only; every family is evaluated in full before the issue list is sliced. check/severity narrow the issue list server-side, before pagination — filtering a single page in the client cannot find a match that lives on a later one. summary and checks are always workspace-global.

Parameters

wid

string

options?

ConfigHealthQueryParams

Returns

Promise<ConfigHealthCollection>

Implementation of

DashboardsBindings.getConfigurationHealth

---

getConfluenceStatus()

getConfluenceStatus: (wid) => Promise<ConfluenceConnectionStatus>

Defined in: packages/sdk/src/client/client.ts:1179

Parameters

wid

string

Returns

Promise<ConfluenceConnectionStatus>

Implementation of

IntegrationsBindings.getConfluenceStatus

---

getConnectionSyncCapabilities()

getConnectionSyncCapabilities: (wid, connectionId) => Promise<SyncCapabilities>

Defined in: packages/sdk/src/client/client.ts:1231

Parameters

wid

string

connectionId

number

Returns

Promise<SyncCapabilities>

Implementation of

IntegrationsBindings.getConnectionSyncCapabilities

---

getConnectionSyncCheckpoint()

getConnectionSyncCheckpoint: (wid, connectionId, direction, syncKey) => Promise<SyncCheckpoint>

Defined in: packages/sdk/src/client/client.ts:1234

Parameters

wid

string

connectionId

number

direction?

SyncDirection = 'inbound'

syncKey?

string = 'default'

Returns

Promise<SyncCheckpoint>

Implementation of

IntegrationsBindings.getConnectionSyncCheckpoint

---

getConnectionSyncConfig()

getConnectionSyncConfig: (wid, connectionId) => Promise<ConnectionSyncConfig>

Defined in: packages/sdk/src/client/client.ts:1232

Parameters

wid

string

connectionId

number

Returns

Promise<ConnectionSyncConfig>

Implementation of

IntegrationsBindings.getConnectionSyncConfig

---

getConsentState()

getConsentState: () => Promise<ConsentStateResponse>

Defined in: packages/sdk/src/client/client.ts:686

Get current consent state for the authenticated account.

Returns

Promise<ConsentStateResponse>

Implementation of

AuthBindings.getConsentState

---

getCredentialChangeInviteDetails()

getCredentialChangeInviteDetails: (token) => Promise<CredentialChangeInviteDetails>

Defined in: packages/sdk/src/client/client.ts:684

Get details of a credential change invitation. The user must be logged in and be the target of the invitation.

Parameters

token

string

Returns

Promise<CredentialChangeInviteDetails>

Implementation of

AuthBindings.getCredentialChangeInviteDetails

---

getCredentialUpdateInvites()

getCredentialUpdateInvites: (wid, memberId?, pageOpts?) => Promise<PaginatedResponse<PendingCredentialChangeInvite>>

Defined in: packages/sdk/src/client/client.ts:321

List pending credential update invitations for the workspace, paginated. Admin-only. Optionally filter by member.

Parameters

wid

string

memberId?

number

pageOpts?

page?

number

pageSize?

number

Returns

Promise<PaginatedResponse<PendingCredentialChangeInvite>>

Implementation of

MembersBindings.getCredentialUpdateInvites

---

getCurrentMember()

getCurrentMember: (wid) => Promise<CurrentMemberResponse>

Defined in: packages/sdk/src/client/client.ts:265

Get the currently authenticated member for a workspace.

Parameters

wid

string

Returns

Promise<CurrentMemberResponse>

Implementation of

MembersBindings.getCurrentMember

---

getCurrentSmsChat()

getCurrentSmsChat: (wid, options) => Promise<CurrentSmsChatResponse>

Defined in: packages/sdk/src/client/client.ts:168

Create-chat preflight for SMS: is a conversation already live between this workspace number and this member?

An SMS conversation with a member is a single stream — inbound SMS resolves to ONE current chat per (member phone, workspace phone) pair — so creating a new SMS chat SUPERSEDES the existing one and the member's next reply lands on the new chat. Callers use this to say so before committing.

Read-only, chats:read, and PHI-safe by construction: status and timing only, no message content and no chat title.

Parameters

wid

string

options

memberId

number

phoneNumberId

number

Returns

Promise<CurrentSmsChatResponse>

Implementation of

ChatsBindings.getCurrentSmsChat

---

getCustomToolkit()

getCustomToolkit: (wid, toolkitId) => Promise<CustomToolkit>

Defined in: packages/sdk/src/client/client.ts:960

Get a specific custom toolkit

Parameters

wid

string

toolkitId

number

Returns

Promise<CustomToolkit>

Implementation of

ToolkitsBindings.getCustomToolkit

---

getCustomToolkits()

getCustomToolkits: (wid) => Promise<CustomToolkit[]>

Defined in: packages/sdk/src/client/client.ts:959

List all custom toolkits in a workspace

Parameters

wid

string

Returns

Promise<CustomToolkit[]>

Implementation of

ToolkitsBindings.getCustomToolkits

---

getDashboard()

getDashboard: (wid, id) => Promise<DashboardResponse>

Defined in: packages/sdk/src/client/client.ts:398

Get a dashboard by ID.

Parameters

wid

string

id

number

Returns

Promise<DashboardResponse>

Implementation of

DashboardsBindings.getDashboard

---

getDashboardChannelStats()

getDashboardChannelStats: (wid, options?) => Promise<ChannelStatsResponse>

Defined in: packages/sdk/src/client/client.ts:402

Per-channel chat volume in the window + live needs-response backlog.

Parameters

wid

string

options?

hours?

number

Returns

Promise<ChannelStatsResponse>

Implementation of

DashboardsBindings.getDashboardChannelStats

---

getDashboards()

getDashboards: (wid) => Promise<DashboardResponse[]>

Defined in: packages/sdk/src/client/client.ts:397

List all dashboards for the workspace, in tab order.

Parameters

wid

string

Returns

Promise<DashboardResponse[]>

Implementation of

DashboardsBindings.getDashboards

---

getDashboardWorkflowAssignmentStats()

getDashboardWorkflowAssignmentStats: (wid) => Promise<WorkflowAssignmentStatsResponse>

Defined in: packages/sdk/src/client/client.ts:403

Assignment status rollup per root workflow.

Parameters

wid

string

Returns

Promise<WorkflowAssignmentStatsResponse>

Implementation of

DashboardsBindings.getDashboardWorkflowAssignmentStats

---

getDataRecord()

getDataRecord: (wid, recordId) => Promise<DataRecordResponse>

Defined in: packages/sdk/src/client/client.ts:245

Get a single data record by ID.

Parameters

wid

string

recordId

number

Returns

Promise<DataRecordResponse>

Implementation of

DataTypesBindings.getDataRecord

---

getDataRecordChanges()

getDataRecordChanges: (wid, dataTypeId, recordId) => Promise<DataRecordUpdateResponse[]>

Defined in: packages/sdk/src/client/client.ts:249

Get the change history for a data record.

Parameters

wid

string

dataTypeId

number

recordId

number

Returns

Promise<DataRecordUpdateResponse[]>

Implementation of

DataTypesBindings.getDataRecordChanges

---

getDataRecordFilter()

getDataRecordFilter: (wid, filterId) => Promise<DataRecordFilterResponse>

Defined in: packages/sdk/src/client/client.ts:258

Get a single data-record filter by ID.

Parameters

wid

string

filterId

number

Returns

Promise<DataRecordFilterResponse>

Implementation of

DataTypesBindings.getDataRecordFilter

---

getDataRecordFilterCount()

getDataRecordFilterCount: (wid, filterId) => Promise<{ count: number; }>

Defined in: packages/sdk/src/client/client.ts:262

Get the count of records matching a saved filter.

Parameters

wid

string

filterId

number

Returns

Promise<{ count: number; }>

Implementation of

DataTypesBindings.getDataRecordFilterCount

---

getDataRecordFilters()

getDataRecordFilters: (wid, options?) => Promise<DataRecordFilterResponse[]>

Defined in: packages/sdk/src/client/client.ts:257

List saved data-record filters, optionally scoped to one DataType.

Parameters

wid

string

options?

dataTypeId?

number

Returns

Promise<DataRecordFilterResponse[]>

Implementation of

DataTypesBindings.getDataRecordFilters

---

getDataRecords()

getDataRecords: (wid, dataTypeId, options?) => Promise<DataRecordsPaginatedResponse>

Defined in: packages/sdk/src/client/client.ts:244

List data records for a data type with optional filtering and pagination.

Parameters

wid

string

dataTypeId

number

options?

dataRecordFilterId?

number

Apply a saved data-record filter by id.

memberId?

number

memberIds?

number[]

Batch form of memberId — one request hydrates a whole table page.

page?

number

pageSize?

number

query?

QueryPredicate

Ad-hoc Query IR predicate (entity=data_record).

search?

string

searchField?

string

Returns

Promise<DataRecordsPaginatedResponse>

Implementation of

DataTypesBindings.getDataRecords

---

getDataType()

getDataType: (wid, id) => Promise<DataTypeResponse>

Defined in: packages/sdk/src/client/client.ts:235

Get a single data type by numeric ID, or by UUID when a UUID string is supplied.

Parameters

wid

string

id

string | number

Returns

Promise<DataTypeResponse>

Implementation of

DataTypesBindings.getDataType

---

getDataTypeBySlug()

getDataTypeBySlug: (wid, slug) => Promise<DataTypeResponse>

Defined in: packages/sdk/src/client/client.ts:237

Get a single data type by its slug.

Parameters

wid

string

slug

string

Returns

Promise<DataTypeResponse>

Implementation of

DataTypesBindings.getDataTypeBySlug

---

getDataTypeByUuid()

getDataTypeByUuid: (wid, uuid) => Promise<DataTypeResponse>

Defined in: packages/sdk/src/client/client.ts:236

Get a single data type by UUID.

Parameters

wid

string

uuid

string

Returns

Promise<DataTypeResponse>

Implementation of

DataTypesBindings.getDataTypeByUuid

---

getDataTypeDraft()

getDataTypeDraft: (wid, id) => Promise<DataTypeDraftResponse>

Defined in: packages/sdk/src/client/client.ts:231

Read the local Form's draft and optimistic publication counters.

Parameters

wid

string

id

number

Returns

Promise<DataTypeDraftResponse>

Implementation of

DataTypesBindings.getDataTypeDraft

---

getDataTypes()

getDataTypes: (wid, options?) => Promise<DataTypeResponse[]>

Defined in: packages/sdk/src/client/client.ts:230

List all data types for a workspace, optionally filtering by archived status.

Parameters

wid

string

options?

archived?

boolean

Returns

Promise<DataTypeResponse[]>

Implementation of

DataTypesBindings.getDataTypes

---

getDataTypeVersions()

getDataTypeVersions: (wid, id, options?) => Promise<DataTypeVersionResponse[]>

Defined in: packages/sdk/src/client/client.ts:234

List schema history newest first; use the last version as the next cursor.

Parameters

wid

string

id

number

options?

beforeVersion?

number

limit?

number

Returns

Promise<DataTypeVersionResponse[]>

Implementation of

DataTypesBindings.getDataTypeVersions

---

getDevice()

getDevice: (deviceUuid) => Promise<DeviceResponse>

Defined in: packages/sdk/src/client/client.ts:987

Fetch one device owned by the current Account. Other devices return 404.

Parameters

deviceUuid

string

Returns

Promise<DeviceResponse>

Implementation of

DevicesBindings.getDevice

---

getDeviceAdmissibleWorkspaces()

getDeviceAdmissibleWorkspaces: () => Promise<CompactWorkspace[]>

Defined in: packages/sdk/src/client/client.ts:535

Compact rows for the workspaces a companion device could enter — the Lantern picker. Filtered by the same admission policy a device credential is gated by, without needing the device credential.

Returns

Promise<CompactWorkspace[]>

Implementation of

WorkspacesBindings.getDeviceAdmissibleWorkspaces

---

getDeviceKinds()

getDeviceKinds: () => Promise<DeviceKindResponse[]>

Defined in: packages/sdk/src/client/client.ts:988

List shippable companion-device products (Lantern, later SKUs).

Returns

Promise<DeviceKindResponse[]>

Implementation of

DevicesBindings.getDeviceKinds

---

getDevices()

getDevices: () => Promise<DeviceResponse[]>

Defined in: packages/sdk/src/client/client.ts:986

List devices owned by the current Account.

Returns

Promise<DeviceResponse[]>

Implementation of

DevicesBindings.getDevices

---

getDiscordBot()

getDiscordBot: (wid, botId) => Promise<DiscordBot>

Defined in: packages/sdk/src/client/client.ts:1082

Get a specific Discord bot by ID.

Parameters

wid

string

botId

number

Returns

Promise<DiscordBot>

Implementation of

IntegrationsBindings.getDiscordBot

---

getDiscordBotAccounts()

getDiscordBotAccounts: (wid, botId, options) => Promise<PaginatedResponse<DiscordBotAccount>>

Defined in: packages/sdk/src/client/client.ts:1091

Get Discord account links for a bot (members linked to Discord users).

Parameters

wid

string

botId

number

options?

page?

number

pageSize?

number

Returns

Promise<PaginatedResponse<DiscordBotAccount>>

Implementation of

IntegrationsBindings.getDiscordBotAccounts

---

getDiscordBotByUuid()

getDiscordBotByUuid: (wid, uuid) => Promise<DiscordBot>

Defined in: packages/sdk/src/client/client.ts:1083

Get a Discord bot by UUID.

Parameters

wid

string

uuid

string

Returns

Promise<DiscordBot>

Implementation of

IntegrationsBindings.getDiscordBotByUuid

---

getDiscordBots()

getDiscordBots: (wid, options) => Promise<PaginatedResponse<DiscordBot>>

Defined in: packages/sdk/src/client/client.ts:1081

List all Discord bots configured for a workspace.

Parameters

wid

string

options?

page?

number

pageSize?

number

search?

string

sortBy?

DiscordBotSortField

sortOrder?

SortOrder

Returns

Promise<PaginatedResponse<DiscordBot>>

Implementation of

IntegrationsBindings.getDiscordBots

---

getDiscordGuilds()

getDiscordGuilds: (wid, botId, options) => Promise<PaginatedResponse<DiscordGuild>>

Defined in: packages/sdk/src/client/client.ts:1090

Get Discord guilds (servers) that have interacted with a bot.

Parameters

wid

string

botId

number

options?

page?

number

pageSize?

number

Returns

Promise<PaginatedResponse<DiscordGuild>>

Implementation of

IntegrationsBindings.getDiscordGuilds

---

getDiscordThreads()

getDiscordThreads: (wid, botId, options) => Promise<PaginatedResponse<DiscordThread>>

Defined in: packages/sdk/src/client/client.ts:1089

Get Discord threads for a bot.

Parameters

wid

string

botId

number

options?

page?

number

pageSize?

number

Returns

Promise<PaginatedResponse<DiscordThread>>

Implementation of

IntegrationsBindings.getDiscordThreads

---

getDocumoFaxSetup()

getDocumoFaxSetup: (wid) => Promise<DocumoFaxSetupResponse>

Defined in: packages/sdk/src/client/client.ts:1152

Parameters

wid

string

Returns

Promise<DocumoFaxSetupResponse>

Implementation of

IntegrationsBindings.getDocumoFaxSetup

---

getDocumoFaxStatus()

getDocumoFaxStatus: (wid) => Promise<DocumoFaxStatusResponse>

Defined in: packages/sdk/src/client/client.ts:1151

Parameters

wid

string

Returns

Promise<DocumoFaxStatusResponse>

Implementation of

IntegrationsBindings.getDocumoFaxStatus

---

getDomainMapping()

getDomainMapping: (customDomain) => Promise<DomainMapping>

Defined in: packages/sdk/src/client/client.ts:664

Get the organization and workspace mapping for a custom domain.

Parameters

customDomain

string

Returns

Promise<DomainMapping>

Implementation of

AuthBindings.getDomainMapping

---

getEnrollmentStatusLog()

getEnrollmentStatusLog: (wid, journeyId, memberJourneyId, params) => Promise<JourneyStatusLogResponse>

Defined in: packages/sdk/src/client/client.ts:475

Status history for one enrollment — the per-member journey timeline.

This is where a step that completed having emitted nothing shows up as zeroEmission: true with its reason, instead of being indistinguishable from a step that sent (GRA-7341). Newest first.

PHI-safe: identifiers, closed status codes, operator-authored step names, counts, and timestamps. entry.reason is populated only for rows the server allowlists; every other row reports reasonRedacted: true.

zeroEmissionOnly narrows the page to the dropped-send rows. Use it when that is all you need: without it a busy enrollment can push every zero-emission row off the first page, and a caller that renders only what it loaded would report "nothing was dropped" — the exact failure this endpoint exists to eliminate. zeroEmissionCount is unaffected by the filter and always counts the whole enrollment.

Parameters

wid

string

journeyId

number

memberJourneyId

number

params?

page?

number

pageSize?

number

zeroEmissionOnly?

boolean

Returns

Promise<JourneyStatusLogResponse>

Implementation of

JourneysBindings.getEnrollmentStatusLog

---

getEventRule()

getEventRule: (wid, id) => Promise<EventRuleResponse>

Defined in: packages/sdk/src/client/client.ts:797

Get a single event rule by ID.

Parameters

wid

string

id

number

Returns

Promise<EventRuleResponse>

Implementation of

EventsBindings.getEventRule

---

getEventRules()

getEventRules: (wid, params?) => Promise<PaginatedResponse<EventRuleResponse>>

Defined in: packages/sdk/src/client/client.ts:794

List event rules in the workspace, paginated.

Parameters

wid

string

params?

page?

number

pageSize?

number

Returns

Promise<PaginatedResponse<EventRuleResponse>>

Implementation of

EventsBindings.getEventRules

---

getExperiment()

getExperiment: (wid, experimentId) => Promise<Experiment>

Defined in: packages/sdk/src/client/client.ts:488

Get a single experiment by ID (includes groups).

Parameters

wid

string

experimentId

number

Returns

Promise<Experiment>

Implementation of

ExperimentsBindings.getExperiment

---

getExperiments()

getExperiments: (wid, params?) => Promise<PaginatedResponse<Experiment>>

Defined in: packages/sdk/src/client/client.ts:487

List experiments with group summaries and assignment counts.

Parameters

wid

string

params?

includeArchived?

boolean

page?

number

pageSize?

number

Returns

Promise<PaginatedResponse<Experiment>>

Implementation of

ExperimentsBindings.getExperiments

---

getExperimentStats()

getExperimentStats: (wid, experimentId) => Promise<ExperimentStats>

Defined in: packages/sdk/src/client/client.ts:495

Aggregate assignment and exposure counts by group.

Parameters

wid

string

experimentId

number

Returns

Promise<ExperimentStats>

Implementation of

ExperimentsBindings.getExperimentStats

---

getFeatureBySlug()

getFeatureBySlug: (slug) => Promise<FeatureDefinition>

Defined in: packages/sdk/src/client/client.ts:983

Get a specific feature definition by slug

Parameters

slug

string

Returns

Promise<FeatureDefinition>

Implementation of

ToolkitsBindings.getFeatureBySlug

---

getFeatureRegistry()

getFeatureRegistry: () => Promise<FeaturesRegistryResponse>

Defined in: packages/sdk/src/client/client.ts:981

Get the full feature registry with all metadata

Returns

Promise<FeaturesRegistryResponse>

Implementation of

ToolkitsBindings.getFeatureRegistry

---

getFhirConnection()

getFhirConnection: (wid, connectionId) => Promise<FhirConnection>

Defined in: packages/sdk/src/client/client.ts:1119

Get a specific FHIR connection by ID.

Parameters

wid

string

connectionId

number

Returns

Promise<FhirConnection>

Implementation of

IntegrationsBindings.getFhirConnection

---

getFhirConnectionByUuid()

getFhirConnectionByUuid: (wid, uuid) => Promise<FhirConnection>

Defined in: packages/sdk/src/client/client.ts:1120

Get a FHIR connection by UUID.

Parameters

wid

string

uuid

string

Returns

Promise<FhirConnection>

Implementation of

IntegrationsBindings.getFhirConnectionByUuid

---

getFhirConnections()

getFhirConnections: (wid, options) => Promise<PaginatedResponse<FhirConnection>>

Defined in: packages/sdk/src/client/client.ts:1118

List all FHIR connections configured for a workspace.

Parameters

wid

string

options?

page?

number

pageSize?

number

search?

string

sortBy?

FhirConnectionSortField

sortOrder?

SortOrder

Returns

Promise<PaginatedResponse<FhirConnection>>

Implementation of

IntegrationsBindings.getFhirConnections

---

getFieldIndexStatus()

getFieldIndexStatus: (wid, dataTypeId, fieldSlug) => Promise<{ fieldName: string; fieldSlug: string; indexStatus: string; shouldIndex: string; }>

Defined in: packages/sdk/src/client/client.ts:254

Get the index status for a data type field.

Parameters

wid

string

dataTypeId

number

fieldSlug

string

Returns

Promise<{ fieldName: string; fieldSlug: string; indexStatus: string; shouldIndex: string; }>

Implementation of

DataTypesBindings.getFieldIndexStatus

---

getFile()

getFile: (wid, id) => Promise<File>

Defined in: packages/sdk/src/client/client.ts:748

Get a single file by ID.

Parameters

wid

string

id

number

Returns

Promise<File>

Implementation of

FilesBindings.getFile

---

getFileLabel()

getFileLabel: (wid, id) => Promise<FileLabelResponse>

Defined in: packages/sdk/src/client/client.ts:774

Get a single file label by ID.

Parameters

wid

string

id

number

Returns

Promise<FileLabelResponse>

Implementation of

FilesBindings.getFileLabel

---

getFileLabelByUuid()

getFileLabelByUuid: (wid, uuid) => Promise<FileLabelResponse>

Defined in: packages/sdk/src/client/client.ts:775

Get a single file label by UUID.

Parameters

wid

string

uuid

string

Returns

Promise<FileLabelResponse>

Implementation of

FilesBindings.getFileLabelByUuid

---

getFileLabels()

getFileLabels: (wid) => Promise<FileLabelResponse[]>

Defined in: packages/sdk/src/client/client.ts:773

List all file labels in the workspace.

Parameters

wid

string

Returns

Promise<FileLabelResponse[]>

Implementation of

FilesBindings.getFileLabels

---

getFiles()

getFiles: (wid, options) => Promise<PaginatedResponse<File>>

Defined in: packages/sdk/src/client/client.ts:747

List files in a workspace with optional folder filtering, sorting, and search.

Parameters

wid

string

options?

folderId?

number

page?

number

pageSize?

number

search?

string

sortBy?

FileSortField

sortOrder?

SortOrder

Returns

Promise<PaginatedResponse<File>>

Implementation of

FilesBindings.getFiles

---

getFileSharing()

getFileSharing: (wid, fileId) => Promise<FileSharingResponse>

Defined in: packages/sdk/src/client/client.ts:779

Get sharing settings for a file.

Parameters

wid

string

fileId

number

Returns

Promise<FileSharingResponse>

Implementation of

FilesBindings.getFileSharing

---

getFileVersionContentsUrl()

getFileVersionContentsUrl: (wid, fileId, versionNumber) => string

Defined in: packages/sdk/src/client/client.ts:763

Same-origin proxy URL for a version's raw contents. Mirrors the shape of FileResponse.cdnUrl: an app-relative Next.js route that authenticates via session cookies and forwards to the versioned contents endpoint.

Parameters

wid

string

fileId

number

versionNumber

number

Returns

string

Implementation of

FilesBindings.getFileVersionContentsUrl

---

getFileVersionDiff()

getFileVersionDiff: (wid, fileId, fromVersion, toVersion) => Promise<FileVersionDiffResponse>

Defined in: packages/sdk/src/client/client.ts:761

Compare two versions of a file. For text files both raw contents are returned.

Parameters

wid

string

fileId

number

fromVersion

number

toVersion

number

Returns

Promise<FileVersionDiffResponse>

Implementation of

FilesBindings.getFileVersionDiff

---

getFirstRunState()

getFirstRunState: (wid) => Promise<FirstRunState>

Defined in: packages/sdk/src/client/client.ts:544

Get the full first-run onboarding state for a workspace.

Parameters

wid

string

Returns

Promise<FirstRunState>

Implementation of

WorkspacesBindings.getFirstRunState

---

getFolder()

getFolder: (wid, id) => Promise<FileFolderResponse>

Defined in: packages/sdk/src/client/client.ts:767

Get a single folder by ID.

Parameters

wid

string

id

number

Returns

Promise<FileFolderResponse>

Implementation of

FilesBindings.getFolder

---

getFolderMemberAccess()

getFolderMemberAccess: (wid, folderId, memberId) => Promise<FolderMemberAccessResponse>

Defined in: packages/sdk/src/client/client.ts:783

Ask whether another member can read a folder, evaluated by the real authorizer as that member. Used to tell "a landing folder is set" apart from "the fax owner can actually open it".

Parameters

wid

string

folderId

number

memberId

number

Returns

Promise<FolderMemberAccessResponse>

Implementation of

FilesBindings.getFolderMemberAccess

---

getFolders()

getFolders: (wid, parentIdOrOpts) => Promise<FileFolderResponse[]>

Defined in: packages/sdk/src/client/client.ts:766

List child folders of a given parent folder.

parentId is required — use the workspace root folder ID from WorkspaceSettings.workspaceFolderId as the starting point for workspace-level browsing.

Parameters

wid

string

parentIdOrOpts

number | { parentId: number; }

Returns

Promise<FileFolderResponse[]>

Implementation of

FilesBindings.getFolders

---

getFolderSharing()

getFolderSharing: (wid, folderId) => Promise<FolderSharingResponse>

Defined in: packages/sdk/src/client/client.ts:782

Get sharing settings for a folder.

Parameters

wid

string

folderId

number

Returns

Promise<FolderSharingResponse>

Implementation of

FilesBindings.getFolderSharing

---

getGlobalApiKeys()

getGlobalApiKeys: () => Promise<ApiKey[]>

Defined in: packages/sdk/src/client/client.ts:997

List all account-level API keys.

Returns

Promise<ApiKey[]>

Implementation of

BillingBindings.getGlobalApiKeys

---

getGoogleCalendarStatus()

getGoogleCalendarStatus: (wid) => Promise<GoogleCalendarInsufficientScopesResponse | GoogleCalendarStatusResponse>

Defined in: packages/sdk/src/client/client.ts:895

Get the Google Calendar integration status for the workspace.

Parameters

wid

string

Returns

Promise<GoogleCalendarInsufficientScopesResponse | GoogleCalendarStatusResponse>

Implementation of

CalendarsBindings.getGoogleCalendarStatus

---

getGranteeGrants()

getGranteeGrants: (wid, memberId, params?) => Promise<PaginatedResponse<AccessGrant>>

Defined in: packages/sdk/src/client/client.ts:523

List access grants received by a member (grantee view) — the "what can this agent do without asking?" list. Filter with status=active and/or a capabilityClass (e.g. 'tool.always_allow').

Parameters

wid

string

memberId

number

params?

capabilityClass?

string

page?

number

pageSize?

number

status?

string

Returns

Promise<PaginatedResponse<AccessGrant>>

Implementation of

AccessGrantsBindings.getGranteeGrants

---

getHealthieAvailableSlots()

getHealthieAvailableSlots: (wid, request) => Promise<AvailableDayResponse[]>

Defined in: packages/sdk/src/client/client.ts:1173

Parameters

wid

string

request

HealthieAvailableSlotsRequest

Returns

Promise<AvailableDayResponse[]>

Implementation of

IntegrationsBindings.getHealthieAvailableSlots

---

getHealthieReconciliationMatches()

getHealthieReconciliationMatches: (wid, params?) => Promise<HealthieReconciliationMatchResponse[]>

Defined in: packages/sdk/src/client/client.ts:1168

Parameters

wid

string

params?

limit?

number

offset?

number

Returns

Promise<HealthieReconciliationMatchResponse[]>

Implementation of

IntegrationsBindings.getHealthieReconciliationMatches

---

getHealthieStatus()

getHealthieStatus: (wid) => Promise<HealthieConnectionStatus>

Defined in: packages/sdk/src/client/client.ts:1162

Parameters

wid

string

Returns

Promise<HealthieConnectionStatus>

Implementation of

IntegrationsBindings.getHealthieStatus

---

getHubspotContactProperties()

getHubspotContactProperties: (wid) => Promise<HubSpotPropertyDefinition[]>

Defined in: packages/sdk/src/client/client.ts:1225

Parameters

wid

string

Returns

Promise<HubSpotPropertyDefinition[]>

Implementation of

IntegrationsBindings.getHubspotContactProperties

---

getHubspotManagedRules()

getHubspotManagedRules: (wid) => Promise<ManagedRuleStatus[]>

Defined in: packages/sdk/src/client/client.ts:1226

Parameters

wid

string

Returns

Promise<ManagedRuleStatus[]>

Implementation of

IntegrationsBindings.getHubspotManagedRules

---

getHubspotReconciliationMatches()

getHubspotReconciliationMatches: (wid, params?) => Promise<HubspotReconciliationMatch[]>

Defined in: packages/sdk/src/client/client.ts:1218

Parameters

wid

string

params?

limit?

number

offset?

number

Returns

Promise<HubspotReconciliationMatch[]>

Implementation of

IntegrationsBindings.getHubspotReconciliationMatches

---

getHubspotStatus()

getHubspotStatus: (wid) => Promise<HubspotConnectionStatus>

Defined in: packages/sdk/src/client/client.ts:1213

Parameters

wid

string

Returns

Promise<HubspotConnectionStatus>

Implementation of

IntegrationsBindings.getHubspotStatus

---

getHubspotSyncLogs()

getHubspotSyncLogs: (wid, params?) => Promise<SyncLogsResponse>

Defined in: packages/sdk/src/client/client.ts:1227

Parameters

wid

string

params?

cursor?

string

pageSize?

number

Returns

Promise<SyncLogsResponse>

Implementation of

IntegrationsBindings.getHubspotSyncLogs

---

getHubspotTransformPresets()

getHubspotTransformPresets: (wid) => Promise<TransformPreset[]>

Defined in: packages/sdk/src/client/client.ts:1228

Parameters

wid

string

Returns

Promise<TransformPreset[]>

Implementation of

IntegrationsBindings.getHubspotTransformPresets

---

getICalFeedUrl()

getICalFeedUrl: (wid, calendarId) => Promise<ICalFeedUrlResponse>

Defined in: packages/sdk/src/client/client.ts:894

Get the iCal feed URL for a calendar.

Parameters

wid

string

calendarId

number

Returns

Promise<ICalFeedUrlResponse>

Implementation of

CalendarsBindings.getICalFeedUrl

---

getImportReadiness()

getImportReadiness: (wid) => Promise<ImportReadinessResponse>

Defined in: packages/sdk/src/client/client.ts:579

Current bounded phone, inbox, and phone-chat binding gaps after an import.

Parameters

wid

string

Returns

Promise<ImportReadinessResponse>

Implementation of

WorkspacesBindings.getImportReadiness

---

getImportSkippedRules()

getImportSkippedRules: (wid, status?) => Promise<ImportSkippedRulesResponse>

Defined in: packages/sdk/src/client/client.ts:578

Reconnectable EventRules skipped by the latest workspace import, grouped by the missing phone / inbox / member. Templates and action params are not returned.

Parameters

wid

string

status?

ImportSkippedRuleResponseStatus

Returns

Promise<ImportSkippedRulesResponse>

Implementation of

WorkspacesBindings.getImportSkippedRules

---

getInbox()

getInbox: (wid, id) => Promise<Inbox>

Defined in: packages/sdk/src/client/client.ts:923

Get an inbox by ID or UUID.

The route has always taken either (inbox_id: str = Path(..., description= "Inbox ID or UUID")); the signature said number, which put the UUID path out of reach for a caller holding an inbox ref from the activity feed — where refs are UUID-only by design.

Parameters

wid

string

id

string | number

Returns

Promise<Inbox>

Implementation of

CommunicationsBindings.getInbox

---

getInboxEmail()

getInboxEmail: (wid, inboxId, emailId) => Promise<Email>

Defined in: packages/sdk/src/client/client.ts:928

Get a single email from an inbox.

Parameters

wid

string

inboxId

number

emailId

number

Returns

Promise<Email>

Implementation of

CommunicationsBindings.getInboxEmail

---

getInboxEmails()

getInboxEmails: (wid, inboxId, options) => Promise<PaginatedResponse<Email>>

Defined in: packages/sdk/src/client/client.ts:927

List emails in an inbox with pagination and optional attachment inclusion.

Parameters

wid

string

inboxId

number

options?

includeAttachments?

boolean

page?

number

pageSize?

number

Returns

Promise<PaginatedResponse<Email>>

Implementation of

CommunicationsBindings.getInboxEmails

---

getInboxes()

getInboxes: (wid) => Promise<PaginatedResponse<Inbox>>

Defined in: packages/sdk/src/client/client.ts:922

List all inboxes in a workspace.

Parameters

wid

string

Returns

Promise<PaginatedResponse<Inbox>>

Implementation of

CommunicationsBindings.getInboxes

---

getInboxThreads()

getInboxThreads: (wid, inboxId) => Promise<InboxThreadsPageResponse>

Defined in: packages/sdk/src/client/client.ts:934

List email threads in an inbox.

Parameters

wid

string

inboxId

number

Returns

Promise<InboxThreadsPageResponse>

Implementation of

CommunicationsBindings.getInboxThreads

---

getInquiry()

getInquiry: (inquiryId) => Promise<InquiryResponse>

Defined in: packages/sdk/src/client/client.ts:1038

Get a specific inquiry (superuser only)

Parameters

inquiryId

number

Returns

Promise<InquiryResponse>

Implementation of

AppsBindings.getInquiry

---

getInterventionRequests()

getInterventionRequests: (wid, params) => Promise<InterventionRequest[]>

Defined in: packages/sdk/src/client/client.ts:527

List intervention requests in a workspace, newest first.

Parameters

wid

string

params?

ListInterventionRequestsParams = {}

Returns

Promise<InterventionRequest[]>

Implementation of

InterventionRequestsBindings.getInterventionRequests

---

getJourney()

getJourney: (wid, journeyId) => Promise<JourneyRead>

Defined in: packages/sdk/src/client/client.ts:448

Get a single journey by ID (includes steps and goals).

Returns the READ projection (JourneyRead) — nested edges carry no celCondition and goals no completionCel. The editor uses getJourneyAuthoring for those.

Parameters

wid

string

journeyId

number

Returns

Promise<JourneyRead>

Implementation of

JourneysBindings.getJourney

---

getJourneyAuthoring()

getJourneyAuthoring: (wid, journeyId) => Promise<Journey>

Defined in: packages/sdk/src/client/client.ts:449

Get a journey's AUTHORING projection (raw edge/goal CEL).

journey-decoupling §3.5: the ordinary getJourney read projection omits raw edge celCondition and goal completionCel. This endpoint is the write-authorized surface that carries them for the Journey editor — it requires the journeys:write scope, so a read-only caller is denied and must not call it. Returns the authoring superset (Journey).

Parameters

wid

string

journeyId

number

Returns

Promise<Journey>

Implementation of

JourneysBindings.getJourneyAuthoring

---

getJourneyFilterOptions()

getJourneyFilterOptions: (wid) => Promise<JourneyFilterOptionResponse[]>

Defined in: packages/sdk/src/client/client.ts:453

MemberFilter ids and names, for the Journey authoring picker.

A v2 wait, route or Ending may carry a structured MemberFilter predicate and the author selects it by NAME (rule-filters plan §3.10). This is the catalogue for that control and the whole of what it needs: two scalars per filter, no query predicate, no rules, no counts.

Authorized on journeys:write alone — deliberately NOT the Members surface's MembersApi.getMemberFilters, which is members:read because it returns each filter's predicate. Journey authoring should not require Member-read access to name a cohort.

Parameters

wid

string

Returns

Promise<JourneyFilterOptionResponse[]>

Implementation of

JourneysBindings.getJourneyFilterOptions

---

getJourneyHealth()

getJourneyHealth: (wid, journeyId) => Promise<JourneyHealthResponse>

Defined in: packages/sdk/src/client/client.ts:454

Get Journey Health diagnostics — authoring issues and runtime failures for a single journey. PHI-safe: response carries IDs, counts, error_type strings, and timestamps only.

Parameters

wid

string

journeyId

number

Returns

Promise<JourneyHealthResponse>

Implementation of

JourneysBindings.getJourneyHealth

---

getJourneyMembers()

getJourneyMembers: (wid, journeyId, params?) => Promise<PaginatedResponse<MemberJourney>>

Defined in: packages/sdk/src/client/client.ts:469

List enrolled members for a journey (paginated).

Parameters

wid

string

journeyId

number

params?

currentTaskId?

number

Only enrollments whose current step is this JourneyStep id.

enrolledAfter?

string

ISO 8601 timestamp — only enrollments on/after this time.

enrolledBefore?

string

ISO 8601 timestamp — only enrollments on/before this time.

page?

number

pageSize?

number

runtimeFailureEdgeId?

number

Only enrollments that have a Journey Health runtime breadcrumb for this edge. The backend validates that the edge belongs to the journey.

search?

string

status?

string

MemberJourneyStatus filter (e.g., 'active', 'completed').

Returns

Promise<PaginatedResponse<MemberJourney>>

Implementation of

JourneysBindings.getJourneyMembers

---

getJourneyNotes()

getJourneyNotes: (wid, journeyId) => Promise<JourneyNoteResponse[]>

Defined in: packages/sdk/src/client/client.ts:481

List notes for a journey.

Parameters

wid

string

journeyId

number

Returns

Promise<JourneyNoteResponse[]>

Implementation of

JourneysBindings.getJourneyNotes

---

getJourneys()

getJourneys: (wid, includeArchived, pageOpts?) => Promise<PaginatedResponse<JourneyRead>>

Defined in: packages/sdk/src/client/client.ts:447

List journeys, optionally including archived, paginated.

Returns the READ projection (JourneyRead) — CEL-free. Use getJourneyAuthoring for the editor's expression-carrying shape.

Parameters

wid

string

includeArchived?

boolean = false

pageOpts?

page?

number

pageSize?

number

Returns

Promise<PaginatedResponse<JourneyRead>>

Implementation of

JourneysBindings.getJourneys

---

getJourneyV2Validation()

getJourneyV2Validation: (wid, journeyId) => Promise<JourneyV2ValidationResponse>

Defined in: packages/sdk/src/client/client.ts:452

Dry-run the v2 publish validator against the STORED definition.

Answers "could I activate this right now?" without attempting the transition. Issues carry closed codes and resource uuids only — never CEL and never member data — so they are safe to render or log.

Parameters

wid

string

journeyId

number

Returns

Promise<JourneyV2ValidationResponse>

Implementation of

JourneysBindings.getJourneyV2Validation

---

getLegalEntity()

getLegalEntity: (orgUuid, legalEntityUuid) => Promise<LegalEntitySummary>

Defined in: packages/sdk/src/client/client.ts:616

Parameters

orgUuid

string

legalEntityUuid

string

Returns

Promise<LegalEntitySummary>

Implementation of

OrgBindings.getLegalEntity

---

getLinkablePhones()

getLinkablePhones: (wid) => Promise<object[]>

Defined in: packages/sdk/src/client/client.ts:920

List provider phones available for linking to workspace phone numbers.

Parameters

wid

string

Returns

Promise<object[]>

Implementation of

CommunicationsBindings.getLinkablePhones

---

getLinkedHealthieMembers()

getLinkedHealthieMembers: (wid, params?) => Promise<PaginatedResponse<HealthieLinkedMemberResponse>>

Defined in: packages/sdk/src/client/client.ts:1167

Parameters

wid

string

params?

page?

number

pageSize?

number

search?

string

Returns

Promise<PaginatedResponse<HealthieLinkedMemberResponse>>

Implementation of

IntegrationsBindings.getLinkedHealthieMembers

---

getLinkedHubspotMembers()

getLinkedHubspotMembers: (wid, params?) => Promise<PaginatedResponse<LinkedHubspotMember>>

Defined in: packages/sdk/src/client/client.ts:1222

Parameters

wid

string

params?

page?

number

pageSize?

number

search?

string

Returns

Promise<PaginatedResponse<LinkedHubspotMember>>

Implementation of

IntegrationsBindings.getLinkedHubspotMembers

---

getLinkedMondayMembers()

getLinkedMondayMembers: (wid, params?) => Promise<PaginatedResponse<LinkedMondayMember>>

Defined in: packages/sdk/src/client/client.ts:1071

Parameters

wid

string

params?

board_id?

string

page?

number

pageSize?

number

search?

string

Returns

Promise<PaginatedResponse<LinkedMondayMember>>

Implementation of

IntegrationsBindings.getLinkedMondayMembers

---

getLinkedRecords()

getLinkedRecords: (wid, params?) => Promise<PaginatedResponse<LinkedMondayRecord>>

Defined in: packages/sdk/src/client/client.ts:1076

Parameters

wid

string

params?

board_id?

string

page?

number

pageSize?

number

Returns

Promise<PaginatedResponse<LinkedMondayRecord>>

Implementation of

IntegrationsBindings.getLinkedRecords

---

getLinkedSalesforceMembers()

getLinkedSalesforceMembers: (wid, params?) => Promise<PaginatedResponse<LinkedSalesforceMember>>

Defined in: packages/sdk/src/client/client.ts:1200

Parameters

wid

string

params?

page?

number

pageSize?

number

search?

string

Returns

Promise<PaginatedResponse<LinkedSalesforceMember>>

Implementation of

IntegrationsBindings.getLinkedSalesforceMembers

---

getLiveOperators()

getLiveOperators: (wid) => Promise<LiveOperatorsResponse>

Defined in: packages/sdk/src/client/client.ts:509

Get all currently live (online) operators in a workspace.

Parameters

wid

string

Returns

Promise<LiveOperatorsResponse>

Implementation of

OperatorBindings.getLiveOperators

---

getManagerSkills()

getManagerSkills: (wid) => Promise<ManagerSkillsResponse>

Defined in: packages/sdk/src/client/client.ts:175

List built-in skills selectable before a Manager Chat (and on Routine manager tasks).

Parameters

wid

string

Returns

Promise<ManagerSkillsResponse>

Implementation of

ChatsBindings.getManagerSkills

---

getMcpServer()

getMcpServer: (wid, serverId) => Promise<McpServerResponse>

Defined in: packages/sdk/src/client/client.ts:970

Get a specific MCP server

Parameters

wid

string

serverId

number

Returns

Promise<McpServerResponse>

Implementation of

ToolkitsBindings.getMcpServer

---

getMcpServerPrompts()

getMcpServerPrompts: (wid, serverId) => Promise<McpServerPromptsResponse>

Defined in: packages/sdk/src/client/client.ts:978

Get prompts for an MCP server.

Returns 403 with detail.code === 'auth_required' when the current user needs to authenticate first.

Parameters

wid

string

serverId

number

Returns

Promise<McpServerPromptsResponse>

Implementation of

ToolkitsBindings.getMcpServerPrompts

---

getMcpServerResources()

getMcpServerResources: (wid, serverId) => Promise<McpServerResourcesResponse>

Defined in: packages/sdk/src/client/client.ts:977

Get resources for an MCP server.

Returns 403 with detail.code === 'auth_required' when the current user needs to authenticate first.

Parameters

wid

string

serverId

number

Returns

Promise<McpServerResourcesResponse>

Implementation of

ToolkitsBindings.getMcpServerResources

---

getMcpServers()

getMcpServers: (wid) => Promise<McpServerResponse[]>

Defined in: packages/sdk/src/client/client.ts:969

List all MCP servers in a workspace

Parameters

wid

string

Returns

Promise<McpServerResponse[]>

Implementation of

ToolkitsBindings.getMcpServers

---

getMcpServerTools()

getMcpServerTools: (wid, serverId) => Promise<McpServerToolsResponse>

Defined in: packages/sdk/src/client/client.ts:976

Get tools for an MCP server.

Returns 403 with detail.code === 'auth_required' when the current user needs to authenticate first.

Parameters

wid

string

serverId

number

Returns

Promise<McpServerToolsResponse>

Implementation of

ToolkitsBindings.getMcpServerTools

---

getMemberExperiments()

getMemberExperiments: (wid, memberId) => Promise<MemberExperimentAssignment[]>

Defined in: packages/sdk/src/client/client.ts:496

List experiment assignments for a member (member profile panel).

Parameters

wid

string

memberId

number

Returns

Promise<MemberExperimentAssignment[]>

Implementation of

ExperimentsBindings.getMemberExperiments

---

getMemberFieldDefinitions()

getMemberFieldDefinitions: (wid) => Promise<MemberFieldDefinitionListResponse>

Defined in: packages/sdk/src/client/client.ts:314

Get available field definitions for this workspace. Returns field keys/labels from active app connections and user-created fields.

Parameters

wid

string

Returns

Promise<MemberFieldDefinitionListResponse>

Implementation of

MembersBindings.getMemberFieldDefinitions

---

getMemberFields()

getMemberFields: (wid, memberId) => Promise<MemberFieldListResponse>

Defined in: packages/sdk/src/client/client.ts:313

Get all fields for a member. Returns key-value fields including service-owned fields (which are read-only).

Parameters

wid

string

memberId

number

Returns

Promise<MemberFieldListResponse>

Implementation of

MembersBindings.getMemberFields

---

getMemberFilter()

getMemberFilter: (wid, filterId) => Promise<MemberFilterResponse>

Defined in: packages/sdk/src/client/client.ts:293

Get a single member filter by ID.

Parameters

wid

string

filterId

number

Returns

Promise<MemberFilterResponse>

Implementation of

MembersBindings.getMemberFilter

---

getMemberFilterCount()

getMemberFilterCount: (wid, filterId) => Promise<{ count: number; }>

Defined in: packages/sdk/src/client/client.ts:297

Get the count of members matching a saved filter.

Parameters

wid

string

filterId

number

Returns

Promise<{ count: number; }>

Implementation of

MembersBindings.getMemberFilterCount

---

getMemberFilters()

getMemberFilters: (wid) => Promise<MemberFilterResponse[]>

Defined in: packages/sdk/src/client/client.ts:292

List all saved member filters for a workspace.

Parameters

wid

string

Returns

Promise<MemberFilterResponse[]>

Implementation of

MembersBindings.getMemberFilters

---

getMemberGrants()

getMemberGrants: (wid, memberId) => Promise<AccessGrant[]>

Defined in: packages/sdk/src/client/client.ts:522

Get all access grants for a specific member.

Parameters

wid

string

memberId

number

Returns

Promise<AccessGrant[]>

Implementation of

AccessGrantsBindings.getMemberGrants

---

getMemberJourneys()

getMemberJourneys: (wid, memberId) => Promise<MemberJourney[]>

Defined in: packages/sdk/src/client/client.ts:474

Get all journey enrollments for a member.

Parameters

wid

string

memberId

number

Returns

Promise<MemberJourney[]>

Implementation of

JourneysBindings.getMemberJourneys

---

getMemberLabel()

getMemberLabel: (wid, id) => Promise<MemberLabelResponse>

Defined in: packages/sdk/src/client/client.ts:299

Get a single member label by ID.

Parameters

wid

string

id

number

Returns

Promise<MemberLabelResponse>

Implementation of

MembersBindings.getMemberLabel

---

getMemberLabelByUuid()

getMemberLabelByUuid: (wid, uuid) => Promise<MemberLabelResponse>

Defined in: packages/sdk/src/client/client.ts:300

Get a single member label by UUID.

Parameters

wid

string

uuid

string

Returns

Promise<MemberLabelResponse>

Implementation of

MembersBindings.getMemberLabelByUuid

---

getMemberLabels()

getMemberLabels: (wid) => Promise<MemberLabelResponse[]>

Defined in: packages/sdk/src/client/client.ts:298

List all member labels for a workspace.

Parameters

wid

string

Returns

Promise<MemberLabelResponse[]>

Implementation of

MembersBindings.getMemberLabels

---

getMemberMemories()

getMemberMemories: (wid, memberId, options?) => Promise<MemberMemoriesResponse>

Defined in: packages/sdk/src/client/client.ts:328

Parameters

wid

string

memberId

number

options?

limit?

number

query?

string

type?

"all" | MemoryType

Returns

Promise<MemberMemoriesResponse>

Implementation of

MembersBindings.getMemberMemories

---

getMemberMemory()

getMemberMemory: (wid, memberId, key) => Promise<GeneratedMemoryResponse>

Defined in: packages/sdk/src/client/client.ts:329

Parameters

wid

string

memberId

number

key

string

Returns

Promise<GeneratedMemoryResponse>

Implementation of

MembersBindings.getMemberMemory

---

getMemberRecordCounts()

getMemberRecordCounts: (wid, memberId) => Promise<{ counts: Record<number, number>; }>

Defined in: packages/sdk/src/client/client.ts:256

Get record counts per data type for a specific member. Returns a mapping of data type ID to record count.

Parameters

wid

string

memberId

number

Returns

Promise<{ counts: Record<number, number>; }>

Implementation of

DataTypesBindings.getMemberRecordCounts

---

getMemberRelationships()

getMemberRelationships: (wid, memberId, params?) => Promise<PaginatedResponse<MemberRelationshipResponse>>

Defined in: packages/sdk/src/client/client.ts:335

Parameters

wid

string

memberId

number

params?

kind?

MemberRelationshipKind

page?

number

pageSize?

number

Returns

Promise<PaginatedResponse<MemberRelationshipResponse>>

Implementation of

MembersBindings.getMemberRelationships

---

getMemberRole()

getMemberRole: (wid, id) => Promise<MemberRoleResponse>

Defined in: packages/sdk/src/client/client.ts:305

Get a single member role by ID.

Parameters

wid

string

id

number

Returns

Promise<MemberRoleResponse>

Implementation of

MembersBindings.getMemberRole

---

getMemberRoleByUuid()

getMemberRoleByUuid: (wid, uuid) => Promise<MemberRoleResponse>

Defined in: packages/sdk/src/client/client.ts:306

Get a single member role by UUID.

Parameters

wid

string

uuid

string

Returns

Promise<MemberRoleResponse>

Implementation of

MembersBindings.getMemberRoleByUuid

---

getMemberRoleCleanupPlan()

getMemberRoleCleanupPlan: (wid) => Promise<MemberRoleCleanupPlanResponse>

Defined in: packages/sdk/src/client/client.ts:310

Describe legacy duplicate default roles in this workspace. Read-only.

Workspaces seeded by older versions of the product can carry the same default role under several spellings ("manager" next to "Manager"). This reports which ones should be merged and exactly how many members and references each merge would move.

Parameters

wid

string

Returns

Promise<MemberRoleCleanupPlanResponse>

Implementation of

MembersBindings.getMemberRoleCleanupPlan

---

getMemberRoles()

getMemberRoles: (wid) => Promise<MemberRoleResponse[]>

Defined in: packages/sdk/src/client/client.ts:304

List all member roles for a workspace.

Parameters

wid

string

Returns

Promise<MemberRoleResponse[]>

Implementation of

MembersBindings.getMemberRoles

---

getMembersMessageActivity()

getMembersMessageActivity: (wid, memberIds, days) => Promise<Record<number, number[]>>

Defined in: packages/sdk/src/client/client.ts:291

Get message activity counts for the specified members over a time period.

Parameters

wid

string

memberIds

number[]

days?

number = 30

Returns

Promise<Record<number, number[]>>

Implementation of

MembersBindings.getMembersMessageActivity

---

getMemberSubscriptionStatus()

getMemberSubscriptionStatus: {(siteUuid): Promise<MemberSubscriptionStatusResponse>; (options): Promise<MemberSubscriptionStatusResponse>; }

Defined in: packages/sdk/src/client/client.ts:1010

Call Signature

(siteUuid): Promise<MemberSubscriptionStatusResponse>

Read the authenticated Account's own membership state.

Parameters

siteUuid

string

Returns

Promise<MemberSubscriptionStatusResponse>

Call Signature

(options): Promise<MemberSubscriptionStatusResponse>

Read the authenticated Account's own membership state.

Parameters

options

siteUuid?

string

workspaceUuid?

string

Returns

Promise<MemberSubscriptionStatusResponse>

Implementation of

BillingBindings.getMemberSubscriptionStatus

---

getMemberSyncLinks()

getMemberSyncLinks: (wid, memberId) => Promise<MemberSyncLink[]>

Defined in: packages/sdk/src/client/client.ts:333

Get all sync links for a member across app connections.

Parameters

wid

string

memberId

number

Returns

Promise<MemberSyncLink[]>

Implementation of

MembersBindings.getMemberSyncLinks

---

getMemberSyncSummary()

getMemberSyncSummary: (wid, connectionId) => Promise<MemberSyncSummary>

Defined in: packages/sdk/src/client/client.ts:1238

Parameters

wid

string

connectionId

number

Returns

Promise<MemberSyncSummary>

Implementation of

IntegrationsBindings.getMemberSyncSummary

---

getMemberUsage()

getMemberUsage: (wid, memberId, params?) => Promise<MemberUsageReport>

Defined in: packages/sdk/src/client/client.ts:1019

Get usage report for a specific member within an optional date range.

Parameters

wid

string

memberId

number

params?

MemberUsageReportParams

Returns

Promise<MemberUsageReport>

Implementation of

BillingBindings.getMemberUsage

---

getMemberWorkflowVoices()

getMemberWorkflowVoices: (wid, memberId) => Promise<MemberWorkflowVoicesResponse>

Defined in: packages/sdk/src/client/client.ts:268

One row per workflow available to the member, with its voice state (Custom Voice). Own-data-or-scope: a member reads their OWN rows with no member scope; others need members:read.

Parameters

wid

string

memberId

number

Returns

Promise<MemberWorkflowVoicesResponse>

Implementation of

MembersBindings.getMemberWorkflowVoices

---

getMenuItems()

getMenuItems: (wid, siteId, parentId?) => Promise<MenuItemResponse[]>

Defined in: packages/sdk/src/client/client.ts:739

List menu items for a site, optionally filtered by parent item.

Parameters

wid

string

siteId

number

parentId?

number | null

Returns

Promise<MenuItemResponse[]>

Implementation of

SitesBindings.getMenuItems

---

getMessageTiming()

getMessageTiming: (wid, chatId) => Promise<MessageTimingResponse>

Defined in: packages/sdk/src/client/client.ts:222

Get message timing data for a chat recording.

Parameters

wid

string

chatId

number

Returns

Promise<MessageTimingResponse>

Implementation of

CallsBindings.getMessageTiming

---

getMetric()

getMetric: (wid, id) => Promise<MetricResponse>

Defined in: packages/sdk/src/client/client.ts:388

Parameters

wid

string

id

number

Returns

Promise<MetricResponse>

---

getMetricSeries()

getMetricSeries: (wid, metricId, params) => Promise<MetricSeriesResponse>

Defined in: packages/sdk/src/client/client.ts:393

Parameters

wid

string

metricId

number

params

aggregation?

"count" | "sum" | "avg" | "rate" | "last"

bucket?

"day" | "week"

end

string

start

string

Returns

Promise<MetricSeriesResponse>

---

getMondayBoardColumns()

getMondayBoardColumns: (wid, boardId) => Promise<ColumnsResponse>

Defined in: packages/sdk/src/client/client.ts:1052

Get columns for a specific Monday.com board

Parameters

wid

string

boardId

string

Returns

Promise<ColumnsResponse>

Implementation of

IntegrationsBindings.getMondayBoardColumns

---

getMondayBoardGroups()

getMondayBoardGroups: (wid, boardId) => Promise<GroupsResponse>

Defined in: packages/sdk/src/client/client.ts:1053

Get groups for a specific Monday.com board

Parameters

wid

string

boardId

string

Returns

Promise<GroupsResponse>

Implementation of

IntegrationsBindings.getMondayBoardGroups

---

getMondayBoards()

getMondayBoards: (wid) => Promise<BoardsResponse>

Defined in: packages/sdk/src/client/client.ts:1051

Get list of boards from the workspace Monday.com connection

Parameters

wid

string

Returns

Promise<BoardsResponse>

Implementation of

IntegrationsBindings.getMondayBoards

---

getMondayConnectionBoardColumns()

getMondayConnectionBoardColumns: (wid, boardId) => Promise<MondayColumn[]>

Defined in: packages/sdk/src/client/client.ts:1067

Parameters

wid

string

boardId

string

Returns

Promise<MondayColumn[]>

Implementation of

IntegrationsBindings.getMondayConnectionBoardColumns

---

getMondayConnectionBoardGroups()

getMondayConnectionBoardGroups: (wid, boardId) => Promise<MondayGroup[]>

Defined in: packages/sdk/src/client/client.ts:1068

Parameters

wid

string

boardId

string

Returns

Promise<MondayGroup[]>

Implementation of

IntegrationsBindings.getMondayConnectionBoardGroups

---

getMondayConnectionBoards()

getMondayConnectionBoards: (wid) => Promise<MondayBoard[]>

Defined in: packages/sdk/src/client/client.ts:1066

Parameters

wid

string

Returns

Promise<MondayBoard[]>

Implementation of

IntegrationsBindings.getMondayConnectionBoards

---

getMondayConnectionStatus()

getMondayConnectionStatus: (wid) => Promise<MondayConnectionStatus>

Defined in: packages/sdk/src/client/client.ts:1059

Parameters

wid

string

Returns

Promise<MondayConnectionStatus>

Implementation of

IntegrationsBindings.getMondayConnectionStatus

---

getMondayCurrentUserInfo()

getMondayCurrentUserInfo: (wid) => Promise<MondayCurrentUserInfoResponse>

Defined in: packages/sdk/src/client/client.ts:1054

Get info about the current user's Monday.com connection

Parameters

wid

string

Returns

Promise<MondayCurrentUserInfoResponse>

Implementation of

IntegrationsBindings.getMondayCurrentUserInfo

---

getMondayReconciliationMatches()

getMondayReconciliationMatches: (wid, params?) => Promise<MondayReconciliationMatch[]>

Defined in: packages/sdk/src/client/client.ts:1072

Parameters

wid

string

params?

limit?

number

offset?

number

Returns

Promise<MondayReconciliationMatch[]>

Implementation of

IntegrationsBindings.getMondayReconciliationMatches

---

getMondaySyncConfig()

getMondaySyncConfig: (wid) => Promise<MondaySyncConfigResponse>

Defined in: packages/sdk/src/client/client.ts:1069

Parameters

wid

string

Returns

Promise<MondaySyncConfigResponse>

Implementation of

IntegrationsBindings.getMondaySyncConfig

---

getMotd()

getMotd: (wid, options?) => Promise<MotdResponse>

Defined in: packages/sdk/src/client/client.ts:434

The Message-of-the-Day tip for the workspace on a given date.

date is an ISO YYYY-MM-DD string (defaults to today, UTC, when omitted); offset advances the rotation ("show another"). Selection is deterministic — same date + workspace + offset always returns the same tip — and cycles through the tip list.

Parameters

wid

string

options?

date?

string

offset?

number

Returns

Promise<MotdResponse>

Implementation of

MotdBindings.getMotd

---

getMyCredentials()

getMyCredentials: (wid) => Promise<MemberCredential[]>

Defined in: packages/sdk/src/client/client.ts:1092

Get the current member's credentials (connected accounts).

Parameters

wid

string

Returns

Promise<MemberCredential[]>

Implementation of

IntegrationsBindings.getMyCredentials

---

getMyCustomer()

getMyCustomer: (uuid) => Promise<MyCustomerResponse>

Defined in: packages/sdk/src/client/client.ts:1268

Parameters

uuid

string

Returns

Promise<MyCustomerResponse>

Implementation of

CustomersBindings.getMyCustomer

---

getMyCustomerAccounts()

getMyCustomerAccounts: (uuid) => Promise<CustomerAccount[]>

Defined in: packages/sdk/src/client/client.ts:1269

Parameters

uuid

string

Returns

Promise<CustomerAccount[]>

Implementation of

CustomersBindings.getMyCustomerAccounts

---

getMyCustomerCreditGrants()

getMyCustomerCreditGrants: (uuid, opts?) => Promise<CreditGrantListResponse>

Defined in: packages/sdk/src/client/client.ts:1279

Parameters

uuid

string

opts?

page?

number

pageSize?

number

subscriptionId?

number

Returns

Promise<CreditGrantListResponse>

Implementation of

CustomersBindings.getMyCustomerCreditGrants

---

getMyCustomerInvoices()

getMyCustomerInvoices: (uuid) => Promise<InvoiceResponse[]>

Defined in: packages/sdk/src/client/client.ts:1271

Parameters

uuid

string

Returns

Promise<InvoiceResponse[]>

Implementation of

CustomersBindings.getMyCustomerInvoices

---

getMyCustomerPaymentMethods()

getMyCustomerPaymentMethods: (uuid) => Promise<StripePaymentMethod[]>

Defined in: packages/sdk/src/client/client.ts:1275

Parameters

uuid

string

Returns

Promise<StripePaymentMethod[]>

Implementation of

CustomersBindings.getMyCustomerPaymentMethods

---

getMyCustomers()

getMyCustomers: () => Promise<MyCustomerResponse[]>

Defined in: packages/sdk/src/client/client.ts:1267

Returns

Promise<MyCustomerResponse[]>

Implementation of

CustomersBindings.getMyCustomers

---

getMyCustomerSubscriptions()

getMyCustomerSubscriptions: (uuid, opts?) => Promise<{ items: SubscriptionResponse[]; page: number; pageSize: number; total: number; }>

Defined in: packages/sdk/src/client/client.ts:1270

Parameters

uuid

string

opts?

page?

number

pageSize?

number

status?

string

subscriptionId?

number

Returns

Promise<{ items: SubscriptionResponse[]; page: number; pageSize: number; total: number; }>

Implementation of

CustomersBindings.getMyCustomerSubscriptions

---

getMyDataTypes()

getMyDataTypes: (wid) => Promise<MyDataTypeResponse[]>

Defined in: packages/sdk/src/client/client.ts:266

Member-scoped DataTypes the current member may use (self-access — works on a Site session, which can hold no records scope by construction).

Parameters

wid

string

Returns

Promise<MyDataTypeResponse[]>

Implementation of

MembersBindings.getMyDataTypes

---

getMyGivenGrants()

getMyGivenGrants: (wid, params?) => Promise<PaginatedResponse<AccessGrant>>

Defined in: packages/sdk/src/client/client.ts:516

List access grants given by the current member.

Parameters

wid

string

params?

page?

number

pageSize?

number

status?

string

Returns

Promise<PaginatedResponse<AccessGrant>>

Implementation of

AccessGrantsBindings.getMyGivenGrants

---

getMyOrganizations()

getMyOrganizations: () => Promise<AdminAccountOrgMembershipResponse[]>

Defined in: packages/sdk/src/client/client.ts:679

List all organizations the current account belongs to.

Returns

Promise<AdminAccountOrgMembershipResponse[]>

Implementation of

AuthBindings.getMyOrganizations

---

getMyPronunciations()

getMyPronunciations: () => Promise<PronunciationEntryResponse[]>

Defined in: packages/sdk/src/client/client.ts:1258

List the current user's personal pronunciation entries.

Returns

Promise<PronunciationEntryResponse[]>

Implementation of

PronunciationsBindings.getMyPronunciations

---

getMyReceivedGrants()

getMyReceivedGrants: (wid, params?) => Promise<PaginatedResponse<AccessGrant>>

Defined in: packages/sdk/src/client/client.ts:515

List access grants received by the current member.

Parameters

wid

string

params?

page?

number

pageSize?

number

status?

string

Returns

Promise<PaginatedResponse<AccessGrant>>

Implementation of

AccessGrantsBindings.getMyReceivedGrants

---

getMyRecords()

getMyRecords: (wid, dataTypeId, options?) => Promise<PaginatedResponseDataRecordResponse>

Defined in: packages/sdk/src/client/client.ts:267

The current member's own records for one DataType (self-access).

Parameters

wid

string

dataTypeId

number

options?

page?

number

pageSize?

number

Returns

Promise<PaginatedResponseDataRecordResponse>

Implementation of

MembersBindings.getMyRecords

---

getMyReseller()

getMyReseller: (uuid) => Promise<MyResellerResponse>

Defined in: packages/sdk/src/client/client.ts:1283

Parameters

uuid

string

Returns

Promise<MyResellerResponse>

Implementation of

ResellersBindings.getMyReseller

---

getMyResellerAccounts()

getMyResellerAccounts: (uuid) => Promise<ResellerAccount[]>

Defined in: packages/sdk/src/client/client.ts:1284

Parameters

uuid

string

Returns

Promise<ResellerAccount[]>

Implementation of

ResellersBindings.getMyResellerAccounts

---

getMyResellerProducts()

getMyResellerProducts: (uuid) => Promise<Product[]>

Defined in: packages/sdk/src/client/client.ts:1285

Parameters

uuid

string

Returns

Promise<Product[]>

Implementation of

ResellersBindings.getMyResellerProducts

---

getMyResellers()

getMyResellers: () => Promise<MyResellerResponse[]>

Defined in: packages/sdk/src/client/client.ts:1282

Returns

Promise<MyResellerResponse[]>

Implementation of

ResellersBindings.getMyResellers

---

getMyResellerSubscriptions()

getMyResellerSubscriptions: (uuid, opts?) => Promise<{ items: SubscriptionResponse[]; page: number; pageSize: number; total: number; }>

Defined in: packages/sdk/src/client/client.ts:1286

Parameters

uuid

string

opts?

page?

number

pageSize?

number

status?

string

Returns

Promise<{ items: SubscriptionResponse[]; page: number; pageSize: number; total: number; }>

Implementation of

ResellersBindings.getMyResellerSubscriptions

---

getNotification()

getNotification: (wid, id) => Promise<NotificationResponse>

Defined in: packages/sdk/src/client/client.ts:551

Get a single notification by ID.

Parameters

wid

string

id

number

Returns

Promise<NotificationResponse>

Implementation of

WorkspacesBindings.getNotification

---

getNotificationRules()

getNotificationRules: (wid) => Promise<NotificationRule[]>

Defined in: packages/sdk/src/client/client.ts:941

List all notification rules in a workspace.

Parameters

wid

string

Returns

Promise<NotificationRule[]>

Implementation of

CommunicationsBindings.getNotificationRules

---

getNotifications()

getNotifications: (wid, options) => Promise<PaginatedResponse<NotificationResponse>>

Defined in: packages/sdk/src/client/client.ts:550

List notifications for the current user in a workspace.

Parameters

wid

string

options?

page?

number

pageSize?

number

Returns

Promise<PaginatedResponse<NotificationResponse>>

Implementation of

WorkspacesBindings.getNotifications

---

getOAuthAuthorizationUrl()

getOAuthAuthorizationUrl: (providerSlug, options?) => Promise<OAuthAuthorizeResponse>

Defined in: packages/sdk/src/client/client.ts:1047

Parameters

providerSlug

OAuthProviderSlug

options?

OAuthAuthorizeOptions

Returns

Promise<OAuthAuthorizeResponse>

Implementation of

AppsBindings.getOAuthAuthorizationUrl

---

getOAuthConnectionStatus()

getOAuthConnectionStatus: (providerSlug) => Promise<OAuthConnectionStatus | null>

Defined in: packages/sdk/src/client/client.ts:1045

Parameters

providerSlug

OAuthProviderSlug

Returns

Promise<OAuthConnectionStatus | null>

Implementation of

AppsBindings.getOAuthConnectionStatus

---

getOperatorChatMessages()

getOperatorChatMessages: (wid, chatId, limit, offset) => Promise<ChatMessage[]>

Defined in: packages/sdk/src/client/client.ts:511

Get paginated chat messages for an operator chat.

Parameters

wid

string

chatId

number

limit?

number = 50

offset?

number = 0

Returns

Promise<ChatMessage[]>

Implementation of

OperatorBindings.getOperatorChatMessages

---

getOperatorGroup()

getOperatorGroup: (wid, groupId) => Promise<OperatorGroup>

Defined in: packages/sdk/src/client/client.ts:503

Get a single operator group by ID.

Parameters

wid

string

groupId

number

Returns

Promise<OperatorGroup>

Implementation of

OperatorBindings.getOperatorGroup

---

getOperatorGroups()

getOperatorGroups: (wid) => Promise<OperatorGroup[]>

Defined in: packages/sdk/src/client/client.ts:502

List all operator groups for a workspace.

Parameters

wid

string

Returns

Promise<OperatorGroup[]>

Implementation of

OperatorBindings.getOperatorGroups

---

getOrCreateQualificationForWorkflow()

getOrCreateQualificationForWorkflow: (wid, workflowId) => Promise<QualificationResponse>

Defined in: packages/sdk/src/client/client.ts:359

Fetch (auto-creating if absent) the qualification for a workflow.

Parameters

wid

string

workflowId

number

Returns

Promise<QualificationResponse>

Implementation of

QualificationsBindings.getOrCreateQualificationForWorkflow

---

getOrgActivityCounts()

getOrgActivityCounts: (orgUuid, request) => Promise<ActivityCountsResponse>

Defined in: packages/sdk/src/client/client.ts:420

The org mount's badge numbers.

Parameters

orgUuid

string

request?

ActivityCountsRequest = {}

Returns

Promise<ActivityCountsResponse>

Implementation of

ActivityBindings.getOrgActivityCounts

---

getOrgBillingCustomer()

getOrgBillingCustomer: (orgIdOrUuid) => Promise<{ customerName: string | null; customerUuid: string | null; hasAccess: boolean; subscriptionId: number | null; }>

Defined in: packages/sdk/src/client/client.ts:623

Get the billing customer and this organization's billable subscription.

subscriptionId is the org-scoped row — never pick the customer's newest subscription from the list endpoint. One customer can bill many organizations.

Parameters

orgIdOrUuid

string | number

Returns

Promise<{ customerName: string | null; customerUuid: string | null; hasAccess: boolean; subscriptionId: number | null; }>

Implementation of

OrgBindings.getOrgBillingCustomer

---

getOrgDomain()

getOrgDomain: (orgIdOrUuid, domainUuid) => Promise<OrgDomain>

Defined in: packages/sdk/src/client/client.ts:597

Get a registered organization domain by UUID.

Parameters

orgIdOrUuid

string | number

domainUuid

string

Returns

Promise<OrgDomain>

Implementation of

OrgBindings.getOrgDomain

---

getOrgDomainEmail()

getOrgDomainEmail: (orgIdOrUuid, domainUuid) => Promise<EmailDomainConfigGetResponse>

Defined in: packages/sdk/src/client/client.ts:601

Get email DNS provisioning and verification status for an org domain.

Parameters

orgIdOrUuid

string | number

domainUuid

string

Returns

Promise<EmailDomainConfigGetResponse>

Implementation of

OrgBindings.getOrgDomainEmail

---

getOrgDomainSite()

getOrgDomainSite: (orgIdOrUuid, domainUuid) => Promise<SiteDomainConfigGetResponse>

Defined in: packages/sdk/src/client/client.ts:605

Get site CNAME provisioning and verification status for an org domain.

Parameters

orgIdOrUuid

string | number

domainUuid

string

Returns

Promise<SiteDomainConfigGetResponse>

Implementation of

OrgBindings.getOrgDomainSite

---

getOrgSupportRequest()

getOrgSupportRequest: (orgUuid, uuid) => Promise<SupportRequest>

Defined in: packages/sdk/src/client/client.ts:1295

Parameters

orgUuid

string

uuid

string

Returns

Promise<SupportRequest>

Implementation of

SupportRequestsBindings.getOrgSupportRequest

---

getOrgWorkspaceMember()

getOrgWorkspaceMember: (orgUuid, workspaceUuid, memberId) => Promise<WorkspaceMemberResponse>

Defined in: packages/sdk/src/client/client.ts:280

Get one member of an org's workspace, under org:read.

The same record and the same shape as getWorkspaceMember, for a reader whose authority is the org rather than a member row in that workspace — an org Activity pane opening a member it just listed. A workspace outside the org is a 404, indistinguishable from a member id that does not exist.

Parameters

orgUuid

string

workspaceUuid

string

memberId

number

Returns

Promise<WorkspaceMemberResponse>

Implementation of

MembersBindings.getOrgWorkspaceMember

---

getOrgWorkspaceUsage()

getOrgWorkspaceUsage: (orgIdOrUuid) => Promise<OrgWorkspaceUsageResponse>

Defined in: packages/sdk/src/client/client.ts:626

Per-workspace usage for this organization's current credit window.

Requires a billing role on the organization's billing customer — the same gate getOrgBillingCustomer().hasAccess reports, and the one that decides whether the billing tab is shown at all.

creditsUsed is a real organization-wide total or it is null; it is never a partial sum. There is deliberately no per-workspace "remaining" figure — the caps belong to the organization, so cap - oneWorkspace describes nothing.

Parameters

orgIdOrUuid

string | number

Returns

Promise<OrgWorkspaceUsageResponse>

Implementation of

OrgBindings.getOrgWorkspaceUsage

---

getOwnedMembers()

getOwnedMembers: (wid) => Promise<WorkspaceMemberResponse[]>

Defined in: packages/sdk/src/client/client.ts:272

Get all members owned by the current member in this workspace. Returns the authenticated member plus any members they own (via owner_id). Used by the member switcher to show available identities.

Parameters

wid

string

Returns

Promise<WorkspaceMemberResponse[]>

Implementation of

MembersBindings.getOwnedMembers

---

getPage()

getPage: (wid, siteId, pageId) => Promise<PageResponse>

Defined in: packages/sdk/src/client/client.ts:732

Get a single page by ID within a site.

Parameters

wid

string

siteId

number

pageId

number

Returns

Promise<PageResponse>

Implementation of

SitesBindings.getPage

---

getPageBySlug()

getPageBySlug: (wid, siteId, slug) => Promise<PageResponse>

Defined in: packages/sdk/src/client/client.ts:733

Get a single page by its slug within a site.

Parameters

wid

string

siteId

number

slug

string

Returns

Promise<PageResponse>

Implementation of

SitesBindings.getPageBySlug

---

getPasswordStatus()

getPasswordStatus: () => Promise<{ hasPassword: boolean; }>

Defined in: packages/sdk/src/client/client.ts:660

Check whether the current account has a password set.

Returns

Promise<{ hasPassword: boolean; }>

Implementation of

AuthBindings.getPasswordStatus

---

getPatientSyncStatus()

getPatientSyncStatus: (wid) => Promise<PatientSyncConnectionStatus>

Defined in: packages/sdk/src/client/client.ts:1159

Read the PatientSync connection status (never returns the API key).

Parameters

wid

string

Returns

Promise<PatientSyncConnectionStatus>

Implementation of

IntegrationsBindings.getPatientSyncStatus

---

getPendingCredentialChanges()

getPendingCredentialChanges: () => Promise<PendingCredentialChange[]>

Defined in: packages/sdk/src/client/client.ts:682

Get all pending (non-applied) credential change requests.

Returns

Promise<PendingCredentialChange[]>

Implementation of

AuthBindings.getPendingCredentialChanges

---

getPersona()

getPersona: (wid, id) => Promise<Persona>

Defined in: packages/sdk/src/client/client.ts:379

Parameters

wid

string

id

number

Returns

Promise<Persona>

Implementation of

PersonasBindings.getPersona

---

getPhoneCalls()

getPhoneCalls: (wid, options) => Promise<PaginatedResponse<PhoneCall>>

Defined in: packages/sdk/src/client/client.ts:221

List workspace phone calls with optional filtering.

Parameters

wid

string

options?

chatId?

number

dateFrom?

string

dateTo?

string

inbound?

boolean

page?

number

pageSize?

number

phoneNumberId?

string | number

status?

string

workflowId?

number

Returns

Promise<PaginatedResponse<PhoneCall>>

Implementation of

CallsBindings.getPhoneCalls

---

getPhoneNumber()

getPhoneNumber: (wid, id) => Promise<PhoneNumber>

Defined in: packages/sdk/src/client/client.ts:905

Get a phone number by ID or UUID.

Parameters

wid

string

id

string | number

Returns

Promise<PhoneNumber>

Implementation of

CommunicationsBindings.getPhoneNumber

---

getPhoneNumberCalls()

getPhoneNumberCalls: (wid, id, page, pageSize, filters?) => Promise<PaginatedResponse<PhoneCall>>

Defined in: packages/sdk/src/client/client.ts:910

List paginated call records for a phone number.

Routes through the workspace-wide /calls endpoint with a phoneNumberId filter.

Parameters

wid

string

id

number

page?

number = 1

pageSize?

number = 10

filters?

callId?

number

Narrow the current phone-number listing to one retired Activity target.

dateFrom?

string

dateTo?

string

inbound?

boolean

status?

string

Returns

Promise<PaginatedResponse<PhoneCall>>

Implementation of

CommunicationsBindings.getPhoneNumberCalls

---

getPhoneNumberFaxes()

getPhoneNumberFaxes: (wid, id, page, pageSize, filters?) => Promise<PaginatedResponse<InboundFaxLogEntry>>

Defined in: packages/sdk/src/client/client.ts:915

List received faxes for a phone number.

The same log the Documo connection page shows, scoped to a number. Rows carry senderNumber — an unauthenticated claim by the sending machine, and PHI. Render it for triage; never log it.

Same query vocabulary as listDocumoFaxes — one log, one spelling. status is repeatable and is validated against the status enum, so a typo is a 422 rather than a silently empty page. The date bounds filter on when the delivery was recorded, not on receivedAt: a fax that failed before storage never gets a receivedAt, so bounding that column would hide exactly the failures an operator filtering by date is hunting for.

Parameters

wid

string

id

number

page?

number = 1

pageSize?

number = 10

filters?

receivedAfter?

string

receivedBefore?

string

status?

readonly InboundFaxStatus[]

Returns

Promise<PaginatedResponse<InboundFaxLogEntry>>

Implementation of

CommunicationsBindings.getPhoneNumberFaxes

---

getPhoneNumberMessages()

getPhoneNumberMessages: (wid, id, page, pageSize, filters?) => Promise<PaginatedResponse<SMSMessage>>

Defined in: packages/sdk/src/client/client.ts:914

List paginated SMS messages for a phone number.

Parameters

wid

string

id

number

page?

number = 1

pageSize?

number = 10

filters?

dateFrom?

string

dateTo?

string

inbound?

boolean

status?

string

Returns

Promise<PaginatedResponse<SMSMessage>>

Implementation of

CommunicationsBindings.getPhoneNumberMessages

---

getPhoneNumberOutboundAnalyticsCalls()

getPhoneNumberOutboundAnalyticsCalls: (wid, id, options) => Promise<PaginatedResponse<OutboundCallAnalyticsRowResponse>>

Defined in: packages/sdk/src/client/client.ts:912

One paginated page of outbound-call analytics detail rows. Anonymized by default; raw: true requires the export:admin scope server-side and is audited per response. analyticsSessionId keeps the callee pseudonyms stable across pagination/sort within one browser session.

Parameters

wid

string

id

number

options

analyticsSessionId

string

filters?

OutboundCallAnalyticsFilters

page?

number

pageSize?

number

raw?

boolean

sort?

OutboundCallAnalyticsSortKey

sortDirection?

"asc" | "desc"

Returns

Promise<PaginatedResponse<OutboundCallAnalyticsRowResponse>>

Implementation of

CommunicationsBindings.getPhoneNumberOutboundAnalyticsCalls

---

getPhoneNumberOutboundAnalyticsSummary()

getPhoneNumberOutboundAnalyticsSummary: (wid, id, filters?) => Promise<OutboundCallAnalyticsSummary>

Defined in: packages/sdk/src/client/client.ts:911

Always-anonymized outbound-call analytics summary for one phone number. No analyticsSessionId is sent — the summary carries no row-level PHI.

Parameters

wid

string

id

number

filters?

OutboundCallAnalyticsFilters

Returns

Promise<OutboundCallAnalyticsSummary>

Implementation of

CommunicationsBindings.getPhoneNumberOutboundAnalyticsSummary

---

getPhoneNumbers()

getPhoneNumbers: (wid, options?) => Promise<PhoneNumber[]>

Defined in: packages/sdk/src/client/client.ts:902

List phone numbers in a workspace, optionally including archived.

Parameters

wid

string

options?

isArchived?

boolean

Returns

Promise<PhoneNumber[]>

Implementation of

CommunicationsBindings.getPhoneNumbers

---

getPhoneNumberVoicemails()

getPhoneNumberVoicemails: (wid, id, page, pageSize, status?) => Promise<PaginatedResponse<Voicemail>>

Defined in: packages/sdk/src/client/client.ts:916

List paginated voicemails for a phone number.

Parameters

wid

string

id

number

page?

number = 1

pageSize?

number = 10

status?

VoicemailStatus

Returns

Promise<PaginatedResponse<Voicemail>>

Implementation of

CommunicationsBindings.getPhoneNumberVoicemails

---

getPhoneUsageReport()

getPhoneUsageReport: (wid, params?) => Promise<PhoneUsageReport>

Defined in: packages/sdk/src/client/client.ts:1017

Get phone call usage report for a workspace within an optional date range.

Parameters

wid

string

params?

PhoneUsageReportParams

Returns

Promise<PhoneUsageReport>

Implementation of

BillingBindings.getPhoneUsageReport

---

getPlan()

getPlan: (wid, slug, plan) => Promise<PlanDetailResponse>

Defined in: packages/sdk/src/client/client.ts:751

One plan: summary + resolved process + flows + run state.

Parameters

wid

string

slug

string

plan

string

Returns

Promise<PlanDetailResponse>

Implementation of

ProjectsBindings.getPlan

---

getPlatformApp()

getPlatformApp: (wid, appUuid) => Promise<PlatformAppConnectionResponse>

Defined in: packages/sdk/src/client/client.ts:1245

Get platform app connection details by UUID.

Parameters

wid

string

appUuid

string

Returns

Promise<PlatformAppConnectionResponse>

Implementation of

IntegrationsBindings.getPlatformApp

---

getPresenceStatus()

getPresenceStatus: (wid) => Promise<PresenceStatusResponse>

Defined in: packages/sdk/src/client/client.ts:510

Get the current member's presence status.

Parameters

wid

string

Returns

Promise<PresenceStatusResponse>

Implementation of

OperatorBindings.getPresenceStatus

---

getProduct()

getProduct: (id) => Promise<Product>

Defined in: packages/sdk/src/client/client.ts:563

Get a product by ID using the global endpoint.

Parameters

id

number

Returns

Promise<Product>

Implementation of

WorkspacesBindings.getProduct

---

getProducts()

getProducts: (wid, featured?) => Promise<Product[]>

Defined in: packages/sdk/src/client/client.ts:562

List products available from a reseller workspace, optionally filtering by featured status.

Parameters

wid

string

featured?

boolean

Returns

Promise<Product[]>

Implementation of

WorkspacesBindings.getProducts

---

getProject()

getProject: (wid, slug) => Promise<ProjectDetailResponse>

Defined in: packages/sdk/src/client/client.ts:750

One project: summary + present docs + plan summaries.

Parameters

wid

string

slug

string

Returns

Promise<ProjectDetailResponse>

Implementation of

ProjectsBindings.getProject

---

getProjects()

getProjects: (wid, options) => Promise<PaginatedResponse<ProjectSummaryResponse>>

Defined in: packages/sdk/src/client/client.ts:749

List projects (README frontmatter summaries).

Parameters

wid

string

options?

page?

number

pageSize?

number

Returns

Promise<PaginatedResponse<ProjectSummaryResponse>>

Implementation of

ProjectsBindings.getProjects

---

getPronunciationEntries()

getPronunciationEntries: (orgUuid, options) => Promise<PronunciationEntryResponse[]>

Defined in: packages/sdk/src/client/client.ts:1252

List pronunciation entries for an organization, optionally filtered by scope.

Parameters

orgUuid

string

options?

accountId?

number

scope?

"org" | "account"

Returns

Promise<PronunciationEntryResponse[]>

Implementation of

PronunciationsBindings.getPronunciationEntries

---

getPublicFeatureRegistry()

getPublicFeatureRegistry: () => Promise<FeaturesRegistryResponse>

Defined in: packages/sdk/src/client/client.ts:982

Get the public feature registry (no auth required). Returns only features marked for product page display.

Returns

Promise<FeaturesRegistryResponse>

Implementation of

ToolkitsBindings.getPublicFeatureRegistry

---

getPublicFile()

getPublicFile: (wid, fileId) => Promise<PublicFileMetadata>

Defined in: packages/sdk/src/client/client.ts:789

Get metadata for a publicly shared file (unauthenticated).

Parameters

wid

string

fileId

number

Returns

Promise<PublicFileMetadata>

Implementation of

FilesBindings.getPublicFile

---

getPublicFolder()

getPublicFolder: (wid, folderId, page, pageSize) => Promise<PublicFolderContents>

Defined in: packages/sdk/src/client/client.ts:790

Get contents of a publicly shared folder (unauthenticated).

Parameters

wid

string

folderId

number

page?

number = 1

pageSize?

number = 100

Returns

Promise<PublicFolderContents>

Implementation of

FilesBindings.getPublicFolder

---

getPublicFolderFiles()

getPublicFolderFiles: (wid, folderId, page, pageSize) => Promise<{ files: PublicFileMetadata[]; pagination?: any; }>

Defined in: packages/sdk/src/client/client.ts:791

List files within a publicly shared folder (unauthenticated).

Parameters

wid

string

folderId

number

page?

number = 1

pageSize?

number = 100

Returns

Promise<{ files: PublicFileMetadata[]; pagination?: any; }>

Implementation of

FilesBindings.getPublicFolderFiles

---

getPublicProduct()

getPublicProduct: (id) => Promise<Product>

Defined in: packages/sdk/src/client/client.ts:568

Get a publicly accessible product by ID.

Parameters

id

number

Returns

Promise<Product>

Implementation of

WorkspacesBindings.getPublicProduct

---

getPublicProducts()

getPublicProducts: (workspaceUuid, featured?) => Promise<Product[]>

Defined in: packages/sdk/src/client/client.ts:565

List public products for a workspace's storefront. No auth required.

Parameters

workspaceUuid

string

featured?

boolean

Returns

Promise<Product[]>

Implementation of

WorkspacesBindings.getPublicProducts

---

getPublicWorkspaces()

getPublicWorkspaces: () => Promise<PublicWorkspace[]>

Defined in: packages/sdk/src/client/client.ts:536

List all publicly visible workspaces.

Returns

Promise<PublicWorkspace[]>

Implementation of

WorkspacesBindings.getPublicWorkspaces

---

getQualification()

getQualification: (wid, id) => Promise<QualificationResponse>

Defined in: packages/sdk/src/client/client.ts:358

Get a single qualification by ID.

Parameters

wid

string

id

number

Returns

Promise<QualificationResponse>

Implementation of

QualificationsBindings.getQualification

---

getQualifications()

getQualifications: (wid, params?) => Promise<PaginatedResponse<QualificationResponse>>

Defined in: packages/sdk/src/client/client.ts:357

List qualifications in a workspace, paginated.

Parameters

wid

string

params?

page?

number

pageSize?

number

Returns

Promise<PaginatedResponse<QualificationResponse>>

Implementation of

QualificationsBindings.getQualifications

---

getQueryFields()

getQueryFields: (wid) => Promise<QueryFieldsResponse>

Defined in: packages/sdk/src/client/client.ts:373

Queryable namespace: native fields, operators per type, DataType record fields.

Parameters

wid

string

Returns

Promise<QueryFieldsResponse>

Implementation of

QueriesBindings.getQueryFields

---

getRealtimeModels()

getRealtimeModels: (provider?) => Promise<AIModelsResponse>

Defined in: packages/sdk/src/client/client.ts:953

Get available realtime AI models

Parameters

provider?

string

Returns

Promise<AIModelsResponse>

Implementation of

ToolkitsBindings.getRealtimeModels

---

getRecommendedVoices()

getRecommendedVoices: () => Promise<RecommendedVoiceResponse[]>

Defined in: packages/sdk/src/client/client.ts:1263

List recommended voices for pronunciation preview.

Returns

Promise<RecommendedVoiceResponse[]>

Implementation of

PronunciationsBindings.getRecommendedVoices

---

getRecordingInfo()

getRecordingInfo: (wid, chatId) => Promise<RecordingInfoResponse>

Defined in: packages/sdk/src/client/client.ts:223

Get PHI-safe provenance metadata for the recording served by /audio.wav — source, encryption, channels, duration, status, etc. Staff-only Twilio SIDs are present only for superusers. Returns 404 when the chat has no native recording row (legacy chunk-only playback).

Parameters

wid

string

chatId

number

Returns

Promise<RecordingInfoResponse>

Implementation of

CallsBindings.getRecordingInfo

---

getRegistrationDraft()

getRegistrationDraft: (orgUuid, legalEntityUuid, kind) => Promise<RegistrationDraftResponse>

Defined in: packages/sdk/src/client/client.ts:618

Read one registration draft for a legal entity.

A draft is what the operator has typed but not submitted. It exists so data entry is never gated on a prerequisite: someone can write down the caller-ID name today and submit it the day the business is verified.

Parameters

orgUuid

string

legalEntityUuid

string

kind

RegistrationDraftKind

Returns

Promise<RegistrationDraftResponse>

Implementation of

OrgBindings.getRegistrationDraft

---

getResellerWorkspaces()

getResellerWorkspaces: (wid, params?) => Promise<PaginatedResponse<ClientWorkspace>>

Defined in: packages/sdk/src/client/client.ts:556

List client workspaces managed by this reseller workspace, paginated.

Parameters

wid

string

params?

page?

number

pageSize?

number

Returns

Promise<PaginatedResponse<ClientWorkspace>>

Implementation of

WorkspacesBindings.getResellerWorkspaces

---

getRoutine()

getRoutine: (wid, id) => Promise<RoutineResponse>

Defined in: packages/sdk/src/client/client.ts:806

Get a single routine by ID.

Parameters

wid

string

id

number

Returns

Promise<RoutineResponse>

Implementation of

EventsBindings.getRoutine

---

getRoutineConfigEvents()

getRoutineConfigEvents: (wid, id, options) => Promise<RoutineConfigEventResponse[]>

Defined in: packages/sdk/src/client/client.ts:811

Configuration change history for one routine, newest first.

Answers "who turned this off, when, and why" — including the platform-initiated pauses (finite-repeat exhaustion, outbound-safety runaway auto-pause) that no other surface exposes.

transitionsOnly filters to rows that record a real trigger-gate transition. Prefer it for a toggle-focused view: a full-form save always re-sends every field, so unfiltered history includes saves that changed nothing.

Parameters

wid

string

id

number

options?

beforeId?

number

limit?

number

transitionsOnly?

boolean

Returns

Promise<RoutineConfigEventResponse[]>

Implementation of

EventsBindings.getRoutineConfigEvents

---

getRoutineRuns()

getRoutineRuns: (wid, options) => Promise<PaginatedResponse<RoutineRunResponse>>

Defined in: packages/sdk/src/client/client.ts:812

List routine run history with optional filtering by routine and status.

Parameters

wid

string

options?

page?

number

pageSize?

number

routineId?

number

sortBy?

"createdAt"

sortOrder?

SortOrder

status?

string

Returns

Promise<PaginatedResponse<RoutineRunResponse>>

Implementation of

EventsBindings.getRoutineRuns

---

getRoutines()

getRoutines: (wid, options) => Promise<PaginatedResponse<RoutineResponse>>

Defined in: packages/sdk/src/client/client.ts:805

List routines with optional pagination and active status filtering.

Parameters

wid

string

options?

RoutinesQueryParams = {}

Returns

Promise<PaginatedResponse<RoutineResponse>>

Implementation of

EventsBindings.getRoutines

---

getRuleExecutions()

getRuleExecutions: (wid, options) => Promise<CursorPaginatedResponse<RuleExecutionResponse>>

Defined in: packages/sdk/src/client/client.ts:804

List event rule executions with cursor-based pagination and filtering.

Parameters

wid

string

options?

RuleExecutionsQueryParams = {}

Returns

Promise<CursorPaginatedResponse<RuleExecutionResponse>>

Implementation of

EventsBindings.getRuleExecutions

---

getSalesforceReconciliationMatches()

getSalesforceReconciliationMatches: (wid, params?) => Promise<SalesforceReconciliationMatch[]>

Defined in: packages/sdk/src/client/client.ts:1196

Parameters

wid

string

params?

limit?

number

offset?

number

Returns

Promise<SalesforceReconciliationMatch[]>

Implementation of

IntegrationsBindings.getSalesforceReconciliationMatches

---

getSalesforceStatus()

getSalesforceStatus: (wid) => Promise<SalesforceConnectionStatus>

Defined in: packages/sdk/src/client/client.ts:1191

Parameters

wid

string

Returns

Promise<SalesforceConnectionStatus>

Implementation of

IntegrationsBindings.getSalesforceStatus

---

getSalesforceSyncConfig()

getSalesforceSyncConfig: (wid) => Promise<SalesforceSyncConfigResponse>

Defined in: packages/sdk/src/client/client.ts:1201

Parameters

wid

string

Returns

Promise<SalesforceSyncConfigResponse>

Implementation of

IntegrationsBindings.getSalesforceSyncConfig

---

getScenario()

getScenario: (wid, scenarioId) => Promise<Scenario>

Defined in: packages/sdk/src/client/client.ts:362

Parameters

wid

string

scenarioId

number

Returns

Promise<Scenario>

Implementation of

QualificationsBindings.getScenario

---

getSite()

getSite: (wid, id) => Promise<Site>

Defined in: packages/sdk/src/client/client.ts:706

Get a single site by ID.

Parameters

wid

string

id

number

Returns

Promise<Site>

Implementation of

SitesBindings.getSite

---

getSiteByUuid()

getSiteByUuid: (wid, uuid) => Promise<Site>

Defined in: packages/sdk/src/client/client.ts:720

Get a single site by UUID.

Parameters

wid

string

uuid

string

Returns

Promise<Site>

Implementation of

SitesBindings.getSiteByUuid

---

getSiteCounts()

getSiteCounts: (wid, siteId) => Promise<SiteCountsResponse>

Defined in: packages/sdk/src/client/client.ts:737

Get aggregate counts (pages, menu items, etc.) for a site.

Parameters

wid

string

siteId

number

Returns

Promise<SiteCountsResponse>

Implementation of

SitesBindings.getSiteCounts

---

getSiteMenu()

getSiteMenu: (wid, siteId) => Promise<MenuTreeResponse>

Defined in: packages/sdk/src/client/client.ts:738

Get the full menu tree for a site.

Parameters

wid

string

siteId

number

Returns

Promise<MenuTreeResponse>

Implementation of

SitesBindings.getSiteMenu

---

getSitePages()

getSitePages: (wid, siteId, options) => Promise<PaginatedResponse<PageResponse>>

Defined in: packages/sdk/src/client/client.ts:731

List pages for a site with optional pagination, sorting, and search.

Parameters

wid

string

siteId

number

options?

PagesQueryParams = {}

Returns

Promise<PaginatedResponse<PageResponse>>

Implementation of

SitesBindings.getSitePages

---

getSiteRenderedMenu()

getSiteRenderedMenu: (wid, siteUuid) => Promise<MenuTreeResponse>

Defined in: packages/sdk/src/client/client.ts:722

Get the rendered navigation menu for a site, including all translations.

Parameters

wid

string

siteUuid

string

Returns

Promise<MenuTreeResponse>

Implementation of

SitesBindings.getSiteRenderedMenu

---

getSiteRenderedPage()

getSiteRenderedPage: (wid, siteUuid, pageSlugOrId) => Promise<RenderedPageResponse>

Defined in: packages/sdk/src/client/client.ts:721

Get a fully rendered page from a site by slug or ID.

Parameters

wid

string

siteUuid

string

pageSlugOrId

string | number

Returns

Promise<RenderedPageResponse>

Implementation of

SitesBindings.getSiteRenderedPage

---

getSites()

getSites: (wid) => Promise<Site[]>

Defined in: packages/sdk/src/client/client.ts:703

List all sites in a workspace.

Parameters

wid

string

Returns

Promise<Site[]>

Implementation of

SitesBindings.getSites

---

getSiteSharing()

getSiteSharing: (wid, siteId) => Promise<SiteSharingResponse>

Defined in: packages/sdk/src/client/client.ts:707

Get a site's sharing settings.

Parameters

wid

string

siteId

number

Returns

Promise<SiteSharingResponse>

Implementation of

SitesBindings.getSiteSharing

---

getSiteSource()

getSiteSource: (wid, siteId) => Promise<SiteSource>

Defined in: packages/sdk/src/client/client.ts:709

Get a site's source tree.

Parameters

wid

string

siteId

number

Returns

Promise<SiteSource>

Implementation of

SitesBindings.getSiteSource

---

getSiteSourceTemplates()

getSiteSourceTemplates: (wid, siteId) => Promise<SiteSourceTemplates>

Defined in: packages/sdk/src/client/client.ts:710

Starter templates the caller may seed (superuser-only ones filtered server-side).

Parameters

wid

string

siteId

number

Returns

Promise<SiteSourceTemplates>

Implementation of

SitesBindings.getSiteSourceTemplates

---

getSlackApp()

getSlackApp: (wid, appId) => Promise<SlackApp>

Defined in: packages/sdk/src/client/client.ts:1099

Get a specific Slack app by ID.

Parameters

wid

string

appId

number

Returns

Promise<SlackApp>

Implementation of

IntegrationsBindings.getSlackApp

---

getSlackAppAccounts()

getSlackAppAccounts: (wid, appId, options) => Promise<PaginatedResponse<SlackAccount>>

Defined in: packages/sdk/src/client/client.ts:1105

Get Slack account links for an app (members linked to Slack users).

Parameters

wid

string

appId

number

options?

page?

number

pageSize?

number

Returns

Promise<PaginatedResponse<SlackAccount>>

Implementation of

IntegrationsBindings.getSlackAppAccounts

---

getSlackApps()

getSlackApps: (wid, options) => Promise<PaginatedResponse<SlackApp>>

Defined in: packages/sdk/src/client/client.ts:1098

List all Slack apps configured for a workspace.

Parameters

wid

string

options?

page?

number

pageSize?

number

search?

string

sortBy?

SlackAppSortField

sortOrder?

SortOrder

Returns

Promise<PaginatedResponse<SlackApp>>

Implementation of

IntegrationsBindings.getSlackApps

---

getSlackInstallations()

getSlackInstallations: (wid, appId, options) => Promise<PaginatedResponse<SlackAppInstallation>>

Defined in: packages/sdk/src/client/client.ts:1104

Get Slack workspace installations for an app.

Parameters

wid

string

appId

number

options?

page?

number

pageSize?

number

Returns

Promise<PaginatedResponse<SlackAppInstallation>>

Implementation of

IntegrationsBindings.getSlackInstallations

---

getSlackThreads()

getSlackThreads: (wid, appId, options) => Promise<PaginatedResponse<SlackThread>>

Defined in: packages/sdk/src/client/client.ts:1103

Get Slack threads for an app.

Parameters

wid

string

appId

number

options?

page?

number

pageSize?

number

Returns

Promise<PaginatedResponse<SlackThread>>

Implementation of

IntegrationsBindings.getSlackThreads

---

getSMSUsageReport()

getSMSUsageReport: (wid, params?) => Promise<SMSUsageReport>

Defined in: packages/sdk/src/client/client.ts:1016

Get SMS usage report for a workspace within an optional date range.

Parameters

wid

string

params?

SMSUsageReportParams

Returns

Promise<SMSUsageReport>

Implementation of

BillingBindings.getSMSUsageReport

---

getStepMemberCounts()

getStepMemberCounts: (wid, journeyId) => Promise<StepMemberCountResponse[]>

Defined in: packages/sdk/src/client/client.ts:477

Get member counts by status for each journey step.

Parameters

wid

string

journeyId

number

Returns

Promise<StepMemberCountResponse[]>

Implementation of

JourneysBindings.getStepMemberCounts

---

getStepMembers()

getStepMembers: (wid, journeyId, stepUuid, params) => Promise<PaginatedResponse<StepMemberResponse>>

Defined in: packages/sdk/src/client/client.ts:476

List members currently or historically associated with one journey step.

Parameters

wid

string

journeyId

number

stepUuid

string

params?

mode?

"all" | "current"

page?

number

pageSize?

number

status?

string

Returns

Promise<PaginatedResponse<StepMemberResponse>>

Implementation of

JourneysBindings.getStepMembers

---

getSTTModels()

getSTTModels: (provider?) => Promise<STTModelsResponse>

Defined in: packages/sdk/src/client/client.ts:954

Get available speech-to-text models.

Returns the per-shape STTModelsResponse so callers see languages and capabilities on each model (the chat-shape AIModelsResponse it used to return doesn't include either).

Parameters

provider?

string

Returns

Promise<STTModelsResponse>

Implementation of

ToolkitsBindings.getSTTModels

---

getSubscriptions()

getSubscriptions: () => Promise<SubscriptionResponse[]>

Defined in: packages/sdk/src/client/client.ts:1000

List all subscriptions for the current account.

Returns

Promise<SubscriptionResponse[]>

Implementation of

BillingBindings.getSubscriptions

---

getSupervisor()

getSupervisor: (wid, id) => Promise<CustomTool>

Defined in: packages/sdk/src/client/client.ts:863

Get a single supervisor by ID.

Parameters

wid

string

id

number

Returns

Promise<CustomTool>

Implementation of

WorkflowsBindings.getSupervisor

---

getSupervisors()

getSupervisors: (wid) => Promise<CustomTool[]>

Defined in: packages/sdk/src/client/client.ts:862

List all supervisors in a workspace.

Parameters

wid

string

Returns

Promise<CustomTool[]>

Implementation of

WorkflowsBindings.getSupervisors

---

getSupportRequest()

getSupportRequest: (uuid) => Promise<SupportRequest>

Defined in: packages/sdk/src/client/client.ts:1291

Parameters

uuid

string

Returns

Promise<SupportRequest>

Implementation of

SupportRequestsBindings.getSupportRequest

---

getSyncRunItems()

getSyncRunItems: (wid, connectionId, runId, limit) => Promise<SyncRunItemDetail[]>

Defined in: packages/sdk/src/client/client.ts:1237

Parameters

wid

string

connectionId

number

runId

string

limit?

number = 500

Returns

Promise<SyncRunItemDetail[]>

Implementation of

IntegrationsBindings.getSyncRunItems

---

getSyncRuns()

getSyncRuns: (wid, connectionId, limit) => Promise<SyncRunSummary[]>

Defined in: packages/sdk/src/client/client.ts:1236

Parameters

wid

string

connectionId

number

limit?

number = 20

Returns

Promise<SyncRunSummary[]>

Implementation of

IntegrationsBindings.getSyncRuns

---

getTask()

getTask: (wid, id) => Promise<Task>

Defined in: packages/sdk/src/client/client.ts:148

Get a single task by ID.

Parameters

wid

string

id

string | number

Returns

Promise<Task>

Implementation of

TasksBindings.getTask

---

getTaskChats()

getTaskChats: (wid, workflowId, taskId, fromDate?, toDate?, limit, offset) => Promise<TaskChatsListResponse>

Defined in: packages/sdk/src/client/client.ts:837

List chats for a specific task within a workflow.

Parameters

wid

string

workflowId

number

taskId

number

fromDate?

string

toDate?

string

limit?

number = 100

offset?

number = 0

Returns

Promise<TaskChatsListResponse>

Implementation of

WorkflowsBindings.getTaskChats

---

getTasks()

getTasks: (wid, options) => Promise<Task[]>

Defined in: packages/sdk/src/client/client.ts:147

List all tasks in a workspace, optionally filtering by workflow or including archived.

workflowId is the STABLE workflow root id — the server resolves it to that workflow's draft revision's tasks. workflowRevisionId filters an explicit revision (the read-only published-revision view). Pass at most one; passing both that disagree is a 400.

Parameters

wid

string

options?

includeArchived?

boolean

sortBy?

"name" | "workflowId" | "createdAt"

sortOrder?

"asc" | "desc"

workflowId?

number

workflowRevisionId?

number

Returns

Promise<Task[]>

Implementation of

TasksBindings.getTasks

---

getTeamsApp()

getTeamsApp: (wid, appId) => Promise<TeamsAppResponse>

Defined in: packages/sdk/src/client/client.ts:1109

Parameters

wid

string

appId

number

Returns

Promise<TeamsAppResponse>

Implementation of

IntegrationsBindings.getTeamsApp

---

getTeamsAppAccounts()

getTeamsAppAccounts: (wid, appId, options) => Promise<PaginatedResponse<TeamsAccountResponse>>

Defined in: packages/sdk/src/client/client.ts:1115

Parameters

wid

string

appId

number

options?

page?

number

pageSize?

number

Returns

Promise<PaginatedResponse<TeamsAccountResponse>>

Implementation of

IntegrationsBindings.getTeamsAppAccounts

---

getTeamsApps()

getTeamsApps: (wid, options) => Promise<PaginatedResponse<TeamsAppResponse>>

Defined in: packages/sdk/src/client/client.ts:1108

List all Teams apps configured for a workspace.

Parameters

wid

string

options?

page?

number

pageSize?

number

search?

string

sortBy?

TeamsAppSortField

sortOrder?

SortOrder

Returns

Promise<PaginatedResponse<TeamsAppResponse>>

Implementation of

IntegrationsBindings.getTeamsApps

---

getTeamsConversations()

getTeamsConversations: (wid, appId, options) => Promise<PaginatedResponse<TeamsConversation>>

Defined in: packages/sdk/src/client/client.ts:1113

Parameters

wid

string

appId

number

options?

page?

number

pageSize?

number

Returns

Promise<PaginatedResponse<TeamsConversation>>

Implementation of

IntegrationsBindings.getTeamsConversations

---

getTeamsInstallations()

getTeamsInstallations: (wid, appId, options) => Promise<PaginatedResponse<TeamsAppInstallationResponse>>

Defined in: packages/sdk/src/client/client.ts:1114

Parameters

wid

string

appId

number

options?

page?

number

pageSize?

number

Returns

Promise<PaginatedResponse<TeamsAppInstallationResponse>>

Implementation of

IntegrationsBindings.getTeamsInstallations

---

getTemplateContext()

getTemplateContext: (wid, request) => Promise<TemplateContextResponse>

Defined in: packages/sdk/src/client/client.ts:949

Get available template variables and sample context for template editing.

Returns variables appropriate for the given context (event type, data type, etc.) with sample values for live preview.

Parameters

wid

string

request

TemplateContextRequest

Returns

Promise<TemplateContextResponse>

Implementation of

ToolkitsBindings.getTemplateContext

---

getTestChatRun()

getTestChatRun: (wid, runId) => Promise<TestChatRun>

Defined in: packages/sdk/src/client/client.ts:366

Parameters

wid

string

runId

number

Returns

Promise<TestChatRun>

Implementation of

QualificationsBindings.getTestChatRun

---

getThemeSettings()

getThemeSettings: (wid, siteId, theme?) => Promise<ThemeSettingsResponse>

Defined in: packages/sdk/src/client/client.ts:718

Get a theme's settings schema, the site's saved values, and capabilities. Pass theme to resolve the schema for a theme other than the saved one (e.g. one the builder has selected but not yet saved).

Parameters

wid

string

siteId

number

theme?

string

Returns

Promise<ThemeSettingsResponse>

Implementation of

SitesBindings.getThemeSettings

---

getThreadEmails()

getThreadEmails: (wid, inboxId, assignmentId, options) => Promise<ThreadEmailsResponse>

Defined in: packages/sdk/src/client/client.ts:935

List emails in a thread by assignment ID with pagination.

Parameters

wid

string

inboxId

number

assignmentId

number

options?

includeAttachments?

boolean

page?

number

pageSize?

number

Returns

Promise<ThreadEmailsResponse>

Implementation of

CommunicationsBindings.getThreadEmails

---

getTool()

getTool: (wid, chatId, toolName) => Promise<ToolResponse>

Defined in: packages/sdk/src/client/client.ts:948

Get details for a specific tool by name within a chat context. Searches tools available to the chat's assistant.

Parameters

wid

string

chatId

number

toolName

string

Returns

Promise<ToolResponse>

Implementation of

ToolkitsBindings.getTool

---

getToolCallNames()

getToolCallNames: (wid) => Promise<string[]>

Defined in: packages/sdk/src/client/client.ts:178

Get distinct tool call names used across workspace chats.

Parameters

wid

string

Returns

Promise<string[]>

Implementation of

ChatsBindings.getToolCallNames

---

getToolkits()

getToolkits: (wid) => Promise<ToolkitsResponse>

Defined in: packages/sdk/src/client/client.ts:947

Get available toolkits for the workspace

Parameters

wid

string

Returns

Promise<ToolkitsResponse>

Implementation of

ToolkitsBindings.getToolkits

---

getTrackedLinkDestinations()

getTrackedLinkDestinations: (wid, options) => Promise<TrackedLinkDestinationResponse[]>

Defined in: packages/sdk/src/client/client.ts:438

Known destination URLs, most recent first. Powers the "Clicked link" member-filter autocomplete, so it stays unaggregated and cheap.

Parameters

wid

string

options?

limit?

number

q?

string

Returns

Promise<TrackedLinkDestinationResponse[]>

Implementation of

TrackedLinksBindings.getTrackedLinkDestinations

---

getTrackedLinkStats()

getTrackedLinkStats: (wid, options) => Promise<PaginatedResponse<TrackedLinkStatsResponse>>

Defined in: packages/sdk/src/client/client.ts:439

Per-destination sent / clicks / unique clickers / CTR for the window.

Parameters

wid

string

options?

TrackedLinkStatsParams = {}

Returns

Promise<PaginatedResponse<TrackedLinkStatsResponse>>

Implementation of

TrackedLinksBindings.getTrackedLinkStats

---

getTrackedLinkSummary()

getTrackedLinkSummary: (wid, options) => Promise<TrackedLinkSummaryResponse>

Defined in: packages/sdk/src/client/client.ts:437

Header counters plus whether shortening is configured and enabled.

Parameters

wid

string

options?

TrackedLinkFilterParams = {}

Returns

Promise<TrackedLinkSummaryResponse>

Implementation of

TrackedLinksBindings.getTrackedLinkSummary

---

getTrackedLinkTimeseries()

getTrackedLinkTimeseries: (wid, options) => Promise<TrackedLinkTimeseriesResponse>

Defined in: packages/sdk/src/client/client.ts:440

Clicks over time for the current filter selection.

Parameters

wid

string

options?

TrackedLinkTimeseriesParams = {}

Returns

Promise<TrackedLinkTimeseriesResponse>

Implementation of

TrackedLinksBindings.getTrackedLinkTimeseries

---

getTTSModels()

getTTSModels: (provider?) => Promise<AIModelsResponse>

Defined in: packages/sdk/src/client/client.ts:955

Get available text-to-speech models

Parameters

provider?

string

Returns

Promise<AIModelsResponse>

Implementation of

ToolkitsBindings.getTTSModels

---

getTwoFactorStatus()

getTwoFactorStatus: () => Promise<TwoFactorStatus>

Defined in: packages/sdk/src/client/client.ts:667

Get the current two-factor authentication status and configured methods.

Returns

Promise<TwoFactorStatus>

Implementation of

AuthBindings.getTwoFactorStatus

---

getUnreadNotificationCount()

getUnreadNotificationCount: (wid) => Promise<number>

Defined in: packages/sdk/src/client/client.ts:552

Get the count of unread notifications for the current user.

Parameters

wid

string

Returns

Promise<number>

Implementation of

WorkspacesBindings.getUnreadNotificationCount

---

getUsageDashboard()

getUsageDashboard: (wid) => Promise<UsageDashboardResponse>

Defined in: packages/sdk/src/client/client.ts:586

Get billing dashboard data for a workspace.

This endpoint is available to organization owners (with org:info scope).

Returns comprehensive billing information including:

• Subscription status and plan details
• Current period usage metrics
• Overage configurations and amounts
• Budget tracking status

Parameters

wid

string

Returns

Promise<UsageDashboardResponse>

Implementation of

WorkspacesBindings.getUsageDashboard

---

getUserAccount()

getUserAccount: () => Promise<Account>

Defined in: packages/sdk/src/client/client.ts:646

Get the authenticated user's account.

Returns

Promise<Account>

Implementation of

AuthBindings.getUserAccount

---

getVapidPublicKey()

getVapidPublicKey: () => Promise<string | null>

Defined in: packages/sdk/src/client/client.ts:627

Get the VAPID public key for Web Push subscription registration.

Returns

Promise<string | null>

Implementation of

WorkspacesBindings.getVapidPublicKey

---

getVariableRegistry()

getVariableRegistry: (wid, request) => Promise<VariableRegistryResponse>

Defined in: packages/sdk/src/client/client.ts:951

Get variables from the central variable registry.

This provides variables defined in the single source of truth registry with extended metadata including deprecation info and permission scopes.

Parameters

wid

string

request?

VariableRegistryRequest = {}

Returns

Promise<VariableRegistryResponse>

Implementation of

ToolkitsBindings.getVariableRegistry

---

getVoiceModels()

getVoiceModels: (provider?) => Promise<VoiceModelsResponse>

Defined in: packages/sdk/src/client/client.ts:956

Get available voice models with metadata

Parameters

provider?

string

Returns

Promise<VoiceModelsResponse>

Implementation of

ToolkitsBindings.getVoiceModels

---

getVoicePresets()

getVoicePresets: () => Promise<VoicePresetsResponse>

Defined in: packages/sdk/src/client/client.ts:957

Get the voice presets offered by the simplified voice picker.

A preset bundles a realtime speech-to-speech model with one of its native voices and the settings recommended alongside it, so choosing a voice is a single decision. Apply one by assigning its config wholesale; compare against it to tell a preset selection from a customised ("Custom") one. The full engine/voice/settings matrix lives on getRealtimeModels.

Returns

Promise<VoicePresetsResponse>

Implementation of

ToolkitsBindings.getVoicePresets

---

getVoiceTrustProducts()

getVoiceTrustProducts: (orgUuid, legalEntityUuid) => Promise<VoiceTrustProductsResponse>

Defined in: packages/sdk/src/client/client.ts:620

Cached voice trust product state (CNAM / SHAKEN-STIR / Voice Integrity) for one legal entity.

Parameters

orgUuid

string

legalEntityUuid

string

Returns

Promise<VoiceTrustProductsResponse>

Implementation of

OrgBindings.getVoiceTrustProducts

---

getVoiceUsageReport()

getVoiceUsageReport: (wid, params?) => Promise<VoiceUsageReport>

Defined in: packages/sdk/src/client/client.ts:1018

Get voice (STT/TTS) usage report for a workspace within an optional date range.

Parameters

wid

string

params?

VoiceUsageReportParams

Returns

Promise<VoiceUsageReport>

Implementation of

BillingBindings.getVoiceUsageReport

---

getWebAuthnAuthOptions()

getWebAuthnAuthOptions: (tempToken) => Promise<{ credentialRequestOptions: { allowCredentials: object[]; challenge: string; rpId: string; timeout: number; userVerification: string; }; }>

Defined in: packages/sdk/src/client/client.ts:674

Get WebAuthn credential request options for two-factor login verification.

Parameters

tempToken

string

Returns

Promise<{ credentialRequestOptions: { allowCredentials: object[]; challenge: string; rpId: string; timeout: number; userVerification: string; }; }>

Implementation of

AuthBindings.getWebAuthnAuthOptions

---

getWebhookLogs()

getWebhookLogs: (wid, options) => Promise<PaginatedResponse<WebhookLogResponse>>

Defined in: packages/sdk/src/client/client.ts:803

List webhook logs with optional filtering by event type and success status.

Parameters

wid

string

options?

WebhookLogsQueryParams = {}

Returns

Promise<PaginatedResponse<WebhookLogResponse>>

Implementation of

EventsBindings.getWebhookLogs

---

getWorkflow()

getWorkflow: (wid, id) => Promise<WorkflowDetail>

Defined in: packages/sdk/src/client/client.ts:820

Get a single workflow by ID (root + draft + active-revision summary).

Parameters

wid

string

id

string | number

Returns

Promise<WorkflowDetail>

Implementation of

WorkflowsBindings.getWorkflow

---

getWorkflowAccessValidation()

getWorkflowAccessValidation: (wid, workflowId) => Promise<WorkflowAccessValidationResponse>

Defined in: packages/sdk/src/client/client.ts:838

Parameters

wid

string

workflowId

number

Returns

Promise<WorkflowAccessValidationResponse>

Implementation of

WorkflowsBindings.getWorkflowAccessValidation

---

getWorkflowActivity()

getWorkflowActivity: (wid, id, options?) => Promise<WorkflowActivity>

Defined in: packages/sdk/src/client/client.ts:823

Get activity metrics for a single workflow.

Parameters

wid

string

id

number

options?

days?

number

Returns

Promise<WorkflowActivity>

Implementation of

WorkflowsBindings.getWorkflowActivity

---

getWorkflowConfigValidation()

getWorkflowConfigValidation: (wid, workflowId) => Promise<WorkflowConfigValidationResponse>

Defined in: packages/sdk/src/client/client.ts:839

Parameters

wid

string

workflowId

number

Returns

Promise<WorkflowConfigValidationResponse>

Implementation of

WorkflowsBindings.getWorkflowConfigValidation

---

getWorkflowContributors()

getWorkflowContributors: (wid, workflowId) => Promise<WorkflowContributorResponse[]>

Defined in: packages/sdk/src/client/client.ts:845

List all contributors for a workflow.

Parameters

wid

string

workflowId

number

Returns

Promise<WorkflowContributorResponse[]>

Implementation of

WorkflowsBindings.getWorkflowContributors

---

getWorkflowDeletionPreview()

getWorkflowDeletionPreview: (wid, id) => Promise<{ hasAssignments: boolean; items: object[]; total: number; }>

Defined in: packages/sdk/src/client/client.ts:829

Preview the impact of deleting a workflow, including affected tasks and assignments.

Parameters

wid

string

id

number

Returns

Promise<{ hasAssignments: boolean; items: object[]; total: number; }>

Implementation of

WorkflowsBindings.getWorkflowDeletionPreview

---

getWorkflowDiagram()

getWorkflowDiagram: (wid, id, options) => Promise<{ archivedTaskCount: number; includeArchived: boolean; mermaid: string; taskCount: number; }>

Defined in: packages/sdk/src/client/client.ts:825

Get the Mermaid diagram representation of a workflow.

By default only active tasks are rendered. Pass includeArchived: true to also render archived tasks (distinctly styled). taskCount is always the total (active + archived); archivedTaskCount breaks out the archived portion so the active count can be derived.

Parameters

wid

string

id

number

options?

includeArchived?

boolean

Returns

Promise<{ archivedTaskCount: number; includeArchived: boolean; mermaid: string; taskCount: number; }>

Implementation of

WorkflowsBindings.getWorkflowDiagram

---

getWorkflowFeedback()

getWorkflowFeedback: (wid, workflowId, options) => Promise<WorkflowFeedbackListResponse>

Defined in: packages/sdk/src/client/client.ts:844

List chat feedback for a workflow (thumbs ratings + explicit/extracted rows). First consumer of the workspace-plane chat_feedback table.

Parameters

wid

string

workflowId

number

options?

GetWorkflowFeedbackOptions = {}

Returns

Promise<WorkflowFeedbackListResponse>

Implementation of

WorkflowsBindings.getWorkflowFeedback

---

getWorkflowNotes()

getWorkflowNotes: (wid, workflowId, query?) => Promise<WorkflowNoteResponse[]>

Defined in: packages/sdk/src/client/client.ts:840

List notes for a workflow root (draft unless workflowRevisionId is set).

Parameters

wid

string

workflowId

number

query?

WorkflowNotesQuery

Returns

Promise<WorkflowNoteResponse[]>

Implementation of

WorkflowsBindings.getWorkflowNotes

---

getWorkflowOpeningTurnConversionReport()

getWorkflowOpeningTurnConversionReport: (wid, id) => Promise<OpeningTurnConversionReportResponse>

Defined in: packages/sdk/src/client/client.ts:821

Parameters

wid

string

id

string | number

Returns

Promise<OpeningTurnConversionReportResponse>

Implementation of

WorkflowsBindings.getWorkflowOpeningTurnConversionReport

---

getWorkflowRevision()

getWorkflowRevision: (wid, workflowId, revisionId) => Promise<WorkflowRevision>

Defined in: packages/sdk/src/client/client.ts:850

Get full workflow details for one relational workflow revision.

Parameters

wid

string

workflowId

string | number

revisionId

string | number

Returns

Promise<WorkflowRevision>

Implementation of

WorkflowsBindings.getWorkflowRevision

---

getWorkflowRevisions()

getWorkflowRevisions: (wid, workflowId) => Promise<WorkflowRevisionListResponse>

Defined in: packages/sdk/src/client/client.ts:849

List relational revisions for a workflow.

Parameters

wid

string

workflowId

string | number

Returns

Promise<WorkflowRevisionListResponse>

Implementation of

WorkflowsBindings.getWorkflowRevisions

---

getWorkflows()

getWorkflows: (wid, options) => Promise<WorkflowListPageResponse>

Defined in: packages/sdk/src/client/client.ts:819

List all workflows in a workspace, optionally including archived ones.

Parameters

wid

string

options?

archived?

boolean

page?

number

pageSize?

number

search?

string

sortBy?

WorkflowSortField

sortOrder?

SortOrder

Returns

Promise<WorkflowListPageResponse>

Implementation of

WorkflowsBindings.getWorkflows

---

getWorkflowsActivityBatch()

getWorkflowsActivityBatch: (wid, workflowIds, options?) => Promise<Record<string, WorkflowActivity>>

Defined in: packages/sdk/src/client/client.ts:824

Get activity metrics for multiple workflows in a single request.

Parameters

wid

string

workflowIds

number[]

options?

days?

number

Returns

Promise<Record<string, WorkflowActivity>>

Implementation of

WorkflowsBindings.getWorkflowsActivityBatch

---

getWorkflowTaskAssignmentStats()

getWorkflowTaskAssignmentStats: (wid, id, fromDate?, toDate?, workflowRevisionId?) => Promise<Record<number, TaskAssignmentStatsResponse>>

Defined in: packages/sdk/src/client/client.ts:836

Get task assignment statistics for a workflow within an optional date range.

Parameters

wid

string

id

number

fromDate?

string

toDate?

string

workflowRevisionId?

number

Returns

Promise<Record<number, TaskAssignmentStatsResponse>>

Implementation of

WorkflowsBindings.getWorkflowTaskAssignmentStats

---

getWorkflowTemplates()

getWorkflowTemplates: (wid) => Promise<WorkflowTemplateResponse[]>

Defined in: packages/sdk/src/client/client.ts:834

List available workflow templates.

Parameters

wid

string

Returns

Promise<WorkflowTemplateResponse[]>

Implementation of

WorkflowsBindings.getWorkflowTemplates

---

getWorkflowThumbnailUrl()

getWorkflowThumbnailUrl: (wid, id) => string

Defined in: packages/sdk/src/client/client.ts:826

Get workflow thumbnail URL. For cross-domain setups, returns a same-origin proxy URL to ensure cookies are sent. For same-origin setups, returns the direct API URL.

Parameters

wid

string

id

number

Returns

string

Implementation of

WorkflowsBindings.getWorkflowThumbnailUrl

---

getWorkspace()

getWorkspace: (wid) => Promise<Workspace>

Defined in: packages/sdk/src/client/client.ts:537

Get a single workspace by ID.

Parameters

wid

string

Returns

Promise<Workspace>

Implementation of

WorkspacesBindings.getWorkspace

---

getWorkspaceActivityCounts()

getWorkspaceActivityCounts: (workspaceUuid, request) => Promise<ActivityCountsResponse>

Defined in: packages/sdk/src/client/client.ts:426

The workspace mount's badge numbers.

Parameters

workspaceUuid

string

request?

ActivityCountsRequest = {}

Returns

Promise<ActivityCountsResponse>

Implementation of

ActivityBindings.getWorkspaceActivityCounts

---

getWorkspaceBuilder()

getWorkspaceBuilder: (wid, builderId) => Promise<WorkspaceBuilderInfo>

Defined in: packages/sdk/src/client/client.ts:857

Get information about a specific workspace builder.

Parameters

wid

string

builderId

string

Returns

Promise<WorkspaceBuilderInfo>

Implementation of

WorkflowsBindings.getWorkspaceBuilder

---

getWorkspaceBuilders()

getWorkspaceBuilders: (wid) => Promise<WorkspaceBuilderInfo[]>

Defined in: packages/sdk/src/client/client.ts:856

Get list of available workspace builders.

Parameters

wid

string

Returns

Promise<WorkspaceBuilderInfo[]>

Implementation of

WorkflowsBindings.getWorkspaceBuilders

---

getWorkspaceBySlug()

getWorkspaceBySlug: (wid) => Promise<Workspace>

Defined in: packages/sdk/src/client/client.ts:584

Get a single workspace by ID.

Parameters

wid

string

Returns

Promise<Workspace>

Implementation of

WorkspacesBindings.getWorkspaceBySlug

---

getWorkspaceCounts()

getWorkspaceCounts: (wid) => Promise<WorkspaceCounts>

Defined in: packages/sdk/src/client/client.ts:546

Get entity counts (members, tasks, workflows, etc.) for a workspace.

Parameters

wid

string

Returns

Promise<WorkspaceCounts>

Implementation of

WorkspacesBindings.getWorkspaceCounts

---

getWorkspaceDefaults()

getWorkspaceDefaults: (wid) => Promise<WorkspaceDefaults>

Defined in: packages/sdk/src/client/client.ts:542

Get the default settings for a workspace.

Parameters

wid

string

Returns

Promise<WorkspaceDefaults>

Implementation of

WorkspacesBindings.getWorkspaceDefaults

---

getWorkspaceEmailDomains()

getWorkspaceEmailDomains: (wid) => Promise<WorkspaceAvailableDomainsResponse>

Defined in: packages/sdk/src/client/client.ts:587

List org domains available for workspace email inbox routing.

Parameters

wid

string

Returns

Promise<WorkspaceAvailableDomainsResponse>

Implementation of

WorkspacesBindings.getWorkspaceEmailDomains

---

getWorkspaceInvitation()

getWorkspaceInvitation: (requestId) => Promise<InvitationResponse>

Defined in: packages/sdk/src/client/client.ts:633

Parameters

requestId

number

Returns

Promise<InvitationResponse>

Implementation of

WorkspacesBindings.getWorkspaceInvitation

---

getWorkspaceMember()

getWorkspaceMember: (wid, memberId) => Promise<WorkspaceMemberResponse>

Defined in: packages/sdk/src/client/client.ts:277

Get a single workspace member by ID.

Parameters

wid

string

memberId

number

Returns

Promise<WorkspaceMemberResponse>

Implementation of

MembersBindings.getWorkspaceMember

---

getWorkspaceMembers()

getWorkspaceMembers: (wid, page, pageSize, search?, role?, sortBy?, sortOrder?, memberType?, isArchived, isManager?, memberTypes?, hasAccount?, excludeIds?, memberFilterId?, query?) => Promise<PaginatedResponse<WorkspaceMemberResponse>>

Defined in: packages/sdk/src/client/client.ts:276

List workspace members with pagination, filtering, and sorting.

Parameters

wid

string

page?

number = 1

pageSize?

number = 10

search?

string

role?

string

sortBy?

MemberSortField

sortOrder?

SortOrder

memberType?

"member" | "anonymous" | "test" | "agent"

isArchived?

boolean = false

isManager?

boolean

memberTypes?

("member" | "anonymous" | "test" | "agent")[]

hasAccount?

boolean

excludeIds?

number[]

memberFilterId?

number

Apply a saved member filter by id (its query predicate).

query?

QueryPredicate

Transient query-engine IR predicate (the unsaved counterpart of a saved filter's query).

Returns

Promise<PaginatedResponse<WorkspaceMemberResponse>>

Implementation of

MembersBindings.getWorkspaceMembers

---

getWorkspaceNotices()

getWorkspaceNotices: (wid) => Promise<NoticesResponse>

Defined in: packages/sdk/src/client/client.ts:549

Get active notices for a workspace.

Parameters

wid

string

Returns

Promise<NoticesResponse>

Implementation of

WorkspacesBindings.getWorkspaceNotices

---

getWorkspaceProduct()

getWorkspaceProduct: (wid, id) => Promise<Product>

Defined in: packages/sdk/src/client/client.ts:564

Get a product from a reseller workspace. Requires workspace admin scope.

Parameters

wid

string

id

number

Returns

Promise<Product>

Implementation of

WorkspacesBindings.getWorkspaceProduct

---

getWorkspaces()

getWorkspaces: () => Promise<Workspace[]>

Defined in: packages/sdk/src/client/client.ts:534

List all workspaces accessible to the current user.

Returns

Promise<Workspace[]>

Implementation of

WorkspacesBindings.getWorkspaces

---

getWorkspaceScopes()

getWorkspaceScopes: () => Promise<WorkspaceScopesResponse>

Defined in: packages/sdk/src/client/client.ts:585

Get all workspace-grantable scopes that can be assigned to member roles.

Returns the full metadata for all scopes including name, category, description, implied scopes, and whether it's a dangerous scope.

Note: This does NOT include organization-level scopes (org:read, org:write, org:admin). Org-level permissions come from OrgMember roles, not workspace member roles.

Returns

Promise<WorkspaceScopesResponse>

Implementation of

WorkspacesBindings.getWorkspaceScopes

---

getWorkspaceSiteDomains()

getWorkspaceSiteDomains: (wid) => Promise<WorkspaceAvailableDomainsResponse>

Defined in: packages/sdk/src/client/client.ts:588

List org domains available for workspace custom site routing.

Parameters

wid

string

Returns

Promise<WorkspaceAvailableDomainsResponse>

Implementation of

WorkspacesBindings.getWorkspaceSiteDomains

---

getWorkspaceSubscriptions()

getWorkspaceSubscriptions: (wid) => Promise<SubscriptionResponse[]>

Defined in: packages/sdk/src/client/client.ts:1001

List all subscriptions associated with a workspace.

Parameters

wid

string

Returns

Promise<SubscriptionResponse[]>

Implementation of

BillingBindings.getWorkspaceSubscriptions

---

getWorkspaceSupportRequest()

getWorkspaceSupportRequest: (workspaceUuid, uuid) => Promise<SupportRequest>

Defined in: packages/sdk/src/client/client.ts:1299

Parameters

workspaceUuid

string

uuid

string

Returns

Promise<SupportRequest>

Implementation of

SupportRequestsBindings.getWorkspaceSupportRequest

---

getWorkspaceThemes()

getWorkspaceThemes: (wid) => Promise<ThemesListResponse>

Defined in: packages/sdk/src/client/client.ts:582

List available themes for a workspace.

Parameters

wid

string

Returns

Promise<ThemesListResponse>

Implementation of

WorkspacesBindings.getWorkspaceThemes

---

getWorkspaceWidgetDomains()

getWorkspaceWidgetDomains: (wid) => Promise<WorkspaceAvailableDomainsResponse>

Defined in: packages/sdk/src/client/client.ts:589

List org domains available for enabling embeddable widgets. Widgets ride on domain-ownership verification only, so the consumer gates selection on ownershipStatus === 'verified'.

Parameters

wid

string

Returns

Promise<WorkspaceAvailableDomainsResponse>

Implementation of

WorkspacesBindings.getWorkspaceWidgetDomains

---

importFromBoard()

importFromBoard: (wid, data) => Promise<MondayImportResponse>

Defined in: packages/sdk/src/client/client.ts:1077

Parameters

wid

string

data

MondayImportRequest

Returns

Promise<MondayImportResponse>

Implementation of

IntegrationsBindings.importFromBoard

---

importHubspotMembers()

importHubspotMembers: (wid, data) => Promise<ImportHubSpotMembersResponse>

Defined in: packages/sdk/src/client/client.ts:1224

Parameters

wid

string

data

ImportHubSpotMembersRequest

Returns

Promise<ImportHubSpotMembersResponse>

Implementation of

IntegrationsBindings.importHubspotMembers

---

importMembers()

importMembers: (wid, file, newMemberRoleId, onProgress?, options?) => Promise<{ success: boolean; }>

Defined in: packages/sdk/src/client/client.ts:289

Import members from a CSV file, streaming progress updates via callback.

identityConflictPolicy (default 'skip') controls how a row matching an existing member ONLY by phone with different identity fields is handled. Send 'overwrite_identity_fields' only after the operator confirms a preview.

Parameters

wid

string

file

File

newMemberRoleId

number

onProgress?

(progress) => void

options?

identityConflictPolicy?

IdentityConflictPolicy

Returns

Promise<{ success: boolean; }>

Implementation of

MembersBindings.importMembers

---

importPronunciationEntries()

importPronunciationEntries: (orgUuid, entries) => Promise<PronunciationImportResult>

Defined in: packages/sdk/src/client/client.ts:1257

Bulk import pronunciation entries into an organization.

Parameters

orgUuid

string

entries

PronunciationImportEntry[]

Returns

Promise<PronunciationImportResult>

Implementation of

PronunciationsBindings.importPronunciationEntries

---

importSalesforceMembers()

importSalesforceMembers: (wid, data) => Promise<ImportSalesforceMembersResponse>

Defined in: packages/sdk/src/client/client.ts:1207

Parameters

wid

string

data

ImportSalesforceMembersRequest

Returns

Promise<ImportSalesforceMembersResponse>

Implementation of

IntegrationsBindings.importSalesforceMembers

---

importSiteSourceZip()

importSiteSourceZip: (wid, siteId, file) => Promise<SiteSource>

Defined in: packages/sdk/src/client/client.ts:717

Replace the site's source tree with the contents of an uploaded ZIP (clears the existing source first, like a reset that loads a template).

Parameters

wid

string

siteId

number

file

Blob

Returns

Promise<SiteSource>

Implementation of

SitesBindings.importSiteSourceZip

---

importWorkspace()

importWorkspace: (wid, exportData, importMappings, createNew, archive?, activateWebhookRules?, autoMap?, options?) => Promise<WorkspaceImportResponse>

Defined in: packages/sdk/src/client/client.ts:576

Import workspace configuration from exported JSON, or from a ZIP archive. Pass archive (the ZIP from exportWorkspaceZip) to restore file contents. exportData may be omitted when the ZIP contains it.

activateWebhookRules is safety-default false: imported webhook:send EventRules are force-disabled unless the operator opts in. An exported-inactive rule stays inactive either way.

With options.intent = 'template_reapply' this is the GUARDED apply. It requires options.expectedPlanFingerprint — the digest a preview returned — and answers 200 success, 200 noop (the target already matched the template, so nothing at all was recorded), 409 stale_import_plan or 409 import_plan_refused. Both 409s commit nothing and carry the complete values-free planRows.

Parameters

wid

string

exportData

WorkspaceExportData | undefined

importMappings

WorkspaceImportMapping

createNew

WorkspaceCreateNewEntities

archive?

Blob

activateWebhookRules?

boolean

autoMap?

WorkspaceAutoMapEntities

options?

WorkspaceImportPlanOptions

Returns

Promise<WorkspaceImportResponse>

Implementation of

WorkspacesBindings.importWorkspace

---

importWorkspaceZip()

importWorkspaceZip: (wid, archive, options?) => Promise<WorkspaceImportResponse>

Defined in: packages/sdk/src/client/client.ts:577

Apply a workspace export ZIP to this workspace.

The apply sibling of previewWorkspaceImportZip, and the same multipart shape: the archive travels as archive, everything else as one JSON request part. exportData defaults to export.json inside the ZIP, so it is sent only to override it.

With options.intent = 'template_reapply' this is the GUARDED apply. It requires options.expectedPlanFingerprint — the digest a preview returned — and answers 200 success, 200 noop (the target already matched the template, so nothing at all was recorded), 409 stale_import_plan or 409 import_plan_refused. Both 409s commit nothing and carry the complete values-free planRows.

options.bindings values are sent in the request body only. They are never projected from a response and must never be logged: the point of a binding is that a webhook endpoint and a signing secret belong to ONE target workspace.

Parameters

wid

string

archive

Blob

options?

WorkspaceImportPlanOptions & object

Returns

Promise<WorkspaceImportResponse>

Implementation of

WorkspacesBindings.importWorkspaceZip

---

initiateOutboundCall()

initiateOutboundCall: (wid, chatId, phoneNumberId) => Promise<OutboundCallResponse>

Defined in: packages/sdk/src/client/client.ts:195

Initiate an outbound phone call from a chat.

Parameters

wid

string

chatId

number

phoneNumberId

number

Returns

Promise<OutboundCallResponse>

Implementation of

ChatsBindings.initiateOutboundCall

---

inspectPrompt()

inspectPrompt: (wid, options) => Promise<PromptInspectionResult>

Defined in: packages/sdk/src/client/client.ts:531

Inspect the full composed prompt for a task (static) or chat (live).

Parameters

wid

string

options

InspectPromptOptions

Returns

Promise<PromptInspectionResult>

Implementation of

PromptsBindings.inspectPrompt

---

installDocumoFax()

installDocumoFax: (wid) => Promise<DocumoFaxSetupResponse>

Defined in: packages/sdk/src/client/client.ts:1154

The three bodyless POSTs below send {} deliberately: the routes require a JSON body as a CSRF barrier (a cross-site HTML form POST cannot set Content-Type: application/json, so it 422s). See GRA-6284.

Parameters

wid

string

Returns

Promise<DocumoFaxSetupResponse>

Implementation of

IntegrationsBindings.installDocumoFax

---

installHubspot()

installHubspot: (wid) => Promise<HubspotConnectionStatus>

Defined in: packages/sdk/src/client/client.ts:1210

Create the HubSpot connection shell (no credentials yet).

First step of the guided setup flow: provisions the connection row so the admin lands on the detail page where the OAuth callback URL is shown — which they need to register their HubSpot app before they have a Client ID / Secret to enter. Idempotent.

Parameters

wid

string

Returns

Promise<HubspotConnectionStatus>

Implementation of

IntegrationsBindings.installHubspot

---

installMondayConnection()

installMondayConnection: (wid) => Promise<MondayConnectionStatus>

Defined in: packages/sdk/src/client/client.ts:1057

Create the Monday.com connection shell (no credentials yet).

First step of the guided setup flow: provisions the connection row so the admin lands on the detail page where the OAuth callback URL is shown — which they need to register their Monday.com app before they have a Client ID / Secret to enter. Idempotent.

Parameters

wid

string

Returns

Promise<MondayConnectionStatus>

Implementation of

IntegrationsBindings.installMondayConnection

---

installSalesforce()

installSalesforce: (wid, data?) => Promise<SalesforceConnectionStatus>

Defined in: packages/sdk/src/client/client.ts:1188

Create the Salesforce connection shell (no credentials yet).

First step of the guided setup flow: provisions the connection row so the admin lands on the detail page where the OAuth callback URL is shown — which they need to register their Salesforce Connected App before they have a Client ID / Secret to enter. Idempotent.

Parameters

wid

string

data?

InstallSalesforceRequest

Returns

Promise<SalesforceConnectionStatus>

Implementation of

IntegrationsBindings.installSalesforce

---

inviteMemberCredentialUpdate()

inviteMemberCredentialUpdate: (wid, memberId, credentialType, newValue) => Promise<CredentialChangeInviteResponse>

Defined in: packages/sdk/src/client/client.ts:319

Invite a member to update their credential (email or phone). Admin-only. Sends invitation to member's current contact method.

Parameters

wid

string

memberId

number

credentialType

CredentialType

newValue

string

Returns

Promise<CredentialChangeInviteResponse>

Implementation of

MembersBindings.inviteMemberCredentialUpdate

---

inviteToWorkspace()

inviteToWorkspace: (workspaceUuid, emailOrAccountId, message?, memberRoleId?, name?) => Promise<InvitationResponse>

Defined in: packages/sdk/src/client/client.ts:641

Invite someone to a workspace (requires workspace admin permission). Uses the workspace-scoped route: POST /api/v2/w/{workspaceUuid}/invitations

Parameters

workspaceUuid

string

emailOrAccountId

string | number

message?

string

memberRoleId?

number

name?

string

Returns

Promise<InvitationResponse>

Implementation of

WorkspacesBindings.inviteToWorkspace

---

leaveWorkspace()

leaveWorkspace: (wid) => Promise<{ message: string; }>

Defined in: packages/sdk/src/client/client.ts:541

Leave a workspace as the current user.

Parameters

wid

string

Returns

Promise<{ message: string; }>

Implementation of

WorkspacesBindings.leaveWorkspace

---

linkCalendarToGoogle()

linkCalendarToGoogle: (wid, calendarId, request) => Promise<LinkCalendarResponse>

Defined in: packages/sdk/src/client/client.ts:897

Link a calendar to a Google Calendar for two-way sync.

Parameters

wid

string

calendarId

number

request

LinkCalendarRequest

Returns

Promise<LinkCalendarResponse>

Implementation of

CalendarsBindings.linkCalendarToGoogle

---

linkCalendarToHealthie()

linkCalendarToHealthie: (wid, data) => Promise<LinkCalendarToHealthieResponse>

Defined in: packages/sdk/src/client/client.ts:1164

Parameters

wid

string

data

LinkCalendarToHealthieRequest

Returns

Promise<LinkCalendarToHealthieResponse>

Implementation of

IntegrationsBindings.linkCalendarToHealthie

---

linkMemberToHealthie()

linkMemberToHealthie: (wid, data) => Promise<LinkMemberToHealthieResponse>

Defined in: packages/sdk/src/client/client.ts:1169

Parameters

wid

string

data

HealthieLinkMemberRequest

Returns

Promise<LinkMemberToHealthieResponse>

Implementation of

IntegrationsBindings.linkMemberToHealthie

---

linkMemberToHubspot()

linkMemberToHubspot: (wid, data) => Promise<{ hubspotRecordId: string; memberId: number; status: string; }>

Defined in: packages/sdk/src/client/client.ts:1219

Parameters

wid

string

data

LinkMemberToHubspotRequest

Returns

Promise<{ hubspotRecordId: string; memberId: number; status: string; }>

Implementation of

IntegrationsBindings.linkMemberToHubspot

---

linkMemberToMonday()

linkMemberToMonday: (wid, data) => Promise<{ memberId: number; mondayItemId: string; status: string; }>

Defined in: packages/sdk/src/client/client.ts:1073

Parameters

wid

string

data

LinkMemberToMondayRequest

Returns

Promise<{ memberId: number; mondayItemId: string; status: string; }>

Implementation of

IntegrationsBindings.linkMemberToMonday

---

linkMemberToSalesforce()

linkMemberToSalesforce: (wid, data) => Promise<{ memberId: number; salesforceRecordId: string; status: string; }>

Defined in: packages/sdk/src/client/client.ts:1197

Parameters

wid

string

data

LinkMemberToSalesforceRequest

Returns

Promise<{ memberId: number; salesforceRecordId: string; status: string; }>

Implementation of

IntegrationsBindings.linkMemberToSalesforce

---

linkPhoneNumber()

linkPhoneNumber: (wid, id, providerPhoneUuid) => Promise<PhoneNumber>

Defined in: packages/sdk/src/client/client.ts:921

Link or unlink a workspace phone number to/from a provider phone.

Parameters

wid

string

id

number

providerPhoneUuid

string | null

Returns

Promise<PhoneNumber>

Implementation of

CommunicationsBindings.linkPhoneNumber

---

listAbilities()

listAbilities: (wid, options) => Promise<AbilityResponse[]>

Defined in: packages/sdk/src/client/client.ts:157

List configured ability instances for a workflow or task scope. Provide exactly one of:

• workflow scope: workflowId (stable root → draft revision) and/or workflowRevisionId (explicit pin)
• taskId for task-scoped abilities

Parameters

wid

string

options

taskId?

number

workflowId?

number

workflowRevisionId?

number

Returns

Promise<AbilityResponse[]>

Implementation of

TasksBindings.listAbilities

---

listAppConnections()

listAppConnections: (wid) => Promise<AppConnectionItem[]>

Defined in: packages/sdk/src/client/client.ts:1243

List all active app connections across all types. Returns a union of platform apps, MCP servers, Discord bots, Slack apps, and FHIR connections.

Parameters

wid

string

Returns

Promise<AppConnectionItem[]>

Implementation of

IntegrationsBindings.listAppConnections

---

listApps()

listApps: (params?) => Promise<AppListResponse>

Defined in: packages/sdk/src/client/client.ts:1022

List apps - either public apps, account's apps, or all apps visible to a workspace

Parameters

params?

builderId?

number

public?

boolean

workspaceUuid?

string

Returns

Promise<AppListResponse>

Implementation of

AppsBindings.listApps

---

listAvailableAppConnections()

listAvailableAppConnections: (wid) => Promise<AppConnectionDirectoryResponse>

Defined in: packages/sdk/src/client/client.ts:1242

List all app connection definitions the workspace can access. Returns static metadata only (no instance counts or active data).

Parameters

wid

string

Returns

Promise<AppConnectionDirectoryResponse>

Implementation of

IntegrationsBindings.listAvailableAppConnections

---

listBuilders()

listBuilders: (all?) => Promise<BuilderListResponse>

Defined in: packages/sdk/src/client/client.ts:1029

List all builders (optionally all with superuser access)

Parameters

all?

boolean

Returns

Promise<BuilderListResponse>

Implementation of

AppsBindings.listBuilders

---

listChatRecordings()

listChatRecordings: (wid, chatId, options) => Promise<RecordingListResponse>

Defined in: packages/sdk/src/client/client.ts:224

List the recorded audio chunks for a chat (metadata only).

Parameters

wid

string

chatId

number

options?

role?

"member" | "assistant"

Returns

Promise<RecordingListResponse>

Implementation of

CallsBindings.listChatRecordings

---

listConfluencePages()

listConfluencePages: (wid, spaceId, params?) => Promise<ConfluencePagesResponse>

Defined in: packages/sdk/src/client/client.ts:1185

Parameters

wid

string

spaceId

string

params?

cursor?

string

limit?

number

Returns

Promise<ConfluencePagesResponse>

Implementation of

IntegrationsBindings.listConfluencePages

---

listConfluenceSpaces()

listConfluenceSpaces: (wid, params?) => Promise<ConfluenceSpacesResponse>

Defined in: packages/sdk/src/client/client.ts:1184

Parameters

wid

string

params?

cursor?

string

limit?

number

Returns

Promise<ConfluenceSpacesResponse>

Implementation of

IntegrationsBindings.listConfluenceSpaces

---

listConnectionMemberFieldKeys()

listConnectionMemberFieldKeys: (wid, connectionId) => Promise<ConnectionMemberFieldKeysResponse>

Defined in: packages/sdk/src/client/client.ts:1248

Parameters

wid

string

connectionId

number

Returns

Promise<ConnectionMemberFieldKeysResponse>

Implementation of

IntegrationsBindings.listConnectionMemberFieldKeys

---

listContactPermissions()

listContactPermissions: (wid, params) => Promise<{ destination: string; rows: object[]; }>

Defined in: packages/sdk/src/client/client.ts:338

Parameters

wid

string

params

channel?

"sms" | "voice"

destination

string

Returns

Promise<{ destination: string; rows: object[]; }>

Implementation of

MembersBindings.listContactPermissions

---

listDeviceOrders()

listDeviceOrders: (options) => Promise<DeviceOrderListResponse>

Defined in: packages/sdk/src/client/client.ts:1012

List the authenticated Account's own device orders in one workspace.

Parameters

options

DeviceOrderListScope

Returns

Promise<DeviceOrderListResponse>

Implementation of

BillingBindings.listDeviceOrders

---

listDocumoFaxes()

listDocumoFaxes: (wid, params?) => Promise<PaginatedResponseInboundFaxLogEntry>

Defined in: packages/sdk/src/client/client.ts:1153

Received-fax log for this connection.

Entries carry senderNumber, which is an unauthenticated claim by the sending machine and is PHI. Render it; never log it.

status is repeatable — one query entry per value, matching the route's list[str] binding. The date bounds filter on when the delivery was recorded, not on receivedAt: a fax that failed before storage never gets a receivedAt, so bounding that column would hide exactly the failures an operator filtering by date is hunting for.

Parameters

wid

string

params?

page?

number

pageSize?

number

receivedAfter?

string

receivedBefore?

string

status?

readonly InboundFaxStatus[]

Returns

Promise<PaginatedResponseInboundFaxLogEntry>

Implementation of

IntegrationsBindings.listDocumoFaxes

---

listFileVersions()

listFileVersions: (wid, fileId) => Promise<FileVersionListResponse>

Defined in: packages/sdk/src/client/client.ts:760

List a file's version history (newest first).

Parameters

wid

string

fileId

number

Returns

Promise<FileVersionListResponse>

Implementation of

FilesBindings.listFileVersions

---

listGoogleCalendars()

listGoogleCalendars: (wid) => Promise<GoogleCalendarInfo[]>

Defined in: packages/sdk/src/client/client.ts:896

List Google Calendars available for linking.

Parameters

wid

string

Returns

Promise<GoogleCalendarInfo[]>

Implementation of

CalendarsBindings.listGoogleCalendars

---

listHealthieAppointmentTypes()

listHealthieAppointmentTypes: (wid, providerId?) => Promise<HealthieAppointmentTypeResponse[]>

Defined in: packages/sdk/src/client/client.ts:1171

Parameters

wid

string

providerId?

string

Returns

Promise<HealthieAppointmentTypeResponse[]>

Implementation of

IntegrationsBindings.listHealthieAppointmentTypes

---

listHealthiePatients()

listHealthiePatients: (wid, keywords?) => Promise<HealthiePatientResponse[]>

Defined in: packages/sdk/src/client/client.ts:1172

Parameters

wid

string

keywords?

string

Returns

Promise<HealthiePatientResponse[]>

Implementation of

IntegrationsBindings.listHealthiePatients

---

listHealthieProviders()

listHealthieProviders: (wid) => Promise<HealthieProviderResponse[]>

Defined in: packages/sdk/src/client/client.ts:1163

Parameters

wid

string

Returns

Promise<HealthieProviderResponse[]>

Implementation of

IntegrationsBindings.listHealthieProviders

---

listInquiries()

listInquiries: (params?) => Promise<InquiryListResponse>

Defined in: packages/sdk/src/client/client.ts:1037

List all inquiries (superuser only)

Parameters

params?

inquiryType?

string

page?

number

pageSize?

number

Returns

Promise<InquiryListResponse>

Implementation of

AppsBindings.listInquiries

---

listLegalEntities()

listLegalEntities: (orgUuid) => Promise<LegalEntityListResponse>

Defined in: packages/sdk/src/client/client.ts:615

List the org's legal entities (one Customer Profile each).

Parameters

orgUuid

string

Returns

Promise<LegalEntityListResponse>

Implementation of

OrgBindings.listLegalEntities

---

listMetricObservations()

listMetricObservations: (wid, metricId, params) => Promise<PaginatedResponse<MetricObservationResponse>>

Defined in: packages/sdk/src/client/client.ts:392

Parameters

wid

string

metricId

number

params

end

string

page?

number

pageSize?

number

start

string

Returns

Promise<PaginatedResponse<MetricObservationResponse>>

---

listMetrics()

listMetrics: (wid, params?) => Promise<PaginatedResponse<MetricResponse>>

Defined in: packages/sdk/src/client/client.ts:387

List metric definitions in the workspace, paginated.

Parameters

wid

string

params?

includeArchived?

boolean

page?

number

pageSize?

number

source?

string

Returns

Promise<PaginatedResponse<MetricResponse>>

---

listOAuthAccounts()

listOAuthAccounts: (providerSlug) => Promise<OAuthAccountsResponse>

Defined in: packages/sdk/src/client/client.ts:1046

Parameters

providerSlug

OAuthProviderSlug

Returns

Promise<OAuthAccountsResponse>

Implementation of

AppsBindings.listOAuthAccounts

---

listOrgDomains()

listOrgDomains: (orgIdOrUuid) => Promise<OrgDomainListResponse>

Defined in: packages/sdk/src/client/client.ts:595

List domains registered to an organization.

Parameters

orgIdOrUuid

string | number

Returns

Promise<OrgDomainListResponse>

Implementation of

OrgBindings.listOrgDomains

---

listOrgDomainSiteChildHosts()

listOrgDomainSiteChildHosts: (orgIdOrUuid, parentDomainUuid) => Promise<SiteChildHostsResponse>

Defined in: packages/sdk/src/client/client.ts:608

List the child hosts beneath a child-hosting parent domain, with live per-host status.

Parameters

orgIdOrUuid

string | number

parentDomainUuid

string

Returns

Promise<SiteChildHostsResponse>

Implementation of

OrgBindings.listOrgDomainSiteChildHosts

---

listOrgSupportRequests()

listOrgSupportRequests: (orgUuid, params?) => Promise<PaginatedResponse<SupportRequest>>

Defined in: packages/sdk/src/client/client.ts:1294

Parameters

orgUuid

string

params?

SupportRequestListParams

Returns

Promise<PaginatedResponse<SupportRequest>>

Implementation of

SupportRequestsBindings.listOrgSupportRequests

---

listPersonas()

listPersonas: (wid, params?) => Promise<PaginatedResponse<Persona>>

Defined in: packages/sdk/src/client/client.ts:378

List personas in the workspace, paginated.

Parameters

wid

string

params?

includeArchived?

boolean

page?

number

pageSize?

number

Returns

Promise<PaginatedResponse<Persona>>

Implementation of

PersonasBindings.listPersonas

---

listPushSubscriptions()

listPushSubscriptions: (wid) => Promise<object[]>

Defined in: packages/sdk/src/client/client.ts:630

List all active Web Push subscriptions for the current user.

Parameters

wid

string

Returns

Promise<object[]>

Implementation of

WorkspacesBindings.listPushSubscriptions

---

listSalesforceObjects()

listSalesforceObjects: (wid) => Promise<object[]>

Defined in: packages/sdk/src/client/client.ts:1204

List the sObjects available in the connected org.

Backs the Target Object picker: the object set is org-specific (custom objects included), so it must come from the org rather than a hardcoded list.

Parameters

wid

string

Returns

Promise<object[]>

Implementation of

IntegrationsBindings.listSalesforceObjects

---

listScenarios()

listScenarios: (wid, qualificationId, params?) => Promise<Scenario[]>

Defined in: packages/sdk/src/client/client.ts:360

Parameters

wid

string

qualificationId

number

params?

includeArchived?

boolean

Returns

Promise<Scenario[]>

Implementation of

QualificationsBindings.listScenarios

---

listSelfServeProducts()

listSelfServeProducts: (productType?) => Promise<Product[]>

Defined in: packages/sdk/src/client/client.ts:1014

List self-service, purchasable organization plans or add-ons. Only products with a Stripe Price are returned; zero-amount plans are allowed.

Parameters

productType?

"org" | "member" | "addon" | "device"

Returns

Promise<Product[]>

Implementation of

BillingBindings.listSelfServeProducts

---

listSupportRequests()

listSupportRequests: (params?) => Promise<PaginatedResponse<SupportRequest>>

Defined in: packages/sdk/src/client/client.ts:1290

Parameters

params?

SupportRequestListParams

Returns

Promise<PaginatedResponse<SupportRequest>>

Implementation of

SupportRequestsBindings.listSupportRequests

---

listTestChatRuns()

listTestChatRuns: (wid, workflowId, params?) => Promise<TestChatRun[]>

Defined in: packages/sdk/src/client/client.ts:365

Parameters

wid

string

workflowId

number

params?

assistantChatModelId?

string

limit?

number

scenarioId?

number

Returns

Promise<TestChatRun[]>

Implementation of

QualificationsBindings.listTestChatRuns

---

listWidgetDomains()

listWidgetDomains: (wid) => Promise<WidgetDomainListResponse>

Defined in: packages/sdk/src/client/client.ts:590

List this workspace's widget-domain enablement entries.

Parameters

wid

string

Returns

Promise<WidgetDomainListResponse>

Implementation of

WorkspacesBindings.listWidgetDomains

---

listWorkspaceInvitations()

listWorkspaceInvitations: (params?) => Promise<InvitationListResponse>

Defined in: packages/sdk/src/client/client.ts:631

List user's own invitations (both org and workspace). For admin listing of a specific workspace's invitations, use listWorkspaceInvitationsAdmin.

Parameters

params?

ListInvitationsParams

Returns

Promise<InvitationListResponse>

Implementation of

WorkspacesBindings.listWorkspaceInvitations

---

listWorkspaceInvitationsAdmin()

listWorkspaceInvitationsAdmin: (workspaceUuid, params?) => Promise<InvitationListResponse>

Defined in: packages/sdk/src/client/client.ts:632

List invitations for a specific workspace (requires workspace admin permission). Uses the workspace-scoped route: /api/v2/w/{workspaceUuid}/invitations

Parameters

workspaceUuid

string

params?

accountId?

number

page?

number

pageSize?

number

status?

InvitationStatus

Returns

Promise<InvitationListResponse>

Implementation of

WorkspacesBindings.listWorkspaceInvitationsAdmin

---

listWorkspaceSupportRequests()

listWorkspaceSupportRequests: (workspaceUuid, params?) => Promise<PaginatedResponse<SupportRequest>>

Defined in: packages/sdk/src/client/client.ts:1298

Parameters

workspaceUuid

string

params?

SupportRequestListParams

Returns

Promise<PaginatedResponse<SupportRequest>>

Implementation of

SupportRequestsBindings.listWorkspaceSupportRequests

---

login()

login: (phoneNumber, wid?, organizationUuid?, isSignUp) => Promise<SMSLoginResponse>

Defined in: packages/sdk/src/client/client.ts:649

Initiate SMS login by sending a verification code to the given phone number.

Parameters

phoneNumber

string

wid?

string

organizationUuid?

string

isSignUp?

boolean = false

Returns

Promise<SMSLoginResponse>

Implementation of

AuthBindings.login

---

logout()

logout: () => Promise<{ success: boolean; }>

Defined in: packages/sdk/src/client/client.ts:661

Log out the current session by clearing auth cookies.

Returns

Promise<{ success: boolean; }>

Implementation of

AuthBindings.logout

---

markEmailAsRead()

markEmailAsRead: (wid, inboxId, emailId) => Promise<Email>

Defined in: packages/sdk/src/client/client.ts:929

Mark an email as read.

Parameters

wid

string

inboxId

number

emailId

number

Returns

Promise<Email>

Implementation of

CommunicationsBindings.markEmailAsRead

---

markEmailAsUnread()

markEmailAsUnread: (wid, inboxId, emailId) => Promise<Email>

Defined in: packages/sdk/src/client/client.ts:930

Mark an email as unread.

Parameters

wid

string

inboxId

number

emailId

number

Returns

Promise<Email>

Implementation of

CommunicationsBindings.markEmailAsUnread

---

markNotificationAsRead()

markNotificationAsRead: (wid, id) => Promise<NotificationResponse>

Defined in: packages/sdk/src/client/client.ts:553

Mark a notification as read.

Parameters

wid

string

id

number

Returns

Promise<NotificationResponse>

Implementation of

WorkspacesBindings.markNotificationAsRead

---

mergeMemberRoles()

mergeMemberRoles: (wid, request) => Promise<MergeMemberRolesResponse>

Defined in: packages/sdk/src/client/client.ts:311

Move every member and reference from one role to another, then delete the source role. Requires member_roles:admin. The source cannot be a default role.

Parameters

wid

string

request

MergeMemberRolesRequest

Returns

Promise<MergeMemberRolesResponse>

Implementation of

MembersBindings.mergeMemberRoles

---

preflightOrgDomainSite()

preflightOrgDomainSite: (orgIdOrUuid, domainUuid, options) => Promise<SitePreflightResponse>

Defined in: packages/sdk/src/client/client.ts:606

Pre-enable DNS check: is the site CNAME resolving to the routing endpoint yet? Pure DNS — consumes no enable budget.

Pass { childHosting: true } to check the mode you intend to enable in: the wildcard is probed instead of the domain's own CNAME.

Parameters

orgIdOrUuid

string | number

domainUuid

string

options?

childHosting?

boolean

Returns

Promise<SitePreflightResponse>

Implementation of

OrgBindings.preflightOrgDomainSite

---

previewEmailReply()

previewEmailReply: (wid, inboxId, emailId, body) => Promise<EmailPreviewResponse>

Defined in: packages/sdk/src/client/client.ts:940

Render a reply draft, including its quote, through outbound body assembly. Preview excludes delivery-specific MIME transformations, including inline-image content IDs.

Parameters

wid

string

inboxId

string | number

emailId

number

body

EmailReplyPreviewRequest

Returns

Promise<EmailPreviewResponse>

Implementation of

CommunicationsBindings.previewEmailReply

---

previewImportMembers()

previewImportMembers: (wid, file, newMemberRoleId) => Promise<MemberImportPreviewResponse>

Defined in: packages/sdk/src/client/client.ts:288

Read-only preview classifying each CSV row before any write (GRA-5545).

Returns create/update/unchanged/conflict/error counts. For phone-only identity conflicts it also returns existing vs incoming identity so the operator can decide whether to skip or explicitly overwrite before committing. Requires MEMBERS_ADMIN and is bulk-PHI audited server-side.

Parameters

wid

string

file

File

newMemberRoleId

number

Returns

Promise<MemberImportPreviewResponse>

Implementation of

MembersBindings.previewImportMembers

---

previewImportWorkspace()

previewImportWorkspace: (wid, exportData, importMappings, createNew, autoMap?) => Promise<any>

Defined in: packages/sdk/src/client/client.ts:581

Preview a workspace import using the legacy untyped interface.

Parameters

wid

string

exportData

any

importMappings?

any = {}

createNew?

any = {}

autoMap?

WorkspaceAutoMapEntities

Returns

Promise<any>

Implementation of

WorkspacesBindings.previewImportWorkspace

---

previewInboxEmail()

previewInboxEmail: (wid, inboxId, body) => Promise<EmailPreviewResponse>

Defined in: packages/sdk/src/client/client.ts:939

Render a compose or email:send template draft through the same outbound body-assembly seam (footer, layout wrapper, markdown fallback) as sending. Preview excludes delivery-specific MIME transformations, including inline-image content IDs.

Parameters

wid

string

inboxId

string | number

body

EmailPreviewRequest

Returns

Promise<EmailPreviewResponse>

Implementation of

CommunicationsBindings.previewInboxEmail

---

previewMemberWorkflowVoice()

previewMemberWorkflowVoice: (wid, memberId, workflowId, body) => Promise<ArrayBuffer>

Defined in: packages/sdk/src/client/client.ts:269

Audition a voice the member can pick for this workflow (PCM16).

Parameters

wid

string

memberId

number

workflowId

number

body

SetWorkflowVoiceRequest

Returns

Promise<ArrayBuffer>

Implementation of

MembersBindings.previewMemberWorkflowVoice

---

previewPromoCode()

previewPromoCode: (code, options?) => Promise<PromoCodeResult>

Defined in: packages/sdk/src/client/client.ts:566

Check whether a promo code is usable, without redeeming it.

Reserves nothing, so it is safe to call as a form field settles. Redemption happens server-side after checkout completes, when the organization and its subscription exist.

Parameters

code

string

options?

signal?

AbortSignal

Returns

Promise<PromoCodeResult>

Implementation of

WorkspacesBindings.previewPromoCode

---

previewPronunciation()

previewPronunciation: (data) => Promise<ArrayBuffer>

Defined in: packages/sdk/src/client/client.ts:1264

Generate an audio preview of a pronunciation respelling using a specified voice.

Parameters

data

respelling

string

voiceModel

string

Returns

Promise<ArrayBuffer>

Implementation of

PronunciationsBindings.previewPronunciation

---

previewQuery()

previewQuery: (wid, query, mode?) => Promise<RunQueryResponse>

Defined in: packages/sdk/src/client/client.ts:375

Bounded sample run (limit capped server-side).

Parameters

wid

string

query

QueryIR

mode?

QueryRunMode

Returns

Promise<RunQueryResponse>

Implementation of

QueriesBindings.previewQuery

---

previewRenameFieldSlug()

previewRenameFieldSlug: (wid, dataTypeId, fieldSlug, newSlug) => Promise<FieldSlugRenamePreview>

Defined in: packages/sdk/src/client/client.ts:252

Preview renaming a field's slug — read-only.

A field slug is the key its answers are stored under, so a rename moves stored data. This reports whether the new slug is allowed, how many records would move, and every configured place still naming the old slug (CEL, templates, sync maps) which this rename does NOT rewrite.

Parameters

wid

string

dataTypeId

number

fieldSlug

string

newSlug

string

Returns

Promise<FieldSlugRenamePreview>

Implementation of

DataTypesBindings.previewRenameFieldSlug

---

previewRoutineVoiceReadiness()

previewRoutineVoiceReadiness: (wid, request) => Promise<RoutineVoiceReadinessPreviewResponse>

Defined in: packages/sdk/src/client/client.ts:815

Preview what would stop a draft Routine placing its scheduled outbound calls — the Member voice opt-out, a missing member phone, or a workspace number that is stale, archived, or not voice-enabled. Non-persisting and advisory. The audience is reported as counts only, never as Member rows.

Parameters

wid

string

request

RoutineVoiceReadinessPreviewRequest

Returns

Promise<RoutineVoiceReadinessPreviewResponse>

Implementation of

EventsBindings.previewRoutineVoiceReadiness

---

previewRoutineWorkflowAccess()

previewRoutineWorkflowAccess: (wid, request) => Promise<RoutineWorkflowAccessPreviewResponse>

Defined in: packages/sdk/src/client/client.ts:816

Preview which target-audience roles lack Workflow USE for the Workflows a draft Routine would start. Non-persisting, non-blocking authoring assist — returns warnings only (role/Workflow names + IDs; no Member data).

Parameters

wid

string

request

RoutineWorkflowAccessPreviewRequest

Returns

Promise<RoutineWorkflowAccessPreviewResponse>

Implementation of

EventsBindings.previewRoutineWorkflowAccess

---

previewSchedule()

previewSchedule: (wid, request) => Promise<SchedulePreviewResponse>

Defined in: packages/sdk/src/client/client.ts:814

Preview the next N run times for a cron expression.

Parameters

wid

string

request

SchedulePreviewRequest

Returns

Promise<SchedulePreviewResponse>

Implementation of

EventsBindings.previewSchedule

---

previewTemplate()

previewTemplate: (wid, request) => Promise<TemplatePreviewResponse>

Defined in: packages/sdk/src/client/client.ts:950

Render a template with sample data for preview.

Uses the same Jinja2 renderer as the actual template system, but with sample data instead of real data.

Parameters

wid

string

request

TemplatePreviewRequest

Returns

Promise<TemplatePreviewResponse>

Implementation of

ToolkitsBindings.previewTemplate

---

previewThinkingSound()

previewThinkingSound: (wid, request) => Promise<ArrayBuffer>

Defined in: packages/sdk/src/client/client.ts:861

Generate a thinking sound audio preview.

Parameters

wid

string

request

ThinkingSoundPreviewRequest

Returns

Promise<ArrayBuffer>

Implementation of

WorkflowsBindings.previewThinkingSound

---

previewTTS()

previewTTS: (wid, request) => Promise<ArrayBuffer>

Defined in: packages/sdk/src/client/client.ts:860

Generate a text-to-speech audio preview for a given voice model.

Parameters

wid

string

request

TTSPreviewRequest

Returns

Promise<ArrayBuffer>

Implementation of

WorkflowsBindings.previewTTS

---

previewWorkspaceImport()

previewWorkspaceImport: (wid, exportData, importMappings, createNew, autoMap?, options?) => Promise<WorkspaceImportPreviewResponse>

Defined in: packages/sdk/src/client/client.ts:574

Preview the result of importing workspace configuration without applying changes.

Pass options.intent = 'template_reapply' to get the deterministic re-apply plan: planRows, sourceFingerprint and planFingerprint come back beside the legacy preview items, and the fingerprint is what importWorkspace must be given to apply exactly that projection.

Parameters

wid

string

exportData

WorkspaceExportData

importMappings

WorkspaceImportMapping

createNew

WorkspaceCreateNewEntities

autoMap?

WorkspaceAutoMapEntities

options?

WorkspaceImportPlanOptions

Returns

Promise<WorkspaceImportPreviewResponse>

Implementation of

WorkspacesBindings.previewWorkspaceImport

---

previewWorkspaceImportZip()

previewWorkspaceImportZip: (wid, archive, options?) => Promise<WorkspaceImportPreviewResponse>

Defined in: packages/sdk/src/client/client.ts:575

Plan a workspace export ZIP against this workspace without importing it.

The sibling of previewWorkspaceImport, and it exists for one reason: a JSON preview has no archive, so it cannot decide whether File BYTES would be replaced — that decision compares the archive's blob digest against the destination's current content digest.

Parameters

wid

string

archive

Blob

options?

WorkspaceImportPlanOptions & object

Returns

Promise<WorkspaceImportPreviewResponse>

Implementation of

WorkspacesBindings.previewWorkspaceImportZip

---

provisionClientWorkspace()

provisionClientWorkspace: (wid, workspaceId) => Promise<{ message: string; status: string; }>

Defined in: packages/sdk/src/client/client.ts:561

Provision a client workspace, setting up its database and resources.

Parameters

wid

string

workspaceId

number

Returns

Promise<{ message: string; status: string; }>

Implementation of

WorkspacesBindings.provisionClientWorkspace

---

publishDataTypeDraft()

publishDataTypeDraft: (wid, id, request) => Promise<DataTypeDraftResponse>

Defined in: packages/sdk/src/client/client.ts:233

Publish the expected draft as the next immutable local schema version.

Parameters

wid

string

id

number

request

PublishDataTypeDraftRequest

Returns

Promise<DataTypeDraftResponse>

Implementation of

DataTypesBindings.publishDataTypeDraft

---

publishSiteSource()

publishSiteSource: (wid, siteId, options?) => Promise<SiteSourcePublishResponse>

Defined in: packages/sdk/src/client/client.ts:713

Build and publish a site's source. Optionally label the published version with a name and note; both default to null (the UI then shows "Version {version}").

Parameters

wid

string

siteId

number

options?

name?

string | null

note?

string | null

Returns

Promise<SiteSourcePublishResponse>

Implementation of

SitesBindings.publishSiteSource

---

publishWorkflowRevision()

publishWorkflowRevision: (wid, workflowId, data) => Promise<WorkflowRevisionSummaryResponse>

Defined in: packages/sdk/src/client/client.ts:851

Freeze the workflow's draft as a published revision and clone a fresh draft.

By default the just-published revision becomes the active revision — live traffic flips to it immediately. Pass setActive: false to publish without flipping live traffic (advanced flow).

Parameters

wid

string

workflowId

string | number

data?

PublishWorkflowRevisionRequest = {}

Returns

Promise<WorkflowRevisionSummaryResponse>

Implementation of

WorkflowsBindings.publishWorkflowRevision

---

purchaseCredits()

purchaseCredits: (subscriptionId, amountCents, idempotencyKey) => Promise<{ amountChargedCents: number; amountSubmittedCents: number; creditsAdded: number; creditsPending: number; grantId: number; newBalance: number; status: string; success: boolean; }>

Defined in: packages/sdk/src/client/client.ts:1006

Purchase extra credits on a subscription (org-level).

Parameters

subscriptionId

number

amountCents

number

idempotencyKey?

string = ...

Returns

Promise<{ amountChargedCents: number; amountSubmittedCents: number; creditsAdded: number; creditsPending: number; grantId: number; newBalance: number; status: string; success: boolean; }>

Implementation of

BillingBindings.purchaseCredits

---

putJourneyDraft()

putJourneyDraft: (wid, journeyId, data) => Promise<Journey>

Defined in: packages/sdk/src/client/client.ts:450

Parameters

wid

string

journeyId

number

data

PutJourneyDraftRequest

Returns

Promise<Journey>

Implementation of

JourneysBindings.putJourneyDraft

---

putJourneyV2Definition()

putJourneyV2Definition: (wid, journeyId, data) => Promise<Journey>

Defined in: packages/sdk/src/client/client.ts:451

Atomically replace a v2 Journey's whole definition (Journey v2 plan §3.8).

ONE request carries the ordered touches, the wait into each touch, the ordered Endings, action associations, goals, and expectedUpdatedAt for optimistic concurrency. It is a full replacement, not a patch — omitting goals is the one exception and leaves them alone.

Returns the AUTHORING projection (Journey): the caller just wrote the CEL and holds the journeys:write scope that authorizes reading it back.

Refusals are HTTP 409 with a stable code:

• journey_v2_execution_model_mismatch — the Journey is legacy; use the step/connection/goal endpoints.
• journey_v2_structural_edit_not_allowed — it is live; pause it first.
• journey_v2_definition_conflict — someone saved first; reload.
• journey_v2_invalid_topology — the resulting graph is not executable; the body carries issues (codes and resource uuids, never CEL).

Parameters

wid

string

journeyId

number

data

PutJourneyV2DefinitionRequest

Returns

Promise<Journey>

Implementation of

JourneysBindings.putJourneyV2Definition

---

queryActivity()

queryActivity: (request) => Promise<ActivityAggregateResponse | ActivityEventsResponse>

Defined in: packages/sdk/src/client/client.ts:408

The account mount: this caller's whole estate, at any grain.

Parameters

request

ActivityFeedQueryRequest

Returns

Promise<ActivityAggregateResponse | ActivityEventsResponse>

Implementation of

ActivityBindings.queryActivity

---

queryActivityDigest()

queryActivityDigest: (request) => Promise<ActivityDigestResponse>

Defined in: packages/sdk/src/client/client.ts:412

The specifics behind a page of aggregate lines, in one round trip.

Each entry of request.lines is an aggregate line's own server-issued drill, POSTed back verbatim, and the response is positional with it — so a caller maps groups back to rows without inventing a key and without a second expression of the slice that could drift from the count above it.

Aggregate-shaped, never row-level: counts per PHI-silent key. A digest the server could not finish comes back with complete: false and no groups, which a client renders as the plain count phrase rather than as a slice presented as the whole.

Parameters

request

ActivityDigestRequest

Returns

Promise<ActivityDigestResponse>

Implementation of

ActivityBindings.queryActivityDigest

---

queryActivityLatestSubjects()

queryActivityLatestSubjects: (request) => Promise<ActivityLatestSubjectsResponse>

Defined in: packages/sdk/src/client/client.ts:409

Latest admitted event for each workspace-qualified Activity subject. Scope authorization and any event-type leaf authorization are both applied before a subject is returned.

Parameters

request

ActivityLatestSubjectsRequest

Returns

Promise<ActivityLatestSubjectsResponse>

Implementation of

ActivityBindings.queryActivityLatestSubjects

---

queryActivityOneView()

queryActivityOneView: (request) => Promise<ActivityOneViewResponse>

Defined in: packages/sdk/src/client/client.ts:411

The account mount's one view: one stream of occurrences, some carrying open state. The window bounds the event axis; open items older than it arrive as olderOpenCount, never hidden.

Parameters

request

ActivityOneViewRequest

Returns

Promise<ActivityOneViewResponse>

Implementation of

ActivityBindings.queryActivityOneView

---

queryActivityOpenItems()

queryActivityOpenItems: (request) => Promise<ActivityOpenItemsResponse>

Defined in: packages/sdk/src/client/client.ts:410

The account mount's priority lane — one queue per human. openedAfter may bound the active backlog without changing the priority policy.

Parameters

request?

ActivityOpenItemsRequest = {}

Returns

Promise<ActivityOpenItemsResponse>

Implementation of

ActivityBindings.queryActivityOpenItems

---

queryOrgActivity()

queryOrgActivity: (orgUuid, request) => Promise<ActivityAggregateResponse | ActivityEventsResponse>

Defined in: packages/sdk/src/client/client.ts:415

The org mount. org:info is the entry gate; org:read widens the rows.

Parameters

orgUuid

string

request

ActivityFeedQueryRequest

Returns

Promise<ActivityAggregateResponse | ActivityEventsResponse>

Implementation of

ActivityBindings.queryOrgActivity

---

queryOrgActivityDigest()

queryOrgActivityDigest: (orgUuid, request) => Promise<ActivityDigestResponse>

Defined in: packages/sdk/src/client/client.ts:419

The org mount's digest.

Parameters

orgUuid

string

request

ActivityDigestRequest

Returns

Promise<ActivityDigestResponse>

Implementation of

ActivityBindings.queryOrgActivityDigest

---

queryOrgActivityLatestSubjects()

queryOrgActivityLatestSubjects: (orgUuid, request) => Promise<ActivityLatestSubjectsResponse>

Defined in: packages/sdk/src/client/client.ts:416

Parameters

orgUuid

string

request

ActivityLatestSubjectsRequest

Returns

Promise<ActivityLatestSubjectsResponse>

Implementation of

ActivityBindings.queryOrgActivityLatestSubjects

---

queryOrgActivityOneView()

queryOrgActivityOneView: (orgUuid, request) => Promise<ActivityOneViewResponse>

Defined in: packages/sdk/src/client/client.ts:418

The org mount's one view.

Parameters

orgUuid

string

request

ActivityOneViewRequest

Returns

Promise<ActivityOneViewResponse>

Implementation of

ActivityBindings.queryOrgActivityOneView

---

queryOrgActivityOpenItems()

queryOrgActivityOpenItems: (orgUuid, request) => Promise<ActivityOpenItemsResponse>

Defined in: packages/sdk/src/client/client.ts:417

The org mount's priority lane.

Parameters

orgUuid

string

request?

ActivityOpenItemsRequest = {}

Returns

Promise<ActivityOpenItemsResponse>

Implementation of

ActivityBindings.queryOrgActivityOpenItems

---

queryWorkspaceActivity()

queryWorkspaceActivity: (workspaceUuid, request) => Promise<ActivityAggregateResponse | ActivityEventsResponse>

Defined in: packages/sdk/src/client/client.ts:421

The workspace mount. The request's own member session carries its scopes.

Parameters

workspaceUuid

string

request

ActivityFeedQueryRequest

Returns

Promise<ActivityAggregateResponse | ActivityEventsResponse>

Implementation of

ActivityBindings.queryWorkspaceActivity

---

queryWorkspaceActivityDigest()

queryWorkspaceActivityDigest: (workspaceUuid, request) => Promise<ActivityDigestResponse>

Defined in: packages/sdk/src/client/client.ts:425

The workspace mount's digest.

Parameters

workspaceUuid

string

request

ActivityDigestRequest

Returns

Promise<ActivityDigestResponse>

Implementation of

ActivityBindings.queryWorkspaceActivityDigest

---

queryWorkspaceActivityLatestSubjects()

queryWorkspaceActivityLatestSubjects: (workspaceUuid, request) => Promise<ActivityLatestSubjectsResponse>

Defined in: packages/sdk/src/client/client.ts:422

Parameters

workspaceUuid

string

request

ActivityLatestSubjectsRequest

Returns

Promise<ActivityLatestSubjectsResponse>

Implementation of

ActivityBindings.queryWorkspaceActivityLatestSubjects

---

queryWorkspaceActivityOneView()

queryWorkspaceActivityOneView: (workspaceUuid, request) => Promise<ActivityOneViewResponse>

Defined in: packages/sdk/src/client/client.ts:424

The workspace mount's one view.

Parameters

workspaceUuid

string

request

ActivityOneViewRequest

Returns

Promise<ActivityOneViewResponse>

Implementation of

ActivityBindings.queryWorkspaceActivityOneView

---

queryWorkspaceActivityOpenItems()

queryWorkspaceActivityOpenItems: (workspaceUuid, request) => Promise<ActivityOpenItemsResponse>

Defined in: packages/sdk/src/client/client.ts:423

The workspace mount's priority lane.

Parameters

workspaceUuid

string

request?

ActivityOpenItemsRequest = {}

Returns

Promise<ActivityOpenItemsResponse>

Implementation of

ActivityBindings.queryWorkspaceActivityOpenItems

---

rateMessage()

rateMessage: (wid, chatId, messageUuid, rating, comment?) => Promise<{ detail?: string; status: string; }>

Defined in: packages/sdk/src/client/client.ts:197

Rate a chat message by its UUID. Optional comment updates free-text details on the same durable rating row.

Parameters

wid

string

chatId

number

messageUuid

string

rating

number

comment?

string | null

Returns

Promise<{ detail?: string; status: string; }>

Implementation of

ChatsBindings.rateMessage

---

reactivateSubscription()

reactivateSubscription: (subscriptionId) => Promise<{ message: string; }>

Defined in: packages/sdk/src/client/client.ts:1003

Reactivate a previously cancelled subscription.

Parameters

subscriptionId

number

Returns

Promise<{ message: string; }>

Implementation of

BillingBindings.reactivateSubscription

---

rebuildImportSkippedRules()

rebuildImportSkippedRules: (wid, body) => Promise<RebuildImportSkippedRulesResponse>

Defined in: packages/sdk/src/client/client.ts:580

Re-point every outstanding skipped EventRule that needed the same source resource onto a re-provisioned one, recreating each rule from its preserved definition. Repeat calls no-op on already-reconnected rows.

Parameters

wid

string

body

RebuildImportSkippedRulesRequest

Returns

Promise<RebuildImportSkippedRulesResponse>

Implementation of

WorkspacesBindings.rebuildImportSkippedRules

---

recordAcquisition()

recordAcquisition: (request) => Promise<AcquisitionResponse>

Defined in: packages/sdk/src/client/client.ts:648

Persist the account's FIRST-touch marketing attribution (write-once).

Called by the browser at signup completion with its resolved UTM / referrer / landing-page capture. The server keeps the first write and ignores later posts (recorded: false), so calling this again is harmless. Marketing context only — never emails, phones, or free text.

Parameters

request

AcquisitionRequest

Returns

Promise<AcquisitionResponse>

Implementation of

AuthBindings.recordAcquisition

---

reenrollMember()

reenrollMember: (wid, journeyId, data) => Promise<MemberJourney>

Defined in: packages/sdk/src/client/client.ts:472

Re-enroll a canceled member back to enrolled status.

Parameters

wid

string

journeyId

number

data

ReenrollMemberFormData

Returns

Promise<MemberJourney>

Implementation of

JourneysBindings.reenrollMember

---

regenerateClientSecret()

regenerateClientSecret: (appId) => Promise<AppCredentialResponse>

Defined in: packages/sdk/src/client/client.ts:1028

Regenerate client secret for an app

Parameters

appId

string

Returns

Promise<AppCredentialResponse>

Implementation of

AppsBindings.regenerateClientSecret

---

registerDiscordSlashCommands()

registerDiscordSlashCommands: (wid, botId) => Promise<void>

Defined in: packages/sdk/src/client/client.ts:1087

Register slash commands for a Discord bot.

Parameters

wid

string

botId

number

Returns

Promise<void>

Implementation of

IntegrationsBindings.registerDiscordSlashCommands

---

registerLinkedRolesMetadata()

registerLinkedRolesMetadata: (wid, botId) => Promise<{ fields: string[]; registered: number; }>

Defined in: packages/sdk/src/client/client.ts:1088

Register role connection metadata schema for Discord Linked Roles. This defines what metadata fields are available for linked roles.

Parameters

wid

string

botId

number

Returns

Promise<{ fields: string[]; registered: number; }>

Implementation of

IntegrationsBindings.registerLinkedRolesMetadata

---

registerOrgDomain()

registerOrgDomain: (orgIdOrUuid, domain) => Promise<OrgDomain>

Defined in: packages/sdk/src/client/client.ts:596

Register a domain with an organization and return the TXT ownership proof.

Parameters

orgIdOrUuid

string | number

domain

string

Returns

Promise<OrgDomain>

Implementation of

OrgBindings.registerOrgDomain

---

registerPushSubscription()

registerPushSubscription: (wid, subscription) => Promise<{ createdAt: string; endpoint: string; id: number; }>

Defined in: packages/sdk/src/client/client.ts:628

Register a Web Push subscription for the current user.

Parameters

wid

string

subscription

authKey

string

endpoint

string

p256dhKey

string

userAgent?

string

Returns

Promise<{ createdAt: string; endpoint: string; id: number; }>

Implementation of

WorkspacesBindings.registerPushSubscription

---

reindexFolder()

reindexFolder: (wid, id) => Promise<{ message: string; status: string; }>

Defined in: packages/sdk/src/client/client.ts:771

Trigger reindexing of a folder's contents for search.

Parameters

wid

string

id

number

Returns

Promise<{ message: string; status: string; }>

Implementation of

FilesBindings.reindexFolder

---

releasePhoneNumber()

releasePhoneNumber: (wid, id) => Promise<void>

Defined in: packages/sdk/src/client/client.ts:919

Parameters

wid

string

id

number

Returns

Promise<void>

Implementation of

CommunicationsBindings.releasePhoneNumber

---

removeFileRole()

removeFileRole: (wid, fileId, roleId) => Promise<void>

Defined in: packages/sdk/src/client/client.ts:781

Remove a role's access to a file.

Parameters

wid

string

fileId

number

roleId

number

Returns

Promise<void>

Implementation of

FilesBindings.removeFileRole

---

removeFolderRole()

removeFolderRole: (wid, folderId, roleId) => Promise<void>

Defined in: packages/sdk/src/client/client.ts:785

Remove a role's access to a folder.

Parameters

wid

string

folderId

number

roleId

number

Returns

Promise<void>

Implementation of

FilesBindings.removeFolderRole

---

removeGroupMember()

removeGroupMember: (wid, groupId, memberId) => Promise<void>

Defined in: packages/sdk/src/client/client.ts:508

Remove a member from an operator group.

Parameters

wid

string

groupId

number

memberId

number

Returns

Promise<void>

Implementation of

OperatorBindings.removeGroupMember

---

renameFieldSlug()

renameFieldSlug: (wid, dataTypeId, fieldSlug, newSlug) => Promise<FieldSlugRenameResult>

Defined in: packages/sdk/src/client/client.ts:253

Rename a field's slug, preserving stored answers.

The schema change commits synchronously; the answers are moved by the existing cleanup workflow, so this resolves on ACCEPTANCE, not completion. Call previewRenameFieldSlug first — references naming the old slug are reported, never rewritten.

Parameters

wid

string

dataTypeId

number

fieldSlug

string

newSlug

string

Returns

Promise<FieldSlugRenameResult>

Implementation of

DataTypesBindings.renameFieldSlug

---

reopenWorkspaceSupportRequest()

reopenWorkspaceSupportRequest: (workspaceUuid, uuid, data) => Promise<SupportRequest>

Defined in: packages/sdk/src/client/client.ts:1303

Reopen a resolved support request (e.g. staff resolved it prematurely). The server rejects requests that are not in the resolved state.

Parameters

workspaceUuid

string

uuid

string

data?

ReopenSupportRequestRequest = {}

Returns

Promise<SupportRequest>

Implementation of

SupportRequestsBindings.reopenWorkspaceSupportRequest

---

reorderEventRules()

reorderEventRules: (wid, ruleIds) => Promise<{ status: string; }>

Defined in: packages/sdk/src/client/client.ts:802

Reorder event rules by specifying the desired rule ID sequence.

Parameters

wid

string

ruleIds

number[]

Returns

Promise<{ status: string; }>

Implementation of

EventsBindings.reorderEventRules

---

reorderMenuItems()

reorderMenuItems: (wid, siteId, data) => Promise<void>

Defined in: packages/sdk/src/client/client.ts:743

Reorder menu items within a site's navigation.

Parameters

wid

string

siteId

number

data

ReorderMenuItemsData

Returns

Promise<void>

Implementation of

SitesBindings.reorderMenuItems

---

replyToEmail()

replyToEmail: (wid, inboxId, emailId, content, htmlContent?) => Promise<Email>

Defined in: packages/sdk/src/client/client.ts:937

Reply to an email from the inbox.

Parameters

wid

string

inboxId

number

emailId

number

content

string

htmlContent?

string

Returns

Promise<Email>

Implementation of

CommunicationsBindings.replyToEmail

---

requestCredentialChange()

requestCredentialChange: (credentialType, newValue, deliveryMethod) => Promise<CredentialChangeRequestResponse>

Defined in: packages/sdk/src/client/client.ts:680

Request to change email or phone credential. Sends an OTP to the NEW credential to verify ownership. For phone, the code can be delivered by SMS (default) or read aloud over a voice call (deliveryMethod: 'voice') so landlines can be verified too.

Parameters

credentialType

CredentialType

newValue

string

deliveryMethod?

"sms" | "voice"

Returns

Promise<CredentialChangeRequestResponse>

Implementation of

AuthBindings.requestCredentialChange

---

requestCrossDomainToken()

requestCrossDomainToken: () => Promise<{ token: string; }>

Defined in: packages/sdk/src/client/client.ts:662

Request a cross-domain authentication token for single sign-on across domains.

Returns

Promise<{ token: string; }>

Implementation of

AuthBindings.requestCrossDomainToken

---

requestMagicLink()

requestMagicLink: (email, organizationUuid?, redirectUrl?) => Promise<RequestMagicLinkResponse>

Defined in: packages/sdk/src/client/client.ts:654

Request a magic link to be sent to the given email address for passwordless login.

Parameters

email

string

organizationUuid?

string

redirectUrl?

string

Returns

Promise<RequestMagicLinkResponse>

Implementation of

AuthBindings.requestMagicLink

---

requestPhoneNumber()

requestPhoneNumber: (wid, phoneNumber) => Promise<{ message: string; status: string; }>

Defined in: packages/sdk/src/client/client.ts:904

Request provisioning of a specific phone number.

Parameters

wid

string

phoneNumber

string

Returns

Promise<{ message: string; status: string; }>

Implementation of

CommunicationsBindings.requestPhoneNumber

---

requestWorkspaceMembership()

requestWorkspaceMembership: (workspaceUuid, message?) => Promise<InvitationResponse>

Defined in: packages/sdk/src/client/client.ts:637

Request membership to a public workspace. Creates a membership request that workspace admins can approve or deny.

Parameters

workspaceUuid

string

message?

string

Returns

Promise<InvitationResponse>

Implementation of

WorkspacesBindings.requestWorkspaceMembership

---

resendCode()

resendCode: (phoneNumber, organizationUuid?, isSignUp) => Promise<SMSLoginResponse>

Defined in: packages/sdk/src/client/client.ts:650

Resend the SMS verification code to the given phone number.

Parameters

phoneNumber

string

organizationUuid?

string

isSignUp?

boolean = false

Returns

Promise<SMSLoginResponse>

Implementation of

AuthBindings.resendCode

---

resetRoutineRuns()

resetRoutineRuns: (wid, routineId) => Promise<{ deletedRunsCount: number; message: string; status: string; }>

Defined in: packages/sdk/src/client/client.ts:813

Delete all run history for a routine.

Parameters

wid

string

routineId

number

Returns

Promise<{ deletedRunsCount: number; message: string; status: string; }>

Implementation of

EventsBindings.resetRoutineRuns

---

resetSiteSource()

resetSiteSource: (wid, siteId, options) => Promise<SiteSource>

Defined in: packages/sdk/src/client/client.ts:714

Reset a site's source files: load a starter template and/or wipe existing files. template selects which starter to seed when loadDefaults is set (defaults to "hello-world"; "patient-enrollment" is the other built-in).

Parameters

wid

string

siteId

number

options

deleteExisting

boolean

loadDefaults

boolean

template?

string

Returns

Promise<SiteSource>

Implementation of

SitesBindings.resetSiteSource

---

resolveAccessGrant()

resolveAccessGrant: (wid, uuid, data) => Promise<AccessGrant>

Defined in: packages/sdk/src/client/client.ts:519

Resolve a pending access grant by approving or denying it.

Parameters

wid

string

uuid

string

data

ResolveGrantRequest

Returns

Promise<AccessGrant>

Implementation of

AccessGrantsBindings.resolveAccessGrant

---

resolveAccountEntityRefs()

resolveAccountEntityRefs: (request) => Promise<ResolveGroupedEntityRefsResponse>

Defined in: packages/sdk/src/client/client.ts:431

Hydrate a page of typed refs spanning the caller's whole estate.

The same grouped body as the org mount, and the same rule that the server chooses each group's authority: a workspace the caller belongs to resolves under their own member row, and a workspace they reach by holding org:read on its org resolves under that. A client never states which, because stating it would mean carrying a copy of the policy.

PHI: resolved labels are member-identifying data. They belong in the UI and nowhere else — never a log line, never an error message.

Parameters

request

ResolveGroupedEntityRefsRequest

Returns

Promise<ResolveGroupedEntityRefsResponse>

Implementation of

ActivityBindings.resolveAccountEntityRefs

---

resolveAnonymousMember()

resolveAnonymousMember: (wid, resolutionId, request) => Promise<AnonymousMemberResolutionResponse>

Defined in: packages/sdk/src/client/client.ts:325

Resolve an anonymous member to an existing member. This merges the anonymous member's data into the target member and archives the anonymous member.

Parameters

wid

string

resolutionId

number

request

ResolveAnonymousMemberRequest

Returns

Promise<AnonymousMemberResolutionResponse>

Implementation of

MembersBindings.resolveAnonymousMember

---

resolveEntityRefs()

resolveEntityRefs: (workspaceUuid, request) => Promise<ResolveEntityRefsResponse>

Defined in: packages/sdk/src/client/client.ts:429

Hydrate a page of typed refs in one round trip.

The relief valve the design names for chatty hydration, and the by-UUID read path most entity kinds otherwise lack: nineteen kinds resolve here, each through the workspace's own live authorizers under the caller's session. One request per workspace per listing, instead of one per ref.

Every requested ref comes back, in the order it was sent and deduplicated on (kind, uuid). A ref the caller may not see is an entry with status: 'unresolved' — never a 404, and never an omission, so a page's ability to render never depends on what it happens to name. status: 'unsupported' means this build has no by-UUID path for that kind at all (account, org, workspace, domain, subscription and the commerce kinds; see the resolve registry for each one's reason) — those resolve through the mount that owns them, and retrying here will not help.

PHI: resolved labels are member-identifying data. They belong in the UI and nowhere else — never a log line, never an error message.

Parameters

workspaceUuid

string

request

ResolveEntityRefsRequest

Returns

Promise<ResolveEntityRefsResponse>

Implementation of

ActivityBindings.resolveEntityRefs

---

resolveFilePath()

resolveFilePath: (wid, path, folderId?) => Promise<File>

Defined in: packages/sdk/src/client/client.ts:754

Resolve a wiki-style relative path (as authored in a markdown link or image) to a file. folderId is the linking document's folder; omit it to resolve from the workspace root. Handles ./.. segments and an omitted .md extension server-side.

Parameters

wid

string

path

string

folderId?

number | null

Returns

Promise<File>

Implementation of

FilesBindings.resolveFilePath

---

resolveInterventionRequest()

resolveInterventionRequest: (wid, requestId, params) => Promise<InterventionRequest>

Defined in: packages/sdk/src/client/client.ts:528

Resolve one intervention request. One row, one resolution — whoever takes it closes it for everyone who was notified. Resolving an already-resolved request is a 409 conflict; a non-escalation request is a 409 too.

The JSON body (empty when no note is supplied) is required as a CSRF barrier (GRA-6284), so a cross-site form POST cannot reach it.

Parameters

wid

string

requestId

number

params?

ResolveInterventionRequestParams = {}

Returns

Promise<InterventionRequest>

Implementation of

InterventionRequestsBindings.resolveInterventionRequest

---

resolveOrgEntityRefs()

resolveOrgEntityRefs: (orgUuid, request) => Promise<ResolveGroupedEntityRefsResponse>

Defined in: packages/sdk/src/client/client.ts:430

Hydrate a page of typed refs spanning an org's workspaces, in one round trip. org:info is the gate; what it buys differs per workspace, and the server decides — an org:read holder reads every workspace in the org, an org:info holder the ones they belong to.

The request groups refs by workspace because the same UUID under two workspaces is two entities. A group naming a workspace this caller cannot reach comes back entirely unresolved — the same answer a denied ref gets, never an error.

Caps: at most 500 refs and 25 workspaces across the whole request, and a workspace may be named at most once in it. Each answered group carries the same per-entry contract as the workspace mount: every requested ref comes back, with a marker status rather than an omission.

PHI: resolved labels are member-identifying data. They belong in the UI and nowhere else — never a log line, never an error message.

Parameters

orgUuid

string

request

ResolveGroupedEntityRefsRequest

Returns

Promise<ResolveGroupedEntityRefsResponse>

Implementation of

ActivityBindings.resolveOrgEntityRefs

---

restoreFileVersion()

restoreFileVersion: (wid, fileId, versionNumber, changeNote?) => Promise<FileVersionRestoreResponse>

Defined in: packages/sdk/src/client/client.ts:762

Restore an earlier version as the file's current contents.

Parameters

wid

string

fileId

number

versionNumber

number

changeNote?

string

Returns

Promise<FileVersionRestoreResponse>

Implementation of

FilesBindings.restoreFileVersion

---

resyncSalesforceLinkedMembers()

resyncSalesforceLinkedMembers: (wid, data) => Promise<ResyncLinkedMembersResponse>

Defined in: packages/sdk/src/client/client.ts:1203

Pull linked members' Salesforce records now, ignoring the sync cursor.

The inbound poll only ever returns records modified after the stored cursor, so a member linked to a record that has not changed since is unreachable by any poll and its link never receives a field — silently. This fetches the records by Id and leaves the cursor untouched, so it is safe to call at any time.

Omit memberIds to resync every linked member (capped server-side).

Parameters

wid

string

data?

ResyncLinkedMembersRequest = {}

Returns

Promise<ResyncLinkedMembersResponse>

Implementation of

IntegrationsBindings.resyncSalesforceLinkedMembers

---

revokeAccessGrant()

revokeAccessGrant: (wid, uuid, data) => Promise<AccessGrant>

Defined in: packages/sdk/src/client/client.ts:520

Revoke a previously approved access grant.

Parameters

wid

string

uuid

string

data

RevokeGrantRequest

Returns

Promise<AccessGrant>

Implementation of

AccessGrantsBindings.revokeAccessGrant

---

revokeApiKey()

revokeApiKey: (wid, id) => Promise<void>

Defined in: packages/sdk/src/client/client.ts:996

Revoke a workspace API key.

Parameters

wid

string

id

number

Returns

Promise<void>

Implementation of

BillingBindings.revokeApiKey

---

revokeDevice()

revokeDevice: (deviceUuid) => Promise<DeviceResponse>

Defined in: packages/sdk/src/client/client.ts:991

Revoke an owned device credential. The device must pair again.

Parameters

deviceUuid

string

Returns

Promise<DeviceResponse>

Implementation of

DevicesBindings.revokeDevice

---

revokeGlobalApiKey()

revokeGlobalApiKey: (id) => Promise<void>

Defined in: packages/sdk/src/client/client.ts:999

Revoke an account-level API key.

Parameters

id

number

Returns

Promise<void>

Implementation of

BillingBindings.revokeGlobalApiKey

---

revokeICalToken()

revokeICalToken: (wid, calendarId) => Promise<{ message: string; success: boolean; }>

Defined in: packages/sdk/src/client/client.ts:893

Revoke the iCal feed token for a calendar, disabling external feed access.

Parameters

wid

string

calendarId

number

Returns

Promise<{ message: string; success: boolean; }>

Implementation of

CalendarsBindings.revokeICalToken

---

rollbackSiteSource()

rollbackSiteSource: (wid, siteId, releaseUuid) => Promise<SiteSource>

Defined in: packages/sdk/src/client/client.ts:715

Re-point the published release to a prior version from the history. A pure pointer move (no rebuild); the other versions stay in the history.

Parameters

wid

string

siteId

number

releaseUuid

string

Returns

Promise<SiteSource>

Implementation of

SitesBindings.rollbackSiteSource

---

rotateDocumoFaxCredentials()

rotateDocumoFaxCredentials: (wid) => Promise<DocumoFaxSetupResponse>

Defined in: packages/sdk/src/client/client.ts:1157

Parameters

wid

string

Returns

Promise<DocumoFaxSetupResponse>

Implementation of

IntegrationsBindings.rotateDocumoFaxCredentials

---

runQuery()

runQuery: (wid, query, mode?) => Promise<RunQueryResponse>

Defined in: packages/sdk/src/client/client.ts:376

Execute a query (rows / count / aggregate).

Parameters

wid

string

query

QueryIR

mode?

QueryRunMode

Returns

Promise<RunQueryResponse>

Implementation of

QueriesBindings.runQuery

---

runRoutine()

runRoutine: (wid, id, params) => Promise<{ message: string; status: string; }>

Defined in: packages/sdk/src/client/client.ts:810

Manually trigger a routine for a specific member or member filter.

Parameters

wid

string

id

number

params

memberFilterId?

number

memberId?

number

Returns

Promise<{ message: string; status: string; }>

Implementation of

EventsBindings.runRoutine

---

saveDataTypeDraft()

saveDataTypeDraft: (wid, id, request) => Promise<DataTypeDraftResponse>

Defined in: packages/sdk/src/client/client.ts:232

Save a draft without changing the schema used to validate live records.

Parameters

wid

string

id

number

request

SaveDataTypeDraftRequest

Returns

Promise<DataTypeDraftResponse>

Implementation of

DataTypesBindings.saveDataTypeDraft

---

saveRegistrationDraft()

saveRegistrationDraft: (orgUuid, legalEntityUuid, kind, data) => Promise<RegistrationDraftResponse>

Defined in: packages/sdk/src/client/client.ts:619

Save one registration draft. Always accepted — the server refuses only an oversized body, never an unfinished one.

Parameters

orgUuid

string

legalEntityUuid

string

kind

RegistrationDraftKind

data

Record<string, unknown>

Returns

Promise<RegistrationDraftResponse>

Implementation of

OrgBindings.saveRegistrationDraft

---

searchEventRules()

searchEventRules: (wid, params) => Promise<EventRuleResponse[]>

Defined in: packages/sdk/src/client/client.ts:796

Search event rules by object type, event type, action type, and related entities.

Parameters

wid

string

params

actionType?

EventRuleActionType

dataTypeId?

number

eventType?

EventRuleEventType

includeDisabled?

boolean

journeyStepId?

number

objectType?

EventRuleObjectType

routineId?

number

taskId?

number

workflowRevisionId?

number

Returns

Promise<EventRuleResponse[]>

Implementation of

EventsBindings.searchEventRules

---

searchFolder()

searchFolder: (wid, id, params) => Promise<FolderSearchResultResponse[]>

Defined in: packages/sdk/src/client/client.ts:772

Search for content within a folder using semantic search.

Parameters

wid

string

id

number

params

FolderSearchParams

Returns

Promise<FolderSearchResultResponse[]>

Implementation of

FilesBindings.searchFolder

---

searchHubspotRecords()

searchHubspotRecords: (wid, data) => Promise<HubSpotSearchResponse>

Defined in: packages/sdk/src/client/client.ts:1223

Parameters

wid

string

data

HubSpotSearchRequest

Returns

Promise<HubSpotSearchResponse>

Implementation of

IntegrationsBindings.searchHubspotRecords

---

searchSalesforceRecords()

searchSalesforceRecords: (wid, data) => Promise<SalesforceSearchResponse>

Defined in: packages/sdk/src/client/client.ts:1206

Parameters

wid

string

data

SalesforceSearchRequest

Returns

Promise<SalesforceSearchResponse>

Implementation of

IntegrationsBindings.searchSalesforceRecords

---

selectCurrentAssignmentTask()

selectCurrentAssignmentTask: (wid, id, assignmentTaskId) => Promise<void>

Defined in: packages/sdk/src/client/client.ts:694

Set the current active task for an assignment.

Parameters

wid

string

id

number

assignmentTaskId

number

Returns

Promise<void>

Implementation of

AuthBindings.selectCurrentAssignmentTask

---

sendAssistantMessage()

sendAssistantMessage: (wid, chatId, message, toolCalls?) => Promise<{ content: string; message: string; message_id: string; message_uuid: string; received_at: string | null; role: string; success: boolean; }>

Defined in: packages/sdk/src/client/client.ts:196

Send a message as the assistant in a chat, optionally including tool calls.

Parameters

wid

string

chatId

string | number

message

string

toolCalls?

object[]

Returns

Promise<{ content: string; message: string; message_id: string; message_uuid: string; received_at: string | null; role: string; success: boolean; }>

Implementation of

ChatsBindings.sendAssistantMessage

---

sendChatMessage()

sendChatMessage: (wid, chatId, content) => Promise<ChatMessage>

Defined in: packages/sdk/src/client/client.ts:204

Send a user message in a chat (works for DM and regular chats).

Parameters

wid

string

chatId

number

content

string

Returns

Promise<ChatMessage>

Implementation of

ChatsBindings.sendChatMessage

---

sendEmailVerification()

sendEmailVerification: (email, organizationUuid?) => Promise<SMSLoginResponse>

Defined in: packages/sdk/src/client/client.ts:656

Send a verification code to the given email address for login.

Parameters

email

string

organizationUuid?

string

Returns

Promise<SMSLoginResponse>

Implementation of

AuthBindings.sendEmailVerification

---

sendInboxEmail()

sendInboxEmail: (wid, inboxId, body) => Promise<Email>

Defined in: packages/sdk/src/client/client.ts:938

Compose and send a new email from an inbox.

Parameters

wid

string

inboxId

number

body

EmailSendRequest

Returns

Promise<Email>

Implementation of

CommunicationsBindings.sendInboxEmail

---

sendMemberPhoneConfirmation()

sendMemberPhoneConfirmation: (wid, memberId) => Promise<{ status: string; }>

Defined in: packages/sdk/src/client/client.ts:286

Send the member an SMS asking them to confirm their phone number. When they reply, a trusted phone auth binding is created so they can use SMS as themselves without an account (member-attested alternative to the members:admin "Trusted" override).

Parameters

wid

string

memberId

number

Returns

Promise<{ status: string; }>

Implementation of

MembersBindings.sendMemberPhoneConfirmation

---

sendOperatorMessage()

sendOperatorMessage: (wid, chatId, content) => Promise<{ content: string; createdAt: string | null; id: number; role: string; uuid: string | null; }>

Defined in: packages/sdk/src/client/client.ts:512

Send a message in an operator chat.

Parameters

wid

string

chatId

number

content

string

Returns

Promise<{ content: string; createdAt: string | null; id: number; role: string; uuid: string | null; }>

Implementation of

OperatorBindings.sendOperatorMessage

---

setDefaultGooglePlatformAccount()

setDefaultGooglePlatformAccount: (wid, connectionUuid, credentialUuid) => Promise<{ accounts: unknown[]; total: number; }>

Defined in: packages/sdk/src/client/client.ts:1249

List distinct MemberField.key values scoped to a connection (GRA-2920). Drives the Monday custom-match "Custom fields" picker.

Returns only the set of keys already in use on this connection; values are intentionally never exposed. Operators can also add a new key via the UI's "Add custom field key" free-text action.

Parameters

wid

string

connectionUuid

string

credentialUuid

string

Returns

Promise<{ accounts: unknown[]; total: number; }>

Implementation of

IntegrationsBindings.setDefaultGooglePlatformAccount

---

setDefaultMyCustomerPaymentMethod()

setDefaultMyCustomerPaymentMethod: (uuid, paymentMethodId) => Promise<{ message: string; success: boolean; }>

Defined in: packages/sdk/src/client/client.ts:1278

Parameters

uuid

string

paymentMethodId

string

Returns

Promise<{ message: string; success: boolean; }>

Implementation of

CustomersBindings.setDefaultMyCustomerPaymentMethod

---

setMemberWorkflowVoice()

setMemberWorkflowVoice: (wid, memberId, workflowId, body) => Promise<WorkflowVoiceRowResponse>

Defined in: packages/sdk/src/client/client.ts:270

Set the member's preferred voice for one workflow (Custom Voice).

Parameters

wid

string

memberId

number

workflowId

number

body

SetWorkflowVoiceRequest

Returns

Promise<WorkflowVoiceRowResponse>

Implementation of

MembersBindings.setMemberWorkflowVoice

---

setPassword()

setPassword: (newPassword) => Promise<{ message: string; success: boolean; }>

Defined in: packages/sdk/src/client/client.ts:659

Set a password for an account that does not yet have one.

Parameters

newPassword

string

Returns

Promise<{ message: string; success: boolean; }>

Implementation of

AuthBindings.setPassword

---

setupTOTP()

setupTOTP: (data) => Promise<TOTPSetupResponse>

Defined in: packages/sdk/src/client/client.ts:668

Initiate TOTP two-factor setup and receive the secret and QR code URI.

Parameters

data

SetupTOTPRequest

Returns

Promise<TOTPSetupResponse>

Implementation of

AuthBindings.setupTOTP

---

setupWebAuthn()

setupWebAuthn: (data) => Promise<any>

Defined in: packages/sdk/src/client/client.ts:670

Initiate WebAuthn (passkey/security key) two-factor setup.

Parameters

data

SetupWebAuthnRequest

Returns

Promise<any>

Implementation of

AuthBindings.setupWebAuthn

---

siteGoogleOAuthInitiate()

siteGoogleOAuthInitiate: (wid, siteUuid, origin) => Promise<{ authorizationUrl: string; }>

Defined in: packages/sdk/src/client/client.ts:727

Initiate Google OAuth flow for site-specific authentication.

Parameters

wid

string

siteUuid

string

origin

string

Returns

Promise<{ authorizationUrl: string; }>

Implementation of

SitesBindings.siteGoogleOAuthInitiate

---

siteSendEmailCode()

siteSendEmailCode: (wid, siteUuid, email) => Promise<{ message: string; success: boolean; }>

Defined in: packages/sdk/src/client/client.ts:725

Send an email verification code for site-specific authentication.

Parameters

wid

string

siteUuid

string

email

string

Returns

Promise<{ message: string; success: boolean; }>

Implementation of

SitesBindings.siteSendEmailCode

---

siteSendPhoneCode()

siteSendPhoneCode: (wid, siteUuid, phoneNumber) => Promise<{ message: string; success: boolean; }>

Defined in: packages/sdk/src/client/client.ts:724

Send a phone verification code for site-specific authentication.

Parameters

wid

string

siteUuid

string

phoneNumber

string

Returns

Promise<{ message: string; success: boolean; }>

Implementation of

SitesBindings.siteSendPhoneCode

---

siteSignup()

siteSignup: (wid, siteUuid) => Promise<SiteSignupResponse>

Defined in: packages/sdk/src/client/client.ts:723

Sign up a new user through a site's public registration.

Parameters

wid

string

siteUuid

string

Returns

Promise<SiteSignupResponse>

Implementation of

SitesBindings.siteSignup

---

siteVerifyCode()

siteVerifyCode: (wid, siteUuid, code, phoneNumber?, email?) => Promise<{ accountId: number; availableTwoFactorMethods?: unknown[] | null; memberId?: number | null; requiresTwoFactor?: boolean; token: string; }>

Defined in: packages/sdk/src/client/client.ts:726

Verify a phone or email code and complete site authentication.

When the account has 2FA enrolled, the backend returns a temporary token with requiresTwoFactor: true and this method does not mint full session cookies — the caller must complete the 2FA challenge (same handoff as public-site Google OAuth).

Parameters

wid

string

siteUuid

string

code

string

phoneNumber?

string

email?

string

Returns

Promise<{ accountId: number; availableTwoFactorMethods?: unknown[] | null; memberId?: number | null; requiresTwoFactor?: boolean; token: string; }>

Implementation of

SitesBindings.siteVerifyCode

---

skipStep()

skipStep: (wid, journeyId, stepUuid, data) => Promise<MemberJourneyStep>

Defined in: packages/sdk/src/client/client.ts:479

Skip a journey step in the current execution context.

Parameters

wid

string

journeyId

number

stepUuid

string

data?

SkipStepFormData = {}

Returns

Promise<MemberJourneyStep>

Implementation of

JourneysBindings.skipStep

---

startConfluenceOAuth()

startConfluenceOAuth: (wid) => Promise<ConfluenceConnectionStatus>

Defined in: packages/sdk/src/client/client.ts:1178

Parameters

wid

string

Returns

Promise<ConfluenceConnectionStatus>

Implementation of

IntegrationsBindings.startConfluenceOAuth

---

startHubspotOAuth()

startHubspotOAuth: (wid) => Promise<HubspotConnectionStatus>

Defined in: packages/sdk/src/client/client.ts:1212

Parameters

wid

string

Returns

Promise<HubspotConnectionStatus>

Implementation of

IntegrationsBindings.startHubspotOAuth

---

startPromoPlanTrial()

startPromoPlanTrial: (request) => Promise<PromoPlanTrialResponse>

Defined in: packages/sdk/src/client/client.ts:567

Provision the one-month direct organization plan carried by a promo code.

Parameters

request

PromoPlanTrialRequest

Returns

Promise<PromoPlanTrialResponse>

Implementation of

WorkspacesBindings.startPromoPlanTrial

---

startSalesforceOAuth()

startSalesforceOAuth: (wid) => Promise<SalesforceConnectionStatus>

Defined in: packages/sdk/src/client/client.ts:1190

Parameters

wid

string

Returns

Promise<SalesforceConnectionStatus>

Implementation of

IntegrationsBindings.startSalesforceOAuth

---

startSyncRun()

startSyncRun: (wid, connectionId, options?) => Promise<Response>

Defined in: packages/sdk/src/client/client.ts:1235

Start a sync run. Returns the raw Response (SSE stream). Callers should read the stream for sync_run and sync_item events.

Pass entityType to scope the run to a single entity type (members or records). When omitted, the run covers every enabled entity type on the connection.

Pass boardId together with entityType to further scope the run to a single board mapping within that entity — useful for isolating test/debug runs to one board.

Parameters

wid

string

connectionId

number

options?

boardId?

string

dryRun?

boolean

entityType?

SyncEntityType

recordLimit?

number

Preview cap (1..200). Server enforces dryRun=true when this is set. Omit for uncapped runs.

resetCheckpoints?

boolean

Returns

Promise<Response>

Implementation of

IntegrationsBindings.startSyncRun

---

startTestChatRun()

startTestChatRun: (wid, workflowId, data) => Promise<StartTestChatRunResponse>

Defined in: packages/sdk/src/client/client.ts:367

Parameters

wid

string

workflowId

number

data?

StartTestChatRunRequest = {}

Returns

Promise<StartTestChatRunResponse>

Implementation of

QualificationsBindings.startTestChatRun

---

submitBusinessProfile()

submitBusinessProfile: (orgUuid, legalEntityUuid?) => Promise<BusinessProfileSubmitResponse>

Defined in: packages/sdk/src/client/client.ts:613

Submit the business profile to Twilio for review. Server re-evaluates compliance live and returns 412 if the profile is not currently compliant; returns 409 if a review is already in flight.

Parameters

orgUuid

string

legalEntityUuid?

string | null

Returns

Promise<BusinessProfileSubmitResponse>

Implementation of

OrgBindings.submitBusinessProfile

---

suggestPronunciations()

suggestPronunciations: (term, language?) => Promise<string[]>

Defined in: packages/sdk/src/client/client.ts:1262

Get AI-suggested respellings for a given term.

Parameters

term

string

language?

string

Returns

Promise<string[]>

Implementation of

PronunciationsBindings.suggestPronunciations

---

summarizeChat()

summarizeChat: (wid, id, updateLabels?) => Promise<ChatResponse>

Defined in: packages/sdk/src/client/client.ts:190

Generate an AI summary for a chat, optionally updating its labels.

Parameters

wid

string

id

number

updateLabels?

boolean

Returns

Promise<ChatResponse>

Implementation of

ChatsBindings.summarizeChat

---

switchMember()

switchMember: (wid, memberUuid) => Promise<WorkspaceMemberResponse>

Defined in: packages/sdk/src/client/client.ts:273

Switch to a different member identity owned by the current member. Sets the actingAsMemberUuid cookie for subsequent requests. Uses UUID (not ID) to prevent cross-workspace identity confusion.

Parameters

wid

string

memberUuid

string

Returns

Promise<WorkspaceMemberResponse>

Implementation of

MembersBindings.switchMember

---

syncCalendarWithGoogle()

syncCalendarWithGoogle: (wid, calendarId) => Promise<SyncCalendarResponse>

Defined in: packages/sdk/src/client/client.ts:899

Trigger a manual sync between a calendar and its linked Google Calendar.

Parameters

wid

string

calendarId

number

Returns

Promise<SyncCalendarResponse>

Implementation of

CalendarsBindings.syncCalendarWithGoogle

---

syncCalendarWithHealthie()

syncCalendarWithHealthie: (wid, calendarId) => Promise<LinkCalendarToHealthieResponse>

Defined in: packages/sdk/src/client/client.ts:1166

Parameters

wid

string

calendarId

number

Returns

Promise<LinkCalendarToHealthieResponse>

Implementation of

IntegrationsBindings.syncCalendarWithHealthie

---

syncVoiceTrustProducts()

syncVoiceTrustProducts: (orgUuid, legalEntityUuid) => Promise<SyncVoiceTrustProductsResponse>

Defined in: packages/sdk/src/client/client.ts:621

Reconcile trust product state against Twilio (discovery + status refresh). Returns the refreshed products plus which product keys were newly discovered. Responds 409 when another Trust Hub operation holds this legal entity's lock, failing fast rather than queueing.

No Retry-After is sent, deliberately (#23601): holders range from a sub-second JSONB write to a multi-minute Twilio sequence, so no interval would be honest. Back off on your own schedule, and re-read before retrying — the operation you collided with may have committed SIDs.

Parameters

orgUuid

string

legalEntityUuid

string

Returns

Promise<SyncVoiceTrustProductsResponse>

Implementation of

OrgBindings.syncVoiceTrustProducts

---

testFhirConnection()

testFhirConnection: (wid, connectionId) => Promise<{ message: string; success: boolean; }>

Defined in: packages/sdk/src/client/client.ts:1124

Test a FHIR connection.

Parameters

wid

string

connectionId

number

Returns

Promise<{ message: string; success: boolean; }>

Implementation of

IntegrationsBindings.testFhirConnection

---

testMcpServerConnection()

testMcpServerConnection: (wid, serverId) => Promise<McpTestConnectionResponse>

Defined in: packages/sdk/src/client/client.ts:979

Test connection to an MCP server.

Parameters

wid

string

serverId

number

Returns

Promise<McpTestConnectionResponse>

Implementation of

ToolkitsBindings.testMcpServerConnection

---

testMondayConnection()

testMondayConnection: (wid) => Promise<{ accountName?: string; status: string; userName?: string; }>

Defined in: packages/sdk/src/client/client.ts:1061

Parameters

wid

string

Returns

Promise<{ accountName?: string; status: string; userName?: string; }>

Implementation of

IntegrationsBindings.testMondayConnection

---

testRunJourney()

testRunJourney: (wid, journeyId, memberId) => Promise<JourneyTestRunResponse>

Defined in: packages/sdk/src/client/client.ts:480

Dry-run heartbeat CEL evaluation for an enrolled member.

Evaluates all PENDING steps exactly as the heartbeat would, but writes no state changes. Returns step-by-step results for debugging stuck members.

Parameters

wid

string

journeyId

number

memberId

number

Returns

Promise<JourneyTestRunResponse>

Implementation of

JourneysBindings.testRunJourney

---

testWebhook()

testWebhook: (wid, id, request) => Promise<TestWebhookResponse>

Defined in: packages/sdk/src/client/client.ts:801

Send a one-off test webhook for an existing webhook event rule.

Parameters

wid

string

id

number

request

TestWebhookRequest

Returns

Promise<TestWebhookResponse>

Implementation of

EventsBindings.testWebhook

---

toggleFieldIndex()

toggleFieldIndex: (wid, dataTypeId, fieldSlug, shouldIndex) => Promise<{ indexStatus?: string; message: string; status: string; }>

Defined in: packages/sdk/src/client/client.ts:251

Toggle search indexing for a data type field.

Parameters

wid

string

dataTypeId

number

fieldSlug

string

shouldIndex

boolean

Returns

Promise<{ indexStatus?: string; message: string; status: string; }>

Implementation of

DataTypesBindings.toggleFieldIndex

---

transitionChatInteractionSession()

transitionChatInteractionSession: (wid, chatId, sessionId, request) => Promise<InteractionSessionResponse>

Defined in: packages/sdk/src/client/client.ts:183

End one mode session and append its replacement in the same Chat.

Parameters

wid

string

chatId

number

sessionId

string

request

TransitionInteractionSessionRequest

Returns

Promise<InteractionSessionResponse>

Implementation of

ChatsBindings.transitionChatInteractionSession

---

unarchiveAgent()

unarchiveAgent: (wid, id) => Promise<AgentResponse>

Defined in: packages/sdk/src/client/client.ts:354

Restore an archived agent back to active status.

Parameters

wid

string

id

number

Returns

Promise<AgentResponse>

Implementation of

AgentsBindings.unarchiveAgent

---

unarchiveChat()

unarchiveChat: (wid, id) => Promise<void>

Defined in: packages/sdk/src/client/client.ts:180

Unarchive a chat.

Parameters

wid

string

id

number

Returns

Promise<void>

Implementation of

ChatsBindings.unarchiveChat

---

unarchiveDataType()

unarchiveDataType: (wid, id) => Promise<{ status: string; }>

Defined in: packages/sdk/src/client/client.ts:242

Restore an archived data type back to active status.

Parameters

wid

string

id

number

Returns

Promise<{ status: string; }>

Implementation of

DataTypesBindings.unarchiveDataType

---

unarchiveMember()

unarchiveMember: (wid, memberId) => Promise<WorkspaceMemberResponse>

Defined in: packages/sdk/src/client/client.ts:285

Unarchive a previously archived workspace member.

Parameters

wid

string

memberId

number

Returns

Promise<WorkspaceMemberResponse>

Implementation of

MembersBindings.unarchiveMember

---

unarchivePersona()

unarchivePersona: (wid, id) => Promise<Persona>

Defined in: packages/sdk/src/client/client.ts:383

Parameters

wid

string

id

number

Returns

Promise<Persona>

Implementation of

PersonasBindings.unarchivePersona

---

unarchiveStep()

unarchiveStep: (wid, journeyId, stepUuid) => Promise<JourneyStepAuthoringResponse>

Defined in: packages/sdk/src/client/client.ts:462

Unarchive a step and backfill active enrollments. Idempotent — repeated calls are harmless. The response's backfilledEnrollmentCount reports how many active enrollments received a new step row; a root step may become eligible for all of them on the next journey sweep.

Parameters

wid

string

journeyId

number

stepUuid

string

Returns

Promise<JourneyStepAuthoringResponse>

Implementation of

JourneysBindings.unarchiveStep

---

unarchiveTask()

unarchiveTask: (wid, id) => Promise<Task>

Defined in: packages/sdk/src/client/client.ts:153

Restore an archived task back to active status.

Parameters

wid

string

id

number

Returns

Promise<Task>

Implementation of

TasksBindings.unarchiveTask

---

unarchiveWorkflow()

unarchiveWorkflow: (wid, id) => Promise<{ status: string; }>

Defined in: packages/sdk/src/client/client.ts:832

Unarchive a previously archived workflow.

Parameters

wid

string

id

number

Returns

Promise<{ status: string; }>

Implementation of

WorkflowsBindings.unarchiveWorkflow

---

unenrollMembers()

unenrollMembers: (wid, journeyId, data) => Promise<MemberJourney[]>

Defined in: packages/sdk/src/client/client.ts:471

Unenroll one or more members from a journey.

Parameters

wid

string

journeyId

number

data

UnenrollMemberFormData

Returns

Promise<MemberJourney[]>

Implementation of

JourneysBindings.unenrollMembers

---

unlinkCalendarFromGoogle()

unlinkCalendarFromGoogle: (wid, calendarId) => Promise<UnlinkCalendarResponse>

Defined in: packages/sdk/src/client/client.ts:898

Unlink a calendar from its connected Google Calendar.

Parameters

wid

string

calendarId

number

Returns

Promise<UnlinkCalendarResponse>

Implementation of

CalendarsBindings.unlinkCalendarFromGoogle

---

unlinkCalendarFromHealthie()

unlinkCalendarFromHealthie: (wid, calendarId) => Promise<{ status: string; }>

Defined in: packages/sdk/src/client/client.ts:1165

Parameters

wid

string

calendarId

number

Returns

Promise<{ status: string; }>

Implementation of

IntegrationsBindings.unlinkCalendarFromHealthie

---

unlinkCredential()

unlinkCredential: (wid, credentialId) => Promise<void>

Defined in: packages/sdk/src/client/client.ts:1093

Unlink a credential from the current member's account.

Parameters

wid

string

credentialId

number

Returns

Promise<void>

Implementation of

IntegrationsBindings.unlinkCredential

---

unlinkMemberFromHealthie()

unlinkMemberFromHealthie: (wid, memberId) => Promise<UnlinkMemberFromHealthieResponse>

Defined in: packages/sdk/src/client/client.ts:1170

Parameters

wid

string

memberId

number

Returns

Promise<UnlinkMemberFromHealthieResponse>

Implementation of

IntegrationsBindings.unlinkMemberFromHealthie

---

unlinkMemberFromHubspot()

unlinkMemberFromHubspot: (wid, memberId) => Promise<{ memberId: number; status: string; }>

Defined in: packages/sdk/src/client/client.ts:1221

Parameters

wid

string

memberId

number

Returns

Promise<{ memberId: number; status: string; }>

Implementation of

IntegrationsBindings.unlinkMemberFromHubspot

---

unlinkMemberFromMonday()

unlinkMemberFromMonday: (wid, memberId, boardId) => Promise<{ memberId: number; status: string; }>

Defined in: packages/sdk/src/client/client.ts:1075

Parameters

wid

string

memberId

number

boardId

string

Returns

Promise<{ memberId: number; status: string; }>

Implementation of

IntegrationsBindings.unlinkMemberFromMonday

---

unlinkMemberFromSalesforce()

unlinkMemberFromSalesforce: (wid, memberId) => Promise<{ memberId: number; status: string; }>

Defined in: packages/sdk/src/client/client.ts:1199

Parameters

wid

string

memberId

number

Returns

Promise<{ memberId: number; status: string; }>

Implementation of

IntegrationsBindings.unlinkMemberFromSalesforce

---

unregisterPushSubscription()

unregisterPushSubscription: (wid, endpoint) => Promise<{ deleted: boolean; }>

Defined in: packages/sdk/src/client/client.ts:629

Unregister a Web Push subscription by endpoint URL.

Parameters

wid

string

endpoint

string

Returns

Promise<{ deleted: boolean; }>

Implementation of

WorkspacesBindings.unregisterPushSubscription

---

updateA2PCampaignConfig()

updateA2PCampaignConfig: (orgUuid, brandUuid, data) => Promise<A2PCampaignConfigResponse>

Defined in: packages/sdk/src/client/client.ts:625

Partial-update a brand's A2P campaign config. Returns the freshly resolved config so the editor's live preview updates without a second round-trip.

Parameters

orgUuid

string

brandUuid

string

data

UpdateA2PCampaignConfigRequest

Returns

Promise<A2PCampaignConfigResponse>

Implementation of

OrgBindings.updateA2PCampaignConfig

---

updateAbility()

updateAbility: (wid, abilityUuid, body) => Promise<AbilityResponse>

Defined in: packages/sdk/src/client/client.ts:159

Update a configured ability (configure / enable / disable) by UUID.

Parameters

wid

string

abilityUuid

string

body

Record<string, unknown>

Returns

Promise<AbilityResponse>

Implementation of

TasksBindings.updateAbility

---

updateAgent()

updateAgent: (wid, id, agent) => Promise<AgentResponse>

Defined in: packages/sdk/src/client/client.ts:351

Update an existing agent.

Parameters

wid

string

id

number

agent

UpdateAgentRequest

Returns

Promise<AgentResponse>

Implementation of

AgentsBindings.updateAgent

---

updateApp()

updateApp: (appId, request) => Promise<App>

Defined in: packages/sdk/src/client/client.ts:1026

Update an app

Parameters

appId

string

request

UpdateAppRequest

Returns

Promise<App>

Implementation of

AppsBindings.updateApp

---

updateAssignment()

updateAssignment: (wid, id, assignment) => Promise<Assignment>

Defined in: packages/sdk/src/client/client.ts:691

Update an assignment by ID.

Parameters

wid

string

id

number

assignment

UpdateAssignmentFormData

Returns

Promise<Assignment>

Implementation of

AuthBindings.updateAssignment

---

updateBuilder()

updateBuilder: (builderId, request) => Promise<BuilderResponse>

Defined in: packages/sdk/src/client/client.ts:1033

Update an existing builder

Parameters

builderId

string

request

UpdateBuilderRequest

Returns

Promise<BuilderResponse>

Implementation of

AppsBindings.updateBuilder

---

updateBusinessProfile()

updateBusinessProfile: (orgUuid, data, legalEntityUuid?) => Promise<BusinessProfile>

Defined in: packages/sdk/src/client/client.ts:612

Upsert the org's business profile. Idempotent via cached SIDs. Returns a fresh BusinessProfileResponse on success — including the compliance evaluation result so the frontend can immediately enable Submit without a second round-trip.

Parameters

orgUuid

string

data

UpdateBusinessProfileRequest

legalEntityUuid?

string | null

Returns

Promise<BusinessProfile>

Implementation of

OrgBindings.updateBusinessProfile

---

updateCalendar()

updateCalendar: (wid, id, calendar) => Promise<Calendar>

Defined in: packages/sdk/src/client/client.ts:872

Update a calendar's configuration.

Parameters

wid

string

id

number

calendar

Partial<CalendarFormData>

Returns

Promise<Calendar>

Implementation of

CalendarsBindings.updateCalendar

---

updateCalendarEvent()

updateCalendarEvent: (wid, eventId, event) => Promise<EventResponse>

Defined in: packages/sdk/src/client/client.ts:883

Update an existing calendar event.

Parameters

wid

string

eventId

number

event

Partial<CalendarEventFormData>

Returns

Promise<EventResponse>

Implementation of

CalendarsBindings.updateCalendarEvent

---

updateCalendarEventType()

updateCalendarEventType: (wid, id, eventType) => Promise<EventTypeResponse>

Defined in: packages/sdk/src/client/client.ts:890

Update an existing calendar event type.

Parameters

wid

string

id

number

eventType

Partial<CalendarEventTypeFormData>

Returns

Promise<EventTypeResponse>

Implementation of

CalendarsBindings.updateCalendarEventType

---

updateCalendarSchedule()

updateCalendarSchedule: (wid, calendarId, scheduleId, schedule) => Promise<CalendarSchedule>

Defined in: packages/sdk/src/client/client.ts:876

Update an existing calendar schedule.

Parameters

wid

string

calendarId

number

scheduleId

number

schedule

Partial<CalendarScheduleFormData>

Returns

Promise<CalendarSchedule>

Implementation of

CalendarsBindings.updateCalendarSchedule

---

updateChat()

updateChat: (wid, id, chat) => Promise<ChatResponse>

Defined in: packages/sdk/src/client/client.ts:186

Update a chat's properties.

Parameters

wid

string

id

number

chat

UpdateChatRequest

Returns

Promise<ChatResponse>

Implementation of

ChatsBindings.updateChat

---

updateChatFilter()

updateChatFilter: (wid, id, filter) => Promise<ChatFilterResponse>

Defined in: packages/sdk/src/client/client.ts:216

Update a chat filter.

Parameters

wid

string

id

number

filter

Partial<ChatFilterFormData>

Returns

Promise<ChatFilterResponse>

Implementation of

ChatsBindings.updateChatFilter

---

updateChatLabel()

updateChatLabel: (wid, id, label) => Promise<ChatLabelResponse>

Defined in: packages/sdk/src/client/client.ts:210

Update a chat label.

Parameters

wid

string

id

number

label

Partial<ChatLabelFormData>

Returns

Promise<ChatLabelResponse>

Implementation of

ChatsBindings.updateChatLabel

---

updateChatModelOverride()

updateChatModelOverride: (wid, id, override) => Promise<ChatModelOverrideResponse>

Defined in: packages/sdk/src/client/client.ts:188

Pin or reset the per-chat chat/realtime model snapshot. A concrete model id pins that model; an empty/null id resets it to the agent's current default. Only fields present in the payload are touched.

Parameters

wid

string

id

number

override

UpdateChatModelOverrideRequest

Returns

Promise<ChatModelOverrideResponse>

Implementation of

ChatsBindings.updateChatModelOverride

---

updateChatMute()

updateChatMute: (wid, id, muted, muteReason?, muteExpiresOnInbound?) => Promise<ChatMuteUpdateResponse>

Defined in: packages/sdk/src/client/client.ts:189

Update the mute status of a chat.

Parameters

wid

string

id

number

muted

boolean

muteReason?

ChatMuteReason

muteExpiresOnInbound?

boolean

Returns

Promise<ChatMuteUpdateResponse>

Implementation of

ChatsBindings.updateChatMute

---

updateClientWorkspace()

updateClientWorkspace: (wid, workspaceId, data) => Promise<ClientWorkspace>

Defined in: packages/sdk/src/client/client.ts:559

Update a client workspace's name or slug.

Parameters

wid

string

workspaceId

number

data

name?

string

slug?

string

Returns

Promise<ClientWorkspace>

Implementation of

WorkspacesBindings.updateClientWorkspace

---

updateConnection()

updateConnection: (wid, journeyId, connectionId, data) => Promise<JourneyStepConnectionAuthoringResponse>

Defined in: packages/sdk/src/client/client.ts:464

Update a connection (edge) by ID.

Parameters

wid

string

journeyId

number

connectionId

number

data

Partial<JourneyStepConnectionFormData>

Returns

Promise<JourneyStepConnectionAuthoringResponse>

Implementation of

JourneysBindings.updateConnection

---

updateConnectionSyncConfig()

updateConnectionSyncConfig: (wid, connectionId, data) => Promise<ConnectionSyncConfig>

Defined in: packages/sdk/src/client/client.ts:1233

Parameters

wid

string

connectionId

number

data

ConnectionSyncConfig

Returns

Promise<ConnectionSyncConfig>

Implementation of

IntegrationsBindings.updateConnectionSyncConfig

---

updateConsent()

updateConsent: (consents) => Promise<ConsentStateResponse>

Defined in: packages/sdk/src/client/client.ts:687

Record consent decisions (batch).

Parameters

consents

object[]

Returns

Promise<ConsentStateResponse>

Implementation of

AuthBindings.updateConsent

---

updateCurrentMember()

updateCurrentMember: (wid, member) => Promise<WorkspaceMemberResponse>

Defined in: packages/sdk/src/client/client.ts:275

Update the currently authenticated member's profile.

Parameters

wid

string

member

Partial<MemberFormData>

Returns

Promise<WorkspaceMemberResponse>

Implementation of

MembersBindings.updateCurrentMember

---

updateCustomTool()

updateCustomTool: (wid, toolkitId, toolId, data) => Promise<CustomTool>

Defined in: packages/sdk/src/client/client.ts:967

Update an existing custom tool

Parameters

wid

string

toolkitId

number

toolId

number

data

CustomToolUpdateFormData

Returns

Promise<CustomTool>

Implementation of

ToolkitsBindings.updateCustomTool

---

updateCustomToolkit()

updateCustomToolkit: (wid, toolkitId, data) => Promise<CustomToolkit>

Defined in: packages/sdk/src/client/client.ts:962

Update an existing custom toolkit

Parameters

wid

string

toolkitId

number

data

CustomToolkitUpdateFormData

Returns

Promise<CustomToolkit>

Implementation of

ToolkitsBindings.updateCustomToolkit

---

updateDashboard()

updateDashboard: (wid, id, body) => Promise<DashboardResponse>

Defined in: packages/sdk/src/client/client.ts:400

Update a dashboard's name, position, or widget list (full replace).

Parameters

wid

string

id

number

body

UpdateDashboardRequest

Returns

Promise<DashboardResponse>

Implementation of

DashboardsBindings.updateDashboard

---

updateDataRecord()

updateDataRecord: (wid, dataTypeId, recordId, record) => Promise<DataRecordResponse>

Defined in: packages/sdk/src/client/client.ts:247

Update an existing data record's field values.

Parameters

wid

string

dataTypeId

number

recordId

number

record

DataRecordFormData

Returns

Promise<DataRecordResponse>

Implementation of

DataTypesBindings.updateDataRecord

---

updateDataRecordFilter()

updateDataRecordFilter: (wid, filterId, data) => Promise<DataRecordFilterResponse>

Defined in: packages/sdk/src/client/client.ts:260

Update a saved data-record filter.

Parameters

wid

string

filterId

number

data

Partial<DataRecordFilterFormData>

Returns

Promise<DataRecordFilterResponse>

Implementation of

DataTypesBindings.updateDataRecordFilter

---

updateDataType()

updateDataType: (wid, id, dataType) => Promise<DataTypeResponse>

Defined in: packages/sdk/src/client/client.ts:239

Update an existing data type definition.

Parameters

wid

string

id

number

dataType

Partial<DataTypeFormData>

Returns

Promise<DataTypeResponse>

Implementation of

DataTypesBindings.updateDataType

---

updateDevice()

updateDevice: (deviceUuid, body) => Promise<DeviceResponse>

Defined in: packages/sdk/src/client/client.ts:990

Update display name and/or LAN capability flags on an owned device.

Parameters

deviceUuid

string

body

UpdateDeviceRequest

Returns

Promise<DeviceResponse>

Implementation of

DevicesBindings.updateDevice

---

updateDiscordBot()

updateDiscordBot: (wid, botId, data) => Promise<DiscordBot>

Defined in: packages/sdk/src/client/client.ts:1085

Update an existing Discord bot configuration.

Parameters

wid

string

botId

number

data

UpdateDiscordBotRequest

Returns

Promise<DiscordBot>

Implementation of

IntegrationsBindings.updateDiscordBot

---

updateEventAttendee()

updateEventAttendee: (wid, eventId, attendeeId, update) => Promise<void>

Defined in: packages/sdk/src/client/client.ts:886

Update an attendee's details on a calendar event.

Parameters

wid

string

eventId

number

attendeeId

number

update

UpdateAttendeeRequest

Returns

Promise<void>

Implementation of

CalendarsBindings.updateEventAttendee

---

updateEventRule()

updateEventRule: (wid, id, rule) => Promise<EventRuleResponse>

Defined in: packages/sdk/src/client/client.ts:799

Update an existing event rule.

Parameters

wid

string

id

number

rule

UpdateEventRuleFormData

Returns

Promise<EventRuleResponse>

Implementation of

EventsBindings.updateEventRule

---

updateExperiment()

updateExperiment: (wid, experimentId, data) => Promise<Experiment>

Defined in: packages/sdk/src/client/client.ts:490

Update experiment metadata or lifecycle status.

Parameters

wid

string

experimentId

number

data

ExperimentUpdateData

Returns

Promise<Experiment>

Implementation of

ExperimentsBindings.updateExperiment

---

updateExperimentAssignment()

updateExperimentAssignment: (wid, experimentId, memberId, data) => Promise<MemberExperimentAssignment>

Defined in: packages/sdk/src/client/client.ts:498

Move an assigned member to a different experiment group.

Parameters

wid

string

experimentId

number

memberId

number

data

groupId

number

Returns

Promise<MemberExperimentAssignment>

Implementation of

ExperimentsBindings.updateExperimentAssignment

---

updateExperimentGroup()

updateExperimentGroup: (wid, experimentId, groupId, data) => Promise<ExperimentGroup>

Defined in: packages/sdk/src/client/client.ts:493

Update a group within an experiment.

Parameters

wid

string

experimentId

number

groupId

number

data

ExperimentGroupUpdateData

Returns

Promise<ExperimentGroup>

Implementation of

ExperimentsBindings.updateExperimentGroup

---

updateFhirConnection()

updateFhirConnection: (wid, connectionId, data) => Promise<FhirConnection>

Defined in: packages/sdk/src/client/client.ts:1122

Update an existing FHIR connection configuration.

Parameters

wid

string

connectionId

number

data

UpdateFhirConnectionRequest

Returns

Promise<FhirConnection>

Implementation of

IntegrationsBindings.updateFhirConnection

---

updateFile()

updateFile: (wid, id, file) => Promise<File>

Defined in: packages/sdk/src/client/client.ts:758

Update an existing file's metadata.

Parameters

wid

string

id

number

file

Partial<FileFormData>

Returns

Promise<File>

Implementation of

FilesBindings.updateFile

---

updateFileLabel()

updateFileLabel: (wid, id, label) => Promise<FileLabelResponse>

Defined in: packages/sdk/src/client/client.ts:777

Update a file label's properties.

Parameters

wid

string

id

number

label

Partial<FileLabelFormData>

Returns

Promise<FileLabelResponse>

Implementation of

FilesBindings.updateFileLabel

---

updateFileRoles()

updateFileRoles: (wid, fileId, data) => Promise<FileRoleAssociationResponse[]>

Defined in: packages/sdk/src/client/client.ts:780

Update the role associations for a file's sharing permissions.

Parameters

wid

string

fileId

number

data

UpdateFileRoleAssociationsRequest

Returns

Promise<FileRoleAssociationResponse[]>

Implementation of

FilesBindings.updateFileRoles

---

updateFileSharing()

updateFileSharing: (wid, fileId, data) => Promise<FileSharingResponse>

Defined in: packages/sdk/src/client/client.ts:786

Update all sharing settings for a file in a single request.

Parameters

wid

string

fileId

number

data

UpdateFileSharingRequest

Returns

Promise<FileSharingResponse>

Implementation of

FilesBindings.updateFileSharing

---

updateFirstRunState()

updateFirstRunState: (wid, state) => Promise<FirstRunState>

Defined in: packages/sdk/src/client/client.ts:545

Update the first-run onboarding state for a workspace.

Parameters

wid

string

state

FirstRunState

Returns

Promise<FirstRunState>

Implementation of

WorkspacesBindings.updateFirstRunState

---

updateFolder()

updateFolder: (wid, id, directory) => Promise<FileFolderResponse>

Defined in: packages/sdk/src/client/client.ts:769

Update a folder's properties.

Parameters

wid

string

id

number

directory

Partial<FileFolderFormData>

Returns

Promise<FileFolderResponse>

Implementation of

FilesBindings.updateFolder

---

updateFolderRoles()

updateFolderRoles: (wid, folderId, data) => Promise<FileRoleAssociationResponse[]>

Defined in: packages/sdk/src/client/client.ts:784

Update the role associations for a folder's sharing permissions.

Parameters

wid

string

folderId

number

data

UpdateFileRoleAssociationsRequest

Returns

Promise<FileRoleAssociationResponse[]>

Implementation of

FilesBindings.updateFolderRoles

---

updateFolderSharing()

updateFolderSharing: (wid, folderId, data) => Promise<FolderSharingResponse>

Defined in: packages/sdk/src/client/client.ts:787

Update all sharing settings for a folder in a single request.

Parameters

wid

string

folderId

number

data

UpdateFileSharingRequest

Returns

Promise<FolderSharingResponse>

Implementation of

FilesBindings.updateFolderSharing

---

updateGoal()

updateGoal: (wid, journeyId, goalUuid, data) => Promise<JourneyGoalAuthoringResponse>

Defined in: packages/sdk/src/client/client.ts:467

Update an existing goal.

Parameters

wid

string

journeyId

number

goalUuid

string

data

Partial<JourneyGoalFormData>

Returns

Promise<JourneyGoalAuthoringResponse>

Implementation of

JourneysBindings.updateGoal

---

updateInbox()

updateInbox: (wid, id, inbox) => Promise<Inbox>

Defined in: packages/sdk/src/client/client.ts:925

Update an inbox.

Parameters

wid

string

id

number

inbox

InboxUpdateRequest

Returns

Promise<Inbox>

Implementation of

CommunicationsBindings.updateInbox

---

updateInquiry()

updateInquiry: (inquiryId, data) => Promise<InquiryResponse>

Defined in: packages/sdk/src/client/client.ts:1039

Update an inquiry (superuser only)

Parameters

inquiryId

number

data

notes?

string = ...

status?

"in_progress" | "new" | "done" = ...

Returns

Promise<InquiryResponse>

Implementation of

AppsBindings.updateInquiry

---

updateJourney()

updateJourney: (wid, journeyId, data) => Promise<JourneyRead>

Defined in: packages/sdk/src/client/client.ts:457

Update an existing journey. Returns the READ projection (JourneyRead).

executionModel is excluded: it is a CREATE-only field. Flipping a live Journey's engine is a guarded, audited migration operation (Journey v2 plan §3.11), so the server has no update counterpart and sending one here would silently do nothing.

Parameters

wid

string

journeyId

number

data

Partial<Omit<JourneyFormData, "executionModel">>

Returns

Promise<JourneyRead>

Implementation of

JourneysBindings.updateJourney

---

updateJourneyNote()

updateJourneyNote: (wid, journeyId, noteId, data) => Promise<JourneyNoteResponse>

Defined in: packages/sdk/src/client/client.ts:483

Update an existing journey note.

Parameters

wid

string

journeyId

number

noteId

number

data

Partial<JourneyNoteFormData>

Returns

Promise<JourneyNoteResponse>

Implementation of

JourneysBindings.updateJourneyNote

---

updateMcpServer()

updateMcpServer: (wid, serverId, data) => Promise<McpServerResponse>

Defined in: packages/sdk/src/client/client.ts:972

Update an existing MCP server

Parameters

wid

string

serverId

number

data

McpServerUpdateFormData

Returns

Promise<McpServerResponse>

Implementation of

ToolkitsBindings.updateMcpServer

---

updateMember()

updateMember: (wid, memberId, data) => Promise<WorkspaceMemberResponse>

Defined in: packages/sdk/src/client/client.ts:282

Update a workspace member by ID.

Parameters

wid

string

memberId

number

data

UpdateWorkspaceMemberRequest

Returns

Promise<WorkspaceMemberResponse>

Implementation of

MembersBindings.updateMember

---

updateMemberField()

updateMemberField: (wid, memberId, fieldId, request) => Promise<MemberFieldResponse>

Defined in: packages/sdk/src/client/client.ts:316

Update a member field value. Only user-created fields (no service_id) can be modified.

Parameters

wid

string

memberId

number

fieldId

number

request

UpdateMemberFieldRequest

Returns

Promise<MemberFieldResponse>

Implementation of

MembersBindings.updateMemberField

---

updateMemberFilter()

updateMemberFilter: (wid, filterId, data) => Promise<MemberFilterResponse>

Defined in: packages/sdk/src/client/client.ts:295

Update a saved member filter.

Parameters

wid

string

filterId

number

data

Partial<MemberFilterFormData>

Returns

Promise<MemberFilterResponse>

Implementation of

MembersBindings.updateMemberFilter

---

updateMemberLabel()

updateMemberLabel: (wid, id, label) => Promise<MemberLabelResponse>

Defined in: packages/sdk/src/client/client.ts:302

Update a member label.

Parameters

wid

string

id

number

label

Partial<MemberLabelFormData>

Returns

Promise<MemberLabelResponse>

Implementation of

MembersBindings.updateMemberLabel

---

updateMemberRole()

updateMemberRole: (wid, id, memberRole) => Promise<MemberRoleResponse>

Defined in: packages/sdk/src/client/client.ts:308

Update a member role.

Parameters

wid

string

id

number

memberRole

MemberRoleFormData

Returns

Promise<MemberRoleResponse>

Implementation of

MembersBindings.updateMemberRole

---

updateMenuItem()

updateMenuItem: (wid, siteId, itemId, item) => Promise<MenuItemResponse>

Defined in: packages/sdk/src/client/client.ts:741

Update a menu item's properties.

Parameters

wid

string

siteId

number

itemId

number

item

Partial<MenuItemFormData>

Returns

Promise<MenuItemResponse>

Implementation of

SitesBindings.updateMenuItem

---

updateMetric()

updateMetric: (wid, id, data) => Promise<MetricResponse>

Defined in: packages/sdk/src/client/client.ts:390

Parameters

wid

string

id

number

data

UpdateMetricRequest

Returns

Promise<MetricResponse>

---

updateMondaySyncConfig()

updateMondaySyncConfig: (wid, syncConfig) => Promise<MondaySyncConfigResponse>

Defined in: packages/sdk/src/client/client.ts:1070

Parameters

wid

string

syncConfig

Record<string, unknown>

Returns

Promise<MondaySyncConfigResponse>

Implementation of

IntegrationsBindings.updateMondaySyncConfig

---

updateMyCustomer()

updateMyCustomer: (uuid, data) => Promise<MyCustomerResponse>

Defined in: packages/sdk/src/client/client.ts:1273

Parameters

uuid

string

data

UpdateCustomerRequest

Returns

Promise<MyCustomerResponse>

Implementation of

CustomersBindings.updateMyCustomer

---

updateMyPronunciation()

updateMyPronunciation: (id, data) => Promise<PronunciationEntryResponse>

Defined in: packages/sdk/src/client/client.ts:1260

Update a personal pronunciation entry.

Parameters

id

number

data

UpdatePronunciationEntryFormData

Returns

Promise<PronunciationEntryResponse>

Implementation of

PronunciationsBindings.updateMyPronunciation

---

updateMyReseller()

updateMyReseller: (uuid, data) => Promise<MyResellerResponse>

Defined in: packages/sdk/src/client/client.ts:1287

Parameters

uuid

string

data

UpdateResellerRequest

Returns

Promise<MyResellerResponse>

Implementation of

ResellersBindings.updateMyReseller

---

updateNotificationRule()

updateNotificationRule: (wid, ruleId, rule) => Promise<NotificationRule>

Defined in: packages/sdk/src/client/client.ts:943

Update a notification rule.

Parameters

wid

string

ruleId

number

rule

NotificationRuleUpdate

Returns

Promise<NotificationRule>

Implementation of

CommunicationsBindings.updateNotificationRule

---

updateOperatorGroup()

updateOperatorGroup: (wid, groupId, data) => Promise<OperatorGroup>

Defined in: packages/sdk/src/client/client.ts:505

Update an operator group.

Parameters

wid

string

groupId

number

data

UpdateOperatorGroupRequest

Returns

Promise<OperatorGroup>

Implementation of

OperatorBindings.updateOperatorGroup

---

updatePage()

updatePage: (wid, siteId, pageId, page) => Promise<PageResponse>

Defined in: packages/sdk/src/client/client.ts:735

Update a page's content or metadata.

Parameters

wid

string

siteId

number

pageId

number

page

Partial<PageFormData>

Returns

Promise<PageResponse>

Implementation of

SitesBindings.updatePage

---

updatePersona()

updatePersona: (wid, id, data) => Promise<Persona>

Defined in: packages/sdk/src/client/client.ts:381

Parameters

wid

string

id

number

data

UpdatePersonaRequest

Returns

Promise<Persona>

Implementation of

PersonasBindings.updatePersona

---

updatePhoneNumber()

updatePhoneNumber: (wid, id, phoneNumber) => Promise<PhoneNumber>

Defined in: packages/sdk/src/client/client.ts:907

Update a phone number record.

Parameters

wid

string

id

number

phoneNumber

UpdatePhoneNumberRequest

Returns

Promise<PhoneNumber>

Implementation of

CommunicationsBindings.updatePhoneNumber

---

updatePlan()

updatePlan: (wid, slug, plan, update) => Promise<PlanDetailResponse>

Defined in: packages/sdk/src/client/client.ts:753

Typed update of a plan README; absent fields are untouched.

Parameters

wid

string

slug

string

plan

string

update

UpdateProjectDocRequest

Returns

Promise<PlanDetailResponse>

Implementation of

ProjectsBindings.updatePlan

---

updatePlatformApp()

updatePlatformApp: (wid, appUuid, data) => Promise<PlatformAppConnectionResponse>

Defined in: packages/sdk/src/client/client.ts:1246

Update platform app config, enabled status, or name.

Parameters

wid

string

appUuid

string

data

UpdateAppConnectionRequest

Returns

Promise<PlatformAppConnectionResponse>

Implementation of

IntegrationsBindings.updatePlatformApp

---

updateProduct()

updateProduct: (wid, id, updates) => Promise<Product>

Defined in: packages/sdk/src/client/client.ts:570

Update an existing product.

Parameters

wid

string

id

number

updates

any

Returns

Promise<Product>

Implementation of

WorkspacesBindings.updateProduct

---

updateProject()

updateProject: (wid, slug, update) => Promise<ProjectDetailResponse>

Defined in: packages/sdk/src/client/client.ts:752

Typed update of a project README; absent fields are untouched.

Parameters

wid

string

slug

string

update

UpdateProjectDocRequest

Returns

Promise<ProjectDetailResponse>

Implementation of

ProjectsBindings.updateProject

---

updatePronunciationEntry()

updatePronunciationEntry: (orgUuid, id, data) => Promise<PronunciationEntryResponse>

Defined in: packages/sdk/src/client/client.ts:1254

Update an existing organization pronunciation entry.

Parameters

orgUuid

string

id

number

data

UpdatePronunciationEntryFormData

Returns

Promise<PronunciationEntryResponse>

Implementation of

PronunciationsBindings.updatePronunciationEntry

---

updateRoutine()

updateRoutine: (wid, id, routine) => Promise<RoutineResponse>

Defined in: packages/sdk/src/client/client.ts:808

Update an existing routine.

Parameters

wid

string

id

number

routine

UpdateRoutineRequest

Returns

Promise<RoutineResponse>

Implementation of

EventsBindings.updateRoutine

---

updateSalesforceSyncConfig()

updateSalesforceSyncConfig: (wid, data) => Promise<SalesforceSyncConfigResponse>

Defined in: packages/sdk/src/client/client.ts:1202

Parameters

wid

string

data

UpdateSalesforceSyncConfigRequest

Returns

Promise<SalesforceSyncConfigResponse>

Implementation of

IntegrationsBindings.updateSalesforceSyncConfig

---

updateScenario()

updateScenario: (wid, scenarioId, data) => Promise<Scenario>

Defined in: packages/sdk/src/client/client.ts:363

Parameters

wid

string

scenarioId

number

data

UpdateScenarioRequest

Returns

Promise<Scenario>

Implementation of

QualificationsBindings.updateScenario

---

updateSite()

updateSite: (wid, id, site) => Promise<Site>

Defined in: packages/sdk/src/client/client.ts:729

Update a site's configuration.

Parameters

wid

string

id

number

site

Partial<SiteFormData>

Returns

Promise<Site>

Implementation of

SitesBindings.updateSite

---

updateSiteSharing()

updateSiteSharing: (wid, siteId, data) => Promise<SiteSharingResponse>

Defined in: packages/sdk/src/client/client.ts:708

Update a site's sharing settings.

Parameters

wid

string

siteId

number

data

UpdateFileSharingRequest

Returns

Promise<SiteSharingResponse>

Implementation of

SitesBindings.updateSiteSharing

---

updateSlackApp()

updateSlackApp: (wid, appId, data) => Promise<SlackApp>

Defined in: packages/sdk/src/client/client.ts:1101

Update an existing Slack app configuration.

Parameters

wid

string

appId

number

data

UpdateSlackAppRequest

Returns

Promise<SlackApp>

Implementation of

IntegrationsBindings.updateSlackApp

---

updateStep()

updateStep: (wid, journeyId, stepUuid, data) => Promise<JourneyStepAuthoringResponse>

Defined in: packages/sdk/src/client/client.ts:460

Update an existing step.

Parameters

wid

string

journeyId

number

stepUuid

string

data

Partial<JourneyStepFormData>

Returns

Promise<JourneyStepAuthoringResponse>

Implementation of

JourneysBindings.updateStep

---

updateSubscription()

updateSubscription: (subscriptionId, updates) => Promise<{ message: string; }>

Defined in: packages/sdk/src/client/client.ts:1004

Update a subscription's budget, plan period, or credit settings.

Parameters

subscriptionId

number

updates

extraUsageEnabled?

boolean

monthlyReloadLimitCents?

number | null

planPeriod?

string

reloadAmountCents?

number | null

reloadThresholdCents?

number | null

Returns

Promise<{ message: string; }>

Implementation of

BillingBindings.updateSubscription

---

updateSupervisor()

updateSupervisor: (wid, id, supervisor) => Promise<CustomTool>

Defined in: packages/sdk/src/client/client.ts:865

Update an existing supervisor with partial data.

Parameters

wid

string

id

number

supervisor

Partial<SupervisorFormData>

Returns

Promise<CustomTool>

Implementation of

WorkflowsBindings.updateSupervisor

---

updateTask()

updateTask: (wid, id, task) => Promise<Task>

Defined in: packages/sdk/src/client/client.ts:150

Update an existing task with partial data.

Parameters

wid

string

id

number

task

Partial<TaskFormData>

Returns

Promise<Task>

Implementation of

TasksBindings.updateTask

---

updateTeamsApp()

updateTeamsApp: (wid, appId, data) => Promise<TeamsAppResponse>

Defined in: packages/sdk/src/client/client.ts:1111

Parameters

wid

string

appId

number

data

UpdateTeamsAppRequest

Returns

Promise<TeamsAppResponse>

Implementation of

IntegrationsBindings.updateTeamsApp

---

updateThemeSettings()

updateThemeSettings: (wid, siteId, values) => Promise<ThemeSettingsResponse>

Defined in: packages/sdk/src/client/client.ts:719

Save values for the active theme's settings (validated against the schema).

Parameters

wid

string

siteId

number

values

Record<string, unknown>

Returns

Promise<ThemeSettingsResponse>

Implementation of

SitesBindings.updateThemeSettings

---

updateTrackedLinkDestination()

updateTrackedLinkDestination: (wid, destinationId, data) => Promise<TrackedLinkDestinationResponse>

Defined in: packages/sdk/src/client/client.ts:442

Re-key or relabel a destination.

Changing key breaks templates: {{links.old}} stops resolving and the message ships without its link. Relabelling (name) is always safe. Passing key: null releases the handle so another destination can take it — the non-destructive alternative to deleting, which would take the click history with it. The URL is not editable.

Parameters

wid

string

destinationId

number

data

UpdateTrackedLinkDestinationRequest

Returns

Promise<TrackedLinkDestinationResponse>

Implementation of

TrackedLinksBindings.updateTrackedLinkDestination

---

updateTwoFactorMethod()

updateTwoFactorMethod: (data) => Promise<TwoFactorOperationResponse>

Defined in: packages/sdk/src/client/client.ts:678

Update settings for a two-factor authentication method.

Parameters

data

UpdateTwoFactorMethodRequest

Returns

Promise<TwoFactorOperationResponse>

Implementation of

AuthBindings.updateTwoFactorMethod

---

updateUserAccount()

updateUserAccount: (info) => Promise<Account>

Defined in: packages/sdk/src/client/client.ts:647

Update the authenticated user's account information.

Parameters

info

AccountFormData

Returns

Promise<Account>

Implementation of

AuthBindings.updateUserAccount

---

updateVoicemailStatus()

updateVoicemailStatus: (wid, phoneNumberId, voicemailId, status) => Promise<Voicemail>

Defined in: packages/sdk/src/client/client.ts:918

Update voicemail status.

Parameters

wid

string

phoneNumberId

number

voicemailId

number

status

VoicemailStatus

Returns

Promise<Voicemail>

Implementation of

CommunicationsBindings.updateVoicemailStatus

---

updateWorkflow()

updateWorkflow: (wid, id, workflow) => Promise<WorkflowDetail>

Defined in: packages/sdk/src/client/client.ts:828

Update an existing workflow's draft revision.

Parameters

wid

string

id

number

workflow

Partial<WorkflowFormData>

Returns

Promise<WorkflowDetail>

Implementation of

WorkflowsBindings.updateWorkflow

---

updateWorkflowContributor()

updateWorkflowContributor: (wid, workflowId, contributorId, data) => Promise<WorkflowContributorResponse>

Defined in: packages/sdk/src/client/client.ts:847

Update a workflow contributor's settings.

Parameters

wid

string

workflowId

number

contributorId

number

data

UpdateWorkflowContributorRequest

Returns

Promise<WorkflowContributorResponse>

Implementation of

WorkflowsBindings.updateWorkflowContributor

---

updateWorkflowNote()

updateWorkflowNote: (wid, workflowId, noteId, data, query?) => Promise<WorkflowNoteResponse>

Defined in: packages/sdk/src/client/client.ts:842

Update an existing workflow note with partial data.

Parameters

wid

string

workflowId

number

noteId

number

data

Partial<WorkflowNoteFormData>

query?

WorkflowNotesQuery

Returns

Promise<WorkflowNoteResponse>

Implementation of

WorkflowsBindings.updateWorkflowNote

---

updateWorkflowRevisionMetadata()

updateWorkflowRevisionMetadata: (wid, workflowId, revisionId, data) => Promise<WorkflowRevisionSummaryResponse>

Defined in: packages/sdk/src/client/client.ts:853

Update a revision's curation metadata (label + publish notes).

Applies to both the draft and published revisions; it is not a graph change, so it never marks the draft dirty.

Parameters

wid

string

workflowId

string | number

revisionId

string | number

data

UpdateWorkflowRevisionMetadataRequest

Returns

Promise<WorkflowRevisionSummaryResponse>

Implementation of

WorkflowsBindings.updateWorkflowRevisionMetadata

---

updateWorkspace()

updateWorkspace: (wid, workspace) => Promise<Workspace>

Defined in: packages/sdk/src/client/client.ts:539

Update an existing workspace.

Parameters

wid

string

workspace

Partial<WorkspaceFormData>

Returns

Promise<Workspace>

Implementation of

WorkspacesBindings.updateWorkspace

---

updateWorkspaceDefaults()

updateWorkspaceDefaults: (wid, defaults) => Promise<WorkspaceDefaults>

Defined in: packages/sdk/src/client/client.ts:543

Update the default settings for a workspace.

Parameters

wid

string

defaults

WorkspaceDefaultsFormData

Returns

Promise<WorkspaceDefaults>

Implementation of

WorkspacesBindings.updateWorkspaceDefaults

---

updateWorkspaceInvitationAdmin()

updateWorkspaceInvitationAdmin: (workspaceUuid, invitationId, data) => Promise<InvitationResponse>

Defined in: packages/sdk/src/client/client.ts:634

Update an invitation status (requires workspace admin permission). Uses the workspace-scoped route: PUT /api/v2/w/{workspaceUuid}/invitations/{id}

Parameters

workspaceUuid

string

invitationId

number

data

UpdateInvitationFormData

Returns

Promise<InvitationResponse>

Implementation of

WorkspacesBindings.updateWorkspaceInvitationAdmin

---

updateWorkspaceThemes()

updateWorkspaceThemes: (wid, themes) => Promise<Workspace>

Defined in: packages/sdk/src/client/client.ts:583

Update the active themes for a workspace.

Parameters

wid

string

themes

string[]

Returns

Promise<Workspace>

Implementation of

WorkspacesBindings.updateWorkspaceThemes

---

uploadFile()

uploadFile: (wid, request) => Promise<File>

Defined in: packages/sdk/src/client/client.ts:757

Upload in-memory file content through the API's database-backed file path.

Parameters

wid

string

request

UploadFileRequest

Returns

Promise<File>

Implementation of

FilesBindings.uploadFile

---

upsertDataRecord()

upsertDataRecord: (wid, dataTypeId, externalId, data) => Promise<DataRecordResponse>

Defined in: packages/sdk/src/client/client.ts:250

Upsert a data record by external ID, creating or updating as needed.

Parameters

wid

string

dataTypeId

number

externalId

string | number

data

fieldValues

Record<string, any>

memberExternalId?

string | null

memberId?

number | null

Returns

Promise<DataRecordResponse>

Implementation of

DataTypesBindings.upsertDataRecord

---

upsertWidgetDomain()

upsertWidgetDomain: (wid, orgDomainUuid, body) => Promise<WidgetDomainResponse>

Defined in: packages/sdk/src/client/client.ts:591

Enable/replace the set of widgets on one verified org domain. Idempotent upsert keyed by orgDomainUuid; the server rejects unverified domains (400) and cross-org domains (404).

Parameters

wid

string

orgDomainUuid

string

body

WidgetDomainUpsertRequest

Returns

Promise<WidgetDomainResponse>

Implementation of

WorkspacesBindings.upsertWidgetDomain

---

validateCelExpression()

validateCelExpression: (wid, request) => Promise<CELValidationResponse>

Defined in: packages/sdk/src/client/client.ts:227

Parameters

wid

string

request

CELValidationRequest

Returns

Promise<CELValidationResponse>

Implementation of

CallsBindings.validateCelExpression

---

validateDataTypeSlug()

validateDataTypeSlug: (wid, slug, excludeId?) => Promise<{ available: boolean; suggestedSlug?: string; }>

Defined in: packages/sdk/src/client/client.ts:255

Validate if a data type slug is available. Returns availability and a suggested alternative if taken.

Parameters

wid

string

slug

string

excludeId?

number

Returns

Promise<{ available: boolean; suggestedSlug?: string; }>

Implementation of

DataTypesBindings.validateDataTypeSlug

---

validateMagicLink()

validateMagicLink: (token) => Promise<ValidateMagicLinkResponse>

Defined in: packages/sdk/src/client/client.ts:655

Validate a magic link token to complete authentication.

Parameters

token

string

Returns

Promise<ValidateMagicLinkResponse>

Implementation of

AuthBindings.validateMagicLink

---

validateQuery()

validateQuery: (wid, query) => Promise<ValidateQueryResponse>

Defined in: packages/sdk/src/client/client.ts:374

Structure / field / access / cost validation without execution.

Parameters

wid

string

query

QueryIR

Returns

Promise<ValidateQueryResponse>

Implementation of

QueriesBindings.validateQuery

---

validateWorkflowName()

validateWorkflowName: (wid, name) => Promise<ValidateNameResponse>

Defined in: packages/sdk/src/client/client.ts:859

Validate if a workflow name is available. Returns availability and a suggested alternative if taken.

Parameters

wid

string

name

string

Returns

Promise<ValidateNameResponse>

Implementation of

WorkflowsBindings.validateWorkflowName

---

verifyCodeWith2FA()

verifyCodeWith2FA: (phoneNumber, code, organizationUuid?, isSignUp) => Promise<VerifyCodeResponse>

Defined in: packages/sdk/src/client/client.ts:651

Verify an SMS code and complete authentication, handling 2FA if required.

Parameters

phoneNumber

string

code

string

organizationUuid?

string

isSignUp?

boolean = false

Returns

Promise<VerifyCodeResponse>

Implementation of

AuthBindings.verifyCodeWith2FA

---

verifyCredentialChange()

verifyCredentialChange: (requestId, otpCode) => Promise<CredentialChangeVerifyResponse>

Defined in: packages/sdk/src/client/client.ts:681

Verify a credential change request with OTP code. On success, applies the credential change to the account.

Parameters

requestId

number

otpCode

string

Returns

Promise<CredentialChangeVerifyResponse>

Implementation of

AuthBindings.verifyCredentialChange

---

verifyDocumoFax()

verifyDocumoFax: (wid) => Promise<DocumoFaxConnectionResponse>

Defined in: packages/sdk/src/client/client.ts:1156

Parameters

wid

string

Returns

Promise<DocumoFaxConnectionResponse>

Implementation of

IntegrationsBindings.verifyDocumoFax

---

verifyEmail()

verifyEmail: (email, code, organizationUuid?) => Promise<VerifyCodeResponse>

Defined in: packages/sdk/src/client/client.ts:657

Verify an email code and complete authentication, handling 2FA if required.

Parameters

email

string

code

string

organizationUuid?

string

Returns

Promise<VerifyCodeResponse>

Implementation of

AuthBindings.verifyEmail

---

verifyOrgDomainEmail()

verifyOrgDomainEmail: (orgIdOrUuid, domainUuid) => Promise<EmailVerificationResponse>

Defined in: packages/sdk/src/client/client.ts:602

Verify email DNS records, including MX.

Parameters

orgIdOrUuid

string | number

domainUuid

string

Returns

Promise<EmailVerificationResponse>

Implementation of

OrgBindings.verifyOrgDomainEmail

---

verifyOrgDomainOwnership()

verifyOrgDomainOwnership: (orgIdOrUuid, domainUuid) => Promise<OwnershipVerificationResponse>

Defined in: packages/sdk/src/client/client.ts:598

Verify domain ownership by checking the _gravity-verify TXT record.

Parameters

orgIdOrUuid

string | number

domainUuid

string

Returns

Promise<OwnershipVerificationResponse>

Implementation of

OrgBindings.verifyOrgDomainOwnership

---

verifyOrgDomainSite()

verifyOrgDomainSite: (orgIdOrUuid, domainUuid) => Promise<SiteVerificationResponse>

Defined in: packages/sdk/src/client/client.ts:609

Verify the site CNAME points at the Gravity Rail sites domain.

Parameters

orgIdOrUuid

string | number

domainUuid

string

Returns

Promise<SiteVerificationResponse>

Implementation of

OrgBindings.verifyOrgDomainSite

---

verifyRecoveryCodeAuth()

verifyRecoveryCodeAuth: (tempToken, code) => Promise<{ accountId: number; accountUuid: string; token: string; }>

Defined in: packages/sdk/src/client/client.ts:673

Verify a recovery code during login to complete two-factor authentication.

Parameters

tempToken

string

code

string

Returns

Promise<{ accountId: number; accountUuid: string; token: string; }>

Implementation of

AuthBindings.verifyRecoveryCodeAuth

---

verifyTOTPAuth()

verifyTOTPAuth: (tempToken, code) => Promise<{ accountId: number; accountUuid: string; token: string; }>

Defined in: packages/sdk/src/client/client.ts:672

Verify a TOTP code during login to complete two-factor authentication.

Parameters

tempToken

string

code

string

Returns

Promise<{ accountId: number; accountUuid: string; token: string; }>

Implementation of

AuthBindings.verifyTOTPAuth

---

verifyTOTPSetup()

verifyTOTPSetup: (data) => Promise<TwoFactorOperationResponse>

Defined in: packages/sdk/src/client/client.ts:669

Verify a TOTP code to complete two-factor setup.

Parameters

data

VerifyTOTPSetupRequest

Returns

Promise<TwoFactorOperationResponse>

Implementation of

AuthBindings.verifyTOTPSetup

---

verifyWebAuthnAuth()

verifyWebAuthnAuth: (tempToken, assertionResponse) => Promise<{ accountId: number; accountUuid: string; token: string; }>

Defined in: packages/sdk/src/client/client.ts:675

Verify a WebAuthn assertion during login to complete two-factor authentication.

Parameters

tempToken

string

assertionResponse

any

Returns

Promise<{ accountId: number; accountUuid: string; token: string; }>

Implementation of

AuthBindings.verifyWebAuthnAuth

---

verifyWebAuthnSetup()

verifyWebAuthnSetup: (data) => Promise<TwoFactorOperationResponse>

Defined in: packages/sdk/src/client/client.ts:671

Verify a WebAuthn assertion to complete two-factor setup.

Parameters

data

VerifyWebAuthnSetupRequest

Returns

Promise<TwoFactorOperationResponse>

Implementation of

AuthBindings.verifyWebAuthnSetup

---

workspaceInvitations

workspaceInvitations: WorkspaceInvitationsApi

Defined in: packages/sdk/src/client/client.ts:141

Methods

getActingMember()

getActingMember(): string | undefined

Defined in: packages/sdk/src/client/client.ts:1492

Get the current acting member UUID. Returns undefined if no member switch is active.

Returns

string | undefined

---

setActingMember()

setActingMember(memberUuid): void

Defined in: packages/sdk/src/client/client.ts:1480

Set the acting member UUID for member identity switching. When set, all API requests will include the X-Acting-Member header. The backend will validate that the authenticated account owns this member and use it as the effective identity for the request. Propagates to all API modules.

Parameters

memberUuid

string | undefined

Returns

void

---

setEnhancedAuthHandler()

setEnhancedAuthHandler(handler): void

Defined in: packages/sdk/src/client/client.ts:1410

Set the handler for enhanced authentication requirements (RFC 9470 Step-Up Auth). This handler is called when a 401 response includes WWW-Authenticate header with error="insufficient_user_authentication". Propagates to all API modules.

Parameters

handler

EnhancedAuthHandler | undefined

Returns

void

---

setOrgAuthHandler()

setOrgAuthHandler(handler): void

Defined in: packages/sdk/src/client/client.ts:1425

Set the handler for organization authentication requirements. This handler is called when a 401 response includes WWW-Authenticate header with realm="org". Propagates to all API modules.

Parameters

handler

OrgAuthHandler | undefined

Returns

void

---

setOrgSession()

setOrgSession(session, orgUuid?): void

Defined in: packages/sdk/src/client/client.ts:1445

Set the org session credential for cross-domain / non-browser clients (e.g. CLI). Opaque gr_sess_ values use X-Org-Session. Legacy orgToken JWE values still use X-Org-Token during the migration window.

orgUuid is the org that issued the session. Pass it so the SDK can detect a stale session (e.g. switching orgs mid-session) and re-fire the org-auth handler instead of silently 401-ing.

Propagates to all API modules.

Parameters

session

string | undefined

orgUuid?

string

Returns

void

---

setOrgToken()

setOrgToken(token, orgUuid?): void

Defined in: packages/sdk/src/client/client.ts:1457

Parameters

token

string | undefined

orgUuid?

string

Returns

void

Deprecated

Legacy compatibility for stateless orgToken JWE credentials. Prefer setOrgSession() for opaque org browser sessions.

---

updateApiKey()

updateApiKey(newApiKey): void

Defined in: packages/sdk/src/client/client.ts:1465

Update the API key across all modules. Used after successful re-authentication.

Parameters

newApiKey

string

Returns

void

---

workspace()

workspace(workspaceUuid): GravityRailWorkspaceClient

Defined in: packages/sdk/src/client/client.ts:1400

Return a workspace-scoped client facade.

Methods on the returned client are the same public SDK methods, but with the workspace UUID pre-bound:

const workspace = client.workspace("workspace-uuid");
await workspace.getAccessGrants({ status: "approved" });

Parameters

workspaceUuid

string

Returns

GravityRailWorkspaceClient