Class: GravityRailClient

CreateOperatorGroupRequest

Implementation of

PronunciationsBindings.createMyPronunciation

createNotificationRule()

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

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

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:372

Create a new operator group.

Parameters

wid

string

data

Returns

Promise<OperatorGroup>

Implementation of

OperatorBindings.createOperatorGroup

createOrganizationWorkspace()

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

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

Create a workspace in an organization.

Parameters

orgIdOrUuid

string | number

data

OrgCreateWorkspaceFormData

Returns

Promise<OrgWorkspace>

Implementation of

OrgBindings.createOrganizationWorkspace

createOrgSupportRequest()

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

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

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:571

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:318

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:732

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:429

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:1038

Create a new pronunciation entry for an organization.

Parameters

orgUuid

string

data

CreatePronunciationEntryFormData

Returns

CreateWorkflowContributorRequest

Implementation of

PronunciationsBindings.createPronunciationEntry

createRoutine()

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

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

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:299

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:501

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:565

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:547

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:900

Create a new Slack app configuration.

Parameters

wid

string

data

CreateSlackAppRequest

Returns

Promise<SlackApp>

Implementation of

IntegrationsBindings.createSlackApp

createStep()

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

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

Create a step within a journey.

Parameters

wid

string

journeyId

number

data

JourneyStepFormData

Returns

Promise<JourneyStepResponse>

Implementation of

JourneysBindings.createStep

createSupervisor()

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

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

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:1076

Parameters

data

CreateSupportRequestRequest

Returns

Promise<SupportRequest>

Implementation of

SupportRequestsBindings.createSupportRequest

createTask()

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

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

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:910

Parameters

wid

string

data

CreateTeamsAppRequest

Returns

Promise<TeamsAppResponse>

Implementation of

IntegrationsBindings.createTeamsApp

createWorkflow()

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

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

Create a new workflow in a workspace.

Parameters

wid

string

workflow

WorkflowFormData

Returns

Promise<Workflow>

Implementation of

WorkflowsBindings.createWorkflow

createWorkflowContributor()

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

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

Add a contributor to a workflow.

Parameters

wid

string

workflowId

number

data

Returns

Promise<WorkflowContributorResponse>

Implementation of

WorkflowsBindings.createWorkflowContributor

createWorkflowFromTemplate()

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

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

Create a new workflow from a template.

Parameters

wid

string

templateUuid

string

data

CreateWorkflowFromTemplateFormData

Returns

Promise<Workflow>

Implementation of

WorkflowsBindings.createWorkflowFromTemplate

createWorkflowNote()

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

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

Create a new note on a workflow.

Parameters

wid

string

workflowId

number

data

WorkflowNoteFormData

Returns

Promise<WorkflowNoteResponse>

Implementation of

WorkflowsBindings.createWorkflowNote

createWorkflowOutboundVoiceChat()

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

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

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:400

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:226

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:1084

Parameters

workspaceUuid

string

data

CreateSupportRequestRequest

Returns

Promise<SupportRequest>

Implementation of

SupportRequestsBindings.createWorkspaceSupportRequest

deactivateWorkflowVersion()

deactivateWorkflowVersion: (wid, workflowUuid, versionNumber) => Promise<WorkflowVersionResponse>

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

Deactivate a published version.

Parameters

wid

string

workflowUuid

string

versionNumber

number

Returns

Promise<WorkflowVersionResponse>

Implementation of

WorkflowsBindings.deactivateWorkflowVersion

declineInvitation()

declineInvitation: (requestId) => Promise<InvitationResponse>

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

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:137

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:288

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:830

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:528

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:837

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:694

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:706

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:712

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:698

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:154

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:183

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:177

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:422

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:972

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:334

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:785

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:780

Delete a custom toolkit

Parameters

wid

string

toolkitId

number

Returns

Promise<{ status: string; }>

Implementation of

ToolkitsBindings.deleteCustomToolkit

deleteDataRecord()

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

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

Delete a data record by ID.

Parameters

wid

string

dataTypeId

number

recordId

number

Returns

Promise<void>

Implementation of

DataTypesBindings.deleteDataRecord

deleteDataType()

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

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

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:888

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:342

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:626

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:359

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:367

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:362

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:923

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:590

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:605

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:597

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:337

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:1002

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:748

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:843

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:352

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:790

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:228

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:260

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:241

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:248

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:273

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:254

Delete a member role.

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:579

Delete a menu item from a site's navigation.

Parameters

wid

string

siteId

number

itemId

number

Returns

Promise<void>

Implementation of

SitesBindings.deleteMenuItem

deleteMilestone()

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

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

Delete a milestone by ID.

Parameters

wid

string

id

number

Returns

Promise<void>

Implementation of

CalendarsBindings.deleteMilestone

deleteMondayConnection()

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

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

Parameters

wid

string

Returns

Promise<{ status: string; }>

Implementation of

IntegrationsBindings.deleteMondayConnection

deleteMyPronunciation()

deleteMyPronunciation: (id) => Promise<void>

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

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:762

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:374

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:449

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:573

Delete a page from a site.

Parameters

wid

string

siteId

number

pageId

number

Returns

Promise<void>

Implementation of

SitesBindings.deletePage

deletePersona()

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

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

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:1032

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:431

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:1040

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:635

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:983

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:302

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:567

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:902

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:687

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:128

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:912

Parameters

wid

string

appId

number

Returns

Promise<void>

Implementation of

IntegrationsBindings.deleteTeamsApp

deleteWorkflow()

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

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

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:668

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) => Promise<void>

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

Delete a workflow note by ID.

Parameters

wid

string

workflowId

number

noteId

number

Returns

Promise<void>

Implementation of

WorkflowsBindings.deleteWorkflowNote

deleteWorkspace()

deleteWorkspace: (wid) => Promise<void>

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

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:472

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:473

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:476

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: object[]; }>

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

Parameters

wid

string

sobject

string

Returns

Promise<{ fields: object[]; }>

Implementation of

IntegrationsBindings.describeSalesforceObject

detachMyCustomerPaymentMethod()

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

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

Parameters

uuid

string

paymentMethodId

string

Returns

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

Implementation of

CustomersBindings.detachMyCustomerPaymentMethod

diffWorkflowVersions()

diffWorkflowVersions: (wid, workflowUuid, fromVersion, toVersion) => Promise<WorkflowVersionDiffResponse>

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

Compare two workflow versions (0 = draft).

Parameters

wid

string

workflowUuid

string

fromVersion

number

toVersion

number

Returns

Promise<WorkflowVersionDiffResponse>

Implementation of

WorkflowsBindings.diffWorkflowVersions

disableConfluence()

disableConfluence: (wid) => Promise<ConfluenceConnectionStatus>

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

Parameters

wid

string

Returns

Promise<ConfluenceConnectionStatus>

Implementation of

IntegrationsBindings.disableConfluence

disableCustomToolkit()

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

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

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:1000

Parameters

wid

string

Returns

Promise<HubspotConnectionStatus>

Implementation of

IntegrationsBindings.disableHubspot

disableMcpServer()

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

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

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:865

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:453

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:457

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:981

Parameters

wid

string

Returns

Promise<SalesforceConnectionStatus>

Implementation of

IntegrationsBindings.disableSalesforce

disableTwoFactorMethod()

disableTwoFactorMethod: (methodId) => Promise<TwoFactorOperationResponse>

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

Disable a specific two-factor authentication method.

Parameters

methodId

number

Returns

Implementation of

AuthBindings.disableTwoFactorMethod

disconnectConfluence()

disconnectConfluence: (wid) => Promise<ConfluenceConnectionStatus>

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

Parameters

wid

string

Returns

Promise<ConfluenceConnectionStatus>

Implementation of

IntegrationsBindings.disconnectConfluence

disconnectHubspot()

disconnectHubspot: (wid) => Promise<HubspotConnectionStatus>

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

Parameters

wid

string

Returns

Promise<HubspotConnectionStatus>

Implementation of

IntegrationsBindings.disconnectHubspot

disconnectMondayConnection()

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

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

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:851

Parameters

providerSlug

CreateAppConnectionRequest

credentialUuid?

string

Returns

Promise<void>

Implementation of

AppsBindings.disconnectOAuthProvider

disconnectPresence()

disconnectPresence: (wid) => Promise<{ ok: boolean; }>

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

Disconnect the current member's presence session.

Parameters

wid

string

Returns

Promise<{ ok: boolean; }>

Implementation of

OperatorBindings.disconnectPresence

disconnectSalesforce()

disconnectSalesforce: (wid) => Promise<SalesforceConnectionStatus>

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

Parameters

wid

string

Returns

Promise<SalesforceConnectionStatus>

Implementation of

IntegrationsBindings.disconnectSalesforce

discoverOAuthMetadata()

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

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

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:417

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:416

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:754

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:586

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:552

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

emailPasswordLogin()

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

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

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:489

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:971

Parameters

wid

string

Returns

Promise<ConfluenceConnectionStatus>

Implementation of

IntegrationsBindings.enableConfluence

enableCustomToolkit()

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

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

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:1001

Parameters

wid

string

Returns

Promise<HubspotConnectionStatus>

Implementation of

IntegrationsBindings.enableHubspot

enableMcpServer()

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

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

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:866

Parameters

wid

string

Returns

Promise<MondayConnectionStatus>

Implementation of

IntegrationsBindings.enableMondayConnection

enableOrgDomainEmail()

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

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

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) => Promise<SiteDomainConfig>

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

Enable custom site routing for a verified org domain.

Parameters

orgIdOrUuid

string | number

domainUuid

string

Returns

Promise<SiteDomainConfig>

Implementation of

OrgBindings.enableOrgDomainSite

enablePlatformApp()

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

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

Enable a platform app connection in the workspace.

Parameters

wid

string

data

Returns

Promise<PlatformAppConnectionResponse>

Implementation of

IntegrationsBindings.enablePlatformApp

enableSalesforce()

enableSalesforce: (wid) => Promise<SalesforceConnectionStatus>

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

Parameters

wid

string

Returns

Promise<SalesforceConnectionStatus>

Implementation of

IntegrationsBindings.enableSalesforce

endTestChatRun()

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

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

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<TestChatRunResponse>

Implementation of

QualificationsBindings.endTestChatRun

enrichInquiry()

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

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

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:339

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:306

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:846

Parameters

request

TokenRequest

Returns

Promise<TokenResponse>

Implementation of

AppsBindings.exchangeOAuthToken

exchangeToken()

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

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

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:536

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:269

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:168

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:167

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:844

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:234

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

exportPronunciationEntries()

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

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

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:432

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

fetchVoicemailAudio()

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

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

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:947

Parameters

wid

string

connectionId

number

data

TriggerConnectionBackfillRequest

Returns

Promise<EncounterSyncRunResponse>

Implementation of

IntegrationsBindings.fhirBackfillEncounterSync

fhirCreateEncounter()

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

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

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:939

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:936

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:928

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:929

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:941

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:940

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:937

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:945

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:942

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:935

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:932

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:931

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:946

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:944

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:927

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:925

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:926

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:934

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:933

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:938

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:943

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:169

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:592

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:713

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:512

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:581

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

Parameters

wid

string

siteId

number

uploadRequest

FileUploadRequest

Returns

Promise<FileUploadResponse>

Implementation of

SitesBindings.generateSiteMediaUploadUrl

getAbilityType()

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

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

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:132

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:386

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:390

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

getAgent()

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

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

Get a single agent by ID.

Parameters

wid

string

id

number

Returns

Promise<AgentResponse>

Implementation of

AgentsBindings.getAgent

getAgents()

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

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

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

Parameters

wid

string

options?

includeArchived?

boolean

page?

number

pageSize?

number

search?

string

sortBy?

AgentSortField

sortOrder?

FhirConnectionSortField

Returns

Promise<PaginatedResponse<AgentResponse>>

Implementation of

AgentsBindings.getAgents

getAgentTask()

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

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

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:281

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:278

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:818

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:775

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:267

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:266

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

Parameters

wid

string

options?

page?

number

pageSize?

number

status?

"pending" | "resolved" | "expired"

Returns

Promise<PendingAnonymousMembersResponse>

Implementation of

MembersBindings.getAnonymousResolutions

getApiKeys()

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

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

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:827

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:828

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:734

Get archive blockers for a phone number.

Parameters

wid

string

id

number

Returns

Promise<ArchiveBlockersResponse>

Implementation of

CommunicationsBindings.getArchiveBlockers

getAssignment()

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

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

Get a single assignment by ID.

Parameters

wid

string

id

number

Returns

Promise<AssignmentResponse>

Implementation of

AuthBindings.getAssignment

getAssignmentCelContext()

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

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

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:526

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<AssignmentResponse>>

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

List assignments with optional filtering, pagination, and sorting.

Parameters

wid

string

options?

AssignmentsQueryParams = {}

Returns

Promise<PaginatedResponse<AssignmentResponse>>

Implementation of

AuthBindings.getAssignments

getAssignmentTask()

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

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

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:532

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:535

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:621

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:729

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:847

Returns

Promise<ScopesListResponse>

Implementation of

AppsBindings.getAvailableScopes

getAvailableSlots()

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

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

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:410

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:833

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:834

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:409

Check whether the workspace is currently within business hours.

Parameters

wid

string

Returns

Promise<{ isBusinessHours: boolean; }>

Implementation of

WorkspacesBindings.getBusinessHoursStatus

getBusinessProfile()

getBusinessProfile: (orgUuid) => Promise<BusinessProfile>

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

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

Returns

Promise<BusinessProfile>

Implementation of

OrgBindings.getBusinessProfile

getCalendar()

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

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

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:702

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:701

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:709

Get a single calendar event type by ID.

Parameters

wid

string

id

number

Returns

Promise<EventTypeResponse>

Implementation of

CalendarsBindings.getCalendarEventType

getCalendarEventTypes()

getCalendarEventTypes: (wid) => Promise<PaginatedResponse<EventTypeResponse>>

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

List all calendar event types in the workspace.

Parameters

wid

string

Returns

Promise<PaginatedResponse<EventTypeResponse>>

Implementation of

CalendarsBindings.getCalendarEventTypes

getCalendars()

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

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

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:695

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:192

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:193

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

getChat()

getChat: (wid, id) => Promise<ChatResponse>

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

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:165

Get assignment tasks linked to a chat.

Parameters

wid

string

chatId

number

Returns

Promise<object[]>

Implementation of

ChatsBindings.getChatAssignmentTasks

getChatCallbacks()

getChatCallbacks: (wid, chatId) => Promise<ScheduledCallbackListResponse>

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

List scheduled callbacks for a chat (newest first).

Parameters

wid

string

chatId

number

Returns

Promise<ScheduledCallbackListResponse>

Implementation of

ChatsBindings.getChatCallbacks

getChatEmails()

getChatEmails: (wid, inboxId, chatId, options) => Promise<ChatEmailsResponse>

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

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

getChatFilter()

getChatFilter: (wid, id) => Promise<ChatFilterResponse>

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

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:180

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:184

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:178

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:173

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:174

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:172

List all chat labels in a workspace.

Parameters

wid

string

Returns

Promise<ChatLabelResponse[]>

Implementation of

ChatsBindings.getChatLabels

getChatMessages()

getChatMessages: (wid, id, limit?, offset?) => Promise<ChatMessage[]>

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

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

Returns

Promise<ChatMessage[]>

Implementation of

ChatsBindings.getChatMessages

getChatModels()

getChatModels: (provider?) => Promise<AIModelsResponse>

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

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:171

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:140

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:148

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<{ loadedSkills: string[]; revealedSkills: string[]; }>

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

Get loaded and revealed skills for a chat.

Parameters

wid

string

chatId

number

Returns

Promise<{ loadedSkills: string[]; revealedSkills: string[]; }>

Implementation of

ChatsBindings.getChatSkills

getChatsNeedsResponse()

getChatsNeedsResponse: (wid) => Promise<number[]>

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

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:145

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:144

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:160

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:161

Get the tools available in a chat.

Parameters

wid

string

chatId

number

Returns

Promise<ToolsResponse>

Implementation of

ChatsBindings.getChatTools

getClientWorkspace()

getClientWorkspace: (wid, workspaceId) => Promise<ClientWorkspace>

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

Get a single client workspace by ID.

Parameters

wid

string

workspaceId

number

Returns

Promise<ClientWorkspace>

Implementation of

WorkspacesBindings.getClientWorkspace

getConfluenceStatus()

getConfluenceStatus: (wid) => Promise<ConfluenceConnectionStatus>

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

Parameters

wid

string

Returns

Promise<ConfluenceConnectionStatus>

Implementation of

IntegrationsBindings.getConfluenceStatus

getConnectionSyncCapabilities()

getConnectionSyncCapabilities: (wid, connectionId) => Promise<SyncCapabilities>

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

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:1019

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:1017

Parameters

wid

string

connectionId

number

Returns

Promise<ConnectionSyncConfig>

Implementation of

IntegrationsBindings.getConnectionSyncConfig

getConsentState()

getConsentState: () => Promise<ConsentStateResponse>

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

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:520

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:264

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:219

Get the currently authenticated member for a workspace.

Parameters

wid

string

Returns

Promise<CurrentMemberResponse>

Implementation of

MembersBindings.getCurrentMember

getCustomToolkit()

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

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

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:776

List all custom toolkits in a workspace

Parameters

wid

string

Returns

Promise<CustomToolkit[]>

Implementation of

ToolkitsBindings.getCustomToolkits

getDataRecord()

getDataRecord: (wid, recordId) => Promise<DataRecordResponse>

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

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:211

Get the change history for a data record.

Parameters

wid

string

dataTypeId

number

recordId

number

Returns

Promise<DataRecordUpdateResponse[]>

Implementation of

DataTypesBindings.getDataRecordChanges

getDataRecords()

getDataRecords: (wid, dataTypeId, options?) => Promise<DataRecordsPaginatedResponse>

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

List data records for a data type with optional filtering and pagination.

Parameters

wid

string

dataTypeId

number

options?

memberId?

number

memberIds?

number[]

Batch form of memberId — one request hydrates a whole table page.

page?

number

pageSize?

number

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:197

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:199

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:198

Get a single data type by UUID.

Parameters

wid

string

uuid

string

Returns

Promise<DataTypeResponse>

Implementation of

DataTypesBindings.getDataTypeByUuid

getDataTypes()

getDataTypes: (wid, options?) => Promise<DataTypeResponse[]>

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

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

getDiscordBot()

getDiscordBot: (wid, botId) => Promise<DiscordBot>

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

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:893

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:885

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:883

List all Discord bots configured for a workspace.

Parameters

wid

string

options?

page?

number

pageSize?

number

search?

string

Implementation of

IntegrationsBindings.getDiscordBots

getDiscordGuilds()

getDiscordGuilds: (wid, botId, options) => Promise<PaginatedResponse<DiscordGuild>>

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

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:891

Get Discord threads for a bot.

Parameters

wid

string

botId

number

options?

page?

number

pageSize?

number

Returns

Promise<PaginatedResponse<DiscordThread>>

Implementation of

IntegrationsBindings.getDiscordThreads

getDomainMapping()

getDomainMapping: (customDomain) => Promise<DomainMapping>

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

Get the organization and workspace mapping for a custom domain.

Parameters

customDomain

string

Returns

Promise<DomainMapping>

Implementation of

AuthBindings.getDomainMapping

getEventRule()

getEventRule: (wid, id) => Promise<EventRuleResponse>

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

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:620

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:356

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:355

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:363

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:800

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:798

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:919

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:920

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:918

List all FHIR connections configured for a workspace.

Parameters

wid

string

options?

page?

number

pageSize?

number

search?

string

sortBy?

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:214

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:585

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:601

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:602

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:600

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:584

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?

Returns

Promise<PaginatedResponse<File>>

Implementation of

FilesBindings.getFiles

getFileSharing()

getFileSharing: (wid, fileId) => Promise<FileSharingResponse>

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

Get sharing settings for a file.

Parameters

wid

string

fileId

number

Returns

Promise<FileSharingResponse>

Implementation of

FilesBindings.getFileSharing

getFirstRunState()

getFirstRunState: (wid) => Promise<FirstRunState>

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

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:594

Get a single folder by ID.

Parameters

wid

string

id

number

Returns

Promise<FileFolderResponse>

Implementation of

FilesBindings.getFolder

getFolders()

getFolders: (wid, parentIdOrOpts) => Promise<FileFolderResponse[]>

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

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:609

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:806

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:716

Get the Google Calendar integration status for the workspace.

Parameters

wid

string

Returns

Promise<GoogleCalendarInsufficientScopesResponse | GoogleCalendarStatusResponse>

Implementation of

CalendarsBindings.getGoogleCalendarStatus

getHealthieAvailableSlots()

getHealthieAvailableSlots: (wid, request) => Promise<AvailableDayResponse[]>

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

Parameters

wid

string

request

GetAvailableSlotsRequest

Returns

Promise<AvailableDayResponse[]>

Implementation of

IntegrationsBindings.getHealthieAvailableSlots

getHealthieReconciliationMatches()

getHealthieReconciliationMatches: (wid, params?) => Promise<HealthieReconciliationMatch[]>

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

Parameters

wid

string

params?

limit?

number

offset?

number

Returns

Promise<HealthieReconciliationMatch[]>

Implementation of

IntegrationsBindings.getHealthieReconciliationMatches

getHealthieStatus()

getHealthieStatus: (wid) => Promise<HealthieConnectionStatus>

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

Parameters

wid

string

Returns

Promise<HealthieConnectionStatus>

Implementation of

IntegrationsBindings.getHealthieStatus

getHubspotContactProperties()

getHubspotContactProperties: (wid) => Promise<HubSpotPropertyDefinition[]>

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

Parameters

wid

string

Returns

Promise<HubSpotPropertyDefinition[]>

Implementation of

IntegrationsBindings.getHubspotContactProperties

getHubspotManagedRules()

getHubspotManagedRules: (wid) => Promise<ManagedRuleStatus[]>

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

Parameters

wid

string

Returns

Promise<ManagedRuleStatus[]>

Implementation of

IntegrationsBindings.getHubspotManagedRules

getHubspotReconciliationMatches()

getHubspotReconciliationMatches: (wid, params?) => Promise<HubspotReconciliationMatch[]>

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

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:998

Parameters

wid

string

Returns

Promise<HubspotConnectionStatus>

Implementation of

IntegrationsBindings.getHubspotStatus

getHubspotSyncLogs()

getHubspotSyncLogs: (wid, params?) => Promise<SyncLogsResponse>

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

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:1013

Parameters

wid

string

Returns

Promise<TransformPreset[]>

Implementation of

IntegrationsBindings.getHubspotTransformPresets

getICalFeedUrl()

getICalFeedUrl: (wid, calendarId) => Promise<ICalFeedUrlResponse>

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

Get the iCal feed URL for a calendar.

Parameters

wid

string

calendarId

number

Returns

Promise<ICalFeedUrlResponse>

Implementation of

CalendarsBindings.getICalFeedUrl

getInbox()

getInbox: (wid, id) => Promise<Inbox>

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

Get an inbox by ID.

Parameters

wid

string

id

number

Returns

Promise<Inbox>

Implementation of

CommunicationsBindings.getInbox

getInboxEmail()

getInboxEmail: (wid, inboxId, emailId) => Promise<Email>

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

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:749

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:744

List all inboxes in a workspace.

Parameters

wid

string

Returns

Promise<PaginatedResponse<Inbox>>

Implementation of

CommunicationsBindings.getInboxes

getInboxThreads()

getInboxThreads: (wid, inboxId) => Promise<any>

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

List email threads in an inbox.

Parameters

wid

string

inboxId

number

Returns

Promise<any>

Implementation of

CommunicationsBindings.getInboxThreads

getInquiry()

getInquiry: (inquiryId) => Promise<InquiryResponse>

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

Get a specific inquiry (superuser only)

Parameters

inquiryId

number

Returns

Promise<InquiryResponse>

Implementation of

AppsBindings.getInquiry

getJourney()

getJourney: (wid, journeyId) => Promise<Journey>

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

Get a single journey by ID (includes steps and goals).

Parameters

wid

string

journeyId

number

Returns

Promise<Journey>

Implementation of

JourneysBindings.getJourney

getJourneyHealth()

getJourneyHealth: (wid, journeyId) => Promise<JourneyHealthResponse>

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

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:338

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:349

List notes for a journey.

Parameters

wid

string

journeyId

number

Returns

Promise<JourneyNoteResponse[]>

Implementation of

JourneysBindings.getJourneyNotes

getJourneys()

getJourneys: (wid, includeArchived, pageOpts?) => Promise<PaginatedResponse<Journey>>

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

List journeys, optionally including archived, paginated.

Parameters

wid

string

includeArchived?

boolean = false

pageOpts?

page?

number

pageSize?

number

Returns

Promise<PaginatedResponse<Journey>>

Implementation of

JourneysBindings.getJourneys

getLinkablePhones()

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

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

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<LinkedHealthieMember>>

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

Parameters

wid

string

params?

page?

number

pageSize?

number

search?

string

Returns

Promise<PaginatedResponse<LinkedHealthieMember>>

Implementation of

IntegrationsBindings.getLinkedHealthieMembers

getLinkedHubspotMembers()

getLinkedHubspotMembers: (wid, params?) => Promise<PaginatedResponse<LinkedHubspotMember>>

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

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:873

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:878

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:988

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:377

Get all currently live (online) operators in a workspace.

Parameters

wid

string

Returns

Promise<LiveOperatorsResponse>

Implementation of

OperatorBindings.getLiveOperators

getMcpServer()

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

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

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:795

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:794

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:786

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:793

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:364

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:257

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:256

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:237

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:242

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:236

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:391

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:343

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:244

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:245

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:243

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:271

Parameters

wid

string

memberId

number

options?

limit?

number

query?

string

type?

MemoryType | "all"

Returns

Promise<MemberMemoriesResponse>

Implementation of

MembersBindings.getMemberMemories

getMemberRecordCounts()

getMemberRecordCounts: (wid, memberId) => Promise<{ counts: Record<number, number>; }>

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

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

getMemberRole()

getMemberRole: (wid, id) => Promise<MemberRoleResponse>

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

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:251

Get a single member role by UUID.

Parameters

wid

string

uuid

string

Returns

Promise<MemberRoleResponse>

Implementation of

MembersBindings.getMemberRoleByUuid

getMemberRoles()

getMemberRoles: (wid) => Promise<MemberRoleResponse[]>

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

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:235

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

getMemberSyncLinks()

getMemberSyncLinks: (wid, memberId) => Promise<MemberSyncLink[]>

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

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:1023

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:822

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

getMenuItems()

getMenuItems: (wid, siteId, parentId?) => Promise<MenuItemResponse[]>

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

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:190

Get message timing data for a chat recording.

Parameters

wid

string

chatId

number

Returns

Promise<MessageTimingResponse>

Implementation of

CallsBindings.getMessageTiming

getMilestone()

getMilestone: (wid, id) => Promise<Milestone>

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

Get a single milestone by ID.

Parameters

wid

string

id

number

Returns

Promise<Milestone>

Implementation of

CalendarsBindings.getMilestone

getMilestones()

getMilestones: (wid, options) => Promise<PaginatedResponse<Milestone>>

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

List milestones in a workspace with optional pagination and sorting.

Parameters

wid

string

options?

page?

number

pageSize?

number

search?

string

sortBy?

MilestoneSortField

sortOrder?

Returns

Promise<PaginatedResponse<Milestone>>

Implementation of

CalendarsBindings.getMilestones

getMondayBoardColumns()

getMondayBoardColumns: (wid, boardId) => Promise<ColumnsResponse>

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

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:856

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:854

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:869

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:870

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:868

Parameters

wid

string

Returns

Promise<MondayBoard[]>

Implementation of

IntegrationsBindings.getMondayConnectionBoards

getMondayConnectionStatus()

getMondayConnectionStatus: (wid) => Promise<MondayConnectionStatus>

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

Parameters

wid

string

Returns

Promise<MondayConnectionStatus>

Implementation of

IntegrationsBindings.getMondayConnectionStatus

getMondayCurrentUserInfo()

getMondayCurrentUserInfo: (wid) => Promise<MondayCurrentUserInfoResponse>

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

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:874

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:871

Parameters

wid

string

Returns

Promise<MondaySyncConfigResponse>

Implementation of

IntegrationsBindings.getMondaySyncConfig

getMyCredentials()

getMyCredentials: (wid) => Promise<MemberCredential[]>

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

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:1053

Parameters

uuid

string

Returns

Promise<MyCustomerResponse>

Implementation of

CustomersBindings.getMyCustomer

getMyCustomerAccounts()

getMyCustomerAccounts: (uuid) => Promise<CustomerAccount[]>

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

Parameters

uuid

string

Returns

Promise<CustomerAccount[]>

Implementation of

CustomersBindings.getMyCustomerAccounts

getMyCustomerCreditGrants()

getMyCustomerCreditGrants: (uuid, opts?) => Promise<CreditGrantListResponse>

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

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:1056

Parameters

uuid

string

Returns

Promise<InvoiceResponse[]>

Implementation of

CustomersBindings.getMyCustomerInvoices

getMyCustomerPaymentMethods()

getMyCustomerPaymentMethods: (uuid) => Promise<StripePaymentMethod[]>

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

Parameters

uuid

string

Returns

Promise<StripePaymentMethod[]>

Implementation of

CustomersBindings.getMyCustomerPaymentMethods

getMyCustomers()

getMyCustomers: () => Promise<MyCustomerResponse[]>

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

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:1055

Parameters

uuid

string

opts?

page?

number

pageSize?

number

status?

string

Returns

Promise<{ items: SubscriptionResponse[]; page: number; pageSize: number; total: number; }>

Implementation of

CustomersBindings.getMyCustomerSubscriptions

getMyGivenGrants()

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

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

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:515

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:1043

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:384

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

getMyReseller()

getMyReseller: (uuid) => Promise<MyResellerResponse>

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

Parameters

uuid

string

Returns

Promise<MyResellerResponse>

Implementation of

ResellersBindings.getMyReseller

getMyResellerAccounts()

getMyResellerAccounts: (uuid) => Promise<ResellerAccount[]>

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

Parameters

uuid

string

Returns

Promise<ResellerAccount[]>

Implementation of

ResellersBindings.getMyResellerAccounts

getMyResellerProducts()

getMyResellerProducts: (uuid) => Promise<Product[]>

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

Parameters

uuid

string

Returns

Promise<Product[]>

Implementation of

ResellersBindings.getMyResellerProducts

getMyResellers()

getMyResellers: () => Promise<MyResellerResponse[]>

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

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:1070

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:413

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:759

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:412

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:850

Parameters

providerSlug

options?

OAuthAuthorizeOptions

Returns

Promise<OAuthAuthorizeResponse>

Implementation of

AppsBindings.getOAuthAuthorizationUrl

getOAuthConnectionStatus()

getOAuthConnectionStatus: (providerSlug) => Promise<OAuthConnectionStatus | null>

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

Parameters

providerSlug

Returns

Promise<OAuthConnectionStatus | null>

Implementation of

AppsBindings.getOAuthConnectionStatus

getOperatorChatMessages()

getOperatorChatMessages: (wid, chatId, limit, offset) => Promise<ChatMessage[]>

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

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:371

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:370

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:297

Fetch (auto-creating if absent) the qualification for a workflow.

Parameters

wid

string

workflowId

number

Returns

Promise<QualificationResponse>

Implementation of

QualificationsBindings.getOrCreateQualificationForWorkflow

getOrgBillingCustomer()

getOrgBillingCustomer: (orgIdOrUuid) => Promise<{ customerName: string | null; customerUuid: string | null; hasAccess: boolean; }>

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

Get the billing customer UUID for an organization.

Parameters

orgIdOrUuid

string | number

Returns

Promise<{ customerName: string | null; customerUuid: string | null; hasAccess: boolean; }>

Implementation of

OrgBindings.getOrgBillingCustomer

getOrgDomain()

getOrgDomain: (orgIdOrUuid, domainUuid) => Promise<OrgDomain>

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

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:451

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:455

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:1079

Parameters

orgUuid

string

uuid

string

Returns

Promise<SupportRequest>

Implementation of

SupportRequestsBindings.getOrgSupportRequest

getOwnedMembers()

getOwnedMembers: (wid) => Promise<WorkspaceMemberResponse[]>

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

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:569

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:570

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:496

Check whether the current account has a password set.

Returns

Promise<{ hasPassword: boolean; }>

Implementation of

AuthBindings.getPasswordStatus

getPendingCredentialChanges()

getPendingCredentialChanges: () => Promise<PendingCredentialChange[]>

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

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:317

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:187

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:731

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:736

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?

dateFrom?

string

dateTo?

string

inbound?

boolean

status?

string

Returns

Promise<PaginatedResponse<PhoneCall>>

Implementation of

CommunicationsBindings.getPhoneNumberCalls

getPhoneNumberMessages()

getPhoneNumberMessages: (wid, id, page, pageSize, filters?) => Promise<PaginatedResponse<SMSMessage>>

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

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

getPhoneNumbers()

getPhoneNumbers: (wid, options?) => Promise<PhoneNumber[]>

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

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:738

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:820

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

getPlatformApp()

getPlatformApp: (wid, appUuid) => Promise<PlatformAppConnectionResponse>

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

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:378

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:425

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:424

List products available from a reseller workspace, optionally filtering by featured status.

Parameters

wid

string

featured?

boolean

Returns

Promise<Product[]>

Implementation of

WorkspacesBindings.getProducts

getPronunciationEntries()

getPronunciationEntries: (orgUuid, options) => Promise<PronunciationEntryResponse[]>

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

List pronunciation entries for an organization, optionally filtered by scope.

Parameters

orgUuid

string

options?

accountId?

number

scope?

"account" | "org"

Returns

Promise<PronunciationEntryResponse[]>

Implementation of

PronunciationsBindings.getPronunciationEntries

getPublicFeatureRegistry()

getPublicFeatureRegistry: () => Promise<FeaturesRegistryResponse>

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

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:615

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:616

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:617

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:428

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:427

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:398

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:296

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:295

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:311

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:771

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:1048

List recommended voices for pronunciation preview.

Returns

Promise<RecommendedVoiceResponse[]>

Implementation of

PronunciationsBindings.getRecommendedVoices

getResellerWorkspaces()

getResellerWorkspaces: (wid, params?) => Promise<PaginatedResponse<ClientWorkspace>>

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

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:632

Get a single routine by ID.

Parameters

wid

string

id

number

Returns

Promise<RoutineResponse>

Implementation of

EventsBindings.getRoutine

getRoutineRuns()

getRoutineRuns: (wid, options) => Promise<PaginatedResponse<RoutineRunResponse>>

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

List routine run history with optional filtering by routine and status.

Parameters

wid

string

options?

page?

number

pageSize?

number

routineId?

number

sortBy?

"createdAt"

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:631

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:630

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:984

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:979

Parameters

wid

string

Returns

Promise<SalesforceConnectionStatus>

Implementation of

IntegrationsBindings.getSalesforceStatus

getSalesforceSyncConfig()

getSalesforceSyncConfig: (wid) => Promise<SalesforceSyncConfigResponse>

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

Parameters

wid

string

Returns

Promise<SalesforceSyncConfigResponse>

Implementation of

IntegrationsBindings.getSalesforceSyncConfig

getScenario()

getScenario: (wid, scenarioId) => Promise<Scenario>

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

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:542

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:556

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:574

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:575

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:568

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:558

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:557

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:539

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:543

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:545

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:546

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:899

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:905

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:898

List all Slack apps configured for a workspace.

Parameters

wid

string

options?

page?

number

pageSize?

number

search?

string

sortBy?

SlackAppSortField

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:904

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:903

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:819

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:345

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:344

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:772

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:809

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:684

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:683

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:1075

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:1022

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:1021

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:125

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:658

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:124

List all tasks in a workspace, optionally filtering by workflow or including archived.

Parameters

wid

string

options?

includeArchived?

boolean

sortBy?

"name" | "workflowId" | "createdAt"

sortOrder?

"asc" | "desc"

workflowId?

number

Returns

Promise<Task[]>

Implementation of

TasksBindings.getTasks

getTeamsApp()

getTeamsApp: (wid, appId) => Promise<TeamsAppResponse>

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

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:915

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:908

List all Teams apps configured for a workspace.

Parameters

wid

string

options?

page?

number

pageSize?

number

search?

string

sortBy?

TeamsAppSortField

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:913

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:914

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:767

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<TestChatRunResponse>

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

Parameters

wid

string

runId

number

Returns

Promise<TestChatRunResponse>

Implementation of

QualificationsBindings.getTestChatRun

getThemeSettings()

getThemeSettings: (wid, siteId, theme?) => Promise<ThemeSettingsResponse>

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

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:756

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:766

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:149

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:765

Get available toolkits for the workspace

Parameters

wid

string

Returns

Promise<ToolkitsResponse>

Implementation of

ToolkitsBindings.getToolkits

getTTSModels()

getTTSModels: (provider?) => Promise<AIModelsResponse>

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

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:503

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:414

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:440

Get billing dashboard data for a workspace.

This endpoint is available to organization owners (with org:billing scope). Superusers should use the admin endpoint via getWorkspaceUsageDashboard.

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:483

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:464

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:769

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:774

Get available voice models with metadata

Parameters

provider?

string

Returns

Promise<VoiceModelsResponse>

Implementation of

ToolkitsBindings.getVoiceModels

getVoiceToken()

getVoiceToken: (wid) => Promise<VoiceTokenResponse>

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

Get a voice authentication token for real-time audio.

Parameters

wid

string

Returns

Promise<VoiceTokenResponse>

Implementation of

CallsBindings.getVoiceToken

getVoiceUsageReport()

getVoiceUsageReport: (wid, params?) => Promise<VoiceUsageReport>

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

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:510

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:629

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<Workflow>

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

Get a single workflow by ID.

Parameters

wid

string

id

string | number

Returns

Promise<Workflow>

Implementation of

WorkflowsBindings.getWorkflow

getWorkflowAccessValidation()

getWorkflowAccessValidation: (wid, workflowId) => Promise<WorkflowAccessValidationResponse>

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

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:644

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:660

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:665

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:650

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:646

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

getWorkflowNotes()

getWorkflowNotes: (wid, workflowId) => Promise<WorkflowNoteResponse[]>

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

List all notes for a specific workflow.

Parameters

wid

string

workflowId

number

Returns

Promise<WorkflowNoteResponse[]>

Implementation of

WorkflowsBindings.getWorkflowNotes

getWorkflows()

getWorkflows: (wid, archived) => Promise<Workflow[]>

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

List all workflows in a workspace, optionally including archived ones.

Parameters

wid

string

archived?

boolean = false

Returns

Promise<Workflow[]>

Implementation of

WorkflowsBindings.getWorkflows

getWorkflowsActivityBatch()

getWorkflowsActivityBatch: (wid, workflowIds, options?) => Promise<Record<string, WorkflowActivity>>

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

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?) => Promise<Record<number, TaskAssignmentStatsResponse>>

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

Get task assignment statistics for a workflow within an optional date range.

Parameters

wid

string

id

number

fromDate?

string

toDate?

string

Returns

Promise<Record<number, TaskAssignmentStatsResponse>>

Implementation of

WorkflowsBindings.getWorkflowTaskAssignmentStats

getWorkflowTemplates()

getWorkflowTemplates: (wid) => Promise<WorkflowTemplateResponse[]>

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

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:647

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

getWorkflowVersion()

getWorkflowVersion: (wid, workflowUuid, versionNumber) => Promise<WorkflowVersionDetailResponse>

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

Get a specific version of a workflow by version number.

Parameters

wid

string

workflowUuid

string

versionNumber

number

Returns

Promise<WorkflowVersionDetailResponse>

Implementation of

WorkflowsBindings.getWorkflowVersion

getWorkflowVersionActive()

getWorkflowVersionActive: (wid, workflowUuid) => Promise<WorkflowVersionDetailResponse>

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

Get the active version of a workflow.

Parameters

wid

string

workflowUuid

string

Returns

Promise<WorkflowVersionDetailResponse>

Implementation of

WorkflowsBindings.getWorkflowVersionActive

getWorkflowVersions()

getWorkflowVersions: (wid, workflowUuid) => Promise<WorkflowVersionListResponse>

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

List all versions of a workflow.

Parameters

wid

string

workflowUuid

string

Returns

Promise<WorkflowVersionListResponse>

Implementation of

WorkflowsBindings.getWorkflowVersions

getWorkspace()

getWorkspace: (wid) => Promise<Workspace>

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

Get a single workspace by ID.

Parameters

wid

string

Returns

Promise<Workspace>

Implementation of

WorkspacesBindings.getWorkspace

getWorkspaceBuilder()

getWorkspaceBuilder: (wid, builderId) => Promise<WorkspaceBuilderInfo>

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

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:677

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:438

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:408

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:404

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:441

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:470

Parameters

requestId

number

Returns

Promise<InvitationResponse>

Implementation of

WorkspacesBindings.getWorkspaceInvitation

getWorkspaceMember()

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

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

Get a single workspace member by ID.

Parameters

wid

string

memberId

number

Returns

Promise<WorkspaceMemberResponse>

Implementation of

MembersBindings.getWorkspaceMember

getWorkspaceMembers()

getWorkspaceMembers: (wid, page, pageSize, filters?, search?, role?, sortBy?, sortOrder?, memberType?, isArchived, isManager?, memberTypes?, hasAccount?, excludeIds?, memberFilterId?, query?) => Promise<PaginatedResponse<WorkspaceMemberResponse>>

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

List workspace members with pagination, filtering, and sorting.

Parameters

wid

string

page?

number = 1

pageSize?

number = 10

filters?

any[] | { query?: string; role?: string; }

search?

string

role?

string

sortBy?

MemberSortField

sortOrder?

ImportHubSpotMembersRequest

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 (rules AND 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:411

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:426

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:397

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:439

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:442

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:810

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:1083

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:436

List available themes for a workspace.

Parameters

wid

string

Returns

Promise<ThemesListResponse>

Implementation of

WorkspacesBindings.getWorkspaceThemes

importFromBoard()

importFromBoard: (wid, data) => Promise<MondayImportResponse>

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

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:1009

Parameters

wid

string

data

Returns

Promise<ImportHubSpotMembersResponse>

Implementation of

IntegrationsBindings.importHubspotMembers

importMembers()

importMembers: (wid, file, newMemberRoleId, onProgress?, options?) => Promise<any>

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

Import members from a CSV file, streaming progress updates via callback.

Parameters

wid

string

file

File

newMemberRoleId

number

onProgress?

(progress) => void

options?

trustEmailAddresses?

boolean

trustPhoneNumbers?

boolean

Returns

Promise<any>

Implementation of

MembersBindings.importMembers

importPronunciationEntries()

importPronunciationEntries: (orgUuid, entries) => Promise<PronunciationImportResult>

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

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:993

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:553

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) => Promise<WorkspaceImportPreviewResponse>

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

Import workspace configuration from exported data.

Parameters

wid

string

exportData

WorkspaceExportData

importMappings

WorkspaceImportMapping

createNew

WorkspaceCreateNewEntities

Returns

Promise<WorkspaceImportPreviewResponse>

Implementation of

WorkspacesBindings.importWorkspace

initiateCall()

initiateCall: (wid, request) => Promise<InitiateCallResponse>

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

Initiate a new outbound call.

Parameters

wid

string

request

InitiateCallRequest

Returns

Promise<InitiateCallResponse>

Implementation of

CallsBindings.initiateCall

initiateOutboundCall()

initiateOutboundCall: (wid, chatId, phoneNumberId) => Promise<OutboundCallResponse>

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

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:394

Inspect the full composed prompt for a task (static) or chat (live).

Parameters

wid

string

options

InspectPromptOptions

Returns

Promise<PromptInspectionResult>

Implementation of

PromptsBindings.inspectPrompt

inviteMemberCredentialUpdate()

inviteMemberCredentialUpdate: (wid, memberId, credentialType, newValue) => Promise<CredentialChangeInviteResponse>

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

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:478

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:403

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:718

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:953

Parameters

wid

string

data

LinkCalendarToHealthieRequest

Returns

Promise<LinkCalendarToHealthieResponse>

Implementation of

IntegrationsBindings.linkCalendarToHealthie

linkMemberToHealthie()

linkMemberToHealthie: (wid, data) => Promise<{ healthie_patient_id: string; member_id: number; status: string; }>

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

Parameters

wid

string

data

LinkMemberToHealthieRequest

Returns

Promise<{ healthie_patient_id: string; member_id: number; status: string; }>

Implementation of

IntegrationsBindings.linkMemberToHealthie

linkMemberToHubspot()

linkMemberToHubspot: (wid, data) => Promise<{ hubspotRecordId: string; memberId: number; status: string; }>

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

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:875

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:985

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:743

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:134

List configured ability instances for a workflow or task scope. Exactly one of workflowId / taskId must be provided.

Parameters

wid

string

options

taskId?

number

workflowId?

number

Returns

Promise<AbilityResponse[]>

Implementation of

TasksBindings.listAbilities

listAgentAbilities()

listAgentAbilities: (wid, id, options) => Promise<AbilityResponse[]>

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

List the configured abilities effective for an agent via a task's workflow. Requires taskId because abilities are scoped to workflows/tasks, not agents.

Parameters

wid

string

id

number

options

taskId

number

Returns

Promise<AbilityResponse[]>

Implementation of

AgentsBindings.listAgentAbilities

listAppConnections()

listAppConnections: (wid) => Promise<AppConnectionItem[]>

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

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:825

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:1027

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:832

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:191

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:974

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:973

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:1033

Parameters

wid

string

connectionId

number

Returns

Promise<ConnectionMemberFieldKeysResponse>

Implementation of

IntegrationsBindings.listConnectionMemberFieldKeys

listGoogleCalendars()

listGoogleCalendars: (wid) => Promise<GoogleCalendarInfo[]>

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

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:960

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:961

Parameters

wid

string

keywords?

string

Returns

Promise<HealthiePatientResponse[]>

Implementation of

IntegrationsBindings.listHealthiePatients

listHealthieProviders()

listHealthieProviders: (wid) => Promise<HealthieProvider[]>

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

Parameters

wid

string

Returns

Promise<HealthieProvider[]>

Implementation of

IntegrationsBindings.listHealthieProviders

listInquiries()

listInquiries: (params?) => Promise<InquiryListResponse>

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

List all inquiries (superuser only)

Parameters

params?

inquiryType?

string

page?

number

pageSize?

number

Returns

Promise<InquiryListResponse>

Implementation of

AppsBindings.listInquiries

listOAuthAccounts()

listOAuthAccounts: (providerSlug) => Promise<OAuthAccountsResponse>

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

Parameters

providerSlug

ThinkingSoundPreviewRequest

Returns

Promise<OAuthAccountsResponse>

Implementation of

AppsBindings.listOAuthAccounts

listOrgDomains()

listOrgDomains: (orgIdOrUuid) => Promise<OrgDomainListResponse>

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

List domains registered to an organization.

Parameters

orgIdOrUuid

string | number

Returns

Promise<OrgDomainListResponse>

Implementation of

OrgBindings.listOrgDomains

listOrgSupportRequests()

listOrgSupportRequests: (orgUuid, params?) => Promise<PaginatedResponse<SupportRequest>>

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

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:316

List personas in the workspace, paginated.

Parameters

wid

string

params?

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:467

List all active Web Push subscriptions for the current user.

Parameters

wid

string

Returns

Promise<object[]>

Implementation of

WorkspacesBindings.listPushSubscriptions

listScenarios()

listScenarios: (wid, qualificationId, params?) => Promise<Scenario[]>

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

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:817

List self-service, purchasable plans (org or workspace). Only plans with a paid Stripe price are returned. No auth required.

Parameters

productType?

"workspace" | "org"

Returns

Promise<Product[]>

Implementation of

BillingBindings.listSelfServeProducts

listSupportRequests()

listSupportRequests: (params?) => Promise<PaginatedResponse<SupportRequest>>

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

Parameters

params?

SupportRequestListParams

Returns

Promise<PaginatedResponse<SupportRequest>>

Implementation of

SupportRequestsBindings.listSupportRequests

listTestChatRuns()

listTestChatRuns: (wid, workflowId, params?) => Promise<TestChatRunResponse[]>

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

Parameters

wid

string

workflowId

number

params?

assistantChatModelId?

string

limit?

number

scenarioId?

number

Returns

Promise<TestChatRunResponse[]>

Implementation of

QualificationsBindings.listTestChatRuns

listWorkspaceInvitations()

listWorkspaceInvitations: (params?) => Promise<InvitationListResponse>

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

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:469

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:1082

Parameters

workspaceUuid

string

params?

SupportRequestListParams

Returns

Promise<PaginatedResponse<SupportRequest>>

Implementation of

SupportRequestsBindings.listWorkspaceSupportRequests

login: (phoneNumber, wid?, organizationUuid?) => Promise<SMSLoginResponse>

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

Initiate SMS login by sending a verification code to the given phone number.

Parameters

phoneNumber

string

wid?

string

organizationUuid?

string

Returns

Promise<SMSLoginResponse>

Implementation of

AuthBindings.login

logout()

logout: () => Promise<{ success: boolean; }>

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

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:751

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:752

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:415

Mark a notification as read.

Parameters

wid

string

id

number

Returns

Promise<NotificationResponse>

Implementation of

WorkspacesBindings.markNotificationAsRead

previewImportWorkspace()

previewImportWorkspace: (wid, exportData, importMappings, createNew) => Promise<any>

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

Preview a workspace import using the legacy untyped interface.

Parameters

wid

string

exportData

any

importMappings?

any = {}

createNew?

any = {}

Returns

Promise<any>

Implementation of

WorkspacesBindings.previewImportWorkspace

previewPronunciation()

previewPronunciation: (data) => Promise<ArrayBuffer>

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

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:313

Bounded sample run (limit capped server-side).

Parameters

wid

string

query

QueryIR

mode?

QueryRunMode

Returns

Promise<RunQueryResponse>

Implementation of

QueriesBindings.previewQuery

previewSchedule()

previewSchedule: (wid, request) => Promise<SchedulePreviewResponse>

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

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:768

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:682

Generate a thinking sound audio preview.

Parameters

wid

string

request

Returns

Promise<ArrayBuffer>

Implementation of

WorkflowsBindings.previewThinkingSound

previewTTS()

previewTTS: (wid, request) => Promise<ArrayBuffer>

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

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?) => Promise<WorkspaceImportPreviewResponse>

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

Preview the result of importing workspace configuration without applying changes.

Parameters

wid

string

exportData

WorkspaceExportData

importMappings

WorkspaceImportMapping

createNew

WorkspaceCreateNewEntities

autoMap?

WorkspaceAutoMapEntities

Returns

Promise<WorkspaceImportPreviewResponse>

Implementation of

WorkspacesBindings.previewWorkspaceImport

provisionClientWorkspace()

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

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

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

publishSiteSource()

publishSiteSource: (wid, siteId, options?) => Promise<SiteSourcePublishResponse>

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

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

publishWorkflowVersion()

publishWorkflowVersion: (wid, workflowUuid, data) => Promise<WorkflowVersionResponse>

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

Publish the live workflow as a new immutable version.

Parameters

wid

string

workflowUuid

string

data

PublishVersionRequest

Returns

Promise<WorkflowVersionResponse>

Implementation of

WorkflowsBindings.publishWorkflowVersion

purchaseCredits()

purchaseCredits: (subscriptionId, amountCents) => Promise<{ amountChargedCents: number; creditsAdded: number; grantId: number; newBalance: number; success: boolean; }>

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

Purchase extra credits on a subscription (org-level).

Parameters

subscriptionId

number

amountCents

number

Returns

Promise<{ amountChargedCents: number; creditsAdded: number; grantId: number; newBalance: number; success: boolean; }>

Implementation of

BillingBindings.purchaseCredits

rateMessage()

rateMessage: (wid, chatId, messageUuid, rating) => Promise<{ detail?: string; status: string; }>

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

Rate a chat message by its UUID.

Parameters

wid

string

chatId

number

messageUuid

string

rating

number

Returns

Promise<{ detail?: string; status: string; }>

Implementation of

ChatsBindings.rateMessage

reactivateSubscription()

reactivateSubscription: (subscriptionId) => Promise<{ message: string; }>

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

Reactivate a previously cancelled subscription.

Parameters

subscriptionId

number

Returns

Promise<{ message: string; }>

Implementation of

BillingBindings.reactivateSubscription

reenrollMember()

reenrollMember: (wid, journeyId, data) => Promise<MemberJourney>

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

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:831

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:889

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:890

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:446

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:465

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:598

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:741

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:608

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:611

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:376

Remove a member from an operator group.

Parameters

wid

string

groupId

number

memberId

number

Returns

Promise<void>

Implementation of

OperatorBindings.removeGroupMember

reopenWorkspaceSupportRequest()

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

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

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:628

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:580

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) => Promise<Email>

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

Reply to an email from the inbox.

Parameters

wid

string

inboxId

number

emailId

number

content

string

Returns

Promise<Email>

Implementation of

CommunicationsBindings.replyToEmail

requestCredentialChange()

requestCredentialChange: (credentialType, newValue) => Promise<CredentialChangeRequestResponse>

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

Request to change email or phone credential. Sends an OTP to the NEW credential to verify ownership.

Parameters

credentialType

CredentialType

newValue

string

Returns

Promise<CredentialChangeRequestResponse>

Implementation of

AuthBindings.requestCredentialChange

requestCrossDomainToken()

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

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

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:490

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:730

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:474

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?) => Promise<SMSLoginResponse>

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

Resend the SMS verification code to the given phone number.

Parameters

phoneNumber

string

organizationUuid?

string

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:638

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:550

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:388

Resolve a pending access grant by approving or denying it.

Parameters

wid

string

uuid

string

data

ResolveGrantRequest

Returns

Promise<AccessGrant>

Implementation of

AccessGrantsBindings.resolveAccessGrant

resolveAgentTools()

resolveAgentTools: (wid, id, options) => Promise<ToolsResponse>

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

Resolve runtime tools for an agent on a simulated channel.

Parameters

wid

string

id

number

options

channel

string

taskId?

number

taskUuid?

string

Returns

Promise<ToolsResponse>

Implementation of

AgentsBindings.resolveAgentTools

resolveAnonymousMember()

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

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

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

revokeAccessGrant()

revokeAccessGrant: (wid, uuid, data) => Promise<AccessGrant>

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

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:805

Revoke a workspace API key.

Parameters

wid

string

id

number

Returns

Promise<void>

Implementation of

BillingBindings.revokeApiKey

revokeGlobalApiKey()

revokeGlobalApiKey: (id) => Promise<void>

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

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:714

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:551

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

runQuery()

runQuery: (wid, query, mode?) => Promise<RunQueryResponse>

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

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:636

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

searchEventRules()

searchEventRules: (wid, params) => Promise<EventRuleResponse[]>

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

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

workflowId?

number

Returns

Promise<EventRuleResponse[]>

Implementation of

EventsBindings.searchEventRules

searchFolder()

searchFolder: (wid, id, params) => Promise<FolderSearchResultResponse[]>

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

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:1008

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:992

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:530

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:163

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:170

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:492

Send a verification code to the given email address for login.

Parameters

email

string

organizationUuid?

string

Returns

Promise<SMSLoginResponse>

Implementation of

AuthBindings.sendEmailVerification

sendMemberPhoneConfirmation()

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

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

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:381

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:1034

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: string; }>

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

Parameters

uuid

string

paymentMethodId

string

Returns

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

Implementation of

CustomersBindings.setDefaultMyCustomerPaymentMethod

setPassword()

setPassword: (newPassword) => Promise<{ message: string; success: boolean; }>

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

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:504

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:506

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:563

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:561

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:560

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:559

Parameters

wid

string

siteUuid

string

Returns

Promise<SiteSignupResponse>

Implementation of

SitesBindings.siteSignup

siteVerifyCode()

siteVerifyCode: (wid, siteUuid, code, phoneNumber?, email?) => Promise<{ accountId: number; memberId?: number; token: string; }>

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

Verify a phone or email code and complete site authentication.

Parameters

wid

string

siteUuid

string

code

string

phoneNumber?

string

email?

string

Returns

Promise<{ accountId: number; memberId?: number; token: string; }>

Implementation of

SitesBindings.siteVerifyCode

skipStep()

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

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

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:967

Parameters

wid

string

Returns

Promise<ConfluenceConnectionStatus>

Implementation of

IntegrationsBindings.startConfluenceOAuth

startHubspotOAuth()

startHubspotOAuth: (wid) => Promise<HubspotConnectionStatus>

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

Parameters

wid

string

Returns

Promise<HubspotConnectionStatus>

Implementation of

IntegrationsBindings.startHubspotOAuth

startSalesforceOAuth()

startSalesforceOAuth: (wid) => Promise<SalesforceConnectionStatus>

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

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:1020

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:305

Parameters

wid

string

workflowId

number

data?

StartTestChatRunRequest = {}

Returns

Promise<StartTestChatRunResponse>

Implementation of

QualificationsBindings.startTestChatRun

submitBusinessProfile()

submitBusinessProfile: (orgUuid) => Promise<BusinessProfileSubmitResponse>

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

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

Returns

Promise<BusinessProfileSubmitResponse>

Implementation of

OrgBindings.submitBusinessProfile

suggestPronunciations()

suggestPronunciations: (term, language?) => Promise<string[]>

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

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:158

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:221

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:720

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:955

Parameters

wid

string

calendarId

number

Returns

Promise<LinkCalendarToHealthieResponse>

Implementation of

IntegrationsBindings.syncCalendarWithHealthie

testFhirConnection()

testFhirConnection: (wid, connectionId) => Promise<{ message: string; success: boolean; }>

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

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:796

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:863

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:348

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:627

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:213

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

unarchiveAgent()

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

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

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:151

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:204

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:230

Unarchive a previously archived workspace member.

Parameters

wid

string

memberId

number

Returns

Promise<WorkspaceMemberResponse>

Implementation of

MembersBindings.unarchiveMember

unarchiveTask()

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

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

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:653

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:340

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:719

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:954

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:895

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<{ member_id: number; status: string; }>

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

Parameters

wid

string

memberId

number

Returns

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

Implementation of

IntegrationsBindings.unlinkMemberFromHealthie

unlinkMemberFromHubspot()

unlinkMemberFromHubspot: (wid, memberId) => Promise<{ memberId: number; status: string; }>

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

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:877

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:987

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:466

Unregister a Web Push subscription by endpoint URL.

Parameters

wid

string

endpoint

string

Returns

Promise<{ deleted: boolean; }>

Implementation of

WorkspacesBindings.unregisterPushSubscription

updateAbility()

updateAbility: (wid, abilityUuid, body) => Promise<AbilityResponse>

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

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:287

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:829

Update an app

Parameters

appId

string

request

UpdateAppRequest

Returns

Promise<App>

Implementation of

AppsBindings.updateApp

updateAssignment()

updateAssignment: (wid, id, assignment) => Promise<AssignmentResponse>

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

Update an assignment by ID.

Parameters

wid

string

id

number

assignment

UpdateAssignmentFormData

Returns

Promise<AssignmentResponse>

Implementation of

AuthBindings.updateAssignment

updateBuilder()

updateBuilder: (builderId, request) => Promise<BuilderResponse>

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

Update an existing builder

Parameters

builderId

string

request

UpdateBuilderRequest

Returns

Promise<BuilderResponse>

Implementation of

AppsBindings.updateBuilder

updateBusinessProfile()

updateBusinessProfile: (orgUuid, data) => Promise<BusinessProfile>

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

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

Returns

Promise<BusinessProfile>

Implementation of

OrgBindings.updateBusinessProfile

updateCalendar()

updateCalendar: (wid, id, calendar) => Promise<Calendar>

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

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:704

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:711

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:697

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:155

Update a chat's properties.

Parameters

wid

string

id

number

chat

Partial<ChatFormData>

Returns

Promise<ChatResponse>

Implementation of

ChatsBindings.updateChat

updateChatFilter()

updateChatFilter: (wid, id, filter) => Promise<ChatFilterResponse>

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

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:176

Update a chat label.

Parameters

wid

string

id

number

label

Partial<ChatLabelFormData>

Returns

Promise<ChatLabelResponse>

Implementation of

ChatsBindings.updateChatLabel

updateChatMute()

updateChatMute: (wid, id, muted) => Promise<{ id: number; muted: boolean; }>

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

Update the mute status of a chat.

Parameters

wid

string

id

number

muted

boolean

Returns

Promise<{ id: number; muted: boolean; }>

Implementation of

ChatsBindings.updateChatMute

updateChatNeedsResponse()

updateChatNeedsResponse: (wid, id, needsResponse) => Promise<{ id: number; needsResponse: boolean; }>

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

Update the needs-response flag on a chat.

Parameters

wid

string

id

number

needsResponse

boolean

Returns

Promise<{ id: number; needsResponse: boolean; }>

Implementation of

ChatsBindings.updateChatNeedsResponse

updateClientWorkspace()

updateClientWorkspace: (wid, workspaceId, data) => Promise<ClientWorkspace>

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

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<JourneyStepConnectionResponse>

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

Update a connection (edge) by ID.

Parameters

wid

string

journeyId

number

connectionId

number

data

Partial<JourneyStepConnectionFormData>

Returns

Promise<JourneyStepConnectionResponse>

Implementation of

JourneysBindings.updateConnection

updateConnectionSyncConfig()

updateConnectionSyncConfig: (wid, connectionId, data) => Promise<ConnectionSyncConfig>

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

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:523

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:223

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:784

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:779

Update an existing custom toolkit

Parameters

wid

string

toolkitId

number

data

CustomToolkitUpdateFormData

Returns

Promise<CustomToolkit>

Implementation of

ToolkitsBindings.updateCustomToolkit

updateDataRecord()

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

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

Update an existing data record's field values.

Parameters

wid

string

dataTypeId

number

recordId

number

record

DataRecordFormData

Returns

Promise<DataRecordResponse>

Implementation of

DataTypesBindings.updateDataRecord

updateDataType()

updateDataType: (wid, id, dataType) => Promise<DataTypeResponse>

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

Update an existing data type definition.

Parameters

wid

string

id

number

dataType

Partial<DataTypeFormData>

Returns

Promise<DataTypeResponse>

Implementation of

DataTypesBindings.updateDataType

updateDiscordBot()

updateDiscordBot: (wid, botId, data) => Promise<DiscordBot>

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

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:707

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:625

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:358

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:366

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:361

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:922

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:589

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:604

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:607

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:612

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:407

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:596

Update a folder's properties.

Parameters

wid

string

id

number

Returns

Promise<FileFolderResponse>

Implementation of

FilesBindings.updateFolder

updateFolderRoles()

updateFolderRoles: (wid, folderId, data) => Promise<FileRoleAssociationResponse[]>

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

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:613

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<JourneyGoalResponse>

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

Update an existing goal.

Parameters

wid

string

journeyId

number

goalUuid

string

data

Partial<JourneyGoalFormData>

Returns

Promise<JourneyGoalResponse>

Implementation of

JourneysBindings.updateGoal

updateInbox()

updateInbox: (wid, id, inbox) => Promise<Inbox>

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

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:842

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<Journey>

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

Update an existing journey.

Parameters

wid

string

journeyId

number

data

Partial<JourneyFormData>

Returns

Promise<Journey>

Implementation of

JourneysBindings.updateJourney

updateJourneyNote()

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

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

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:789

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:227

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:259

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:239

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:247

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:253

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:578

Update a menu item's properties.

Parameters

wid

string

siteId

number

itemId

number

item

Partial<MenuItemFormData>

Returns

Promise<MenuItemResponse>

Implementation of

SitesBindings.updateMenuItem

updateMilestone()

updateMilestone: (wid, id, milestone) => Promise<Milestone>

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

Update an existing milestone with partial data.

Parameters

wid

string

id

number

milestone

Partial<MilestoneFormData>

Returns

Promise<Milestone>

Implementation of

CalendarsBindings.updateMilestone

updateMondaySyncConfig()

updateMondaySyncConfig: (wid, syncConfig) => Promise<MondaySyncConfigResponse>

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

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:1057

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:1045

Update a personal pronunciation entry.

Parameters

id

number

data

UpdatePronunciationEntryFormData

Returns

UpdateOperatorGroupRequest

Implementation of

PronunciationsBindings.updateMyPronunciation

updateMyReseller()

updateMyReseller: (uuid, data) => Promise<MyResellerResponse>

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

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:761

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:373

Update an operator group.

Parameters

wid

string

groupId

number

data

Returns

Promise<OperatorGroup>

Implementation of

OperatorBindings.updateOperatorGroup

updatePage()

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

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

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:319

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:733

Update a phone number record.

Parameters

wid

string

id

number

phoneNumber

PhoneNumberFormData

Returns

Promise<PhoneNumber>

Implementation of

CommunicationsBindings.updatePhoneNumber

updatePlatformApp()

updatePlatformApp: (wid, appUuid, data) => Promise<PlatformAppConnectionResponse>

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

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:430

Update an existing product.

Parameters

wid

string

id

number

updates

any

Returns

Promise<Product>

Implementation of

WorkspacesBindings.updateProduct

updatePronunciationEntry()

updatePronunciationEntry: (orgUuid, id, data) => Promise<PronunciationEntryResponse>

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

Update an existing organization pronunciation entry.

Parameters

orgUuid

string

id

number

data

UpdatePronunciationEntryFormData

Returns

UpdateSalesforceSyncConfigRequest

Implementation of

PronunciationsBindings.updatePronunciationEntry

updateRoutine()

updateRoutine: (wid, id, routine) => Promise<RoutineResponse>

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

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:990

Parameters

wid

string

data

Returns

Promise<SalesforceSyncConfigResponse>

Implementation of

IntegrationsBindings.updateSalesforceSyncConfig

updateScenario()

updateScenario: (wid, scenarioId, data) => Promise<Scenario>

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

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:566

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:544

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:901

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<JourneyStepResponse>

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

Update an existing step.

Parameters

wid

string

journeyId

number

stepUuid

string

data

Partial<JourneyStepFormData>

Returns

Promise<JourneyStepResponse>

Implementation of

JourneysBindings.updateStep

updateSubscription()

updateSubscription: (subscriptionId, updates) => Promise<{ message: string; }>

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

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:686

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:127

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:911

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:555

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

updateTwoFactorMethod()

updateTwoFactorMethod: (data) => Promise<TwoFactorOperationResponse>

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

Update settings for a two-factor authentication method.

Parameters

data

UpdateTwoFactorMethodRequest

Returns

UpdateWorkflowContributorRequest

Implementation of

AuthBindings.updateTwoFactorMethod

updateUserAccount()

updateUserAccount: (info) => Promise<Account>

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

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:740

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<Workflow>

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

Update an existing workflow.

Parameters

wid

string

id

number

workflow

Partial<WorkflowFormData>

Returns

Promise<Workflow>

Implementation of

WorkflowsBindings.updateWorkflow

updateWorkflowContributor()

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

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

Update a workflow contributor's settings.

Parameters

wid

string

workflowId

number

contributorId

number

data

Returns

Promise<WorkflowContributorResponse>

Implementation of

WorkflowsBindings.updateWorkflowContributor

updateWorkflowNote()

updateWorkflowNote: (wid, workflowId, noteId, data) => Promise<WorkflowNoteResponse>

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

Update an existing workflow note with partial data.

Parameters

wid

string

workflowId

number

noteId

number

data

Partial<WorkflowNoteFormData>

Returns

Promise<WorkflowNoteResponse>

Implementation of

WorkflowsBindings.updateWorkflowNote

updateWorkflowVersion()

updateWorkflowVersion: (wid, workflowUuid, versionNumber, data) => Promise<WorkflowVersionResponse>

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

Parameters

wid

string

workflowUuid

string

versionNumber

number

data

UpdateVersionRequest

Returns

Promise<WorkflowVersionResponse>

Implementation of

WorkflowsBindings.updateWorkflowVersion

updateWorkspace()

updateWorkspace: (wid, workspace) => Promise<Workspace>

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

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:405

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:471

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:437

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:588

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:212

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

validateDataTypeSlug()

validateDataTypeSlug: (wid, slug, excludeId?) => Promise<{ available: boolean; suggestedSlug?: string; }>

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

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, otp?) => Promise<ValidateMagicLinkResponse>

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

Validate a magic link token and optional OTP to complete authentication.

Parameters

token

string

otp?

string

Returns

Promise<ValidateMagicLinkResponse>

Implementation of

AuthBindings.validateMagicLink

validateQuery()

validateQuery: (wid, query) => Promise<ValidateQueryResponse>

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

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:680

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?) => Promise<VerifyCodeResponse>

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

Verify an SMS code and complete authentication, handling 2FA if required.

Parameters

phoneNumber

string

code

string

organizationUuid?

string

Returns

Promise<VerifyCodeResponse>

Implementation of

AuthBindings.verifyCodeWith2FA

verifyCredentialChange()

verifyCredentialChange: (requestId, otpCode) => Promise<CredentialChangeVerifyResponse>

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

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

verifyEmail()

verifyEmail: (email, code, organizationUuid?) => Promise<VerifyCodeResponse>

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

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:452

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:448

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:456

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; token: string; }>

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

Verify a recovery code during login to complete two-factor authentication.

Parameters

tempToken

string

code

string

Returns

Promise<{ accountId: number; token: string; }>

Implementation of

AuthBindings.verifyRecoveryCodeAuth

verifyTOTPAuth()

verifyTOTPAuth: (tempToken, code) => Promise<{ accountId: number; token: string; }>

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

Verify a TOTP code during login to complete two-factor authentication.

Parameters

tempToken

string

code

string

Returns

Promise<{ accountId: number; token: string; }>

Implementation of

AuthBindings.verifyTOTPAuth

verifyTOTPSetup()

verifyTOTPSetup: (data) => Promise<TwoFactorOperationResponse>

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

Verify a TOTP code to complete two-factor setup.

Parameters

data

VerifyTOTPSetupRequest

Returns

VerifyWebAuthnSetupRequest

Implementation of

AuthBindings.verifyTOTPSetup

verifyWebAuthnAuth()

verifyWebAuthnAuth: (tempToken, assertionResponse) => Promise<{ accountId: number; token: string; }>

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

Verify a WebAuthn assertion during login to complete two-factor authentication.

Parameters

tempToken

string

assertionResponse

any

Returns

Promise<{ accountId: number; token: string; }>

Implementation of

AuthBindings.verifyWebAuthnAuth

verifyWebAuthnSetup()

verifyWebAuthnSetup: (data) => Promise<TwoFactorOperationResponse>

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

Verify a WebAuthn assertion to complete two-factor setup.

Parameters

data

Returns