# Gravity Rail > Build AI experiences that talk, text, email, and call. Gravity Rail is a multi-channel AI platform with a REST API, TypeScript SDK, CLI, and MCP servers. - [Gravity Rail](https://docs.gravityrail.com/index.md) ## developer Complete guide to building AI-powered workflows with Gravity Rail - [Gravity Rail Developer Guide](https://docs.gravityrail.com/developer.md): Complete guide to building AI-powered workflows with Gravity Rail ### api Complete reference documentation for all Gravity Rail API endpoints - [API Reference](https://docs.gravityrail.com/developer/api.md): Complete reference documentation for all Gravity Rail API endpoints - [Account](https://docs.gravityrail.com/developer/api/glb/account.md): Tags: account, authentication - [AI Models](https://docs.gravityrail.com/developer/api/glb/ai_models.md): Tags: ai, configuration, models - [Features](https://docs.gravityrail.com/developer/api/glb/features.md): Tags: capabilities, features - [Organizations](https://docs.gravityrail.com/developer/api/glb/organizations.md): Tags: configuration, organizations - [Resources](https://docs.gravityrail.com/developer/api/glb/resources.md): Tags: configuration, resources - [Abilities](https://docs.gravityrail.com/developer/api/workspace/abilities.md): Tags: abilities, automation, workflows - [Assignments](https://docs.gravityrail.com/developer/api/workspace/assignments.md): Tags: assignments, tasks, workflow - [Calendar Event Types](https://docs.gravityrail.com/developer/api/workspace/calendar_event_types.md): Tags: configuration, events, scheduling - [Calendar Events](https://docs.gravityrail.com/developer/api/workspace/calendar_events.md): Tags: events, scheduling - [Calendars](https://docs.gravityrail.com/developer/api/workspace/calendars.md): Tags: calendars, scheduling - [Calls](https://docs.gravityrail.com/developer/api/workspace/calls.md): Tags: communication, telephony, voice - [Chat Labels](https://docs.gravityrail.com/developer/api/workspace/chat_labels.md): Tags: chat, labels, organization - [Workspace.Chats.Actions](https://docs.gravityrail.com/developer/api/workspace/chats/actions.md): Tags: chat, communication, messaging - [Workspace.Chats.Crud](https://docs.gravityrail.com/developer/api/workspace/chats/crud.md): Tags: chat, communication, messaging - [Workspace.Chats.Messages](https://docs.gravityrail.com/developer/api/workspace/chats/messages.md): Tags: chat, communication, messaging - [Workspace.Chats.Stats](https://docs.gravityrail.com/developer/api/workspace/chats/stats.md): Tags: chat, communication, messaging - [Workspace.Chats.Usage](https://docs.gravityrail.com/developer/api/workspace/chats/usage.md): Tags: chat, communication, messaging - [Workspace.Chats.Voice](https://docs.gravityrail.com/developer/api/workspace/chats/voice.md): Tags: chat, communication, messaging, voice - [Custom Toolkits](https://docs.gravityrail.com/developer/api/workspace/custom_toolkits.md): Tags: ai, customization, tools - [Data Records](https://docs.gravityrail.com/developer/api/workspace/data_records.md): Tags: data, records - [Data Types](https://docs.gravityrail.com/developer/api/workspace/data_types.md): Tags: collections, data - [Event Rules](https://docs.gravityrail.com/developer/api/workspace/event_rules.md): Tags: automation, events, rules - [Files](https://docs.gravityrail.com/developer/api/workspace/files.md): Tags: files, storage - [Folders](https://docs.gravityrail.com/developer/api/workspace/folders.md): Tags: files, organization, storage - [Inboxes](https://docs.gravityrail.com/developer/api/workspace/inboxes.md): Tags: communication, email, messaging - [Journey Notes](https://docs.gravityrail.com/developer/api/workspace/journey_notes.md): Tags: journeys, notes - [Journeys](https://docs.gravityrail.com/developer/api/workspace/journeys.md): Tags: journeys, members - [MCP Servers](https://docs.gravityrail.com/developer/api/workspace/mcp_servers.md): Tags: ai, integrations, mcp - [Member Filters](https://docs.gravityrail.com/developer/api/workspace/member_filters.md): Tags: filters, members, organization - [Member Labels](https://docs.gravityrail.com/developer/api/workspace/member_labels.md): Tags: labels, members, organization - [Member Roles](https://docs.gravityrail.com/developer/api/workspace/member_roles.md): Tags: members, permissions, roles - [Workspace.Members.Bulk](https://docs.gravityrail.com/developer/api/workspace/members/bulk.md): Tags: members, users - [Workspace.Members.Crud](https://docs.gravityrail.com/developer/api/workspace/members/crud.md): Tags: members, users - [Workspace.Members.Current](https://docs.gravityrail.com/developer/api/workspace/members/current.md): Tags: members, users - [Workspace.Members.Export](https://docs.gravityrail.com/developer/api/workspace/members/export.md): Tags: members, users - [Workspace.Members.Fields](https://docs.gravityrail.com/developer/api/workspace/members/fields.md): Tags: members, users - [Workspace.Members.Import Csv](https://docs.gravityrail.com/developer/api/workspace/members/import_csv.md): Tags: members, users - [Workspace.Members.List](https://docs.gravityrail.com/developer/api/workspace/members/list.md): Tags: members, users - [Notification Rules](https://docs.gravityrail.com/developer/api/workspace/notification_rules.md): Tags: automation, notifications, rules - [Notifications](https://docs.gravityrail.com/developer/api/workspace/notifications.md): Tags: alerts, notifications - [Phone Numbers](https://docs.gravityrail.com/developer/api/workspace/phone_numbers.md): Tags: communication, phone, sms - [Push Subscriptions](https://docs.gravityrail.com/developer/api/workspace/push_subscriptions.md): Tags: notifications, push - [Recordings](https://docs.gravityrail.com/developer/api/workspace/recordings.md): Tags: recordings, voice - [Routines](https://docs.gravityrail.com/developer/api/workspace/routines.md): Tags: automation, routines - [Settings](https://docs.gravityrail.com/developer/api/workspace/settings.md): Tags: business-hours, configuration, settings, workspace - [Sharing](https://docs.gravityrail.com/developer/api/workspace/sharing.md): Tags: permissions, sharing - [Sites](https://docs.gravityrail.com/developer/api/workspace/sites.md): Tags: content, sites - [Snippets](https://docs.gravityrail.com/developer/api/workspace/snippets.md): Tags: content, snippets - [Tasks](https://docs.gravityrail.com/developer/api/workspace/tasks.md): Tags: automation, tasks, workflows - [Toolkits](https://docs.gravityrail.com/developer/api/workspace/toolkits.md): Tags: ai, tools - [Webhook Logs](https://docs.gravityrail.com/developer/api/workspace/webhook_logs.md): Tags: integrations, logging, webhooks - [Workflow Versions](https://docs.gravityrail.com/developer/api/workspace/workflow_versions.md): Tags: versions, workflows - [Workspace.Workflows.Activity](https://docs.gravityrail.com/developer/api/workspace/workflows/activity.md): Tags: automation, workflows - [Workspace.Workflows.Contributors](https://docs.gravityrail.com/developer/api/workspace/workflows/contributors.md): Tags: automation, workflows - [Workspace.Workflows.Crud](https://docs.gravityrail.com/developer/api/workspace/workflows/crud.md): Tags: automation, workflows - [Workspace.Workflows.List](https://docs.gravityrail.com/developer/api/workspace/workflows/list.md): Tags: automation, workflows - [Workspace.Workflows.Media](https://docs.gravityrail.com/developer/api/workspace/workflows/media.md): Tags: automation, workflows - [Workspace.Workflows.Stats](https://docs.gravityrail.com/developer/api/workspace/workflows/stats.md): Tags: automation, workflows - [Workspace.Workflows.Validation](https://docs.gravityrail.com/developer/api/workspace/workflows/validation.md): Tags: automation, workflows - [Menu](https://docs.gravityrail.com/developer/api/workspace/workspace_menu.md): Tags: customization, navigation, workspace ### guides Comprehensive guides for integrating with Gravity Rail's core features - [Developer Guides](https://docs.gravityrail.com/developer/guides.md): Comprehensive guides for integrating with Gravity Rail's core features - [AI Disclosure Requirements](https://docs.gravityrail.com/developer/guides/ai-disclosure-requirements.md): Legal requirements for disclosing AI usage to end users - [Authentication](https://docs.gravityrail.com/developer/guides/authentication.md): Learn how to authenticate API requests - [Chat Widget Embed Guide](https://docs.gravityrail.com/developer/guides/chat-widget.md): Embed a floating AI chat launcher on any external site with a single script tag. - [Claude Skills for Gravity Rail](https://docs.gravityrail.com/developer/guides/claude-skills.md): Install the Gravity Rail plugin for Claude Code and Claude Cowork to get AI-assisted SDK and CLI guidance - [Embeddable Widgets](https://docs.gravityrail.com/developer/guides/cross-domain-widgets.md): Embed Gravity Rail chat and operator experiences directly in your own application or website. - [Data in Gravity Rail](https://docs.gravityrail.com/developer/guides/data-in-gravity-rail.md): Understanding data types, fields, records, and permissions - [Error Handling](https://docs.gravityrail.com/developer/guides/error-handling.md): Standard API error response format for integrators - [Exporting Data from Gravity Rail](https://docs.gravityrail.com/developer/guides/exporting-data.md): Extract data from Gravity Rail via APIs, exports, and real-time webhooks - [Getting Started with Integration](https://docs.gravityrail.com/developer/guides/getting-started-integration.md): Complete guide to integrating Gravity Rail into your application - [HIPAA Compliance](https://docs.gravityrail.com/developer/guides/hipaa-compliance.md): How HIPAA compliance works on Gravity Rail and how to enable it for your healthcare workspace - [Importing Data into Gravity Rail](https://docs.gravityrail.com/developer/guides/importing-data.md): Populate Gravity Rail with data via APIs and UIs - [Importing Members into Gravity Rail](https://docs.gravityrail.com/developer/guides/importing-members.md): Create and manage users in your Gravity Rail workspace - [Migration Guide: 0.2.x → 0.3.0](https://docs.gravityrail.com/developer/guides/migration-0.2-to-0.3.md): @gravity-rail/sdk and @gravity-rail/cli released 0.3.0 together (versions are linked — they always bump in lockstep). This guide covers the breaking changes and how to update. - [Operator Widget Embed Guide](https://docs.gravityrail.com/developer/guides/operator-widget.md): Embed the Gravity Rail operator dashboard in your own application so staff can manage conversations without leaving your platform. ### quick_reference Quick reference card for common Gravity Rail API operations - [Gravity Rail API - Quick Reference](https://docs.gravityrail.com/developer/quick_reference.md): Quick reference card for common Gravity Rail API operations ## sdk TypeScript SDK API reference for Gravity Rail - [SDK Reference](https://docs.gravityrail.com/sdk.md): TypeScript SDK API reference for Gravity Rail ### classes - [Class: AgentBuilder](https://docs.gravityrail.com/sdk/classes/AgentBuilder.md): Defined in293 - [Class: ApiError](https://docs.gravityrail.com/sdk/classes/ApiError.md): Defined in50 - [Class: ApplyError](https://docs.gravityrail.com/sdk/classes/ApplyError.md): Defined in476 - [Class: AppsApi](https://docs.gravityrail.com/sdk/classes/AppsApi.md): Defined in10 - [Class: BaseApiClient](https://docs.gravityrail.com/sdk/classes/BaseApiClient.md): Defined in153 - [Class: BuildersApi](https://docs.gravityrail.com/sdk/classes/BuildersApi.md): Defined in13 - [Class: CELApi](https://docs.gravityrail.com/sdk/classes/CELApi.md): Defined in4 - [Class: FormBuilder](https://docs.gravityrail.com/sdk/classes/FormBuilder.md): Defined in53 - [Class: GravityRailClient](https://docs.gravityrail.com/sdk/classes/GravityRailClient.md): Defined in82 - [Class: JourneyBuilder](https://docs.gravityrail.com/sdk/classes/JourneyBuilder.md): Defined in70 - [Class: JourneyStepBuilder](https://docs.gravityrail.com/sdk/classes/JourneyStepBuilder.md): Defined in28 - [Class: MemberFilterBuilder](https://docs.gravityrail.com/sdk/classes/MemberFilterBuilder.md): Defined in17 - [Class: MemberImportValidationError](https://docs.gravityrail.com/sdk/classes/MemberImportValidationError.md): Defined in56 - [Class: MemberLabelBuilder](https://docs.gravityrail.com/sdk/classes/MemberLabelBuilder.md): Defined in225 - [Class: NotificationRuleBuilder](https://docs.gravityrail.com/sdk/classes/NotificationRuleBuilder.md): Defined in138 - [Class: OrgApi](https://docs.gravityrail.com/sdk/classes/OrgApi.md): Defined in63 - [Class: QueriesApi](https://docs.gravityrail.com/sdk/classes/QueriesApi.md): Defined in17 - [Class: RoleUpdate](https://docs.gravityrail.com/sdk/classes/RoleUpdate.md): Defined in5 - [Class: RoutineBuilder](https://docs.gravityrail.com/sdk/classes/RoutineBuilder.md): Defined in67 - [Class: ScopeManager](https://docs.gravityrail.com/sdk/classes/ScopeManager.md): Defined in601 - [Class: SupervisorsApi](https://docs.gravityrail.com/sdk/classes/SupervisorsApi.md): Defined in18 - [Class: TaskBuilder](https://docs.gravityrail.com/sdk/classes/TaskBuilder.md): Defined in75 - [Class: TemplatesApi](https://docs.gravityrail.com/sdk/classes/TemplatesApi.md): Defined in84 - [Class: WorkflowBuilder](https://docs.gravityrail.com/sdk/classes/WorkflowBuilder.md): Defined in145 - [Class: WorkspaceBuilder](https://docs.gravityrail.com/sdk/classes/WorkspaceBuilder.md): Defined in46 ### enumerations - [Enumeration: AccessGrantResourceType](https://docs.gravityrail.com/sdk/enumerations/AccessGrantResourceType.md): Defined in14 - [Enumeration: AccessGrantStatus](https://docs.gravityrail.com/sdk/enumerations/AccessGrantStatus.md): Defined in34 - [Enumeration: AccessGrantTrigger](https://docs.gravityrail.com/sdk/enumerations/AccessGrantTrigger.md): Defined in42 - [Enumeration: AccessLevel](https://docs.gravityrail.com/sdk/enumerations/AccessLevel.md): Defined in24 - [Enumeration: AttendeeResponseStatus](https://docs.gravityrail.com/sdk/enumerations/AttendeeResponseStatus.md): Defined in152 - [Enumeration: AttendeeStatus](https://docs.gravityrail.com/sdk/enumerations/AttendeeStatus.md): Defined in147 - [Enumeration: CalendarEventStatus](https://docs.gravityrail.com/sdk/enumerations/CalendarEventStatus.md): Defined in139 - [Enumeration: CalendarPermissionType](https://docs.gravityrail.com/sdk/enumerations/CalendarPermissionType.md): Defined in51 - [Enumeration: CalendarScheduleAvailabilityType](https://docs.gravityrail.com/sdk/enumerations/CalendarScheduleAvailabilityType.md): Defined in103 - [Enumeration: CalendarScheduleRecurrence](https://docs.gravityrail.com/sdk/enumerations/CalendarScheduleRecurrence.md): Defined in95 - [Enumeration: CalendarSource](https://docs.gravityrail.com/sdk/enumerations/CalendarSource.md): Defined in59 - [Enumeration: CapabilityClass](https://docs.gravityrail.com/sdk/enumerations/CapabilityClass.md): Defined in28 - [Enumeration: ConsentMethod](https://docs.gravityrail.com/sdk/enumerations/ConsentMethod.md): Defined in49 - [Enumeration: CriterionType](https://docs.gravityrail.com/sdk/enumerations/CriterionType.md): Defined in25 - [Enumeration: DataCategory](https://docs.gravityrail.com/sdk/enumerations/DataCategory.md): Defined in84 - [Enumeration: DataFieldType](https://docs.gravityrail.com/sdk/enumerations/DataFieldType.md): Defined in44 - [Enumeration: DataSensitivity](https://docs.gravityrail.com/sdk/enumerations/DataSensitivity.md): Defined in76 - [Enumeration: DataTypeRecordScope](https://docs.gravityrail.com/sdk/enumerations/DataTypeRecordScope.md): Defined in71 - [Enumeration: DriverMode](https://docs.gravityrail.com/sdk/enumerations/DriverMode.md): Defined in30 - [Enumeration: EventRuleActionType](https://docs.gravityrail.com/sdk/enumerations/EventRuleActionType.md): Defined in72 - [Enumeration: EventRuleEventType](https://docs.gravityrail.com/sdk/enumerations/EventRuleEventType.md): Defined in42 - [Enumeration: EventRuleObjectType](https://docs.gravityrail.com/sdk/enumerations/EventRuleObjectType.md): Defined in28 - [Enumeration: FeatureCategory](https://docs.gravityrail.com/sdk/enumerations/FeatureCategory.md): Defined in20 - [Enumeration: FeatureVisibility](https://docs.gravityrail.com/sdk/enumerations/FeatureVisibility.md): Defined in33 - [Enumeration: FhirClientType](https://docs.gravityrail.com/sdk/enumerations/FhirClientType.md): Defined in63 - [Enumeration: FhirConnectionState](https://docs.gravityrail.com/sdk/enumerations/FhirConnectionState.md): Defined in52 - [Enumeration: FhirVendor](https://docs.gravityrail.com/sdk/enumerations/FhirVendor.md): Defined in42 - [Enumeration: IndexStatus](https://docs.gravityrail.com/sdk/enumerations/IndexStatus.md): Defined in64 - [Enumeration: InvitationStatus](https://docs.gravityrail.com/sdk/enumerations/InvitationStatus.md): Defined in20 - [Enumeration: McpServerState](https://docs.gravityrail.com/sdk/enumerations/McpServerState.md): Defined in16 - [Enumeration: MemberFeature](https://docs.gravityrail.com/sdk/enumerations/MemberFeature.md): Defined in202 - [Enumeration: MemberType](https://docs.gravityrail.com/sdk/enumerations/MemberType.md): Defined in114 - [Enumeration: OrgFeature](https://docs.gravityrail.com/sdk/enumerations/OrgFeature.md): Defined in215 - [Enumeration: ProductType](https://docs.gravityrail.com/sdk/enumerations/ProductType.md): Defined in292 - [Enumeration: Resource](https://docs.gravityrail.com/sdk/enumerations/Resource.md): Defined in243 - [Enumeration: Scope](https://docs.gravityrail.com/sdk/enumerations/Scope.md): Defined in99 - [Enumeration: ScopeCategory](https://docs.gravityrail.com/sdk/enumerations/ScopeCategory.md): Defined in15 - [Enumeration: ToolkitState](https://docs.gravityrail.com/sdk/enumerations/ToolkitState.md): Defined in22 - [Enumeration: WorkspaceFeature](https://docs.gravityrail.com/sdk/enumerations/WorkspaceFeature.md): Defined in146 - [Enumeration: WorkspaceProvisionStatus](https://docs.gravityrail.com/sdk/enumerations/WorkspaceProvisionStatus.md): Defined in63 ### functions - [Function: areDependenciesSatisfied()](https://docs.gravityrail.com/sdk/functions/areDependenciesSatisfied.md): areDependenciesSatisfied(slug, enabledFeatures): boolean - [Function: canPreviewVoice()](https://docs.gravityrail.com/sdk/functions/canPreviewVoice.md): canPreviewVoice(entity): boolean - [Function: clearRegistry()](https://docs.gravityrail.com/sdk/functions/clearRegistry.md): clearRegistry(): void - [Function: createWorkspaceClient()](https://docs.gravityrail.com/sdk/functions/createWorkspaceClient.md): createWorkspaceClient(root, workspaceUuid): GravityRailWorkspaceClient - [Function: decodePermissions()](https://docs.gravityrail.com/sdk/functions/decodePermissions.md): decodePermissions(accessMode): ObjectPermissionFlags - [Function: encodePermissions()](https://docs.gravityrail.com/sdk/functions/encodePermissions.md): encodePermissions(permissions): number - [Function: eventRuleActionParams()](https://docs.gravityrail.com/sdk/functions/eventRuleActionParams.md): eventRuleActionParams\(params): T - [Function: formatAppContextAsMarkdown()](https://docs.gravityrail.com/sdk/functions/formatAppContextAsMarkdown.md): formatAppContextAsMarkdown(context): string - [Function: getAllFeatures()](https://docs.gravityrail.com/sdk/functions/getAllFeatures.md): getAllFeatures(): Record\ - [Function: getAllResourceSlugs()](https://docs.gravityrail.com/sdk/functions/getAllResourceSlugs.md): getAllResourceSlugs(): Resource[] - [Function: getApplicableResources()](https://docs.gravityrail.com/sdk/functions/getApplicableResources.md): getApplicableResources(scope, enabledFeatures?): Resource[] - [Function: getApplicableResourceSlugs()](https://docs.gravityrail.com/sdk/functions/getApplicableResourceSlugs.md): getApplicableResourceSlugs(productType): Resource[] - [Function: getAvailableFeaturesForUpgrade()](https://docs.gravityrail.com/sdk/functions/getAvailableFeaturesForUpgrade.md): getAvailableFeaturesForUpgrade(enabledFeatures): FeatureDefinition[] - [Function: getCookieValue()](https://docs.gravityrail.com/sdk/functions/getCookieValue.md): getCookieValue(name): string \| undefined - [Function: getFeature()](https://docs.gravityrail.com/sdk/functions/getFeature.md): getFeature(slug): FeatureDefinition \| undefined - [Function: getFeaturesByCategory()](https://docs.gravityrail.com/sdk/functions/getFeaturesByCategory.md): getFeaturesByCategory(category): FeatureDefinition[] - [Function: getFeaturesByVisibility()](https://docs.gravityrail.com/sdk/functions/getFeaturesByVisibility.md): getFeaturesByVisibility(visibility): FeatureDefinition[] - [Function: getMissingDependencies()](https://docs.gravityrail.com/sdk/functions/getMissingDependencies.md): getMissingDependencies(slug, enabledFeatures): string[] - [Function: getResourceMetadata()](https://docs.gravityrail.com/sdk/functions/getResourceMetadata.md): getResourceMetadata(resource): ResourceMetadata \| undefined - [Function: getScopeFromProductType()](https://docs.gravityrail.com/sdk/functions/getScopeFromProductType.md): getScopeFromProductType(productType): ResourceScope - [Function: getTTSProvider()](https://docs.gravityrail.com/sdk/functions/getTTSProvider.md): getTTSProvider(ttsModel): string \| null - [Function: getVoiceModelId()](https://docs.gravityrail.com/sdk/functions/getVoiceModelId.md): getVoiceModelId(entity): string \| null - [Function: initializeFeatures()](https://docs.gravityrail.com/sdk/functions/initializeFeatures.md): initializeFeatures(features): void - [Function: isChatType()](https://docs.gravityrail.com/sdk/functions/isChatType.md): isChatType(value): value is ChatType - [Function: isFeatureAvailable()](https://docs.gravityrail.com/sdk/functions/isFeatureAvailable.md): isFeatureAvailable(slug, enabledFeatures): boolean - [Function: isRegistryInitialized()](https://docs.gravityrail.com/sdk/functions/isRegistryInitialized.md): isRegistryInitialized(): boolean - [Function: isSMSDeliveryFailureStatus()](https://docs.gravityrail.com/sdk/functions/isSMSDeliveryFailureStatus.md): isSMSDeliveryFailureStatus(status): status is SMSDeliveryFailureStatus - [Function: requiresAssistantParticipant()](https://docs.gravityrail.com/sdk/functions/requiresAssistantParticipant.md): requiresAssistantParticipant(chatType): boolean - [Function: runWorkspaceScript()](https://docs.gravityrail.com/sdk/functions/runWorkspaceScript.md): runWorkspaceScript(client, build, mode?): Promise\ - [Function: usesBuiltinAssistant()](https://docs.gravityrail.com/sdk/functions/usesBuiltinAssistant.md): usesBuiltinAssistant(chatType): boolean - [Function: validateFeatureDependencies()](https://docs.gravityrail.com/sdk/functions/validateFeatureDependencies.md): validateFeatureDependencies(enabledFeatures): string[] ### interfaces - [Interface: A2PBrandEnrollmentUrlResponse](https://docs.gravityrail.com/sdk/interfaces/A2PBrandEnrollmentUrlResponse.md): Defined in278 - [Interface: A2PCampaignConfigResponse](https://docs.gravityrail.com/sdk/interfaces/A2PCampaignConfigResponse.md): Defined in245 - [Interface: A2PEnrollmentSiteCandidate](https://docs.gravityrail.com/sdk/interfaces/A2PEnrollmentSiteCandidate.md): Defined in253 - [Interface: A2PEnrollmentSiteCandidatesResponse](https://docs.gravityrail.com/sdk/interfaces/A2PEnrollmentSiteCandidatesResponse.md): Defined in260 - [Interface: AbilityConfigIssue](https://docs.gravityrail.com/sdk/interfaces/AbilityConfigIssue.md): Defined in24 - [Interface: AbilityTypeResponse](https://docs.gravityrail.com/sdk/interfaces/AbilityTypeResponse.md): Defined in59 - [Interface: AbilityTypesResponse](https://docs.gravityrail.com/sdk/interfaces/AbilityTypesResponse.md): Defined in82 - [Interface: AccessGrantDecision](https://docs.gravityrail.com/sdk/interfaces/AccessGrantDecision.md): Defined in356 - [Interface: Account](https://docs.gravityrail.com/sdk/interfaces/Account.md): Defined in15 - [Interface: AccountFormData](https://docs.gravityrail.com/sdk/interfaces/AccountFormData.md): Defined in92 - [Interface: AccountLookupResponse](https://docs.gravityrail.com/sdk/interfaces/AccountLookupResponse.md): Defined in443 - [Interface: AccountReportItem](https://docs.gravityrail.com/sdk/interfaces/AccountReportItem.md): Defined in339 - [Interface: AccountState](https://docs.gravityrail.com/sdk/interfaces/AccountState.md): Defined in112 - [Interface: AddGroupMemberRequest](https://docs.gravityrail.com/sdk/interfaces/AddGroupMemberRequest.md): Defined in192 - [Interface: Address](https://docs.gravityrail.com/sdk/interfaces/Address.md): Defined in12 - [Interface: AdminBulkWorkflowAccessValidationResponse](https://docs.gravityrail.com/sdk/interfaces/AdminBulkWorkflowAccessValidationResponse.md): Defined in58 - [Interface: AdminChatDetailResponse](https://docs.gravityrail.com/sdk/interfaces/AdminChatDetailResponse.md): Defined in38 - [Interface: AdminChatResponse](https://docs.gravityrail.com/sdk/interfaces/AdminChatResponse.md): Defined in46 - [Interface: AdminChatsOptions](https://docs.gravityrail.com/sdk/interfaces/AdminChatsOptions.md): Defined in390 - [Interface: AdminPidsFindingResponse](https://docs.gravityrail.com/sdk/interfaces/AdminPidsFindingResponse.md): Defined in14 - [Interface: AdminWorkspaceAccessGapSummary](https://docs.gravityrail.com/sdk/interfaces/AdminWorkspaceAccessGapSummary.md): Defined in69 - [Interface: AgentChatParticipant](https://docs.gravityrail.com/sdk/interfaces/AgentChatParticipant.md): Defined in137 - [Interface: AgentConfigFormData](https://docs.gravityrail.com/sdk/interfaces/AgentConfigFormData.md): Defined in207 - [Interface: AgentConfigResponse](https://docs.gravityrail.com/sdk/interfaces/AgentConfigResponse.md): Defined in11 - [Interface: AgentExport](https://docs.gravityrail.com/sdk/interfaces/AgentExport.md): Defined in43 - [Interface: AgentMemoryConfig](https://docs.gravityrail.com/sdk/interfaces/AgentMemoryConfig.md): Defined in103 - [Interface: AgentResponse](https://docs.gravityrail.com/sdk/interfaces/AgentResponse.md): Defined in38 - [Interface: AIModelsResponse](https://docs.gravityrail.com/sdk/interfaces/AIModelsResponse.md): Defined in42 - [Interface: AIModelUsageResponse](https://docs.gravityrail.com/sdk/interfaces/AIModelUsageResponse.md): Defined in11 - [Interface: AIUsageDetailsResponse](https://docs.gravityrail.com/sdk/interfaces/AIUsageDetailsResponse.md): Defined in25 - [Interface: AIUsageReport](https://docs.gravityrail.com/sdk/interfaces/AIUsageReport.md): Defined in12 - [Interface: AIUsageReportParams](https://docs.gravityrail.com/sdk/interfaces/AIUsageReportParams.md): Defined in34 - [Interface: AllModelsResponse](https://docs.gravityrail.com/sdk/interfaces/AllModelsResponse.md): Defined in11 - [Interface: AnalyticsFilter](https://docs.gravityrail.com/sdk/interfaces/AnalyticsFilter.md): Defined in49 - [Interface: AnalyticsQuery](https://docs.gravityrail.com/sdk/interfaces/AnalyticsQuery.md): Defined in60 - [Interface: AnonymousInteractionResponse](https://docs.gravityrail.com/sdk/interfaces/AnonymousInteractionResponse.md): Defined in61 - [Interface: AnonymousMemberResolutionResponse](https://docs.gravityrail.com/sdk/interfaces/AnonymousMemberResolutionResponse.md): Defined in74 - [Interface: ApiKey](https://docs.gravityrail.com/sdk/interfaces/ApiKey.md): Defined in148 - [Interface: ApiKeyCreated](https://docs.gravityrail.com/sdk/interfaces/ApiKeyCreated.md): Defined in131 - [Interface: ApiKeyFormData](https://docs.gravityrail.com/sdk/interfaces/ApiKeyFormData.md): Defined in209 - [Interface: ApiKeyScope](https://docs.gravityrail.com/sdk/interfaces/ApiKeyScope.md): Defined in215 - [Interface: ApiKeyScopesResponse](https://docs.gravityrail.com/sdk/interfaces/ApiKeyScopesResponse.md): Defined in221 - [Interface: ApiScope](https://docs.gravityrail.com/sdk/interfaces/ApiScope.md): Defined in127 - [Interface: ApiValidationError](https://docs.gravityrail.com/sdk/interfaces/ApiValidationError.md): Defined in27 - [Interface: AppBuilder](https://docs.gravityrail.com/sdk/interfaces/AppBuilder.md): Defined in20 - [Interface: AppConnectionAccessInterrupt](https://docs.gravityrail.com/sdk/interfaces/AppConnectionAccessInterrupt.md): Defined in362 - [Interface: AppConnectionDirectoryEntry](https://docs.gravityrail.com/sdk/interfaces/AppConnectionDirectoryEntry.md): Defined in11 - [Interface: AppConnectionDirectoryResponse](https://docs.gravityrail.com/sdk/interfaces/AppConnectionDirectoryResponse.md): Defined in30 - [Interface: AppContext](https://docs.gravityrail.com/sdk/interfaces/AppContext.md): Defined in66 - [Interface: AppCredentialResponse](https://docs.gravityrail.com/sdk/interfaces/AppCredentialResponse.md): Defined in11 - [Interface: AssignmentResponse](https://docs.gravityrail.com/sdk/interfaces/AssignmentResponse.md): Defined in76 - [Interface: AssignmentsQueryParams](https://docs.gravityrail.com/sdk/interfaces/AssignmentsQueryParams.md): Defined in113 - [Interface: AssignmentTaskResponse](https://docs.gravityrail.com/sdk/interfaces/AssignmentTaskResponse.md): Defined in104 - [Interface: AssistantMessageActionParams](https://docs.gravityrail.com/sdk/interfaces/AssistantMessageActionParams.md): Defined in232 - [Interface: AttachedAddonInfo](https://docs.gravityrail.com/sdk/interfaces/AttachedAddonInfo.md): Defined in11 - [Interface: AttendeeResponse](https://docs.gravityrail.com/sdk/interfaces/AttendeeResponse.md): Defined in12 - [Interface: AudioMessageMetadata](https://docs.gravityrail.com/sdk/interfaces/AudioMessageMetadata.md): Defined in311 - [Interface: AudioPlaybackAbilityConfig](https://docs.gravityrail.com/sdk/interfaces/AudioPlaybackAbilityConfig.md): Defined in321 - [Interface: AudioPlaybackFileEntry](https://docs.gravityrail.com/sdk/interfaces/AudioPlaybackFileEntry.md): Defined in311 - [Interface: AuthorizedRep](https://docs.gravityrail.com/sdk/interfaces/AuthorizedRep.md): Defined in85 - [Interface: AuthorizeRequest](https://docs.gravityrail.com/sdk/interfaces/AuthorizeRequest.md): Defined in94 - [Interface: AuthorizeResponse](https://docs.gravityrail.com/sdk/interfaces/AuthorizeResponse.md): Defined in104 - [Interface: AvailabilityCheck](https://docs.gravityrail.com/sdk/interfaces/AvailabilityCheck.md): Defined in164 - [Interface: AvailabilityResponse](https://docs.gravityrail.com/sdk/interfaces/AvailabilityResponse.md): Defined in24 - [Interface: AvailableMemberRole](https://docs.gravityrail.com/sdk/interfaces/AvailableMemberRole.md): Defined in147 - [Interface: AvailableSlotsRequest](https://docs.gravityrail.com/sdk/interfaces/AvailableSlotsRequest.md): Defined in170 - [Interface: AvailableSlotsResponse](https://docs.gravityrail.com/sdk/interfaces/AvailableSlotsResponse.md): Defined in36 - [Interface: AWSRealtimeModelConfig](https://docs.gravityrail.com/sdk/interfaces/AWSRealtimeModelConfig.md): Defined in101 - [Interface: BaseChatModelConfig](https://docs.gravityrail.com/sdk/interfaces/BaseChatModelConfig.md): Defined in147 - [Interface: BaseRealtimeModelConfig](https://docs.gravityrail.com/sdk/interfaces/BaseRealtimeModelConfig.md): Defined in59 - [Interface: BillingResourceCounts](https://docs.gravityrail.com/sdk/interfaces/BillingResourceCounts.md): Defined in202 - [Interface: BillingStatistics](https://docs.gravityrail.com/sdk/interfaces/BillingStatistics.md): Defined in125 - [Interface: BillingUsageInfo](https://docs.gravityrail.com/sdk/interfaces/BillingUsageInfo.md): Defined in389 - [Interface: BoardsResponse](https://docs.gravityrail.com/sdk/interfaces/BoardsResponse.md): Defined in37 - [Interface: BuilderListResponse](https://docs.gravityrail.com/sdk/interfaces/BuilderListResponse.md): Defined in15 - [Interface: BuilderResponse](https://docs.gravityrail.com/sdk/interfaces/BuilderResponse.md): Defined in11 - [Interface: BuildWorkspaceRequest](https://docs.gravityrail.com/sdk/interfaces/BuildWorkspaceRequest.md): Defined in65 - [Interface: BuildWorkspaceResponse](https://docs.gravityrail.com/sdk/interfaces/BuildWorkspaceResponse.md): Defined in21 - [Interface: BulkCreateDataRecordRequest](https://docs.gravityrail.com/sdk/interfaces/BulkCreateDataRecordRequest.md): Defined in235 - [Interface: BulkCreateDataRecordResponse](https://docs.gravityrail.com/sdk/interfaces/BulkCreateDataRecordResponse.md): Defined in227 - [Interface: BulkCreateMembersRequest](https://docs.gravityrail.com/sdk/interfaces/BulkCreateMembersRequest.md): Defined in201 - [Interface: BulkCreateMembersResponse](https://docs.gravityrail.com/sdk/interfaces/BulkCreateMembersResponse.md): Defined in107 - [Interface: BulkMemberItem](https://docs.gravityrail.com/sdk/interfaces/BulkMemberItem.md): Defined in185 - [Interface: BulkMemberResult](https://docs.gravityrail.com/sdk/interfaces/BulkMemberResult.md): Defined in137 - [Interface: BulkRecordResult](https://docs.gravityrail.com/sdk/interfaces/BulkRecordResult.md): Defined in220 - [Interface: BusinessHoursDay](https://docs.gravityrail.com/sdk/interfaces/BusinessHoursDay.md): Defined in117 - [Interface: BusinessInfo](https://docs.gravityrail.com/sdk/interfaces/BusinessInfo.md): Defined in159 - [Interface: BusinessProfileCancelResponse](https://docs.gravityrail.com/sdk/interfaces/BusinessProfileCancelResponse.md): Defined in182 - [Interface: BusinessProfileSubmitResponse](https://docs.gravityrail.com/sdk/interfaces/BusinessProfileSubmitResponse.md): Defined in223 - [Interface: CalendarBookingAbilityConfig](https://docs.gravityrail.com/sdk/interfaces/CalendarBookingAbilityConfig.md): Defined in84 - [Interface: CalendarEventFormData](https://docs.gravityrail.com/sdk/interfaces/CalendarEventFormData.md): Defined in126 - [Interface: CalendarEventsQueryParams](https://docs.gravityrail.com/sdk/interfaces/CalendarEventsQueryParams.md): Defined in177 - [Interface: CalendarEventTypeFormData](https://docs.gravityrail.com/sdk/interfaces/CalendarEventTypeFormData.md): Defined in108 - [Interface: CalendarFormData](https://docs.gravityrail.com/sdk/interfaces/CalendarFormData.md): Defined in65 - [Interface: CalendarScheduleFormData](https://docs.gravityrail.com/sdk/interfaces/CalendarScheduleFormData.md): Defined in81 - [Interface: CancelCredentialChangeInviteResponse](https://docs.gravityrail.com/sdk/interfaces/CancelCredentialChangeInviteResponse.md): Defined in164 - [Interface: CancelCredentialChangeResponse](https://docs.gravityrail.com/sdk/interfaces/CancelCredentialChangeResponse.md): Defined in172 - [Interface: CELContextRequest](https://docs.gravityrail.com/sdk/interfaces/CELContextRequest.md): Defined in29 - [Interface: CELContextResponse](https://docs.gravityrail.com/sdk/interfaces/CELContextResponse.md): Defined in51 - [Interface: CELFunction](https://docs.gravityrail.com/sdk/interfaces/CELFunction.md): Defined in19 - [Interface: CELVariable](https://docs.gravityrail.com/sdk/interfaces/CELVariable.md): Defined in8 - [Interface: ChangeWorkspaceProductRequest](https://docs.gravityrail.com/sdk/interfaces/ChangeWorkspaceProductRequest.md): Defined in26 - [Interface: ChangeWorkspaceProductResponse](https://docs.gravityrail.com/sdk/interfaces/ChangeWorkspaceProductResponse.md): Defined in33 - [Interface: ChannelErrorBreakdown](https://docs.gravityrail.com/sdk/interfaces/ChannelErrorBreakdown.md): Defined in38 - [Interface: ChannelFailures](https://docs.gravityrail.com/sdk/interfaces/ChannelFailures.md): Defined in11 - [Interface: CharlestonPmdAbilityConfig](https://docs.gravityrail.com/sdk/interfaces/CharlestonPmdAbilityConfig.md): Defined in327 - [Interface: ChatActivityEvent](https://docs.gravityrail.com/sdk/interfaces/ChatActivityEvent.md): Defined in139 - [Interface: ChatCompletionError](https://docs.gravityrail.com/sdk/interfaces/ChatCompletionError.md): Defined in266 - [Interface: ChatContinueActionParams](https://docs.gravityrail.com/sdk/interfaces/ChatContinueActionParams.md): Defined in282 - [Interface: ChatCreateActionParams](https://docs.gravityrail.com/sdk/interfaces/ChatCreateActionParams.md): Defined in272 - [Interface: ChatFilterFormData](https://docs.gravityrail.com/sdk/interfaces/ChatFilterFormData.md): Defined in445 - [Interface: ChatFilterResponse](https://docs.gravityrail.com/sdk/interfaces/ChatFilterResponse.md): Defined in90 - [Interface: ChatFilterRuleFormData](https://docs.gravityrail.com/sdk/interfaces/ChatFilterRuleFormData.md): Defined in438 - [Interface: ChatFilterRuleResponse](https://docs.gravityrail.com/sdk/interfaces/ChatFilterRuleResponse.md): Defined in104 - [Interface: ChatFormData](https://docs.gravityrail.com/sdk/interfaces/ChatFormData.md): Defined in85 - [Interface: ChatInterruptResponse](https://docs.gravityrail.com/sdk/interfaces/ChatInterruptResponse.md): Defined in122 - [Interface: ChatLabelFormData](https://docs.gravityrail.com/sdk/interfaces/ChatLabelFormData.md): Defined in77 - [Interface: ChatLabelResponse](https://docs.gravityrail.com/sdk/interfaces/ChatLabelResponse.md): Defined in144 - [Interface: ChatMessage](https://docs.gravityrail.com/sdk/interfaces/ChatMessage.md): Defined in242 - [Interface: ChatMessageChunk](https://docs.gravityrail.com/sdk/interfaces/ChatMessageChunk.md): Defined in283 - [Interface: ChatMessageObject](https://docs.gravityrail.com/sdk/interfaces/ChatMessageObject.md): Defined in278 - [Interface: ChatModelResponse](https://docs.gravityrail.com/sdk/interfaces/ChatModelResponse.md): Defined in22 - [Interface: ChatNoteSyncConfig](https://docs.gravityrail.com/sdk/interfaces/ChatNoteSyncConfig.md): Defined in225 - [Interface: ChatNoteSyncFilters](https://docs.gravityrail.com/sdk/interfaces/ChatNoteSyncFilters.md): Defined in220 - [Interface: ChatParticipantFormData](https://docs.gravityrail.com/sdk/interfaces/ChatParticipantFormData.md): Defined in114 - [Interface: ChatParticipantResponse](https://docs.gravityrail.com/sdk/interfaces/ChatParticipantResponse.md): Defined in189 - [Interface: ChatPauseActionParams](https://docs.gravityrail.com/sdk/interfaces/ChatPauseActionParams.md): Defined in287 - [Interface: ChatResponse](https://docs.gravityrail.com/sdk/interfaces/ChatResponse.md): Defined in208 - [Interface: ChatState](https://docs.gravityrail.com/sdk/interfaces/ChatState.md): Defined in54 - [Interface: ChatSummarizeActionParams](https://docs.gravityrail.com/sdk/interfaces/ChatSummarizeActionParams.md): Defined in291 - [Interface: ChatTokenUsageResponse](https://docs.gravityrail.com/sdk/interfaces/ChatTokenUsageResponse.md): Defined in244 - [Interface: ChildTaskFormData](https://docs.gravityrail.com/sdk/interfaces/ChildTaskFormData.md): Defined in81 - [Interface: ChildTaskResponse](https://docs.gravityrail.com/sdk/interfaces/ChildTaskResponse.md): Defined in120 - [Interface: ClaudeChatModelConfig](https://docs.gravityrail.com/sdk/interfaces/ClaudeChatModelConfig.md): Defined in154 - [Interface: CleanupChatsResponse](https://docs.gravityrail.com/sdk/interfaces/CleanupChatsResponse.md): Defined in275 - [Interface: ClientWorkspace](https://docs.gravityrail.com/sdk/interfaces/ClientWorkspace.md): Defined in103 - [Interface: ColumnsResponse](https://docs.gravityrail.com/sdk/interfaces/ColumnsResponse.md): Defined in41 - [Interface: CommunicationDetailsResponse](https://docs.gravityrail.com/sdk/interfaces/CommunicationDetailsResponse.md): Defined in37 - [Interface: CompareWithStripeResponse](https://docs.gravityrail.com/sdk/interfaces/CompareWithStripeResponse.md): Defined in18 - [Interface: ConcludeAssignmentActionParams](https://docs.gravityrail.com/sdk/interfaces/ConcludeAssignmentActionParams.md): Defined in304 - [Interface: ConfigurePatientSyncRequest](https://docs.gravityrail.com/sdk/interfaces/ConfigurePatientSyncRequest.md): Defined in9 - [Interface: ConflictPolicy](https://docs.gravityrail.com/sdk/interfaces/ConflictPolicy.md): Defined in483 - [Interface: ConfluenceConnectionResponse](https://docs.gravityrail.com/sdk/interfaces/ConfluenceConnectionResponse.md): Defined in38 - [Interface: ConnectionSyncConfig](https://docs.gravityrail.com/sdk/interfaces/ConnectionSyncConfig.md): Defined in518 - [Interface: ContributorChatParticipant](https://docs.gravityrail.com/sdk/interfaces/ContributorChatParticipant.md): Defined in151 - [Interface: ConversationControlAbilityConfig](https://docs.gravityrail.com/sdk/interfaces/ConversationControlAbilityConfig.md): Defined in387 - [Interface: ConversationHistoryAbilityConfig](https://docs.gravityrail.com/sdk/interfaces/ConversationHistoryAbilityConfig.md): Defined in266 - [Interface: ConvertedFileResponse](https://docs.gravityrail.com/sdk/interfaces/ConvertedFileResponse.md): Defined in12 - [Interface: CreateAccessGrantRequest](https://docs.gravityrail.com/sdk/interfaces/CreateAccessGrantRequest.md): Defined in58 - [Interface: CreateAccountOrgMembershipRequest](https://docs.gravityrail.com/sdk/interfaces/CreateAccountOrgMembershipRequest.md): Defined in452 - [Interface: CreateAccountOrgMembershipResponse](https://docs.gravityrail.com/sdk/interfaces/CreateAccountOrgMembershipResponse.md): Defined in457 - [Interface: CreateAgentRequest](https://docs.gravityrail.com/sdk/interfaces/CreateAgentRequest.md): Defined in441 - [Interface: CreateAnonymousMemberRequest](https://docs.gravityrail.com/sdk/interfaces/CreateAnonymousMemberRequest.md): Defined in494 - [Interface: CreateAppConnectionRequest](https://docs.gravityrail.com/sdk/interfaces/CreateAppConnectionRequest.md): Defined in619 - [Interface: CreateAppRequest](https://docs.gravityrail.com/sdk/interfaces/CreateAppRequest.md): Defined in39 - [Interface: CreateAssignmentFormData](https://docs.gravityrail.com/sdk/interfaces/CreateAssignmentFormData.md): Defined in129 - [Interface: CreateBuilderRequest](https://docs.gravityrail.com/sdk/interfaces/CreateBuilderRequest.md): Defined in20 - [Interface: CreateCredentialChangeInviteRequest](https://docs.gravityrail.com/sdk/interfaces/CreateCredentialChangeInviteRequest.md): Defined in488 - [Interface: CreateDiscordBotRequest](https://docs.gravityrail.com/sdk/interfaces/CreateDiscordBotRequest.md): Defined in39 - [Interface: CreateFhirConnectionRequest](https://docs.gravityrail.com/sdk/interfaces/CreateFhirConnectionRequest.md): Defined in71 - [Interface: CreateMemberFieldRequest](https://docs.gravityrail.com/sdk/interfaces/CreateMemberFieldRequest.md): Defined in15 - [Interface: CreateOperatorGroupRequest](https://docs.gravityrail.com/sdk/interfaces/CreateOperatorGroupRequest.md): Defined in180 - [Interface: CreateOrganizationInvitationFormData](https://docs.gravityrail.com/sdk/interfaces/CreateOrganizationInvitationFormData.md): Defined in49 - [Interface: CreateOrganizationRequest](https://docs.gravityrail.com/sdk/interfaces/CreateOrganizationRequest.md): Defined in273 - [Interface: CreatePersonaRequest](https://docs.gravityrail.com/sdk/interfaces/CreatePersonaRequest.md): Defined in97 - [Interface: CreatePhoneVoiceOutboundChatInput](https://docs.gravityrail.com/sdk/interfaces/CreatePhoneVoiceOutboundChatInput.md): Defined in121 - [Interface: CreateProductRequest](https://docs.gravityrail.com/sdk/interfaces/CreateProductRequest.md): Defined in373 - [Interface: CreatePronunciationEntryFormData](https://docs.gravityrail.com/sdk/interfaces/CreatePronunciationEntryFormData.md): Defined in16 - [Interface: CreateRoutineRequest](https://docs.gravityrail.com/sdk/interfaces/CreateRoutineRequest.md): Defined in562 - [Interface: CreateScenarioRequest](https://docs.gravityrail.com/sdk/interfaces/CreateScenarioRequest.md): Defined in70 - [Interface: CreateSignupResponse](https://docs.gravityrail.com/sdk/interfaces/CreateSignupResponse.md): Defined in193 - [Interface: CreateSlackAppRequest](https://docs.gravityrail.com/sdk/interfaces/CreateSlackAppRequest.md): Defined in76 - [Interface: CreateTeamsAppRequest](https://docs.gravityrail.com/sdk/interfaces/CreateTeamsAppRequest.md): Defined in61 - [Interface: CreateWorkflowContributorRequest](https://docs.gravityrail.com/sdk/interfaces/CreateWorkflowContributorRequest.md): Defined in157 - [Interface: CreateWorkflowFromTemplateFormData](https://docs.gravityrail.com/sdk/interfaces/CreateWorkflowFromTemplateFormData.md): Defined in212 - [Interface: CreateWorkspaceInvitationFormData](https://docs.gravityrail.com/sdk/interfaces/CreateWorkspaceInvitationFormData.md): Defined in43 - [Interface: CreateWorkspaceMemberRequest](https://docs.gravityrail.com/sdk/interfaces/CreateWorkspaceMemberRequest.md): Defined in343 - [Interface: CredentialChangeInviteConfirmResponse](https://docs.gravityrail.com/sdk/interfaces/CredentialChangeInviteConfirmResponse.md): Defined in180 - [Interface: CredentialChangeInviteDetails](https://docs.gravityrail.com/sdk/interfaces/CredentialChangeInviteDetails.md): Defined in199 - [Interface: CredentialChangeInviteResponse](https://docs.gravityrail.com/sdk/interfaces/CredentialChangeInviteResponse.md): Defined in223 - [Interface: CredentialChangeRequestResponse](https://docs.gravityrail.com/sdk/interfaces/CredentialChangeRequestResponse.md): Defined in242 - [Interface: CredentialChangeVerifyResponse](https://docs.gravityrail.com/sdk/interfaces/CredentialChangeVerifyResponse.md): Defined in260 - [Interface: CriterionInput](https://docs.gravityrail.com/sdk/interfaces/CriterionInput.md): Defined in59 - [Interface: CriterionResultResponse](https://docs.gravityrail.com/sdk/interfaces/CriterionResultResponse.md): Defined in65 - [Interface: CurrentMemberResponse](https://docs.gravityrail.com/sdk/interfaces/CurrentMemberResponse.md): Defined in236 - [Interface: CurrentOrgMember](https://docs.gravityrail.com/sdk/interfaces/CurrentOrgMember.md): Defined in426 - [Interface: CurrentPlanInfo](https://docs.gravityrail.com/sdk/interfaces/CurrentPlanInfo.md): Defined in50 - [Interface: CursorPaginatedResponse](https://docs.gravityrail.com/sdk/interfaces/CursorPaginatedResponse.md): Defined in13 - [Interface: CustomRealtimeModelConfig](https://docs.gravityrail.com/sdk/interfaces/CustomRealtimeModelConfig.md): Defined in93 - [Interface: CustomToolExport](https://docs.gravityrail.com/sdk/interfaces/CustomToolExport.md): Defined in265 - [Interface: CustomToolFormData](https://docs.gravityrail.com/sdk/interfaces/CustomToolFormData.md): Defined in55 - [Interface: CustomToolkitExport](https://docs.gravityrail.com/sdk/interfaces/CustomToolkitExport.md): Defined in259 - [Interface: CustomToolkitFormData](https://docs.gravityrail.com/sdk/interfaces/CustomToolkitFormData.md): Defined in81 - [Interface: CustomToolkitUpdateFormData](https://docs.gravityrail.com/sdk/interfaces/CustomToolkitUpdateFormData.md): Defined in90 - [Interface: CustomToolUpdateFormData](https://docs.gravityrail.com/sdk/interfaces/CustomToolUpdateFormData.md): Defined in68 - [Interface: DailyPhoneRowResponse](https://docs.gravityrail.com/sdk/interfaces/DailyPhoneRowResponse.md): Defined in45 - [Interface: DailySMSRowResponse](https://docs.gravityrail.com/sdk/interfaces/DailySMSRowResponse.md): Defined in58 - [Interface: DashboardMetrics](https://docs.gravityrail.com/sdk/interfaces/DashboardMetrics.md): Defined in71 - [Interface: DataAccessAbilityConfig](https://docs.gravityrail.com/sdk/interfaces/DataAccessAbilityConfig.md): Defined in154 - [Interface: DataAccessGrantInterrupt](https://docs.gravityrail.com/sdk/interfaces/DataAccessGrantInterrupt.md): Defined in374 - [Interface: DataField](https://docs.gravityrail.com/sdk/interfaces/DataField.md): Defined in96 - [Interface: DataFieldFormData](https://docs.gravityrail.com/sdk/interfaces/DataFieldFormData.md): Defined in114 - [Interface: DataIntegrityReportItem](https://docs.gravityrail.com/sdk/interfaces/DataIntegrityReportItem.md): Defined in196 - [Interface: DataRecordAssociationFormData](https://docs.gravityrail.com/sdk/interfaces/DataRecordAssociationFormData.md): Defined in177 - [Interface: DataRecordContext](https://docs.gravityrail.com/sdk/interfaces/DataRecordContext.md): Defined in46 - [Interface: DataRecordFieldWarning](https://docs.gravityrail.com/sdk/interfaces/DataRecordFieldWarning.md): Defined in288 - [Interface: DataRecordFormData](https://docs.gravityrail.com/sdk/interfaces/DataRecordFormData.md): Defined in165 - [Interface: DataRecordReportItem](https://docs.gravityrail.com/sdk/interfaces/DataRecordReportItem.md): Defined in186 - [Interface: DataRecordResponse](https://docs.gravityrail.com/sdk/interfaces/DataRecordResponse.md): Defined in62 - [Interface: DataRecordRetirementResponse](https://docs.gravityrail.com/sdk/interfaces/DataRecordRetirementResponse.md): Defined in88 - [Interface: DataRecordsPaginatedResponse](https://docs.gravityrail.com/sdk/interfaces/DataRecordsPaginatedResponse.md): Defined in24 - [Interface: DataRecordUpdateResponse](https://docs.gravityrail.com/sdk/interfaces/DataRecordUpdateResponse.md): Defined in102 - [Interface: DataRecordWithAccessMode](https://docs.gravityrail.com/sdk/interfaces/DataRecordWithAccessMode.md): Defined in182 - [Interface: DataTypeExport](https://docs.gravityrail.com/sdk/interfaces/DataTypeExport.md): Defined in32 - [Interface: DataTypeExportItem](https://docs.gravityrail.com/sdk/interfaces/DataTypeExportItem.md): Defined in205 - [Interface: DataTypeFormData](https://docs.gravityrail.com/sdk/interfaces/DataTypeFormData.md): Defined in146 - [Interface: DataTypeMemberRoleAccessInput](https://docs.gravityrail.com/sdk/interfaces/DataTypeMemberRoleAccessInput.md): Defined in172 - [Interface: DataTypeMemberRoleAccessResponse](https://docs.gravityrail.com/sdk/interfaces/DataTypeMemberRoleAccessResponse.md): Defined in116 - [Interface: DataTypeResponse](https://docs.gravityrail.com/sdk/interfaces/DataTypeResponse.md): Defined in122 - [Interface: DayAggregatedData](https://docs.gravityrail.com/sdk/interfaces/DayAggregatedData.md): Defined in72 - [Interface: DayCallAggregatedData](https://docs.gravityrail.com/sdk/interfaces/DayCallAggregatedData.md): Defined in93 - [Interface: DeleteAccountOrgMembershipResponse](https://docs.gravityrail.com/sdk/interfaces/DeleteAccountOrgMembershipResponse.md): Defined in466 - [Interface: DetailedAccount](https://docs.gravityrail.com/sdk/interfaces/DetailedAccount.md): Defined in88 - [Interface: DiscordBotAccount](https://docs.gravityrail.com/sdk/interfaces/DiscordBotAccount.md): Defined in136 - [Interface: DiscordGuild](https://docs.gravityrail.com/sdk/interfaces/DiscordGuild.md): Defined in123 - [Interface: DiscordThread](https://docs.gravityrail.com/sdk/interfaces/DiscordThread.md): Defined in93 - [Interface: DisplayFileLabelResponse](https://docs.gravityrail.com/sdk/interfaces/DisplayFileLabelResponse.md): Defined in192 - [Interface: DisplayFileResponse](https://docs.gravityrail.com/sdk/interfaces/DisplayFileResponse.md): Defined in198 - [Interface: DomainMapping](https://docs.gravityrail.com/sdk/interfaces/DomainMapping.md): Defined in251 - [Interface: DuplicateAccountInfo](https://docs.gravityrail.com/sdk/interfaces/DuplicateAccountInfo.md): Defined in349 - [Interface: EcwRefreshMemberEncountersActionParams](https://docs.gravityrail.com/sdk/interfaces/EcwRefreshMemberEncountersActionParams.md): Defined in377 - [Interface: EfficiencyMetricsResponse](https://docs.gravityrail.com/sdk/interfaces/EfficiencyMetricsResponse.md): Defined in72 - [Interface: Email](https://docs.gravityrail.com/sdk/interfaces/Email.md): Defined in180 - [Interface: EmailAttachment](https://docs.gravityrail.com/sdk/interfaces/EmailAttachment.md): Defined in154 - [Interface: EmailConversionResponse](https://docs.gravityrail.com/sdk/interfaces/EmailConversionResponse.md): Defined in135 - [Interface: EmailCountsResponse](https://docs.gravityrail.com/sdk/interfaces/EmailCountsResponse.md): Defined in12 - [Interface: EmailDisableImpactResponse](https://docs.gravityrail.com/sdk/interfaces/EmailDisableImpactResponse.md): Defined in297 - [Interface: EmailDomainConfigResponse](https://docs.gravityrail.com/sdk/interfaces/EmailDomainConfigResponse.md): Defined in343 - [Interface: EmailSendActionParams](https://docs.gravityrail.com/sdk/interfaces/EmailSendActionParams.md): Defined in350 - [Interface: EmailUsageResponse](https://docs.gravityrail.com/sdk/interfaces/EmailUsageResponse.md): Defined in80 - [Interface: EmailVerificationResponse](https://docs.gravityrail.com/sdk/interfaces/EmailVerificationResponse.md): Defined in362 - [Interface: EncounterSyncDataTypeSummary](https://docs.gravityrail.com/sdk/interfaces/EncounterSyncDataTypeSummary.md): Defined in92 - [Interface: EncounterSyncHistoryItem](https://docs.gravityrail.com/sdk/interfaces/EncounterSyncHistoryItem.md): Defined in360 - [Interface: EncounterSyncRunResponse](https://docs.gravityrail.com/sdk/interfaces/EncounterSyncRunResponse.md): Defined in102 - [Interface: EncounterSyncStatusResponse](https://docs.gravityrail.com/sdk/interfaces/EncounterSyncStatusResponse.md): Defined in120 - [Interface: EngineTimeSeries](https://docs.gravityrail.com/sdk/interfaces/EngineTimeSeries.md): Defined in20 - [Interface: EnrichInquiryRequest](https://docs.gravityrail.com/sdk/interfaces/EnrichInquiryRequest.md): Defined in29 - [Interface: EntitySyncConfig](https://docs.gravityrail.com/sdk/interfaces/EntitySyncConfig.md): Defined in501 - [Interface: EnumOption](https://docs.gravityrail.com/sdk/interfaces/EnumOption.md): Defined in133 - [Interface: ErrorCodeBucket](https://docs.gravityrail.com/sdk/interfaces/ErrorCodeBucket.md): Defined in25 - [Interface: ErrorResponse](https://docs.gravityrail.com/sdk/interfaces/ErrorResponse.md): Defined in173 - [Interface: EscalationAbilityConfig](https://docs.gravityrail.com/sdk/interfaces/EscalationAbilityConfig.md): Defined in242 - [Interface: EventActionMapping](https://docs.gravityrail.com/sdk/interfaces/EventActionMapping.md): Defined in39 - [Interface: EventActionMappingsResponse](https://docs.gravityrail.com/sdk/interfaces/EventActionMappingsResponse.md): Defined in47 - [Interface: EventResponse](https://docs.gravityrail.com/sdk/interfaces/EventResponse.md): Defined in208 - [Interface: EventRuleExport](https://docs.gravityrail.com/sdk/interfaces/EventRuleExport.md): Defined in63 - [Interface: EventRuleExportItem](https://docs.gravityrail.com/sdk/interfaces/EventRuleExportItem.md): Defined in655 - [Interface: EventRuleFormData](https://docs.gravityrail.com/sdk/interfaces/EventRuleFormData.md): Defined in475 - [Interface: EventRuleInput](https://docs.gravityrail.com/sdk/interfaces/EventRuleInput.md): Defined in515 - [Interface: EventRuleMetrics](https://docs.gravityrail.com/sdk/interfaces/EventRuleMetrics.md): Defined in27 - [Interface: EventTypeResponse](https://docs.gravityrail.com/sdk/interfaces/EventTypeResponse.md): Defined in244 - [Interface: ExecuteToolResponse](https://docs.gravityrail.com/sdk/interfaces/ExecuteToolResponse.md): Defined in165 - [Interface: ExpireAnonymousMemberRequest](https://docs.gravityrail.com/sdk/interfaces/ExpireAnonymousMemberRequest.md): Defined in490 - [Interface: ExportStatistics](https://docs.gravityrail.com/sdk/interfaces/ExportStatistics.md): Defined in96 - [Interface: FeatureDefinition](https://docs.gravityrail.com/sdk/interfaces/FeatureDefinition.md): Defined in45 - [Interface: FeaturesResponse](https://docs.gravityrail.com/sdk/interfaces/FeaturesResponse.md): Defined in85 - [Interface: FeatureSyncStatus](https://docs.gravityrail.com/sdk/interfaces/FeatureSyncStatus.md): Defined in63 - [Interface: FhirCreateEncounterRequest](https://docs.gravityrail.com/sdk/interfaces/FhirCreateEncounterRequest.md): Defined in149 - [Interface: FhirCsvColumnMeta](https://docs.gravityrail.com/sdk/interfaces/FhirCsvColumnMeta.md): Defined in175 - [Interface: FhirCsvImportRunItem](https://docs.gravityrail.com/sdk/interfaces/FhirCsvImportRunItem.md): Defined in278 - [Interface: FhirCsvImportRunSummary](https://docs.gravityrail.com/sdk/interfaces/FhirCsvImportRunSummary.md): Defined in257 - [Interface: FhirCsvImportSettings](https://docs.gravityrail.com/sdk/interfaces/FhirCsvImportSettings.md): Defined in209 - [Interface: FhirCsvInspectResponse](https://docs.gravityrail.com/sdk/interfaces/FhirCsvInspectResponse.md): Defined in183 - [Interface: FhirFetchCareTeamRequest](https://docs.gravityrail.com/sdk/interfaces/FhirFetchCareTeamRequest.md): Defined in142 - [Interface: FhirFetchEncountersRequest](https://docs.gravityrail.com/sdk/interfaces/FhirFetchEncountersRequest.md): Defined in108 - [Interface: FhirMethodResponse](https://docs.gravityrail.com/sdk/interfaces/FhirMethodResponse.md): Defined in215 - [Interface: FhirSearchLocationsRequest](https://docs.gravityrail.com/sdk/interfaces/FhirSearchLocationsRequest.md): Defined in134 - [Interface: FhirSearchPatientsRequest](https://docs.gravityrail.com/sdk/interfaces/FhirSearchPatientsRequest.md): Defined in115 - [Interface: FhirSearchPractitionersRequest](https://docs.gravityrail.com/sdk/interfaces/FhirSearchPractitionersRequest.md): Defined in126 - [Interface: FileAccessAbilityConfig](https://docs.gravityrail.com/sdk/interfaces/FileAccessAbilityConfig.md): Defined in120 - [Interface: FileAccessEntry](https://docs.gravityrail.com/sdk/interfaces/FileAccessEntry.md): Defined in108 - [Interface: FileAssociationFormData](https://docs.gravityrail.com/sdk/interfaces/FileAssociationFormData.md): Defined in124 - [Interface: FileExport](https://docs.gravityrail.com/sdk/interfaces/FileExport.md): Defined in54 - [Interface: FileExportItem](https://docs.gravityrail.com/sdk/interfaces/FileExportItem.md): Defined in113 - [Interface: FileFolderExport](https://docs.gravityrail.com/sdk/interfaces/FileFolderExport.md): Defined in274 - [Interface: FileFolderFormData](https://docs.gravityrail.com/sdk/interfaces/FileFolderFormData.md): Defined in94 - [Interface: FileFolderRelation](https://docs.gravityrail.com/sdk/interfaces/FileFolderRelation.md): Defined in334 - [Interface: FileFolderResponse](https://docs.gravityrail.com/sdk/interfaces/FileFolderResponse.md): Defined in69 - [Interface: FileFormData](https://docs.gravityrail.com/sdk/interfaces/FileFormData.md): Defined in57 - [Interface: FileLabelExport](https://docs.gravityrail.com/sdk/interfaces/FileLabelExport.md): Defined in283 - [Interface: FileLabelFormData](https://docs.gravityrail.com/sdk/interfaces/FileLabelFormData.md): Defined in51 - [Interface: FileLabelRelation](https://docs.gravityrail.com/sdk/interfaces/FileLabelRelation.md): Defined in339 - [Interface: FileLabelResponse](https://docs.gravityrail.com/sdk/interfaces/FileLabelResponse.md): Defined in92 - [Interface: FileRoleAssociationResponse](https://docs.gravityrail.com/sdk/interfaces/FileRoleAssociationResponse.md): Defined in132 - [Interface: FilesQueryParams](https://docs.gravityrail.com/sdk/interfaces/FilesQueryParams.md): Defined in128 - [Interface: FileUploadRequest](https://docs.gravityrail.com/sdk/interfaces/FileUploadRequest.md): Defined in137 - [Interface: FileUploadResponse](https://docs.gravityrail.com/sdk/interfaces/FileUploadResponse.md): Defined in161 - [Interface: FileWithAccessModeFormData](https://docs.gravityrail.com/sdk/interfaces/FileWithAccessModeFormData.md): Defined in107 - [Interface: FirstRunState](https://docs.gravityrail.com/sdk/interfaces/FirstRunState.md): Defined in57 - [Interface: FolderAccessEntry](https://docs.gravityrail.com/sdk/interfaces/FolderAccessEntry.md): Defined in92 - [Interface: FolderMemberRoleRelation](https://docs.gravityrail.com/sdk/interfaces/FolderMemberRoleRelation.md): Defined in344 - [Interface: FolderPathSegment](https://docs.gravityrail.com/sdk/interfaces/FolderPathSegment.md): Defined in172 - [Interface: FolderSearchParams](https://docs.gravityrail.com/sdk/interfaces/FolderSearchParams.md): Defined in142 - [Interface: FolderSearchResultResponse](https://docs.gravityrail.com/sdk/interfaces/FolderSearchResultResponse.md): Defined in180 - [Interface: FormFieldUpdateActionParams](https://docs.gravityrail.com/sdk/interfaces/FormFieldUpdateActionParams.md): Defined in253 - [Interface: ForwardingNumberDef](https://docs.gravityrail.com/sdk/interfaces/ForwardingNumberDef.md): Defined in202 - [Interface: FunctionTool](https://docs.gravityrail.com/sdk/interfaces/FunctionTool.md): Defined in159 - [Interface: GeminiChatModelConfig](https://docs.gravityrail.com/sdk/interfaces/GeminiChatModelConfig.md): Defined in149 - [Interface: GeminiRealtimeModelConfig](https://docs.gravityrail.com/sdk/interfaces/GeminiRealtimeModelConfig.md): Defined in89 - [Interface: GeneratedAccessGrantResponse](https://docs.gravityrail.com/sdk/interfaces/GeneratedAccessGrantResponse.md): Defined in28 - [Interface: GeneratedAppListResponse](https://docs.gravityrail.com/sdk/interfaces/GeneratedAppListResponse.md): Defined in20 - [Interface: GeneratedBusinessProfileResponse](https://docs.gravityrail.com/sdk/interfaces/GeneratedBusinessProfileResponse.md): Defined in205 - [Interface: GeneratedCalendarResponse](https://docs.gravityrail.com/sdk/interfaces/GeneratedCalendarResponse.md): Defined in45 - [Interface: GeneratedCalendarScheduleResponse](https://docs.gravityrail.com/sdk/interfaces/GeneratedCalendarScheduleResponse.md): Defined in70 - [Interface: GeneratedCustomToolkitResponse](https://docs.gravityrail.com/sdk/interfaces/GeneratedCustomToolkitResponse.md): Defined in308 - [Interface: GeneratedCustomToolResponse](https://docs.gravityrail.com/sdk/interfaces/GeneratedCustomToolResponse.md): Defined in112 - [Interface: GeneratedDiscordBotResponse](https://docs.gravityrail.com/sdk/interfaces/GeneratedDiscordBotResponse.md): Defined in59 - [Interface: GeneratedFhirConnectionResponse](https://docs.gravityrail.com/sdk/interfaces/GeneratedFhirConnectionResponse.md): Defined in179 - [Interface: GeneratedFileResponse](https://docs.gravityrail.com/sdk/interfaces/GeneratedFileResponse.md): Defined in103 - [Interface: GeneratedFileSharingResponse](https://docs.gravityrail.com/sdk/interfaces/GeneratedFileSharingResponse.md): Defined in141 - [Interface: GeneratedFolderSharingResponse](https://docs.gravityrail.com/sdk/interfaces/GeneratedFolderSharingResponse.md): Defined in196 - [Interface: GeneratedInvitationListResponse](https://docs.gravityrail.com/sdk/interfaces/GeneratedInvitationListResponse.md): Defined in12 - [Interface: GeneratedMemoryListResponse](https://docs.gravityrail.com/sdk/interfaces/GeneratedMemoryListResponse.md): Defined in592 - [Interface: GeneratedMemoryResponse](https://docs.gravityrail.com/sdk/interfaces/GeneratedMemoryResponse.md): Defined in597 - [Interface: GeneratedMetricSummary](https://docs.gravityrail.com/sdk/interfaces/GeneratedMetricSummary.md): Defined in40 - [Interface: GeneratedMilestoneGoalResponse](https://docs.gravityrail.com/sdk/interfaces/GeneratedMilestoneGoalResponse.md): Defined in32 - [Interface: GeneratedOrgDomainResponse](https://docs.gravityrail.com/sdk/interfaces/GeneratedOrgDomainResponse.md): Defined in491 - [Interface: GeneratedOwnershipDnsRecord](https://docs.gravityrail.com/sdk/interfaces/GeneratedOwnershipDnsRecord.md): Defined in547 - [Interface: GeneratedSiteResponse](https://docs.gravityrail.com/sdk/interfaces/GeneratedSiteResponse.md): Defined in180 - [Interface: GeneratedSlackAppResponse](https://docs.gravityrail.com/sdk/interfaces/GeneratedSlackAppResponse.md): Defined in380 - [Interface: GeneratedTaskResponse](https://docs.gravityrail.com/sdk/interfaces/GeneratedTaskResponse.md): Defined in257 - [Interface: GeneratedVoiceMetricsResponse](https://docs.gravityrail.com/sdk/interfaces/GeneratedVoiceMetricsResponse.md): Defined in76 - [Interface: GeneratedVoiceModelResponse](https://docs.gravityrail.com/sdk/interfaces/GeneratedVoiceModelResponse.md): Defined in222 - [Interface: GeneratedWorkflowResponse](https://docs.gravityrail.com/sdk/interfaces/GeneratedWorkflowResponse.md): Defined in405 - [Interface: GeneratedWorkspaceHealthResponse](https://docs.gravityrail.com/sdk/interfaces/GeneratedWorkspaceHealthResponse.md): Defined in93 - [Interface: GenerateRecoveryCodesRequest](https://docs.gravityrail.com/sdk/interfaces/GenerateRecoveryCodesRequest.md): Defined in381 - [Interface: GenerateSummariesResponse](https://docs.gravityrail.com/sdk/interfaces/GenerateSummariesResponse.md): Defined in207 - [Interface: GetChatsOptions](https://docs.gravityrail.com/sdk/interfaces/GetChatsOptions.md): Defined in452 - [Interface: GoogleCalendarInfo](https://docs.gravityrail.com/sdk/interfaces/GoogleCalendarInfo.md): Defined in265 - [Interface: GoogleCalendarInsufficientScopesResponse](https://docs.gravityrail.com/sdk/interfaces/GoogleCalendarInsufficientScopesResponse.md): Defined in278 - [Interface: GoogleCalendarStatusResponse](https://docs.gravityrail.com/sdk/interfaces/GoogleCalendarStatusResponse.md): Defined in288 - [Interface: GoogleWorkspaceIntegrationAbilityConfig](https://docs.gravityrail.com/sdk/interfaces/GoogleWorkspaceIntegrationAbilityConfig.md): Defined in293 - [Interface: GroupsResponse](https://docs.gravityrail.com/sdk/interfaces/GroupsResponse.md): Defined in50 - [Interface: HealthCheckStatistics](https://docs.gravityrail.com/sdk/interfaces/HealthCheckStatistics.md): Defined in138 - [Interface: HealthDetailRequest](https://docs.gravityrail.com/sdk/interfaces/HealthDetailRequest.md): Defined in52 - [Interface: HealthieConnectionResponse](https://docs.gravityrail.com/sdk/interfaces/HealthieConnectionResponse.md): Defined in225 - [Interface: HealthMetricsRequest](https://docs.gravityrail.com/sdk/interfaces/HealthMetricsRequest.md): Defined in17 - [Interface: HealthMetricsResponse](https://docs.gravityrail.com/sdk/interfaces/HealthMetricsResponse.md): Defined in35 - [Interface: HealthSummary](https://docs.gravityrail.com/sdk/interfaces/HealthSummary.md): Defined in46 - [Interface: HITLActionRequest](https://docs.gravityrail.com/sdk/interfaces/HITLActionRequest.md): Defined in321 - [Interface: HITLDecision](https://docs.gravityrail.com/sdk/interfaces/HITLDecision.md): Defined in338 - [Interface: HITLRequest](https://docs.gravityrail.com/sdk/interfaces/HITLRequest.md): Defined in331 - [Interface: HITLResponse](https://docs.gravityrail.com/sdk/interfaces/HITLResponse.md): Defined in344 - [Interface: HITLReviewConfig](https://docs.gravityrail.com/sdk/interfaces/HITLReviewConfig.md): Defined in326 - [Interface: HubspotConnectionResponse](https://docs.gravityrail.com/sdk/interfaces/HubspotConnectionResponse.md): Defined in243 - [Interface: HubSpotNoteSyncConfig](https://docs.gravityrail.com/sdk/interfaces/HubSpotNoteSyncConfig.md): Defined in201 - [Interface: HubSpotPropertyDefinition](https://docs.gravityrail.com/sdk/interfaces/HubSpotPropertyDefinition.md): Defined in303 - [Interface: HubSpotPropertyOption](https://docs.gravityrail.com/sdk/interfaces/HubSpotPropertyOption.md): Defined in298 - [Interface: HubSpotSearchRequest](https://docs.gravityrail.com/sdk/interfaces/HubSpotSearchRequest.md): Defined in105 - [Interface: HubSpotSearchResponse](https://docs.gravityrail.com/sdk/interfaces/HubSpotSearchResponse.md): Defined in127 - [Interface: HubSpotSearchResult](https://docs.gravityrail.com/sdk/interfaces/HubSpotSearchResult.md): Defined in117 - [Interface: HubSpotSearchResultMatch](https://docs.gravityrail.com/sdk/interfaces/HubSpotSearchResultMatch.md): Defined in112 - [Interface: HubSpotSyncSettingsRequest](https://docs.gravityrail.com/sdk/interfaces/HubSpotSyncSettingsRequest.md): Defined in241 - [Interface: HubSpotSyncSettingsResponse](https://docs.gravityrail.com/sdk/interfaces/HubSpotSyncSettingsResponse.md): Defined in250 - [Interface: HubSpotTaskSyncConfig](https://docs.gravityrail.com/sdk/interfaces/HubSpotTaskSyncConfig.md): Defined in210 - [Interface: HumanChatParticipant](https://docs.gravityrail.com/sdk/interfaces/HumanChatParticipant.md): Defined in131 - [Interface: ICalFeedTokenResponse](https://docs.gravityrail.com/sdk/interfaces/ICalFeedTokenResponse.md): Defined in298 - [Interface: ICalFeedUrlResponse](https://docs.gravityrail.com/sdk/interfaces/ICalFeedUrlResponse.md): Defined in308 - [Interface: ImageGenerationAbilityConfig](https://docs.gravityrail.com/sdk/interfaces/ImageGenerationAbilityConfig.md): Defined in376 - [Interface: ImageUrlContent](https://docs.gravityrail.com/sdk/interfaces/ImageUrlContent.md): Defined in195 - [Interface: ImportedMemberResult](https://docs.gravityrail.com/sdk/interfaces/ImportedMemberResult.md): Defined in150 - [Interface: ImportedSalesforceMemberResult](https://docs.gravityrail.com/sdk/interfaces/ImportedSalesforceMemberResult.md): Defined in411 - [Interface: ImportHubSpotMembersRequest](https://docs.gravityrail.com/sdk/interfaces/ImportHubSpotMembersRequest.md): Defined in141 - [Interface: ImportHubSpotMembersResponse](https://docs.gravityrail.com/sdk/interfaces/ImportHubSpotMembersResponse.md): Defined in158 - [Interface: ImportHubSpotRecordRequest](https://docs.gravityrail.com/sdk/interfaces/ImportHubSpotRecordRequest.md): Defined in133 - [Interface: ImportPreviewItem](https://docs.gravityrail.com/sdk/interfaces/ImportPreviewItem.md): Defined in216 - [Interface: ImportSalesforceMembersRequest](https://docs.gravityrail.com/sdk/interfaces/ImportSalesforceMembersRequest.md): Defined in402 - [Interface: ImportSalesforceMembersResponse](https://docs.gravityrail.com/sdk/interfaces/ImportSalesforceMembersResponse.md): Defined in419 - [Interface: ImportSalesforceRecordRequest](https://docs.gravityrail.com/sdk/interfaces/ImportSalesforceRecordRequest.md): Defined in394 - [Interface: ImportStatistics](https://docs.gravityrail.com/sdk/interfaces/ImportStatistics.md): Defined in105 - [Interface: InboxCreateRequest](https://docs.gravityrail.com/sdk/interfaces/InboxCreateRequest.md): Defined in200 - [Interface: InboxExport](https://docs.gravityrail.com/sdk/interfaces/InboxExport.md): Defined in195 - [Interface: InboxMapping](https://docs.gravityrail.com/sdk/interfaces/InboxMapping.md): Defined in239 - [Interface: InboxMappingDetailResponse](https://docs.gravityrail.com/sdk/interfaces/InboxMappingDetailResponse.md): Defined in223 - [Interface: InboxThreadResponse](https://docs.gravityrail.com/sdk/interfaces/InboxThreadResponse.md): Defined in260 - [Interface: InboxThreadsPageResponse](https://docs.gravityrail.com/sdk/interfaces/InboxThreadsPageResponse.md): Defined in273 - [Interface: InboxUpdateRequest](https://docs.gravityrail.com/sdk/interfaces/InboxUpdateRequest.md): Defined in211 - [Interface: IncomingInteraction](https://docs.gravityrail.com/sdk/interfaces/IncomingInteraction.md): Defined in86 - [Interface: IndexStatusResponse](https://docs.gravityrail.com/sdk/interfaces/IndexStatusResponse.md): Defined in146 - [Interface: InitiateCallRequest](https://docs.gravityrail.com/sdk/interfaces/InitiateCallRequest.md): Defined in177 - [Interface: InitiateCallResponse](https://docs.gravityrail.com/sdk/interfaces/InitiateCallResponse.md): Defined in280 - [Interface: InquiryListResponse](https://docs.gravityrail.com/sdk/interfaces/InquiryListResponse.md): Defined in39 - [Interface: InquiryResponse](https://docs.gravityrail.com/sdk/interfaces/InquiryResponse.md): Defined in49 - [Interface: InteractionAccepted](https://docs.gravityrail.com/sdk/interfaces/InteractionAccepted.md): Defined in102 - [Interface: InteractionTimedOut](https://docs.gravityrail.com/sdk/interfaces/InteractionTimedOut.md): Defined in109 - [Interface: InvitationAcceptedResponse](https://docs.gravityrail.com/sdk/interfaces/InvitationAcceptedResponse.md): Defined in98 - [Interface: InvitationDetails](https://docs.gravityrail.com/sdk/interfaces/InvitationDetails.md): Defined in73 - [Interface: InvokeCustomToolActionParams](https://docs.gravityrail.com/sdk/interfaces/InvokeCustomToolActionParams.md): Defined in296 - [Interface: JourneyEnrollActionParams](https://docs.gravityrail.com/sdk/interfaces/JourneyEnrollActionParams.md): Defined in312 - [Interface: JsonSchema](https://docs.gravityrail.com/sdk/interfaces/JsonSchema.md): Defined in25 - [Interface: JsonSchemaProperty](https://docs.gravityrail.com/sdk/interfaces/JsonSchemaProperty.md): Defined in19 - [Interface: LinkA2PEnrollmentSiteRequest](https://docs.gravityrail.com/sdk/interfaces/LinkA2PEnrollmentSiteRequest.md): Defined in264 - [Interface: LinkablePhone](https://docs.gravityrail.com/sdk/interfaces/LinkablePhone.md): Defined in116 - [Interface: LinkCalendarRequest](https://docs.gravityrail.com/sdk/interfaces/LinkCalendarRequest.md): Defined in187 - [Interface: LinkCalendarResponse](https://docs.gravityrail.com/sdk/interfaces/LinkCalendarResponse.md): Defined in191 - [Interface: ListInvitationsParams](https://docs.gravityrail.com/sdk/interfaces/ListInvitationsParams.md): Defined in63 - [Interface: LiveOperatorEntry](https://docs.gravityrail.com/sdk/interfaces/LiveOperatorEntry.md): Defined in8 - [Interface: LiveOperatorsResponse](https://docs.gravityrail.com/sdk/interfaces/LiveOperatorsResponse.md): Defined in18 - [Interface: LoadedSkill](https://docs.gravityrail.com/sdk/interfaces/LoadedSkill.md): Defined in67 - [Interface: LoginRequest](https://docs.gravityrail.com/sdk/interfaces/LoginRequest.md): Defined in124 - [Interface: LoginResponse](https://docs.gravityrail.com/sdk/interfaces/LoginResponse.md): Defined in274 - [Interface: LogoUploadRequest](https://docs.gravityrail.com/sdk/interfaces/LogoUploadRequest.md): Defined in312 - [Interface: LogoUploadResponse](https://docs.gravityrail.com/sdk/interfaces/LogoUploadResponse.md): Defined in317 - [Interface: ManagedAutomationConfig](https://docs.gravityrail.com/sdk/interfaces/ManagedAutomationConfig.md): Defined in490 - [Interface: ManagedRuleStatus](https://docs.gravityrail.com/sdk/interfaces/ManagedRuleStatus.md): Defined in232 - [Interface: MatchStrategy](https://docs.gravityrail.com/sdk/interfaces/MatchStrategy.md): Defined in444 - [Interface: McpPromptArgumentResponse](https://docs.gravityrail.com/sdk/interfaces/McpPromptArgumentResponse.md): Defined in584 - [Interface: McpPromptResponse](https://docs.gravityrail.com/sdk/interfaces/McpPromptResponse.md): Defined in590 - [Interface: McpResourceResponse](https://docs.gravityrail.com/sdk/interfaces/McpResourceResponse.md): Defined in569 - [Interface: McpServerAuthRequired](https://docs.gravityrail.com/sdk/interfaces/McpServerAuthRequired.md): Defined in557 - [Interface: McpServerExport](https://docs.gravityrail.com/sdk/interfaces/McpServerExport.md): Defined in183 - [Interface: McpServerFormData](https://docs.gravityrail.com/sdk/interfaces/McpServerFormData.md): Defined in22 - [Interface: McpServerPromptsResponse](https://docs.gravityrail.com/sdk/interfaces/McpServerPromptsResponse.md): Defined in596 - [Interface: McpServerResourcesResponse](https://docs.gravityrail.com/sdk/interfaces/McpServerResourcesResponse.md): Defined in576 - [Interface: McpServerResponse](https://docs.gravityrail.com/sdk/interfaces/McpServerResponse.md): Defined in263 - [Interface: McpServerToolResponse](https://docs.gravityrail.com/sdk/interfaces/McpServerToolResponse.md): Defined in538 - [Interface: McpServerToolsResponse](https://docs.gravityrail.com/sdk/interfaces/McpServerToolsResponse.md): Defined in550 - [Interface: McpServerUpdateFormData](https://docs.gravityrail.com/sdk/interfaces/McpServerUpdateFormData.md): Defined in36 - [Interface: McpTestConnectionResponse](https://docs.gravityrail.com/sdk/interfaces/McpTestConnectionResponse.md): Defined in604 - [Interface: McpToolResponse](https://docs.gravityrail.com/sdk/interfaces/McpToolResponse.md): Defined in297 - [Interface: MemberCredential](https://docs.gravityrail.com/sdk/interfaces/MemberCredential.md): Defined in319 - [Interface: MemberFieldDefinitionListResponse](https://docs.gravityrail.com/sdk/interfaces/MemberFieldDefinitionListResponse.md): Defined in351 - [Interface: MemberFieldDefinitionResponse](https://docs.gravityrail.com/sdk/interfaces/MemberFieldDefinitionResponse.md): Defined in359 - [Interface: MemberFieldListResponse](https://docs.gravityrail.com/sdk/interfaces/MemberFieldListResponse.md): Defined in369 - [Interface: MemberFieldResponse](https://docs.gravityrail.com/sdk/interfaces/MemberFieldResponse.md): Defined in380 - [Interface: MemberFieldVerificationAbilityConfig](https://docs.gravityrail.com/sdk/interfaces/MemberFieldVerificationAbilityConfig.md): Defined in416 - [Interface: MemberFilterExport](https://docs.gravityrail.com/sdk/interfaces/MemberFilterExport.md): Defined in231 - [Interface: MemberFilterFormData](https://docs.gravityrail.com/sdk/interfaces/MemberFilterFormData.md): Defined in298 - [Interface: MemberFilterResponse](https://docs.gravityrail.com/sdk/interfaces/MemberFilterResponse.md): Defined in395 - [Interface: MemberFilterRuleExport](https://docs.gravityrail.com/sdk/interfaces/MemberFilterRuleExport.md): Defined in237 - [Interface: MemberFilterRuleFormData](https://docs.gravityrail.com/sdk/interfaces/MemberFilterRuleFormData.md): Defined in283 - [Interface: MemberFilterRuleResponse](https://docs.gravityrail.com/sdk/interfaces/MemberFilterRuleResponse.md): Defined in412 - [Interface: MemberFormData](https://docs.gravityrail.com/sdk/interfaces/MemberFormData.md): Defined in328 - [Interface: MemberImportConflictInfo](https://docs.gravityrail.com/sdk/interfaces/MemberImportConflictInfo.md): Defined in424 - [Interface: MemberImportIdentitySnapshot](https://docs.gravityrail.com/sdk/interfaces/MemberImportIdentitySnapshot.md): Defined in434 - [Interface: MemberImportMatchInfo](https://docs.gravityrail.com/sdk/interfaces/MemberImportMatchInfo.md): Defined in442 - [Interface: MemberImportPreviewResponse](https://docs.gravityrail.com/sdk/interfaces/MemberImportPreviewResponse.md): Defined in462 - [Interface: MemberImportPreviewRow](https://docs.gravityrail.com/sdk/interfaces/MemberImportPreviewRow.md): Defined in471 - [Interface: MemberImportPreviewSummary](https://docs.gravityrail.com/sdk/interfaces/MemberImportPreviewSummary.md): Defined in496 - [Interface: MemberImportStreamConflict](https://docs.gravityrail.com/sdk/interfaces/MemberImportStreamConflict.md): Defined in132 - [Interface: MemberImportStreamEvent](https://docs.gravityrail.com/sdk/interfaces/MemberImportStreamEvent.md): Defined in148 - [Interface: MemberLabelActionParams](https://docs.gravityrail.com/sdk/interfaces/MemberLabelActionParams.md): Defined in193 - [Interface: MemberLabelExport](https://docs.gravityrail.com/sdk/interfaces/MemberLabelExport.md): Defined in203 - [Interface: MemberLabelFormData](https://docs.gravityrail.com/sdk/interfaces/MemberLabelFormData.md): Defined in177 - [Interface: MemberLabelResponse](https://docs.gravityrail.com/sdk/interfaces/MemberLabelResponse.md): Defined in507 - [Interface: MemberMessageActivity](https://docs.gravityrail.com/sdk/interfaces/MemberMessageActivity.md): Defined in436 - [Interface: MemberNotificationPreferences](https://docs.gravityrail.com/sdk/interfaces/MemberNotificationPreferences.md): Defined in19 - [Interface: MemberNotifyActionParams](https://docs.gravityrail.com/sdk/interfaces/MemberNotifyActionParams.md): Defined in26 - [Interface: MemberOrgView](https://docs.gravityrail.com/sdk/interfaces/MemberOrgView.md): Defined in262 - [Interface: MemberReportItem](https://docs.gravityrail.com/sdk/interfaces/MemberReportItem.md): Defined in409 - [Interface: MemberRoleCalendarAccessResponse](https://docs.gravityrail.com/sdk/interfaces/MemberRoleCalendarAccessResponse.md): Defined in519 - [Interface: MemberRoleDataTypeAccessResponse](https://docs.gravityrail.com/sdk/interfaces/MemberRoleDataTypeAccessResponse.md): Defined in527 - [Interface: MemberRoleDataTypeRelation](https://docs.gravityrail.com/sdk/interfaces/MemberRoleDataTypeRelation.md): Defined in134 - [Interface: MemberRoleExport](https://docs.gravityrail.com/sdk/interfaces/MemberRoleExport.md): Defined in73 - [Interface: MemberRoleFileAccessResponse](https://docs.gravityrail.com/sdk/interfaces/MemberRoleFileAccessResponse.md): Defined in535 - [Interface: MemberRoleFolderAccessResponse](https://docs.gravityrail.com/sdk/interfaces/MemberRoleFolderAccessResponse.md): Defined in543 - [Interface: MemberRoleFormData](https://docs.gravityrail.com/sdk/interfaces/MemberRoleFormData.md): Defined in314 - [Interface: MemberRoleInboxAccessResponse](https://docs.gravityrail.com/sdk/interfaces/MemberRoleInboxAccessResponse.md): Defined in551 - [Interface: MemberRoleInboxRelation](https://docs.gravityrail.com/sdk/interfaces/MemberRoleInboxRelation.md): Defined in146 - [Interface: MemberRoleResponse](https://docs.gravityrail.com/sdk/interfaces/MemberRoleResponse.md): Defined in559 - [Interface: MemberRoleSiteAccessResponse](https://docs.gravityrail.com/sdk/interfaces/MemberRoleSiteAccessResponse.md): Defined in579 - [Interface: MemberRoleSiteRelation](https://docs.gravityrail.com/sdk/interfaces/MemberRoleSiteRelation.md): Defined in140 - [Interface: MemberRoleTaskAccess](https://docs.gravityrail.com/sdk/interfaces/MemberRoleTaskAccess.md): Defined in308 - [Interface: MemberRoleTaskRelation](https://docs.gravityrail.com/sdk/interfaces/MemberRoleTaskRelation.md): Defined in128 - [Interface: MemberRoleWorkflowAccessResponse](https://docs.gravityrail.com/sdk/interfaces/MemberRoleWorkflowAccessResponse.md): Defined in587 - [Interface: MembersQueryParams](https://docs.gravityrail.com/sdk/interfaces/MembersQueryParams.md): Defined in423 - [Interface: MemberSummary](https://docs.gravityrail.com/sdk/interfaces/MemberSummary.md): Defined in35 - [Interface: MemberSyncLink](https://docs.gravityrail.com/sdk/interfaces/MemberSyncLink.md): Defined in502 - [Interface: MemberUpsertActionParams](https://docs.gravityrail.com/sdk/interfaces/MemberUpsertActionParams.md): Defined in200 - [Interface: MemberUsageReport](https://docs.gravityrail.com/sdk/interfaces/MemberUsageReport.md): Defined in64 - [Interface: MemberWorkspaceInfo](https://docs.gravityrail.com/sdk/interfaces/MemberWorkspaceInfo.md): Defined in252 - [Interface: MenuItemExport](https://docs.gravityrail.com/sdk/interfaces/MenuItemExport.md): Defined in168 - [Interface: MenuItemFormData](https://docs.gravityrail.com/sdk/interfaces/MenuItemFormData.md): Defined in104 - [Interface: MenuItemResponse](https://docs.gravityrail.com/sdk/interfaces/MenuItemResponse.md): Defined in69 - [Interface: MenuTreeResponse](https://docs.gravityrail.com/sdk/interfaces/MenuTreeResponse.md): Defined in105 - [Interface: MergeMembersRequest](https://docs.gravityrail.com/sdk/interfaces/MergeMembersRequest.md): Defined in394 - [Interface: MergeMembersResponse](https://docs.gravityrail.com/sdk/interfaces/MergeMembersResponse.md): Defined in612 - [Interface: MessageTimingResponse](https://docs.gravityrail.com/sdk/interfaces/MessageTimingResponse.md): Defined in285 - [Interface: MessageTokenUsageResponse](https://docs.gravityrail.com/sdk/interfaces/MessageTokenUsageResponse.md): Defined in356 - [Interface: MessageValidationActionParams](https://docs.gravityrail.com/sdk/interfaces/MessageValidationActionParams.md): Defined in267 - [Interface: MetricDataPoint](https://docs.gravityrail.com/sdk/interfaces/MetricDataPoint.md): Defined in25 - [Interface: MetricValue](https://docs.gravityrail.com/sdk/interfaces/MetricValue.md): Defined in21 - [Interface: Milestone](https://docs.gravityrail.com/sdk/interfaces/Milestone.md): Defined in47 - [Interface: MilestoneAnalytics](https://docs.gravityrail.com/sdk/interfaces/MilestoneAnalytics.md): Defined in75 - [Interface: MilestoneCreateRequest](https://docs.gravityrail.com/sdk/interfaces/MilestoneCreateRequest.md): Defined in63 - [Interface: MilestoneDeleteResponse](https://docs.gravityrail.com/sdk/interfaces/MilestoneDeleteResponse.md): Defined in70 - [Interface: MilestoneExport](https://docs.gravityrail.com/sdk/interfaces/MilestoneExport.md): Defined in245 - [Interface: MilestoneGoalExport](https://docs.gravityrail.com/sdk/interfaces/MilestoneGoalExport.md): Defined in252 - [Interface: MilestoneGoalProgress](https://docs.gravityrail.com/sdk/interfaces/MilestoneGoalProgress.md): Defined in36 - [Interface: MilestoneProgress](https://docs.gravityrail.com/sdk/interfaces/MilestoneProgress.md): Defined in46 - [Interface: MilestonesQueryParams](https://docs.gravityrail.com/sdk/interfaces/MilestonesQueryParams.md): Defined in28 - [Interface: MilestoneTimeline](https://docs.gravityrail.com/sdk/interfaces/MilestoneTimeline.md): Defined in93 - [Interface: MilestoneTimelineItem](https://docs.gravityrail.com/sdk/interfaces/MilestoneTimelineItem.md): Defined in84 - [Interface: MilestoneUpdateRequest](https://docs.gravityrail.com/sdk/interfaces/MilestoneUpdateRequest.md): Defined in56 - [Interface: MissingMembershipItem](https://docs.gravityrail.com/sdk/interfaces/MissingMembershipItem.md): Defined in392 - [Interface: ModelMetadataResponse](https://docs.gravityrail.com/sdk/interfaces/ModelMetadataResponse.md): Defined in72 - [Interface: ModelUsageResponse](https://docs.gravityrail.com/sdk/interfaces/ModelUsageResponse.md): Defined in368 - [Interface: ModelUsageStats](https://docs.gravityrail.com/sdk/interfaces/ModelUsageStats.md): Defined in63 - [Interface: MondayBoard](https://docs.gravityrail.com/sdk/interfaces/MondayBoard.md): Defined in4 - [Interface: MondayColumn](https://docs.gravityrail.com/sdk/interfaces/MondayColumn.md): Defined in29 - [Interface: MondayColumnMapping](https://docs.gravityrail.com/sdk/interfaces/MondayColumnMapping.md): Defined in396 - [Interface: MondayColumnSettings](https://docs.gravityrail.com/sdk/interfaces/MondayColumnSettings.md): Defined in22 - [Interface: MondayConnectionResponse](https://docs.gravityrail.com/sdk/interfaces/MondayConnectionResponse.md): Defined in320 - [Interface: MondayCurrentUserInfoResponse](https://docs.gravityrail.com/sdk/interfaces/MondayCurrentUserInfoResponse.md): Defined in54 - [Interface: MondayGroup](https://docs.gravityrail.com/sdk/interfaces/MondayGroup.md): Defined in45 - [Interface: MondayRefreshActionParams](https://docs.gravityrail.com/sdk/interfaces/MondayRefreshActionParams.md): Defined in458 - [Interface: MondayRefreshColumnMapping](https://docs.gravityrail.com/sdk/interfaces/MondayRefreshColumnMapping.md): Defined in449 - [Interface: MondayStatusLabel](https://docs.gravityrail.com/sdk/interfaces/MondayStatusLabel.md): Defined in10 - [Interface: MondayUpsertItemActionParams](https://docs.gravityrail.com/sdk/interfaces/MondayUpsertItemActionParams.md): Defined in424 - [Interface: NormalizeMemberRequest](https://docs.gravityrail.com/sdk/interfaces/NormalizeMemberRequest.md): Defined in399 - [Interface: NormalizeMemberResponse](https://docs.gravityrail.com/sdk/interfaces/NormalizeMemberResponse.md): Defined in403 - [Interface: Notice](https://docs.gravityrail.com/sdk/interfaces/Notice.md): Defined in11 - [Interface: NoticesResponse](https://docs.gravityrail.com/sdk/interfaces/NoticesResponse.md): Defined in23 - [Interface: NotificationResponse](https://docs.gravityrail.com/sdk/interfaces/NotificationResponse.md): Defined in30 - [Interface: NotificationRule](https://docs.gravityrail.com/sdk/interfaces/NotificationRule.md): Defined in3 - [Interface: NotificationRuleCreate](https://docs.gravityrail.com/sdk/interfaces/NotificationRuleCreate.md): Defined in14 - [Interface: NotificationRuleResponse](https://docs.gravityrail.com/sdk/interfaces/NotificationRuleResponse.md): Defined in47 - [Interface: NotificationRuleUpdate](https://docs.gravityrail.com/sdk/interfaces/NotificationRuleUpdate.md): Defined in24 - [Interface: OAuthAuthorizeResponse](https://docs.gravityrail.com/sdk/interfaces/OAuthAuthorizeResponse.md): Defined in22 - [Interface: OAuthConnectionStatus](https://docs.gravityrail.com/sdk/interfaces/OAuthConnectionStatus.md): Defined in6 - [Interface: ObjectPermissionFlags](https://docs.gravityrail.com/sdk/interfaces/ObjectPermissionFlags.md): Defined in43 - [Interface: OIDCAdminConfigView](https://docs.gravityrail.com/sdk/interfaces/OIDCAdminConfigView.md): Defined in443 - [Interface: OpenAIChatModelConfig](https://docs.gravityrail.com/sdk/interfaces/OpenAIChatModelConfig.md): Defined in159 - [Interface: OpenAIRealtimeModelConfig](https://docs.gravityrail.com/sdk/interfaces/OpenAIRealtimeModelConfig.md): Defined in84 - [Interface: OpenAISemanticVADTurnDetection](https://docs.gravityrail.com/sdk/interfaces/OpenAISemanticVADTurnDetection.md): Defined in9 - [Interface: OpenAIServerVADTurnDetection](https://docs.gravityrail.com/sdk/interfaces/OpenAIServerVADTurnDetection.md): Defined in16 - [Interface: OperatorChatParticipant](https://docs.gravityrail.com/sdk/interfaces/OperatorChatParticipant.md): Defined in145 - [Interface: OperatorChildTaskDetail](https://docs.gravityrail.com/sdk/interfaces/OperatorChildTaskDetail.md): Defined in175 - [Interface: OperatorGroupMemberInput](https://docs.gravityrail.com/sdk/interfaces/OperatorGroupMemberInput.md): Defined in175 - [Interface: OperatorGroupMemberResponse](https://docs.gravityrail.com/sdk/interfaces/OperatorGroupMemberResponse.md): Defined in25 - [Interface: OperatorTaskDetailResponse](https://docs.gravityrail.com/sdk/interfaces/OperatorTaskDetailResponse.md): Defined in196 - [Interface: OrgA2PBrandListResponse](https://docs.gravityrail.com/sdk/interfaces/OrgA2PBrandListResponse.md): Defined in213 - [Interface: OrgA2PBrandSummary](https://docs.gravityrail.com/sdk/interfaces/OrgA2PBrandSummary.md): Defined in205 - [Interface: OrgAccessDeniedData](https://docs.gravityrail.com/sdk/interfaces/OrgAccessDeniedData.md): Defined in157 - [Interface: Organization](https://docs.gravityrail.com/sdk/interfaces/Organization.md): Defined in526 - [Interface: OrganizationInvitationListResponse](https://docs.gravityrail.com/sdk/interfaces/OrganizationInvitationListResponse.md): Defined in149 - [Interface: OrgAuthInfo](https://docs.gravityrail.com/sdk/interfaces/OrgAuthInfo.md): Defined in84 - [Interface: OrgMember](https://docs.gravityrail.com/sdk/interfaces/OrgMember.md): Defined in405 - [Interface: OrgMemberListResponse](https://docs.gravityrail.com/sdk/interfaces/OrgMemberListResponse.md): Defined in430 - [Interface: OutboundCallRequest](https://docs.gravityrail.com/sdk/interfaces/OutboundCallRequest.md): Defined in172 - [Interface: OutboundCallResponse](https://docs.gravityrail.com/sdk/interfaces/OutboundCallResponse.md): Defined in167 - [Interface: OwnershipVerificationResponse](https://docs.gravityrail.com/sdk/interfaces/OwnershipVerificationResponse.md): Defined in557 - [Interface: PageContext](https://docs.gravityrail.com/sdk/interfaces/PageContext.md): Defined in20 - [Interface: PageExport](https://docs.gravityrail.com/sdk/interfaces/PageExport.md): Defined in156 - [Interface: PageFormData](https://docs.gravityrail.com/sdk/interfaces/PageFormData.md): Defined in82 - [Interface: PageResponse](https://docs.gravityrail.com/sdk/interfaces/PageResponse.md): Defined in110 - [Interface: PagesQueryParams](https://docs.gravityrail.com/sdk/interfaces/PagesQueryParams.md): Defined in96 - [Interface: PaginatedResponse](https://docs.gravityrail.com/sdk/interfaces/PaginatedResponse.md): Defined in4 - [Interface: PaginatedSubscriptionsResponse](https://docs.gravityrail.com/sdk/interfaces/PaginatedSubscriptionsResponse.md): Defined in78 - [Interface: PatientSyncConnectionStatus](https://docs.gravityrail.com/sdk/interfaces/PatientSyncConnectionStatus.md): Defined in19 - [Interface: PendingAnonymousMembersResponse](https://docs.gravityrail.com/sdk/interfaces/PendingAnonymousMembersResponse.md): Defined in631 - [Interface: PendingCredentialChange](https://docs.gravityrail.com/sdk/interfaces/PendingCredentialChange.md): Defined in309 - [Interface: PendingCredentialChangeInvite](https://docs.gravityrail.com/sdk/interfaces/PendingCredentialChangeInvite.md): Defined in286 - [Interface: PerformanceMetrics](https://docs.gravityrail.com/sdk/interfaces/PerformanceMetrics.md): Defined in85 - [Interface: PhoneAggregatedData](https://docs.gravityrail.com/sdk/interfaces/PhoneAggregatedData.md): Defined in60 - [Interface: PhoneCall](https://docs.gravityrail.com/sdk/interfaces/PhoneCall.md): Defined in308 - [Interface: PhoneCallActionParams](https://docs.gravityrail.com/sdk/interfaces/PhoneCallActionParams.md): Defined in367 - [Interface: PhoneCallAggregatedData](https://docs.gravityrail.com/sdk/interfaces/PhoneCallAggregatedData.md): Defined in82 - [Interface: PhoneCallPhoneNumberUsageResponse](https://docs.gravityrail.com/sdk/interfaces/PhoneCallPhoneNumberUsageResponse.md): Defined in89 - [Interface: PhoneCallToolsAbilityConfig](https://docs.gravityrail.com/sdk/interfaces/PhoneCallToolsAbilityConfig.md): Defined in214 - [Interface: PhoneCallUsageResponse](https://docs.gravityrail.com/sdk/interfaces/PhoneCallUsageResponse.md): Defined in101 - [Interface: PhoneCommunicationDetailsResponse](https://docs.gravityrail.com/sdk/interfaces/PhoneCommunicationDetailsResponse.md): Defined in110 - [Interface: PhoneNumber](https://docs.gravityrail.com/sdk/interfaces/PhoneNumber.md): Defined in327 - [Interface: PhoneNumberExport](https://docs.gravityrail.com/sdk/interfaces/PhoneNumberExport.md): Defined in81 - [Interface: PhoneNumberFormData](https://docs.gravityrail.com/sdk/interfaces/PhoneNumberFormData.md): Defined in126 - [Interface: PhoneNumberUsage](https://docs.gravityrail.com/sdk/interfaces/PhoneNumberUsage.md): Defined in47 - [Interface: PhoneUsageReport](https://docs.gravityrail.com/sdk/interfaces/PhoneUsageReport.md): Defined in82 - [Interface: PhoneUsageReportParams](https://docs.gravityrail.com/sdk/interfaces/PhoneUsageReportParams.md): Defined in44 - [Interface: PhoneUsageRow](https://docs.gravityrail.com/sdk/interfaces/PhoneUsageRow.md): Defined in98 - [Interface: PlanComparisonResult](https://docs.gravityrail.com/sdk/interfaces/PlanComparisonResult.md): Defined in89 - [Interface: PlanConfiguration](https://docs.gravityrail.com/sdk/interfaces/PlanConfiguration.md): Defined in99 - [Interface: PlatformAppConnectionResponse](https://docs.gravityrail.com/sdk/interfaces/PlatformAppConnectionResponse.md): Defined in337 - [Interface: PlatformUsageData](https://docs.gravityrail.com/sdk/interfaces/PlatformUsageData.md): Defined in283 - [Interface: PlayAudioActionParams](https://docs.gravityrail.com/sdk/interfaces/PlayAudioActionParams.md): Defined in326 - [Interface: PresenceAcceptInteractionMessage](https://docs.gravityrail.com/sdk/interfaces/PresenceAcceptInteractionMessage.md): Defined in41 - [Interface: PresenceConfirmation](https://docs.gravityrail.com/sdk/interfaces/PresenceConfirmation.md): Defined in115 - [Interface: PresenceEndInteractionMessage](https://docs.gravityrail.com/sdk/interfaces/PresenceEndInteractionMessage.md): Defined in67 - [Interface: PresenceError](https://docs.gravityrail.com/sdk/interfaces/PresenceError.md): Defined in121 - [Interface: PresenceGoLiveMessage](https://docs.gravityrail.com/sdk/interfaces/PresenceGoLiveMessage.md): Defined in24 - [Interface: PresenceGoOfflineMessage](https://docs.gravityrail.com/sdk/interfaces/PresenceGoOfflineMessage.md): Defined in31 - [Interface: PresenceHeartbeatMessage](https://docs.gravityrail.com/sdk/interfaces/PresenceHeartbeatMessage.md): Defined in36 - [Interface: PresenceLoginAck](https://docs.gravityrail.com/sdk/interfaces/PresenceLoginAck.md): Defined in133 - [Interface: PresenceLoginMessage](https://docs.gravityrail.com/sdk/interfaces/PresenceLoginMessage.md): Defined in61 - [Interface: PresenceRejectInteractionMessage](https://docs.gravityrail.com/sdk/interfaces/PresenceRejectInteractionMessage.md): Defined in50 - [Interface: PresenceStatusResponse](https://docs.gravityrail.com/sdk/interfaces/PresenceStatusResponse.md): Defined in46 - [Interface: PresenceTakenOverAckMessage](https://docs.gravityrail.com/sdk/interfaces/PresenceTakenOverAckMessage.md): Defined in56 - [Interface: ProductFeature](https://docs.gravityrail.com/sdk/interfaces/ProductFeature.md): Defined in133 - [Interface: ProductImage](https://docs.gravityrail.com/sdk/interfaces/ProductImage.md): Defined in130 - [Interface: ProductLink](https://docs.gravityrail.com/sdk/interfaces/ProductLink.md): Defined in138 - [Interface: ProductMetadata](https://docs.gravityrail.com/sdk/interfaces/ProductMetadata.md): Defined in146 - [Interface: ProductOverageConfig](https://docs.gravityrail.com/sdk/interfaces/ProductOverageConfig.md): Defined in118 - [Interface: ProductPlan](https://docs.gravityrail.com/sdk/interfaces/ProductPlan.md): Defined in66 - [Interface: PronunciationEntryResponse](https://docs.gravityrail.com/sdk/interfaces/PronunciationEntryResponse.md): Defined in44 - [Interface: PronunciationImportEntry](https://docs.gravityrail.com/sdk/interfaces/PronunciationImportEntry.md): Defined in56 - [Interface: PronunciationImportResult](https://docs.gravityrail.com/sdk/interfaces/PronunciationImportResult.md): Defined in73 - [Interface: ProviderPhoneNumber](https://docs.gravityrail.com/sdk/interfaces/ProviderPhoneNumber.md): Defined in374 - [Interface: ProviderUsageSummary](https://docs.gravityrail.com/sdk/interfaces/ProviderUsageSummary.md): Defined in111 - [Interface: ProvisionA2PEnrollmentSiteRequest](https://docs.gravityrail.com/sdk/interfaces/ProvisionA2PEnrollmentSiteRequest.md): Defined in274 - [Interface: ProvisionPlanRequest](https://docs.gravityrail.com/sdk/interfaces/ProvisionPlanRequest.md): Defined in27 - [Interface: ProvisionPlanResponse](https://docs.gravityrail.com/sdk/interfaces/ProvisionPlanResponse.md): Defined in80 - [Interface: PublicFileMetadata](https://docs.gravityrail.com/sdk/interfaces/PublicFileMetadata.md): Defined in168 - [Interface: PublicFolderContents](https://docs.gravityrail.com/sdk/interfaces/PublicFolderContents.md): Defined in179 - [Interface: PublicOrganizationConfig](https://docs.gravityrail.com/sdk/interfaces/PublicOrganizationConfig.md): Defined in147 - [Interface: PublicSSOConfig](https://docs.gravityrail.com/sdk/interfaces/PublicSSOConfig.md): Defined in141 - [Interface: PublicWorkspace](https://docs.gravityrail.com/sdk/interfaces/PublicWorkspace.md): Defined in270 - [Interface: QualificationExport](https://docs.gravityrail.com/sdk/interfaces/QualificationExport.md): Defined in326 - [Interface: QualificationResponse](https://docs.gravityrail.com/sdk/interfaces/QualificationResponse.md): Defined in133 - [Interface: QueryAggregatePredicate](https://docs.gravityrail.com/sdk/interfaces/QueryAggregatePredicate.md): Defined in154 - [Interface: QueryAggregateSpec](https://docs.gravityrail.com/sdk/interfaces/QueryAggregateSpec.md): Defined in216 - [Interface: QueryAnd](https://docs.gravityrail.com/sdk/interfaces/QueryAnd.md): Defined in93 - [Interface: QueryCompare](https://docs.gravityrail.com/sdk/interfaces/QueryCompare.md): Defined in108 - [Interface: QueryCostInfo](https://docs.gravityrail.com/sdk/interfaces/QueryCostInfo.md): Defined in245 - [Interface: QueryDataTypeInfo](https://docs.gravityrail.com/sdk/interfaces/QueryDataTypeInfo.md): Defined in310 - [Interface: QueryDayBoundaryValue](https://docs.gravityrail.com/sdk/interfaces/QueryDayBoundaryValue.md): Defined in60 - [Interface: QueryDaysAgoValue](https://docs.gravityrail.com/sdk/interfaces/QueryDaysAgoValue.md): Defined in48 - [Interface: QueryDaysFromNowValue](https://docs.gravityrail.com/sdk/interfaces/QueryDaysFromNowValue.md): Defined in55 - [Interface: QueryEnumOption](https://docs.gravityrail.com/sdk/interfaces/QueryEnumOption.md): Defined in272 - [Interface: QueryFieldInfo](https://docs.gravityrail.com/sdk/interfaces/QueryFieldInfo.md): Defined in279 - [Interface: QueryFieldsResponse](https://docs.gravityrail.com/sdk/interfaces/QueryFieldsResponse.md): Defined in318 - [Interface: QueryGroupBy](https://docs.gravityrail.com/sdk/interfaces/QueryGroupBy.md): Defined in204 - [Interface: QueryIR](https://docs.gravityrail.com/sdk/interfaces/QueryIR.md): Defined in222 - [Interface: QueryMetric](https://docs.gravityrail.com/sdk/interfaces/QueryMetric.md): Defined in210 - [Interface: QueryNot](https://docs.gravityrail.com/sdk/interfaces/QueryNot.md): Defined in103 - [Interface: QueryNowValue](https://docs.gravityrail.com/sdk/interfaces/QueryNowValue.md): Defined in44 - [Interface: QueryOr](https://docs.gravityrail.com/sdk/interfaces/QueryOr.md): Defined in98 - [Interface: QueryRangeValue](https://docs.gravityrail.com/sdk/interfaces/QueryRangeValue.md): Defined in81 - [Interface: QueryRecordFieldInfo](https://docs.gravityrail.com/sdk/interfaces/QueryRecordFieldInfo.md): Defined in302 - [Interface: QueryRecordMatch](https://docs.gravityrail.com/sdk/interfaces/QueryRecordMatch.md): Defined in128 - [Interface: QueryRecordSelection](https://docs.gravityrail.com/sdk/interfaces/QueryRecordSelection.md): Defined in115 - [Interface: QueryRelationMatch](https://docs.gravityrail.com/sdk/interfaces/QueryRelationMatch.md): Defined in147 - [Interface: QuerySavedFilterRef](https://docs.gravityrail.com/sdk/interfaces/QuerySavedFilterRef.md): Defined in177 - [Interface: QuerySortKey](https://docs.gravityrail.com/sdk/interfaces/QuerySortKey.md): Defined in199 - [Interface: QuerySubQueryRef](https://docs.gravityrail.com/sdk/interfaces/QuerySubQueryRef.md): Defined in169 - [Interface: RealtimeChatError](https://docs.gravityrail.com/sdk/interfaces/RealtimeChatError.md): Defined in258 - [Interface: RealtimeModelResponse](https://docs.gravityrail.com/sdk/interfaces/RealtimeModelResponse.md): Defined in124 - [Interface: RecommendedVoiceResponse](https://docs.gravityrail.com/sdk/interfaces/RecommendedVoiceResponse.md): Defined in79 - [Interface: RecoveryCodesResponse](https://docs.gravityrail.com/sdk/interfaces/RecoveryCodesResponse.md): Defined in330 - [Interface: RegistryVariable](https://docs.gravityrail.com/sdk/interfaces/RegistryVariable.md): Defined in56 - [Interface: RenderedPageResponse](https://docs.gravityrail.com/sdk/interfaces/RenderedPageResponse.md): Defined in133 - [Interface: ReorderMenuItemsData](https://docs.gravityrail.com/sdk/interfaces/ReorderMenuItemsData.md): Defined in118 - [Interface: RequestCredentialChangeRequest](https://docs.gravityrail.com/sdk/interfaces/RequestCredentialChangeRequest.md): Defined in476 - [Interface: RequestMagicLinkRequest](https://docs.gravityrail.com/sdk/interfaces/RequestMagicLinkRequest.md): Defined in179 - [Interface: RequestMagicLinkResponse](https://docs.gravityrail.com/sdk/interfaces/RequestMagicLinkResponse.md): Defined in185 - [Interface: ResolveAnonymousMemberRequest](https://docs.gravityrail.com/sdk/interfaces/ResolveAnonymousMemberRequest.md): Defined in485 - [Interface: ResolvedA2PCampaignConfig](https://docs.gravityrail.com/sdk/interfaces/ResolvedA2PCampaignConfig.md): Defined in223 - [Interface: ResolveGrantRequest](https://docs.gravityrail.com/sdk/interfaces/ResolveGrantRequest.md): Defined in76 - [Interface: ResourceMetadata](https://docs.gravityrail.com/sdk/interfaces/ResourceMetadata.md): Defined in12 - [Interface: ResourceOverage](https://docs.gravityrail.com/sdk/interfaces/ResourceOverage.md): Defined in270 - [Interface: ResourceOverageResponse](https://docs.gravityrail.com/sdk/interfaces/ResourceOverageResponse.md): Defined in159 - [Interface: ResourceUsageResponse](https://docs.gravityrail.com/sdk/interfaces/ResourceUsageResponse.md): Defined in169 - [Interface: RevokeGrantRequest](https://docs.gravityrail.com/sdk/interfaces/RevokeGrantRequest.md): Defined in82 - [Interface: RoleAssociationEntry](https://docs.gravityrail.com/sdk/interfaces/RoleAssociationEntry.md): Defined in147 - [Interface: RoutineExport](https://docs.gravityrail.com/sdk/interfaces/RoutineExport.md): Defined in211 - [Interface: RoutineResponse](https://docs.gravityrail.com/sdk/interfaces/RoutineResponse.md): Defined in158 - [Interface: RoutineRunResponse](https://docs.gravityrail.com/sdk/interfaces/RoutineRunResponse.md): Defined in74 - [Interface: RoutineRunsQueryParams](https://docs.gravityrail.com/sdk/interfaces/RoutineRunsQueryParams.md): Defined in631 - [Interface: RoutinesQueryParams](https://docs.gravityrail.com/sdk/interfaces/RoutinesQueryParams.md): Defined in618 - [Interface: RuleExecutionResponse](https://docs.gravityrail.com/sdk/interfaces/RuleExecutionResponse.md): Defined in13 - [Interface: RuleExecutionsQueryParams](https://docs.gravityrail.com/sdk/interfaces/RuleExecutionsQueryParams.md): Defined in537 - [Interface: RunQueryRequest](https://docs.gravityrail.com/sdk/interfaces/RunQueryRequest.md): Defined in240 - [Interface: RunQueryResponse](https://docs.gravityrail.com/sdk/interfaces/RunQueryResponse.md): Defined in257 - [Interface: SalesforceConnectionResponse](https://docs.gravityrail.com/sdk/interfaces/SalesforceConnectionResponse.md): Defined in361 - [Interface: SalesforceDataRecordObjectMapping](https://docs.gravityrail.com/sdk/interfaces/SalesforceDataRecordObjectMapping.md): Defined in329 - [Interface: SalesforceSearchRequest](https://docs.gravityrail.com/sdk/interfaces/SalesforceSearchRequest.md): Defined in368 - [Interface: SalesforceSearchResponse](https://docs.gravityrail.com/sdk/interfaces/SalesforceSearchResponse.md): Defined in389 - [Interface: SalesforceSearchResult](https://docs.gravityrail.com/sdk/interfaces/SalesforceSearchResult.md): Defined in379 - [Interface: SalesforceSearchResultMatch](https://docs.gravityrail.com/sdk/interfaces/SalesforceSearchResultMatch.md): Defined in374 - [Interface: SalesforceSyncConfigResponse](https://docs.gravityrail.com/sdk/interfaces/SalesforceSyncConfigResponse.md): Defined in354 - [Interface: SalesforceSyncSettings](https://docs.gravityrail.com/sdk/interfaces/SalesforceSyncSettings.md): Defined in338 - [Interface: ScenarioCriterionExport](https://docs.gravityrail.com/sdk/interfaces/ScenarioCriterionExport.md): Defined in301 - [Interface: ScenarioDataRecord](https://docs.gravityrail.com/sdk/interfaces/ScenarioDataRecord.md): Defined in37 - [Interface: ScenarioExport](https://docs.gravityrail.com/sdk/interfaces/ScenarioExport.md): Defined in313 - [Interface: ScheduledCallbackListResponse](https://docs.gravityrail.com/sdk/interfaces/ScheduledCallbackListResponse.md): Defined in454 - [Interface: ScheduledCallbackResponse](https://docs.gravityrail.com/sdk/interfaces/ScheduledCallbackResponse.md): Defined in461 - [Interface: SchedulePreviewRequest](https://docs.gravityrail.com/sdk/interfaces/SchedulePreviewRequest.md): Defined in641 - [Interface: SchedulePreviewResponse](https://docs.gravityrail.com/sdk/interfaces/SchedulePreviewResponse.md): Defined in108 - [Interface: SchemaField](https://docs.gravityrail.com/sdk/interfaces/SchemaField.md): Defined in157 - [Interface: ScopesListResponse](https://docs.gravityrail.com/sdk/interfaces/ScopesListResponse.md): Defined in135 - [Interface: SendEmailVerificationRequest](https://docs.gravityrail.com/sdk/interfaces/SendEmailVerificationRequest.md): Defined in162 - [Interface: SendSMSAbilityConfig](https://docs.gravityrail.com/sdk/interfaces/SendSMSAbilityConfig.md): Defined in234 - [Interface: SessionExchangeRequest](https://docs.gravityrail.com/sdk/interfaces/SessionExchangeRequest.md): Defined in144 - [Interface: SessionExchangeResponse](https://docs.gravityrail.com/sdk/interfaces/SessionExchangeResponse.md): Defined in150 - [Interface: SessionTakeover](https://docs.gravityrail.com/sdk/interfaces/SessionTakeover.md): Defined in128 - [Interface: SetupStep](https://docs.gravityrail.com/sdk/interfaces/SetupStep.md): Defined in61 - [Interface: SetupTOTPRequest](https://docs.gravityrail.com/sdk/interfaces/SetupTOTPRequest.md): Defined in361 - [Interface: SetupWebAuthnRequest](https://docs.gravityrail.com/sdk/interfaces/SetupWebAuthnRequest.md): Defined in371 - [Interface: SharingGrantEntry](https://docs.gravityrail.com/sdk/interfaces/SharingGrantEntry.md): Defined in156 - [Interface: SignupAccountResponse](https://docs.gravityrail.com/sdk/interfaces/SignupAccountResponse.md): Defined in646 - [Interface: SignupMemberResponse](https://docs.gravityrail.com/sdk/interfaces/SignupMemberResponse.md): Defined in659 - [Interface: SiteContext](https://docs.gravityrail.com/sdk/interfaces/SiteContext.md): Defined in11 - [Interface: SiteCountsResponse](https://docs.gravityrail.com/sdk/interfaces/SiteCountsResponse.md): Defined in169 - [Interface: SiteDisableImpactResponse](https://docs.gravityrail.com/sdk/interfaces/SiteDisableImpactResponse.md): Defined in691 - [Interface: SiteDomainConfigResponse](https://docs.gravityrail.com/sdk/interfaces/SiteDomainConfigResponse.md): Defined in734 - [Interface: SiteExport](https://docs.gravityrail.com/sdk/interfaces/SiteExport.md): Defined in88 - [Interface: SiteFormData](https://docs.gravityrail.com/sdk/interfaces/SiteFormData.md): Defined in123 - [Interface: SiteMappingFormData](https://docs.gravityrail.com/sdk/interfaces/SiteMappingFormData.md): Defined in139 - [Interface: SiteSharingResponse](https://docs.gravityrail.com/sdk/interfaces/SiteSharingResponse.md): Defined in200 - [Interface: SiteSignupResponse](https://docs.gravityrail.com/sdk/interfaces/SiteSignupResponse.md): Defined in276 - [Interface: SiteSlugAvailability](https://docs.gravityrail.com/sdk/interfaces/SiteSlugAvailability.md): Defined in209 - [Interface: SiteSource](https://docs.gravityrail.com/sdk/interfaces/SiteSource.md): Defined in170 - [Interface: SiteSourceBuild](https://docs.gravityrail.com/sdk/interfaces/SiteSourceBuild.md): Defined in149 - [Interface: SiteSourcePublishResponse](https://docs.gravityrail.com/sdk/interfaces/SiteSourcePublishResponse.md): Defined in181 - [Interface: SiteSourceRelease](https://docs.gravityrail.com/sdk/interfaces/SiteSourceRelease.md): Defined in158 - [Interface: SiteSourceTemplateOption](https://docs.gravityrail.com/sdk/interfaces/SiteSourceTemplateOption.md): Defined in187 - [Interface: SiteSourceTemplates](https://docs.gravityrail.com/sdk/interfaces/SiteSourceTemplates.md): Defined in195 - [Interface: SiteVerificationResponse](https://docs.gravityrail.com/sdk/interfaces/SiteVerificationResponse.md): Defined in750 - [Interface: SkillsResponse](https://docs.gravityrail.com/sdk/interfaces/SkillsResponse.md): Defined in502 - [Interface: SkillsState](https://docs.gravityrail.com/sdk/interfaces/SkillsState.md): Defined in71 - [Interface: SkippedWorkspace](https://docs.gravityrail.com/sdk/interfaces/SkippedWorkspace.md): Defined in71 - [Interface: SlackAccount](https://docs.gravityrail.com/sdk/interfaces/SlackAccount.md): Defined in60 - [Interface: SlackAppInstallation](https://docs.gravityrail.com/sdk/interfaces/SlackAppInstallation.md): Defined in42 - [Interface: SlackSlashCommandConfigResponse](https://docs.gravityrail.com/sdk/interfaces/SlackSlashCommandConfigResponse.md): Defined in402 - [Interface: SlackThread](https://docs.gravityrail.com/sdk/interfaces/SlackThread.md): Defined in146 - [Interface: SlashCommandConfigResponse](https://docs.gravityrail.com/sdk/interfaces/SlashCommandConfigResponse.md): Defined in411 - [Interface: SMSCommunicationDetailsResponse](https://docs.gravityrail.com/sdk/interfaces/SMSCommunicationDetailsResponse.md): Defined in184 - [Interface: SMSLoginResponse](https://docs.gravityrail.com/sdk/interfaces/SMSLoginResponse.md): Defined in338 - [Interface: SMSMessage](https://docs.gravityrail.com/sdk/interfaces/SMSMessage.md): Defined in419 - [Interface: SMSMessageDef](https://docs.gravityrail.com/sdk/interfaces/SMSMessageDef.md): Defined in226 - [Interface: SMSMessageUsageResponse](https://docs.gravityrail.com/sdk/interfaces/SMSMessageUsageResponse.md): Defined in194 - [Interface: SMSPhoneNumberUsageResponse](https://docs.gravityrail.com/sdk/interfaces/SMSPhoneNumberUsageResponse.md): Defined in204 - [Interface: SmsSendActionParams](https://docs.gravityrail.com/sdk/interfaces/SmsSendActionParams.md): Defined in360 - [Interface: SMSUsageReport](https://docs.gravityrail.com/sdk/interfaces/SMSUsageReport.md): Defined in125 - [Interface: SMSUsageReportParams](https://docs.gravityrail.com/sdk/interfaces/SMSUsageReportParams.md): Defined in39 - [Interface: SMSUsageRow](https://docs.gravityrail.com/sdk/interfaces/SMSUsageRow.md): Defined in144 - [Interface: SpamScore](https://docs.gravityrail.com/sdk/interfaces/SpamScore.md): Defined in182 - [Interface: SSOConfig](https://docs.gravityrail.com/sdk/interfaces/SSOConfig.md): Defined in388 - [Interface: SSOConfigData](https://docs.gravityrail.com/sdk/interfaces/SSOConfigData.md): Defined in641 - [Interface: StartTestChatRunRequest](https://docs.gravityrail.com/sdk/interfaces/StartTestChatRunRequest.md): Defined in128 - [Interface: StartTestChatRunResponse](https://docs.gravityrail.com/sdk/interfaces/StartTestChatRunResponse.md): Defined in218 - [Interface: StatisticsSummary](https://docs.gravityrail.com/sdk/interfaces/StatisticsSummary.md): Defined in41 - [Interface: StripeAddress](https://docs.gravityrail.com/sdk/interfaces/StripeAddress.md): Defined in454 - [Interface: StripeCardDetails](https://docs.gravityrail.com/sdk/interfaces/StripeCardDetails.md): Defined in503 - [Interface: StripeComparisonResult](https://docs.gravityrail.com/sdk/interfaces/StripeComparisonResult.md): Defined in212 - [Interface: StripeCustomer](https://docs.gravityrail.com/sdk/interfaces/StripeCustomer.md): Defined in223 - [Interface: StripeCustomerCreateRequest](https://docs.gravityrail.com/sdk/interfaces/StripeCustomerCreateRequest.md): Defined in477 - [Interface: StripeCustomerUpdateRequest](https://docs.gravityrail.com/sdk/interfaces/StripeCustomerUpdateRequest.md): Defined in489 - [Interface: StripePaymentMethod](https://docs.gravityrail.com/sdk/interfaces/StripePaymentMethod.md): Defined in519 - [Interface: StripePlanDetail](https://docs.gravityrail.com/sdk/interfaces/StripePlanDetail.md): Defined in250 - [Interface: StripePrice](https://docs.gravityrail.com/sdk/interfaces/StripePrice.md): Defined in266 - [Interface: StripeProduct](https://docs.gravityrail.com/sdk/interfaces/StripeProduct.md): Defined in284 - [Interface: StripeShipping](https://docs.gravityrail.com/sdk/interfaces/StripeShipping.md): Defined in463 - [Interface: StripeSubscriptionCreateRequest](https://docs.gravityrail.com/sdk/interfaces/StripeSubscriptionCreateRequest.md): Defined in530 - [Interface: StripeSubscriptionUpdateRequest](https://docs.gravityrail.com/sdk/interfaces/StripeSubscriptionUpdateRequest.md): Defined in558 - [Interface: StripeTax](https://docs.gravityrail.com/sdk/interfaces/StripeTax.md): Defined in469 - [Interface: StripeUSBankAccountDetails](https://docs.gravityrail.com/sdk/interfaces/StripeUSBankAccountDetails.md): Defined in512 - [Interface: STTCapabilitiesResponse](https://docs.gravityrail.com/sdk/interfaces/STTCapabilitiesResponse.md): Defined in157 - [Interface: STTModelResponse](https://docs.gravityrail.com/sdk/interfaces/STTModelResponse.md): Defined in174 - [Interface: STTModelsResponse](https://docs.gravityrail.com/sdk/interfaces/STTModelsResponse.md): Defined in192 - [Interface: STTProviderSummary](https://docs.gravityrail.com/sdk/interfaces/STTProviderSummary.md): Defined in158 - [Interface: STTUsageRow](https://docs.gravityrail.com/sdk/interfaces/STTUsageRow.md): Defined in168 - [Interface: SubscriptionUpdateRequest](https://docs.gravityrail.com/sdk/interfaces/SubscriptionUpdateRequest.md): Defined in550 - [Interface: SupervisorAbilityConfig](https://docs.gravityrail.com/sdk/interfaces/SupervisorAbilityConfig.md): Defined in128 - [Interface: SupervisorActionsAbilityConfig](https://docs.gravityrail.com/sdk/interfaces/SupervisorActionsAbilityConfig.md): Defined in138 - [Interface: SupervisorFormData](https://docs.gravityrail.com/sdk/interfaces/SupervisorFormData.md): Defined in5 - [Interface: SwitchTaskActionParams](https://docs.gravityrail.com/sdk/interfaces/SwitchTaskActionParams.md): Defined in228 - [Interface: SyncCalendarResponse](https://docs.gravityrail.com/sdk/interfaces/SyncCalendarResponse.md): Defined in203 - [Interface: SyncCapabilities](https://docs.gravityrail.com/sdk/interfaces/SyncCapabilities.md): Defined in429 - [Interface: SyncCapabilitiesResponse](https://docs.gravityrail.com/sdk/interfaces/SyncCapabilitiesResponse.md): Defined in420 - [Interface: SyncCheckpoint](https://docs.gravityrail.com/sdk/interfaces/SyncCheckpoint.md): Defined in529 - [Interface: SyncLogEntry](https://docs.gravityrail.com/sdk/interfaces/SyncLogEntry.md): Defined in313 - [Interface: SyncLogsResponse](https://docs.gravityrail.com/sdk/interfaces/SyncLogsResponse.md): Defined in321 - [Interface: SyncProductToStripeRequest](https://docs.gravityrail.com/sdk/interfaces/SyncProductToStripeRequest.md): Defined in567 - [Interface: SyncProductToStripeResponse](https://docs.gravityrail.com/sdk/interfaces/SyncProductToStripeResponse.md): Defined in355 - [Interface: SyncRule](https://docs.gravityrail.com/sdk/interfaces/SyncRule.md): Defined in193 - [Interface: SyncRuleInbound](https://docs.gravityrail.com/sdk/interfaces/SyncRuleInbound.md): Defined in187 - [Interface: SyncRuleOutbound](https://docs.gravityrail.com/sdk/interfaces/SyncRuleOutbound.md): Defined in176 - [Interface: SyncRunRequest](https://docs.gravityrail.com/sdk/interfaces/SyncRunRequest.md): Defined in265 - [Interface: SyncRunResponse](https://docs.gravityrail.com/sdk/interfaces/SyncRunResponse.md): Defined in293 - [Interface: SystemStatistics](https://docs.gravityrail.com/sdk/interfaces/SystemStatistics.md): Defined in147 - [Interface: TaskAssignmentStatsResponse](https://docs.gravityrail.com/sdk/interfaces/TaskAssignmentStatsResponse.md): Defined in221 - [Interface: TaskChatResponse](https://docs.gravityrail.com/sdk/interfaces/TaskChatResponse.md): Defined in230 - [Interface: TaskChatsListResponse](https://docs.gravityrail.com/sdk/interfaces/TaskChatsListResponse.md): Defined in247 - [Interface: TaskChildRelation](https://docs.gravityrail.com/sdk/interfaces/TaskChildRelation.md): Defined in113 - [Interface: TaskContext](https://docs.gravityrail.com/sdk/interfaces/TaskContext.md): Defined in38 - [Interface: TaskCountResponse](https://docs.gravityrail.com/sdk/interfaces/TaskCountResponse.md): Defined in6 - [Interface: TaskDataTypeRelation](https://docs.gravityrail.com/sdk/interfaces/TaskDataTypeRelation.md): Defined in101 - [Interface: TaskEventRuleRelation](https://docs.gravityrail.com/sdk/interfaces/TaskEventRuleRelation.md): Defined in122 - [Interface: TaskExport](https://docs.gravityrail.com/sdk/interfaces/TaskExport.md): Defined in18 - [Interface: TaskExportChildRelation](https://docs.gravityrail.com/sdk/interfaces/TaskExportChildRelation.md): Defined in203 - [Interface: TaskExportDataTypeRelation](https://docs.gravityrail.com/sdk/interfaces/TaskExportDataTypeRelation.md): Defined in214 - [Interface: TaskExportEventRuleRelation](https://docs.gravityrail.com/sdk/interfaces/TaskExportEventRuleRelation.md): Defined in649 - [Interface: TaskExportFileRelation](https://docs.gravityrail.com/sdk/interfaces/TaskExportFileRelation.md): Defined in122 - [Interface: TaskFileRelation](https://docs.gravityrail.com/sdk/interfaces/TaskFileRelation.md): Defined in107 - [Interface: TaskFormData](https://docs.gravityrail.com/sdk/interfaces/TaskFormData.md): Defined in89 - [Interface: TasksQueryParams](https://docs.gravityrail.com/sdk/interfaces/TasksQueryParams.md): Defined in107 - [Interface: TeamsAccountResponse](https://docs.gravityrail.com/sdk/interfaces/TeamsAccountResponse.md): Defined in443 - [Interface: TeamsAppInstallationResponse](https://docs.gravityrail.com/sdk/interfaces/TeamsAppInstallationResponse.md): Defined in461 - [Interface: TeamsAppResponse](https://docs.gravityrail.com/sdk/interfaces/TeamsAppResponse.md): Defined in477 - [Interface: TeamsCommandConfigResponse](https://docs.gravityrail.com/sdk/interfaces/TeamsCommandConfigResponse.md): Defined in501 - [Interface: TemplateContextRequest](https://docs.gravityrail.com/sdk/interfaces/TemplateContextRequest.md): Defined in16 - [Interface: TemplateContextResponse](https://docs.gravityrail.com/sdk/interfaces/TemplateContextResponse.md): Defined in27 - [Interface: TemplatePreviewRequest](https://docs.gravityrail.com/sdk/interfaces/TemplatePreviewRequest.md): Defined in36 - [Interface: TemplatePreviewResponse](https://docs.gravityrail.com/sdk/interfaces/TemplatePreviewResponse.md): Defined in48 - [Interface: TemplateVariable](https://docs.gravityrail.com/sdk/interfaces/TemplateVariable.md): Defined in6 - [Interface: TestChatRunResponse](https://docs.gravityrail.com/sdk/interfaces/TestChatRunResponse.md): Defined in230 - [Interface: TestConnectionResponse](https://docs.gravityrail.com/sdk/interfaces/TestConnectionResponse.md): Defined in530 - [Interface: TestWebhookRequest](https://docs.gravityrail.com/sdk/interfaces/TestWebhookRequest.md): Defined in214 - [Interface: TestWebhookResponse](https://docs.gravityrail.com/sdk/interfaces/TestWebhookResponse.md): Defined in220 - [Interface: TextContent](https://docs.gravityrail.com/sdk/interfaces/TextContent.md): Defined in190 - [Interface: ThemeFeatures](https://docs.gravityrail.com/sdk/interfaces/ThemeFeatures.md): Defined in17 - [Interface: ThemeResponse](https://docs.gravityrail.com/sdk/interfaces/ThemeResponse.md): Defined in53 - [Interface: ThemeSettingField](https://docs.gravityrail.com/sdk/interfaces/ThemeSettingField.md): Defined in294 - [Interface: ThemeSettingsResponse](https://docs.gravityrail.com/sdk/interfaces/ThemeSettingsResponse.md): Defined in349 - [Interface: ThemesListResponse](https://docs.gravityrail.com/sdk/interfaces/ThemesListResponse.md): Defined in65 - [Interface: ThinkingSoundPreviewRequest](https://docs.gravityrail.com/sdk/interfaces/ThinkingSoundPreviewRequest.md): Defined in8 - [Interface: TimeSeriesData](https://docs.gravityrail.com/sdk/interfaces/TimeSeriesData.md): Defined in34 - [Interface: TimeSeriesDataPoint](https://docs.gravityrail.com/sdk/interfaces/TimeSeriesDataPoint.md): Defined in28 - [Interface: TimeSlot](https://docs.gravityrail.com/sdk/interfaces/TimeSlot.md): Defined in317 - [Interface: TipTapDocumentOutput](https://docs.gravityrail.com/sdk/interfaces/TipTapDocumentOutput.md): Defined in372 - [Interface: TodoItemResponse](https://docs.gravityrail.com/sdk/interfaces/TodoItemResponse.md): Defined in510 - [Interface: TodosResponse](https://docs.gravityrail.com/sdk/interfaces/TodosResponse.md): Defined in522 - [Interface: Tool](https://docs.gravityrail.com/sdk/interfaces/Tool.md): Defined in11 - [Interface: ToolCall](https://docs.gravityrail.com/sdk/interfaces/ToolCall.md): Defined in173 - [Interface: ToolCallFunction](https://docs.gravityrail.com/sdk/interfaces/ToolCallFunction.md): Defined in168 - [Interface: ToolInputSchema](https://docs.gravityrail.com/sdk/interfaces/ToolInputSchema.md): Defined in28 - [Interface: Toolkit](https://docs.gravityrail.com/sdk/interfaces/Toolkit.md): Defined in56 - [Interface: ToolkitContext](https://docs.gravityrail.com/sdk/interfaces/ToolkitContext.md): Defined in55 - [Interface: ToolkitsAbilityConfig](https://docs.gravityrail.com/sdk/interfaces/ToolkitsAbilityConfig.md): Defined in148 - [Interface: ToolkitsResponse](https://docs.gravityrail.com/sdk/interfaces/ToolkitsResponse.md): Defined in68 - [Interface: ToolParameter](https://docs.gravityrail.com/sdk/interfaces/ToolParameter.md): Defined in28 - [Interface: ToolResponse](https://docs.gravityrail.com/sdk/interfaces/ToolResponse.md): Defined in40 - [Interface: ToolResult](https://docs.gravityrail.com/sdk/interfaces/ToolResult.md): Defined in179 - [Interface: ToolsResponse](https://docs.gravityrail.com/sdk/interfaces/ToolsResponse.md): Defined in75 - [Interface: TopOffender](https://docs.gravityrail.com/sdk/interfaces/TopOffender.md): Defined in31 - [Interface: TopResourceOverageResponse](https://docs.gravityrail.com/sdk/interfaces/TopResourceOverageResponse.md): Defined in217 - [Interface: TOTPSetupResponse](https://docs.gravityrail.com/sdk/interfaces/TOTPSetupResponse.md): Defined in346 - [Interface: TransformPreset](https://docs.gravityrail.com/sdk/interfaces/TransformPreset.md): Defined in167 - [Interface: TriggerConnectionBackfillRequest](https://docs.gravityrail.com/sdk/interfaces/TriggerConnectionBackfillRequest.md): Defined in349 - [Interface: TriggerPatientRefreshRequest](https://docs.gravityrail.com/sdk/interfaces/TriggerPatientRefreshRequest.md): Defined in338 - [Interface: TTSModelResponse](https://docs.gravityrail.com/sdk/interfaces/TTSModelResponse.md): Defined in199 - [Interface: TTSPreviewRequest](https://docs.gravityrail.com/sdk/interfaces/TTSPreviewRequest.md): Defined in3 - [Interface: TTSProviderSummary](https://docs.gravityrail.com/sdk/interfaces/TTSProviderSummary.md): Defined in179 - [Interface: TTSUsageRow](https://docs.gravityrail.com/sdk/interfaces/TTSUsageRow.md): Defined in189 - [Interface: TwoFactorOperationResponse](https://docs.gravityrail.com/sdk/interfaces/TwoFactorOperationResponse.md): Defined in374 - [Interface: UIChoiceDecision](https://docs.gravityrail.com/sdk/interfaces/UIChoiceDecision.md): Defined in350 - [Interface: UnauthorizedSiteResponse](https://docs.gravityrail.com/sdk/interfaces/UnauthorizedSiteResponse.md): Defined in406 - [Interface: UnlinkCalendarResponse](https://docs.gravityrail.com/sdk/interfaces/UnlinkCalendarResponse.md): Defined in198 - [Interface: UnmappedPhoneNumber](https://docs.gravityrail.com/sdk/interfaces/UnmappedPhoneNumber.md): Defined in98 - [Interface: UnthreadedEmailResponse](https://docs.gravityrail.com/sdk/interfaces/UnthreadedEmailResponse.md): Defined in463 - [Interface: UpdateA2PCampaignConfigRequest](https://docs.gravityrail.com/sdk/interfaces/UpdateA2PCampaignConfigRequest.md): Defined in284 - [Interface: UpdateAgentRequest](https://docs.gravityrail.com/sdk/interfaces/UpdateAgentRequest.md): Defined in462 - [Interface: UpdateAppConnectionRequest](https://docs.gravityrail.com/sdk/interfaces/UpdateAppConnectionRequest.md): Defined in628 - [Interface: UpdateAppRequest](https://docs.gravityrail.com/sdk/interfaces/UpdateAppRequest.md): Defined in53 - [Interface: UpdateAssignmentFormData](https://docs.gravityrail.com/sdk/interfaces/UpdateAssignmentFormData.md): Defined in138 - [Interface: UpdateAttendeeRequest](https://docs.gravityrail.com/sdk/interfaces/UpdateAttendeeRequest.md): Defined in159 - [Interface: UpdateBuilderRequest](https://docs.gravityrail.com/sdk/interfaces/UpdateBuilderRequest.md): Defined in28 - [Interface: UpdateBusinessProfileRequest](https://docs.gravityrail.com/sdk/interfaces/UpdateBusinessProfileRequest.md): Defined in184 - [Interface: UpdateDiscordBotRequest](https://docs.gravityrail.com/sdk/interfaces/UpdateDiscordBotRequest.md): Defined in66 - [Interface: UpdateEncounterSyncRequest](https://docs.gravityrail.com/sdk/interfaces/UpdateEncounterSyncRequest.md): Defined in292 - [Interface: UpdateEventRuleFormData](https://docs.gravityrail.com/sdk/interfaces/UpdateEventRuleFormData.md): Defined in497 - [Interface: UpdateFhirConnectionRequest](https://docs.gravityrail.com/sdk/interfaces/UpdateFhirConnectionRequest.md): Defined in87 - [Interface: UpdateFhirCsvImportSettingsRequest](https://docs.gravityrail.com/sdk/interfaces/UpdateFhirCsvImportSettingsRequest.md): Defined in227 - [Interface: UpdateFileRoleAssociationsRequest](https://docs.gravityrail.com/sdk/interfaces/UpdateFileRoleAssociationsRequest.md): Defined in152 - [Interface: UpdateFileSharingRequest](https://docs.gravityrail.com/sdk/interfaces/UpdateFileSharingRequest.md): Defined in161 - [Interface: UpdateInvitationFormData](https://docs.gravityrail.com/sdk/interfaces/UpdateInvitationFormData.md): Defined in57 - [Interface: UpdateMemberFieldRequest](https://docs.gravityrail.com/sdk/interfaces/UpdateMemberFieldRequest.md): Defined in21 - [Interface: UpdateOperatorGroupRequest](https://docs.gravityrail.com/sdk/interfaces/UpdateOperatorGroupRequest.md): Defined in186 - [Interface: UpdateOrganizationRequest](https://docs.gravityrail.com/sdk/interfaces/UpdateOrganizationRequest.md): Defined in283 - [Interface: UpdateOrgMemberRequest](https://docs.gravityrail.com/sdk/interfaces/UpdateOrgMemberRequest.md): Defined in437 - [Interface: UpdatePersonaRequest](https://docs.gravityrail.com/sdk/interfaces/UpdatePersonaRequest.md): Defined in108 - [Interface: UpdatePronunciationEntryFormData](https://docs.gravityrail.com/sdk/interfaces/UpdatePronunciationEntryFormData.md): Defined in22 - [Interface: UpdateRoutineRequest](https://docs.gravityrail.com/sdk/interfaces/UpdateRoutineRequest.md): Defined in589 - [Interface: UpdateSalesforceSyncConfigRequest](https://docs.gravityrail.com/sdk/interfaces/UpdateSalesforceSyncConfigRequest.md): Defined in359 - [Interface: UpdateScenarioRequest](https://docs.gravityrail.com/sdk/interfaces/UpdateScenarioRequest.md): Defined in83 - [Interface: UpdateSlackAppRequest](https://docs.gravityrail.com/sdk/interfaces/UpdateSlackAppRequest.md): Defined in111 - [Interface: UpdateTeamsAppRequest](https://docs.gravityrail.com/sdk/interfaces/UpdateTeamsAppRequest.md): Defined in86 - [Interface: UpdateThemeSettingsRequest](https://docs.gravityrail.com/sdk/interfaces/UpdateThemeSettingsRequest.md): Defined in551 - [Interface: UpdateTwoFactorMethodRequest](https://docs.gravityrail.com/sdk/interfaces/UpdateTwoFactorMethodRequest.md): Defined in385 - [Interface: UpdateWorkflowContributorRequest](https://docs.gravityrail.com/sdk/interfaces/UpdateWorkflowContributorRequest.md): Defined in164 - [Interface: UpdateWorkspaceMemberRequest](https://docs.gravityrail.com/sdk/interfaces/UpdateWorkspaceMemberRequest.md): Defined in369 - [Interface: UploadFileRequest](https://docs.gravityrail.com/sdk/interfaces/UploadFileRequest.md): Defined in79 - [Interface: UsageDiscrepancy](https://docs.gravityrail.com/sdk/interfaces/UsageDiscrepancy.md): Defined in380 - [Interface: UsageProductSummaryResponse](https://docs.gravityrail.com/sdk/interfaces/UsageProductSummaryResponse.md): Defined in225 - [Interface: UsageReportRequest](https://docs.gravityrail.com/sdk/interfaces/UsageReportRequest.md): Defined in58 - [Interface: UsageReportResponse](https://docs.gravityrail.com/sdk/interfaces/UsageReportResponse.md): Defined in239 - [Interface: UsageStatistics](https://docs.gravityrail.com/sdk/interfaces/UsageStatistics.md): Defined in116 - [Interface: ValidateMagicLinkRequest](https://docs.gravityrail.com/sdk/interfaces/ValidateMagicLinkRequest.md): Defined in192 - [Interface: ValidateMagicLinkResponse](https://docs.gravityrail.com/sdk/interfaces/ValidateMagicLinkResponse.md): Defined in196 - [Interface: ValidateQueryResponse](https://docs.gravityrail.com/sdk/interfaces/ValidateQueryResponse.md): Defined in250 - [Interface: VariableRegistryRequest](https://docs.gravityrail.com/sdk/interfaces/VariableRegistryRequest.md): Defined in70 - [Interface: VariableRegistryResponse](https://docs.gravityrail.com/sdk/interfaces/VariableRegistryResponse.md): Defined in78 - [Interface: VerifyCodeRequest](https://docs.gravityrail.com/sdk/interfaces/VerifyCodeRequest.md): Defined in129 - [Interface: VerifyCodeResponse](https://docs.gravityrail.com/sdk/interfaces/VerifyCodeResponse.md): Defined in135 - [Interface: VerifyCredentialChangeRequest](https://docs.gravityrail.com/sdk/interfaces/VerifyCredentialChangeRequest.md): Defined in481 - [Interface: VerifyEmailRequest](https://docs.gravityrail.com/sdk/interfaces/VerifyEmailRequest.md): Defined in167 - [Interface: VerifyTOTPSetupRequest](https://docs.gravityrail.com/sdk/interfaces/VerifyTOTPSetupRequest.md): Defined in365 - [Interface: VerifyWebAuthnSetupRequest](https://docs.gravityrail.com/sdk/interfaces/VerifyWebAuthnSetupRequest.md): Defined in375 - [Interface: VoiceMetricsTimeRange](https://docs.gravityrail.com/sdk/interfaces/VoiceMetricsTimeRange.md): Defined in87 - [Interface: VoiceTokenResponse](https://docs.gravityrail.com/sdk/interfaces/VoiceTokenResponse.md): Defined in471 - [Interface: VoiceUsageReport](https://docs.gravityrail.com/sdk/interfaces/VoiceUsageReport.md): Defined in200 - [Interface: VoiceUsageReportParams](https://docs.gravityrail.com/sdk/interfaces/VoiceUsageReportParams.md): Defined in54 - [Interface: VoiceUsageResponse](https://docs.gravityrail.com/sdk/interfaces/VoiceUsageResponse.md): Defined in567 - [Interface: WebhookActionParams](https://docs.gravityrail.com/sdk/interfaces/WebhookActionParams.md): Defined in209 - [Interface: WebhookLogResponse](https://docs.gravityrail.com/sdk/interfaces/WebhookLogResponse.md): Defined in37 - [Interface: WebhookLogsQueryParams](https://docs.gravityrail.com/sdk/interfaces/WebhookLogsQueryParams.md): Defined in528 - [Interface: WebhookMetrics](https://docs.gravityrail.com/sdk/interfaces/WebhookMetrics.md): Defined in79 - [Interface: WebSearchAbilityConfig](https://docs.gravityrail.com/sdk/interfaces/WebSearchAbilityConfig.md): Defined in258 - [Interface: WorkflowAccessGapSummary](https://docs.gravityrail.com/sdk/interfaces/WorkflowAccessGapSummary.md): Defined in313 - [Interface: WorkflowAccessValidationResponse](https://docs.gravityrail.com/sdk/interfaces/WorkflowAccessValidationResponse.md): Defined in322 - [Interface: WorkflowAccessWarning](https://docs.gravityrail.com/sdk/interfaces/WorkflowAccessWarning.md): Defined in329 - [Interface: WorkflowActivity](https://docs.gravityrail.com/sdk/interfaces/WorkflowActivity.md): Defined in171 - [Interface: WorkflowConfigValidationResponse](https://docs.gravityrail.com/sdk/interfaces/WorkflowConfigValidationResponse.md): Defined in359 - [Interface: WorkflowContext](https://docs.gravityrail.com/sdk/interfaces/WorkflowContext.md): Defined in29 - [Interface: WorkflowContributorResponse](https://docs.gravityrail.com/sdk/interfaces/WorkflowContributorResponse.md): Defined in366 - [Interface: WorkflowExport](https://docs.gravityrail.com/sdk/interfaces/WorkflowExport.md): Defined in9 - [Interface: WorkflowFormData](https://docs.gravityrail.com/sdk/interfaces/WorkflowFormData.md): Defined in176 - [Interface: WorkflowMemberRoleAccessInput](https://docs.gravityrail.com/sdk/interfaces/WorkflowMemberRoleAccessInput.md): Defined in143 - [Interface: WorkflowNoteExport](https://docs.gravityrail.com/sdk/interfaces/WorkflowNoteExport.md): Defined in290 - [Interface: WorkflowNoteFormData](https://docs.gravityrail.com/sdk/interfaces/WorkflowNoteFormData.md): Defined in149 - [Interface: WorkflowNoteResponse](https://docs.gravityrail.com/sdk/interfaces/WorkflowNoteResponse.md): Defined in389 - [Interface: WorkflowRouteDryRunCandidate](https://docs.gravityrail.com/sdk/interfaces/WorkflowRouteDryRunCandidate.md): Defined in229 - [Interface: WorkflowRouteDryRunResponse](https://docs.gravityrail.com/sdk/interfaces/WorkflowRouteDryRunResponse.md): Defined in475 - [Interface: WorkflowRunAbilityConfig](https://docs.gravityrail.com/sdk/interfaces/WorkflowRunAbilityConfig.md): Defined in403 - [Interface: WorkflowStartAutomationResponse](https://docs.gravityrail.com/sdk/interfaces/WorkflowStartAutomationResponse.md): Defined in546 - [Interface: WorkflowTemplateResponse](https://docs.gravityrail.com/sdk/interfaces/WorkflowTemplateResponse.md): Defined in491 - [Interface: Workspace](https://docs.gravityrail.com/sdk/interfaces/Workspace.md): Defined in480 - [Interface: WorkspaceAccessDeniedData](https://docs.gravityrail.com/sdk/interfaces/WorkspaceAccessDeniedData.md): Defined in155 - [Interface: WorkspaceAutoMapEntities](https://docs.gravityrail.com/sdk/interfaces/WorkspaceAutoMapEntities.md): Defined in456 - [Interface: WorkspaceAvailableDomain](https://docs.gravityrail.com/sdk/interfaces/WorkspaceAvailableDomain.md): Defined in430 - [Interface: WorkspaceAvailableDomainsResponse](https://docs.gravityrail.com/sdk/interfaces/WorkspaceAvailableDomainsResponse.md): Defined in438 - [Interface: WorkspaceBuilderExportData](https://docs.gravityrail.com/sdk/interfaces/WorkspaceBuilderExportData.md): Defined in40 - [Interface: WorkspaceBuilderInfo](https://docs.gravityrail.com/sdk/interfaces/WorkspaceBuilderInfo.md): Defined in53 - [Interface: WorkspaceBuilderListResponse](https://docs.gravityrail.com/sdk/interfaces/WorkspaceBuilderListResponse.md): Defined in61 - [Interface: WorkspaceBuilderTaskExport](https://docs.gravityrail.com/sdk/interfaces/WorkspaceBuilderTaskExport.md): Defined in27 - [Interface: WorkspaceBuilderWorkflowExport](https://docs.gravityrail.com/sdk/interfaces/WorkspaceBuilderWorkflowExport.md): Defined in19 - [Interface: WorkspaceBuildPreview](https://docs.gravityrail.com/sdk/interfaces/WorkspaceBuildPreview.md): Defined in70 - [Interface: WorkspaceCounts](https://docs.gravityrail.com/sdk/interfaces/WorkspaceCounts.md): Defined in446 - [Interface: WorkspaceCreateNewEntities](https://docs.gravityrail.com/sdk/interfaces/WorkspaceCreateNewEntities.md): Defined in424 - [Interface: WorkspaceDefaults](https://docs.gravityrail.com/sdk/interfaces/WorkspaceDefaults.md): Defined in526 - [Interface: WorkspaceDefaultsFormData](https://docs.gravityrail.com/sdk/interfaces/WorkspaceDefaultsFormData.md): Defined in124 - [Interface: WorkspaceExportData](https://docs.gravityrail.com/sdk/interfaces/WorkspaceExportData.md): Defined in350 - [Interface: WorkspaceFeatureInfo](https://docs.gravityrail.com/sdk/interfaces/WorkspaceFeatureInfo.md): Defined in50 - [Interface: WorkspaceFormData](https://docs.gravityrail.com/sdk/interfaces/WorkspaceFormData.md): Defined in76 - [Interface: WorkspaceHealthDetail](https://docs.gravityrail.com/sdk/interfaces/WorkspaceHealthDetail.md): Defined in43 - [Interface: WorkspaceHealthRow](https://docs.gravityrail.com/sdk/interfaces/WorkspaceHealthRow.md): Defined in87 - [Interface: WorkspaceImportMapping](https://docs.gravityrail.com/sdk/interfaces/WorkspaceImportMapping.md): Defined in396 - [Interface: WorkspaceImportPreviewResponse](https://docs.gravityrail.com/sdk/interfaces/WorkspaceImportPreviewResponse.md): Defined in510 - [Interface: WorkspaceImportRequest](https://docs.gravityrail.com/sdk/interfaces/WorkspaceImportRequest.md): Defined in484 - [Interface: WorkspaceImportValidation](https://docs.gravityrail.com/sdk/interfaces/WorkspaceImportValidation.md): Defined in493 - [Interface: WorkspaceJoinRequest](https://docs.gravityrail.com/sdk/interfaces/WorkspaceJoinRequest.md): Defined in168 - [Interface: WorkspaceJoinResponse](https://docs.gravityrail.com/sdk/interfaces/WorkspaceJoinResponse.md): Defined in470 - [Interface: WorkspaceMemberResponse](https://docs.gravityrail.com/sdk/interfaces/WorkspaceMemberResponse.md): Defined in730 - [Interface: WorkspaceScope](https://docs.gravityrail.com/sdk/interfaces/WorkspaceScope.md): Defined in32 - [Interface: WorkspaceScopesResponse](https://docs.gravityrail.com/sdk/interfaces/WorkspaceScopesResponse.md): Defined in43 - [Interface: WorkspaceStatsResponse](https://docs.gravityrail.com/sdk/interfaces/WorkspaceStatsResponse.md): Defined in112 - [Interface: WorkspaceUsageReportResponse](https://docs.gravityrail.com/sdk/interfaces/WorkspaceUsageReportResponse.md): Defined in268 - [Interface: XAIChatModelConfig](https://docs.gravityrail.com/sdk/interfaces/XAIChatModelConfig.md): Defined in164 - [Interface: XAIRealtimeModelConfig](https://docs.gravityrail.com/sdk/interfaces/XAIRealtimeModelConfig.md): Defined in110 ### type-aliases - [Type Alias: Ability](https://docs.gravityrail.com/sdk/type-aliases/Ability.md): Ability = AbilityResponse - [Type Alias: AbilityConfig](https://docs.gravityrail.com/sdk/type-aliases/AbilityConfig.md): AbilityConfig = CalendarBookingAbilityConfig \| FileAccessAbilityConfig \| SupervisorAbilityConfig \| SupervisorActionsAbilityConfig \| ToolkitsAbilityConfig \| DataAccessAbilityConfig \| PhoneCallToolsAbilityConfig \| SendSMSAbilityConfig \| EscalationAbilityConfig \| WebSearchAbilityConfig \| ConversationHistoryAbilityConfig \| GmailAbilityConfig \| GoogleCalendarAbilityConfig \| GoogleDriveAbilityConfig \| AudioPlaybackAbilityConfig \| CharlestonPmdAbilityConfig \| ConversationControlAbilityConfig \| WorkflowRunAbilityConfig \| MemberFieldVerificationAbilityConfig \| ImageGenerationAbilityConfig \| EmptyAbilityConfig \| Record\ - [Type Alias: AbilityConfigIssueCode](https://docs.gravityrail.com/sdk/type-aliases/AbilityConfigIssueCode.md): AbilityConfigIssueCode = typeof AbilityConfigIssueCode\keyof typeof [AbilityConfigIssueCode\] - [Type Alias: AbilityConfigIssueSeverity](https://docs.gravityrail.com/sdk/type-aliases/AbilityConfigIssueSeverity.md): AbilityConfigIssueSeverity = typeof AbilityConfigIssueSeverity\keyof typeof [AbilityConfigIssueSeverity\] - [Type Alias: AbilityResponse](https://docs.gravityrail.com/sdk/type-aliases/AbilityResponse.md): AbilityResponse = Omit\ & object - [Type Alias: AbilityTypeSlug](https://docs.gravityrail.com/sdk/type-aliases/AbilityTypeSlug.md): AbilityTypeSlug = typeof AbilityTypeSlugs\keyof typeof [AbilityTypeSlugs\] - [Type Alias: AccessGrant](https://docs.gravityrail.com/sdk/type-aliases/AccessGrant.md): AccessGrant = Omit\ & object - [Type Alias: AccessGrantInterrupt](https://docs.gravityrail.com/sdk/type-aliases/AccessGrantInterrupt.md): AccessGrantInterrupt = AppConnectionAccessInterrupt \| DataAccessGrantInterrupt - [Type Alias: AccessGrantResponse](https://docs.gravityrail.com/sdk/type-aliases/AccessGrantResponse.md): AccessGrantResponse = AccessGrant - [Type Alias: AccountSortField](https://docs.gravityrail.com/sdk/type-aliases/AccountSortField.md): AccountSortField = "createdAt" \| "updatedAt" \| "name" \| "email" - [Type Alias: AdminWorkspaceSortField](https://docs.gravityrail.com/sdk/type-aliases/AdminWorkspaceSortField.md): AdminWorkspaceSortField = "name" \| "slug" \| "createdAt" - [Type Alias: AgentSortField](https://docs.gravityrail.com/sdk/type-aliases/AgentSortField.md): AgentSortField = "createdAt" \| "updatedAt" \| "name" - [Type Alias: AnonymousMemberResolutionStatus](https://docs.gravityrail.com/sdk/type-aliases/AnonymousMemberResolutionStatus.md): AnonymousMemberResolutionStatus = "pending" \| "resolved" \| "expired" - [Type Alias: App](https://docs.gravityrail.com/sdk/type-aliases/App.md): App = Omit\ & object - [Type Alias: AppConnectionItem](https://docs.gravityrail.com/sdk/type-aliases/AppConnectionItem.md): AppConnectionItem = PlatformAppConnectionResponse \| McpServerResponse \| DiscordBotResponse \| SlackAppResponse \| TeamsAppResponse \| FhirConnectionResponse \| SalesforceConnectionResponse \| HubspotConnectionResponse \| MondayConnectionResponse \| ConfluenceConnectionResponse \| HealthieConnectionResponse - [Type Alias: AppConnectionType](https://docs.gravityrail.com/sdk/type-aliases/AppConnectionType.md): AppConnectionType = "platformapp" \| "mcpserver" \| "discordbot" \| "slackapp" \| "teamsapp" \| "fhirconnection" \| "salesforceconnection" \| "hubspotconnection" \| "mondayconnection" \| "confluenceconnection" \| "healthie_connection" - [Type Alias: AppListResponse](https://docs.gravityrail.com/sdk/type-aliases/AppListResponse.md): AppListResponse = Omit\ & object - [Type Alias: AppResponse](https://docs.gravityrail.com/sdk/type-aliases/AppResponse.md): AppResponse = App - [Type Alias: AssignmentSortField](https://docs.gravityrail.com/sdk/type-aliases/AssignmentSortField.md): AssignmentSortField = "createdAt" \| "updatedAt" - [Type Alias: AssignmentStatusType](https://docs.gravityrail.com/sdk/type-aliases/AssignmentStatusType.md): AssignmentStatusType = "active" \| "completed" \| "canceled" - [Type Alias: BillingPlanInfo](https://docs.gravityrail.com/sdk/type-aliases/BillingPlanInfo.md): BillingPlanInfo = PlanInfo - [Type Alias: BotSortField](https://docs.gravityrail.com/sdk/type-aliases/BotSortField.md): BotSortField = "createdAt" \| "updatedAt" \| "name" - [Type Alias: BulkMemberResultStatus](https://docs.gravityrail.com/sdk/type-aliases/BulkMemberResultStatus.md): BulkMemberResultStatus = typeof BulkMemberResultStatus\keyof typeof [BulkMemberResultStatus\] - [Type Alias: BusinessIndustry](https://docs.gravityrail.com/sdk/type-aliases/BusinessIndustry.md): BusinessIndustry = typeof BusinessIndustry\keyof typeof [BusinessIndustry\] - [Type Alias: BusinessProfile](https://docs.gravityrail.com/sdk/type-aliases/BusinessProfile.md): BusinessProfile = Omit\ & object - [Type Alias: BusinessProfileEvaluationStatus](https://docs.gravityrail.com/sdk/type-aliases/BusinessProfileEvaluationStatus.md): BusinessProfileEvaluationStatus = "compliant" \| "noncompliant" - [Type Alias: BusinessProfileResponse](https://docs.gravityrail.com/sdk/type-aliases/BusinessProfileResponse.md): BusinessProfileResponse = BusinessProfile - [Type Alias: BusinessProfileStatus](https://docs.gravityrail.com/sdk/type-aliases/BusinessProfileStatus.md): BusinessProfileStatus = "draft" \| "pending-review" \| "in-review" \| "twilio-approved" \| "twilio-rejected" - [Type Alias: BusinessType](https://docs.gravityrail.com/sdk/type-aliases/BusinessType.md): BusinessType = typeof BusinessType\keyof typeof [BusinessType\] - [Type Alias: Calendar](https://docs.gravityrail.com/sdk/type-aliases/Calendar.md): Calendar = Omit\ & object - [Type Alias: CalendarEventSortField](https://docs.gravityrail.com/sdk/type-aliases/CalendarEventSortField.md): CalendarEventSortField = "startTime" \| "createdAt" - [Type Alias: CalendarResponse](https://docs.gravityrail.com/sdk/type-aliases/CalendarResponse.md): CalendarResponse = Calendar - [Type Alias: CalendarSchedule](https://docs.gravityrail.com/sdk/type-aliases/CalendarSchedule.md): CalendarSchedule = Omit\ & object - [Type Alias: CalendarScheduleResponse](https://docs.gravityrail.com/sdk/type-aliases/CalendarScheduleResponse.md): CalendarScheduleResponse = CalendarSchedule - [Type Alias: CallEndSection](https://docs.gravityrail.com/sdk/type-aliases/CallEndSection.md): CallEndSection = Omit\ & object - [Type Alias: CallEndStatusEntry](https://docs.gravityrail.com/sdk/type-aliases/CallEndStatusEntry.md): CallEndStatusEntry = Omit\ & object - [Type Alias: Channel](https://docs.gravityrail.com/sdk/type-aliases/Channel.md): Channel = "cli" \| "frame" \| "phone-sms" \| "phone-voice" \| "phone-whatsapp" \| "email" \| "background" \| "web-chat" \| "web-voice" \| "discord" \| "slack" \| "teams" \| "direct-message" \| "a2a" \| "routine" - [Type Alias: CharlestonPmdSimulationOutcome](https://docs.gravityrail.com/sdk/type-aliases/CharlestonPmdSimulationOutcome.md): CharlestonPmdSimulationOutcome = "read" \| "reply" \| "sendfailed" \| "noresponseescalate" \| "daytimefollowup_unread" - [Type Alias: ChatAIModel](https://docs.gravityrail.com/sdk/type-aliases/ChatAIModel.md): ChatAIModel = ChatModelResponse & object - [Type Alias: ChatFilterFilterType](https://docs.gravityrail.com/sdk/type-aliases/ChatFilterFilterType.md): ChatFilterFilterType = "any" \| "all" \| "none" \| "partial" \| "exact" \| "equals" \| "notEquals" \| "onlyMine" \| "active" \| "greaterThan" \| "lessThan" \| "greaterThanOrEqual" \| "lessThanOrEqual" \| "before" \| "after" \| "between" - [Type Alias: ChatFilterObjectType](https://docs.gravityrail.com/sdk/type-aliases/ChatFilterObjectType.md): ChatFilterObjectType = "title" \| "participant" \| "mode" \| "channel" \| "owner" \| "needsResponse" \| "paused" \| "label" \| "memberFilter" \| "messageCount" \| "workflow" \| "phoneNumber" \| "inbox" \| "site" \| "toolCall" \| "createdAt" \| "updatedAt" - [Type Alias: ChatModelConfig](https://docs.gravityrail.com/sdk/type-aliases/ChatModelConfig.md): ChatModelConfig = GeminiChatModelConfig \| ClaudeChatModelConfig \| OpenAIChatModelConfig \| XAIChatModelConfig - [Type Alias: ChatSortField](https://docs.gravityrail.com/sdk/type-aliases/ChatSortField.md): ChatSortField = "createdAt" \| "updatedAt" \| "title" \| "mostRecentMessage" - [Type Alias: ChatType](https://docs.gravityrail.com/sdk/type-aliases/ChatType.md): ChatType = typeof CHATTYPES\keyof typeof [CHATTYPES\] - [Type Alias: ConflictPolicyMode](https://docs.gravityrail.com/sdk/type-aliases/ConflictPolicyMode.md): ConflictPolicyMode = "localwins" \| "remotewins" \| "skip" - [Type Alias: ConnectionMultiplicity](https://docs.gravityrail.com/sdk/type-aliases/ConnectionMultiplicity.md): ConnectionMultiplicity = "singleton" \| "multiple" - [Type Alias: ContributorAbilityConfig](https://docs.gravityrail.com/sdk/type-aliases/ContributorAbilityConfig.md): ContributorAbilityConfig = EmptyAbilityConfig - [Type Alias: CreateInquiryRequest](https://docs.gravityrail.com/sdk/type-aliases/CreateInquiryRequest.md): CreateInquiryRequest = z.infer\ - [Type Alias: CredentialProvider](https://docs.gravityrail.com/sdk/type-aliases/CredentialProvider.md): CredentialProvider = "platformapp" \| "mcpserver" \| "discordbot" \| "slackapp" \| "teamsapp" \| "fhirconnection" \| "salesforce_connection" - [Type Alias: CredentialType](https://docs.gravityrail.com/sdk/type-aliases/CredentialType.md): CredentialType = "email" \| "phone" - [Type Alias: CustomTool](https://docs.gravityrail.com/sdk/type-aliases/CustomTool.md): CustomTool = Omit\ & object - [Type Alias: CustomToolkit](https://docs.gravityrail.com/sdk/type-aliases/CustomToolkit.md): CustomToolkit = Omit\ & object - [Type Alias: CustomToolkitResponse](https://docs.gravityrail.com/sdk/type-aliases/CustomToolkitResponse.md): CustomToolkitResponse = CustomToolkit - [Type Alias: CustomToolResponse](https://docs.gravityrail.com/sdk/type-aliases/CustomToolResponse.md): CustomToolResponse = CustomTool - [Type Alias: DataRecordRetirementResponseReason](https://docs.gravityrail.com/sdk/type-aliases/DataRecordRetirementResponseReason.md): DataRecordRetirementResponseReason = typeof DataRecordRetirementResponseReason\keyof typeof [DataRecordRetirementResponseReason\] - [Type Alias: DataTypeSortField](https://docs.gravityrail.com/sdk/type-aliases/DataTypeSortField.md): DataTypeSortField = "name" \| "createdAt" - [Type Alias: DiscordBot](https://docs.gravityrail.com/sdk/type-aliases/DiscordBot.md): DiscordBot = Omit\ & object - [Type Alias: DiscordBotResponse](https://docs.gravityrail.com/sdk/type-aliases/DiscordBotResponse.md): DiscordBotResponse = DiscordBot - [Type Alias: DiscordBotSortField](https://docs.gravityrail.com/sdk/type-aliases/DiscordBotSortField.md): DiscordBotSortField = "createdAt" \| "updatedAt" \| "name" - [Type Alias: DiscordRespondMode](https://docs.gravityrail.com/sdk/type-aliases/DiscordRespondMode.md): DiscordRespondMode = "mentions" \| "auto" \| "off" - [Type Alias: EmailDisableResponse](https://docs.gravityrail.com/sdk/type-aliases/EmailDisableResponse.md): EmailDisableResponse = \{ impact? true; \} \| \{ impact false; \} - [Type Alias: EmailDnsRecord](https://docs.gravityrail.com/sdk/type-aliases/EmailDnsRecord.md): EmailDnsRecord = Omit\ & object - [Type Alias: EmailDnsRecordType](https://docs.gravityrail.com/sdk/type-aliases/EmailDnsRecordType.md): EmailDnsRecordType = typeof EmailDnsRecordType\keyof typeof [EmailDnsRecordType\] - [Type Alias: EmailDomainConfig](https://docs.gravityrail.com/sdk/type-aliases/EmailDomainConfig.md): EmailDomainConfig = Omit\ & object - [Type Alias: EmailDomainConfigGetResponse](https://docs.gravityrail.com/sdk/type-aliases/EmailDomainConfigGetResponse.md): EmailDomainConfigGetResponse = Omit\ & object - [Type Alias: EmptyAbilityConfig](https://docs.gravityrail.com/sdk/type-aliases/EmptyAbilityConfig.md): EmptyAbilityConfig = Record\ - [Type Alias: EnhancedAuthHandler()](https://docs.gravityrail.com/sdk/type-aliases/EnhancedAuthHandler.md): EnhancedAuthHandler = () => Promise\ - [Type Alias: EventRule](https://docs.gravityrail.com/sdk/type-aliases/EventRule.md): EventRule = EventRuleResponse - [Type Alias: EventRuleResponse](https://docs.gravityrail.com/sdk/type-aliases/EventRuleResponse.md): EventRuleResponse = Omit\ & object - [Type Alias: EventRunSortField](https://docs.gravityrail.com/sdk/type-aliases/EventRunSortField.md): EventRunSortField = "createdAt" - [Type Alias: FeatureStatusValue](https://docs.gravityrail.com/sdk/type-aliases/FeatureStatusValue.md): FeatureStatusValue = "enabled" \| "hidden" \| "upgrade" \| "contact" - [Type Alias: FhirConnection](https://docs.gravityrail.com/sdk/type-aliases/FhirConnection.md): FhirConnection = Omit\ & object - [Type Alias: FhirConnectionResponse](https://docs.gravityrail.com/sdk/type-aliases/FhirConnectionResponse.md): FhirConnectionResponse = FhirConnection - [Type Alias: FhirConnectionSortField](https://docs.gravityrail.com/sdk/type-aliases/FhirConnectionSortField.md): FhirConnectionSortField = "createdAt" \| "updatedAt" \| "name" \| "vendor" \| "state" - [Type Alias: FhirCsvIdentifierKind](https://docs.gravityrail.com/sdk/type-aliases/FhirCsvIdentifierKind.md): FhirCsvIdentifierKind = "encryptedpatientid" \| "human_identifier" - [Type Alias: FhirCsvImportRowStatus](https://docs.gravityrail.com/sdk/type-aliases/FhirCsvImportRowStatus.md): FhirCsvImportRowStatus = "linked" \| "alreadylinked" \| "created" \| "skipped" \| "ambiguous" \| "conflict" \| "notfound" \| "failed" - [Type Alias: FhirCsvImportRunStatus](https://docs.gravityrail.com/sdk/type-aliases/FhirCsvImportRunStatus.md): FhirCsvImportRunStatus = "queued" \| "inprogress" \| "completed" \| "completedwith_errors" \| "failed" - [Type Alias: File](https://docs.gravityrail.com/sdk/type-aliases/File.md): File = GeneratedFileResponse & object - [Type Alias: FileResponse](https://docs.gravityrail.com/sdk/type-aliases/FileResponse.md): FileResponse = File - [Type Alias: FileSharingResponse](https://docs.gravityrail.com/sdk/type-aliases/FileSharingResponse.md): FileSharingResponse = Omit\ & object - [Type Alias: FileSortField](https://docs.gravityrail.com/sdk/type-aliases/FileSortField.md): FileSortField = "createdAt" \| "updatedAt" \| "name" - [Type Alias: FileWithAccessMode](https://docs.gravityrail.com/sdk/type-aliases/FileWithAccessMode.md): FileWithAccessMode = FileResponse & object - [Type Alias: FirstRunMode](https://docs.gravityrail.com/sdk/type-aliases/FirstRunMode.md): FirstRunMode = "unset" \| "concierge" \| "explorer" \| "expert" - [Type Alias: FolderSharingResponse](https://docs.gravityrail.com/sdk/type-aliases/FolderSharingResponse.md): FolderSharingResponse = Omit\ & object - [Type Alias: GeminiThinkingLevel](https://docs.gravityrail.com/sdk/type-aliases/GeminiThinkingLevel.md): GeminiThinkingLevel = "minimal" \| "low" \| "medium" \| "high" - [Type Alias: GmailAbilityConfig](https://docs.gravityrail.com/sdk/type-aliases/GmailAbilityConfig.md): GmailAbilityConfig = GoogleWorkspaceIntegrationAbilityConfig - [Type Alias: GoogleCalendarAbilityConfig](https://docs.gravityrail.com/sdk/type-aliases/GoogleCalendarAbilityConfig.md): GoogleCalendarAbilityConfig = GoogleWorkspaceIntegrationAbilityConfig - [Type Alias: GoogleDriveAbilityConfig](https://docs.gravityrail.com/sdk/type-aliases/GoogleDriveAbilityConfig.md): GoogleDriveAbilityConfig = GoogleWorkspaceIntegrationAbilityConfig - [Type Alias: GoogleWorkspaceAccessMode](https://docs.gravityrail.com/sdk/type-aliases/GoogleWorkspaceAccessMode.md): GoogleWorkspaceAccessMode = "readonly" \| "readwrite" - [Type Alias: GravityRailWorkspaceClient](https://docs.gravityrail.com/sdk/type-aliases/GravityRailWorkspaceClient.md): GravityRailWorkspaceClient = object & { [K in WorkspaceMethodKey]: WorkspaceBoundMethod } - [Type Alias: HubSpotTaskPriority](https://docs.gravityrail.com/sdk/type-aliases/HubSpotTaskPriority.md): HubSpotTaskPriority = "NONE" \| "LOW" \| "MEDIUM" \| "HIGH" - [Type Alias: HubSpotTaskStatus](https://docs.gravityrail.com/sdk/type-aliases/HubSpotTaskStatus.md): HubSpotTaskStatus = "NOTSTARTED" \| "INPROGRESS" \| "COMPLETED" - [Type Alias: IdentityConflictPolicy](https://docs.gravityrail.com/sdk/type-aliases/IdentityConflictPolicy.md): IdentityConflictPolicy = "skip" \| "overwriteidentityfields" - [Type Alias: Inbox](https://docs.gravityrail.com/sdk/type-aliases/Inbox.md): Inbox = Omit\ & object - [Type Alias: InquiryStatus](https://docs.gravityrail.com/sdk/type-aliases/InquiryStatus.md): InquiryStatus = "new" \| "in_progress" \| "done" - [Type Alias: InquiryType](https://docs.gravityrail.com/sdk/type-aliases/InquiryType.md): InquiryType = "customer" \| "builder" \| "partner" \| "other" \| "demo_request" \| "waitlist" - [Type Alias: InterruptionSound](https://docs.gravityrail.com/sdk/type-aliases/InterruptionSound.md): InterruptionSound = "none" \| "clav" \| "bells" \| "organ" \| "guzheng" - [Type Alias: Invitation](https://docs.gravityrail.com/sdk/type-aliases/Invitation.md): Invitation = InvitationResponse - [Type Alias: InvitationListResponse](https://docs.gravityrail.com/sdk/type-aliases/InvitationListResponse.md): InvitationListResponse = Omit\ & object - [Type Alias: InvitationResponse](https://docs.gravityrail.com/sdk/type-aliases/InvitationResponse.md): InvitationResponse = Omit\ & object - [Type Alias: JobPosition](https://docs.gravityrail.com/sdk/type-aliases/JobPosition.md): JobPosition = typeof JobPosition\keyof typeof [JobPosition\] - [Type Alias: JourneySortField](https://docs.gravityrail.com/sdk/type-aliases/JourneySortField.md): JourneySortField = "name" \| "createdAt" - [Type Alias: ManagedAutomationPriority](https://docs.gravityrail.com/sdk/type-aliases/ManagedAutomationPriority.md): ManagedAutomationPriority = "NONE" \| "LOW" \| "MEDIUM" \| "HIGH" - [Type Alias: ManagedAutomationStatus](https://docs.gravityrail.com/sdk/type-aliases/ManagedAutomationStatus.md): ManagedAutomationStatus = "NOTSTARTED" \| "INPROGRESS" \| "COMPLETED" \| "DEFERRED" - [Type Alias: MatchStrategyMode](https://docs.gravityrail.com/sdk/type-aliases/MatchStrategyMode.md): MatchStrategyMode = "linkedid" \| "email" \| "externalid" \| "phone" \| "custom" - [Type Alias: McpServerSortField](https://docs.gravityrail.com/sdk/type-aliases/McpServerSortField.md): McpServerSortField = "name" \| "createdAt" \| "state" - [Type Alias: MemberFilterFilterType](https://docs.gravityrail.com/sdk/type-aliases/MemberFilterFilterType.md): MemberFilterFilterType = "any" \| "all" \| "none" \| "partial" \| "notPartial" \| "exact" \| "equals" \| "notEquals" \| "notContains" \| "atLeast" \| "atMost" \| "field" \| "dateFilter" \| "greaterThan" \| "greaterThanOrEqual" \| "lessThan" \| "lessThanOrEqual" \| "within" \| "olderThan" \| "never" \| "isEmpty" \| "notEmpty" \| "before" \| "after" \| "between" \| "daysAgo" \| "lessThanDaysAgo" \| "daysUntil" \| "hasKey" \| "hasKeyValue" \| "smsDeliveryStatusNeedsAttention" \| "callForwardedAny" \| "inGroup" - [Type Alias: MemberFilterObjectType](https://docs.gravityrail.com/sdk/type-aliases/MemberFilterObjectType.md): MemberFilterObjectType = "label" \| "dataType" \| "member" \| "memberRole" \| "name" \| "email" \| "phone" \| "phoneType" \| "age" \| "dateOfBirth" \| "workflow" \| "tosAccepted" \| "notifySms" \| "notifyEmail" \| "notifyVoice" \| "smsDeliveryStatus" \| "callForwarded" \| "calendarEvent" \| "chatEngagement" \| "lastMessageActivity" \| "memberCreated" \| "isDefault" \| "memberType" \| "memberField" \| "journey" \| "experiment" - [Type Alias: MemberFilterWithQuery](https://docs.gravityrail.com/sdk/type-aliases/MemberFilterWithQuery.md): MemberFilterWithQuery = MemberFilterResponse & object - [Type Alias: MemberImportMatchInfoMatchType](https://docs.gravityrail.com/sdk/type-aliases/MemberImportMatchInfoMatchType.md): MemberImportMatchInfoMatchType = typeof MemberImportMatchInfoMatchType\keyof typeof [MemberImportMatchInfoMatchType\] - [Type Alias: MemberImportPreviewRowAction](https://docs.gravityrail.com/sdk/type-aliases/MemberImportPreviewRowAction.md): MemberImportPreviewRowAction = typeof MemberImportPreviewRowAction\keyof typeof [MemberImportPreviewRowAction\] - [Type Alias: MemberMemoriesResponse](https://docs.gravityrail.com/sdk/type-aliases/MemberMemoriesResponse.md): MemberMemoriesResponse = Omit\ & object - [Type Alias: MemberSortField](https://docs.gravityrail.com/sdk/type-aliases/MemberSortField.md): MemberSortField = "createdAt" \| "updatedAt" \| "name" \| "email" - [Type Alias: MemberUpsertBehavior](https://docs.gravityrail.com/sdk/type-aliases/MemberUpsertBehavior.md): MemberUpsertBehavior = "upsert" \| "createonly" \| "updateonly" - [Type Alias: MemoryItem](https://docs.gravityrail.com/sdk/type-aliases/MemoryItem.md): MemoryItem = GeneratedMemoryResponse - [Type Alias: MemoryResponse](https://docs.gravityrail.com/sdk/type-aliases/MemoryResponse.md): MemoryResponse = MemoryItem - [Type Alias: MemoryType](https://docs.gravityrail.com/sdk/type-aliases/MemoryType.md): MemoryType = "basic" \| "preferences" \| "semantic" \| "summaries" \| "episodic" - [Type Alias: MenuItemResponseItemType](https://docs.gravityrail.com/sdk/type-aliases/MenuItemResponseItemType.md): MenuItemResponseItemType = typeof MenuItemResponseItemType\keyof typeof [MenuItemResponseItemType\] - [Type Alias: MessageContentPart](https://docs.gravityrail.com/sdk/type-aliases/MessageContentPart.md): MessageContentPart = TextContent \| ImageUrlContent - [Type Alias: MessageRole](https://docs.gravityrail.com/sdk/type-aliases/MessageRole.md): MessageRole = "user" \| "assistant" \| "system" \| "tool" \| "function" \| "operator" \| "error" - [Type Alias: MetricSection](https://docs.gravityrail.com/sdk/type-aliases/MetricSection.md): MetricSection = Omit\ & object - [Type Alias: MetricSummary](https://docs.gravityrail.com/sdk/type-aliases/MetricSummary.md): MetricSummary = Required\\> & Omit\ - [Type Alias: MilestoneFormData](https://docs.gravityrail.com/sdk/type-aliases/MilestoneFormData.md): MilestoneFormData = z.infer\ - [Type Alias: MilestoneGoal](https://docs.gravityrail.com/sdk/type-aliases/MilestoneGoal.md): MilestoneGoal = Omit\ & object - [Type Alias: MilestoneGoalFormData](https://docs.gravityrail.com/sdk/type-aliases/MilestoneGoalFormData.md): MilestoneGoalFormData = z.infer\ - [Type Alias: MilestoneGoalResponse](https://docs.gravityrail.com/sdk/type-aliases/MilestoneGoalResponse.md): MilestoneGoalResponse = MilestoneGoal - [Type Alias: MilestoneSortField](https://docs.gravityrail.com/sdk/type-aliases/MilestoneSortField.md): MilestoneSortField = "name" \| "createdAt" \| "updatedAt" \| "targetDate" - [Type Alias: ModelProvider](https://docs.gravityrail.com/sdk/type-aliases/ModelProvider.md): ModelProvider = typeof ModelProvider\keyof typeof [ModelProvider\] - [Type Alias: ModelState](https://docs.gravityrail.com/sdk/type-aliases/ModelState.md): ModelState = "enabled" \| "disabled" \| "deprecated" - [Type Alias: ModelType](https://docs.gravityrail.com/sdk/type-aliases/ModelType.md): ModelType = typeof ModelType\keyof typeof [ModelType\] - [Type Alias: MondayLookupType](https://docs.gravityrail.com/sdk/type-aliases/MondayLookupType.md): MondayLookupType = "columnvalue" \| "itemid" - [Type Alias: MondayUpsertMode](https://docs.gravityrail.com/sdk/type-aliases/MondayUpsertMode.md): MondayUpsertMode = "createonly" \| "updateonly" \| "upsert" - [Type Alias: MultiMatchBehavior](https://docs.gravityrail.com/sdk/type-aliases/MultiMatchBehavior.md): MultiMatchBehavior = "fail" \| "updatefirst" \| "updateall" - [Type Alias: OAuthProviderSlug](https://docs.gravityrail.com/sdk/type-aliases/OAuthProviderSlug.md): OAuthProviderSlug = "google_calendar" \| "gmail" \| "google" \| "gdrive" - [Type Alias: ObjectPermission](https://docs.gravityrail.com/sdk/type-aliases/ObjectPermission.md): ObjectPermission = "use" \| "edit" \| "create" \| "list" \| "verify" \| "geolocate" \| "listAll" \| "delete" - [Type Alias: OIDCAdminConfigViewProviderType](https://docs.gravityrail.com/sdk/type-aliases/OIDCAdminConfigViewProviderType.md): OIDCAdminConfigViewProviderType = typeof OIDCAdminConfigViewProviderType\keyof typeof [OIDCAdminConfigViewProviderType\] - [Type Alias: OpenAIReasoningEffort](https://docs.gravityrail.com/sdk/type-aliases/OpenAIReasoningEffort.md): OpenAIReasoningEffort = "none" \| "minimal" \| "low" \| "medium" \| "high" \| "xhigh" - [Type Alias: OpenAISemanticVADEagerness](https://docs.gravityrail.com/sdk/type-aliases/OpenAISemanticVADEagerness.md): OpenAISemanticVADEagerness = "low" \| "medium" \| "high" \| "auto" - [Type Alias: OpenAITurnDetection](https://docs.gravityrail.com/sdk/type-aliases/OpenAITurnDetection.md): OpenAITurnDetection = OpenAISemanticVADTurnDetection \| OpenAIServerVADTurnDetection - [Type Alias: OpenAITurnDetectionType](https://docs.gravityrail.com/sdk/type-aliases/OpenAITurnDetectionType.md): OpenAITurnDetectionType = "semanticvad" \| "servervad" - [Type Alias: OperatorGroup](https://docs.gravityrail.com/sdk/type-aliases/OperatorGroup.md): OperatorGroup = Omit\ & object - [Type Alias: OperatorGroupResponse](https://docs.gravityrail.com/sdk/type-aliases/OperatorGroupResponse.md): OperatorGroupResponse = OperatorGroup - [Type Alias: OperatorLiveStatus](https://docs.gravityrail.com/sdk/type-aliases/OperatorLiveStatus.md): OperatorLiveStatus = "live" \| "offline" - [Type Alias: OrgAuthHandler()](https://docs.gravityrail.com/sdk/type-aliases/OrgAuthHandler.md): OrgAuthHandler = (info) => Promise\ - [Type Alias: OrgDomain](https://docs.gravityrail.com/sdk/type-aliases/OrgDomain.md): OrgDomain = Omit\ & object - [Type Alias: OrgDomainCapabilityStatus](https://docs.gravityrail.com/sdk/type-aliases/OrgDomainCapabilityStatus.md): OrgDomainCapabilityStatus = "unconfigured" \| "pending" \| "verified" \| "failed" - [Type Alias: OrgDomainDnsRecordStatus](https://docs.gravityrail.com/sdk/type-aliases/OrgDomainDnsRecordStatus.md): OrgDomainDnsRecordStatus = "pending" \| "verified" \| "failed" - [Type Alias: OrgDomainListResponse](https://docs.gravityrail.com/sdk/type-aliases/OrgDomainListResponse.md): OrgDomainListResponse = Omit\ & object - [Type Alias: OrgDomainOwnershipStatus](https://docs.gravityrail.com/sdk/type-aliases/OrgDomainOwnershipStatus.md): OrgDomainOwnershipStatus = "pending" \| "verified" \| "failed" - [Type Alias: OrgDomainResponse](https://docs.gravityrail.com/sdk/type-aliases/OrgDomainResponse.md): OrgDomainResponse = OrgDomain - [Type Alias: OrgMemberRole](https://docs.gravityrail.com/sdk/type-aliases/OrgMemberRole.md): OrgMemberRole = "member" \| "admin" \| "owner" \| "platform_support" - [Type Alias: OwnershipDnsRecord](https://docs.gravityrail.com/sdk/type-aliases/OwnershipDnsRecord.md): OwnershipDnsRecord = Omit\ & object - [Type Alias: PageSortField](https://docs.gravityrail.com/sdk/type-aliases/PageSortField.md): PageSortField = "createdAt" \| "updatedAt" \| "title" - [Type Alias: Persona](https://docs.gravityrail.com/sdk/type-aliases/Persona.md): Persona = Omit\ & object - [Type Alias: PersonaResponse](https://docs.gravityrail.com/sdk/type-aliases/PersonaResponse.md): PersonaResponse = Persona - [Type Alias: PidsDisposition](https://docs.gravityrail.com/sdk/type-aliases/PidsDisposition.md): PidsDisposition = typeof PIDSDISPOSITIONS\[number\] - [Type Alias: PidsSource](https://docs.gravityrail.com/sdk/type-aliases/PidsSource.md): PidsSource = typeof PIDSSOURCES\[number\] - [Type Alias: PresenceClientMessage](https://docs.gravityrail.com/sdk/type-aliases/PresenceClientMessage.md): PresenceClientMessage = PresenceLoginMessage \| PresenceGoLiveMessage \| PresenceGoOfflineMessage \| PresenceHeartbeatMessage \| PresenceAcceptInteractionMessage \| PresenceRejectInteractionMessage \| PresenceTakenOverAckMessage \| PresenceEndInteractionMessage - [Type Alias: PresenceServerMessage](https://docs.gravityrail.com/sdk/type-aliases/PresenceServerMessage.md): PresenceServerMessage = PresenceLoginAck \| IncomingInteraction \| InteractionAccepted \| InteractionTimedOut \| PresenceConfirmation \| PresenceError \| SessionTakeover \| ChatActivityEvent - [Type Alias: Product](https://docs.gravityrail.com/sdk/type-aliases/Product.md): Product = Omit\ & object - [Type Alias: ProductFeatureKey](https://docs.gravityrail.com/sdk/type-aliases/ProductFeatureKey.md): ProductFeatureKey = WorkspaceFeature \| MemberFeature \| OrgFeature - [Type Alias: ProductLimits](https://docs.gravityrail.com/sdk/type-aliases/ProductLimits.md): ProductLimits = \{ \[key in Resource\]?: number \| null \} - [Type Alias: ProductPlans](https://docs.gravityrail.com/sdk/type-aliases/ProductPlans.md): ProductPlans = Partial\\> - [Type Alias: QualificationSortField](https://docs.gravityrail.com/sdk/type-aliases/QualificationSortField.md): QualificationSortField = "name" \| "createdAt" - [Type Alias: QueryAggregateOp](https://docs.gravityrail.com/sdk/type-aliases/QueryAggregateOp.md): QueryAggregateOp = "eq" \| "neq" \| "gt" \| "gte" \| "lt" \| "lte" - [Type Alias: QueryComparisonOp](https://docs.gravityrail.com/sdk/type-aliases/QueryComparisonOp.md): QueryComparisonOp = "eq" \| "neq" \| "contains" \| "notContains" \| "startsWith" \| "in" \| "notIn" \| "gt" \| "gte" \| "lt" \| "lte" \| "between" \| "notBetween" \| "isEmpty" \| "notEmpty" \| "exists" \| "onDay" \| "notOnDay" - [Type Alias: QueryEntityType](https://docs.gravityrail.com/sdk/type-aliases/QueryEntityType.md): QueryEntityType = "member" \| "chat" \| "data_record" - [Type Alias: QueryPredicate](https://docs.gravityrail.com/sdk/type-aliases/QueryPredicate.md): QueryPredicate = QueryAnd \| QueryOr \| QueryNot \| QueryCompare \| QueryRecordMatch \| QueryRelationMatch \| QueryAggregatePredicate \| QuerySubQueryRef \| QuerySavedFilterRef - [Type Alias: QueryRangeBound](https://docs.gravityrail.com/sdk/type-aliases/QueryRangeBound.md): QueryRangeBound = QueryScalar \| QueryTemporalValue - [Type Alias: QueryRunMode](https://docs.gravityrail.com/sdk/type-aliases/QueryRunMode.md): QueryRunMode = "rows" \| "count" \| "aggregate" - [Type Alias: QueryScalar](https://docs.gravityrail.com/sdk/type-aliases/QueryScalar.md): QueryScalar = boolean \| number \| string - [Type Alias: QueryTemporalValue](https://docs.gravityrail.com/sdk/type-aliases/QueryTemporalValue.md): QueryTemporalValue = QueryNowValue \| QueryDaysAgoValue \| QueryDaysFromNowValue \| QueryDayBoundaryValue - [Type Alias: QueryValue](https://docs.gravityrail.com/sdk/type-aliases/QueryValue.md): QueryValue = QueryScalar \| QueryTemporalValue \| QueryRangeValue \| QueryScalar[] - [Type Alias: RealtimeAIModel](https://docs.gravityrail.com/sdk/type-aliases/RealtimeAIModel.md): RealtimeAIModel = Omit\ & object - [Type Alias: RealtimeModelConfig](https://docs.gravityrail.com/sdk/type-aliases/RealtimeModelConfig.md): RealtimeModelConfig = OpenAIRealtimeModelConfig \| GeminiRealtimeModelConfig \| CustomRealtimeModelConfig \| AWSRealtimeModelConfig \| XAIRealtimeModelConfig - [Type Alias: Region](https://docs.gravityrail.com/sdk/type-aliases/Region.md): Region = typeof Region\keyof typeof [Region\] - [Type Alias: RegistrationIdentifier](https://docs.gravityrail.com/sdk/type-aliases/RegistrationIdentifier.md): RegistrationIdentifier = typeof RegistrationIdentifier\keyof typeof [RegistrationIdentifier\] - [Type Alias: RequestsSection](https://docs.gravityrail.com/sdk/type-aliases/RequestsSection.md): RequestsSection = Omit\ & object - [Type Alias: RequestsStatusEntry](https://docs.gravityrail.com/sdk/type-aliases/RequestsStatusEntry.md): RequestsStatusEntry = Omit\ & object - [Type Alias: ResellerAbilityConfig](https://docs.gravityrail.com/sdk/type-aliases/ResellerAbilityConfig.md): ResellerAbilityConfig = EmptyAbilityConfig - [Type Alias: ResourceScope](https://docs.gravityrail.com/sdk/type-aliases/ResourceScope.md): ResourceScope = "workspace" \| "org" \| "any" - [Type Alias: Routine](https://docs.gravityrail.com/sdk/type-aliases/Routine.md): Routine = RoutineResponse - [Type Alias: RoutineRunStatus](https://docs.gravityrail.com/sdk/type-aliases/RoutineRunStatus.md): RoutineRunStatus = "PENDING" \| "IN_PROGRESS" \| "COMPLETED" \| "FAILED" \| "CANCELLED" \| "SKIPPED" - [Type Alias: RoutineScheduleMode](https://docs.gravityrail.com/sdk/type-aliases/RoutineScheduleMode.md): RoutineScheduleMode = "ONCE" \| "CRON" \| "INTERVAL" - [Type Alias: RoutineSortField](https://docs.gravityrail.com/sdk/type-aliases/RoutineSortField.md): RoutineSortField = "createdAt" \| "updatedAt" \| "name" \| "scheduledTime" - [Type Alias: RoutineVisibility](https://docs.gravityrail.com/sdk/type-aliases/RoutineVisibility.md): RoutineVisibility = "private" \| "workspace" - [Type Alias: RoutingStrategy](https://docs.gravityrail.com/sdk/type-aliases/RoutingStrategy.md): RoutingStrategy = "broadcast" \| "round_robin" - [Type Alias: RuleExecutionSortField](https://docs.gravityrail.com/sdk/type-aliases/RuleExecutionSortField.md): RuleExecutionSortField = "createdAt" \| "completedAt" \| "durationMs" \| "status" - [Type Alias: RuleExecutionStatus](https://docs.gravityrail.com/sdk/type-aliases/RuleExecutionStatus.md): RuleExecutionStatus = "running" \| "success" \| "failed" \| "skipped" - [Type Alias: SalesforceLabelSyncMode](https://docs.gravityrail.com/sdk/type-aliases/SalesforceLabelSyncMode.md): SalesforceLabelSyncMode = "multi_select" \| "text" - [Type Alias: SalesforceSearchObjectType](https://docs.gravityrail.com/sdk/type-aliases/SalesforceSearchObjectType.md): SalesforceSearchObjectType = "Contact" \| "Account" \| "Lead" - [Type Alias: SalesforceSyncConfig](https://docs.gravityrail.com/sdk/type-aliases/SalesforceSyncConfig.md): SalesforceSyncConfig = ConnectionSyncConfig - [Type Alias: Scenario](https://docs.gravityrail.com/sdk/type-aliases/Scenario.md): Scenario = Omit\ & object - [Type Alias: ScenarioCriterion](https://docs.gravityrail.com/sdk/type-aliases/ScenarioCriterion.md): ScenarioCriterion = Omit\ & object - [Type Alias: ScenarioCriterionResponse](https://docs.gravityrail.com/sdk/type-aliases/ScenarioCriterionResponse.md): ScenarioCriterionResponse = ScenarioCriterion - [Type Alias: ScenarioResponse](https://docs.gravityrail.com/sdk/type-aliases/ScenarioResponse.md): ScenarioResponse = Scenario - [Type Alias: ScopeName](https://docs.gravityrail.com/sdk/type-aliases/ScopeName.md): ScopeName = keyof typeof SCOPES - [Type Alias: SendWhatsAppAbilityConfig](https://docs.gravityrail.com/sdk/type-aliases/SendWhatsAppAbilityConfig.md): SendWhatsAppAbilityConfig = EmptyAbilityConfig - [Type Alias: Site](https://docs.gravityrail.com/sdk/type-aliases/Site.md): Site = Omit\ & object - [Type Alias: SiteDisableResponse](https://docs.gravityrail.com/sdk/type-aliases/SiteDisableResponse.md): SiteDisableResponse = \{ impact? true; \} \| \{ impact false; \} - [Type Alias: SiteDnsRecord](https://docs.gravityrail.com/sdk/type-aliases/SiteDnsRecord.md): SiteDnsRecord = Omit\ & object - [Type Alias: SiteDnsRecordType](https://docs.gravityrail.com/sdk/type-aliases/SiteDnsRecordType.md): SiteDnsRecordType = typeof SiteDnsRecordType\keyof typeof [SiteDnsRecordType\] - [Type Alias: SiteDomainConfig](https://docs.gravityrail.com/sdk/type-aliases/SiteDomainConfig.md): SiteDomainConfig = Omit\ & object - [Type Alias: SiteDomainConfigGetResponse](https://docs.gravityrail.com/sdk/type-aliases/SiteDomainConfigGetResponse.md): SiteDomainConfigGetResponse = Omit\ & object - [Type Alias: SiteMapping](https://docs.gravityrail.com/sdk/type-aliases/SiteMapping.md): SiteMapping = Omit\ & object - [Type Alias: SiteResponse](https://docs.gravityrail.com/sdk/type-aliases/SiteResponse.md): SiteResponse = Site - [Type Alias: SiteSortField](https://docs.gravityrail.com/sdk/type-aliases/SiteSortField.md): SiteSortField = "createdAt" \| "updatedAt" \| "name" - [Type Alias: SlackApp](https://docs.gravityrail.com/sdk/type-aliases/SlackApp.md): SlackApp = Omit\ & object - [Type Alias: SlackAppResponse](https://docs.gravityrail.com/sdk/type-aliases/SlackAppResponse.md): SlackAppResponse = SlackApp - [Type Alias: SlackAppSortField](https://docs.gravityrail.com/sdk/type-aliases/SlackAppSortField.md): SlackAppSortField = "createdAt" \| "updatedAt" \| "name" - [Type Alias: SlackRespondMode](https://docs.gravityrail.com/sdk/type-aliases/SlackRespondMode.md): SlackRespondMode = "mentions" \| "auto" \| "off" - [Type Alias: SMSDeliveryFailureStatus](https://docs.gravityrail.com/sdk/type-aliases/SMSDeliveryFailureStatus.md): SMSDeliveryFailureStatus = Extract\ - [Type Alias: SMSDeliveryStatus](https://docs.gravityrail.com/sdk/type-aliases/SMSDeliveryStatus.md): SMSDeliveryStatus = "queued" \| "sending" \| "sent" \| "delivered" \| "undelivered" \| "failed" - [Type Alias: SortOrder](https://docs.gravityrail.com/sdk/type-aliases/SortOrder.md): SortOrder = "asc" \| "desc" - [Type Alias: STTAIModel](https://docs.gravityrail.com/sdk/type-aliases/STTAIModel.md): STTAIModel = STTModelResponse & object - [Type Alias: Subscription](https://docs.gravityrail.com/sdk/type-aliases/Subscription.md): Subscription = GeneratedSubscriptionResponse - [Type Alias: SyncEntityType](https://docs.gravityrail.com/sdk/type-aliases/SyncEntityType.md): SyncEntityType = "member" \| "record" \| "calendar_event" \| "file" - [Type Alias: SyncRuleInboundTargetType](https://docs.gravityrail.com/sdk/type-aliases/SyncRuleInboundTargetType.md): SyncRuleInboundTargetType = "memberproperty" \| "managedfield" \| "label" \| "form_field" - [Type Alias: SyncRunMode](https://docs.gravityrail.com/sdk/type-aliases/SyncRunMode.md): SyncRunMode = "outbound" \| "inbound" \| "both" - [Type Alias: Task](https://docs.gravityrail.com/sdk/type-aliases/Task.md): Task = Omit\ & object - [Type Alias: TaskResponse](https://docs.gravityrail.com/sdk/type-aliases/TaskResponse.md): TaskResponse = Task - [Type Alias: TaskSortField](https://docs.gravityrail.com/sdk/type-aliases/TaskSortField.md): TaskSortField = "name" \| "createdAt" \| "workflowId" - [Type Alias: TeamsAppSortField](https://docs.gravityrail.com/sdk/type-aliases/TeamsAppSortField.md): TeamsAppSortField = "createdAt" \| "updatedAt" \| "name" - [Type Alias: TeamsConversation](https://docs.gravityrail.com/sdk/type-aliases/TeamsConversation.md): TeamsConversation = Omit\ & object - [Type Alias: TeamsConversationResponse](https://docs.gravityrail.com/sdk/type-aliases/TeamsConversationResponse.md): TeamsConversationResponse = TeamsConversation - [Type Alias: TeamsConversationType](https://docs.gravityrail.com/sdk/type-aliases/TeamsConversationType.md): TeamsConversationType = "personal" \| "groupChat" \| "channel" - [Type Alias: TeamsRespondMode](https://docs.gravityrail.com/sdk/type-aliases/TeamsRespondMode.md): TeamsRespondMode = "mentions" \| "auto" \| "off" - [Type Alias: ThemeFeaturesDarkMode](https://docs.gravityrail.com/sdk/type-aliases/ThemeFeaturesDarkMode.md): ThemeFeaturesDarkMode = object - [Type Alias: ThemeFeaturesDarkMode](https://docs.gravityrail.com/sdk/type-aliases/ThemeFeaturesDarkMode-1.md): ThemeFeaturesDarkMode = typeof ThemeFeaturesDarkMode\keyof typeof [ThemeFeaturesDarkMode\] - [Type Alias: ThemeName](https://docs.gravityrail.com/sdk/type-aliases/ThemeName.md): ThemeName = "default" \| "gravityrail-home" \| "gravityrail-home-2" \| "gravityrail-start" \| "gravityrail-pitch" \| "leapcure-home" \| "leapcure-home-no-chat" \| "leapcure-home-pre-launch" \| "dml-home" \| "rc360-demo" \| "patient-engagement-demo" \| "admin-clinical-trial" \| "customer-basic" \| "operator-product" \| "gravity-health" \| "gravity-health-enrollment" \| "gravity-developer" \| "gravityrail-launch" \| "gravity-rail-feb-2026" \| "cosan-enrollment" \| "gravity-health-enrollment" \| "source-site" - [Type Alias: ThemeSettingFieldType](https://docs.gravityrail.com/sdk/type-aliases/ThemeSettingFieldType.md): ThemeSettingFieldType = object - [Type Alias: ThemeSettingFieldType](https://docs.gravityrail.com/sdk/type-aliases/ThemeSettingFieldType-1.md): ThemeSettingFieldType = typeof ThemeSettingFieldType\keyof typeof [ThemeSettingFieldType\] - [Type Alias: ThinkingSound](https://docs.gravityrail.com/sdk/type-aliases/ThinkingSound.md): ThinkingSound = "none" \| "typing" \| "strumming" \| "speech" - [Type Alias: TodoStatus](https://docs.gravityrail.com/sdk/type-aliases/TodoStatus.md): TodoStatus = "pending" \| "in_progress" \| "completed" \| "blocked" - [Type Alias: ToolType](https://docs.gravityrail.com/sdk/type-aliases/ToolType.md): ToolType = "custom" \| "supervisor" - [Type Alias: TruncationReason](https://docs.gravityrail.com/sdk/type-aliases/TruncationReason.md): TruncationReason = "bargein" \| "clientinterrupt" \| "user_cancel" \| "error" - [Type Alias: TTSAIModel](https://docs.gravityrail.com/sdk/type-aliases/TTSAIModel.md): TTSAIModel = TTSModelResponse & object - [Type Alias: TTSModel](https://docs.gravityrail.com/sdk/type-aliases/TTSModel.md): TTSModel = "native" \| "elevenlabseleventurbov2" \| "elevenlabseleventurbov25" \| "elevenlabselevenmultilingualv2" \| "elevenlabselevenflashv25" \| "openaitts-1" \| "openaitts-1-hd" \| "openaigpt-4o-mini-tts" \| "awspolly-generative" \| "awspolly-neural" \| "googlechirp" - [Type Alias: TTSPreviewProvider](https://docs.gravityrail.com/sdk/type-aliases/TTSPreviewProvider.md): TTSPreviewProvider = typeof TTSPREVIEWPROVIDERS\[number\] - [Type Alias: TtsReconnectOutcomeEntry](https://docs.gravityrail.com/sdk/type-aliases/TtsReconnectOutcomeEntry.md): TtsReconnectOutcomeEntry = Omit\ & object - [Type Alias: TtsReconnectSection](https://docs.gravityrail.com/sdk/type-aliases/TtsReconnectSection.md): TtsReconnectSection = Omit\ & object - [Type Alias: TwoFactorMethod](https://docs.gravityrail.com/sdk/type-aliases/TwoFactorMethod.md): TwoFactorMethod = Omit\ & object - [Type Alias: TwoFactorStatus](https://docs.gravityrail.com/sdk/type-aliases/TwoFactorStatus.md): TwoFactorStatus = Omit\ & object - [Type Alias: UpdateInquiryRequest](https://docs.gravityrail.com/sdk/type-aliases/UpdateInquiryRequest.md): UpdateInquiryRequest = z.infer\ - [Type Alias: UploadFileData](https://docs.gravityrail.com/sdk/type-aliases/UploadFileData.md): UploadFileData = string \| Uint8Array \| ArrayBuffer \| ArrayBufferView \| Blob - [Type Alias: UsageDashboardResponse](https://docs.gravityrail.com/sdk/type-aliases/UsageDashboardResponse.md): UsageDashboardResponse = Omit\ & object - [Type Alias: VoiceMetricsResponse](https://docs.gravityrail.com/sdk/type-aliases/VoiceMetricsResponse.md): VoiceMetricsResponse = Omit\ & object - [Type Alias: VoiceModel](https://docs.gravityrail.com/sdk/type-aliases/VoiceModel.md): VoiceModel = Omit\ & object - [Type Alias: VoiceModelResponse](https://docs.gravityrail.com/sdk/type-aliases/VoiceModelResponse.md): VoiceModelResponse = VoiceModel - [Type Alias: VoiceModelsResponse](https://docs.gravityrail.com/sdk/type-aliases/VoiceModelsResponse.md): VoiceModelsResponse = Omit\ & object - [Type Alias: WebhookLogSortField](https://docs.gravityrail.com/sdk/type-aliases/WebhookLogSortField.md): WebhookLogSortField = "createdAt" - [Type Alias: Workflow](https://docs.gravityrail.com/sdk/type-aliases/Workflow.md): Workflow = Omit\ & object - [Type Alias: WorkflowAccessWarningResourceType](https://docs.gravityrail.com/sdk/type-aliases/WorkflowAccessWarningResourceType.md): WorkflowAccessWarningResourceType = typeof WorkflowAccessWarningResourceType\keyof typeof [WorkflowAccessWarningResourceType\] - [Type Alias: WorkflowResponse](https://docs.gravityrail.com/sdk/type-aliases/WorkflowResponse.md): WorkflowResponse = Workflow - [Type Alias: WorkflowSortField](https://docs.gravityrail.com/sdk/type-aliases/WorkflowSortField.md): WorkflowSortField = "name" \| "updatedAt" \| "createdAt" - [Type Alias: WorkspaceGrantReason](https://docs.gravityrail.com/sdk/type-aliases/WorkspaceGrantReason.md): WorkspaceGrantReason = "superuser" \| "orgowner" \| "orgadmin" - [Type Alias: WorkspaceHealthResponse](https://docs.gravityrail.com/sdk/type-aliases/WorkspaceHealthResponse.md): WorkspaceHealthResponse = Omit\ & object - [Type Alias: WorkspaceSortField](https://docs.gravityrail.com/sdk/type-aliases/WorkspaceSortField.md): WorkspaceSortField = "createdAt" \| "updatedAt" \| "name" - [Type Alias: XAIReasoningEffort](https://docs.gravityrail.com/sdk/type-aliases/XAIReasoningEffort.md): XAIReasoningEffort = "none" \| "low" \| "medium" \| "high" ### variables - [Variable: AbilityConfigIssueCode](https://docs.gravityrail.com/sdk/variables/AbilityConfigIssueCode.md): AbilityConfigIssueCode: object - [Variable: AbilityConfigIssueSeverity](https://docs.gravityrail.com/sdk/variables/AbilityConfigIssueSeverity.md): AbilityConfigIssueSeverity: object - [Variable: AbilityTypeSlugs](https://docs.gravityrail.com/sdk/variables/AbilityTypeSlugs.md): const AbilityTypeSlugs: object - [Variable: BUILTIN_ASSISTANT_CHAT_TYPES](https://docs.gravityrail.com/sdk/variables/BUILTIN_ASSISTANT_CHAT_TYPES.md): const BUILTIN\_ASSISTANT\_CHAT\_TYPES: Set\ - [Variable: BulkMemberResultStatus](https://docs.gravityrail.com/sdk/variables/BulkMemberResultStatus.md): BulkMemberResultStatus: object - [Variable: BusinessIndustry](https://docs.gravityrail.com/sdk/variables/BusinessIndustry.md): BusinessIndustry: object - [Variable: BusinessType](https://docs.gravityrail.com/sdk/variables/BusinessType.md): BusinessType: object - [Variable: CHAT_TYPES](https://docs.gravityrail.com/sdk/variables/CHAT_TYPES.md): const CHAT\_TYPES: object - [Variable: DataRecordRetirementResponseReason](https://docs.gravityrail.com/sdk/variables/DataRecordRetirementResponseReason.md): DataRecordRetirementResponseReason: object - [Variable: DEFAULT_CHAT_MODEL](https://docs.gravityrail.com/sdk/variables/DEFAULT_CHAT_MODEL.md): const DEFAULT\_CHAT\_MODELbedrockbedrock:claude-4-5-haiku' - [Variable: DEFAULT_CUSTOM_VOICE_MODEL](https://docs.gravityrail.com/sdk/variables/DEFAULT_CUSTOM_VOICE_MODEL.md): const DEFAULT\_CUSTOM\_VOICE\_MODELvoicevoice:river' - [Variable: DEFAULT_THINKING_SPEECH_PHRASES](https://docs.gravityrail.com/sdk/variables/DEFAULT_THINKING_SPEECH_PHRASES.md): const DEFAULT\_THINKING\_SPEECH\_PHRASES: readonly string[] - [Variable: DEFAULT_VOICE_INFERENCE_MODEL](https://docs.gravityrail.com/sdk/variables/DEFAULT_VOICE_INFERENCE_MODEL.md): const DEFAULT\_VOICE\_INFERENCE\_MODELvertexvertex:gemini-3-flash' - [Variable: EmailDnsRecordType](https://docs.gravityrail.com/sdk/variables/EmailDnsRecordType.md): EmailDnsRecordType: object - [Variable: JobPosition](https://docs.gravityrail.com/sdk/variables/JobPosition.md): JobPosition: object - [Variable: MASKED_SECRET_SENTINEL](https://docs.gravityrail.com/sdk/variables/MASKED_SECRET_SENTINEL.md): const MASKED\_SECRET\_SENTINEL: "SECRET_SET" = 'SECRET_SET' - [Variable: MemberImportMatchInfoMatchType](https://docs.gravityrail.com/sdk/variables/MemberImportMatchInfoMatchType.md): MemberImportMatchInfoMatchType: object - [Variable: MemberImportPreviewRowAction](https://docs.gravityrail.com/sdk/variables/MemberImportPreviewRowAction.md): MemberImportPreviewRowAction: object - [Variable: MenuItemResponseItemType](https://docs.gravityrail.com/sdk/variables/MenuItemResponseItemType.md): MenuItemResponseItemType: object - [Variable: ModelProvider](https://docs.gravityrail.com/sdk/variables/ModelProvider.md): ModelProvider: object - [Variable: ModelType](https://docs.gravityrail.com/sdk/variables/ModelType.md): ModelType: object - [Variable: NO_ASSISTANT_PARTICIPANT_CHAT_TYPES](https://docs.gravityrail.com/sdk/variables/NO_ASSISTANT_PARTICIPANT_CHAT_TYPES.md): const NO\_ASSISTANT\_PARTICIPANT\_CHAT\_TYPES: Set\ - [Variable: OIDCAdminConfigViewProviderType](https://docs.gravityrail.com/sdk/variables/OIDCAdminConfigViewProviderType.md): OIDCAdminConfigViewProviderType: object - [Variable: ORG_ONLY_RESOURCES](https://docs.gravityrail.com/sdk/variables/ORG_ONLY_RESOURCES.md): const ORG\_ONLY\_RESOURCES: Set\ - [Variable: PERMISSION_ADMIN](https://docs.gravityrail.com/sdk/variables/PERMISSION_ADMIN.md): const PERMISSION\_ADMIN: 16 = 16 - [Variable: PERMISSION_CREATE](https://docs.gravityrail.com/sdk/variables/PERMISSION_CREATE.md): const PERMISSION\_CREATE: 4 = 4 - [Variable: PERMISSION_DELETE](https://docs.gravityrail.com/sdk/variables/PERMISSION_DELETE.md): const PERMISSION\_DELETE: 512 = 512 - [Variable: PERMISSION_EDIT](https://docs.gravityrail.com/sdk/variables/PERMISSION_EDIT.md): const PERMISSION\_EDIT: 2 = 2 - [Variable: PERMISSION_GEOLOCATE](https://docs.gravityrail.com/sdk/variables/PERMISSION_GEOLOCATE.md): const PERMISSION\_GEOLOCATE: 128 = 128 - [Variable: PERMISSION_LIST](https://docs.gravityrail.com/sdk/variables/PERMISSION_LIST.md): const PERMISSION\_LIST: 8 = 8 - [Variable: PERMISSION_LIST_ALL](https://docs.gravityrail.com/sdk/variables/PERMISSION_LIST_ALL.md): const PERMISSION\_LIST\_ALL: 256 = 256 - [Variable: PERMISSION_NONE](https://docs.gravityrail.com/sdk/variables/PERMISSION_NONE.md): const PERMISSION\_NONE: 0 = 0 - [Variable: PERMISSION_USE](https://docs.gravityrail.com/sdk/variables/PERMISSION_USE.md): const PERMISSION\_USE: 1 = 1 - [Variable: PERMISSION_VERIFY](https://docs.gravityrail.com/sdk/variables/PERMISSION_VERIFY.md): const PERMISSION\_VERIFY: 32 = 32 - [Variable: PIDS_DISPOSITIONS](https://docs.gravityrail.com/sdk/variables/PIDS_DISPOSITIONS.md): const PIDS\_DISPOSITIONS: readonly \["truepositive", "falsepositive", "needsmorecontext"\] - [Variable: PIDS_SOURCES](https://docs.gravityrail.com/sdk/variables/PIDS_SOURCES.md): const PIDS\_SOURCES: readonly \["scheduled", "backfill", "pre_llm"\] - [Variable: QUERY_VALUELESS_OPS](https://docs.gravityrail.com/sdk/variables/QUERY_VALUELESS_OPS.md): const QUERY\_VALUELESS\_OPS: ReadonlySet\ - [Variable: REALTIME_MODEL_CUSTOM](https://docs.gravityrail.com/sdk/variables/REALTIME_MODEL_CUSTOM.md): const REALTIME\_MODEL\_CUSTOMrealtimerealtime:composable' - [Variable: REALTIME_MODEL_GEMINI](https://docs.gravityrail.com/sdk/variables/REALTIME_MODEL_GEMINI.md): const REALTIME\_MODEL\_GEMINIaistudioaistudio:gemini-3.1-flash-live' - [Variable: REALTIME_MODEL_GEMINI_VERTEX](https://docs.gravityrail.com/sdk/variables/REALTIME_MODEL_GEMINI_VERTEX.md): const REALTIME\_MODEL\_GEMINI\_VERTEXvertexvertex:gemini-3.1-flash-live' - [Variable: REALTIME_MODEL_NOVA_SONIC](https://docs.gravityrail.com/sdk/variables/REALTIME_MODEL_NOVA_SONIC.md): const REALTIME\_MODEL\_NOVA\_SONICbedrockbedrock:nova-sonic-1' - [Variable: REALTIME_MODEL_OPENAI](https://docs.gravityrail.com/sdk/variables/REALTIME_MODEL_OPENAI.md): const REALTIME\_MODEL\_OPENAIrealtimerealtime:gpt-realtime' - [Variable: REALTIME_MODEL_OPENAI_2](https://docs.gravityrail.com/sdk/variables/REALTIME_MODEL_OPENAI_2.md): const REALTIME\_MODEL\_OPENAI\_2realtimerealtime:gpt-realtime-2' - [Variable: REALTIME_MODEL_OPENAI_MINI](https://docs.gravityrail.com/sdk/variables/REALTIME_MODEL_OPENAI_MINI.md): const REALTIME\_MODEL\_OPENAI\_MINIrealtimerealtime:gpt-realtime-mini' - [Variable: Region](https://docs.gravityrail.com/sdk/variables/Region.md): Region: object - [Variable: RegistrationIdentifier](https://docs.gravityrail.com/sdk/variables/RegistrationIdentifier.md): RegistrationIdentifier: object - [Variable: SCOPE_PRESETS](https://docs.gravityrail.com/sdk/variables/SCOPE_PRESETS.md): const SCOPE\_PRESETS: object - [Variable: SCOPES](https://docs.gravityrail.com/sdk/variables/SCOPES.md): const SCOPES: object - [Variable: SiteDnsRecordType](https://docs.gravityrail.com/sdk/variables/SiteDnsRecordType.md): SiteDnsRecordType: object - [Variable: SMS_DELIVERY_FAILURE_STATUSES](https://docs.gravityrail.com/sdk/variables/SMS_DELIVERY_FAILURE_STATUSES.md): const SMS\_DELIVERY\_FAILURE\_STATUSES: ReadonlySet\ - [Variable: STT_MODEL_DEEPGRAM_FLUX](https://docs.gravityrail.com/sdk/variables/STT_MODEL_DEEPGRAM_FLUX.md): const STT\_MODEL\_DEEPGRAM\_FLUXsttstt:flux-general-en' - [Variable: STT_MODEL_DEEPGRAM_FLUX_MULTI](https://docs.gravityrail.com/sdk/variables/STT_MODEL_DEEPGRAM_FLUX_MULTI.md): const STT\_MODEL\_DEEPGRAM\_FLUX\_MULTIsttstt:flux-general-multi' - [Variable: STT_MODEL_ELEVENLABS_SCRIBE](https://docs.gravityrail.com/sdk/variables/STT_MODEL_ELEVENLABS_SCRIBE.md): const STT\_MODEL\_ELEVENLABS\_SCRIBEsttstt:scribev2realtime' - [Variable: TTS_MODEL_AWS_POLLY_GENERATIVE](https://docs.gravityrail.com/sdk/variables/TTS_MODEL_AWS_POLLY_GENERATIVE.md): const TTS\_MODEL\_AWS\_POLLY\_GENERATIVEttstts:polly-generative' - [Variable: TTS_MODEL_AWS_POLLY_NEURAL](https://docs.gravityrail.com/sdk/variables/TTS_MODEL_AWS_POLLY_NEURAL.md): const TTS\_MODEL\_AWS\_POLLY\_NEURALttstts:polly-neural' - [Variable: TTS_MODEL_DEEPGRAM_AURA_2](https://docs.gravityrail.com/sdk/variables/TTS_MODEL_DEEPGRAM_AURA_2.md): const TTS\_MODEL\_DEEPGRAM\_AURA\_2ttstts:aura-2' - [Variable: TTS_MODEL_ELEVENLABS_FLASH](https://docs.gravityrail.com/sdk/variables/TTS_MODEL_ELEVENLABS_FLASH.md): const TTS\_MODEL\_ELEVENLABS\_FLASHttstts:elevenflashv25' - [Variable: TTS_MODEL_ELEVENLABS_MULTILINGUAL](https://docs.gravityrail.com/sdk/variables/TTS_MODEL_ELEVENLABS_MULTILINGUAL.md): const TTS\_MODEL\_ELEVENLABS\_MULTILINGUALttstts:elevenmultilingualv2' - [Variable: TTS_MODEL_ELEVENLABS_TURBO](https://docs.gravityrail.com/sdk/variables/TTS_MODEL_ELEVENLABS_TURBO.md): const TTS\_MODEL\_ELEVENLABS\_TURBOttstts:eleventurbov25' - [Variable: TTS_PREVIEW_PROVIDERS](https://docs.gravityrail.com/sdk/variables/TTS_PREVIEW_PROVIDERS.md): const TTS\_PREVIEW\_PROVIDERS: readonly \["openai", "elevenlabs", "google", "aws", "deepgram", "xai"\] - [Variable: WorkflowAccessWarningResourceType](https://docs.gravityrail.com/sdk/variables/WorkflowAccessWarningResourceType.md): WorkflowAccessWarningResourceType: object ## features Explore Gravity Rail platform features. - [Features](https://docs.gravityrail.com/features.md): Explore Gravity Rail platform features. ### actions - [Event Rules](https://docs.gravityrail.com/features/actions/event-rules.md): Powerful automation rules that trigger actions when specific events occur, enabling complex workflows without code - [Routines](https://docs.gravityrail.com/features/actions/scheduled-events.md): Time-based automation that triggers workflows, sends messages, and takes actions on a schedule ### ai - [Agent Members](https://docs.gravityrail.com/features/ai/agents.md): AI-powered team members that handle conversations via DMs, SMS, and voice with full context and memory - [Async Sub-Agents](https://docs.gravityrail.com/features/ai/async-sub-agents.md): Your primary agent delegates slow work to a background sub-agent so the conversation never has to wait. ### automation - [Experiments (A/B Testing)](https://docs.gravityrail.com/features/automation/experiments.md): Compare control and variant experiences for members with weighted assignment, CEL branching, and journey goal reporting ### channels - [Email Inboxes](https://docs.gravityrail.com/features/channels/email.md): Receive, organize, and respond to emails with AI-powered automation and workflow integration - [Notifications](https://docs.gravityrail.com/features/channels/notifications.md): Multi-channel notification system for alerts, escalations, and member engagement with customizable delivery preferences - [Phone Numbers](https://docs.gravityrail.com/features/channels/phone.md): Connect with your members via voice calls and SMS messaging using dedicated phone numbers with intelligent routing and automation - [Sites](https://docs.gravityrail.com/features/channels/sites.md): Custom web portals and chat interfaces where members engage with your AI agents and access workspace resources - [SMS Messaging](https://docs.gravityrail.com/features/channels/sms.md): Send and receive SMS text messages with dedicated phone numbers and AI-powered conversations - [Voice Communication](https://docs.gravityrail.com/features/channels/voice.md): Real-time voice conversations with AI agents using phone calls and web-based voice chat ### chats Unified conversation management for all member interactions across text, voice, email, and web chat channels - [Chats & Conversations](https://docs.gravityrail.com/features/chats.md): Unified conversation management for all member interactions across text, voice, email, and web chat channels ### communication - [Direct Messages](https://docs.gravityrail.com/features/communication/direct-messages.md): Private 1:1 messaging between team members and AI agents within your workspace ### developer - [API Keys](https://docs.gravityrail.com/features/developer/api-keys.md): Secure programmatic access to your workspace through API keys for automation, integrations, and custom applications - [Integrations](https://docs.gravityrail.com/features/developer/integrations.md): Connect Gravity Rail with external services, EHR systems, and third-party applications - [Webhooks](https://docs.gravityrail.com/features/developer/webhooks.md): Automated HTTP notifications that send real-time data to external systems when events occur in your workspace ### integration - [Discord Bots](https://docs.gravityrail.com/features/integration/discord_bots.md): Connect your Gravity Rail workspace to Discord with AI-powered bots that respond to commands, @mentions, and direct messages. ### knowledge - [Calendars](https://docs.gravityrail.com/features/knowledge/calendars.md): Scheduling and availability management with Google Calendar sync, event types, and AI-powered booking - [Data Types](https://docs.gravityrail.com/features/knowledge/data-types.md): Custom structured data schemas that enable AI assistants to collect, store, and query information through natural conversation - [Files](https://docs.gravityrail.com/features/knowledge/files.md): Secure file storage and management for documents, images, and media that AI assistants can reference and share - [Labels](https://docs.gravityrail.com/features/knowledge/labels.md): Flexible tags for categorizing members, chats, and files to enable filtering, automation, and targeted engagement ### members People who interact with your workspace through conversations, workflows, and AI agents - [Members](https://docs.gravityrail.com/features/members.md): People who interact with your workspace through conversations, workflows, and AI agents ### workflows AI-powered conversational workflows that guide users through multi-step processes with intelligent task management and automation - [Workflows](https://docs.gravityrail.com/features/workflows.md): AI-powered conversational workflows that guide users through multi-step processes with intelligent task management and automation ## use-cases Real-world use cases and implementation patterns. - [Use Cases](https://docs.gravityrail.com/use-cases.md): Real-world use cases and implementation patterns. ### healthcare - [Patient Engagement](https://docs.gravityrail.com/use-cases/healthcare/patient_engagement.md): Need to complete patient onboarding? Re-engage patients who stopped responding? Collect key details with our Patient Engagement features. ## user-guide Getting started, tutorials, and how-to guides. - [User Guide](https://docs.gravityrail.com/user-guide.md): Getting started, tutorials, and how-to guides. ### abilities Give your AI agents capabilities like web search, calendar booking, and file access. - [Abilities](https://docs.gravityrail.com/user-guide/abilities.md): Give your AI agents capabilities like web search, calendar booking, and file access. - [Calendar Booking](https://docs.gravityrail.com/user-guide/abilities/calendar-booking.md): Give your AI access to book appointments on connected calendars. - [Custom Toolkits](https://docs.gravityrail.com/user-guide/abilities/custom-toolkits.md): Attach custom tools you've built to give your AI new capabilities. - [Data Access](https://docs.gravityrail.com/user-guide/abilities/data-access.md): Give your AI access to read or create form records. - [File Access](https://docs.gravityrail.com/user-guide/abilities/file-access.md): Let your AI read, write, and search files and folders. - [Phone Call Tools](https://docs.gravityrail.com/user-guide/abilities/phone-call-tools.md): Give AI control over voice calls with hang up and forward capabilities. - [Supervisor](https://docs.gravityrail.com/user-guide/abilities/supervisor.md): Route complex requests to a supervisor AI for review. - [Web Search](https://docs.gravityrail.com/user-guide/abilities/web-search.md): Let your AI search the internet for current information. ### access-grants Understand, approve, manage, and revoke time-bounded access grants to your data. - [Access Grants](https://docs.gravityrail.com/user-guide/access-grants.md): Understand, approve, manage, and revoke time-bounded access grants to your data. ### account-security Manage your account profile, login methods, and security settings. - [Account & Security](https://docs.gravityrail.com/user-guide/account-security.md): Manage your account profile, login methods, and security settings. ### analytics Track AI, SMS, phone, voice, and member-level usage across your workspace for billing, budgeting, and cost analysis. - [Analytics & Usage Reports](https://docs.gravityrail.com/user-guide/analytics.md): Track AI, SMS, phone, voice, and member-level usage across your workspace for billing, budgeting, and cost analysis. ### api-keys Create and manage secure API keys for integrations and automation. - [API Keys](https://docs.gravityrail.com/user-guide/api-keys.md): Create and manage secure API keys for integrations and automation. ### app-connections Connect external services like HubSpot, Salesforce, Monday.com, FHIR EHRs, Slack, Discord, and MCP servers to sync data and extend your workspace. - [App Connections](https://docs.gravityrail.com/user-guide/app-connections.md): Connect external services like HubSpot, Salesforce, Monday.com, FHIR EHRs, Slack, Discord, and MCP servers to sync data and extend your workspace. - [Confluence Sync](https://docs.gravityrail.com/user-guide/app-connections/confluence-sync.md): Connect an Atlassian Confluence Cloud site and sync selected spaces into workspace folders as Markdown files so agents can cite your knowledge base. - [HubSpot Sync](https://docs.gravityrail.com/user-guide/app-connections/hubspot-sync.md): Keep your Gravity Rail members and HubSpot contacts in sync with bidirectional field mapping, flexible transforms, and real-time progress tracking. - [Monday.com Setup](https://docs.gravityrail.com/user-guide/app-connections/monday-setup.md): Create a Monday.com app and connect it to your Gravity Rail workspace via OAuth. - [Monday.com Sync](https://docs.gravityrail.com/user-guide/app-connections/monday-sync.md): Configure board mappings, sync rules, and automations to keep Monday.com and Gravity Rail in sync. ### automation Build automated workflows, event-triggered actions, and scheduled tasks. - [Automation](https://docs.gravityrail.com/user-guide/automation.md): Build automated workflows, event-triggered actions, and scheduled tasks. - [Actions](https://docs.gravityrail.com/user-guide/automation/actions.md): Automate your workspace with event-triggered actions, notifications, and webhooks. - [CEL Expressions](https://docs.gravityrail.com/user-guide/automation/cel-expressions.md): Quick reference for writing conditions in workflows, event rules, and data validation. - [Experiments (A/B Testing)](https://docs.gravityrail.com/user-guide/automation/experiments.md): Run member-level A/B tests with weighted groups, CEL branching, and journey goal reporting. - [Creating a Phone Call Action on a Workflow Task](https://docs.gravityrail.com/user-guide/automation/phone-call-action.md): Initiate AI-powered phone calls to members as part of an automated workflow. - [Creating a Play Audio Action](https://docs.gravityrail.com/user-guide/automation/play-audio-action.md): Play a pre-recorded audio file on a phone call as part of an automated workflow. - [Routines](https://docs.gravityrail.com/user-guide/automation/routines.md): Run automated actions on schedules - daily reports, reminders, and recurring tasks. - [Creating a Send Email Action on a Workflow Task](https://docs.gravityrail.com/user-guide/automation/send-email-action.md): Send templated emails to members as part of an automated workflow. - [Creating a Member Notify Action on a Workflow Task](https://docs.gravityrail.com/user-guide/automation/send-notification-action.md): Notify team members automatically when workflow tasks are entered, forms are submitted, or other events occur. - [Creating a Send SMS Action on a Workflow Task](https://docs.gravityrail.com/user-guide/automation/send-sms-action.md): Send templated SMS messages to members as part of an automated workflow. - [Creating a Send WhatsApp Action on a Workflow Task](https://docs.gravityrail.com/user-guide/automation/send-whatsapp-action.md): Send templated WhatsApp messages to members as part of an automated workflow. - [Upsert Member Action](https://docs.gravityrail.com/user-guide/automation/upsert-member-action.md): Create or update members automatically from webhook data as part of an automated workflow. - [Workflows](https://docs.gravityrail.com/user-guide/automation/workflows.md): Build AI-powered conversation flows with tasks, abilities, and agents. ### billing Understand your credit balance, configure auto-reload, view invoices, and set spending limits. - [Billing & Usage](https://docs.gravityrail.com/user-guide/billing.md): Understand your credit balance, configure auto-reload, view invoices, and set spending limits. ### calendars Manage schedules, availability, event types, and AI-powered appointment booking. - [Calendars](https://docs.gravityrail.com/user-guide/calendars.md): Manage schedules, availability, event types, and AI-powered appointment booking. ### channels Connect with people across phone, email, web, Discord, Slack, and more. - [Channels](https://docs.gravityrail.com/user-guide/channels.md): Connect with people across phone, email, web, Discord, Slack, and more. - [Call Recordings](https://docs.gravityrail.com/user-guide/channels/call-recordings.md): Listen to recorded voice calls in chat, sync playback with the transcript, and handle PHI safely. - [Discord Bots](https://docs.gravityrail.com/user-guide/channels/discord-bots.md): Deploy AI-powered bots in Discord with slash commands, @mentions, and DMs. - [Email Inboxes](https://docs.gravityrail.com/user-guide/channels/email-inboxes.md): Receive, route, and reply to email with AI-powered workflows on a Gravity Rail address or your own domain. - [Healthie](https://docs.gravityrail.com/user-guide/channels/healthie.md): Sync appointments, patients, and providers between Gravity Rail and Healthie EHR. - [Phone & Voice](https://docs.gravityrail.com/user-guide/channels/phone-and-voice.md): Connect with users via AI-powered phone calls and SMS messaging. - [Salesforce](https://docs.gravityrail.com/user-guide/channels/salesforce.md): Connect your workspace to Salesforce CRM to link members with contacts and leads, and give assistants access to your CRM data. - [Sites](https://docs.gravityrail.com/user-guide/channels/sites.md): Build customer-facing portals, help centers, and booking pages with AI chat. - [Slack Bots](https://docs.gravityrail.com/user-guide/channels/slack.md): Deploy AI-powered bots in Slack with @mentions, DMs, and streaming responses. - [Microsoft Teams Bots](https://docs.gravityrail.com/user-guide/channels/teams.md): Deploy AI-powered bots in Microsoft Teams with @mentions, DMs, and channel conversations. - [Voice](https://docs.gravityrail.com/user-guide/channels/voice.md): Configure AI voice calls — inbound, outbound, voice models, speech recognition, interruption handling, and troubleshooting. - [WhatsApp Messaging](https://docs.gravityrail.com/user-guide/channels/whatsapp.md): Send and receive WhatsApp messages with AI-powered workflows on the same phone numbers you use for SMS. ### chats Manage conversations across web, SMS, voice, and email channels. - [Chats](https://docs.gravityrail.com/user-guide/chats.md): Manage conversations across web, SMS, voice, and email channels. - [Scheduled Callbacks](https://docs.gravityrail.com/user-guide/chats/callbacks.md): Let agents promise a follow-up, then automatically deliver it at the right time on the right channel. - [Exporting Chats](https://docs.gravityrail.com/user-guide/chats/export.md): Download individual chat transcripts as JSONL or bulk-export chats as CSV for compliance, records, and offline review. - [Generating Chat Summaries](https://docs.gravityrail.com/user-guide/chats/generating-summaries.md): Generate AI-powered summaries to quickly understand conversation content. ### developer Developer tools, API access, webhooks, and integrations for extending your workspace. - [Developer](https://docs.gravityrail.com/user-guide/developer.md): Developer tools, API access, webhooks, and integrations for extending your workspace. - [Apps & API Keys](https://docs.gravityrail.com/user-guide/developer/apps.md): Integrate third-party tools and services with OAuth-based app grants and API keys. - [Docs Search](https://docs.gravityrail.com/user-guide/developer/docs-search.md): Search the Gravity Rail documentation from the command line using the gr CLI. - [Healthcare MCP Integration Examples](https://docs.gravityrail.com/user-guide/developer/healthcare-mcp-examples.md): Healthcare-specific examples for connecting EHR systems, scheduling, lab results, pharmacy, and clinical decision support via MCP and custom toolkits. - [Template Variables](https://docs.gravityrail.com/user-guide/developer/template-variables.md): Personalize messages and notifications with dynamic variables like member names and form data. - [Toolkits](https://docs.gravityrail.com/user-guide/developer/toolkits.md): Create custom tools and integrate external services for your AI workflows. - [Webhooks](https://docs.gravityrail.com/user-guide/developer/webhooks.md): Send signed webhook payloads to external systems when events happen in your workspace. ### direct-messages Send 1:1 messages to teammates and AI agents — including streaming agent responses, read receipts, and archive. - [Direct Messages](https://docs.gravityrail.com/user-guide/direct-messages.md): Send 1:1 messages to teammates and AI agents — including streaming agent responses, read receipts, and archive. ### filters Save reusable searches across chats and members — combine multiple rules, pin to the dashboard, and reuse in routines and goals. - [Filters](https://docs.gravityrail.com/user-guide/filters.md): Save reusable searches across chats and members — combine multiple rules, pin to the dashboard, and reuse in routines and goals. ### getting-started Get your workspace set up and start building automated workflows with AI assistance. - [Getting Started](https://docs.gravityrail.com/user-guide/getting-started.md): Get your workspace set up and start building automated workflows with AI assistance. - [Learning Path: Care Coordinator](https://docs.gravityrail.com/user-guide/getting-started/care-coordinator.md): Set up AI-powered engagement for your team — patient outreach, appointment scheduling, and ongoing care programs. - [Learning Path: Developer / Integrator](https://docs.gravityrail.com/user-guide/getting-started/developer.md): Connect Gravity Rail to your existing systems — syncing data, handling webhooks, and building custom tools. - [Learning Path: Evaluator](https://docs.gravityrail.com/user-guide/getting-started/evaluator.md): Exploring whether Gravity Rail is right for your organization? Get the big picture fast. ### journeys Build multi-step care programs that guide members through onboarding, treatment plans, and engagement sequences. - [Journeys](https://docs.gravityrail.com/user-guide/journeys.md): Build multi-step care programs that guide members through onboarding, treatment plans, and engagement sequences. ### knowledge Store and manage structured data, files, and labels in your workspace. - [Knowledge](https://docs.gravityrail.com/user-guide/knowledge.md): Store and manage structured data, files, and labels in your workspace. - [Computed Fields](https://docs.gravityrail.com/user-guide/knowledge/computed-fields.md): Automatically calculate form values using CEL formulas for scoring, totals, and derived data. - [Files](https://docs.gravityrail.com/user-guide/knowledge/files.md): Upload, organize, and share documents, images, and files with folder hierarchies and access controls. - [Forms](https://docs.gravityrail.com/user-guide/knowledge/forms.md): Create structured data types to collect, store, and manage information through AI-powered conversations or manual entry. - [Labels](https://docs.gravityrail.com/user-guide/knowledge/labels.md): Organize members, chats, and files with color-coded tags for filtering, automations, and access control. ### manager Configure your workspace through natural conversation with your AI agent. - [Workspace Manager](https://docs.gravityrail.com/user-guide/manager.md): Configure your workspace through natural conversation with your AI agent. ### members Manage members, roles, agents, and operator groups from the Members section. - [Members](https://docs.gravityrail.com/user-guide/members.md): Manage members, roles, agents, and operator groups from the Members section. - [Agents](https://docs.gravityrail.com/user-guide/members/agents.md): Create and configure AI team members that handle conversations and complete tasks. - [Anonymous & Test Members](https://docs.gravityrail.com/user-guide/members/anonymous-and-test-members.md): Manage unknown callers and sandbox accounts — review the anonymous queue, resolve to real members, expire stale entries, and create test members. - [Escalation & Human Handoff](https://docs.gravityrail.com/user-guide/members/escalation.md): Route conversations to human agents when the AI needs help — configure triggers, notifications, routing, and business hours. - [Importing Members](https://docs.gravityrail.com/user-guide/members/importing-members.md): Import members in bulk via CSV upload or the API — format your file, handle duplicates, and troubleshoot errors. - [Managing Members](https://docs.gravityrail.com/user-guide/members/managing-members.md): Add, invite, and manage the humans in your workspace — team and customers alike. - [Creating and Saving Member Filters](https://docs.gravityrail.com/user-guide/members/member-filters.md): Target specific groups of members based on labels, data fields, activity, and more. - [Notification Preferences](https://docs.gravityrail.com/user-guide/members/notification-preferences.md): Control how members receive notifications — enable or disable SMS, email, and voice channels per member. - [Live Operator Mode](https://docs.gravityrail.com/user-guide/members/operator-mode.md): Let human operators handle conversations in real time — go live, take calls, and work alongside AI. - [Qualifications](https://docs.gravityrail.com/user-guide/members/qualifications.md): Author and run persona-driven test chat scenarios for a workflow, with optional automated grading. - [Roles and Permissions](https://docs.gravityrail.com/user-guide/members/roles.md): How member roles and permission scopes control access to workspace features and data. ### milestones Learn how to set time-bound goals, define measurable targets with member filters, and track progress in your workspace. - [Milestones](https://docs.gravityrail.com/user-guide/milestones.md): Learn how to set time-bound goals, define measurable targets with member filters, and track progress in your workspace. ### notifications Understand and configure notification rules, delivery channels, and member preferences for alerts and escalations. - [Notifications](https://docs.gravityrail.com/user-guide/notifications.md): Understand and configure notification rules, delivery channels, and member preferences for alerts and escalations. - [Browser Push Notifications](https://docs.gravityrail.com/user-guide/notifications/push-notifications.md): Enable, disable, and troubleshoot real-time browser push notifications for direct messages and workspace alerts. ### organizations Manage your organization, members, and workspaces. - [Organizations](https://docs.gravityrail.com/user-guide/organizations.md): Manage your organization, members, and workspaces. ### release-notes Latest updates and improvements to Gravity Rail - [Release Notes](https://docs.gravityrail.com/user-guide/release-notes.md): Latest updates and improvements to Gravity Rail ### reseller Enable reseller mode, define products, and provision client workspaces. - [Reseller](https://docs.gravityrail.com/user-guide/reseller.md): Enable reseller mode, define products, and provision client workspaces. ### search Find workspace resources, navigation sections, and organizations instantly with keyboard-driven global search. - [Global Search](https://docs.gravityrail.com/user-guide/search.md): Find workspace resources, navigation sections, and organizations instantly with keyboard-driven global search. ### sites Create and manage customer-facing portals with customizable pages, themes, and custom domains. - [Sites](https://docs.gravityrail.com/user-guide/sites.md): Create and manage customer-facing portals with customizable pages, themes, and custom domains. ### sso-setup Configure Single Sign-On (SSO) with your organization's identity provider. - [SSO Setup](https://docs.gravityrail.com/user-guide/sso-setup.md): Configure Single Sign-On (SSO) with your organization's identity provider. ### sub-agents How your AI agent delegates slow work to a second agent so your conversation never has to wait. - [Background Sub-Agents](https://docs.gravityrail.com/user-guide/sub-agents.md): How your AI agent delegates slow work to a second agent so your conversation never has to wait. ### support-requests File, track, comment on, and close support requests with the Gravity Rail team. - [Support Requests](https://docs.gravityrail.com/user-guide/support-requests.md): File, track, comment on, and close support requests with the Gravity Rail team. ### tutorials Step-by-step guides for common workflows and use cases in Gravity Rail. - [Tutorials](https://docs.gravityrail.com/user-guide/tutorials.md): Step-by-step guides for common workflows and use cases in Gravity Rail. - [Build Your First Workflow — Appointment Reminder](https://docs.gravityrail.com/user-guide/tutorials/appointment-reminder.md): Create an automated appointment reminder workflow that contacts members via SMS and handles rescheduling requests. - [Build an AI-Powered Knowledge Base from Your Document Library](https://docs.gravityrail.com/user-guide/tutorials/document-knowledge-base.md): Upload a document library, enable semantic indexing, and configure your AI agent to search and reference the content during conversations. - [Connect to Your EHR — Build an MCP Server](https://docs.gravityrail.com/user-guide/tutorials/ehr-integration.md): Integrate your AI workflows with Epic, Cerner, or other EHR systems by building and connecting an MCP server. - [Send an HTML Email Campaign with AI-Powered Reply Handling](https://docs.gravityrail.com/user-guide/tutorials/email-campaign.md): Build a complete email campaign with personalized HTML emails and AI-powered reply handling. - [Set Up a Knowledge Base — FAQ Assistant with RAG](https://docs.gravityrail.com/user-guide/tutorials/knowledge-base.md): Build an AI assistant that answers questions using your organization's documents, policies, and FAQs with retrieval-augmented generation. - [Create a Conversational Form — Patient Intake](https://docs.gravityrail.com/user-guide/tutorials/patient-intake.md): Build an AI-powered patient intake workflow that collects demographic, insurance, and medical history information through natural conversation. - [Risk Assessment & Escalation — PHQ-9 Screening](https://docs.gravityrail.com/user-guide/tutorials/risk-assessment.md): Build a clinical screening workflow that administers the PHQ-9 depression questionnaire, scores responses, and routes to appropriate care based on severity. - [Voice Call Assistant — Phone-Based Receptionist](https://docs.gravityrail.com/user-guide/tutorials/voice-receptionist.md): Build an AI-powered phone receptionist that answers calls, routes inquiries, books appointments, and handles after-hours messaging. ### workflows Build, publish, and manage AI-powered workflows that guide members through multi-step processes. - [Workflows](https://docs.gravityrail.com/user-guide/workflows.md): Build, publish, and manage AI-powered workflows that guide members through multi-step processes. ### workspace-settings Configure workspace identity, business hours, phone defaults, escalation, email, and import/export. - [Workspace Settings](https://docs.gravityrail.com/user-guide/workspace-settings.md): Configure workspace identity, business hours, phone defaults, escalation, email, and import/export. - [Business Hours](https://docs.gravityrail.com/user-guide/workspace-settings/business-hours.md): Define when your workspace is open. Drives escalation routing, phone work modes, and the is_business_hours variable. - [Email](https://docs.gravityrail.com/user-guide/workspace-settings/email.md): Workspace-wide email footer appended to every outbound message. - [Escalation](https://docs.gravityrail.com/user-guide/workspace-settings/escalation.md): Pause behaviour, message templates, and notification rules used when AI hands a chat to a human. - [General](https://docs.gravityrail.com/user-guide/workspace-settings/general.md): Workspace name, slug, default language, timezone, signup code, and default assistant. - [Import / Export](https://docs.gravityrail.com/user-guide/workspace-settings/import-export.md): Back up, migrate, or share workspace configuration as a portable JSON file. - [Phone](https://docs.gravityrail.com/user-guide/workspace-settings/phone.md): Workspace-wide voice defaults — default phone number, audio recording, and voicemail detection on AI-initiated outbound calls. ## Optional - [Gravity Rail CLI on npm](https://www.npmjs.com/package/@gravity-rail/cli): Install the `gr` CLI to manage workspaces, chats, workflows, and 40+ resource types from the terminal. - [TypeScript SDK on npm](https://www.npmjs.com/package/@gravity-rail/sdk): The @gravity-rail/sdk TypeScript client. - [Platform Status](https://status.gravityrail.com): Service health, uptime, and incident history. --- # Full Documentation Content # Gravity Rail Developer Guide Welcome to Gravity Rail! Build sophisticated AI-powered applications with multi-channel communication, custom data management, and intelligent automation. ## What is Gravity Rail?[​](#what-is-gravity-rail "Direct link to What is Gravity Rail?") Gravity Rail is an enterprise platform for developers who need: * **Multi-channel communication** - Email, SMS, voice, and web chat unified in one platform * **AI workflows** - Build intelligent automation with custom tools and integrations * **Custom data management** - Define your own CRM-like data structures with indexing and search * **MCP integration** - Connect AI models to your business logic via Model Context Protocol * **Flexible APIs** - 170+ REST endpoints with OAuth 2.0 and webhooks * **White-label capable** - Resell with your own branding and pricing Think of it as **Zapier + Twilio + HubSpot + MCP**, designed for developers. ## Pick your integration path[​](#pick-your-integration-path "Direct link to Pick your integration path") | You want to… | Start here | | --------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Call the API from any language | **REST API** — see [Quick Reference](https://docs.gravityrail.com/developer/quick_reference.md) then [API Reference](https://docs.gravityrail.com/developer/api/.md) | | Ship a TypeScript/Node integration | **TypeScript SDK** — see [SDK Reference](https://docs.gravityrail.com/sdk/.md) | | Drive your workspace from the terminal | **CLI** — `npm install -g @gravity-rail/cli`, then `gr login` | | Let Claude/ChatGPT talk to Gravity Rail | **MCP** — see [Getting Started with Integration](https://docs.gravityrail.com/developer/guides/getting-started-integration.md) | | Use Claude Code with Gravity Rail | **Claude Skills** — see [Claude Skills for Gravity Rail](https://docs.gravityrail.com/developer/guides/claude-skills.md) | > **For AI coding agents:** a machine-readable index of this documentation is published at [`/llms.txt`](https://docs.gravityrail.com/llms.txt), with the full content inlined at [`/llms-full.txt`](https://docs.gravityrail.com/llms-full.txt). These follow the [llms.txt convention](https://llmstxt.org/). ## Quick Start[​](#quick-start "Direct link to Quick Start") ### Prerequisites[​](#prerequisites "Direct link to Prerequisites") * Gravity Rail account ([sign up](https://docs.gravityrail.com/products)) * API key (Dashboard > Settings > API Keys) — or use [OAuth 2.0](https://docs.gravityrail.com/developer/guides/authentication.md) for third-party apps * Basic REST API knowledge ### Base URL[​](#base-url "Direct link to Base URL") ``` https://api.gravityrail.com/api/v2 ``` ### Authentication[​](#authentication "Direct link to Authentication") ``` curl https://api.gravityrail.com/api/v2/w \ -H "Authorization: Bearer YOUR_API_KEY" ``` ### Your first API call — cURL vs SDK[​](#your-first-api-call--curl-vs-sdk "Direct link to Your first API call — cURL vs SDK") List your workspaces. Both examples hit `GET /api/v2/w` and return the same payload — pick whichever matches your stack. ``` # cURL curl https://api.gravityrail.com/api/v2/w \ -H "Authorization: Bearer YOUR_API_KEY" \ -H "Content-Type: application/json" ``` ``` // TypeScript SDK — @gravity-rail/sdk import { GravityRailClient } from '@gravity-rail/sdk'; const client = new GravityRailClient({ apiKey: process.env.GRAVITY_RAIL_API_KEY, }); const workspaces = await client.getWorkspaces(); console.log(workspaces); ``` ``` # CLI — @gravity-rail/cli gr login # OAuth, cached per environment gr workspaces list # same endpoint, terminal-friendly output ``` ### Send your first message[​](#send-your-first-message "Direct link to Send your first message") Create a chat and send a message on behalf of the assistant. Replace `{wid}` with a workspace ID returned by the call above. ``` # 1. Create a chat curl -X POST https://api.gravityrail.com/api/v2/w/{wid}/chats \ -H "Authorization: Bearer YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{"channel":"web-chat","title":"Support","assistantEnabled":true}' # 2. Send an assistant-authored message (API-initiated) curl -X POST https://api.gravityrail.com/api/v2/w/{wid}/chats/{chatId}/send-assistant-message \ -H "Authorization: Bearer YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{"message":"Hello, how can I help?"}' ``` See the [Quick Reference](https://docs.gravityrail.com/developer/quick_reference.md) for 30+ common operations side-by-side. ## Core Capabilities[​](#core-capabilities "Direct link to Core Capabilities") **Communication Channels** * Email inboxes with AI processing * SMS and voice calls * Web chat widgets * Unified conversation management **Custom Data Types** * Define flexible data schemas * Full-text search and indexing * Bulk operations * Relationship management **AI Workflows** * Custom toolkits extending AI capabilities * Event-driven automation * Multi-step processes * Integration with external services **MCP (Model Context Protocol)** * Build MCP servers for Claude/ChatGPT * Add external tools to AI workflows * OAuth 2.0 with Dynamic Client Registration **Webhooks & Events** * Real-time notifications * Email, chat, task, and data events * Custom event rules **Permission System** * Custom roles and RBAC * Scope-based access control * Multi-workspace organizations ## What Can You Build?[​](#what-can-you-build "Direct link to What Can You Build?") * **AI-powered customer support** with multi-channel inbox and smart routing * **Custom CRM systems** with flexible data structures and automation * **Chatbots and AI agents** using custom toolkits and MCP * **Workflow automation** triggered by emails, webhooks, or routines * **SaaS platforms** with white-label reseller capabilities * **Healthcare patient engagement** with HIPAA-compliant data storage * **MCP servers** that expose your business logic to AI models ## Documentation Structure[​](#documentation-structure "Direct link to Documentation Structure") * **[Getting Started with Integration](https://docs.gravityrail.com/developer/guides/getting-started-integration.md)** - Step-by-step guide from member registration to webhooks and MCP * **[Quick Reference](https://docs.gravityrail.com/developer/quick_reference.md)** - Common operations and examples * **[API Reference](https://docs.gravityrail.com/developer/api/.md)** - Detailed endpoint documentation (170+ endpoints) * **[SDK Reference](https://docs.gravityrail.com/sdk/.md)** - TypeScript SDK (`@gravity-rail/sdk`) with full type definitions * **[Developer Guides](https://docs.gravityrail.com/developer/guides/.md)** - Comprehensive guides for core features * **[Authentication](https://docs.gravityrail.com/developer/guides/authentication.md)** - OAuth 2.0 and API key setup * **[Claude Skills for Gravity Rail](https://docs.gravityrail.com/developer/guides/claude-skills.md)** - Install the Gravity Rail plugin for Claude Code and Cowork ## Rate Limits[​](#rate-limits "Direct link to Rate Limits") Rate limits vary by plan. Check your plan details or contact . ## Support[​](#support "Direct link to Support") * **Email**: * **Documentation**: Browse the sidebar for detailed API references --- # API Reference Complete reference documentation for all Gravity Rail API endpoints. ## API Modules[​](#api-modules "Direct link to API Modules") The API is organized into the following categories: ### Global[​](#global "Direct link to Global") * **[AI Models](https://docs.gravityrail.com/developer/api/glb/ai_models.md)** - 7 endpoint(s) · `ai`, `models`, `configuration` * **[Account](https://docs.gravityrail.com/developer/api/glb/account.md)** - 2 endpoint(s) · `authentication`, `account` * **[Features](https://docs.gravityrail.com/developer/api/glb/features.md)** - 3 endpoint(s) · `features`, `capabilities` * **[Organizations](https://docs.gravityrail.com/developer/api/glb/organizations.md)** - 3 endpoint(s) · `organizations`, `configuration` * **[Resources](https://docs.gravityrail.com/developer/api/glb/resources.md)** - 2 endpoint(s) · `resources`, `configuration` ### Workspace[​](#workspace "Direct link to Workspace") * **[Abilities](https://docs.gravityrail.com/developer/api/workspace/abilities.md)** - 6 endpoint(s) · `workflows`, `automation`, `abilities` * **[Assignments](https://docs.gravityrail.com/developer/api/workspace/assignments.md)** - 10 endpoint(s) · `tasks`, `assignments`, `workflow` * **[Calendar Event Types](https://docs.gravityrail.com/developer/api/workspace/calendar_event_types.md)** - 5 endpoint(s) · `scheduling`, `events`, `configuration` * **[Calendar Events](https://docs.gravityrail.com/developer/api/workspace/calendar_events.md)** - 8 endpoint(s) · `scheduling`, `events` * **[Calendars](https://docs.gravityrail.com/developer/api/workspace/calendars.md)** - 9 endpoint(s) · `scheduling`, `calendars` * **[Calls](https://docs.gravityrail.com/developer/api/workspace/calls.md)** - 1 endpoint(s) · `communication`, `voice`, `telephony` * **[Chat Labels](https://docs.gravityrail.com/developer/api/workspace/chat_labels.md)** - 5 endpoint(s) · `chat`, `labels`, `organization` * **[Custom Toolkits](https://docs.gravityrail.com/developer/api/workspace/custom_toolkits.md)** - 7 endpoint(s) · `ai`, `tools`, `customization` * **[Data Records](https://docs.gravityrail.com/developer/api/workspace/data_records.md)** - 4 endpoint(s) · `data`, `records` * **[Data Types](https://docs.gravityrail.com/developer/api/workspace/data_types.md)** - 7 endpoint(s) · `data`, `collections` * **[Event Rules](https://docs.gravityrail.com/developer/api/workspace/event_rules.md)** - 11 endpoint(s) · `automation`, `events`, `rules` * **[Files](https://docs.gravityrail.com/developer/api/workspace/files.md)** - 6 endpoint(s) · `files`, `storage` * **[Folders](https://docs.gravityrail.com/developer/api/workspace/folders.md)** - 11 endpoint(s) · `files`, `storage`, `organization` * **[Inboxes](https://docs.gravityrail.com/developer/api/workspace/inboxes.md)** - 5 endpoint(s) · `communication`, `email`, `messaging` * **[Journey Notes](https://docs.gravityrail.com/developer/api/workspace/journey_notes.md)** - 4 endpoint(s) · `journeys`, `notes` * **[Journeys](https://docs.gravityrail.com/developer/api/workspace/journeys.md)** - 6 endpoint(s) · `journeys`, `members` * **[MCP Servers](https://docs.gravityrail.com/developer/api/workspace/mcp_servers.md)** - 14 endpoint(s) · `integrations`, `ai`, `mcp` * **[Member Filters](https://docs.gravityrail.com/developer/api/workspace/member_filters.md)** - 1 endpoint(s) · `members`, `filters`, `organization` * **[Member Labels](https://docs.gravityrail.com/developer/api/workspace/member_labels.md)** - 5 endpoint(s) · `members`, `labels`, `organization` * **[Member Roles](https://docs.gravityrail.com/developer/api/workspace/member_roles.md)** - 5 endpoint(s) · `members`, `roles`, `permissions` * **[Menu](https://docs.gravityrail.com/developer/api/workspace/workspace_menu.md)** - 6 endpoint(s) · `workspace`, `navigation`, `customization` * **[Notification Rules](https://docs.gravityrail.com/developer/api/workspace/notification_rules.md)** - 4 endpoint(s) · `notifications`, `rules`, `automation` * **[Notifications](https://docs.gravityrail.com/developer/api/workspace/notifications.md)** - 6 endpoint(s) · `notifications`, `alerts` * **[Phone Numbers](https://docs.gravityrail.com/developer/api/workspace/phone_numbers.md)** - 8 endpoint(s) · `communication`, `phone`, `sms` * **[Push Subscriptions](https://docs.gravityrail.com/developer/api/workspace/push_subscriptions.md)** - 3 endpoint(s) · `notifications`, `push` * **[Recordings](https://docs.gravityrail.com/developer/api/workspace/recordings.md)** - 2 endpoint(s) · `voice`, `recordings` * **[Routines](https://docs.gravityrail.com/developer/api/workspace/routines.md)** - 9 endpoint(s) · `automation`, `routines` * **[Settings](https://docs.gravityrail.com/developer/api/workspace/settings.md)** - 5 endpoint(s) · `workspace`, `settings` * **[Sharing](https://docs.gravityrail.com/developer/api/workspace/sharing.md)** - 4 endpoint(s) · `sharing`, `permissions` * **[Sites](https://docs.gravityrail.com/developer/api/workspace/sites.md)** - 9 endpoint(s) · `sites`, `content` * **[Snippets](https://docs.gravityrail.com/developer/api/workspace/snippets.md)** - 5 endpoint(s) · `content`, `snippets` * **[Tasks](https://docs.gravityrail.com/developer/api/workspace/tasks.md)** - 8 endpoint(s) · `workflows`, `tasks`, `automation` * **[Toolkits](https://docs.gravityrail.com/developer/api/workspace/toolkits.md)** - 1 endpoint(s) · `ai`, `tools` * **[Webhook Logs](https://docs.gravityrail.com/developer/api/workspace/webhook_logs.md)** - 1 endpoint(s) · `webhooks`, `integrations`, `logging` * **[Workflow Versions](https://docs.gravityrail.com/developer/api/workspace/workflow_versions.md)** - 8 endpoint(s) · `workflows`, `versions` * **[Workspace.Chats.Actions](https://docs.gravityrail.com/developer/api/workspace/chats/actions.md)** - 3 endpoint(s) · `communication`, `chat`, `messaging` * **[Workspace.Chats.Crud](https://docs.gravityrail.com/developer/api/workspace/chats/crud.md)** - 2 endpoint(s) · `communication`, `chat`, `messaging` * **[Workspace.Chats.Messages](https://docs.gravityrail.com/developer/api/workspace/chats/messages.md)** - 5 endpoint(s) · `communication`, `chat`, `messaging` * **[Workspace.Chats.Stats](https://docs.gravityrail.com/developer/api/workspace/chats/stats.md)** - 4 endpoint(s) · `communication`, `chat`, `messaging` * **[Workspace.Chats.Usage](https://docs.gravityrail.com/developer/api/workspace/chats/usage.md)** - 1 endpoint(s) · `communication`, `chat`, `messaging` * **[Workspace.Chats.Voice](https://docs.gravityrail.com/developer/api/workspace/chats/voice.md)** - 2 endpoint(s) · `communication`, `chat`, `messaging`, `voice` * **[Workspace.Members.Bulk](https://docs.gravityrail.com/developer/api/workspace/members/bulk.md)** - 1 endpoint(s) · `members`, `users` * **[Workspace.Members.Crud](https://docs.gravityrail.com/developer/api/workspace/members/crud.md)** - 7 endpoint(s) · `members`, `users` * **[Workspace.Members.Current](https://docs.gravityrail.com/developer/api/workspace/members/current.md)** - 6 endpoint(s) · `members`, `users` * **[Workspace.Members.Export](https://docs.gravityrail.com/developer/api/workspace/members/export.md)** - 1 endpoint(s) · `members`, `users` * **[Workspace.Members.Fields](https://docs.gravityrail.com/developer/api/workspace/members/fields.md)** - 5 endpoint(s) · `members`, `users` * **[Workspace.Members.Import Csv](https://docs.gravityrail.com/developer/api/workspace/members/import_csv.md)** - 2 endpoint(s) · `members`, `users` * **[Workspace.Members.List](https://docs.gravityrail.com/developer/api/workspace/members/list.md)** - 2 endpoint(s) · `members`, `users` * **[Workspace.Workflows.Activity](https://docs.gravityrail.com/developer/api/workspace/workflows/activity.md)** - 2 endpoint(s) · `workflows`, `automation` * **[Workspace.Workflows.Contributors](https://docs.gravityrail.com/developer/api/workspace/workflows/contributors.md)** - 4 endpoint(s) · `workflows`, `automation` * **[Workspace.Workflows.Crud](https://docs.gravityrail.com/developer/api/workspace/workflows/crud.md)** - 7 endpoint(s) · `workflows`, `automation` * **[Workspace.Workflows.List](https://docs.gravityrail.com/developer/api/workspace/workflows/list.md)** - 2 endpoint(s) · `workflows`, `automation` * **[Workspace.Workflows.Media](https://docs.gravityrail.com/developer/api/workspace/workflows/media.md)** - 2 endpoint(s) · `workflows`, `automation` * **[Workspace.Workflows.Stats](https://docs.gravityrail.com/developer/api/workspace/workflows/stats.md)** - 2 endpoint(s) · `workflows`, `automation` * **[Workspace.Workflows.Validation](https://docs.gravityrail.com/developer/api/workspace/workflows/validation.md)** - 3 endpoint(s) · `workflows`, `automation` --- # Account **Tags:** `account`, `authentication` ## Endpoints[​](#endpoints "Direct link to Endpoints") * [`GET `](#get)- Get Current Account * [`POST `](#post)- Update Current Account ### Get Current Account[​](#get-current-account "Direct link to Get Current Account") **`GET /api/v2/account`** **Description:** Retrieve the current user's account information Retrieve user information based on user\_id. Returns a logged-out account object (with loggedIn=false) if not authenticated. This endpoint accepts optional authentication. **Authorization:** Requires scopes: **Response:** See [AccountResponse](#account-response) *** ### Update Current Account[​](#update-current-account "Direct link to Update Current Account") **`POST /api/v2/account`** **Description:** Update the current user's account information Update user information. **Authentication:** Requires authenticated user **Parameters:** * `request` - See [UpdateAccountRequest](#update-account-request) **Response:** See [AccountResponse](#account-response) *** --- # AI Models **Tags:** `ai`, `configuration`, `models` ## Endpoints[​](#endpoints "Direct link to Endpoints") * [`GET /all`](#get-all) - All * [`GET /chat`](#get-chat) - Chat * [`GET /image`](#get-image) - Image * [`GET /realtime`](#get-realtime) - Realtime * [`GET /stt`](#get-stt) - Stt * [`GET /tts`](#get-tts) - Tts * [`GET /voices`](#get-voices) - Voices ### All[​](#all "Direct link to All") **`GET /api/v2/ai-models/all`** **Description:** Available AI models and capabilities List all AI models with full metadata. Returns all model types (chat, realtime, image, stt, tts) with complete metadata including multipliers for a units calculation. This is the recommended endpoint for clients that need to display comprehensive model information or perform billing calculations. Each model contains: * id: globally unique identifier * name: human-readable name * provider: provider name * type: model type (chat, realtime, image, stt, tts) * description: optional description * state: "enabled", "disabled", or "deprecated" * available: whether the model is currently available * recommended: whether this model is recommended * replacement: ID of replacement model if deprecated * multiplier: credits multiplier for billing - 1 credit === 1 ai unit Query parameters: * provider: Filter by provider * include\_unavailable: Include unavailable models (default: false) **Authentication:** Requires authenticated user **Parameters:** * `provider` (ModelProvider) * `include_unavailable` (Boolean) **Response:** See [AllModelsResponse](#all-models-response) *** ### Chat[​](#chat "Direct link to Chat") **`GET /api/v2/ai-models/chat`** **Description:** Available AI models and capabilities List all available chat AI models. Returns chat models with optional filtering by provider. Each model contains: * id: globally unique identifier (e.g., "openai:chat:gpt-4.1") * name: human-readable name * provider: provider name (openai, google, anthropic, aws) * type: "chat" * description: optional description * state: "enabled", "disabled", or "deprecated" * available: whether the model is currently available for use * multiplier: credit multiplier for billing Query parameters: * provider: Filter by provider (openai, google, anthropic, aws) **Authentication:** Requires authenticated user **Parameters:** * `provider` (ModelProvider) **Response:** See [ChatModelsResponse](#chat-models-response) *** ### Image[​](#image "Direct link to Image") **`GET /api/v2/ai-models/image`** **Description:** Available AI models and capabilities List all available image generation AI models. Returns image models with optional filtering by provider. Each model contains: * id: globally unique identifier (e.g., "openai:image:dall-e-3") * name: human-readable name * provider: provider name (openai, google) * type: "image" * description: optional description * state: "enabled", "disabled", or "deprecated" * available: whether the model is currently available for use * multiplier: credit multiplier per image generated Query parameters: * provider: Filter by provider (openai, google) **Authentication:** Requires authenticated user **Parameters:** * `provider` (ModelProvider) **Response:** See [ImageModelsResponse](#image-models-response) *** ### Realtime[​](#realtime "Direct link to Realtime") **`GET /api/v2/ai-models/realtime`** **Description:** Available AI models and capabilities List all available realtime AI models. Returns realtime voice models with optional filtering by provider. Each model contains: * id: globally unique identifier (e.g., "openai:realtime:gpt-4o-realtime") * name: human-readable name * provider: provider name (openai, google, aws) * type: "realtime" * description: optional description * state: "enabled", "disabled", or "deprecated" * available: whether the model is currently available for use * voices: list of supported native voice model IDs * serverVad: whether server-side VAD is supported * clientVad: whether client-side VAD is supported * multiplier: credit multiplier for billing Query parameters: * provider: Filter by provider (openai, google, aws) **Authentication:** Requires authenticated user **Parameters:** * `provider` (ModelProvider) **Response:** See [RealtimeModelsResponse](#realtime-models-response) *** ### Stt[​](#stt "Direct link to Stt") **`GET /api/v2/ai-models/stt`** **Description:** Available AI models and capabilities List all available speech-to-text (STT) AI models. Returns STT models with optional filtering by provider. Each model contains: * id: globally unique identifier (e.g., "deepgram:stt:flux-general-en") * name: human-readable name * provider: provider name (deepgram, elevenlabs, openai, google) * type: "stt" * description: optional description * state: "enabled", "disabled", or "deprecated" * available: whether the model is currently available for use * multiplier: credit multiplier per minute of audio processed Query parameters: * provider: Filter by provider (deepgram, elevenlabs, openai, google) **Authentication:** Requires authenticated user **Parameters:** * `provider` (ModelProvider) **Response:** See [STTModelsResponse](#stt-models-response) *** ### Tts[​](#tts "Direct link to Tts") **`GET /api/v2/ai-models/tts`** **Description:** Available AI models and capabilities List all available text-to-speech (TTS) AI models. Returns TTS models with optional filtering by provider. Each model contains: * id: globally unique identifier (e.g., "elevenlabs:tts:eleven\_turbo\_v2\_5") * name: human-readable name * provider: provider name (elevenlabs, openai, google) * type: "tts" * description: optional description * state: "enabled", "disabled", or "deprecated" * available: whether the model is currently available for use * multiplier: credit multiplier per 1000 characters Query parameters: * provider: Filter by provider (elevenlabs, openai, google) **Authentication:** Requires authenticated user **Parameters:** * `provider` (ModelProvider) **Response:** See [TTSModelsResponse](#tts-models-response) *** ### Voices[​](#voices "Direct link to Voices") **`GET /api/v2/ai-models/voices`** **Description:** Available AI models and capabilities List available voice models with metadata. Returns all voice models with their names, descriptions, and provider info. Voice IDs are in the format: provider:voice:name (e.g., elevenlabs:voice:catt) Query parameters: * provider: Filter by provider (openai, google, aws, elevenlabs, deepgram) **Authentication:** Requires authenticated user **Parameters:** * `provider` (ModelProvider) **Response:** See [VoiceModelsResponse](#voice-models-response) *** --- # Features **Tags:** `capabilities`, `features` ## Endpoints[​](#endpoints "Direct link to Endpoints") * [`GET /registry`](#get-registry) - Registry * [`GET /registry/public`](#get-registry-public) - Public * [`GET /{slug}`](#get-slug) - Get Slug ### Registry[​](#registry "Direct link to Registry") **`GET /api/v2/features/registry`** **Description:** Available platform features and capabilities Get the full feature registry with all metadata. Returns all feature definitions including: * Dependencies between features * Visibility settings for upgrade prompts * Associated abilities, tools, routes, and event types * UI configuration (icons) This endpoint is used by the frontend to initialize the feature registry. **Authentication:** Requires authenticated user **Response:** See [FeaturesRegistryResponse](#features-registry-response) *** ### Public[​](#public "Direct link to Public") **`GET /api/v2/features/registry/public`** **Description:** Available platform features and capabilities Public feature registry — no authentication required. Returns only features marked for product page display (product\_display=True), sorted by product\_order. Used by public storefronts to render product cards. **Authentication:** Public endpoint (no authentication required) **Response:** See [FeaturesRegistryResponse](#features-registry-response) *** ### Get Slug[​](#get-slug "Direct link to Get Slug") **`GET /api/v2/features/{slug}`** **Description:** Available platform features and capabilities Get a specific feature definition by slug. Returns the full feature definition including dependencies, visibility settings, and associated components. **Authentication:** Requires authenticated user **Parameters:** * `slug` (String) **Response:** See [FeatureDefinitionResponse](#feature-definition-response) *** --- # Organizations **Tags:** `configuration`, `organizations` ## Endpoints[​](#endpoints "Direct link to Endpoints") * [`POST /o/{org_uuid}/join`](#post-o-org-uuid-join) - Join * [`GET /o/{org_uuid}/membership`](#get-o-org-uuid-membership) - Membership * [`GET /o/{org}/config`](#get-o-org-config) - Config ### Join[​](#join "Direct link to Join") **`POST /api/v2/o/{org_uuid}/join`** **Description:** Organization public configuration Join an organization and get an org-specific authentication session. This endpoint: 1. Verifies the user is authenticated 2. Checks if OrgMember exists for this account/org combination 3. Creates OrgMember if it doesn't exist (for internal auth orgs) 4. Generates an opaque org session and sets it as a cookie This is the "consent screen" completion endpoint for internal auth. For external SSO (OIDC/Google), the OAuth callback handles this instead. **Authorization:** Requires scopes: **Parameters:** * `org_uuid` (String) * `request_data` (OrgJoinRequest) **Response:** See [OrgJoinResponse](#org-join-response) *** ### Membership[​](#membership "Direct link to Membership") **`GET /api/v2/o/{org_uuid}/membership`** **Description:** Organization public configuration Check if the current user is a member of an organization. Returns membership status and role if member. **Authorization:** Requires scopes: **Parameters:** * `org_uuid` (String) **Response:** See [dict](#dict) *** ### Config[​](#config "Direct link to Config") **`GET /api/v2/o/{org}/config`** **Description:** Organization public configuration Get public configuration for an organization. This endpoint is unauthenticated and returns only the minimal information needed for the login page (name, logo, SSO settings). Args: org: Organization identifier (UUID or slug) **Authorization:** Requires scopes: **Parameters:** * `org` (String) **Response:** See [PublicOrganizationConfig](#public-organization-config) *** --- # Resources **Tags:** `configuration`, `resources` ## Endpoints[​](#endpoints "Direct link to Endpoints") * [`GET /registry`](#get-registry) - Registry * [`GET /{slug}`](#get-slug) - Get Slug ### Registry[​](#registry "Direct link to Registry") **`GET /api/v2/resources/registry`** **Description:** Resource metadata and definitions Get the full resource registry with all metadata. Returns all resource definitions including: * Display labels for UI * Unit names (singular and plural) * Descriptions * Required feature flag (if any) * Scope (workspace, org, or any) This endpoint is public (no auth required) as it returns static configuration. **Authentication:** Public endpoint (no authentication required) **Response:** See [ResourcesRegistryResponse](#resources-registry-response) *** ### Get Slug[​](#get-slug "Direct link to Get Slug") **`GET /api/v2/resources/{slug}`** **Description:** Resource metadata and definitions Get a specific resource definition by slug. **Authentication:** Public endpoint (no authentication required) **Parameters:** * `slug` (String) **Response:** See [ResourceMetadataResponse](#resource-metadata-response) *** --- # Abilities **Tags:** `abilities`, `automation`, `workflows` ## Endpoints[​](#endpoints "Direct link to Endpoints") * [`GET `](#get)- List * [`POST `](#post)- Create * [`GET /types`](#get-types) - Types * [`GET /types/{slug:path}`](#get-types-slug:path) - Types * [`DELETE /{ability_uuid}`](#delete-ability-uuid) - Delete Ability Uuid * [`PATCH /{ability_uuid}`](#patch-ability-uuid) - Update Ability Uuid ### List[​](#list "Direct link to List") **`GET /api/v2/w/{workspace_uuid}/abilities`** **Description:** Workflow ability configuration and management List configured ability instances for a workflow or task scope. Exactly one of `workflowId` or `taskId` must be provided. When `workflowId` is given, only workflow-scoped abilities (`task_id IS NULL`) are returned; pass `taskId` for task-scoped ones. **Authorization:** Requires `agents:read` scope **Parameters:** * `workflowId` (Integer) * `taskId` (Integer) **Response:** List of [AbilityResponse](#ability-response) *** ### Create[​](#create "Direct link to Create") **`POST /api/v2/w/{workspace_uuid}/abilities`** **Description:** Workflow ability configuration and management Create (enable) a configured ability on a workflow or task scope. Backs `gr agents abilities enable`. The request must name a `workflowId` (optionally with `taskId`) — abilities cannot be attached to an agent row directly. **Authorization:** Requires `agents:write` scope **Parameters:** * `request` - See [CreateAbilityRequest](#create-ability-request) **Response:** See [AbilityResponse](#ability-response) *** ### Types[​](#types "Direct link to Types") **`GET /api/v2/w/{workspace_uuid}/abilities/types`** **Description:** Workflow ability configuration and management List available ability types from the code registry. Returns ability type definitions including slug, title, category, description, channels, flags, and config schema. System abilities (auto-injected for core functionality) are hidden by default and surfaced only with `includeSystem=true`. Abilities gated behind workspace features are hidden when the feature is not enabled. **Authorization:** Requires `agents:read` scope **Parameters:** * `includeSystem` (Boolean) **Response:** See [AbilityTypesResponse](#ability-types-response) *** ### Types[​](#types-1 "Direct link to Types") **`GET /api/v2/w/{workspace_uuid}/abilities/types/{slug:path}`** **Description:** Workflow ability configuration and management Return the full spec for a single ability type by slug. Includes title, description, category, channels, singleton/system flags, required feature, and the JSON Schema of the params model. Backs `gr abilities get --name X`. The `:path` converter lets the slug contain a colon (e.g. `communication:phone_call_tools`). **Authorization:** Requires `agents:read` scope **Parameters:** * `slug` (String) **Response:** See [AbilityTypeResponse](#ability-type-response) *** ### Delete Ability Uuid[​](#delete-ability-uuid "Direct link to Delete Ability Uuid") **`DELETE /api/v2/w/{workspace_uuid}/abilities/{ability_uuid}`** **Description:** Workflow ability configuration and management Delete a configured ability instance by UUID. Backs the removal half of `gr agents abilities` management. Distinct from `disable` (which sets `enabled=false` but keeps the config). **Authorization:** Requires `agents:write` scope **Parameters:** * `ability_uuid` (String) **Response:** See [None](#none) *** ### Update Ability Uuid[​](#update-ability-uuid "Direct link to Update Ability Uuid") **`PATCH /api/v2/w/{workspace_uuid}/abilities/{ability_uuid}`** **Description:** Workflow ability configuration and management Update a configured ability (configure / enable / disable). Backs `gr agents abilities configure` (config + celCondition) and the `enable`/`disable` toggles (`enabled`). `config` is merged with the existing config; pass `enabled` to toggle activation. **Authorization:** Requires `agents:write` scope **Parameters:** * `ability_uuid` (String) * `request` - See [UpdateAbilityRequest](#update-ability-request) **Response:** See [AbilityResponse](#ability-response) *** --- # Assignments **Tags:** `assignments`, `tasks`, `workflow` ## Endpoints[​](#endpoints "Direct link to Endpoints") * [`GET `](#get)- List * [`POST `](#post)- Create * [`GET /{assignment_id}`](#get-assignment-id) - Get Assignment Id * [`PUT /{assignment_id}`](#put-assignment-id) - Update Assignment Id * [`POST /{assignment_id}/cancel`](#post-assignment-id-cancel) - Cancel * [`GET /{assignment_id}/cel-context`](#get-assignment-id-cel-context) - Cel Context * [`GET /{assignment_id}/current-task-detail`](#get-assignment-id-current-task-detail) - Current Task Detail * [`GET /{assignment_id}/messages`](#get-assignment-id-messages) - Messages * [`GET /{assignment_id}/tasks/{assignment_task_id}`](#get-assignment-id-tasks-assignment-task-id) - Tasks * [`PUT /{assignment_id}/tasks/{assignment_task_id}/select`](#put-assignment-id-tasks-assignment-task-id-select) - Update Select ### List[​](#list "Direct link to List") **`GET /api/v2/w/{workspace_uuid}/assignments`** **Description:** Task and workflow assignments List assignments with pagination. Self-access: Users can always list their own assignments (mine=True forced). Admin access: ASSIGNMENTS\_READ scope required to list all assignments or to filter by a memberId other than the caller's own. **Authentication:** Requires workspace member **Parameters:** * `page` (Integer) * `pageSize` (Integer) * `sortBy` (AssignmentSortField) * `sortOrder` (SortOrder) * `mine` (Boolean) * `taskId` (Integer) * `memberId` (Integer) * `status` (String) **Response:** See [PaginatedResponse\[AssignmentResponse\]](#paginated-response%5B-assignment-response%5D) *** ### Create[​](#create "Direct link to Create") **`POST /api/v2/w/{workspace_uuid}/assignments`** **Description:** Task and workflow assignments Create a new assignment. Requires workflow USE permission (checked by CreateAssignmentRequest). **Authentication:** Requires workspace member **Parameters:** * `request_body` (CreateAssignmentRequest) **Response:** See [AssignmentResponse](#assignment-response) *** ### Get Assignment Id[​](#get-assignment-id "Direct link to Get Assignment Id") **`GET /api/v2/w/{workspace_uuid}/assignments/{assignment_id}`** **Description:** Task and workflow assignments Get a specific assignment by ID. Self-access: Users can view their own assignments. Admin access: ASSIGNMENTS\_READ scope required to view other members' assignments. **Authentication:** Requires workspace member **Parameters:** * `assignment_id` (Integer) **Response:** See [AssignmentResponse](#assignment-response) *** ### Update Assignment Id[​](#update-assignment-id "Direct link to Update Assignment Id") **`PUT /api/v2/w/{workspace_uuid}/assignments/{assignment_id}`** **Description:** Task and workflow assignments Update an existing assignment. Self-access: Users can update their own assignments. Admin access: ASSIGNMENTS\_WRITE scope required to update other members' assignments. **Authentication:** Requires workspace member **Parameters:** * `assignment_id` (Integer) * `request_body` (UpdateAssignmentRequest) **Response:** See [AssignmentResponse](#assignment-response) *** ### Cancel[​](#cancel "Direct link to Cancel") **`POST /api/v2/w/{workspace_uuid}/assignments/{assignment_id}/cancel`** **Description:** Task and workflow assignments Cancel an active assignment. Admin access: ASSIGNMENTS\_WRITE scope required to cancel other members' assignments. Self-access: Users can cancel their own assignments. **Authentication:** Requires workspace member **Parameters:** * `assignment_id` (Integer) * `request_body` (CancelAssignmentRequest) **Response:** See [AssignmentResponse](#assignment-response) *** ### Cel Context[​](#cel-context "Direct link to Cel Context") **`GET /api/v2/w/{workspace_uuid}/assignments/{assignment_id}/cel-context`** **Description:** Task and workflow assignments Get CEL evaluation context for the current assignment. Returns a read-only snapshot of the variables used when evaluating task conditions for this Assignment, so the UI can show routing hints. Task switches are still enforced server-side. Self-access: Users can read context for their own assignments. Admin access: ASSIGNMENTS\_READ scope required for other members' assignments. The response omits `member.form_data` and `member.data` (empty maps) so this preview does not expose PHI; the runtime evaluator still has access when conditions reference those fields. **Authentication:** Requires workspace member **Parameters:** * `assignment_id` (Integer) **Response:** See [dict](#dict) *** ### Current Task Detail[​](#current-task-detail "Direct link to Current Task Detail") **`GET /api/v2/w/{workspace_uuid}/assignments/{assignment_id}/current-task-detail`** **Description:** Task and workflow assignments Get rich detail of the current task for operator assignment view. **Authentication:** Requires workspace member **Parameters:** * `assignment_id` (Integer) **Response:** See [OperatorTaskDetailResponse](#operator-task-detail-response) *** ### Messages[​](#messages "Direct link to Messages") **`GET /api/v2/w/{workspace_uuid}/assignments/{assignment_id}/messages`** **Description:** Task and workflow assignments Get all messages for a specific assignment. Self-access: Users can view messages for their own assignments. Admin access: ASSIGNMENTS\_READ scope required to view other members' messages. **Authentication:** Requires workspace member **Parameters:** * `assignment_id` (Integer) **Response:** List of [OpenAIMessageResponse](#open-ai-message-response) *** ### Tasks[​](#tasks "Direct link to Tasks") **`GET /api/v2/w/{workspace_uuid}/assignments/{assignment_id}/tasks/{assignment_task_id}`** **Description:** Task and workflow assignments Get a specific assignment task by ID. Self-access: Users can view tasks for their own assignments. Admin access: ASSIGNMENTS\_READ scope required to view other members' tasks. **Authentication:** Requires workspace member **Parameters:** * `assignment_id` (Integer) * `assignment_task_id` (Integer) **Response:** See [AssignmentTaskResponse](#assignment-task-response) *** ### Update Select[​](#update-select "Direct link to Update Select") **`PUT /api/v2/w/{workspace_uuid}/assignments/{assignment_id}/tasks/{assignment_task_id}/select`** **Description:** Task and workflow assignments Switch the current task for an assignment. Self-access: Users can switch tasks for their own assignments. Admin access: ASSIGNMENTS\_WRITE scope required to switch other members' tasks. **Authentication:** Requires workspace member **Parameters:** * `assignment_id` (Integer) * `assignment_task_id` (Integer) **Response:** See [AssignmentTaskResponse](#assignment-task-response) *** --- # Calendar Event Types **Tags:** `configuration`, `events`, `scheduling` ## Endpoints[​](#endpoints "Direct link to Endpoints") * [`GET `](#get)- List * [`POST `](#post)- Create * [`DELETE /{event_type_id}`](#delete-event-type-id) - Delete Event Type Id * [`GET /{event_type_id}`](#get-event-type-id) - Get Event Type Id * [`PUT /{event_type_id}`](#put-event-type-id) - Update Event Type Id ### List[​](#list "Direct link to List") **`GET /api/v2/w/{workspace_uuid}/calendar-event-types`** **Description:** Calendar event type definitions List all calendar event types. **Authorization:** Requires `calendars:read` scope **Parameters:** * `page` (Integer) * `pageSize` (Integer) * `active_only` (Boolean) **Response:** See [PaginatedResponse\[EventTypeResponse\]](#paginated-response%5B-event-type-response%5D) *** ### Create[​](#create "Direct link to Create") **`POST /api/v2/w/{workspace_uuid}/calendar-event-types`** **Description:** Calendar event type definitions Create a new calendar event type. **Authorization:** Requires `calendars:write` scope **Parameters:** * `request` - See [CreateEventTypeRequest](#create-event-type-request) **Response:** See [EventTypeResponse](#event-type-response) *** ### Delete Event Type Id[​](#delete-event-type-id "Direct link to Delete Event Type Id") **`DELETE /api/v2/w/{workspace_uuid}/calendar-event-types/{event_type_id}`** **Description:** Calendar event type definitions Delete a calendar event type. Note: This will fail if there are existing events using this type. Consider deactivating instead by setting active=false. **Authorization:** Requires `calendars:admin` scope **Parameters:** * `event_type_id` (Integer) **Response:** See [dict](#dict) *** ### Get Event Type Id[​](#get-event-type-id "Direct link to Get Event Type Id") **`GET /api/v2/w/{workspace_uuid}/calendar-event-types/{event_type_id}`** **Description:** Calendar event type definitions Get a specific event type by ID. **Authorization:** Requires `calendars:read` scope **Parameters:** * `event_type_id` (Integer) **Response:** See [EventTypeResponse](#event-type-response) *** ### Update Event Type Id[​](#update-event-type-id "Direct link to Update Event Type Id") **`PUT /api/v2/w/{workspace_uuid}/calendar-event-types/{event_type_id}`** **Description:** Calendar event type definitions Update an existing calendar event type. **Authorization:** Requires `calendars:write` scope **Parameters:** * `event_type_id` (Integer) * `request` - See [UpdateEventTypeRequest](#update-event-type-request) **Response:** See [EventTypeResponse](#event-type-response) *** --- # Calendar Events **Tags:** `events`, `scheduling` ## Endpoints[​](#endpoints "Direct link to Endpoints") * [`GET `](#get)- List * [`POST `](#post)- Create * [`DELETE /{event_id}`](#delete-event-id) - Delete Event Id * [`GET /{event_id}`](#get-event-id) - Get Event Id * [`PUT /{event_id}`](#put-event-id) - Update Event Id * [`GET /{event_id}/attendees`](#get-event-id-attendees) - Attendees * [`PUT /{event_id}/attendees/{member_id}`](#put-event-id-attendees-member-id) - Update Attendees * [`POST /{event_id}/cancel`](#post-event-id-cancel) - Cancel ### List[​](#list "Direct link to List") **`GET /api/v2/w/{workspace_uuid}/calendar-events`** **Description:** Calendar event management List calendar events with optional filtering. **Authorization:** Requires `calendars:read` scope **Parameters:** * `calendarId` (Integer) * `startDate` (datetime) * `endDate` (datetime) * `status` (String) * `page` (Integer) * `pageSize` (Integer) * `sortBy` (CalendarEventSortField) * `sortOrder` (SortOrder) **Response:** See [PaginatedResponse\[EventResponse\]](#paginated-response%5B-event-response%5D) *** ### Create[​](#create "Direct link to Create") **`POST /api/v2/w/{workspace_uuid}/calendar-events`** **Description:** Calendar event management Create a new calendar event (booking). This endpoint validates availability and attendee limits before creating the booking. If the calendar is linked to Google Calendar, the event will be synced automatically. The startTime parameter should be timezone-aware (ISO 8601 with timezone). If it's timezone-naive, it will be interpreted as being in the calendar's timezone. Event rules and Google Calendar sync run after the event is saved. **Authorization:** Requires `calendars:write` scope **Parameters:** * `request` - See [CreateEventRequest](#create-event-request) **Response:** See [EventResponse](#event-response) *** ### Delete Event Id[​](#delete-event-id "Direct link to Delete Event Id") **`DELETE /api/v2/w/{workspace_uuid}/calendar-events/{event_id}`** **Description:** Calendar event management Delete a calendar event (hard delete). Also deletes from Google Calendar if linked. Event rules and Google Calendar sync run after the local delete commits. **Authorization:** Requires `calendars:admin` scope **Parameters:** * `event_id` (Integer) **Response:** See [dict](#dict) *** ### Get Event Id[​](#get-event-id "Direct link to Get Event Id") **`GET /api/v2/w/{workspace_uuid}/calendar-events/{event_id}`** **Description:** Calendar event management Get a specific calendar event by ID. **Authorization:** Requires `calendars:read` scope **Parameters:** * `event_id` (Integer) **Response:** See [EventResponse](#event-response) *** ### Update Event Id[​](#update-event-id "Direct link to Update Event Id") **`PUT /api/v2/w/{workspace_uuid}/calendar-events/{event_id}`** **Description:** Calendar event management Update an existing calendar event. The startTime and endTime parameters should be timezone-aware (ISO 8601 with timezone). If they're timezone-naive, they will be interpreted as being in the calendar's timezone. Event rules and Google Calendar sync run after the event is updated. **Authorization:** Requires `calendars:write` scope **Parameters:** * `event_id` (Integer) * `request` - See [UpdateEventRequest](#update-event-request) **Response:** See [EventResponse](#event-response) *** ### Attendees[​](#attendees "Direct link to Attendees") **`GET /api/v2/w/{workspace_uuid}/calendar-events/{event_id}/attendees`** **Description:** Calendar event management List all attendees for an event. **Authorization:** Requires `calendars:read` scope **Parameters:** * `event_id` (Integer) **Response:** List of [AttendeeResponse](#attendee-response) *** ### Update Attendees[​](#update-attendees "Direct link to Update Attendees") **`PUT /api/v2/w/{workspace_uuid}/calendar-events/{event_id}/attendees/{member_id}`** **Description:** Calendar event management Update an attendee's response to an event invitation. **Authorization:** Requires `calendars:write` scope **Parameters:** * `event_id` (Integer) * `member_id` (Integer) * `request` - See [UpdateAttendeeRequest](#update-attendee-request) **Response:** See [AttendeeResponse](#attendee-response) *** ### Cancel[​](#cancel "Direct link to Cancel") **`POST /api/v2/w/{workspace_uuid}/calendar-events/{event_id}/cancel`** **Description:** Calendar event management Cancel a calendar event. Event rules and Google Calendar sync run after the cancellation is saved. **Authorization:** Requires `calendars:write` scope **Parameters:** * `event_id` (Integer) * `request` - See [CancelEventRequest](#cancel-event-request) **Response:** See [EventResponse](#event-response) *** --- # Calendars **Tags:** `calendars`, `scheduling` ## Endpoints[​](#endpoints "Direct link to Endpoints") * [`GET `](#get)- List * [`POST `](#post)- Create * [`DELETE /{calendar_id}`](#delete-calendar-id) - Delete Calendar Id * [`GET /{calendar_id}`](#get-calendar-id) - Get Calendar Id * [`PUT /{calendar_id}`](#put-calendar-id) - Update Calendar Id * [`GET /{calendar_id}/schedules`](#get-calendar-id-schedules) - Schedules * [`POST /{calendar_id}/schedules`](#post-calendar-id-schedules) - Schedules * [`DELETE /{calendar_id}/schedules/{schedule_id}`](#delete-calendar-id-schedules-schedule-id) - Delete Schedules * [`PUT /{calendar_id}/schedules/{schedule_id}`](#put-calendar-id-schedules-schedule-id) - Update Schedules ### List[​](#list "Direct link to List") **`GET /api/v2/w/{workspace_uuid}/calendars`** **Description:** Calendar and scheduling management List all calendars accessible to the authenticated user. **Authorization:** Requires `calendars:read` scope **Parameters:** * `page` (Integer) * `pageSize` (Integer) * `includeSchedules` (Boolean) **Response:** See [PaginatedResponse\[CalendarResponse\]](#paginated-response%5B-calendar-response%5D) *** ### Create[​](#create "Direct link to Create") **`POST /api/v2/w/{workspace_uuid}/calendars`** **Description:** Calendar and scheduling management Create a new calendar. Creates an open/unconstrained calendar by default. Users can add schedules and event types later through the edit interface. **Authorization:** Requires `calendars:write` scope **Parameters:** * `request` - See [CreateCalendarRequest](#create-calendar-request) **Response:** See [CalendarResponse](#calendar-response) *** ### Delete Calendar Id[​](#delete-calendar-id "Direct link to Delete Calendar Id") **`DELETE /api/v2/w/{workspace_uuid}/calendars/{calendar_id}`** **Description:** Calendar and scheduling management Delete a calendar. **Authorization:** Requires `calendars:admin` scope **Parameters:** * `calendar_id` (Integer) **Response:** See [dict](#dict) *** ### Get Calendar Id[​](#get-calendar-id "Direct link to Get Calendar Id") **`GET /api/v2/w/{workspace_uuid}/calendars/{calendar_id}`** **Description:** Calendar and scheduling management Get a specific calendar by ID. **Authorization:** Requires `calendars:read` scope **Parameters:** * `calendar_id` (Integer) * `includeSchedules` (Boolean) **Response:** See [CalendarResponse](#calendar-response) *** ### Update Calendar Id[​](#update-calendar-id "Direct link to Update Calendar Id") **`PUT /api/v2/w/{workspace_uuid}/calendars/{calendar_id}`** **Description:** Calendar and scheduling management Update an existing calendar. **Authorization:** Requires `calendars:write` scope **Parameters:** * `calendar_id` (Integer) * `request` - See [UpdateCalendarRequest](#update-calendar-request) **Response:** See [CalendarResponse](#calendar-response) *** ### Schedules[​](#schedules "Direct link to Schedules") **`GET /api/v2/w/{workspace_uuid}/calendars/{calendar_id}/schedules`** **Description:** Calendar and scheduling management List all schedules for a calendar. **Authorization:** Requires `calendars:read` scope **Parameters:** * `calendar_id` (Integer) **Response:** List of [CalendarScheduleResponse](#calendar-schedule-response) *** ### Schedules[​](#schedules-1 "Direct link to Schedules") **`POST /api/v2/w/{workspace_uuid}/calendars/{calendar_id}/schedules`** **Description:** Calendar and scheduling management Create a new schedule for a calendar. **Authorization:** Requires `calendars:write` scope **Parameters:** * `calendar_id` (Integer) * `request` - See [CreateCalendarScheduleRequest](#create-calendar-schedule-request) **Response:** See [CalendarScheduleResponse](#calendar-schedule-response) *** ### Delete Schedules[​](#delete-schedules "Direct link to Delete Schedules") **`DELETE /api/v2/w/{workspace_uuid}/calendars/{calendar_id}/schedules/{schedule_id}`** **Description:** Calendar and scheduling management Delete a schedule. **Authorization:** Requires `calendars:admin` scope **Parameters:** * `calendar_id` (Integer) * `schedule_id` (Integer) **Response:** See [dict](#dict) *** ### Update Schedules[​](#update-schedules "Direct link to Update Schedules") **`PUT /api/v2/w/{workspace_uuid}/calendars/{calendar_id}/schedules/{schedule_id}`** **Description:** Calendar and scheduling management Update an existing schedule. **Authorization:** Requires `calendars:write` scope **Parameters:** * `calendar_id` (Integer) * `schedule_id` (Integer) * `request` - See [UpdateCalendarScheduleRequest](#update-calendar-schedule-request) **Response:** See [CalendarScheduleResponse](#calendar-schedule-response) *** --- # Calls **Tags:** `communication`, `telephony`, `voice` ## Endpoints[​](#endpoints "Direct link to Endpoints") * [`POST `](#post)- Create ### Create[​](#create "Direct link to Create") **`POST /api/v2/w/{workspace_uuid}/calls`** **Description:** Voice call history and management Initiate a direct call from the current member to another member. This creates a call without an AI assistant, directly connecting two members. The originating member receives a call first, hears a confirmation message, then is connected to the target member. Args: request: Call initiation request with target member ID and name ctx: Current execution context Returns: InitiateCallResponse: Created phone call details Raises: HTTPException: If members don't have phone numbers or Twilio call fails **Authorization:** Requires `phones:write` scope **Parameters:** * `request` - See [InitiateCallRequest](#initiate-call-request) **Response:** See [InitiateCallResponse](#initiate-call-response) *** --- # Chat Labels **Tags:** `chat`, `labels`, `organization` ## Endpoints[​](#endpoints "Direct link to Endpoints") * [`GET `](#get)- List * [`POST `](#post)- Create * [`DELETE /{label_id}`](#delete-label-id) - Delete Label Id * [`GET /{label_id}`](#get-label-id) - Get Label Id * [`PUT /{label_id}`](#put-label-id) - Update Label Id ### List[​](#list "Direct link to List") **`GET /api/v2/w/{workspace_uuid}/chat-labels`** **Description:** Chat conversation tagging and categorization List all chat labels for the workspace. Access: All workspace members can view labels (workspace-scoped resource). **Authorization:** Requires `labels:read` scope **Response:** List of [ChatLabelResponse](#chat-label-response) *** ### Create[​](#create "Direct link to Create") **`POST /api/v2/w/{workspace_uuid}/chat-labels`** **Description:** Chat conversation tagging and categorization Create a new chat label. Requires workspace manager role. **Authorization:** Requires `chats:write` scope **Parameters:** * `label` (CreateChatLabelRequest) **Response:** See [ChatLabelResponse](#chat-label-response) *** ### Delete Label Id[​](#delete-label-id "Direct link to Delete Label Id") **`DELETE /api/v2/w/{workspace_uuid}/chat-labels/{label_id}`** **Description:** Chat conversation tagging and categorization Delete a chat label. Requires workspace manager role. **Authorization:** Requires `chats:write` scope **Parameters:** * `label_id` (Integer) *** ### Get Label Id[​](#get-label-id "Direct link to Get Label Id") **`GET /api/v2/w/{workspace_uuid}/chat-labels/{label_id}`** **Description:** Chat conversation tagging and categorization Get a specific chat label by ID. **Authorization:** Requires `labels:read` scope **Parameters:** * `label_id` (String) **Response:** See [ChatLabelResponse](#chat-label-response) *** ### Update Label Id[​](#update-label-id "Direct link to Update Label Id") **`PUT /api/v2/w/{workspace_uuid}/chat-labels/{label_id}`** **Description:** Chat conversation tagging and categorization Update an existing chat label. Requires workspace manager role. **Authorization:** Requires `chats:write` scope **Parameters:** * `label_id` (Integer) * `label` (UpdateChatLabelRequest) **Response:** See [ChatLabelResponse](#chat-label-response) *** --- # Workspace.Chats.Actions **Tags:** `chat`, `communication`, `messaging` ## Endpoints[​](#endpoints "Direct link to Endpoints") * [`POST /{chat_id}/participants`](#post-chat-id-participants) - Participants * [`POST /{chat_id}/send-assistant-message`](#post-chat-id-send-assistant-message) - Send Assistant Message * [`POST /{chat_id}/summarize`](#post-chat-id-summarize) - Summarize ### Participants[​](#participants "Direct link to Participants") **`POST /api/v2/w/{workspace_uuid}/chats/{chat_id}/participants`** **Description:** Chat actions and operations Add a participant to a chat with a specified role. Allows workspace managers to add members to chats with various roles including contributors. Contributors can be consulted via contributor\_input\_request tool during conversations. **Path Parameters:** * `chat_id`: Chat ID to add participant to **Request Body:** * `memberId`: ID of the member to add as a participant * `role`: Role for the participant (default: "contributor") **Response:** Returns a success status, message, and the ID of the created participant. **Permissions:** Requires `chats:write` scope. **Error Responses:** * `401 Unauthorized`: Missing or invalid authentication * `403 Forbidden`: User lacks `chats:write` scope * `404 Not Found`: Chat or member not found * `400 Bad Request`: Invalid role or participant already exists **Related Endpoints:** * `GET /chats/{id}` - Get chat details including participants * `GET /members` - List workspace members **Authorization:** Requires `chats:write` scope **Parameters:** * `chat_id` (Integer) * `request` - See [AddChatParticipantRequest](#add-chat-participant-request) **Response:** See [ChatParticipantAddedResponse](#chat-participant-added-response) *** ### Send Assistant Message[​](#send-assistant-message "Direct link to Send Assistant Message") **`POST /api/v2/w/{workspace_uuid}/chats/{chat_id}/send-assistant-message`** **Description:** Chat actions and operations Send a message as the assistant in a chat conversation. Allows workspace managers to manually send messages on behalf of the chat's assistant. Supports SMS and email channels with automatic delivery. Can optionally include tool calls which will be executed before message delivery. Automatically clears the needs\_response flag when used. **Path Parameters:** * `chat_id`: Chat ID to send the message in **Request Body:** * `message`: Message content to send (supports markdown for email) * `tool_calls`: Optional array of tool calls to execute with the message **Response:** Returns a success confirmation with the created message details including ID, UUID, role, content, and timestamp. **Permissions:** Requires `chats:admin` scope to send messages as the assistant. **Error Responses:** * `400 Bad Request`: Invalid chat configuration, missing phone/email, or notifications disabled * `401 Unauthorized`: Missing or invalid authentication * `403 Forbidden`: User lacks `chats:admin` scope * `404 Not Found`: Chat, assistant, or participant not found * `500 Internal Server Error`: Failed to send SMS/email or execute tools **Related Endpoints:** * `GET /chats/{id}/messages` - Get chat message history * `POST /chats/{id}/messages/{uuid}/rate` - Rate an assistant message * `GET /chats/{id}/tools` - Get available tools for the chat **Authorization:** Requires `chats:admin` scope **Parameters:** * `chat_id` (Integer) * `payload` - See [SendAssistantMessageRequest](#send-assistant-message-request) *** ### Summarize[​](#summarize "Direct link to Summarize") **`POST /api/v2/w/{workspace_uuid}/chats/{chat_id}/summarize`** **Description:** Chat actions and operations Generate an AI summary of the chat conversation. Creates an AI-generated summary of the chat's message history, updating the chat's title and summary fields. Optionally analyzes conversation content to automatically update chat labels. Summary generation happens synchronously within the request. **Path Parameters:** * `chat_id`: Chat ID to summarize **Query Parameters:** * `update_labels`: If true, also updates chat labels based on conversation content (default: false) **Response:** Returns the updated ChatResponse object with new title, summary, summary\_updated\_at timestamp, and optionally updated labels. **Permissions:** Self-access: Users can summarize their own chats. Admin access: CHATS\_WRITE scope required to summarize other members' chats. **Error Responses:** * `401 Unauthorized`: Missing or invalid authentication * `403 Forbidden`: User does not have permission to summarize this chat * `404 Not Found`: Chat not found * `500 Internal Server Error`: AI summarization failed **Related Endpoints:** * `GET /chats/{id}` - Get chat details including current summary * `GET /chats/{id}/messages` - View messages being summarized * `PUT /chats/{id}` - Update chat manually **Authentication:** Requires workspace member **Parameters:** * `chat_id` (Integer) * `update_labels` (Boolean) **Response:** See [ChatResponse](#chat-response) *** --- # Workspace.Chats.Crud **Tags:** `chat`, `communication`, `messaging` ## Endpoints[​](#endpoints "Direct link to Endpoints") * [`POST `](#post)- Create * [`POST /dm`](#post-dm) - Dm ### Create[​](#create "Direct link to Create") **`POST /api/v2/w/{workspace_uuid}/chats`** **Description:** Chat CRUD operations Create a new chat conversation in the workspace. Self-access: Any authenticated member can create a chat (becomes the owner). Creates either a simple chat or, when `workflowId` is provided, a workflow assignment chat. The assignment is created automatically; callers do not create or pass an assignment first. For `phone-voice` assignment chats with the assistant enabled, chat creation also places the outbound call. **Request Body:** * `channel`: Communication channel (web-chat, phone-sms, phone-voice, email) * `workflowId`: Workflow to run; creates the assignment automatically when provided * `workflowVersionNumber`: Published workflow version to pin this assignment to * `memberId`: Member this chat is for; defaults to the authenticated member * `phoneNumberId`: Workspace phone number for SMS/voice; workflow default is used when available * `inboxId`: Workspace inbox for email chats; mutually exclusive with `phoneNumberId` * `participants`: Additional member participants such as an assistant/operator member * `assistantEnabled`: Whether the AI assistant runs the chat (default: true) * `assistantMemberId`: Specific assistant member to use instead of the workflow agent * `assistantChatModelId` / `assistantRealtimeModelId`: Per-chat assistant model overrides * `initialMessage`: Initial operator message for agent-disabled SMS/email chats * `title`, `siteId`, `isTest`, `chatType`: Optional metadata and chat classification **Response:** Returns a ChatResponse object with the newly created chat, including all participants, message counts, and metadata. When an operator-typed `initialMessage` could not be sent (SMS/email dispatch failed, recipient opted out, missing phone/inbox), the chat is still created and returned with `initialMessageError` set to a PHI-free reason code — a partial success, not an error. Callers should surface a "reload and retry" warning when that field is present. **Permissions:** Requires authenticated member session. Chat ownership is automatically assigned to the creator. **Error Responses:** * `400 Bad Request`: Invalid request parameters or missing required fields * `401 Unauthorized`: Missing or invalid authentication * `404 Not Found`: Referenced workflow, member, or assistant member not found * `500 Internal Server Error`: Database or processing error **Related Endpoints:** * `GET /chats` - List all chats * `GET /chats/{chat_id}` - Get chat details * `PUT /chats/{chat_id}` - Update chat properties **Authentication:** Requires workspace member **Parameters:** * `chat` (CreateChatRequest) **Response:** See [ChatResponse](#chat-response) *** ### Dm[​](#dm "Direct link to Dm") **`POST /api/v2/w/{workspace_uuid}/chats/dm`** **Description:** Chat CRUD operations Find or create a DM chat with a specific member. Returns the existing DM chat between the current member and the target member, or creates a new one if none exists. Self-access: a member may always start their own DM with an **agent** — it is their own conversation, so no scope is required (matching record self-access, where creating your own record needs no `records:write`). Initiating a DM with another **human** member is cross-member contact and requires `dm:write`. **Authentication:** Requires workspace member **Parameters:** * `request` - See [FindOrCreateDMChatRequest](#find-or-create-dm-chat-request) **Response:** See [ChatResponse](#chat-response) *** --- # Workspace.Chats.Messages **Tags:** `chat`, `communication`, `messaging` ## Endpoints[​](#endpoints "Direct link to Endpoints") * [`GET /{chat_id}/messages`](#get-chat-id-messages) - Messages * [`GET /{chat_id}/messages`](#get-chat-id-messages) - Messages * [`POST /{chat_id}/messages`](#post-chat-id-messages) - Messages * [`POST /{chat_id}/messages/{message_uuid}/rate`](#post-chat-id-messages-message-uuid-rate) - Rate * [`GET /{chat_id}/tool-calls/{call_id}/messages`](#get-chat-id-tool-calls-call-id-messages) - Messages ### Messages[​](#messages "Direct link to Messages") **`GET /api/v2/w/{workspace_uuid}/chats/{chat_id}/messages`** **Description:** Chat message operations Get messages from a specific chat with pagination. Retrieves the message history for a chat in OpenAI-compatible format. Messages include content, role (user/assistant/system), tool calls, and metadata. Results are paginated for efficient loading of long conversations. **Path Parameters:** * `id`: Chat ID to retrieve messages from **Query Parameters:** * `limit`: Maximum number of messages to return (1-100, default: 10) * `offset`: Number of messages to skip for pagination (default: 0) **Response:** Returns an array of OpenAIMessageResponse objects in reverse chronological order (most recent first), each containing message content, role, timestamps, and tool call data. **Permissions:** Self-access: Users can view messages in their own chats. Admin access: CHATS\_READ scope required to view other members' chat messages. **Error Responses:** * `401 Unauthorized`: Missing or invalid authentication * `403 Forbidden`: User does not have permission to view this chat * `404 Not Found`: Chat not found **Related Endpoints:** * `GET /chats/{chat_id}` - Get chat details * `GET /chats/{chat_id}/tool-calls/{call_id}/messages` - Get tool call messages * `POST /chats/{chat_id}/send-assistant-message` - Send a message as assistant **Authentication:** Requires workspace member **Parameters:** * `chat_id` (int | str) * `limit` (Integer) * `offset` (Integer) **Response:** List of [OpenAIMessageResponse](#open-ai-message-response) *** ### Messages[​](#messages-1 "Direct link to Messages") **`GET /api/v2/w/{workspace_uuid}/chats/{chat_id}/messages`** **Description:** Chat message operations Get paginated messages for a specific chat. Retrieves chat messages with full pagination support including total count calculation. Messages are returned in OpenAI-compatible format with role, content, and tool call information. **Path Parameters:** * `chat_id`: Chat ID to retrieve messages from **Query Parameters:** * `limit`: Maximum messages per page (1-100, default: 10) * `offset`: Number of messages to skip (default: 0) * `total_count`: Whether to calculate total message count (default: false for performance) **Response:** Returns a paginated response with message array, total count, page number, page size, and total pages. Messages are in OpenAI format with full metadata. **Permissions:** Self-access: Users can view messages in their own chats. Admin access: CHATS\_READ scope required to view other members' chat messages. **Error Responses:** * `401 Unauthorized`: Missing or invalid authentication * `403 Forbidden`: User does not have permission to view this chat * `404 Not Found`: Chat not found **Related Endpoints:** * `GET /chats/{chat_id}/messages` - Alternative messages endpoint * `GET /chats/{chat_id}` - Get chat details **Authentication:** Requires workspace member **Parameters:** * `workspace_uuid` (String) * `chat_id` (int | str) * `limit` (Integer) * `offset` (Integer) * `total_count` (Boolean) **Response:** See [PaginatedResponse\[OpenAIMessageResponse\]](#paginated-response%5B-open-ai-message-response%5D) *** ### Messages[​](#messages-2 "Direct link to Messages") **`POST /api/v2/w/{workspace_uuid}/chats/{chat_id}/messages`** **Description:** Chat message operations Send a user message in a chat. For DM chats with human recipients, triggers SendDmNotificationWorkflow. Agent DM responses are handled via the AGUI streaming endpoint. **Authorization:** Requires `chats:write` scope **Parameters:** * `chat_id` (int | str) * `request` - See [SendUserMessageRequest](#send-user-message-request) **Response:** See [OpenAIMessageResponse](#open-ai-message-response) *** ### Rate[​](#rate "Direct link to Rate") **`POST /api/v2/w/{workspace_uuid}/chats/{chat_id}/messages/{message_uuid}/rate`** **Description:** Chat message operations Rate an assistant message for quality feedback. Records user feedback on assistant message quality to Langfuse for observability and continuous improvement. Only assistant messages can be rated. Ratings are associated with the message's trace and observation IDs for detailed analysis. **Path Parameters:** * `chat_id`: Chat ID containing the message * `message_uuid`: UUID of the message to rate **Request Body:** * `rating`: Numeric rating value (e.g., 1.0 for positive, 0.0 for negative) * `comment`: Optional text comment explaining the rating **Response:** Returns a success status confirming the rating was recorded in Langfuse. **Permissions:** Self-access: Users can rate messages in their own chats. Admin access: CHATS\_WRITE scope required to rate other members' chat messages. **Error Responses:** * `400 Bad Request`: Message is not an assistant message or integrity check failed * `401 Unauthorized`: Missing or invalid authentication * `403 Forbidden`: User does not have permission to rate messages in this chat * `404 Not Found`: Chat or message not found * `500 Internal Server Error`: Failed to record rating in Langfuse **Related Endpoints:** * `GET /chats/{chat_id}/messages` - Get chat messages to rate * `POST /chats/{chat_id}/send-assistant-message` - Send assistant messages **Authentication:** Requires workspace member **Parameters:** * `chat_id` (int | str) * `message_uuid` (String) * `rating_data` (RateMessageRequest) *** ### Messages[​](#messages-3 "Direct link to Messages") **`GET /api/v2/w/{workspace_uuid}/chats/{chat_id}/tool-calls/{call_id}/messages`** **Description:** Chat message operations Get messages from a specific tool call execution. Retrieves the detailed message history from a tool call's ReACT loop execution. This includes sub-agent messages, tool invocations, and results from custom tools that run their own conversation loops. **Path Parameters:** * `id`: Chat ID containing the tool call * `call_id`: Tool call ID to retrieve messages from **Query Parameters:** * `limit`: Maximum number of messages to return (1-1000, default: 100) * `offset`: Number of messages to skip for pagination (default: 0) **Response:** Returns an array of OpenAIMessageResponse objects representing the internal conversation flow within the tool execution, useful for debugging and transparency. **Permissions:** Self-access: Users can view tool call messages in their own chats. Admin access: CHATS\_READ scope required to view other members' chat messages. **Error Responses:** * `401 Unauthorized`: Missing or invalid authentication * `403 Forbidden`: User does not have permission to view this chat * `404 Not Found`: Chat or tool call not found **Related Endpoints:** * `GET /chats/{chat_id}/messages` - Get main chat messages * `GET /chats/{chat_id}/tools` - Get available tools for chat **Authentication:** Requires workspace member **Parameters:** * `chat_id` (int | str) * `call_id` (String) * `limit` (Integer) * `offset` (Integer) **Response:** List of [OpenAIMessageResponse](#open-ai-message-response) *** --- # Workspace.Chats.Stats **Tags:** `chat`, `communication`, `messaging` ## Endpoints[​](#endpoints "Direct link to Endpoints") * [`GET /export`](#get-export) - Export * [`GET /needs-response`](#get-needs-response) - Needs Response * [`GET /stats/daily-creation`](#get-stats-daily-creation) - Daily Creation * [`GET /tool-call-names`](#get-tool-call-names) - Tool Call Names ### Export[​](#export "Direct link to Export") **`GET /api/v2/w/{workspace_uuid}/chats/export`** **Description:** Chat statistics and exports Export chats as CSV with filtering applied. Exports all chats matching the current filters to a CSV file. Respects the same filtering parameters as the list\_chats endpoint but returns all matching results (not paginated). Useful for bulk analysis, reporting, and integration with external tools. **Query Parameters:** All the same filtering parameters as `GET /chats`: * `sortBy`, `sortOrder`: Sort order for consistent output * `mine`, `archived`, `needsResponse`, `paused`: Status filters * `channel`, `chatType`, `memberId`, `assistantMemberId`: Type and participant filters * `search`: Text search across chat content and metadata * `isTest`: Filter test chats * `isAnonymous`: Filter by anonymous owner chats (true = anonymous only, requires CHATS\_ADMIN) * `filters`: JSON-encoded advanced filter rules * `createdAfter`: ISO-8601 timestamp with timezone offset — only export chats created on or after this instant * `createdBefore`: ISO-8601 timestamp with timezone offset — only export chats created on or before this instant **Response:** Returns a CSV file with chat data including metadata, participants, and status. **Permissions:** Requires `chats:read` scope. Members without this scope cannot bulk-export chats. Filtering to anonymous chats (`isAnonymous=true`) additionally requires `chats:admin`. **Authorization:** Requires `chats:read` scope **Parameters:** * `sortBy` (ChatSortField) * `sortOrder` (SortOrder) * `mine` (Boolean) * `archived` (Boolean) * `needsResponse` (Boolean) * `paused` (Boolean) * `channel` (String) * `chatType` (String) * `memberId` (Integer) * `search` (String) * `filters` (String) * `isTest` (Boolean) * `isAnonymous` (Boolean) * `assistantMemberId` (Integer) * `createdAfter` (datetime) * `createdBefore` (datetime) *** ### Needs Response[​](#needs-response "Direct link to Needs Response") **`GET /api/v2/w/{workspace_uuid}/chats/needs-response`** **Description:** Chat statistics and exports Get IDs of chats that need a response. Returns a lightweight list of chat IDs that require attention from the workspace team. Only includes non-archived, non-muted chats with the needs\_response flag set to true. Useful for dashboard notifications and task management workflows. **Response:** Returns an array of chat IDs (integers) that need responses. Empty array if none found. **Permissions:** Self-access: Users see their own chats needing response. Admin access: CHATS\_READ scope required to see all chats needing response. **Authentication:** Requires workspace member **Response:** List of [int](#int) *** ### Daily Creation[​](#daily-creation "Direct link to Daily Creation") **`GET /api/v2/w/{workspace_uuid}/chats/stats/daily-creation`** **Description:** Chat statistics and exports Get daily chat creation statistics for the last 30 days. Returns aggregated chat creation counts grouped by date and chat type for the past 30 days. This data is useful for visualizing chat activity trends and patterns by type. **Query Parameters:** * `archived`: Filter by archived status (true/false, default: excludes archived) * `isTest`: Filter by test status (true/false, default: excludes test chats) **Response:** Returns a dictionary with `dailyStats` array containing objects with: * `date`: YYYY-MM-DD format * `count`: total chat count * `assignment`, `manager`, `dm`, `testing`: breakdown by type **Permissions:** * Admin users see all workspace chats * Regular users see only their own chats **Authentication:** Requires workspace member **Parameters:** * `archived` (Boolean) * `isTest` (Boolean) *** ### Tool Call Names[​](#tool-call-names "Direct link to Tool Call Names") **`GET /api/v2/w/{workspace_uuid}/chats/tool-call-names`** **Description:** Chat statistics and exports Get distinct tool call names used across workspace chats. Returns an alphabetically sorted list of unique tool call names from all messages in the workspace. Useful for populating filter dropdowns. **Permissions:** * Admin users see tool calls from all workspace chats * Regular users see tool calls only from their own chats **Authentication:** Requires workspace member **Response:** List of [str](#str) *** --- # Workspace.Chats.Usage **Tags:** `chat`, `communication`, `messaging` ## Endpoints[​](#endpoints "Direct link to Endpoints") * [`GET /{chat_id}/token-usage`](#get-chat-id-token-usage) - Token Usage ### Token Usage[​](#token-usage "Direct link to Token Usage") **`GET /api/v2/w/{workspace_uuid}/chats/{chat_id}/token-usage`** **Description:** Chat usage information Get aggregated token usage statistics for a specific chat. Returns the total prompt tokens, completion tokens, total tokens, cached tokens, and credits used by all messages in this chat, including STT and TTS usage from voice calls. **Path Parameters:** * `chat_id`: Chat ID to retrieve token usage for **Response:** Returns a ChatTokenUsageResponse with aggregated token counts and credits. **Permissions:** Self-access: Users can view token usage for their own chats. Admin access: CHATS\_READ scope required to view other members' chat usage. **Error Responses:** * `401 Unauthorized`: Missing or invalid authentication * `403 Forbidden`: User does not have permission to view this chat * `404 Not Found`: Chat not found **Authentication:** Requires workspace member **Parameters:** * `chat_id` (Integer) **Response:** See [ChatTokenUsageResponse](#chat-token-usage-response) *** --- # Workspace.Chats.Voice **Tags:** `chat`, `communication`, `messaging`, `voice` ## Endpoints[​](#endpoints "Direct link to Endpoints") * [`POST /{chat_id}/outbound-call`](#post-chat-id-outbound-call) - Outbound Call * [`GET /{chat_id}/phone-calls`](#get-chat-id-phone-calls) - Phone Calls ### Outbound Call[​](#outbound-call "Direct link to Outbound Call") **`POST /api/v2/w/{workspace_uuid}/chats/{chat_id}/outbound-call`** **Description:** Voice chat functionality Initiate an outbound phone call for a chat. Starts an outbound voice call from the assistant to the chat participant using Twilio. The call will be connected to the workspace's configured phone number and handled by the chat's assigned assistant with real-time audio streaming. **Path Parameters:** * `chat_id`: Chat ID to initiate the call for **Request Body:** * `phoneNumberId`: ID of the workspace phone number to use for the outbound call **Response:** Returns a status object confirming the call was initiated successfully. **Permissions:** Requires workspace management permissions and sufficient phone call budget. **Error Responses:** * `400 Bad Request`: Invalid phone number ID or chat configuration * `401 Unauthorized`: Missing or invalid authentication * `403 Forbidden`: Insufficient permissions or exceeded budget limits * `404 Not Found`: Chat or phone number not found * `500 Internal Server Error`: Failed to initiate call with Twilio **Related Endpoints:** * `GET /chats/{id}` - Get chat details * `POST /chats` - Create a new chat for phone conversations **Authorization:** Requires `phones:write` scope **Parameters:** * `chat_id` (Integer) * `request` - See [OutboundCallRequest](#outbound-call-request) **Response:** See [OutboundDialResult](#outbound-dial-result) *** ### Phone Calls[​](#phone-calls "Direct link to Phone Calls") **`GET /api/v2/w/{workspace_uuid}/chats/{chat_id}/phone-calls`** **Description:** Voice chat functionality Get phone calls associated with a chat. Returns all phone calls linked to the given chat, ordered by most recent first. Used by the chat detail view to display call termination information. **Authorization:** Requires `chats:read` scope **Parameters:** * `chat_id` (Integer) **Response:** List of [PhoneCallResponse](#phone-call-response) *** --- # Custom Toolkits **Tags:** `ai`, `customization`, `tools` ## Endpoints[​](#endpoints "Direct link to Endpoints") * [`GET `](#get)- List * [`POST `](#post)- Create * [`DELETE /{toolkit_id}`](#delete-toolkit-id) - Delete Toolkit Id * [`GET /{toolkit_id}`](#get-toolkit-id) - Get Toolkit Id * [`PUT /{toolkit_id}`](#put-toolkit-id) - Update Toolkit Id * [`POST /{toolkit_id}/disable`](#post-toolkit-id-disable) - Disable * [`POST /{toolkit_id}/enable`](#post-toolkit-id-enable) - Enable ### List[​](#list "Direct link to List") **`GET /api/v2/w/{workspace_uuid}/custom-toolkits`** **Description:** Custom AI toolkit creation and management List all custom toolkits the current member has access to. **Authorization:** Requires `apps:read` scope **Response:** List of [CustomToolkitResponse](#custom-toolkit-response) *** ### Create[​](#create "Direct link to Create") **`POST /api/v2/w/{workspace_uuid}/custom-toolkits`** **Description:** Custom AI toolkit creation and management Create a new custom toolkit. **Authorization:** Requires `apps:write` scope **Parameters:** * `data` - See [CustomToolkitCreateRequest](#custom-toolkit-create-request) **Response:** See [CustomToolkitResponse](#custom-toolkit-response) *** ### Delete Toolkit Id[​](#delete-toolkit-id "Direct link to Delete Toolkit Id") **`DELETE /api/v2/w/{workspace_uuid}/custom-toolkits/{toolkit_id}`** **Description:** Custom AI toolkit creation and management Delete a custom toolkit. **Authorization:** Requires `apps:admin` scope **Parameters:** * `toolkit_id` (Integer) *** ### Get Toolkit Id[​](#get-toolkit-id "Direct link to Get Toolkit Id") **`GET /api/v2/w/{workspace_uuid}/custom-toolkits/{toolkit_id}`** **Description:** Custom AI toolkit creation and management Get a specific custom toolkit by ID. **Authorization:** Requires `apps:read` scope **Parameters:** * `toolkit_id` (Integer) **Response:** See [CustomToolkitResponse](#custom-toolkit-response) *** ### Update Toolkit Id[​](#update-toolkit-id "Direct link to Update Toolkit Id") **`PUT /api/v2/w/{workspace_uuid}/custom-toolkits/{toolkit_id}`** **Description:** Custom AI toolkit creation and management Update a custom toolkit. **Authorization:** Requires `apps:write` scope **Parameters:** * `toolkit_id` (Integer) * `data` - See [CustomToolkitUpdateRequest](#custom-toolkit-update-request) **Response:** See [CustomToolkitResponse](#custom-toolkit-response) *** ### Disable[​](#disable "Direct link to Disable") **`POST /api/v2/w/{workspace_uuid}/custom-toolkits/{toolkit_id}/disable`** **Description:** Custom AI toolkit creation and management Disable a custom toolkit. **Authorization:** Requires `apps:write` scope **Parameters:** * `toolkit_id` (Integer) **Response:** See [CustomToolkitResponse](#custom-toolkit-response) *** ### Enable[​](#enable "Direct link to Enable") **`POST /api/v2/w/{workspace_uuid}/custom-toolkits/{toolkit_id}/enable`** **Description:** Custom AI toolkit creation and management Enable a custom toolkit. **Authorization:** Requires `apps:write` scope **Parameters:** * `toolkit_id` (Integer) **Response:** See [CustomToolkitResponse](#custom-toolkit-response) *** --- # Data Records **Tags:** `data`, `records` ## Endpoints[​](#endpoints "Direct link to Endpoints") * [`GET /member-record-counts`](#get-member-record-counts) - Member Record Counts * [`POST /{data_type_id}/records`](#post-data-type-id-records) - Records * [`DELETE /{data_type_id}/records/{record_id}`](#delete-data-type-id-records-record-id) - Delete Records * [`PUT /{data_type_id}/records/{record_id}`](#put-data-type-id-records-record-id) - Update Records ### Member Record Counts[​](#member-record-counts "Direct link to Member Record Counts") **`GET /api/v2/w/{workspace_uuid}/data-types/member-record-counts`** **Description:** Structured data record CRUD within a data type Get record counts per data type for a specific member. Returns the number of records each data type has for the specified member. This is more efficient than querying each data type individually. **Query Parameters:** * `member_id`: The member ID to get record counts for **Response:** Returns an object with `counts` mapping data type IDs to record counts. **Permissions:** Self-access: Any authenticated member can query their own record counts. Cross-member access: Only returns counts for data types where the caller has `list_all` permission (same model used by other record read endpoints). **Error Responses:** * `401 Unauthorized`: Missing or invalid authentication **Authorization:** Requires `datatypes:read` scope **Parameters:** * `member_id` (Integer) **Response:** See [MemberRecordCountsResponse](#member-record-counts-response) *** ### Records[​](#records "Direct link to Records") **`POST /api/v2/w/{workspace_uuid}/data-types/{data_type_id}/records`** **Description:** Structured data record CRUD within a data type Create a new record for a data type. Creates a new data record instance with field values conforming to the data type's schema. Field values are validated against the schema's type and validation rules before creation. **Path Parameters:** * `data_type_id`: Data type ID to create a record for **Request Body:** * `fieldValues`: Object mapping field slugs to values * `memberId`: Optional member ID to associate with the record * `externalId`: Optional external system identifier * `assignmentTaskId`: Optional assignment task ID linkage **Response:** Returns the created DataRecordResponse object with all field values and metadata. **Permissions:** Self-access: Users can create their own records (memberId = self). Admin access: RECORDS\_WRITE scope required to create records for other members. **Error Responses:** * `400 Bad Request`: Invalid field values or validation error * `401 Unauthorized`: Missing or invalid authentication * `403 Forbidden`: User lacks create permission for this data type * `404 Not Found`: Data type not found **Related Endpoints:** * `GET /data-types/{id}/records` - List all records * `POST /data-types/{id}/upsert/{external_id}` - Create or update by external ID * `PUT /data-types/{id}/records/{record_id}` - Update a record **Authentication:** Requires workspace member **Parameters:** * `data_type_id` (Integer) * `record` (CreateDataRecordRequest) **Response:** See [DataRecordResponse](#data-record-response) *** ### Delete Records[​](#delete-records "Direct link to Delete Records") **`DELETE /api/v2/w/{workspace_uuid}/data-types/{data_type_id}/records/{record_id}`** **Description:** Structured data record CRUD within a data type Permanently delete a data record. Removes a data record and its audit trail from the database. This operation is irreversible. The record and all its change history will be permanently deleted. **Path Parameters:** * `data_type_id`: Data type ID the record belongs to * `record_id`: Record ID to delete **Response:** Returns a status object with "deleted" confirmation. **Permissions:** Requires delete permission for the data type or record member access. **Error Responses:** * `401 Unauthorized`: Missing or invalid authentication * `403 Forbidden`: User lacks delete permission * `404 Not Found`: Record not found **Related Endpoints:** * `GET /data-types/{data_type_id}/records/{record_id}` - View record before deletion * `GET /data-types/{data_type_id}/records` - List remaining records **Authorization:** Requires `records:admin` scope **Parameters:** * `data_type_id` (Integer) * `record_id` (Integer) *** ### Update Records[​](#update-records "Direct link to Update Records") **`PUT /api/v2/w/{workspace_uuid}/data-types/{data_type_id}/records/{record_id}`** **Description:** Structured data record CRUD within a data type Update an existing data record. Modifies field values in a data record, creating an audit trail entry for the change. Only specified fields are updated; omitted fields retain their current values. Values are validated against the data type's schema. **Path Parameters:** * `data_type_id`: Data type ID the record belongs to * `record_id`: Record ID to update **Request Body:** * `fieldValues`: Object mapping field slugs to new values (partial updates supported) **Response:** Returns the updated DataRecordResponse object with all current field values. **Permissions:** Self-access: Users can update records where they are the member. Admin access: RECORDS\_WRITE scope required to update other members' records. **Error Responses:** * `400 Bad Request`: Invalid field values or validation error * `401 Unauthorized`: Missing or invalid authentication * `403 Forbidden`: User lacks write permission * `404 Not Found`: Record not found **Related Endpoints:** * `GET /data-types/{data_type_id}/records/{record_id}` - Get current record state * `GET /data-types/{data_type_id}/records/{record_id}/changes` - View update history * `DELETE /data-types/{data_type_id}/records/{record_id}` - Delete the record **Authentication:** Requires workspace member **Parameters:** * `data_type_id` (Integer) * `record_id` (Integer) * `record_update` (UpdateDataRecordRequest) **Response:** See [DataRecordResponse](#data-record-response) *** --- # Data Types **Tags:** `collections`, `data` ## Endpoints[​](#endpoints "Direct link to Endpoints") * [`GET `](#get)- List * [`POST `](#post)- Create * [`GET /slug/{slug}`](#get-slug-slug) - Slug * [`POST /validate-slug`](#post-validate-slug) - Validate Slug * [`DELETE /{data_type_id}`](#delete-data-type-id) - Delete Data Type Id * [`GET /{data_type_id}`](#get-data-type-id) - Get Data Type Id * [`PUT /{data_type_id}`](#put-data-type-id) - Update Data Type Id ### List[​](#list "Direct link to List") **`GET /api/v2/w/{workspace_uuid}/data-types`** **Description:** Custom data type management List all data types in the workspace. Retrieves all custom data type definitions created in the workspace, including their field schemas, record counts, and configuration. Data types define structured data models that can be used to store and organize workspace information. **Query Parameters:** * `archived`: Filter by archived status (boolean, default: false) **Response:** Returns an array of DataTypeResponse objects, each containing the data type's ID, name, slug, description, fields (with types and validation rules), and record count. **Permissions:** Requires authenticated member session. All workspace members can list data types. **Error Responses:** * `401 Unauthorized`: Missing or invalid authentication **Related Endpoints:** * `POST /data-types` - Create a new data type * `GET /data-types/{data_type_id}` - Get a specific data type * `GET /data-types/{data_type_id}/records` - List records for a data type **Authorization:** Requires `datatypes:read` scope **Parameters:** * `archived` (Boolean) * `sortBy` (DataTypeSortField) * `sortOrder` (SortOrder) **Response:** List of [DataTypeResponse](#data-type-response) *** ### Create[​](#create "Direct link to Create") **`POST /api/v2/w/{workspace_uuid}/data-types`** **Description:** Custom data type management Create a new custom data type. Defines a new structured data model in the workspace with custom fields and validation rules. Data types can represent any entity (customers, products, tickets, etc.) and are used by assistants to store and retrieve structured information. **Request Body:** * `name`: Display name for the data type * `slug`: URL-friendly identifier (auto-generated if not provided) * `description`: Optional description of the data type's purpose * `fields`: Array of field definitions with name, type, validation, and indexing options **Response:** Returns the created DataTypeResponse object with all field definitions and configuration. **Permissions:** Requires appropriate admin scope to create data types. **Error Responses:** * `400 Bad Request`: Invalid request parameters or duplicate slug * `401 Unauthorized`: Missing or invalid authentication * `403 Forbidden`: User lacks appropriate admin scope * `500 Internal Server Error`: Database error during creation **Related Endpoints:** * `GET /data-types` - List all data types * `PUT /data-types/{data_type_id}` - Update data type definition * `POST /data-types/{data_type_id}/records` - Create records of this type **Authorization:** Requires `datatypes:write` scope **Parameters:** * `data_type` (CreateDataTypeRequest) **Response:** See [DataTypeResponse](#data-type-response) *** ### Slug[​](#slug "Direct link to Slug") **`GET /api/v2/w/{workspace_uuid}/data-types/slug/{slug}`** **Description:** Custom data type management Get a data type by its slug identifier. Retrieves complete data type details using its URL-friendly slug identifier. Returns the full schema including all field definitions, types, and validation rules. **Path Parameters:** * `slug`: URL-friendly slug identifier for the data type **Response:** Returns a DataTypeResponse object with complete field schema and configuration. **Permissions:** Requires authenticated member session. **Error Responses:** * `401 Unauthorized`: Missing or invalid authentication * `404 Not Found`: Data type with specified slug not found **Related Endpoints:** * `GET /data-types/{data_type_id}` - Get data type by numeric ID * `GET /data-types` - List all data types * `GET /data-types/{data_type_id}/records` - Get records for this data type **Authorization:** Requires `datatypes:read` scope **Parameters:** * `slug` (String) **Response:** See [DataTypeResponse](#data-type-response) *** ### Validate Slug[​](#validate-slug "Direct link to Validate Slug") **`POST /api/v2/w/{workspace_uuid}/data-types/validate-slug`** **Description:** Custom data type management Validate if a data type slug is available. Checks if the given slug conflicts with existing data types and suggests a unique alternative if needed. **Request Body:** * `slug`: The slug to validate * `excludeId`: Optional data type ID to exclude (for updates) **Response:** * `available`: Whether the slug is available * `suggestedSlug`: A suggested unique slug if the original is taken **Permissions:** Requires valid workspace membership. **Authorization:** Requires `datatypes:write` scope **Parameters:** * `request` - See [ValidateSlugRequest](#validate-slug-request) **Response:** See [ValidateSlugResponse](#validate-slug-response) *** ### Delete Data Type Id[​](#delete-data-type-id "Direct link to Delete Data Type Id") **`DELETE /api/v2/w/{workspace_uuid}/data-types/{data_type_id}`** **Description:** Custom data type management Permanently delete a data type and all its records. Removes a data type definition along with all associated records and field indexes. This operation is irreversible and will delete all data stored in records of this type. Field indexes are removed via background tasks. **Path Parameters:** * `id`: Data type ID to delete **Response:** Returns a status object with "deleted" confirmation. **Permissions:** Requires appropriate admin scope to delete data types. **Error Responses:** * `401 Unauthorized`: Missing or invalid authentication * `403 Forbidden`: User lacks appropriate admin scope * `404 Not Found`: Data type not found * `500 Internal Server Error`: Database error during deletion **Related Endpoints:** * `GET /data-types` - List remaining data types * `POST /data-types/{data_type_id}/export` - Export data before deletion * `GET /data-types/{data_type_id}/records` - View records that will be deleted **Authorization:** Requires `datatypes:admin` scope **Parameters:** * `data_type_id` (Integer) *** ### Get Data Type Id[​](#get-data-type-id "Direct link to Get Data Type Id") **`GET /api/v2/w/{workspace_uuid}/data-types/{data_type_id}`** **Description:** Custom data type management Get detailed information about a specific data type. Retrieves complete data type configuration including all field definitions, record count, and metadata. Includes field types, validation rules, and indexing status. This endpoint accepts either the numeric data type ID or stable UUID. **Path Parameters:** * `data_type_id`: Data type numeric ID or UUID to retrieve **Response:** Returns a DataTypeResponse object with complete field schema, record count, and all configuration details. **Permissions:** Requires authenticated member session. **Error Responses:** * `401 Unauthorized`: Missing or invalid authentication * `404 Not Found`: Data type not found **Related Endpoints:** * `GET /data-types/slug/{slug}` - Get data type by slug * `PUT /data-types/{data_type_id}` - Update data type * `GET /data-types/{data_type_id}/records` - List records for this data type **Authorization:** Requires `datatypes:read` scope **Parameters:** * `data_type_id` (String) **Response:** See [DataTypeResponse](#data-type-response) *** ### Update Data Type Id[​](#update-data-type-id "Direct link to Update Data Type Id") **`PUT /api/v2/w/{workspace_uuid}/data-types/{data_type_id}`** **Description:** Custom data type management Update an existing data type definition. Modifies a data type's metadata, field definitions, or configuration. Can add new fields, update field properties, or modify validation rules. Existing records are preserved and automatically adapt to schema changes. **Path Parameters:** * `id`: Data type ID to update **Request Body:** * `name`: Updated display name (optional) * `description`: Updated description (optional) * `fields`: Updated field definitions array (optional) **Response:** Returns the updated DataTypeResponse object with refreshed schema and configuration. **Permissions:** Requires appropriate admin scope to update data types. **Error Responses:** * `400 Bad Request`: Invalid update parameters or validation error * `401 Unauthorized`: Missing or invalid authentication * `403 Forbidden`: User lacks appropriate admin scope * `404 Not Found`: Data type not found * `500 Internal Server Error`: Database error during update **Related Endpoints:** * `GET /data-types/{data_type_id}` - Get current data type definition * `DELETE /data-types/{data_type_id}` - Delete the data type * `GET /data-types/{data_type_id}/records` - View records affected by schema changes **Authorization:** Requires `datatypes:write` scope **Parameters:** * `data_type_id` (Integer) * `data_type` (UpdateDataTypeRequest) **Response:** See [DataTypeResponse](#data-type-response) *** --- # Event Rules **Tags:** `automation`, `events`, `rules` ## Endpoints[​](#endpoints "Direct link to Endpoints") * [`GET `](#get)- List * [`POST `](#post)- Create * [`GET /actions/available`](#get-actions-available) - Available * [`GET /executions`](#get-executions) - Executions * [`POST /reorder`](#post-reorder) - Reorder * [`GET /search`](#get-search) - Search * [`DELETE /{event_rule_id}`](#delete-event-rule-id) - Delete Event Rule Id * [`GET /{event_rule_id}`](#get-event-rule-id) - Get Event Rule Id * [`PUT /{event_rule_id}`](#put-event-rule-id) - Update Event Rule Id * [`POST /{event_rule_id}/reset-cel-block`](#post-event-rule-id-reset-cel-block) - Reset Cel Block * [`POST /{event_rule_id}/test-webhook`](#post-event-rule-id-test-webhook) - Test Webhook ### List[​](#list "Direct link to List") **`GET /api/v2/w/{workspace_uuid}/event-rules`** **Description:** Event-driven automation rules List all event rules, paginated. Requires `automations:read` scope. **Authorization:** Requires `automations:read` scope **Parameters:** * `page` (Integer) * `pageSize` (Integer) **Response:** See [PaginatedResponse\[EventRuleResponse\]](#paginated-response%5B-event-rule-response%5D) *** ### Create[​](#create "Direct link to Create") **`POST /api/v2/w/{workspace_uuid}/event-rules`** **Description:** Event-driven automation rules Create a new event rule. Requires `automations:admin` scope. **Authorization:** Requires `automations:admin` scope **Parameters:** * `request` - See [CreateEventRuleRequest](#create-event-rule-request) **Response:** See [EventRuleResponse](#event-rule-response) *** ### Available[​](#available "Direct link to Available") **`GET /api/v2/w/{workspace_uuid}/event-rules/actions/available`** **Description:** Event-driven automation rules Get all available event-action mappings. Returns a list of event types and their valid action types. This endpoint provides the validation rules for frontend to use. **Authorization:** Requires `automations:read` scope **Response:** See [EventActionMappingsResponse](#event-action-mappings-response) *** ### Executions[​](#executions "Direct link to Executions") **`GET /api/v2/w/{workspace_uuid}/event-rules/executions`** **Description:** Event-driven automation rules List all rule executions for the workspace with cursor-based pagination. Requires `automations:read` scope. **Authorization:** Requires `automations:read` scope **Parameters:** * `cursor` (String) * `pageSize` (Integer) * `sortBy` (ExecutionSortField) * `sortOrder` (SortOrder) * `ruleId` (Integer) * `status` (String) * `triggerType` (String) * `actionSlug` (String) * `objectType` (EventRuleObjectType) * `eventType` (EventRuleEventType) * `actionType` (EventRuleActionType) * `workflowId` (Integer) **Response:** See [CursorPaginatedResponse\[RuleExecutionResponse\]](#cursor-paginated-response%5B-rule-execution-response%5D) *** ### Reorder[​](#reorder "Direct link to Reorder") **`POST /api/v2/w/{workspace_uuid}/event-rules/reorder`** **Description:** Event-driven automation rules Reorder event rules by updating their order field based on the provided list of IDs. Requires `automations:admin` scope. **Authorization:** Requires `automations:admin` scope **Parameters:** * `rule_ids` (Array) *** ### Search[​](#search "Direct link to Search") **`GET /api/v2/w/{workspace_uuid}/event-rules/search`** **Description:** Event-driven automation rules Search for event rules matching the given criteria. Requires `automations:read` scope. **Authorization:** Requires `automations:read` scope **Parameters:** * `objectType` (EventRuleObjectType) * `eventType` (EventRuleEventType) * `actionType` (EventRuleActionType) * `taskId` (Integer) * `dataTypeId` (Integer) * `routineId` (Integer) * `workflowId` (Integer) * `calendarId` (Integer) * `calendarEventTypeId` (Integer) * `journeyStepId` (Integer) * `includeDisabled` (Boolean) **Response:** List of [EventRuleResponse](#event-rule-response) *** ### Delete Event Rule Id[​](#delete-event-rule-id "Direct link to Delete Event Rule Id") **`DELETE /api/v2/w/{workspace_uuid}/event-rules/{event_rule_id}`** **Description:** Event-driven automation rules Delete an event rule. Requires `automations:admin` scope. **Authorization:** Requires `automations:admin` scope **Parameters:** * `event_rule_id` (Integer) *** ### Get Event Rule Id[​](#get-event-rule-id "Direct link to Get Event Rule Id") **`GET /api/v2/w/{workspace_uuid}/event-rules/{event_rule_id}`** **Description:** Event-driven automation rules Get a specific event rule by ID. Requires `automations:read` scope. **Authorization:** Requires `automations:read` scope **Parameters:** * `event_rule_id` (Integer) **Response:** See [EventRuleResponse](#event-rule-response) *** ### Update Event Rule Id[​](#update-event-rule-id "Direct link to Update Event Rule Id") **`PUT /api/v2/w/{workspace_uuid}/event-rules/{event_rule_id}`** **Description:** Event-driven automation rules Update an existing event rule. Requires `automations:admin` scope. **Authorization:** Requires `automations:admin` scope **Parameters:** * `event_rule_id` (Integer) * `request` - See [UpdateEventRuleRequest](#update-event-rule-request) **Response:** See [EventRuleResponse](#event-rule-response) *** ### Reset Cel Block[​](#reset-cel-block "Direct link to Reset Cel Block") **`POST /api/v2/w/{workspace_uuid}/event-rules/{event_rule_id}/reset-cel-block`** **Description:** Event-driven automation rules Clear the cel\_blocked\_at circuit-breaker flag on an event rule. When a rule's CEL condition fails N consecutive times the circuit breaker trips: `cel_blocked_at` is set and evaluation is skipped. Call this endpoint after saving a corrected expression, or to manually re-enable a rule that was blocked by a transient error. Requires `automations:admin` scope. **Authorization:** Requires `automations:admin` scope **Parameters:** * `event_rule_id` (Integer) **Response:** See [EventRuleResponse](#event-rule-response) *** ### Test Webhook[​](#test-webhook "Direct link to Test Webhook") **`POST /api/v2/w/{workspace_uuid}/event-rules/{event_rule_id}/test-webhook`** **Description:** Event-driven automation rules Send a one-off test webhook without updating rule health or webhook logs. **Authorization:** Requires `automations:write` scope **Parameters:** * `event_rule_id` (Integer) * `request` - See [TestWebhookRequest](#test-webhook-request) **Response:** See [TestWebhookResponse](#test-webhook-response) *** --- # Files **Tags:** `files`, `storage` ## Endpoints[​](#endpoints "Direct link to Endpoints") * [`GET `](#get)- List * [`POST `](#post)- Create * [`POST /upload-url`](#post-upload-url) - Upload Url * [`GET /{file_id}`](#get-file-id) - Get File Id * [`PUT /{file_id}`](#put-file-id) - Update File Id * [`POST /{file_id}/convert`](#post-file-id-convert) - Convert ### List[​](#list "Direct link to List") **`GET /api/v2/w/{workspace_uuid}/files`** **Description:** File upload and management List all files for the authenticated user. **Authorization:** Requires `files:read` scope **Parameters:** * `folder_id` (Integer) * `page` (Integer) * `pageSize` (Integer) * `sortBy` (FileSortField) * `sortOrder` (SortOrder) * `search` (String) **Response:** See [PaginatedResponse\[FileResponse\]](#paginated-response%5B-file-response%5D) *** ### Create[​](#create "Direct link to Create") **`POST /api/v2/w/{workspace_uuid}/files`** **Description:** File upload and management Create a new file. **Authorization:** Requires `files:write` scope **Parameters:** * `file` (CreateFileRequest) *** ### Upload Url[​](#upload-url "Direct link to Upload Url") **`POST /api/v2/w/{workspace_uuid}/files/upload-url`** **Description:** File upload and management Generate a presigned URL for uploading a file. **Authorization:** Requires `files:write` scope **Parameters:** * `file_request` (FileUploadRequest) **Response:** See [FileUploadResponse](#file-upload-response) *** ### Get File Id[​](#get-file-id "Direct link to Get File Id") **`GET /api/v2/w/{workspace_uuid}/files/{file_id}`** **Description:** File upload and management Get a specific file by ID. **Authorization:** Requires `files:read` scope **Parameters:** * `file_id` (Integer) *** ### Update File Id[​](#update-file-id "Direct link to Update File Id") **`PUT /api/v2/w/{workspace_uuid}/files/{file_id}`** **Description:** File upload and management Update an existing file. **Authorization:** Requires `files:write` scope **Parameters:** * `file_id` (Integer) * `file` (UpdateFileRequest) *** ### Convert[​](#convert "Direct link to Convert") **`POST /api/v2/w/{workspace_uuid}/files/{file_id}/convert`** **Description:** File upload and management Convert a file to various formats. Returns: A ConvertedFileResponse containing the converted content and file metadata. **Authorization:** Requires `files:read` scope **Parameters:** * `file_id` (Integer) * `format` (Literal\['text', 'markdown', 'pdf']) **Response:** See [ConvertedFileResponse](#converted-file-response) *** --- # Folders **Tags:** `files`, `organization`, `storage` ## Endpoints[​](#endpoints "Direct link to Endpoints") * [`GET `](#get)- List * [`POST `](#post)- Create * [`DELETE /{folder_id}`](#delete-folder-id) - Delete Folder Id * [`GET /{folder_id}`](#get-folder-id) - Get Folder Id * [`PUT /{folder_id}`](#put-folder-id) - Update Folder Id * [`POST /{folder_id}/reindex`](#post-folder-id-reindex) - Reindex * [`GET /{folder_id}/search`](#get-folder-id-search) - Search * [`GET /{folder_id}/sharing`](#get-folder-id-sharing) - Sharing * [`PUT /{folder_id}/sharing`](#put-folder-id-sharing) - Update Sharing * [`PUT /{folder_id}/sharing/roles`](#put-folder-id-sharing-roles) - Update Roles * [`DELETE /{folder_id}/sharing/roles/{member_role_id}`](#delete-folder-id-sharing-roles-member-role-id) - Delete Roles ### List[​](#list "Direct link to List") **`GET /api/v2/w/{workspace_uuid}/folders`** **Description:** File and document folder management List child folders of the given parent folder. **Authorization:** Requires `files:read` scope **Parameters:** * `parent_id` (Integer) **Response:** List of [FileFolderResponse](#file-folder-response) *** ### Create[​](#create "Direct link to Create") **`POST /api/v2/w/{workspace_uuid}/folders`** **Description:** File and document folder management Create a new folder. **Authorization:** Requires `files:write` scope **Parameters:** * `folder` (CreateFileFolderRequest) **Response:** See [FileFolderResponse](#file-folder-response) *** ### Delete Folder Id[​](#delete-folder-id "Direct link to Delete Folder Id") **`DELETE /api/v2/w/{workspace_uuid}/folders/{folder_id}`** **Description:** File and document folder management Delete a folder. Root folders (workspace root, member homes, site assets) cannot be deleted — only emptied. We check early to give a clear error and avoid cascade-deleting children. **Authorization:** Requires `files:admin` scope **Parameters:** * `folder_id` (Integer) *** ### Get Folder Id[​](#get-folder-id "Direct link to Get Folder Id") **`GET /api/v2/w/{workspace_uuid}/folders/{folder_id}`** **Description:** File and document folder management Get a specific folder by ID, including its children and files. **Authorization:** Requires `files:read` scope **Parameters:** * `folder_id` (Integer) **Response:** See [FileFolderResponse](#file-folder-response) *** ### Update Folder Id[​](#update-folder-id "Direct link to Update Folder Id") **`PUT /api/v2/w/{workspace_uuid}/folders/{folder_id}`** **Description:** File and document folder management Update an existing folder. **Authorization:** Requires `files:write` scope **Parameters:** * `folder_id` (Integer) * `folder` (UpdateFileFolderRequest) **Response:** See [FileFolderResponse](#file-folder-response) *** ### Reindex[​](#reindex "Direct link to Reindex") **`POST /api/v2/w/{workspace_uuid}/folders/{folder_id}/reindex`** **Description:** File and document folder management Trigger background reindexing of a folder with vector embeddings. This endpoint triggers background reindexing to: 1. Process all files in the folder 2. Generate vector embeddings for semantic search The indexing happens asynchronously. Check the folder's indexing timestamps to monitor progress. **Authorization:** Requires `files:write` scope **Parameters:** * `folder_id` (Integer) *** ### Search[​](#search "Direct link to Search") **`GET /api/v2/w/{workspace_uuid}/folders/{folder_id}/search`** **Description:** File and document folder management Search for documents in a folder using vector similarity. Args: id: The folder ID to search in query: The search query text top\_k: Number of results to return (default 5) ctx: The execution context Returns: List of search results with content snippets and metadata **Authorization:** Requires `files:read` scope **Parameters:** * `folder_id` (Integer) * `query` (String) * `top_k` (Integer) **Response:** List of [FolderSearchResultResponse](#folder-search-result-response) *** ### Sharing[​](#sharing "Direct link to Sharing") **`GET /api/v2/w/{workspace_uuid}/folders/{folder_id}/sharing`** **Description:** File and document folder management Get complete sharing state for a folder. **Authorization:** Requires `files:read` scope **Parameters:** * `folder_id` (Integer) **Response:** See [FolderSharingResponse](#folder-sharing-response) *** ### Update Sharing[​](#update-sharing "Direct link to Update Sharing") **`PUT /api/v2/w/{workspace_uuid}/folders/{folder_id}/sharing`** **Description:** File and document folder management Batch-update the complete sharing state for a folder in a single transaction. **Authorization:** Requires `files:write` scope **Parameters:** * `folder_id` (Integer) * `request` - See [UpdateFileSharingRequest](#update-file-sharing-request) **Response:** See [FolderSharingResponse](#folder-sharing-response) *** ### Update Roles[​](#update-roles "Direct link to Update Roles") **`PUT /api/v2/w/{workspace_uuid}/folders/{folder_id}/sharing/roles`** **Description:** File and document folder management Set role associations for a folder (replaces all). **Authorization:** Requires `files:write` scope **Parameters:** * `folder_id` (Integer) * `request` - See [UpdateFileRoleAssociationsRequest](#update-file-role-associations-request) **Response:** List of [FileRoleAssociationResponse](#file-role-association-response) *** ### Delete Roles[​](#delete-roles "Direct link to Delete Roles") **`DELETE /api/v2/w/{workspace_uuid}/folders/{folder_id}/sharing/roles/{member_role_id}`** **Description:** File and document folder management Remove a single role's access to a folder. **Authorization:** Requires `files:write` scope **Parameters:** * `folder_id` (Integer) * `member_role_id` (Integer) *** --- # Inboxes **Tags:** `communication`, `email`, `messaging` ## Endpoints[​](#endpoints "Direct link to Endpoints") * [`GET `](#get)- List * [`POST `](#post)- Create * [`DELETE /{inbox_id}`](#delete-inbox-id) - Delete Inbox Id * [`GET /{inbox_id}`](#get-inbox-id) - Get Inbox Id * [`PUT /{inbox_id}`](#put-inbox-id) - Update Inbox Id ### List[​](#list "Direct link to List") **`GET /api/v2/w/{workspace_uuid}/inboxes`** **Description:** Email inbox and message thread management List all inboxes that the current member has permissions to access. **Authorization:** Requires `inboxes:read` scope **Response:** See [InboxListResponse](#inbox-list-response) *** ### Create[​](#create "Direct link to Create") **`POST /api/v2/w/{workspace_uuid}/inboxes`** **Description:** Email inbox and message thread management Create a new inbox for the current member. Requires `inboxes:admin` scope. **Authorization:** Requires `inboxes:write` scope **Parameters:** * `request` - See [InboxCreateRequest](#inbox-create-request) **Response:** See [InboxResponse](#inbox-response) *** ### Delete Inbox Id[​](#delete-inbox-id "Direct link to Delete Inbox Id") **`DELETE /api/v2/w/{workspace_uuid}/inboxes/{inbox_id}`** **Description:** Email inbox and message thread management Delete an inbox and its global mapping by ID or UUID. Requires INBOXES\_ADMIN scope or being the owner. **Authorization:** Requires `inboxes:admin` scope **Parameters:** * `inbox_id` (String) *** ### Get Inbox Id[​](#get-inbox-id "Direct link to Get Inbox Id") **`GET /api/v2/w/{workspace_uuid}/inboxes/{inbox_id}`** **Description:** Email inbox and message thread management Get a specific inbox by ID or UUID. **Authorization:** Requires `inboxes:read` scope **Parameters:** * `inbox_id` (String) **Response:** See [InboxResponse](#inbox-response) *** ### Update Inbox Id[​](#update-inbox-id "Direct link to Update Inbox Id") **`PUT /api/v2/w/{workspace_uuid}/inboxes/{inbox_id}`** **Description:** Email inbox and message thread management Update an existing inbox by ID or UUID. Requires INBOXES\_WRITE scope and admin permission on the inbox. If `orgDomainUuid` is provided, the inbox's hosting domain is switched to the referenced verified OrgDomain — the same ownership + email-config validation used on create is applied, and the resulting email address becomes `@`. Omitting the field leaves the hosting domain unchanged (the inbox stays on whatever domain it was already on). **Authorization:** Requires `inboxes:write` scope **Parameters:** * `request` - See [InboxUpdateRequest](#inbox-update-request) * `inbox_id` (String) **Response:** See [InboxResponse](#inbox-response) *** --- # Journey Notes **Tags:** `journeys`, `notes` ## Endpoints[​](#endpoints "Direct link to Endpoints") * [`GET /{journey_id}/notes`](#get-journey-id-notes) - Notes * [`POST /{journey_id}/notes`](#post-journey-id-notes) - Notes * [`DELETE /{journey_id}/notes/{note_id}`](#delete-journey-id-notes-note-id) - Delete Notes * [`PUT /{journey_id}/notes/{note_id}`](#put-journey-id-notes-note-id) - Update Notes ### Notes[​](#notes "Direct link to Notes") **`GET /api/v2/w/{workspace_uuid}/journeys/{journey_id}/notes`** **Description:** Notes and annotations on member journeys List all notes for a specific journey. **Authorization:** Requires `journeys:read` scope **Parameters:** * `journey_id` (Integer) **Response:** List of [JourneyNoteResponse](#journey-note-response) *** ### Notes[​](#notes-1 "Direct link to Notes") **`POST /api/v2/w/{workspace_uuid}/journeys/{journey_id}/notes`** **Description:** Notes and annotations on member journeys Create a new note for a journey. **Authorization:** Requires `journeys:write` scope **Parameters:** * `journey_id` (Integer) * `request` - See [CreateJourneyNoteRequest](#create-journey-note-request) **Response:** See [JourneyNoteResponse](#journey-note-response) *** ### Delete Notes[​](#delete-notes "Direct link to Delete Notes") **`DELETE /api/v2/w/{workspace_uuid}/journeys/{journey_id}/notes/{note_id}`** **Description:** Notes and annotations on member journeys Delete a journey note. **Authorization:** Requires `journeys:admin` scope **Parameters:** * `journey_id` (Integer) * `note_id` (Integer) *** ### Update Notes[​](#update-notes "Direct link to Update Notes") **`PUT /api/v2/w/{workspace_uuid}/journeys/{journey_id}/notes/{note_id}`** **Description:** Notes and annotations on member journeys Update a journey note. **Authorization:** Requires `journeys:write` scope **Parameters:** * `journey_id` (Integer) * `note_id` (Integer) * `request` - See [UpdateJourneyNoteRequest](#update-journey-note-request) **Response:** See [JourneyNoteResponse](#journey-note-response) *** --- # Journeys **Tags:** `journeys`, `members` ## Endpoints[​](#endpoints "Direct link to Endpoints") * [`GET `](#get)- List * [`POST `](#post)- Create * [`DELETE /{journey_id}`](#delete-journey-id) - Delete Journey Id * [`GET /{journey_id}`](#get-journey-id) - Get Journey Id * [`PUT /{journey_id}`](#put-journey-id) - Update Journey Id * [`GET /{journey_id}/health`](#get-journey-id-health) - Health ### List[​](#list "Direct link to List") **`GET /api/v2/w/{workspace_uuid}/journeys`** **Description:** Member journey tracking and progression List all journeys, paginated. **Authorization:** Requires `journeys:read` scope **Parameters:** * `include_archived` (Boolean) * `sortBy` (JourneySortField) * `sortOrder` (SortOrder) * `page` (Integer) * `pageSize` (Integer) **Response:** See [PaginatedResponse\[JourneyResponse\]](#paginated-response%5B-journey-response%5D) *** ### Create[​](#create "Direct link to Create") **`POST /api/v2/w/{workspace_uuid}/journeys`** **Description:** Member journey tracking and progression Create a new journey. **Authorization:** Requires `journeys:write` scope **Parameters:** * `request` - See [CreateJourneyRequest](#create-journey-request) **Response:** See [JourneyResponse](#journey-response) *** ### Delete Journey Id[​](#delete-journey-id "Direct link to Delete Journey Id") **`DELETE /api/v2/w/{workspace_uuid}/journeys/{journey_id}`** **Description:** Member journey tracking and progression Archive a journey (soft delete). **Authorization:** Requires `journeys:admin` scope **Parameters:** * `journey_id` (Integer) *** ### Get Journey Id[​](#get-journey-id "Direct link to Get Journey Id") **`GET /api/v2/w/{workspace_uuid}/journeys/{journey_id}`** **Description:** Member journey tracking and progression Get a journey by ID with steps and goals. **Authorization:** Requires `journeys:read` scope **Parameters:** * `journey_id` (Integer) * `experimentId` (Integer) **Response:** See [JourneyResponse](#journey-response) *** ### Update Journey Id[​](#update-journey-id "Direct link to Update Journey Id") **`PUT /api/v2/w/{workspace_uuid}/journeys/{journey_id}`** **Description:** Member journey tracking and progression Update an existing journey. **Authorization:** Requires `journeys:write` scope **Parameters:** * `journey_id` (Integer) * `request` - See [UpdateJourneyRequest](#update-journey-request) **Response:** See [JourneyResponse](#journey-response) *** ### Health[​](#health "Direct link to Health") **`GET /api/v2/w/{workspace_uuid}/journeys/{journey_id}/health`** **Description:** Member journey tracking and progression Return Journey Health diagnostics — authoring issues + runtime failures. Authorization: requires `Scope.JOURNEYS_WRITE` because every primary action exposed by the Health UI mutates the journey (the edge editor for authoring issues; the same editor for runtime failures). Read-only viewers should not see the surface at all. PHI policy: the response carries only PHI-safe `AbilityConfigIssue` entries — IDs, operator-set names, counts, `error_type` strings, and timestamps. No CEL text, no exception messages, no Member data. **Authorization:** Requires `journeys:write` scope **Parameters:** * `journey_id` (Integer) **Response:** See [JourneyHealthResponse](#journey-health-response) *** --- # MCP Servers **Tags:** `ai`, `integrations`, `mcp` ## Endpoints[​](#endpoints "Direct link to Endpoints") * [`GET `](#get)- List * [`POST /oauth-discovery`](#post-oauth-discovery) - Oauth Discovery * [`DELETE /{server_id}`](#delete-server-id) - Delete Server Id * [`GET /{server_id}`](#get-server-id) - Get Server Id * [`POST /{server_id}/credentials`](#post-server-id-credentials) - Credentials * [`POST /{server_id}/disable`](#post-server-id-disable) - Disable * [`POST /{server_id}/enable`](#post-server-id-enable) - Enable * [`GET /{server_id}/icon`](#get-server-id-icon) - Icon * [`GET /{server_id}/members`](#get-server-id-members) - Members * [`GET /{server_id}/oauth/authorize`](#get-server-id-oauth-authorize) - Authorize * [`GET /{server_id}/prompts`](#get-server-id-prompts) - Prompts * [`GET /{server_id}/resources`](#get-server-id-resources) - Resources * [`POST /{server_id}/test`](#post-server-id-test) - Test * [`GET /{server_id}/tools`](#get-server-id-tools) - Tools ### List[​](#list "Direct link to List") **`GET /api/v2/w/{workspace_uuid}/mcp-servers`** **Description:** Model Context Protocol server management List all MCP servers the current member has access to. Tools are NOT included in the list response. Use GET /app-connections/mcp-servers/{id}/tools to fetch tools for a specific server. **Authorization:** Requires `apps:read` scope **Parameters:** * `sortBy` (McpServerSortField) * `sortOrder` (SortOrder) **Response:** List of [McpServerResponse](#mcp-server-response) *** ### Oauth Discovery[​](#oauth-discovery "Direct link to Oauth Discovery") **`POST /api/v2/w/{workspace_uuid}/mcp-servers/oauth-discovery`** **Description:** Model Context Protocol server management Discover OAuth metadata for a given server URL. **Authorization:** Requires `apps:write` scope **Parameters:** * `data` - See [OAuthDiscoveryRequest](#o-auth-discovery-request) **Response:** See [OAuthDiscoveryResponse](#o-auth-discovery-response) *** ### Delete Server Id[​](#delete-server-id "Direct link to Delete Server Id") **`DELETE /api/v2/w/{workspace_uuid}/mcp-servers/{server_id}`** **Description:** Model Context Protocol server management Delete an MCP server. **Authorization:** Requires `apps:admin` scope **Parameters:** * `server_id` (Integer) **Response:** See [dict](#dict) *** ### Get Server Id[​](#get-server-id "Direct link to Get Server Id") **`GET /api/v2/w/{workspace_uuid}/mcp-servers/{server_id}`** **Description:** Model Context Protocol server management Get a specific MCP server by ID. **Authorization:** Requires `apps:read` scope **Parameters:** * `server_id` (Integer) **Response:** See [McpServerResponse](#mcp-server-response) *** ### Credentials[​](#credentials "Direct link to Credentials") **`POST /api/v2/w/{workspace_uuid}/mcp-servers/{server_id}/credentials`** **Description:** Model Context Protocol server management Create a MemberCredential linking the current member to an MCP server. Used for direct\_auth servers where no OAuth tokens are needed — simply establishes the member-to-app\_connection link so the server recognises the member as authorised. **Authorization:** Requires `apps:write` scope **Parameters:** * `server_id` (Integer) **Response:** See [dict](#dict) *** ### Disable[​](#disable "Direct link to Disable") **`POST /api/v2/w/{workspace_uuid}/mcp-servers/{server_id}/disable`** **Description:** Model Context Protocol server management Disable an MCP server. Args: server\_id: The MCP server ID clear\_registration: If true, also clear OAuth registration info (client\_id, secret, etc.) **Authorization:** Requires `apps:write` scope **Parameters:** * `server_id` (Integer) * `clear_registration` (Boolean) **Response:** See [McpServerResponse](#mcp-server-response) *** ### Enable[​](#enable "Direct link to Enable") **`POST /api/v2/w/{workspace_uuid}/mcp-servers/{server_id}/enable`** **Description:** Model Context Protocol server management Enable an MCP server and test its connection. This endpoint handles the state transitions: * READY + enabled -> return current state (already active) * READY + disabled -> re-enable and return * REGISTER -> try to connect or determine next setup step * AUTHORIZE -> error (user needs to complete OAuth flow) **Authorization:** Requires `apps:write` scope **Parameters:** * `server_id` (Integer) **Response:** See [McpServerResponse](#mcp-server-response) *** ### Icon[​](#icon "Direct link to Icon") **`GET /api/v2/w/{workspace_uuid}/mcp-servers/{server_id}/icon`** **Description:** Model Context Protocol server management Get the favicon for an MCP server. Token-authenticated (HMAC) so the endpoint can be embedded in `` for the web UI. **Authentication:** Public endpoint (no authentication required) **Parameters:** * `server_id` (Integer) * `token` (String) *** ### Members[​](#members "Direct link to Members") **`GET /api/v2/w/{workspace_uuid}/mcp-servers/{server_id}/members`** **Description:** Model Context Protocol server management List all members who have connected to this MCP server. **Authorization:** Requires `apps:read` scope **Parameters:** * `server_id` (Integer) **Response:** List of [McpServerMemberResponse](#mcp-server-member-response) *** ### Authorize[​](#authorize "Direct link to Authorize") **`GET /api/v2/w/{workspace_uuid}/mcp-servers/{server_id}/oauth/authorize`** **Description:** Model Context Protocol server management Initiate OAuth authorization flow for an MCP server. This endpoint dynamically generates the OAuth authorization URL and redirects the client directly into the OAuth flow. The server must be in AUTH state. OAuth discovery and dynamic client registration may run when needed before redirecting. **Authorization:** Requires `apps:write` scope **Parameters:** * `server_id` (Integer) *** ### Prompts[​](#prompts "Direct link to Prompts") **`GET /api/v2/w/{workspace_uuid}/mcp-servers/{server_id}/prompts`** **Description:** Model Context Protocol server management Get the prompts for an MCP server. Returns 403 with a structured detail when the current user needs to authenticate before prompts can be fetched. OAuth tokens may be refreshed when connecting to the remote server. **Authorization:** Requires `apps:read` scope **Parameters:** * `server_id` (Integer) *** ### Resources[​](#resources "Direct link to Resources") **`GET /api/v2/w/{workspace_uuid}/mcp-servers/{server_id}/resources`** **Description:** Model Context Protocol server management Get the resources for an MCP server. Returns 403 with a structured detail when the current user needs to authenticate before resources can be fetched. OAuth tokens may be refreshed when connecting to the remote server. **Authorization:** Requires `apps:read` scope **Parameters:** * `server_id` (Integer) *** ### Test[​](#test "Direct link to Test") **`POST /api/v2/w/{workspace_uuid}/mcp-servers/{server_id}/test`** **Description:** Model Context Protocol server management Test an MCP server connection by performing an initialize handshake. A successful probe marks the server as ready and enabled. Returns success or failure with latency info. **Authorization:** Requires `apps:read` scope **Parameters:** * `server_id` (Integer) *** ### Tools[​](#tools "Direct link to Tools") **`GET /api/v2/w/{workspace_uuid}/mcp-servers/{server_id}/tools`** **Description:** Model Context Protocol server management Get the tools for an MCP server. Returns 403 with a structured detail when the current user needs to authenticate before tools can be fetched. The `detail` object contains `code`, `authType` and either `authorizeUrl` or `appUuid` so any client can prompt the user accordingly. OAuth tokens may be refreshed and tool definitions are fetched from the remote MCP server when listing tools. **Authorization:** Requires `apps:read` scope **Parameters:** * `server_id` (Integer) *** --- # Member Filters **Tags:** `filters`, `members`, `organization` ## Endpoints[​](#endpoints "Direct link to Endpoints") * [`PUT /{member_filter_id}/convert`](#put-member-filter-id-convert) - Update Convert ### Update Convert[​](#update-convert "Direct link to Update Convert") **`PUT /api/v2/w/{workspace_uuid}/member-filters/{member_filter_id}/convert`** **Description:** Saved member filters and search criteria Convert a legacy rules filter to a query-engine predicate. One-way. Adapts the filter's legacy rules to a single IR predicate (`adapt_member_rules`), runs strict save-time validation, stores the normalized predicate on `MemberFilter.query`, and deletes the legacy rule rows — all in one transaction, so the filter is never left half converted. There is intentionally no reverse operation: once a filter is query-format the legacy rule editor no longer applies to it. With `dryRun=true` the full validation chain runs (same 404/409/422/400 behavior) but nothing is persisted: the response carries the normalized predicate in `query` alongside the still-intact legacy `rules` so the client can preview the conversion reversibly. Rules the LEGACY engine itself ignores (empty operands — e.g. `name:partial` with an empty query) adapt to nothing and are skipped silently; they never block conversion because skipping them preserves the matched member set exactly. **Error Responses:** * `404 Not Found`: Filter does not exist * `409 Conflict`: Filter already has a query predicate (already converted, or authored in the Query builder) * `422 Unprocessable Entity`: Filter has no rules, or every rule is a legacy no-op so there is no predicate to store (detail lists `objectType:filterType` pairs — structure only, never rule values) * `400 Bad Request`: Adapted predicate fails engine save-time validation (mapped by the global domain exception handlers) **Authorization:** Requires `members:write` scope **Parameters:** * `member_filter_id` (Integer) * `dryRun` (Annotated\[bool, Query()]) **Response:** See [MemberFilterResponse](#member-filter-response) *** --- # Member Labels **Tags:** `labels`, `members`, `organization` ## Endpoints[​](#endpoints "Direct link to Endpoints") * [`GET `](#get)- List * [`POST `](#post)- Create * [`DELETE /{label_id}`](#delete-label-id) - Delete Label Id * [`GET /{label_id}`](#get-label-id) - Get Label Id * [`PUT /{label_id}`](#put-label-id) - Update Label Id ### List[​](#list "Direct link to List") **`GET /api/v2/w/{workspace_uuid}/member-labels`** **Description:** Member tagging and categorization List all member labels for the workspace. Access: All workspace members can view member labels (workspace-scoped resource). **Authorization:** Requires `labels:read` scope **Response:** List of [MemberLabelResponse](#member-label-response) *** ### Create[​](#create "Direct link to Create") **`POST /api/v2/w/{workspace_uuid}/member-labels`** **Description:** Member tagging and categorization Create a new member label. Requires workspace manager role. **Authorization:** Requires `members:write` scope **Parameters:** * `label` (CreateMemberLabelRequest) **Response:** See [MemberLabelResponse](#member-label-response) *** ### Delete Label Id[​](#delete-label-id "Direct link to Delete Label Id") **`DELETE /api/v2/w/{workspace_uuid}/member-labels/{label_id}`** **Description:** Member tagging and categorization Delete a member label. Requires workspace manager role. **Authorization:** Requires `members:write` scope **Parameters:** * `label_id` (Integer) *** ### Get Label Id[​](#get-label-id "Direct link to Get Label Id") **`GET /api/v2/w/{workspace_uuid}/member-labels/{label_id}`** **Description:** Member tagging and categorization Get a specific member label by ID. **Authorization:** Requires `labels:read` scope **Parameters:** * `label_id` (String) **Response:** See [MemberLabelResponse](#member-label-response) *** ### Update Label Id[​](#update-label-id "Direct link to Update Label Id") **`PUT /api/v2/w/{workspace_uuid}/member-labels/{label_id}`** **Description:** Member tagging and categorization Update an existing member label. Requires workspace manager role. **Authorization:** Requires `members:write` scope **Parameters:** * `label_id` (Integer) * `label` (UpdateMemberLabelRequest) **Response:** See [MemberLabelResponse](#member-label-response) *** --- # Member Roles **Tags:** `members`, `permissions`, `roles` ## Endpoints[​](#endpoints "Direct link to Endpoints") * [`GET `](#get)- List * [`POST `](#post)- Create * [`GET /{role_id_or_uuid}`](#get-role-id-or-uuid) - Get Role Id Or Uuid * [`DELETE /{role_id}`](#delete-role-id) - Delete Role Id * [`PUT /{role_id}`](#put-role-id) - Update Role Id ### List[​](#list "Direct link to List") **`GET /api/v2/w/{workspace_uuid}/member-roles`** **Description:** Member role and permission management List all member roles. **Authorization:** Requires `member-roles:read` scope **Response:** List of [MemberRoleResponse](#member-role-response) *** ### Create[​](#create "Direct link to Create") **`POST /api/v2/w/{workspace_uuid}/member-roles`** **Description:** Member role and permission management Create a new member role. **Authorization:** Requires `member-roles:admin` scope **Parameters:** * `request` - See [CreateMemberRoleRequest](#create-member-role-request) **Response:** See [MemberRoleResponse](#member-role-response) *** ### Get Role Id Or Uuid[​](#get-role-id-or-uuid "Direct link to Get Role Id Or Uuid") **`GET /api/v2/w/{workspace_uuid}/member-roles/{role_id_or_uuid}`** **Description:** Member role and permission management Get a specific member role by ID or UUID. Users can view their own role, managers can view any role. **Authorization:** Requires `member-roles:read` scope **Parameters:** * `role_id_or_uuid` (String) **Response:** See [MemberRoleResponse](#member-role-response) *** ### Delete Role Id[​](#delete-role-id "Direct link to Delete Role Id") **`DELETE /api/v2/w/{workspace_uuid}/member-roles/{role_id}`** **Description:** Member role and permission management Delete a member role. **Authorization:** Requires `member-roles:admin` scope **Parameters:** * `role_id` (Integer) **Response:** See [None](#none) *** ### Update Role Id[​](#update-role-id "Direct link to Update Role Id") **`PUT /api/v2/w/{workspace_uuid}/member-roles/{role_id}`** **Description:** Member role and permission management Update an existing member role. **Authorization:** Requires `member-roles:admin` scope **Parameters:** * `role_id` (Integer) * `request` - See [UpdateMemberRoleRequest](#update-member-role-request) **Response:** See [MemberRoleResponse](#member-role-response) *** --- # Workspace.Members.Bulk **Tags:** `members`, `users` ## Endpoints[​](#endpoints "Direct link to Endpoints") * [`POST /members/bulk`](#post-members-bulk) - Bulk ### Bulk[​](#bulk "Direct link to Bulk") **`POST /api/v2/w/{workspace_uuid}/members/bulk`** **Description:** Workspace member management Bulk create or upsert workspace members. **Authorization:** Requires `members:write` scope **Parameters:** * `request` - See [BulkCreateMembersRequest](#bulk-create-members-request) **Response:** See [BulkCreateMembersResponse](#bulk-create-members-response) *** --- # Workspace.Members.Crud **Tags:** `members`, `users` ## Endpoints[​](#endpoints "Direct link to Endpoints") * [`POST /members`](#post-members) - Members * [`DELETE /members/{member_id}`](#delete-members-member-id) - Delete Members * [`GET /members/{member_id}`](#get-members-member-id) - Members * [`PUT /members/{member_id}`](#put-members-member-id) - Update Members * [`POST /members/{member_id}/archive`](#post-members-member-id-archive) - Archive * [`POST /members/{member_id}/phone-confirmation`](#post-members-member-id-phone-confirmation) - Phone Confirmation * [`POST /members/{member_id}/unarchive`](#post-members-member-id-unarchive) - Unarchive ### Members[​](#members "Direct link to Members") **`POST /api/v2/w/{workspace_uuid}/members`** **Description:** Workspace member management Create a new workspace member. **Authorization:** Requires `members:write` scope **Parameters:** * `request` - See [CreateWorkspaceMemberRequest](#create-workspace-member-request) **Response:** See [WorkspaceMemberResponse](#workspace-member-response) *** ### Delete Members[​](#delete-members "Direct link to Delete Members") **`DELETE /api/v2/w/{workspace_uuid}/members/{member_id}`** **Description:** Workspace member management Permanently delete a workspace member and all their associated data. **Important:** Members must be archived first before deletion. Use the archive endpoint to safely remove a member from the workspace. Permanent deletion is a destructive operation that cannot be undone. The `force` flag allows workspace managers to auto-archive before deletion. Without `force`, this endpoint is restricted to superusers for erasure scenarios. **Authorization:** Requires `members:admin` scope **Parameters:** * `member_id` (Integer) * `reassign_to_id` (Integer) * `force` (Boolean) **Response:** See [DeleteMembershipResponse](#delete-membership-response) *** ### Members[​](#members-1 "Direct link to Members") **`GET /api/v2/w/{workspace_uuid}/members/{member_id}`** **Description:** Workspace member management Get a workspace member by ID. Self-access: Users can view their own member profile. Admin access: MEMBERS\_READ scope required for viewing other members. **Authentication:** Requires workspace member **Parameters:** * `member_id` (Integer) **Response:** See [WorkspaceMemberResponse](#workspace-member-response) *** ### Update Members[​](#update-members "Direct link to Update Members") **`PUT /api/v2/w/{workspace_uuid}/members/{member_id}`** **Description:** Workspace member management Update a workspace member. **Authorization:** Requires `members:write` scope **Parameters:** * `member_id` (Integer) * `request` - See [UpdateWorkspaceMemberRequest](#update-workspace-member-request) **Response:** See [WorkspaceMemberResponse](#workspace-member-response) *** ### Archive[​](#archive "Direct link to Archive") **`POST /api/v2/w/{workspace_uuid}/members/{member_id}/archive`** **Description:** Workspace member management Archive a workspace member instead of deleting them. **Authorization:** Requires `members:write` scope **Parameters:** * `member_id` (Integer) **Response:** See [WorkspaceMemberResponse](#workspace-member-response) *** ### Phone Confirmation[​](#phone-confirmation "Direct link to Phone Confirmation") **`POST /api/v2/w/{workspace_uuid}/members/{member_id}/phone-confirmation`** **Description:** Workspace member management Text a member asking them to confirm their phone (member-attested trust). **Authorization:** Requires `members:write` scope **Parameters:** * `member_id` (Integer) **Response:** See [SendPhoneConfirmationResponse](#send-phone-confirmation-response) *** ### Unarchive[​](#unarchive "Direct link to Unarchive") **`POST /api/v2/w/{workspace_uuid}/members/{member_id}/unarchive`** **Description:** Workspace member management Unarchive a previously archived workspace member. For account-backed members this enforces the GLB membership invariant: the GLB workspace\_memberships link must exist or be recreatable (the account is still in the workspace's org). When it isn't, `unarchive_account_member_by_id` raises `ConflictError` -> HTTP 409 via the global handler and the member stays archived. **Authorization:** Requires `members:write` scope **Parameters:** * `member_id` (Integer) **Response:** See [WorkspaceMemberResponse](#workspace-member-response) *** --- # Workspace.Members.Current **Tags:** `members`, `users` ## Endpoints[​](#endpoints "Direct link to Endpoints") * [`DELETE /me`](#delete-me) - Delete Me * [`GET /me`](#get-me) - Me * [`PUT /me`](#put-me) - Update Me * [`GET /me/credentials`](#get-me-credentials) - Credentials * [`DELETE /me/credentials/{credential_id}`](#delete-me-credentials-credential-id) - Delete Credentials * [`GET /members/owned`](#get-members-owned) - Owned ### Delete Me[​](#delete-me "Direct link to Delete Me") **`DELETE /api/v2/w/{workspace_uuid}/me`** **Description:** Workspace member management Leave a workspace. Archives the workspace-level Member (so they no longer appear as active to others, while preserving assignments, chats, and audit history) and removes the account-to-workspace association so the user loses access. **Authentication:** Requires workspace member **Response:** See [DeleteMembershipResponse](#delete-membership-response) *** ### Me[​](#me "Direct link to Me") **`GET /api/v2/w/{workspace_uuid}/me`** **Description:** Workspace member management Get the current user's workspace member profile. This is a self-access endpoint - no special scope required. Includes the effective scopes and org role that the API honors for this user. **Authentication:** Requires workspace member **Response:** See [CurrentMemberResponse](#current-member-response) *** ### Update Me[​](#update-me "Direct link to Update Me") **`PUT /api/v2/w/{workspace_uuid}/me`** **Description:** Workspace member management Update the current user's workspace member profile. This is a self-access endpoint - no special scope required. **Authentication:** Requires workspace member **Parameters:** * `request` - See [UpdateWorkspaceMemberRequest](#update-workspace-member-request) **Response:** See [WorkspaceMemberResponse](#workspace-member-response) *** ### Credentials[​](#credentials "Direct link to Credentials") **`GET /api/v2/w/{workspace_uuid}/me/credentials`** **Description:** Workspace member management Get the current member's connected integration credentials (Discord, etc.). This is a self-access endpoint - no special scope required. **Authentication:** Requires workspace member **Response:** List of [MemberCredentialResponse](#member-credential-response) *** ### Delete Credentials[​](#delete-credentials "Direct link to Delete Credentials") **`DELETE /api/v2/w/{workspace_uuid}/me/credentials/{credential_id}`** **Description:** Workspace member management Delete/unlink a credential from the current member's account. This is a self-access endpoint - no special scope required. **Authentication:** Requires workspace member **Parameters:** * `credential_id` (Integer) *** ### Owned[​](#owned "Direct link to Owned") **`GET /api/v2/w/{workspace_uuid}/members/owned`** **Description:** Workspace member management Get all members owned by the AUTHENTICATED member in this workspace. IMPORTANT: This endpoint always uses the authenticated member (the one who logged in with their account), NOT the "acting-as" member. This is critical because: 1. Only account-based members can own other members 2. Owned members cannot own other members (prevents recursive ownership) 3. The identity switcher needs to always show the same list regardless of which identity is currently active Returns the authenticated member plus all non-archived MEMBER and AGENT-type records that have owner\_id pointing to the authenticated member. This enables the identity switcher UI to show available identities (including personal agents) the user can switch between. Use POST /members/switch to switch to an owned member identity. **Authorization:** Requires `members:read` scope **Response:** List of [WorkspaceMemberResponse](#workspace-member-response) *** --- # Workspace.Members.Export **Tags:** `members`, `users` ## Endpoints[​](#endpoints "Direct link to Endpoints") * [`POST /members/export`](#post-members-export) - Export ### Export[​](#export "Direct link to Export") **`POST /api/v2/w/{workspace_uuid}/members/export`** **Description:** Workspace member management Export members to CSV, matching the same filters the list view applies. **Authorization:** Requires `members:admin` scope **Parameters:** * `selected_fields` (Array) * `selected_data_types` (Array) * `member_type` (String) * `member_types` (String) * `search` (String) * `filters` (String) * `memberFilterId` (Integer) * `query` (String) * `role` (String) *** --- # Workspace.Members.Fields **Tags:** `members`, `users` ## Endpoints[​](#endpoints "Direct link to Endpoints") * [`GET /member-field-definitions`](#get-member-field-definitions) - Member Field Definitions * [`GET /members/{member_id}/fields`](#get-members-member-id-fields) - Fields * [`POST /members/{member_id}/fields`](#post-members-member-id-fields) - Fields * [`DELETE /members/{member_id}/fields/{field_id}`](#delete-members-member-id-fields-field-id) - Delete Fields * [`PUT /members/{member_id}/fields/{field_id}`](#put-members-member-id-fields-field-id) - Update Fields ### Member Field Definitions[​](#member-field-definitions "Direct link to Member Field Definitions") **`GET /api/v2/w/{workspace_uuid}/member-field-definitions`** **Description:** Workspace member management Get available field definitions for this workspace. Returns field keys and labels from active app connections' managed field definitions, plus any distinct user-created field keys. **Authorization:** Requires `members:read` scope **Response:** See [MemberFieldDefinitionListResponse](#member-field-definition-list-response) *** ### Fields[​](#fields "Direct link to Fields") **`GET /api/v2/w/{workspace_uuid}/members/{member_id}/fields`** **Description:** Workspace member management Get all fields for a member. Returns all key-value fields associated with this member, including service-owned fields and placeholder entries for managed field definitions that don't have a value yet. **Authorization:** Requires `members:read` scope **Parameters:** * `member_id` (Integer) **Response:** See [MemberFieldListResponse](#member-field-list-response) *** ### Fields[​](#fields-1 "Direct link to Fields") **`POST /api/v2/w/{workspace_uuid}/members/{member_id}/fields`** **Description:** Workspace member management Create a new field for a member. When serviceId is provided, creates a managed field owned by that app connection. The key must match a managed field definition declared by the connection. Otherwise creates a user-owned field. **Authorization:** Requires `members:write` scope **Parameters:** * `member_id` (Integer) * `request` - See [CreateMemberFieldRequest](#create-member-field-request) **Response:** See [MemberFieldResponse](#member-field-response) *** ### Delete Fields[​](#delete-fields "Direct link to Delete Fields") **`DELETE /api/v2/w/{workspace_uuid}/members/{member_id}/fields/{field_id}`** **Description:** Workspace member management Delete a member field. Only user-created fields (service\_id is null) can be deleted. Service-owned fields are read-only. **Authorization:** Requires `members:write` scope **Parameters:** * `member_id` (Integer) * `field_id` (Integer) *** ### Update Fields[​](#update-fields "Direct link to Update Fields") **`PUT /api/v2/w/{workspace_uuid}/members/{member_id}/fields/{field_id}`** **Description:** Workspace member management Update a member field value. Both user-created and service-owned (managed) fields can have their values updated. The app connection owns the field's existence; the admin owns the value. **Authorization:** Requires `members:write` scope **Parameters:** * `member_id` (Integer) * `field_id` (Integer) * `request` - See [UpdateMemberFieldRequest](#update-member-field-request) **Response:** See [MemberFieldResponse](#member-field-response) *** --- # Workspace.Members.Import Csv **Tags:** `members`, `users` ## Endpoints[​](#endpoints "Direct link to Endpoints") * [`POST /members/import`](#post-members-import) - Import * [`POST /members/import/preview`](#post-members-import-preview) - Preview ### Import[​](#import "Direct link to Import") **`POST /api/v2/w/{workspace_uuid}/members/import`** **Description:** Workspace member management Import members from CSV file with streaming progress updates. `identity_conflict_policy='overwrite_identity_fields'` is intended to be sent only after an operator reviews a preview. Two known, accepted limits: * Preview→commit is not transactional (TOCTOU): the commit re-classifies each row against live DB state, so under the default `skip` policy a row that became a conflict after the preview is still skipped. Under `overwrite` the operator's prior approval is applied to current state, so an identity that changed between preview and commit is overwritten on the stale approval. Closing this would require optimistic locking / a preview token. * Preview-first is advisory, not enforced: `overwrite` requires only `MEMBERS_ADMIN` (which can already mutate identity via the member-update API) and every overwrite is audited; there is no backend gate requiring a prior preview call. **Authorization:** Requires `members:admin` scope **Parameters:** * `file` (UploadFile) * `new_member_role_id` (Integer) * `trust_email_addresses` (Boolean) * `trust_phone_numbers` (Boolean) * `identity_conflict_policy` (IdentityConflictPolicy) *** ### Preview[​](#preview "Direct link to Preview") **`POST /api/v2/w/{workspace_uuid}/members/import/preview`** **Description:** Workspace member management Read-only preview classifying each CSV row before any write (GRA-5545). Returns create/update/unchanged/conflict/error counts plus, for phone-only identity *conflicts*, the existing vs incoming identity so the operator can decide before committing. `@phi_audit(bulk=True)` because the response can surface existing Member PHI in bulk; the response is never logged. Design trade-off (accepted): returning existing name/date\_of\_birth for conflicted rows lets one authorized call enumerate identity PHI for the matched members. This is the explicit purpose of the conflict-review flow — the operator must compare existing vs incoming to choose skip/overwrite — and is bounded to phone-only *conflict* rows, gated by `MEMBERS_ADMIN` and the bulk PHI audit above. Identity is not returned for create/update/unchanged rows (PHI minimization). **Authorization:** Requires `members:admin` scope **Parameters:** * `file` (UploadFile) * `new_member_role_id` (Integer) * `trust_email_addresses` (Boolean) * `trust_phone_numbers` (Boolean) **Response:** See [MemberImportPreviewResponse](#member-import-preview-response) *** --- # Workspace.Members.List **Tags:** `members`, `users` ## Endpoints[​](#endpoints "Direct link to Endpoints") * [`GET /members`](#get-members) - Members * [`GET /members/message-activity`](#get-members-message-activity) - Message Activity ### Members[​](#members "Direct link to Members") **`GET /api/v2/w/{workspace_uuid}/members`** **Description:** Workspace member management List all workspace members with filtering and pagination. **Authorization:** Requires `members:read` scope **Parameters:** * `workspace_uuid` (String) * `filters` (String) * `memberFilterId` (Integer) * `query` (String) * `search` (String) * `role` (String) * `member_type` (String) * `member_types` (String) * `is_archived` (Boolean) * `is_manager` (Boolean) * `has_account` (Boolean) * `exclude_ids` (String) * `experimentId` (Integer) * `experimentGroupId` (Integer) * `experimentUnassigned` (Boolean) * `page` (Integer) * `pageSize` (Integer) * `sortBy` (MemberSortField) * `sortOrder` (SortOrder) **Response:** See [PaginatedResponse\[WorkspaceMemberResponse\]](#paginated-response%5B-workspace-member-response%5D) *** ### Message Activity[​](#message-activity "Direct link to Message Activity") **`GET /api/v2/w/{workspace_uuid}/members/message-activity`** **Description:** Workspace member management Get message activity (count per day) for specified members. **Authorization:** Requires `members:read` scope **Parameters:** * `workspace_uuid` (String) * `member_ids` (String) * `days` (Integer) *** --- # Notification Rules **Tags:** `automation`, `notifications`, `rules` ## Endpoints[​](#endpoints "Direct link to Endpoints") * [`GET /notification-rules`](#get-notification-rules) - Notification Rules * [`POST /notification-rules`](#post-notification-rules) - Notification Rules * [`DELETE /notification-rules/{rule_id}`](#delete-notification-rules-rule-id) - Delete Notification Rules * [`PUT /notification-rules/{rule_id}`](#put-notification-rules-rule-id) - Update Notification Rules ### Notification Rules[​](#notification-rules-1 "Direct link to Notification Rules") **`GET /api/v2/w/{workspace_uuid}/notification-rules/notification-rules`** **Description:** Notification delivery rules and triggers Get all notification rules for a workspace. Requires `automations:read` scope. **Authorization:** Requires `automations:read` scope **Response:** List of [NotificationRuleResponse](#notification-rule-response) *** ### Notification Rules[​](#notification-rules-2 "Direct link to Notification Rules") **`POST /api/v2/w/{workspace_uuid}/notification-rules/notification-rules`** **Description:** Notification delivery rules and triggers Create a new notification rule. **Authorization:** Requires `automations:admin` scope **Parameters:** * `request` (NotificationRuleCreate) **Response:** See [NotificationRuleResponse](#notification-rule-response) *** ### Delete Notification Rules[​](#delete-notification-rules "Direct link to Delete Notification Rules") **`DELETE /api/v2/w/{workspace_uuid}/notification-rules/notification-rules/{rule_id}`** **Description:** Notification delivery rules and triggers Delete a notification rule. **Authorization:** Requires `automations:admin` scope **Parameters:** * `rule_id` (Integer) **Response:** See [dict](#dict) *** ### Update Notification Rules[​](#update-notification-rules "Direct link to Update Notification Rules") **`PUT /api/v2/w/{workspace_uuid}/notification-rules/notification-rules/{rule_id}`** **Description:** Notification delivery rules and triggers Update an existing notification rule. **Authorization:** Requires `automations:admin` scope **Parameters:** * `rule_id` (Integer) * `request` (NotificationRuleUpdate) **Response:** See [NotificationRuleResponse](#notification-rule-response) *** --- # Notifications **Tags:** `alerts`, `notifications` ## Endpoints[​](#endpoints "Direct link to Endpoints") * [`GET `](#get)- List * [`POST /dismiss-all`](#post-dismiss-all) - Dismiss All * [`GET /unread-count`](#get-unread-count) - Unread Count * [`GET /{notification_id}`](#get-notification-id) - Get Notification Id * [`POST /{notification_id}/dismiss`](#post-notification-id-dismiss) - Dismiss * [`POST /{notification_id}/read`](#post-notification-id-read) - Read ### List[​](#list "Direct link to List") **`GET /api/v2/w/{workspace_uuid}/notifications`** **Description:** Notification management List all notifications for the authenticated user. **Authentication:** Requires workspace member **Parameters:** * `page` (Integer) * `pageSize` (Integer) **Response:** See [PaginatedResponse\[NotificationResponse\]](#paginated-response%5B-notification-response%5D) *** ### Dismiss All[​](#dismiss-all "Direct link to Dismiss All") **`POST /api/v2/w/{workspace_uuid}/notifications/dismiss-all`** **Description:** Notification management Dismiss all notifications for the current member. **Authentication:** Requires workspace member **Response:** See [dict](#dict) *** ### Unread Count[​](#unread-count "Direct link to Unread Count") **`GET /api/v2/w/{workspace_uuid}/notifications/unread-count`** **Description:** Notification management Get the number of unread notifications for the authenticated user. **Authentication:** Requires workspace member **Response:** See [int](#int) *** ### Get Notification Id[​](#get-notification-id "Direct link to Get Notification Id") **`GET /api/v2/w/{workspace_uuid}/notifications/{notification_id}`** **Description:** Notification management Get a specific notification by ID. **Authentication:** Requires workspace member **Parameters:** * `notification_id` (Integer) **Response:** See [NotificationResponse](#notification-response) *** ### Dismiss[​](#dismiss "Direct link to Dismiss") **`POST /api/v2/w/{workspace_uuid}/notifications/{notification_id}/dismiss`** **Description:** Notification management Dismiss a notification. **Authentication:** Requires workspace member **Parameters:** * `notification_id` (Integer) **Response:** See [NotificationResponse](#notification-response) *** ### Read[​](#read "Direct link to Read") **`POST /api/v2/w/{workspace_uuid}/notifications/{notification_id}/read`** **Description:** Notification management Mark a notification as read. **Authentication:** Requires workspace member **Parameters:** * `notification_id` (Integer) **Response:** See [NotificationResponse](#notification-response) *** --- # Phone Numbers **Tags:** `communication`, `phone`, `sms` ## Endpoints[​](#endpoints "Direct link to Endpoints") * [`GET `](#get)- List * [`POST `](#post)- Create * [`GET /linkable-phones`](#get-linkable-phones) - Linkable Phones * [`GET /{phone_number_id}`](#get-phone-number-id) - Get Phone Number Id * [`PUT /{phone_number_id}`](#put-phone-number-id) - Update Phone Number Id * [`POST /{phone_number_id}/archive`](#post-phone-number-id-archive) - Archive * [`GET /{phone_number_id}/archive-blockers`](#get-phone-number-id-archive-blockers) - Archive Blockers * [`POST /{phone_number_id}/link`](#post-phone-number-id-link) - Link ### List[​](#list "Direct link to List") **`GET /api/v2/w/{workspace_uuid}/phone-numbers`** **Description:** Phone number and SMS management List phone numbers for the workspace, filtered by archive status. Access: All workspace members can view phone numbers (workspace-scoped resource). **Authorization:** Requires `phones:read` scope **Parameters:** * `is_archived` (Boolean) **Response:** List of [PhoneNumberResponse](#phone-number-response) *** ### Create[​](#create "Direct link to Create") **`POST /api/v2/w/{workspace_uuid}/phone-numbers`** **Description:** Phone number and SMS management Create a new phone number for the authenticated user. Requires `phones:write` scope. If providerPhoneUuid is provided, looks up the provider phone, verifies org ownership, and sets bidirectional references. Otherwise falls back to looking up by number string in the global pool. **Authorization:** Requires `phones:write` scope **Parameters:** * `phone` (CreatePhoneNumberRequest) **Response:** See [PhoneNumberResponse](#phone-number-response) *** ### Linkable Phones[​](#linkable-phones "Direct link to Linkable Phones") **`GET /api/v2/w/{workspace_uuid}/phone-numbers/linkable-phones`** **Description:** Phone number and SMS management List provider phones available for linking to workspace phone numbers. Returns org-owned provider phones that are either: * Unassigned (available to any workspace in the org) * Already assigned to this workspace (for re-linking or viewing) Requires PHONES\_WRITE scope. **Authorization:** Requires `phones:write` scope **Response:** List of [dict](#dict) *** ### Get Phone Number Id[​](#get-phone-number-id "Direct link to Get Phone Number Id") **`GET /api/v2/w/{workspace_uuid}/phone-numbers/{phone_number_id}`** **Description:** Phone number and SMS management Get a specific phone number by ID or UUID. **Authorization:** Requires `phones:read` scope **Parameters:** * `phone_number_id` (String) **Response:** See [PhoneNumberResponse](#phone-number-response) *** ### Update Phone Number Id[​](#update-phone-number-id "Direct link to Update Phone Number Id") **`PUT /api/v2/w/{workspace_uuid}/phone-numbers/{phone_number_id}`** **Description:** Phone number and SMS management Update an existing phone number by ID or UUID. Requires `phones:write` scope. **Authorization:** Requires `phones:write` scope **Parameters:** * `phone_number_id` (String) * `phone_update` (UpdatePhoneNumberRequest) **Response:** See [PhoneNumberResponse](#phone-number-response) *** ### Archive[​](#archive "Direct link to Archive") **`POST /api/v2/w/{workspace_uuid}/phone-numbers/{phone_number_id}/archive`** **Description:** Phone number and SMS management Archive a phone number, releasing the Twilio number back to the pool. Call and SMS history is preserved. This action cannot be undone. **Authorization:** Requires `phones:admin` scope **Parameters:** * `phone_number_id` (String) **Response:** See [PhoneNumberResponse](#phone-number-response) *** ### Archive Blockers[​](#archive-blockers "Direct link to Archive Blockers") **`GET /api/v2/w/{workspace_uuid}/phone-numbers/{phone_number_id}/archive-blockers`** **Description:** Phone number and SMS management Return workflow blockers that prevent archiving this phone number. **Authorization:** Requires `phones:admin` scope **Parameters:** * `phone_number_id` (String) **Response:** See [ArchiveBlockersResponse](#archive-blockers-response) *** ### Link[​](#link "Direct link to Link") **`POST /api/v2/w/{workspace_uuid}/phone-numbers/{phone_number_id}/link`** **Description:** Phone number and SMS management Link or unlink a workspace phone number to/from a provider phone. If providerPhoneUuid is provided, sets bidirectional references between the workspace phone and the GLB provider phone. If null, clears the link. Requires PHONES\_WRITE scope. **Authorization:** Requires `phones:write` scope **Parameters:** * `phone_number_id` (String) * `request` - See [LinkPhoneRequest](#link-phone-request) **Response:** See [PhoneNumberResponse](#phone-number-response) *** --- # Push Subscriptions **Tags:** `notifications`, `push` ## Endpoints[​](#endpoints "Direct link to Endpoints") * [`DELETE `](#delete)- Delete All * [`GET `](#get)- List * [`POST `](#post)- Create ### Delete All[​](#delete-all "Direct link to Delete All") **`DELETE /api/v2/w/{workspace_uuid}/push-subscriptions`** **Description:** Web push notification subscription management Unregister a push subscription. Only the member who owns the subscription can unregister it. **Authentication:** Requires workspace member **Parameters:** * `endpoint` (String) **Response:** See [dict](#dict) *** ### List[​](#list "Direct link to List") **`GET /api/v2/w/{workspace_uuid}/push-subscriptions`** **Description:** Web push notification subscription management List all push subscriptions for the current member. **Authentication:** Requires workspace member **Response:** List of [PushSubscriptionResponse](#push-subscription-response) *** ### Create[​](#create "Direct link to Create") **`POST /api/v2/w/{workspace_uuid}/push-subscriptions`** **Description:** Web push notification subscription management Register a new push subscription for the current member. If a subscription with the same endpoint already exists, it will be updated. **Authentication:** Requires workspace member **Parameters:** * `request` - See [RegisterPushSubscriptionRequest](#register-push-subscription-request) **Response:** See [PushSubscriptionResponse](#push-subscription-response) *** --- # Recordings **Tags:** `recordings`, `voice` Download recorded voice calls. Audio is only available when the workspace has **Enable Audio Recording** turned on and the call completed with stored audio. Recorded call audio may contain protected health information (PHI); treat it with the same care as any other patient data. ## Endpoints[​](#endpoints "Direct link to Endpoints") * [`GET /chat/{chat_id}/audio.wav`](#get-chat-chat-id-audio.wav) - Download Recording * [`GET /chat/{chat_id}/download-url`](#get-chat-chat-id-download-url) - Get Download URL ### Download Recording[​](#download-recording "Direct link to Download Recording") **`GET /api/v2/w/{workspace_uuid}/recordings/chat/{chat_id}/audio.wav`** **Description:** Download a completed call recording as a single WAV file Returns the full call for `chat_id` as one standard WAV file, assembled from the stored audio onto a single timeline (overlapping speech is mixed). The result is suitable for any HTML5 audio player or `wavesurfer.js`. You only need the chat ID — no chunk enumeration or storage keys are involved. For API integrations, prefer `GET /chat/{chat_id}/download-url` so large recording downloads do not stream through the Gravity Rail API process. Manager-owned and direct-message chats stay private to their participants: a caller who is not a participant receives `403 Forbidden` for those chats even with the `chats:read` scope. Returns `404 Not Found` when no audio is stored for the chat (recording was off, the call was too short, or the chat is not a voice chat). **Authorization:** Requires `chats:read` scope **Parameters:** * `chat_id` (Integer) *** ### Get Download URL[​](#get-download-url "Direct link to Get Download URL") **`GET /api/v2/w/{workspace_uuid}/recordings/chat/{chat_id}/download-url`** **Description:** Get a short-lived URL for a completed call recording Return a short-lived presigned URL for downloading a completed call recording as one WAV file. This is the recommended integration endpoint for workflows such as "call ended → download the recording": your client downloads the bytes directly from object storage instead of streaming them through the Gravity Rail API. When a ready Twilio-native recording exists for the chat, the URL points at the derived mono playback WAV (both parties mixed to one channel) — the same object `GET /chat/{chat_id}/audio.wav` serves — and no chunk assembly happens. Ingest writes that mono object as a deterministic sibling of the canonical dual-channel WAV, so a ready recording always has it. Otherwise the first request assembles the recording from stored audio chunks and caches the full-call WAV in workspace-scoped storage; later requests reuse that cached object and only mint a fresh presigned URL. The `expires_in` query parameter (seconds) is optional; Gravity Rail caps it at the server-configured maximum and defaults to 3600 seconds. Manager-owned and direct-message chats stay private to their participants: a caller who is not a participant receives `403 Forbidden` for those chats even with the `chats:read` scope. Returns `404 Not Found` when no audio is stored for the chat (recording was off, the call was too short, or the chat is not a voice chat). **Authorization:** Requires `chats:read` scope **Parameters:** * `chat_id` (Integer) * `expires_in` (Integer) **Response:** See [CallRecordingDownloadUrlResponse](#call-recording-download-url-response) *** --- # Routines **Tags:** `automation`, `routines` ## Endpoints[​](#endpoints "Direct link to Endpoints") * [`GET `](#get)- List * [`POST `](#post)- Create * [`POST /preview-schedule`](#post-preview-schedule) - Preview Schedule * [`GET /runs`](#get-runs) - Runs * [`DELETE /{event_id}`](#delete-event-id) - Delete Event Id * [`GET /{event_id}`](#get-event-id) - Get Event Id * [`PUT /{event_id}`](#put-event-id) - Update Event Id * [`POST /{event_id}/run`](#post-event-id-run) - Run * [`DELETE /{event_id}/runs`](#delete-event-id-runs) - Delete Runs ### List[​](#list "Direct link to List") **`GET /api/v2/w/{workspace_uuid}/routines`** **Description:** Routines — the unified automation primitive (schedule, webhook, and system-event triggers) List all Routines for the workspace with pagination. Visibility rules: a member sees Routines they own (any visibility) plus workspace-visible Routines owned by others. Private Routines owned by other members are hidden by default. Callers with `AUTOMATIONS_ADMIN` can request `owner=all_including_private` to see every routine in the workspace for administrative operations. The `owner` query param narrows within what the caller is allowed to see — it cannot widen access beyond the caller's scopes. **Authorization:** Requires `automations:read` scope **Parameters:** * `page` (Integer) * `pageSize` (Integer) * `sortBy` (RoutineSortField) * `sortOrder` (SortOrder) * `owner` (String) **Response:** See [PaginatedResponse\[RoutineResponse\]](#paginated-response%5B-routine-response%5D) *** ### Create[​](#create "Direct link to Create") **`POST /api/v2/w/{workspace_uuid}/routines`** **Description:** Routines — the unified automation primitive (schedule, webhook, and system-event triggers) Create a new Routine. **Authorization:** Requires `automations:write` scope **Parameters:** * `request` - See [CreateRoutineRequest](#create-routine-request) **Response:** See [RoutineResponse](#routine-response) *** ### Preview Schedule[​](#preview-schedule "Direct link to Preview Schedule") **`POST /api/v2/w/{workspace_uuid}/routines/preview-schedule`** **Description:** Routines — the unified automation primitive (schedule, webhook, and system-event triggers) Preview the next N run times for a cron expression. **Authorization:** Requires `automations:read` scope **Parameters:** * `request` - See [SchedulePreviewRequest](#schedule-preview-request) **Response:** See [SchedulePreviewResponse](#schedule-preview-response) *** ### Runs[​](#runs "Direct link to Runs") **`GET /api/v2/w/{workspace_uuid}/routines/runs`** **Description:** Routines — the unified automation primitive (schedule, webhook, and system-event triggers) List all Routine runs for the workspace with pagination. Only runs for Routines the caller can see are returned — i.e. runs of their own Routines plus runs of workspace-visible Routines owned by others. Without the visibility join a caller with AUTOMATIONS\_READ could enumerate history of any private Routine by guessing `routineId`. **Authorization:** Requires `automations:read` scope **Parameters:** * `page` (Integer) * `pageSize` (Integer) * `sortBy` (EventRunSortField) * `sortOrder` (SortOrder) * `routineId` (Integer) * `status` (String) **Response:** See [PaginatedResponse\[RoutineRunResponse\]](#paginated-response%5B-routine-run-response%5D) *** ### Delete Event Id[​](#delete-event-id "Direct link to Delete Event Id") **`DELETE /api/v2/w/{workspace_uuid}/routines/{event_id}`** **Description:** Routines — the unified automation primitive (schedule, webhook, and system-event triggers) Delete a Routine. **Authorization:** Requires `automations:admin` scope **Parameters:** * `event_id` (Integer) *** ### Get Event Id[​](#get-event-id "Direct link to Get Event Id") **`GET /api/v2/w/{workspace_uuid}/routines/{event_id}`** **Description:** Routines — the unified automation primitive (schedule, webhook, and system-event triggers) Get a specific Routine by ID. **Authorization:** Requires `automations:read` scope **Parameters:** * `event_id` (Integer) **Response:** See [RoutineResponse](#routine-response) *** ### Update Event Id[​](#update-event-id "Direct link to Update Event Id") **`PUT /api/v2/w/{workspace_uuid}/routines/{event_id}`** **Description:** Routines — the unified automation primitive (schedule, webhook, and system-event triggers) Update an existing Routine. **Authorization:** Requires `automations:write` scope **Parameters:** * `event_id` (Integer) * `request` - See [UpdateRoutineRequest](#update-routine-request) **Response:** See [RoutineResponse](#routine-response) *** ### Run[​](#run "Direct link to Run") **`POST /api/v2/w/{workspace_uuid}/routines/{event_id}/run`** **Description:** Routines — the unified automation primitive (schedule, webhook, and system-event triggers) Run a Routine manually. **Authorization:** Requires `automations:write` scope **Parameters:** * `event_id` (Integer) * `member_id` (Integer) * `member_filter_id` (Integer) *** ### Delete Runs[​](#delete-runs "Direct link to Delete Runs") **`DELETE /api/v2/w/{workspace_uuid}/routines/{event_id}/runs`** **Description:** Routines — the unified automation primitive (schedule, webhook, and system-event triggers) Reset/clear all runs for a Routine. This removes all run history for the Routine. **Authorization:** Requires `automations:admin` scope **Parameters:** * `event_id` (Integer) *** --- # Settings **Tags:** `business-hours`, `configuration`, `settings`, `workspace` ## Endpoints[​](#endpoints "Direct link to Endpoints") * [`GET /business-hours-status`](#get-business-hours-status) - Business Hours Status * [`GET /defaults`](#get-defaults) - Defaults * [`PUT /defaults`](#put-defaults) - Update Defaults * [`GET /first-run-state`](#get-first-run-state) - First Run State * [`PUT /first-run-state`](#put-first-run-state) - Update First Run State ### Business Hours Status[​](#business-hours-status "Direct link to Business Hours Status") **`GET /api/v2/w/{workspace_uuid}/business-hours-status`** **Description:** Get current business hours status Get the current business hours status for the workspace. **Authorization:** Requires `workspace:read` scope **Response:** See [BusinessHoursStatusResponse](#business-hours-status-response) *** ### Defaults[​](#defaults "Direct link to Defaults") **`GET /api/v2/w/{workspace_uuid}/defaults`** **Description:** Get workspace default settings Get the default settings for a workspace. If no settings row exists yet, returns workspace defaults. The row is created on the first update. **Authorization:** Requires `workspace:read` scope **Response:** See [WorkspaceSettingsResponse](#workspace-settings-response) *** ### Update Defaults[​](#update-defaults "Direct link to Update Defaults") **`PUT /api/v2/w/{workspace_uuid}/defaults`** **Description:** Update workspace default settings Update default settings for a workspace. **Authorization:** Requires `workspace:write` scope **Parameters:** * `request` - See [UpdateWorkspaceDefaultsRequest](#update-workspace-defaults-request) **Response:** See [WorkspaceSettingsResponse](#workspace-settings-response) *** ### First Run State[​](#first-run-state "Direct link to First Run State") **`GET /api/v2/w/{workspace_uuid}/first-run-state`** **Description:** Workspace configuration and settings management **Authorization:** Requires `workspace:read` scope **Response:** See [FirstRunState](#first-run-state) *** ### Update First Run State[​](#update-first-run-state "Direct link to Update First Run State") **`PUT /api/v2/w/{workspace_uuid}/first-run-state`** **Description:** Workspace configuration and settings management **Authorization:** Requires `workspace:write` scope **Parameters:** * `request` (FirstRunState) **Response:** See [FirstRunState](#first-run-state) *** --- # Sharing **Tags:** `permissions`, `sharing` ## Endpoints[​](#endpoints "Direct link to Endpoints") * [`GET /files/{file_id}`](#get-files-file-id) - Files * [`GET /files/{file_id}/contents/{filename}`](#get-files-file-id-contents-filename) - Contents * [`GET /folders/{folder_id}`](#get-folders-folder-id) - Folders * [`GET /folders/{folder_id}/files`](#get-folders-folder-id-files) - Files ### Files[​](#files "Direct link to Files") **`GET /api/v2/w/{workspace_uuid}/files/{file_id}`** **Description:** Resource sharing and share-link management Get public file metadata. Returns file information if the file is public or the user has access. Supports unauthenticated access for public files. **Authentication:** Requires workspace session **Parameters:** * `file_id` (Integer) **Response:** See [SharedFileResponse](#shared-file-response) *** ### Contents[​](#contents "Direct link to Contents") **`GET /api/v2/w/{workspace_uuid}/files/{file_id}/contents/{filename}`** **Description:** Resource sharing and share-link management Serve file contents for shareable files. Returns the raw file data if the file is shareable and the user has access. Supports unauthenticated access for public shareable files. **Authentication:** Requires workspace session **Parameters:** * `file_id` (Integer) * `filename` (String) *** ### Folders[​](#folders "Direct link to Folders") **`GET /api/v2/w/{workspace_uuid}/folders/{folder_id}`** **Description:** Resource sharing and share-link management Get public folder metadata and file listing. Returns folder information and list of files if the folder is public or user has access. Supports unauthenticated access for public folders. **Authentication:** Requires workspace session **Parameters:** * `folder_id` (Integer) * `page` (Integer) * `pageSize` (Integer) **Response:** See [SharedFolderResponse](#shared-folder-response) *** ### Files[​](#files-1 "Direct link to Files") **`GET /api/v2/w/{workspace_uuid}/folders/{folder_id}/files`** **Description:** Resource sharing and share-link management Get list of files in a public folder. Alias for GET /sharing/folders/{folder\_id} that returns just the file listing. **Authentication:** Requires workspace session **Parameters:** * `folder_id` (Integer) * `page` (Integer) * `pageSize` (Integer) **Response:** See [SharedFolderFilesResponse](#shared-folder-files-response) *** --- # Sites **Tags:** `content`, `sites` ## Endpoints[​](#endpoints "Direct link to Endpoints") * [`GET /mapping/{custom_domain}`](#get-mapping-custom-domain) - Mapping * [`GET /{workspace_uuid}/{site_uuid}`](#get-workspace-uuid-site-uuid) - Get Workspace Uuid Site Uuid * [`POST /{workspace_uuid}/{site_uuid}/auth/send-email-code`](#post-workspace-uuid-site-uuid-auth-send-email-code) - Send Email Code * [`POST /{workspace_uuid}/{site_uuid}/auth/send-phone-code`](#post-workspace-uuid-site-uuid-auth-send-phone-code) - Send Phone Code * [`POST /{workspace_uuid}/{site_uuid}/auth/verify`](#post-workspace-uuid-site-uuid-auth-verify) - Verify * [`GET /{workspace_uuid}/{site_uuid}/files/{file_id}/contents/{filename}`](#get-workspace-uuid-site-uuid-files-file-id-contents-filename) - Contents * [`GET /{workspace_uuid}/{site_uuid}/menu`](#get-workspace-uuid-site-uuid-menu) - Menu * [`GET /{workspace_uuid}/{site_uuid}/pages/{page_slug_or_id}`](#get-workspace-uuid-site-uuid-pages-page-slug-or-id) - Pages * [`POST /{workspace_uuid}/{site_uuid}/signup`](#post-workspace-uuid-site-uuid-signup) - Signup ### Mapping[​](#mapping "Direct link to Mapping") **`GET /api/v2/s/{site_uuid}/mapping/{custom_domain}`** **Description:** Website and content management Get workspace\_uuid and site\_uuid for a custom domain. **Authorization:** Requires scopes: **Parameters:** * `custom_domain` (String) **Response:** See [SiteMappingResponse](#site-mapping-response) *** ### Get Workspace Uuid Site Uuid[​](#get-workspace-uuid-site-uuid "Direct link to Get Workspace Uuid Site Uuid") **`GET /api/v2/s/{site_uuid}/{workspace_uuid}/{site_uuid}`** **Description:** Website and content management Get a specific site by ID. **Authentication:** Requires workspace session **Parameters:** * `site_uuid` (String) **Response:** See [SiteResponse](#site-response) *** ### Send Email Code[​](#send-email-code "Direct link to Send Email Code") **`POST /api/v2/s/{site_uuid}/{workspace_uuid}/{site_uuid}/auth/send-email-code`** **Description:** Website and content management Send email verification code for site authentication (allows new signups if site.allow\_signup=True). **Authentication:** Requires workspace session **Parameters:** * `site_uuid` (String) * `request` - See [SiteAuthEmailRequest](#site-auth-email-request) **Response:** See [SendLoginCodeResponse](#send-login-code-response) *** ### Send Phone Code[​](#send-phone-code "Direct link to Send Phone Code") **`POST /api/v2/s/{site_uuid}/{workspace_uuid}/{site_uuid}/auth/send-phone-code`** **Description:** Website and content management Send SMS verification code for site authentication (allows new signups if site.allow\_signup=True). **Authentication:** Requires workspace session **Parameters:** * `site_uuid` (String) * `request` - See [SiteAuthPhoneRequest](#site-auth-phone-request) **Response:** See [SendLoginCodeResponse](#send-login-code-response) *** ### Verify[​](#verify "Direct link to Verify") **`POST /api/v2/s/{site_uuid}/{workspace_uuid}/{site_uuid}/auth/verify`** **Description:** Website and content management Verify code and create account+member if needed for site with allow\_signup=True. **Authentication:** Requires workspace session **Parameters:** * `site_uuid` (String) * `request` - See [SiteAuthVerifyRequest](#site-auth-verify-request) **Response:** See [SiteAuthVerifyResponse](#site-auth-verify-response) *** ### Contents[​](#contents "Direct link to Contents") **`GET /api/v2/s/{site_uuid}/{workspace_uuid}/{site_uuid}/files/{file_id}/contents/{filename}`** **Description:** Website and content management Download file contents for site media with site-based access controls. This endpoint allows downloading site file contents with proper access control enforcement. **Authentication:** Requires workspace session **Parameters:** * `site_uuid` (String) * `file_id` (Integer) * `filename` (String) * `token` (String) *** ### Menu[​](#menu "Direct link to Menu") **`GET /api/v2/s/{site_uuid}/{workspace_uuid}/{site_uuid}/menu`** **Description:** Website and content management Get the complete menu tree for a site. **Authentication:** Requires workspace session **Parameters:** * `site_uuid` (String) **Response:** See [MenuTreeResponse](#menu-tree-response) *** ### Pages[​](#pages "Direct link to Pages") **`GET /api/v2/s/{site_uuid}/{workspace_uuid}/{site_uuid}/pages/{page_slug_or_id}`** **Description:** Website and content management Get a specific page by its ID or slug within a site. Supports locale-specific content via the locale query parameter. If the requested locale is not available, falls back to the page's primary locale. **Authentication:** Requires workspace session **Parameters:** * `site_uuid` (String) * `page_slug_or_id` (String) * `locale` (String) * `preview` (Boolean) **Response:** See [RenderedPageResponse](#rendered-page-response) *** ### Signup[​](#signup "Direct link to Signup") **`POST /api/v2/s/{site_uuid}/{workspace_uuid}/{site_uuid}/signup`** **Description:** Website and content management Sign up a logged-in user for a public site if signup is allowed. **Authentication:** Requires workspace session **Parameters:** * `site_uuid` (String) **Response:** See [SiteSignupResponse](#site-signup-response) *** --- # Snippets **Tags:** `content`, `snippets` ## Endpoints[​](#endpoints "Direct link to Endpoints") * [`GET `](#get)- List * [`POST `](#post)- Create * [`DELETE /{snippet_id}`](#delete-snippet-id) - Delete Snippet Id * [`GET /{snippet_id}`](#get-snippet-id) - Get Snippet Id * [`PUT /{snippet_id}`](#put-snippet-id) - Update Snippet Id ### List[​](#list "Direct link to List") **`GET /api/v2/w/{workspace_uuid}/snippets`** **Description:** Reusable content snippets and macros List all snippets for the workspace. **Authorization:** Requires `workflows:read` scope **Response:** List of [SnippetResponse](#snippet-response) *** ### Create[​](#create "Direct link to Create") **`POST /api/v2/w/{workspace_uuid}/snippets`** **Description:** Reusable content snippets and macros Create a new snippet. **Authorization:** Requires `workflows:write` scope **Parameters:** * `request` - See [CreateSnippetRequest](#create-snippet-request) **Response:** See [SnippetResponse](#snippet-response) *** ### Delete Snippet Id[​](#delete-snippet-id "Direct link to Delete Snippet Id") **`DELETE /api/v2/w/{workspace_uuid}/snippets/{snippet_id}`** **Description:** Reusable content snippets and macros Delete a snippet. Returns usage info for any templates referencing it. **Authorization:** Requires `workflows:write` scope **Parameters:** * `snippet_id` (Integer) **Response:** See [dict](#dict) *** ### Get Snippet Id[​](#get-snippet-id "Direct link to Get Snippet Id") **`GET /api/v2/w/{workspace_uuid}/snippets/{snippet_id}`** **Description:** Reusable content snippets and macros Get a specific snippet by ID. **Authorization:** Requires `workflows:read` scope **Parameters:** * `snippet_id` (Integer) **Response:** See [SnippetResponse](#snippet-response) *** ### Update Snippet Id[​](#update-snippet-id "Direct link to Update Snippet Id") **`PUT /api/v2/w/{workspace_uuid}/snippets/{snippet_id}`** **Description:** Reusable content snippets and macros Update an existing snippet. **Authorization:** Requires `workflows:write` scope **Parameters:** * `snippet_id` (Integer) * `request` - See [UpdateSnippetRequest](#update-snippet-request) **Response:** See [SnippetResponse](#snippet-response) *** --- # Tasks **Tags:** `automation`, `tasks`, `workflows` ## Endpoints[​](#endpoints "Direct link to Endpoints") * [`GET `](#get)- List * [`POST `](#post)- Create * [`DELETE /{task_id}`](#delete-task-id) - Delete Task Id * [`GET /{task_id}`](#get-task-id) - Get Task Id * [`PUT /{task_id}`](#put-task-id) - Update Task Id * [`PUT /{task_id}/archive`](#put-task-id-archive) - Update Archive * [`POST /{task_id}/clone`](#post-task-id-clone) - Clone * [`PUT /{task_id}/unarchive`](#put-task-id-unarchive) - Update Unarchive ### List[​](#list "Direct link to List") **`GET /api/v2/w/{workspace_uuid}/tasks`** **Description:** Task execution and monitoring List all tasks accessible to the authenticated member. Returns a collection of tasks that the member can access based on workspace management permissions. Tasks represent specific AI agent operations within workflows. Use this endpoint to view all available tasks for management, monitoring, or selection purposes. **Query Parameters:** * `include_archived`: Include archived tasks in results (optional, default: false) * `workflow_id`: Filter tasks by specific workflow ID (optional, integer) **Response:** Returns an array of TaskResponse objects, each containing complete task configuration, associated workflow information, child-task links, abilities, event rules, and enabled features. **Permissions:** Requires valid workspace membership with `manage_workspace` permission. Only workspace managers can list all tasks. **Error Responses:** * `401 Unauthorized`: Authentication required or invalid session * `403 Forbidden`: User lacks `manage_workspace` permission **Related Endpoints:** * `GET /tasks/{task_id}` - Get a specific task * `POST /tasks` - Create a new task * `GET /workflows/{workflow_id}` - Get tasks within a workflow **Authorization:** Requires `workflows:read` scope **Parameters:** * `include_archived` (Boolean) * `workflow_id` (Integer) * `sortBy` (TaskSortField) * `sortOrder` (SortOrder) **Response:** List of [TaskResponse](#task-response) *** ### Create[​](#create "Direct link to Create") **`POST /api/v2/w/{workspace_uuid}/tasks`** **Description:** Task execution and monitoring Create a new task in the workspace. Creates a task with specified configuration including prompts, guards, child-task links, abilities, event rules, and workflow assignment. Tasks define specific AI agent behavior within a workflow. **Request Body:** Contains task creation parameters including: * `name`: Task display name (required, string) * `taskType`: Task category/type (optional, string) * `configuration`: Task-specific configuration (optional, object) * `description`: Task purpose description (optional, string) * `prompt`: Main instruction prompt for the AI agent (optional, string) * `shortPrompt`: Brief task summary (optional, string) * `workflowId`: Associated workflow ID (required, integer) * `isAdmin`: Whether the task is admin-only (optional, boolean) * `childTasks`: Child task associations and routing metadata (optional) * `celGuard`: CEL condition for entering the task (optional, string) * `posX`, `posY`: Workflow diagram position (optional, number) * `abilities`: Task-scoped abilities (optional, array) * `eventRules`: Task-scoped event rules (optional, array) **Response:** Returns a TaskResponse object with the newly created task including all configuration, associations, and default settings. **Permissions:** Requires valid workspace membership with `manage_workspace` permission. Only workspace managers can create tasks. **Error Responses:** * `400 Bad Request`: Invalid request data or validation failure * `401 Unauthorized`: Authentication required or invalid session * `403 Forbidden`: User lacks `manage_workspace` permission * `500 Internal Server Error`: Failed to create task **Related Endpoints:** * `GET /tasks` - List all tasks * `PUT /tasks/{task_id}` - Update the created task * `POST /tasks/import` - Import a task from export data **Authorization:** Requires `workflows:write` scope **Parameters:** * `request` - See [CreateTaskRequest](#create-task-request) **Response:** See [TaskResponse](#task-response) *** ### Delete Task Id[​](#delete-task-id "Direct link to Delete Task Id") **`DELETE /api/v2/w/{workspace_uuid}/tasks/{task_id}`** **Description:** Task execution and monitoring Delete a task permanently. Removes a task from the workspace. This operation is restricted to prevent accidental deletion of tasks with active assignments. Tasks with existing assignments cannot be deleted and must be archived instead. Use this endpoint carefully as deletion is permanent. **Path Parameters:** * `id`: Unique identifier of the task to delete (integer) **Response:** Returns deletion confirmation: * `status`: "deleted" string confirming successful deletion **Permissions:** Requires valid workspace membership with `manage_workspace` permission. Only workspace managers can delete tasks. **Error Responses:** * `400 Bad Request`: Task is not archived (archive it first) * `401 Unauthorized`: Authentication required or invalid session * `403 Forbidden`: User lacks `manage_workspace` permission * `404 Not Found`: Task with specified ID does not exist * `409 Conflict`: Task has active assignment references and cannot be deleted * `500 Internal Server Error`: Unexpected error during deletion **Related Endpoints:** * `PUT /tasks/{task_id}/archive` - Archive task instead of deleting * `GET /tasks/{task_id}` - View task before deletion * `GET /tasks/{task_id}/export` - Export task before deletion for backup **Authorization:** Requires `workflows:admin` scope **Parameters:** * `task_id` (Integer) *** ### Get Task Id[​](#get-task-id "Direct link to Get Task Id") **`GET /api/v2/w/{workspace_uuid}/tasks/{task_id}`** **Description:** Task execution and monitoring Retrieve a specific task by its identifier. Fetches complete task details including configuration, associated workflow, child-task links, abilities, event rules, and prompt templates. This endpoint accepts multiple identifier formats: numeric ID or UUID. Use this when you need detailed information about a specific task. **Path Parameters:** * `id`: Task identifier (can be integer ID or UUID string) **Response:** Returns a TaskResponse object containing complete task configuration including prompts, guards, child-task links, abilities, event rules, workflow information, and feature settings. **Permissions:** Requires valid workspace membership with `manage_workspace` permission. Only workspace managers can view task details. **Error Responses:** * `401 Unauthorized`: Authentication required or invalid session * `403 Forbidden`: User lacks `manage_workspace` permission * `404 Not Found`: Task not found or member lacks access * `500 Internal Server Error`: Failed to retrieve task data **Related Endpoints:** * `GET /tasks` - List all tasks * `PUT /tasks/{task_id}` - Update a task * `DELETE /tasks/{task_id}` - Delete a task **Authorization:** Requires `workflows:read` scope **Parameters:** * `task_id` (String) **Response:** See [TaskResponse](#task-response) *** ### Update Task Id[​](#update-task-id "Direct link to Update Task Id") **`PUT /api/v2/w/{workspace_uuid}/tasks/{task_id}`** **Description:** Task execution and monitoring Update an existing task's configuration. Modifies task settings including prompts, guards, child-task links, abilities, event rules, and workflow assignment. Use this endpoint to refine task behavior, update AI instructions, or adjust automation as workflows evolve. **Path Parameters:** * `id`: Unique identifier of the task to update (integer) **Request Body:** Contains task update parameters (all optional): * `name`: Updated task display name (string) * `taskType`: Updated task category/type (string) * `configuration`: Updated task-specific configuration (object) * `description`: Updated task description (string) * `prompt`: Updated AI instruction prompt (string) * `shortPrompt`: Updated brief task summary (string) * `workflowId`: Updated workflow association (integer) * `isAdmin`: Updated admin-only flag (boolean) * `childTasks`: Replacement child task associations and routing metadata * `celGuard`: Updated CEL condition for entering the task * `posX`, `posY`: Updated workflow diagram position * `abilities`: Replacement task-scoped abilities * `eventRules`: Replacement task-scoped event rules **Response:** Returns a TaskResponse object with the updated task configuration including all associations and current settings. **Permissions:** Requires valid workspace membership with `manage_workspace` permission. Only workspace managers can update tasks. **Error Responses:** * `400 Bad Request`: Invalid request data or validation failure * `401 Unauthorized`: Authentication required or invalid session * `403 Forbidden`: User lacks `manage_workspace` permission * `404 Not Found`: Task with specified ID does not exist * `500 Internal Server Error`: Failed to update task **Related Endpoints:** * `GET /tasks/{task_id}` - View task before updating * `DELETE /tasks/{task_id}` - Delete a task * `PUT /tasks/{task_id}/archive` - Archive instead of updating **Authorization:** Requires `workflows:write` scope **Parameters:** * `task_id` (Integer) * `request` - See [UpdateTaskRequest](#update-task-request) **Response:** See [TaskResponse](#task-response) *** ### Update Archive[​](#update-archive "Direct link to Update Archive") **`PUT /api/v2/w/{workspace_uuid}/tasks/{task_id}/archive`** **Description:** Task execution and monitoring Archive a task to hide it from active lists. Marks a task as archived, removing it from default task listings while preserving all data and history. Archived tasks cannot be selected for new assignments but existing assignments remain functional. Use this instead of deletion to maintain historical data while decluttering active task lists. **Path Parameters:** * `id`: Unique identifier of the task to archive (integer) **Response:** Returns a TaskResponse object with the archived task showing updated status and all preserved configuration. **Permissions:** Requires valid workspace membership with `manage_workspace` permission. Only workspace managers can archive tasks. **Error Responses:** * `400 Bad Request`: Task is set as default task for a workflow (must be changed first) * `401 Unauthorized`: Authentication required or invalid session * `403 Forbidden`: User lacks `manage_workspace` permission * `404 Not Found`: Task with specified ID does not exist * `500 Internal Server Error`: Archiving operation failed **Related Endpoints:** * `PUT /tasks/{task_id}/unarchive` - Restore archived task * `GET /tasks?include_archived=true` - List including archived tasks * `DELETE /tasks/{task_id}` - Permanently delete a task **Authorization:** Requires `workflows:write` scope **Parameters:** * `task_id` (Integer) **Response:** See [TaskResponse](#task-response) *** ### Clone[​](#clone "Direct link to Clone") **`POST /api/v2/w/{workspace_uuid}/tasks/{task_id}/clone`** **Description:** Task execution and monitoring Clone an existing task with all its dependencies including abilities. Creates a complete copy of a task including: * Task configuration (prompts, settings, etc.) * Data type associations * File associations * Child task relationships * Event rules * Abilities (task-scoped integration settings) The cloned task will be created with a new name and optionally a new slug. All dependencies will be mapped to existing resources in the workspace. **Path Parameters:** * `id`: Unique identifier of the task to clone (integer) **Request Body:** * `name`: Name for the cloned task (required) * `slug`: URL-friendly identifier for the cloned task (optional, auto-generated if not provided) **Response:** Returns a TaskResponse object containing the newly created cloned task. **Permissions:** Requires valid workspace membership with `manage_workspace` permission. Only workspace managers can clone tasks. **Error Responses:** * `400 Bad Request`: Invalid request data or cloning failed * `401 Unauthorized`: Authentication required or invalid session * `403 Forbidden`: User lacks `manage_workspace` permission * `404 Not Found`: Task not found or member lacks access * `500 Internal Server Error`: Clone operation failed **Related Endpoints:** * `GET /tasks/{task_id}/export` - Export a task for transfer to another workspace * `POST /tasks/import` - Import a task from export data * `POST /tasks` - Create a new task from scratch **Authorization:** Requires `workflows:write` scope **Parameters:** * `task_id` (Integer) * `request` - See [CloneTaskRequest](#clone-task-request) **Response:** See [TaskResponse](#task-response) *** ### Update Unarchive[​](#update-unarchive "Direct link to Update Unarchive") **`PUT /api/v2/w/{workspace_uuid}/tasks/{task_id}/unarchive`** **Description:** Task execution and monitoring Restore an archived task to active status. Unarchives a previously archived task, making it visible in default task listings and available for new assignments. All task configuration and history are preserved during archiving. Use this endpoint to reactivate tasks that were temporarily hidden. **Path Parameters:** * `id`: Unique identifier of the task to unarchive (integer) **Response:** Returns a TaskResponse object with the restored task showing active status and all preserved configuration. **Permissions:** Requires valid workspace membership with `manage_workspace` permission. Only workspace managers can unarchive tasks. **Error Responses:** * `401 Unauthorized`: Authentication required or invalid session * `403 Forbidden`: User lacks `manage_workspace` permission * `404 Not Found`: Task with specified ID does not exist * `500 Internal Server Error`: Unarchiving operation failed **Related Endpoints:** * `PUT /tasks/{task_id}/archive` - Archive a task again * `GET /tasks` - List active tasks (now includes unarchived task) * `PUT /tasks/{task_id}` - Update unarchived task configuration **Authorization:** Requires `workflows:write` scope **Parameters:** * `task_id` (Integer) **Response:** See [TaskResponse](#task-response) *** --- # Toolkits **Tags:** `ai`, `tools` ## Endpoints[​](#endpoints "Direct link to Endpoints") * [`GET `](#get)- List ### List[​](#list "Direct link to List") **`GET /api/v2/w/{workspace_uuid}/toolkits`** **Description:** Available AI toolkits and capabilities List all available toolkits for the workspace based on enabled features. Toolkits group related tools together and are returned in MCP (Model Context Protocol) format. Each toolkit contains: * name: unique identifier (e.g., "base", "browser", "data") * displayName: human-readable name * description: optional description of the toolkit's purpose * tools: list of tools in the toolkit Each tool name follows the format: `\{toolkit_name}:\{tool_slug}`. Connected MCP servers may refresh OAuth tokens and fetch tool definitions from the remote server when listing toolkits. **Authorization:** Requires `agents:read` scope **Response:** See [ToolkitsResponse](#toolkits-response) *** --- # Webhook Logs **Tags:** `integrations`, `logging`, `webhooks` ## Endpoints[​](#endpoints "Direct link to Endpoints") * [`GET `](#get)- List ### List[​](#list "Direct link to List") **`GET /api/v2/w/{workspace_uuid}/webhook-logs`** **Description:** Webhook request history and debugging List all webhook logs for the workspace with pagination. **Authorization:** Requires `webhooks:read` scope **Parameters:** * `page` (Integer) * `pageSize` (Integer) * `sortBy` (WebhookLogSortField) * `sortOrder` (SortOrder) * `eventType` (EventRuleEventType) * `success` (Boolean) **Response:** See [PaginatedResponse\[WebhookLogResponse\]](#paginated-response%5B-webhook-log-response%5D) *** --- # Workflow Versions **Tags:** `versions`, `workflows` ## Endpoints[​](#endpoints "Direct link to Endpoints") * [`GET `](#get)- List * [`POST `](#post)- Create * [`GET /active`](#get-active) - Active * [`GET /diff`](#get-diff) - Diff * [`GET /{version_number}`](#get-version-number) - Get Version Number * [`PATCH /{version_number}`](#patch-version-number) - Update Version Number * [`POST /{version_number}/activate`](#post-version-number-activate) - Activate * [`POST /{version_number}/deactivate`](#post-version-number-deactivate) - Deactivate ### List[​](#list "Direct link to List") **`GET /api/v2/w/{workspace_uuid}/workflows/{workflow_uuid}/versions`** **Description:** Draft/publish lifecycle for workflows. The live workflow is the draft; published versions are immutable snapshots. List all published versions of a workflow, newest first. **Authorization:** Requires `workflows:read` scope **Parameters:** * `workflow_uuid` (String) **Response:** See [WorkflowVersionListResponse](#workflow-version-list-response) *** ### Create[​](#create "Direct link to Create") **`POST /api/v2/w/{workspace_uuid}/workflows/{workflow_uuid}/versions`** **Description:** Draft/publish lifecycle for workflows. The live workflow is the draft; published versions are immutable snapshots. Publish the current live workflow as a new immutable version. **Authorization:** Requires `workflows:write` scope **Parameters:** * `workflow_uuid` (String) * `request` - See [PublishVersionRequest](#publish-version-request) **Response:** See [WorkflowVersionResponse](#workflow-version-response) *** ### Active[​](#active "Direct link to Active") **`GET /api/v2/w/{workspace_uuid}/workflows/{workflow_uuid}/versions/active`** **Description:** Draft/publish lifecycle for workflows. The live workflow is the draft; published versions are immutable snapshots. Get the active published version with full snapshot. **Authorization:** Requires `workflows:read` scope **Parameters:** * `workflow_uuid` (String) **Response:** See [WorkflowVersionDetailResponse](#workflow-version-detail-response) *** ### Diff[​](#diff "Direct link to Diff") **`GET /api/v2/w/{workspace_uuid}/workflows/{workflow_uuid}/versions/diff`** **Description:** Draft/publish lifecycle for workflows. The live workflow is the draft; published versions are immutable snapshots. Compare two workflow versions and return a structured diff. Version number 0 means the current live draft workflow. Includes field-level detail with old/new text values for prompts, descriptions, agent identity, etc. **Authorization:** Requires `workflows:read` scope **Parameters:** * `workflow_uuid` (String) * `from_version` (Integer) * `to_version` (Integer) **Response:** See [WorkflowVersionDiffResponse](#workflow-version-diff-response) *** ### Get Version Number[​](#get-version-number "Direct link to Get Version Number") **`GET /api/v2/w/{workspace_uuid}/workflows/{workflow_uuid}/versions/{version_number}`** **Description:** Draft/publish lifecycle for workflows. The live workflow is the draft; published versions are immutable snapshots. Get a specific version by number with full snapshot. **Authorization:** Requires `workflows:read` scope **Parameters:** * `workflow_uuid` (String) * `version_number` (Integer) **Response:** See [WorkflowVersionDetailResponse](#workflow-version-detail-response) *** ### Update Version Number[​](#update-version-number "Direct link to Update Version Number") **`PATCH /api/v2/w/{workspace_uuid}/workflows/{workflow_uuid}/versions/{version_number}`** **Description:** Draft/publish lifecycle for workflows. The live workflow is the draft; published versions are immutable snapshots. Update mutable metadata (name, changeSummary) of a published version. **Authorization:** Requires `workflows:write` scope **Parameters:** * `workflow_uuid` (String) * `version_number` (Integer) * `request` - See [UpdateVersionRequest](#update-version-request) **Response:** See [WorkflowVersionResponse](#workflow-version-response) *** ### Activate[​](#activate "Direct link to Activate") **`POST /api/v2/w/{workspace_uuid}/workflows/{workflow_uuid}/versions/{version_number}/activate`** **Description:** Draft/publish lifecycle for workflows. The live workflow is the draft; published versions are immutable snapshots. Activate a version to receive new assignments. **Authorization:** Requires `workflows:write` scope **Parameters:** * `workflow_uuid` (String) * `version_number` (Integer) **Response:** See [WorkflowVersionResponse](#workflow-version-response) *** ### Deactivate[​](#deactivate "Direct link to Deactivate") **`POST /api/v2/w/{workspace_uuid}/workflows/{workflow_uuid}/versions/{version_number}/deactivate`** **Description:** Draft/publish lifecycle for workflows. The live workflow is the draft; published versions are immutable snapshots. Deactivate a version so it no longer receives new assignments. **Authorization:** Requires `workflows:write` scope **Parameters:** * `workflow_uuid` (String) * `version_number` (Integer) **Response:** See [WorkflowVersionResponse](#workflow-version-response) *** --- # Workspace.Workflows.Activity **Tags:** `automation`, `workflows` ## Endpoints[​](#endpoints "Direct link to Endpoints") * [`GET /activity/batch`](#get-activity-batch) - Batch * [`GET /{workflow_id}/activity`](#get-workflow-id-activity) - Activity ### Batch[​](#batch "Direct link to Batch") **`GET /api/v2/w/{workspace_uuid}/workflows/activity/batch`** **Description:** Workflow creation and management Get activity statistics for multiple workflows in a single request. **Query Parameters:** * `workflow_ids`: Comma-separated list of workflow IDs (e.g., "1,2,3") * `days`: Number of days of sparkline data to return (1-90, default 7) **Response:** Returns a dict mapping workflow ID (as string key) to activity object: * `chatCount`: Total number of chats (integer) * `sparklineData`: Array of integers representing daily chat counts (oldest to newest) **Authorization:** Requires `workflows:read` scope **Parameters:** * `workflow_ids` (String) * `days` (Integer) *** ### Activity[​](#activity "Direct link to Activity") **`GET /api/v2/w/{workspace_uuid}/workflows/{workflow_id}/activity`** **Description:** Workflow creation and management Get activity statistics for a workflow. Returns sparkline data showing chat activity over the specified number of days. **Path Parameters:** * `workflow_id`: Unique identifier of the workflow (integer) **Query Parameters:** * `days`: Number of days of sparkline data to return (1-90, default 7) **Response:** Returns an object containing: * `chatCount`: Total number of chats (integer) * `sparklineData`: Array of integers representing daily chat counts (oldest to newest) **Permissions:** Requires `workflows:read` and workflow read visibility. **Error Responses:** * `401 Unauthorized`: Authentication required or invalid session * `403 Forbidden`: User lacks workflow read visibility * `404 Not Found`: Workflow with specified ID does not exist * `422 Unprocessable Entity`: Invalid days parameter (must be 1-90) **Related Endpoints:** * `GET /workflows/{workflow_id}` - Get workflow details * `GET /workflows` - List all workflows **Authorization:** Requires `workflows:read` scope **Parameters:** * `workflow_id` (Integer) * `days` (Integer) *** --- # Workspace.Workflows.Contributors **Tags:** `automation`, `workflows` ## Endpoints[​](#endpoints "Direct link to Endpoints") * [`GET /{workflow_id}/contributors`](#get-workflow-id-contributors) - Contributors * [`POST /{workflow_id}/contributors`](#post-workflow-id-contributors) - Contributors * [`DELETE /{workflow_id}/contributors/{contributor_id}`](#delete-workflow-id-contributors-contributor-id) - Delete Contributors * [`PATCH /{workflow_id}/contributors/{contributor_id}`](#patch-workflow-id-contributors-contributor-id) - Update Contributors ### Contributors[​](#contributors "Direct link to Contributors") **`GET /api/v2/w/{workspace_uuid}/workflows/{workflow_id}/contributors`** **Description:** Workflow creation and management List all contributors for a workflow. **Authentication:** Requires workspace member **Parameters:** * `workflow_id` (Integer) **Response:** List of [WorkflowContributorResponse](#workflow-contributor-response) *** ### Contributors[​](#contributors-1 "Direct link to Contributors") **`POST /api/v2/w/{workspace_uuid}/workflows/{workflow_id}/contributors`** **Description:** Workflow creation and management Add a contributor to a workflow. **Authorization:** Requires `workflows:write` scope **Parameters:** * `workflow_id` (Integer) * `request` - See [CreateWorkflowContributorRequest](#create-workflow-contributor-request) **Response:** See [WorkflowContributorResponse](#workflow-contributor-response) *** ### Delete Contributors[​](#delete-contributors "Direct link to Delete Contributors") **`DELETE /api/v2/w/{workspace_uuid}/workflows/{workflow_id}/contributors/{contributor_id}`** **Description:** Workflow creation and management Remove a contributor from a workflow. **Authorization:** Requires `workflows:admin` scope **Parameters:** * `workflow_id` (Integer) * `contributor_id` (Integer) **Response:** See [dict](#dict) *** ### Update Contributors[​](#update-contributors "Direct link to Update Contributors") **`PATCH /api/v2/w/{workspace_uuid}/workflows/{workflow_id}/contributors/{contributor_id}`** **Description:** Workflow creation and management Update a workflow contributor. **Authorization:** Requires `workflows:write` scope **Parameters:** * `workflow_id` (Integer) * `contributor_id` (Integer) * `request` - See [UpdateWorkflowContributorRequest](#update-workflow-contributor-request) **Response:** See [WorkflowContributorResponse](#workflow-contributor-response) *** --- # Workspace.Workflows.Crud **Tags:** `automation`, `workflows` ## Endpoints[​](#endpoints "Direct link to Endpoints") * [`DELETE /{workflow_id}`](#delete-workflow-id) - Delete Workflow Id * [`GET /{workflow_id}`](#get-workflow-id) - Get Workflow Id * [`PUT /{workflow_id}`](#put-workflow-id) - Update Workflow Id * [`POST /{workflow_id}/archive`](#post-workflow-id-archive) - Archive * [`POST /{workflow_id}/clone`](#post-workflow-id-clone) - Clone * [`GET /{workflow_id}/deletion-preview`](#get-workflow-id-deletion-preview) - Deletion Preview * [`POST /{workflow_id}/unarchive`](#post-workflow-id-unarchive) - Unarchive ### Delete Workflow Id[​](#delete-workflow-id "Direct link to Delete Workflow Id") **`DELETE /api/v2/w/{workspace_uuid}/workflows/{workflow_id}`** **Description:** Workflow creation and management Delete a workflow permanently. Removes a workflow from the workspace. By default, workflows with tasks cannot be deleted. Set cascade=true to delete the workflow and all its associated tasks. Deletion requires workspace admin scope and workflow delete/admin authority. **Path Parameters:** * `workflow_id`: Unique identifier of the workflow to delete (integer) **Query Parameters:** * `cascade`: If true, deletes workflow and all associated tasks (boolean, default: false) **Response:** Returns a success status object: * `status`: "success" string confirming deletion * `deletedTaskCount`: Number of tasks deleted (only when cascade=true) **Permissions:** Requires `workflows:admin` and workflow delete/admin authority. **Error Responses:** * `400 Bad Request`: Workflow has existing tasks and cascade=false * `401 Unauthorized`: Authentication required or invalid session * `403 Forbidden`: User lacks delete authority * `404 Not Found`: Workflow with specified ID does not exist **Related Endpoints:** * `GET /workflows/{workflow_id}/deletion-preview` - Preview what will be deleted * `GET /workflows/{workflow_id}` - Get workflow details before deletion * `PUT /workflows/{workflow_id}` - Update workflow instead of deleting * `POST /workflows/{workflow_id}/clone` - Clone workflow before deletion **Authorization:** Requires `workflows:admin` scope **Parameters:** * `workflow_id` (Integer) * `cascade` (Boolean) *** ### Get Workflow Id[​](#get-workflow-id "Direct link to Get Workflow Id") **`GET /api/v2/w/{workspace_uuid}/workflows/{workflow_id}`** **Description:** Workflow creation and management Retrieve a specific workflow by its identifier. Fetches complete workflow details including all associated tasks, configuration, and permissions. This endpoint accepts multiple identifier formats for flexibility: numeric ID or UUID. Use this when you need to view or edit a specific workflow's complete configuration. **Path Parameters:** * `workflow_id`: Workflow identifier (can be integer ID or UUID string) **Response:** Returns a WorkflowResponse object containing: * `id`: Unique workflow identifier (integer) * `uuid`: Universal unique identifier (UUID string) * `name`: Workflow display name (string) * `description`: Workflow purpose description (string, nullable) * `ownerId`: ID of the member who owns the workflow (integer) * `agentId`: ID of the associated agent member (integer, nullable) * `startTaskId`: ID of the start task for this workflow (integer, nullable) * `tasks`: Array of associated tasks (TaskResponse objects) * `permissions`: Object with `use` and `edit` boolean flags * `createdAt`: Creation timestamp (ISO 8601) * `updatedAt`: Last modification timestamp (ISO 8601) **Permissions:** Requires valid workspace membership and "use" permission on the workflow. Members without appropriate permissions will receive a 403 error even if the workflow exists. **Error Responses:** * `401 Unauthorized`: Authentication required or invalid session * `403 Forbidden`: User lacks "use" permission on this workflow * `404 Not Found`: Workflow with specified identifier does not exist **Related Endpoints:** * `GET /workflows` - List all workflows * `PUT /workflows/{workflow_id}` - Update a workflow * `DELETE /workflows/{workflow_id}` - Delete a workflow **Authentication:** Requires workspace member **Parameters:** * `workflow_id` (String) **Response:** See [WorkflowResponse](#workflow-response) *** ### Update Workflow Id[​](#update-workflow-id "Direct link to Update Workflow Id") **`PUT /api/v2/w/{workspace_uuid}/workflows/{workflow_id}`** **Description:** Workflow creation and management Update an existing workflow's configuration. Modifies workflow settings including name, description, associated agent, and default task. Use this endpoint to refine workflows as your business processes evolve or to update configuration after initial creation. **Path Parameters:** * `workflow_id`: Unique identifier of the workflow to update (integer) **Request Body:** Contains workflow update parameters (all optional): * `name`: Updated workflow display name (string) * `description`: Updated workflow description (string) * `prompt`: Updated workflow-level instruction prompt (string, nullable) * `ownerId`: Updated owner member ID (integer) * `agentId`: Updated associated agent ID (integer) * `startTaskId`: Updated start task ID (integer, nullable) * `defaultPhoneNumberId`: Updated default phone number ID (integer, nullable) * `defaultInboxId`: Updated default inbox ID (integer, nullable) * `posX`: Workflow diagram X position (number, nullable) * `posY`: Workflow diagram Y position (number, nullable) * `abilities`: Replacement workflow-level abilities (array) * `eventRules`: Replacement workflow-level event rules (array) * `memberRoleAccess`: Replacement role access policy (array; requires admin permission) **Response:** Returns a WorkflowResponse object with the updated workflow configuration, including all associated tasks and current permissions. **Permissions:** Requires valid workspace membership and "edit" permission on the workflow. Only workflow owners or members with appropriate permissions can update. **Error Responses:** * `400 Bad Request`: Invalid request data or validation failure * `401 Unauthorized`: Authentication required or invalid session * `403 Forbidden`: User lacks "edit" permission on this workflow * `404 Not Found`: Workflow with specified ID does not exist **Related Endpoints:** * `GET /workflows/{workflow_id}` - Get workflow details * `DELETE /workflows/{workflow_id}` - Delete a workflow * `POST /workflows/{workflow_id}/clone` - Clone a workflow **Authorization:** Requires `workflows:write` scope **Parameters:** * `workflow_id` (Integer) * `data` - See [UpdateWorkflowRequest](#update-workflow-request) **Response:** See [WorkflowResponse](#workflow-response) *** ### Archive[​](#archive "Direct link to Archive") **`POST /api/v2/w/{workspace_uuid}/workflows/{workflow_id}/archive`** **Description:** Workflow creation and management Archive a workflow. Archives a workflow, hiding it from the default workflow list. Archived workflows cannot be used to create new assignments, but existing assignments remain accessible. Members with workflow edit authority can archive workflows. **Path Parameters:** * `workflow_id`: Unique identifier of the workflow to archive (integer) **Response:** Returns a success status object: * `status`: "success" string confirming archival **Permissions:** Requires `workflows:write` and workflow edit authority. **Error Responses:** * `401 Unauthorized`: Authentication required or invalid session * `403 Forbidden`: User lacks workflow edit authority * `404 Not Found`: Workflow with specified ID does not exist **Related Endpoints:** * `POST /workflows/{workflow_id}/unarchive` - Unarchive a workflow * `DELETE /workflows/{workflow_id}` - Delete a workflow permanently **Authorization:** Requires `workflows:write` scope **Parameters:** * `workflow_id` (Integer) *** ### Clone[​](#clone "Direct link to Clone") **`POST /api/v2/w/{workspace_uuid}/workflows/{workflow_id}/clone`** **Description:** Workflow creation and management Clone a workflow with all tasks and associations. Creates a complete copy of an existing workflow including all associated tasks, task configurations, and relationships. Use this endpoint to duplicate successful workflows for reuse, create variations, or establish templates from existing work. The cloned workflow becomes owned by the requesting member. **Path Parameters:** * `workflow_id`: Unique identifier of the workflow to clone (integer) **Request Body:** Contains cloning parameters: * `name`: Display name for the cloned workflow (required, string) **Response:** Returns a WorkflowResponse object with the newly cloned workflow containing: * New unique identifiers (id and uuid) * Copied configuration and settings * Cloned tasks with preserved configurations * Permissions for the current member (as owner) **Permissions:** Requires valid workspace membership with "use" permission on the source workflow and permission to create workflows in the workspace. The cloned workflow is owned by the member who performs the cloning operation. **Error Responses:** * `401 Unauthorized`: Authentication required or invalid session * `403 Forbidden`: User lacks "use" permission on source workflow or cannot create workflows * `404 Not Found`: Workflow with specified ID does not exist * `409 Conflict`: A workflow with the specified name already exists * `500 Internal Server Error`: Failed to reload cloned workflow data **Related Endpoints:** * `GET /workflows/{workflow_id}` - View workflow before cloning * `POST /workflows` - Create new workflow from scratch * `POST /workflows/templates/{template_uuid}/create-workflow` - Create from template **Authorization:** Requires `workflows:write` scope **Parameters:** * `workflow_id` (Integer) * `data` - See [CloneWorkflowRequest](#clone-workflow-request) **Response:** See [WorkflowResponse](#workflow-response) *** ### Deletion Preview[​](#deletion-preview "Direct link to Deletion Preview") **`GET /api/v2/w/{workspace_uuid}/workflows/{workflow_id}/deletion-preview`** **Description:** Workflow creation and management Preview what will be deleted/archived when deleting a workflow. Returns information about all tasks that will be deleted along with the workflow, and whether there are any assignments associated with this workflow. **Path Parameters:** * `workflow_id`: Unique identifier of the workflow (integer) **Response:** Returns an object containing: * `taskCount`: Number of tasks that will be deleted (integer) * `tasks`: Array of task objects with id, name, and description * `hasAssignments`: Whether this workflow has any assignments (boolean) **Permissions:** Requires valid workspace membership and "edit" permission on the workflow. **Error Responses:** * `401 Unauthorized`: Authentication required or invalid session * `403 Forbidden`: User lacks "edit" permission * `404 Not Found`: Workflow with specified ID does not exist **Authentication:** Requires workspace member **Parameters:** * `workflow_id` (Integer) *** ### Unarchive[​](#unarchive "Direct link to Unarchive") **`POST /api/v2/w/{workspace_uuid}/workflows/{workflow_id}/unarchive`** **Description:** Workflow creation and management Unarchive a workflow. Restores an archived workflow, making it visible in the default workflow list and available for creating new assignments. Members with workflow edit authority can unarchive workflows. **Path Parameters:** * `workflow_id`: Unique identifier of the workflow to unarchive (integer) **Response:** Returns a success status object: * `status`: "success" string confirming unarchival **Permissions:** Requires `workflows:write` and workflow edit authority. **Error Responses:** * `401 Unauthorized`: Authentication required or invalid session * `403 Forbidden`: User lacks workflow edit authority * `404 Not Found`: Workflow with specified ID does not exist **Related Endpoints:** * `POST /workflows/{workflow_id}/archive` - Archive a workflow * `GET /workflows?archived=true` - List archived workflows **Authorization:** Requires `workflows:write` scope **Parameters:** * `workflow_id` (Integer) *** --- # Workspace.Workflows.List **Tags:** `automation`, `workflows` ## Endpoints[​](#endpoints "Direct link to Endpoints") * [`GET /templates`](#get-templates) - Templates * [`POST /templates/{template_uuid}/create-workflow`](#post-templates-template-uuid-create-workflow) - Create Workflow ### Templates[​](#templates "Direct link to Templates") **`GET /api/v2/w/{workspace_uuid}/workflows/templates`** **Description:** Workflow creation and management List all available workflow templates with feature availability status. Returns all registered workflow templates including pre-built configurations for common use cases like appointment booking, lead qualification, and customer support. Each template includes availability status based on the workspace's enabled features. **Query Parameters:** None **Response:** Returns an array of WorkflowTemplateResponse objects, each containing: * `uuid`: Unique template identifier (UUID string) * `name`: Template display name (string) * `shortDescription`: Brief template description (string) * `longDescription`: Detailed template explanation (string) * `category`: Template category (string) * `requiredFeatures`: Array of required feature flags (string array) * `isAvailable`: Whether template can be used in this workspace (boolean) * `iconName`: Icon identifier for UI display (string, nullable) **Permissions:** Requires valid workspace membership. All members can view templates, but availability depends on workspace feature flags and subscription level. **Error Responses:** * `401 Unauthorized`: Authentication required or invalid session * `403 Forbidden`: Member lacks workspace access **Related Endpoints:** * `POST /workflows/templates/{template_uuid}/create-workflow` - Create workflow from template * `GET /workflows` - List all workflows * `POST /workflows` - Create a custom workflow **Authorization:** Requires `workflows:read` scope **Response:** List of [WorkflowTemplateResponse](#workflow-template-response) *** ### Create Workflow[​](#create-workflow "Direct link to Create Workflow") **`POST /api/v2/w/{workspace_uuid}/workflows/templates/{template_uuid}/create-workflow`** **Description:** Workflow creation and management Create a new workflow from a pre-configured template. Instantiates a workflow based on a registered template, including all associated tasks, assistants, and configurations. Templates provide quick-start solutions for common workflows like appointment scheduling, lead qualification, or customer support. The endpoint validates feature requirements and creates all necessary resources in a single operation. **Path Parameters:** * `template_uuid`: Unique identifier of the workflow template (UUID string) **Request Body:** Contains workflow creation parameters: * `name`: Display name for the new workflow (required, string) **Response:** Returns a WorkflowResponse object with the newly created workflow including: * Complete workflow configuration * Associated tasks and default task settings * Calendar configurations (for scheduling templates) * Permissions for the current member **Permissions:** Requires valid workspace membership. Template availability depends on workspace feature flags and subscription level. Some templates may require specific enabled features to be instantiated. **Error Responses:** * `400 Bad Request`: Required feature not enabled for template * `401 Unauthorized`: Authentication required or invalid session * `404 Not Found`: Template UUID does not exist * `500 Internal Server Error`: Failed to create workflow or missing dependencies * `501 Not Implemented`: Template creation not yet implemented for this template type **Related Endpoints:** * `GET /workflows/templates` - List available workflow templates * `GET /workflows` - List all workflows * `GET /workflows/{workflow_id}` - Get created workflow details **Authorization:** Requires `workflows:write` scope **Parameters:** * `template_uuid` (String) * `data` - See [CreateWorkflowFromTemplateRequest](#create-workflow-from-template-request) **Response:** See [WorkflowResponse](#workflow-response) *** --- # Workspace.Workflows.Media **Tags:** `automation`, `workflows` ## Endpoints[​](#endpoints "Direct link to Endpoints") * [`GET /{workflow_id}/diagram`](#get-workflow-id-diagram) - Diagram * [`GET /{workflow_id}/thumbnail`](#get-workflow-id-thumbnail) - Thumbnail ### Diagram[​](#diagram "Direct link to Diagram") **`GET /api/v2/w/{workspace_uuid}/workflows/{workflow_id}/diagram`** **Description:** Workflow creation and management Get a Mermaid diagram representation of a workflow. Returns a Mermaid flowchart definition that can be rendered client-side. The diagram shows the workflow structure with tasks as nodes and their connections as edges. By default only **active** tasks are rendered, matching the active task list. Archived tasks (and edges touching them) are excluded so they don't appear as live-but-orphaned nodes. Pass `include_archived=true` to render archived tasks as well — they get a distinct dashed-grey style and an "(archived)" label so they are never mistaken for active tasks. **Path Parameters:** * `workflow_id`: Unique identifier of the workflow (integer) **Query Parameters:** * `include_archived`: Render archived tasks (distinctly styled) in addition to active ones (optional, default: false) **Response:** Returns an object containing: * `mermaid`: Mermaid diagram definition (string) * `taskCount`: Total number of tasks in the workflow, active + archived (integer) * `archivedTaskCount`: How many of those tasks are archived (integer) * `includeArchived`: Whether archived tasks were rendered (boolean) **Permissions:** Requires valid workspace membership and "use" permission on the workflow. **Error Responses:** * `401 Unauthorized`: Authentication required or invalid session * `403 Forbidden`: User lacks "use" permission * `404 Not Found`: Workflow with specified ID does not exist **Authentication:** Requires workspace member **Parameters:** * `workflow_id` (Integer) * `include_archived` (Boolean) *** ### Thumbnail[​](#thumbnail "Direct link to Thumbnail") **`GET /api/v2/w/{workspace_uuid}/workflows/{workflow_id}/thumbnail`** **Description:** Workflow creation and management Get an SVG thumbnail representation of a workflow. Returns a compact SVG diagram showing the workflow structure with tasks as nodes and their connections as edges, styled to match the React Flow workflow diagram. **Path Parameters:** * `workflow_id`: Unique identifier of the workflow (integer) **Response:** Returns SVG content with Content-Type: image/svg+xml **Permissions:** Requires valid workspace membership and "use" permission on the workflow. **Error Responses:** * `401 Unauthorized`: Authentication required or invalid session * `403 Forbidden`: User lacks "use" permission * `404 Not Found`: Workflow with specified ID does not exist **Authentication:** Requires workspace member **Parameters:** * `workflow_id` (Integer) *** --- # Workspace.Workflows.Stats **Tags:** `automation`, `workflows` ## Endpoints[​](#endpoints "Direct link to Endpoints") * [`GET /{workflow_id}/task-assignment-stats`](#get-workflow-id-task-assignment-stats) - Task Assignment Stats * [`GET /{workflow_id}/tasks/{task_id}/chats`](#get-workflow-id-tasks-task-id-chats) - Chats ### Task Assignment Stats[​](#task-assignment-stats "Direct link to Task Assignment Stats") **`GET /api/v2/w/{workspace_uuid}/workflows/{workflow_id}/task-assignment-stats`** **Description:** Workflow creation and management Get current assignment count for each task in a workflow. Returns aggregated data showing how many assignments are currently on each task. Useful for workflow visualization and identifying bottlenecks. **Path Parameters:** * `workflow_id`: Unique identifier of the workflow (integer) **Query Parameters:** * `from_date`: Filter assignments created on or after this date (ISO 8601 format, e.g., 2024-01-15) * `to_date`: Filter assignments created on or before this date (ISO 8601 format, e.g., 2024-01-20) **Response:** Returns a dictionary mapping task IDs to assignment counts: ``` { 123: {"count": 5}, 456: {"count": 3} } ``` **Permissions:** Requires valid workspace membership and "use" permission on the workflow. **Error Responses:** * `401 Unauthorized`: Authentication required or invalid session * `403 Forbidden`: User lacks "use" permission on this workflow * `404 Not Found`: Workflow with specified ID does not exist **Authentication:** Requires workspace member **Parameters:** * `workflow_id` (Integer) * `from_date` (String) * `to_date` (String) *** ### Chats[​](#chats "Direct link to Chats") **`GET /api/v2/w/{workspace_uuid}/workflows/{workflow_id}/tasks/{task_id}/chats`** **Description:** Workflow creation and management Get list of chats on a specific task in a workflow. Returns a paginated list of chats that are currently assigned to a specific task. Useful for viewing all chats at a particular workflow task. **Path Parameters:** * `workflow_id`: Unique identifier of the workflow (integer) * `task_id`: Unique identifier of the task (integer) **Query Parameters:** * `from_date`: Filter assignments created on or after this date (ISO 8601 format) * `to_date`: Filter assignments created on or before this date (ISO 8601 format) * `limit`: Maximum number of results to return (integer, default: 100, max: 500) * `offset`: Number of results to skip for pagination (integer, default: 0) **Response:** Returns a TaskChatsListResponse containing: * `items`: Array of task chat objects with: * `chatId`: Chat identifier * `chatUuid`: Chat UUID * `title`: Chat title * `summary`: Chat summary * `assignmentId`: Current assignment ID * `memberName`: Name of assigned member * `memberId`: ID of assigned member * `currentTaskName`: Name of current task * `workflowName`: Name of workflow * `lastMessageAt`: Timestamp of last message * `messageCount`: Number of messages in the chat * `total`: Total count of matching chats * `limit`: Limit used for pagination * `offset`: Offset used for pagination **Permissions:** Requires valid workspace membership and "use" permission on the workflow. **Error Responses:** * `400 Bad Request`: Invalid date format or parameters * `401 Unauthorized`: Authentication required or invalid session * `403 Forbidden`: User lacks "use" permission on this workflow * `404 Not Found`: Workflow or task not found **Authentication:** Requires workspace member **Parameters:** * `workflow_id` (Integer) * `task_id` (Integer) * `from_date` (String) * `to_date` (String) * `limit` (Integer) * `offset` (Integer) **Response:** See [TaskChatsListResponse](#task-chats-list-response) *** --- # Workspace.Workflows.Validation **Tags:** `automation`, `workflows` ## Endpoints[​](#endpoints "Direct link to Endpoints") * [`GET /{workflow_id}/route-dry-run`](#get-workflow-id-route-dry-run) - Route Dry Run * [`GET /{workflow_id}/validate-access`](#get-workflow-id-validate-access) - Validate Access * [`GET /{workflow_id}/validate-config`](#get-workflow-id-validate-config) - Validate Config ### Route Dry Run[​](#route-dry-run "Direct link to Route Dry Run") **`GET /api/v2/w/{workspace_uuid}/workflows/{workflow_id}/route-dry-run`** **Description:** Workflow creation and management Trace automatic routing for a Chat without performing the transition. Replays the same routing logic the platform uses at the next turn, but does not change Assignment state. Use this to see which child Task would be selected for a given Chat and optional task overrides. **Path parameters** * `workflow_id`: Workflow to evaluate. **Query parameters** * `chat_id`: Chat on an Assignment in that Workflow. * `current_task_id` (optional): Override the active Task for evaluation. * `current_assignment_task_id` (optional): Override the active Assignment Task for evaluation. **Response:** Task and Assignment identifiers, candidate child Task IDs, the winning child Task ID when one is selected, and `errorType` when evaluation fails. CEL expressions, form values, Member fields, Chat content, and raw error messages are not returned. **Permissions:** Workflow edit access on `workflow_id` and read access to `chat_id` (Assignment owner or `chats:read` scope). Read-only Workflow access is not sufficient because the trace exposes routing topology and Task IDs. **Authentication:** Requires workspace member **Parameters:** * `workflow_id` (Integer) * `chat_id` (Integer) * `current_task_id` (Integer) * `current_assignment_task_id` (Integer) **Response:** See [WorkflowRouteDryRunResponse](#workflow-route-dry-run-response) *** ### Validate Access[​](#validate-access "Direct link to Validate Access") **`GET /api/v2/w/{workspace_uuid}/workflows/{workflow_id}/validate-access`** **Description:** Workflow creation and management Validate that roles with workflow access also have access to dependency resources. Checks all abilities on the workflow and its tasks, then verifies that each role with workflow USE access also has access to the forms, files, folders, and calendars referenced by those abilities. Each ability type defines its own validation logic via the AbilityRegistry. **Path Parameters:** * `workflow_id`: Unique identifier of the workflow (integer) **Response:** Returns a WorkflowAccessValidationResponse containing: * `warnings`: Array of WorkflowAccessWarning objects describing missing access **Permissions:** Requires valid workspace membership and "edit" permission on the workflow. **Authentication:** Requires workspace member **Parameters:** * `workflow_id` (Integer) **Response:** See [WorkflowAccessValidationResponse](#workflow-access-validation-response) *** ### Validate Config[​](#validate-config "Direct link to Validate Config") **`GET /api/v2/w/{workspace_uuid}/workflows/{workflow_id}/validate-config`** **Description:** Workflow creation and management Validate that this workflow's abilities reference live workspace resources. Calls `collect_config_issues` on every ability (enabled or not) and aggregates non-blocking diagnostics (for example, files or folders that were deleted after the ability was saved). Runtime resolution stays resilient regardless — this route exists to surface drift to operators before they re-enable something or save an unrelated change that would drag broken config along with it. **Path Parameters:** * `workflow_id`: Unique identifier of the workflow (integer) **Response:** Returns a WorkflowConfigValidationResponse containing: * `issues`: Array of AbilityConfigIssue entries describing config drift **Permissions:** Requires valid workspace membership and "edit" permission on the workflow. **Authentication:** Requires workspace member **Parameters:** * `workflow_id` (Integer) **Response:** See [WorkflowConfigValidationResponse](#workflow-config-validation-response) *** --- # Menu **Tags:** `customization`, `navigation`, `workspace` ## Endpoints[​](#endpoints "Direct link to Endpoints") * [`GET /{site_id}/menu`](#get-site-id-menu) - Menu * [`GET /{site_id}/menu/items`](#get-site-id-menu-items) - Items * [`POST /{site_id}/menu/items`](#post-site-id-menu-items) - Items * [`DELETE /{site_id}/menu/items/{item_id}`](#delete-site-id-menu-items-item-id) - Delete Items * [`PUT /{site_id}/menu/items/{item_id}`](#put-site-id-menu-items-item-id) - Update Items * [`POST /{site_id}/menu/reorder`](#post-site-id-menu-reorder) - Reorder ### Menu[​](#menu-1 "Direct link to Menu") **`GET /api/v2/w/{workspace_uuid}/menu/{site_id}/menu`** **Description:** Workspace menu customization and navigation Get the complete menu tree for a site, with optional locale for translated labels. **Authorization:** Requires `sites:read` scope **Parameters:** * `site_id` (Integer) * `locale` (String) **Response:** See [MenuTreeResponse](#menu-tree-response) *** ### Items[​](#items "Direct link to Items") **`GET /api/v2/w/{workspace_uuid}/menu/{site_id}/menu/items`** **Description:** Workspace menu customization and navigation Get all menu items for a site, optionally filtered by parent. **Authorization:** Requires `sites:read` scope **Parameters:** * `site_id` (Integer) * `parent_id` (Integer) **Response:** List of [MenuItemResponse](#menu-item-response) *** ### Items[​](#items-1 "Direct link to Items") **`POST /api/v2/w/{workspace_uuid}/menu/{site_id}/menu/items`** **Description:** Workspace menu customization and navigation Create a new menu item. **Authorization:** Requires `sites:write` scope **Parameters:** * `site_id` (Integer) * `request` - See [CreateMenuItemRequest](#create-menu-item-request) **Response:** See [MenuItemResponse](#menu-item-response) *** ### Delete Items[​](#delete-items "Direct link to Delete Items") **`DELETE /api/v2/w/{workspace_uuid}/menu/{site_id}/menu/items/{item_id}`** **Description:** Workspace menu customization and navigation Delete a menu item and all its children. **Authorization:** Requires `sites:admin` scope **Parameters:** * `site_id` (Integer) * `item_id` (Integer) **Response:** See [dict](#dict) *** ### Update Items[​](#update-items "Direct link to Update Items") **`PUT /api/v2/w/{workspace_uuid}/menu/{site_id}/menu/items/{item_id}`** **Description:** Workspace menu customization and navigation Update an existing menu item. **Authorization:** Requires `sites:write` scope **Parameters:** * `site_id` (Integer) * `item_id` (Integer) * `request` - See [UpdateMenuItemRequest](#update-menu-item-request) **Response:** See [MenuItemResponse](#menu-item-response) *** ### Reorder[​](#reorder "Direct link to Reorder") **`POST /api/v2/w/{workspace_uuid}/menu/{site_id}/menu/reorder`** **Description:** Workspace menu customization and navigation Reorder menu items within the same parent. **Authorization:** Requires `sites:write` scope **Parameters:** * `site_id` (Integer) * `request` - See [ReorderMenuItemsRequest](#reorder-menu-items-request) **Response:** See [dict](#dict) *** --- # Developer Guides Welcome to the Gravity Rail developer guides! These focused guides walk you through key aspects of working with Gravity Rail: ## Getting Started[​](#getting-started "Direct link to Getting Started") * **[Getting Started with Integration](https://docs.gravityrail.com/developer/guides/getting-started-integration.md)** - Complete onboarding guide from member registration to webhooks and MCP * **[Authentication](https://docs.gravityrail.com/developer/guides/authentication.md)** - OAuth 2.0 and API key setup * **[Error Handling](https://docs.gravityrail.com/developer/guides/error-handling.md)** - Standard API error response format, status codes, and PHI-safe error design * **[Claude Skills for Gravity Rail](https://docs.gravityrail.com/developer/guides/claude-skills.md)** - Install the Gravity Rail plugin for Claude Code and Cowork ## Core Data Management[​](#core-data-management "Direct link to Core Data Management") * **[Understanding Data](https://docs.gravityrail.com/developer/guides/data-in-gravity-rail.md)** - Understanding data types, fields, records, and the permissions system * **[Importing Data](https://docs.gravityrail.com/developer/guides/importing-data.md)** - How to populate Gravity Rail with data via APIs and UIs * **[Exporting Data](https://docs.gravityrail.com/developer/guides/exporting-data.md)** - How to extract data from Gravity Rail and subscribe to real-time updates via webhooks ## User & Account Management[​](#user--account-management "Direct link to User & Account Management") * **[Importing Members](https://docs.gravityrail.com/developer/guides/importing-members.md)** - How to create and manage users in your workspace ## Trust, Safety & Compliance[​](#trust-safety--compliance "Direct link to Trust, Safety & Compliance") * **[HIPAA Compliance](https://docs.gravityrail.com/developer/guides/hipaa-compliance.md)** - How HIPAA compliance works on Gravity Rail and how to enable it for healthcare workspaces * **[AI Disclosure Requirements](https://docs.gravityrail.com/developer/guides/ai-disclosure-requirements.md)** - Disclosing AI usage to end users ## Next Steps[​](#next-steps "Direct link to Next Steps") New to Gravity Rail? Start with **[Getting Started with Integration](https://docs.gravityrail.com/developer/guides/getting-started-integration.md)** for a complete walkthrough of the essential integration steps. For detailed topics, each guide builds on core concepts. **Understanding Data in Gravity Rail** explains the data model, while import/export guides show you how to move data in and out. For the complete API reference, see [API Reference](https://docs.gravityrail.com/developer/api/index). --- # AI Disclosure Requirements When building applications with Gravity Rail's AI agents, voice agents, or chatbots, you must inform your end users that they are interacting with AI. This page outlines the disclosure requirements and provides guidance on implementation. ## Why Disclosure Matters[​](#why-disclosure-matters "Direct link to Why Disclosure Matters") Many jurisdictions require businesses to disclose when customers are interacting with AI rather than humans. Beyond legal compliance, transparent disclosure builds trust with your users and sets appropriate expectations for the interaction. ## Core Requirements[​](#core-requirements "Direct link to Core Requirements") When using Gravity Rail's AI features, you must inform end users of two key points: 1. **AI Interaction Notice**: Users should understand they're engaging with artificial intelligence, not a human. 2. **Data Handling Disclosure**: Users should be informed that their conversations may be recorded and processed by AI systems, including third-party AI providers. ## When to Disclose[​](#when-to-disclose "Direct link to When to Disclose") The disclosure must appear **before** any AI interaction begins. Users should not be able to interact with an AI agent without first seeing this notice. Common presentation methods include: * Separate disclosure screens before starting a chat * Pop-up notifications when initiating a conversation * Persistent on-screen banners during the interaction * Verbal statements at the start of voice calls * Terms acceptance during user onboarding ## Sample Disclosure Language[​](#sample-disclosure-language "Direct link to Sample Disclosure Language") ### Written Disclosure[​](#written-disclosure "Direct link to Written Disclosure") You may adapt the following language for your application: > **AI Agent Notice** > > This \[chat/call/conversation] is powered by an AI agent. By continuing, you acknowledge that: > > * You are interacting with artificial intelligence, not a human > * Your communications may be recorded and processed > * Conversation data may be shared with our AI service providers for processing > * Data may be used to improve our services > > For more information, please review our \[Privacy Policy]. ### Verbal Disclosure (Voice Calls)[​](#verbal-disclosure-voice-calls "Direct link to Verbal Disclosure (Voice Calls)") For voice-based AI interactions, include a brief disclosure at the start of the call: > "Hi, this is \[Agent Name], an AI agent from \[Company]. This call may be recorded. For our privacy policy, visit \[URL]. How can I help you today?" ## Implementation with Gravity Rail[​](#implementation-with-gravity-rail "Direct link to Implementation with Gravity Rail") ### API Integrations[​](#api-integrations "Direct link to API Integrations") If you're building custom integrations with Gravity Rail's API: 1. Ensure your application displays appropriate disclosures before initiating AI conversations 2. Log user acknowledgment of disclosures where required by your jurisdiction 3. Include disclosure requirements in your application's terms of service ## Legal Considerations[​](#legal-considerations "Direct link to Legal Considerations") **Important**: You are responsible for ensuring compliance with all applicable laws and regulations in your jurisdiction. This guidance is informational only and does not constitute legal advice. Consult with qualified legal counsel to determine the specific requirements for your use case and location. Different jurisdictions may have varying requirements, including: * Consumer protection laws requiring AI disclosure * Privacy regulations governing data collection and processing * Industry-specific regulations (healthcare, finance, etc.) * Recording consent requirements for voice calls ## Additional Resources[​](#additional-resources "Direct link to Additional Resources") * [Gravity Rail Privacy Policy](https://www.gravityrail.com/privacy) * [Gravity Rail Terms of Service](https://www.gravityrail.com/tos) * Contact for compliance questions --- # Authentication Gravity Rail supports two authentication methods: OAuth 2.0 for third-party applications and API Keys for direct API access. ## OAuth 2.0 (Recommended for Apps)[​](#oauth-20-recommended-for-apps "Direct link to OAuth 2.0 (Recommended for Apps)") OAuth 2.0 is the recommended authentication method for third-party applications that need to access Gravity Rail on behalf of users. ### Why Use OAuth 2.0?[​](#why-use-oauth-20 "Direct link to Why Use OAuth 2.0?") OAuth enables your users to securely connect their Gravity Rail accounts to your application without sharing their passwords. This provides several key benefits: * **Secure User Access**: Users can authorize your app to access Gravity Rail's extensive APIs on their behalf * **Comprehensive API Access**: Build powerful integrations using Gravity Rail's APIs for data import/export, task management, workflow automation, and more * **User Control**: Users can revoke access to your app at any time from their settings * **Fine-Grained Permissions**: Request only the specific permissions (scopes) your application needs * **Industry Standard**: OAuth 2.0 is a proven security standard used by major platforms worldwide ### Prerequisites: Create a Builder Profile[​](#prerequisites-create-a-builder-profile "Direct link to Prerequisites: Create a Builder Profile") Before you can create your first OAuth app, you need to establish your developer identity by creating a Builder Profile. This profile represents you or your organization as an app developer. ![Builder Profile Form](/assets/images/create-builder-profile-form-1ac11e257806d59b3f94c191ae04febb.png) **To create a Builder Profile:** 1. Log in to your Gravity Rail account 2. Open your account menu (top-right) and go to **Account → Apps** tab 3. You'll see a welcome screen prompting you to create a Builder Profile 4. Click "Create Builder Profile" and fill in: * **Profile Name** (required): Your name or organization name (e.g., "Acme Inc") * **Description** (optional): What kind of integrations you're building * **Website** (optional): Your website or company URL Once created, your Builder Profile will be associated with all apps you develop. ### Creating an OAuth App[​](#creating-an-oauth-app "Direct link to Creating an OAuth App") After setting up your Builder Profile, you can create OAuth applications: 1. Go to **Account → Apps** tab and select the **Apps** sub-tab 2. Click "Create Application" 3. Fill in the app creation form across four tabs: #### General Tab[​](#general-tab "Direct link to General Tab") ![Create App - General Tab](/assets/images/create-app-form-general-f734ed4b4ad57fb8573859dc766cf89e.png) Configure basic app information: * **Builder Profile** (required): Select your Builder Profile from the dropdown * **Application Name** (required): A descriptive name for your app (e.g., "Project Management Sync") * **Description** (optional): What your application does and how it integrates with Gravity Rail * **MCP Server URL** (optional): If building an MCP (Model Context Protocol) server, provide its URL for automatic OAuth integration #### Authentication Tab[​](#authentication-tab "Direct link to Authentication Tab") ![Create App - Authentication Tab](/assets/images/create-app-form-authentication-ee7530bb62a9d54011b46618fc62dada.png) Configure OAuth 2.0 settings: * **OAuth Redirect URIs**: Add one or more callback URLs where users will be redirected after authorization (e.g., `https://yourapp.com/oauth/callback`) * **Authorization Server URL** (optional): Leave empty to use Gravity Rail's default authorization server * **OAuth Response Types**: * **code** - Authorization Code Flow (recommended) - checked by default * **token** - Implicit Flow (less secure, not recommended) #### Permissions Tab[​](#permissions-tab "Direct link to Permissions Tab") ![Create App - Permissions Tab](/assets/images/create-app-form-permissions-cc6620e7a5df8bf1a1a9b12023e0316b.png) Select the OAuth scopes your application needs. Available scopes are organized by category: * **Account**: `account:read`, `account:write`, `account:create` * **Workspace**: `workspace:read`, `workspace:write`, `workspace:delete` * **Member**: `members:read`, `members:write`, `members:admin` * **Agent**: `assistants:read`, `assistants:write`, `assistants:admin` * **Data**: `data:read`, `data:write`, `data:delete`, `data:admin` * **Task**: `task:read`, `task:write`, `task:delete`, `task:execute` * **Chat**: `chats:read`, `chats:write`, `chats:admin` * **Workflow**: `workflows:read`, `workflows:write`, `workflows:delete` * **Site**: `sites:read`, `sites:write`, `sites:publish` * **Export**: `export:read`, `export:read-all` * **Admin**: `admin:superuser` Choose only the permissions your app actually needs following the principle of least privilege. #### Sharing Tab[​](#sharing-tab "Direct link to Sharing Tab") ![Create App - Sharing Tab](/assets/images/create-app-form-sharing-c0f2d43d8d7046ac2bf7c8046ce4cf8e.png) Control app visibility and access: * **Public Application**: Toggle to make your app available to all workspaces * **Share with Workspaces**: If not public, select specific workspaces that can use your app (leave empty to allow all your workspaces) 4. Click "Create App" to save After creation, you'll receive: * **Client ID**: Public identifier for your app (format: `gr_app_...`) * **Client Secret**: Private secret for confidential clients (format: `gr_app_priv_...`) **Important**: Copy and securely store your Client Secret immediately - you won't be able to view it again! ### OAuth 2.0 Authorization Flow[​](#oauth-20-authorization-flow "Direct link to OAuth 2.0 Authorization Flow") Gravity Rail implements the OAuth 2.0 Authorization Code flow with PKCE support for enhanced security. **Step 1: Authorization Request** Redirect users to the authorization endpoint: ``` https://api.gravityrail.com/api/v2/oauth/authorize? response_type=code& client_id=YOUR_CLIENT_ID& redirect_uri=YOUR_REDIRECT_URI& scope=REQUESTED_SCOPES& state=RANDOM_STATE& code_challenge=YOUR_CODE_CHALLENGE& code_challenge_method=S256 ``` **Step 2: User Authorization** Users will be presented with a consent screen to approve your app's access. **Step 3: Authorization Code** After approval, users are redirected to your `redirect_uri` with an authorization code: ``` https://yourapp.com/callback?code=AUTHORIZATION_CODE&state=RANDOM_STATE ``` **Step 4: Exchange Code for Token** Exchange the authorization code for an access token: ``` curl -X POST https://api.gravityrail.com/api/v2/oauth/token \ -H "Content-Type: application/x-www-form-urlencoded" \ -d "grant_type=authorization_code" \ -d "code=AUTHORIZATION_CODE" \ -d "redirect_uri=YOUR_REDIRECT_URI" \ -d "client_id=YOUR_CLIENT_ID" \ -d "client_secret=YOUR_CLIENT_SECRET" \ -d "code_verifier=YOUR_CODE_VERIFIER" ``` **Step 5: Use Access Token** Include the access token in API requests: ``` curl https://api.gravityrail.com/api/v2/workflows \ -H "Authorization: Bearer ACCESS_TOKEN" ``` ### PKCE (Proof Key for Code Exchange)[​](#pkce-proof-key-for-code-exchange "Direct link to PKCE (Proof Key for Code Exchange)") PKCE is required for public clients (mobile/desktop apps) and recommended for all OAuth flows. 1. Generate a random `code_verifier` 2. Create `code_challenge` = BASE64URL(SHA256(code\_verifier)) 3. Use `code_challenge_method=S256` ## API Keys (Direct Access)[​](#api-keys-direct-access "Direct link to API Keys (Direct Access)") For server-to-server integrations or direct API access, you can use API keys. ### Creating an API Key[​](#creating-an-api-key "Direct link to Creating an API Key") 1. Log in to your Gravity Rail account 2. Open **Settings** (top-right) and select **API Keys** under the **Developer** section 3. Click **Create API Key** 4. Name the key, choose scopes and expiration, then create it 5. Copy and securely store your API key — the full secret is shown once ### Using API Keys[​](#using-api-keys "Direct link to Using API Keys") Include your API key in the `Authorization` header: ``` curl https://api.gravityrail.com/api/v2/workflows \ -H "Authorization: Bearer YOUR_API_KEY" ``` ## SMART on FHIR Backend Services (Healthcare Integrations)[​](#smart-on-fhir-backend-services-healthcare-integrations "Direct link to SMART on FHIR Backend Services (Healthcare Integrations)") For healthcare integrators connecting Gravity Rail to EHR systems such as eClinicalWorks, Epic, or Cerner, Gravity Rail supports [SMART on FHIR Backend Services](https://hl7.org/fhir/smart-app-launch/backend-services.html) authentication using asymmetric client authentication (`private_key_jwt`). Use this auth method when you need to verify Gravity Rail-issued JWTs, or when an EHR requires registering a JWKS URL for your tenant. ### JWKS Endpoint[​](#jwks-endpoint "Direct link to JWKS Endpoint") Gravity Rail publishes its public signing keys at: ``` https://api.gravityrail.com/.well-known/jwks.json ``` The endpoint returns a [JWK Set (RFC 7517)](https://datatracker.ietf.org/doc/html/rfc7517) with one or more public keys: ``` { "keys": [ { "kty": "RSA", "use": "sig", "alg": "RS384", "kid": "a1b2c3d4e5f6g7h8", "n": "...", "e": "AQAB" } ] } ``` * **Algorithm**: `RS384` (RSA with SHA-384) — required by the SMART on FHIR spec * **Key size**: 3072 bits * **Caching**: the endpoint sets `Cache-Control: public, max-age=3600`; respect it and refresh at least hourly so key rotations are picked up * **Rotation**: multiple keys may appear in the set during rotation windows — always select by `kid`, not array position ### OAuth Discovery[​](#oauth-discovery "Direct link to OAuth Discovery") Client capabilities and the `jwks_uri` are advertised via [OAuth 2.0 Authorization Server Metadata (RFC 8414)](https://datatracker.ietf.org/doc/html/rfc8414): ``` https://api.gravityrail.com/.well-known/oauth-authorization-server ``` Relevant fields: | Field | Value | | -------------------------------------------------- | --------------------------------------------------- | | `jwks_uri` | `https://api.gravityrail.com/.well-known/jwks.json` | | `token_endpoint_auth_methods_supported` | includes `private_key_jwt` | | `token_endpoint_auth_signing_alg_values_supported` | `["RS384", "ES384"]` | ### When to Use `private_key_jwt` vs API Keys[​](#when-to-use-private_key_jwt-vs-api-keys "Direct link to when-to-use-private_key_jwt-vs-api-keys") | Scenario | Recommended auth | | ----------------------------------------------------------- | --------------------------------- | | SMART on FHIR backend services integration with an EHR | `private_key_jwt` + JWKS | | Third-party service that needs to verify a Gravity Rail JWT | Fetch JWKS, verify with `RS384` | | Generic server-to-server REST calls | API Keys | | User-delegated access from a third-party app | OAuth 2.0 authorization code flow | ### Verifying a Gravity Rail JWT[​](#verifying-a-gravity-rail-jwt "Direct link to Verifying a Gravity Rail JWT") Use `PyJWKClient` so the correct key is selected by the JWT's `kid` header and the JWKS is cached between calls: ``` import jwt from jwt import PyJWKClient jwks_client = PyJWKClient("https://api.gravityrail.com/.well-known/jwks.json") signing_key = jwks_client.get_signing_key_from_jwt(token) decoded = jwt.decode( token, signing_key.key, algorithms=["RS384"], audience="your-audience", ) ``` `PyJWKClient` refreshes the key set when an unknown `kid` is seen, which handles Gravity Rail's key rotations transparently. ## Security Best Practices[​](#security-best-practices "Direct link to Security Best Practices") ### For OAuth Apps[​](#for-oauth-apps "Direct link to For OAuth Apps") 1. **Store client secrets securely** - Never expose in client-side code 2. **Use PKCE** for all public clients (mobile/desktop apps) 3. **Validate redirect URIs** - Only use registered URIs 4. **Implement state parameter** - Prevent CSRF attacks 5. **Use HTTPS** - All redirect URIs must use HTTPS (except localhost) ### For API Keys[​](#for-api-keys "Direct link to For API Keys") 1. **Never expose API keys** in client-side code or version control 2. **Use environment variables** to store API keys 3. **Rotate keys regularly** for enhanced security 4. **Revoke compromised keys** immediately via **Settings → API Keys** (workspace keys) or **Account → Apps → API Keys** (account-level keys) 5. **Use workspace-specific keys** when possible for principle of least privilege ## Code Examples[​](#code-examples "Direct link to Code Examples") ### OAuth Example: Node.js[​](#oauth-example-nodejs "Direct link to OAuth Example: Node.js") ``` // Step 1: Redirect to authorization const authUrl = new URL('https://api.gravityrail.com/api/v2/oauth/authorize'); authUrl.searchParams.set('response_type', 'code'); authUrl.searchParams.set('client_id', process.env.CLIENT_ID); authUrl.searchParams.set('redirect_uri', 'https://yourapp.com/callback'); authUrl.searchParams.set('scope', 'workflows:read workflows:write'); authUrl.searchParams.set('state', randomState); // Step 2: Handle callback and exchange code const tokenResponse = await fetch('https://api.gravityrail.com/api/v2/oauth/token', { method: 'POST', headers: { 'Content-Type': 'application/x-www-form-urlencoded', }, body: new URLSearchParams({ grant_type: 'authorization_code', code: authCode, redirect_uri: 'https://yourapp.com/callback', client_id: process.env.CLIENT_ID, client_secret: process.env.CLIENT_SECRET, }), }); const { access_token } = await tokenResponse.json(); // Step 3: Use access token const response = await fetch('https://api.gravityrail.com/api/v2/workflows', { headers: { Authorization: `Bearer ${access_token}`, 'Content-Type': 'application/json', }, }); ``` ### API Key Example: Python[​](#api-key-example-python "Direct link to API Key Example: Python") ``` import os import requests GRAVITYRAIL_API_KEY = os.environ.get('GRAVITYRAIL_API_KEY') headers = { 'Authorization': f'Bearer {GRAVITYRAIL_API_KEY}', 'Content-Type': 'application/json' } response = requests.get( 'https://api.gravityrail.com/api/v2/workflows', headers=headers ) workflows = response.json() ``` --- # Chat Widget Embed Guide The chat widget lets you embed a floating chat launcher on any external site. It renders the full `SiteFloatingChat` experience inside a fixed-position iframe that auto-resizes between a collapsed launcher button and an expanded chat panel. ## How It Works[​](#how-it-works "Direct link to How It Works") A small async script injected into the host page creates the iframe. Authentication uses `SameSite=None; Secure` cookies, so the `authToken` flows through cross-domain without changes to your auth setup. Inline verification (email/SMS OTP) continues to work inside the iframe. The only `postMessage` traffic between parent and iframe is resize events scoped by `widgetId`. The host page cannot read conversation content. ## Production Embed Snippet[​](#production-embed-snippet "Direct link to Production Embed Snippet") ``` ``` ### Required Attributes[​](#required-attributes "Direct link to Required Attributes") | Attribute | Description | | --------------- | --------------------------------------------------------- | | `data-wid` | Workspace UUID | | `data-site` | Site UUID | | `data-workflow` | Workflow slug — determines which workflow starts the chat | ### Optional Attributes[​](#optional-attributes "Direct link to Optional Attributes") | Attribute | Default | Description | | ---------------------- | ------------ | ---------------------------------------------------------------------------------------------- | | `data-locale` | `en` | Locale slug for the chat experience | | `data-title` | — | Headline shown in the launcher popover | | `data-subtitle` | — | Subtitle text inside the launcher | | `data-button` | — | CTA button text inside the launcher | | `data-voice` | — | Set to `true` to enable microphone/voice mode (also grants the iframe `microphone` permission) | | `data-video` | — | Set to `true` to grant the iframe `camera` permission for video features | | `data-open` | — | Set to `true` to start the widget in expanded state | | `data-storage-key` | — | Custom localStorage key for persisting chat state | | `data-launcher-width` | `80` | Collapsed iframe width in pixels | | `data-launcher-height` | `80` | Collapsed iframe height in pixels | | `data-widget-width` | `420` | Expanded iframe width in pixels | | `data-widget-height` | `640` | Expanded iframe height in pixels | | `data-bottom` | `24px` | CSS `bottom` position of the launcher | | `data-right` | `24px` | CSS `right` position of the launcher | | `data-z-index` | `2147483000` | CSS `z-index` of the widget container | | `data-widget-id` | auto | Custom identifier scoped to `postMessage` resize events | ## iframe Permissions[​](#iframe-permissions "Direct link to iframe Permissions") The chat widget iframe `allow` attribute is built from opt-in data attributes. By default it includes only `clipboard-read; clipboard-write; autoplay;` — no microphone or camera. Add the relevant attributes when your embed uses those features: | Attributes set | Resulting `allow` value | | ------------------------------------- | ---------------------------------------------------------------- | | (none — text-only chat) | `clipboard-read; clipboard-write; autoplay;` | | `data-voice="true"` | `clipboard-read; clipboard-write; autoplay; microphone;` | | `data-video="true"` | `clipboard-read; clipboard-write; autoplay; camera;` | | `data-voice="true" data-video="true"` | `clipboard-read; clipboard-write; autoplay; microphone; camera;` | Text-only embeds do not need to disclose microphone/camera permissions in privacy notices, because the iframe never requests them. Add disclosures only for the features you opt into. The host page must be served over HTTPS or browser microphone/camera access will be blocked even if the permission is granted in the `allow` attribute. ## Server-Side Setup[​](#server-side-setup "Direct link to Server-Side Setup") ### Allow the parent domain[​](#allow-the-parent-domain "Direct link to Allow the parent domain") Add the embedding domain to `WIDGET_ALLOWED_PARENT_ORIGINS`. Requests from origins not on this list get a `403`, and the `Content-Security-Policy: frame-ancestors` directive blocks the iframe from rendering at all. ``` # Space- or comma-separated; wildcards supported WIDGET_ALLOWED_PARENT_ORIGINS="https://leapcure.com https://*.leapcure.com" ``` Defaults already include `https://app.gravityrail.com` (prod) and `https://app.gr-staging.com` (staging). ### Cookie configuration[​](#cookie-configuration "Direct link to Cookie configuration") Cross-domain cookies require `SameSite=None; Secure`. Set these in your environment: ``` COOKIE_SAMESITE=none COOKIE_DOMAIN=.gravityrail.com # adjust to match your deployment domain ``` Verify in DevTools → Application → Cookies that both `authToken` and `requestToken` show `SameSite=None` and `Secure`. ## Security Considerations[​](#security-considerations "Direct link to Security Considerations") * **Domain allowlist** — `WIDGET_ALLOWED_PARENT_ORIGINS` is the enforcement boundary. Keep it tight. * **SRI for production** — Add `integrity="sha384-..."` and `crossorigin="anonymous"` to the script tag to prevent tampered loader delivery. * **Host page CSP** — Allow the loader script origin and iframe origin explicitly: ``` Content-Security-Policy: script-src https://app.gravityrail.com; frame-src https://app.gravityrail.com; ``` * **Data isolation** — Conversation data stays in Gravity Rail. The only outbound `postMessage` is resize events; no PHI crosses the frame boundary. * **Compromised host page** — A compromised host can observe the rendered iframe visually. Encourage customers to harden their sites and review their privacy disclosures. ## Local Development[​](#local-development "Direct link to Local Development") ### Prerequisites[​](#prerequisites "Direct link to Prerequisites") Local widget testing requires HTTPS on both the app server and the test host. See [Local HTTPS Development](#local-https-development) below. ### Run the widget test harness[​](#run-the-widget-test-harness "Direct link to Run the widget test harness") ``` yarn dev:widget-host ``` Then open: ``` https://widget-host.test:4444/?wid=&site=&workflow=&locale=en ``` Additional query params: `title`, `subtitle`, `button`, `voice=true`, `launcherWidth`, `launcherHeight`, `widgetWidth`, `widgetHeight`, `src=` (override loader URL for testing local changes to `chat.js`). Example: ``` https://widget-host.test:4444/?wid=00000000-0000-0000-0000-000000000000&site=676936d1-7ba5-4590-b46a-ee7d6c181035&workflow=my-workflow&voice=true&title=Support ``` Add `widget-host.test` to `/etc/hosts`: ``` 127.0.0.1 widget-host.test ``` *** ## Local HTTPS Development[​](#local-https-development "Direct link to Local HTTPS Development") ### Why HTTPS locally?[​](#why-https-locally "Direct link to Why HTTPS locally?") Browsers require HTTPS ("secure context") for: * **Microphone/camera access** — required for voice features * **SameSite=None cookies** — required for cross-domain iframe auth * **Service Workers** — required for PWA features ### Setup[​](#setup "Direct link to Setup") **Install mkcert:** ``` brew install mkcert nss mkcert -install ``` **Generate certificates:** ``` yarn dev:https:regenerate-cert ``` Generates `certs/dev-local-cert.pem` and `certs/dev-local-key.pem` covering: * `localhost` * `*.gravityrail.test` * `*.o.gravityrail.test` * `widget-host.test` * `127.0.0.1` **Add custom domains to `/etc/hosts`:** ``` 127.0.0.1 localhost 127.0.0.1 app.gravityrail.test 127.0.0.1 api.gravityrail.test 127.0.0.1 private-oidc.o.gravityrail.test 127.0.0.1 widget-host.test ``` **Start Next.js with HTTPS:** ``` # Default yarn dev:local:https # Custom hostname NEXT_DEV_HOST=private-oidc.o.gravityrail.test yarn dev:local:https ``` The server binds to `0.0.0.0` for custom domains so all configured `*.gravityrail.test` hostnames resolve to the same server. **Configure cross-domain cookies in `.env.local`:** ``` COOKIE_SAMESITE=none ``` ### Environment Variables[​](#environment-variables "Direct link to Environment Variables") | Variable | Default | Description | | ------------------------------- | ----------------------------- | ------------------------------------------------------------------------- | | `NEXT_DEV_HOST` | `app.gravityrail.test` | Hostname to bind to | | `NEXT_DEV_HTTPS_CERT` | `certs/dev-local-cert.pem` | Path to TLS certificate | | `NEXT_DEV_HTTPS_KEY` | `certs/dev-local-key.pem` | Path to private key | | `WIDGET_ALLOWED_PARENT_ORIGINS` | env-specific defaults | Space/comma-separated list of allowed parent origins (supports wildcards) | | `AUTH_ALLOWED_ORIGINS` | `https://app.gravityrail.com` | Origins permitted to call `/api/auth/complete` | ### Troubleshooting[​](#troubleshooting "Direct link to Troubleshooting") **Microphone not working** * Must be on HTTPS — `https://private-oidc.o.gravityrail.test:3000`, not `http://` * Check browser mic permissions (lock icon in address bar) * Clear site data and retry * Chrome/Edge have better WebRTC support than Safari **Cookies not working across domains** * Verify `COOKIE_SAMESITE=none` in your `.env.local` * Both parent and iframe must be HTTPS * Check DevTools → Application → Cookies for `SameSite=None; Secure` **Certificate errors ("NET::ERR\_CERT\_AUTHORITY\_INVALID")** * Run `mkcert -install` then restart your browser * Regenerate with `yarn dev:https:regenerate-cert` * Verify: `openssl x509 -in certs/dev-local-cert.pem -noout -text | grep -A 5 "Subject Alternative Name"` **"Certificate doesn't cover your domain"** * Use `*.gravityrail.test` or `*.o.gravityrail.test` local hosts * Regenerate the cert and verify the SAN includes `DNS:*.gravityrail.test` **Port 3000 in use** ``` lsof -ti:3000 | xargs kill -9 ``` **Mixed content errors ("blocked:mixed-content")** * Ensure `API_HOST` uses `https://` * WebSocket connections must use `wss://` not `ws://` --- # Claude Skills for Gravity Rail Gravity Rail publishes a free plugin for [Claude Code](https://docs.anthropic.com/en/docs/claude-code) and [Claude Cowork](https://claude.com/blog/cowork-plugins) that gives Claude built-in knowledge of the Gravity Rail SDK and CLI. Once installed, Claude can help you write integrations, explore the API, and troubleshoot issues without leaving your editor or workspace. ## What you get[​](#what-you-get "Direct link to What you get") The **gravity-rail-developer** plugin includes two skills: | Skill | What Claude learns | | ------------- | --------------------------------------------------------------------------------------------------------------------------------------- | | **SDK Guide** | Authentication, method conventions, types, Zod schemas, scopes, error handling, and common integration patterns for `@gravity-rail/sdk` | | **CLI Guide** | Installation, command patterns, domain listing, CRUD recipes, output formats, and scripting tips for `@gravity-rail/cli` | Skills activate automatically when Claude detects you're working with Gravity Rail — no slash commands required. ## Install in Claude Code[​](#install-in-claude-code "Direct link to Install in Claude Code") ### 1. Add the marketplace[​](#1-add-the-marketplace "Direct link to 1. Add the marketplace") Open Claude Code and run: ``` /plugin marketplace add Gravity-Rail/claude-plugins ``` This registers the Gravity Rail marketplace so you can browse its plugins. ### 2. Install the plugin[​](#2-install-the-plugin "Direct link to 2. Install the plugin") ``` /plugin install gravity-rail-developer@gravity-rail-public-marketplace ``` Choose an installation scope when prompted: * **User** — available in all your projects (recommended) * **Project** — shared with everyone on this repository * **Local** — just you, just this repo ### 3. Verify[​](#3-verify "Direct link to 3. Verify") Run `/plugin` and check the **Installed** tab. You should see **gravity-rail-developer** listed. ### Usage[​](#usage "Direct link to Usage") Once installed, the skills are always available. Just ask Claude: ``` How do I create a member with the Gravity Rail SDK? ``` ``` Show me how to list all chats using the CLI ``` ``` What scopes do I need to read data records? ``` Claude will use its knowledge of the SDK and CLI to give you accurate, up-to-date answers with working code examples. ### Keeping up to date[​](#keeping-up-to-date "Direct link to Keeping up to date") To pull the latest skill updates: ``` /plugin marketplace update gravity-rail-public-marketplace ``` ## Install in Claude Cowork[​](#install-in-claude-cowork "Direct link to Install in Claude Cowork") [Claude Cowork](https://claude.com/cowork) is Anthropic's browser-based workspace for getting professional work done with Claude. It supports the same plugin system as Claude Code. ### 1. Open the plugin manager[​](#1-open-the-plugin-manager "Direct link to 1. Open the plugin manager") In a Cowork session, type: ``` /plugin marketplace add Gravity-Rail/claude-plugins ``` ### 2. Install the plugin[​](#2-install-the-plugin-1 "Direct link to 2. Install the plugin") ``` /plugin install gravity-rail-developer@gravity-rail-public-marketplace ``` ### 3. Start using it[​](#3-start-using-it "Direct link to 3. Start using it") Ask Claude anything about Gravity Rail's SDK or CLI. The skills activate automatically based on context. ## What the skills cover[​](#what-the-skills-cover "Direct link to What the skills cover") ### SDK Guide[​](#sdk-guide "Direct link to SDK Guide") * **Authentication** — API keys, OAuth 2.0 with PKCE, member identity switching * **Method conventions** — `get*`, `create*`, `update*`, `delete*` naming patterns * **Domain overview** — members, chats, tasks, workflows, data types, agents, and more * **Type system** — importing types and using Zod schemas for runtime validation * **Scopes and permissions** — which scopes protect which endpoints * **Error handling** — working with `ApiError` and HTTP status codes * **Integration patterns** — webhooks, polling, white-label provisioning ### CLI Guide[​](#cli-guide "Direct link to CLI Guide") * **Installation** — `npm install -g @gravity-rail/cli` or run via `npx` * **Authentication** — OAuth login and API key usage * **Command patterns** — `gr [options]` * **Output formats** — table (default), JSON (`-o json`), piping to `jq` * **Domain listing** — all available domains grouped by category * **CRUD recipes** — list, get, create, update, delete patterns * **Scripting** — chaining commands, extracting IDs, bulk operations ## Requirements[​](#requirements "Direct link to Requirements") * **Claude Code** version 1.0.33 or later * **Claude Cowork** — any paid Claude plan * No Gravity Rail account is needed to install the plugin — the skills provide general guidance. To make API calls, you'll need an [API key](https://docs.gravityrail.com/developer/guides/authentication.md) or [MCP connection](https://docs.gravityrail.com/developer/api/workspace/mcp_servers.md). ## Source code[​](#source-code "Direct link to Source code") The plugin source is open at [github.com/Gravity-Rail/claude-plugins](https://github.com/Gravity-Rail/claude-plugins). Contributions and feedback are welcome. --- # Embeddable Widgets Gravity Rail offers two embeddable widgets for external sites. Each uses the same iframe + `postMessage` architecture and shares the same HTTPS and cookie requirements. * **[Chat Widget](https://docs.gravityrail.com/developer/guides/guides/chat-widget)** — Floating launcher that lets visitors start a chat workflow. Drop a single ` ``` ### Open to a specific member by Gravity Rail ID[​](#open-to-a-specific-member-by-gravity-rail-id "Direct link to Open to a specific member by Gravity Rail ID") ``` ``` ### Open to a specific member by your external ID[​](#open-to-a-specific-member-by-your-external-id "Direct link to Open to a specific member by your external ID") ``` ``` ## Configuration Reference[​](#configuration-reference "Direct link to Configuration Reference") ### Required Attributes[​](#required-attributes "Direct link to Required Attributes") | Attribute | Description | | ----------- | ------------------------------------------- | | `data-wid` | Workspace UUID | | `data-site` | Site UUID (same as used in theme/chat URLs) | ### Member Targeting (optional)[​](#member-targeting-optional "Direct link to Member Targeting (optional)") Provide one of these to open the widget on a specific member's detail page. If neither is set, the widget shows a member search UI. | Attribute | Description | | ------------------ | -------------------------------------------------------------------------------------------------------------------------------------- | | `data-member` | Gravity Rail member ID (numeric). Opens directly to that member. | | `data-external-id` | Your system's external ID (string). The widget looks up the member by their `externalId` field. Returns an error if no match is found. | When a member target is provided: * Member search is hidden by default (`showMemberSearch` becomes `false`) * The operator is locked to that member's context — they cannot navigate to other members To override this and show search even when a member is pre-selected (useful for "start at this member but allow navigation"): | Attribute | Description | | ------------------------- | ----------------------------------------------------------------------------------------------------------------- | | `data-show-member-search` | `true` to show member search even when `data-member` is set. `false` to hide it even when no member is specified. | ### Layout Attributes (optional)[​](#layout-attributes-optional "Direct link to Layout Attributes (optional)") | Attribute | Default | Description | | ---------------- | ------------ | ------------------------------------------------------- | | `data-width` | `480` | Widget width in pixels | | `data-height` | `720` | Widget height in pixels | | `data-top` | `50%` | CSS `top` position (widget is centered by default) | | `data-left` | `50%` | CSS `left` position | | `data-z-index` | `2147483000` | CSS `z-index` of the widget container | | `data-widget-id` | auto | Custom identifier scoped to `postMessage` resize events | ## Member ID vs External ID[​](#member-id-vs-external-id "Direct link to Member ID vs External ID") Use **`data-member`** when you have the Gravity Rail numeric member ID. This is the fastest path — no member lookup required. Use **`data-external-id`** when you have your own system's identifier and have stored it in the member's `externalId` field in Gravity Rail. The widget performs a search on load and finds the exact match. If you haven't populated `externalId` on your members, this won't work — use `data-member` instead or ensure member import/sync is populating that field. If neither is provided, the widget shows a member search input and the operator can find members manually. ## Server-Side Setup[​](#server-side-setup "Direct link to Server-Side Setup") ### Allow the parent domain[​](#allow-the-parent-domain "Direct link to Allow the parent domain") Add the embedding domain to `WIDGET_ALLOWED_PARENT_ORIGINS`. Without this, all requests return `403` and the CSP `frame-ancestors` directive blocks the iframe from rendering. ``` # Space- or comma-separated; wildcards supported WIDGET_ALLOWED_PARENT_ORIGINS="https://leapcure.com https://*.leapcure.com" ``` Defaults already include `https://app.gravityrail.com` (prod) and `https://app.gr-staging.com` (staging). ### Cookie configuration[​](#cookie-configuration "Direct link to Cookie configuration") Cross-domain cookies require `SameSite=None; Secure`: ``` COOKIE_SAMESITE=none COOKIE_DOMAIN=.gravityrail.com # adjust to match your deployment domain ``` Verify in DevTools → Application → Cookies that `authToken` shows `SameSite=None` and `Secure`. ## Authentication[​](#authentication "Direct link to Authentication") The operator widget uses **global Gravity Rail auth**, not workspace-specific member auth. This means: * The person using the embed must be an authenticated Gravity Rail user (staff member, not a patient/member) * If they aren't logged in, the widget displays an inline `InlineAuthPrompt` — they log in inside the iframe * After login, the cookie persists cross-domain via `SameSite=None` so they stay logged in on subsequent loads There is no public/anonymous access. The widget is always gated behind operator credentials. ## Security Considerations[​](#security-considerations "Direct link to Security Considerations") * **Domain allowlist** — `WIDGET_ALLOWED_PARENT_ORIGINS` is the enforcement boundary. Keep it tight to only embedding domains that should have operator access. * **Operator-only** — The widget requires an authenticated Gravity Rail account. Unauthenticated requests see a login prompt, not patient data. * **SRI for production** — Add `integrity="sha384-..."` and `crossorigin="anonymous"` to the script tag to protect against tampered loader delivery. * **Host page CSP** — Allow the loader and iframe origin explicitly: ``` Content-Security-Policy: script-src https://app.gravityrail.com; frame-src https://app.gravityrail.com; ``` * **Data isolation** — Conversation content and member data stay inside the iframe. The only `postMessage` payloads sent to the parent page are resize events. * **`data-external-id` lands in server logs** — When `data-external-id` is used, the external ID is passed as a URL query parameter (`?externalId=...`) to the iframe. This means it appears in server access logs and browser history. If your external IDs are patient identifiers (MRNs, partner patient IDs), use `data-member` with the Gravity Rail numeric ID instead to avoid logging PHI in URLs. ## Local Development[​](#local-development "Direct link to Local Development") Local widget testing requires HTTPS on the app server. See [Local HTTPS Development](https://docs.gravityrail.com/developer/guides/guides/chat-widget#local-https-development) in the chat widget guide — the same setup applies. ### Test the operator widget locally[​](#test-the-operator-widget-locally "Direct link to Test the operator widget locally") 1. Start the app with HTTPS: ``` NEXT_DEV_HOST=private-oidc.o.gravityrail.test yarn dev:local:https ``` 2. Create a test HTML file with the embed snippet pointing at your local server: ``` ``` 3. Serve the test file from a different origin (e.g., `widget-host.test:4444`) to exercise the cross-domain path: ``` yarn dev:widget-host ``` 4. Add `widget-host.test` to your `WIDGET_ALLOWED_PARENT_ORIGINS` in `.env.local`. ### Troubleshooting[​](#troubleshooting "Direct link to Troubleshooting") **Widget shows "Missing or invalid host origin parameter"** * The loader script sets `hostOrigin` automatically from `window.location.origin` * This error means the iframe was loaded directly (not via the loader script) or the origin was malformed * Always embed via the loader script, not by creating the iframe yourself **Widget shows "No member found with that external ID."** * The value passed in `data-external-id` doesn't match any member's `externalId` field * Verify the member's `externalId` is set: `yarn gr members get -w $UUID --id --env prod -o json` * Alternatively, switch to `data-member` with the numeric Gravity Rail member ID **Widget shows login prompt instead of dashboard** * The operator is not authenticated (no valid `authToken` cookie cross-domain) * Verify `COOKIE_SAMESITE=none` is set and both the app and embedding site are HTTPS * Check DevTools → Application → Cookies for `authToken` with `SameSite=None; Secure` **Iframe blocked / CSP violation** * Parent origin is not in `WIDGET_ALLOWED_PARENT_ORIGINS` * Add it and redeploy, or set it in `.env.local` for local testing **Member search not showing** * When `data-member` or `data-external-id` is set, member search is hidden by default * Add `data-show-member-search="true"` to keep search visible **Cookies not working across domains** — see [chat widget troubleshooting](https://docs.gravityrail.com/developer/guides/guides/chat-widget#troubleshooting) --- # Gravity Rail API - Quick Reference **Base URL**: `https://api.gravityrail.com/api/v2` ## Authentication[​](#authentication "Direct link to Authentication") ``` # API Key curl https://api.gravityrail.com/api/v2/w \ -H "Authorization: Bearer YOUR_API_KEY" # OAuth Token curl https://api.gravityrail.com/api/v2/w \ -H "Authorization: Bearer YOUR_ACCESS_TOKEN" ``` ## Essential Endpoints[​](#essential-endpoints "Direct link to Essential Endpoints") ### Workspaces[​](#workspaces "Direct link to Workspaces") ``` # List workspaces GET /w # Get workspace GET /w/{wid} # Update workspace PUT /w/{wid} ``` ### Chats & Messaging[​](#chats--messaging "Direct link to Chats & Messaging") ``` # Create chat POST /w/{wid}/chats { "channel": "web-chat", "workflowId": 1, "title": "Support Chat", "assistantEnabled": true } # Send user message POST /w/{wid}/chats/{chatId}/messages { "content": "Hello, how can I help?" } # Send assistant message (API-initiated) POST /w/{wid}/chats/{chatId}/send-assistant-message { "message": "Hello, how can I help?" } # Get messages GET /w/{wid}/chats/{chatId}/messages # Update chat (assign, pause, etc.) PUT /w/{wid}/chats/{chatId} { "title": "Updated Title", "assignmentId": 42, "paused": false } ``` ### Data Types (CRM)[​](#data-types-crm "Direct link to Data Types (CRM)") ``` # Create data type POST /w/{wid}/data-types { "name": "Customer", "slug": "customer", "fields": [ { "name": "firstName", "slug": "first_name", "fieldType": "text", "required": true, "shouldIndex": true }, { "name": "email", "slug": "email", "fieldType": "email", "shouldIndex": true } ] } # Create record # Note: {dataTypeId} is the numeric ID returned when creating the data type POST /w/{wid}/data-types/{dataTypeId}/records { "fieldValues": { "firstName": "John", "email": "john@example.com" }, "memberId": 123, // optional - record owner "externalId": "CRM-001" // optional - for upsert/sync } # Query records GET /w/{wid}/data-types/{dataTypeId}/records?search=John&page=1&page_size=10 # Update record PUT /w/{wid}/data-types/{dataTypeId}/records/{recordId} { "fieldValues": { "firstName": "Jane", "email": "jane@example.com" } } # Delete record DELETE /w/{wid}/data-types/{dataTypeId}/records/{recordId} # Upsert by external ID POST /w/{wid}/data-types/{dataTypeId}/upsert/{externalId} { "fieldValues": { "firstName": "John", "email": "john@example.com" } } # Bulk create/upsert (up to 10,000 records) POST /w/{wid}/data-types/{dataTypeId}/records/bulk { "records": [ { "fieldValues": {"firstName": "John", "email": "john@example.com"}, "externalId": "CRM-001" }, { "fieldValues": {"firstName": "Jane", "email": "jane@example.com"}, "externalId": "CRM-002" } ], "upsert": false // set true to update existing records by externalId } # Bulk response { "success": true, "totalCount": 2, "importedCount": 2, "results": [ {"index": 0, "status": "created", "recordId": 123, "externalId": "CRM-001"}, {"index": 1, "status": "created", "recordId": 124, "externalId": "CRM-002"} ], "errors": null } ``` ### Tasks & Workflows[​](#tasks--workflows "Direct link to Tasks & Workflows") ``` # Create task POST /w/{wid}/tasks { "name": "Review Document", "slug": "review-doc", "description": "Review the submitted document", "workflowId": 1, "isAdmin": false } # Update task PUT /w/{wid}/tasks/{taskId} { "name": "Review Document - Updated", "description": "Review the document carefully" } # Create workflow POST /w/{wid}/workflows { "name": "Customer Support", "agentId": 2, "defaultPhoneNumberId": 5 } # Update workflow PUT /w/{wid}/workflows/{workflowId} { "name": "Customer Support - Updated", "agentId": 3 } # List workflows GET /w/{wid}/workflows ``` ### Inboxes & Email[​](#inboxes--email "Direct link to Inboxes & Email") ``` # List inboxes GET /w/{wid}/inboxes # Get inbox GET /w/{wid}/inboxes/{inboxId} # Create inbox POST /w/{wid}/inboxes { "email": "support@company.com" } ``` ### Phone & SMS[​](#phone--sms "Direct link to Phone & SMS") ``` # List phone numbers GET /w/{wid}/phone-numbers # Get phone number GET /w/{wid}/phone-numbers/{phoneId} # Create phone number POST /w/{wid}/phone-numbers { "number": "+1234567890" } # Send SMS (via chat — create an SMS chat, then send a message) POST /w/{wid}/chats { "channel": "phone-sms", "workflowId": 1, "memberId": 42, "phoneNumberId": 123, "title": "Outreach" } POST /w/{wid}/chats/{chatId}/send-assistant-message { "message": "Hello" } ``` ### Calendar & Events[​](#calendar--events "Direct link to Calendar & Events") ``` # List calendars GET /w/{wid}/calendars # Create event POST /w/{wid}/calendar-events { "title": "Meeting", "startTime": "2024-01-15T10:00:00Z" } # List events GET /w/{wid}/calendar-events?startTime=...&endTime=... ``` ### Custom Toolkits[​](#custom-toolkits "Direct link to Custom Toolkits") ``` # Create toolkit POST /w/{wid}/custom-toolkits { "name": "Medical Toolkit", "slug": "medical", "description": "Tools for medical operations" } # Create tool POST /w/{wid}/custom-toolkits/{toolkitId}/tools { "name": "check_vitals", "displayName": "Check Patient Vitals", "description": "Retrieve patient vital signs", "prompt": "You are a medical assistant...", "chatModel": "claude-3-5-sonnet", "inputSchema": { "type": "object", "properties": { "patientId": {"type": "string"} }, "required": ["patientId"] } } # Update tool PUT /w/{wid}/custom-toolkits/{toolkitId}/tools/{toolId} { "displayName": "Check Patient Vitals - v2", "description": "Retrieve and validate patient vital signs" } # List tools in toolkit GET /w/{wid}/custom-toolkits/{toolkitId}/tools # Delete tool DELETE /w/{wid}/custom-toolkits/{toolkitId}/tools/{toolId} # Enable toolkit POST /w/{wid}/custom-toolkits/{toolkitId}/enable # Disable toolkit POST /w/{wid}/custom-toolkits/{toolkitId}/disable ``` ### MCP Servers[​](#mcp-servers "Direct link to MCP Servers") ``` # List MCP servers GET /w/{wid}/mcp-servers # Create MCP server POST /w/{wid}/mcp-servers { "name": "External API", "slug": "external-api", "mcpUrl": "https://api.example.com/mcp", "supportsDirectAuth": true, "description": "Connect to external service" } # Create with OAuth POST /w/{wid}/mcp-servers { "name": "Secure Service", "slug": "secure", "mcpUrl": "https://secure.example.com/mcp", "supportsDirectAuth": false, "oauthClientId": "client_id", "oauthClientSecret": "secret" } # Get MCP server details GET /w/{wid}/mcp-servers/{serverId} # Update server PUT /w/{wid}/mcp-servers/{serverId} { "name": "Updated Name", "description": "New description" } # Enable server POST /w/{wid}/mcp-servers/{serverId}/enable # Disable server POST /w/{wid}/mcp-servers/{serverId}/disable # Refresh tools POST /w/{wid}/mcp-servers/{serverId}/refresh-tools # Delete server DELETE /w/{wid}/mcp-servers/{serverId} ``` ### Files[​](#files "Direct link to Files") ``` # Upload file POST /w/{wid}/files (multipart form data) # Get file GET /w/{wid}/files/{fileId} # Delete file DELETE /w/{wid}/files/{fileId} ``` ### Event Rules (Automation)[​](#event-rules-automation "Direct link to Event Rules (Automation)") ``` # Create event rule POST /w/{wid}/event-rules { "trigger": "email.received", "action": "execute_workflow" } # List rules GET /w/{wid}/event-rules # Update rule PUT /w/{wid}/event-rules/{ruleId} # Delete rule DELETE /w/{wid}/event-rules/{ruleId} ``` ### Webhooks[​](#webhooks "Direct link to Webhooks") ``` # Get webhook logs GET /w/{wid}/webhook-logs # Webhooks are created via event rules POST /w/{wid}/event-rules { "trigger": "email.received", "action": "webhook", "webhookUrl": "https://..." } ``` ### Members & Roles[​](#members--roles "Direct link to Members & Roles") ``` # List members GET /w/{wid}/members # Get member GET /w/{wid}/members/{memberId} # List roles GET /w/{wid}/member-roles # Create role POST /w/{wid}/member-roles { "name": "Custom Role", "permissions": [...] } ``` ### Assignments[​](#assignments "Direct link to Assignments") ``` # Create assignment POST /w/{wid}/assignments { "workflowId": 1, "memberId": 2 } # List assignments GET /w/{wid}/assignments # Update assignment PUT /w/{wid}/assignments/{assignmentId} ``` ## Common Response Format[​](#common-response-format "Direct link to Common Response Format") ``` { "items": [...], // Array of resources "total": 100, // Total count "page": 1, // Current page "pageSize": 10 // Items per page } ``` ## Error Handling[​](#error-handling "Direct link to Error Handling") 4xx responses return a JSON body with a `detail` field: ``` {"detail": "Error message"} ``` 5xx responses return: ``` {"detail": "An internal server error occurred"} ``` See [Error Handling Guide](https://docs.gravityrail.com/developer/guides/error-handling.md) for full reference. **Common Status Codes**: * `200`: Success * `201`: Created * `400`: Bad Request * `401`: Unauthorized * `403`: Forbidden * `404`: Not Found * `409`: Conflict (duplicate) * `429`: Rate Limited * `500`: Server Error ## OAuth 2.0 Flow[​](#oauth-20-flow "Direct link to OAuth 2.0 Flow") ``` # 1. Redirect to authorization https://api.gravityrail.com/api/v2/oauth/authorize? response_type=code& client_id=YOUR_CLIENT_ID& redirect_uri=YOUR_REDIRECT_URI& scope=workspace:read%20workspace:write& state=RANDOM_STATE # 2. User authorizes, gets redirected to redirect_uri with code # https://yourapp.com/callback?code=AUTH_CODE&state=RANDOM_STATE # 3. Exchange code for token POST /oauth/token Content-Type: application/x-www-form-urlencoded grant_type=authorization_code& code=AUTH_CODE& redirect_uri=YOUR_REDIRECT_URI& client_id=YOUR_CLIENT_ID& client_secret=YOUR_CLIENT_SECRET # Response: { "access_token": "...", "token_type": "Bearer", "expires_in": 3600, "refresh_token": "..." } # 4. Use access token Authorization: Bearer ACCESS_TOKEN ``` ## Webhook Events[​](#webhook-events "Direct link to Webhook Events") Common event types: * `email.received` - New email arrived * `chat.message.created` - New chat message * `task.created` - New task created * `task.updated` - Task status changed * `record.created` - New data record * `record.updated` - Record updated * `record.deleted` - Record deleted * `workflow.completed` - Workflow finished * `workflow.failed` - Workflow errored Webhook payload format: ``` { "eventType": "email.received", "timestamp": "2024-01-15T10:30:00Z", "workspaceId": "550e8400-e29b-41d4-a716-446655440000", "data": { "id": 123, "...": "event specific data" } } ``` ## Rate Limits[​](#rate-limits "Direct link to Rate Limits") * **Default**: 100 requests per minute per API key * **Burst**: Up to 10 concurrent requests * **Check headers**: `X-RateLimit-Remaining`, `X-RateLimit-Reset` ## SDK/Libraries[​](#sdklibraries "Direct link to SDK/Libraries") **TypeScript/Node.js** (@gravity-rail/sdk): ``` import { GravityRailClient } from '@gravity-rail/sdk'; const apiKey = process.env.GRAVITYRAIL_API_KEY; const baseUrl = 'https://api.gravityrail.com/api/v2'; const client = new GravityRailClient(apiKey, baseUrl); const workspaceUuid = process.env.WORKSPACE_UUID; // List chats const chats = await client.getChats(workspaceUuid); // Create a chat const newChat = await client.createChat(workspaceUuid, { channel: 'web-chat', workflowId: 1, title: 'Support Chat', }); // Send message const message = await client.sendChatMessage(workspaceUuid, newChat.id, 'Hello!'); // Get data records (uses numeric data type ID, not slug) const dataTypeId = 1; const records = await client.getDataRecords(workspaceUuid, dataTypeId); // Create a record const record = await client.createDataRecord(workspaceUuid, dataTypeId, { fieldValues: { name: 'John Doe', email: 'john@example.com', }, }); ``` **Python**: ``` import requests headers = { 'Authorization': f'Bearer {API_KEY}', 'Content-Type': 'application/json' } response = requests.get( 'https://api.gravityrail.com/api/v2/w', headers=headers ) ``` ## Useful Curl Patterns[​](#useful-curl-patterns "Direct link to Useful Curl Patterns") ``` # Set variables export API_KEY="your_api_key" export WS="workspace_uuid" # List with pagination curl "https://api.gravityrail.com/api/v2/w/$WS/chats?page=1&pageSize=50" \ -H "Authorization: Bearer $API_KEY" # Create with JSON curl -X POST "https://api.gravityrail.com/api/v2/w/$WS/chats" \ -H "Authorization: Bearer $API_KEY" \ -H "Content-Type: application/json" \ -d '{"workflowId": 1}' # Upload file curl -X POST "https://api.gravityrail.com/api/v2/w/$WS/files" \ -H "Authorization: Bearer $API_KEY" \ -F "file=@./document.pdf" # Pretty print response curl ... | jq . ``` ## Key Concepts[​](#key-concepts "Direct link to Key Concepts") **Workspace**: Container for all resources (chats, tasks, data, etc.) **Member**: User in workspace with assigned role and permissions **Role**: Set of permissions (can be custom) **Chat**: Conversation session, can be created with a workflow **Task**: Work item with title, priority, assignments **Data Type**: Custom CRM object (like "Customer", "Lead", etc.) **Record**: Instance of a data type with field values **Workflow**: Automated process triggered by events **Custom Toolkit**: Set of custom tools for AI agents **MCP Server**: External service connected via Model Context Protocol **Event Rule**: Automation that triggers on events **Webhook**: Outbound notification to your system ## Documentation Links[​](#documentation-links "Direct link to Documentation Links") * [Getting Started with Integration](https://docs.gravityrail.com/developer/guides/getting-started-integration.md) * [Authentication Guide](https://docs.gravityrail.com/developer/guides/authentication.md) * [API Reference](https://docs.gravityrail.com/developer/api/.md) --- # Features Explore Gravity Rail platform features. --- # Event Rules Automate actions based on what happens in your workspace. When events occur—task completions, messages, data updates—rules automatically label members, send notifications, start workflows, or trigger webhooks. ## What Event Rules Do[​](#what-event-rules-do "Direct link to What Event Rules Do") Event Rules automate your workspace: * **React to events** in real-time * **Apply business logic** consistently * **Connect features** for powerful workflows * **Scale operations** without manual work * **No code required** ## Key Features[​](#key-features "Direct link to Key Features") ### Multiple Actions[​](#multiple-actions "Direct link to Multiple Actions") Chain actions in one rule: label + message + webhook + notify. ### Delayed Actions[​](#delayed-actions "Direct link to Delayed Actions") Schedule actions for later: "24 hours before appointment, send reminder." ### Rule Testing[​](#rule-testing "Direct link to Rule Testing") Test rules against sample data before activating. ## How It Works[​](#how-it-works "Direct link to How It Works") ``` WHEN [Event] → IF [Condition] → THEN [Action] (trigger) (optional) (execute) ``` Every rule follows this pattern. Events trigger the rule, optional conditions filter when it runs, actions execute the response. ## Events (Triggers)[​](#events-triggers "Direct link to Events (Triggers)") | Event | Example | | -------------------- | ------------------------------ | | **Task Entered** | Member starts "Screening" task | | **Task Exited** | Member completes onboarding | | **Data Updated** | Contact info collected | | **Message Received** | New SMS from member | | **Label Applied** | "VIP" tag added | ## Actions[​](#actions "Direct link to Actions") | Action | What It Does | | ---------------------- | ------------------------- | | **Apply/Remove Label** | Tag members automatically | | **Send SMS/Email** | Message members | | **Start Workflow** | Begin new assignment | | **Switch Task** | Move to different task | | **Send Webhook** | POST to external system | | **Notify Staff** | Alert team members | ## Conditions[​](#conditions "Direct link to Conditions") Filter with expressions: ``` member.data.company.size > 100 "vip" in member.labels datetime.hour >= 9 && datetime.hour < 17 member.collections.patient_visits.count > 0 member.collections.lab_results.latest.data.status == "critical" ``` ## Common Patterns[​](#common-patterns "Direct link to Common Patterns") **Qualification routing:** ``` WHEN: "Screening" task exited IF: member.data.score >= 80 THEN: Switch to "Qualified Path" ``` **VIP fast-track:** ``` WHEN: "Support" task entered IF: "gold" in member.labels THEN: Switch to "Priority Support" ``` **CRM sync:** ``` WHEN: Data type "Contact" updated THEN: Send webhook to CRM endpoint ``` **Escalation:** ``` WHEN: Message received IF: message contains "urgent" THEN: Apply "Urgent" label + notify staff ``` ## Pricing & Limits[​](#pricing--limits "Direct link to Pricing & Limits") Feature availability and limits are determined by your subscription plan. See the [pricing page](https://www.gravityrail.com/pages/pricing) for details. ## Related Resources[​](#related-resources "Direct link to Related Resources") * [Workflows](https://docs.gravityrail.com/features/workflows/.md) - Structure conversations * [Routines](https://docs.gravityrail.com/features/actions/scheduled-events.md) - Time-based triggers * [Webhooks](https://docs.gravityrail.com/features/developer/webhooks.md) - External integrations * [Labels](https://docs.gravityrail.com/features/knowledge/labels.md) - Member organization --- # Routines Trigger actions automatically based on time. Daily check-ins, weekly reminders, one-time notifications—reach out to members proactively without manual work. ## What Routines Do[​](#what-routines-do "Direct link to What Routines Do") Routines automate time-based actions: * **Run workflows** on a recurring schedule * **Send messages** to targeted member segments * **Apply labels** at specific times * **Trigger webhooks** on schedule * **One-time or recurring** patterns ## Key Features[​](#key-features "Direct link to Key Features") ### Member Targeting[​](#member-targeting "Direct link to Member Targeting") Target specific segments: * All members * Filter by labels or data * Individual members ### Available Actions[​](#available-actions "Direct link to Available Actions") | Action | What It Does | | ---------------------- | -------------------------------- | | **Start Workflow** | Begin assignment for each member | | **Send SMS/Email** | Message to targeted members | | **Apply/Remove Label** | Update member tags | | **Trigger Webhook** | POST to external system | ### Timezone-Aware[​](#timezone-aware "Direct link to Timezone-Aware") Events run in your workspace timezone. Member-specific events can use member timezone. ## How It Works[​](#how-it-works "Direct link to How It Works") ``` Schedule → Member Filter → Action (when) (who) (what) ``` **Example:** Every Monday at 9 AM → Members with "Active" label → Send check-in SMS ## Schedule Types[​](#schedule-types "Direct link to Schedule Types") | Type | Use Case | | ------------ | ---------------------------------------- | | **One-Time** | Launch announcements, specific reminders | | **Interval** | Every X hours/days for regular cadence | | **Cron** | Complex patterns like "weekdays at 9 AM" | ## Common Cron Patterns[​](#common-cron-patterns "Direct link to Common Cron Patterns") | Pattern | Expression | | ---------------- | ------------- | | Daily at 9 AM | `0 9 * * *` | | Weekdays at 9 AM | `0 9 * * 1-5` | | Every Monday | `0 9 * * 1` | | First of month | `0 9 1 * *` | ## Common Use Cases[​](#common-use-cases "Direct link to Common Use Cases") | Use Case | Configuration | | ------------------------ | --------------------------------------------------- | | **Daily Check-In** | 9 AM daily → Active patients → Wellness workflow | | **Appointment Reminder** | 24h before → Specific member → SMS reminder | | **Lead Nurturing** | Every 3 days → Stale leads → Re-engagement workflow | | **Renewal Alert** | Daily → Expiring subscriptions → Renewal message | ## Pricing & Limits[​](#pricing--limits "Direct link to Pricing & Limits") Feature availability and limits are determined by your subscription plan. See the [pricing page](https://www.gravityrail.com/pages/pricing) for details. ## Related Resources[​](#related-resources "Direct link to Related Resources") * [Event Rules](https://docs.gravityrail.com/features/actions/event-rules.md) - React to events in real-time * [Workflows](https://docs.gravityrail.com/features/workflows/.md) - Conversation automation * [Members](https://docs.gravityrail.com/features/members/.md) - Member management * [Labels](https://docs.gravityrail.com/features/knowledge/labels.md) - Member organization --- # Agent Members Deploy AI team members with their own identity, phone number, and the ability to proactively reach out. Agent Members work alongside your team, handling conversations across DMs, SMS, and voice with full context. ## What Agents Do[​](#what-agents-do "Direct link to What Agents Do") Agent Members are autonomous AI identities that live in your workspace: * **Communicate directly** via DMs, SMS, and voice calls * **Remember context** across all conversations with a person * **Act proactively** with scheduled check-ins and follow-ups * **Own resources** like phone numbers and calendars * **Work 24/7** without needing supervision Unlike traditional chatbots that wait for users to start conversations, agents can reach out, follow up, and maintain ongoing relationships. ## Key Features[​](#key-features "Direct link to Key Features") ### Multi-Channel Communication[​](#multi-channel-communication "Direct link to Multi-Channel Communication") One agent, many channels: | Channel | Capability | | ------------------- | --------------------------------------- | | **Direct Messages** | Chat within the workspace | | **SMS** | Text conversations via dedicated number | | **Voice Calls** | Natural phone conversations with AI | ### Persistent Memory[​](#persistent-memory "Direct link to Persistent Memory") Agents remember every interaction. A member who texted last week can call today, and the agent picks up where they left off—no need to repeat information. ### Customizable Personality[​](#customizable-personality "Direct link to Customizable Personality") Define how your agent behaves: * **System prompt** sets role, tone, and boundaries * **Model selection** balances capability and speed * **Tool access** controls what actions agents can take ### Scheduled Autonomy[​](#scheduled-autonomy "Direct link to Scheduled Autonomy") Enable proactive behavior: * Daily check-ins with specific members * Weekly status updates * Follow-up reminders after appointments ## How It Works[​](#how-it-works "Direct link to How It Works") ``` Agent Identity → Incoming Message → Contextual Response (name, phone) (DM, SMS, call) (memory-aware) ``` When someone messages your agent, it draws on conversation history, system instructions, and available tools to respond naturally. Agents maintain memory across channels—a conversation started via SMS can continue via DM without losing context. ## Use Cases[​](#use-cases "Direct link to Use Cases") ### Care Coordinator[​](#care-coordinator "Direct link to Care Coordinator") An agent named "Sarah" handles patient communication: * Answers scheduling questions via SMS * Sends appointment reminders * Follows up after visits to collect feedback * Routes urgent issues to the on-call team ### Account Manager[​](#account-manager "Direct link to Account Manager") An agent manages customer relationships: * Proactively checks in monthly via DM * Answers product questions via their direct line * Schedules meetings when customers need help * Escalates renewal conversations to sales ### Support Representative[​](#support-representative "Direct link to Support Representative") An agent handles tier-1 support: * Receives calls on a dedicated number * Resolves common issues autonomously * Creates tickets for complex problems * Follows up to confirm resolution ## Getting Started[​](#getting-started "Direct link to Getting Started") 1. **Create an Agent** - Navigate to Members > Agents and click Create Agent 2. **Configure Identity** - Set name, description, and optionally email or phone 3. **Set AI Behavior** - Choose a model and write system instructions 4. **Assign Resources** - Attach a phone number for SMS/voice capability 5. **Enable Channels** - Turn on DMs, SMS, or voice as needed Your agent is now ready to communicate. Test it by sending a DM from another workspace member. ## Pricing & Limits[​](#pricing--limits "Direct link to Pricing & Limits") Feature availability and limits are determined by your subscription plan. See the [pricing page](https://www.gravityrail.com/pages/pricing) for details. ## Related Resources[​](#related-resources "Direct link to Related Resources") * [SMS Messaging](https://docs.gravityrail.com/features/channels/sms.md) - SMS infrastructure and capabilities * [Phone Numbers](https://docs.gravityrail.com/features/channels/phone.md) - Phone number setup and routing * [Direct Messages](https://docs.gravityrail.com/features/communication/direct-messages.md) - DM system overview --- # Async Sub-Agents Sometimes your agent says: *"I'm working on that in the background — I'll get back to you."* That's an **async sub-agent** at work. Your primary agent stays with you, handling the conversation in real time. When it hits something slow — an outbound phone call, a prior authorization, a multi-step lookup — it spins up a second agent to do the work in the background. You keep chatting. The primary agent reports back the moment the background work is done. ## What This Enables[​](#what-this-enables "Direct link to What This Enables") Async sub-agents turn one agent into a small team. A few examples: ### Outbound outreach in parallel[​](#outbound-outreach-in-parallel "Direct link to Outbound outreach in parallel") Ask your primary agent to reach every patient who hasn't completed onboarding. It can spawn one background agent per patient, each making its own call, and roll the results up for you: > *Agent 1 called Alice — she's getting back to us today. Agent 2 left a voicemail for Bob. Agent 3 learned that Carol has moved and no longer needs services.* You didn't have to wait through any of the calls. ### Prior authorization in the background[​](#prior-authorization-in-the-background "Direct link to Prior authorization in the background") A caller asks about a prescription. Your primary agent stays with them, answering other questions, while a background agent begins the prior auth request. When authorization comes back, the primary agent weaves the update into the conversation naturally — no context switch, no "please hold." ### Multi-step research[​](#multi-step-research "Direct link to Multi-step research") Need five patient records looked up and cross-referenced? Your agent can fan out five parallel sub-agents, each reading one record, and synthesize the combined result when they're all done. ## What You'll See[​](#what-youll-see "Direct link to What You'll See") Async delegation feels like the agent simply *works*. Concretely, you'll notice: * **Progress messages** in your chat: *"Let me start that in the background..."* or *"Still waiting on the pharmacy — I'll let you know."* * **Unsolicited follow-ups** when the background work finishes: *"Quick update on the prior auth you asked about earlier — approved."* * **Live status on demand.** Ask *"What's happening with the Ozempic request?"* at any time and the primary agent will check the background task and give you the latest. * **Clean cancellation.** If you change your mind, just say *"cancel the background work on Ozempic"* and the agent will stop the sub-agent. ## How It Relates To Your Existing Agents[​](#how-it-relates-to-your-existing-agents "Direct link to How It Relates To Your Existing Agents") You don't configure anything new. The primary agent decides when a task is too slow to block on and delegates automatically, drawing from the same set of agents you've already built in your workspace. Think of it as one agent *borrowing* another agent for a specific piece of work — no new accounts, no new seats, no new phone numbers. Each sub-agent runs in its own chat, which you can see in the Chats view if you want to follow along. But the primary conversation never pauses waiting for them. ## Safeguards[​](#safeguards "Direct link to Safeguards") Sub-agents run with real teeth and real guardrails. * **Delegation depth is capped.** A primary agent can delegate to a sub-agent, which can delegate to another, up to a maximum of three levels. This prevents runaway chains. * **Ownership is enforced.** Only the agent (and the person) that started a background task can check on it, send it new instructions, or cancel it. Other agents in the workspace can't even see it exists. * **You can always cancel.** A single instruction — *"stop the background work on X"* — ends the sub-agent gracefully. * **HIPAA-compliant audit logging.** Every time a background task's contents are read, a `PHI_RECORD_VIEWED` audit event is written. The audit trail records *that* PHI was accessed and *by whom*, never the PHI itself. * **Workspace isolation.** Sub-agents never cross workspace boundaries. A background task spawned in one workspace can only read, write, and act inside that workspace. ## Learn More[​](#learn-more "Direct link to Learn More") * **[How background work shows up in your chats](https://docs.gravityrail.com/user-guide/sub-agents.md)** — end-user guide for clinic staff and workspace admins. * For platform admins: the internal feature reference and QA runbook live in the developer documentation. --- # Experiments (A/B Testing) Run member-level A/B tests without building custom label hacks or workspace-wide toggles. Define **Groups** (control and variants), branch in Actions and workflows with [CEL](https://docs.gravityrail.com/docs/automation/cel-expressions), and compare outcomes on Journey Goals. ## What Experiments Do[​](#what-experiments-do "Direct link to What Experiments Do") * **Assign members to groups** with weighted randomization that stays sticky * **Branch behavior** in Event Rules, task edges, and journey step conditions * **Track exposure** so reporting counts only members who actually saw the treatment * **Compare journey goals** by group with privacy-safe aggregate stats ## How Assignment Works[​](#how-assignment-works "Direct link to How Assignment Works") Gravity Rail assigns on **first encounter**, not when you start the experiment: 1. You write a condition such as `member.experiments["opening-test"] == "friendly"`. 2. The first time that expression runs for a member (on a supported runtime surface), Gravity Rail assigns them to a group, records exposure, and resolves the branch. 3. Later reads return the same group. No separate “assign member” action is required for typical tests. ## Filtering[​](#filtering "Direct link to Filtering") ### Who can be assigned (eligibility)[​](#who-can-be-assigned-eligibility "Direct link to Who can be assigned (eligibility)") Optional **Eligibility CEL** on the experiment limits assignment — for example, age, labels, or form data. Members who fail eligibility are never assigned and do not appear in experiment stats. ### What you see in lists[​](#what-you-see-in-lists "Direct link to What you see in lists") Archived experiments are hidden by default. Enable **Include archived** on the Experiments list to see historical tests. ### Finding members by assignment[​](#finding-members-by-assignment "Direct link to Finding members by assignment") On the **Members** page, add an **Experiments** filter rule to list members assigned to an experiment, not assigned, or in a specific Group. Saved member filters and routines support the same rule type. ### What counts in reports[​](#what-counts-in-reports "Direct link to What counts in reports") Journey goal breakdowns use **exposed** members enrolled in that journey — not everyone assigned elsewhere, and not members who never reached the branch. Counts below five are shown as `"<5"` to protect privacy. ## Common Patterns[​](#common-patterns "Direct link to Common Patterns") | Goal | Approach | | ------------------------------------------ | -------------------------------------------------------------- | | Compare two SMS openings on a journey step | Event Rule on `journey_step:execute` with experiment condition | | Route workflow paths | Automatic task edge with `member.experiments["slug"]` | | Limit test to a cohort | Eligibility CEL on the experiment | | See per-member assignment | Member profile → Experiments tab | | Find members in a test cohort | Members → filter by Experiments / Group | ## Related Features[​](#related-features "Direct link to Related Features") * [Event Rules](https://docs.gravityrail.com/features/actions/event-rules.md) — triggers and conditions * [Workflows](https://docs.gravityrail.com/features/workflows/.md) — task edges and branching * [Journeys](https://docs.gravityrail.com/user-guide/journeys.md) — programs and goals For setup steps, see the [Experiments user guide](https://docs.gravityrail.com/docs/automation/experiments). --- # Email Inboxes Dedicated email addresses that connect to your AI workflows. Receive emails, process them with AI agents, and respond automatically—all with threaded conversation history. ## What Email Inboxes Do[​](#what-email-inboxes-do "Direct link to What Email Inboxes Do") Email inboxes bring email into your workspace: * **Dedicated addresses** () * **AI-powered responses** via workflow automation * **Unified inbox** with conversation threading * **Attachment handling** for documents * **Role-based access** for team organization ## Key Features[​](#key-features "Direct link to Key Features") ### Multiple Inboxes[​](#multiple-inboxes "Direct link to Multiple Inboxes") Create separate inboxes for different purposes: * * * Each can have different workflows and permissions. ### AI-Powered Responses[​](#ai-powered-responses "Direct link to AI-Powered Responses") Connect inboxes to workflows for automated responses: > **Incoming:** "I'd like to schedule an appointment for next Tuesday." > > **AI:** "I'd be happy to help! I have availability at 10am, 2pm, and 4pm. Which works best?" ### Email Threading[​](#email-threading "Direct link to Email Threading") Conversations are automatically grouped. Replies link to originals, preserving full context across exchanges. ### Rich Email Support[​](#rich-email-support "Direct link to Rich Email Support") * HTML and plain text emails * Attachments up to 25MB * Custom footers for branding * Variable substitution for personalization ## How It Works[​](#how-it-works "Direct link to How It Works") ``` Email Arrives → Workflow Triggered → AI Responds (your inbox) (if configured) (contextual reply) ``` Emails arrive at your inbox address. If a workflow is connected, AI reads the email, understands it, and sends an appropriate reply. ## Creating an Inbox[​](#creating-an-inbox "Direct link to Creating an Inbox") 1. Navigate to **Settings > Email Inboxes** 2. Click **Create Inbox** 3. Enter name and email prefix 4. Optionally connect a workflow 5. Configure role permissions Your inbox is active at `{prefix}@{workspace}.gravityrail.com` ## Common Use Cases[​](#common-use-cases "Direct link to Common Use Cases") | Use Case | What It Does | | ----------------- | ----------------------------------------- | | **Support Inbox** | AI handles FAQs, escalates complex issues | | **Lead Capture** | AI qualifies inbound leads automatically | | **Appointments** | AI schedules via email conversation | | **Feedback** | AI categorizes and stores feedback | ## Pricing & Limits[​](#pricing--limits "Direct link to Pricing & Limits") Feature availability and limits are determined by your subscription plan. See the [pricing page](https://www.gravityrail.com/pages/pricing) for details. ## Related Resources[​](#related-resources "Direct link to Related Resources") * [Workflows](https://docs.gravityrail.com/features/workflows/.md) - Configure email processing * [Agents](https://docs.gravityrail.com/features/ai/agents.md) - Set up AI for responses * [Event Rules](https://docs.gravityrail.com/features/actions/event-rules.md) - Automate on email events * [Chats](https://docs.gravityrail.com/features/chats/.md) - Unified conversation management --- # Notifications Real-time alerts for your team via SMS, email, and in-app. Configure rules to automatically notify staff when conversations need attention, AI escalates, or workflows reach milestones. ## What Notifications Do[​](#what-notifications-do "Direct link to What Notifications Do") Notifications keep your team informed: * **Multi-channel delivery** (SMS, email, in-app) * **Escalation alerts** when AI needs human help * **Customizable rules** for targeted routing * **Personal preferences** per team member * **Read/unread tracking** ## Key Features[​](#key-features "Direct link to Key Features") ### Notification Rules[​](#notification-rules "Direct link to Notification Rules") Configure automatic routing: * **Notice Type**: What triggers it (escalation, milestone) * **Target Member**: Who gets notified * **Workflow Scope**: Specific workflow or all * **Channels**: SMS, email, or both ### Personal Preferences[​](#personal-preferences "Direct link to Personal Preferences") Each member controls their channels: * Enable/disable SMS notifications * Enable/disable email notifications * Notifications only sent when BOTH rule and preference allow ### Escalation Handling[​](#escalation-handling "Direct link to Escalation Handling") When AI needs human help: 1. AI triggers escalation with reason 2. Matching rules identify who to notify 3. Staff receives alert with chat link 4. Click to open conversation with full context ## How It Works[​](#how-it-works "Direct link to How It Works") ``` Event Occurs → Rules Evaluated → Channels Checked → Delivered (escalation) (who to notify) (preferences) (SMS/email/app) ``` When AI escalates or important events occur, notifications route to the right people via their preferred channels. ## Business Hours[​](#business-hours "Direct link to Business Hours") Notifications respect workspace hours: * Different messages during/after hours * "We'll respond at 9am" for off-hours escalations * Timezone-aware scheduling ## Common Use Cases[​](#common-use-cases "Direct link to Common Use Cases") | Use Case | Configuration | | ------------------------ | ---------------------------------------------- | | **Support Escalation** | AI escalates → SMS to support lead | | **After-Hours Coverage** | Escalation outside hours → On-call manager | | **Workflow Milestones** | Onboarding complete → Email to account manager | | **VIP Handling** | VIP message → SMS to senior staff | ## Pricing & Limits[​](#pricing--limits "Direct link to Pricing & Limits") Feature availability and limits are determined by your subscription plan. See the [pricing page](https://www.gravityrail.com/pages/pricing) for details. ## Related Resources[​](#related-resources "Direct link to Related Resources") * [Workflows](https://docs.gravityrail.com/features/workflows/.md) - Trigger notifications from workflows * [Chats](https://docs.gravityrail.com/features/chats/.md) - Conversation context for alerts * [Event Rules](https://docs.gravityrail.com/features/actions/event-rules.md) - Advanced notification triggers * [Phone Numbers](https://docs.gravityrail.com/features/channels/phone.md) - SMS delivery configuration --- # Phone Numbers Dedicated phone numbers that connect voice and SMS to your AI assistants. Enable 24/7 automated communication, intelligent routing, and frictionless member signup via text. ## What Phone Numbers Do[​](#what-phone-numbers-do "Direct link to What Phone Numbers Do") Phone numbers are your communication gateway: * **Two-way SMS** with AI-powered responses * **Voice calls** answered by AI assistants * **Work modes** for business hours and forwarding * **Member signup** via simple text message * **Unified history** across all channels ## Key Features[​](#key-features "Direct link to Key Features") ### SMS + Voice in One Number[​](#sms--voice-in-one-number "Direct link to SMS + Voice in One Number") Each phone number supports both channels. Enable one or both based on your needs. ### Member Signup via SMS[​](#member-signup-via-sms "Direct link to Member Signup via SMS") Let new members join by texting your number: 1. They text a signup code 2. Account created automatically 3. Workflow starts immediately ### Smart Forwarding[​](#smart-forwarding "Direct link to Smart Forwarding") Route to humans when needed: * Forward during off-hours * Conditional forwarding based on caller * Fallback when AI can't help ### Agent Routing[​](#agent-routing "Direct link to Agent Routing") Route inbound calls or SMS directly to an AI agent instead of a workflow. The agent responds autonomously using full conversation context, making it ideal for open-ended interactions that don't follow a fixed script. This works for both SMS and voice calls. ## How It Works[​](#how-it-works "Direct link to How It Works") ``` Incoming Call/SMS → Route by Mode → AI or Forward → Logged (your number) (hours/rules) (responds) (in chat) ``` When someone calls or texts your number, Gravity Rail routes the interaction based on your work mode settings—to AI, to a human, or an auto-reply. ## Work Modes[​](#work-modes "Direct link to Work Modes") | Mode | Behavior | | -------------------- | -------------------------------------- | | **Always Available** | AI handles all communications 24/7 | | **Business Hours** | AI during hours, forward/message after | | **Always Forward** | Route all calls to another number | | **Custom Message** | Send auto-reply with custom message | ## Common Use Cases[​](#common-use-cases "Direct link to Common Use Cases") | Use Case | Configuration | | ------------------------ | --------------------------------- | | **Support Hotline** | AI during hours, forward after | | **Patient Registration** | SMS signup, onboarding workflow | | **Emergency Line** | Always forward to humans | | **Sales Inquiries** | AI qualification, demo scheduling | ## Pricing & Limits[​](#pricing--limits "Direct link to Pricing & Limits") Feature availability and limits are determined by your subscription plan. See the [pricing page](https://www.gravityrail.com/pages/pricing) for details. ## Related Resources[​](#related-resources "Direct link to Related Resources") * [Voice](https://docs.gravityrail.com/features/channels/voice.md) - Voice call capabilities * [SMS](https://docs.gravityrail.com/features/channels/sms.md) - Text messaging features * [Workflows](https://docs.gravityrail.com/features/workflows/.md) - Connect to conversation flows --- # Sites Launch branded web portals and chat interfaces where members engage with your AI. From embeddable chat widgets to full member portals, Sites bring your workspace to the web. ## What Sites Do[​](#what-sites-do "Direct link to What Sites Do") Sites are the public-facing layer of your workspace: * **Deploy AI chat** on your website or standalone portals * **Control access** with public, private, or role-based settings * **Enable self-signup** to grow your member base * **Use custom domains** for professional branding * **Host content** with pages, menus, and localization ## Key Features[​](#key-features "Direct link to Key Features") ### AI-Powered Chat[​](#ai-powered-chat "Direct link to AI-Powered Chat") Every site can have intelligent chat: * Customizable greeting and behavior * Powered by your configured AI agent * Connected to workflows for structured processes * Human handoff when needed ### Flexible Authentication[​](#flexible-authentication "Direct link to Flexible Authentication") Multiple ways for members to sign in: * Phone/SMS verification * Email verification * Google OAuth * Or keep it public—no auth required ### Custom Domains[​](#custom-domains "Direct link to Custom Domains") Use your own domain for professional branding: * `support.yourcompany.com` * `portal.yourcompany.com` * Full HTTPS security ### Embeddable Widget[​](#embeddable-widget "Direct link to Embeddable Widget") Add AI chat to any website with a single script tag. Configure allowed origins to control where it can be embedded. ## Types of Sites[​](#types-of-sites "Direct link to Types of Sites") | Type | Access | Best For | | ----------- | --------------------- | ------------------------------------------------- | | **Public** | Anyone on the web | Lead capture, support chat, info hubs | | **Private** | Authenticated members | Patient portals, client dashboards, employee hubs | | **Widget** | Embedded on your site | Website chat, in-app support | ## How It Works[​](#how-it-works "Direct link to How It Works") ``` Your Brand → AI Chat → Member Engagement (domain/design) (workflows) (data/actions) ``` Sites connect your workspace capabilities to visitors: * AI assistants power the chat interface * Workflows structure the conversation * Data types capture information * Event rules trigger follow-up actions ## Common Use Cases[​](#common-use-cases "Direct link to Common Use Cases") | Use Case | Configuration | | -------------------- | ------------------------------------------------------------------- | | **Patient Portal** | Private site with phone auth, AI care coordinator, health resources | | **Lead Capture** | Public widget on marketing site, qualification workflow, CRM sync | | **Client Dashboard** | Private site on custom domain, AI support, documentation | | **Employee Hub** | Private site for staff, HR assistant, policy documents | ## Pricing & Limits[​](#pricing--limits "Direct link to Pricing & Limits") Feature availability and limits are determined by your subscription plan. See the [pricing page](https://www.gravityrail.com/pages/pricing) for details. ## Related Resources[​](#related-resources "Direct link to Related Resources") * [Agents](https://docs.gravityrail.com/features/ai/agents.md) - Configure the AI powering your site * [Workflows](https://docs.gravityrail.com/features/workflows/.md) - Structure site interactions * [Files](https://docs.gravityrail.com/features/knowledge/files.md) - Manage site content and media * [Members](https://docs.gravityrail.com/features/members/.md) - Manage site visitors --- # SMS Messaging Reach members where they are—their phones. Send and receive text messages through dedicated numbers, powered by AI for automated conversations at scale. ## What SMS Does[​](#what-sms-does "Direct link to What SMS Does") SMS connects your workspace to member phones: * **Two-way messaging** with dedicated numbers * **AI conversations** via workflow automation * **Signup codes** for new member acquisition * **Opt-out handling** for compliance * **Conversation threading** with full history ## Key Features[​](#key-features "Direct link to Key Features") ### AI-Powered Responses[​](#ai-powered-responses "Direct link to AI-Powered Responses") Connect a workflow to handle incoming texts. AI reads messages, understands context, and responds conversationally—24/7. ### Signup Codes[​](#signup-codes "Direct link to Signup Codes") Let new members join via SMS: 1. Member texts code (e.g., "JOIN2024") 2. System creates account 3. Member accepts terms 4. Ready to engage ### Built-in Compliance[​](#built-in-compliance "Direct link to Built-in Compliance") * **STOP** command automatically opts members out * **HELP** command provides service info * All opt-outs honored immediately * Consent records maintained ### Location Awareness[​](#location-awareness "Direct link to Location Awareness") Messages include sender city and country—useful for localized responses and timezone-aware scheduling. ## How It Works[​](#how-it-works "Direct link to How It Works") ``` Member Texts → Message Received → AI Responds → Conversation Logged (your number) (validated) (contextual) (in chat history) ``` When a member texts your number, AI picks up the conversation, answers questions, collects data, or routes to a human—all via natural dialogue. ## Common Use Cases[​](#common-use-cases "Direct link to Common Use Cases") | Use Case | What It Enables | | ------------------------- | --------------------------------------- | | **Appointment Reminders** | Reduce no-shows with confirmation texts | | **Two-Way Support** | Answer questions via text messaging | | **Marketing Campaigns** | High-open-rate promotional messages | | **Onboarding Sequences** | Multi-day automated welcome flows | ## Example Conversation[​](#example-conversation "Direct link to Example Conversation") > **Member:** "Hi, I'd like to check my appointment status" > > **AI:** "Hi! I found your appointment for Tuesday at 2pm. Would you like to confirm or reschedule?" > > **Member:** "Confirm please" > > **AI:** "Done! You'll receive a reminder the day before." ## Pricing & Limits[​](#pricing--limits "Direct link to Pricing & Limits") Feature availability and limits are determined by your subscription plan. See the [pricing page](https://www.gravityrail.com/pages/pricing) for details. ## Related Resources[​](#related-resources "Direct link to Related Resources") * [Phone Numbers](https://docs.gravityrail.com/features/channels/phone.md) - Configure SMS-enabled numbers * [Voice](https://docs.gravityrail.com/features/channels/voice.md) - Add voice calling * [Workflows](https://docs.gravityrail.com/features/workflows/.md) - Build SMS conversation flows * [Chats](https://docs.gravityrail.com/features/chats/.md) - View unified message history --- # Voice Communication Talk to your AI agents in real-time through phone calls or web-based voice chat. Natural conversation, minimal latency, and seamless handoff to humans when needed. ## What Voice Does[​](#what-voice-does "Direct link to What Voice Does") Voice enables real-time spoken conversations: * **Answer calls** with AI-powered phone support * **Embed voice chat** directly on your website * **Stream responses** with ultra-low latency * **Transcribe automatically** for searchable records * **Forward to humans** when appropriate ## Key Features[​](#key-features "Direct link to Key Features") ### Natural Conversations[​](#natural-conversations "Direct link to Natural Conversations") AI handles interruptions, pauses naturally, and maintains context across the call—just like talking to a person. ### Voice Selection[​](#voice-selection "Direct link to Voice Selection") Choose from multiple AI voices to match your brand personality—warm, professional, energetic, or calm. ### Automatic Transcription[​](#automatic-transcription "Direct link to Automatic Transcription") Every call is transcribed and logged. Search conversations, review quality, and maintain compliance records. ### Smart Escalation[​](#smart-escalation "Direct link to Smart Escalation") Configure when AI should transfer to humans—complex issues, emotional situations, or explicit requests for a person. ## How It Works[​](#how-it-works "Direct link to How It Works") ``` Phone/Web → Voice Model → AI Response → Transcribed (call in) (speech-to-text) (conversational) (logged) ``` Members call your number or click a voice button on your site. The AI listens, responds naturally, and can hand off to staff when needed. ## Voice Options[​](#voice-options "Direct link to Voice Options") | Channel | Best For | | --------------- | --------------------------------------- | | **Phone Calls** | Inbound support, outbound campaigns | | **Web Voice** | In-browser conversations, accessibility | ### AI Voice Models[​](#ai-voice-models "Direct link to AI Voice Models") | Provider | Latency | Best For | | ------------------- | ---------- | ------------------------------- | | **OpenAI Realtime** | 200-500ms | Quick, responsive conversations | | **Gemini Live** | 300-600ms | Multi-modal, complex dialogue | | **TTS + Chat** | 800-1200ms | Maximum control, scripted flows | ## Common Use Cases[​](#common-use-cases "Direct link to Common Use Cases") | Use Case | What It Enables | | ---------------------- | ----------------------------------------- | | **Patient Scheduling** | 24/7 appointment booking via phone | | **Support Hotline** | AI troubleshooting with human escalation | | **Lead Qualification** | Screen callers before connecting to sales | | **Order Status** | Voice-based self-service inquiries | ## Pricing & Limits[​](#pricing--limits "Direct link to Pricing & Limits") Feature availability and limits are determined by your subscription plan. See the [pricing page](https://www.gravityrail.com/pages/pricing) for details. ## Related Resources[​](#related-resources "Direct link to Related Resources") * [Phone Numbers](https://docs.gravityrail.com/features/channels/phone.md) - Configure voice-enabled numbers * [Agents](https://docs.gravityrail.com/features/ai/agents.md) - Customize voice AI behavior * [Chats](https://docs.gravityrail.com/features/chats/.md) - View call transcripts --- # Chats & Conversations One inbox for every conversation. Chats unify SMS, voice calls, web chat, and email into a single timeline—giving your team complete context for every member interaction. ## What Chats Do[​](#what-chats-do "Direct link to What Chats Do") Chats are your unified communication hub: * **Single timeline** for all channels (SMS, voice, web, email) * **Full history** with messages, transcripts, and events * **AI + human** collaboration in the same thread * **Smart routing** based on labels and rules * **Real-time updates** as conversations happen ## Key Features[​](#key-features "Direct link to Key Features") ### Multi-Channel Threading[​](#multi-channel-threading "Direct link to Multi-Channel Threading") Unlike siloed systems, Gravity Rail keeps all interactions together: | Channel | Same Chat | | ------------------------- | --------- | | Web chat | ✓ | | SMS | ✓ | | Voice calls (transcribed) | ✓ | | Email | ✓ | ### Human Takeover[​](#human-takeover "Direct link to Human Takeover") Seamlessly transition from AI to human: 1. AI handles initial conversation 2. Staff joins when needed 3. Human has full AI conversation context 4. Member experiences smooth handoff ### Smart Organization[​](#smart-organization "Direct link to Smart Organization") * **Labels** tag chats (Urgent, VIP, Follow-up) * **Filters** create saved views * **Search** finds any conversation * **Assignment** routes to the right person ### AI Collaboration[​](#ai-collaboration "Direct link to AI Collaboration") AI assistants work alongside your team: * Respond automatically when enabled * Collect data via conversation * Escalate on configured triggers * Suggest responses for human approval ## How It Works[​](#how-it-works "Direct link to How It Works") ``` Any Channel → Unified Chat → AI or Human → Complete History (SMS/voice/web) (one thread) (responds) (searchable) ``` A member starts on web chat, continues via SMS, and calls in—all captured in one conversation. Your team sees everything in context. ## Common Use Cases[​](#common-use-cases "Direct link to Common Use Cases") | Use Case | What It Enables | | -------------------------- | -------------------------------------- | | **Multi-Channel Support** | Complete context across channels | | **Appointment Management** | Reminders, confirmations, rescheduling | | **Sales Follow-Up** | AI nurtures, humans close | | **Team Inbox** | Shared visibility, clear ownership | ## Pricing & Limits[​](#pricing--limits "Direct link to Pricing & Limits") Feature availability and limits are determined by your subscription plan. See the [pricing page](https://www.gravityrail.com/pages/pricing) for details. ## Related Resources[​](#related-resources "Direct link to Related Resources") * [Agents](https://docs.gravityrail.com/features/ai/agents.md) - Configure conversation AI * [Phone Numbers](https://docs.gravityrail.com/features/channels/phone.md) - SMS and voice setup * [Workflows](https://docs.gravityrail.com/features/workflows/.md) - Structure conversations * [Labels](https://docs.gravityrail.com/features/knowledge/labels.md) - Organize and route chats --- # Direct Messages Private conversations between team members and AI agents. Direct Messages give your team a dedicated space for 1:1 communication without the noise of group channels. ## What Direct Messages Do[​](#what-direct-messages-do "Direct link to What Direct Messages Do") Direct Messages enable private communication: * **1:1 conversations** between any two workspace members * **Message AI agents** directly for quick assistance * **Thread-based** organization for focused discussions * **Real-time sync** across all your devices ## Key Features[​](#key-features "Direct link to Key Features") ### Thread-Based Conversations[​](#thread-based-conversations "Direct link to Thread-Based Conversations") Each DM is a dedicated thread. Keep your discussions organized with full message history, making it easy to reference past conversations. ### Read Receipts & Unread Counts[​](#read-receipts--unread-counts "Direct link to Read Receipts & Unread Counts") Know when your messages have been seen. Unread counts help you track conversations that need your attention. ### Push Notifications[​](#push-notifications "Direct link to Push Notifications") Get notified instantly when someone messages you. Works across mobile and desktop with customizable preferences. ### Message AI Agents[​](#message-ai-agents "Direct link to Message AI Agents") Need quick help? Message an AI agent directly. Get answers, run workflows, or ask questions without switching contexts. ## How It Works[​](#how-it-works "Direct link to How It Works") ``` Start Conversation → Send Messages → Get Notified (pick a person/agent) (text, files) (push, email, in-app) ``` Select a team member or AI agent, start typing, and your messages are delivered instantly. Conversations persist so you can pick up where you left off. ## How to Use[​](#how-to-use "Direct link to How to Use") 1. **Start a DM**: Click the compose button and select a team member or AI agent 2. **Send messages**: Type your message and hit send 3. **Manage notifications**: Adjust your preferences in Settings > Notifications 4. **View history**: All conversations are saved and searchable ## Common Use Cases[​](#common-use-cases "Direct link to Common Use Cases") | Use Case | Example | | ------------------------- | ------------------------------------------------------------ | | **Quick Questions** | Ask a colleague about a project without scheduling a meeting | | **AI Assistance** | Message an agent to check patient status or run a report | | **Sensitive Discussions** | Private conversations that don't belong in group channels | ## Pricing & Limits[​](#pricing--limits "Direct link to Pricing & Limits") Feature availability and limits are determined by your subscription plan. See the [pricing page](https://www.gravityrail.com/pages/pricing) for details. ## Related Resources[​](#related-resources "Direct link to Related Resources") * [Notifications](https://docs.gravityrail.com/features/channels/notifications.md) - Configure how you receive DM alerts * [AI Assistants](https://docs.gravityrail.com/features/ai/agents.md) - Set up agents you can message * [Members](https://docs.gravityrail.com/features/members/.md) - Manage who can send and receive DMs --- # API Keys Secure programmatic access to your workspace. Build custom integrations, automate workflows, and connect third-party applications via the Gravity Rail API. ## What API Keys Do[​](#what-api-keys-do "Direct link to What API Keys Do") API Keys enable programmatic access: * **Authenticate requests** to the Gravity Rail API * **Scoped permissions** control what each key can access * **Key management** with rotation and revocation * **Usage tracking** to monitor activity * **Expiration support** for time-limited access ## Key Features[​](#key-features "Direct link to Key Features") ### Scoped Permissions[​](#scoped-permissions "Direct link to Scoped Permissions") Grant only the permissions needed. Follow the principle of least privilege. ### Key Expiration[​](#key-expiration "Direct link to Key Expiration") Set expiration dates—30 days for testing, 90 days for temporary access, or no expiration for permanent integrations. ### Usage Tracking[​](#usage-tracking "Direct link to Usage Tracking") Monitor when each key was last used to identify unused keys for cleanup. ## Key Format[​](#key-format "Direct link to Key Format") ``` gr_4k7n9m2p8q3r5t6v8w1x ``` The `gr_` prefix identifies Gravity Rail API keys. ## Creating an API Key[​](#creating-an-api-key "Direct link to Creating an API Key") 1. Open **Settings** (top-right) and select **API Keys** under the **Developer** section 2. Click **Create API Key** 3. Configure name, scopes, and expiration 4. **Copy immediately** — the full secret is shown only once ## Using an API Key[​](#using-an-api-key "Direct link to Using an API Key") ``` curl -X GET "https://api.gravityrail.com/api/v2/w/{workspace_id}/members" \ -H "Authorization: Bearer gr_your_api_key_here" ``` ## Available Scopes[​](#available-scopes "Direct link to Available Scopes") | Scope | Permission | | ----------------- | ------------------------- | | `read:members` | View member information | | `write:members` | Create and update members | | `read:chats` | Access chat history | | `write:chats` | Send messages | | `read:data` | Access data records | | `write:data` | Create/update data | | `admin:workspace` | Full workspace admin | ## Security Best Practices[​](#security-best-practices "Direct link to Security Best Practices") * **Never commit** keys to source control * **Store in** environment variables or secret managers * **Rotate** every 90 days or after team changes * **Delete** unused keys promptly * **Revoke immediately** if compromised ## Common Use Cases[​](#common-use-cases "Direct link to Common Use Cases") | Use Case | Scopes Needed | | ----------------------- | -------------------------------- | | **Automated Reports** | `read:members`, `read:data` | | **CRM Sync** | `read:members`, `write:members` | | **Custom Dashboard** | `read:chats`, `read:members` | | **Workflow Automation** | `write:chats`, `write:workflows` | ## Pricing & Limits[​](#pricing--limits "Direct link to Pricing & Limits") Feature availability and limits are determined by your subscription plan. See the [pricing page](https://www.gravityrail.com/pages/pricing) for details. ## Related Resources[​](#related-resources "Direct link to Related Resources") * [Webhooks](https://docs.gravityrail.com/features/developer/webhooks.md) - Receive real-time notifications * [Integrations](https://docs.gravityrail.com/features/developer/integrations.md) - Pre-built connections * [Workflows](https://docs.gravityrail.com/features/workflows/.md) - Automate processes --- # Integrations Connect Gravity Rail to your existing systems—EHRs, CRMs, calendars, and custom APIs. Keep data synchronized and enable AI assistants to access external context. ## What Integrations Do[​](#what-integrations-do "Direct link to What Integrations Do") Integrations connect your workspace to external systems: * **Sync data** between systems in real-time * **Access external context** in AI conversations * **Write back** to external systems from workflows * **Calendar sync** for scheduling * **EHR connections** for healthcare workflows ## Integration Types[​](#integration-types "Direct link to Integration Types") | Type | Examples | | -------------- | ----------------------------------------- | | **Native** | Google Calendar, eClinicalWorks, Healthie | | **Webhook** | Any HTTP API (Zapier, n8n, custom) | | **OAuth Apps** | Third-party authorized access | ## Available Integrations[​](#available-integrations "Direct link to Available Integrations") ### Google Calendar[​](#google-calendar "Direct link to Google Calendar") Two-way calendar sync: * Import availability from Google * Create events from workflows * Real-time sync ### eClinicalWorks (EHR)[​](#eclinicalworks-ehr "Direct link to eClinicalWorks (EHR)") Healthcare data via FHIR: * Patient demographics * Appointment scheduling * Clinical summaries * HIPAA-compliant ### Healthie (EHR)[​](#healthie-ehr "Direct link to Healthie (EHR)") Healthcare scheduling and patient management: * Appointment sync via calendars * Patient/member reconciliation * Provider and appointment type import * HIPAA-compliant ### Salesforce (CRM)[​](#salesforce-crm "Direct link to Salesforce (CRM)") CRM integration for sales and service workflows: * OAuth 2.0 connection to your Salesforce org * Member reconciliation with Contacts and Leads * SOQL queries and record management * AI assistant tools for reading and updating Salesforce data * Requires `crm_salesforce` feature flag ### Coming Soon[​](#coming-soon "Direct link to Coming Soon") * Epic (EHR) * HubSpot (CRM/Marketing) * Slack, Microsoft Teams ## How AI Uses Integrations[​](#how-ai-uses-integrations "Direct link to How AI Uses Integrations") **Reading external data:** > AI sees from CRM that member recently purchased Product X, proactively asks about their experience. **Writing to external systems:** > When appointment is booked, event created in Google Calendar and CRM updated automatically. ## Healthcare (FHIR)[​](#healthcare-fhir "Direct link to Healthcare (FHIR)") For healthcare workflows: * **Patient matching** via email, phone, or MRN * **Clinical data access** with patient consent * **Appointment sync** with practice management * **HIPAA-compliant** data handling EHR integrations require Enterprise plan and implementation support. ## Custom Integrations[​](#custom-integrations "Direct link to Custom Integrations") Build your own with: * **Outbound webhooks** to push data out * **Inbound webhooks** to receive data * **REST API** for programmatic access See [Webhooks](https://docs.gravityrail.com/features/developer/webhooks.md) for custom HTTP integrations. ## Pricing & Limits[​](#pricing--limits "Direct link to Pricing & Limits") Feature availability and limits are determined by your subscription plan. See the [pricing page](https://www.gravityrail.com/pages/pricing) for details. ## Related Resources[​](#related-resources "Direct link to Related Resources") * [Webhooks](https://docs.gravityrail.com/features/developer/webhooks.md) - Custom HTTP integrations * [Calendars](https://docs.gravityrail.com/features/knowledge/calendars.md) - Calendar sync details * [Workflows](https://docs.gravityrail.com/features/workflows/.md) - Using integrations in automation --- # Webhooks Push real-time data to external systems when events happen in your workspace. Connect to CRMs, analytics platforms, Zapier, n8n, or any HTTP endpoint. ## What Webhooks Do[​](#what-webhooks-do "Direct link to What Webhooks Do") Webhooks bridge Gravity Rail to your other tools: * **Sync data in real-time** when events occur * **Trigger external workflows** automatically * **Integrate with any API** that accepts HTTP POST * **Monitor delivery** with logging and retries * **Send structured JSON** with full context ## Key Features[​](#key-features "Direct link to Key Features") ### Automatic Retries[​](#automatic-retries "Direct link to Automatic Retries") Failed webhooks retry automatically with exponential backoff (up to 5 attempts, starting 10 seconds apart), then are logged as failed. ### Delivery Logs[​](#delivery-logs "Direct link to Delivery Logs") View all webhook executions with request/response details, status, and retry attempts. ### Secure Delivery[​](#secure-delivery "Direct link to Secure Delivery") HTTPS only. No localhost or internal IPs. Public DNS resolution required. ## How It Works[​](#how-it-works "Direct link to How It Works") ``` Event Occurs → Event Rule Fires → HTTP POST Sent (task, data) (conditions met) (to your endpoint) ``` Webhooks are configured as actions in Event Rules. When conditions are met, Gravity Rail sends a JSON payload to your URL. ## Webhook Payload[​](#webhook-payload "Direct link to Webhook Payload") Every payload carries a top-level `event` field naming the event type, plus `eventRule` and `workspace` blocks. The rest of the body varies by event family (data record, member, or call/chat). For example, a new data record: ``` { "event": "data_record:created", "dataType": { "uuid": "5f3c…", "type": "Contact Form", "slug": "contact_form" }, "member": { "id": 123, "name": "John Doe", "email": "john@example.com", "labels": ["vip"] }, "dataRecord": { "id": 4567, "fields": { "message": "Hello!", "priority": "high" } }, "eventRule": { "id": 88, "uuid": "a1b2…", "name": "Notify CRM" }, "workspace": { "uuid": "9e8d…", "name": "Acme Health" } } ``` For the complete payload field reference (every event family), HMAC signature verification, and how to fetch call audio/transcript, see the [Webhooks developer reference](https://docs.gravityrail.com/user-guide/developer/webhooks.md). ## Common Integrations[​](#common-integrations "Direct link to Common Integrations") | Platform | Use Case | | -------------- | ---------------------- | | **Zapier** | Connect to 5000+ apps | | **n8n** | Self-hosted automation | | **Slack** | Team notifications | | **Custom API** | Your own systems | ## Common Use Cases[​](#common-use-cases "Direct link to Common Use Cases") | Use Case | What It Does | | ----------------- | ------------------------------------ | | **CRM Sync** | Push qualified leads to Salesforce | | **Analytics** | Track funnel events in your platform | | **Notifications** | Alert Slack when VIP contacts you | | **Data Export** | Sync collected data to your database | ## Pricing & Limits[​](#pricing--limits "Direct link to Pricing & Limits") Feature availability and limits are determined by your subscription plan. See the [pricing page](https://www.gravityrail.com/pages/pricing) for details. ## Related Resources[​](#related-resources "Direct link to Related Resources") * [Event Rules](https://docs.gravityrail.com/features/actions/event-rules.md) - Configure webhook triggers * [Data Types](https://docs.gravityrail.com/features/knowledge/data-types.md) - Data sent in webhooks * [Routines](https://docs.gravityrail.com/features/actions/scheduled-events.md) - Time-based webhooks --- # Discord Bots Bring your AI-powered workflows directly into Discord. Discord Bots enable your team and community to interact with Gravity Rail through familiar Discord interfaces - slash commands, @mentions, and direct messages. ## Overview[​](#overview "Direct link to Overview") Discord Bots bridge your Gravity Rail workspace with Discord communities, allowing you to: * **Deploy AI assistants** that respond to questions and provide support in Discord channels * **Create custom slash commands** that trigger specific workflows (e.g., `/order-status`, `/schedule-meeting`) * **Enable @mention responses** for natural conversational interactions * **Link Discord users to members** for personalized experiences * **Support direct messages** for private bot interactions ## Key Features[​](#key-features "Direct link to Key Features") ### Custom Slash Commands[​](#custom-slash-commands "Direct link to Custom Slash Commands") Create branded slash commands that connect directly to your Gravity Rail workflows: | Command | What It Does | | ------------------- | ---------------------------------------------------------- | | `/support` | Opens a support conversation with your AI assistant | | `/order-status` | Checks order status using your Order Management workflow | | `/book-appointment` | Schedules appointments via your Booking workflow | | `/gravity-link` | Links user's Discord account to their Gravity Rail profile | Each command triggers a specific workflow, giving you complete control over the AI's behavior, available tools, and response style. ### Response Modes[​](#response-modes "Direct link to Response Modes") Choose how your bot responds to messages: **Mentions Only** (Default) * Bot responds when explicitly @mentioned * Best for busy channels where you don't want automatic responses * Always responds in DMs **Auto (AI Decides)** * Uses AI to determine if a message warrants a response * Considers conversation context and bot's purpose * Great for support channels where users may ask questions without @mentioning **Off** * Only slash commands work * No automatic message responses * Useful for bots that should only respond to explicit commands ### Account Linking[​](#account-linking "Direct link to Account Linking") Connect Discord users to their Gravity Rail profiles: **Manual Linking**: Users run `/gravity-link` and authorize via Discord OAuth **Auto-Link by Email**: If enabled, users with matching verified emails are automatically linked when they first interact with the bot Linked accounts enable: * Personalized responses using member data * Access to member-specific workflows * Persistent conversation history ### Gateway Mode for Real-Time Responses[​](#gateway-mode-for-real-time-responses "Direct link to Gateway Mode for Real-Time Responses") Enable Gateway Mode for immediate @mention responses: * Maintains a persistent connection to Discord * Responds instantly to @mentions and messages * Required for auto-respond mode * Uses dedicated infrastructure for reliability ## Getting Started[​](#getting-started "Direct link to Getting Started") ### Prerequisites[​](#prerequisites "Direct link to Prerequisites") 1. A Discord account with permission to create applications 2. A Gravity Rail workspace with Professional or Enterprise plan 3. At least one workflow you want to connect to Discord ### Step 1: Create a Discord Application[​](#step-1-create-a-discord-application "Direct link to Step 1: Create a Discord Application") 1. Go to the [Discord Developer Portal](https://discord.com/developers/applications) 2. Click **New Application** and give it a name 3. Navigate to **Bot** in the left sidebar 4. Click **Reset Token** and copy your bot token (you'll need this) 5. Note down these values from **General Information**: * Application ID * Public Key ### Step 2: Configure Bot Permissions[​](#step-2-configure-bot-permissions "Direct link to Step 2: Configure Bot Permissions") In the Discord Developer Portal: 1. Go to **Bot** settings 2. Enable **MESSAGE CONTENT INTENT** if you plan to use Gateway Mode 3. Under **OAuth2** → **URL Generator**: * Select scopes: `bot`, `applications.commands` * Select bot permissions as needed ### Step 3: Add Bot in Gravity Rail[​](#step-3-add-bot-in-gravity-rail "Direct link to Step 3: Add Bot in Gravity Rail") 1. Navigate to **[Discord Bots](https://docs.gravityrail.com/features/integration/@workspace/discord-bots)** in your workspace 2. Click **Add Discord Bot** 3. Enter: * **Bot Name**: A friendly name for this configuration * **Application ID**: From Discord Developer Portal * **Bot Token**: The token you copied earlier * **Public Key**: From Discord Developer Portal * **Client Secret** (optional): Required for OAuth user linking ### Step 4: Configure Behavior[​](#step-4-configure-behavior "Direct link to Step 4: Configure Behavior") On the **Behavior** tab: 1. Set **Response Mode** based on your use case 2. Enable **Auto-Link by Email** if your members have matching Discord emails 3. Toggle **Allow Direct Messages** if you want DM support 4. Enable **Gateway Mode** if you want @mention responses ### Step 5: Create Slash Commands[​](#step-5-create-slash-commands "Direct link to Step 5: Create Slash Commands") 1. Go to the **Commands** tab on your bot detail page 2. Click **Add Command** 3. Enter: * **Command name** (lowercase, letters/numbers/dashes) * **Description** (shown to users in Discord) * **Workflow** to trigger ### Step 6: Register Commands & Install[​](#step-6-register-commands--install "Direct link to Step 6: Register Commands & Install") 1. Click **Register Commands** to push commands to Discord 2. Use the **Install Bot** link to add the bot to your Discord server 3. Test by running your commands in Discord! ## Use Cases[​](#use-cases "Direct link to Use Cases") ### Customer Support Bot[​](#customer-support-bot "Direct link to Customer Support Bot") **Scenario**: Provide 24/7 AI-powered support in your Discord community **Configuration**: * Response Mode: Mentions * Gateway Mode: Enabled * Default Workflow: Your Support workflow with FAQ knowledge base **Slash Commands**: * `/support` - Start a support conversation * `/faq` - Get quick answers to common questions * `/ticket` - Create a support ticket **Behavior**: * Users @mention the bot with questions * Bot uses your knowledge base to provide answers * Complex issues can escalate to human operators ### Internal Team Assistant[​](#internal-team-assistant "Direct link to Internal Team Assistant") **Scenario**: Help your team with quick lookups and actions **Configuration**: * Response Mode: Auto * Auto-Link by Email: Enabled * Allow DM: Enabled **Slash Commands**: * `/schedule` - Check team availability * `/standup` - Post daily standup update * `/docs` - Search internal documentation **Behavior**: * Team members linked automatically by email * Bot joins conversations when relevant * DMs available for private requests ### Community Engagement Bot[​](#community-engagement-bot "Direct link to Community Engagement Bot") **Scenario**: Engage new members and answer questions about your product **Configuration**: * Response Mode: Off (commands only) * Public commands for all users **Slash Commands**: * `/getting-started` - Onboarding guide for new members * `/features` - Learn about product features * `/roadmap` - Check upcoming features **Behavior**: * Non-intrusive - only responds to explicit commands * Provides consistent, accurate information * Reduces repetitive questions for moderators ## Advanced Features[​](#advanced-features "Direct link to Advanced Features") ### Multiple Bots[​](#multiple-bots "Direct link to Multiple Bots") Create different bots for different purposes: * Public support bot for your community server * Internal bot for your team server * Specialized bots for different workflows ### Threaded Conversations[​](#threaded-conversations "Direct link to Threaded Conversations") When enabled, bot responses create Discord threads: * Keeps channel organized * Maintains conversation context * Users can continue conversations naturally ### File Attachments[​](#file-attachments "Direct link to File Attachments") Bots can send files generated by workflows: * PDFs, images, documents * Generated reports * Downloaded artifacts from tools ### Linked Roles[​](#linked-roles "Direct link to Linked Roles") Integrate with Discord's Linked Roles feature: * Verify member status * Grant roles based on Gravity Rail membership * Display verification badges ## Best Practices[​](#best-practices "Direct link to Best Practices") ### Command Naming[​](#command-naming "Direct link to Command Naming") ✓ Use clear, action-oriented names: `/check-order`, `/book-meeting` ✗ Avoid generic names: `/do`, `/action`, `/run` ### Response Mode Selection[​](#response-mode-selection "Direct link to Response Mode Selection") | Scenario | Recommended Mode | | --------------------------- | ---------------- | | High-traffic public channel | Mentions | | Support channel | Auto | | Internal team channel | Auto | | Command-only bot | Off | ### Workflow Design[​](#workflow-design "Direct link to Workflow Design") * Keep initial responses quick (under 3 seconds) * Use deferred responses for longer operations * Include fallback messages for errors * Consider conversation context in prompts ### Security[​](#security "Direct link to Security") * Only give the bot permissions it needs * Use client secret for proper OAuth linking * Review who can use commands (server roles) * Monitor bot activity for abuse ## Troubleshooting[​](#troubleshooting "Direct link to Troubleshooting") ### Bot Not Responding to Commands[​](#bot-not-responding-to-commands "Direct link to Bot Not Responding to Commands") **Solutions**: 1. Verify the bot is installed in your Discord server 2. Check that commands are registered (click **Register Commands**) 3. Ensure the bot is active in Gravity Rail 4. Verify the webhook URL in Discord Developer Portal ### @Mentions Not Working[​](#mentions-not-working "Direct link to @Mentions Not Working") **Solutions**: 1. Enable Gateway Mode in bot settings 2. Enable MESSAGE\_CONTENT Intent in Discord Developer Portal 3. Check that Response Mode is not set to "Off" 4. Verify the bot has permission to read messages in the channel ### User Linking Fails[​](#user-linking-fails "Direct link to User Linking Fails") **Solutions**: 1. Ensure Client Secret is configured 2. Verify user's Discord email is verified 3. Check member exists with matching email (for auto-link) 4. User can try `/gravity-link` command again ### Slow Responses[​](#slow-responses "Direct link to Slow Responses") **Solutions**: 1. Simplify the workflow triggered by commands 2. Ensure tools and data sources are responding quickly 3. Check for any errors in workflow execution 4. Consider using simpler AI models for faster responses ## Pricing & Limits[​](#pricing--limits "Direct link to Pricing & Limits") Feature availability and limits are determined by your subscription plan. See the [pricing page](https://www.gravityrail.com/pages/pricing) for details. ## Related Resources[​](#related-resources "Direct link to Related Resources") * [Workflows Guide](https://docs.gravityrail.com/user-guide/workflows.md) - Configure workflows for Discord commands * [Chats Overview](https://docs.gravityrail.com/user-guide/chats/.md) - Understand conversation management * [Toolkits Guide](https://docs.gravityrail.com/user-guide/toolkits) - Add custom tools to bot workflows --- # Calendars Let your AI book appointments through natural conversation. Calendars connect your real availability to AI assistants—enabling members to schedule without forms or phone tag. ## What Calendars Do[​](#what-calendars-do "Direct link to What Calendars Do") Calendars turn scheduling into a conversation: * **Define availability** with flexible schedule patterns * **Sync with Google Calendar** for real-time accuracy * **Create event types** for different appointment categories * **Enable AI booking** through natural conversation * **Export iCal feeds** for external calendar subscriptions ## Key Features[​](#key-features "Direct link to Key Features") ### Availability Schedules[​](#availability-schedules "Direct link to Availability Schedules") Define when you're available with recurring patterns: * Business hours (Mon-Fri 9-5) * Lunch breaks blocked * Weekend on-call hours * Custom patterns ### Event Types[​](#event-types "Direct link to Event Types") Create bookable appointment types with duration, buffer time, and descriptions. Different event types can have different availability rules. ### Google Calendar Sync[​](#google-calendar-sync "Direct link to Google Calendar Sync") Two-way sync keeps everything in harmony: * Events created in Gravity Rail appear in Google * Busy time from Google blocks booking * Real-time updates via webhooks ### iCal Feeds[​](#ical-feeds "Direct link to iCal Feeds") Export calendar feeds for any iCal-compatible app—Apple Calendar, Outlook, and more. ## How It Works[​](#how-it-works "Direct link to How It Works") ``` Availability → Event Types → AI Booking (when you're free) (what's bookable) (conversational) ``` When a member asks to schedule, your AI assistant: 1. Checks calendar availability in real-time 2. Offers available times conversationally 3. Books the appointment 4. Syncs to connected calendars ## Common Use Cases[​](#common-use-cases "Direct link to Common Use Cases") | Use Case | What It Enables | | ------------------------ | ----------------------------------------------------- | | **Patient Scheduling** | AI books appointments, syncs with practice management | | **Demo Booking** | Prospects self-schedule product demos via chat | | **Consultation Booking** | Clients book around your real availability | | **Team Scheduling** | Coordinate multiple calendars for availability | ## Example Booking Conversation[​](#example-booking-conversation "Direct link to Example Booking Conversation") **Member:** "I'd like to schedule a consultation" **AI:** "I have openings this week on Tuesday at 2pm, Wednesday at 10am, or Thursday at 3:30pm. Which works best?" **Member:** "Wednesday morning" **AI:** "Done! I've booked your consultation for Wednesday at 10am. You'll receive a confirmation shortly." ## Pricing & Limits[​](#pricing--limits "Direct link to Pricing & Limits") Feature availability and limits are determined by your subscription plan. See the [pricing page](https://www.gravityrail.com/pages/pricing) for details. ## Related Resources[​](#related-resources "Direct link to Related Resources") * [AI Assistants](https://docs.gravityrail.com/features/ai/agents.md) - Enable conversational booking * [Workflows](https://docs.gravityrail.com/features/workflows/.md) - Post-booking automation * [Routines](https://docs.gravityrail.com/features/actions/scheduled-events.md) - Time-based triggers --- # Data Types Replace rigid forms with conversational data collection. Data Types define what information to capture, and AI assistants collect it naturally through dialogue—structured data without the friction. ## What Data Types Do[​](#what-data-types-do "Direct link to What Data Types Do") Data Types turn conversations into structured records: * **Define schemas** with typed fields and validation * **Collect via conversation** instead of form-filling * **Search records** with text matching or semantic similarity * **Sync with external systems** via API * **Import/export CSV** for bulk operations ## Key Features[​](#key-features "Direct link to Key Features") ### Conversational Collection[​](#conversational-collection "Direct link to Conversational Collection") AI weaves data collection into natural dialogue—asking follow-up questions, handling corrections, and validating input conversationally. ### Semantic Search[​](#semantic-search "Direct link to Semantic Search") Enable AI-powered search on text fields. Search "frustrated customer" finds records mentioning "angry" or "disappointed" even without exact matches. ### External ID Sync[​](#external-id-sync "Direct link to External ID Sync") Sync records with external systems (CRM, EHR) using external IDs. Upsert operations create or update records automatically. ### Audit Trail[​](#audit-trail "Direct link to Audit Trail") Every record change is tracked—who changed it, when, and what values changed. Essential for compliance. ## How It Works[​](#how-it-works "Direct link to How It Works") ``` Schema Definition → AI Collection → Structured Records (fields & types) (conversational) (queryable, exportable) ``` You define the data structure. When a member engages with a workflow, the AI collects the information naturally and saves it as structured records linked to that member. ## Field Types[​](#field-types "Direct link to Field Types") | Type | Description | Example | | ----------- | --------------- | --------------------- | | **Text** | Free-form text | Name, notes | | **Number** | Numeric values | Age, score | | **Boolean** | Yes/No | Consent, subscription | | **Date** | Date values | Birth date | | **Email** | Validated email | Contact email | | **Phone** | Phone number | Mobile | | **Select** | Single choice | Status, category | ## Dynamic Field Options[​](#dynamic-field-options "Direct link to Dynamic Field Options") Make your data types smarter with conditional logic and custom validation. ### Conditional Select Options[​](#conditional-select-options "Direct link to Conditional Select Options") Show or hide dropdown options based on other field values using `visibleWhen`. Useful when options depend on a previous selection. **Example: State-specific insurance plans** A "State" field with options like CA, TX, NY. An "Insurance Plan" select field where: * "Medi-Cal" only appears when State = CA * "CHIP Texas" only appears when State = TX * "Medicaid" appears for all states Configure each option's `visibleWhen` condition: ``` state == "CA" ``` The AI will only offer relevant options based on what the member has already provided. ### Custom Validation[​](#custom-validation "Direct link to Custom Validation") Add validation rules beyond basic field types using `validateCel`. The validation runs when a value is collected, and the AI will ask the member to correct invalid input. **Example: End date must be after start date** ``` end_date > start_date ``` **Example: Age must be 18 or older** ``` age >= 18 ``` Validation messages are shown conversationally—the AI explains what's wrong and asks for a corrected value. For full syntax details, see the [CEL Expression Guide](https://docs.gravityrail.com/docs/automation/cel-expressions). ## Common Use Cases[​](#common-use-cases "Direct link to Common Use Cases") | Use Case | Data Captured | | ---------------------- | ------------------------------------------- | | **Patient Intake** | Demographics, medical history, insurance | | **Lead Qualification** | Company info, budget, timeline, pain points | | **Incident Reports** | Date, location, severity, actions taken | | **Support Tickets** | Issue details, priority, resolution | ## Example: Patient Intake[​](#example-patient-intake "Direct link to Example: Patient Intake") **Schema:** * Full Name (text, required) * Date of Birth (date, required) * Insurance ID (text) * Allergies (text) * Reason for Visit (text, required) **Conversation:** > **AI:** "To get you scheduled, I'll need a few details. What's your full name?" > > **Member:** "Sarah Johnson" > > **AI:** "Thanks Sarah! And your date of birth?" The AI collects each field naturally, validates as it goes, and saves a structured record—no form required. ## Pricing & Limits[​](#pricing--limits "Direct link to Pricing & Limits") Feature availability and limits are determined by your subscription plan. See the [pricing page](https://www.gravityrail.com/pages/pricing) for details. ## Related Resources[​](#related-resources "Direct link to Related Resources") * [Workflows](https://docs.gravityrail.com/features/workflows/.md) - Trigger data collection in conversations * [AI Assistants](https://docs.gravityrail.com/features/ai/agents.md) - Configure how AI collects data * [Event Rules](https://docs.gravityrail.com/features/actions/event-rules.md) - Automate actions on data changes * [Members](https://docs.gravityrail.com/features/members/.md) - Associate records with people --- # Files Store documents, images, and media that your AI assistants can reference during conversations. Upload product catalogs, policy documents, or FAQ files—and AI uses them to answer questions accurately. ## What Files Do[​](#what-files-do "Direct link to What Files Do") Files connect your content to AI: * **Store securely** with access control * **Attach to assistants** as knowledge sources * **Process images** with cropping and resizing * **Convert documents** to searchable text * **Organize in folders** for easy management ## Key Features[​](#key-features "Direct link to Key Features") ### AI Knowledge Base[​](#ai-knowledge-base "Direct link to AI Knowledge Base") Attach files to assistants and they reference the content during conversations. AI cites your documents, not generic answers. ### Access Control[​](#access-control "Direct link to Access Control") Control who sees what: * **Public** files for logos and site assets * **Site-linked** files inherit site permissions * **Member-only** files require authentication ### Image Processing[​](#image-processing "Direct link to Image Processing") Transform images on-demand: * Resize to any dimensions * Crop to regions * Convert formats (WebP, PNG, JPEG) * Adjust quality for performance ### Document Conversion[​](#document-conversion "Direct link to Document Conversion") Convert PDFs and Word docs to text or markdown for AI processing. Complex documents become searchable, referenceable content. ## How It Works[​](#how-it-works "Direct link to How It Works") ``` Upload → Store → AI Access → Reference in Chat (doc/image) (secure) (knowledge) (accurate answers) ``` Upload a product manual. Attach it to your AI assistant. Now when members ask product questions, AI answers using your actual documentation. ## Supported Types[​](#supported-types "Direct link to Supported Types") | Category | Formats | | ------------- | -------------------------------------------- | | **Documents** | PDF, Word, Excel, PowerPoint, Text, Markdown | | **Images** | JPEG, PNG, GIF, WebP, SVG | | **Media** | MP3, WAV, MP4, AVI | | **Code** | JS, Python, JSON, YAML, and more | ## Common Use Cases[​](#common-use-cases "Direct link to Common Use Cases") | Use Case | What to Upload | | ---------------------- | -------------------------------------- | | **Product Support** | Manuals, FAQs, spec sheets | | **Patient Engagement** | Policies, forms, educational materials | | **Site Branding** | Logos, favicons, hero images | | **Training** | Onboarding docs, procedures, guides | ## Pricing & Limits[​](#pricing--limits "Direct link to Pricing & Limits") Feature availability and limits are determined by your subscription plan. See the [pricing page](https://www.gravityrail.com/pages/pricing) for details. ## Related Resources[​](#related-resources "Direct link to Related Resources") * [AI Assistants](https://docs.gravityrail.com/features/ai/agents.md) - Attach files as knowledge * [Sites](https://docs.gravityrail.com/features/channels/sites.md) - Display files on web portals * [Workflows](https://docs.gravityrail.com/features/workflows/.md) - Accept uploads in conversations --- # Labels Flexible tags for organizing members, chats, and files. Filter your audience, target communications, and trigger automations—all based on simple labels. ## What Labels Do[​](#what-labels-do "Direct link to What Labels Do") Labels help you organize everything: * **Segment members** into meaningful groups * **Filter and search** by category * **Target messages** to specific segments * **Trigger automations** when applied/removed * **Track progress** through stages ## Key Features[​](#key-features "Direct link to Key Features") ### Visual Organization[​](#visual-organization "Direct link to Visual Organization") Color-coded labels for instant recognition. Green for positive, red for urgent, blue for informational. ### Manual or Automatic[​](#manual-or-automatic "Direct link to Manual or Automatic") Apply labels manually or let Event Rules apply them automatically based on behavior. ### Filter Everything[​](#filter-everything "Direct link to Filter Everything") Filter member lists, chat inboxes, and file views by any combination of labels. ### Trigger Automations[​](#trigger-automations "Direct link to Trigger Automations") Use labels to trigger event rules or target scheduled messages. ## How It Works[​](#how-it-works "Direct link to How It Works") ``` Create Label → Apply to Items → Use for Organization (name, color) (members, chats) (filter, automate) ``` Create workspace-wide labels, apply them to members or chats, then use them for filtering, targeting, and automation. ## Label Types[​](#label-types "Direct link to Label Types") | Applies To | Example Labels | | ----------- | ------------------------------- | | **Members** | VIP, Qualified, Active, At-Risk | | **Chats** | Urgent, Waiting, Resolved | | **Files** | Draft, Final, Contract | ## Common Label Patterns[​](#common-label-patterns "Direct link to Common Label Patterns") | Pattern | Labels | | ------------------- | ------------------------------------------- | | **Sales Pipeline** | Lead → Qualified → Demo → Proposal → Closed | | **Customer Health** | Active, At-Risk, Churned, VIP | | **Support Triage** | Urgent, Bug, Feature Request, Billing | | **Patient Journey** | Screened → Eligible → Enrolled → Completed | ## Automation Examples[​](#automation-examples "Direct link to Automation Examples") **Auto-label on task completion:** ``` WHEN: Task "Qualification" completed THEN: Apply label "Qualified" ``` **Target labeled segments:** ``` Schedule: Weekly at 9 AM Target: Members with "Active" label Action: Send check-in message ``` ## Pricing & Limits[​](#pricing--limits "Direct link to Pricing & Limits") Feature availability and limits are determined by your subscription plan. See the [pricing page](https://www.gravityrail.com/pages/pricing) for details. ## Related Resources[​](#related-resources "Direct link to Related Resources") * [Members](https://docs.gravityrail.com/features/members/.md) - Apply labels to people * [Chats](https://docs.gravityrail.com/features/chats/.md) - Apply labels to conversations * [Event Rules](https://docs.gravityrail.com/features/actions/event-rules.md) - Automate labeling * [Routines](https://docs.gravityrail.com/features/actions/scheduled-events.md) - Target labeled segments --- # Members Every person who engages with your workspace—patients, customers, leads, prospects. Members connect conversations, data, and automation into one unified profile. ## What Members Do[​](#what-members-do "Direct link to What Members Do") Members are the people in your workspace: * **Track everyone** who communicates with you * **Store contact info** (phone, email, custom fields) * **View complete history** of all interactions * **Organize with labels** for segmentation * **Connect to workflows** for structured engagement * **Import/export** for bulk operations ## Key Features[​](#key-features "Direct link to Key Features") ### Automatic Creation[​](#automatic-creation "Direct link to Automatic Creation") Members appear automatically from any channel: * Text your phone number * Chat on your website * Sign up on your site * Import via CSV ### External ID Sync[​](#external-id-sync "Direct link to External ID Sync") Connect to your CRM or EHR with external IDs. Import and export sync records by ID to prevent duplicates. ### Communication Preferences[​](#communication-preferences "Direct link to Communication Preferences") Control how each member can be reached—SMS, email, voice—and honor opt-outs automatically. ### Test Mode[​](#test-mode "Direct link to Test Mode") Mark internal accounts as "test" to exclude from analytics while testing. ## How It Works[​](#how-it-works "Direct link to How It Works") ``` Contact Info → Conversations → Data & History (phone, email) (chat, SMS, voice) (records, labels) ``` Members are created automatically when someone texts your number, chats on your site, or signs up. You can also import from existing systems. ## Member Profile[​](#member-profile "Direct link to Member Profile") Each member has: * **Contact**: Name, email, phone * **Labels**: Applied tags for segmentation * **Conversations**: Complete chat history * **Workflows**: Active and completed assignments * **Data**: Information collected via forms * **Activity**: Timeline of all interactions ## Common Use Cases[​](#common-use-cases "Direct link to Common Use Cases") | Use Case | Member Data | | -------------- | ------------------------------------------------ | | **Healthcare** | Patient demographics, insurance, medical history | | **Sales** | Lead info, company details, qualification status | | **Support** | Account info, support history, ticket records | ## Pricing & Limits[​](#pricing--limits "Direct link to Pricing & Limits") Feature availability and limits are determined by your subscription plan. See the [pricing page](https://www.gravityrail.com/pages/pricing) for details. ## Related Resources[​](#related-resources "Direct link to Related Resources") * [Labels](https://docs.gravityrail.com/features/knowledge/labels.md) - Organize members with tags * [Data Types](https://docs.gravityrail.com/features/knowledge/data-types.md) - Store custom member data * [Chats](https://docs.gravityrail.com/features/chats/.md) - View conversation history * [Workflows](https://docs.gravityrail.com/features/workflows/.md) - Engage members through processes --- # Workflows Automate multi-step processes with AI-powered conversations. Workflows guide members through complex tasks—from patient intake to lead qualification—without manual intervention. ## What Workflows Do[​](#what-workflows-do "Direct link to What Workflows Do") Workflows replace repetitive manual processes with intelligent, conversational automation: * **Guide conversations** through structured steps with branching logic * **Collect data** naturally through AI-powered dialogue * **Route automatically** based on member responses and attributes * **Trigger actions** like notifications, labels, or integrations at each step * **Scale operations** without adding staff ## Key Features[​](#key-features "Direct link to Key Features") ### Intelligent Branching[​](#intelligent-branching "Direct link to Intelligent Branching") Route members based on their responses, data, or attributes using conditional logic. Fast-track VIP customers, exit unqualified leads early, or customize paths per segment. ### Data Collection[​](#data-collection "Direct link to Data Collection") Attach data types to tasks and the AI collects information conversationally. Data is structured, searchable, and exportable—no form-filling friction. ### Event-Driven Actions[​](#event-driven-actions "Direct link to Event-Driven Actions") Trigger webhooks, apply labels, send notifications, or start other workflows when members enter or exit tasks. ### Multi-Channel[​](#multi-channel "Direct link to Multi-Channel") Workflows run identically across SMS, voice, web chat, and email—members engage on their preferred channel. ### Version Control[​](#version-control "Direct link to Version Control") Publish workflow versions to create immutable snapshots of your configuration. Compare versions side-by-side, activate any published version for new conversations, and roll back instantly if something goes wrong. Every change is tracked with author attribution and timestamps. ### Scheduling[​](#scheduling "Direct link to Scheduling") Start workflows automatically on a schedule. Daily check-ins, weekly surveys, or monthly renewals—all automated. ## How It Works[​](#how-it-works "Direct link to How It Works") ``` Member Starts → AI Guides Tasks → Data Collected → Actions Triggered (site/SMS/call) (conversational) (structured) (webhooks/labels) ``` A workflow consists of **tasks**—individual conversation goals that flow into each other: | Component | Description | | --------------- | ------------------------------------------------ | | **Workflow** | The overall process (e.g., "Patient Onboarding") | | **Tasks** | Individual steps with AI instructions and goals | | **Assignments** | A member's progress through the workflow | | **Branches** | Conditional paths based on responses or data | Tasks can branch based on member responses, collected data, or attributes—enabling sophisticated routing without code. ## Common Use Cases[​](#common-use-cases "Direct link to Common Use Cases") | Use Case | What It Automates | | ---------------------- | ------------------------------------------------------------------ | | **Patient Intake** | Collect medical history, verify eligibility, schedule appointments | | **Lead Qualification** | Score prospects, route to sales, capture contact info | | **Support Triage** | Classify issues, attempt resolution, escalate appropriately | | **Onboarding** | Welcome new members, collect preferences, guide setup | | **Surveys & Feedback** | Scheduled check-ins, NPS collection, satisfaction tracking | ## Example: Patient Screening[​](#example-patient-screening "Direct link to Example: Patient Screening") A clinical trial screening workflow might flow like this: ``` Consent → Verify Conditions → Verify Medications → Match to Site → Confirmed ↓ ↓ Unqualified Unqualified ``` The AI handles each step conversationally: * Collects medical history naturally * Routes qualified patients to site matching * Exits gracefully for unqualified candidates * Captures structured data throughout What previously required 15-minute phone calls now happens in 3-5 minutes via text. ## Pricing & Limits[​](#pricing--limits "Direct link to Pricing & Limits") Feature availability and limits are determined by your subscription plan. See the [pricing page](https://www.gravityrail.com/pages/pricing) for details. ## Related Resources[​](#related-resources "Direct link to Related Resources") * [Agents](https://docs.gravityrail.com/features/ai/agents.md) - Configure the AI that powers your workflows * [Data Types](https://docs.gravityrail.com/features/knowledge/data-types.md) - Define what data to collect * [Event Rules](https://docs.gravityrail.com/features/actions/event-rules.md) - Automate actions on workflow events * [Routines](https://docs.gravityrail.com/features/actions/scheduled-events.md) - Trigger workflows on a schedule --- # SDK Reference **@gravity-rail/sdk** *** # @gravity-rail/sdk ## Enumerations[​](#enumerations "Direct link to Enumerations") * [AccessGrantResourceType](https://docs.gravityrail.com/sdk/enumerations/AccessGrantResourceType.md) * [AccessGrantStatus](https://docs.gravityrail.com/sdk/enumerations/AccessGrantStatus.md) * [AccessGrantTrigger](https://docs.gravityrail.com/sdk/enumerations/AccessGrantTrigger.md) * [AccessLevel](https://docs.gravityrail.com/sdk/enumerations/AccessLevel.md) * [AttendeeResponseStatus](https://docs.gravityrail.com/sdk/enumerations/AttendeeResponseStatus.md) * [AttendeeStatus](https://docs.gravityrail.com/sdk/enumerations/AttendeeStatus.md) * [CalendarEventStatus](https://docs.gravityrail.com/sdk/enumerations/CalendarEventStatus.md) * [CalendarPermissionType](https://docs.gravityrail.com/sdk/enumerations/CalendarPermissionType.md) * [CalendarScheduleAvailabilityType](https://docs.gravityrail.com/sdk/enumerations/CalendarScheduleAvailabilityType.md) * [CalendarScheduleRecurrence](https://docs.gravityrail.com/sdk/enumerations/CalendarScheduleRecurrence.md) * [CalendarSource](https://docs.gravityrail.com/sdk/enumerations/CalendarSource.md) * [CapabilityClass](https://docs.gravityrail.com/sdk/enumerations/CapabilityClass.md) * [ConsentMethod](https://docs.gravityrail.com/sdk/enumerations/ConsentMethod.md) * [CriterionType](https://docs.gravityrail.com/sdk/enumerations/CriterionType.md) * [DataCategory](https://docs.gravityrail.com/sdk/enumerations/DataCategory.md) * [DataFieldType](https://docs.gravityrail.com/sdk/enumerations/DataFieldType.md) * [DataSensitivity](https://docs.gravityrail.com/sdk/enumerations/DataSensitivity.md) * [DataTypeRecordScope](https://docs.gravityrail.com/sdk/enumerations/DataTypeRecordScope.md) * [DriverMode](https://docs.gravityrail.com/sdk/enumerations/DriverMode.md) * [EventRuleActionType](https://docs.gravityrail.com/sdk/enumerations/EventRuleActionType.md) * [EventRuleEventType](https://docs.gravityrail.com/sdk/enumerations/EventRuleEventType.md) * [EventRuleObjectType](https://docs.gravityrail.com/sdk/enumerations/EventRuleObjectType.md) * [FeatureCategory](https://docs.gravityrail.com/sdk/enumerations/FeatureCategory.md) * [FeatureVisibility](https://docs.gravityrail.com/sdk/enumerations/FeatureVisibility.md) * [FhirClientType](https://docs.gravityrail.com/sdk/enumerations/FhirClientType.md) * [FhirConnectionState](https://docs.gravityrail.com/sdk/enumerations/FhirConnectionState.md) * [FhirVendor](https://docs.gravityrail.com/sdk/enumerations/FhirVendor.md) * [IndexStatus](https://docs.gravityrail.com/sdk/enumerations/IndexStatus.md) * [InvitationStatus](https://docs.gravityrail.com/sdk/enumerations/InvitationStatus.md) * [McpServerState](https://docs.gravityrail.com/sdk/enumerations/McpServerState.md) * [MemberFeature](https://docs.gravityrail.com/sdk/enumerations/MemberFeature.md) * [MemberType](https://docs.gravityrail.com/sdk/enumerations/MemberType.md) * [OrgFeature](https://docs.gravityrail.com/sdk/enumerations/OrgFeature.md) * [ProductType](https://docs.gravityrail.com/sdk/enumerations/ProductType.md) * [Resource](https://docs.gravityrail.com/sdk/enumerations/Resource.md) * [Scope](https://docs.gravityrail.com/sdk/enumerations/Scope.md) * [ScopeCategory](https://docs.gravityrail.com/sdk/enumerations/ScopeCategory.md) * [ToolkitState](https://docs.gravityrail.com/sdk/enumerations/ToolkitState.md) * [WorkspaceFeature](https://docs.gravityrail.com/sdk/enumerations/WorkspaceFeature.md) * [WorkspaceProvisionStatus](https://docs.gravityrail.com/sdk/enumerations/WorkspaceProvisionStatus.md) ## Classes[​](#classes "Direct link to Classes") * [AgentBuilder](https://docs.gravityrail.com/sdk/classes/AgentBuilder.md) * [ApiError](https://docs.gravityrail.com/sdk/classes/ApiError.md) * [ApplyError](https://docs.gravityrail.com/sdk/classes/ApplyError.md) * [AppsApi](https://docs.gravityrail.com/sdk/classes/AppsApi.md) * [BaseApiClient](https://docs.gravityrail.com/sdk/classes/BaseApiClient.md) * [BuildersApi](https://docs.gravityrail.com/sdk/classes/BuildersApi.md) * [CELApi](https://docs.gravityrail.com/sdk/classes/CELApi.md) * [FormBuilder](https://docs.gravityrail.com/sdk/classes/FormBuilder.md) * [GravityRailClient](https://docs.gravityrail.com/sdk/classes/GravityRailClient.md) * [JourneyBuilder](https://docs.gravityrail.com/sdk/classes/JourneyBuilder.md) * [JourneyStepBuilder](https://docs.gravityrail.com/sdk/classes/JourneyStepBuilder.md) * [MemberFilterBuilder](https://docs.gravityrail.com/sdk/classes/MemberFilterBuilder.md) * [MemberImportValidationError](https://docs.gravityrail.com/sdk/classes/MemberImportValidationError.md) * [MemberLabelBuilder](https://docs.gravityrail.com/sdk/classes/MemberLabelBuilder.md) * [NotificationRuleBuilder](https://docs.gravityrail.com/sdk/classes/NotificationRuleBuilder.md) * [OrgApi](https://docs.gravityrail.com/sdk/classes/OrgApi.md) * [QueriesApi](https://docs.gravityrail.com/sdk/classes/QueriesApi.md) * [RoleUpdate](https://docs.gravityrail.com/sdk/classes/RoleUpdate.md) * [RoutineBuilder](https://docs.gravityrail.com/sdk/classes/RoutineBuilder.md) * [ScopeManager](https://docs.gravityrail.com/sdk/classes/ScopeManager.md) * [SupervisorsApi](https://docs.gravityrail.com/sdk/classes/SupervisorsApi.md) * [TaskBuilder](https://docs.gravityrail.com/sdk/classes/TaskBuilder.md) * [TemplatesApi](https://docs.gravityrail.com/sdk/classes/TemplatesApi.md) * [WorkflowBuilder](https://docs.gravityrail.com/sdk/classes/WorkflowBuilder.md) * [WorkspaceBuilder](https://docs.gravityrail.com/sdk/classes/WorkspaceBuilder.md) ## Interfaces[​](#interfaces "Direct link to Interfaces") * [A2PBrandEnrollmentUrlResponse](https://docs.gravityrail.com/sdk/interfaces/A2PBrandEnrollmentUrlResponse.md) * [A2PCampaignConfigResponse](https://docs.gravityrail.com/sdk/interfaces/A2PCampaignConfigResponse.md) * [A2PEnrollmentSiteCandidate](https://docs.gravityrail.com/sdk/interfaces/A2PEnrollmentSiteCandidate.md) * [A2PEnrollmentSiteCandidatesResponse](https://docs.gravityrail.com/sdk/interfaces/A2PEnrollmentSiteCandidatesResponse.md) * [AbilityConfigIssue](https://docs.gravityrail.com/sdk/interfaces/AbilityConfigIssue.md) * [AbilityTypeResponse](https://docs.gravityrail.com/sdk/interfaces/AbilityTypeResponse.md) * [AbilityTypesResponse](https://docs.gravityrail.com/sdk/interfaces/AbilityTypesResponse.md) * [AccessGrantDecision](https://docs.gravityrail.com/sdk/interfaces/AccessGrantDecision.md) * [Account](https://docs.gravityrail.com/sdk/interfaces/Account.md) * [AccountFormData](https://docs.gravityrail.com/sdk/interfaces/AccountFormData.md) * [AccountLookupResponse](https://docs.gravityrail.com/sdk/interfaces/AccountLookupResponse.md) * [AccountReportItem](https://docs.gravityrail.com/sdk/interfaces/AccountReportItem.md) * [AccountState](https://docs.gravityrail.com/sdk/interfaces/AccountState.md) * [AddGroupMemberRequest](https://docs.gravityrail.com/sdk/interfaces/AddGroupMemberRequest.md) * [Address](https://docs.gravityrail.com/sdk/interfaces/Address.md) * [AdminBulkWorkflowAccessValidationResponse](https://docs.gravityrail.com/sdk/interfaces/AdminBulkWorkflowAccessValidationResponse.md) * [AdminChatDetailResponse](https://docs.gravityrail.com/sdk/interfaces/AdminChatDetailResponse.md) * [AdminChatResponse](https://docs.gravityrail.com/sdk/interfaces/AdminChatResponse.md) * [AdminChatsOptions](https://docs.gravityrail.com/sdk/interfaces/AdminChatsOptions.md) * [AdminPidsFindingResponse](https://docs.gravityrail.com/sdk/interfaces/AdminPidsFindingResponse.md) * [AdminWorkspaceAccessGapSummary](https://docs.gravityrail.com/sdk/interfaces/AdminWorkspaceAccessGapSummary.md) * [AgentChatParticipant](https://docs.gravityrail.com/sdk/interfaces/AgentChatParticipant.md) * [AgentConfigFormData](https://docs.gravityrail.com/sdk/interfaces/AgentConfigFormData.md) * [AgentConfigResponse](https://docs.gravityrail.com/sdk/interfaces/AgentConfigResponse.md) * [AgentExport](https://docs.gravityrail.com/sdk/interfaces/AgentExport.md) * [AgentMemoryConfig](https://docs.gravityrail.com/sdk/interfaces/AgentMemoryConfig.md) * [AgentResponse](https://docs.gravityrail.com/sdk/interfaces/AgentResponse.md) * [AIModelsResponse](https://docs.gravityrail.com/sdk/interfaces/AIModelsResponse.md) * [AIModelUsageResponse](https://docs.gravityrail.com/sdk/interfaces/AIModelUsageResponse.md) * [AIUsageDetailsResponse](https://docs.gravityrail.com/sdk/interfaces/AIUsageDetailsResponse.md) * [AIUsageReport](https://docs.gravityrail.com/sdk/interfaces/AIUsageReport.md) * [AIUsageReportParams](https://docs.gravityrail.com/sdk/interfaces/AIUsageReportParams.md) * [AllModelsResponse](https://docs.gravityrail.com/sdk/interfaces/AllModelsResponse.md) * [AnalyticsFilter](https://docs.gravityrail.com/sdk/interfaces/AnalyticsFilter.md) * [AnalyticsQuery](https://docs.gravityrail.com/sdk/interfaces/AnalyticsQuery.md) * [AnonymousInteractionResponse](https://docs.gravityrail.com/sdk/interfaces/AnonymousInteractionResponse.md) * [AnonymousMemberResolutionResponse](https://docs.gravityrail.com/sdk/interfaces/AnonymousMemberResolutionResponse.md) * [ApiKey](https://docs.gravityrail.com/sdk/interfaces/ApiKey.md) * [ApiKeyCreated](https://docs.gravityrail.com/sdk/interfaces/ApiKeyCreated.md) * [ApiKeyFormData](https://docs.gravityrail.com/sdk/interfaces/ApiKeyFormData.md) * [ApiKeyScope](https://docs.gravityrail.com/sdk/interfaces/ApiKeyScope.md) * [ApiKeyScopesResponse](https://docs.gravityrail.com/sdk/interfaces/ApiKeyScopesResponse.md) * [ApiScope](https://docs.gravityrail.com/sdk/interfaces/ApiScope.md) * [ApiValidationError](https://docs.gravityrail.com/sdk/interfaces/ApiValidationError.md) * [AppBuilder](https://docs.gravityrail.com/sdk/interfaces/AppBuilder.md) * [AppConnectionAccessInterrupt](https://docs.gravityrail.com/sdk/interfaces/AppConnectionAccessInterrupt.md) * [AppConnectionDirectoryEntry](https://docs.gravityrail.com/sdk/interfaces/AppConnectionDirectoryEntry.md) * [AppConnectionDirectoryResponse](https://docs.gravityrail.com/sdk/interfaces/AppConnectionDirectoryResponse.md) * [AppContext](https://docs.gravityrail.com/sdk/interfaces/AppContext.md) * [AppCredentialResponse](https://docs.gravityrail.com/sdk/interfaces/AppCredentialResponse.md) * [AssignmentResponse](https://docs.gravityrail.com/sdk/interfaces/AssignmentResponse.md) * [AssignmentsQueryParams](https://docs.gravityrail.com/sdk/interfaces/AssignmentsQueryParams.md) * [AssignmentTaskResponse](https://docs.gravityrail.com/sdk/interfaces/AssignmentTaskResponse.md) * [AssistantMessageActionParams](https://docs.gravityrail.com/sdk/interfaces/AssistantMessageActionParams.md) * [AttachedAddonInfo](https://docs.gravityrail.com/sdk/interfaces/AttachedAddonInfo.md) * [AttendeeResponse](https://docs.gravityrail.com/sdk/interfaces/AttendeeResponse.md) * [AudioMessageMetadata](https://docs.gravityrail.com/sdk/interfaces/AudioMessageMetadata.md) * [AudioPlaybackAbilityConfig](https://docs.gravityrail.com/sdk/interfaces/AudioPlaybackAbilityConfig.md) * [AudioPlaybackFileEntry](https://docs.gravityrail.com/sdk/interfaces/AudioPlaybackFileEntry.md) * [AuthorizedRep](https://docs.gravityrail.com/sdk/interfaces/AuthorizedRep.md) * [AuthorizeRequest](https://docs.gravityrail.com/sdk/interfaces/AuthorizeRequest.md) * [AuthorizeResponse](https://docs.gravityrail.com/sdk/interfaces/AuthorizeResponse.md) * [AvailabilityCheck](https://docs.gravityrail.com/sdk/interfaces/AvailabilityCheck.md) * [AvailabilityResponse](https://docs.gravityrail.com/sdk/interfaces/AvailabilityResponse.md) * [AvailableMemberRole](https://docs.gravityrail.com/sdk/interfaces/AvailableMemberRole.md) * [AvailableSlotsRequest](https://docs.gravityrail.com/sdk/interfaces/AvailableSlotsRequest.md) * [AvailableSlotsResponse](https://docs.gravityrail.com/sdk/interfaces/AvailableSlotsResponse.md) * [AWSRealtimeModelConfig](https://docs.gravityrail.com/sdk/interfaces/AWSRealtimeModelConfig.md) * [BaseChatModelConfig](https://docs.gravityrail.com/sdk/interfaces/BaseChatModelConfig.md) * [BaseRealtimeModelConfig](https://docs.gravityrail.com/sdk/interfaces/BaseRealtimeModelConfig.md) * [BillingResourceCounts](https://docs.gravityrail.com/sdk/interfaces/BillingResourceCounts.md) * [BillingStatistics](https://docs.gravityrail.com/sdk/interfaces/BillingStatistics.md) * [BillingUsageInfo](https://docs.gravityrail.com/sdk/interfaces/BillingUsageInfo.md) * [BoardsResponse](https://docs.gravityrail.com/sdk/interfaces/BoardsResponse.md) * [BuilderListResponse](https://docs.gravityrail.com/sdk/interfaces/BuilderListResponse.md) * [BuilderResponse](https://docs.gravityrail.com/sdk/interfaces/BuilderResponse.md) * [BuildWorkspaceRequest](https://docs.gravityrail.com/sdk/interfaces/BuildWorkspaceRequest.md) * [BuildWorkspaceResponse](https://docs.gravityrail.com/sdk/interfaces/BuildWorkspaceResponse.md) * [BulkCreateDataRecordRequest](https://docs.gravityrail.com/sdk/interfaces/BulkCreateDataRecordRequest.md) * [BulkCreateDataRecordResponse](https://docs.gravityrail.com/sdk/interfaces/BulkCreateDataRecordResponse.md) * [BulkCreateMembersRequest](https://docs.gravityrail.com/sdk/interfaces/BulkCreateMembersRequest.md) * [BulkCreateMembersResponse](https://docs.gravityrail.com/sdk/interfaces/BulkCreateMembersResponse.md) * [BulkMemberItem](https://docs.gravityrail.com/sdk/interfaces/BulkMemberItem.md) * [BulkMemberResult](https://docs.gravityrail.com/sdk/interfaces/BulkMemberResult.md) * [BulkRecordResult](https://docs.gravityrail.com/sdk/interfaces/BulkRecordResult.md) * [BusinessHoursDay](https://docs.gravityrail.com/sdk/interfaces/BusinessHoursDay.md) * [BusinessInfo](https://docs.gravityrail.com/sdk/interfaces/BusinessInfo.md) * [BusinessProfileCancelResponse](https://docs.gravityrail.com/sdk/interfaces/BusinessProfileCancelResponse.md) * [BusinessProfileSubmitResponse](https://docs.gravityrail.com/sdk/interfaces/BusinessProfileSubmitResponse.md) * [CalendarBookingAbilityConfig](https://docs.gravityrail.com/sdk/interfaces/CalendarBookingAbilityConfig.md) * [CalendarEventFormData](https://docs.gravityrail.com/sdk/interfaces/CalendarEventFormData.md) * [CalendarEventsQueryParams](https://docs.gravityrail.com/sdk/interfaces/CalendarEventsQueryParams.md) * [CalendarEventTypeFormData](https://docs.gravityrail.com/sdk/interfaces/CalendarEventTypeFormData.md) * [CalendarFormData](https://docs.gravityrail.com/sdk/interfaces/CalendarFormData.md) * [CalendarScheduleFormData](https://docs.gravityrail.com/sdk/interfaces/CalendarScheduleFormData.md) * [CancelCredentialChangeInviteResponse](https://docs.gravityrail.com/sdk/interfaces/CancelCredentialChangeInviteResponse.md) * [CancelCredentialChangeResponse](https://docs.gravityrail.com/sdk/interfaces/CancelCredentialChangeResponse.md) * [CELContextRequest](https://docs.gravityrail.com/sdk/interfaces/CELContextRequest.md) * [CELContextResponse](https://docs.gravityrail.com/sdk/interfaces/CELContextResponse.md) * [CELFunction](https://docs.gravityrail.com/sdk/interfaces/CELFunction.md) * [CELVariable](https://docs.gravityrail.com/sdk/interfaces/CELVariable.md) * [ChangeWorkspaceProductRequest](https://docs.gravityrail.com/sdk/interfaces/ChangeWorkspaceProductRequest.md) * [ChangeWorkspaceProductResponse](https://docs.gravityrail.com/sdk/interfaces/ChangeWorkspaceProductResponse.md) * [ChannelErrorBreakdown](https://docs.gravityrail.com/sdk/interfaces/ChannelErrorBreakdown.md) * [ChannelFailures](https://docs.gravityrail.com/sdk/interfaces/ChannelFailures.md) * [CharlestonPmdAbilityConfig](https://docs.gravityrail.com/sdk/interfaces/CharlestonPmdAbilityConfig.md) * [ChatActivityEvent](https://docs.gravityrail.com/sdk/interfaces/ChatActivityEvent.md) * [ChatCompletionError](https://docs.gravityrail.com/sdk/interfaces/ChatCompletionError.md) * [ChatContinueActionParams](https://docs.gravityrail.com/sdk/interfaces/ChatContinueActionParams.md) * [ChatCreateActionParams](https://docs.gravityrail.com/sdk/interfaces/ChatCreateActionParams.md) * [ChatFilterFormData](https://docs.gravityrail.com/sdk/interfaces/ChatFilterFormData.md) * [ChatFilterResponse](https://docs.gravityrail.com/sdk/interfaces/ChatFilterResponse.md) * [ChatFilterRuleFormData](https://docs.gravityrail.com/sdk/interfaces/ChatFilterRuleFormData.md) * [ChatFilterRuleResponse](https://docs.gravityrail.com/sdk/interfaces/ChatFilterRuleResponse.md) * [ChatFormData](https://docs.gravityrail.com/sdk/interfaces/ChatFormData.md) * [ChatInterruptResponse](https://docs.gravityrail.com/sdk/interfaces/ChatInterruptResponse.md) * [ChatLabelFormData](https://docs.gravityrail.com/sdk/interfaces/ChatLabelFormData.md) * [ChatLabelResponse](https://docs.gravityrail.com/sdk/interfaces/ChatLabelResponse.md) * [ChatMessage](https://docs.gravityrail.com/sdk/interfaces/ChatMessage.md) * [ChatMessageChunk](https://docs.gravityrail.com/sdk/interfaces/ChatMessageChunk.md) * [ChatMessageObject](https://docs.gravityrail.com/sdk/interfaces/ChatMessageObject.md) * [ChatModelResponse](https://docs.gravityrail.com/sdk/interfaces/ChatModelResponse.md) * [ChatNoteSyncConfig](https://docs.gravityrail.com/sdk/interfaces/ChatNoteSyncConfig.md) * [ChatNoteSyncFilters](https://docs.gravityrail.com/sdk/interfaces/ChatNoteSyncFilters.md) * [ChatParticipantFormData](https://docs.gravityrail.com/sdk/interfaces/ChatParticipantFormData.md) * [ChatParticipantResponse](https://docs.gravityrail.com/sdk/interfaces/ChatParticipantResponse.md) * [ChatPauseActionParams](https://docs.gravityrail.com/sdk/interfaces/ChatPauseActionParams.md) * [ChatResponse](https://docs.gravityrail.com/sdk/interfaces/ChatResponse.md) * [ChatState](https://docs.gravityrail.com/sdk/interfaces/ChatState.md) * [ChatSummarizeActionParams](https://docs.gravityrail.com/sdk/interfaces/ChatSummarizeActionParams.md) * [ChatTokenUsageResponse](https://docs.gravityrail.com/sdk/interfaces/ChatTokenUsageResponse.md) * [ChildTaskFormData](https://docs.gravityrail.com/sdk/interfaces/ChildTaskFormData.md) * [ChildTaskResponse](https://docs.gravityrail.com/sdk/interfaces/ChildTaskResponse.md) * [ClaudeChatModelConfig](https://docs.gravityrail.com/sdk/interfaces/ClaudeChatModelConfig.md) * [CleanupChatsResponse](https://docs.gravityrail.com/sdk/interfaces/CleanupChatsResponse.md) * [ClientWorkspace](https://docs.gravityrail.com/sdk/interfaces/ClientWorkspace.md) * [ColumnsResponse](https://docs.gravityrail.com/sdk/interfaces/ColumnsResponse.md) * [CommunicationDetailsResponse](https://docs.gravityrail.com/sdk/interfaces/CommunicationDetailsResponse.md) * [CompareWithStripeResponse](https://docs.gravityrail.com/sdk/interfaces/CompareWithStripeResponse.md) * [ConcludeAssignmentActionParams](https://docs.gravityrail.com/sdk/interfaces/ConcludeAssignmentActionParams.md) * [ConfigurePatientSyncRequest](https://docs.gravityrail.com/sdk/interfaces/ConfigurePatientSyncRequest.md) * [ConflictPolicy](https://docs.gravityrail.com/sdk/interfaces/ConflictPolicy.md) * [ConfluenceConnectionResponse](https://docs.gravityrail.com/sdk/interfaces/ConfluenceConnectionResponse.md) * [ConnectionSyncConfig](https://docs.gravityrail.com/sdk/interfaces/ConnectionSyncConfig.md) * [ContributorChatParticipant](https://docs.gravityrail.com/sdk/interfaces/ContributorChatParticipant.md) * [ConversationControlAbilityConfig](https://docs.gravityrail.com/sdk/interfaces/ConversationControlAbilityConfig.md) * [ConversationHistoryAbilityConfig](https://docs.gravityrail.com/sdk/interfaces/ConversationHistoryAbilityConfig.md) * [ConvertedFileResponse](https://docs.gravityrail.com/sdk/interfaces/ConvertedFileResponse.md) * [CreateAccessGrantRequest](https://docs.gravityrail.com/sdk/interfaces/CreateAccessGrantRequest.md) * [CreateAccountOrgMembershipRequest](https://docs.gravityrail.com/sdk/interfaces/CreateAccountOrgMembershipRequest.md) * [CreateAccountOrgMembershipResponse](https://docs.gravityrail.com/sdk/interfaces/CreateAccountOrgMembershipResponse.md) * [CreateAgentRequest](https://docs.gravityrail.com/sdk/interfaces/CreateAgentRequest.md) * [CreateAnonymousMemberRequest](https://docs.gravityrail.com/sdk/interfaces/CreateAnonymousMemberRequest.md) * [CreateAppConnectionRequest](https://docs.gravityrail.com/sdk/interfaces/CreateAppConnectionRequest.md) * [CreateAppRequest](https://docs.gravityrail.com/sdk/interfaces/CreateAppRequest.md) * [CreateAssignmentFormData](https://docs.gravityrail.com/sdk/interfaces/CreateAssignmentFormData.md) * [CreateBuilderRequest](https://docs.gravityrail.com/sdk/interfaces/CreateBuilderRequest.md) * [CreateCredentialChangeInviteRequest](https://docs.gravityrail.com/sdk/interfaces/CreateCredentialChangeInviteRequest.md) * [CreateDiscordBotRequest](https://docs.gravityrail.com/sdk/interfaces/CreateDiscordBotRequest.md) * [CreateFhirConnectionRequest](https://docs.gravityrail.com/sdk/interfaces/CreateFhirConnectionRequest.md) * [CreateMemberFieldRequest](https://docs.gravityrail.com/sdk/interfaces/CreateMemberFieldRequest.md) * [CreateOperatorGroupRequest](https://docs.gravityrail.com/sdk/interfaces/CreateOperatorGroupRequest.md) * [CreateOrganizationInvitationFormData](https://docs.gravityrail.com/sdk/interfaces/CreateOrganizationInvitationFormData.md) * [CreateOrganizationRequest](https://docs.gravityrail.com/sdk/interfaces/CreateOrganizationRequest.md) * [CreatePersonaRequest](https://docs.gravityrail.com/sdk/interfaces/CreatePersonaRequest.md) * [CreatePhoneVoiceOutboundChatInput](https://docs.gravityrail.com/sdk/interfaces/CreatePhoneVoiceOutboundChatInput.md) * [CreateProductRequest](https://docs.gravityrail.com/sdk/interfaces/CreateProductRequest.md) * [CreatePronunciationEntryFormData](https://docs.gravityrail.com/sdk/interfaces/CreatePronunciationEntryFormData.md) * [CreateRoutineRequest](https://docs.gravityrail.com/sdk/interfaces/CreateRoutineRequest.md) * [CreateScenarioRequest](https://docs.gravityrail.com/sdk/interfaces/CreateScenarioRequest.md) * [CreateSignupResponse](https://docs.gravityrail.com/sdk/interfaces/CreateSignupResponse.md) * [CreateSlackAppRequest](https://docs.gravityrail.com/sdk/interfaces/CreateSlackAppRequest.md) * [CreateTeamsAppRequest](https://docs.gravityrail.com/sdk/interfaces/CreateTeamsAppRequest.md) * [CreateWorkflowContributorRequest](https://docs.gravityrail.com/sdk/interfaces/CreateWorkflowContributorRequest.md) * [CreateWorkflowFromTemplateFormData](https://docs.gravityrail.com/sdk/interfaces/CreateWorkflowFromTemplateFormData.md) * [CreateWorkspaceInvitationFormData](https://docs.gravityrail.com/sdk/interfaces/CreateWorkspaceInvitationFormData.md) * [CreateWorkspaceMemberRequest](https://docs.gravityrail.com/sdk/interfaces/CreateWorkspaceMemberRequest.md) * [CredentialChangeInviteConfirmResponse](https://docs.gravityrail.com/sdk/interfaces/CredentialChangeInviteConfirmResponse.md) * [CredentialChangeInviteDetails](https://docs.gravityrail.com/sdk/interfaces/CredentialChangeInviteDetails.md) * [CredentialChangeInviteResponse](https://docs.gravityrail.com/sdk/interfaces/CredentialChangeInviteResponse.md) * [CredentialChangeRequestResponse](https://docs.gravityrail.com/sdk/interfaces/CredentialChangeRequestResponse.md) * [CredentialChangeVerifyResponse](https://docs.gravityrail.com/sdk/interfaces/CredentialChangeVerifyResponse.md) * [CriterionInput](https://docs.gravityrail.com/sdk/interfaces/CriterionInput.md) * [CriterionResultResponse](https://docs.gravityrail.com/sdk/interfaces/CriterionResultResponse.md) * [CurrentMemberResponse](https://docs.gravityrail.com/sdk/interfaces/CurrentMemberResponse.md) * [CurrentOrgMember](https://docs.gravityrail.com/sdk/interfaces/CurrentOrgMember.md) * [CurrentPlanInfo](https://docs.gravityrail.com/sdk/interfaces/CurrentPlanInfo.md) * [CursorPaginatedResponse](https://docs.gravityrail.com/sdk/interfaces/CursorPaginatedResponse.md) * [CustomRealtimeModelConfig](https://docs.gravityrail.com/sdk/interfaces/CustomRealtimeModelConfig.md) * [CustomToolExport](https://docs.gravityrail.com/sdk/interfaces/CustomToolExport.md) * [CustomToolFormData](https://docs.gravityrail.com/sdk/interfaces/CustomToolFormData.md) * [CustomToolkitExport](https://docs.gravityrail.com/sdk/interfaces/CustomToolkitExport.md) * [CustomToolkitFormData](https://docs.gravityrail.com/sdk/interfaces/CustomToolkitFormData.md) * [CustomToolkitUpdateFormData](https://docs.gravityrail.com/sdk/interfaces/CustomToolkitUpdateFormData.md) * [CustomToolUpdateFormData](https://docs.gravityrail.com/sdk/interfaces/CustomToolUpdateFormData.md) * [DailyPhoneRowResponse](https://docs.gravityrail.com/sdk/interfaces/DailyPhoneRowResponse.md) * [DailySMSRowResponse](https://docs.gravityrail.com/sdk/interfaces/DailySMSRowResponse.md) * [DashboardMetrics](https://docs.gravityrail.com/sdk/interfaces/DashboardMetrics.md) * [DataAccessAbilityConfig](https://docs.gravityrail.com/sdk/interfaces/DataAccessAbilityConfig.md) * [DataAccessGrantInterrupt](https://docs.gravityrail.com/sdk/interfaces/DataAccessGrantInterrupt.md) * [DataField](https://docs.gravityrail.com/sdk/interfaces/DataField.md) * [DataFieldFormData](https://docs.gravityrail.com/sdk/interfaces/DataFieldFormData.md) * [DataIntegrityReportItem](https://docs.gravityrail.com/sdk/interfaces/DataIntegrityReportItem.md) * [DataRecordAssociationFormData](https://docs.gravityrail.com/sdk/interfaces/DataRecordAssociationFormData.md) * [DataRecordContext](https://docs.gravityrail.com/sdk/interfaces/DataRecordContext.md) * [DataRecordFieldWarning](https://docs.gravityrail.com/sdk/interfaces/DataRecordFieldWarning.md) * [DataRecordFormData](https://docs.gravityrail.com/sdk/interfaces/DataRecordFormData.md) * [DataRecordReportItem](https://docs.gravityrail.com/sdk/interfaces/DataRecordReportItem.md) * [DataRecordResponse](https://docs.gravityrail.com/sdk/interfaces/DataRecordResponse.md) * [DataRecordRetirementResponse](https://docs.gravityrail.com/sdk/interfaces/DataRecordRetirementResponse.md) * [DataRecordsPaginatedResponse](https://docs.gravityrail.com/sdk/interfaces/DataRecordsPaginatedResponse.md) * [DataRecordUpdateResponse](https://docs.gravityrail.com/sdk/interfaces/DataRecordUpdateResponse.md) * [DataRecordWithAccessMode](https://docs.gravityrail.com/sdk/interfaces/DataRecordWithAccessMode.md) * [DataTypeExport](https://docs.gravityrail.com/sdk/interfaces/DataTypeExport.md) * [DataTypeExportItem](https://docs.gravityrail.com/sdk/interfaces/DataTypeExportItem.md) * [DataTypeFormData](https://docs.gravityrail.com/sdk/interfaces/DataTypeFormData.md) * [DataTypeMemberRoleAccessInput](https://docs.gravityrail.com/sdk/interfaces/DataTypeMemberRoleAccessInput.md) * [DataTypeMemberRoleAccessResponse](https://docs.gravityrail.com/sdk/interfaces/DataTypeMemberRoleAccessResponse.md) * [DataTypeResponse](https://docs.gravityrail.com/sdk/interfaces/DataTypeResponse.md) * [DayAggregatedData](https://docs.gravityrail.com/sdk/interfaces/DayAggregatedData.md) * [DayCallAggregatedData](https://docs.gravityrail.com/sdk/interfaces/DayCallAggregatedData.md) * [DeleteAccountOrgMembershipResponse](https://docs.gravityrail.com/sdk/interfaces/DeleteAccountOrgMembershipResponse.md) * [DetailedAccount](https://docs.gravityrail.com/sdk/interfaces/DetailedAccount.md) * [DiscordBotAccount](https://docs.gravityrail.com/sdk/interfaces/DiscordBotAccount.md) * [DiscordGuild](https://docs.gravityrail.com/sdk/interfaces/DiscordGuild.md) * [DiscordThread](https://docs.gravityrail.com/sdk/interfaces/DiscordThread.md) * [DisplayFileLabelResponse](https://docs.gravityrail.com/sdk/interfaces/DisplayFileLabelResponse.md) * [DisplayFileResponse](https://docs.gravityrail.com/sdk/interfaces/DisplayFileResponse.md) * [DomainMapping](https://docs.gravityrail.com/sdk/interfaces/DomainMapping.md) * [DuplicateAccountInfo](https://docs.gravityrail.com/sdk/interfaces/DuplicateAccountInfo.md) * [EcwRefreshMemberEncountersActionParams](https://docs.gravityrail.com/sdk/interfaces/EcwRefreshMemberEncountersActionParams.md) * [EfficiencyMetricsResponse](https://docs.gravityrail.com/sdk/interfaces/EfficiencyMetricsResponse.md) * [Email](https://docs.gravityrail.com/sdk/interfaces/Email.md) * [EmailAttachment](https://docs.gravityrail.com/sdk/interfaces/EmailAttachment.md) * [EmailConversionResponse](https://docs.gravityrail.com/sdk/interfaces/EmailConversionResponse.md) * [EmailCountsResponse](https://docs.gravityrail.com/sdk/interfaces/EmailCountsResponse.md) * [EmailDisableImpactResponse](https://docs.gravityrail.com/sdk/interfaces/EmailDisableImpactResponse.md) * [EmailDomainConfigResponse](https://docs.gravityrail.com/sdk/interfaces/EmailDomainConfigResponse.md) * [EmailSendActionParams](https://docs.gravityrail.com/sdk/interfaces/EmailSendActionParams.md) * [EmailUsageResponse](https://docs.gravityrail.com/sdk/interfaces/EmailUsageResponse.md) * [EmailVerificationResponse](https://docs.gravityrail.com/sdk/interfaces/EmailVerificationResponse.md) * [EncounterSyncDataTypeSummary](https://docs.gravityrail.com/sdk/interfaces/EncounterSyncDataTypeSummary.md) * [EncounterSyncHistoryItem](https://docs.gravityrail.com/sdk/interfaces/EncounterSyncHistoryItem.md) * [EncounterSyncRunResponse](https://docs.gravityrail.com/sdk/interfaces/EncounterSyncRunResponse.md) * [EncounterSyncStatusResponse](https://docs.gravityrail.com/sdk/interfaces/EncounterSyncStatusResponse.md) * [EngineTimeSeries](https://docs.gravityrail.com/sdk/interfaces/EngineTimeSeries.md) * [EnrichInquiryRequest](https://docs.gravityrail.com/sdk/interfaces/EnrichInquiryRequest.md) * [EntitySyncConfig](https://docs.gravityrail.com/sdk/interfaces/EntitySyncConfig.md) * [EnumOption](https://docs.gravityrail.com/sdk/interfaces/EnumOption.md) * [ErrorCodeBucket](https://docs.gravityrail.com/sdk/interfaces/ErrorCodeBucket.md) * [ErrorResponse](https://docs.gravityrail.com/sdk/interfaces/ErrorResponse.md) * [EscalationAbilityConfig](https://docs.gravityrail.com/sdk/interfaces/EscalationAbilityConfig.md) * [EventActionMapping](https://docs.gravityrail.com/sdk/interfaces/EventActionMapping.md) * [EventActionMappingsResponse](https://docs.gravityrail.com/sdk/interfaces/EventActionMappingsResponse.md) * [EventResponse](https://docs.gravityrail.com/sdk/interfaces/EventResponse.md) * [EventRuleExport](https://docs.gravityrail.com/sdk/interfaces/EventRuleExport.md) * [EventRuleExportItem](https://docs.gravityrail.com/sdk/interfaces/EventRuleExportItem.md) * [EventRuleFormData](https://docs.gravityrail.com/sdk/interfaces/EventRuleFormData.md) * [EventRuleInput](https://docs.gravityrail.com/sdk/interfaces/EventRuleInput.md) * [EventRuleMetrics](https://docs.gravityrail.com/sdk/interfaces/EventRuleMetrics.md) * [EventTypeResponse](https://docs.gravityrail.com/sdk/interfaces/EventTypeResponse.md) * [ExecuteToolResponse](https://docs.gravityrail.com/sdk/interfaces/ExecuteToolResponse.md) * [ExpireAnonymousMemberRequest](https://docs.gravityrail.com/sdk/interfaces/ExpireAnonymousMemberRequest.md) * [ExportStatistics](https://docs.gravityrail.com/sdk/interfaces/ExportStatistics.md) * [FeatureDefinition](https://docs.gravityrail.com/sdk/interfaces/FeatureDefinition.md) * [FeaturesResponse](https://docs.gravityrail.com/sdk/interfaces/FeaturesResponse.md) * [FeatureSyncStatus](https://docs.gravityrail.com/sdk/interfaces/FeatureSyncStatus.md) * [FhirCreateEncounterRequest](https://docs.gravityrail.com/sdk/interfaces/FhirCreateEncounterRequest.md) * [FhirCsvColumnMeta](https://docs.gravityrail.com/sdk/interfaces/FhirCsvColumnMeta.md) * [FhirCsvImportRunItem](https://docs.gravityrail.com/sdk/interfaces/FhirCsvImportRunItem.md) * [FhirCsvImportRunSummary](https://docs.gravityrail.com/sdk/interfaces/FhirCsvImportRunSummary.md) * [FhirCsvImportSettings](https://docs.gravityrail.com/sdk/interfaces/FhirCsvImportSettings.md) * [FhirCsvInspectResponse](https://docs.gravityrail.com/sdk/interfaces/FhirCsvInspectResponse.md) * [FhirFetchCareTeamRequest](https://docs.gravityrail.com/sdk/interfaces/FhirFetchCareTeamRequest.md) * [FhirFetchEncountersRequest](https://docs.gravityrail.com/sdk/interfaces/FhirFetchEncountersRequest.md) * [FhirMethodResponse](https://docs.gravityrail.com/sdk/interfaces/FhirMethodResponse.md) * [FhirSearchLocationsRequest](https://docs.gravityrail.com/sdk/interfaces/FhirSearchLocationsRequest.md) * [FhirSearchPatientsRequest](https://docs.gravityrail.com/sdk/interfaces/FhirSearchPatientsRequest.md) * [FhirSearchPractitionersRequest](https://docs.gravityrail.com/sdk/interfaces/FhirSearchPractitionersRequest.md) * [FileAccessAbilityConfig](https://docs.gravityrail.com/sdk/interfaces/FileAccessAbilityConfig.md) * [FileAccessEntry](https://docs.gravityrail.com/sdk/interfaces/FileAccessEntry.md) * [FileAssociationFormData](https://docs.gravityrail.com/sdk/interfaces/FileAssociationFormData.md) * [FileExport](https://docs.gravityrail.com/sdk/interfaces/FileExport.md) * [FileExportItem](https://docs.gravityrail.com/sdk/interfaces/FileExportItem.md) * [FileFolderExport](https://docs.gravityrail.com/sdk/interfaces/FileFolderExport.md) * [FileFolderFormData](https://docs.gravityrail.com/sdk/interfaces/FileFolderFormData.md) * [FileFolderRelation](https://docs.gravityrail.com/sdk/interfaces/FileFolderRelation.md) * [FileFolderResponse](https://docs.gravityrail.com/sdk/interfaces/FileFolderResponse.md) * [FileFormData](https://docs.gravityrail.com/sdk/interfaces/FileFormData.md) * [FileLabelExport](https://docs.gravityrail.com/sdk/interfaces/FileLabelExport.md) * [FileLabelFormData](https://docs.gravityrail.com/sdk/interfaces/FileLabelFormData.md) * [FileLabelRelation](https://docs.gravityrail.com/sdk/interfaces/FileLabelRelation.md) * [FileLabelResponse](https://docs.gravityrail.com/sdk/interfaces/FileLabelResponse.md) * [FileRoleAssociationResponse](https://docs.gravityrail.com/sdk/interfaces/FileRoleAssociationResponse.md) * [FilesQueryParams](https://docs.gravityrail.com/sdk/interfaces/FilesQueryParams.md) * [FileUploadRequest](https://docs.gravityrail.com/sdk/interfaces/FileUploadRequest.md) * [FileUploadResponse](https://docs.gravityrail.com/sdk/interfaces/FileUploadResponse.md) * [FileWithAccessModeFormData](https://docs.gravityrail.com/sdk/interfaces/FileWithAccessModeFormData.md) * [FirstRunState](https://docs.gravityrail.com/sdk/interfaces/FirstRunState.md) * [FolderAccessEntry](https://docs.gravityrail.com/sdk/interfaces/FolderAccessEntry.md) * [FolderMemberRoleRelation](https://docs.gravityrail.com/sdk/interfaces/FolderMemberRoleRelation.md) * [FolderPathSegment](https://docs.gravityrail.com/sdk/interfaces/FolderPathSegment.md) * [FolderSearchParams](https://docs.gravityrail.com/sdk/interfaces/FolderSearchParams.md) * [FolderSearchResultResponse](https://docs.gravityrail.com/sdk/interfaces/FolderSearchResultResponse.md) * [FormFieldUpdateActionParams](https://docs.gravityrail.com/sdk/interfaces/FormFieldUpdateActionParams.md) * [ForwardingNumberDef](https://docs.gravityrail.com/sdk/interfaces/ForwardingNumberDef.md) * [FunctionTool](https://docs.gravityrail.com/sdk/interfaces/FunctionTool.md) * [GeminiChatModelConfig](https://docs.gravityrail.com/sdk/interfaces/GeminiChatModelConfig.md) * [GeminiRealtimeModelConfig](https://docs.gravityrail.com/sdk/interfaces/GeminiRealtimeModelConfig.md) * [GeneratedAccessGrantResponse](https://docs.gravityrail.com/sdk/interfaces/GeneratedAccessGrantResponse.md) * [GeneratedAppListResponse](https://docs.gravityrail.com/sdk/interfaces/GeneratedAppListResponse.md) * [GeneratedBusinessProfileResponse](https://docs.gravityrail.com/sdk/interfaces/GeneratedBusinessProfileResponse.md) * [GeneratedCalendarResponse](https://docs.gravityrail.com/sdk/interfaces/GeneratedCalendarResponse.md) * [GeneratedCalendarScheduleResponse](https://docs.gravityrail.com/sdk/interfaces/GeneratedCalendarScheduleResponse.md) * [GeneratedCustomToolkitResponse](https://docs.gravityrail.com/sdk/interfaces/GeneratedCustomToolkitResponse.md) * [GeneratedCustomToolResponse](https://docs.gravityrail.com/sdk/interfaces/GeneratedCustomToolResponse.md) * [GeneratedDiscordBotResponse](https://docs.gravityrail.com/sdk/interfaces/GeneratedDiscordBotResponse.md) * [GeneratedFhirConnectionResponse](https://docs.gravityrail.com/sdk/interfaces/GeneratedFhirConnectionResponse.md) * [GeneratedFileResponse](https://docs.gravityrail.com/sdk/interfaces/GeneratedFileResponse.md) * [GeneratedFileSharingResponse](https://docs.gravityrail.com/sdk/interfaces/GeneratedFileSharingResponse.md) * [GeneratedFolderSharingResponse](https://docs.gravityrail.com/sdk/interfaces/GeneratedFolderSharingResponse.md) * [GeneratedInvitationListResponse](https://docs.gravityrail.com/sdk/interfaces/GeneratedInvitationListResponse.md) * [GeneratedMemoryListResponse](https://docs.gravityrail.com/sdk/interfaces/GeneratedMemoryListResponse.md) * [GeneratedMemoryResponse](https://docs.gravityrail.com/sdk/interfaces/GeneratedMemoryResponse.md) * [GeneratedMetricSummary](https://docs.gravityrail.com/sdk/interfaces/GeneratedMetricSummary.md) * [GeneratedMilestoneGoalResponse](https://docs.gravityrail.com/sdk/interfaces/GeneratedMilestoneGoalResponse.md) * [GeneratedOrgDomainResponse](https://docs.gravityrail.com/sdk/interfaces/GeneratedOrgDomainResponse.md) * [GeneratedOwnershipDnsRecord](https://docs.gravityrail.com/sdk/interfaces/GeneratedOwnershipDnsRecord.md) * [GeneratedSiteResponse](https://docs.gravityrail.com/sdk/interfaces/GeneratedSiteResponse.md) * [GeneratedSlackAppResponse](https://docs.gravityrail.com/sdk/interfaces/GeneratedSlackAppResponse.md) * [GeneratedTaskResponse](https://docs.gravityrail.com/sdk/interfaces/GeneratedTaskResponse.md) * [GeneratedVoiceMetricsResponse](https://docs.gravityrail.com/sdk/interfaces/GeneratedVoiceMetricsResponse.md) * [GeneratedVoiceModelResponse](https://docs.gravityrail.com/sdk/interfaces/GeneratedVoiceModelResponse.md) * [GeneratedWorkflowResponse](https://docs.gravityrail.com/sdk/interfaces/GeneratedWorkflowResponse.md) * [GeneratedWorkspaceHealthResponse](https://docs.gravityrail.com/sdk/interfaces/GeneratedWorkspaceHealthResponse.md) * [GenerateRecoveryCodesRequest](https://docs.gravityrail.com/sdk/interfaces/GenerateRecoveryCodesRequest.md) * [GenerateSummariesResponse](https://docs.gravityrail.com/sdk/interfaces/GenerateSummariesResponse.md) * [GetChatsOptions](https://docs.gravityrail.com/sdk/interfaces/GetChatsOptions.md) * [GoogleCalendarInfo](https://docs.gravityrail.com/sdk/interfaces/GoogleCalendarInfo.md) * [GoogleCalendarInsufficientScopesResponse](https://docs.gravityrail.com/sdk/interfaces/GoogleCalendarInsufficientScopesResponse.md) * [GoogleCalendarStatusResponse](https://docs.gravityrail.com/sdk/interfaces/GoogleCalendarStatusResponse.md) * [GoogleWorkspaceIntegrationAbilityConfig](https://docs.gravityrail.com/sdk/interfaces/GoogleWorkspaceIntegrationAbilityConfig.md) * [GroupsResponse](https://docs.gravityrail.com/sdk/interfaces/GroupsResponse.md) * [HealthCheckStatistics](https://docs.gravityrail.com/sdk/interfaces/HealthCheckStatistics.md) * [HealthDetailRequest](https://docs.gravityrail.com/sdk/interfaces/HealthDetailRequest.md) * [HealthieConnectionResponse](https://docs.gravityrail.com/sdk/interfaces/HealthieConnectionResponse.md) * [HealthMetricsRequest](https://docs.gravityrail.com/sdk/interfaces/HealthMetricsRequest.md) * [HealthMetricsResponse](https://docs.gravityrail.com/sdk/interfaces/HealthMetricsResponse.md) * [HealthSummary](https://docs.gravityrail.com/sdk/interfaces/HealthSummary.md) * [HITLActionRequest](https://docs.gravityrail.com/sdk/interfaces/HITLActionRequest.md) * [HITLDecision](https://docs.gravityrail.com/sdk/interfaces/HITLDecision.md) * [HITLRequest](https://docs.gravityrail.com/sdk/interfaces/HITLRequest.md) * [HITLResponse](https://docs.gravityrail.com/sdk/interfaces/HITLResponse.md) * [HITLReviewConfig](https://docs.gravityrail.com/sdk/interfaces/HITLReviewConfig.md) * [HubspotConnectionResponse](https://docs.gravityrail.com/sdk/interfaces/HubspotConnectionResponse.md) * [HubSpotNoteSyncConfig](https://docs.gravityrail.com/sdk/interfaces/HubSpotNoteSyncConfig.md) * [HubSpotPropertyDefinition](https://docs.gravityrail.com/sdk/interfaces/HubSpotPropertyDefinition.md) * [HubSpotPropertyOption](https://docs.gravityrail.com/sdk/interfaces/HubSpotPropertyOption.md) * [HubSpotSearchRequest](https://docs.gravityrail.com/sdk/interfaces/HubSpotSearchRequest.md) * [HubSpotSearchResponse](https://docs.gravityrail.com/sdk/interfaces/HubSpotSearchResponse.md) * [HubSpotSearchResult](https://docs.gravityrail.com/sdk/interfaces/HubSpotSearchResult.md) * [HubSpotSearchResultMatch](https://docs.gravityrail.com/sdk/interfaces/HubSpotSearchResultMatch.md) * [HubSpotSyncSettingsRequest](https://docs.gravityrail.com/sdk/interfaces/HubSpotSyncSettingsRequest.md) * [HubSpotSyncSettingsResponse](https://docs.gravityrail.com/sdk/interfaces/HubSpotSyncSettingsResponse.md) * [HubSpotTaskSyncConfig](https://docs.gravityrail.com/sdk/interfaces/HubSpotTaskSyncConfig.md) * [HumanChatParticipant](https://docs.gravityrail.com/sdk/interfaces/HumanChatParticipant.md) * [ICalFeedTokenResponse](https://docs.gravityrail.com/sdk/interfaces/ICalFeedTokenResponse.md) * [ICalFeedUrlResponse](https://docs.gravityrail.com/sdk/interfaces/ICalFeedUrlResponse.md) * [ImageGenerationAbilityConfig](https://docs.gravityrail.com/sdk/interfaces/ImageGenerationAbilityConfig.md) * [ImageUrlContent](https://docs.gravityrail.com/sdk/interfaces/ImageUrlContent.md) * [ImportedMemberResult](https://docs.gravityrail.com/sdk/interfaces/ImportedMemberResult.md) * [ImportedSalesforceMemberResult](https://docs.gravityrail.com/sdk/interfaces/ImportedSalesforceMemberResult.md) * [ImportHubSpotMembersRequest](https://docs.gravityrail.com/sdk/interfaces/ImportHubSpotMembersRequest.md) * [ImportHubSpotMembersResponse](https://docs.gravityrail.com/sdk/interfaces/ImportHubSpotMembersResponse.md) * [ImportHubSpotRecordRequest](https://docs.gravityrail.com/sdk/interfaces/ImportHubSpotRecordRequest.md) * [ImportPreviewItem](https://docs.gravityrail.com/sdk/interfaces/ImportPreviewItem.md) * [ImportSalesforceMembersRequest](https://docs.gravityrail.com/sdk/interfaces/ImportSalesforceMembersRequest.md) * [ImportSalesforceMembersResponse](https://docs.gravityrail.com/sdk/interfaces/ImportSalesforceMembersResponse.md) * [ImportSalesforceRecordRequest](https://docs.gravityrail.com/sdk/interfaces/ImportSalesforceRecordRequest.md) * [ImportStatistics](https://docs.gravityrail.com/sdk/interfaces/ImportStatistics.md) * [InboxCreateRequest](https://docs.gravityrail.com/sdk/interfaces/InboxCreateRequest.md) * [InboxExport](https://docs.gravityrail.com/sdk/interfaces/InboxExport.md) * [InboxMapping](https://docs.gravityrail.com/sdk/interfaces/InboxMapping.md) * [InboxMappingDetailResponse](https://docs.gravityrail.com/sdk/interfaces/InboxMappingDetailResponse.md) * [InboxThreadResponse](https://docs.gravityrail.com/sdk/interfaces/InboxThreadResponse.md) * [InboxThreadsPageResponse](https://docs.gravityrail.com/sdk/interfaces/InboxThreadsPageResponse.md) * [InboxUpdateRequest](https://docs.gravityrail.com/sdk/interfaces/InboxUpdateRequest.md) * [IncomingInteraction](https://docs.gravityrail.com/sdk/interfaces/IncomingInteraction.md) * [IndexStatusResponse](https://docs.gravityrail.com/sdk/interfaces/IndexStatusResponse.md) * [InitiateCallRequest](https://docs.gravityrail.com/sdk/interfaces/InitiateCallRequest.md) * [InitiateCallResponse](https://docs.gravityrail.com/sdk/interfaces/InitiateCallResponse.md) * [InquiryListResponse](https://docs.gravityrail.com/sdk/interfaces/InquiryListResponse.md) * [InquiryResponse](https://docs.gravityrail.com/sdk/interfaces/InquiryResponse.md) * [InteractionAccepted](https://docs.gravityrail.com/sdk/interfaces/InteractionAccepted.md) * [InteractionTimedOut](https://docs.gravityrail.com/sdk/interfaces/InteractionTimedOut.md) * [InvitationAcceptedResponse](https://docs.gravityrail.com/sdk/interfaces/InvitationAcceptedResponse.md) * [InvitationDetails](https://docs.gravityrail.com/sdk/interfaces/InvitationDetails.md) * [InvokeCustomToolActionParams](https://docs.gravityrail.com/sdk/interfaces/InvokeCustomToolActionParams.md) * [JourneyEnrollActionParams](https://docs.gravityrail.com/sdk/interfaces/JourneyEnrollActionParams.md) * [JsonSchema](https://docs.gravityrail.com/sdk/interfaces/JsonSchema.md) * [JsonSchemaProperty](https://docs.gravityrail.com/sdk/interfaces/JsonSchemaProperty.md) * [LinkA2PEnrollmentSiteRequest](https://docs.gravityrail.com/sdk/interfaces/LinkA2PEnrollmentSiteRequest.md) * [LinkablePhone](https://docs.gravityrail.com/sdk/interfaces/LinkablePhone.md) * [LinkCalendarRequest](https://docs.gravityrail.com/sdk/interfaces/LinkCalendarRequest.md) * [LinkCalendarResponse](https://docs.gravityrail.com/sdk/interfaces/LinkCalendarResponse.md) * [ListInvitationsParams](https://docs.gravityrail.com/sdk/interfaces/ListInvitationsParams.md) * [LiveOperatorEntry](https://docs.gravityrail.com/sdk/interfaces/LiveOperatorEntry.md) * [LiveOperatorsResponse](https://docs.gravityrail.com/sdk/interfaces/LiveOperatorsResponse.md) * [LoadedSkill](https://docs.gravityrail.com/sdk/interfaces/LoadedSkill.md) * [LoginRequest](https://docs.gravityrail.com/sdk/interfaces/LoginRequest.md) * [LoginResponse](https://docs.gravityrail.com/sdk/interfaces/LoginResponse.md) * [LogoUploadRequest](https://docs.gravityrail.com/sdk/interfaces/LogoUploadRequest.md) * [LogoUploadResponse](https://docs.gravityrail.com/sdk/interfaces/LogoUploadResponse.md) * [ManagedAutomationConfig](https://docs.gravityrail.com/sdk/interfaces/ManagedAutomationConfig.md) * [ManagedRuleStatus](https://docs.gravityrail.com/sdk/interfaces/ManagedRuleStatus.md) * [MatchStrategy](https://docs.gravityrail.com/sdk/interfaces/MatchStrategy.md) * [McpPromptArgumentResponse](https://docs.gravityrail.com/sdk/interfaces/McpPromptArgumentResponse.md) * [McpPromptResponse](https://docs.gravityrail.com/sdk/interfaces/McpPromptResponse.md) * [McpResourceResponse](https://docs.gravityrail.com/sdk/interfaces/McpResourceResponse.md) * [McpServerAuthRequired](https://docs.gravityrail.com/sdk/interfaces/McpServerAuthRequired.md) * [McpServerExport](https://docs.gravityrail.com/sdk/interfaces/McpServerExport.md) * [McpServerFormData](https://docs.gravityrail.com/sdk/interfaces/McpServerFormData.md) * [McpServerPromptsResponse](https://docs.gravityrail.com/sdk/interfaces/McpServerPromptsResponse.md) * [McpServerResourcesResponse](https://docs.gravityrail.com/sdk/interfaces/McpServerResourcesResponse.md) * [McpServerResponse](https://docs.gravityrail.com/sdk/interfaces/McpServerResponse.md) * [McpServerToolResponse](https://docs.gravityrail.com/sdk/interfaces/McpServerToolResponse.md) * [McpServerToolsResponse](https://docs.gravityrail.com/sdk/interfaces/McpServerToolsResponse.md) * [McpServerUpdateFormData](https://docs.gravityrail.com/sdk/interfaces/McpServerUpdateFormData.md) * [McpTestConnectionResponse](https://docs.gravityrail.com/sdk/interfaces/McpTestConnectionResponse.md) * [McpToolResponse](https://docs.gravityrail.com/sdk/interfaces/McpToolResponse.md) * [MemberCredential](https://docs.gravityrail.com/sdk/interfaces/MemberCredential.md) * [MemberFieldDefinitionListResponse](https://docs.gravityrail.com/sdk/interfaces/MemberFieldDefinitionListResponse.md) * [MemberFieldDefinitionResponse](https://docs.gravityrail.com/sdk/interfaces/MemberFieldDefinitionResponse.md) * [MemberFieldListResponse](https://docs.gravityrail.com/sdk/interfaces/MemberFieldListResponse.md) * [MemberFieldResponse](https://docs.gravityrail.com/sdk/interfaces/MemberFieldResponse.md) * [MemberFieldVerificationAbilityConfig](https://docs.gravityrail.com/sdk/interfaces/MemberFieldVerificationAbilityConfig.md) * [MemberFilterExport](https://docs.gravityrail.com/sdk/interfaces/MemberFilterExport.md) * [MemberFilterFormData](https://docs.gravityrail.com/sdk/interfaces/MemberFilterFormData.md) * [MemberFilterResponse](https://docs.gravityrail.com/sdk/interfaces/MemberFilterResponse.md) * [MemberFilterRuleExport](https://docs.gravityrail.com/sdk/interfaces/MemberFilterRuleExport.md) * [MemberFilterRuleFormData](https://docs.gravityrail.com/sdk/interfaces/MemberFilterRuleFormData.md) * [MemberFilterRuleResponse](https://docs.gravityrail.com/sdk/interfaces/MemberFilterRuleResponse.md) * [MemberFormData](https://docs.gravityrail.com/sdk/interfaces/MemberFormData.md) * [MemberImportConflictInfo](https://docs.gravityrail.com/sdk/interfaces/MemberImportConflictInfo.md) * [MemberImportIdentitySnapshot](https://docs.gravityrail.com/sdk/interfaces/MemberImportIdentitySnapshot.md) * [MemberImportMatchInfo](https://docs.gravityrail.com/sdk/interfaces/MemberImportMatchInfo.md) * [MemberImportPreviewResponse](https://docs.gravityrail.com/sdk/interfaces/MemberImportPreviewResponse.md) * [MemberImportPreviewRow](https://docs.gravityrail.com/sdk/interfaces/MemberImportPreviewRow.md) * [MemberImportPreviewSummary](https://docs.gravityrail.com/sdk/interfaces/MemberImportPreviewSummary.md) * [MemberImportStreamConflict](https://docs.gravityrail.com/sdk/interfaces/MemberImportStreamConflict.md) * [MemberImportStreamEvent](https://docs.gravityrail.com/sdk/interfaces/MemberImportStreamEvent.md) * [MemberLabelActionParams](https://docs.gravityrail.com/sdk/interfaces/MemberLabelActionParams.md) * [MemberLabelExport](https://docs.gravityrail.com/sdk/interfaces/MemberLabelExport.md) * [MemberLabelFormData](https://docs.gravityrail.com/sdk/interfaces/MemberLabelFormData.md) * [MemberLabelResponse](https://docs.gravityrail.com/sdk/interfaces/MemberLabelResponse.md) * [MemberMessageActivity](https://docs.gravityrail.com/sdk/interfaces/MemberMessageActivity.md) * [MemberNotificationPreferences](https://docs.gravityrail.com/sdk/interfaces/MemberNotificationPreferences.md) * [MemberNotifyActionParams](https://docs.gravityrail.com/sdk/interfaces/MemberNotifyActionParams.md) * [MemberOrgView](https://docs.gravityrail.com/sdk/interfaces/MemberOrgView.md) * [MemberReportItem](https://docs.gravityrail.com/sdk/interfaces/MemberReportItem.md) * [MemberRoleCalendarAccessResponse](https://docs.gravityrail.com/sdk/interfaces/MemberRoleCalendarAccessResponse.md) * [MemberRoleDataTypeAccessResponse](https://docs.gravityrail.com/sdk/interfaces/MemberRoleDataTypeAccessResponse.md) * [MemberRoleDataTypeRelation](https://docs.gravityrail.com/sdk/interfaces/MemberRoleDataTypeRelation.md) * [MemberRoleExport](https://docs.gravityrail.com/sdk/interfaces/MemberRoleExport.md) * [MemberRoleFileAccessResponse](https://docs.gravityrail.com/sdk/interfaces/MemberRoleFileAccessResponse.md) * [MemberRoleFolderAccessResponse](https://docs.gravityrail.com/sdk/interfaces/MemberRoleFolderAccessResponse.md) * [MemberRoleFormData](https://docs.gravityrail.com/sdk/interfaces/MemberRoleFormData.md) * [MemberRoleInboxAccessResponse](https://docs.gravityrail.com/sdk/interfaces/MemberRoleInboxAccessResponse.md) * [MemberRoleInboxRelation](https://docs.gravityrail.com/sdk/interfaces/MemberRoleInboxRelation.md) * [MemberRoleResponse](https://docs.gravityrail.com/sdk/interfaces/MemberRoleResponse.md) * [MemberRoleSiteAccessResponse](https://docs.gravityrail.com/sdk/interfaces/MemberRoleSiteAccessResponse.md) * [MemberRoleSiteRelation](https://docs.gravityrail.com/sdk/interfaces/MemberRoleSiteRelation.md) * [MemberRoleTaskAccess](https://docs.gravityrail.com/sdk/interfaces/MemberRoleTaskAccess.md) * [MemberRoleTaskRelation](https://docs.gravityrail.com/sdk/interfaces/MemberRoleTaskRelation.md) * [MemberRoleWorkflowAccessResponse](https://docs.gravityrail.com/sdk/interfaces/MemberRoleWorkflowAccessResponse.md) * [MembersQueryParams](https://docs.gravityrail.com/sdk/interfaces/MembersQueryParams.md) * [MemberSummary](https://docs.gravityrail.com/sdk/interfaces/MemberSummary.md) * [MemberSyncLink](https://docs.gravityrail.com/sdk/interfaces/MemberSyncLink.md) * [MemberUpsertActionParams](https://docs.gravityrail.com/sdk/interfaces/MemberUpsertActionParams.md) * [MemberUsageReport](https://docs.gravityrail.com/sdk/interfaces/MemberUsageReport.md) * [MemberWorkspaceInfo](https://docs.gravityrail.com/sdk/interfaces/MemberWorkspaceInfo.md) * [MenuItemExport](https://docs.gravityrail.com/sdk/interfaces/MenuItemExport.md) * [MenuItemFormData](https://docs.gravityrail.com/sdk/interfaces/MenuItemFormData.md) * [MenuItemResponse](https://docs.gravityrail.com/sdk/interfaces/MenuItemResponse.md) * [MenuTreeResponse](https://docs.gravityrail.com/sdk/interfaces/MenuTreeResponse.md) * [MergeMembersRequest](https://docs.gravityrail.com/sdk/interfaces/MergeMembersRequest.md) * [MergeMembersResponse](https://docs.gravityrail.com/sdk/interfaces/MergeMembersResponse.md) * [MessageTimingResponse](https://docs.gravityrail.com/sdk/interfaces/MessageTimingResponse.md) * [MessageTokenUsageResponse](https://docs.gravityrail.com/sdk/interfaces/MessageTokenUsageResponse.md) * [MessageValidationActionParams](https://docs.gravityrail.com/sdk/interfaces/MessageValidationActionParams.md) * [MetricDataPoint](https://docs.gravityrail.com/sdk/interfaces/MetricDataPoint.md) * [MetricValue](https://docs.gravityrail.com/sdk/interfaces/MetricValue.md) * [Milestone](https://docs.gravityrail.com/sdk/interfaces/Milestone.md) * [MilestoneAnalytics](https://docs.gravityrail.com/sdk/interfaces/MilestoneAnalytics.md) * [MilestoneCreateRequest](https://docs.gravityrail.com/sdk/interfaces/MilestoneCreateRequest.md) * [MilestoneDeleteResponse](https://docs.gravityrail.com/sdk/interfaces/MilestoneDeleteResponse.md) * [MilestoneExport](https://docs.gravityrail.com/sdk/interfaces/MilestoneExport.md) * [MilestoneGoalExport](https://docs.gravityrail.com/sdk/interfaces/MilestoneGoalExport.md) * [MilestoneGoalProgress](https://docs.gravityrail.com/sdk/interfaces/MilestoneGoalProgress.md) * [MilestoneProgress](https://docs.gravityrail.com/sdk/interfaces/MilestoneProgress.md) * [MilestonesQueryParams](https://docs.gravityrail.com/sdk/interfaces/MilestonesQueryParams.md) * [MilestoneTimeline](https://docs.gravityrail.com/sdk/interfaces/MilestoneTimeline.md) * [MilestoneTimelineItem](https://docs.gravityrail.com/sdk/interfaces/MilestoneTimelineItem.md) * [MilestoneUpdateRequest](https://docs.gravityrail.com/sdk/interfaces/MilestoneUpdateRequest.md) * [MissingMembershipItem](https://docs.gravityrail.com/sdk/interfaces/MissingMembershipItem.md) * [ModelMetadataResponse](https://docs.gravityrail.com/sdk/interfaces/ModelMetadataResponse.md) * [ModelUsageResponse](https://docs.gravityrail.com/sdk/interfaces/ModelUsageResponse.md) * [ModelUsageStats](https://docs.gravityrail.com/sdk/interfaces/ModelUsageStats.md) * [MondayBoard](https://docs.gravityrail.com/sdk/interfaces/MondayBoard.md) * [MondayColumn](https://docs.gravityrail.com/sdk/interfaces/MondayColumn.md) * [MondayColumnMapping](https://docs.gravityrail.com/sdk/interfaces/MondayColumnMapping.md) * [MondayColumnSettings](https://docs.gravityrail.com/sdk/interfaces/MondayColumnSettings.md) * [MondayConnectionResponse](https://docs.gravityrail.com/sdk/interfaces/MondayConnectionResponse.md) * [MondayCurrentUserInfoResponse](https://docs.gravityrail.com/sdk/interfaces/MondayCurrentUserInfoResponse.md) * [MondayGroup](https://docs.gravityrail.com/sdk/interfaces/MondayGroup.md) * [MondayRefreshActionParams](https://docs.gravityrail.com/sdk/interfaces/MondayRefreshActionParams.md) * [MondayRefreshColumnMapping](https://docs.gravityrail.com/sdk/interfaces/MondayRefreshColumnMapping.md) * [MondayStatusLabel](https://docs.gravityrail.com/sdk/interfaces/MondayStatusLabel.md) * [MondayUpsertItemActionParams](https://docs.gravityrail.com/sdk/interfaces/MondayUpsertItemActionParams.md) * [NormalizeMemberRequest](https://docs.gravityrail.com/sdk/interfaces/NormalizeMemberRequest.md) * [NormalizeMemberResponse](https://docs.gravityrail.com/sdk/interfaces/NormalizeMemberResponse.md) * [Notice](https://docs.gravityrail.com/sdk/interfaces/Notice.md) * [NoticesResponse](https://docs.gravityrail.com/sdk/interfaces/NoticesResponse.md) * [NotificationResponse](https://docs.gravityrail.com/sdk/interfaces/NotificationResponse.md) * [NotificationRule](https://docs.gravityrail.com/sdk/interfaces/NotificationRule.md) * [NotificationRuleCreate](https://docs.gravityrail.com/sdk/interfaces/NotificationRuleCreate.md) * [NotificationRuleResponse](https://docs.gravityrail.com/sdk/interfaces/NotificationRuleResponse.md) * [NotificationRuleUpdate](https://docs.gravityrail.com/sdk/interfaces/NotificationRuleUpdate.md) * [OAuthAuthorizeResponse](https://docs.gravityrail.com/sdk/interfaces/OAuthAuthorizeResponse.md) * [OAuthConnectionStatus](https://docs.gravityrail.com/sdk/interfaces/OAuthConnectionStatus.md) * [ObjectPermissionFlags](https://docs.gravityrail.com/sdk/interfaces/ObjectPermissionFlags.md) * [OIDCAdminConfigView](https://docs.gravityrail.com/sdk/interfaces/OIDCAdminConfigView.md) * [OpenAIChatModelConfig](https://docs.gravityrail.com/sdk/interfaces/OpenAIChatModelConfig.md) * [OpenAIRealtimeModelConfig](https://docs.gravityrail.com/sdk/interfaces/OpenAIRealtimeModelConfig.md) * [OpenAISemanticVADTurnDetection](https://docs.gravityrail.com/sdk/interfaces/OpenAISemanticVADTurnDetection.md) * [OpenAIServerVADTurnDetection](https://docs.gravityrail.com/sdk/interfaces/OpenAIServerVADTurnDetection.md) * [OperatorChatParticipant](https://docs.gravityrail.com/sdk/interfaces/OperatorChatParticipant.md) * [OperatorChildTaskDetail](https://docs.gravityrail.com/sdk/interfaces/OperatorChildTaskDetail.md) * [OperatorGroupMemberInput](https://docs.gravityrail.com/sdk/interfaces/OperatorGroupMemberInput.md) * [OperatorGroupMemberResponse](https://docs.gravityrail.com/sdk/interfaces/OperatorGroupMemberResponse.md) * [OperatorTaskDetailResponse](https://docs.gravityrail.com/sdk/interfaces/OperatorTaskDetailResponse.md) * [OrgA2PBrandListResponse](https://docs.gravityrail.com/sdk/interfaces/OrgA2PBrandListResponse.md) * [OrgA2PBrandSummary](https://docs.gravityrail.com/sdk/interfaces/OrgA2PBrandSummary.md) * [OrgAccessDeniedData](https://docs.gravityrail.com/sdk/interfaces/OrgAccessDeniedData.md) * [Organization](https://docs.gravityrail.com/sdk/interfaces/Organization.md) * [OrganizationInvitationListResponse](https://docs.gravityrail.com/sdk/interfaces/OrganizationInvitationListResponse.md) * [OrgAuthInfo](https://docs.gravityrail.com/sdk/interfaces/OrgAuthInfo.md) * [OrgMember](https://docs.gravityrail.com/sdk/interfaces/OrgMember.md) * [OrgMemberListResponse](https://docs.gravityrail.com/sdk/interfaces/OrgMemberListResponse.md) * [OutboundCallRequest](https://docs.gravityrail.com/sdk/interfaces/OutboundCallRequest.md) * [OutboundCallResponse](https://docs.gravityrail.com/sdk/interfaces/OutboundCallResponse.md) * [OwnershipVerificationResponse](https://docs.gravityrail.com/sdk/interfaces/OwnershipVerificationResponse.md) * [PageContext](https://docs.gravityrail.com/sdk/interfaces/PageContext.md) * [PageExport](https://docs.gravityrail.com/sdk/interfaces/PageExport.md) * [PageFormData](https://docs.gravityrail.com/sdk/interfaces/PageFormData.md) * [PageResponse](https://docs.gravityrail.com/sdk/interfaces/PageResponse.md) * [PagesQueryParams](https://docs.gravityrail.com/sdk/interfaces/PagesQueryParams.md) * [PaginatedResponse](https://docs.gravityrail.com/sdk/interfaces/PaginatedResponse.md) * [PaginatedSubscriptionsResponse](https://docs.gravityrail.com/sdk/interfaces/PaginatedSubscriptionsResponse.md) * [PatientSyncConnectionStatus](https://docs.gravityrail.com/sdk/interfaces/PatientSyncConnectionStatus.md) * [PendingAnonymousMembersResponse](https://docs.gravityrail.com/sdk/interfaces/PendingAnonymousMembersResponse.md) * [PendingCredentialChange](https://docs.gravityrail.com/sdk/interfaces/PendingCredentialChange.md) * [PendingCredentialChangeInvite](https://docs.gravityrail.com/sdk/interfaces/PendingCredentialChangeInvite.md) * [PerformanceMetrics](https://docs.gravityrail.com/sdk/interfaces/PerformanceMetrics.md) * [PhoneAggregatedData](https://docs.gravityrail.com/sdk/interfaces/PhoneAggregatedData.md) * [PhoneCall](https://docs.gravityrail.com/sdk/interfaces/PhoneCall.md) * [PhoneCallActionParams](https://docs.gravityrail.com/sdk/interfaces/PhoneCallActionParams.md) * [PhoneCallAggregatedData](https://docs.gravityrail.com/sdk/interfaces/PhoneCallAggregatedData.md) * [PhoneCallPhoneNumberUsageResponse](https://docs.gravityrail.com/sdk/interfaces/PhoneCallPhoneNumberUsageResponse.md) * [PhoneCallToolsAbilityConfig](https://docs.gravityrail.com/sdk/interfaces/PhoneCallToolsAbilityConfig.md) * [PhoneCallUsageResponse](https://docs.gravityrail.com/sdk/interfaces/PhoneCallUsageResponse.md) * [PhoneCommunicationDetailsResponse](https://docs.gravityrail.com/sdk/interfaces/PhoneCommunicationDetailsResponse.md) * [PhoneNumber](https://docs.gravityrail.com/sdk/interfaces/PhoneNumber.md) * [PhoneNumberExport](https://docs.gravityrail.com/sdk/interfaces/PhoneNumberExport.md) * [PhoneNumberFormData](https://docs.gravityrail.com/sdk/interfaces/PhoneNumberFormData.md) * [PhoneNumberUsage](https://docs.gravityrail.com/sdk/interfaces/PhoneNumberUsage.md) * [PhoneUsageReport](https://docs.gravityrail.com/sdk/interfaces/PhoneUsageReport.md) * [PhoneUsageReportParams](https://docs.gravityrail.com/sdk/interfaces/PhoneUsageReportParams.md) * [PhoneUsageRow](https://docs.gravityrail.com/sdk/interfaces/PhoneUsageRow.md) * [PlanComparisonResult](https://docs.gravityrail.com/sdk/interfaces/PlanComparisonResult.md) * [PlanConfiguration](https://docs.gravityrail.com/sdk/interfaces/PlanConfiguration.md) * [PlatformAppConnectionResponse](https://docs.gravityrail.com/sdk/interfaces/PlatformAppConnectionResponse.md) * [PlatformUsageData](https://docs.gravityrail.com/sdk/interfaces/PlatformUsageData.md) * [PlayAudioActionParams](https://docs.gravityrail.com/sdk/interfaces/PlayAudioActionParams.md) * [PresenceAcceptInteractionMessage](https://docs.gravityrail.com/sdk/interfaces/PresenceAcceptInteractionMessage.md) * [PresenceConfirmation](https://docs.gravityrail.com/sdk/interfaces/PresenceConfirmation.md) * [PresenceEndInteractionMessage](https://docs.gravityrail.com/sdk/interfaces/PresenceEndInteractionMessage.md) * [PresenceError](https://docs.gravityrail.com/sdk/interfaces/PresenceError.md) * [PresenceGoLiveMessage](https://docs.gravityrail.com/sdk/interfaces/PresenceGoLiveMessage.md) * [PresenceGoOfflineMessage](https://docs.gravityrail.com/sdk/interfaces/PresenceGoOfflineMessage.md) * [PresenceHeartbeatMessage](https://docs.gravityrail.com/sdk/interfaces/PresenceHeartbeatMessage.md) * [PresenceLoginAck](https://docs.gravityrail.com/sdk/interfaces/PresenceLoginAck.md) * [PresenceLoginMessage](https://docs.gravityrail.com/sdk/interfaces/PresenceLoginMessage.md) * [PresenceRejectInteractionMessage](https://docs.gravityrail.com/sdk/interfaces/PresenceRejectInteractionMessage.md) * [PresenceStatusResponse](https://docs.gravityrail.com/sdk/interfaces/PresenceStatusResponse.md) * [PresenceTakenOverAckMessage](https://docs.gravityrail.com/sdk/interfaces/PresenceTakenOverAckMessage.md) * [ProductFeature](https://docs.gravityrail.com/sdk/interfaces/ProductFeature.md) * [ProductImage](https://docs.gravityrail.com/sdk/interfaces/ProductImage.md) * [ProductLink](https://docs.gravityrail.com/sdk/interfaces/ProductLink.md) * [ProductMetadata](https://docs.gravityrail.com/sdk/interfaces/ProductMetadata.md) * [ProductOverageConfig](https://docs.gravityrail.com/sdk/interfaces/ProductOverageConfig.md) * [ProductPlan](https://docs.gravityrail.com/sdk/interfaces/ProductPlan.md) * [PronunciationEntryResponse](https://docs.gravityrail.com/sdk/interfaces/PronunciationEntryResponse.md) * [PronunciationImportEntry](https://docs.gravityrail.com/sdk/interfaces/PronunciationImportEntry.md) * [PronunciationImportResult](https://docs.gravityrail.com/sdk/interfaces/PronunciationImportResult.md) * [ProviderPhoneNumber](https://docs.gravityrail.com/sdk/interfaces/ProviderPhoneNumber.md) * [ProviderUsageSummary](https://docs.gravityrail.com/sdk/interfaces/ProviderUsageSummary.md) * [ProvisionA2PEnrollmentSiteRequest](https://docs.gravityrail.com/sdk/interfaces/ProvisionA2PEnrollmentSiteRequest.md) * [ProvisionPlanRequest](https://docs.gravityrail.com/sdk/interfaces/ProvisionPlanRequest.md) * [ProvisionPlanResponse](https://docs.gravityrail.com/sdk/interfaces/ProvisionPlanResponse.md) * [PublicFileMetadata](https://docs.gravityrail.com/sdk/interfaces/PublicFileMetadata.md) * [PublicFolderContents](https://docs.gravityrail.com/sdk/interfaces/PublicFolderContents.md) * [PublicOrganizationConfig](https://docs.gravityrail.com/sdk/interfaces/PublicOrganizationConfig.md) * [PublicSSOConfig](https://docs.gravityrail.com/sdk/interfaces/PublicSSOConfig.md) * [PublicWorkspace](https://docs.gravityrail.com/sdk/interfaces/PublicWorkspace.md) * [QualificationExport](https://docs.gravityrail.com/sdk/interfaces/QualificationExport.md) * [QualificationResponse](https://docs.gravityrail.com/sdk/interfaces/QualificationResponse.md) * [QueryAggregatePredicate](https://docs.gravityrail.com/sdk/interfaces/QueryAggregatePredicate.md) * [QueryAggregateSpec](https://docs.gravityrail.com/sdk/interfaces/QueryAggregateSpec.md) * [QueryAnd](https://docs.gravityrail.com/sdk/interfaces/QueryAnd.md) * [QueryCompare](https://docs.gravityrail.com/sdk/interfaces/QueryCompare.md) * [QueryCostInfo](https://docs.gravityrail.com/sdk/interfaces/QueryCostInfo.md) * [QueryDataTypeInfo](https://docs.gravityrail.com/sdk/interfaces/QueryDataTypeInfo.md) * [QueryDayBoundaryValue](https://docs.gravityrail.com/sdk/interfaces/QueryDayBoundaryValue.md) * [QueryDaysAgoValue](https://docs.gravityrail.com/sdk/interfaces/QueryDaysAgoValue.md) * [QueryDaysFromNowValue](https://docs.gravityrail.com/sdk/interfaces/QueryDaysFromNowValue.md) * [QueryEnumOption](https://docs.gravityrail.com/sdk/interfaces/QueryEnumOption.md) * [QueryFieldInfo](https://docs.gravityrail.com/sdk/interfaces/QueryFieldInfo.md) * [QueryFieldsResponse](https://docs.gravityrail.com/sdk/interfaces/QueryFieldsResponse.md) * [QueryGroupBy](https://docs.gravityrail.com/sdk/interfaces/QueryGroupBy.md) * [QueryIR](https://docs.gravityrail.com/sdk/interfaces/QueryIR.md) * [QueryMetric](https://docs.gravityrail.com/sdk/interfaces/QueryMetric.md) * [QueryNot](https://docs.gravityrail.com/sdk/interfaces/QueryNot.md) * [QueryNowValue](https://docs.gravityrail.com/sdk/interfaces/QueryNowValue.md) * [QueryOr](https://docs.gravityrail.com/sdk/interfaces/QueryOr.md) * [QueryRangeValue](https://docs.gravityrail.com/sdk/interfaces/QueryRangeValue.md) * [QueryRecordFieldInfo](https://docs.gravityrail.com/sdk/interfaces/QueryRecordFieldInfo.md) * [QueryRecordMatch](https://docs.gravityrail.com/sdk/interfaces/QueryRecordMatch.md) * [QueryRecordSelection](https://docs.gravityrail.com/sdk/interfaces/QueryRecordSelection.md) * [QueryRelationMatch](https://docs.gravityrail.com/sdk/interfaces/QueryRelationMatch.md) * [QuerySavedFilterRef](https://docs.gravityrail.com/sdk/interfaces/QuerySavedFilterRef.md) * [QuerySortKey](https://docs.gravityrail.com/sdk/interfaces/QuerySortKey.md) * [QuerySubQueryRef](https://docs.gravityrail.com/sdk/interfaces/QuerySubQueryRef.md) * [RealtimeChatError](https://docs.gravityrail.com/sdk/interfaces/RealtimeChatError.md) * [RealtimeModelResponse](https://docs.gravityrail.com/sdk/interfaces/RealtimeModelResponse.md) * [RecommendedVoiceResponse](https://docs.gravityrail.com/sdk/interfaces/RecommendedVoiceResponse.md) * [RecoveryCodesResponse](https://docs.gravityrail.com/sdk/interfaces/RecoveryCodesResponse.md) * [RegistryVariable](https://docs.gravityrail.com/sdk/interfaces/RegistryVariable.md) * [RenderedPageResponse](https://docs.gravityrail.com/sdk/interfaces/RenderedPageResponse.md) * [ReorderMenuItemsData](https://docs.gravityrail.com/sdk/interfaces/ReorderMenuItemsData.md) * [RequestCredentialChangeRequest](https://docs.gravityrail.com/sdk/interfaces/RequestCredentialChangeRequest.md) * [RequestMagicLinkRequest](https://docs.gravityrail.com/sdk/interfaces/RequestMagicLinkRequest.md) * [RequestMagicLinkResponse](https://docs.gravityrail.com/sdk/interfaces/RequestMagicLinkResponse.md) * [ResolveAnonymousMemberRequest](https://docs.gravityrail.com/sdk/interfaces/ResolveAnonymousMemberRequest.md) * [ResolvedA2PCampaignConfig](https://docs.gravityrail.com/sdk/interfaces/ResolvedA2PCampaignConfig.md) * [ResolveGrantRequest](https://docs.gravityrail.com/sdk/interfaces/ResolveGrantRequest.md) * [ResourceMetadata](https://docs.gravityrail.com/sdk/interfaces/ResourceMetadata.md) * [ResourceOverage](https://docs.gravityrail.com/sdk/interfaces/ResourceOverage.md) * [ResourceOverageResponse](https://docs.gravityrail.com/sdk/interfaces/ResourceOverageResponse.md) * [ResourceUsageResponse](https://docs.gravityrail.com/sdk/interfaces/ResourceUsageResponse.md) * [RevokeGrantRequest](https://docs.gravityrail.com/sdk/interfaces/RevokeGrantRequest.md) * [RoleAssociationEntry](https://docs.gravityrail.com/sdk/interfaces/RoleAssociationEntry.md) * [RoutineExport](https://docs.gravityrail.com/sdk/interfaces/RoutineExport.md) * [RoutineResponse](https://docs.gravityrail.com/sdk/interfaces/RoutineResponse.md) * [RoutineRunResponse](https://docs.gravityrail.com/sdk/interfaces/RoutineRunResponse.md) * [RoutineRunsQueryParams](https://docs.gravityrail.com/sdk/interfaces/RoutineRunsQueryParams.md) * [RoutinesQueryParams](https://docs.gravityrail.com/sdk/interfaces/RoutinesQueryParams.md) * [RuleExecutionResponse](https://docs.gravityrail.com/sdk/interfaces/RuleExecutionResponse.md) * [RuleExecutionsQueryParams](https://docs.gravityrail.com/sdk/interfaces/RuleExecutionsQueryParams.md) * [RunQueryRequest](https://docs.gravityrail.com/sdk/interfaces/RunQueryRequest.md) * [RunQueryResponse](https://docs.gravityrail.com/sdk/interfaces/RunQueryResponse.md) * [SalesforceConnectionResponse](https://docs.gravityrail.com/sdk/interfaces/SalesforceConnectionResponse.md) * [SalesforceDataRecordObjectMapping](https://docs.gravityrail.com/sdk/interfaces/SalesforceDataRecordObjectMapping.md) * [SalesforceSearchRequest](https://docs.gravityrail.com/sdk/interfaces/SalesforceSearchRequest.md) * [SalesforceSearchResponse](https://docs.gravityrail.com/sdk/interfaces/SalesforceSearchResponse.md) * [SalesforceSearchResult](https://docs.gravityrail.com/sdk/interfaces/SalesforceSearchResult.md) * [SalesforceSearchResultMatch](https://docs.gravityrail.com/sdk/interfaces/SalesforceSearchResultMatch.md) * [SalesforceSyncConfigResponse](https://docs.gravityrail.com/sdk/interfaces/SalesforceSyncConfigResponse.md) * [SalesforceSyncSettings](https://docs.gravityrail.com/sdk/interfaces/SalesforceSyncSettings.md) * [ScenarioCriterionExport](https://docs.gravityrail.com/sdk/interfaces/ScenarioCriterionExport.md) * [ScenarioDataRecord](https://docs.gravityrail.com/sdk/interfaces/ScenarioDataRecord.md) * [ScenarioExport](https://docs.gravityrail.com/sdk/interfaces/ScenarioExport.md) * [ScheduledCallbackListResponse](https://docs.gravityrail.com/sdk/interfaces/ScheduledCallbackListResponse.md) * [ScheduledCallbackResponse](https://docs.gravityrail.com/sdk/interfaces/ScheduledCallbackResponse.md) * [SchedulePreviewRequest](https://docs.gravityrail.com/sdk/interfaces/SchedulePreviewRequest.md) * [SchedulePreviewResponse](https://docs.gravityrail.com/sdk/interfaces/SchedulePreviewResponse.md) * [SchemaField](https://docs.gravityrail.com/sdk/interfaces/SchemaField.md) * [ScopesListResponse](https://docs.gravityrail.com/sdk/interfaces/ScopesListResponse.md) * [SendEmailVerificationRequest](https://docs.gravityrail.com/sdk/interfaces/SendEmailVerificationRequest.md) * [SendSMSAbilityConfig](https://docs.gravityrail.com/sdk/interfaces/SendSMSAbilityConfig.md) * [SessionExchangeRequest](https://docs.gravityrail.com/sdk/interfaces/SessionExchangeRequest.md) * [SessionExchangeResponse](https://docs.gravityrail.com/sdk/interfaces/SessionExchangeResponse.md) * [SessionTakeover](https://docs.gravityrail.com/sdk/interfaces/SessionTakeover.md) * [SetupStep](https://docs.gravityrail.com/sdk/interfaces/SetupStep.md) * [SetupTOTPRequest](https://docs.gravityrail.com/sdk/interfaces/SetupTOTPRequest.md) * [SetupWebAuthnRequest](https://docs.gravityrail.com/sdk/interfaces/SetupWebAuthnRequest.md) * [SharingGrantEntry](https://docs.gravityrail.com/sdk/interfaces/SharingGrantEntry.md) * [SignupAccountResponse](https://docs.gravityrail.com/sdk/interfaces/SignupAccountResponse.md) * [SignupMemberResponse](https://docs.gravityrail.com/sdk/interfaces/SignupMemberResponse.md) * [SiteContext](https://docs.gravityrail.com/sdk/interfaces/SiteContext.md) * [SiteCountsResponse](https://docs.gravityrail.com/sdk/interfaces/SiteCountsResponse.md) * [SiteDisableImpactResponse](https://docs.gravityrail.com/sdk/interfaces/SiteDisableImpactResponse.md) * [SiteDomainConfigResponse](https://docs.gravityrail.com/sdk/interfaces/SiteDomainConfigResponse.md) * [SiteExport](https://docs.gravityrail.com/sdk/interfaces/SiteExport.md) * [SiteFormData](https://docs.gravityrail.com/sdk/interfaces/SiteFormData.md) * [SiteMappingFormData](https://docs.gravityrail.com/sdk/interfaces/SiteMappingFormData.md) * [SiteSharingResponse](https://docs.gravityrail.com/sdk/interfaces/SiteSharingResponse.md) * [SiteSignupResponse](https://docs.gravityrail.com/sdk/interfaces/SiteSignupResponse.md) * [SiteSlugAvailability](https://docs.gravityrail.com/sdk/interfaces/SiteSlugAvailability.md) * [SiteSource](https://docs.gravityrail.com/sdk/interfaces/SiteSource.md) * [SiteSourceBuild](https://docs.gravityrail.com/sdk/interfaces/SiteSourceBuild.md) * [SiteSourcePublishResponse](https://docs.gravityrail.com/sdk/interfaces/SiteSourcePublishResponse.md) * [SiteSourceRelease](https://docs.gravityrail.com/sdk/interfaces/SiteSourceRelease.md) * [SiteSourceTemplateOption](https://docs.gravityrail.com/sdk/interfaces/SiteSourceTemplateOption.md) * [SiteSourceTemplates](https://docs.gravityrail.com/sdk/interfaces/SiteSourceTemplates.md) * [SiteVerificationResponse](https://docs.gravityrail.com/sdk/interfaces/SiteVerificationResponse.md) * [SkillsResponse](https://docs.gravityrail.com/sdk/interfaces/SkillsResponse.md) * [SkillsState](https://docs.gravityrail.com/sdk/interfaces/SkillsState.md) * [SkippedWorkspace](https://docs.gravityrail.com/sdk/interfaces/SkippedWorkspace.md) * [SlackAccount](https://docs.gravityrail.com/sdk/interfaces/SlackAccount.md) * [SlackAppInstallation](https://docs.gravityrail.com/sdk/interfaces/SlackAppInstallation.md) * [SlackSlashCommandConfigResponse](https://docs.gravityrail.com/sdk/interfaces/SlackSlashCommandConfigResponse.md) * [SlackThread](https://docs.gravityrail.com/sdk/interfaces/SlackThread.md) * [SlashCommandConfigResponse](https://docs.gravityrail.com/sdk/interfaces/SlashCommandConfigResponse.md) * [SMSCommunicationDetailsResponse](https://docs.gravityrail.com/sdk/interfaces/SMSCommunicationDetailsResponse.md) * [SMSLoginResponse](https://docs.gravityrail.com/sdk/interfaces/SMSLoginResponse.md) * [SMSMessage](https://docs.gravityrail.com/sdk/interfaces/SMSMessage.md) * [SMSMessageDef](https://docs.gravityrail.com/sdk/interfaces/SMSMessageDef.md) * [SMSMessageUsageResponse](https://docs.gravityrail.com/sdk/interfaces/SMSMessageUsageResponse.md) * [SMSPhoneNumberUsageResponse](https://docs.gravityrail.com/sdk/interfaces/SMSPhoneNumberUsageResponse.md) * [SmsSendActionParams](https://docs.gravityrail.com/sdk/interfaces/SmsSendActionParams.md) * [SMSUsageReport](https://docs.gravityrail.com/sdk/interfaces/SMSUsageReport.md) * [SMSUsageReportParams](https://docs.gravityrail.com/sdk/interfaces/SMSUsageReportParams.md) * [SMSUsageRow](https://docs.gravityrail.com/sdk/interfaces/SMSUsageRow.md) * [SpamScore](https://docs.gravityrail.com/sdk/interfaces/SpamScore.md) * [SSOConfig](https://docs.gravityrail.com/sdk/interfaces/SSOConfig.md) * [SSOConfigData](https://docs.gravityrail.com/sdk/interfaces/SSOConfigData.md) * [StartTestChatRunRequest](https://docs.gravityrail.com/sdk/interfaces/StartTestChatRunRequest.md) * [StartTestChatRunResponse](https://docs.gravityrail.com/sdk/interfaces/StartTestChatRunResponse.md) * [StatisticsSummary](https://docs.gravityrail.com/sdk/interfaces/StatisticsSummary.md) * [StripeAddress](https://docs.gravityrail.com/sdk/interfaces/StripeAddress.md) * [StripeCardDetails](https://docs.gravityrail.com/sdk/interfaces/StripeCardDetails.md) * [StripeComparisonResult](https://docs.gravityrail.com/sdk/interfaces/StripeComparisonResult.md) * [StripeCustomer](https://docs.gravityrail.com/sdk/interfaces/StripeCustomer.md) * [StripeCustomerCreateRequest](https://docs.gravityrail.com/sdk/interfaces/StripeCustomerCreateRequest.md) * [StripeCustomerUpdateRequest](https://docs.gravityrail.com/sdk/interfaces/StripeCustomerUpdateRequest.md) * [StripePaymentMethod](https://docs.gravityrail.com/sdk/interfaces/StripePaymentMethod.md) * [StripePlanDetail](https://docs.gravityrail.com/sdk/interfaces/StripePlanDetail.md) * [StripePrice](https://docs.gravityrail.com/sdk/interfaces/StripePrice.md) * [StripeProduct](https://docs.gravityrail.com/sdk/interfaces/StripeProduct.md) * [StripeShipping](https://docs.gravityrail.com/sdk/interfaces/StripeShipping.md) * [StripeSubscriptionCreateRequest](https://docs.gravityrail.com/sdk/interfaces/StripeSubscriptionCreateRequest.md) * [StripeSubscriptionUpdateRequest](https://docs.gravityrail.com/sdk/interfaces/StripeSubscriptionUpdateRequest.md) * [StripeTax](https://docs.gravityrail.com/sdk/interfaces/StripeTax.md) * [StripeUSBankAccountDetails](https://docs.gravityrail.com/sdk/interfaces/StripeUSBankAccountDetails.md) * [STTCapabilitiesResponse](https://docs.gravityrail.com/sdk/interfaces/STTCapabilitiesResponse.md) * [STTModelResponse](https://docs.gravityrail.com/sdk/interfaces/STTModelResponse.md) * [STTModelsResponse](https://docs.gravityrail.com/sdk/interfaces/STTModelsResponse.md) * [STTProviderSummary](https://docs.gravityrail.com/sdk/interfaces/STTProviderSummary.md) * [STTUsageRow](https://docs.gravityrail.com/sdk/interfaces/STTUsageRow.md) * [SubscriptionUpdateRequest](https://docs.gravityrail.com/sdk/interfaces/SubscriptionUpdateRequest.md) * [SupervisorAbilityConfig](https://docs.gravityrail.com/sdk/interfaces/SupervisorAbilityConfig.md) * [SupervisorActionsAbilityConfig](https://docs.gravityrail.com/sdk/interfaces/SupervisorActionsAbilityConfig.md) * [SupervisorFormData](https://docs.gravityrail.com/sdk/interfaces/SupervisorFormData.md) * [SwitchTaskActionParams](https://docs.gravityrail.com/sdk/interfaces/SwitchTaskActionParams.md) * [SyncCalendarResponse](https://docs.gravityrail.com/sdk/interfaces/SyncCalendarResponse.md) * [SyncCapabilities](https://docs.gravityrail.com/sdk/interfaces/SyncCapabilities.md) * [SyncCapabilitiesResponse](https://docs.gravityrail.com/sdk/interfaces/SyncCapabilitiesResponse.md) * [SyncCheckpoint](https://docs.gravityrail.com/sdk/interfaces/SyncCheckpoint.md) * [SyncLogEntry](https://docs.gravityrail.com/sdk/interfaces/SyncLogEntry.md) * [SyncLogsResponse](https://docs.gravityrail.com/sdk/interfaces/SyncLogsResponse.md) * [SyncProductToStripeRequest](https://docs.gravityrail.com/sdk/interfaces/SyncProductToStripeRequest.md) * [SyncProductToStripeResponse](https://docs.gravityrail.com/sdk/interfaces/SyncProductToStripeResponse.md) * [SyncRule](https://docs.gravityrail.com/sdk/interfaces/SyncRule.md) * [SyncRuleInbound](https://docs.gravityrail.com/sdk/interfaces/SyncRuleInbound.md) * [SyncRuleOutbound](https://docs.gravityrail.com/sdk/interfaces/SyncRuleOutbound.md) * [SyncRunRequest](https://docs.gravityrail.com/sdk/interfaces/SyncRunRequest.md) * [SyncRunResponse](https://docs.gravityrail.com/sdk/interfaces/SyncRunResponse.md) * [SystemStatistics](https://docs.gravityrail.com/sdk/interfaces/SystemStatistics.md) * [TaskAssignmentStatsResponse](https://docs.gravityrail.com/sdk/interfaces/TaskAssignmentStatsResponse.md) * [TaskChatResponse](https://docs.gravityrail.com/sdk/interfaces/TaskChatResponse.md) * [TaskChatsListResponse](https://docs.gravityrail.com/sdk/interfaces/TaskChatsListResponse.md) * [TaskChildRelation](https://docs.gravityrail.com/sdk/interfaces/TaskChildRelation.md) * [TaskContext](https://docs.gravityrail.com/sdk/interfaces/TaskContext.md) * [TaskCountResponse](https://docs.gravityrail.com/sdk/interfaces/TaskCountResponse.md) * [TaskDataTypeRelation](https://docs.gravityrail.com/sdk/interfaces/TaskDataTypeRelation.md) * [TaskEventRuleRelation](https://docs.gravityrail.com/sdk/interfaces/TaskEventRuleRelation.md) * [TaskExport](https://docs.gravityrail.com/sdk/interfaces/TaskExport.md) * [TaskExportChildRelation](https://docs.gravityrail.com/sdk/interfaces/TaskExportChildRelation.md) * [TaskExportDataTypeRelation](https://docs.gravityrail.com/sdk/interfaces/TaskExportDataTypeRelation.md) * [TaskExportEventRuleRelation](https://docs.gravityrail.com/sdk/interfaces/TaskExportEventRuleRelation.md) * [TaskExportFileRelation](https://docs.gravityrail.com/sdk/interfaces/TaskExportFileRelation.md) * [TaskFileRelation](https://docs.gravityrail.com/sdk/interfaces/TaskFileRelation.md) * [TaskFormData](https://docs.gravityrail.com/sdk/interfaces/TaskFormData.md) * [TasksQueryParams](https://docs.gravityrail.com/sdk/interfaces/TasksQueryParams.md) * [TeamsAccountResponse](https://docs.gravityrail.com/sdk/interfaces/TeamsAccountResponse.md) * [TeamsAppInstallationResponse](https://docs.gravityrail.com/sdk/interfaces/TeamsAppInstallationResponse.md) * [TeamsAppResponse](https://docs.gravityrail.com/sdk/interfaces/TeamsAppResponse.md) * [TeamsCommandConfigResponse](https://docs.gravityrail.com/sdk/interfaces/TeamsCommandConfigResponse.md) * [TemplateContextRequest](https://docs.gravityrail.com/sdk/interfaces/TemplateContextRequest.md) * [TemplateContextResponse](https://docs.gravityrail.com/sdk/interfaces/TemplateContextResponse.md) * [TemplatePreviewRequest](https://docs.gravityrail.com/sdk/interfaces/TemplatePreviewRequest.md) * [TemplatePreviewResponse](https://docs.gravityrail.com/sdk/interfaces/TemplatePreviewResponse.md) * [TemplateVariable](https://docs.gravityrail.com/sdk/interfaces/TemplateVariable.md) * [TestChatRunResponse](https://docs.gravityrail.com/sdk/interfaces/TestChatRunResponse.md) * [TestConnectionResponse](https://docs.gravityrail.com/sdk/interfaces/TestConnectionResponse.md) * [TestWebhookRequest](https://docs.gravityrail.com/sdk/interfaces/TestWebhookRequest.md) * [TestWebhookResponse](https://docs.gravityrail.com/sdk/interfaces/TestWebhookResponse.md) * [TextContent](https://docs.gravityrail.com/sdk/interfaces/TextContent.md) * [ThemeFeatures](https://docs.gravityrail.com/sdk/interfaces/ThemeFeatures.md) * [ThemeResponse](https://docs.gravityrail.com/sdk/interfaces/ThemeResponse.md) * [ThemeSettingField](https://docs.gravityrail.com/sdk/interfaces/ThemeSettingField.md) * [ThemeSettingsResponse](https://docs.gravityrail.com/sdk/interfaces/ThemeSettingsResponse.md) * [ThemesListResponse](https://docs.gravityrail.com/sdk/interfaces/ThemesListResponse.md) * [ThinkingSoundPreviewRequest](https://docs.gravityrail.com/sdk/interfaces/ThinkingSoundPreviewRequest.md) * [TimeSeriesData](https://docs.gravityrail.com/sdk/interfaces/TimeSeriesData.md) * [TimeSeriesDataPoint](https://docs.gravityrail.com/sdk/interfaces/TimeSeriesDataPoint.md) * [TimeSlot](https://docs.gravityrail.com/sdk/interfaces/TimeSlot.md) * [TipTapDocumentOutput](https://docs.gravityrail.com/sdk/interfaces/TipTapDocumentOutput.md) * [TodoItemResponse](https://docs.gravityrail.com/sdk/interfaces/TodoItemResponse.md) * [TodosResponse](https://docs.gravityrail.com/sdk/interfaces/TodosResponse.md) * [Tool](https://docs.gravityrail.com/sdk/interfaces/Tool.md) * [ToolCall](https://docs.gravityrail.com/sdk/interfaces/ToolCall.md) * [ToolCallFunction](https://docs.gravityrail.com/sdk/interfaces/ToolCallFunction.md) * [ToolInputSchema](https://docs.gravityrail.com/sdk/interfaces/ToolInputSchema.md) * [Toolkit](https://docs.gravityrail.com/sdk/interfaces/Toolkit.md) * [ToolkitContext](https://docs.gravityrail.com/sdk/interfaces/ToolkitContext.md) * [ToolkitsAbilityConfig](https://docs.gravityrail.com/sdk/interfaces/ToolkitsAbilityConfig.md) * [ToolkitsResponse](https://docs.gravityrail.com/sdk/interfaces/ToolkitsResponse.md) * [ToolParameter](https://docs.gravityrail.com/sdk/interfaces/ToolParameter.md) * [ToolResponse](https://docs.gravityrail.com/sdk/interfaces/ToolResponse.md) * [ToolResult](https://docs.gravityrail.com/sdk/interfaces/ToolResult.md) * [ToolsResponse](https://docs.gravityrail.com/sdk/interfaces/ToolsResponse.md) * [TopOffender](https://docs.gravityrail.com/sdk/interfaces/TopOffender.md) * [TopResourceOverageResponse](https://docs.gravityrail.com/sdk/interfaces/TopResourceOverageResponse.md) * [TOTPSetupResponse](https://docs.gravityrail.com/sdk/interfaces/TOTPSetupResponse.md) * [TransformPreset](https://docs.gravityrail.com/sdk/interfaces/TransformPreset.md) * [TriggerConnectionBackfillRequest](https://docs.gravityrail.com/sdk/interfaces/TriggerConnectionBackfillRequest.md) * [TriggerPatientRefreshRequest](https://docs.gravityrail.com/sdk/interfaces/TriggerPatientRefreshRequest.md) * [TTSModelResponse](https://docs.gravityrail.com/sdk/interfaces/TTSModelResponse.md) * [TTSPreviewRequest](https://docs.gravityrail.com/sdk/interfaces/TTSPreviewRequest.md) * [TTSProviderSummary](https://docs.gravityrail.com/sdk/interfaces/TTSProviderSummary.md) * [TTSUsageRow](https://docs.gravityrail.com/sdk/interfaces/TTSUsageRow.md) * [TwoFactorOperationResponse](https://docs.gravityrail.com/sdk/interfaces/TwoFactorOperationResponse.md) * [UIChoiceDecision](https://docs.gravityrail.com/sdk/interfaces/UIChoiceDecision.md) * [UnauthorizedSiteResponse](https://docs.gravityrail.com/sdk/interfaces/UnauthorizedSiteResponse.md) * [UnlinkCalendarResponse](https://docs.gravityrail.com/sdk/interfaces/UnlinkCalendarResponse.md) * [UnmappedPhoneNumber](https://docs.gravityrail.com/sdk/interfaces/UnmappedPhoneNumber.md) * [UnthreadedEmailResponse](https://docs.gravityrail.com/sdk/interfaces/UnthreadedEmailResponse.md) * [UpdateA2PCampaignConfigRequest](https://docs.gravityrail.com/sdk/interfaces/UpdateA2PCampaignConfigRequest.md) * [UpdateAgentRequest](https://docs.gravityrail.com/sdk/interfaces/UpdateAgentRequest.md) * [UpdateAppConnectionRequest](https://docs.gravityrail.com/sdk/interfaces/UpdateAppConnectionRequest.md) * [UpdateAppRequest](https://docs.gravityrail.com/sdk/interfaces/UpdateAppRequest.md) * [UpdateAssignmentFormData](https://docs.gravityrail.com/sdk/interfaces/UpdateAssignmentFormData.md) * [UpdateAttendeeRequest](https://docs.gravityrail.com/sdk/interfaces/UpdateAttendeeRequest.md) * [UpdateBuilderRequest](https://docs.gravityrail.com/sdk/interfaces/UpdateBuilderRequest.md) * [UpdateBusinessProfileRequest](https://docs.gravityrail.com/sdk/interfaces/UpdateBusinessProfileRequest.md) * [UpdateDiscordBotRequest](https://docs.gravityrail.com/sdk/interfaces/UpdateDiscordBotRequest.md) * [UpdateEncounterSyncRequest](https://docs.gravityrail.com/sdk/interfaces/UpdateEncounterSyncRequest.md) * [UpdateEventRuleFormData](https://docs.gravityrail.com/sdk/interfaces/UpdateEventRuleFormData.md) * [UpdateFhirConnectionRequest](https://docs.gravityrail.com/sdk/interfaces/UpdateFhirConnectionRequest.md) * [UpdateFhirCsvImportSettingsRequest](https://docs.gravityrail.com/sdk/interfaces/UpdateFhirCsvImportSettingsRequest.md) * [UpdateFileRoleAssociationsRequest](https://docs.gravityrail.com/sdk/interfaces/UpdateFileRoleAssociationsRequest.md) * [UpdateFileSharingRequest](https://docs.gravityrail.com/sdk/interfaces/UpdateFileSharingRequest.md) * [UpdateInvitationFormData](https://docs.gravityrail.com/sdk/interfaces/UpdateInvitationFormData.md) * [UpdateMemberFieldRequest](https://docs.gravityrail.com/sdk/interfaces/UpdateMemberFieldRequest.md) * [UpdateOperatorGroupRequest](https://docs.gravityrail.com/sdk/interfaces/UpdateOperatorGroupRequest.md) * [UpdateOrganizationRequest](https://docs.gravityrail.com/sdk/interfaces/UpdateOrganizationRequest.md) * [UpdateOrgMemberRequest](https://docs.gravityrail.com/sdk/interfaces/UpdateOrgMemberRequest.md) * [UpdatePersonaRequest](https://docs.gravityrail.com/sdk/interfaces/UpdatePersonaRequest.md) * [UpdatePronunciationEntryFormData](https://docs.gravityrail.com/sdk/interfaces/UpdatePronunciationEntryFormData.md) * [UpdateRoutineRequest](https://docs.gravityrail.com/sdk/interfaces/UpdateRoutineRequest.md) * [UpdateSalesforceSyncConfigRequest](https://docs.gravityrail.com/sdk/interfaces/UpdateSalesforceSyncConfigRequest.md) * [UpdateScenarioRequest](https://docs.gravityrail.com/sdk/interfaces/UpdateScenarioRequest.md) * [UpdateSlackAppRequest](https://docs.gravityrail.com/sdk/interfaces/UpdateSlackAppRequest.md) * [UpdateTeamsAppRequest](https://docs.gravityrail.com/sdk/interfaces/UpdateTeamsAppRequest.md) * [UpdateThemeSettingsRequest](https://docs.gravityrail.com/sdk/interfaces/UpdateThemeSettingsRequest.md) * [UpdateTwoFactorMethodRequest](https://docs.gravityrail.com/sdk/interfaces/UpdateTwoFactorMethodRequest.md) * [UpdateWorkflowContributorRequest](https://docs.gravityrail.com/sdk/interfaces/UpdateWorkflowContributorRequest.md) * [UpdateWorkspaceMemberRequest](https://docs.gravityrail.com/sdk/interfaces/UpdateWorkspaceMemberRequest.md) * [UploadFileRequest](https://docs.gravityrail.com/sdk/interfaces/UploadFileRequest.md) * [UsageDiscrepancy](https://docs.gravityrail.com/sdk/interfaces/UsageDiscrepancy.md) * [UsageProductSummaryResponse](https://docs.gravityrail.com/sdk/interfaces/UsageProductSummaryResponse.md) * [UsageReportRequest](https://docs.gravityrail.com/sdk/interfaces/UsageReportRequest.md) * [UsageReportResponse](https://docs.gravityrail.com/sdk/interfaces/UsageReportResponse.md) * [UsageStatistics](https://docs.gravityrail.com/sdk/interfaces/UsageStatistics.md) * [ValidateMagicLinkRequest](https://docs.gravityrail.com/sdk/interfaces/ValidateMagicLinkRequest.md) * [ValidateMagicLinkResponse](https://docs.gravityrail.com/sdk/interfaces/ValidateMagicLinkResponse.md) * [ValidateQueryResponse](https://docs.gravityrail.com/sdk/interfaces/ValidateQueryResponse.md) * [VariableRegistryRequest](https://docs.gravityrail.com/sdk/interfaces/VariableRegistryRequest.md) * [VariableRegistryResponse](https://docs.gravityrail.com/sdk/interfaces/VariableRegistryResponse.md) * [VerifyCodeRequest](https://docs.gravityrail.com/sdk/interfaces/VerifyCodeRequest.md) * [VerifyCodeResponse](https://docs.gravityrail.com/sdk/interfaces/VerifyCodeResponse.md) * [VerifyCredentialChangeRequest](https://docs.gravityrail.com/sdk/interfaces/VerifyCredentialChangeRequest.md) * [VerifyEmailRequest](https://docs.gravityrail.com/sdk/interfaces/VerifyEmailRequest.md) * [VerifyTOTPSetupRequest](https://docs.gravityrail.com/sdk/interfaces/VerifyTOTPSetupRequest.md) * [VerifyWebAuthnSetupRequest](https://docs.gravityrail.com/sdk/interfaces/VerifyWebAuthnSetupRequest.md) * [VoiceMetricsTimeRange](https://docs.gravityrail.com/sdk/interfaces/VoiceMetricsTimeRange.md) * [VoiceTokenResponse](https://docs.gravityrail.com/sdk/interfaces/VoiceTokenResponse.md) * [VoiceUsageReport](https://docs.gravityrail.com/sdk/interfaces/VoiceUsageReport.md) * [VoiceUsageReportParams](https://docs.gravityrail.com/sdk/interfaces/VoiceUsageReportParams.md) * [VoiceUsageResponse](https://docs.gravityrail.com/sdk/interfaces/VoiceUsageResponse.md) * [WebhookActionParams](https://docs.gravityrail.com/sdk/interfaces/WebhookActionParams.md) * [WebhookLogResponse](https://docs.gravityrail.com/sdk/interfaces/WebhookLogResponse.md) * [WebhookLogsQueryParams](https://docs.gravityrail.com/sdk/interfaces/WebhookLogsQueryParams.md) * [WebhookMetrics](https://docs.gravityrail.com/sdk/interfaces/WebhookMetrics.md) * [WebSearchAbilityConfig](https://docs.gravityrail.com/sdk/interfaces/WebSearchAbilityConfig.md) * [WorkflowAccessGapSummary](https://docs.gravityrail.com/sdk/interfaces/WorkflowAccessGapSummary.md) * [WorkflowAccessValidationResponse](https://docs.gravityrail.com/sdk/interfaces/WorkflowAccessValidationResponse.md) * [WorkflowAccessWarning](https://docs.gravityrail.com/sdk/interfaces/WorkflowAccessWarning.md) * [WorkflowActivity](https://docs.gravityrail.com/sdk/interfaces/WorkflowActivity.md) * [WorkflowConfigValidationResponse](https://docs.gravityrail.com/sdk/interfaces/WorkflowConfigValidationResponse.md) * [WorkflowContext](https://docs.gravityrail.com/sdk/interfaces/WorkflowContext.md) * [WorkflowContributorResponse](https://docs.gravityrail.com/sdk/interfaces/WorkflowContributorResponse.md) * [WorkflowExport](https://docs.gravityrail.com/sdk/interfaces/WorkflowExport.md) * [WorkflowFormData](https://docs.gravityrail.com/sdk/interfaces/WorkflowFormData.md) * [WorkflowMemberRoleAccessInput](https://docs.gravityrail.com/sdk/interfaces/WorkflowMemberRoleAccessInput.md) * [WorkflowNoteExport](https://docs.gravityrail.com/sdk/interfaces/WorkflowNoteExport.md) * [WorkflowNoteFormData](https://docs.gravityrail.com/sdk/interfaces/WorkflowNoteFormData.md) * [WorkflowNoteResponse](https://docs.gravityrail.com/sdk/interfaces/WorkflowNoteResponse.md) * [WorkflowRouteDryRunCandidate](https://docs.gravityrail.com/sdk/interfaces/WorkflowRouteDryRunCandidate.md) * [WorkflowRouteDryRunResponse](https://docs.gravityrail.com/sdk/interfaces/WorkflowRouteDryRunResponse.md) * [WorkflowRunAbilityConfig](https://docs.gravityrail.com/sdk/interfaces/WorkflowRunAbilityConfig.md) * [WorkflowStartAutomationResponse](https://docs.gravityrail.com/sdk/interfaces/WorkflowStartAutomationResponse.md) * [WorkflowTemplateResponse](https://docs.gravityrail.com/sdk/interfaces/WorkflowTemplateResponse.md) * [Workspace](https://docs.gravityrail.com/sdk/interfaces/Workspace.md) * [WorkspaceAccessDeniedData](https://docs.gravityrail.com/sdk/interfaces/WorkspaceAccessDeniedData.md) * [WorkspaceAutoMapEntities](https://docs.gravityrail.com/sdk/interfaces/WorkspaceAutoMapEntities.md) * [WorkspaceAvailableDomain](https://docs.gravityrail.com/sdk/interfaces/WorkspaceAvailableDomain.md) * [WorkspaceAvailableDomainsResponse](https://docs.gravityrail.com/sdk/interfaces/WorkspaceAvailableDomainsResponse.md) * [WorkspaceBuilderExportData](https://docs.gravityrail.com/sdk/interfaces/WorkspaceBuilderExportData.md) * [WorkspaceBuilderInfo](https://docs.gravityrail.com/sdk/interfaces/WorkspaceBuilderInfo.md) * [WorkspaceBuilderListResponse](https://docs.gravityrail.com/sdk/interfaces/WorkspaceBuilderListResponse.md) * [WorkspaceBuilderTaskExport](https://docs.gravityrail.com/sdk/interfaces/WorkspaceBuilderTaskExport.md) * [WorkspaceBuilderWorkflowExport](https://docs.gravityrail.com/sdk/interfaces/WorkspaceBuilderWorkflowExport.md) * [WorkspaceBuildPreview](https://docs.gravityrail.com/sdk/interfaces/WorkspaceBuildPreview.md) * [WorkspaceCounts](https://docs.gravityrail.com/sdk/interfaces/WorkspaceCounts.md) * [WorkspaceCreateNewEntities](https://docs.gravityrail.com/sdk/interfaces/WorkspaceCreateNewEntities.md) * [WorkspaceDefaults](https://docs.gravityrail.com/sdk/interfaces/WorkspaceDefaults.md) * [WorkspaceDefaultsFormData](https://docs.gravityrail.com/sdk/interfaces/WorkspaceDefaultsFormData.md) * [WorkspaceExportData](https://docs.gravityrail.com/sdk/interfaces/WorkspaceExportData.md) * [WorkspaceFeatureInfo](https://docs.gravityrail.com/sdk/interfaces/WorkspaceFeatureInfo.md) * [WorkspaceFormData](https://docs.gravityrail.com/sdk/interfaces/WorkspaceFormData.md) * [WorkspaceHealthDetail](https://docs.gravityrail.com/sdk/interfaces/WorkspaceHealthDetail.md) * [WorkspaceHealthRow](https://docs.gravityrail.com/sdk/interfaces/WorkspaceHealthRow.md) * [WorkspaceImportMapping](https://docs.gravityrail.com/sdk/interfaces/WorkspaceImportMapping.md) * [WorkspaceImportPreviewResponse](https://docs.gravityrail.com/sdk/interfaces/WorkspaceImportPreviewResponse.md) * [WorkspaceImportRequest](https://docs.gravityrail.com/sdk/interfaces/WorkspaceImportRequest.md) * [WorkspaceImportValidation](https://docs.gravityrail.com/sdk/interfaces/WorkspaceImportValidation.md) * [WorkspaceJoinRequest](https://docs.gravityrail.com/sdk/interfaces/WorkspaceJoinRequest.md) * [WorkspaceJoinResponse](https://docs.gravityrail.com/sdk/interfaces/WorkspaceJoinResponse.md) * [WorkspaceMemberResponse](https://docs.gravityrail.com/sdk/interfaces/WorkspaceMemberResponse.md) * [WorkspaceScope](https://docs.gravityrail.com/sdk/interfaces/WorkspaceScope.md) * [WorkspaceScopesResponse](https://docs.gravityrail.com/sdk/interfaces/WorkspaceScopesResponse.md) * [WorkspaceStatsResponse](https://docs.gravityrail.com/sdk/interfaces/WorkspaceStatsResponse.md) * [WorkspaceUsageReportResponse](https://docs.gravityrail.com/sdk/interfaces/WorkspaceUsageReportResponse.md) * [XAIChatModelConfig](https://docs.gravityrail.com/sdk/interfaces/XAIChatModelConfig.md) * [XAIRealtimeModelConfig](https://docs.gravityrail.com/sdk/interfaces/XAIRealtimeModelConfig.md) ## Type Aliases[​](#type-aliases "Direct link to Type Aliases") * [Ability](https://docs.gravityrail.com/sdk/type-aliases/Ability.md) * [AbilityConfig](https://docs.gravityrail.com/sdk/type-aliases/AbilityConfig.md) * [AbilityConfigIssueCode](https://docs.gravityrail.com/sdk/type-aliases/AbilityConfigIssueCode.md) * [AbilityConfigIssueSeverity](https://docs.gravityrail.com/sdk/type-aliases/AbilityConfigIssueSeverity.md) * [AbilityResponse](https://docs.gravityrail.com/sdk/type-aliases/AbilityResponse.md) * [AbilityTypeSlug](https://docs.gravityrail.com/sdk/type-aliases/AbilityTypeSlug.md) * [AccessGrant](https://docs.gravityrail.com/sdk/type-aliases/AccessGrant.md) * [AccessGrantInterrupt](https://docs.gravityrail.com/sdk/type-aliases/AccessGrantInterrupt.md) * [AccessGrantResponse](https://docs.gravityrail.com/sdk/type-aliases/AccessGrantResponse.md) * [AccountSortField](https://docs.gravityrail.com/sdk/type-aliases/AccountSortField.md) * [AdminWorkspaceSortField](https://docs.gravityrail.com/sdk/type-aliases/AdminWorkspaceSortField.md) * [AgentSortField](https://docs.gravityrail.com/sdk/type-aliases/AgentSortField.md) * [AnonymousMemberResolutionStatus](https://docs.gravityrail.com/sdk/type-aliases/AnonymousMemberResolutionStatus.md) * [App](https://docs.gravityrail.com/sdk/type-aliases/App.md) * [AppConnectionItem](https://docs.gravityrail.com/sdk/type-aliases/AppConnectionItem.md) * [AppConnectionType](https://docs.gravityrail.com/sdk/type-aliases/AppConnectionType.md) * [AppListResponse](https://docs.gravityrail.com/sdk/type-aliases/AppListResponse.md) * [AppResponse](https://docs.gravityrail.com/sdk/type-aliases/AppResponse.md) * [AssignmentSortField](https://docs.gravityrail.com/sdk/type-aliases/AssignmentSortField.md) * [AssignmentStatusType](https://docs.gravityrail.com/sdk/type-aliases/AssignmentStatusType.md) * [BillingPlanInfo](https://docs.gravityrail.com/sdk/type-aliases/BillingPlanInfo.md) * [BotSortField](https://docs.gravityrail.com/sdk/type-aliases/BotSortField.md) * [BulkMemberResultStatus](https://docs.gravityrail.com/sdk/type-aliases/BulkMemberResultStatus.md) * [BusinessIndustry](https://docs.gravityrail.com/sdk/type-aliases/BusinessIndustry.md) * [BusinessProfile](https://docs.gravityrail.com/sdk/type-aliases/BusinessProfile.md) * [BusinessProfileEvaluationStatus](https://docs.gravityrail.com/sdk/type-aliases/BusinessProfileEvaluationStatus.md) * [BusinessProfileResponse](https://docs.gravityrail.com/sdk/type-aliases/BusinessProfileResponse.md) * [BusinessProfileStatus](https://docs.gravityrail.com/sdk/type-aliases/BusinessProfileStatus.md) * [BusinessType](https://docs.gravityrail.com/sdk/type-aliases/BusinessType.md) * [Calendar](https://docs.gravityrail.com/sdk/type-aliases/Calendar.md) * [CalendarEventSortField](https://docs.gravityrail.com/sdk/type-aliases/CalendarEventSortField.md) * [CalendarResponse](https://docs.gravityrail.com/sdk/type-aliases/CalendarResponse.md) * [CalendarSchedule](https://docs.gravityrail.com/sdk/type-aliases/CalendarSchedule.md) * [CalendarScheduleResponse](https://docs.gravityrail.com/sdk/type-aliases/CalendarScheduleResponse.md) * [CallEndSection](https://docs.gravityrail.com/sdk/type-aliases/CallEndSection.md) * [CallEndStatusEntry](https://docs.gravityrail.com/sdk/type-aliases/CallEndStatusEntry.md) * [Channel](https://docs.gravityrail.com/sdk/type-aliases/Channel.md) * [CharlestonPmdSimulationOutcome](https://docs.gravityrail.com/sdk/type-aliases/CharlestonPmdSimulationOutcome.md) * [ChatAIModel](https://docs.gravityrail.com/sdk/type-aliases/ChatAIModel.md) * [ChatFilterFilterType](https://docs.gravityrail.com/sdk/type-aliases/ChatFilterFilterType.md) * [ChatFilterObjectType](https://docs.gravityrail.com/sdk/type-aliases/ChatFilterObjectType.md) * [ChatModelConfig](https://docs.gravityrail.com/sdk/type-aliases/ChatModelConfig.md) * [ChatSortField](https://docs.gravityrail.com/sdk/type-aliases/ChatSortField.md) * [ChatType](https://docs.gravityrail.com/sdk/type-aliases/ChatType.md) * [ConflictPolicyMode](https://docs.gravityrail.com/sdk/type-aliases/ConflictPolicyMode.md) * [ConnectionMultiplicity](https://docs.gravityrail.com/sdk/type-aliases/ConnectionMultiplicity.md) * [ContributorAbilityConfig](https://docs.gravityrail.com/sdk/type-aliases/ContributorAbilityConfig.md) * [CreateInquiryRequest](https://docs.gravityrail.com/sdk/type-aliases/CreateInquiryRequest.md) * [CredentialProvider](https://docs.gravityrail.com/sdk/type-aliases/CredentialProvider.md) * [CredentialType](https://docs.gravityrail.com/sdk/type-aliases/CredentialType.md) * [CustomTool](https://docs.gravityrail.com/sdk/type-aliases/CustomTool.md) * [CustomToolkit](https://docs.gravityrail.com/sdk/type-aliases/CustomToolkit.md) * [CustomToolkitResponse](https://docs.gravityrail.com/sdk/type-aliases/CustomToolkitResponse.md) * [CustomToolResponse](https://docs.gravityrail.com/sdk/type-aliases/CustomToolResponse.md) * [DataRecordRetirementResponseReason](https://docs.gravityrail.com/sdk/type-aliases/DataRecordRetirementResponseReason.md) * [DataTypeSortField](https://docs.gravityrail.com/sdk/type-aliases/DataTypeSortField.md) * [DiscordBot](https://docs.gravityrail.com/sdk/type-aliases/DiscordBot.md) * [DiscordBotResponse](https://docs.gravityrail.com/sdk/type-aliases/DiscordBotResponse.md) * [DiscordBotSortField](https://docs.gravityrail.com/sdk/type-aliases/DiscordBotSortField.md) * [DiscordRespondMode](https://docs.gravityrail.com/sdk/type-aliases/DiscordRespondMode.md) * [EmailDisableResponse](https://docs.gravityrail.com/sdk/type-aliases/EmailDisableResponse.md) * [EmailDnsRecord](https://docs.gravityrail.com/sdk/type-aliases/EmailDnsRecord.md) * [EmailDnsRecordType](https://docs.gravityrail.com/sdk/type-aliases/EmailDnsRecordType.md) * [EmailDomainConfig](https://docs.gravityrail.com/sdk/type-aliases/EmailDomainConfig.md) * [EmailDomainConfigGetResponse](https://docs.gravityrail.com/sdk/type-aliases/EmailDomainConfigGetResponse.md) * [EmptyAbilityConfig](https://docs.gravityrail.com/sdk/type-aliases/EmptyAbilityConfig.md) * [EnhancedAuthHandler](https://docs.gravityrail.com/sdk/type-aliases/EnhancedAuthHandler.md) * [EventRule](https://docs.gravityrail.com/sdk/type-aliases/EventRule.md) * [EventRuleResponse](https://docs.gravityrail.com/sdk/type-aliases/EventRuleResponse.md) * [EventRunSortField](https://docs.gravityrail.com/sdk/type-aliases/EventRunSortField.md) * [FeatureStatusValue](https://docs.gravityrail.com/sdk/type-aliases/FeatureStatusValue.md) * [FhirConnection](https://docs.gravityrail.com/sdk/type-aliases/FhirConnection.md) * [FhirConnectionResponse](https://docs.gravityrail.com/sdk/type-aliases/FhirConnectionResponse.md) * [FhirConnectionSortField](https://docs.gravityrail.com/sdk/type-aliases/FhirConnectionSortField.md) * [FhirCsvIdentifierKind](https://docs.gravityrail.com/sdk/type-aliases/FhirCsvIdentifierKind.md) * [FhirCsvImportRowStatus](https://docs.gravityrail.com/sdk/type-aliases/FhirCsvImportRowStatus.md) * [FhirCsvImportRunStatus](https://docs.gravityrail.com/sdk/type-aliases/FhirCsvImportRunStatus.md) * [File](https://docs.gravityrail.com/sdk/type-aliases/File.md) * [FileResponse](https://docs.gravityrail.com/sdk/type-aliases/FileResponse.md) * [FileSharingResponse](https://docs.gravityrail.com/sdk/type-aliases/FileSharingResponse.md) * [FileSortField](https://docs.gravityrail.com/sdk/type-aliases/FileSortField.md) * [FileWithAccessMode](https://docs.gravityrail.com/sdk/type-aliases/FileWithAccessMode.md) * [FirstRunMode](https://docs.gravityrail.com/sdk/type-aliases/FirstRunMode.md) * [FolderSharingResponse](https://docs.gravityrail.com/sdk/type-aliases/FolderSharingResponse.md) * [GeminiThinkingLevel](https://docs.gravityrail.com/sdk/type-aliases/GeminiThinkingLevel.md) * [GmailAbilityConfig](https://docs.gravityrail.com/sdk/type-aliases/GmailAbilityConfig.md) * [GoogleCalendarAbilityConfig](https://docs.gravityrail.com/sdk/type-aliases/GoogleCalendarAbilityConfig.md) * [GoogleDriveAbilityConfig](https://docs.gravityrail.com/sdk/type-aliases/GoogleDriveAbilityConfig.md) * [GoogleWorkspaceAccessMode](https://docs.gravityrail.com/sdk/type-aliases/GoogleWorkspaceAccessMode.md) * [GravityRailWorkspaceClient](https://docs.gravityrail.com/sdk/type-aliases/GravityRailWorkspaceClient.md) * [HubSpotTaskPriority](https://docs.gravityrail.com/sdk/type-aliases/HubSpotTaskPriority.md) * [HubSpotTaskStatus](https://docs.gravityrail.com/sdk/type-aliases/HubSpotTaskStatus.md) * [IdentityConflictPolicy](https://docs.gravityrail.com/sdk/type-aliases/IdentityConflictPolicy.md) * [Inbox](https://docs.gravityrail.com/sdk/type-aliases/Inbox.md) * [InquiryStatus](https://docs.gravityrail.com/sdk/type-aliases/InquiryStatus.md) * [InquiryType](https://docs.gravityrail.com/sdk/type-aliases/InquiryType.md) * [InterruptionSound](https://docs.gravityrail.com/sdk/type-aliases/InterruptionSound.md) * [Invitation](https://docs.gravityrail.com/sdk/type-aliases/Invitation.md) * [InvitationListResponse](https://docs.gravityrail.com/sdk/type-aliases/InvitationListResponse.md) * [InvitationResponse](https://docs.gravityrail.com/sdk/type-aliases/InvitationResponse.md) * [JobPosition](https://docs.gravityrail.com/sdk/type-aliases/JobPosition.md) * [JourneySortField](https://docs.gravityrail.com/sdk/type-aliases/JourneySortField.md) * [ManagedAutomationPriority](https://docs.gravityrail.com/sdk/type-aliases/ManagedAutomationPriority.md) * [ManagedAutomationStatus](https://docs.gravityrail.com/sdk/type-aliases/ManagedAutomationStatus.md) * [MatchStrategyMode](https://docs.gravityrail.com/sdk/type-aliases/MatchStrategyMode.md) * [McpServerSortField](https://docs.gravityrail.com/sdk/type-aliases/McpServerSortField.md) * [MemberFilterFilterType](https://docs.gravityrail.com/sdk/type-aliases/MemberFilterFilterType.md) * [MemberFilterObjectType](https://docs.gravityrail.com/sdk/type-aliases/MemberFilterObjectType.md) * [MemberFilterWithQuery](https://docs.gravityrail.com/sdk/type-aliases/MemberFilterWithQuery.md) * [MemberImportMatchInfoMatchType](https://docs.gravityrail.com/sdk/type-aliases/MemberImportMatchInfoMatchType.md) * [MemberImportPreviewRowAction](https://docs.gravityrail.com/sdk/type-aliases/MemberImportPreviewRowAction.md) * [MemberMemoriesResponse](https://docs.gravityrail.com/sdk/type-aliases/MemberMemoriesResponse.md) * [MemberSortField](https://docs.gravityrail.com/sdk/type-aliases/MemberSortField.md) * [MemberUpsertBehavior](https://docs.gravityrail.com/sdk/type-aliases/MemberUpsertBehavior.md) * [MemoryItem](https://docs.gravityrail.com/sdk/type-aliases/MemoryItem.md) * [MemoryResponse](https://docs.gravityrail.com/sdk/type-aliases/MemoryResponse.md) * [MemoryType](https://docs.gravityrail.com/sdk/type-aliases/MemoryType.md) * [MenuItemResponseItemType](https://docs.gravityrail.com/sdk/type-aliases/MenuItemResponseItemType.md) * [MessageContentPart](https://docs.gravityrail.com/sdk/type-aliases/MessageContentPart.md) * [MessageRole](https://docs.gravityrail.com/sdk/type-aliases/MessageRole.md) * [MetricSection](https://docs.gravityrail.com/sdk/type-aliases/MetricSection.md) * [MetricSummary](https://docs.gravityrail.com/sdk/type-aliases/MetricSummary.md) * [MilestoneFormData](https://docs.gravityrail.com/sdk/type-aliases/MilestoneFormData.md) * [MilestoneGoal](https://docs.gravityrail.com/sdk/type-aliases/MilestoneGoal.md) * [MilestoneGoalFormData](https://docs.gravityrail.com/sdk/type-aliases/MilestoneGoalFormData.md) * [MilestoneGoalResponse](https://docs.gravityrail.com/sdk/type-aliases/MilestoneGoalResponse.md) * [MilestoneSortField](https://docs.gravityrail.com/sdk/type-aliases/MilestoneSortField.md) * [ModelProvider](https://docs.gravityrail.com/sdk/type-aliases/ModelProvider.md) * [ModelState](https://docs.gravityrail.com/sdk/type-aliases/ModelState.md) * [ModelType](https://docs.gravityrail.com/sdk/type-aliases/ModelType.md) * [MondayLookupType](https://docs.gravityrail.com/sdk/type-aliases/MondayLookupType.md) * [MondayUpsertMode](https://docs.gravityrail.com/sdk/type-aliases/MondayUpsertMode.md) * [MultiMatchBehavior](https://docs.gravityrail.com/sdk/type-aliases/MultiMatchBehavior.md) * [OAuthProviderSlug](https://docs.gravityrail.com/sdk/type-aliases/OAuthProviderSlug.md) * [ObjectPermission](https://docs.gravityrail.com/sdk/type-aliases/ObjectPermission.md) * [OIDCAdminConfigViewProviderType](https://docs.gravityrail.com/sdk/type-aliases/OIDCAdminConfigViewProviderType.md) * [OpenAIReasoningEffort](https://docs.gravityrail.com/sdk/type-aliases/OpenAIReasoningEffort.md) * [OpenAISemanticVADEagerness](https://docs.gravityrail.com/sdk/type-aliases/OpenAISemanticVADEagerness.md) * [OpenAITurnDetection](https://docs.gravityrail.com/sdk/type-aliases/OpenAITurnDetection.md) * [OpenAITurnDetectionType](https://docs.gravityrail.com/sdk/type-aliases/OpenAITurnDetectionType.md) * [OperatorGroup](https://docs.gravityrail.com/sdk/type-aliases/OperatorGroup.md) * [OperatorGroupResponse](https://docs.gravityrail.com/sdk/type-aliases/OperatorGroupResponse.md) * [OperatorLiveStatus](https://docs.gravityrail.com/sdk/type-aliases/OperatorLiveStatus.md) * [OrgAuthHandler](https://docs.gravityrail.com/sdk/type-aliases/OrgAuthHandler.md) * [OrgDomain](https://docs.gravityrail.com/sdk/type-aliases/OrgDomain.md) * [OrgDomainCapabilityStatus](https://docs.gravityrail.com/sdk/type-aliases/OrgDomainCapabilityStatus.md) * [OrgDomainDnsRecordStatus](https://docs.gravityrail.com/sdk/type-aliases/OrgDomainDnsRecordStatus.md) * [OrgDomainListResponse](https://docs.gravityrail.com/sdk/type-aliases/OrgDomainListResponse.md) * [OrgDomainOwnershipStatus](https://docs.gravityrail.com/sdk/type-aliases/OrgDomainOwnershipStatus.md) * [OrgDomainResponse](https://docs.gravityrail.com/sdk/type-aliases/OrgDomainResponse.md) * [OrgMemberRole](https://docs.gravityrail.com/sdk/type-aliases/OrgMemberRole.md) * [OwnershipDnsRecord](https://docs.gravityrail.com/sdk/type-aliases/OwnershipDnsRecord.md) * [PageSortField](https://docs.gravityrail.com/sdk/type-aliases/PageSortField.md) * [Persona](https://docs.gravityrail.com/sdk/type-aliases/Persona.md) * [PersonaResponse](https://docs.gravityrail.com/sdk/type-aliases/PersonaResponse.md) * [PidsDisposition](https://docs.gravityrail.com/sdk/type-aliases/PidsDisposition.md) * [PidsSource](https://docs.gravityrail.com/sdk/type-aliases/PidsSource.md) * [PresenceClientMessage](https://docs.gravityrail.com/sdk/type-aliases/PresenceClientMessage.md) * [PresenceServerMessage](https://docs.gravityrail.com/sdk/type-aliases/PresenceServerMessage.md) * [Product](https://docs.gravityrail.com/sdk/type-aliases/Product.md) * [ProductFeatureKey](https://docs.gravityrail.com/sdk/type-aliases/ProductFeatureKey.md) * [ProductLimits](https://docs.gravityrail.com/sdk/type-aliases/ProductLimits.md) * [ProductPlans](https://docs.gravityrail.com/sdk/type-aliases/ProductPlans.md) * [QualificationSortField](https://docs.gravityrail.com/sdk/type-aliases/QualificationSortField.md) * [QueryAggregateOp](https://docs.gravityrail.com/sdk/type-aliases/QueryAggregateOp.md) * [QueryComparisonOp](https://docs.gravityrail.com/sdk/type-aliases/QueryComparisonOp.md) * [QueryEntityType](https://docs.gravityrail.com/sdk/type-aliases/QueryEntityType.md) * [QueryPredicate](https://docs.gravityrail.com/sdk/type-aliases/QueryPredicate.md) * [QueryRangeBound](https://docs.gravityrail.com/sdk/type-aliases/QueryRangeBound.md) * [QueryRunMode](https://docs.gravityrail.com/sdk/type-aliases/QueryRunMode.md) * [QueryScalar](https://docs.gravityrail.com/sdk/type-aliases/QueryScalar.md) * [QueryTemporalValue](https://docs.gravityrail.com/sdk/type-aliases/QueryTemporalValue.md) * [QueryValue](https://docs.gravityrail.com/sdk/type-aliases/QueryValue.md) * [RealtimeAIModel](https://docs.gravityrail.com/sdk/type-aliases/RealtimeAIModel.md) * [RealtimeModelConfig](https://docs.gravityrail.com/sdk/type-aliases/RealtimeModelConfig.md) * [Region](https://docs.gravityrail.com/sdk/type-aliases/Region.md) * [RegistrationIdentifier](https://docs.gravityrail.com/sdk/type-aliases/RegistrationIdentifier.md) * [RequestsSection](https://docs.gravityrail.com/sdk/type-aliases/RequestsSection.md) * [RequestsStatusEntry](https://docs.gravityrail.com/sdk/type-aliases/RequestsStatusEntry.md) * [ResellerAbilityConfig](https://docs.gravityrail.com/sdk/type-aliases/ResellerAbilityConfig.md) * [ResourceScope](https://docs.gravityrail.com/sdk/type-aliases/ResourceScope.md) * [Routine](https://docs.gravityrail.com/sdk/type-aliases/Routine.md) * [RoutineRunStatus](https://docs.gravityrail.com/sdk/type-aliases/RoutineRunStatus.md) * [RoutineScheduleMode](https://docs.gravityrail.com/sdk/type-aliases/RoutineScheduleMode.md) * [RoutineSortField](https://docs.gravityrail.com/sdk/type-aliases/RoutineSortField.md) * [RoutineVisibility](https://docs.gravityrail.com/sdk/type-aliases/RoutineVisibility.md) * [RoutingStrategy](https://docs.gravityrail.com/sdk/type-aliases/RoutingStrategy.md) * [RuleExecutionSortField](https://docs.gravityrail.com/sdk/type-aliases/RuleExecutionSortField.md) * [RuleExecutionStatus](https://docs.gravityrail.com/sdk/type-aliases/RuleExecutionStatus.md) * [SalesforceLabelSyncMode](https://docs.gravityrail.com/sdk/type-aliases/SalesforceLabelSyncMode.md) * [SalesforceSearchObjectType](https://docs.gravityrail.com/sdk/type-aliases/SalesforceSearchObjectType.md) * [SalesforceSyncConfig](https://docs.gravityrail.com/sdk/type-aliases/SalesforceSyncConfig.md) * [Scenario](https://docs.gravityrail.com/sdk/type-aliases/Scenario.md) * [ScenarioCriterion](https://docs.gravityrail.com/sdk/type-aliases/ScenarioCriterion.md) * [ScenarioCriterionResponse](https://docs.gravityrail.com/sdk/type-aliases/ScenarioCriterionResponse.md) * [ScenarioResponse](https://docs.gravityrail.com/sdk/type-aliases/ScenarioResponse.md) * [ScopeName](https://docs.gravityrail.com/sdk/type-aliases/ScopeName.md) * [SendWhatsAppAbilityConfig](https://docs.gravityrail.com/sdk/type-aliases/SendWhatsAppAbilityConfig.md) * [Site](https://docs.gravityrail.com/sdk/type-aliases/Site.md) * [SiteDisableResponse](https://docs.gravityrail.com/sdk/type-aliases/SiteDisableResponse.md) * [SiteDnsRecord](https://docs.gravityrail.com/sdk/type-aliases/SiteDnsRecord.md) * [SiteDnsRecordType](https://docs.gravityrail.com/sdk/type-aliases/SiteDnsRecordType.md) * [SiteDomainConfig](https://docs.gravityrail.com/sdk/type-aliases/SiteDomainConfig.md) * [SiteDomainConfigGetResponse](https://docs.gravityrail.com/sdk/type-aliases/SiteDomainConfigGetResponse.md) * [SiteMapping](https://docs.gravityrail.com/sdk/type-aliases/SiteMapping.md) * [SiteResponse](https://docs.gravityrail.com/sdk/type-aliases/SiteResponse.md) * [SiteSortField](https://docs.gravityrail.com/sdk/type-aliases/SiteSortField.md) * [SlackApp](https://docs.gravityrail.com/sdk/type-aliases/SlackApp.md) * [SlackAppResponse](https://docs.gravityrail.com/sdk/type-aliases/SlackAppResponse.md) * [SlackAppSortField](https://docs.gravityrail.com/sdk/type-aliases/SlackAppSortField.md) * [SlackRespondMode](https://docs.gravityrail.com/sdk/type-aliases/SlackRespondMode.md) * [SMSDeliveryFailureStatus](https://docs.gravityrail.com/sdk/type-aliases/SMSDeliveryFailureStatus.md) * [SMSDeliveryStatus](https://docs.gravityrail.com/sdk/type-aliases/SMSDeliveryStatus.md) * [SortOrder](https://docs.gravityrail.com/sdk/type-aliases/SortOrder.md) * [STTAIModel](https://docs.gravityrail.com/sdk/type-aliases/STTAIModel.md) * [Subscription](https://docs.gravityrail.com/sdk/type-aliases/Subscription.md) * [SyncEntityType](https://docs.gravityrail.com/sdk/type-aliases/SyncEntityType.md) * [SyncRuleInboundTargetType](https://docs.gravityrail.com/sdk/type-aliases/SyncRuleInboundTargetType.md) * [SyncRunMode](https://docs.gravityrail.com/sdk/type-aliases/SyncRunMode.md) * [Task](https://docs.gravityrail.com/sdk/type-aliases/Task.md) * [TaskResponse](https://docs.gravityrail.com/sdk/type-aliases/TaskResponse.md) * [TaskSortField](https://docs.gravityrail.com/sdk/type-aliases/TaskSortField.md) * [TeamsAppSortField](https://docs.gravityrail.com/sdk/type-aliases/TeamsAppSortField.md) * [TeamsConversation](https://docs.gravityrail.com/sdk/type-aliases/TeamsConversation.md) * [TeamsConversationResponse](https://docs.gravityrail.com/sdk/type-aliases/TeamsConversationResponse.md) * [TeamsConversationType](https://docs.gravityrail.com/sdk/type-aliases/TeamsConversationType.md) * [TeamsRespondMode](https://docs.gravityrail.com/sdk/type-aliases/TeamsRespondMode.md) * [ThemeFeaturesDarkMode](https://docs.gravityrail.com/sdk/type-aliases/ThemeFeaturesDarkMode.md) * [ThemeFeaturesDarkMode](https://docs.gravityrail.com/sdk/type-aliases/ThemeFeaturesDarkMode-1.md) * [ThemeName](https://docs.gravityrail.com/sdk/type-aliases/ThemeName.md) * [ThemeSettingFieldType](https://docs.gravityrail.com/sdk/type-aliases/ThemeSettingFieldType.md) * [ThemeSettingFieldType](https://docs.gravityrail.com/sdk/type-aliases/ThemeSettingFieldType-1.md) * [ThinkingSound](https://docs.gravityrail.com/sdk/type-aliases/ThinkingSound.md) * [TodoStatus](https://docs.gravityrail.com/sdk/type-aliases/TodoStatus.md) * [ToolType](https://docs.gravityrail.com/sdk/type-aliases/ToolType.md) * [TruncationReason](https://docs.gravityrail.com/sdk/type-aliases/TruncationReason.md) * [TTSAIModel](https://docs.gravityrail.com/sdk/type-aliases/TTSAIModel.md) * [TTSModel](https://docs.gravityrail.com/sdk/type-aliases/TTSModel.md) * [TTSPreviewProvider](https://docs.gravityrail.com/sdk/type-aliases/TTSPreviewProvider.md) * [TtsReconnectOutcomeEntry](https://docs.gravityrail.com/sdk/type-aliases/TtsReconnectOutcomeEntry.md) * [TtsReconnectSection](https://docs.gravityrail.com/sdk/type-aliases/TtsReconnectSection.md) * [TwoFactorMethod](https://docs.gravityrail.com/sdk/type-aliases/TwoFactorMethod.md) * [TwoFactorStatus](https://docs.gravityrail.com/sdk/type-aliases/TwoFactorStatus.md) * [UpdateInquiryRequest](https://docs.gravityrail.com/sdk/type-aliases/UpdateInquiryRequest.md) * [UploadFileData](https://docs.gravityrail.com/sdk/type-aliases/UploadFileData.md) * [UsageDashboardResponse](https://docs.gravityrail.com/sdk/type-aliases/UsageDashboardResponse.md) * [VoiceMetricsResponse](https://docs.gravityrail.com/sdk/type-aliases/VoiceMetricsResponse.md) * [VoiceModel](https://docs.gravityrail.com/sdk/type-aliases/VoiceModel.md) * [VoiceModelResponse](https://docs.gravityrail.com/sdk/type-aliases/VoiceModelResponse.md) * [VoiceModelsResponse](https://docs.gravityrail.com/sdk/type-aliases/VoiceModelsResponse.md) * [WebhookLogSortField](https://docs.gravityrail.com/sdk/type-aliases/WebhookLogSortField.md) * [Workflow](https://docs.gravityrail.com/sdk/type-aliases/Workflow.md) * [WorkflowAccessWarningResourceType](https://docs.gravityrail.com/sdk/type-aliases/WorkflowAccessWarningResourceType.md) * [WorkflowResponse](https://docs.gravityrail.com/sdk/type-aliases/WorkflowResponse.md) * [WorkflowSortField](https://docs.gravityrail.com/sdk/type-aliases/WorkflowSortField.md) * [WorkspaceGrantReason](https://docs.gravityrail.com/sdk/type-aliases/WorkspaceGrantReason.md) * [WorkspaceHealthResponse](https://docs.gravityrail.com/sdk/type-aliases/WorkspaceHealthResponse.md) * [WorkspaceSortField](https://docs.gravityrail.com/sdk/type-aliases/WorkspaceSortField.md) * [XAIReasoningEffort](https://docs.gravityrail.com/sdk/type-aliases/XAIReasoningEffort.md) ## Variables[​](#variables "Direct link to Variables") * [AbilityConfigIssueCode](https://docs.gravityrail.com/sdk/variables/AbilityConfigIssueCode.md) * [AbilityConfigIssueSeverity](https://docs.gravityrail.com/sdk/variables/AbilityConfigIssueSeverity.md) * [AbilityTypeSlugs](https://docs.gravityrail.com/sdk/variables/AbilityTypeSlugs.md) * [BUILTIN\_ASSISTANT\_CHAT\_TYPES](https://docs.gravityrail.com/sdk/variables/BUILTIN_ASSISTANT_CHAT_TYPES.md) * [BulkMemberResultStatus](https://docs.gravityrail.com/sdk/variables/BulkMemberResultStatus.md) * [BusinessIndustry](https://docs.gravityrail.com/sdk/variables/BusinessIndustry.md) * [BusinessType](https://docs.gravityrail.com/sdk/variables/BusinessType.md) * [CHAT\_TYPES](https://docs.gravityrail.com/sdk/variables/CHAT_TYPES.md) * [DataRecordRetirementResponseReason](https://docs.gravityrail.com/sdk/variables/DataRecordRetirementResponseReason.md) * [DEFAULT\_CHAT\_MODEL](https://docs.gravityrail.com/sdk/variables/DEFAULT_CHAT_MODEL.md) * [DEFAULT\_CUSTOM\_VOICE\_MODEL](https://docs.gravityrail.com/sdk/variables/DEFAULT_CUSTOM_VOICE_MODEL.md) * [DEFAULT\_THINKING\_SPEECH\_PHRASES](https://docs.gravityrail.com/sdk/variables/DEFAULT_THINKING_SPEECH_PHRASES.md) * [DEFAULT\_VOICE\_INFERENCE\_MODEL](https://docs.gravityrail.com/sdk/variables/DEFAULT_VOICE_INFERENCE_MODEL.md) * [EmailDnsRecordType](https://docs.gravityrail.com/sdk/variables/EmailDnsRecordType.md) * [JobPosition](https://docs.gravityrail.com/sdk/variables/JobPosition.md) * [MASKED\_SECRET\_SENTINEL](https://docs.gravityrail.com/sdk/variables/MASKED_SECRET_SENTINEL.md) * [MemberImportMatchInfoMatchType](https://docs.gravityrail.com/sdk/variables/MemberImportMatchInfoMatchType.md) * [MemberImportPreviewRowAction](https://docs.gravityrail.com/sdk/variables/MemberImportPreviewRowAction.md) * [MenuItemResponseItemType](https://docs.gravityrail.com/sdk/variables/MenuItemResponseItemType.md) * [ModelProvider](https://docs.gravityrail.com/sdk/variables/ModelProvider.md) * [ModelType](https://docs.gravityrail.com/sdk/variables/ModelType.md) * [NO\_ASSISTANT\_PARTICIPANT\_CHAT\_TYPES](https://docs.gravityrail.com/sdk/variables/NO_ASSISTANT_PARTICIPANT_CHAT_TYPES.md) * [OIDCAdminConfigViewProviderType](https://docs.gravityrail.com/sdk/variables/OIDCAdminConfigViewProviderType.md) * [ORG\_ONLY\_RESOURCES](https://docs.gravityrail.com/sdk/variables/ORG_ONLY_RESOURCES.md) * [PERMISSION\_ADMIN](https://docs.gravityrail.com/sdk/variables/PERMISSION_ADMIN.md) * [PERMISSION\_CREATE](https://docs.gravityrail.com/sdk/variables/PERMISSION_CREATE.md) * [PERMISSION\_DELETE](https://docs.gravityrail.com/sdk/variables/PERMISSION_DELETE.md) * [PERMISSION\_EDIT](https://docs.gravityrail.com/sdk/variables/PERMISSION_EDIT.md) * [PERMISSION\_GEOLOCATE](https://docs.gravityrail.com/sdk/variables/PERMISSION_GEOLOCATE.md) * [PERMISSION\_LIST](https://docs.gravityrail.com/sdk/variables/PERMISSION_LIST.md) * [PERMISSION\_LIST\_ALL](https://docs.gravityrail.com/sdk/variables/PERMISSION_LIST_ALL.md) * [PERMISSION\_NONE](https://docs.gravityrail.com/sdk/variables/PERMISSION_NONE.md) * [PERMISSION\_USE](https://docs.gravityrail.com/sdk/variables/PERMISSION_USE.md) * [PERMISSION\_VERIFY](https://docs.gravityrail.com/sdk/variables/PERMISSION_VERIFY.md) * [PIDS\_DISPOSITIONS](https://docs.gravityrail.com/sdk/variables/PIDS_DISPOSITIONS.md) * [PIDS\_SOURCES](https://docs.gravityrail.com/sdk/variables/PIDS_SOURCES.md) * [QUERY\_VALUELESS\_OPS](https://docs.gravityrail.com/sdk/variables/QUERY_VALUELESS_OPS.md) * [REALTIME\_MODEL\_CUSTOM](https://docs.gravityrail.com/sdk/variables/REALTIME_MODEL_CUSTOM.md) * [REALTIME\_MODEL\_GEMINI](https://docs.gravityrail.com/sdk/variables/REALTIME_MODEL_GEMINI.md) * [REALTIME\_MODEL\_GEMINI\_VERTEX](https://docs.gravityrail.com/sdk/variables/REALTIME_MODEL_GEMINI_VERTEX.md) * [REALTIME\_MODEL\_NOVA\_SONIC](https://docs.gravityrail.com/sdk/variables/REALTIME_MODEL_NOVA_SONIC.md) * [REALTIME\_MODEL\_OPENAI](https://docs.gravityrail.com/sdk/variables/REALTIME_MODEL_OPENAI.md) * [REALTIME\_MODEL\_OPENAI\_2](https://docs.gravityrail.com/sdk/variables/REALTIME_MODEL_OPENAI_2.md) * [REALTIME\_MODEL\_OPENAI\_MINI](https://docs.gravityrail.com/sdk/variables/REALTIME_MODEL_OPENAI_MINI.md) * [Region](https://docs.gravityrail.com/sdk/variables/Region.md) * [RegistrationIdentifier](https://docs.gravityrail.com/sdk/variables/RegistrationIdentifier.md) * [SCOPE\_PRESETS](https://docs.gravityrail.com/sdk/variables/SCOPE_PRESETS.md) * [SCOPES](https://docs.gravityrail.com/sdk/variables/SCOPES.md) * [SiteDnsRecordType](https://docs.gravityrail.com/sdk/variables/SiteDnsRecordType.md) * [SMS\_DELIVERY\_FAILURE\_STATUSES](https://docs.gravityrail.com/sdk/variables/SMS_DELIVERY_FAILURE_STATUSES.md) * [STT\_MODEL\_DEEPGRAM\_FLUX](https://docs.gravityrail.com/sdk/variables/STT_MODEL_DEEPGRAM_FLUX.md) * [STT\_MODEL\_DEEPGRAM\_FLUX\_MULTI](https://docs.gravityrail.com/sdk/variables/STT_MODEL_DEEPGRAM_FLUX_MULTI.md) * [STT\_MODEL\_ELEVENLABS\_SCRIBE](https://docs.gravityrail.com/sdk/variables/STT_MODEL_ELEVENLABS_SCRIBE.md) * [TTS\_MODEL\_AWS\_POLLY\_GENERATIVE](https://docs.gravityrail.com/sdk/variables/TTS_MODEL_AWS_POLLY_GENERATIVE.md) * [TTS\_MODEL\_AWS\_POLLY\_NEURAL](https://docs.gravityrail.com/sdk/variables/TTS_MODEL_AWS_POLLY_NEURAL.md) * [TTS\_MODEL\_DEEPGRAM\_AURA\_2](https://docs.gravityrail.com/sdk/variables/TTS_MODEL_DEEPGRAM_AURA_2.md) * [TTS\_MODEL\_ELEVENLABS\_FLASH](https://docs.gravityrail.com/sdk/variables/TTS_MODEL_ELEVENLABS_FLASH.md) * [TTS\_MODEL\_ELEVENLABS\_MULTILINGUAL](https://docs.gravityrail.com/sdk/variables/TTS_MODEL_ELEVENLABS_MULTILINGUAL.md) * [TTS\_MODEL\_ELEVENLABS\_TURBO](https://docs.gravityrail.com/sdk/variables/TTS_MODEL_ELEVENLABS_TURBO.md) * [TTS\_PREVIEW\_PROVIDERS](https://docs.gravityrail.com/sdk/variables/TTS_PREVIEW_PROVIDERS.md) * [WorkflowAccessWarningResourceType](https://docs.gravityrail.com/sdk/variables/WorkflowAccessWarningResourceType.md) ## Functions[​](#functions "Direct link to Functions") * [areDependenciesSatisfied](https://docs.gravityrail.com/sdk/functions/areDependenciesSatisfied.md) * [canPreviewVoice](https://docs.gravityrail.com/sdk/functions/canPreviewVoice.md) * [clearRegistry](https://docs.gravityrail.com/sdk/functions/clearRegistry.md) * [createWorkspaceClient](https://docs.gravityrail.com/sdk/functions/createWorkspaceClient.md) * [decodePermissions](https://docs.gravityrail.com/sdk/functions/decodePermissions.md) * [encodePermissions](https://docs.gravityrail.com/sdk/functions/encodePermissions.md) * [eventRuleActionParams](https://docs.gravityrail.com/sdk/functions/eventRuleActionParams.md) * [formatAppContextAsMarkdown](https://docs.gravityrail.com/sdk/functions/formatAppContextAsMarkdown.md) * [getAllFeatures](https://docs.gravityrail.com/sdk/functions/getAllFeatures.md) * [getAllResourceSlugs](https://docs.gravityrail.com/sdk/functions/getAllResourceSlugs.md) * [getApplicableResources](https://docs.gravityrail.com/sdk/functions/getApplicableResources.md) * [getApplicableResourceSlugs](https://docs.gravityrail.com/sdk/functions/getApplicableResourceSlugs.md) * [getAvailableFeaturesForUpgrade](https://docs.gravityrail.com/sdk/functions/getAvailableFeaturesForUpgrade.md) * [getCookieValue](https://docs.gravityrail.com/sdk/functions/getCookieValue.md) * [getFeature](https://docs.gravityrail.com/sdk/functions/getFeature.md) * [getFeaturesByCategory](https://docs.gravityrail.com/sdk/functions/getFeaturesByCategory.md) * [getFeaturesByVisibility](https://docs.gravityrail.com/sdk/functions/getFeaturesByVisibility.md) * [getMissingDependencies](https://docs.gravityrail.com/sdk/functions/getMissingDependencies.md) * [getResourceMetadata](https://docs.gravityrail.com/sdk/functions/getResourceMetadata.md) * [getScopeFromProductType](https://docs.gravityrail.com/sdk/functions/getScopeFromProductType.md) * [getTTSProvider](https://docs.gravityrail.com/sdk/functions/getTTSProvider.md) * [getVoiceModelId](https://docs.gravityrail.com/sdk/functions/getVoiceModelId.md) * [initializeFeatures](https://docs.gravityrail.com/sdk/functions/initializeFeatures.md) * [isChatType](https://docs.gravityrail.com/sdk/functions/isChatType.md) * [isFeatureAvailable](https://docs.gravityrail.com/sdk/functions/isFeatureAvailable.md) * [isRegistryInitialized](https://docs.gravityrail.com/sdk/functions/isRegistryInitialized.md) * [isSMSDeliveryFailureStatus](https://docs.gravityrail.com/sdk/functions/isSMSDeliveryFailureStatus.md) * [requiresAssistantParticipant](https://docs.gravityrail.com/sdk/functions/requiresAssistantParticipant.md) * [runWorkspaceScript](https://docs.gravityrail.com/sdk/functions/runWorkspaceScript.md) * [usesBuiltinAssistant](https://docs.gravityrail.com/sdk/functions/usesBuiltinAssistant.md) * [validateFeatureDependencies](https://docs.gravityrail.com/sdk/functions/validateFeatureDependencies.md) ## References[​](#references "Direct link to References") ### AbilityType[​](#abilitytype "Direct link to AbilityType") Renames and re-exports [AbilityTypeResponse](https://docs.gravityrail.com/sdk/interfaces/AbilityTypeResponse.md) *** ### AddressData[​](#addressdata "Direct link to AddressData") Renames and re-exports [Address](https://docs.gravityrail.com/sdk/interfaces/Address.md) *** ### AdminChat[​](#adminchat "Direct link to AdminChat") Renames and re-exports [AdminChatResponse](https://docs.gravityrail.com/sdk/interfaces/AdminChatResponse.md) *** ### AdminChatDetail[​](#adminchatdetail "Direct link to AdminChatDetail") Renames and re-exports [AdminChatDetailResponse](https://docs.gravityrail.com/sdk/interfaces/AdminChatDetailResponse.md) *** ### AdminPidsFinding[​](#adminpidsfinding "Direct link to AdminPidsFinding") Renames and re-exports [AdminPidsFindingResponse](https://docs.gravityrail.com/sdk/interfaces/AdminPidsFindingResponse.md) *** ### Agent[​](#agent "Direct link to Agent") Renames and re-exports [AgentResponse](https://docs.gravityrail.com/sdk/interfaces/AgentResponse.md) *** ### AgentConfig[​](#agentconfig "Direct link to AgentConfig") Renames and re-exports [AgentConfigResponse](https://docs.gravityrail.com/sdk/interfaces/AgentConfigResponse.md) *** ### AIModel[​](#aimodel "Direct link to AIModel") Renames and re-exports [ModelMetadataResponse](https://docs.gravityrail.com/sdk/interfaces/ModelMetadataResponse.md) *** ### AIModelResponse[​](#aimodelresponse "Direct link to AIModelResponse") Renames and re-exports [ModelMetadataResponse](https://docs.gravityrail.com/sdk/interfaces/ModelMetadataResponse.md) *** ### AIModelUsage[​](#aimodelusage "Direct link to AIModelUsage") Renames and re-exports [AIModelUsageResponse](https://docs.gravityrail.com/sdk/interfaces/AIModelUsageResponse.md) *** ### AIUsageDetails[​](#aiusagedetails "Direct link to AIUsageDetails") Renames and re-exports [AIUsageDetailsResponse](https://docs.gravityrail.com/sdk/interfaces/AIUsageDetailsResponse.md) *** ### AnonymousInteraction[​](#anonymousinteraction "Direct link to AnonymousInteraction") Renames and re-exports [AnonymousInteractionResponse](https://docs.gravityrail.com/sdk/interfaces/AnonymousInteractionResponse.md) *** ### AnonymousMemberResolution[​](#anonymousmemberresolution "Direct link to AnonymousMemberResolution") Renames and re-exports [AnonymousMemberResolutionResponse](https://docs.gravityrail.com/sdk/interfaces/AnonymousMemberResolutionResponse.md) *** ### Assignment[​](#assignment "Direct link to Assignment") Renames and re-exports [AssignmentResponse](https://docs.gravityrail.com/sdk/interfaces/AssignmentResponse.md) *** ### AssignmentTask[​](#assignmenttask "Direct link to AssignmentTask") Renames and re-exports [AssignmentTaskResponse](https://docs.gravityrail.com/sdk/interfaces/AssignmentTaskResponse.md) *** ### Builder[​](#builder "Direct link to Builder") Renames and re-exports [BuilderResponse](https://docs.gravityrail.com/sdk/interfaces/BuilderResponse.md) *** ### CalendarEvent[​](#calendarevent "Direct link to CalendarEvent") Renames and re-exports [EventResponse](https://docs.gravityrail.com/sdk/interfaces/EventResponse.md) *** ### CalendarEventAttendee[​](#calendareventattendee "Direct link to CalendarEventAttendee") Renames and re-exports [AttendeeResponse](https://docs.gravityrail.com/sdk/interfaces/AttendeeResponse.md) *** ### CalendarEventType[​](#calendareventtype "Direct link to CalendarEventType") Renames and re-exports [EventTypeResponse](https://docs.gravityrail.com/sdk/interfaces/EventTypeResponse.md) *** ### CancelBusinessProfileResponse[​](#cancelbusinessprofileresponse "Direct link to CancelBusinessProfileResponse") Renames and re-exports [BusinessProfileCancelResponse](https://docs.gravityrail.com/sdk/interfaces/BusinessProfileCancelResponse.md) *** ### Chat[​](#chat "Direct link to Chat") Renames and re-exports [ChatResponse](https://docs.gravityrail.com/sdk/interfaces/ChatResponse.md) *** ### ChatFilter[​](#chatfilter "Direct link to ChatFilter") Renames and re-exports [ChatFilterResponse](https://docs.gravityrail.com/sdk/interfaces/ChatFilterResponse.md) *** ### ChatFilterRule[​](#chatfilterrule "Direct link to ChatFilterRule") Renames and re-exports [ChatFilterRuleResponse](https://docs.gravityrail.com/sdk/interfaces/ChatFilterRuleResponse.md) *** ### ChatLabel[​](#chatlabel "Direct link to ChatLabel") Renames and re-exports [ChatLabelResponse](https://docs.gravityrail.com/sdk/interfaces/ChatLabelResponse.md) *** ### ChatParticipant[​](#chatparticipant "Direct link to ChatParticipant") Renames and re-exports [ChatParticipantResponse](https://docs.gravityrail.com/sdk/interfaces/ChatParticipantResponse.md) *** ### ChatTokenUsage[​](#chattokenusage "Direct link to ChatTokenUsage") Renames and re-exports [ChatTokenUsageResponse](https://docs.gravityrail.com/sdk/interfaces/ChatTokenUsageResponse.md) *** ### ChildTask[​](#childtask "Direct link to ChildTask") Renames and re-exports [ChildTaskResponse](https://docs.gravityrail.com/sdk/interfaces/ChildTaskResponse.md) *** ### CommunicationDetails[​](#communicationdetails "Direct link to CommunicationDetails") Renames and re-exports [CommunicationDetailsResponse](https://docs.gravityrail.com/sdk/interfaces/CommunicationDetailsResponse.md) *** ### CriterionResult[​](#criterionresult "Direct link to CriterionResult") Renames and re-exports [CriterionResultResponse](https://docs.gravityrail.com/sdk/interfaces/CriterionResultResponse.md) *** ### CurrentMember[​](#currentmember "Direct link to CurrentMember") Renames and re-exports [CurrentMemberResponse](https://docs.gravityrail.com/sdk/interfaces/CurrentMemberResponse.md) *** ### DailyPhoneRow[​](#dailyphonerow "Direct link to DailyPhoneRow") Renames and re-exports [DailyPhoneRowResponse](https://docs.gravityrail.com/sdk/interfaces/DailyPhoneRowResponse.md) *** ### DailySMSRow[​](#dailysmsrow "Direct link to DailySMSRow") Renames and re-exports [DailySMSRowResponse](https://docs.gravityrail.com/sdk/interfaces/DailySMSRowResponse.md) *** ### DataRecord[​](#datarecord "Direct link to DataRecord") Renames and re-exports [DataRecordResponse](https://docs.gravityrail.com/sdk/interfaces/DataRecordResponse.md) *** ### DataRecordUpdate[​](#datarecordupdate "Direct link to DataRecordUpdate") Renames and re-exports [DataRecordUpdateResponse](https://docs.gravityrail.com/sdk/interfaces/DataRecordUpdateResponse.md) *** ### DataType[​](#datatype "Direct link to DataType") Renames and re-exports [DataTypeResponse](https://docs.gravityrail.com/sdk/interfaces/DataTypeResponse.md) *** ### EfficiencyMetrics[​](#efficiencymetrics "Direct link to EfficiencyMetrics") Renames and re-exports [EfficiencyMetricsResponse](https://docs.gravityrail.com/sdk/interfaces/EfficiencyMetricsResponse.md) *** ### EmailUsage[​](#emailusage "Direct link to EmailUsage") Renames and re-exports [EmailUsageResponse](https://docs.gravityrail.com/sdk/interfaces/EmailUsageResponse.md) *** ### EncounterSyncStatus[​](#encountersyncstatus "Direct link to EncounterSyncStatus") Renames and re-exports [EncounterSyncStatusResponse](https://docs.gravityrail.com/sdk/interfaces/EncounterSyncStatusResponse.md) *** ### FileConversionResponse[​](#fileconversionresponse "Direct link to FileConversionResponse") Renames and re-exports [ConvertedFileResponse](https://docs.gravityrail.com/sdk/interfaces/ConvertedFileResponse.md) *** ### FileFolder[​](#filefolder "Direct link to FileFolder") Renames and re-exports [FileFolderResponse](https://docs.gravityrail.com/sdk/interfaces/FileFolderResponse.md) *** ### FileLabel[​](#filelabel "Direct link to FileLabel") Renames and re-exports [FileLabelResponse](https://docs.gravityrail.com/sdk/interfaces/FileLabelResponse.md) *** ### FolderSearchResult[​](#foldersearchresult "Direct link to FolderSearchResult") Renames and re-exports [FolderSearchResultResponse](https://docs.gravityrail.com/sdk/interfaces/FolderSearchResultResponse.md) *** ### Inquiry[​](#inquiry "Direct link to Inquiry") Renames and re-exports [InquiryResponse](https://docs.gravityrail.com/sdk/interfaces/InquiryResponse.md) *** ### LibModelsGlbResponsesOrganizationResponsesSSOConfigResponse[​](#libmodelsglbresponsesorganizationresponsesssoconfigresponse "Direct link to LibModelsGlbResponsesOrganizationResponsesSSOConfigResponse") Renames and re-exports [SSOConfig](https://docs.gravityrail.com/sdk/interfaces/SSOConfig.md) *** ### LiveOperator[​](#liveoperator "Direct link to LiveOperator") Renames and re-exports [LiveOperatorEntry](https://docs.gravityrail.com/sdk/interfaces/LiveOperatorEntry.md) *** ### McpServer[​](#mcpserver "Direct link to McpServer") Renames and re-exports [McpServerResponse](https://docs.gravityrail.com/sdk/interfaces/McpServerResponse.md) *** ### McpTool[​](#mcptool "Direct link to McpTool") Renames and re-exports [McpToolResponse](https://docs.gravityrail.com/sdk/interfaces/McpToolResponse.md) *** ### Member[​](#member "Direct link to Member") Renames and re-exports [WorkspaceMemberResponse](https://docs.gravityrail.com/sdk/interfaces/WorkspaceMemberResponse.md) *** ### MemberCredentialResponse[​](#membercredentialresponse "Direct link to MemberCredentialResponse") Renames and re-exports [MemberCredential](https://docs.gravityrail.com/sdk/interfaces/MemberCredential.md) *** ### MemberField[​](#memberfield "Direct link to MemberField") Renames and re-exports [MemberFieldResponse](https://docs.gravityrail.com/sdk/interfaces/MemberFieldResponse.md) *** ### MemberFieldDefinition[​](#memberfielddefinition "Direct link to MemberFieldDefinition") Renames and re-exports [MemberFieldDefinitionResponse](https://docs.gravityrail.com/sdk/interfaces/MemberFieldDefinitionResponse.md) *** ### MemberFilter[​](#memberfilter "Direct link to MemberFilter") Renames and re-exports [MemberFilterResponse](https://docs.gravityrail.com/sdk/interfaces/MemberFilterResponse.md) *** ### MemberFilterRule[​](#memberfilterrule "Direct link to MemberFilterRule") Renames and re-exports [MemberFilterRuleResponse](https://docs.gravityrail.com/sdk/interfaces/MemberFilterRuleResponse.md) *** ### MemberLabel[​](#memberlabel "Direct link to MemberLabel") Renames and re-exports [MemberLabelResponse](https://docs.gravityrail.com/sdk/interfaces/MemberLabelResponse.md) *** ### MemberRole[​](#memberrole "Direct link to MemberRole") Renames and re-exports [MemberRoleResponse](https://docs.gravityrail.com/sdk/interfaces/MemberRoleResponse.md) *** ### MemberRoleCalendarAccess[​](#memberrolecalendaraccess "Direct link to MemberRoleCalendarAccess") Renames and re-exports [MemberRoleCalendarAccessResponse](https://docs.gravityrail.com/sdk/interfaces/MemberRoleCalendarAccessResponse.md) *** ### MemberRoleDataTypeAccess[​](#memberroledatatypeaccess "Direct link to MemberRoleDataTypeAccess") Renames and re-exports [MemberRoleDataTypeAccessResponse](https://docs.gravityrail.com/sdk/interfaces/MemberRoleDataTypeAccessResponse.md) *** ### MemberRoleFileAccess[​](#memberrolefileaccess "Direct link to MemberRoleFileAccess") Renames and re-exports [MemberRoleFileAccessResponse](https://docs.gravityrail.com/sdk/interfaces/MemberRoleFileAccessResponse.md) *** ### MemberRoleFolderAccess[​](#memberrolefolderaccess "Direct link to MemberRoleFolderAccess") Renames and re-exports [MemberRoleFolderAccessResponse](https://docs.gravityrail.com/sdk/interfaces/MemberRoleFolderAccessResponse.md) *** ### MemberRoleInboxAccess[​](#memberroleinboxaccess "Direct link to MemberRoleInboxAccess") Renames and re-exports [MemberRoleInboxAccessResponse](https://docs.gravityrail.com/sdk/interfaces/MemberRoleInboxAccessResponse.md) *** ### MemberRoleSiteAccess[​](#memberrolesiteaccess "Direct link to MemberRoleSiteAccess") Renames and re-exports [MemberRoleSiteAccessResponse](https://docs.gravityrail.com/sdk/interfaces/MemberRoleSiteAccessResponse.md) *** ### MemberRoleWorkflowAccess[​](#memberroleworkflowaccess "Direct link to MemberRoleWorkflowAccess") Renames and re-exports [MemberRoleWorkflowAccessResponse](https://docs.gravityrail.com/sdk/interfaces/MemberRoleWorkflowAccessResponse.md) *** ### MenuItem[​](#menuitem "Direct link to MenuItem") Renames and re-exports [MenuItemResponse](https://docs.gravityrail.com/sdk/interfaces/MenuItemResponse.md) *** ### MenuItemType[​](#menuitemtype "Direct link to MenuItemType") Renames and re-exports [MenuItemResponseItemType](https://docs.gravityrail.com/sdk/variables/MenuItemResponseItemType.md) *** ### MenuTree[​](#menutree "Direct link to MenuTree") Renames and re-exports [MenuTreeResponse](https://docs.gravityrail.com/sdk/interfaces/MenuTreeResponse.md) *** ### MessageTokenUsage[​](#messagetokenusage "Direct link to MessageTokenUsage") Renames and re-exports [MessageTokenUsageResponse](https://docs.gravityrail.com/sdk/interfaces/MessageTokenUsageResponse.md) *** ### MilestoneResponse[​](#milestoneresponse "Direct link to MilestoneResponse") Renames and re-exports [Milestone](https://docs.gravityrail.com/sdk/interfaces/Milestone.md) *** ### ModelUsage[​](#modelusage "Direct link to ModelUsage") Renames and re-exports [ModelUsageResponse](https://docs.gravityrail.com/sdk/interfaces/ModelUsageResponse.md) *** ### Notification[​](#notification "Direct link to Notification") Renames and re-exports [NotificationResponse](https://docs.gravityrail.com/sdk/interfaces/NotificationResponse.md) *** ### OperatorGroupMember[​](#operatorgroupmember "Direct link to OperatorGroupMember") Renames and re-exports [OperatorGroupMemberResponse](https://docs.gravityrail.com/sdk/interfaces/OperatorGroupMemberResponse.md) *** ### OrganizationResponse[​](#organizationresponse "Direct link to OrganizationResponse") Renames and re-exports [Organization](https://docs.gravityrail.com/sdk/interfaces/Organization.md) *** ### Page[​](#page "Direct link to Page") Renames and re-exports [PageResponse](https://docs.gravityrail.com/sdk/interfaces/PageResponse.md) *** ### PhoneCallPhoneNumberUsage[​](#phonecallphonenumberusage "Direct link to PhoneCallPhoneNumberUsage") Renames and re-exports [PhoneCallPhoneNumberUsageResponse](https://docs.gravityrail.com/sdk/interfaces/PhoneCallPhoneNumberUsageResponse.md) *** ### PhoneCallUsage[​](#phonecallusage "Direct link to PhoneCallUsage") Renames and re-exports [PhoneCallUsageResponse](https://docs.gravityrail.com/sdk/interfaces/PhoneCallUsageResponse.md) *** ### PhoneCommunicationDetails[​](#phonecommunicationdetails "Direct link to PhoneCommunicationDetails") Renames and re-exports [PhoneCommunicationDetailsResponse](https://docs.gravityrail.com/sdk/interfaces/PhoneCommunicationDetailsResponse.md) *** ### PronunciationEntry[​](#pronunciationentry "Direct link to PronunciationEntry") Renames and re-exports [PronunciationEntryResponse](https://docs.gravityrail.com/sdk/interfaces/PronunciationEntryResponse.md) *** ### Qualification[​](#qualification "Direct link to Qualification") Renames and re-exports [QualificationResponse](https://docs.gravityrail.com/sdk/interfaces/QualificationResponse.md) *** ### RecommendedVoice[​](#recommendedvoice "Direct link to RecommendedVoice") Renames and re-exports [RecommendedVoiceResponse](https://docs.gravityrail.com/sdk/interfaces/RecommendedVoiceResponse.md) *** ### RenderedPage[​](#renderedpage "Direct link to RenderedPage") Renames and re-exports [RenderedPageResponse](https://docs.gravityrail.com/sdk/interfaces/RenderedPageResponse.md) *** ### ResourceUsage[​](#resourceusage "Direct link to ResourceUsage") Renames and re-exports [ResourceUsageResponse](https://docs.gravityrail.com/sdk/interfaces/ResourceUsageResponse.md) *** ### RoutineRun[​](#routinerun "Direct link to RoutineRun") Renames and re-exports [RoutineRunResponse](https://docs.gravityrail.com/sdk/interfaces/RoutineRunResponse.md) *** ### RuleExecution[​](#ruleexecution "Direct link to RuleExecution") Renames and re-exports [RuleExecutionResponse](https://docs.gravityrail.com/sdk/interfaces/RuleExecutionResponse.md) *** ### ScheduledCallback[​](#scheduledcallback "Direct link to ScheduledCallback") Renames and re-exports [ScheduledCallbackResponse](https://docs.gravityrail.com/sdk/interfaces/ScheduledCallbackResponse.md) *** ### SlackSlashCommandConfig[​](#slackslashcommandconfig "Direct link to SlackSlashCommandConfig") Renames and re-exports [SlackSlashCommandConfigResponse](https://docs.gravityrail.com/sdk/interfaces/SlackSlashCommandConfigResponse.md) *** ### SlashCommandConfig[​](#slashcommandconfig "Direct link to SlashCommandConfig") Renames and re-exports [SlashCommandConfigResponse](https://docs.gravityrail.com/sdk/interfaces/SlashCommandConfigResponse.md) *** ### SMSCommunicationDetails[​](#smscommunicationdetails "Direct link to SMSCommunicationDetails") Renames and re-exports [SMSCommunicationDetailsResponse](https://docs.gravityrail.com/sdk/interfaces/SMSCommunicationDetailsResponse.md) *** ### SMSMessageUsage[​](#smsmessageusage "Direct link to SMSMessageUsage") Renames and re-exports [SMSMessageUsageResponse](https://docs.gravityrail.com/sdk/interfaces/SMSMessageUsageResponse.md) *** ### SMSPhoneNumberUsage[​](#smsphonenumberusage "Direct link to SMSPhoneNumberUsage") Renames and re-exports [SMSPhoneNumberUsageResponse](https://docs.gravityrail.com/sdk/interfaces/SMSPhoneNumberUsageResponse.md) *** ### SubmitBusinessProfileResponse[​](#submitbusinessprofileresponse "Direct link to SubmitBusinessProfileResponse") Renames and re-exports [BusinessProfileSubmitResponse](https://docs.gravityrail.com/sdk/interfaces/BusinessProfileSubmitResponse.md) *** ### TaskAssignmentStats[​](#taskassignmentstats "Direct link to TaskAssignmentStats") Renames and re-exports [TaskAssignmentStatsResponse](https://docs.gravityrail.com/sdk/interfaces/TaskAssignmentStatsResponse.md) *** ### TaskChat[​](#taskchat "Direct link to TaskChat") Renames and re-exports [TaskChatResponse](https://docs.gravityrail.com/sdk/interfaces/TaskChatResponse.md) *** ### TeamsAccount[​](#teamsaccount "Direct link to TeamsAccount") Renames and re-exports [TeamsAccountResponse](https://docs.gravityrail.com/sdk/interfaces/TeamsAccountResponse.md) *** ### TeamsApp[​](#teamsapp "Direct link to TeamsApp") Renames and re-exports [TeamsAppResponse](https://docs.gravityrail.com/sdk/interfaces/TeamsAppResponse.md) *** ### TeamsAppInstallation[​](#teamsappinstallation "Direct link to TeamsAppInstallation") Renames and re-exports [TeamsAppInstallationResponse](https://docs.gravityrail.com/sdk/interfaces/TeamsAppInstallationResponse.md) *** ### TeamsCommandConfig[​](#teamscommandconfig "Direct link to TeamsCommandConfig") Renames and re-exports [TeamsCommandConfigResponse](https://docs.gravityrail.com/sdk/interfaces/TeamsCommandConfigResponse.md) *** ### TestChatRun[​](#testchatrun "Direct link to TestChatRun") Renames and re-exports [TestChatRunResponse](https://docs.gravityrail.com/sdk/interfaces/TestChatRunResponse.md) *** ### Theme[​](#theme "Direct link to Theme") Renames and re-exports [ThemeResponse](https://docs.gravityrail.com/sdk/interfaces/ThemeResponse.md) *** ### TipTapDocument[​](#tiptapdocument "Direct link to TipTapDocument") Renames and re-exports [TipTapDocumentOutput](https://docs.gravityrail.com/sdk/interfaces/TipTapDocumentOutput.md) *** ### TodoItem[​](#todoitem "Direct link to TodoItem") Renames and re-exports [TodoItemResponse](https://docs.gravityrail.com/sdk/interfaces/TodoItemResponse.md) *** ### TopResourceOverage[​](#topresourceoverage "Direct link to TopResourceOverage") Renames and re-exports [TopResourceOverageResponse](https://docs.gravityrail.com/sdk/interfaces/TopResourceOverageResponse.md) *** ### UsageProductSummary[​](#usageproductsummary "Direct link to UsageProductSummary") Renames and re-exports [UsageProductSummaryResponse](https://docs.gravityrail.com/sdk/interfaces/UsageProductSummaryResponse.md) *** ### UsageReport[​](#usagereport "Direct link to UsageReport") Renames and re-exports [UsageReportResponse](https://docs.gravityrail.com/sdk/interfaces/UsageReportResponse.md) *** ### VoiceModelUsage[​](#voicemodelusage "Direct link to VoiceModelUsage") Renames and re-exports [VoiceUsageResponse](https://docs.gravityrail.com/sdk/interfaces/VoiceUsageResponse.md) *** ### WebhookLog[​](#webhooklog "Direct link to WebhookLog") Renames and re-exports [WebhookLogResponse](https://docs.gravityrail.com/sdk/interfaces/WebhookLogResponse.md) *** ### WorkflowContributor[​](#workflowcontributor "Direct link to WorkflowContributor") Renames and re-exports [WorkflowContributorResponse](https://docs.gravityrail.com/sdk/interfaces/WorkflowContributorResponse.md) *** ### WorkflowNote[​](#workflownote "Direct link to WorkflowNote") Renames and re-exports [WorkflowNoteResponse](https://docs.gravityrail.com/sdk/interfaces/WorkflowNoteResponse.md) *** ### WorkflowResourceType[​](#workflowresourcetype "Direct link to WorkflowResourceType") Renames and re-exports [WorkflowAccessWarningResourceType](https://docs.gravityrail.com/sdk/variables/WorkflowAccessWarningResourceType.md) *** ### WorkflowStartAutomation[​](#workflowstartautomation "Direct link to WorkflowStartAutomation") Renames and re-exports [WorkflowStartAutomationResponse](https://docs.gravityrail.com/sdk/interfaces/WorkflowStartAutomationResponse.md) *** ### WorkflowTemplate[​](#workflowtemplate "Direct link to WorkflowTemplate") Renames and re-exports [WorkflowTemplateResponse](https://docs.gravityrail.com/sdk/interfaces/WorkflowTemplateResponse.md) *** ### WorkspaceUsageReport[​](#workspaceusagereport "Direct link to WorkspaceUsageReport") Renames and re-exports [WorkspaceUsageReportResponse](https://docs.gravityrail.com/sdk/interfaces/WorkspaceUsageReportResponse.md) --- # Class: AgentBuilder Defined in: [packages/sdk/src/workspace-builder/workflows.ts:293](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/workflows.ts#L293) ## Extends[​](#extends "Direct link to Extends") * `WorkspaceBuilderResource` ## Constructors[​](#constructors "Direct link to Constructors") ### Constructor[​](#constructor "Direct link to Constructor") > **new AgentBuilder**(`name`, `options?`): `AgentBuilder` Defined in: [packages/sdk/src/workspace-builder/workflows.ts:300](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/workflows.ts#L300) #### Parameters[​](#parameters "Direct link to Parameters") ##### name[​](#name "Direct link to name") `string` ##### options?[​](#options "Direct link to options?") `AnyRecord` = `{}` #### Returns[​](#returns "Direct link to Returns") `AgentBuilder` #### Overrides[​](#overrides "Direct link to Overrides") `WorkspaceBuilderResource.constructor` ## Properties[​](#properties "Direct link to Properties") ### \_created[​](#_created "Direct link to _created") > **\_created**: `boolean` = `false` Defined in: [packages/sdk/src/workspace-builder/resource.ts:23](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/resource.ts#L23) #### Inherited from[​](#inherited-from "Direct link to Inherited from") `WorkspaceBuilderResource._created` *** ### \_existed[​](#_existed "Direct link to _existed") > **\_existed**: `boolean` = `false` Defined in: [packages/sdk/src/workspace-builder/resource.ts:24](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/resource.ts#L24) #### Inherited from[​](#inherited-from-1 "Direct link to Inherited from") `WorkspaceBuilderResource._existed` *** ### \_id?[​](#_id "Direct link to _id?") > `optional` **\_id**: `number` Defined in: [packages/sdk/src/workspace-builder/resource.ts:21](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/resource.ts#L21) #### Inherited from[​](#inherited-from-2 "Direct link to Inherited from") `WorkspaceBuilderResource._id` *** ### \_uuid?[​](#_uuid "Direct link to _uuid?") > `optional` **\_uuid**: `string` Defined in: [packages/sdk/src/workspace-builder/resource.ts:22](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/resource.ts#L22) #### Inherited from[​](#inherited-from-3 "Direct link to Inherited from") `WorkspaceBuilderResource._uuid` *** ### chatModelId[​](#chatmodelid "Direct link to chatModelId") > `readonly` **chatModelId**: `string` Defined in: [packages/sdk/src/workspace-builder/workflows.ts:294](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/workflows.ts#L294) *** ### codeInterpreterEnabled[​](#codeinterpreterenabled "Direct link to codeInterpreterEnabled") > `readonly` **codeInterpreterEnabled**: `boolean` Defined in: [packages/sdk/src/workspace-builder/workflows.ts:298](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/workflows.ts#L298) *** ### memberRoleId?[​](#memberroleid "Direct link to memberRoleId?") > `readonly` `optional` **memberRoleId**: `number` Defined in: [packages/sdk/src/workspace-builder/workflows.ts:296](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/workflows.ts#L296) *** ### name[​](#name-1 "Direct link to name") > `readonly` **name**: `string` Defined in: [packages/sdk/src/workspace-builder/workflows.ts:301](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/workflows.ts#L301) *** ### systemPrompt[​](#systemprompt "Direct link to systemPrompt") > `readonly` **systemPrompt**: `string` Defined in: [packages/sdk/src/workspace-builder/workflows.ts:295](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/workflows.ts#L295) *** ### tools[​](#tools "Direct link to tools") > `readonly` **tools**: `string`\[] Defined in: [packages/sdk/src/workspace-builder/workflows.ts:297](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/workflows.ts#L297) ## Accessors[​](#accessors "Direct link to Accessors") ### id[​](#id "Direct link to id") #### Get Signature[​](#get-signature "Direct link to Get Signature") > **get** **id**(): `number` Defined in: [packages/sdk/src/workspace-builder/resource.ts:27](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/resource.ts#L27) Server-assigned numeric id — available after apply() or adopt(). ##### Returns[​](#returns-1 "Direct link to Returns") `number` #### Inherited from[​](#inherited-from-4 "Direct link to Inherited from") `WorkspaceBuilderResource.id` *** ### uuid[​](#uuid "Direct link to uuid") #### Get Signature[​](#get-signature-1 "Direct link to Get Signature") > **get** **uuid**(): `string` Defined in: [packages/sdk/src/workspace-builder/resource.ts:38](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/resource.ts#L38) Server-assigned uuid — available after apply() or adopt(). ##### Returns[​](#returns-2 "Direct link to Returns") `string` #### Inherited from[​](#inherited-from-5 "Direct link to Inherited from") `WorkspaceBuilderResource.uuid` ## Methods[​](#methods "Direct link to Methods") ### adopt()[​](#adopt "Direct link to adopt()") > **adopt**(`existing`): `void` Defined in: [packages/sdk/src/workspace-builder/resource.ts:55](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/resource.ts#L55) #### Parameters[​](#parameters-1 "Direct link to Parameters") ##### existing[​](#existing "Direct link to existing") `AnyRecord` #### Returns[​](#returns-3 "Direct link to Returns") `void` #### Inherited from[​](#inherited-from-6 "Direct link to Inherited from") `WorkspaceBuilderResource.adopt` *** ### apply()[​](#apply "Direct link to apply()") > **apply**(`client`): `Promise`<`void`> Defined in: [packages/sdk/src/workspace-builder/workflows.ts:320](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/workflows.ts#L320) #### Parameters[​](#parameters-2 "Direct link to Parameters") ##### client[​](#client "Direct link to client") [`GravityRailWorkspaceClient`](https://docs.gravityrail.com/sdk/type-aliases/GravityRailWorkspaceClient.md) #### Returns[​](#returns-4 "Direct link to Returns") `Promise`<`void`> #### Overrides[​](#overrides-1 "Direct link to Overrides") `WorkspaceBuilderResource.apply` *** ### matchKey()[​](#matchkey "Direct link to matchKey()") > **matchKey**(): `string` | `undefined` Defined in: [packages/sdk/src/workspace-builder/resource.ts:51](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/resource.ts#L51) #### Returns[​](#returns-5 "Direct link to Returns") `string` | `undefined` #### Inherited from[​](#inherited-from-7 "Direct link to Inherited from") `WorkspaceBuilderResource.matchKey` *** ### planLine()[​](#planline "Direct link to planLine()") > **planLine**(): `string` Defined in: [packages/sdk/src/workspace-builder/workflows.ts:313](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/workflows.ts#L313) #### Returns[​](#returns-6 "Direct link to Returns") `string` #### Overrides[​](#overrides-2 "Direct link to Overrides") `WorkspaceBuilderResource.planLine` --- # Class: ApiError Defined in: [packages/sdk/src/api/base.ts:50](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/base.ts#L50) ## Extends[​](#extends "Direct link to Extends") * `Error` ## Constructors[​](#constructors "Direct link to Constructors") ### Constructor[​](#constructor "Direct link to Constructor") > **new ApiError**(`message`, `statusCode`, `errors?`, `validationErrors?`): `ApiError` Defined in: [packages/sdk/src/api/base.ts:60](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/base.ts#L60) #### Parameters[​](#parameters "Direct link to Parameters") ##### message[​](#message "Direct link to message") `string` ##### statusCode[​](#statuscode "Direct link to statusCode") `number` ##### errors?[​](#errors "Direct link to errors?") `string`\[] ##### validationErrors?[​](#validationerrors "Direct link to validationErrors?") [`ApiValidationError`](https://docs.gravityrail.com/sdk/interfaces/ApiValidationError.md)\[] #### Returns[​](#returns "Direct link to Returns") `ApiError` #### Overrides[​](#overrides "Direct link to Overrides") `Error.constructor` ## Properties[​](#properties "Direct link to Properties") ### cause?[​](#cause "Direct link to cause?") > `optional` **cause**: `unknown` Defined in: node\_modules/typescript/lib/lib.es2022.error.d.ts:24 #### Inherited from[​](#inherited-from "Direct link to Inherited from") `Error.cause` *** ### errors?[​](#errors-1 "Direct link to errors?") > `optional` **errors**: `string`\[] Defined in: [packages/sdk/src/api/base.ts:53](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/base.ts#L53) Legacy string-array errors — kept for non-validation callers. *** ### message[​](#message-1 "Direct link to message") > **message**: `string` Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1075 #### Inherited from[​](#inherited-from-1 "Direct link to Inherited from") `Error.message` *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1074 #### Inherited from[​](#inherited-from-2 "Direct link to Inherited from") `Error.name` *** ### stack?[​](#stack "Direct link to stack?") > `optional` **stack**: `string` Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1076 #### Inherited from[​](#inherited-from-3 "Direct link to Inherited from") `Error.stack` *** ### stackTraceLimit[​](#stacktracelimit "Direct link to stackTraceLimit") > `static` **stackTraceLimit**: `number` Defined in: node\_modules/@types/node/globals.d.ts:67 The `Error.stackTraceLimit` property specifies the number of stack frames collected by a stack trace (whether generated by `new Error().stack` or `Error.captureStackTrace(obj)`). The default value is `10` but may be set to any valid JavaScript number. Changes will affect any stack trace captured *after* the value has been changed. If set to a non-number value, or set to a negative number, stack traces will not capture any frames. #### Inherited from[​](#inherited-from-4 "Direct link to Inherited from") `Error.stackTraceLimit` *** ### statusCode[​](#statuscode-1 "Direct link to statusCode") > **statusCode**: `number` Defined in: [packages/sdk/src/api/base.ts:51](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/base.ts#L51) *** ### validationErrors?[​](#validationerrors-1 "Direct link to validationErrors?") > `optional` **validationErrors**: [`ApiValidationError`](https://docs.gravityrail.com/sdk/interfaces/ApiValidationError.md)\[] Defined in: [packages/sdk/src/api/base.ts:58](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/base.ts#L58) Structured workflow-expression validation errors (CEL/Jinja). Populated when the backend returns a WorkflowValidationErrorResponse. ## Methods[​](#methods "Direct link to Methods") ### captureStackTrace()[​](#capturestacktrace "Direct link to captureStackTrace()") > `static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` Defined in: node\_modules/@types/node/globals.d.ts:51 Creates a `.stack` property on `targetObject`, which when accessed returns a string representing the location in the code at which `Error.captureStackTrace()` was called. ``` const myObject = {}; Error.captureStackTrace(myObject); myObject.stack; // Similar to `new Error().stack` ``` The first line of the trace will be prefixed with `${myObject.name}: ${myObject.message}`. The optional `constructorOpt` argument accepts a function. If given, all frames above `constructorOpt`, including `constructorOpt`, will be omitted from the generated stack trace. The `constructorOpt` argument is useful for hiding implementation details of error generation from the user. For instance: ``` function a() { b(); } function b() { c(); } function c() { // Create an error without stack trace to avoid calculating the stack trace twice. const { stackTraceLimit } = Error; Error.stackTraceLimit = 0; const error = new Error(); Error.stackTraceLimit = stackTraceLimit; // Capture the stack trace above function b Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace throw error; } a(); ``` #### Parameters[​](#parameters-1 "Direct link to Parameters") ##### targetObject[​](#targetobject "Direct link to targetObject") `object` ##### constructorOpt?[​](#constructoropt "Direct link to constructorOpt?") `Function` #### Returns[​](#returns-1 "Direct link to Returns") `void` #### Inherited from[​](#inherited-from-5 "Direct link to Inherited from") `Error.captureStackTrace` *** ### prepareStackTrace()[​](#preparestacktrace "Direct link to prepareStackTrace()") > `static` **prepareStackTrace**(`err`, `stackTraces`): `any` Defined in: node\_modules/@types/node/globals.d.ts:55 #### Parameters[​](#parameters-2 "Direct link to Parameters") ##### err[​](#err "Direct link to err") `Error` ##### stackTraces[​](#stacktraces "Direct link to stackTraces") `CallSite`\[] #### Returns[​](#returns-2 "Direct link to Returns") `any` #### See[​](#see "Direct link to See") #### Inherited from[​](#inherited-from-6 "Direct link to Inherited from") `Error.prepareStackTrace` --- # Class: ApplyError Defined in: [packages/sdk/src/workspace-builder/orchestrator.ts:476](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/orchestrator.ts#L476) ## Extends[​](#extends "Direct link to Extends") * `Error` ## Constructors[​](#constructors "Direct link to Constructors") ### Constructor[​](#constructor "Direct link to Constructor") > **new ApplyError**(`resource`, `cause`, `createdSoFar`): `ApplyError` Defined in: [packages/sdk/src/workspace-builder/orchestrator.ts:481](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/orchestrator.ts#L481) #### Parameters[​](#parameters "Direct link to Parameters") ##### resource[​](#resource "Direct link to resource") `WorkspaceBuilderResource` ##### cause[​](#cause "Direct link to cause") `unknown` ##### createdSoFar[​](#createdsofar "Direct link to createdSoFar") `ResourceSummary` #### Returns[​](#returns "Direct link to Returns") `ApplyError` #### Overrides[​](#overrides "Direct link to Overrides") `Error.constructor` ## Properties[​](#properties "Direct link to Properties") ### createdSoFar[​](#createdsofar-1 "Direct link to createdSoFar") > `readonly` **createdSoFar**: `ResourceSummary` Defined in: [packages/sdk/src/workspace-builder/orchestrator.ts:477](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/orchestrator.ts#L477) *** ### message[​](#message "Direct link to message") > **message**: `string` Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1075 #### Inherited from[​](#inherited-from "Direct link to Inherited from") `Error.message` *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1074 #### Inherited from[​](#inherited-from-1 "Direct link to Inherited from") `Error.name` *** ### stack?[​](#stack "Direct link to stack?") > `optional` **stack**: `string` Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1076 #### Inherited from[​](#inherited-from-2 "Direct link to Inherited from") `Error.stack` *** ### stackTraceLimit[​](#stacktracelimit "Direct link to stackTraceLimit") > `static` **stackTraceLimit**: `number` Defined in: node\_modules/@types/node/globals.d.ts:67 The `Error.stackTraceLimit` property specifies the number of stack frames collected by a stack trace (whether generated by `new Error().stack` or `Error.captureStackTrace(obj)`). The default value is `10` but may be set to any valid JavaScript number. Changes will affect any stack trace captured *after* the value has been changed. If set to a non-number value, or set to a negative number, stack traces will not capture any frames. #### Inherited from[​](#inherited-from-3 "Direct link to Inherited from") `Error.stackTraceLimit` ## Accessors[​](#accessors "Direct link to Accessors") ### cause[​](#cause-1 "Direct link to cause") #### Get Signature[​](#get-signature "Direct link to Get Signature") > **get** **cause**(): `unknown` Defined in: [packages/sdk/src/workspace-builder/orchestrator.ts:493](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/orchestrator.ts#L493) ##### Returns[​](#returns-1 "Direct link to Returns") `unknown` #### Overrides[​](#overrides-1 "Direct link to Overrides") `Error.cause` *** ### resource[​](#resource-1 "Direct link to resource") #### Get Signature[​](#get-signature-1 "Direct link to Get Signature") > **get** **resource**(): `WorkspaceBuilderResource` Defined in: [packages/sdk/src/workspace-builder/orchestrator.ts:489](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/orchestrator.ts#L489) ##### Returns[​](#returns-2 "Direct link to Returns") `WorkspaceBuilderResource` ## Methods[​](#methods "Direct link to Methods") ### captureStackTrace()[​](#capturestacktrace "Direct link to captureStackTrace()") > `static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` Defined in: node\_modules/@types/node/globals.d.ts:51 Creates a `.stack` property on `targetObject`, which when accessed returns a string representing the location in the code at which `Error.captureStackTrace()` was called. ``` const myObject = {}; Error.captureStackTrace(myObject); myObject.stack; // Similar to `new Error().stack` ``` The first line of the trace will be prefixed with `${myObject.name}: ${myObject.message}`. The optional `constructorOpt` argument accepts a function. If given, all frames above `constructorOpt`, including `constructorOpt`, will be omitted from the generated stack trace. The `constructorOpt` argument is useful for hiding implementation details of error generation from the user. For instance: ``` function a() { b(); } function b() { c(); } function c() { // Create an error without stack trace to avoid calculating the stack trace twice. const { stackTraceLimit } = Error; Error.stackTraceLimit = 0; const error = new Error(); Error.stackTraceLimit = stackTraceLimit; // Capture the stack trace above function b Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace throw error; } a(); ``` #### Parameters[​](#parameters-1 "Direct link to Parameters") ##### targetObject[​](#targetobject "Direct link to targetObject") `object` ##### constructorOpt?[​](#constructoropt "Direct link to constructorOpt?") `Function` #### Returns[​](#returns-3 "Direct link to Returns") `void` #### Inherited from[​](#inherited-from-4 "Direct link to Inherited from") `Error.captureStackTrace` *** ### prepareStackTrace()[​](#preparestacktrace "Direct link to prepareStackTrace()") > `static` **prepareStackTrace**(`err`, `stackTraces`): `any` Defined in: node\_modules/@types/node/globals.d.ts:55 #### Parameters[​](#parameters-2 "Direct link to Parameters") ##### err[​](#err "Direct link to err") `Error` ##### stackTraces[​](#stacktraces "Direct link to stackTraces") `CallSite`\[] #### Returns[​](#returns-4 "Direct link to Returns") `any` #### See[​](#see "Direct link to See") #### Inherited from[​](#inherited-from-5 "Direct link to Inherited from") `Error.prepareStackTrace` --- # Class: AppsApi Defined in: [packages/sdk/src/api/apps.ts:10](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/apps.ts#L10) Public API surface — excludes admin/superuser types and classes. Used by @gravity-rail/sdk. Instead of re-exporting through the types.ts barrel (which includes admin types via export \*), this file exports from each type sub-module individually. Admin-containing modules use selective exports. Admin types excluded: AdminAccount, AdminAccountFormData, AdminAccountMembership, AdminAccountOrgMembership, AdminOrganization, AdminWorkspaceMemberFormData, AdminInboxMappingRequest, AdminWorkspace, AdminWorkspaceFormData, AdminUpdateProductRequest ## Extends[​](#extends "Direct link to Extends") * [`BaseApiClient`](https://docs.gravityrail.com/sdk/classes/BaseApiClient.md) ## Constructors[​](#constructors "Direct link to Constructors") ### Constructor[​](#constructor "Direct link to Constructor") > **new AppsApi**(`apiKey`, `baseUrl`, `customFetch?`): `AppsApi` Defined in: [packages/sdk/src/api/base.ts:173](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/base.ts#L173) #### Parameters[​](#parameters "Direct link to Parameters") ##### apiKey[​](#apikey "Direct link to apiKey") `string` | `undefined` ##### baseUrl[​](#baseurl "Direct link to baseUrl") `string` ##### customFetch?[​](#customfetch "Direct link to customFetch?") {(`input`, `init?`): `Promise`<`Response`>; (`input`, `init?`): `Promise`<`Response`>; } #### Returns[​](#returns "Direct link to Returns") `AppsApi` #### Inherited from[​](#inherited-from "Direct link to Inherited from") [`BaseApiClient`](https://docs.gravityrail.com/sdk/classes/BaseApiClient.md).[`constructor`](https://docs.gravityrail.com/sdk/classes/BaseApiClient.md#constructor) ## Methods[​](#methods "Direct link to Methods") ### createApp()[​](#createapp "Direct link to createApp()") > **createApp**(`request`): `Promise`<[`App`](https://docs.gravityrail.com/sdk/type-aliases/App.md)> Defined in: [packages/sdk/src/api/apps.ts:32](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/apps.ts#L32) Create a new app #### Parameters[​](#parameters-1 "Direct link to Parameters") ##### request[​](#request "Direct link to request") [`CreateAppRequest`](https://docs.gravityrail.com/sdk/interfaces/CreateAppRequest.md) #### Returns[​](#returns-1 "Direct link to Returns") `Promise`<[`App`](https://docs.gravityrail.com/sdk/type-aliases/App.md)> *** ### deleteApp()[​](#deleteapp "Direct link to deleteApp()") > **deleteApp**(`appId`): `Promise`<{ `message`: `string`; }> Defined in: [packages/sdk/src/api/apps.ts:66](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/apps.ts#L66) Delete an app #### Parameters[​](#parameters-2 "Direct link to Parameters") ##### appId[​](#appid "Direct link to appId") `string` #### Returns[​](#returns-2 "Direct link to Returns") `Promise`<{ `message`: `string`; }> *** ### getActingMember()[​](#getactingmember "Direct link to getActingMember()") > **getActingMember**(): `string` | `undefined` Defined in: [packages/sdk/src/api/base.ts:226](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/base.ts#L226) Get the current acting member UUID. #### Returns[​](#returns-3 "Direct link to Returns") `string` | `undefined` #### Inherited from[​](#inherited-from-1 "Direct link to Inherited from") [`BaseApiClient`](https://docs.gravityrail.com/sdk/classes/BaseApiClient.md).[`getActingMember`](https://docs.gravityrail.com/sdk/classes/BaseApiClient.md#getactingmember) *** ### getApp()[​](#getapp "Direct link to getApp()") > **getApp**(`appId`): `Promise`<[`App`](https://docs.gravityrail.com/sdk/type-aliases/App.md)> Defined in: [packages/sdk/src/api/apps.ts:42](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/apps.ts#L42) Get details of a specific app #### Parameters[​](#parameters-3 "Direct link to Parameters") ##### appId[​](#appid-1 "Direct link to appId") `string` #### Returns[​](#returns-4 "Direct link to Returns") `Promise`<[`App`](https://docs.gravityrail.com/sdk/type-aliases/App.md)> *** ### getAppByClientId()[​](#getappbyclientid "Direct link to getAppByClientId()") > **getAppByClientId**(`clientId`): `Promise`<[`App`](https://docs.gravityrail.com/sdk/type-aliases/App.md)> Defined in: [packages/sdk/src/api/apps.ts:49](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/apps.ts#L49) Get app by client ID (for OAuth flows) #### Parameters[​](#parameters-4 "Direct link to Parameters") ##### clientId[​](#clientid "Direct link to clientId") `string` #### Returns[​](#returns-5 "Direct link to Returns") `Promise`<[`App`](https://docs.gravityrail.com/sdk/type-aliases/App.md)> *** ### listApps()[​](#listapps "Direct link to listApps()") > **listApps**(`params?`): `Promise`<[`AppListResponse`](https://docs.gravityrail.com/sdk/type-aliases/AppListResponse.md)> Defined in: [packages/sdk/src/api/apps.ts:14](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/apps.ts#L14) List apps - either public apps, account's apps, or all apps visible to a workspace #### Parameters[​](#parameters-5 "Direct link to Parameters") ##### params?[​](#params "Direct link to params?") ###### builderId?[​](#builderid "Direct link to builderId?") `number` ###### public?[​](#public "Direct link to public?") `boolean` ###### workspaceUuid?[​](#workspaceuuid "Direct link to workspaceUuid?") `string` #### Returns[​](#returns-6 "Direct link to Returns") `Promise`<[`AppListResponse`](https://docs.gravityrail.com/sdk/type-aliases/AppListResponse.md)> *** ### regenerateClientSecret()[​](#regenerateclientsecret "Direct link to regenerateClientSecret()") > **regenerateClientSecret**(`appId`): `Promise`<[`AppCredentialResponse`](https://docs.gravityrail.com/sdk/interfaces/AppCredentialResponse.md)> Defined in: [packages/sdk/src/api/apps.ts:75](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/apps.ts#L75) Regenerate client secret for an app #### Parameters[​](#parameters-6 "Direct link to Parameters") ##### appId[​](#appid-2 "Direct link to appId") `string` #### Returns[​](#returns-7 "Direct link to Returns") `Promise`<[`AppCredentialResponse`](https://docs.gravityrail.com/sdk/interfaces/AppCredentialResponse.md)> *** ### setActingMember()[​](#setactingmember "Direct link to setActingMember()") > **setActingMember**(`memberUuid`): `void` Defined in: [packages/sdk/src/api/base.ts:219](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/base.ts#L219) Set the acting member UUID for member identity switching. When set, all API requests will include the X-Acting-Member header. The backend will validate that the authenticated account owns this member and use it as the effective identity for the request. #### Parameters[​](#parameters-7 "Direct link to Parameters") ##### memberUuid[​](#memberuuid "Direct link to memberUuid") `string` | `undefined` #### Returns[​](#returns-8 "Direct link to Returns") `void` #### Inherited from[​](#inherited-from-2 "Direct link to Inherited from") [`BaseApiClient`](https://docs.gravityrail.com/sdk/classes/BaseApiClient.md).[`setActingMember`](https://docs.gravityrail.com/sdk/classes/BaseApiClient.md#setactingmember) *** ### setEnhancedAuthHandler()[​](#setenhancedauthhandler "Direct link to setEnhancedAuthHandler()") > **setEnhancedAuthHandler**(`handler`): `void` Defined in: [packages/sdk/src/api/base.ts:193](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/base.ts#L193) Set the handler for enhanced authentication requirements (RFC 9470 Step-Up Auth). This handler is called when a 401 response includes WWW-Authenticate header with error="insufficient\_user\_authentication". #### Parameters[​](#parameters-8 "Direct link to Parameters") ##### handler[​](#handler "Direct link to handler") [`EnhancedAuthHandler`](https://docs.gravityrail.com/sdk/type-aliases/EnhancedAuthHandler.md) | `undefined` #### Returns[​](#returns-9 "Direct link to Returns") `void` #### Inherited from[​](#inherited-from-3 "Direct link to Inherited from") [`BaseApiClient`](https://docs.gravityrail.com/sdk/classes/BaseApiClient.md).[`setEnhancedAuthHandler`](https://docs.gravityrail.com/sdk/classes/BaseApiClient.md#setenhancedauthhandler) *** ### setOrgAuthHandler()[​](#setorgauthhandler "Direct link to setOrgAuthHandler()") > **setOrgAuthHandler**(`handler`): `void` Defined in: [packages/sdk/src/api/base.ts:202](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/base.ts#L202) Set the handler for organization authentication requirements. This handler is called when a 401 response includes WWW-Authenticate header with realm="org". The handler should redirect the user to complete org auth. #### Parameters[​](#parameters-9 "Direct link to Parameters") ##### handler[​](#handler-1 "Direct link to handler") [`OrgAuthHandler`](https://docs.gravityrail.com/sdk/type-aliases/OrgAuthHandler.md) | `undefined` #### Returns[​](#returns-10 "Direct link to Returns") `void` #### Inherited from[​](#inherited-from-4 "Direct link to Inherited from") [`BaseApiClient`](https://docs.gravityrail.com/sdk/classes/BaseApiClient.md).[`setOrgAuthHandler`](https://docs.gravityrail.com/sdk/classes/BaseApiClient.md#setorgauthhandler) *** ### setOrgSession()[​](#setorgsession "Direct link to setOrgSession()") > **setOrgSession**(`session`, `orgUuid?`): `void` Defined in: [packages/sdk/src/api/base.ts:240](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/base.ts#L240) Set the opaque org session credential for cross-domain requests. Opaque gr\_sess\_ values use X-Org-Session. Legacy orgToken JWE values still use X-Org-Token through setOrgToken() during the migration window. `orgUuid` is the org that issued the credential; passing it lets the 401 handler detect a stale session when a subsequent request targets a different org and re-fire the org-auth handler instead of silently 401-ing. Callers without that context (legacy / unknown) may omit it. #### Parameters[​](#parameters-10 "Direct link to Parameters") ##### session[​](#session "Direct link to session") `string` | `undefined` ##### orgUuid?[​](#orguuid "Direct link to orgUuid?") `string` #### Returns[​](#returns-11 "Direct link to Returns") `void` #### Inherited from[​](#inherited-from-5 "Direct link to Inherited from") [`BaseApiClient`](https://docs.gravityrail.com/sdk/classes/BaseApiClient.md).[`setOrgSession`](https://docs.gravityrail.com/sdk/classes/BaseApiClient.md#setorgsession) *** ### ~~setOrgToken()~~[​](#setorgtoken "Direct link to setorgtoken") > **setOrgToken**(`token`, `orgUuid?`): `void` Defined in: [packages/sdk/src/api/base.ts:249](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/base.ts#L249) #### Parameters[​](#parameters-11 "Direct link to Parameters") ##### token[​](#token "Direct link to token") `string` | `undefined` ##### orgUuid?[​](#orguuid-1 "Direct link to orgUuid?") `string` #### Returns[​](#returns-12 "Direct link to Returns") `void` #### Deprecated[​](#deprecated "Direct link to Deprecated") Legacy compatibility for stateless orgToken JWE credentials. Prefer setOrgSession() for opaque org browser sessions. #### Inherited from[​](#inherited-from-6 "Direct link to Inherited from") [`BaseApiClient`](https://docs.gravityrail.com/sdk/classes/BaseApiClient.md).[`setOrgToken`](https://docs.gravityrail.com/sdk/classes/BaseApiClient.md#setorgtoken) *** ### updateApiKey()[​](#updateapikey "Direct link to updateApiKey()") > **updateApiKey**(`newApiKey`): `void` Defined in: [packages/sdk/src/api/base.ts:209](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/base.ts#L209) Update the API key (used after successful re-authentication). #### Parameters[​](#parameters-12 "Direct link to Parameters") ##### newApiKey[​](#newapikey "Direct link to newApiKey") `string` #### Returns[​](#returns-13 "Direct link to Returns") `void` #### Inherited from[​](#inherited-from-7 "Direct link to Inherited from") [`BaseApiClient`](https://docs.gravityrail.com/sdk/classes/BaseApiClient.md).[`updateApiKey`](https://docs.gravityrail.com/sdk/classes/BaseApiClient.md#updateapikey) *** ### updateApp()[​](#updateapp "Direct link to updateApp()") > **updateApp**(`appId`, `request`): `Promise`<[`App`](https://docs.gravityrail.com/sdk/type-aliases/App.md)> Defined in: [packages/sdk/src/api/apps.ts:56](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/apps.ts#L56) Update an app #### Parameters[​](#parameters-13 "Direct link to Parameters") ##### appId[​](#appid-3 "Direct link to appId") `string` ##### request[​](#request-1 "Direct link to request") [`UpdateAppRequest`](https://docs.gravityrail.com/sdk/interfaces/UpdateAppRequest.md) #### Returns[​](#returns-14 "Direct link to Returns") `Promise`<[`App`](https://docs.gravityrail.com/sdk/type-aliases/App.md)> --- # Class: BaseApiClient Defined in: [packages/sdk/src/api/base.ts:153](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/base.ts#L153) ## Extended by[​](#extended-by "Direct link to Extended by") * [`AppsApi`](https://docs.gravityrail.com/sdk/classes/AppsApi.md) * [`BuildersApi`](https://docs.gravityrail.com/sdk/classes/BuildersApi.md) * [`CELApi`](https://docs.gravityrail.com/sdk/classes/CELApi.md) * [`QueriesApi`](https://docs.gravityrail.com/sdk/classes/QueriesApi.md) * [`OrgApi`](https://docs.gravityrail.com/sdk/classes/OrgApi.md) * [`SupervisorsApi`](https://docs.gravityrail.com/sdk/classes/SupervisorsApi.md) * [`TemplatesApi`](https://docs.gravityrail.com/sdk/classes/TemplatesApi.md) ## Constructors[​](#constructors "Direct link to Constructors") ### Constructor[​](#constructor "Direct link to Constructor") > **new BaseApiClient**(`apiKey`, `baseUrl`, `customFetch?`): `BaseApiClient` Defined in: [packages/sdk/src/api/base.ts:173](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/base.ts#L173) #### Parameters[​](#parameters "Direct link to Parameters") ##### apiKey[​](#apikey "Direct link to apiKey") `string` | `undefined` ##### baseUrl[​](#baseurl "Direct link to baseUrl") `string` ##### customFetch?[​](#customfetch "Direct link to customFetch?") {(`input`, `init?`): `Promise`<`Response`>; (`input`, `init?`): `Promise`<`Response`>; } #### Returns[​](#returns "Direct link to Returns") `BaseApiClient` ## Methods[​](#methods "Direct link to Methods") ### getActingMember()[​](#getactingmember "Direct link to getActingMember()") > **getActingMember**(): `string` | `undefined` Defined in: [packages/sdk/src/api/base.ts:226](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/base.ts#L226) Get the current acting member UUID. #### Returns[​](#returns-1 "Direct link to Returns") `string` | `undefined` *** ### setActingMember()[​](#setactingmember "Direct link to setActingMember()") > **setActingMember**(`memberUuid`): `void` Defined in: [packages/sdk/src/api/base.ts:219](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/base.ts#L219) Set the acting member UUID for member identity switching. When set, all API requests will include the X-Acting-Member header. The backend will validate that the authenticated account owns this member and use it as the effective identity for the request. #### Parameters[​](#parameters-1 "Direct link to Parameters") ##### memberUuid[​](#memberuuid "Direct link to memberUuid") `string` | `undefined` #### Returns[​](#returns-2 "Direct link to Returns") `void` *** ### setEnhancedAuthHandler()[​](#setenhancedauthhandler "Direct link to setEnhancedAuthHandler()") > **setEnhancedAuthHandler**(`handler`): `void` Defined in: [packages/sdk/src/api/base.ts:193](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/base.ts#L193) Set the handler for enhanced authentication requirements (RFC 9470 Step-Up Auth). This handler is called when a 401 response includes WWW-Authenticate header with error="insufficient\_user\_authentication". #### Parameters[​](#parameters-2 "Direct link to Parameters") ##### handler[​](#handler "Direct link to handler") [`EnhancedAuthHandler`](https://docs.gravityrail.com/sdk/type-aliases/EnhancedAuthHandler.md) | `undefined` #### Returns[​](#returns-3 "Direct link to Returns") `void` *** ### setOrgAuthHandler()[​](#setorgauthhandler "Direct link to setOrgAuthHandler()") > **setOrgAuthHandler**(`handler`): `void` Defined in: [packages/sdk/src/api/base.ts:202](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/base.ts#L202) Set the handler for organization authentication requirements. This handler is called when a 401 response includes WWW-Authenticate header with realm="org". The handler should redirect the user to complete org auth. #### Parameters[​](#parameters-3 "Direct link to Parameters") ##### handler[​](#handler-1 "Direct link to handler") [`OrgAuthHandler`](https://docs.gravityrail.com/sdk/type-aliases/OrgAuthHandler.md) | `undefined` #### Returns[​](#returns-4 "Direct link to Returns") `void` *** ### setOrgSession()[​](#setorgsession "Direct link to setOrgSession()") > **setOrgSession**(`session`, `orgUuid?`): `void` Defined in: [packages/sdk/src/api/base.ts:240](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/base.ts#L240) Set the opaque org session credential for cross-domain requests. Opaque gr\_sess\_ values use X-Org-Session. Legacy orgToken JWE values still use X-Org-Token through setOrgToken() during the migration window. `orgUuid` is the org that issued the credential; passing it lets the 401 handler detect a stale session when a subsequent request targets a different org and re-fire the org-auth handler instead of silently 401-ing. Callers without that context (legacy / unknown) may omit it. #### Parameters[​](#parameters-4 "Direct link to Parameters") ##### session[​](#session "Direct link to session") `string` | `undefined` ##### orgUuid?[​](#orguuid "Direct link to orgUuid?") `string` #### Returns[​](#returns-5 "Direct link to Returns") `void` *** ### ~~setOrgToken()~~[​](#setorgtoken "Direct link to setorgtoken") > **setOrgToken**(`token`, `orgUuid?`): `void` Defined in: [packages/sdk/src/api/base.ts:249](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/base.ts#L249) #### Parameters[​](#parameters-5 "Direct link to Parameters") ##### token[​](#token "Direct link to token") `string` | `undefined` ##### orgUuid?[​](#orguuid-1 "Direct link to orgUuid?") `string` #### Returns[​](#returns-6 "Direct link to Returns") `void` #### Deprecated[​](#deprecated "Direct link to Deprecated") Legacy compatibility for stateless orgToken JWE credentials. Prefer setOrgSession() for opaque org browser sessions. *** ### updateApiKey()[​](#updateapikey "Direct link to updateApiKey()") > **updateApiKey**(`newApiKey`): `void` Defined in: [packages/sdk/src/api/base.ts:209](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/base.ts#L209) Update the API key (used after successful re-authentication). #### Parameters[​](#parameters-6 "Direct link to Parameters") ##### newApiKey[​](#newapikey "Direct link to newApiKey") `string` #### Returns[​](#returns-7 "Direct link to Returns") `void` --- # Class: BuildersApi Defined in: [packages/sdk/src/api/builders.ts:13](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/builders.ts#L13) Builders API client ## Extends[​](#extends "Direct link to Extends") * [`BaseApiClient`](https://docs.gravityrail.com/sdk/classes/BaseApiClient.md) ## Constructors[​](#constructors "Direct link to Constructors") ### Constructor[​](#constructor "Direct link to Constructor") > **new BuildersApi**(`apiKey`, `baseUrl`, `customFetch?`): `BuildersApi` Defined in: [packages/sdk/src/api/base.ts:173](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/base.ts#L173) #### Parameters[​](#parameters "Direct link to Parameters") ##### apiKey[​](#apikey "Direct link to apiKey") `string` | `undefined` ##### baseUrl[​](#baseurl "Direct link to baseUrl") `string` ##### customFetch?[​](#customfetch "Direct link to customFetch?") {(`input`, `init?`): `Promise`<`Response`>; (`input`, `init?`): `Promise`<`Response`>; } #### Returns[​](#returns "Direct link to Returns") `BuildersApi` #### Inherited from[​](#inherited-from "Direct link to Inherited from") [`BaseApiClient`](https://docs.gravityrail.com/sdk/classes/BaseApiClient.md).[`constructor`](https://docs.gravityrail.com/sdk/classes/BaseApiClient.md#constructor) ## Methods[​](#methods "Direct link to Methods") ### createBuilder()[​](#createbuilder "Direct link to createBuilder()") > **createBuilder**(`request`): `Promise`<[`BuilderResponse`](https://docs.gravityrail.com/sdk/interfaces/BuilderResponse.md)> Defined in: [packages/sdk/src/api/builders.ts:37](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/builders.ts#L37) Create a new builder #### Parameters[​](#parameters-1 "Direct link to Parameters") ##### request[​](#request "Direct link to request") [`CreateBuilderRequest`](https://docs.gravityrail.com/sdk/interfaces/CreateBuilderRequest.md) #### Returns[​](#returns-1 "Direct link to Returns") `Promise`<[`BuilderResponse`](https://docs.gravityrail.com/sdk/interfaces/BuilderResponse.md)> *** ### deleteBuilder()[​](#deletebuilder "Direct link to deleteBuilder()") > **deleteBuilder**(`builderId`): `Promise`<{ `message`: `string`; }> Defined in: [packages/sdk/src/api/builders.ts:57](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/builders.ts#L57) Delete a builder #### Parameters[​](#parameters-2 "Direct link to Parameters") ##### builderId[​](#builderid "Direct link to builderId") `string` #### Returns[​](#returns-2 "Direct link to Returns") `Promise`<{ `message`: `string`; }> *** ### getActingMember()[​](#getactingmember "Direct link to getActingMember()") > **getActingMember**(): `string` | `undefined` Defined in: [packages/sdk/src/api/base.ts:226](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/base.ts#L226) Get the current acting member UUID. #### Returns[​](#returns-3 "Direct link to Returns") `string` | `undefined` #### Inherited from[​](#inherited-from-1 "Direct link to Inherited from") [`BaseApiClient`](https://docs.gravityrail.com/sdk/classes/BaseApiClient.md).[`getActingMember`](https://docs.gravityrail.com/sdk/classes/BaseApiClient.md#getactingmember) *** ### getBuilder()[​](#getbuilder "Direct link to getBuilder()") > **getBuilder**(`builderId`): `Promise`<[`BuilderResponse`](https://docs.gravityrail.com/sdk/interfaces/BuilderResponse.md)> Defined in: [packages/sdk/src/api/builders.ts:30](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/builders.ts#L30) Get a specific builder by UUID #### Parameters[​](#parameters-3 "Direct link to Parameters") ##### builderId[​](#builderid-1 "Direct link to builderId") `string` #### Returns[​](#returns-4 "Direct link to Returns") `Promise`<[`BuilderResponse`](https://docs.gravityrail.com/sdk/interfaces/BuilderResponse.md)> *** ### getBuilderApps()[​](#getbuilderapps "Direct link to getBuilderApps()") > **getBuilderApps**(`builderId`): `Promise`<[`AppListResponse`](https://docs.gravityrail.com/sdk/type-aliases/AppListResponse.md)> Defined in: [packages/sdk/src/api/builders.ts:66](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/builders.ts#L66) Get apps for a specific builder #### Parameters[​](#parameters-4 "Direct link to Parameters") ##### builderId[​](#builderid-2 "Direct link to builderId") `string` #### Returns[​](#returns-5 "Direct link to Returns") `Promise`<[`AppListResponse`](https://docs.gravityrail.com/sdk/type-aliases/AppListResponse.md)> *** ### listBuilders()[​](#listbuilders "Direct link to listBuilders()") > **listBuilders**(`all?`): `Promise`<[`BuilderListResponse`](https://docs.gravityrail.com/sdk/interfaces/BuilderListResponse.md)> Defined in: [packages/sdk/src/api/builders.ts:17](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/builders.ts#L17) List all builders (optionally all with superuser access) #### Parameters[​](#parameters-5 "Direct link to Parameters") ##### all?[​](#all "Direct link to all?") `boolean` #### Returns[​](#returns-6 "Direct link to Returns") `Promise`<[`BuilderListResponse`](https://docs.gravityrail.com/sdk/interfaces/BuilderListResponse.md)> *** ### setActingMember()[​](#setactingmember "Direct link to setActingMember()") > **setActingMember**(`memberUuid`): `void` Defined in: [packages/sdk/src/api/base.ts:219](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/base.ts#L219) Set the acting member UUID for member identity switching. When set, all API requests will include the X-Acting-Member header. The backend will validate that the authenticated account owns this member and use it as the effective identity for the request. #### Parameters[​](#parameters-6 "Direct link to Parameters") ##### memberUuid[​](#memberuuid "Direct link to memberUuid") `string` | `undefined` #### Returns[​](#returns-7 "Direct link to Returns") `void` #### Inherited from[​](#inherited-from-2 "Direct link to Inherited from") [`BaseApiClient`](https://docs.gravityrail.com/sdk/classes/BaseApiClient.md).[`setActingMember`](https://docs.gravityrail.com/sdk/classes/BaseApiClient.md#setactingmember) *** ### setEnhancedAuthHandler()[​](#setenhancedauthhandler "Direct link to setEnhancedAuthHandler()") > **setEnhancedAuthHandler**(`handler`): `void` Defined in: [packages/sdk/src/api/base.ts:193](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/base.ts#L193) Set the handler for enhanced authentication requirements (RFC 9470 Step-Up Auth). This handler is called when a 401 response includes WWW-Authenticate header with error="insufficient\_user\_authentication". #### Parameters[​](#parameters-7 "Direct link to Parameters") ##### handler[​](#handler "Direct link to handler") [`EnhancedAuthHandler`](https://docs.gravityrail.com/sdk/type-aliases/EnhancedAuthHandler.md) | `undefined` #### Returns[​](#returns-8 "Direct link to Returns") `void` #### Inherited from[​](#inherited-from-3 "Direct link to Inherited from") [`BaseApiClient`](https://docs.gravityrail.com/sdk/classes/BaseApiClient.md).[`setEnhancedAuthHandler`](https://docs.gravityrail.com/sdk/classes/BaseApiClient.md#setenhancedauthhandler) *** ### setOrgAuthHandler()[​](#setorgauthhandler "Direct link to setOrgAuthHandler()") > **setOrgAuthHandler**(`handler`): `void` Defined in: [packages/sdk/src/api/base.ts:202](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/base.ts#L202) Set the handler for organization authentication requirements. This handler is called when a 401 response includes WWW-Authenticate header with realm="org". The handler should redirect the user to complete org auth. #### Parameters[​](#parameters-8 "Direct link to Parameters") ##### handler[​](#handler-1 "Direct link to handler") [`OrgAuthHandler`](https://docs.gravityrail.com/sdk/type-aliases/OrgAuthHandler.md) | `undefined` #### Returns[​](#returns-9 "Direct link to Returns") `void` #### Inherited from[​](#inherited-from-4 "Direct link to Inherited from") [`BaseApiClient`](https://docs.gravityrail.com/sdk/classes/BaseApiClient.md).[`setOrgAuthHandler`](https://docs.gravityrail.com/sdk/classes/BaseApiClient.md#setorgauthhandler) *** ### setOrgSession()[​](#setorgsession "Direct link to setOrgSession()") > **setOrgSession**(`session`, `orgUuid?`): `void` Defined in: [packages/sdk/src/api/base.ts:240](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/base.ts#L240) Set the opaque org session credential for cross-domain requests. Opaque gr\_sess\_ values use X-Org-Session. Legacy orgToken JWE values still use X-Org-Token through setOrgToken() during the migration window. `orgUuid` is the org that issued the credential; passing it lets the 401 handler detect a stale session when a subsequent request targets a different org and re-fire the org-auth handler instead of silently 401-ing. Callers without that context (legacy / unknown) may omit it. #### Parameters[​](#parameters-9 "Direct link to Parameters") ##### session[​](#session "Direct link to session") `string` | `undefined` ##### orgUuid?[​](#orguuid "Direct link to orgUuid?") `string` #### Returns[​](#returns-10 "Direct link to Returns") `void` #### Inherited from[​](#inherited-from-5 "Direct link to Inherited from") [`BaseApiClient`](https://docs.gravityrail.com/sdk/classes/BaseApiClient.md).[`setOrgSession`](https://docs.gravityrail.com/sdk/classes/BaseApiClient.md#setorgsession) *** ### ~~setOrgToken()~~[​](#setorgtoken "Direct link to setorgtoken") > **setOrgToken**(`token`, `orgUuid?`): `void` Defined in: [packages/sdk/src/api/base.ts:249](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/base.ts#L249) #### Parameters[​](#parameters-10 "Direct link to Parameters") ##### token[​](#token "Direct link to token") `string` | `undefined` ##### orgUuid?[​](#orguuid-1 "Direct link to orgUuid?") `string` #### Returns[​](#returns-11 "Direct link to Returns") `void` #### Deprecated[​](#deprecated "Direct link to Deprecated") Legacy compatibility for stateless orgToken JWE credentials. Prefer setOrgSession() for opaque org browser sessions. #### Inherited from[​](#inherited-from-6 "Direct link to Inherited from") [`BaseApiClient`](https://docs.gravityrail.com/sdk/classes/BaseApiClient.md).[`setOrgToken`](https://docs.gravityrail.com/sdk/classes/BaseApiClient.md#setorgtoken) *** ### updateApiKey()[​](#updateapikey "Direct link to updateApiKey()") > **updateApiKey**(`newApiKey`): `void` Defined in: [packages/sdk/src/api/base.ts:209](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/base.ts#L209) Update the API key (used after successful re-authentication). #### Parameters[​](#parameters-11 "Direct link to Parameters") ##### newApiKey[​](#newapikey "Direct link to newApiKey") `string` #### Returns[​](#returns-12 "Direct link to Returns") `void` #### Inherited from[​](#inherited-from-7 "Direct link to Inherited from") [`BaseApiClient`](https://docs.gravityrail.com/sdk/classes/BaseApiClient.md).[`updateApiKey`](https://docs.gravityrail.com/sdk/classes/BaseApiClient.md#updateapikey) *** ### updateBuilder()[​](#updatebuilder "Direct link to updateBuilder()") > **updateBuilder**(`builderId`, `request`): `Promise`<[`BuilderResponse`](https://docs.gravityrail.com/sdk/interfaces/BuilderResponse.md)> Defined in: [packages/sdk/src/api/builders.ts:47](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/builders.ts#L47) Update an existing builder #### Parameters[​](#parameters-12 "Direct link to Parameters") ##### builderId[​](#builderid-3 "Direct link to builderId") `string` ##### request[​](#request-1 "Direct link to request") [`UpdateBuilderRequest`](https://docs.gravityrail.com/sdk/interfaces/UpdateBuilderRequest.md) #### Returns[​](#returns-13 "Direct link to Returns") `Promise`<[`BuilderResponse`](https://docs.gravityrail.com/sdk/interfaces/BuilderResponse.md)> --- # Class: CELApi Defined in: [packages/sdk/src/api/cel.ts:4](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/cel.ts#L4) ## Extends[​](#extends "Direct link to Extends") * [`BaseApiClient`](https://docs.gravityrail.com/sdk/classes/BaseApiClient.md) ## Constructors[​](#constructors "Direct link to Constructors") ### Constructor[​](#constructor "Direct link to Constructor") > **new CELApi**(`apiKey`, `baseUrl`, `customFetch?`): `CELApi` Defined in: [packages/sdk/src/api/base.ts:173](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/base.ts#L173) #### Parameters[​](#parameters "Direct link to Parameters") ##### apiKey[​](#apikey "Direct link to apiKey") `string` | `undefined` ##### baseUrl[​](#baseurl "Direct link to baseUrl") `string` ##### customFetch?[​](#customfetch "Direct link to customFetch?") {(`input`, `init?`): `Promise`<`Response`>; (`input`, `init?`): `Promise`<`Response`>; } #### Returns[​](#returns "Direct link to Returns") `CELApi` #### Inherited from[​](#inherited-from "Direct link to Inherited from") [`BaseApiClient`](https://docs.gravityrail.com/sdk/classes/BaseApiClient.md).[`constructor`](https://docs.gravityrail.com/sdk/classes/BaseApiClient.md#constructor) ## Methods[​](#methods "Direct link to Methods") ### getActingMember()[​](#getactingmember "Direct link to getActingMember()") > **getActingMember**(): `string` | `undefined` Defined in: [packages/sdk/src/api/base.ts:226](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/base.ts#L226) Get the current acting member UUID. #### Returns[​](#returns-1 "Direct link to Returns") `string` | `undefined` #### Inherited from[​](#inherited-from-1 "Direct link to Inherited from") [`BaseApiClient`](https://docs.gravityrail.com/sdk/classes/BaseApiClient.md).[`getActingMember`](https://docs.gravityrail.com/sdk/classes/BaseApiClient.md#getactingmember) *** ### getCelContext()[​](#getcelcontext "Direct link to getCelContext()") > **getCelContext**(`wid`, `request`): `Promise`<[`CELContextResponse`](https://docs.gravityrail.com/sdk/interfaces/CELContextResponse.md)> Defined in: [packages/sdk/src/api/cel.ts:11](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/cel.ts#L11) 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[​](#parameters-1 "Direct link to Parameters") ##### wid[​](#wid "Direct link to wid") `string` ##### request[​](#request "Direct link to request") [`CELContextRequest`](https://docs.gravityrail.com/sdk/interfaces/CELContextRequest.md) #### Returns[​](#returns-2 "Direct link to Returns") `Promise`<[`CELContextResponse`](https://docs.gravityrail.com/sdk/interfaces/CELContextResponse.md)> *** ### setActingMember()[​](#setactingmember "Direct link to setActingMember()") > **setActingMember**(`memberUuid`): `void` Defined in: [packages/sdk/src/api/base.ts:219](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/base.ts#L219) Set the acting member UUID for member identity switching. When set, all API requests will include the X-Acting-Member header. The backend will validate that the authenticated account owns this member and use it as the effective identity for the request. #### Parameters[​](#parameters-2 "Direct link to Parameters") ##### memberUuid[​](#memberuuid "Direct link to memberUuid") `string` | `undefined` #### Returns[​](#returns-3 "Direct link to Returns") `void` #### Inherited from[​](#inherited-from-2 "Direct link to Inherited from") [`BaseApiClient`](https://docs.gravityrail.com/sdk/classes/BaseApiClient.md).[`setActingMember`](https://docs.gravityrail.com/sdk/classes/BaseApiClient.md#setactingmember) *** ### setEnhancedAuthHandler()[​](#setenhancedauthhandler "Direct link to setEnhancedAuthHandler()") > **setEnhancedAuthHandler**(`handler`): `void` Defined in: [packages/sdk/src/api/base.ts:193](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/base.ts#L193) Set the handler for enhanced authentication requirements (RFC 9470 Step-Up Auth). This handler is called when a 401 response includes WWW-Authenticate header with error="insufficient\_user\_authentication". #### Parameters[​](#parameters-3 "Direct link to Parameters") ##### handler[​](#handler "Direct link to handler") [`EnhancedAuthHandler`](https://docs.gravityrail.com/sdk/type-aliases/EnhancedAuthHandler.md) | `undefined` #### Returns[​](#returns-4 "Direct link to Returns") `void` #### Inherited from[​](#inherited-from-3 "Direct link to Inherited from") [`BaseApiClient`](https://docs.gravityrail.com/sdk/classes/BaseApiClient.md).[`setEnhancedAuthHandler`](https://docs.gravityrail.com/sdk/classes/BaseApiClient.md#setenhancedauthhandler) *** ### setOrgAuthHandler()[​](#setorgauthhandler "Direct link to setOrgAuthHandler()") > **setOrgAuthHandler**(`handler`): `void` Defined in: [packages/sdk/src/api/base.ts:202](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/base.ts#L202) Set the handler for organization authentication requirements. This handler is called when a 401 response includes WWW-Authenticate header with realm="org". The handler should redirect the user to complete org auth. #### Parameters[​](#parameters-4 "Direct link to Parameters") ##### handler[​](#handler-1 "Direct link to handler") [`OrgAuthHandler`](https://docs.gravityrail.com/sdk/type-aliases/OrgAuthHandler.md) | `undefined` #### Returns[​](#returns-5 "Direct link to Returns") `void` #### Inherited from[​](#inherited-from-4 "Direct link to Inherited from") [`BaseApiClient`](https://docs.gravityrail.com/sdk/classes/BaseApiClient.md).[`setOrgAuthHandler`](https://docs.gravityrail.com/sdk/classes/BaseApiClient.md#setorgauthhandler) *** ### setOrgSession()[​](#setorgsession "Direct link to setOrgSession()") > **setOrgSession**(`session`, `orgUuid?`): `void` Defined in: [packages/sdk/src/api/base.ts:240](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/base.ts#L240) Set the opaque org session credential for cross-domain requests. Opaque gr\_sess\_ values use X-Org-Session. Legacy orgToken JWE values still use X-Org-Token through setOrgToken() during the migration window. `orgUuid` is the org that issued the credential; passing it lets the 401 handler detect a stale session when a subsequent request targets a different org and re-fire the org-auth handler instead of silently 401-ing. Callers without that context (legacy / unknown) may omit it. #### Parameters[​](#parameters-5 "Direct link to Parameters") ##### session[​](#session "Direct link to session") `string` | `undefined` ##### orgUuid?[​](#orguuid "Direct link to orgUuid?") `string` #### Returns[​](#returns-6 "Direct link to Returns") `void` #### Inherited from[​](#inherited-from-5 "Direct link to Inherited from") [`BaseApiClient`](https://docs.gravityrail.com/sdk/classes/BaseApiClient.md).[`setOrgSession`](https://docs.gravityrail.com/sdk/classes/BaseApiClient.md#setorgsession) *** ### ~~setOrgToken()~~[​](#setorgtoken "Direct link to setorgtoken") > **setOrgToken**(`token`, `orgUuid?`): `void` Defined in: [packages/sdk/src/api/base.ts:249](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/base.ts#L249) #### Parameters[​](#parameters-6 "Direct link to Parameters") ##### token[​](#token "Direct link to token") `string` | `undefined` ##### orgUuid?[​](#orguuid-1 "Direct link to orgUuid?") `string` #### Returns[​](#returns-7 "Direct link to Returns") `void` #### Deprecated[​](#deprecated "Direct link to Deprecated") Legacy compatibility for stateless orgToken JWE credentials. Prefer setOrgSession() for opaque org browser sessions. #### Inherited from[​](#inherited-from-6 "Direct link to Inherited from") [`BaseApiClient`](https://docs.gravityrail.com/sdk/classes/BaseApiClient.md).[`setOrgToken`](https://docs.gravityrail.com/sdk/classes/BaseApiClient.md#setorgtoken) *** ### updateApiKey()[​](#updateapikey "Direct link to updateApiKey()") > **updateApiKey**(`newApiKey`): `void` Defined in: [packages/sdk/src/api/base.ts:209](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/base.ts#L209) Update the API key (used after successful re-authentication). #### Parameters[​](#parameters-7 "Direct link to Parameters") ##### newApiKey[​](#newapikey "Direct link to newApiKey") `string` #### Returns[​](#returns-8 "Direct link to Returns") `void` #### Inherited from[​](#inherited-from-7 "Direct link to Inherited from") [`BaseApiClient`](https://docs.gravityrail.com/sdk/classes/BaseApiClient.md).[`updateApiKey`](https://docs.gravityrail.com/sdk/classes/BaseApiClient.md#updateapikey) --- # Class: FormBuilder Defined in: [packages/sdk/src/workspace-builder/forms.ts:53](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/forms.ts#L53) ## Extends[​](#extends "Direct link to Extends") * `WorkspaceBuilderResource` ## Constructors[​](#constructors "Direct link to Constructors") ### Constructor[​](#constructor "Direct link to Constructor") > **new FormBuilder**(`name`, `slug?`, `options?`): `FormBuilder` Defined in: [packages/sdk/src/workspace-builder/forms.ts:62](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/forms.ts#L62) #### Parameters[​](#parameters "Direct link to Parameters") ##### name[​](#name "Direct link to name") `string` ##### slug?[​](#slug "Direct link to slug?") `string` ##### options?[​](#options "Direct link to options?") `AnyRecord` = `{}` #### Returns[​](#returns "Direct link to Returns") `FormBuilder` #### Overrides[​](#overrides "Direct link to Overrides") `WorkspaceBuilderResource.constructor` ## Properties[​](#properties "Direct link to Properties") ### \_created[​](#_created "Direct link to _created") > **\_created**: `boolean` = `false` Defined in: [packages/sdk/src/workspace-builder/resource.ts:23](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/resource.ts#L23) #### Inherited from[​](#inherited-from "Direct link to Inherited from") `WorkspaceBuilderResource._created` *** ### \_existed[​](#_existed "Direct link to _existed") > **\_existed**: `boolean` = `false` Defined in: [packages/sdk/src/workspace-builder/resource.ts:24](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/resource.ts#L24) #### Inherited from[​](#inherited-from-1 "Direct link to Inherited from") `WorkspaceBuilderResource._existed` *** ### \_id?[​](#_id "Direct link to _id?") > `optional` **\_id**: `number` Defined in: [packages/sdk/src/workspace-builder/resource.ts:21](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/resource.ts#L21) #### Inherited from[​](#inherited-from-2 "Direct link to Inherited from") `WorkspaceBuilderResource._id` *** ### \_uuid?[​](#_uuid "Direct link to _uuid?") > `optional` **\_uuid**: `string` Defined in: [packages/sdk/src/workspace-builder/resource.ts:22](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/resource.ts#L22) #### Inherited from[​](#inherited-from-3 "Direct link to Inherited from") `WorkspaceBuilderResource._uuid` *** ### collection[​](#collection "Direct link to collection") > `readonly` **collection**: `boolean` Defined in: [packages/sdk/src/workspace-builder/forms.ts:58](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/forms.ts#L58) *** ### description[​](#description "Direct link to description") > `readonly` **description**: `string` Defined in: [packages/sdk/src/workspace-builder/forms.ts:56](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/forms.ts#L56) *** ### eventRules[​](#eventrules "Direct link to eventRules") > `readonly` **eventRules**: `WorkspaceBuilderEventRule`\[] = `[]` Defined in: [packages/sdk/src/workspace-builder/forms.ts:60](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/forms.ts#L60) *** ### fields[​](#fields "Direct link to fields") > `readonly` **fields**: `WorkspaceFieldDraft`\[] = `[]` Defined in: [packages/sdk/src/workspace-builder/forms.ts:59](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/forms.ts#L59) *** ### name[​](#name-1 "Direct link to name") > `readonly` **name**: `string` Defined in: [packages/sdk/src/workspace-builder/forms.ts:54](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/forms.ts#L54) *** ### prompt[​](#prompt "Direct link to prompt") > `readonly` **prompt**: `string` Defined in: [packages/sdk/src/workspace-builder/forms.ts:57](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/forms.ts#L57) *** ### slug[​](#slug-1 "Direct link to slug") > `readonly` **slug**: `string` Defined in: [packages/sdk/src/workspace-builder/forms.ts:55](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/forms.ts#L55) ## Accessors[​](#accessors "Direct link to Accessors") ### id[​](#id "Direct link to id") #### Get Signature[​](#get-signature "Direct link to Get Signature") > **get** **id**(): `number` Defined in: [packages/sdk/src/workspace-builder/resource.ts:27](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/resource.ts#L27) Server-assigned numeric id — available after apply() or adopt(). ##### Returns[​](#returns-1 "Direct link to Returns") `number` #### Inherited from[​](#inherited-from-4 "Direct link to Inherited from") `WorkspaceBuilderResource.id` *** ### uuid[​](#uuid "Direct link to uuid") #### Get Signature[​](#get-signature-1 "Direct link to Get Signature") > **get** **uuid**(): `string` Defined in: [packages/sdk/src/workspace-builder/resource.ts:38](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/resource.ts#L38) Server-assigned uuid — available after apply() or adopt(). ##### Returns[​](#returns-2 "Direct link to Returns") `string` #### Inherited from[​](#inherited-from-5 "Direct link to Inherited from") `WorkspaceBuilderResource.uuid` ## Methods[​](#methods "Direct link to Methods") ### adopt()[​](#adopt "Direct link to adopt()") > **adopt**(`existing`): `void` Defined in: [packages/sdk/src/workspace-builder/resource.ts:55](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/resource.ts#L55) #### Parameters[​](#parameters-1 "Direct link to Parameters") ##### existing[​](#existing "Direct link to existing") `AnyRecord` #### Returns[​](#returns-3 "Direct link to Returns") `void` #### Inherited from[​](#inherited-from-6 "Direct link to Inherited from") `WorkspaceBuilderResource.adopt` *** ### apply()[​](#apply "Direct link to apply()") > **apply**(`client`): `Promise`<`void`> Defined in: [packages/sdk/src/workspace-builder/forms.ts:208](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/forms.ts#L208) #### Parameters[​](#parameters-2 "Direct link to Parameters") ##### client[​](#client "Direct link to client") [`GravityRailWorkspaceClient`](https://docs.gravityrail.com/sdk/type-aliases/GravityRailWorkspaceClient.md) #### Returns[​](#returns-4 "Direct link to Returns") `Promise`<`void`> #### Overrides[​](#overrides-1 "Direct link to Overrides") `WorkspaceBuilderResource.apply` *** ### arrayField()[​](#arrayfield "Direct link to arrayField()") > **arrayField**(`name`, `slug`, `settings?`): `FormBuilder` Defined in: [packages/sdk/src/workspace-builder/forms.ts:160](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/forms.ts#L160) #### Parameters[​](#parameters-3 "Direct link to Parameters") ##### name[​](#name-2 "Direct link to name") `string` ##### slug[​](#slug-2 "Direct link to slug") `string` ##### settings?[​](#settings "Direct link to settings?") `AnyRecord` = `{}` #### Returns[​](#returns-5 "Direct link to Returns") `FormBuilder` *** ### booleanField()[​](#booleanfield "Direct link to booleanField()") > **booleanField**(`name`, `slug`, `settings?`): `FormBuilder` Defined in: [packages/sdk/src/workspace-builder/forms.ts:124](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/forms.ts#L124) #### Parameters[​](#parameters-4 "Direct link to Parameters") ##### name[​](#name-3 "Direct link to name") `string` ##### slug[​](#slug-3 "Direct link to slug") `string` ##### settings?[​](#settings-1 "Direct link to settings?") `AnyRecord` = `{}` #### Returns[​](#returns-6 "Direct link to Returns") `FormBuilder` *** ### dateField()[​](#datefield "Direct link to dateField()") > **dateField**(`name`, `slug`, `settings?`): `FormBuilder` Defined in: [packages/sdk/src/workspace-builder/forms.ts:120](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/forms.ts#L120) #### Parameters[​](#parameters-5 "Direct link to Parameters") ##### name[​](#name-4 "Direct link to name") `string` ##### slug[​](#slug-4 "Direct link to slug") `string` ##### settings?[​](#settings-2 "Direct link to settings?") `AnyRecord` = `{}` #### Returns[​](#returns-7 "Direct link to Returns") `FormBuilder` *** ### datetimeField()[​](#datetimefield "Direct link to datetimeField()") > **datetimeField**(`name`, `slug`, `settings?`): `FormBuilder` Defined in: [packages/sdk/src/workspace-builder/forms.ts:148](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/forms.ts#L148) #### Parameters[​](#parameters-6 "Direct link to Parameters") ##### name[​](#name-5 "Direct link to name") `string` ##### slug[​](#slug-5 "Direct link to slug") `string` ##### settings?[​](#settings-3 "Direct link to settings?") `AnyRecord` = `{}` #### Returns[​](#returns-8 "Direct link to Returns") `FormBuilder` *** ### emailField()[​](#emailfield "Direct link to emailField()") > **emailField**(`name`, `slug`, `settings?`): `FormBuilder` Defined in: [packages/sdk/src/workspace-builder/forms.ts:132](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/forms.ts#L132) #### Parameters[​](#parameters-7 "Direct link to Parameters") ##### name[​](#name-6 "Direct link to name") `string` ##### slug[​](#slug-6 "Direct link to slug") `string` ##### settings?[​](#settings-4 "Direct link to settings?") `AnyRecord` = `{}` #### Returns[​](#returns-9 "Direct link to Returns") `FormBuilder` *** ### enumField()[​](#enumfield "Direct link to enumField()") > **enumField**(`name`, `slug`, `options`, `settings?`): `FormBuilder` Defined in: [packages/sdk/src/workspace-builder/forms.ts:105](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/forms.ts#L105) #### Parameters[​](#parameters-8 "Direct link to Parameters") ##### name[​](#name-7 "Direct link to name") `string` ##### slug[​](#slug-7 "Direct link to slug") `string` ##### options[​](#options-1 "Direct link to options") `any`\[] ##### settings?[​](#settings-5 "Direct link to settings?") `AnyRecord` = `{}` #### Returns[​](#returns-10 "Direct link to Returns") `FormBuilder` *** ### field()[​](#field "Direct link to field()") > **field**(`fieldType`, `name`, `slug`, `options?`): `FormBuilder` Defined in: [packages/sdk/src/workspace-builder/forms.ts:89](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/forms.ts#L89) #### Parameters[​](#parameters-9 "Direct link to Parameters") ##### fieldType[​](#fieldtype "Direct link to fieldType") [`DataFieldType`](https://docs.gravityrail.com/sdk/enumerations/DataFieldType.md) ##### name[​](#name-8 "Direct link to name") `string` ##### slug[​](#slug-8 "Direct link to slug") `string` ##### options?[​](#options-2 "Direct link to options?") ###### cel?[​](#cel "Direct link to cel?") `string` ###### choices?[​](#choices "Direct link to choices?") `any`\[] ###### description?[​](#description-1 "Direct link to description?") `string` ###### order?[​](#order "Direct link to order?") `number` ###### required?[​](#required "Direct link to required?") `boolean` #### Returns[​](#returns-11 "Direct link to Returns") `FormBuilder` *** ### functionField()[​](#functionfield "Direct link to functionField()") > **functionField**(`name`, `slug`, `cel`, `settings?`): `FormBuilder` Defined in: [packages/sdk/src/workspace-builder/forms.ts:128](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/forms.ts#L128) #### Parameters[​](#parameters-10 "Direct link to Parameters") ##### name[​](#name-9 "Direct link to name") `string` ##### slug[​](#slug-9 "Direct link to slug") `string` ##### cel[​](#cel-1 "Direct link to cel") `string` ##### settings?[​](#settings-6 "Direct link to settings?") `AnyRecord` = `{}` #### Returns[​](#returns-12 "Direct link to Returns") `FormBuilder` *** ### integerField()[​](#integerfield "Direct link to integerField()") > **integerField**(`name`, `slug`, `settings?`): `FormBuilder` Defined in: [packages/sdk/src/workspace-builder/forms.ts:144](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/forms.ts#L144) #### Parameters[​](#parameters-11 "Direct link to Parameters") ##### name[​](#name-10 "Direct link to name") `string` ##### slug[​](#slug-10 "Direct link to slug") `string` ##### settings?[​](#settings-7 "Direct link to settings?") `AnyRecord` = `{}` #### Returns[​](#returns-13 "Direct link to Returns") `FormBuilder` *** ### longtextField()[​](#longtextfield "Direct link to longtextField()") > **longtextField**(`name`, `slug`, `settings?`): `FormBuilder` Defined in: [packages/sdk/src/workspace-builder/forms.ts:140](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/forms.ts#L140) #### Parameters[​](#parameters-12 "Direct link to Parameters") ##### name[​](#name-11 "Direct link to name") `string` ##### slug[​](#slug-11 "Direct link to slug") `string` ##### settings?[​](#settings-8 "Direct link to settings?") `AnyRecord` = `{}` #### Returns[​](#returns-14 "Direct link to Returns") `FormBuilder` *** ### matchKey()[​](#matchkey "Direct link to matchKey()") > **matchKey**(): `string` Defined in: [packages/sdk/src/workspace-builder/forms.ts:200](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/forms.ts#L200) #### Returns[​](#returns-15 "Direct link to Returns") `string` #### Overrides[​](#overrides-2 "Direct link to Overrides") `WorkspaceBuilderResource.matchKey` *** ### numberField()[​](#numberfield "Direct link to numberField()") > **numberField**(`name`, `slug`, `settings?`): `FormBuilder` Defined in: [packages/sdk/src/workspace-builder/forms.ts:116](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/forms.ts#L116) #### Parameters[​](#parameters-13 "Direct link to Parameters") ##### name[​](#name-12 "Direct link to name") `string` ##### slug[​](#slug-12 "Direct link to slug") `string` ##### settings?[​](#settings-9 "Direct link to settings?") `AnyRecord` = `{}` #### Returns[​](#returns-16 "Direct link to Returns") `FormBuilder` *** ### objectField()[​](#objectfield "Direct link to objectField()") > **objectField**(`name`, `slug`, `settings?`): `FormBuilder` Defined in: [packages/sdk/src/workspace-builder/forms.ts:164](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/forms.ts#L164) #### Parameters[​](#parameters-14 "Direct link to Parameters") ##### name[​](#name-13 "Direct link to name") `string` ##### slug[​](#slug-13 "Direct link to slug") `string` ##### settings?[​](#settings-10 "Direct link to settings?") `AnyRecord` = `{}` #### Returns[​](#returns-17 "Direct link to Returns") `FormBuilder` *** ### onRecordCreated()[​](#onrecordcreated "Direct link to onRecordCreated()") > **onRecordCreated**(`action`, `params?`, `condition?`, `name?`): `FormBuilder` Defined in: [packages/sdk/src/workspace-builder/forms.ts:168](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/forms.ts#L168) #### Parameters[​](#parameters-15 "Direct link to Parameters") ##### action[​](#action "Direct link to action") `string` ##### params?[​](#params "Direct link to params?") `AnyRecord` = `{}` ##### condition?[​](#condition "Direct link to condition?") `string` ##### name?[​](#name-14 "Direct link to name?") `string` #### Returns[​](#returns-18 "Direct link to Returns") `FormBuilder` *** ### onRecordUpdated()[​](#onrecordupdated "Direct link to onRecordUpdated()") > **onRecordUpdated**(`action`, `params?`, `condition?`, `name?`): `FormBuilder` Defined in: [packages/sdk/src/workspace-builder/forms.ts:184](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/forms.ts#L184) #### Parameters[​](#parameters-16 "Direct link to Parameters") ##### action[​](#action-1 "Direct link to action") `string` ##### params?[​](#params-1 "Direct link to params?") `AnyRecord` = `{}` ##### condition?[​](#condition-1 "Direct link to condition?") `string` ##### name?[​](#name-15 "Direct link to name?") `string` #### Returns[​](#returns-19 "Direct link to Returns") `FormBuilder` *** ### phoneField()[​](#phonefield "Direct link to phoneField()") > **phoneField**(`name`, `slug`, `settings?`): `FormBuilder` Defined in: [packages/sdk/src/workspace-builder/forms.ts:136](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/forms.ts#L136) #### Parameters[​](#parameters-17 "Direct link to Parameters") ##### name[​](#name-16 "Direct link to name") `string` ##### slug[​](#slug-14 "Direct link to slug") `string` ##### settings?[​](#settings-11 "Direct link to settings?") `AnyRecord` = `{}` #### Returns[​](#returns-20 "Direct link to Returns") `FormBuilder` *** ### planLine()[​](#planline "Direct link to planLine()") > **planLine**(): `string` Defined in: [packages/sdk/src/workspace-builder/forms.ts:204](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/forms.ts#L204) #### Returns[​](#returns-21 "Direct link to Returns") `string` #### Overrides[​](#overrides-3 "Direct link to Overrides") `WorkspaceBuilderResource.planLine` *** ### textField()[​](#textfield "Direct link to textField()") > **textField**(`name`, `slug`, `settings?`): `FormBuilder` Defined in: [packages/sdk/src/workspace-builder/forms.ts:112](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/forms.ts#L112) #### Parameters[​](#parameters-18 "Direct link to Parameters") ##### name[​](#name-17 "Direct link to name") `string` ##### slug[​](#slug-15 "Direct link to slug") `string` ##### settings?[​](#settings-12 "Direct link to settings?") `AnyRecord` = `{}` #### Returns[​](#returns-22 "Direct link to Returns") `FormBuilder` *** ### timeOfDayField()[​](#timeofdayfield "Direct link to timeOfDayField()") > **timeOfDayField**(`name`, `slug`, `settings?`): `FormBuilder` Defined in: [packages/sdk/src/workspace-builder/forms.ts:152](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/forms.ts#L152) #### Parameters[​](#parameters-19 "Direct link to Parameters") ##### name[​](#name-18 "Direct link to name") `string` ##### slug[​](#slug-16 "Direct link to slug") `string` ##### settings?[​](#settings-13 "Direct link to settings?") `AnyRecord` = `{}` #### Returns[​](#returns-23 "Direct link to Returns") `FormBuilder` *** ### usZipCodeField()[​](#uszipcodefield "Direct link to usZipCodeField()") > **usZipCodeField**(`name`, `slug`, `settings?`): `FormBuilder` Defined in: [packages/sdk/src/workspace-builder/forms.ts:156](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/forms.ts#L156) #### Parameters[​](#parameters-20 "Direct link to Parameters") ##### name[​](#name-19 "Direct link to name") `string` ##### slug[​](#slug-17 "Direct link to slug") `string` ##### settings?[​](#settings-14 "Direct link to settings?") `AnyRecord` = `{}` #### Returns[​](#returns-24 "Direct link to Returns") `FormBuilder` --- # Class: GravityRailClient Defined in: [packages/sdk/src/client/client.ts:82](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L82) GravityRailClient provides a unified interface to all public Gravity Rail API endpoints. Methods are organized by domain and bound to their respective API modules. See the bindings directory for the organization of methods by domain. This class excludes admin/superuser methods. The full client including admin functionality (`ApiClient`) lives in the private `@gravity-rail/client` package and extends this class. ## Implements[​](#implements "Direct link to Implements") * `TasksBindings` * `ChatsBindings` * `CallsBindings` * `DataTypesBindings` * `MembersBindings` * `WorkspacesBindings` * `AuthBindings` * `SitesBindings` * `FilesBindings` * `EventsBindings` * `ExperimentsBindings` * `WorkflowsBindings` * `CalendarsBindings` * `CommunicationsBindings` * `ToolkitsBindings` * `BillingBindings` * `AppsBindings` * `IntegrationsBindings` * `AgentTasksBindings` * `AgentsBindings` * `PronunciationsBindings` * `QualificationsBindings` * `PersonasBindings` * `QueriesBindings` * `CustomersBindings` * `ResellersBindings` * `JourneysBindings` * `OperatorBindings` * `OrgBindings` * `AccessGrantsBindings` * `PromptsBindings` * `SupportRequestsBindings` ## Constructors[​](#constructors "Direct link to Constructors") ### Constructor[​](#constructor "Direct link to Constructor") > **new GravityRailClient**(`apiKey`, `baseUrl`, `customFetch?`): `GravityRailClient` Defined in: [packages/sdk/src/client/client.ts:1096](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L1096) #### Parameters[​](#parameters "Direct link to Parameters") ##### apiKey[​](#apikey "Direct link to apiKey") `string` | `undefined` ##### baseUrl[​](#baseurl "Direct link to baseUrl") `string` ##### customFetch?[​](#customfetch "Direct link to customFetch?") {(`input`, `init?`): `Promise`<`Response`>; (`input`, `init?`): `Promise`<`Response`>; } #### Returns[​](#returns "Direct link to Returns") `GravityRailClient` ## Properties[​](#properties "Direct link to Properties") ### acceptInvitation()[​](#acceptinvitation "Direct link to acceptInvitation()") > **acceptInvitation**: (`requestId`) => `Promise`<[`InvitationResponse`](https://docs.gravityrail.com/sdk/type-aliases/InvitationResponse.md)> Defined in: [packages/sdk/src/client/client.ts:482](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L482) Accept an invitation by ID (for invitees accepting their own invitations) Works for both organization and workspace invitations. #### Parameters[​](#parameters-1 "Direct link to Parameters") ##### requestId[​](#requestid "Direct link to requestId") `number` #### Returns[​](#returns-1 "Direct link to Returns") `Promise`<[`InvitationResponse`](https://docs.gravityrail.com/sdk/type-aliases/InvitationResponse.md)> #### Implementation of[​](#implementation-of "Direct link to Implementation of") `WorkspacesBindings.acceptInvitation` *** ### activateWorkflowVersion()[​](#activateworkflowversion "Direct link to activateWorkflowVersion()") > **activateWorkflowVersion**: (`wid`, `workflowUuid`, `versionNumber`) => `Promise`<`WorkflowVersionResponse`> Defined in: [packages/sdk/src/client/client.ts:677](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L677) Activate a published version. #### Parameters[​](#parameters-2 "Direct link to Parameters") ##### wid[​](#wid "Direct link to wid") `string` ##### workflowUuid[​](#workflowuuid "Direct link to workflowUuid") `string` ##### versionNumber[​](#versionnumber "Direct link to versionNumber") `number` #### Returns[​](#returns-2 "Direct link to Returns") `Promise`<`WorkflowVersionResponse`> #### Implementation of[​](#implementation-of-1 "Direct link to Implementation of") `WorkflowsBindings.activateWorkflowVersion` *** ### addGroupMember()[​](#addgroupmember "Direct link to addGroupMember()") > **addGroupMember**: (`wid`, `groupId`, `data`) => `Promise`<[`OperatorGroupMemberResponse`](https://docs.gravityrail.com/sdk/interfaces/OperatorGroupMemberResponse.md)> Defined in: [packages/sdk/src/client/client.ts:377](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L377) Add a member to an operator group. #### Parameters[​](#parameters-3 "Direct link to Parameters") ##### wid[​](#wid-1 "Direct link to wid") `string` ##### groupId[​](#groupid "Direct link to groupId") `number` ##### data[​](#data "Direct link to data") [`AddGroupMemberRequest`](https://docs.gravityrail.com/sdk/interfaces/AddGroupMemberRequest.md) #### Returns[​](#returns-3 "Direct link to Returns") `Promise`<[`OperatorGroupMemberResponse`](https://docs.gravityrail.com/sdk/interfaces/OperatorGroupMemberResponse.md)> #### Implementation of[​](#implementation-of-2 "Direct link to Implementation of") `OperatorBindings.addGroupMember` *** ### addWorkspaceToSubscription()[​](#addworkspacetosubscription "Direct link to addWorkspaceToSubscription()") > **addWorkspaceToSubscription**: (`subscriptionId`, `data`) => `Promise`<{ `itemsCreated`: `number`; `subscriptionId`: `number`; `success`: `boolean`; `workspaceId`: `number`; }> Defined in: [packages/sdk/src/client/client.ts:817](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L817) Add a workspace to an existing subscription. #### Parameters[​](#parameters-4 "Direct link to Parameters") ##### subscriptionId[​](#subscriptionid "Direct link to subscriptionId") `number` ##### data[​](#data-1 "Direct link to data") ###### name?[​](#name "Direct link to name?") `string` ###### plan\_period?[​](#plan_period "Direct link to plan_period?") `string` ###### product\_id[​](#product_id "Direct link to product_id") `number` ###### slug?[​](#slug "Direct link to slug?") `string` ###### template\_workspace\_uuid?[​](#template_workspace_uuid "Direct link to template_workspace_uuid?") `string` ###### workspace\_id[​](#workspace_id "Direct link to workspace_id") `number` #### Returns[​](#returns-4 "Direct link to Returns") `Promise`<{ `itemsCreated`: `number`; `subscriptionId`: `number`; `success`: `boolean`; `workspaceId`: `number`; }> #### Implementation of[​](#implementation-of-3 "Direct link to Implementation of") `BillingBindings.addWorkspaceToSubscription` *** ### advanceStep()[​](#advancestep "Direct link to advanceStep()") > **advanceStep**: (`wid`, `journeyId`, `stepUuid`, `data`) => `Promise`<`MemberJourneyStep`> Defined in: [packages/sdk/src/client/client.ts:348](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L348) Advance a journey step in the current execution context. #### Parameters[​](#parameters-5 "Direct link to Parameters") ##### wid[​](#wid-2 "Direct link to wid") `string` ##### journeyId[​](#journeyid "Direct link to journeyId") `number` ##### stepUuid[​](#stepuuid "Direct link to stepUuid") `string` ##### data?[​](#data-2 "Direct link to data?") `AdvanceStepFormData` = `{}` #### Returns[​](#returns-5 "Direct link to Returns") `Promise`<`MemberJourneyStep`> #### Implementation of[​](#implementation-of-4 "Direct link to Implementation of") `JourneysBindings.advanceStep` *** ### approveWorkspaceInvitation()[​](#approveworkspaceinvitation "Direct link to approveWorkspaceInvitation()") > **approveWorkspaceInvitation**: (`workspaceUuid`, `invitationId`) => `Promise`<[`InvitationResponse`](https://docs.gravityrail.com/sdk/type-aliases/InvitationResponse.md)> Defined in: [packages/sdk/src/client/client.ts:478](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L478) Approve an invitation (grant access) - requires workspace admin permission. #### Parameters[​](#parameters-6 "Direct link to Parameters") ##### workspaceUuid[​](#workspaceuuid "Direct link to workspaceUuid") `string` ##### invitationId[​](#invitationid "Direct link to invitationId") `number` #### Returns[​](#returns-6 "Direct link to Returns") `Promise`<[`InvitationResponse`](https://docs.gravityrail.com/sdk/type-aliases/InvitationResponse.md)> #### Implementation of[​](#implementation-of-5 "Direct link to Implementation of") `WorkspacesBindings.approveWorkspaceInvitation` *** ### archiveAgent()[​](#archiveagent "Direct link to archiveAgent()") > **archiveAgent**: (`wid`, `id`) => `Promise`<[`AgentResponse`](https://docs.gravityrail.com/sdk/interfaces/AgentResponse.md)> Defined in: [packages/sdk/src/client/client.ts:291](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L291) Archive an agent, hiding it from default listings. #### Parameters[​](#parameters-7 "Direct link to Parameters") ##### wid[​](#wid-3 "Direct link to wid") `string` ##### id[​](#id "Direct link to id") `number` #### Returns[​](#returns-7 "Direct link to Returns") `Promise`<[`AgentResponse`](https://docs.gravityrail.com/sdk/interfaces/AgentResponse.md)> #### Implementation of[​](#implementation-of-6 "Direct link to Implementation of") `AgentsBindings.archiveAgent` *** ### archiveChat()[​](#archivechat "Direct link to archiveChat()") > **archiveChat**: (`wid`, `id`) => `Promise`<`void`> Defined in: [packages/sdk/src/client/client.ts:150](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L150) Archive a chat. #### Parameters[​](#parameters-8 "Direct link to Parameters") ##### wid[​](#wid-4 "Direct link to wid") `string` ##### id[​](#id-1 "Direct link to id") `number` #### Returns[​](#returns-8 "Direct link to Returns") `Promise`<`void`> #### Implementation of[​](#implementation-of-7 "Direct link to Implementation of") `ChatsBindings.archiveChat` *** ### archiveDataType()[​](#archivedatatype "Direct link to archiveDataType()") > **archiveDataType**: (`wid`, `id`) => `Promise`<{ `status`: `string`; }> Defined in: [packages/sdk/src/client/client.ts:203](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L203) Archive a data type, hiding it from default listings. #### Parameters[​](#parameters-9 "Direct link to Parameters") ##### wid[​](#wid-5 "Direct link to wid") `string` ##### id[​](#id-2 "Direct link to id") `number` #### Returns[​](#returns-9 "Direct link to Returns") `Promise`<{ `status`: `string`; }> #### Implementation of[​](#implementation-of-8 "Direct link to Implementation of") `DataTypesBindings.archiveDataType` *** ### archiveJourney()[​](#archivejourney "Direct link to archiveJourney()") > **archiveJourney**: (`wid`, `journeyId`) => `Promise`<{ `status`: `string`; }> Defined in: [packages/sdk/src/client/client.ts:330](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L330) Archive a journey (soft delete). #### Parameters[​](#parameters-10 "Direct link to Parameters") ##### wid[​](#wid-6 "Direct link to wid") `string` ##### journeyId[​](#journeyid-1 "Direct link to journeyId") `number` #### Returns[​](#returns-10 "Direct link to Returns") `Promise`<{ `status`: `string`; }> #### Implementation of[​](#implementation-of-9 "Direct link to Implementation of") `JourneysBindings.archiveJourney` *** ### archiveMember()[​](#archivemember "Direct link to archiveMember()") > **archiveMember**: (`wid`, `memberId`) => `Promise`<[`WorkspaceMemberResponse`](https://docs.gravityrail.com/sdk/interfaces/WorkspaceMemberResponse.md)> Defined in: [packages/sdk/src/client/client.ts:229](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L229) Archive a workspace member. #### Parameters[​](#parameters-11 "Direct link to Parameters") ##### wid[​](#wid-7 "Direct link to wid") `string` ##### memberId[​](#memberid "Direct link to memberId") `number` #### Returns[​](#returns-11 "Direct link to Returns") `Promise`<[`WorkspaceMemberResponse`](https://docs.gravityrail.com/sdk/interfaces/WorkspaceMemberResponse.md)> #### Implementation of[​](#implementation-of-10 "Direct link to Implementation of") `MembersBindings.archiveMember` *** ### archivePhoneNumber()[​](#archivephonenumber "Direct link to archivePhoneNumber()") > **archivePhoneNumber**: (`wid`, `id`) => `Promise`<[`PhoneNumber`](https://docs.gravityrail.com/sdk/interfaces/PhoneNumber.md)> Defined in: [packages/sdk/src/client/client.ts:738](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L738) Archive a phone number, releasing the Twilio number back to the pool. #### Parameters[​](#parameters-12 "Direct link to Parameters") ##### wid[​](#wid-8 "Direct link to wid") `string` ##### id[​](#id-3 "Direct link to id") `number` #### Returns[​](#returns-12 "Direct link to Returns") `Promise`<[`PhoneNumber`](https://docs.gravityrail.com/sdk/interfaces/PhoneNumber.md)> #### Implementation of[​](#implementation-of-11 "Direct link to Implementation of") `CommunicationsBindings.archivePhoneNumber` *** ### archiveStep()[​](#archivestep "Direct link to archiveStep()") > **archiveStep**: (`wid`, `journeyId`, `stepUuid`) => `Promise`<{ `status`: `string`; }> Defined in: [packages/sdk/src/client/client.ts:333](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L333) Archive a step (soft delete). #### Parameters[​](#parameters-13 "Direct link to Parameters") ##### wid[​](#wid-9 "Direct link to wid") `string` ##### journeyId[​](#journeyid-2 "Direct link to journeyId") `number` ##### stepUuid[​](#stepuuid-1 "Direct link to stepUuid") `string` #### Returns[​](#returns-13 "Direct link to Returns") `Promise`<{ `status`: `string`; }> #### Implementation of[​](#implementation-of-12 "Direct link to Implementation of") `JourneysBindings.archiveStep` *** ### archiveTask()[​](#archivetask "Direct link to archiveTask()") > **archiveTask**: (`wid`, `id`) => `Promise`<[`Task`](https://docs.gravityrail.com/sdk/type-aliases/Task.md)> Defined in: [packages/sdk/src/client/client.ts:129](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L129) Archive a task, hiding it from default listings. #### Parameters[​](#parameters-14 "Direct link to Parameters") ##### wid[​](#wid-10 "Direct link to wid") `string` ##### id[​](#id-4 "Direct link to id") `number` #### Returns[​](#returns-14 "Direct link to Returns") `Promise`<[`Task`](https://docs.gravityrail.com/sdk/type-aliases/Task.md)> #### Implementation of[​](#implementation-of-13 "Direct link to Implementation of") `TasksBindings.archiveTask` *** ### archiveWorkflow()[​](#archiveworkflow "Direct link to archiveWorkflow()") > **archiveWorkflow**: (`wid`, `id`) => `Promise`<{ `status`: `string`; }> Defined in: [packages/sdk/src/client/client.ts:655](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L655) Archive a workflow. #### Parameters[​](#parameters-15 "Direct link to Parameters") ##### wid[​](#wid-11 "Direct link to wid") `string` ##### id[​](#id-5 "Direct link to id") `number` #### Returns[​](#returns-15 "Direct link to Returns") `Promise`<{ `status`: `string`; }> #### Implementation of[​](#implementation-of-14 "Direct link to Implementation of") `WorkflowsBindings.archiveWorkflow` *** ### attachMyCustomerPaymentMethod()[​](#attachmycustomerpaymentmethod "Direct link to attachMyCustomerPaymentMethod()") > **attachMyCustomerPaymentMethod**: (`uuid`, `paymentMethodId`, `setAsDefault`) => `Promise`<{ `message`: `string`; `paymentMethodId`: `string`; `success`: `boolean`; `type`: `string`; }> Defined in: [packages/sdk/src/client/client.ts:1066](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L1066) #### Parameters[​](#parameters-16 "Direct link to Parameters") ##### uuid[​](#uuid "Direct link to uuid") `string` ##### paymentMethodId[​](#paymentmethodid "Direct link to paymentMethodId") `string` ##### setAsDefault?[​](#setasdefault "Direct link to setAsDefault?") `boolean` = `false` #### Returns[​](#returns-16 "Direct link to Returns") `Promise`<{ `message`: `string`; `paymentMethodId`: `string`; `success`: `boolean`; `type`: `string`; }> #### Implementation of[​](#implementation-of-15 "Direct link to Implementation of") `CustomersBindings.attachMyCustomerPaymentMethod` *** ### authorize()[​](#authorize "Direct link to authorize()") > **authorize**: (`request`) => `Promise`<[`AuthorizeResponse`](https://docs.gravityrail.com/sdk/interfaces/AuthorizeResponse.md)> Defined in: [packages/sdk/src/client/client.ts:848](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L848) #### Parameters[​](#parameters-17 "Direct link to Parameters") ##### request[​](#request "Direct link to request") [`AuthorizeRequest`](https://docs.gravityrail.com/sdk/interfaces/AuthorizeRequest.md) #### Returns[​](#returns-17 "Direct link to Returns") `Promise`<[`AuthorizeResponse`](https://docs.gravityrail.com/sdk/interfaces/AuthorizeResponse.md)> #### Implementation of[​](#implementation-of-16 "Direct link to Implementation of") `AppsBindings.authorize` *** ### authorizeMondayConnection()[​](#authorizemondayconnection "Direct link to authorizeMondayConnection()") > **authorizeMondayConnection**: (`wid`) => `Promise`<{ `authorizeUrl`: `string`; }> Defined in: [packages/sdk/src/client/client.ts:865](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L865) #### Parameters[​](#parameters-18 "Direct link to Parameters") ##### wid[​](#wid-12 "Direct link to wid") `string` #### Returns[​](#returns-18 "Direct link to Returns") `Promise`<{ `authorizeUrl`: `string`; }> #### Implementation of[​](#implementation-of-17 "Direct link to Implementation of") `IntegrationsBindings.authorizeMondayConnection` *** ### autoCreateDataTypeFromBoard()[​](#autocreatedatatypefromboard "Direct link to autoCreateDataTypeFromBoard()") > **autoCreateDataTypeFromBoard**: (`wid`, `boardId`) => `Promise`<{ `dataTypeId`: `number`; `dataTypeName`: `string`; `fieldCount`: `number`; `warnings?`: `string`\[]; }> Defined in: [packages/sdk/src/client/client.ts:883](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L883) #### Parameters[​](#parameters-19 "Direct link to Parameters") ##### wid[​](#wid-13 "Direct link to wid") `string` ##### boardId[​](#boardid "Direct link to boardId") `string` #### Returns[​](#returns-19 "Direct link to Returns") `Promise`<{ `dataTypeId`: `number`; `dataTypeName`: `string`; `fieldCount`: `number`; `warnings?`: `string`\[]; }> #### Implementation of[​](#implementation-of-18 "Direct link to Implementation of") `IntegrationsBindings.autoCreateDataTypeFromBoard` *** ### blockWorkspaceInvitation()[​](#blockworkspaceinvitation "Direct link to blockWorkspaceInvitation()") > **blockWorkspaceInvitation**: (`workspaceUuid`, `invitationId`) => `Promise`<[`InvitationResponse`](https://docs.gravityrail.com/sdk/type-aliases/InvitationResponse.md)> Defined in: [packages/sdk/src/client/client.ts:480](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L480) Block an invitation - requires workspace admin permission. #### Parameters[​](#parameters-20 "Direct link to Parameters") ##### workspaceUuid[​](#workspaceuuid-1 "Direct link to workspaceUuid") `string` ##### invitationId[​](#invitationid-1 "Direct link to invitationId") `number` #### Returns[​](#returns-20 "Direct link to Returns") `Promise`<[`InvitationResponse`](https://docs.gravityrail.com/sdk/type-aliases/InvitationResponse.md)> #### Implementation of[​](#implementation-of-19 "Direct link to Implementation of") `WorkspacesBindings.blockWorkspaceInvitation` *** ### bookHealthieAppointment()[​](#bookhealthieappointment "Direct link to bookHealthieAppointment()") > **bookHealthieAppointment**: (`wid`, `request`) => `Promise`<`BookingResultResponse`> Defined in: [packages/sdk/src/client/client.ts:969](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L969) #### Parameters[​](#parameters-21 "Direct link to Parameters") ##### wid[​](#wid-14 "Direct link to wid") `string` ##### request[​](#request-1 "Direct link to request") `BookAppointmentRequest` #### Returns[​](#returns-21 "Direct link to Returns") `Promise`<`BookingResultResponse`> #### Implementation of[​](#implementation-of-20 "Direct link to Implementation of") `IntegrationsBindings.bookHealthieAppointment` *** ### buildSiteSource()[​](#buildsitesource "Direct link to buildSiteSource()") > **buildSiteSource**: (`wid`, `siteId`) => `Promise`<[`SiteSourcePublishResponse`](https://docs.gravityrail.com/sdk/interfaces/SiteSourcePublishResponse.md)> Defined in: [packages/sdk/src/client/client.ts:551](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L551) Build a site's source without publishing. #### Parameters[​](#parameters-22 "Direct link to Parameters") ##### wid[​](#wid-15 "Direct link to wid") `string` ##### siteId[​](#siteid "Direct link to siteId") `number` #### Returns[​](#returns-22 "Direct link to Returns") `Promise`<[`SiteSourcePublishResponse`](https://docs.gravityrail.com/sdk/interfaces/SiteSourcePublishResponse.md)> #### Implementation of[​](#implementation-of-21 "Direct link to Implementation of") `SitesBindings.buildSiteSource` *** ### buildWorkspace()[​](#buildworkspace "Direct link to buildWorkspace()") > **buildWorkspace**: (`wid`, `builderId`, `params`) => `Promise`<[`BuildWorkspaceResponse`](https://docs.gravityrail.com/sdk/interfaces/BuildWorkspaceResponse.md)> Defined in: [packages/sdk/src/client/client.ts:682](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L682) Build and import a workflow from a builder template in one step. Returns the created workflow ID and UUID. #### Parameters[​](#parameters-23 "Direct link to Parameters") ##### wid[​](#wid-16 "Direct link to wid") `string` ##### builderId[​](#builderid "Direct link to builderId") `string` ##### params[​](#params "Direct link to params") `Record`<`string`, `unknown`> #### Returns[​](#returns-23 "Direct link to Returns") `Promise`<[`BuildWorkspaceResponse`](https://docs.gravityrail.com/sdk/interfaces/BuildWorkspaceResponse.md)> #### Implementation of[​](#implementation-of-22 "Direct link to Implementation of") `WorkflowsBindings.buildWorkspace` *** ### bulkCreateMembers()[​](#bulkcreatemembers "Direct link to bulkCreateMembers()") > **bulkCreateMembers**: (`wid`, `request`) => `Promise`<[`BulkCreateMembersResponse`](https://docs.gravityrail.com/sdk/interfaces/BulkCreateMembersResponse.md)> Defined in: [packages/sdk/src/client/client.ts:232](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L232) Bulk-create members in a workspace. #### Parameters[​](#parameters-24 "Direct link to Parameters") ##### wid[​](#wid-17 "Direct link to wid") `string` ##### request[​](#request-2 "Direct link to request") [`BulkCreateMembersRequest`](https://docs.gravityrail.com/sdk/interfaces/BulkCreateMembersRequest.md) #### Returns[​](#returns-24 "Direct link to Returns") `Promise`<[`BulkCreateMembersResponse`](https://docs.gravityrail.com/sdk/interfaces/BulkCreateMembersResponse.md)> #### Implementation of[​](#implementation-of-23 "Direct link to Implementation of") `MembersBindings.bulkCreateMembers` *** ### bulkLinkMembersToHubspot()[​](#bulklinkmemberstohubspot "Direct link to bulkLinkMembersToHubspot()") > **bulkLinkMembersToHubspot**: (`wid`, `data`) => `Promise`<{ `linked`: `number`; }> Defined in: [packages/sdk/src/client/client.ts:1011](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L1011) #### Parameters[​](#parameters-25 "Direct link to Parameters") ##### wid[​](#wid-18 "Direct link to wid") `string` ##### data[​](#data-3 "Direct link to data") `BulkLinkHubspotRequest` #### Returns[​](#returns-25 "Direct link to Returns") `Promise`<{ `linked`: `number`; }> #### Implementation of[​](#implementation-of-24 "Direct link to Implementation of") `IntegrationsBindings.bulkLinkMembersToHubspot` *** ### bulkLinkMembersToMonday()[​](#bulklinkmemberstomonday "Direct link to bulkLinkMembersToMonday()") > **bulkLinkMembersToMonday**: (`wid`, `data`) => `Promise`<{ `linked`: `number`; }> Defined in: [packages/sdk/src/client/client.ts:879](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L879) #### Parameters[​](#parameters-26 "Direct link to Parameters") ##### wid[​](#wid-19 "Direct link to wid") `string` ##### data[​](#data-4 "Direct link to data") `BulkLinkMondayRequest` #### Returns[​](#returns-26 "Direct link to Returns") `Promise`<{ `linked`: `number`; }> #### Implementation of[​](#implementation-of-25 "Direct link to Implementation of") `IntegrationsBindings.bulkLinkMembersToMonday` *** ### bulkLinkMembersToSalesforce()[​](#bulklinkmemberstosalesforce "Direct link to bulkLinkMembersToSalesforce()") > **bulkLinkMembersToSalesforce**: (`wid`, `data`) => `Promise`<{ `linked`: `number`; }> Defined in: [packages/sdk/src/client/client.ts:992](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L992) #### Parameters[​](#parameters-27 "Direct link to Parameters") ##### wid[​](#wid-20 "Direct link to wid") `string` ##### data[​](#data-5 "Direct link to data") `BulkLinkSalesforceRequest` #### Returns[​](#returns-27 "Direct link to Returns") `Promise`<{ `linked`: `number`; }> #### Implementation of[​](#implementation-of-26 "Direct link to Implementation of") `IntegrationsBindings.bulkLinkMembersToSalesforce` *** ### cancelAgentTask()[​](#cancelagenttask "Direct link to cancelAgentTask()") > **cancelAgentTask**: (`wid`, `taskUuid`) => `Promise`<`CancelAgentTaskResponse`> Defined in: [packages/sdk/src/client/client.ts:282](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L282) #### Parameters[​](#parameters-28 "Direct link to Parameters") ##### wid[​](#wid-21 "Direct link to wid") `string` ##### taskUuid[​](#taskuuid "Direct link to taskUuid") `string` #### Returns[​](#returns-28 "Direct link to Returns") `Promise`<`CancelAgentTaskResponse`> #### Implementation of[​](#implementation-of-27 "Direct link to Implementation of") `AgentTasksBindings.cancelAgentTask` *** ### cancelAssignment()[​](#cancelassignment "Direct link to cancelAssignment()") > **cancelAssignment**: (`wid`, `id`, `data?`) => `Promise`<[`AssignmentResponse`](https://docs.gravityrail.com/sdk/interfaces/AssignmentResponse.md)> Defined in: [packages/sdk/src/client/client.ts:537](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L537) Cancel an active assignment with an optional reason. #### Parameters[​](#parameters-29 "Direct link to Parameters") ##### wid[​](#wid-22 "Direct link to wid") `string` ##### id[​](#id-6 "Direct link to id") `number` ##### data?[​](#data-6 "Direct link to data?") ###### reason?[​](#reason "Direct link to reason?") `string` #### Returns[​](#returns-29 "Direct link to Returns") `Promise`<[`AssignmentResponse`](https://docs.gravityrail.com/sdk/interfaces/AssignmentResponse.md)> #### Implementation of[​](#implementation-of-28 "Direct link to Implementation of") `AuthBindings.cancelAssignment` *** ### cancelBusinessProfile()[​](#cancelbusinessprofile "Direct link to cancelBusinessProfile()") > **cancelBusinessProfile**: (`orgUuid`) => `Promise`<[`BusinessProfileCancelResponse`](https://docs.gravityrail.com/sdk/interfaces/BusinessProfileCancelResponse.md)> Defined in: [packages/sdk/src/client/client.ts:464](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L464) Cancel an in-flight Twilio review. Resets the cached profile state to `draft` so the user can edit and resubmit. #### Parameters[​](#parameters-30 "Direct link to Parameters") ##### orgUuid[​](#orguuid "Direct link to orgUuid") `string` #### Returns[​](#returns-30 "Direct link to Returns") `Promise`<[`BusinessProfileCancelResponse`](https://docs.gravityrail.com/sdk/interfaces/BusinessProfileCancelResponse.md)> #### Implementation of[​](#implementation-of-29 "Direct link to Implementation of") `OrgBindings.cancelBusinessProfile` *** ### cancelCalendarEvent()[​](#cancelcalendarevent "Direct link to cancelCalendarEvent()") > **cancelCalendarEvent**: (`wid`, `eventId`, `reason?`) => `Promise`<[`EventResponse`](https://docs.gravityrail.com/sdk/interfaces/EventResponse.md)> Defined in: [packages/sdk/src/client/client.ts:708](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L708) Cancel a calendar event with an optional reason. #### Parameters[​](#parameters-31 "Direct link to Parameters") ##### wid[​](#wid-23 "Direct link to wid") `string` ##### eventId[​](#eventid "Direct link to eventId") `number` ##### reason?[​](#reason-1 "Direct link to reason?") `string` #### Returns[​](#returns-31 "Direct link to Returns") `Promise`<[`EventResponse`](https://docs.gravityrail.com/sdk/interfaces/EventResponse.md)> #### Implementation of[​](#implementation-of-30 "Direct link to Implementation of") `CalendarsBindings.cancelCalendarEvent` *** ### cancelChatCallback()[​](#cancelchatcallback "Direct link to cancelChatCallback()") > **cancelChatCallback**: (`wid`, `chatId`, `callbackId`) => `Promise`<[`ScheduledCallbackResponse`](https://docs.gravityrail.com/sdk/interfaces/ScheduledCallbackResponse.md)> Defined in: [packages/sdk/src/client/client.ts:143](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L143) Cancel a pending scheduled callback on a chat. #### Parameters[​](#parameters-32 "Direct link to Parameters") ##### wid[​](#wid-24 "Direct link to wid") `string` ##### chatId[​](#chatid "Direct link to chatId") `number` ##### callbackId[​](#callbackid "Direct link to callbackId") `number` #### Returns[​](#returns-32 "Direct link to Returns") `Promise`<[`ScheduledCallbackResponse`](https://docs.gravityrail.com/sdk/interfaces/ScheduledCallbackResponse.md)> #### Implementation of[​](#implementation-of-31 "Direct link to Implementation of") `ChatsBindings.cancelChatCallback` *** ### cancelCredentialChange()[​](#cancelcredentialchange "Direct link to cancelCredentialChange()") > **cancelCredentialChange**: (`requestId`) => `Promise`<[`CancelCredentialChangeResponse`](https://docs.gravityrail.com/sdk/interfaces/CancelCredentialChangeResponse.md)> Defined in: [packages/sdk/src/client/client.ts:522](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L522) Cancel a pending credential change request. #### Parameters[​](#parameters-33 "Direct link to Parameters") ##### requestId[​](#requestid-1 "Direct link to requestId") `number` #### Returns[​](#returns-33 "Direct link to Returns") `Promise`<[`CancelCredentialChangeResponse`](https://docs.gravityrail.com/sdk/interfaces/CancelCredentialChangeResponse.md)> #### Implementation of[​](#implementation-of-32 "Direct link to Implementation of") `AuthBindings.cancelCredentialChange` *** ### cancelCredentialUpdateInvite()[​](#cancelcredentialupdateinvite "Direct link to cancelCredentialUpdateInvite()") > **cancelCredentialUpdateInvite**: (`wid`, `inviteId`) => `Promise`<[`CancelCredentialChangeInviteResponse`](https://docs.gravityrail.com/sdk/interfaces/CancelCredentialChangeInviteResponse.md)> Defined in: [packages/sdk/src/client/client.ts:264](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L264) Cancel a pending credential update invitation. Admin-only. #### Parameters[​](#parameters-34 "Direct link to Parameters") ##### wid[​](#wid-25 "Direct link to wid") `string` ##### inviteId[​](#inviteid "Direct link to inviteId") `number` #### Returns[​](#returns-34 "Direct link to Returns") `Promise`<[`CancelCredentialChangeInviteResponse`](https://docs.gravityrail.com/sdk/interfaces/CancelCredentialChangeInviteResponse.md)> #### Implementation of[​](#implementation-of-33 "Direct link to Implementation of") `MembersBindings.cancelCredentialUpdateInvite` *** ### cancelSubscription()[​](#cancelsubscription "Direct link to cancelSubscription()") > **cancelSubscription**: (`subscriptionId`) => `Promise`<`void`> Defined in: [packages/sdk/src/client/client.ts:814](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L814) Cancel an active subscription. #### Parameters[​](#parameters-35 "Direct link to Parameters") ##### subscriptionId[​](#subscriptionid-1 "Direct link to subscriptionId") `number` #### Returns[​](#returns-35 "Direct link to Returns") `Promise`<`void`> #### Implementation of[​](#implementation-of-34 "Direct link to Implementation of") `BillingBindings.cancelSubscription` *** ### changePassword()[​](#changepassword "Direct link to changePassword()") > **changePassword**: (`currentPassword`, `newPassword`) => `Promise`<{ `message`: `string`; `success`: `boolean`; }> Defined in: [packages/sdk/src/client/client.ts:497](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L497) Change the current account password by providing the existing password. #### Parameters[​](#parameters-36 "Direct link to Parameters") ##### currentPassword[​](#currentpassword "Direct link to currentPassword") `string` ##### newPassword[​](#newpassword "Direct link to newPassword") `string` #### Returns[​](#returns-36 "Direct link to Returns") `Promise`<{ `message`: `string`; `success`: `boolean`; }> #### Implementation of[​](#implementation-of-35 "Direct link to Implementation of") `AuthBindings.changePassword` *** ### checkAvailability()[​](#checkavailability "Direct link to checkAvailability()") > **checkAvailability**: (`wid`, `calendarId`, `check`) => `Promise`<[`AvailabilityResponse`](https://docs.gravityrail.com/sdk/interfaces/AvailabilityResponse.md)> Defined in: [packages/sdk/src/client/client.ts:702](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L702) Check availability for a time range on a calendar. #### Parameters[​](#parameters-37 "Direct link to Parameters") ##### wid[​](#wid-26 "Direct link to wid") `string` ##### calendarId[​](#calendarid "Direct link to calendarId") `number` ##### check[​](#check "Direct link to check") [`AvailabilityCheck`](https://docs.gravityrail.com/sdk/interfaces/AvailabilityCheck.md) #### Returns[​](#returns-37 "Direct link to Returns") `Promise`<[`AvailabilityResponse`](https://docs.gravityrail.com/sdk/interfaces/AvailabilityResponse.md)> #### Implementation of[​](#implementation-of-36 "Direct link to Implementation of") `CalendarsBindings.checkAvailability` *** ### checkSiteDomainAvailability()[​](#checksitedomainavailability "Direct link to checkSiteDomainAvailability()") > **checkSiteDomainAvailability**: (`wid`, `domain`, `siteUuid`) => `Promise`<{ `result`: `boolean`; }> Defined in: [packages/sdk/src/client/client.ts:544](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L544) Check whether a custom domain is available for a site. #### Parameters[​](#parameters-38 "Direct link to Parameters") ##### wid[​](#wid-27 "Direct link to wid") `string` ##### domain[​](#domain "Direct link to domain") `string` ##### siteUuid?[​](#siteuuid "Direct link to siteUuid?") `string` | `null` #### Returns[​](#returns-38 "Direct link to Returns") `Promise`<{ `result`: `boolean`; }> #### Implementation of[​](#implementation-of-37 "Direct link to Implementation of") `SitesBindings.checkSiteDomainAvailability` *** ### checkSiteSlugAvailability()[​](#checksiteslugavailability "Direct link to checkSiteSlugAvailability()") > **checkSiteSlugAvailability**: (`wid`, `slug`, `siteUuid`) => `Promise`<[`SiteSlugAvailability`](https://docs.gravityrail.com/sdk/interfaces/SiteSlugAvailability.md)> Defined in: [packages/sdk/src/client/client.ts:543](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L543) Check whether a site slug is available for use. #### Parameters[​](#parameters-39 "Direct link to Parameters") ##### wid[​](#wid-28 "Direct link to wid") `string` ##### slug[​](#slug-1 "Direct link to slug") `string` ##### siteUuid?[​](#siteuuid-1 "Direct link to siteUuid?") `string` | `null` #### Returns[​](#returns-39 "Direct link to Returns") `Promise`<[`SiteSlugAvailability`](https://docs.gravityrail.com/sdk/interfaces/SiteSlugAvailability.md)> #### Implementation of[​](#implementation-of-38 "Direct link to Implementation of") `SitesBindings.checkSiteSlugAvailability` *** ### clearConnectionMemberExclusion()[​](#clearconnectionmemberexclusion "Direct link to clearConnectionMemberExclusion()") > **clearConnectionMemberExclusion**: (`wid`, `connectionId`, `memberId`, `options?`) => `Promise`<{ `cleared`: `boolean`; `connectionId`: `number`; `memberId`: `number`; `scope`: `string`; }> Defined in: [packages/sdk/src/client/client.ts:1030](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L1030) Clear a manual-unlink exclusion for a member on a connection so subsequent outbound syncs stop silently skipping them. Idempotent: returns `cleared=false` when no matching exclusion exists. `boardId` is only meaningful for multi-scope connectors (Monday). #### Parameters[​](#parameters-40 "Direct link to Parameters") ##### wid[​](#wid-29 "Direct link to wid") `string` ##### connectionId[​](#connectionid "Direct link to connectionId") `number` ##### memberId[​](#memberid-1 "Direct link to memberId") `number` ##### options?[​](#options "Direct link to options?") ###### boardId?[​](#boardid-1 "Direct link to boardId?") `string` #### Returns[​](#returns-40 "Direct link to Returns") `Promise`<{ `cleared`: `boolean`; `connectionId`: `number`; `memberId`: `number`; `scope`: `string`; }> #### Implementation of[​](#implementation-of-39 "Direct link to Implementation of") `IntegrationsBindings.clearConnectionMemberExclusion` *** ### clearMemberSwitch()[​](#clearmemberswitch "Direct link to clearMemberSwitch()") > **clearMemberSwitch**: (`wid`) => `Promise`<[`WorkspaceMemberResponse`](https://docs.gravityrail.com/sdk/interfaces/WorkspaceMemberResponse.md)> Defined in: [packages/sdk/src/client/client.ts:222](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L222) Clear the member switch and return to the authenticated member. #### Parameters[​](#parameters-41 "Direct link to Parameters") ##### wid[​](#wid-30 "Direct link to wid") `string` #### Returns[​](#returns-41 "Direct link to Returns") `Promise`<[`WorkspaceMemberResponse`](https://docs.gravityrail.com/sdk/interfaces/WorkspaceMemberResponse.md)> #### Implementation of[​](#implementation-of-40 "Direct link to Implementation of") `MembersBindings.clearMemberSwitch` *** ### clickWorkspaceSupportRequestResource()[​](#clickworkspacesupportrequestresource "Direct link to clickWorkspaceSupportRequestResource()") > **clickWorkspaceSupportRequestResource**: (`workspaceUuid`, `uuid`, `resourceUuid`, `data`) => `Promise`<`SupportRequest`> Defined in: [packages/sdk/src/client/client.ts:1094](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L1094) Record a click on a pushed resource (Proactive Support). For a manager\_prompt, pass the Manager Chat UUID it opened so the resource→chat linkage is preserved. #### Parameters[​](#parameters-42 "Direct link to Parameters") ##### workspaceUuid[​](#workspaceuuid-2 "Direct link to workspaceUuid") `string` ##### uuid[​](#uuid-1 "Direct link to uuid") `string` ##### resourceUuid[​](#resourceuuid "Direct link to resourceUuid") `string` ##### data?[​](#data-7 "Direct link to data?") `RecordResourceClickRequest` = `{}` #### Returns[​](#returns-42 "Direct link to Returns") `Promise`<`SupportRequest`> #### Implementation of[​](#implementation-of-41 "Direct link to Implementation of") `SupportRequestsBindings.clickWorkspaceSupportRequestResource` *** ### cloneDataType()[​](#clonedatatype "Direct link to cloneDataType()") > **cloneDataType**: (`wid`, `id`, `data`) => `Promise`<[`DataTypeResponse`](https://docs.gravityrail.com/sdk/interfaces/DataTypeResponse.md)> Defined in: [packages/sdk/src/client/client.ts:205](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L205) Clone a data type with a new name and slug. #### Parameters[​](#parameters-43 "Direct link to Parameters") ##### wid[​](#wid-31 "Direct link to wid") `string` ##### id[​](#id-7 "Direct link to id") `number` ##### data[​](#data-8 "Direct link to data") ###### name[​](#name-1 "Direct link to name") `string` ###### slug[​](#slug-2 "Direct link to slug") `string` #### Returns[​](#returns-43 "Direct link to Returns") `Promise`<[`DataTypeResponse`](https://docs.gravityrail.com/sdk/interfaces/DataTypeResponse.md)> #### Implementation of[​](#implementation-of-42 "Direct link to Implementation of") `DataTypesBindings.cloneDataType` *** ### cloneTask()[​](#clonetask "Direct link to cloneTask()") > **cloneTask**: (`wid`, `taskId`, `name`, `slug?`) => `Promise`<[`Task`](https://docs.gravityrail.com/sdk/type-aliases/Task.md)> Defined in: [packages/sdk/src/client/client.ts:131](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L131) Clone a task with all its dependencies including abilities. This creates a complete copy of the task on the backend, including: * Task properties (name, description, prompt, etc.) * File associations * Data type associations * Event rules * Abilities (task-scoped) #### Parameters[​](#parameters-44 "Direct link to Parameters") ##### wid[​](#wid-32 "Direct link to wid") `string` ##### taskId[​](#taskid "Direct link to taskId") `number` ##### name[​](#name-2 "Direct link to name") `string` ##### slug?[​](#slug-3 "Direct link to slug?") `string` #### Returns[​](#returns-44 "Direct link to Returns") `Promise`<[`Task`](https://docs.gravityrail.com/sdk/type-aliases/Task.md)> #### Implementation of[​](#implementation-of-43 "Direct link to Implementation of") `TasksBindings.cloneTask` *** ### cloneWorkflow()[​](#cloneworkflow "Direct link to cloneWorkflow()") > **cloneWorkflow**: (`wid`, `id`, `data`) => `Promise`<[`Workflow`](https://docs.gravityrail.com/sdk/type-aliases/Workflow.md)> Defined in: [packages/sdk/src/client/client.ts:657](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L657) Clone a workflow with a new name. #### Parameters[​](#parameters-45 "Direct link to Parameters") ##### wid[​](#wid-33 "Direct link to wid") `string` ##### id[​](#id-8 "Direct link to id") `number` ##### data[​](#data-9 "Direct link to data") ###### name[​](#name-3 "Direct link to name") `string` #### Returns[​](#returns-45 "Direct link to Returns") `Promise`<[`Workflow`](https://docs.gravityrail.com/sdk/type-aliases/Workflow.md)> #### Implementation of[​](#implementation-of-44 "Direct link to Implementation of") `WorkflowsBindings.cloneWorkflow` *** ### closeWorkspaceSupportRequest()[​](#closeworkspacesupportrequest "Direct link to closeWorkspaceSupportRequest()") > **closeWorkspaceSupportRequest**: (`workspaceUuid`, `uuid`, `data`) => `Promise`<`SupportRequest`> Defined in: [packages/sdk/src/client/client.ts:1092](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L1092) #### Parameters[​](#parameters-46 "Direct link to Parameters") ##### workspaceUuid[​](#workspaceuuid-3 "Direct link to workspaceUuid") `string` ##### uuid[​](#uuid-2 "Direct link to uuid") `string` ##### data?[​](#data-10 "Direct link to data?") `CloseSupportRequestRequest` = `{}` #### Returns[​](#returns-46 "Direct link to Returns") `Promise`<`SupportRequest`> #### Implementation of[​](#implementation-of-45 "Direct link to Implementation of") `SupportRequestsBindings.closeWorkspaceSupportRequest` *** ### commentOnOrgSupportRequest()[​](#commentonorgsupportrequest "Direct link to commentOnOrgSupportRequest()") > **commentOnOrgSupportRequest**: (`orgUuid`, `uuid`, `data`) => `Promise`<`SupportRequest`> Defined in: [packages/sdk/src/client/client.ts:1087](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L1087) #### Parameters[​](#parameters-47 "Direct link to Parameters") ##### orgUuid[​](#orguuid-1 "Direct link to orgUuid") `string` ##### uuid[​](#uuid-3 "Direct link to uuid") `string` ##### data[​](#data-11 "Direct link to data") `CreateSupportRequestCommentRequest` #### Returns[​](#returns-47 "Direct link to Returns") `Promise`<`SupportRequest`> #### Implementation of[​](#implementation-of-46 "Direct link to Implementation of") `SupportRequestsBindings.commentOnOrgSupportRequest` *** ### commentOnSupportRequest()[​](#commentonsupportrequest "Direct link to commentOnSupportRequest()") > **commentOnSupportRequest**: (`uuid`, `data`) => `Promise`<`SupportRequest`> Defined in: [packages/sdk/src/client/client.ts:1083](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L1083) #### Parameters[​](#parameters-48 "Direct link to Parameters") ##### uuid[​](#uuid-4 "Direct link to uuid") `string` ##### data[​](#data-12 "Direct link to data") `CreateSupportRequestCommentRequest` #### Returns[​](#returns-48 "Direct link to Returns") `Promise`<`SupportRequest`> #### Implementation of[​](#implementation-of-47 "Direct link to Implementation of") `SupportRequestsBindings.commentOnSupportRequest` *** ### commentOnWorkspaceSupportRequest()[​](#commentonworkspacesupportrequest "Direct link to commentOnWorkspaceSupportRequest()") > **commentOnWorkspaceSupportRequest**: (`workspaceUuid`, `uuid`, `data`) => `Promise`<`SupportRequest`> Defined in: [packages/sdk/src/client/client.ts:1091](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L1091) #### Parameters[​](#parameters-49 "Direct link to Parameters") ##### workspaceUuid[​](#workspaceuuid-4 "Direct link to workspaceUuid") `string` ##### uuid[​](#uuid-5 "Direct link to uuid") `string` ##### data[​](#data-13 "Direct link to data") `CreateSupportRequestCommentRequest` #### Returns[​](#returns-49 "Direct link to Returns") `Promise`<`SupportRequest`> #### Implementation of[​](#implementation-of-48 "Direct link to Implementation of") `SupportRequestsBindings.commentOnWorkspaceSupportRequest` *** ### configureConfluence()[​](#configureconfluence "Direct link to configureConfluence()") > **configureConfluence**: (`wid`, `data`) => `Promise`<`ConfluenceConnectionStatus`> Defined in: [packages/sdk/src/client/client.ts:972](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L972) #### Parameters[​](#parameters-50 "Direct link to Parameters") ##### wid[​](#wid-34 "Direct link to wid") `string` ##### data[​](#data-14 "Direct link to data") `ConfigureConfluenceRequest` #### Returns[​](#returns-50 "Direct link to Returns") `Promise`<`ConfluenceConnectionStatus`> #### Implementation of[​](#implementation-of-49 "Direct link to Implementation of") `IntegrationsBindings.configureConfluence` *** ### configureHealthie()[​](#configurehealthie "Direct link to configureHealthie()") > **configureHealthie**: (`wid`, `data`) => `Promise`<`HealthieConnectionStatus`> Defined in: [packages/sdk/src/client/client.ts:956](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L956) #### Parameters[​](#parameters-51 "Direct link to Parameters") ##### wid[​](#wid-35 "Direct link to wid") `string` ##### data[​](#data-15 "Direct link to data") `ConfigureHealthieRequest` #### Returns[​](#returns-51 "Direct link to Returns") `Promise`<`HealthieConnectionStatus`> #### Implementation of[​](#implementation-of-50 "Direct link to Implementation of") `IntegrationsBindings.configureHealthie` *** ### configureHubspot()[​](#configurehubspot "Direct link to configureHubspot()") > **configureHubspot**: (`wid`, `data`) => `Promise`<`HubspotConnectionStatus`> Defined in: [packages/sdk/src/client/client.ts:1002](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L1002) #### Parameters[​](#parameters-52 "Direct link to Parameters") ##### wid[​](#wid-36 "Direct link to wid") `string` ##### data[​](#data-16 "Direct link to data") `ConfigureHubspotRequest` #### Returns[​](#returns-52 "Direct link to Returns") `Promise`<`HubspotConnectionStatus`> #### Implementation of[​](#implementation-of-51 "Direct link to Implementation of") `IntegrationsBindings.configureHubspot` *** ### configureMondayConnection()[​](#configuremondayconnection "Direct link to configureMondayConnection()") > **configureMondayConnection**: (`wid`, `data`) => `Promise`<`MondayConnectionStatus`> Defined in: [packages/sdk/src/client/client.ts:863](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L863) #### Parameters[​](#parameters-53 "Direct link to Parameters") ##### wid[​](#wid-37 "Direct link to wid") `string` ##### data[​](#data-17 "Direct link to data") ###### clientId[​](#clientid "Direct link to clientId") `string` ###### clientSecret[​](#clientsecret "Direct link to clientSecret") `string` ###### signingSecret?[​](#signingsecret "Direct link to signingSecret?") `string` #### Returns[​](#returns-53 "Direct link to Returns") `Promise`<`MondayConnectionStatus`> #### Implementation of[​](#implementation-of-52 "Direct link to Implementation of") `IntegrationsBindings.configureMondayConnection` *** ### configurePatientSync()[​](#configurepatientsync "Direct link to configurePatientSync()") > **configurePatientSync**: (`wid`, `data`) => `Promise`<[`PatientSyncConnectionStatus`](https://docs.gravityrail.com/sdk/interfaces/PatientSyncConnectionStatus.md)> Defined in: [packages/sdk/src/client/client.ts:953](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L953) Create or update the workspace's PatientSync connection (singleton). #### Parameters[​](#parameters-54 "Direct link to Parameters") ##### wid[​](#wid-38 "Direct link to wid") `string` ##### data[​](#data-18 "Direct link to data") [`ConfigurePatientSyncRequest`](https://docs.gravityrail.com/sdk/interfaces/ConfigurePatientSyncRequest.md) #### Returns[​](#returns-54 "Direct link to Returns") `Promise`<[`PatientSyncConnectionStatus`](https://docs.gravityrail.com/sdk/interfaces/PatientSyncConnectionStatus.md)> #### Implementation of[​](#implementation-of-53 "Direct link to Implementation of") `IntegrationsBindings.configurePatientSync` *** ### configureSalesforce()[​](#configuresalesforce "Direct link to configureSalesforce()") > **configureSalesforce**: (`wid`, `data`) => `Promise`<`SalesforceConnectionStatus`> Defined in: [packages/sdk/src/client/client.ts:983](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L983) #### Parameters[​](#parameters-55 "Direct link to Parameters") ##### wid[​](#wid-39 "Direct link to wid") `string` ##### data[​](#data-19 "Direct link to data") `ConfigureSalesforceRequest` #### Returns[​](#returns-55 "Direct link to Returns") `Promise`<`SalesforceConnectionStatus`> #### Implementation of[​](#implementation-of-54 "Direct link to Implementation of") `IntegrationsBindings.configureSalesforce` *** ### confirmCredentialChangeInvite()[​](#confirmcredentialchangeinvite "Direct link to confirmCredentialChangeInvite()") > **confirmCredentialChangeInvite**: (`token`) => `Promise`<[`CredentialChangeInviteConfirmResponse`](https://docs.gravityrail.com/sdk/interfaces/CredentialChangeInviteConfirmResponse.md)> Defined in: [packages/sdk/src/client/client.ts:524](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L524) Confirm a credential change invitation. The user must be logged in and be the target of the invitation. #### Parameters[​](#parameters-56 "Direct link to Parameters") ##### token[​](#token "Direct link to token") `string` #### Returns[​](#returns-56 "Direct link to Returns") `Promise`<[`CredentialChangeInviteConfirmResponse`](https://docs.gravityrail.com/sdk/interfaces/CredentialChangeInviteConfirmResponse.md)> #### Implementation of[​](#implementation-of-55 "Direct link to Implementation of") `AuthBindings.confirmCredentialChangeInvite` *** ### convertEmail()[​](#convertemail "Direct link to convertEmail()") > **convertEmail**: (`wid`, `inboxId`, `emailId`, `format`) => `Promise`<[`EmailConversionResponse`](https://docs.gravityrail.com/sdk/interfaces/EmailConversionResponse.md)> Defined in: [packages/sdk/src/client/client.ts:756](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L756) Convert an email to text, markdown, or PDF format. #### Parameters[​](#parameters-57 "Direct link to Parameters") ##### wid[​](#wid-40 "Direct link to wid") `string` ##### inboxId[​](#inboxid "Direct link to inboxId") `number` ##### emailId[​](#emailid "Direct link to emailId") `number` ##### format?[​](#format "Direct link to format?") `"text"` | `"markdown"` | `"pdf"` #### Returns[​](#returns-57 "Direct link to Returns") `Promise`<[`EmailConversionResponse`](https://docs.gravityrail.com/sdk/interfaces/EmailConversionResponse.md)> #### Implementation of[​](#implementation-of-56 "Direct link to Implementation of") `CommunicationsBindings.convertEmail` *** ### convertFile()[​](#convertfile "Direct link to convertFile()") > **convertFile**: (`wid`, `fileId`, `format`) => `Promise`<[`ConvertedFileResponse`](https://docs.gravityrail.com/sdk/interfaces/ConvertedFileResponse.md)> Defined in: [packages/sdk/src/client/client.ts:594](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L594) Convert a file to the specified format (text, markdown, or PDF). #### Parameters[​](#parameters-58 "Direct link to Parameters") ##### wid[​](#wid-41 "Direct link to wid") `string` ##### fileId[​](#fileid "Direct link to fileId") `number` ##### format?[​](#format-1 "Direct link to format?") `"text"` | `"markdown"` | `"pdf"` #### Returns[​](#returns-58 "Direct link to Returns") `Promise`<[`ConvertedFileResponse`](https://docs.gravityrail.com/sdk/interfaces/ConvertedFileResponse.md)> #### Implementation of[​](#implementation-of-57 "Direct link to Implementation of") `FilesBindings.convertFile` *** ### convertMemberFilterToQuery()[​](#convertmemberfiltertoquery "Direct link to convertMemberFilterToQuery()") > **convertMemberFilterToQuery**: (`wid`, `filterId`, `opts?`) => `Promise`<[`MemberFilterResponse`](https://docs.gravityrail.com/sdk/interfaces/MemberFilterResponse.md)> Defined in: [packages/sdk/src/client/client.ts:241](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L241) Convert a legacy rules filter to a query-engine predicate. One-way and transactional: on success the filter's legacy rules are gone and `query` holds the equivalent IR predicate. 409 if already query-format; 422 when rules have no engine equivalent. With `dryRun: true` the same validation runs but nothing persists: the response previews the normalized predicate in `query` while `rules` stay intact on the filter. #### Parameters[​](#parameters-59 "Direct link to Parameters") ##### wid[​](#wid-42 "Direct link to wid") `string` ##### filterId[​](#filterid "Direct link to filterId") `number` ##### opts?[​](#opts "Direct link to opts?") ###### dryRun?[​](#dryrun "Direct link to dryRun?") `boolean` #### Returns[​](#returns-59 "Direct link to Returns") `Promise`<[`MemberFilterResponse`](https://docs.gravityrail.com/sdk/interfaces/MemberFilterResponse.md)> #### Implementation of[​](#implementation-of-58 "Direct link to Implementation of") `MembersBindings.convertMemberFilterToQuery` *** ### crawlSite()[​](#crawlsite "Direct link to crawlSite()") > **crawlSite**: (`wid`, `siteId`) => `Promise`<[`Site`](https://docs.gravityrail.com/sdk/type-aliases/Site.md)> Defined in: [packages/sdk/src/client/client.ts:567](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L567) Trigger a crawl of the site's external content source. #### Parameters[​](#parameters-60 "Direct link to Parameters") ##### wid[​](#wid-43 "Direct link to wid") `string` ##### siteId[​](#siteid-1 "Direct link to siteId") `number` #### Returns[​](#returns-60 "Direct link to Returns") `Promise`<[`Site`](https://docs.gravityrail.com/sdk/type-aliases/Site.md)> #### Implementation of[​](#implementation-of-59 "Direct link to Implementation of") `SitesBindings.crawlSite` *** ### createAbility()[​](#createability "Direct link to createAbility()") > **createAbility**: (`wid`, `body`) => `Promise`<[`AbilityResponse`](https://docs.gravityrail.com/sdk/type-aliases/AbilityResponse.md)> Defined in: [packages/sdk/src/client/client.ts:135](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L135) Create (enable) a configured ability on a workflow or task scope. #### Parameters[​](#parameters-61 "Direct link to Parameters") ##### wid[​](#wid-44 "Direct link to wid") `string` ##### body[​](#body "Direct link to body") `Record`<`string`, `unknown`> #### Returns[​](#returns-61 "Direct link to Returns") `Promise`<[`AbilityResponse`](https://docs.gravityrail.com/sdk/type-aliases/AbilityResponse.md)> #### Implementation of[​](#implementation-of-60 "Direct link to Implementation of") `TasksBindings.createAbility` *** ### createAccessGrant()[​](#createaccessgrant "Direct link to createAccessGrant()") > **createAccessGrant**: (`wid`, `data`) => `Promise`<[`AccessGrant`](https://docs.gravityrail.com/sdk/type-aliases/AccessGrant.md)> Defined in: [packages/sdk/src/client/client.ts:389](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L389) Create a new access grant for a resource. #### Parameters[​](#parameters-62 "Direct link to Parameters") ##### wid[​](#wid-45 "Direct link to wid") `string` ##### data[​](#data-20 "Direct link to data") [`CreateAccessGrantRequest`](https://docs.gravityrail.com/sdk/interfaces/CreateAccessGrantRequest.md) #### Returns[​](#returns-62 "Direct link to Returns") `Promise`<[`AccessGrant`](https://docs.gravityrail.com/sdk/type-aliases/AccessGrant.md)> #### Implementation of[​](#implementation-of-61 "Direct link to Implementation of") `AccessGrantsBindings.createAccessGrant` *** ### createAccount()[​](#createaccount "Direct link to createAccount()") > **createAccount**: (`email`, `password`, `name?`, `organizationUuid?`) => `Promise`<[`VerifyCodeResponse`](https://docs.gravityrail.com/sdk/interfaces/VerifyCodeResponse.md)> Defined in: [packages/sdk/src/client/client.ts:505](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L505) Sign up a new account with email and password. #### Parameters[​](#parameters-63 "Direct link to Parameters") ##### email[​](#email "Direct link to email") `string` ##### password[​](#password "Direct link to password") `string` ##### name?[​](#name-4 "Direct link to name?") `string` ##### organizationUuid?[​](#organizationuuid "Direct link to organizationUuid?") `string` #### Returns[​](#returns-63 "Direct link to Returns") `Promise`<[`VerifyCodeResponse`](https://docs.gravityrail.com/sdk/interfaces/VerifyCodeResponse.md)> #### Implementation of[​](#implementation-of-62 "Direct link to Implementation of") `AuthBindings.createAccount` *** ### createAgent()[​](#createagent "Direct link to createAgent()") > **createAgent**: (`wid`, `agent`) => `Promise`<[`AgentResponse`](https://docs.gravityrail.com/sdk/interfaces/AgentResponse.md)> Defined in: [packages/sdk/src/client/client.ts:288](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L288) Create a new agent in a workspace. #### Parameters[​](#parameters-64 "Direct link to Parameters") ##### wid[​](#wid-46 "Direct link to wid") `string` ##### agent[​](#agent "Direct link to agent") [`CreateAgentRequest`](https://docs.gravityrail.com/sdk/interfaces/CreateAgentRequest.md) #### Returns[​](#returns-64 "Direct link to Returns") `Promise`<[`AgentResponse`](https://docs.gravityrail.com/sdk/interfaces/AgentResponse.md)> #### Implementation of[​](#implementation-of-63 "Direct link to Implementation of") `AgentsBindings.createAgent` *** ### createApiKey()[​](#createapikey "Direct link to createApiKey()") > **createApiKey**: (`wid`, `apiKey`) => `Promise`<[`ApiKeyCreated`](https://docs.gravityrail.com/sdk/interfaces/ApiKeyCreated.md)> Defined in: [packages/sdk/src/client/client.ts:807](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L807) Create a new API key for a workspace. #### Parameters[​](#parameters-65 "Direct link to Parameters") ##### wid[​](#wid-47 "Direct link to wid") `string` ##### apiKey[​](#apikey-1 "Direct link to apiKey") [`ApiKeyFormData`](https://docs.gravityrail.com/sdk/interfaces/ApiKeyFormData.md) #### Returns[​](#returns-65 "Direct link to Returns") `Promise`<[`ApiKeyCreated`](https://docs.gravityrail.com/sdk/interfaces/ApiKeyCreated.md)> #### Implementation of[​](#implementation-of-64 "Direct link to Implementation of") `BillingBindings.createApiKey` *** ### createApp()[​](#createapp "Direct link to createApp()") > **createApp**: (`request`) => `Promise`<[`App`](https://docs.gravityrail.com/sdk/type-aliases/App.md)> Defined in: [packages/sdk/src/client/client.ts:829](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L829) Create a new app #### Parameters[​](#parameters-66 "Direct link to Parameters") ##### request[​](#request-3 "Direct link to request") [`CreateAppRequest`](https://docs.gravityrail.com/sdk/interfaces/CreateAppRequest.md) #### Returns[​](#returns-66 "Direct link to Returns") `Promise`<[`App`](https://docs.gravityrail.com/sdk/type-aliases/App.md)> #### Implementation of[​](#implementation-of-65 "Direct link to Implementation of") `AppsBindings.createApp` *** ### createAssignment()[​](#createassignment "Direct link to createAssignment()") > **createAssignment**: (`wid`, `data`) => `Promise`<[`AssignmentResponse`](https://docs.gravityrail.com/sdk/interfaces/AssignmentResponse.md)> Defined in: [packages/sdk/src/client/client.ts:534](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L534) Create a new assignment for a member. #### Parameters[​](#parameters-67 "Direct link to Parameters") ##### wid[​](#wid-48 "Direct link to wid") `string` ##### data[​](#data-21 "Direct link to data") [`CreateAssignmentFormData`](https://docs.gravityrail.com/sdk/interfaces/CreateAssignmentFormData.md) #### Returns[​](#returns-67 "Direct link to Returns") `Promise`<[`AssignmentResponse`](https://docs.gravityrail.com/sdk/interfaces/AssignmentResponse.md)> #### Implementation of[​](#implementation-of-66 "Direct link to Implementation of") `AuthBindings.createAssignment` *** ### createBuilder()[​](#createbuilder "Direct link to createBuilder()") > **createBuilder**: (`request`) => `Promise`<[`BuilderResponse`](https://docs.gravityrail.com/sdk/interfaces/BuilderResponse.md)> Defined in: [packages/sdk/src/client/client.ts:838](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L838) Create a new builder #### Parameters[​](#parameters-68 "Direct link to Parameters") ##### request[​](#request-4 "Direct link to request") [`CreateBuilderRequest`](https://docs.gravityrail.com/sdk/interfaces/CreateBuilderRequest.md) #### Returns[​](#returns-68 "Direct link to Returns") `Promise`<[`BuilderResponse`](https://docs.gravityrail.com/sdk/interfaces/BuilderResponse.md)> #### Implementation of[​](#implementation-of-67 "Direct link to Implementation of") `AppsBindings.createBuilder` *** ### createCalendar()[​](#createcalendar "Direct link to createCalendar()") > **createCalendar**: (`wid`, `calendar`) => `Promise`<[`Calendar`](https://docs.gravityrail.com/sdk/type-aliases/Calendar.md)> Defined in: [packages/sdk/src/client/client.ts:695](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L695) Create a new calendar in the workspace. #### Parameters[​](#parameters-69 "Direct link to Parameters") ##### wid[​](#wid-49 "Direct link to wid") `string` ##### calendar[​](#calendar "Direct link to calendar") [`CalendarFormData`](https://docs.gravityrail.com/sdk/interfaces/CalendarFormData.md) #### Returns[​](#returns-69 "Direct link to Returns") `Promise`<[`Calendar`](https://docs.gravityrail.com/sdk/type-aliases/Calendar.md)> #### Implementation of[​](#implementation-of-68 "Direct link to Implementation of") `CalendarsBindings.createCalendar` *** ### createCalendarEvent()[​](#createcalendarevent "Direct link to createCalendarEvent()") > **createCalendarEvent**: (`wid`, `event`) => `Promise`<[`EventResponse`](https://docs.gravityrail.com/sdk/interfaces/EventResponse.md)> Defined in: [packages/sdk/src/client/client.ts:706](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L706) Create a new calendar event. #### Parameters[​](#parameters-70 "Direct link to Parameters") ##### wid[​](#wid-50 "Direct link to wid") `string` ##### event[​](#event "Direct link to event") [`CalendarEventFormData`](https://docs.gravityrail.com/sdk/interfaces/CalendarEventFormData.md) #### Returns[​](#returns-70 "Direct link to Returns") `Promise`<[`EventResponse`](https://docs.gravityrail.com/sdk/interfaces/EventResponse.md)> #### Implementation of[​](#implementation-of-69 "Direct link to Implementation of") `CalendarsBindings.createCalendarEvent` *** ### createCalendarEventType()[​](#createcalendareventtype "Direct link to createCalendarEventType()") > **createCalendarEventType**: (`wid`, `eventType`) => `Promise`<[`EventTypeResponse`](https://docs.gravityrail.com/sdk/interfaces/EventTypeResponse.md)> Defined in: [packages/sdk/src/client/client.ts:713](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L713) Create a new calendar event type. #### Parameters[​](#parameters-71 "Direct link to Parameters") ##### wid[​](#wid-51 "Direct link to wid") `string` ##### eventType[​](#eventtype "Direct link to eventType") [`CalendarEventTypeFormData`](https://docs.gravityrail.com/sdk/interfaces/CalendarEventTypeFormData.md) #### Returns[​](#returns-71 "Direct link to Returns") `Promise`<[`EventTypeResponse`](https://docs.gravityrail.com/sdk/interfaces/EventTypeResponse.md)> #### Implementation of[​](#implementation-of-70 "Direct link to Implementation of") `CalendarsBindings.createCalendarEventType` *** ### createCalendarSchedule()[​](#createcalendarschedule "Direct link to createCalendarSchedule()") > **createCalendarSchedule**: (`wid`, `calendarId`, `schedule`) => `Promise`<[`CalendarSchedule`](https://docs.gravityrail.com/sdk/type-aliases/CalendarSchedule.md)> Defined in: [packages/sdk/src/client/client.ts:699](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L699) Create a new schedule for a calendar. #### Parameters[​](#parameters-72 "Direct link to Parameters") ##### wid[​](#wid-52 "Direct link to wid") `string` ##### calendarId[​](#calendarid-1 "Direct link to calendarId") `number` ##### schedule[​](#schedule "Direct link to schedule") [`CalendarScheduleFormData`](https://docs.gravityrail.com/sdk/interfaces/CalendarScheduleFormData.md) #### Returns[​](#returns-72 "Direct link to Returns") `Promise`<[`CalendarSchedule`](https://docs.gravityrail.com/sdk/type-aliases/CalendarSchedule.md)> #### Implementation of[​](#implementation-of-71 "Direct link to Implementation of") `CalendarsBindings.createCalendarSchedule` *** ### createChat()[​](#createchat "Direct link to createChat()") > **createChat**: (`wid`, `chat`) => `Promise`<[`ChatResponse`](https://docs.gravityrail.com/sdk/interfaces/ChatResponse.md)> Defined in: [packages/sdk/src/client/client.ts:152](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L152) Create a new chat. #### Parameters[​](#parameters-73 "Direct link to Parameters") ##### wid[​](#wid-53 "Direct link to wid") `string` ##### chat[​](#chat "Direct link to chat") [`ChatFormData`](https://docs.gravityrail.com/sdk/interfaces/ChatFormData.md) #### Returns[​](#returns-73 "Direct link to Returns") `Promise`<[`ChatResponse`](https://docs.gravityrail.com/sdk/interfaces/ChatResponse.md)> #### Implementation of[​](#implementation-of-72 "Direct link to Implementation of") `ChatsBindings.createChat` *** ### createChatCompletion()[​](#createchatcompletion "Direct link to createChatCompletion()") > **createChatCompletion**: (`wid`, `chatId`, `data`) => `Promise`<{ `choices`: `object`\[]; `created`: `number`; `id`: `string`; `model`: `string`; `object`: `string`; `usage?`: { `completion_tokens`: `number`; `prompt_tokens`: `number`; `total_tokens`: `number`; }; }> Defined in: [packages/sdk/src/client/client.ts:166](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L166) Create a chat completion using the OpenAI-compatible API (used by eval scripts). #### Parameters[​](#parameters-74 "Direct link to Parameters") ##### wid[​](#wid-54 "Direct link to wid") `string` ##### chatId[​](#chatid-1 "Direct link to chatId") `number` ##### data[​](#data-22 "Direct link to data") ###### messages[​](#messages "Direct link to messages") `object`\[] ###### model?[​](#model "Direct link to model?") `string` #### Returns[​](#returns-74 "Direct link to Returns") `Promise`<{ `choices`: `object`\[]; `created`: `number`; `id`: `string`; `model`: `string`; `object`: `string`; `usage?`: { `completion_tokens`: `number`; `prompt_tokens`: `number`; `total_tokens`: `number`; }; }> #### Implementation of[​](#implementation-of-73 "Direct link to Implementation of") `ChatsBindings.createChatCompletion` *** ### createChatFilter()[​](#createchatfilter "Direct link to createChatFilter()") > **createChatFilter**: (`wid`, `filter`) => `Promise`<[`ChatFilterResponse`](https://docs.gravityrail.com/sdk/interfaces/ChatFilterResponse.md)> Defined in: [packages/sdk/src/client/client.ts:181](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L181) Create a new chat filter. #### Parameters[​](#parameters-75 "Direct link to Parameters") ##### wid[​](#wid-55 "Direct link to wid") `string` ##### filter[​](#filter "Direct link to filter") [`ChatFilterFormData`](https://docs.gravityrail.com/sdk/interfaces/ChatFilterFormData.md) #### Returns[​](#returns-75 "Direct link to Returns") `Promise`<[`ChatFilterResponse`](https://docs.gravityrail.com/sdk/interfaces/ChatFilterResponse.md)> #### Implementation of[​](#implementation-of-74 "Direct link to Implementation of") `ChatsBindings.createChatFilter` *** ### createChatLabel()[​](#createchatlabel "Direct link to createChatLabel()") > **createChatLabel**: (`wid`, `label`) => `Promise`<[`ChatLabelResponse`](https://docs.gravityrail.com/sdk/interfaces/ChatLabelResponse.md)> Defined in: [packages/sdk/src/client/client.ts:175](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L175) Create a new chat label. #### Parameters[​](#parameters-76 "Direct link to Parameters") ##### wid[​](#wid-56 "Direct link to wid") `string` ##### label[​](#label "Direct link to label") [`ChatLabelFormData`](https://docs.gravityrail.com/sdk/interfaces/ChatLabelFormData.md) #### Returns[​](#returns-76 "Direct link to Returns") `Promise`<[`ChatLabelResponse`](https://docs.gravityrail.com/sdk/interfaces/ChatLabelResponse.md)> #### Implementation of[​](#implementation-of-75 "Direct link to Implementation of") `ChatsBindings.createChatLabel` *** ### createCheckoutSession()[​](#createcheckoutsession "Direct link to createCheckoutSession()") > **createCheckoutSession**: (`productId`, `planPeriod`) => `Promise`<{ `checkoutUrl`: `string`; `sessionId`: `string`; }> Defined in: [packages/sdk/src/client/client.ts:819](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L819) Create a Stripe Checkout session to purchase an organization plan. Returns the checkout URL to open in a browser. The organization, billing customer, and subscription are created on payment by the checkout completion handler. #### Parameters[​](#parameters-77 "Direct link to Parameters") ##### productId[​](#productid "Direct link to productId") `number` ##### planPeriod?[​](#planperiod "Direct link to planPeriod?") `string` = `'month'` #### Returns[​](#returns-77 "Direct link to Returns") `Promise`<{ `checkoutUrl`: `string`; `sessionId`: `string`; }> #### Implementation of[​](#implementation-of-76 "Direct link to Implementation of") `BillingBindings.createCheckoutSession` *** ### createClientWorkspace()[​](#createclientworkspace "Direct link to createClientWorkspace()") > **createClientWorkspace**: (`wid`, `data`) => `Promise`<[`ClientWorkspace`](https://docs.gravityrail.com/sdk/interfaces/ClientWorkspace.md)> Defined in: [packages/sdk/src/client/client.ts:422](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L422) Create a new client workspace under a reseller workspace. #### Parameters[​](#parameters-78 "Direct link to Parameters") ##### wid[​](#wid-57 "Direct link to wid") `string` ##### data[​](#data-23 "Direct link to data") ###### name[​](#name-5 "Direct link to name") `string` ###### slug?[​](#slug-4 "Direct link to slug?") `string` #### Returns[​](#returns-78 "Direct link to Returns") `Promise`<[`ClientWorkspace`](https://docs.gravityrail.com/sdk/interfaces/ClientWorkspace.md)> #### Implementation of[​](#implementation-of-77 "Direct link to Implementation of") `WorkspacesBindings.createClientWorkspace` *** ### createConnection()[​](#createconnection "Direct link to createConnection()") > **createConnection**: (`wid`, `journeyId`, `data`) => `Promise`<`JourneyStepConnectionResponse`> Defined in: [packages/sdk/src/client/client.ts:334](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L334) Create a connection (DAG edge) between two steps. #### Parameters[​](#parameters-79 "Direct link to Parameters") ##### wid[​](#wid-58 "Direct link to wid") `string` ##### journeyId[​](#journeyid-3 "Direct link to journeyId") `number` ##### data[​](#data-24 "Direct link to data") `JourneyStepConnectionFormData` #### Returns[​](#returns-79 "Direct link to Returns") `Promise`<`JourneyStepConnectionResponse`> #### Implementation of[​](#implementation-of-78 "Direct link to Implementation of") `JourneysBindings.createConnection` *** ### createCustomTool()[​](#createcustomtool "Direct link to createCustomTool()") > **createCustomTool**: (`wid`, `toolkitId`, `data`) => `Promise`<[`CustomTool`](https://docs.gravityrail.com/sdk/type-aliases/CustomTool.md)> Defined in: [packages/sdk/src/client/client.ts:786](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L786) Create a new custom tool in a toolkit #### Parameters[​](#parameters-80 "Direct link to Parameters") ##### wid[​](#wid-59 "Direct link to wid") `string` ##### toolkitId[​](#toolkitid "Direct link to toolkitId") `number` ##### data[​](#data-25 "Direct link to data") [`CustomToolFormData`](https://docs.gravityrail.com/sdk/interfaces/CustomToolFormData.md) #### Returns[​](#returns-80 "Direct link to Returns") `Promise`<[`CustomTool`](https://docs.gravityrail.com/sdk/type-aliases/CustomTool.md)> #### Implementation of[​](#implementation-of-79 "Direct link to Implementation of") `ToolkitsBindings.createCustomTool` *** ### createCustomToolkit()[​](#createcustomtoolkit "Direct link to createCustomToolkit()") > **createCustomToolkit**: (`wid`, `data`) => `Promise`<[`CustomToolkit`](https://docs.gravityrail.com/sdk/type-aliases/CustomToolkit.md)> Defined in: [packages/sdk/src/client/client.ts:781](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L781) Create a new custom toolkit #### Parameters[​](#parameters-81 "Direct link to Parameters") ##### wid[​](#wid-60 "Direct link to wid") `string` ##### data[​](#data-26 "Direct link to data") [`CustomToolkitFormData`](https://docs.gravityrail.com/sdk/interfaces/CustomToolkitFormData.md) #### Returns[​](#returns-81 "Direct link to Returns") `Promise`<[`CustomToolkit`](https://docs.gravityrail.com/sdk/type-aliases/CustomToolkit.md)> #### Implementation of[​](#implementation-of-80 "Direct link to Implementation of") `ToolkitsBindings.createCustomToolkit` *** ### createDataRecord()[​](#createdatarecord "Direct link to createDataRecord()") > **createDataRecord**: (`wid`, `dataTypeId`, `record`) => `Promise`<[`DataRecordResponse`](https://docs.gravityrail.com/sdk/interfaces/DataRecordResponse.md)> Defined in: [packages/sdk/src/client/client.ts:208](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L208) Create a new data record under the specified data type. #### Parameters[​](#parameters-82 "Direct link to Parameters") ##### wid[​](#wid-61 "Direct link to wid") `string` ##### dataTypeId[​](#datatypeid "Direct link to dataTypeId") `number` ##### record[​](#record "Direct link to record") [`DataRecordFormData`](https://docs.gravityrail.com/sdk/interfaces/DataRecordFormData.md) #### Returns[​](#returns-82 "Direct link to Returns") `Promise`<[`DataRecordResponse`](https://docs.gravityrail.com/sdk/interfaces/DataRecordResponse.md)> #### Implementation of[​](#implementation-of-81 "Direct link to Implementation of") `DataTypesBindings.createDataRecord` *** ### createDataType()[​](#createdatatype "Direct link to createDataType()") > **createDataType**: (`wid`, `dataType`) => `Promise`<[`DataTypeResponse`](https://docs.gravityrail.com/sdk/interfaces/DataTypeResponse.md)> Defined in: [packages/sdk/src/client/client.ts:200](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L200) Create a new data type definition in the workspace. #### Parameters[​](#parameters-83 "Direct link to Parameters") ##### wid[​](#wid-62 "Direct link to wid") `string` ##### dataType[​](#datatype "Direct link to dataType") [`DataTypeFormData`](https://docs.gravityrail.com/sdk/interfaces/DataTypeFormData.md) #### Returns[​](#returns-83 "Direct link to Returns") `Promise`<[`DataTypeResponse`](https://docs.gravityrail.com/sdk/interfaces/DataTypeResponse.md)> #### Implementation of[​](#implementation-of-82 "Direct link to Implementation of") `DataTypesBindings.createDataType` *** ### createDiscordBot()[​](#creatediscordbot "Direct link to createDiscordBot()") > **createDiscordBot**: (`wid`, `data`) => `Promise`<[`DiscordBot`](https://docs.gravityrail.com/sdk/type-aliases/DiscordBot.md)> Defined in: [packages/sdk/src/client/client.ts:889](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L889) Create a new Discord bot configuration. #### Parameters[​](#parameters-84 "Direct link to Parameters") ##### wid[​](#wid-63 "Direct link to wid") `string` ##### data[​](#data-27 "Direct link to data") [`CreateDiscordBotRequest`](https://docs.gravityrail.com/sdk/interfaces/CreateDiscordBotRequest.md) #### Returns[​](#returns-84 "Direct link to Returns") `Promise`<[`DiscordBot`](https://docs.gravityrail.com/sdk/type-aliases/DiscordBot.md)> #### Implementation of[​](#implementation-of-83 "Direct link to Implementation of") `IntegrationsBindings.createDiscordBot` *** ### createEventRule()[​](#createeventrule "Direct link to createEventRule()") > **createEventRule**: (`wid`, `rule`) => `Promise`<[`EventRuleResponse`](https://docs.gravityrail.com/sdk/type-aliases/EventRuleResponse.md)> Defined in: [packages/sdk/src/client/client.ts:627](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L627) Create a new event rule in the workspace. #### Parameters[​](#parameters-85 "Direct link to Parameters") ##### wid[​](#wid-64 "Direct link to wid") `string` ##### rule[​](#rule "Direct link to rule") [`EventRuleFormData`](https://docs.gravityrail.com/sdk/interfaces/EventRuleFormData.md) #### Returns[​](#returns-85 "Direct link to Returns") `Promise`<[`EventRuleResponse`](https://docs.gravityrail.com/sdk/type-aliases/EventRuleResponse.md)> #### Implementation of[​](#implementation-of-84 "Direct link to Implementation of") `EventsBindings.createEventRule` *** ### createExperiment()[​](#createexperiment "Direct link to createExperiment()") > **createExperiment**: (`wid`, `data`) => `Promise`<`Experiment`> Defined in: [packages/sdk/src/client/client.ts:359](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L359) Create a draft experiment. #### Parameters[​](#parameters-86 "Direct link to Parameters") ##### wid[​](#wid-65 "Direct link to wid") `string` ##### data[​](#data-28 "Direct link to data") `ExperimentFormData` #### Returns[​](#returns-86 "Direct link to Returns") `Promise`<`Experiment`> #### Implementation of[​](#implementation-of-85 "Direct link to Implementation of") `ExperimentsBindings.createExperiment` *** ### createExperimentAssignment()[​](#createexperimentassignment "Direct link to createExperimentAssignment()") > **createExperimentAssignment**: (`wid`, `experimentId`, `data`) => `Promise`<`MemberExperimentAssignment`> Defined in: [packages/sdk/src/client/client.ts:367](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L367) Manually assign a member to an experiment (optional group, or weighted random). #### Parameters[​](#parameters-87 "Direct link to Parameters") ##### wid[​](#wid-66 "Direct link to wid") `string` ##### experimentId[​](#experimentid "Direct link to experimentId") `number` ##### data[​](#data-29 "Direct link to data") ###### groupId?[​](#groupid-1 "Direct link to groupId?") `number` | `null` ###### memberId[​](#memberid-2 "Direct link to memberId") `number` #### Returns[​](#returns-87 "Direct link to Returns") `Promise`<`MemberExperimentAssignment`> #### Implementation of[​](#implementation-of-86 "Direct link to Implementation of") `ExperimentsBindings.createExperimentAssignment` *** ### createExperimentGroup()[​](#createexperimentgroup "Direct link to createExperimentGroup()") > **createExperimentGroup**: (`wid`, `experimentId`, `data`) => `Promise`<`ExperimentGroup`> Defined in: [packages/sdk/src/client/client.ts:362](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L362) Create a group within an experiment. #### Parameters[​](#parameters-88 "Direct link to Parameters") ##### wid[​](#wid-67 "Direct link to wid") `string` ##### experimentId[​](#experimentid-1 "Direct link to experimentId") `number` ##### data[​](#data-30 "Direct link to data") `ExperimentGroupFormData` #### Returns[​](#returns-88 "Direct link to Returns") `Promise`<`ExperimentGroup`> #### Implementation of[​](#implementation-of-87 "Direct link to Implementation of") `ExperimentsBindings.createExperimentGroup` *** ### createFhirConnection()[​](#createfhirconnection "Direct link to createFhirConnection()") > **createFhirConnection**: (`wid`, `data`) => `Promise`<[`FhirConnection`](https://docs.gravityrail.com/sdk/type-aliases/FhirConnection.md)> Defined in: [packages/sdk/src/client/client.ts:924](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L924) Create a new FHIR connection configuration. #### Parameters[​](#parameters-89 "Direct link to Parameters") ##### wid[​](#wid-68 "Direct link to wid") `string` ##### data[​](#data-31 "Direct link to data") [`CreateFhirConnectionRequest`](https://docs.gravityrail.com/sdk/interfaces/CreateFhirConnectionRequest.md) #### Returns[​](#returns-89 "Direct link to Returns") `Promise`<[`FhirConnection`](https://docs.gravityrail.com/sdk/type-aliases/FhirConnection.md)> #### Implementation of[​](#implementation-of-88 "Direct link to Implementation of") `IntegrationsBindings.createFhirConnection` *** ### createFile()[​](#createfile "Direct link to createFile()") > **createFile**: (`wid`, `file`) => `Promise`<[`File`](https://docs.gravityrail.com/sdk/type-aliases/File.md)> Defined in: [packages/sdk/src/client/client.ts:590](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L590) Create a new file record in the workspace. #### Parameters[​](#parameters-90 "Direct link to Parameters") ##### wid[​](#wid-69 "Direct link to wid") `string` ##### file[​](#file "Direct link to file") [`FileFormData`](https://docs.gravityrail.com/sdk/interfaces/FileFormData.md) #### Returns[​](#returns-90 "Direct link to Returns") `Promise`<[`File`](https://docs.gravityrail.com/sdk/type-aliases/File.md)> #### Implementation of[​](#implementation-of-89 "Direct link to Implementation of") `FilesBindings.createFile` *** ### createFileLabel()[​](#createfilelabel "Direct link to createFileLabel()") > **createFileLabel**: (`wid`, `label`) => `Promise`<[`FileLabelResponse`](https://docs.gravityrail.com/sdk/interfaces/FileLabelResponse.md)> Defined in: [packages/sdk/src/client/client.ts:606](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L606) Create a new file label in the workspace. #### Parameters[​](#parameters-91 "Direct link to Parameters") ##### wid[​](#wid-70 "Direct link to wid") `string` ##### label[​](#label-1 "Direct link to label") [`FileLabelFormData`](https://docs.gravityrail.com/sdk/interfaces/FileLabelFormData.md) #### Returns[​](#returns-91 "Direct link to Returns") `Promise`<[`FileLabelResponse`](https://docs.gravityrail.com/sdk/interfaces/FileLabelResponse.md)> #### Implementation of[​](#implementation-of-90 "Direct link to Implementation of") `FilesBindings.createFileLabel` *** ### createFolder()[​](#createfolder "Direct link to createFolder()") > **createFolder**: (`wid`, `directory`) => `Promise`<[`FileFolderResponse`](https://docs.gravityrail.com/sdk/interfaces/FileFolderResponse.md)> Defined in: [packages/sdk/src/client/client.ts:598](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L598) Create a new folder in the workspace. #### Parameters[​](#parameters-92 "Direct link to Parameters") ##### wid[​](#wid-71 "Direct link to wid") `string` ##### directory[​](#directory "Direct link to directory") [`FileFolderFormData`](https://docs.gravityrail.com/sdk/interfaces/FileFolderFormData.md) #### Returns[​](#returns-92 "Direct link to Returns") `Promise`<[`FileFolderResponse`](https://docs.gravityrail.com/sdk/interfaces/FileFolderResponse.md)> #### Implementation of[​](#implementation-of-91 "Direct link to Implementation of") `FilesBindings.createFolder` *** ### createGlobalApiKey()[​](#createglobalapikey "Direct link to createGlobalApiKey()") > **createGlobalApiKey**: (`apiKey`) => `Promise`<[`ApiKeyCreated`](https://docs.gravityrail.com/sdk/interfaces/ApiKeyCreated.md)> Defined in: [packages/sdk/src/client/client.ts:810](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L810) Create a new account-level API key. #### Parameters[​](#parameters-93 "Direct link to Parameters") ##### apiKey[​](#apikey-2 "Direct link to apiKey") [`ApiKeyFormData`](https://docs.gravityrail.com/sdk/interfaces/ApiKeyFormData.md) #### Returns[​](#returns-93 "Direct link to Returns") `Promise`<[`ApiKeyCreated`](https://docs.gravityrail.com/sdk/interfaces/ApiKeyCreated.md)> #### Implementation of[​](#implementation-of-92 "Direct link to Implementation of") `BillingBindings.createGlobalApiKey` *** ### createGoal()[​](#creategoal "Direct link to createGoal()") > **createGoal**: (`wid`, `journeyId`, `data`) => `Promise`<`JourneyGoalResponse`> Defined in: [packages/sdk/src/client/client.ts:337](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L337) Create a goal for a journey. #### Parameters[​](#parameters-94 "Direct link to Parameters") ##### wid[​](#wid-72 "Direct link to wid") `string` ##### journeyId[​](#journeyid-4 "Direct link to journeyId") `number` ##### data[​](#data-32 "Direct link to data") `JourneyGoalFormData` #### Returns[​](#returns-94 "Direct link to Returns") `Promise`<`JourneyGoalResponse`> #### Implementation of[​](#implementation-of-93 "Direct link to Implementation of") `JourneysBindings.createGoal` *** ### createInbox()[​](#createinbox "Direct link to createInbox()") > **createInbox**: (`wid`, `inbox`) => `Promise`<[`Inbox`](https://docs.gravityrail.com/sdk/type-aliases/Inbox.md)> Defined in: [packages/sdk/src/client/client.ts:749](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L749) Create a new inbox. #### Parameters[​](#parameters-95 "Direct link to Parameters") ##### wid[​](#wid-73 "Direct link to wid") `string` ##### inbox[​](#inbox "Direct link to inbox") [`InboxCreateRequest`](https://docs.gravityrail.com/sdk/interfaces/InboxCreateRequest.md) #### Returns[​](#returns-95 "Direct link to Returns") `Promise`<[`Inbox`](https://docs.gravityrail.com/sdk/type-aliases/Inbox.md)> #### Implementation of[​](#implementation-of-94 "Direct link to Implementation of") `CommunicationsBindings.createInbox` *** ### createInquiry()[​](#createinquiry "Direct link to createInquiry()") > **createInquiry**: (`data`) => `Promise`<[`InquiryResponse`](https://docs.gravityrail.com/sdk/interfaces/InquiryResponse.md)> Defined in: [packages/sdk/src/client/client.ts:841](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L841) Create a new inquiry (public endpoint) #### Parameters[​](#parameters-96 "Direct link to Parameters") ##### data[​](#data-33 "Direct link to data") ###### businessName?[​](#businessname "Direct link to businessName?") `string` = `...` ###### businessNumber?[​](#businessnumber "Direct link to businessNumber?") `string` = `...` ###### cellNumber?[​](#cellnumber "Direct link to cellNumber?") `string` = `...` ###### country?[​](#country "Direct link to country?") `string` = `...` ###### email?[​](#email-1 "Direct link to email?") `string` = `...` ###### inquiryType[​](#inquirytype "Direct link to inquiryType") `"builder"` | `"customer"` | `"partner"` | `"other"` | `"demo_request"` | `"waitlist"` = `...` ###### message?[​](#message "Direct link to message?") `string` = `...` ###### name?[​](#name-6 "Direct link to name?") `string` = `...` ###### productId?[​](#productid-1 "Direct link to productId?") `number` = `...` ###### recaptchaToken?[​](#recaptchatoken "Direct link to recaptchaToken?") `string` = `...` ###### state?[​](#state "Direct link to state?") `string` = `...` #### Returns[​](#returns-96 "Direct link to Returns") `Promise`<[`InquiryResponse`](https://docs.gravityrail.com/sdk/interfaces/InquiryResponse.md)> #### Implementation of[​](#implementation-of-95 "Direct link to Implementation of") `AppsBindings.createInquiry` *** ### createJourney()[​](#createjourney "Direct link to createJourney()") > **createJourney**: (`wid`, `data`) => `Promise`<`Journey`> Defined in: [packages/sdk/src/client/client.ts:328](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L328) Create a new journey. #### Parameters[​](#parameters-97 "Direct link to Parameters") ##### wid[​](#wid-74 "Direct link to wid") `string` ##### data[​](#data-34 "Direct link to data") `JourneyFormData` #### Returns[​](#returns-97 "Direct link to Returns") `Promise`<`Journey`> #### Implementation of[​](#implementation-of-96 "Direct link to Implementation of") `JourneysBindings.createJourney` *** ### createJourneyNote()[​](#createjourneynote "Direct link to createJourneyNote()") > **createJourneyNote**: (`wid`, `journeyId`, `data`) => `Promise`<`JourneyNoteResponse`> Defined in: [packages/sdk/src/client/client.ts:352](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L352) Create a note on a journey. #### Parameters[​](#parameters-98 "Direct link to Parameters") ##### wid[​](#wid-75 "Direct link to wid") `string` ##### journeyId[​](#journeyid-5 "Direct link to journeyId") `number` ##### data[​](#data-35 "Direct link to data") `JourneyNoteFormData` #### Returns[​](#returns-98 "Direct link to Returns") `Promise`<`JourneyNoteResponse`> #### Implementation of[​](#implementation-of-97 "Direct link to Implementation of") `JourneysBindings.createJourneyNote` *** ### createMcpServer()[​](#createmcpserver "Direct link to createMcpServer()") > **createMcpServer**: (`wid`, `data`) => `Promise`<[`McpServerResponse`](https://docs.gravityrail.com/sdk/interfaces/McpServerResponse.md)> Defined in: [packages/sdk/src/client/client.ts:791](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L791) Create a new MCP server #### Parameters[​](#parameters-99 "Direct link to Parameters") ##### wid[​](#wid-76 "Direct link to wid") `string` ##### data[​](#data-36 "Direct link to data") [`McpServerFormData`](https://docs.gravityrail.com/sdk/interfaces/McpServerFormData.md) #### Returns[​](#returns-99 "Direct link to Returns") `Promise`<[`McpServerResponse`](https://docs.gravityrail.com/sdk/interfaces/McpServerResponse.md)> #### Implementation of[​](#implementation-of-98 "Direct link to Implementation of") `ToolkitsBindings.createMcpServer` *** ### createMemberField()[​](#creatememberfield "Direct link to createMemberField()") > **createMemberField**: (`wid`, `memberId`, `request`) => `Promise`<[`MemberFieldResponse`](https://docs.gravityrail.com/sdk/interfaces/MemberFieldResponse.md)> Defined in: [packages/sdk/src/client/client.ts:259](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L259) Create a new field for a member. User-created fields have no service and can be modified/deleted. #### Parameters[​](#parameters-100 "Direct link to Parameters") ##### wid[​](#wid-77 "Direct link to wid") `string` ##### memberId[​](#memberid-3 "Direct link to memberId") `number` ##### request[​](#request-5 "Direct link to request") [`CreateMemberFieldRequest`](https://docs.gravityrail.com/sdk/interfaces/CreateMemberFieldRequest.md) #### Returns[​](#returns-100 "Direct link to Returns") `Promise`<[`MemberFieldResponse`](https://docs.gravityrail.com/sdk/interfaces/MemberFieldResponse.md)> #### Implementation of[​](#implementation-of-99 "Direct link to Implementation of") `MembersBindings.createMemberField` *** ### createMemberFilter()[​](#creatememberfilter "Direct link to createMemberFilter()") > **createMemberFilter**: (`wid`, `data`) => `Promise`<[`MemberFilterResponse`](https://docs.gravityrail.com/sdk/interfaces/MemberFilterResponse.md)> Defined in: [packages/sdk/src/client/client.ts:239](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L239) Create a new saved member filter. #### Parameters[​](#parameters-101 "Direct link to Parameters") ##### wid[​](#wid-78 "Direct link to wid") `string` ##### data[​](#data-37 "Direct link to data") [`MemberFilterFormData`](https://docs.gravityrail.com/sdk/interfaces/MemberFilterFormData.md) #### Returns[​](#returns-101 "Direct link to Returns") `Promise`<[`MemberFilterResponse`](https://docs.gravityrail.com/sdk/interfaces/MemberFilterResponse.md)> #### Implementation of[​](#implementation-of-100 "Direct link to Implementation of") `MembersBindings.createMemberFilter` *** ### createMemberLabel()[​](#creatememberlabel "Direct link to createMemberLabel()") > **createMemberLabel**: (`wid`, `label`) => `Promise`<[`MemberLabelResponse`](https://docs.gravityrail.com/sdk/interfaces/MemberLabelResponse.md)> Defined in: [packages/sdk/src/client/client.ts:247](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L247) Create a new member label. #### Parameters[​](#parameters-102 "Direct link to Parameters") ##### wid[​](#wid-79 "Direct link to wid") `string` ##### label[​](#label-2 "Direct link to label") [`MemberLabelFormData`](https://docs.gravityrail.com/sdk/interfaces/MemberLabelFormData.md) #### Returns[​](#returns-102 "Direct link to Returns") `Promise`<[`MemberLabelResponse`](https://docs.gravityrail.com/sdk/interfaces/MemberLabelResponse.md)> #### Implementation of[​](#implementation-of-101 "Direct link to Implementation of") `MembersBindings.createMemberLabel` *** ### createMemberMemory()[​](#createmembermemory "Direct link to createMemberMemory()") > **createMemberMemory**: (`wid`, `memberId`, `body`) => `Promise`<[`GeneratedMemoryResponse`](https://docs.gravityrail.com/sdk/interfaces/GeneratedMemoryResponse.md)> Defined in: [packages/sdk/src/client/client.ts:274](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L274) #### Parameters[​](#parameters-103 "Direct link to Parameters") ##### wid[​](#wid-80 "Direct link to wid") `string` ##### memberId[​](#memberid-4 "Direct link to memberId") `number` ##### body[​](#body-1 "Direct link to body") ###### content?[​](#content "Direct link to content?") `string` | `null` ###### description[​](#description "Direct link to description") `string` ###### key[​](#key "Direct link to key") `string` ###### priority?[​](#priority "Direct link to priority?") `number` #### Returns[​](#returns-103 "Direct link to Returns") `Promise`<[`GeneratedMemoryResponse`](https://docs.gravityrail.com/sdk/interfaces/GeneratedMemoryResponse.md)> #### Implementation of[​](#implementation-of-102 "Direct link to Implementation of") `MembersBindings.createMemberMemory` *** ### createMemberRole()[​](#creatememberrole "Direct link to createMemberRole()") > **createMemberRole**: (`wid`, `memberRole`) => `Promise`<[`MemberRoleResponse`](https://docs.gravityrail.com/sdk/interfaces/MemberRoleResponse.md)> Defined in: [packages/sdk/src/client/client.ts:253](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L253) Create a new member role. #### Parameters[​](#parameters-104 "Direct link to Parameters") ##### wid[​](#wid-81 "Direct link to wid") `string` ##### memberRole[​](#memberrole "Direct link to memberRole") [`MemberRoleFormData`](https://docs.gravityrail.com/sdk/interfaces/MemberRoleFormData.md) #### Returns[​](#returns-104 "Direct link to Returns") `Promise`<[`MemberRoleResponse`](https://docs.gravityrail.com/sdk/interfaces/MemberRoleResponse.md)> #### Implementation of[​](#implementation-of-103 "Direct link to Implementation of") `MembersBindings.createMemberRole` *** ### createMenuItem()[​](#createmenuitem "Direct link to createMenuItem()") > **createMenuItem**: (`wid`, `siteId`, `item`) => `Promise`<[`MenuItemResponse`](https://docs.gravityrail.com/sdk/interfaces/MenuItemResponse.md)> Defined in: [packages/sdk/src/client/client.ts:580](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L580) Create a new menu item in a site's navigation. #### Parameters[​](#parameters-105 "Direct link to Parameters") ##### wid[​](#wid-82 "Direct link to wid") `string` ##### siteId[​](#siteid-2 "Direct link to siteId") `number` ##### item[​](#item "Direct link to item") [`MenuItemFormData`](https://docs.gravityrail.com/sdk/interfaces/MenuItemFormData.md) #### Returns[​](#returns-105 "Direct link to Returns") `Promise`<[`MenuItemResponse`](https://docs.gravityrail.com/sdk/interfaces/MenuItemResponse.md)> #### Implementation of[​](#implementation-of-104 "Direct link to Implementation of") `SitesBindings.createMenuItem` *** ### createMilestone()[​](#createmilestone "Direct link to createMilestone()") > **createMilestone**: (`wid`, `milestone`) => `Promise`<[`Milestone`](https://docs.gravityrail.com/sdk/interfaces/Milestone.md)> Defined in: [packages/sdk/src/client/client.ts:726](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L726) Create a new milestone in a workspace. #### Parameters[​](#parameters-106 "Direct link to Parameters") ##### wid[​](#wid-83 "Direct link to wid") `string` ##### milestone[​](#milestone "Direct link to milestone") ###### description?[​](#description-1 "Direct link to description?") `string` = `...` ###### goals[​](#goals "Direct link to goals") `object`\[] = `...` ###### name[​](#name-7 "Direct link to name") `string` = `...` ###### targetDate[​](#targetdate "Direct link to targetDate") `string` = `...` #### Returns[​](#returns-106 "Direct link to Returns") `Promise`<[`Milestone`](https://docs.gravityrail.com/sdk/interfaces/Milestone.md)> #### Implementation of[​](#implementation-of-105 "Direct link to Implementation of") `CalendarsBindings.createMilestone` *** ### createMyCustomerSetupIntent()[​](#createmycustomersetupintent "Direct link to createMyCustomerSetupIntent()") > **createMyCustomerSetupIntent**: (`uuid`) => `Promise`<{ `clientSecret`: `string`; `setupIntentId`: `string`; `status`: `string`; }> Defined in: [packages/sdk/src/client/client.ts:1064](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L1064) #### Parameters[​](#parameters-107 "Direct link to Parameters") ##### uuid[​](#uuid-6 "Direct link to uuid") `string` #### Returns[​](#returns-107 "Direct link to Returns") `Promise`<{ `clientSecret`: `string`; `setupIntentId`: `string`; `status`: `string`; }> #### Implementation of[​](#implementation-of-106 "Direct link to Implementation of") `CustomersBindings.createMyCustomerSetupIntent` *** ### createMyPronunciation()[​](#createmypronunciation "Direct link to createMyPronunciation()") > **createMyPronunciation**: (`data`) => `Promise`<[`PronunciationEntryResponse`](https://docs.gravityrail.com/sdk/interfaces/PronunciationEntryResponse.md)> Defined in: [packages/sdk/src/client/client.ts:1050](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L1050) Create a personal pronunciation entry for the current user. #### Parameters[​](#parameters-108 "Direct link to Parameters") ##### data[​](#data-38 "Direct link to data") `Pick`<[`CreatePronunciationEntryFormData`](https://docs.gravityrail.com/sdk/interfaces/CreatePronunciationEntryFormData.md), `"term"` | `"respelling"`> #### Returns[​](#returns-108 "Direct link to Returns") `Promise`<[`PronunciationEntryResponse`](https://docs.gravityrail.com/sdk/interfaces/PronunciationEntryResponse.md)> #### Implementation of[​](#implementation-of-107 "Direct link to Implementation of") `PronunciationsBindings.createMyPronunciation` *** ### createNotificationRule()[​](#createnotificationrule "Direct link to createNotificationRule()") > **createNotificationRule**: (`wid`, `rule`) => `Promise`<[`NotificationRule`](https://docs.gravityrail.com/sdk/interfaces/NotificationRule.md)> Defined in: [packages/sdk/src/client/client.ts:763](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L763) Create a new notification rule. #### Parameters[​](#parameters-109 "Direct link to Parameters") ##### wid[​](#wid-84 "Direct link to wid") `string` ##### rule[​](#rule-1 "Direct link to rule") [`NotificationRuleCreate`](https://docs.gravityrail.com/sdk/interfaces/NotificationRuleCreate.md) #### Returns[​](#returns-109 "Direct link to Returns") `Promise`<[`NotificationRule`](https://docs.gravityrail.com/sdk/interfaces/NotificationRule.md)> #### Implementation of[​](#implementation-of-108 "Direct link to Implementation of") `CommunicationsBindings.createNotificationRule` *** ### createOperatorGroup()[​](#createoperatorgroup "Direct link to createOperatorGroup()") > **createOperatorGroup**: (`wid`, `data`) => `Promise`<[`OperatorGroup`](https://docs.gravityrail.com/sdk/type-aliases/OperatorGroup.md)> Defined in: [packages/sdk/src/client/client.ts:374](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L374) Create a new operator group. #### Parameters[​](#parameters-110 "Direct link to Parameters") ##### wid[​](#wid-85 "Direct link to wid") `string` ##### data[​](#data-39 "Direct link to data") [`CreateOperatorGroupRequest`](https://docs.gravityrail.com/sdk/interfaces/CreateOperatorGroupRequest.md) #### Returns[​](#returns-110 "Direct link to Returns") `Promise`<[`OperatorGroup`](https://docs.gravityrail.com/sdk/type-aliases/OperatorGroup.md)> #### Implementation of[​](#implementation-of-109 "Direct link to Implementation of") `OperatorBindings.createOperatorGroup` *** ### createOrganizationWorkspace()[​](#createorganizationworkspace "Direct link to createOrganizationWorkspace()") > **createOrganizationWorkspace**: (`orgIdOrUuid`, `data`) => `Promise`<`OrgWorkspace`> Defined in: [packages/sdk/src/client/client.ts:465](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L465) Create a workspace in an organization. #### Parameters[​](#parameters-111 "Direct link to Parameters") ##### orgIdOrUuid[​](#orgidoruuid "Direct link to orgIdOrUuid") `string` | `number` ##### data[​](#data-40 "Direct link to data") `OrgCreateWorkspaceFormData` #### Returns[​](#returns-111 "Direct link to Returns") `Promise`<`OrgWorkspace`> #### Implementation of[​](#implementation-of-110 "Direct link to Implementation of") `OrgBindings.createOrganizationWorkspace` *** ### createOrgSupportRequest()[​](#createorgsupportrequest "Direct link to createOrgSupportRequest()") > **createOrgSupportRequest**: (`orgUuid`, `data`) => `Promise`<`SupportRequest`> Defined in: [packages/sdk/src/client/client.ts:1086](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L1086) #### Parameters[​](#parameters-112 "Direct link to Parameters") ##### orgUuid[​](#orguuid-2 "Direct link to orgUuid") `string` ##### data[​](#data-41 "Direct link to data") `CreateSupportRequestRequest` #### Returns[​](#returns-112 "Direct link to Returns") `Promise`<`SupportRequest`> #### Implementation of[​](#implementation-of-111 "Direct link to Implementation of") `SupportRequestsBindings.createOrgSupportRequest` *** ### createPage()[​](#createpage "Direct link to createPage()") > **createPage**: (`wid`, `siteId`, `page`) => `Promise`<[`PageResponse`](https://docs.gravityrail.com/sdk/interfaces/PageResponse.md)> Defined in: [packages/sdk/src/client/client.ts:574](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L574) Create a new page within a site. #### Parameters[​](#parameters-113 "Direct link to Parameters") ##### wid[​](#wid-86 "Direct link to wid") `string` ##### siteId[​](#siteid-3 "Direct link to siteId") `number` ##### page[​](#page "Direct link to page") [`PageFormData`](https://docs.gravityrail.com/sdk/interfaces/PageFormData.md) #### Returns[​](#returns-113 "Direct link to Returns") `Promise`<[`PageResponse`](https://docs.gravityrail.com/sdk/interfaces/PageResponse.md)> #### Implementation of[​](#implementation-of-112 "Direct link to Implementation of") `SitesBindings.createPage` *** ### createPersona()[​](#createpersona "Direct link to createPersona()") > **createPersona**: (`wid`, `data`) => `Promise`<[`Persona`](https://docs.gravityrail.com/sdk/type-aliases/Persona.md)> Defined in: [packages/sdk/src/client/client.ts:320](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L320) #### Parameters[​](#parameters-114 "Direct link to Parameters") ##### wid[​](#wid-87 "Direct link to wid") `string` ##### data[​](#data-42 "Direct link to data") [`CreatePersonaRequest`](https://docs.gravityrail.com/sdk/interfaces/CreatePersonaRequest.md) #### Returns[​](#returns-114 "Direct link to Returns") `Promise`<[`Persona`](https://docs.gravityrail.com/sdk/type-aliases/Persona.md)> #### Implementation of[​](#implementation-of-113 "Direct link to Implementation of") `PersonasBindings.createPersona` *** ### createPhoneNumber()[​](#createphonenumber "Direct link to createPhoneNumber()") > **createPhoneNumber**: (`wid`, `phoneNumber`) => `Promise`<[`PhoneNumber`](https://docs.gravityrail.com/sdk/interfaces/PhoneNumber.md)> Defined in: [packages/sdk/src/client/client.ts:735](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L735) Create a new phone number record. #### Parameters[​](#parameters-115 "Direct link to Parameters") ##### wid[​](#wid-88 "Direct link to wid") `string` ##### phoneNumber[​](#phonenumber "Direct link to phoneNumber") [`PhoneNumberFormData`](https://docs.gravityrail.com/sdk/interfaces/PhoneNumberFormData.md) #### Returns[​](#returns-115 "Direct link to Returns") `Promise`<[`PhoneNumber`](https://docs.gravityrail.com/sdk/interfaces/PhoneNumber.md)> #### Implementation of[​](#implementation-of-114 "Direct link to Implementation of") `CommunicationsBindings.createPhoneNumber` *** ### createProduct()[​](#createproduct "Direct link to createProduct()") > **createProduct**: (`wid`, `product`) => `Promise`<[`Product`](https://docs.gravityrail.com/sdk/type-aliases/Product.md)> Defined in: [packages/sdk/src/client/client.ts:432](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L432) Create a new product for a reseller workspace. #### Parameters[​](#parameters-116 "Direct link to Parameters") ##### wid[​](#wid-89 "Direct link to wid") `string` ##### product[​](#product "Direct link to product") `any` #### Returns[​](#returns-116 "Direct link to Returns") `Promise`<[`Product`](https://docs.gravityrail.com/sdk/type-aliases/Product.md)> #### Implementation of[​](#implementation-of-115 "Direct link to Implementation of") `WorkspacesBindings.createProduct` *** ### createPronunciationEntry()[​](#createpronunciationentry "Direct link to createPronunciationEntry()") > **createPronunciationEntry**: (`orgUuid`, `data`) => `Promise`<[`PronunciationEntryResponse`](https://docs.gravityrail.com/sdk/interfaces/PronunciationEntryResponse.md)> Defined in: [packages/sdk/src/client/client.ts:1044](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L1044) Create a new pronunciation entry for an organization. #### Parameters[​](#parameters-117 "Direct link to Parameters") ##### orgUuid[​](#orguuid-3 "Direct link to orgUuid") `string` ##### data[​](#data-43 "Direct link to data") [`CreatePronunciationEntryFormData`](https://docs.gravityrail.com/sdk/interfaces/CreatePronunciationEntryFormData.md) #### Returns[​](#returns-117 "Direct link to Returns") `Promise`<[`PronunciationEntryResponse`](https://docs.gravityrail.com/sdk/interfaces/PronunciationEntryResponse.md)> #### Implementation of[​](#implementation-of-116 "Direct link to Implementation of") `PronunciationsBindings.createPronunciationEntry` *** ### createRoutine()[​](#createroutine "Direct link to createRoutine()") > **createRoutine**: (`wid`, `routine`) => `Promise`<[`RoutineResponse`](https://docs.gravityrail.com/sdk/interfaces/RoutineResponse.md)> Defined in: [packages/sdk/src/client/client.ts:636](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L636) Create a new routine. #### Parameters[​](#parameters-118 "Direct link to Parameters") ##### wid[​](#wid-90 "Direct link to wid") `string` ##### routine[​](#routine "Direct link to routine") [`CreateRoutineRequest`](https://docs.gravityrail.com/sdk/interfaces/CreateRoutineRequest.md) #### Returns[​](#returns-118 "Direct link to Returns") `Promise`<[`RoutineResponse`](https://docs.gravityrail.com/sdk/interfaces/RoutineResponse.md)> #### Implementation of[​](#implementation-of-117 "Direct link to Implementation of") `EventsBindings.createRoutine` *** ### createScenario()[​](#createscenario "Direct link to createScenario()") > **createScenario**: (`wid`, `qualificationId`, `data`) => `Promise`<[`Scenario`](https://docs.gravityrail.com/sdk/type-aliases/Scenario.md)> Defined in: [packages/sdk/src/client/client.ts:301](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L301) #### Parameters[​](#parameters-119 "Direct link to Parameters") ##### wid[​](#wid-91 "Direct link to wid") `string` ##### qualificationId[​](#qualificationid "Direct link to qualificationId") `number` ##### data[​](#data-44 "Direct link to data") [`CreateScenarioRequest`](https://docs.gravityrail.com/sdk/interfaces/CreateScenarioRequest.md) #### Returns[​](#returns-119 "Direct link to Returns") `Promise`<[`Scenario`](https://docs.gravityrail.com/sdk/type-aliases/Scenario.md)> #### Implementation of[​](#implementation-of-118 "Direct link to Implementation of") `QualificationsBindings.createScenario` *** ### createSignup()[​](#createsignup "Direct link to createSignup()") > **createSignup**: (`wid`, `data`) => `Promise`<[`CreateSignupResponse`](https://docs.gravityrail.com/sdk/interfaces/CreateSignupResponse.md)> Defined in: [packages/sdk/src/client/client.ts:504](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L504) Create a new signup with member and data records for a workspace. #### Parameters[​](#parameters-120 "Direct link to Parameters") ##### wid[​](#wid-92 "Direct link to wid") `string` ##### data[​](#data-45 "Direct link to data") ###### data?[​](#data-46 "Direct link to data?") `Record`<`string`, { `externalId?`: `string`; `values`: `Record`<`string`, `any`>; }> ###### member?[​](#member "Direct link to member?") { `description?`: `string`; `email?`: `string`; `name?`: `string`; `phone?`: `string`; `role?`: `string`; `tosAccepted?`: `boolean`; } ###### member.description?[​](#memberdescription "Direct link to member.description?") `string` ###### member.email?[​](#memberemail "Direct link to member.email?") `string` ###### member.name?[​](#membername "Direct link to member.name?") `string` ###### member.phone?[​](#memberphone "Direct link to member.phone?") `string` ###### member.role?[​](#memberrole-1 "Direct link to member.role?") `string` ###### member.tosAccepted?[​](#membertosaccepted "Direct link to member.tosAccepted?") `boolean` ###### origin?[​](#origin "Direct link to origin?") `string` #### Returns[​](#returns-120 "Direct link to Returns") `Promise`<[`CreateSignupResponse`](https://docs.gravityrail.com/sdk/interfaces/CreateSignupResponse.md)> #### Implementation of[​](#implementation-of-119 "Direct link to Implementation of") `AuthBindings.createSignup` *** ### createSite()[​](#createsite "Direct link to createSite()") > **createSite**: (`wid`, `site`) => `Promise`<[`Site`](https://docs.gravityrail.com/sdk/type-aliases/Site.md)> Defined in: [packages/sdk/src/client/client.ts:568](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L568) Create a new site in the workspace. #### Parameters[​](#parameters-121 "Direct link to Parameters") ##### wid[​](#wid-93 "Direct link to wid") `string` ##### site[​](#site "Direct link to site") [`SiteFormData`](https://docs.gravityrail.com/sdk/interfaces/SiteFormData.md) #### Returns[​](#returns-121 "Direct link to Returns") `Promise`<[`Site`](https://docs.gravityrail.com/sdk/type-aliases/Site.md)> #### Implementation of[​](#implementation-of-120 "Direct link to Implementation of") `SitesBindings.createSite` *** ### createSiteSource()[​](#createsitesource "Direct link to createSiteSource()") > **createSiteSource**: (`wid`, `siteId`) => `Promise`<[`SiteSource`](https://docs.gravityrail.com/sdk/interfaces/SiteSource.md)> Defined in: [packages/sdk/src/client/client.ts:550](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L550) Create a site's source tree with starter files if it does not exist. #### Parameters[​](#parameters-122 "Direct link to Parameters") ##### wid[​](#wid-94 "Direct link to wid") `string` ##### siteId[​](#siteid-4 "Direct link to siteId") `number` #### Returns[​](#returns-122 "Direct link to Returns") `Promise`<[`SiteSource`](https://docs.gravityrail.com/sdk/interfaces/SiteSource.md)> #### Implementation of[​](#implementation-of-121 "Direct link to Implementation of") `SitesBindings.createSiteSource` *** ### createSlackApp()[​](#createslackapp "Direct link to createSlackApp()") > **createSlackApp**: (`wid`, `data`) => `Promise`<[`SlackApp`](https://docs.gravityrail.com/sdk/type-aliases/SlackApp.md)> Defined in: [packages/sdk/src/client/client.ts:903](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L903) Create a new Slack app configuration. #### Parameters[​](#parameters-123 "Direct link to Parameters") ##### wid[​](#wid-95 "Direct link to wid") `string` ##### data[​](#data-47 "Direct link to data") [`CreateSlackAppRequest`](https://docs.gravityrail.com/sdk/interfaces/CreateSlackAppRequest.md) #### Returns[​](#returns-123 "Direct link to Returns") `Promise`<[`SlackApp`](https://docs.gravityrail.com/sdk/type-aliases/SlackApp.md)> #### Implementation of[​](#implementation-of-122 "Direct link to Implementation of") `IntegrationsBindings.createSlackApp` *** ### createStep()[​](#createstep "Direct link to createStep()") > **createStep**: (`wid`, `journeyId`, `data`) => `Promise`<`JourneyStepResponse`> Defined in: [packages/sdk/src/client/client.ts:331](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L331) Create a step within a journey. #### Parameters[​](#parameters-124 "Direct link to Parameters") ##### wid[​](#wid-96 "Direct link to wid") `string` ##### journeyId[​](#journeyid-6 "Direct link to journeyId") `number` ##### data[​](#data-48 "Direct link to data") `JourneyStepFormData` #### Returns[​](#returns-124 "Direct link to Returns") `Promise`<`JourneyStepResponse`> #### Implementation of[​](#implementation-of-123 "Direct link to Implementation of") `JourneysBindings.createStep` *** ### createSupervisor()[​](#createsupervisor "Direct link to createSupervisor()") > **createSupervisor**: (`wid`, `supervisor`) => `Promise`<[`CustomTool`](https://docs.gravityrail.com/sdk/type-aliases/CustomTool.md)> Defined in: [packages/sdk/src/client/client.ts:688](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L688) Create a new supervisor in a workspace. #### Parameters[​](#parameters-125 "Direct link to Parameters") ##### wid[​](#wid-97 "Direct link to wid") `string` ##### supervisor[​](#supervisor "Direct link to supervisor") [`SupervisorFormData`](https://docs.gravityrail.com/sdk/interfaces/SupervisorFormData.md) #### Returns[​](#returns-125 "Direct link to Returns") `Promise`<[`CustomTool`](https://docs.gravityrail.com/sdk/type-aliases/CustomTool.md)> #### Implementation of[​](#implementation-of-124 "Direct link to Implementation of") `WorkflowsBindings.createSupervisor` *** ### createSupportRequest()[​](#createsupportrequest "Direct link to createSupportRequest()") > **createSupportRequest**: (`data`) => `Promise`<`SupportRequest`> Defined in: [packages/sdk/src/client/client.ts:1082](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L1082) #### Parameters[​](#parameters-126 "Direct link to Parameters") ##### data[​](#data-49 "Direct link to data") `CreateSupportRequestRequest` #### Returns[​](#returns-126 "Direct link to Returns") `Promise`<`SupportRequest`> #### Implementation of[​](#implementation-of-125 "Direct link to Implementation of") `SupportRequestsBindings.createSupportRequest` *** ### createTask()[​](#createtask "Direct link to createTask()") > **createTask**: (`wid`, `task`) => `Promise`<[`Task`](https://docs.gravityrail.com/sdk/type-aliases/Task.md)> Defined in: [packages/sdk/src/client/client.ts:126](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L126) Create a new task in a workspace. #### Parameters[​](#parameters-127 "Direct link to Parameters") ##### wid[​](#wid-98 "Direct link to wid") `string` ##### task[​](#task "Direct link to task") [`TaskFormData`](https://docs.gravityrail.com/sdk/interfaces/TaskFormData.md) #### Returns[​](#returns-127 "Direct link to Returns") `Promise`<[`Task`](https://docs.gravityrail.com/sdk/type-aliases/Task.md)> #### Implementation of[​](#implementation-of-126 "Direct link to Implementation of") `TasksBindings.createTask` *** ### createTeamsApp()[​](#createteamsapp "Direct link to createTeamsApp()") > **createTeamsApp**: (`wid`, `data`) => `Promise`<[`TeamsAppResponse`](https://docs.gravityrail.com/sdk/interfaces/TeamsAppResponse.md)> Defined in: [packages/sdk/src/client/client.ts:913](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L913) #### Parameters[​](#parameters-128 "Direct link to Parameters") ##### wid[​](#wid-99 "Direct link to wid") `string` ##### data[​](#data-50 "Direct link to data") [`CreateTeamsAppRequest`](https://docs.gravityrail.com/sdk/interfaces/CreateTeamsAppRequest.md) #### Returns[​](#returns-128 "Direct link to Returns") `Promise`<[`TeamsAppResponse`](https://docs.gravityrail.com/sdk/interfaces/TeamsAppResponse.md)> #### Implementation of[​](#implementation-of-127 "Direct link to Implementation of") `IntegrationsBindings.createTeamsApp` *** ### createWorkflow()[​](#createworkflow "Direct link to createWorkflow()") > **createWorkflow**: (`wid`, `workflow`) => `Promise`<[`Workflow`](https://docs.gravityrail.com/sdk/type-aliases/Workflow.md)> Defined in: [packages/sdk/src/client/client.ts:651](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L651) Create a new workflow in a workspace. #### Parameters[​](#parameters-129 "Direct link to Parameters") ##### wid[​](#wid-100 "Direct link to wid") `string` ##### workflow[​](#workflow "Direct link to workflow") [`WorkflowFormData`](https://docs.gravityrail.com/sdk/interfaces/WorkflowFormData.md) #### Returns[​](#returns-129 "Direct link to Returns") `Promise`<[`Workflow`](https://docs.gravityrail.com/sdk/type-aliases/Workflow.md)> #### Implementation of[​](#implementation-of-128 "Direct link to Implementation of") `WorkflowsBindings.createWorkflow` *** ### createWorkflowContributor()[​](#createworkflowcontributor "Direct link to createWorkflowContributor()") > **createWorkflowContributor**: (`wid`, `workflowId`, `data`) => `Promise`<[`WorkflowContributorResponse`](https://docs.gravityrail.com/sdk/interfaces/WorkflowContributorResponse.md)> Defined in: [packages/sdk/src/client/client.ts:669](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L669) Add a contributor to a workflow. #### Parameters[​](#parameters-130 "Direct link to Parameters") ##### wid[​](#wid-101 "Direct link to wid") `string` ##### workflowId[​](#workflowid "Direct link to workflowId") `number` ##### data[​](#data-51 "Direct link to data") [`CreateWorkflowContributorRequest`](https://docs.gravityrail.com/sdk/interfaces/CreateWorkflowContributorRequest.md) #### Returns[​](#returns-130 "Direct link to Returns") `Promise`<[`WorkflowContributorResponse`](https://docs.gravityrail.com/sdk/interfaces/WorkflowContributorResponse.md)> #### Implementation of[​](#implementation-of-129 "Direct link to Implementation of") `WorkflowsBindings.createWorkflowContributor` *** ### createWorkflowFromTemplate()[​](#createworkflowfromtemplate "Direct link to createWorkflowFromTemplate()") > **createWorkflowFromTemplate**: (`wid`, `templateUuid`, `data`) => `Promise`<[`Workflow`](https://docs.gravityrail.com/sdk/type-aliases/Workflow.md)> Defined in: [packages/sdk/src/client/client.ts:659](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L659) Create a new workflow from a template. #### Parameters[​](#parameters-131 "Direct link to Parameters") ##### wid[​](#wid-102 "Direct link to wid") `string` ##### templateUuid[​](#templateuuid "Direct link to templateUuid") `string` ##### data[​](#data-52 "Direct link to data") [`CreateWorkflowFromTemplateFormData`](https://docs.gravityrail.com/sdk/interfaces/CreateWorkflowFromTemplateFormData.md) #### Returns[​](#returns-131 "Direct link to Returns") `Promise`<[`Workflow`](https://docs.gravityrail.com/sdk/type-aliases/Workflow.md)> #### Implementation of[​](#implementation-of-130 "Direct link to Implementation of") `WorkflowsBindings.createWorkflowFromTemplate` *** ### createWorkflowNote()[​](#createworkflownote "Direct link to createWorkflowNote()") > **createWorkflowNote**: (`wid`, `workflowId`, `data`) => `Promise`<[`WorkflowNoteResponse`](https://docs.gravityrail.com/sdk/interfaces/WorkflowNoteResponse.md)> Defined in: [packages/sdk/src/client/client.ts:665](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L665) Create a new note on a workflow. #### Parameters[​](#parameters-132 "Direct link to Parameters") ##### wid[​](#wid-103 "Direct link to wid") `string` ##### workflowId[​](#workflowid-1 "Direct link to workflowId") `number` ##### data[​](#data-53 "Direct link to data") [`WorkflowNoteFormData`](https://docs.gravityrail.com/sdk/interfaces/WorkflowNoteFormData.md) #### Returns[​](#returns-132 "Direct link to Returns") `Promise`<[`WorkflowNoteResponse`](https://docs.gravityrail.com/sdk/interfaces/WorkflowNoteResponse.md)> #### Implementation of[​](#implementation-of-131 "Direct link to Implementation of") `WorkflowsBindings.createWorkflowNote` *** ### createWorkflowOutboundVoiceChat()[​](#createworkflowoutboundvoicechat "Direct link to createWorkflowOutboundVoiceChat()") > **createWorkflowOutboundVoiceChat**: (`wid`, `input`) => `Promise`<[`ChatResponse`](https://docs.gravityrail.com/sdk/interfaces/ChatResponse.md)> Defined in: [packages/sdk/src/client/client.ts:153](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L153) 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[​](#parameters-133 "Direct link to Parameters") ##### wid[​](#wid-104 "Direct link to wid") `string` ##### input[​](#input "Direct link to input") [`CreatePhoneVoiceOutboundChatInput`](https://docs.gravityrail.com/sdk/interfaces/CreatePhoneVoiceOutboundChatInput.md) #### Returns[​](#returns-133 "Direct link to Returns") `Promise`<[`ChatResponse`](https://docs.gravityrail.com/sdk/interfaces/ChatResponse.md)> #### Implementation of[​](#implementation-of-132 "Direct link to Implementation of") `ChatsBindings.createWorkflowOutboundVoiceChat` *** ### createWorkspace()[​](#createworkspace "Direct link to createWorkspace()") > **createWorkspace**: (`workspace`) => `Promise`<[`Workspace`](https://docs.gravityrail.com/sdk/interfaces/Workspace.md)> Defined in: [packages/sdk/src/client/client.ts:403](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L403) Create a new workspace. #### Parameters[​](#parameters-134 "Direct link to Parameters") ##### workspace[​](#workspace "Direct link to workspace") [`WorkspaceFormData`](https://docs.gravityrail.com/sdk/interfaces/WorkspaceFormData.md) #### Returns[​](#returns-134 "Direct link to Returns") `Promise`<[`Workspace`](https://docs.gravityrail.com/sdk/interfaces/Workspace.md)> #### Implementation of[​](#implementation-of-133 "Direct link to Implementation of") `WorkspacesBindings.createWorkspace` *** ### createWorkspaceMember()[​](#createworkspacemember "Direct link to createWorkspaceMember()") > **createWorkspaceMember**: (`wid`, `data`) => `Promise`<[`WorkspaceMemberResponse`](https://docs.gravityrail.com/sdk/interfaces/WorkspaceMemberResponse.md)> Defined in: [packages/sdk/src/client/client.ts:226](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L226) Create a new workspace member. #### Parameters[​](#parameters-135 "Direct link to Parameters") ##### wid[​](#wid-105 "Direct link to wid") `string` ##### data[​](#data-54 "Direct link to data") [`CreateWorkspaceMemberRequest`](https://docs.gravityrail.com/sdk/interfaces/CreateWorkspaceMemberRequest.md) #### Returns[​](#returns-135 "Direct link to Returns") `Promise`<[`WorkspaceMemberResponse`](https://docs.gravityrail.com/sdk/interfaces/WorkspaceMemberResponse.md)> #### Implementation of[​](#implementation-of-134 "Direct link to Implementation of") `MembersBindings.createWorkspaceMember` *** ### createWorkspaceSupportRequest()[​](#createworkspacesupportrequest "Direct link to createWorkspaceSupportRequest()") > **createWorkspaceSupportRequest**: (`workspaceUuid`, `data`) => `Promise`<`SupportRequest`> Defined in: [packages/sdk/src/client/client.ts:1090](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L1090) #### Parameters[​](#parameters-136 "Direct link to Parameters") ##### workspaceUuid[​](#workspaceuuid-5 "Direct link to workspaceUuid") `string` ##### data[​](#data-55 "Direct link to data") `CreateSupportRequestRequest` #### Returns[​](#returns-136 "Direct link to Returns") `Promise`<`SupportRequest`> #### Implementation of[​](#implementation-of-135 "Direct link to Implementation of") `SupportRequestsBindings.createWorkspaceSupportRequest` *** ### deactivateWorkflowVersion()[​](#deactivateworkflowversion "Direct link to deactivateWorkflowVersion()") > **deactivateWorkflowVersion**: (`wid`, `workflowUuid`, `versionNumber`) => `Promise`<`WorkflowVersionResponse`> Defined in: [packages/sdk/src/client/client.ts:678](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L678) Deactivate a published version. #### Parameters[​](#parameters-137 "Direct link to Parameters") ##### wid[​](#wid-106 "Direct link to wid") `string` ##### workflowUuid[​](#workflowuuid-1 "Direct link to workflowUuid") `string` ##### versionNumber[​](#versionnumber-1 "Direct link to versionNumber") `number` #### Returns[​](#returns-137 "Direct link to Returns") `Promise`<`WorkflowVersionResponse`> #### Implementation of[​](#implementation-of-136 "Direct link to Implementation of") `WorkflowsBindings.deactivateWorkflowVersion` *** ### declineInvitation()[​](#declineinvitation "Direct link to declineInvitation()") > **declineInvitation**: (`requestId`) => `Promise`<[`InvitationResponse`](https://docs.gravityrail.com/sdk/type-aliases/InvitationResponse.md)> Defined in: [packages/sdk/src/client/client.ts:483](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L483) Decline an invitation by ID (for invitees declining their own invitations) Works for both organization and workspace invitations. #### Parameters[​](#parameters-138 "Direct link to Parameters") ##### requestId[​](#requestid-2 "Direct link to requestId") `number` #### Returns[​](#returns-138 "Direct link to Returns") `Promise`<[`InvitationResponse`](https://docs.gravityrail.com/sdk/type-aliases/InvitationResponse.md)> #### Implementation of[​](#implementation-of-137 "Direct link to Implementation of") `WorkspacesBindings.declineInvitation` *** ### deleteAbility()[​](#deleteability "Direct link to deleteAbility()") > **deleteAbility**: (`wid`, `abilityUuid`) => `Promise`<`void`> Defined in: [packages/sdk/src/client/client.ts:137](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L137) Delete a configured ability instance by UUID. #### Parameters[​](#parameters-139 "Direct link to Parameters") ##### wid[​](#wid-107 "Direct link to wid") `string` ##### abilityUuid[​](#abilityuuid "Direct link to abilityUuid") `string` #### Returns[​](#returns-139 "Direct link to Returns") `Promise`<`void`> #### Implementation of[​](#implementation-of-138 "Direct link to Implementation of") `TasksBindings.deleteAbility` *** ### deleteAgent()[​](#deleteagent "Direct link to deleteAgent()") > **deleteAgent**: (`wid`, `id`, `force?`) => `Promise`<`void`> Defined in: [packages/sdk/src/client/client.ts:290](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L290) Delete an agent by ID, optionally forcing deletion of agents with active references. #### Parameters[​](#parameters-140 "Direct link to Parameters") ##### wid[​](#wid-108 "Direct link to wid") `string` ##### id[​](#id-9 "Direct link to id") `number` ##### force?[​](#force "Direct link to force?") `boolean` #### Returns[​](#returns-140 "Direct link to Returns") `Promise`<`void`> #### Implementation of[​](#implementation-of-139 "Direct link to Implementation of") `AgentsBindings.deleteAgent` *** ### deleteApp()[​](#deleteapp "Direct link to deleteApp()") > **deleteApp**: (`appId`) => `Promise`<{ `message`: `string`; }> Defined in: [packages/sdk/src/client/client.ts:833](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L833) Delete an app #### Parameters[​](#parameters-141 "Direct link to Parameters") ##### appId[​](#appid "Direct link to appId") `string` #### Returns[​](#returns-141 "Direct link to Returns") `Promise`<{ `message`: `string`; }> #### Implementation of[​](#implementation-of-140 "Direct link to Implementation of") `AppsBindings.deleteApp` *** ### deleteAssignment()[​](#deleteassignment "Direct link to deleteAssignment()") > **deleteAssignment**: (`wid`, `id`) => `Promise`<`void`> Defined in: [packages/sdk/src/client/client.ts:531](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L531) Delete an assignment by ID. #### Parameters[​](#parameters-142 "Direct link to Parameters") ##### wid[​](#wid-109 "Direct link to wid") `string` ##### id[​](#id-10 "Direct link to id") `number` #### Returns[​](#returns-142 "Direct link to Returns") `Promise`<`void`> #### Implementation of[​](#implementation-of-141 "Direct link to Implementation of") `AuthBindings.deleteAssignment` *** ### deleteBuilder()[​](#deletebuilder "Direct link to deleteBuilder()") > **deleteBuilder**: (`builderId`) => `Promise`<{ `message`: `string`; }> Defined in: [packages/sdk/src/client/client.ts:840](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L840) Delete a builder #### Parameters[​](#parameters-143 "Direct link to Parameters") ##### builderId[​](#builderid-1 "Direct link to builderId") `string` #### Returns[​](#returns-143 "Direct link to Returns") `Promise`<{ `message`: `string`; }> #### Implementation of[​](#implementation-of-142 "Direct link to Implementation of") `AppsBindings.deleteBuilder` *** ### deleteCalendar()[​](#deletecalendar "Direct link to deleteCalendar()") > **deleteCalendar**: (`wid`, `id`) => `Promise`<`void`> Defined in: [packages/sdk/src/client/client.ts:697](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L697) Delete a calendar by ID. #### Parameters[​](#parameters-144 "Direct link to Parameters") ##### wid[​](#wid-110 "Direct link to wid") `string` ##### id[​](#id-11 "Direct link to id") `number` #### Returns[​](#returns-144 "Direct link to Returns") `Promise`<`void`> #### Implementation of[​](#implementation-of-143 "Direct link to Implementation of") `CalendarsBindings.deleteCalendar` *** ### deleteCalendarEvent()[​](#deletecalendarevent "Direct link to deleteCalendarEvent()") > **deleteCalendarEvent**: (`wid`, `eventId`) => `Promise`<`void`> Defined in: [packages/sdk/src/client/client.ts:709](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L709) Delete a calendar event by ID. #### Parameters[​](#parameters-145 "Direct link to Parameters") ##### wid[​](#wid-111 "Direct link to wid") `string` ##### eventId[​](#eventid-1 "Direct link to eventId") `number` #### Returns[​](#returns-145 "Direct link to Returns") `Promise`<`void`> #### Implementation of[​](#implementation-of-144 "Direct link to Implementation of") `CalendarsBindings.deleteCalendarEvent` *** ### deleteCalendarEventType()[​](#deletecalendareventtype "Direct link to deleteCalendarEventType()") > **deleteCalendarEventType**: (`wid`, `id`) => `Promise`<`void`> Defined in: [packages/sdk/src/client/client.ts:715](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L715) Delete a calendar event type by ID. #### Parameters[​](#parameters-146 "Direct link to Parameters") ##### wid[​](#wid-112 "Direct link to wid") `string` ##### id[​](#id-12 "Direct link to id") `number` #### Returns[​](#returns-146 "Direct link to Returns") `Promise`<`void`> #### Implementation of[​](#implementation-of-145 "Direct link to Implementation of") `CalendarsBindings.deleteCalendarEventType` *** ### deleteCalendarSchedule()[​](#deletecalendarschedule "Direct link to deleteCalendarSchedule()") > **deleteCalendarSchedule**: (`wid`, `calendarId`, `scheduleId`) => `Promise`<`void`> Defined in: [packages/sdk/src/client/client.ts:701](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L701) Delete a calendar schedule. #### Parameters[​](#parameters-147 "Direct link to Parameters") ##### wid[​](#wid-113 "Direct link to wid") `string` ##### calendarId[​](#calendarid-2 "Direct link to calendarId") `number` ##### scheduleId[​](#scheduleid "Direct link to scheduleId") `number` #### Returns[​](#returns-147 "Direct link to Returns") `Promise`<`void`> #### Implementation of[​](#implementation-of-146 "Direct link to Implementation of") `CalendarsBindings.deleteCalendarSchedule` *** ### deleteChat()[​](#deletechat "Direct link to deleteChat()") > **deleteChat**: (`wid`, `id`, `reason?`) => `Promise`<`void`> Defined in: [packages/sdk/src/client/client.ts:154](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L154) Delete a chat, optionally providing a reason. #### Parameters[​](#parameters-148 "Direct link to Parameters") ##### wid[​](#wid-114 "Direct link to wid") `string` ##### id[​](#id-13 "Direct link to id") `number` ##### reason?[​](#reason-2 "Direct link to reason?") `string` #### Returns[​](#returns-148 "Direct link to Returns") `Promise`<`void`> #### Implementation of[​](#implementation-of-147 "Direct link to Implementation of") `ChatsBindings.deleteChat` *** ### deleteChatFilter()[​](#deletechatfilter "Direct link to deleteChatFilter()") > **deleteChatFilter**: (`wid`, `id`) => `Promise`<`void`> Defined in: [packages/sdk/src/client/client.ts:183](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L183) Delete a chat filter. #### Parameters[​](#parameters-149 "Direct link to Parameters") ##### wid[​](#wid-115 "Direct link to wid") `string` ##### id[​](#id-14 "Direct link to id") `number` #### Returns[​](#returns-149 "Direct link to Returns") `Promise`<`void`> #### Implementation of[​](#implementation-of-148 "Direct link to Implementation of") `ChatsBindings.deleteChatFilter` *** ### deleteChatLabel()[​](#deletechatlabel "Direct link to deleteChatLabel()") > **deleteChatLabel**: (`wid`, `id`) => `Promise`<`void`> Defined in: [packages/sdk/src/client/client.ts:177](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L177) Delete a chat label. #### Parameters[​](#parameters-150 "Direct link to Parameters") ##### wid[​](#wid-116 "Direct link to wid") `string` ##### id[​](#id-15 "Direct link to id") `number` #### Returns[​](#returns-150 "Direct link to Returns") `Promise`<`void`> #### Implementation of[​](#implementation-of-149 "Direct link to Implementation of") `ChatsBindings.deleteChatLabel` *** ### deleteClientWorkspace()[​](#deleteclientworkspace "Direct link to deleteClientWorkspace()") > **deleteClientWorkspace**: (`wid`, `workspaceId`) => `Promise`<{ `message`: `string`; }> Defined in: [packages/sdk/src/client/client.ts:425](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L425) Delete a client workspace. #### Parameters[​](#parameters-151 "Direct link to Parameters") ##### wid[​](#wid-117 "Direct link to wid") `string` ##### workspaceId[​](#workspaceid "Direct link to workspaceId") `number` #### Returns[​](#returns-151 "Direct link to Returns") `Promise`<{ `message`: `string`; }> #### Implementation of[​](#implementation-of-150 "Direct link to Implementation of") `WorkspacesBindings.deleteClientWorkspace` *** ### deleteConfluence()[​](#deleteconfluence "Direct link to deleteConfluence()") > **deleteConfluence**: (`wid`) => `Promise`<{ `status`: `string`; }> Defined in: [packages/sdk/src/client/client.ts:978](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L978) #### Parameters[​](#parameters-152 "Direct link to Parameters") ##### wid[​](#wid-118 "Direct link to wid") `string` #### Returns[​](#returns-152 "Direct link to Returns") `Promise`<{ `status`: `string`; }> #### Implementation of[​](#implementation-of-151 "Direct link to Implementation of") `IntegrationsBindings.deleteConfluence` *** ### deleteConnection()[​](#deleteconnection "Direct link to deleteConnection()") > **deleteConnection**: (`wid`, `journeyId`, `connectionId`) => `Promise`<{ `status`: `string`; }> Defined in: [packages/sdk/src/client/client.ts:336](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L336) Delete a connection by ID. #### Parameters[​](#parameters-153 "Direct link to Parameters") ##### wid[​](#wid-119 "Direct link to wid") `string` ##### journeyId[​](#journeyid-7 "Direct link to journeyId") `number` ##### connectionId[​](#connectionid-1 "Direct link to connectionId") `number` #### Returns[​](#returns-153 "Direct link to Returns") `Promise`<{ `status`: `string`; }> #### Implementation of[​](#implementation-of-152 "Direct link to Implementation of") `JourneysBindings.deleteConnection` *** ### deleteCustomTool()[​](#deletecustomtool "Direct link to deleteCustomTool()") > **deleteCustomTool**: (`wid`, `toolkitId`, `toolId`) => `Promise`<{ `status`: `string`; }> Defined in: [packages/sdk/src/client/client.ts:788](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L788) Delete a custom tool #### Parameters[​](#parameters-154 "Direct link to Parameters") ##### wid[​](#wid-120 "Direct link to wid") `string` ##### toolkitId[​](#toolkitid-1 "Direct link to toolkitId") `number` ##### toolId[​](#toolid "Direct link to toolId") `number` #### Returns[​](#returns-154 "Direct link to Returns") `Promise`<{ `status`: `string`; }> #### Implementation of[​](#implementation-of-153 "Direct link to Implementation of") `ToolkitsBindings.deleteCustomTool` *** ### deleteCustomToolkit()[​](#deletecustomtoolkit "Direct link to deleteCustomToolkit()") > **deleteCustomToolkit**: (`wid`, `toolkitId`) => `Promise`<{ `status`: `string`; }> Defined in: [packages/sdk/src/client/client.ts:783](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L783) Delete a custom toolkit #### Parameters[​](#parameters-155 "Direct link to Parameters") ##### wid[​](#wid-121 "Direct link to wid") `string` ##### toolkitId[​](#toolkitid-2 "Direct link to toolkitId") `number` #### Returns[​](#returns-155 "Direct link to Returns") `Promise`<{ `status`: `string`; }> #### Implementation of[​](#implementation-of-154 "Direct link to Implementation of") `ToolkitsBindings.deleteCustomToolkit` *** ### deleteDataRecord()[​](#deletedatarecord "Direct link to deleteDataRecord()") > **deleteDataRecord**: (`wid`, `dataTypeId`, `recordId`) => `Promise`<`void`> Defined in: [packages/sdk/src/client/client.ts:210](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L210) Delete a data record by ID. #### Parameters[​](#parameters-156 "Direct link to Parameters") ##### wid[​](#wid-122 "Direct link to wid") `string` ##### dataTypeId[​](#datatypeid-1 "Direct link to dataTypeId") `number` ##### recordId[​](#recordid "Direct link to recordId") `number` #### Returns[​](#returns-156 "Direct link to Returns") `Promise`<`void`> #### Implementation of[​](#implementation-of-155 "Direct link to Implementation of") `DataTypesBindings.deleteDataRecord` *** ### deleteDataType()[​](#deletedatatype "Direct link to deleteDataType()") > **deleteDataType**: (`wid`, `id`) => `Promise`<`void`> Defined in: [packages/sdk/src/client/client.ts:202](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L202) Delete a data type definition by ID. #### Parameters[​](#parameters-157 "Direct link to Parameters") ##### wid[​](#wid-123 "Direct link to wid") `string` ##### id[​](#id-16 "Direct link to id") `number` #### Returns[​](#returns-157 "Direct link to Returns") `Promise`<`void`> #### Implementation of[​](#implementation-of-156 "Direct link to Implementation of") `DataTypesBindings.deleteDataType` *** ### deleteDiscordBot()[​](#deletediscordbot "Direct link to deleteDiscordBot()") > **deleteDiscordBot**: (`wid`, `botId`) => `Promise`<`void`> Defined in: [packages/sdk/src/client/client.ts:891](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L891) Delete a Discord bot configuration. #### Parameters[​](#parameters-158 "Direct link to Parameters") ##### wid[​](#wid-124 "Direct link to wid") `string` ##### botId[​](#botid "Direct link to botId") `number` #### Returns[​](#returns-158 "Direct link to Returns") `Promise`<`void`> #### Implementation of[​](#implementation-of-157 "Direct link to Implementation of") `IntegrationsBindings.deleteDiscordBot` *** ### deleteEnrollment()[​](#deleteenrollment "Direct link to deleteEnrollment()") > **deleteEnrollment**: (`wid`, `journeyId`, `memberId`) => `Promise`<`void`> Defined in: [packages/sdk/src/client/client.ts:344](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L344) Hard-delete a canceled enrollment so the member can be re-enrolled fresh. #### Parameters[​](#parameters-159 "Direct link to Parameters") ##### wid[​](#wid-125 "Direct link to wid") `string` ##### journeyId[​](#journeyid-8 "Direct link to journeyId") `number` ##### memberId[​](#memberid-5 "Direct link to memberId") `number` #### Returns[​](#returns-159 "Direct link to Returns") `Promise`<`void`> #### Implementation of[​](#implementation-of-158 "Direct link to Implementation of") `JourneysBindings.deleteEnrollment` *** ### deleteEventRule()[​](#deleteeventrule "Direct link to deleteEventRule()") > **deleteEventRule**: (`wid`, `id`) => `Promise`<`void`> Defined in: [packages/sdk/src/client/client.ts:629](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L629) Delete an event rule by ID. #### Parameters[​](#parameters-160 "Direct link to Parameters") ##### wid[​](#wid-126 "Direct link to wid") `string` ##### id[​](#id-17 "Direct link to id") `number` #### Returns[​](#returns-160 "Direct link to Returns") `Promise`<`void`> #### Implementation of[​](#implementation-of-159 "Direct link to Implementation of") `EventsBindings.deleteEventRule` *** ### deleteExperiment()[​](#deleteexperiment "Direct link to deleteExperiment()") > **deleteExperiment**: (`wid`, `experimentId`) => `Promise`<{ `status`: `string`; }> Defined in: [packages/sdk/src/client/client.ts:361](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L361) Hard-delete a draft experiment, or archive otherwise. #### Parameters[​](#parameters-161 "Direct link to Parameters") ##### wid[​](#wid-127 "Direct link to wid") `string` ##### experimentId[​](#experimentid-2 "Direct link to experimentId") `number` #### Returns[​](#returns-161 "Direct link to Returns") `Promise`<{ `status`: `string`; }> #### Implementation of[​](#implementation-of-160 "Direct link to Implementation of") `ExperimentsBindings.deleteExperiment` *** ### deleteExperimentAssignment()[​](#deleteexperimentassignment "Direct link to deleteExperimentAssignment()") > **deleteExperimentAssignment**: (`wid`, `experimentId`, `memberId`) => `Promise`<{ `status`: `string`; }> Defined in: [packages/sdk/src/client/client.ts:369](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L369) Remove a member's assignment from an experiment. #### Parameters[​](#parameters-162 "Direct link to Parameters") ##### wid[​](#wid-128 "Direct link to wid") `string` ##### experimentId[​](#experimentid-3 "Direct link to experimentId") `number` ##### memberId[​](#memberid-6 "Direct link to memberId") `number` #### Returns[​](#returns-162 "Direct link to Returns") `Promise`<{ `status`: `string`; }> #### Implementation of[​](#implementation-of-161 "Direct link to Implementation of") `ExperimentsBindings.deleteExperimentAssignment` *** ### deleteExperimentGroup()[​](#deleteexperimentgroup "Direct link to deleteExperimentGroup()") > **deleteExperimentGroup**: (`wid`, `experimentId`, `groupId`) => `Promise`<{ `status`: `string`; }> Defined in: [packages/sdk/src/client/client.ts:364](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L364) Delete a group that has no member assignments. #### Parameters[​](#parameters-163 "Direct link to Parameters") ##### wid[​](#wid-129 "Direct link to wid") `string` ##### experimentId[​](#experimentid-4 "Direct link to experimentId") `number` ##### groupId[​](#groupid-2 "Direct link to groupId") `number` #### Returns[​](#returns-163 "Direct link to Returns") `Promise`<{ `status`: `string`; }> #### Implementation of[​](#implementation-of-162 "Direct link to Implementation of") `ExperimentsBindings.deleteExperimentGroup` *** ### deleteFhirConnection()[​](#deletefhirconnection "Direct link to deleteFhirConnection()") > **deleteFhirConnection**: (`wid`, `connectionId`) => `Promise`<`void`> Defined in: [packages/sdk/src/client/client.ts:926](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L926) Delete a FHIR connection configuration. #### Parameters[​](#parameters-164 "Direct link to Parameters") ##### wid[​](#wid-130 "Direct link to wid") `string` ##### connectionId[​](#connectionid-2 "Direct link to connectionId") `number` #### Returns[​](#returns-164 "Direct link to Returns") `Promise`<`void`> #### Implementation of[​](#implementation-of-163 "Direct link to Implementation of") `IntegrationsBindings.deleteFhirConnection` *** ### deleteFile()[​](#deletefile "Direct link to deleteFile()") > **deleteFile**: (`wid`, `id`) => `Promise`<`void`> Defined in: [packages/sdk/src/client/client.ts:593](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L593) Delete a file by ID. #### Parameters[​](#parameters-165 "Direct link to Parameters") ##### wid[​](#wid-131 "Direct link to wid") `string` ##### id[​](#id-18 "Direct link to id") `number` #### Returns[​](#returns-165 "Direct link to Returns") `Promise`<`void`> #### Implementation of[​](#implementation-of-164 "Direct link to Implementation of") `FilesBindings.deleteFile` *** ### deleteFileLabel()[​](#deletefilelabel "Direct link to deleteFileLabel()") > **deleteFileLabel**: (`wid`, `id`) => `Promise`<`void`> Defined in: [packages/sdk/src/client/client.ts:608](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L608) Delete a file label by ID. #### Parameters[​](#parameters-166 "Direct link to Parameters") ##### wid[​](#wid-132 "Direct link to wid") `string` ##### id[​](#id-19 "Direct link to id") `number` #### Returns[​](#returns-166 "Direct link to Returns") `Promise`<`void`> #### Implementation of[​](#implementation-of-165 "Direct link to Implementation of") `FilesBindings.deleteFileLabel` *** ### deleteFolder()[​](#deletefolder "Direct link to deleteFolder()") > **deleteFolder**: (`wid`, `id`) => `Promise`<`void`> Defined in: [packages/sdk/src/client/client.ts:600](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L600) Delete a folder by ID. #### Parameters[​](#parameters-167 "Direct link to Parameters") ##### wid[​](#wid-133 "Direct link to wid") `string` ##### id[​](#id-20 "Direct link to id") `number` #### Returns[​](#returns-167 "Direct link to Returns") `Promise`<`void`> #### Implementation of[​](#implementation-of-166 "Direct link to Implementation of") `FilesBindings.deleteFolder` *** ### deleteGoal()[​](#deletegoal "Direct link to deleteGoal()") > **deleteGoal**: (`wid`, `journeyId`, `goalUuid`) => `Promise`<{ `status`: `string`; }> Defined in: [packages/sdk/src/client/client.ts:339](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L339) Delete a goal. #### Parameters[​](#parameters-168 "Direct link to Parameters") ##### wid[​](#wid-134 "Direct link to wid") `string` ##### journeyId[​](#journeyid-9 "Direct link to journeyId") `number` ##### goalUuid[​](#goaluuid "Direct link to goalUuid") `string` #### Returns[​](#returns-168 "Direct link to Returns") `Promise`<{ `status`: `string`; }> #### Implementation of[​](#implementation-of-167 "Direct link to Implementation of") `JourneysBindings.deleteGoal` *** ### deleteHubspot()[​](#deletehubspot "Direct link to deleteHubspot()") > **deleteHubspot**: (`wid`) => `Promise`<{ `status`: `string`; }> Defined in: [packages/sdk/src/client/client.ts:1008](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L1008) #### Parameters[​](#parameters-169 "Direct link to Parameters") ##### wid[​](#wid-135 "Direct link to wid") `string` #### Returns[​](#returns-169 "Direct link to Returns") `Promise`<{ `status`: `string`; }> #### Implementation of[​](#implementation-of-168 "Direct link to Implementation of") `IntegrationsBindings.deleteHubspot` *** ### deleteInbox()[​](#deleteinbox "Direct link to deleteInbox()") > **deleteInbox**: (`wid`, `id`) => `Promise`<`void`> Defined in: [packages/sdk/src/client/client.ts:751](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L751) Delete an inbox. #### Parameters[​](#parameters-170 "Direct link to Parameters") ##### wid[​](#wid-136 "Direct link to wid") `string` ##### id[​](#id-21 "Direct link to id") `number` #### Returns[​](#returns-170 "Direct link to Returns") `Promise`<`void`> #### Implementation of[​](#implementation-of-169 "Direct link to Implementation of") `CommunicationsBindings.deleteInbox` *** ### deleteInquiry()[​](#deleteinquiry "Direct link to deleteInquiry()") > **deleteInquiry**: (`inquiryId`) => `Promise`<`void`> Defined in: [packages/sdk/src/client/client.ts:846](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L846) Delete an inquiry (superuser only) #### Parameters[​](#parameters-171 "Direct link to Parameters") ##### inquiryId[​](#inquiryid "Direct link to inquiryId") `number` #### Returns[​](#returns-171 "Direct link to Returns") `Promise`<`void`> #### Implementation of[​](#implementation-of-170 "Direct link to Implementation of") `AppsBindings.deleteInquiry` *** ### deleteJourneyNote()[​](#deletejourneynote "Direct link to deleteJourneyNote()") > **deleteJourneyNote**: (`wid`, `journeyId`, `noteId`) => `Promise`<`void`> Defined in: [packages/sdk/src/client/client.ts:354](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L354) Delete a journey note. #### Parameters[​](#parameters-172 "Direct link to Parameters") ##### wid[​](#wid-137 "Direct link to wid") `string` ##### journeyId[​](#journeyid-10 "Direct link to journeyId") `number` ##### noteId[​](#noteid "Direct link to noteId") `number` #### Returns[​](#returns-172 "Direct link to Returns") `Promise`<`void`> #### Implementation of[​](#implementation-of-171 "Direct link to Implementation of") `JourneysBindings.deleteJourneyNote` *** ### deleteMcpServer()[​](#deletemcpserver "Direct link to deleteMcpServer()") > **deleteMcpServer**: (`wid`, `serverId`) => `Promise`<{ `message`: `string`; }> Defined in: [packages/sdk/src/client/client.ts:793](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L793) Delete an MCP server #### Parameters[​](#parameters-173 "Direct link to Parameters") ##### wid[​](#wid-138 "Direct link to wid") `string` ##### serverId[​](#serverid "Direct link to serverId") `number` #### Returns[​](#returns-173 "Direct link to Returns") `Promise`<{ `message`: `string`; }> #### Implementation of[​](#implementation-of-172 "Direct link to Implementation of") `ToolkitsBindings.deleteMcpServer` *** ### deleteMember()[​](#deletemember "Direct link to deleteMember()") > **deleteMember**: (`wid`, `memberId`, `options?`) => `Promise`<`void`> Defined in: [packages/sdk/src/client/client.ts:228](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L228) Delete a workspace member, optionally forcing removal of associated data. #### Parameters[​](#parameters-174 "Direct link to Parameters") ##### wid[​](#wid-139 "Direct link to wid") `string` ##### memberId[​](#memberid-7 "Direct link to memberId") `number` ##### options?[​](#options-1 "Direct link to options?") ###### force?[​](#force-1 "Direct link to force?") `boolean` #### Returns[​](#returns-174 "Direct link to Returns") `Promise`<`void`> #### Implementation of[​](#implementation-of-173 "Direct link to Implementation of") `MembersBindings.deleteMember` *** ### deleteMemberField()[​](#deletememberfield "Direct link to deleteMemberField()") > **deleteMemberField**: (`wid`, `memberId`, `fieldId`) => `Promise`<`void`> Defined in: [packages/sdk/src/client/client.ts:261](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L261) Delete a member field. Only user-created fields (no service\_id) can be deleted. #### Parameters[​](#parameters-175 "Direct link to Parameters") ##### wid[​](#wid-140 "Direct link to wid") `string` ##### memberId[​](#memberid-8 "Direct link to memberId") `number` ##### fieldId[​](#fieldid "Direct link to fieldId") `number` #### Returns[​](#returns-175 "Direct link to Returns") `Promise`<`void`> #### Implementation of[​](#implementation-of-174 "Direct link to Implementation of") `MembersBindings.deleteMemberField` *** ### deleteMemberFilter()[​](#deletememberfilter "Direct link to deleteMemberFilter()") > **deleteMemberFilter**: (`wid`, `filterId`) => `Promise`<`void`> Defined in: [packages/sdk/src/client/client.ts:242](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L242) Delete a saved member filter. #### Parameters[​](#parameters-176 "Direct link to Parameters") ##### wid[​](#wid-141 "Direct link to wid") `string` ##### filterId[​](#filterid-1 "Direct link to filterId") `number` #### Returns[​](#returns-176 "Direct link to Returns") `Promise`<`void`> #### Implementation of[​](#implementation-of-175 "Direct link to Implementation of") `MembersBindings.deleteMemberFilter` *** ### deleteMemberLabel()[​](#deletememberlabel "Direct link to deleteMemberLabel()") > **deleteMemberLabel**: (`wid`, `id`) => `Promise`<`void`> Defined in: [packages/sdk/src/client/client.ts:249](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L249) Delete a member label. #### Parameters[​](#parameters-177 "Direct link to Parameters") ##### wid[​](#wid-142 "Direct link to wid") `string` ##### id[​](#id-22 "Direct link to id") `number` #### Returns[​](#returns-177 "Direct link to Returns") `Promise`<`void`> #### Implementation of[​](#implementation-of-176 "Direct link to Implementation of") `MembersBindings.deleteMemberLabel` *** ### deleteMemberMemory()[​](#deletemembermemory "Direct link to deleteMemberMemory()") > **deleteMemberMemory**: (`wid`, `memberId`, `memoryKey`, `options?`) => `Promise`<`void`> Defined in: [packages/sdk/src/client/client.ts:275](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L275) #### Parameters[​](#parameters-178 "Direct link to Parameters") ##### wid[​](#wid-143 "Direct link to wid") `string` ##### memberId[​](#memberid-9 "Direct link to memberId") `number` ##### memoryKey[​](#memorykey "Direct link to memoryKey") `string` ##### options?[​](#options-2 "Direct link to options?") ###### type?[​](#type "Direct link to type?") [`MemoryType`](https://docs.gravityrail.com/sdk/type-aliases/MemoryType.md) #### Returns[​](#returns-178 "Direct link to Returns") `Promise`<`void`> #### Implementation of[​](#implementation-of-177 "Direct link to Implementation of") `MembersBindings.deleteMemberMemory` *** ### deleteMemberRole()[​](#deletememberrole "Direct link to deleteMemberRole()") > **deleteMemberRole**: (`wid`, `id`) => `Promise`<`void`> Defined in: [packages/sdk/src/client/client.ts:255](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L255) Delete a member role. #### Parameters[​](#parameters-179 "Direct link to Parameters") ##### wid[​](#wid-144 "Direct link to wid") `string` ##### id[​](#id-23 "Direct link to id") `number` #### Returns[​](#returns-179 "Direct link to Returns") `Promise`<`void`> #### Implementation of[​](#implementation-of-178 "Direct link to Implementation of") `MembersBindings.deleteMemberRole` *** ### deleteMenuItem()[​](#deletemenuitem "Direct link to deleteMenuItem()") > **deleteMenuItem**: (`wid`, `siteId`, `itemId`) => `Promise`<`void`> Defined in: [packages/sdk/src/client/client.ts:582](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L582) Delete a menu item from a site's navigation. #### Parameters[​](#parameters-180 "Direct link to Parameters") ##### wid[​](#wid-145 "Direct link to wid") `string` ##### siteId[​](#siteid-5 "Direct link to siteId") `number` ##### itemId[​](#itemid "Direct link to itemId") `number` #### Returns[​](#returns-180 "Direct link to Returns") `Promise`<`void`> #### Implementation of[​](#implementation-of-179 "Direct link to Implementation of") `SitesBindings.deleteMenuItem` *** ### deleteMilestone()[​](#deletemilestone "Direct link to deleteMilestone()") > **deleteMilestone**: (`wid`, `id`) => `Promise`<`void`> Defined in: [packages/sdk/src/client/client.ts:728](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L728) Delete a milestone by ID. #### Parameters[​](#parameters-181 "Direct link to Parameters") ##### wid[​](#wid-146 "Direct link to wid") `string` ##### id[​](#id-24 "Direct link to id") `number` #### Returns[​](#returns-181 "Direct link to Returns") `Promise`<`void`> #### Implementation of[​](#implementation-of-180 "Direct link to Implementation of") `CalendarsBindings.deleteMilestone` *** ### deleteMondayConnection()[​](#deletemondayconnection "Direct link to deleteMondayConnection()") > **deleteMondayConnection**: (`wid`) => `Promise`<{ `status`: `string`; }> Defined in: [packages/sdk/src/client/client.ts:870](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L870) #### Parameters[​](#parameters-182 "Direct link to Parameters") ##### wid[​](#wid-147 "Direct link to wid") `string` #### Returns[​](#returns-182 "Direct link to Returns") `Promise`<{ `status`: `string`; }> #### Implementation of[​](#implementation-of-181 "Direct link to Implementation of") `IntegrationsBindings.deleteMondayConnection` *** ### deleteMyPronunciation()[​](#deletemypronunciation "Direct link to deleteMyPronunciation()") > **deleteMyPronunciation**: (`id`) => `Promise`<`void`> Defined in: [packages/sdk/src/client/client.ts:1052](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L1052) Delete a personal pronunciation entry. #### Parameters[​](#parameters-183 "Direct link to Parameters") ##### id[​](#id-25 "Direct link to id") `number` #### Returns[​](#returns-183 "Direct link to Returns") `Promise`<`void`> #### Implementation of[​](#implementation-of-182 "Direct link to Implementation of") `PronunciationsBindings.deleteMyPronunciation` *** ### deleteNotificationRule()[​](#deletenotificationrule "Direct link to deleteNotificationRule()") > **deleteNotificationRule**: (`wid`, `ruleId`) => `Promise`<{ `message`: `string`; }> Defined in: [packages/sdk/src/client/client.ts:765](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L765) Delete a notification rule. #### Parameters[​](#parameters-184 "Direct link to Parameters") ##### wid[​](#wid-148 "Direct link to wid") `string` ##### ruleId[​](#ruleid "Direct link to ruleId") `number` #### Returns[​](#returns-184 "Direct link to Returns") `Promise`<{ `message`: `string`; }> #### Implementation of[​](#implementation-of-183 "Direct link to Implementation of") `CommunicationsBindings.deleteNotificationRule` *** ### deleteOperatorGroup()[​](#deleteoperatorgroup "Direct link to deleteOperatorGroup()") > **deleteOperatorGroup**: (`wid`, `groupId`) => `Promise`<`void`> Defined in: [packages/sdk/src/client/client.ts:376](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L376) Delete an operator group. #### Parameters[​](#parameters-185 "Direct link to Parameters") ##### wid[​](#wid-149 "Direct link to wid") `string` ##### groupId[​](#groupid-3 "Direct link to groupId") `number` #### Returns[​](#returns-185 "Direct link to Returns") `Promise`<`void`> #### Implementation of[​](#implementation-of-184 "Direct link to Implementation of") `OperatorBindings.deleteOperatorGroup` *** ### deleteOrgDomain()[​](#deleteorgdomain "Direct link to deleteOrgDomain()") > **deleteOrgDomain**: (`orgIdOrUuid`, `domainUuid`) => `Promise`<`void`> Defined in: [packages/sdk/src/client/client.ts:452](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L452) Delete a registered organization domain. #### Parameters[​](#parameters-186 "Direct link to Parameters") ##### orgIdOrUuid[​](#orgidoruuid-1 "Direct link to orgIdOrUuid") `string` | `number` ##### domainUuid[​](#domainuuid "Direct link to domainUuid") `string` #### Returns[​](#returns-186 "Direct link to Returns") `Promise`<`void`> #### Implementation of[​](#implementation-of-185 "Direct link to Implementation of") `OrgBindings.deleteOrgDomain` *** ### deletePage()[​](#deletepage "Direct link to deletePage()") > **deletePage**: (`wid`, `siteId`, `pageId`) => `Promise`<`void`> Defined in: [packages/sdk/src/client/client.ts:576](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L576) Delete a page from a site. #### Parameters[​](#parameters-187 "Direct link to Parameters") ##### wid[​](#wid-150 "Direct link to wid") `string` ##### siteId[​](#siteid-6 "Direct link to siteId") `number` ##### pageId[​](#pageid "Direct link to pageId") `number` #### Returns[​](#returns-187 "Direct link to Returns") `Promise`<`void`> #### Implementation of[​](#implementation-of-186 "Direct link to Implementation of") `SitesBindings.deletePage` *** ### deletePatientSyncConnection()[​](#deletepatientsyncconnection "Direct link to deletePatientSyncConnection()") > **deletePatientSyncConnection**: (`wid`) => `Promise`<`void`> Defined in: [packages/sdk/src/client/client.ts:955](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L955) Delete the workspace's PatientSync connection. #### Parameters[​](#parameters-188 "Direct link to Parameters") ##### wid[​](#wid-151 "Direct link to wid") `string` #### Returns[​](#returns-188 "Direct link to Returns") `Promise`<`void`> #### Implementation of[​](#implementation-of-187 "Direct link to Implementation of") `IntegrationsBindings.deletePatientSyncConnection` *** ### deletePersona()[​](#deletepersona "Direct link to deletePersona()") > **deletePersona**: (`wid`, `id`) => `Promise`<`void`> Defined in: [packages/sdk/src/client/client.ts:322](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L322) #### Parameters[​](#parameters-189 "Direct link to Parameters") ##### wid[​](#wid-152 "Direct link to wid") `string` ##### id[​](#id-26 "Direct link to id") `number` #### Returns[​](#returns-189 "Direct link to Returns") `Promise`<`void`> #### Implementation of[​](#implementation-of-188 "Direct link to Implementation of") `PersonasBindings.deletePersona` *** ### deletePlatformApp()[​](#deleteplatformapp "Direct link to deletePlatformApp()") > **deletePlatformApp**: (`wid`, `appUuid`, `hard`) => `Promise`<{ `deleted?`: `boolean`; `disabled?`: `boolean`; `uuid`: `string`; }> Defined in: [packages/sdk/src/client/client.ts:1038](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L1038) Disable (soft) or delete (hard) a platform app connection. #### Parameters[​](#parameters-190 "Direct link to Parameters") ##### wid[​](#wid-153 "Direct link to wid") `string` ##### appUuid[​](#appuuid "Direct link to appUuid") `string` ##### hard?[​](#hard "Direct link to hard?") `boolean` = `false` #### Returns[​](#returns-190 "Direct link to Returns") `Promise`<{ `deleted?`: `boolean`; `disabled?`: `boolean`; `uuid`: `string`; }> #### Implementation of[​](#implementation-of-189 "Direct link to Implementation of") `IntegrationsBindings.deletePlatformApp` *** ### deleteProduct()[​](#deleteproduct "Direct link to deleteProduct()") > **deleteProduct**: (`wid`, `id`) => `Promise`<{ `message`: `string`; }> Defined in: [packages/sdk/src/client/client.ts:434](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L434) Delete a product from a reseller workspace. #### Parameters[​](#parameters-191 "Direct link to Parameters") ##### wid[​](#wid-154 "Direct link to wid") `string` ##### id[​](#id-27 "Direct link to id") `number` #### Returns[​](#returns-191 "Direct link to Returns") `Promise`<{ `message`: `string`; }> #### Implementation of[​](#implementation-of-190 "Direct link to Implementation of") `WorkspacesBindings.deleteProduct` *** ### deletePronunciationEntry()[​](#deletepronunciationentry "Direct link to deletePronunciationEntry()") > **deletePronunciationEntry**: (`orgUuid`, `id`) => `Promise`<`void`> Defined in: [packages/sdk/src/client/client.ts:1046](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L1046) Delete a pronunciation entry from an organization. #### Parameters[​](#parameters-192 "Direct link to Parameters") ##### orgUuid[​](#orguuid-4 "Direct link to orgUuid") `string` ##### id[​](#id-28 "Direct link to id") `number` #### Returns[​](#returns-192 "Direct link to Returns") `Promise`<`void`> #### Implementation of[​](#implementation-of-191 "Direct link to Implementation of") `PronunciationsBindings.deletePronunciationEntry` *** ### deleteRoutine()[​](#deleteroutine "Direct link to deleteRoutine()") > **deleteRoutine**: (`wid`, `id`) => `Promise`<`void`> Defined in: [packages/sdk/src/client/client.ts:638](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L638) Delete a routine by ID. #### Parameters[​](#parameters-193 "Direct link to Parameters") ##### wid[​](#wid-155 "Direct link to wid") `string` ##### id[​](#id-29 "Direct link to id") `number` #### Returns[​](#returns-193 "Direct link to Returns") `Promise`<`void`> #### Implementation of[​](#implementation-of-192 "Direct link to Implementation of") `EventsBindings.deleteRoutine` *** ### deleteSalesforce()[​](#deletesalesforce "Direct link to deleteSalesforce()") > **deleteSalesforce**: (`wid`) => `Promise`<{ `status`: `string`; }> Defined in: [packages/sdk/src/client/client.ts:989](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L989) #### Parameters[​](#parameters-194 "Direct link to Parameters") ##### wid[​](#wid-156 "Direct link to wid") `string` #### Returns[​](#returns-194 "Direct link to Returns") `Promise`<{ `status`: `string`; }> #### Implementation of[​](#implementation-of-193 "Direct link to Implementation of") `IntegrationsBindings.deleteSalesforce` *** ### deleteScenario()[​](#deletescenario "Direct link to deleteScenario()") > **deleteScenario**: (`wid`, `scenarioId`) => `Promise`<`void`> Defined in: [packages/sdk/src/client/client.ts:304](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L304) #### Parameters[​](#parameters-195 "Direct link to Parameters") ##### wid[​](#wid-157 "Direct link to wid") `string` ##### scenarioId[​](#scenarioid "Direct link to scenarioId") `number` #### Returns[​](#returns-195 "Direct link to Returns") `Promise`<`void`> #### Implementation of[​](#implementation-of-194 "Direct link to Implementation of") `QualificationsBindings.deleteScenario` *** ### deleteSite()[​](#deletesite "Direct link to deleteSite()") > **deleteSite**: (`wid`, `id`) => `Promise`<`void`> Defined in: [packages/sdk/src/client/client.ts:570](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L570) Delete a site by ID. #### Parameters[​](#parameters-196 "Direct link to Parameters") ##### wid[​](#wid-158 "Direct link to wid") `string` ##### id[​](#id-30 "Direct link to id") `number` #### Returns[​](#returns-196 "Direct link to Returns") `Promise`<`void`> #### Implementation of[​](#implementation-of-195 "Direct link to Implementation of") `SitesBindings.deleteSite` *** ### deleteSlackApp()[​](#deleteslackapp "Direct link to deleteSlackApp()") > **deleteSlackApp**: (`wid`, `appId`) => `Promise`<`void`> Defined in: [packages/sdk/src/client/client.ts:905](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L905) Delete a Slack app configuration. #### Parameters[​](#parameters-197 "Direct link to Parameters") ##### wid[​](#wid-159 "Direct link to wid") `string` ##### appId[​](#appid-1 "Direct link to appId") `number` #### Returns[​](#returns-197 "Direct link to Returns") `Promise`<`void`> #### Implementation of[​](#implementation-of-196 "Direct link to Implementation of") `IntegrationsBindings.deleteSlackApp` *** ### deleteSupervisor()[​](#deletesupervisor "Direct link to deleteSupervisor()") > **deleteSupervisor**: (`wid`, `id`) => `Promise`<`void`> Defined in: [packages/sdk/src/client/client.ts:690](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L690) Delete a supervisor by ID. #### Parameters[​](#parameters-198 "Direct link to Parameters") ##### wid[​](#wid-160 "Direct link to wid") `string` ##### id[​](#id-31 "Direct link to id") `number` #### Returns[​](#returns-198 "Direct link to Returns") `Promise`<`void`> #### Implementation of[​](#implementation-of-197 "Direct link to Implementation of") `WorkflowsBindings.deleteSupervisor` *** ### deleteTask()[​](#deletetask "Direct link to deleteTask()") > **deleteTask**: (`wid`, `id`) => `Promise`<`void`> Defined in: [packages/sdk/src/client/client.ts:128](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L128) Delete a task by ID. #### Parameters[​](#parameters-199 "Direct link to Parameters") ##### wid[​](#wid-161 "Direct link to wid") `string` ##### id[​](#id-32 "Direct link to id") `number` #### Returns[​](#returns-199 "Direct link to Returns") `Promise`<`void`> #### Implementation of[​](#implementation-of-198 "Direct link to Implementation of") `TasksBindings.deleteTask` *** ### deleteTeamsApp()[​](#deleteteamsapp "Direct link to deleteTeamsApp()") > **deleteTeamsApp**: (`wid`, `appId`) => `Promise`<`void`> Defined in: [packages/sdk/src/client/client.ts:915](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L915) #### Parameters[​](#parameters-200 "Direct link to Parameters") ##### wid[​](#wid-162 "Direct link to wid") `string` ##### appId[​](#appid-2 "Direct link to appId") `number` #### Returns[​](#returns-200 "Direct link to Returns") `Promise`<`void`> #### Implementation of[​](#implementation-of-199 "Direct link to Implementation of") `IntegrationsBindings.deleteTeamsApp` *** ### deleteWorkflow()[​](#deleteworkflow "Direct link to deleteWorkflow()") > **deleteWorkflow**: (`wid`, `id`, `cascade`) => `Promise`<{ `deletedTaskCount`: `number`; `status`: `string`; }> Defined in: [packages/sdk/src/client/client.ts:654](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L654) Delete a workflow, optionally cascading to delete its tasks. #### Parameters[​](#parameters-201 "Direct link to Parameters") ##### wid[​](#wid-163 "Direct link to wid") `string` ##### id[​](#id-33 "Direct link to id") `number` ##### cascade?[​](#cascade "Direct link to cascade?") `boolean` = `false` #### Returns[​](#returns-201 "Direct link to Returns") `Promise`<{ `deletedTaskCount`: `number`; `status`: `string`; }> #### Implementation of[​](#implementation-of-200 "Direct link to Implementation of") `WorkflowsBindings.deleteWorkflow` *** ### deleteWorkflowContributor()[​](#deleteworkflowcontributor "Direct link to deleteWorkflowContributor()") > **deleteWorkflowContributor**: (`wid`, `workflowId`, `contributorId`) => `Promise`<{ `success`: `boolean`; }> Defined in: [packages/sdk/src/client/client.ts:671](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L671) Remove a contributor from a workflow. #### Parameters[​](#parameters-202 "Direct link to Parameters") ##### wid[​](#wid-164 "Direct link to wid") `string` ##### workflowId[​](#workflowid-2 "Direct link to workflowId") `number` ##### contributorId[​](#contributorid "Direct link to contributorId") `number` #### Returns[​](#returns-202 "Direct link to Returns") `Promise`<{ `success`: `boolean`; }> #### Implementation of[​](#implementation-of-201 "Direct link to Implementation of") `WorkflowsBindings.deleteWorkflowContributor` *** ### deleteWorkflowNote()[​](#deleteworkflownote "Direct link to deleteWorkflowNote()") > **deleteWorkflowNote**: (`wid`, `workflowId`, `noteId`) => `Promise`<`void`> Defined in: [packages/sdk/src/client/client.ts:667](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L667) Delete a workflow note by ID. #### Parameters[​](#parameters-203 "Direct link to Parameters") ##### wid[​](#wid-165 "Direct link to wid") `string` ##### workflowId[​](#workflowid-3 "Direct link to workflowId") `number` ##### noteId[​](#noteid-1 "Direct link to noteId") `number` #### Returns[​](#returns-203 "Direct link to Returns") `Promise`<`void`> #### Implementation of[​](#implementation-of-202 "Direct link to Implementation of") `WorkflowsBindings.deleteWorkflowNote` *** ### deleteWorkspace()[​](#deleteworkspace "Direct link to deleteWorkspace()") > **deleteWorkspace**: (`wid`) => `Promise`<`void`> Defined in: [packages/sdk/src/client/client.ts:405](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L405) Delete a workspace. #### Parameters[​](#parameters-204 "Direct link to Parameters") ##### wid[​](#wid-166 "Direct link to wid") `string` #### Returns[​](#returns-204 "Direct link to Returns") `Promise`<`void`> #### Implementation of[​](#implementation-of-203 "Direct link to Implementation of") `WorkspacesBindings.deleteWorkspace` *** ### deleteWorkspaceInvitation()[​](#deleteworkspaceinvitation "Direct link to deleteWorkspaceInvitation()") > **deleteWorkspaceInvitation**: (`requestId`) => `Promise`<{ `message`: `string`; }> Defined in: [packages/sdk/src/client/client.ts:475](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L475) #### Parameters[​](#parameters-205 "Direct link to Parameters") ##### requestId[​](#requestid-3 "Direct link to requestId") `number` #### Returns[​](#returns-205 "Direct link to Returns") `Promise`<{ `message`: `string`; }> #### Implementation of[​](#implementation-of-204 "Direct link to Implementation of") `WorkspacesBindings.deleteWorkspaceInvitation` *** ### deleteWorkspaceInvitationAdmin()[​](#deleteworkspaceinvitationadmin "Direct link to deleteWorkspaceInvitationAdmin()") > **deleteWorkspaceInvitationAdmin**: (`workspaceUuid`, `invitationId`) => `Promise`<{ `message`: `string`; }> Defined in: [packages/sdk/src/client/client.ts:476](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L476) Delete an invitation (requires workspace admin permission). Uses the workspace-scoped route: DELETE /api/v2/w/{workspaceUuid}/invitations/{id} #### Parameters[​](#parameters-206 "Direct link to Parameters") ##### workspaceUuid[​](#workspaceuuid-6 "Direct link to workspaceUuid") `string` ##### invitationId[​](#invitationid-2 "Direct link to invitationId") `number` #### Returns[​](#returns-206 "Direct link to Returns") `Promise`<{ `message`: `string`; }> #### Implementation of[​](#implementation-of-205 "Direct link to Implementation of") `WorkspacesBindings.deleteWorkspaceInvitationAdmin` *** ### denyWorkspaceInvitation()[​](#denyworkspaceinvitation "Direct link to denyWorkspaceInvitation()") > **denyWorkspaceInvitation**: (`workspaceUuid`, `invitationId`) => `Promise`<[`InvitationResponse`](https://docs.gravityrail.com/sdk/type-aliases/InvitationResponse.md)> Defined in: [packages/sdk/src/client/client.ts:479](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L479) Deny an invitation - requires workspace admin permission. #### Parameters[​](#parameters-207 "Direct link to Parameters") ##### workspaceUuid[​](#workspaceuuid-7 "Direct link to workspaceUuid") `string` ##### invitationId[​](#invitationid-3 "Direct link to invitationId") `number` #### Returns[​](#returns-207 "Direct link to Returns") `Promise`<[`InvitationResponse`](https://docs.gravityrail.com/sdk/type-aliases/InvitationResponse.md)> #### Implementation of[​](#implementation-of-206 "Direct link to Implementation of") `WorkspacesBindings.denyWorkspaceInvitation` *** ### describeSalesforceObject()[​](#describesalesforceobject "Direct link to describeSalesforceObject()") > **describeSalesforceObject**: (`wid`, `sobject`) => `Promise`<{ `fields`: `object`\[]; }> Defined in: [packages/sdk/src/client/client.ts:997](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L997) #### Parameters[​](#parameters-208 "Direct link to Parameters") ##### wid[​](#wid-167 "Direct link to wid") `string` ##### sobject[​](#sobject "Direct link to sobject") `string` #### Returns[​](#returns-208 "Direct link to Returns") `Promise`<{ `fields`: `object`\[]; }> #### Implementation of[​](#implementation-of-207 "Direct link to Implementation of") `IntegrationsBindings.describeSalesforceObject` *** ### detachMyCustomerPaymentMethod()[​](#detachmycustomerpaymentmethod "Direct link to detachMyCustomerPaymentMethod()") > **detachMyCustomerPaymentMethod**: (`uuid`, `paymentMethodId`) => `Promise`<{ `message`: `string`; `success`: `string`; }> Defined in: [packages/sdk/src/client/client.ts:1067](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L1067) #### Parameters[​](#parameters-209 "Direct link to Parameters") ##### uuid[​](#uuid-7 "Direct link to uuid") `string` ##### paymentMethodId[​](#paymentmethodid-1 "Direct link to paymentMethodId") `string` #### Returns[​](#returns-209 "Direct link to Returns") `Promise`<{ `message`: `string`; `success`: `string`; }> #### Implementation of[​](#implementation-of-208 "Direct link to Implementation of") `CustomersBindings.detachMyCustomerPaymentMethod` *** ### diffWorkflowVersions()[​](#diffworkflowversions "Direct link to diffWorkflowVersions()") > **diffWorkflowVersions**: (`wid`, `workflowUuid`, `fromVersion`, `toVersion`) => `Promise`<`WorkflowVersionDiffResponse`> Defined in: [packages/sdk/src/client/client.ts:679](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L679) Compare two workflow versions (0 = draft). #### Parameters[​](#parameters-210 "Direct link to Parameters") ##### wid[​](#wid-168 "Direct link to wid") `string` ##### workflowUuid[​](#workflowuuid-2 "Direct link to workflowUuid") `string` ##### fromVersion[​](#fromversion "Direct link to fromVersion") `number` ##### toVersion[​](#toversion "Direct link to toVersion") `number` #### Returns[​](#returns-210 "Direct link to Returns") `Promise`<`WorkflowVersionDiffResponse`> #### Implementation of[​](#implementation-of-209 "Direct link to Implementation of") `WorkflowsBindings.diffWorkflowVersions` *** ### disableConfluence()[​](#disableconfluence "Direct link to disableConfluence()") > **disableConfluence**: (`wid`) => `Promise`<`ConfluenceConnectionStatus`> Defined in: [packages/sdk/src/client/client.ts:976](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L976) #### Parameters[​](#parameters-211 "Direct link to Parameters") ##### wid[​](#wid-169 "Direct link to wid") `string` #### Returns[​](#returns-211 "Direct link to Returns") `Promise`<`ConfluenceConnectionStatus`> #### Implementation of[​](#implementation-of-210 "Direct link to Implementation of") `IntegrationsBindings.disableConfluence` *** ### disableCustomToolkit()[​](#disablecustomtoolkit "Direct link to disableCustomToolkit()") > **disableCustomToolkit**: (`wid`, `toolkitId`) => `Promise`<[`CustomToolkit`](https://docs.gravityrail.com/sdk/type-aliases/CustomToolkit.md)> Defined in: [packages/sdk/src/client/client.ts:785](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L785) Disable a custom toolkit #### Parameters[​](#parameters-212 "Direct link to Parameters") ##### wid[​](#wid-170 "Direct link to wid") `string` ##### toolkitId[​](#toolkitid-3 "Direct link to toolkitId") `number` #### Returns[​](#returns-212 "Direct link to Returns") `Promise`<[`CustomToolkit`](https://docs.gravityrail.com/sdk/type-aliases/CustomToolkit.md)> #### Implementation of[​](#implementation-of-211 "Direct link to Implementation of") `ToolkitsBindings.disableCustomToolkit` *** ### disableHubspot()[​](#disablehubspot "Direct link to disableHubspot()") > **disableHubspot**: (`wid`) => `Promise`<`HubspotConnectionStatus`> Defined in: [packages/sdk/src/client/client.ts:1006](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L1006) #### Parameters[​](#parameters-213 "Direct link to Parameters") ##### wid[​](#wid-171 "Direct link to wid") `string` #### Returns[​](#returns-213 "Direct link to Returns") `Promise`<`HubspotConnectionStatus`> #### Implementation of[​](#implementation-of-212 "Direct link to Implementation of") `IntegrationsBindings.disableHubspot` *** ### disableMcpServer()[​](#disablemcpserver "Direct link to disableMcpServer()") > **disableMcpServer**: (`wid`, `serverId`) => `Promise`<[`McpServerResponse`](https://docs.gravityrail.com/sdk/interfaces/McpServerResponse.md)> Defined in: [packages/sdk/src/client/client.ts:795](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L795) Disable an MCP server #### Parameters[​](#parameters-214 "Direct link to Parameters") ##### wid[​](#wid-172 "Direct link to wid") `string` ##### serverId[​](#serverid-1 "Direct link to serverId") `number` #### Returns[​](#returns-214 "Direct link to Returns") `Promise`<[`McpServerResponse`](https://docs.gravityrail.com/sdk/interfaces/McpServerResponse.md)> #### Implementation of[​](#implementation-of-213 "Direct link to Implementation of") `ToolkitsBindings.disableMcpServer` *** ### disableMondayConnection()[​](#disablemondayconnection "Direct link to disableMondayConnection()") > **disableMondayConnection**: (`wid`) => `Promise`<`MondayConnectionStatus`> Defined in: [packages/sdk/src/client/client.ts:868](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L868) #### Parameters[​](#parameters-215 "Direct link to Parameters") ##### wid[​](#wid-173 "Direct link to wid") `string` #### Returns[​](#returns-215 "Direct link to Returns") `Promise`<`MondayConnectionStatus`> #### Implementation of[​](#implementation-of-214 "Direct link to Implementation of") `IntegrationsBindings.disableMondayConnection` *** ### disableOrgDomainEmail()[​](#disableorgdomainemail "Direct link to disableOrgDomainEmail()") > **disableOrgDomainEmail**: (`orgIdOrUuid`, `domainUuid`, `confirm`) => `Promise`<[`EmailDisableResponse`](https://docs.gravityrail.com/sdk/type-aliases/EmailDisableResponse.md)> Defined in: [packages/sdk/src/client/client.ts:456](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L456) Disable email support for an org domain. #### Parameters[​](#parameters-216 "Direct link to Parameters") ##### orgIdOrUuid[​](#orgidoruuid-2 "Direct link to orgIdOrUuid") `string` | `number` ##### domainUuid[​](#domainuuid-1 "Direct link to domainUuid") `string` ##### confirm?[​](#confirm "Direct link to confirm?") `boolean` = `false` #### Returns[​](#returns-216 "Direct link to Returns") `Promise`<[`EmailDisableResponse`](https://docs.gravityrail.com/sdk/type-aliases/EmailDisableResponse.md)> #### Implementation of[​](#implementation-of-215 "Direct link to Implementation of") `OrgBindings.disableOrgDomainEmail` *** ### disableOrgDomainSite()[​](#disableorgdomainsite "Direct link to disableOrgDomainSite()") > **disableOrgDomainSite**: (`orgIdOrUuid`, `domainUuid`, `confirm`) => `Promise`<[`SiteDisableResponse`](https://docs.gravityrail.com/sdk/type-aliases/SiteDisableResponse.md)> Defined in: [packages/sdk/src/client/client.ts:460](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L460) Disable custom site routing for an org domain. #### Parameters[​](#parameters-217 "Direct link to Parameters") ##### orgIdOrUuid[​](#orgidoruuid-3 "Direct link to orgIdOrUuid") `string` | `number` ##### domainUuid[​](#domainuuid-2 "Direct link to domainUuid") `string` ##### confirm?[​](#confirm-1 "Direct link to confirm?") `boolean` = `false` #### Returns[​](#returns-217 "Direct link to Returns") `Promise`<[`SiteDisableResponse`](https://docs.gravityrail.com/sdk/type-aliases/SiteDisableResponse.md)> #### Implementation of[​](#implementation-of-216 "Direct link to Implementation of") `OrgBindings.disableOrgDomainSite` *** ### disableSalesforce()[​](#disablesalesforce "Direct link to disableSalesforce()") > **disableSalesforce**: (`wid`) => `Promise`<`SalesforceConnectionStatus`> Defined in: [packages/sdk/src/client/client.ts:987](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L987) #### Parameters[​](#parameters-218 "Direct link to Parameters") ##### wid[​](#wid-174 "Direct link to wid") `string` #### Returns[​](#returns-218 "Direct link to Returns") `Promise`<`SalesforceConnectionStatus`> #### Implementation of[​](#implementation-of-217 "Direct link to Implementation of") `IntegrationsBindings.disableSalesforce` *** ### disableTwoFactorMethod()[​](#disabletwofactormethod "Direct link to disableTwoFactorMethod()") > **disableTwoFactorMethod**: (`methodId`) => `Promise`<[`TwoFactorOperationResponse`](https://docs.gravityrail.com/sdk/interfaces/TwoFactorOperationResponse.md)> Defined in: [packages/sdk/src/client/client.ts:516](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L516) Disable a specific two-factor authentication method. #### Parameters[​](#parameters-219 "Direct link to Parameters") ##### methodId[​](#methodid "Direct link to methodId") `number` #### Returns[​](#returns-219 "Direct link to Returns") `Promise`<[`TwoFactorOperationResponse`](https://docs.gravityrail.com/sdk/interfaces/TwoFactorOperationResponse.md)> #### Implementation of[​](#implementation-of-218 "Direct link to Implementation of") `AuthBindings.disableTwoFactorMethod` *** ### disconnectConfluence()[​](#disconnectconfluence "Direct link to disconnectConfluence()") > **disconnectConfluence**: (`wid`) => `Promise`<`ConfluenceConnectionStatus`> Defined in: [packages/sdk/src/client/client.ts:975](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L975) #### Parameters[​](#parameters-220 "Direct link to Parameters") ##### wid[​](#wid-175 "Direct link to wid") `string` #### Returns[​](#returns-220 "Direct link to Returns") `Promise`<`ConfluenceConnectionStatus`> #### Implementation of[​](#implementation-of-219 "Direct link to Implementation of") `IntegrationsBindings.disconnectConfluence` *** ### disconnectHubspot()[​](#disconnecthubspot "Direct link to disconnectHubspot()") > **disconnectHubspot**: (`wid`) => `Promise`<`HubspotConnectionStatus`> Defined in: [packages/sdk/src/client/client.ts:1005](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L1005) #### Parameters[​](#parameters-221 "Direct link to Parameters") ##### wid[​](#wid-176 "Direct link to wid") `string` #### Returns[​](#returns-221 "Direct link to Returns") `Promise`<`HubspotConnectionStatus`> #### Implementation of[​](#implementation-of-220 "Direct link to Implementation of") `IntegrationsBindings.disconnectHubspot` *** ### disconnectMondayConnection()[​](#disconnectmondayconnection "Direct link to disconnectMondayConnection()") > **disconnectMondayConnection**: (`wid`) => `Promise`<{ `status`: `string`; }> Defined in: [packages/sdk/src/client/client.ts:867](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L867) #### Parameters[​](#parameters-222 "Direct link to Parameters") ##### wid[​](#wid-177 "Direct link to wid") `string` #### Returns[​](#returns-222 "Direct link to Returns") `Promise`<{ `status`: `string`; }> #### Implementation of[​](#implementation-of-221 "Direct link to Implementation of") `IntegrationsBindings.disconnectMondayConnection` *** ### disconnectOAuthProvider()[​](#disconnectoauthprovider "Direct link to disconnectOAuthProvider()") > **disconnectOAuthProvider**: (`providerSlug`, `credentialUuid?`) => `Promise`<`void`> Defined in: [packages/sdk/src/client/client.ts:854](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L854) #### Parameters[​](#parameters-223 "Direct link to Parameters") ##### providerSlug[​](#providerslug "Direct link to providerSlug") [`OAuthProviderSlug`](https://docs.gravityrail.com/sdk/type-aliases/OAuthProviderSlug.md) ##### credentialUuid?[​](#credentialuuid "Direct link to credentialUuid?") `string` #### Returns[​](#returns-223 "Direct link to Returns") `Promise`<`void`> #### Implementation of[​](#implementation-of-222 "Direct link to Implementation of") `AppsBindings.disconnectOAuthProvider` *** ### disconnectPresence()[​](#disconnectpresence "Direct link to disconnectPresence()") > **disconnectPresence**: (`wid`) => `Promise`<{ `ok`: `boolean`; }> Defined in: [packages/sdk/src/client/client.ts:381](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L381) Disconnect the current member's presence session. #### Parameters[​](#parameters-224 "Direct link to Parameters") ##### wid[​](#wid-178 "Direct link to wid") `string` #### Returns[​](#returns-224 "Direct link to Returns") `Promise`<{ `ok`: `boolean`; }> #### Implementation of[​](#implementation-of-223 "Direct link to Implementation of") `OperatorBindings.disconnectPresence` *** ### disconnectSalesforce()[​](#disconnectsalesforce "Direct link to disconnectSalesforce()") > **disconnectSalesforce**: (`wid`) => `Promise`<`SalesforceConnectionStatus`> Defined in: [packages/sdk/src/client/client.ts:986](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L986) #### Parameters[​](#parameters-225 "Direct link to Parameters") ##### wid[​](#wid-179 "Direct link to wid") `string` #### Returns[​](#returns-225 "Direct link to Returns") `Promise`<`SalesforceConnectionStatus`> #### Implementation of[​](#implementation-of-224 "Direct link to Implementation of") `IntegrationsBindings.disconnectSalesforce` *** ### discoverOAuthMetadata()[​](#discoveroauthmetadata "Direct link to discoverOAuthMetadata()") > **discoverOAuthMetadata**: (`wid`, `data`) => `Promise`<{ `error?`: `string`; `metadata?`: `any`; `success`: `boolean`; }> Defined in: [packages/sdk/src/client/client.ts:800](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L800) Discover OAuth metadata for an authorization server #### Parameters[​](#parameters-226 "Direct link to Parameters") ##### wid[​](#wid-180 "Direct link to wid") `string` ##### data[​](#data-56 "Direct link to data") ###### oauthServerUrl[​](#oauthserverurl "Direct link to oauthServerUrl") `string` #### Returns[​](#returns-226 "Direct link to Returns") `Promise`<{ `error?`: `string`; `metadata?`: `any`; `success`: `boolean`; }> #### Implementation of[​](#implementation-of-225 "Direct link to Implementation of") `ToolkitsBindings.discoverOAuthMetadata` *** ### dismissAllNotifications()[​](#dismissallnotifications "Direct link to dismissAllNotifications()") > **dismissAllNotifications**: (`wid`) => `Promise`<{ `dismissedCount`: `number`; }> Defined in: [packages/sdk/src/client/client.ts:420](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L420) Dismiss all notifications for the current user in a workspace. #### Parameters[​](#parameters-227 "Direct link to Parameters") ##### wid[​](#wid-181 "Direct link to wid") `string` #### Returns[​](#returns-227 "Direct link to Returns") `Promise`<{ `dismissedCount`: `number`; }> #### Implementation of[​](#implementation-of-226 "Direct link to Implementation of") `WorkspacesBindings.dismissAllNotifications` *** ### dismissNotification()[​](#dismissnotification "Direct link to dismissNotification()") > **dismissNotification**: (`wid`, `id`) => `Promise`<[`NotificationResponse`](https://docs.gravityrail.com/sdk/interfaces/NotificationResponse.md)> Defined in: [packages/sdk/src/client/client.ts:419](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L419) Dismiss a single notification. #### Parameters[​](#parameters-228 "Direct link to Parameters") ##### wid[​](#wid-182 "Direct link to wid") `string` ##### id[​](#id-34 "Direct link to id") `number` #### Returns[​](#returns-228 "Direct link to Returns") `Promise`<[`NotificationResponse`](https://docs.gravityrail.com/sdk/interfaces/NotificationResponse.md)> #### Implementation of[​](#implementation-of-227 "Direct link to Implementation of") `WorkspacesBindings.dismissNotification` *** ### downloadEmailAttachment()[​](#downloademailattachment "Direct link to downloadEmailAttachment()") > **downloadEmailAttachment**: (`wid`, `inboxId`, `emailId`, `attachmentId`) => `Promise`<`ArrayBuffer`> Defined in: [packages/sdk/src/client/client.ts:757](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L757) Download an email attachment as raw bytes. #### Parameters[​](#parameters-229 "Direct link to Parameters") ##### wid[​](#wid-183 "Direct link to wid") `string` ##### inboxId[​](#inboxid-1 "Direct link to inboxId") `number` ##### emailId[​](#emailid-1 "Direct link to emailId") `number` ##### attachmentId[​](#attachmentid "Direct link to attachmentId") `string` #### Returns[​](#returns-229 "Direct link to Returns") `Promise`<`ArrayBuffer`> #### Implementation of[​](#implementation-of-228 "Direct link to Implementation of") `CommunicationsBindings.downloadEmailAttachment` *** ### downloadFilesZip()[​](#downloadfileszip "Direct link to downloadFilesZip()") > **downloadFilesZip**: (`wid`, `fileIds`, `folderIds`) => `Promise`<`Blob`> Defined in: [packages/sdk/src/client/client.ts:589](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L589) Download the given files + folders (folders recursively) as a single ZIP. Returns the raw archive bytes for the caller to save. #### Parameters[​](#parameters-230 "Direct link to Parameters") ##### wid[​](#wid-184 "Direct link to wid") `string` ##### fileIds[​](#fileids "Direct link to fileIds") `number`\[] ##### folderIds[​](#folderids "Direct link to folderIds") `number`\[] #### Returns[​](#returns-230 "Direct link to Returns") `Promise`<`Blob`> #### Implementation of[​](#implementation-of-229 "Direct link to Implementation of") `FilesBindings.downloadFilesZip` *** ### downloadSiteSourceZip()[​](#downloadsitesourcezip "Direct link to downloadSiteSourceZip()") > **downloadSiteSourceZip**: (`wid`, `siteId`) => `Promise`<`Blob`> Defined in: [packages/sdk/src/client/client.ts:555](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L555) 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[​](#parameters-231 "Direct link to Parameters") ##### wid[​](#wid-185 "Direct link to wid") `string` ##### siteId[​](#siteid-7 "Direct link to siteId") `number` #### Returns[​](#returns-231 "Direct link to Returns") `Promise`<`Blob`> #### Implementation of[​](#implementation-of-230 "Direct link to Implementation of") `SitesBindings.downloadSiteSourceZip` *** ### emailPasswordLogin()[​](#emailpasswordlogin "Direct link to emailPasswordLogin()") > **emailPasswordLogin**: (`email`, `password`, `organizationUuid?`) => `Promise`<[`VerifyCodeResponse`](https://docs.gravityrail.com/sdk/interfaces/VerifyCodeResponse.md)> Defined in: [packages/sdk/src/client/client.ts:491](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L491) Log in with email and password credentials. #### Parameters[​](#parameters-232 "Direct link to Parameters") ##### email[​](#email-2 "Direct link to email") `string` ##### password[​](#password-1 "Direct link to password") `string` ##### organizationUuid?[​](#organizationuuid-1 "Direct link to organizationUuid?") `string` #### Returns[​](#returns-232 "Direct link to Returns") `Promise`<[`VerifyCodeResponse`](https://docs.gravityrail.com/sdk/interfaces/VerifyCodeResponse.md)> #### Implementation of[​](#implementation-of-231 "Direct link to Implementation of") `AuthBindings.emailPasswordLogin` *** ### emailPasswordSignup()[​](#emailpasswordsignup "Direct link to emailPasswordSignup()") > **emailPasswordSignup**: (`email`, `password`, `name?`, `organizationUuid?`) => `Promise`<[`VerifyCodeResponse`](https://docs.gravityrail.com/sdk/interfaces/VerifyCodeResponse.md)> Defined in: [packages/sdk/src/client/client.ts:492](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L492) Sign up a new account with email and password. #### Parameters[​](#parameters-233 "Direct link to Parameters") ##### email[​](#email-3 "Direct link to email") `string` ##### password[​](#password-2 "Direct link to password") `string` ##### name?[​](#name-8 "Direct link to name?") `string` ##### organizationUuid?[​](#organizationuuid-2 "Direct link to organizationUuid?") `string` #### Returns[​](#returns-233 "Direct link to Returns") `Promise`<[`VerifyCodeResponse`](https://docs.gravityrail.com/sdk/interfaces/VerifyCodeResponse.md)> #### Implementation of[​](#implementation-of-232 "Direct link to Implementation of") `AuthBindings.emailPasswordSignup` *** ### enableConfluence()[​](#enableconfluence "Direct link to enableConfluence()") > **enableConfluence**: (`wid`) => `Promise`<`ConfluenceConnectionStatus`> Defined in: [packages/sdk/src/client/client.ts:977](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L977) #### Parameters[​](#parameters-234 "Direct link to Parameters") ##### wid[​](#wid-186 "Direct link to wid") `string` #### Returns[​](#returns-234 "Direct link to Returns") `Promise`<`ConfluenceConnectionStatus`> #### Implementation of[​](#implementation-of-233 "Direct link to Implementation of") `IntegrationsBindings.enableConfluence` *** ### enableCustomToolkit()[​](#enablecustomtoolkit "Direct link to enableCustomToolkit()") > **enableCustomToolkit**: (`wid`, `toolkitId`) => `Promise`<[`CustomToolkit`](https://docs.gravityrail.com/sdk/type-aliases/CustomToolkit.md)> Defined in: [packages/sdk/src/client/client.ts:784](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L784) Enable a custom toolkit #### Parameters[​](#parameters-235 "Direct link to Parameters") ##### wid[​](#wid-187 "Direct link to wid") `string` ##### toolkitId[​](#toolkitid-4 "Direct link to toolkitId") `number` #### Returns[​](#returns-235 "Direct link to Returns") `Promise`<[`CustomToolkit`](https://docs.gravityrail.com/sdk/type-aliases/CustomToolkit.md)> #### Implementation of[​](#implementation-of-234 "Direct link to Implementation of") `ToolkitsBindings.enableCustomToolkit` *** ### enableHubspot()[​](#enablehubspot "Direct link to enableHubspot()") > **enableHubspot**: (`wid`) => `Promise`<`HubspotConnectionStatus`> Defined in: [packages/sdk/src/client/client.ts:1007](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L1007) #### Parameters[​](#parameters-236 "Direct link to Parameters") ##### wid[​](#wid-188 "Direct link to wid") `string` #### Returns[​](#returns-236 "Direct link to Returns") `Promise`<`HubspotConnectionStatus`> #### Implementation of[​](#implementation-of-235 "Direct link to Implementation of") `IntegrationsBindings.enableHubspot` *** ### enableMcpServer()[​](#enablemcpserver "Direct link to enableMcpServer()") > **enableMcpServer**: (`wid`, `serverId`) => `Promise`<[`McpServerResponse`](https://docs.gravityrail.com/sdk/interfaces/McpServerResponse.md)> Defined in: [packages/sdk/src/client/client.ts:794](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L794) Enable an MCP server #### Parameters[​](#parameters-237 "Direct link to Parameters") ##### wid[​](#wid-189 "Direct link to wid") `string` ##### serverId[​](#serverid-2 "Direct link to serverId") `number` #### Returns[​](#returns-237 "Direct link to Returns") `Promise`<[`McpServerResponse`](https://docs.gravityrail.com/sdk/interfaces/McpServerResponse.md)> #### Implementation of[​](#implementation-of-236 "Direct link to Implementation of") `ToolkitsBindings.enableMcpServer` *** ### enableMondayConnection()[​](#enablemondayconnection "Direct link to enableMondayConnection()") > **enableMondayConnection**: (`wid`) => `Promise`<`MondayConnectionStatus`> Defined in: [packages/sdk/src/client/client.ts:869](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L869) #### Parameters[​](#parameters-238 "Direct link to Parameters") ##### wid[​](#wid-190 "Direct link to wid") `string` #### Returns[​](#returns-238 "Direct link to Returns") `Promise`<`MondayConnectionStatus`> #### Implementation of[​](#implementation-of-237 "Direct link to Implementation of") `IntegrationsBindings.enableMondayConnection` *** ### enableOrgDomainEmail()[​](#enableorgdomainemail "Direct link to enableOrgDomainEmail()") > **enableOrgDomainEmail**: (`orgIdOrUuid`, `domainUuid`) => `Promise`<[`EmailDomainConfig`](https://docs.gravityrail.com/sdk/type-aliases/EmailDomainConfig.md)> Defined in: [packages/sdk/src/client/client.ts:453](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L453) Enable email DNS provisioning for a verified org domain. #### Parameters[​](#parameters-239 "Direct link to Parameters") ##### orgIdOrUuid[​](#orgidoruuid-4 "Direct link to orgIdOrUuid") `string` | `number` ##### domainUuid[​](#domainuuid-3 "Direct link to domainUuid") `string` #### Returns[​](#returns-239 "Direct link to Returns") `Promise`<[`EmailDomainConfig`](https://docs.gravityrail.com/sdk/type-aliases/EmailDomainConfig.md)> #### Implementation of[​](#implementation-of-238 "Direct link to Implementation of") `OrgBindings.enableOrgDomainEmail` *** ### enableOrgDomainSite()[​](#enableorgdomainsite "Direct link to enableOrgDomainSite()") > **enableOrgDomainSite**: (`orgIdOrUuid`, `domainUuid`) => `Promise`<[`SiteDomainConfig`](https://docs.gravityrail.com/sdk/type-aliases/SiteDomainConfig.md)> Defined in: [packages/sdk/src/client/client.ts:457](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L457) Enable custom site routing for a verified org domain. #### Parameters[​](#parameters-240 "Direct link to Parameters") ##### orgIdOrUuid[​](#orgidoruuid-5 "Direct link to orgIdOrUuid") `string` | `number` ##### domainUuid[​](#domainuuid-4 "Direct link to domainUuid") `string` #### Returns[​](#returns-240 "Direct link to Returns") `Promise`<[`SiteDomainConfig`](https://docs.gravityrail.com/sdk/type-aliases/SiteDomainConfig.md)> #### Implementation of[​](#implementation-of-239 "Direct link to Implementation of") `OrgBindings.enableOrgDomainSite` *** ### enablePlatformApp()[​](#enableplatformapp "Direct link to enablePlatformApp()") > **enablePlatformApp**: (`wid`, `data`) => `Promise`<[`PlatformAppConnectionResponse`](https://docs.gravityrail.com/sdk/interfaces/PlatformAppConnectionResponse.md)> Defined in: [packages/sdk/src/client/client.ts:1035](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L1035) Enable a platform app connection in the workspace. #### Parameters[​](#parameters-241 "Direct link to Parameters") ##### wid[​](#wid-191 "Direct link to wid") `string` ##### data[​](#data-57 "Direct link to data") [`CreateAppConnectionRequest`](https://docs.gravityrail.com/sdk/interfaces/CreateAppConnectionRequest.md) #### Returns[​](#returns-241 "Direct link to Returns") `Promise`<[`PlatformAppConnectionResponse`](https://docs.gravityrail.com/sdk/interfaces/PlatformAppConnectionResponse.md)> #### Implementation of[​](#implementation-of-240 "Direct link to Implementation of") `IntegrationsBindings.enablePlatformApp` *** ### enableSalesforce()[​](#enablesalesforce "Direct link to enableSalesforce()") > **enableSalesforce**: (`wid`) => `Promise`<`SalesforceConnectionStatus`> Defined in: [packages/sdk/src/client/client.ts:988](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L988) #### Parameters[​](#parameters-242 "Direct link to Parameters") ##### wid[​](#wid-192 "Direct link to wid") `string` #### Returns[​](#returns-242 "Direct link to Returns") `Promise`<`SalesforceConnectionStatus`> #### Implementation of[​](#implementation-of-241 "Direct link to Implementation of") `IntegrationsBindings.enableSalesforce` *** ### endTestChatRun()[​](#endtestchatrun "Direct link to endTestChatRun()") > **endTestChatRun**: (`wid`, `runId`) => `Promise`<[`TestChatRunResponse`](https://docs.gravityrail.com/sdk/interfaces/TestChatRunResponse.md)> Defined in: [packages/sdk/src/client/client.ts:309](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L309) Manually end a test chat run (for human-driven runs, which have no simulator workflow to mark them completed). #### Parameters[​](#parameters-243 "Direct link to Parameters") ##### wid[​](#wid-193 "Direct link to wid") `string` ##### runId[​](#runid "Direct link to runId") `number` #### Returns[​](#returns-243 "Direct link to Returns") `Promise`<[`TestChatRunResponse`](https://docs.gravityrail.com/sdk/interfaces/TestChatRunResponse.md)> #### Implementation of[​](#implementation-of-242 "Direct link to Implementation of") `QualificationsBindings.endTestChatRun` *** ### enrichInquiry()[​](#enrichinquiry "Direct link to enrichInquiry()") > **enrichInquiry**: (`inquiryUuid`, `data`) => `Promise`<[`InquiryResponse`](https://docs.gravityrail.com/sdk/interfaces/InquiryResponse.md)> Defined in: [packages/sdk/src/client/client.ts:842](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L842) Enrich an existing inquiry with additional fields (public endpoint). Uses the inquiry UUID (from cookie) to identify the inquiry. #### Parameters[​](#parameters-244 "Direct link to Parameters") ##### inquiryUuid[​](#inquiryuuid "Direct link to inquiryUuid") `string` ##### data[​](#data-58 "Direct link to data") [`EnrichInquiryRequest`](https://docs.gravityrail.com/sdk/interfaces/EnrichInquiryRequest.md) #### Returns[​](#returns-244 "Direct link to Returns") `Promise`<[`InquiryResponse`](https://docs.gravityrail.com/sdk/interfaces/InquiryResponse.md)> #### Implementation of[​](#implementation-of-243 "Direct link to Implementation of") `AppsBindings.enrichInquiry` *** ### enrollMembers()[​](#enrollmembers "Direct link to enrollMembers()") > **enrollMembers**: (`wid`, `journeyId`, `data`) => `Promise`<`MemberJourney`\[]> Defined in: [packages/sdk/src/client/client.ts:341](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L341) Enroll one or more members in a journey. #### Parameters[​](#parameters-245 "Direct link to Parameters") ##### wid[​](#wid-194 "Direct link to wid") `string` ##### journeyId[​](#journeyid-11 "Direct link to journeyId") `number` ##### data[​](#data-59 "Direct link to data") `EnrollMemberFormData` #### Returns[​](#returns-245 "Direct link to Returns") `Promise`<`MemberJourney`\[]> #### Implementation of[​](#implementation-of-244 "Direct link to Implementation of") `JourneysBindings.enrollMembers` *** ### evaluateTestChatRun()[​](#evaluatetestchatrun "Direct link to evaluateTestChatRun()") > **evaluateTestChatRun**: (`wid`, `runId`) => `Promise`<`void`> Defined in: [packages/sdk/src/client/client.ts:308](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L308) #### Parameters[​](#parameters-246 "Direct link to Parameters") ##### wid[​](#wid-195 "Direct link to wid") `string` ##### runId[​](#runid-1 "Direct link to runId") `number` #### Returns[​](#returns-246 "Direct link to Returns") `Promise`<`void`> #### Implementation of[​](#implementation-of-245 "Direct link to Implementation of") `QualificationsBindings.evaluateTestChatRun` *** ### exchangeOAuthToken()[​](#exchangeoauthtoken "Direct link to exchangeOAuthToken()") > **exchangeOAuthToken**: (`request`) => `Promise`<`TokenResponse`> Defined in: [packages/sdk/src/client/client.ts:849](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L849) #### Parameters[​](#parameters-247 "Direct link to Parameters") ##### request[​](#request-6 "Direct link to request") `TokenRequest` #### Returns[​](#returns-247 "Direct link to Returns") `Promise`<`TokenResponse`> #### Implementation of[​](#implementation-of-246 "Direct link to Implementation of") `AppsBindings.exchangeOAuthToken` *** ### exchangeToken()[​](#exchangetoken "Direct link to exchangeToken()") > **exchangeToken**: (`token`) => `Promise`<{ `token`: `string`; }> Defined in: [packages/sdk/src/client/client.ts:502](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L502) Exchange a cross-domain token for an authenticated session token. #### Parameters[​](#parameters-248 "Direct link to Parameters") ##### token[​](#token-1 "Direct link to token") `string` #### Returns[​](#returns-248 "Direct link to Returns") `Promise`<{ `token`: `string`; }> #### Implementation of[​](#implementation-of-247 "Direct link to Implementation of") `AuthBindings.exchangeToken` *** ### executeAssignmentTool()[​](#executeassignmenttool "Direct link to executeAssignmentTool()") > **executeAssignmentTool**: (`wid`, `assignmentId`, `toolName`, `parameters`) => `Promise`<[`ExecuteToolResponse`](https://docs.gravityrail.com/sdk/interfaces/ExecuteToolResponse.md)> Defined in: [packages/sdk/src/client/client.ts:539](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L539) Execute a tool within an assignment context. #### Parameters[​](#parameters-249 "Direct link to Parameters") ##### wid[​](#wid-196 "Direct link to wid") `string` ##### assignmentId[​](#assignmentid "Direct link to assignmentId") `number` ##### toolName[​](#toolname "Direct link to toolName") `string` ##### parameters?[​](#parameters-250 "Direct link to parameters?") `Record`<`string`, `unknown`> = `{}` #### Returns[​](#returns-249 "Direct link to Returns") `Promise`<[`ExecuteToolResponse`](https://docs.gravityrail.com/sdk/interfaces/ExecuteToolResponse.md)> #### Implementation of[​](#implementation-of-248 "Direct link to Implementation of") `AuthBindings.executeAssignmentTool` *** ### expireAnonymousMember()[​](#expireanonymousmember "Direct link to expireAnonymousMember()") > **expireAnonymousMember**: (`wid`, `resolutionId`, `request?`) => `Promise`<[`AnonymousMemberResolutionResponse`](https://docs.gravityrail.com/sdk/interfaces/AnonymousMemberResolutionResponse.md)> Defined in: [packages/sdk/src/client/client.ts:270](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L270) Expire an anonymous member without resolving to a real member. This archives the anonymous member without merging their data. #### Parameters[​](#parameters-251 "Direct link to Parameters") ##### wid[​](#wid-197 "Direct link to wid") `string` ##### resolutionId[​](#resolutionid "Direct link to resolutionId") `number` ##### request?[​](#request-7 "Direct link to request?") [`ExpireAnonymousMemberRequest`](https://docs.gravityrail.com/sdk/interfaces/ExpireAnonymousMemberRequest.md) #### Returns[​](#returns-250 "Direct link to Returns") `Promise`<[`AnonymousMemberResolutionResponse`](https://docs.gravityrail.com/sdk/interfaces/AnonymousMemberResolutionResponse.md)> #### Implementation of[​](#implementation-of-249 "Direct link to Implementation of") `MembersBindings.expireAnonymousMember` *** ### exportChat()[​](#exportchat "Direct link to exportChat()") > **exportChat**: (`wid`, `chatId`, `format`) => `Promise`<`Blob`> Defined in: [packages/sdk/src/client/client.ts:168](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L168) Export a single chat in the specified format as a downloadable blob. #### Parameters[​](#parameters-252 "Direct link to Parameters") ##### wid[​](#wid-198 "Direct link to wid") `string` ##### chatId[​](#chatid-2 "Direct link to chatId") `number` ##### format?[​](#format-2 "Direct link to format?") `"jsonl"` = `'jsonl'` #### Returns[​](#returns-251 "Direct link to Returns") `Promise`<`Blob`> #### Implementation of[​](#implementation-of-250 "Direct link to Implementation of") `ChatsBindings.exportChat` *** ### exportChats()[​](#exportchats "Direct link to exportChats()") > **exportChats**: (`wid`, `options`) => `Promise`<`Blob`> Defined in: [packages/sdk/src/client/client.ts:167](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L167) Export multiple chats as a downloadable blob. #### Parameters[​](#parameters-253 "Direct link to Parameters") ##### wid[​](#wid-199 "Direct link to wid") `string` ##### options?[​](#options-3 "Direct link to options?") [`GetChatsOptions`](https://docs.gravityrail.com/sdk/interfaces/GetChatsOptions.md) = `{}` #### Returns[​](#returns-252 "Direct link to Returns") `Promise`<`Blob`> #### Implementation of[​](#implementation-of-251 "Direct link to Implementation of") `ChatsBindings.exportChats` *** ### exportInquiriesCsv()[​](#exportinquiriescsv "Direct link to exportInquiriesCsv()") > **exportInquiriesCsv**: (`statusFilter?`) => `Promise`<`Blob`> Defined in: [packages/sdk/src/client/client.ts:847](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L847) Export inquiries to CSV with optional status filtering (superuser only) #### Parameters[​](#parameters-254 "Direct link to Parameters") ##### statusFilter?[​](#statusfilter "Direct link to statusFilter?") `string` #### Returns[​](#returns-253 "Direct link to Returns") `Promise`<`Blob`> #### Implementation of[​](#implementation-of-252 "Direct link to Implementation of") `AppsBindings.exportInquiriesCsv` *** ### exportMembers()[​](#exportmembers "Direct link to exportMembers()") > **exportMembers**: (`wid`, `selectedFields`, `selectedDataTypes`, `memberType?`) => `Promise`<`Blob`> Defined in: [packages/sdk/src/client/client.ts:235](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L235) Export members as a downloadable file with selected fields and data types. #### Parameters[​](#parameters-255 "Direct link to Parameters") ##### wid[​](#wid-200 "Direct link to wid") `string` ##### selectedFields[​](#selectedfields "Direct link to selectedFields") `string`\[] ##### selectedDataTypes[​](#selecteddatatypes "Direct link to selectedDataTypes") `number`\[] ##### memberType?[​](#membertype "Direct link to memberType?") `"member"` | `"anonymous"` | `"test"` #### Returns[​](#returns-254 "Direct link to Returns") `Promise`<`Blob`> #### Implementation of[​](#implementation-of-253 "Direct link to Implementation of") `MembersBindings.exportMembers` *** ### exportPronunciationEntries()[​](#exportpronunciationentries "Direct link to exportPronunciationEntries()") > **exportPronunciationEntries**: (`orgUuid`) => `Promise`<`object`\[]> Defined in: [packages/sdk/src/client/client.ts:1047](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L1047) Export all pronunciation entries for an organization as term/respelling pairs. #### Parameters[​](#parameters-256 "Direct link to Parameters") ##### orgUuid[​](#orguuid-5 "Direct link to orgUuid") `string` #### Returns[​](#returns-255 "Direct link to Returns") `Promise`<`object`\[]> #### Implementation of[​](#implementation-of-254 "Direct link to Implementation of") `PronunciationsBindings.exportPronunciationEntries` *** ### exportWorkspace()[​](#exportworkspace "Direct link to exportWorkspace()") > **exportWorkspace**: (`wid`, `workflowId?`, `scope?`, `exclude?`) => `Promise`<[`WorkspaceExportData`](https://docs.gravityrail.com/sdk/interfaces/WorkspaceExportData.md)> Defined in: [packages/sdk/src/client/client.ts:435](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L435) Export workspace configuration, optionally scoped to a single workflow or workflows-only. #### Parameters[​](#parameters-257 "Direct link to Parameters") ##### wid[​](#wid-201 "Direct link to wid") `string` ##### workflowId?[​](#workflowid-4 "Direct link to workflowId?") `number` Export a single workflow by ID ##### scope?[​](#scope "Direct link to scope?") `"workflows"` Export scope ("workflows" for all workflows only). Cannot be combined with workflowId. ##### exclude?[​](#exclude "Direct link to exclude?") `string` Comma-separated entity categories to exclude (e.g. "channels") #### Returns[​](#returns-256 "Direct link to Returns") `Promise`<[`WorkspaceExportData`](https://docs.gravityrail.com/sdk/interfaces/WorkspaceExportData.md)> #### Implementation of[​](#implementation-of-255 "Direct link to Implementation of") `WorkspacesBindings.exportWorkspace` *** ### fetchVoicemailAudio()[​](#fetchvoicemailaudio "Direct link to fetchVoicemailAudio()") > **fetchVoicemailAudio**: (`wid`, `phoneNumberId`, `voicemailId`) => `Promise`<`ArrayBuffer`> Defined in: [packages/sdk/src/client/client.ts:742](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L742) Fetch voicemail audio through the authenticated client path. #### Parameters[​](#parameters-258 "Direct link to Parameters") ##### wid[​](#wid-202 "Direct link to wid") `string` ##### phoneNumberId[​](#phonenumberid "Direct link to phoneNumberId") `number` ##### voicemailId[​](#voicemailid "Direct link to voicemailId") `number` #### Returns[​](#returns-257 "Direct link to Returns") `Promise`<`ArrayBuffer`> #### Implementation of[​](#implementation-of-256 "Direct link to Implementation of") `CommunicationsBindings.fetchVoicemailAudio` *** ### fhirBackfillEncounterSync()[​](#fhirbackfillencountersync "Direct link to fhirBackfillEncounterSync()") > **fhirBackfillEncounterSync**: (`wid`, `connectionId`, `data`) => `Promise`<[`EncounterSyncRunResponse`](https://docs.gravityrail.com/sdk/interfaces/EncounterSyncRunResponse.md)> Defined in: [packages/sdk/src/client/client.ts:950](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L950) #### Parameters[​](#parameters-259 "Direct link to Parameters") ##### wid[​](#wid-203 "Direct link to wid") `string` ##### connectionId[​](#connectionid-3 "Direct link to connectionId") `number` ##### data[​](#data-60 "Direct link to data") [`TriggerConnectionBackfillRequest`](https://docs.gravityrail.com/sdk/interfaces/TriggerConnectionBackfillRequest.md) #### Returns[​](#returns-258 "Direct link to Returns") `Promise`<[`EncounterSyncRunResponse`](https://docs.gravityrail.com/sdk/interfaces/EncounterSyncRunResponse.md)> #### Implementation of[​](#implementation-of-257 "Direct link to Implementation of") `IntegrationsBindings.fhirBackfillEncounterSync` *** ### fhirCreateEncounter()[​](#fhircreateencounter "Direct link to fhirCreateEncounter()") > **fhirCreateEncounter**: (`wid`, `connectionId`, `data`) => `Promise`<[`FhirMethodResponse`](https://docs.gravityrail.com/sdk/interfaces/FhirMethodResponse.md)> Defined in: [packages/sdk/src/client/client.ts:933](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L933) Create a telephone encounter for a patient via the FHIR connection. #### Parameters[​](#parameters-260 "Direct link to Parameters") ##### wid[​](#wid-204 "Direct link to wid") `string` ##### connectionId[​](#connectionid-4 "Direct link to connectionId") `number` ##### data[​](#data-61 "Direct link to data") [`FhirCreateEncounterRequest`](https://docs.gravityrail.com/sdk/interfaces/FhirCreateEncounterRequest.md) #### Returns[​](#returns-259 "Direct link to Returns") `Promise`<[`FhirMethodResponse`](https://docs.gravityrail.com/sdk/interfaces/FhirMethodResponse.md)> #### Implementation of[​](#implementation-of-258 "Direct link to Implementation of") `IntegrationsBindings.fhirCreateEncounter` *** ### fhirCsvImportApply()[​](#fhircsvimportapply "Direct link to fhirCsvImportApply()") > **fhirCsvImportApply**: (`wid`, `connectionId`, `file`, `columns?`) => `Promise`<`Response`> Defined in: [packages/sdk/src/client/client.ts:942](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L942) #### Parameters[​](#parameters-261 "Direct link to Parameters") ##### wid[​](#wid-205 "Direct link to wid") `string` ##### connectionId[​](#connectionid-5 "Direct link to connectionId") `number` ##### file[​](#file-1 "Direct link to file") `File` ##### columns?[​](#columns "Direct link to columns?") ###### birthdateColumn?[​](#birthdatecolumn "Direct link to birthdateColumn?") `string` ###### identifierColumn[​](#identifiercolumn "Direct link to identifierColumn") `string` #### Returns[​](#returns-260 "Direct link to Returns") `Promise`<`Response`> #### Implementation of[​](#implementation-of-259 "Direct link to Implementation of") `IntegrationsBindings.fhirCsvImportApply` *** ### fhirCsvImportInspect()[​](#fhircsvimportinspect "Direct link to fhirCsvImportInspect()") > **fhirCsvImportInspect**: (`wid`, `connectionId`, `file`) => `Promise`<[`FhirCsvInspectResponse`](https://docs.gravityrail.com/sdk/interfaces/FhirCsvInspectResponse.md)> Defined in: [packages/sdk/src/client/client.ts:939](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L939) #### Parameters[​](#parameters-262 "Direct link to Parameters") ##### wid[​](#wid-206 "Direct link to wid") `string` ##### connectionId[​](#connectionid-6 "Direct link to connectionId") `number` ##### file[​](#file-2 "Direct link to file") `File` #### Returns[​](#returns-261 "Direct link to Returns") `Promise`<[`FhirCsvInspectResponse`](https://docs.gravityrail.com/sdk/interfaces/FhirCsvInspectResponse.md)> #### Implementation of[​](#implementation-of-260 "Direct link to Implementation of") `IntegrationsBindings.fhirCsvImportInspect` *** ### fhirFetchCareTeam()[​](#fhirfetchcareteam "Direct link to fhirFetchCareTeam()") > **fhirFetchCareTeam**: (`wid`, `connectionId`, `data`) => `Promise`<[`FhirMethodResponse`](https://docs.gravityrail.com/sdk/interfaces/FhirMethodResponse.md)> Defined in: [packages/sdk/src/client/client.ts:931](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L931) Fetch care team for a patient via the FHIR connection. #### Parameters[​](#parameters-263 "Direct link to Parameters") ##### wid[​](#wid-207 "Direct link to wid") `string` ##### connectionId[​](#connectionid-7 "Direct link to connectionId") `number` ##### data[​](#data-62 "Direct link to data") [`FhirFetchCareTeamRequest`](https://docs.gravityrail.com/sdk/interfaces/FhirFetchCareTeamRequest.md) #### Returns[​](#returns-262 "Direct link to Returns") `Promise`<[`FhirMethodResponse`](https://docs.gravityrail.com/sdk/interfaces/FhirMethodResponse.md)> #### Implementation of[​](#implementation-of-261 "Direct link to Implementation of") `IntegrationsBindings.fhirFetchCareTeam` *** ### fhirFetchEncounters()[​](#fhirfetchencounters "Direct link to fhirFetchEncounters()") > **fhirFetchEncounters**: (`wid`, `connectionId`, `data`) => `Promise`<[`FhirMethodResponse`](https://docs.gravityrail.com/sdk/interfaces/FhirMethodResponse.md)> Defined in: [packages/sdk/src/client/client.ts:932](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L932) Fetch encounters for a patient via the FHIR connection. #### Parameters[​](#parameters-264 "Direct link to Parameters") ##### wid[​](#wid-208 "Direct link to wid") `string` ##### connectionId[​](#connectionid-8 "Direct link to connectionId") `number` ##### data[​](#data-63 "Direct link to data") [`FhirFetchEncountersRequest`](https://docs.gravityrail.com/sdk/interfaces/FhirFetchEncountersRequest.md) #### Returns[​](#returns-263 "Direct link to Returns") `Promise`<[`FhirMethodResponse`](https://docs.gravityrail.com/sdk/interfaces/FhirMethodResponse.md)> #### Implementation of[​](#implementation-of-262 "Direct link to Implementation of") `IntegrationsBindings.fhirFetchEncounters` *** ### fhirGetCsvImportRunItems()[​](#fhirgetcsvimportrunitems "Direct link to fhirGetCsvImportRunItems()") > **fhirGetCsvImportRunItems**: (`wid`, `connectionId`, `runId`, `limit`) => `Promise`<[`FhirCsvImportRunItem`](https://docs.gravityrail.com/sdk/interfaces/FhirCsvImportRunItem.md)\[]> Defined in: [packages/sdk/src/client/client.ts:944](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L944) #### Parameters[​](#parameters-265 "Direct link to Parameters") ##### wid[​](#wid-209 "Direct link to wid") `string` ##### connectionId[​](#connectionid-9 "Direct link to connectionId") `number` ##### runId[​](#runid-2 "Direct link to runId") `string` ##### limit?[​](#limit "Direct link to limit?") `number` = `500` #### Returns[​](#returns-264 "Direct link to Returns") `Promise`<[`FhirCsvImportRunItem`](https://docs.gravityrail.com/sdk/interfaces/FhirCsvImportRunItem.md)\[]> #### Implementation of[​](#implementation-of-263 "Direct link to Implementation of") `IntegrationsBindings.fhirGetCsvImportRunItems` *** ### fhirGetCsvImportRuns()[​](#fhirgetcsvimportruns "Direct link to fhirGetCsvImportRuns()") > **fhirGetCsvImportRuns**: (`wid`, `connectionId`, `limit`) => `Promise`<[`FhirCsvImportRunSummary`](https://docs.gravityrail.com/sdk/interfaces/FhirCsvImportRunSummary.md)\[]> Defined in: [packages/sdk/src/client/client.ts:943](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L943) #### Parameters[​](#parameters-266 "Direct link to Parameters") ##### wid[​](#wid-210 "Direct link to wid") `string` ##### connectionId[​](#connectionid-10 "Direct link to connectionId") `number` ##### limit?[​](#limit-1 "Direct link to limit?") `number` = `20` #### Returns[​](#returns-265 "Direct link to Returns") `Promise`<[`FhirCsvImportRunSummary`](https://docs.gravityrail.com/sdk/interfaces/FhirCsvImportRunSummary.md)\[]> #### Implementation of[​](#implementation-of-264 "Direct link to Implementation of") `IntegrationsBindings.fhirGetCsvImportRuns` *** ### fhirGetCsvImportSettings()[​](#fhirgetcsvimportsettings "Direct link to fhirGetCsvImportSettings()") > **fhirGetCsvImportSettings**: (`wid`, `connectionId`) => `Promise`<[`FhirCsvImportSettings`](https://docs.gravityrail.com/sdk/interfaces/FhirCsvImportSettings.md)> Defined in: [packages/sdk/src/client/client.ts:940](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L940) #### Parameters[​](#parameters-267 "Direct link to Parameters") ##### wid[​](#wid-211 "Direct link to wid") `string` ##### connectionId[​](#connectionid-11 "Direct link to connectionId") `number` #### Returns[​](#returns-266 "Direct link to Returns") `Promise`<[`FhirCsvImportSettings`](https://docs.gravityrail.com/sdk/interfaces/FhirCsvImportSettings.md)> #### Implementation of[​](#implementation-of-265 "Direct link to Implementation of") `IntegrationsBindings.fhirGetCsvImportSettings` *** ### fhirGetEncounterSyncRuns()[​](#fhirgetencountersyncruns "Direct link to fhirGetEncounterSyncRuns()") > **fhirGetEncounterSyncRuns**: (`wid`, `connectionId`, `limit`) => `Promise`<[`EncounterSyncHistoryItem`](https://docs.gravityrail.com/sdk/interfaces/EncounterSyncHistoryItem.md)\[]> Defined in: [packages/sdk/src/client/client.ts:948](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L948) #### Parameters[​](#parameters-268 "Direct link to Parameters") ##### wid[​](#wid-212 "Direct link to wid") `string` ##### connectionId[​](#connectionid-12 "Direct link to connectionId") `number` ##### limit?[​](#limit-2 "Direct link to limit?") `number` = `20` #### Returns[​](#returns-267 "Direct link to Returns") `Promise`<[`EncounterSyncHistoryItem`](https://docs.gravityrail.com/sdk/interfaces/EncounterSyncHistoryItem.md)\[]> #### Implementation of[​](#implementation-of-266 "Direct link to Implementation of") `IntegrationsBindings.fhirGetEncounterSyncRuns` *** ### fhirGetEncounterSyncStatus()[​](#fhirgetencountersyncstatus "Direct link to fhirGetEncounterSyncStatus()") > **fhirGetEncounterSyncStatus**: (`wid`, `connectionId`) => `Promise`<[`EncounterSyncStatusResponse`](https://docs.gravityrail.com/sdk/interfaces/EncounterSyncStatusResponse.md)> Defined in: [packages/sdk/src/client/client.ts:945](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L945) #### Parameters[​](#parameters-269 "Direct link to Parameters") ##### wid[​](#wid-213 "Direct link to wid") `string` ##### connectionId[​](#connectionid-13 "Direct link to connectionId") `number` #### Returns[​](#returns-268 "Direct link to Returns") `Promise`<[`EncounterSyncStatusResponse`](https://docs.gravityrail.com/sdk/interfaces/EncounterSyncStatusResponse.md)> #### Implementation of[​](#implementation-of-267 "Direct link to Implementation of") `IntegrationsBindings.fhirGetEncounterSyncStatus` *** ### fhirImportPatient()[​](#fhirimportpatient "Direct link to fhirImportPatient()") > **fhirImportPatient**: (`wid`, `connectionId`, `data`) => `Promise`<[`FhirMethodResponse`](https://docs.gravityrail.com/sdk/interfaces/FhirMethodResponse.md)> Defined in: [packages/sdk/src/client/client.ts:938](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L938) #### Parameters[​](#parameters-270 "Direct link to Parameters") ##### wid[​](#wid-214 "Direct link to wid") `string` ##### connectionId[​](#connectionid-14 "Direct link to connectionId") `number` ##### data[​](#data-64 "Direct link to data") ###### memberRoleId?[​](#memberroleid "Direct link to memberRoleId?") `number` ###### patientId[​](#patientid "Direct link to patientId") `string` #### Returns[​](#returns-269 "Direct link to Returns") `Promise`<[`FhirMethodResponse`](https://docs.gravityrail.com/sdk/interfaces/FhirMethodResponse.md)> #### Implementation of[​](#implementation-of-268 "Direct link to Implementation of") `IntegrationsBindings.fhirImportPatient` *** ### fhirLinkMember()[​](#fhirlinkmember "Direct link to fhirLinkMember()") > **fhirLinkMember**: (`wid`, `connectionId`, `data`) => `Promise`<[`FhirMethodResponse`](https://docs.gravityrail.com/sdk/interfaces/FhirMethodResponse.md)> Defined in: [packages/sdk/src/client/client.ts:935](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L935) #### Parameters[​](#parameters-271 "Direct link to Parameters") ##### wid[​](#wid-215 "Direct link to wid") `string` ##### connectionId[​](#connectionid-15 "Direct link to connectionId") `number` ##### data[​](#data-65 "Direct link to data") ###### memberId[​](#memberid-10 "Direct link to memberId") `number` ###### patientId[​](#patientid-1 "Direct link to patientId") `string` #### Returns[​](#returns-270 "Direct link to Returns") `Promise`<[`FhirMethodResponse`](https://docs.gravityrail.com/sdk/interfaces/FhirMethodResponse.md)> #### Implementation of[​](#implementation-of-269 "Direct link to Implementation of") `IntegrationsBindings.fhirLinkMember` *** ### fhirListLinkedMembers()[​](#fhirlistlinkedmembers "Direct link to fhirListLinkedMembers()") > **fhirListLinkedMembers**: (`wid`, `connectionId`, `params?`) => `Promise`<[`PaginatedResponse`](https://docs.gravityrail.com/sdk/interfaces/PaginatedResponse.md)<`FhirLinkedMember`>> Defined in: [packages/sdk/src/client/client.ts:934](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L934) #### Parameters[​](#parameters-272 "Direct link to Parameters") ##### wid[​](#wid-216 "Direct link to wid") `string` ##### connectionId[​](#connectionid-16 "Direct link to connectionId") `number` ##### params?[​](#params-1 "Direct link to params?") ###### page?[​](#page-1 "Direct link to page?") `number` ###### pageSize?[​](#pagesize "Direct link to pageSize?") `number` ###### search?[​](#search "Direct link to search?") `string` #### Returns[​](#returns-271 "Direct link to Returns") `Promise`<[`PaginatedResponse`](https://docs.gravityrail.com/sdk/interfaces/PaginatedResponse.md)<`FhirLinkedMember`>> #### Implementation of[​](#implementation-of-270 "Direct link to Implementation of") `IntegrationsBindings.fhirListLinkedMembers` *** ### fhirRefreshEncounterPatient()[​](#fhirrefreshencounterpatient "Direct link to fhirRefreshEncounterPatient()") > **fhirRefreshEncounterPatient**: (`wid`, `connectionId`, `data`) => `Promise`<[`EncounterSyncRunResponse`](https://docs.gravityrail.com/sdk/interfaces/EncounterSyncRunResponse.md)> Defined in: [packages/sdk/src/client/client.ts:949](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L949) #### Parameters[​](#parameters-273 "Direct link to Parameters") ##### wid[​](#wid-217 "Direct link to wid") `string` ##### connectionId[​](#connectionid-17 "Direct link to connectionId") `number` ##### data[​](#data-66 "Direct link to data") [`TriggerPatientRefreshRequest`](https://docs.gravityrail.com/sdk/interfaces/TriggerPatientRefreshRequest.md) #### Returns[​](#returns-272 "Direct link to Returns") `Promise`<[`EncounterSyncRunResponse`](https://docs.gravityrail.com/sdk/interfaces/EncounterSyncRunResponse.md)> #### Implementation of[​](#implementation-of-271 "Direct link to Implementation of") `IntegrationsBindings.fhirRefreshEncounterPatient` *** ### fhirRunEncounterSync()[​](#fhirrunencountersync "Direct link to fhirRunEncounterSync()") > **fhirRunEncounterSync**: (`wid`, `connectionId`) => `Promise`<[`EncounterSyncRunResponse`](https://docs.gravityrail.com/sdk/interfaces/EncounterSyncRunResponse.md)> Defined in: [packages/sdk/src/client/client.ts:947](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L947) #### Parameters[​](#parameters-274 "Direct link to Parameters") ##### wid[​](#wid-218 "Direct link to wid") `string` ##### connectionId[​](#connectionid-18 "Direct link to connectionId") `number` #### Returns[​](#returns-273 "Direct link to Returns") `Promise`<[`EncounterSyncRunResponse`](https://docs.gravityrail.com/sdk/interfaces/EncounterSyncRunResponse.md)> #### Implementation of[​](#implementation-of-272 "Direct link to Implementation of") `IntegrationsBindings.fhirRunEncounterSync` *** ### fhirSearchLocations()[​](#fhirsearchlocations "Direct link to fhirSearchLocations()") > **fhirSearchLocations**: (`wid`, `connectionId`, `data`) => `Promise`<[`FhirMethodResponse`](https://docs.gravityrail.com/sdk/interfaces/FhirMethodResponse.md)> Defined in: [packages/sdk/src/client/client.ts:930](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L930) Search for locations via the FHIR connection. #### Parameters[​](#parameters-275 "Direct link to Parameters") ##### wid[​](#wid-219 "Direct link to wid") `string` ##### connectionId[​](#connectionid-19 "Direct link to connectionId") `number` ##### data[​](#data-67 "Direct link to data") [`FhirSearchLocationsRequest`](https://docs.gravityrail.com/sdk/interfaces/FhirSearchLocationsRequest.md) #### Returns[​](#returns-274 "Direct link to Returns") `Promise`<[`FhirMethodResponse`](https://docs.gravityrail.com/sdk/interfaces/FhirMethodResponse.md)> #### Implementation of[​](#implementation-of-273 "Direct link to Implementation of") `IntegrationsBindings.fhirSearchLocations` *** ### fhirSearchPatients()[​](#fhirsearchpatients "Direct link to fhirSearchPatients()") > **fhirSearchPatients**: (`wid`, `connectionId`, `data`) => `Promise`<[`FhirMethodResponse`](https://docs.gravityrail.com/sdk/interfaces/FhirMethodResponse.md)> Defined in: [packages/sdk/src/client/client.ts:928](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L928) Search for patients via the FHIR connection. #### Parameters[​](#parameters-276 "Direct link to Parameters") ##### wid[​](#wid-220 "Direct link to wid") `string` ##### connectionId[​](#connectionid-20 "Direct link to connectionId") `number` ##### data[​](#data-68 "Direct link to data") [`FhirSearchPatientsRequest`](https://docs.gravityrail.com/sdk/interfaces/FhirSearchPatientsRequest.md) #### Returns[​](#returns-275 "Direct link to Returns") `Promise`<[`FhirMethodResponse`](https://docs.gravityrail.com/sdk/interfaces/FhirMethodResponse.md)> #### Implementation of[​](#implementation-of-274 "Direct link to Implementation of") `IntegrationsBindings.fhirSearchPatients` *** ### fhirSearchPractitioners()[​](#fhirsearchpractitioners "Direct link to fhirSearchPractitioners()") > **fhirSearchPractitioners**: (`wid`, `connectionId`, `data`) => `Promise`<[`FhirMethodResponse`](https://docs.gravityrail.com/sdk/interfaces/FhirMethodResponse.md)> Defined in: [packages/sdk/src/client/client.ts:929](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L929) Search for practitioners via the FHIR connection. #### Parameters[​](#parameters-277 "Direct link to Parameters") ##### wid[​](#wid-221 "Direct link to wid") `string` ##### connectionId[​](#connectionid-21 "Direct link to connectionId") `number` ##### data[​](#data-69 "Direct link to data") [`FhirSearchPractitionersRequest`](https://docs.gravityrail.com/sdk/interfaces/FhirSearchPractitionersRequest.md) #### Returns[​](#returns-276 "Direct link to Returns") `Promise`<[`FhirMethodResponse`](https://docs.gravityrail.com/sdk/interfaces/FhirMethodResponse.md)> #### Implementation of[​](#implementation-of-275 "Direct link to Implementation of") `IntegrationsBindings.fhirSearchPractitioners` *** ### fhirSyncMember()[​](#fhirsyncmember "Direct link to fhirSyncMember()") > **fhirSyncMember**: (`wid`, `connectionId`, `memberId`) => `Promise`<[`FhirMethodResponse`](https://docs.gravityrail.com/sdk/interfaces/FhirMethodResponse.md)> Defined in: [packages/sdk/src/client/client.ts:937](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L937) #### Parameters[​](#parameters-278 "Direct link to Parameters") ##### wid[​](#wid-222 "Direct link to wid") `string` ##### connectionId[​](#connectionid-22 "Direct link to connectionId") `number` ##### memberId[​](#memberid-11 "Direct link to memberId") `number` #### Returns[​](#returns-277 "Direct link to Returns") `Promise`<[`FhirMethodResponse`](https://docs.gravityrail.com/sdk/interfaces/FhirMethodResponse.md)> #### Implementation of[​](#implementation-of-276 "Direct link to Implementation of") `IntegrationsBindings.fhirSyncMember` *** ### fhirUnlinkMember()[​](#fhirunlinkmember "Direct link to fhirUnlinkMember()") > **fhirUnlinkMember**: (`wid`, `connectionId`, `memberId`) => `Promise`<[`FhirMethodResponse`](https://docs.gravityrail.com/sdk/interfaces/FhirMethodResponse.md)> Defined in: [packages/sdk/src/client/client.ts:936](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L936) #### Parameters[​](#parameters-279 "Direct link to Parameters") ##### wid[​](#wid-223 "Direct link to wid") `string` ##### connectionId[​](#connectionid-23 "Direct link to connectionId") `number` ##### memberId[​](#memberid-12 "Direct link to memberId") `number` #### Returns[​](#returns-278 "Direct link to Returns") `Promise`<[`FhirMethodResponse`](https://docs.gravityrail.com/sdk/interfaces/FhirMethodResponse.md)> #### Implementation of[​](#implementation-of-277 "Direct link to Implementation of") `IntegrationsBindings.fhirUnlinkMember` *** ### fhirUpdateCsvImportSettings()[​](#fhirupdatecsvimportsettings "Direct link to fhirUpdateCsvImportSettings()") > **fhirUpdateCsvImportSettings**: (`wid`, `connectionId`, `data`) => `Promise`<[`FhirCsvImportSettings`](https://docs.gravityrail.com/sdk/interfaces/FhirCsvImportSettings.md)> Defined in: [packages/sdk/src/client/client.ts:941](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L941) #### Parameters[​](#parameters-280 "Direct link to Parameters") ##### wid[​](#wid-224 "Direct link to wid") `string` ##### connectionId[​](#connectionid-24 "Direct link to connectionId") `number` ##### data[​](#data-70 "Direct link to data") [`UpdateFhirCsvImportSettingsRequest`](https://docs.gravityrail.com/sdk/interfaces/UpdateFhirCsvImportSettingsRequest.md) #### Returns[​](#returns-279 "Direct link to Returns") `Promise`<[`FhirCsvImportSettings`](https://docs.gravityrail.com/sdk/interfaces/FhirCsvImportSettings.md)> #### Implementation of[​](#implementation-of-278 "Direct link to Implementation of") `IntegrationsBindings.fhirUpdateCsvImportSettings` *** ### fhirUpdateEncounterSync()[​](#fhirupdateencountersync "Direct link to fhirUpdateEncounterSync()") > **fhirUpdateEncounterSync**: (`wid`, `connectionId`, `data`) => `Promise`<[`EncounterSyncStatusResponse`](https://docs.gravityrail.com/sdk/interfaces/EncounterSyncStatusResponse.md)> Defined in: [packages/sdk/src/client/client.ts:946](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L946) #### Parameters[​](#parameters-281 "Direct link to Parameters") ##### wid[​](#wid-225 "Direct link to wid") `string` ##### connectionId[​](#connectionid-25 "Direct link to connectionId") `number` ##### data[​](#data-71 "Direct link to data") [`UpdateEncounterSyncRequest`](https://docs.gravityrail.com/sdk/interfaces/UpdateEncounterSyncRequest.md) #### Returns[​](#returns-280 "Direct link to Returns") `Promise`<[`EncounterSyncStatusResponse`](https://docs.gravityrail.com/sdk/interfaces/EncounterSyncStatusResponse.md)> #### Implementation of[​](#implementation-of-279 "Direct link to Implementation of") `IntegrationsBindings.fhirUpdateEncounterSync` *** ### findOrCreateDMChat()[​](#findorcreatedmchat "Direct link to findOrCreateDMChat()") > **findOrCreateDMChat**: (`wid`, `memberId`) => `Promise`<[`ChatResponse`](https://docs.gravityrail.com/sdk/interfaces/ChatResponse.md)> Defined in: [packages/sdk/src/client/client.ts:169](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L169) Find or create a DM chat with a specific member. Returns the Chat object for the DM conversation. #### Parameters[​](#parameters-282 "Direct link to Parameters") ##### wid[​](#wid-226 "Direct link to wid") `string` ##### memberId[​](#memberid-13 "Direct link to memberId") `number` #### Returns[​](#returns-281 "Direct link to Returns") `Promise`<[`ChatResponse`](https://docs.gravityrail.com/sdk/interfaces/ChatResponse.md)> #### Implementation of[​](#implementation-of-280 "Direct link to Implementation of") `ChatsBindings.findOrCreateDMChat` *** ### generateFileUploadUrl()[​](#generatefileuploadurl "Direct link to generateFileUploadUrl()") > **generateFileUploadUrl**: (`wid`, `request`) => `Promise`<[`FileUploadResponse`](https://docs.gravityrail.com/sdk/interfaces/FileUploadResponse.md)> Defined in: [packages/sdk/src/client/client.ts:595](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L595) Generate a pre-signed upload URL for uploading file content. #### Parameters[​](#parameters-283 "Direct link to Parameters") ##### wid[​](#wid-227 "Direct link to wid") `string` ##### request[​](#request-8 "Direct link to request") [`FileUploadRequest`](https://docs.gravityrail.com/sdk/interfaces/FileUploadRequest.md) #### Returns[​](#returns-282 "Direct link to Returns") `Promise`<[`FileUploadResponse`](https://docs.gravityrail.com/sdk/interfaces/FileUploadResponse.md)> #### Implementation of[​](#implementation-of-281 "Direct link to Implementation of") `FilesBindings.generateFileUploadUrl` *** ### generateICalToken()[​](#generateicaltoken "Direct link to generateICalToken()") > **generateICalToken**: (`wid`, `calendarId`, `regenerate`) => `Promise`<[`ICalFeedTokenResponse`](https://docs.gravityrail.com/sdk/interfaces/ICalFeedTokenResponse.md)> Defined in: [packages/sdk/src/client/client.ts:716](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L716) Generate or regenerate an iCal feed token for a calendar. #### Parameters[​](#parameters-284 "Direct link to Parameters") ##### wid[​](#wid-228 "Direct link to wid") `string` ##### calendarId[​](#calendarid-3 "Direct link to calendarId") `number` ##### regenerate?[​](#regenerate "Direct link to regenerate?") `boolean` = `false` #### Returns[​](#returns-283 "Direct link to Returns") `Promise`<[`ICalFeedTokenResponse`](https://docs.gravityrail.com/sdk/interfaces/ICalFeedTokenResponse.md)> #### Implementation of[​](#implementation-of-282 "Direct link to Implementation of") `CalendarsBindings.generateICalToken` *** ### generateRecoveryCodes()[​](#generaterecoverycodes "Direct link to generateRecoveryCodes()") > **generateRecoveryCodes**: (`data`) => `Promise`<[`RecoveryCodesResponse`](https://docs.gravityrail.com/sdk/interfaces/RecoveryCodesResponse.md)> Defined in: [packages/sdk/src/client/client.ts:515](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L515) Generate new two-factor recovery codes, invalidating any existing ones. #### Parameters[​](#parameters-285 "Direct link to Parameters") ##### data?[​](#data-72 "Direct link to data?") [`GenerateRecoveryCodesRequest`](https://docs.gravityrail.com/sdk/interfaces/GenerateRecoveryCodesRequest.md) = `{}` #### Returns[​](#returns-284 "Direct link to Returns") `Promise`<[`RecoveryCodesResponse`](https://docs.gravityrail.com/sdk/interfaces/RecoveryCodesResponse.md)> #### Implementation of[​](#implementation-of-283 "Direct link to Implementation of") `AuthBindings.generateRecoveryCodes` *** ### generateSiteMediaUploadUrl()[​](#generatesitemediauploadurl "Direct link to generateSiteMediaUploadUrl()") > **generateSiteMediaUploadUrl**: (`wid`, `siteId`, `uploadRequest`) => `Promise`<[`FileUploadResponse`](https://docs.gravityrail.com/sdk/interfaces/FileUploadResponse.md)> Defined in: [packages/sdk/src/client/client.ts:584](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L584) Generate a pre-signed upload URL for site media content. #### Parameters[​](#parameters-286 "Direct link to Parameters") ##### wid[​](#wid-229 "Direct link to wid") `string` ##### siteId[​](#siteid-8 "Direct link to siteId") `number` ##### uploadRequest[​](#uploadrequest "Direct link to uploadRequest") [`FileUploadRequest`](https://docs.gravityrail.com/sdk/interfaces/FileUploadRequest.md) #### Returns[​](#returns-285 "Direct link to Returns") `Promise`<[`FileUploadResponse`](https://docs.gravityrail.com/sdk/interfaces/FileUploadResponse.md)> #### Implementation of[​](#implementation-of-284 "Direct link to Implementation of") `SitesBindings.generateSiteMediaUploadUrl` *** ### getAbilityType()[​](#getabilitytype "Direct link to getAbilityType()") > **getAbilityType**: (`wid`, `slug`) => `Promise`<[`AbilityTypeResponse`](https://docs.gravityrail.com/sdk/interfaces/AbilityTypeResponse.md)> Defined in: [packages/sdk/src/client/client.ts:133](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L133) Get the full spec for a single ability type by slug. #### Parameters[​](#parameters-287 "Direct link to Parameters") ##### wid[​](#wid-230 "Direct link to wid") `string` ##### slug[​](#slug-5 "Direct link to slug") `string` #### Returns[​](#returns-286 "Direct link to Returns") `Promise`<[`AbilityTypeResponse`](https://docs.gravityrail.com/sdk/interfaces/AbilityTypeResponse.md)> #### Implementation of[​](#implementation-of-285 "Direct link to Implementation of") `TasksBindings.getAbilityType` *** ### getAbilityTypes()[​](#getabilitytypes "Direct link to getAbilityTypes()") > **getAbilityTypes**: (`wid`, `options`) => `Promise`<[`AbilityTypesResponse`](https://docs.gravityrail.com/sdk/interfaces/AbilityTypesResponse.md)> Defined in: [packages/sdk/src/client/client.ts:132](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L132) List available ability types from the registry. Pass includeSystem to also return auto-injected system abilities. #### Parameters[​](#parameters-288 "Direct link to Parameters") ##### wid[​](#wid-231 "Direct link to wid") `string` ##### options?[​](#options-4 "Direct link to options?") ###### includeSystem?[​](#includesystem "Direct link to includeSystem?") `boolean` #### Returns[​](#returns-287 "Direct link to Returns") `Promise`<[`AbilityTypesResponse`](https://docs.gravityrail.com/sdk/interfaces/AbilityTypesResponse.md)> #### Implementation of[​](#implementation-of-286 "Direct link to Implementation of") `TasksBindings.getAbilityTypes` *** ### getAccessGrant()[​](#getaccessgrant "Direct link to getAccessGrant()") > **getAccessGrant**: (`wid`, `uuid`) => `Promise`<[`AccessGrant`](https://docs.gravityrail.com/sdk/type-aliases/AccessGrant.md)> Defined in: [packages/sdk/src/client/client.ts:388](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L388) Get a single access grant by UUID. #### Parameters[​](#parameters-289 "Direct link to Parameters") ##### wid[​](#wid-232 "Direct link to wid") `string` ##### uuid[​](#uuid-8 "Direct link to uuid") `string` #### Returns[​](#returns-288 "Direct link to Returns") `Promise`<[`AccessGrant`](https://docs.gravityrail.com/sdk/type-aliases/AccessGrant.md)> #### Implementation of[​](#implementation-of-287 "Direct link to Implementation of") `AccessGrantsBindings.getAccessGrant` *** ### getAccessGrants()[​](#getaccessgrants "Direct link to getAccessGrants()") > **getAccessGrants**: (`wid`, `params?`) => `Promise`<[`PaginatedResponse`](https://docs.gravityrail.com/sdk/interfaces/PaginatedResponse.md)<[`AccessGrant`](https://docs.gravityrail.com/sdk/type-aliases/AccessGrant.md)>> Defined in: [packages/sdk/src/client/client.ts:392](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L392) List all access grants with optional filtering by status, resource type, and resource ID. #### Parameters[​](#parameters-290 "Direct link to Parameters") ##### wid[​](#wid-233 "Direct link to wid") `string` ##### params?[​](#params-2 "Direct link to params?") ###### page?[​](#page-2 "Direct link to page?") `number` ###### pageSize?[​](#pagesize-1 "Direct link to pageSize?") `number` ###### resourceId?[​](#resourceid "Direct link to resourceId?") `number` ###### resourceType?[​](#resourcetype "Direct link to resourceType?") `string` ###### status?[​](#status "Direct link to status?") `string` #### Returns[​](#returns-289 "Direct link to Returns") `Promise`<[`PaginatedResponse`](https://docs.gravityrail.com/sdk/interfaces/PaginatedResponse.md)<[`AccessGrant`](https://docs.gravityrail.com/sdk/type-aliases/AccessGrant.md)>> #### Implementation of[​](#implementation-of-288 "Direct link to Implementation of") `AccessGrantsBindings.getAccessGrants` *** ### getAgent()[​](#getagent "Direct link to getAgent()") > **getAgent**: (`wid`, `id`) => `Promise`<[`AgentResponse`](https://docs.gravityrail.com/sdk/interfaces/AgentResponse.md)> Defined in: [packages/sdk/src/client/client.ts:287](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L287) Get a single agent by ID. #### Parameters[​](#parameters-291 "Direct link to Parameters") ##### wid[​](#wid-234 "Direct link to wid") `string` ##### id[​](#id-35 "Direct link to id") `number` #### Returns[​](#returns-290 "Direct link to Returns") `Promise`<[`AgentResponse`](https://docs.gravityrail.com/sdk/interfaces/AgentResponse.md)> #### Implementation of[​](#implementation-of-289 "Direct link to Implementation of") `AgentsBindings.getAgent` *** ### getAgents()[​](#getagents "Direct link to getAgents()") > **getAgents**: (`wid`, `options`) => `Promise`<[`PaginatedResponse`](https://docs.gravityrail.com/sdk/interfaces/PaginatedResponse.md)<[`AgentResponse`](https://docs.gravityrail.com/sdk/interfaces/AgentResponse.md)>> Defined in: [packages/sdk/src/client/client.ts:286](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L286) List agents in a workspace with optional pagination, sorting, and search. #### Parameters[​](#parameters-292 "Direct link to Parameters") ##### wid[​](#wid-235 "Direct link to wid") `string` ##### options?[​](#options-5 "Direct link to options?") ###### includeArchived?[​](#includearchived "Direct link to includeArchived?") `boolean` ###### page?[​](#page-3 "Direct link to page?") `number` ###### pageSize?[​](#pagesize-2 "Direct link to pageSize?") `number` ###### search?[​](#search-1 "Direct link to search?") `string` ###### sortBy?[​](#sortby "Direct link to sortBy?") `AgentSortField` ###### sortOrder?[​](#sortorder "Direct link to sortOrder?") [`SortOrder`](https://docs.gravityrail.com/sdk/type-aliases/SortOrder.md) #### Returns[​](#returns-291 "Direct link to Returns") `Promise`<[`PaginatedResponse`](https://docs.gravityrail.com/sdk/interfaces/PaginatedResponse.md)<[`AgentResponse`](https://docs.gravityrail.com/sdk/interfaces/AgentResponse.md)>> #### Implementation of[​](#implementation-of-290 "Direct link to Implementation of") `AgentsBindings.getAgents` *** ### getAgentTask()[​](#getagenttask "Direct link to getAgentTask()") > **getAgentTask**: (`wid`, `taskUuid`) => `Promise`<`AgentTaskResponse`> Defined in: [packages/sdk/src/client/client.ts:281](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L281) #### Parameters[​](#parameters-293 "Direct link to Parameters") ##### wid[​](#wid-236 "Direct link to wid") `string` ##### taskUuid[​](#taskuuid-1 "Direct link to taskUuid") `string` #### Returns[​](#returns-292 "Direct link to Returns") `Promise`<`AgentTaskResponse`> #### Implementation of[​](#implementation-of-291 "Direct link to Implementation of") `AgentTasksBindings.getAgentTask` *** ### getAgentTaskMessages()[​](#getagenttaskmessages "Direct link to getAgentTaskMessages()") > **getAgentTaskMessages**: (`wid`, `taskUuid`, `params?`) => `Promise`<`AgentTaskMessageResponse`\[]> Defined in: [packages/sdk/src/client/client.ts:283](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L283) #### Parameters[​](#parameters-294 "Direct link to Parameters") ##### wid[​](#wid-237 "Direct link to wid") `string` ##### taskUuid[​](#taskuuid-2 "Direct link to taskUuid") `string` ##### params?[​](#params-3 "Direct link to params?") `GetAgentTaskMessagesParams` #### Returns[​](#returns-293 "Direct link to Returns") `Promise`<`AgentTaskMessageResponse`\[]> #### Implementation of[​](#implementation-of-292 "Direct link to Implementation of") `AgentTasksBindings.getAgentTaskMessages` *** ### getAgentTasks()[​](#getagenttasks "Direct link to getAgentTasks()") > **getAgentTasks**: (`wid`, `params?`) => `Promise`<`AgentTaskResponse`\[]> Defined in: [packages/sdk/src/client/client.ts:280](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L280) #### Parameters[​](#parameters-295 "Direct link to Parameters") ##### wid[​](#wid-238 "Direct link to wid") `string` ##### params?[​](#params-4 "Direct link to params?") `ListAgentTasksParams` #### Returns[​](#returns-294 "Direct link to Returns") `Promise`<`AgentTaskResponse`\[]> #### Implementation of[​](#implementation-of-293 "Direct link to Implementation of") `AgentTasksBindings.getAgentTasks` *** ### getAIUsageReport()[​](#getaiusagereport "Direct link to getAIUsageReport()") > **getAIUsageReport**: (`wid`, `params?`) => `Promise`<[`AIUsageReport`](https://docs.gravityrail.com/sdk/interfaces/AIUsageReport.md)> Defined in: [packages/sdk/src/client/client.ts:821](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L821) Get AI model usage report for a workspace within an optional date range. #### Parameters[​](#parameters-296 "Direct link to Parameters") ##### wid[​](#wid-239 "Direct link to wid") `string` ##### params?[​](#params-5 "Direct link to params?") [`AIUsageReportParams`](https://docs.gravityrail.com/sdk/interfaces/AIUsageReportParams.md) #### Returns[​](#returns-295 "Direct link to Returns") `Promise`<[`AIUsageReport`](https://docs.gravityrail.com/sdk/interfaces/AIUsageReport.md)> #### Implementation of[​](#implementation-of-294 "Direct link to Implementation of") `BillingBindings.getAIUsageReport` *** ### getAllModels()[​](#getallmodels "Direct link to getAllModels()") > **getAllModels**: (`provider?`, `includeUnavailable`) => `Promise`<[`AllModelsResponse`](https://docs.gravityrail.com/sdk/interfaces/AllModelsResponse.md)> Defined in: [packages/sdk/src/client/client.ts:778](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L778) Get all AI models with full metadata including multipliers Returns models grouped by type (chat, realtime, image, stt, tts) #### Parameters[​](#parameters-297 "Direct link to Parameters") ##### provider?[​](#provider "Direct link to provider?") `string` ##### includeUnavailable?[​](#includeunavailable "Direct link to includeUnavailable?") `boolean` = `false` #### Returns[​](#returns-296 "Direct link to Returns") `Promise`<[`AllModelsResponse`](https://docs.gravityrail.com/sdk/interfaces/AllModelsResponse.md)> #### Implementation of[​](#implementation-of-295 "Direct link to Implementation of") `ToolkitsBindings.getAllModels` *** ### getAnonymousResolution()[​](#getanonymousresolution "Direct link to getAnonymousResolution()") > **getAnonymousResolution**: (`wid`, `resolutionId`) => `Promise`<[`AnonymousMemberResolutionResponse`](https://docs.gravityrail.com/sdk/interfaces/AnonymousMemberResolutionResponse.md)> Defined in: [packages/sdk/src/client/client.ts:268](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L268) Get a single anonymous member resolution by ID. #### Parameters[​](#parameters-298 "Direct link to Parameters") ##### wid[​](#wid-240 "Direct link to wid") `string` ##### resolutionId[​](#resolutionid-1 "Direct link to resolutionId") `number` #### Returns[​](#returns-297 "Direct link to Returns") `Promise`<[`AnonymousMemberResolutionResponse`](https://docs.gravityrail.com/sdk/interfaces/AnonymousMemberResolutionResponse.md)> #### Implementation of[​](#implementation-of-296 "Direct link to Implementation of") `MembersBindings.getAnonymousResolution` *** ### getAnonymousResolutions()[​](#getanonymousresolutions "Direct link to getAnonymousResolutions()") > **getAnonymousResolutions**: (`wid`, `options?`) => `Promise`<[`PendingAnonymousMembersResponse`](https://docs.gravityrail.com/sdk/interfaces/PendingAnonymousMembersResponse.md)> Defined in: [packages/sdk/src/client/client.ts:267](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L267) List anonymous member resolutions with filtering and pagination. Returns pending resolutions by default. #### Parameters[​](#parameters-299 "Direct link to Parameters") ##### wid[​](#wid-241 "Direct link to wid") `string` ##### options?[​](#options-6 "Direct link to options?") ###### page?[​](#page-4 "Direct link to page?") `number` ###### pageSize?[​](#pagesize-3 "Direct link to pageSize?") `number` ###### status?[​](#status-1 "Direct link to status?") `"pending"` | `"resolved"` | `"expired"` #### Returns[​](#returns-298 "Direct link to Returns") `Promise`<[`PendingAnonymousMembersResponse`](https://docs.gravityrail.com/sdk/interfaces/PendingAnonymousMembersResponse.md)> #### Implementation of[​](#implementation-of-297 "Direct link to Implementation of") `MembersBindings.getAnonymousResolutions` *** ### getApiKeys()[​](#getapikeys "Direct link to getApiKeys()") > **getApiKeys**: (`wid`) => `Promise`<[`ApiKey`](https://docs.gravityrail.com/sdk/interfaces/ApiKey.md)\[]> Defined in: [packages/sdk/src/client/client.ts:806](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L806) List all API keys for a workspace. #### Parameters[​](#parameters-300 "Direct link to Parameters") ##### wid[​](#wid-242 "Direct link to wid") `string` #### Returns[​](#returns-299 "Direct link to Returns") `Promise`<[`ApiKey`](https://docs.gravityrail.com/sdk/interfaces/ApiKey.md)\[]> #### Implementation of[​](#implementation-of-298 "Direct link to Implementation of") `BillingBindings.getApiKeys` *** ### getApp()[​](#getapp "Direct link to getApp()") > **getApp**: (`appId`) => `Promise`<[`App`](https://docs.gravityrail.com/sdk/type-aliases/App.md)> Defined in: [packages/sdk/src/client/client.ts:830](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L830) Get details of a specific app #### Parameters[​](#parameters-301 "Direct link to Parameters") ##### appId[​](#appid-3 "Direct link to appId") `string` #### Returns[​](#returns-300 "Direct link to Returns") `Promise`<[`App`](https://docs.gravityrail.com/sdk/type-aliases/App.md)> #### Implementation of[​](#implementation-of-299 "Direct link to Implementation of") `AppsBindings.getApp` *** ### getAppByClientId()[​](#getappbyclientid "Direct link to getAppByClientId()") > **getAppByClientId**: (`clientId`) => `Promise`<[`App`](https://docs.gravityrail.com/sdk/type-aliases/App.md)> Defined in: [packages/sdk/src/client/client.ts:831](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L831) Get app by client ID (for OAuth flows) #### Parameters[​](#parameters-302 "Direct link to Parameters") ##### clientId[​](#clientid-1 "Direct link to clientId") `string` #### Returns[​](#returns-301 "Direct link to Returns") `Promise`<[`App`](https://docs.gravityrail.com/sdk/type-aliases/App.md)> #### Implementation of[​](#implementation-of-300 "Direct link to Implementation of") `AppsBindings.getAppByClientId` *** ### getArchiveBlockers()[​](#getarchiveblockers "Direct link to getArchiveBlockers()") > **getArchiveBlockers**: (`wid`, `id`) => `Promise`<`ArchiveBlockersResponse`> Defined in: [packages/sdk/src/client/client.ts:737](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L737) Get archive blockers for a phone number. #### Parameters[​](#parameters-303 "Direct link to Parameters") ##### wid[​](#wid-243 "Direct link to wid") `string` ##### id[​](#id-36 "Direct link to id") `number` #### Returns[​](#returns-302 "Direct link to Returns") `Promise`<`ArchiveBlockersResponse`> #### Implementation of[​](#implementation-of-301 "Direct link to Implementation of") `CommunicationsBindings.getArchiveBlockers` *** ### getAssignment()[​](#getassignment "Direct link to getAssignment()") > **getAssignment**: (`wid`, `id`) => `Promise`<[`AssignmentResponse`](https://docs.gravityrail.com/sdk/interfaces/AssignmentResponse.md)> Defined in: [packages/sdk/src/client/client.ts:528](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L528) Get a single assignment by ID. #### Parameters[​](#parameters-304 "Direct link to Parameters") ##### wid[​](#wid-244 "Direct link to wid") `string` ##### id[​](#id-37 "Direct link to id") `number` #### Returns[​](#returns-303 "Direct link to Returns") `Promise`<[`AssignmentResponse`](https://docs.gravityrail.com/sdk/interfaces/AssignmentResponse.md)> #### Implementation of[​](#implementation-of-302 "Direct link to Implementation of") `AuthBindings.getAssignment` *** ### getAssignmentCelContext()[​](#getassignmentcelcontext "Direct link to getAssignmentCelContext()") > **getAssignmentCelContext**: (`wid`, `assignmentId`) => `Promise`<`Record`<`string`, `unknown`>> Defined in: [packages/sdk/src/client/client.ts:536](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L536) Get the CEL expression evaluation context for an assignment. #### Parameters[​](#parameters-305 "Direct link to Parameters") ##### wid[​](#wid-245 "Direct link to wid") `string` ##### assignmentId[​](#assignmentid-1 "Direct link to assignmentId") `number` #### Returns[​](#returns-304 "Direct link to Returns") `Promise`<`Record`<`string`, `unknown`>> #### Implementation of[​](#implementation-of-303 "Direct link to Implementation of") `AuthBindings.getAssignmentCelContext` *** ### getAssignmentMessages()[​](#getassignmentmessages "Direct link to getAssignmentMessages()") > **getAssignmentMessages**: (`wid`, `id`) => `Promise`<[`ChatMessage`](https://docs.gravityrail.com/sdk/interfaces/ChatMessage.md)\[]> Defined in: [packages/sdk/src/client/client.ts:529](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L529) Get all chat messages for an assignment. #### Parameters[​](#parameters-306 "Direct link to Parameters") ##### wid[​](#wid-246 "Direct link to wid") `string` ##### id[​](#id-38 "Direct link to id") `number` #### Returns[​](#returns-305 "Direct link to Returns") `Promise`<[`ChatMessage`](https://docs.gravityrail.com/sdk/interfaces/ChatMessage.md)\[]> #### Implementation of[​](#implementation-of-304 "Direct link to Implementation of") `AuthBindings.getAssignmentMessages` *** ### getAssignments()[​](#getassignments "Direct link to getAssignments()") > **getAssignments**: (`wid`, `options`) => `Promise`<[`PaginatedResponse`](https://docs.gravityrail.com/sdk/interfaces/PaginatedResponse.md)<[`AssignmentResponse`](https://docs.gravityrail.com/sdk/interfaces/AssignmentResponse.md)>> Defined in: [packages/sdk/src/client/client.ts:527](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L527) List assignments with optional filtering, pagination, and sorting. #### Parameters[​](#parameters-307 "Direct link to Parameters") ##### wid[​](#wid-247 "Direct link to wid") `string` ##### options?[​](#options-7 "Direct link to options?") [`AssignmentsQueryParams`](https://docs.gravityrail.com/sdk/interfaces/AssignmentsQueryParams.md) = `{}` #### Returns[​](#returns-306 "Direct link to Returns") `Promise`<[`PaginatedResponse`](https://docs.gravityrail.com/sdk/interfaces/PaginatedResponse.md)<[`AssignmentResponse`](https://docs.gravityrail.com/sdk/interfaces/AssignmentResponse.md)>> #### Implementation of[​](#implementation-of-305 "Direct link to Implementation of") `AuthBindings.getAssignments` *** ### getAssignmentTask()[​](#getassignmenttask "Direct link to getAssignmentTask()") > **getAssignmentTask**: (`wid`, `id`, `assignmentTaskId`) => `Promise`<[`AssignmentTaskResponse`](https://docs.gravityrail.com/sdk/interfaces/AssignmentTaskResponse.md)> Defined in: [packages/sdk/src/client/client.ts:532](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L532) Get a specific task within an assignment. #### Parameters[​](#parameters-308 "Direct link to Parameters") ##### wid[​](#wid-248 "Direct link to wid") `string` ##### id[​](#id-39 "Direct link to id") `number` ##### assignmentTaskId[​](#assignmenttaskid "Direct link to assignmentTaskId") `number` #### Returns[​](#returns-307 "Direct link to Returns") `Promise`<[`AssignmentTaskResponse`](https://docs.gravityrail.com/sdk/interfaces/AssignmentTaskResponse.md)> #### Implementation of[​](#implementation-of-306 "Direct link to Implementation of") `AuthBindings.getAssignmentTask` *** ### getAssignmentTaskDetail()[​](#getassignmenttaskdetail "Direct link to getAssignmentTaskDetail()") > **getAssignmentTaskDetail**: (`wid`, `assignmentId`) => `Promise`<[`OperatorTaskDetailResponse`](https://docs.gravityrail.com/sdk/interfaces/OperatorTaskDetailResponse.md)> Defined in: [packages/sdk/src/client/client.ts:535](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L535) Get the current task detail for an assignment from the operator perspective. #### Parameters[​](#parameters-309 "Direct link to Parameters") ##### wid[​](#wid-249 "Direct link to wid") `string` ##### assignmentId[​](#assignmentid-2 "Direct link to assignmentId") `number` #### Returns[​](#returns-308 "Direct link to Returns") `Promise`<[`OperatorTaskDetailResponse`](https://docs.gravityrail.com/sdk/interfaces/OperatorTaskDetailResponse.md)> #### Implementation of[​](#implementation-of-307 "Direct link to Implementation of") `AuthBindings.getAssignmentTaskDetail` *** ### getAssignmentTools()[​](#getassignmenttools "Direct link to getAssignmentTools()") > **getAssignmentTools**: (`wid`, `assignmentId`) => `Promise`<[`ToolsResponse`](https://docs.gravityrail.com/sdk/interfaces/ToolsResponse.md)> Defined in: [packages/sdk/src/client/client.ts:538](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L538) List available tools for an assignment. #### Parameters[​](#parameters-310 "Direct link to Parameters") ##### wid[​](#wid-250 "Direct link to wid") `string` ##### assignmentId[​](#assignmentid-3 "Direct link to assignmentId") `number` #### Returns[​](#returns-309 "Direct link to Returns") `Promise`<[`ToolsResponse`](https://docs.gravityrail.com/sdk/interfaces/ToolsResponse.md)> #### Implementation of[​](#implementation-of-308 "Direct link to Implementation of") `AuthBindings.getAssignmentTools` *** ### getAvailableActions()[​](#getavailableactions "Direct link to getAvailableActions()") > **getAvailableActions**: (`wid`) => `Promise`<[`EventActionMappingsResponse`](https://docs.gravityrail.com/sdk/interfaces/EventActionMappingsResponse.md)> Defined in: [packages/sdk/src/client/client.ts:624](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L624) Get the available action types that can be used in event rules. #### Parameters[​](#parameters-311 "Direct link to Parameters") ##### wid[​](#wid-251 "Direct link to wid") `string` #### Returns[​](#returns-310 "Direct link to Returns") `Promise`<[`EventActionMappingsResponse`](https://docs.gravityrail.com/sdk/interfaces/EventActionMappingsResponse.md)> #### Implementation of[​](#implementation-of-309 "Direct link to Implementation of") `EventsBindings.getAvailableActions` *** ### getAvailablePhoneNumbers()[​](#getavailablephonenumbers "Direct link to getAvailablePhoneNumbers()") > **getAvailablePhoneNumbers**: (`wid`) => `Promise`<`object`\[]> Defined in: [packages/sdk/src/client/client.ts:732](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L732) List phone numbers available for provisioning. #### Parameters[​](#parameters-312 "Direct link to Parameters") ##### wid[​](#wid-252 "Direct link to wid") `string` #### Returns[​](#returns-311 "Direct link to Returns") `Promise`<`object`\[]> #### Implementation of[​](#implementation-of-310 "Direct link to Implementation of") `CommunicationsBindings.getAvailablePhoneNumbers` *** ### getAvailableScopes()[​](#getavailablescopes "Direct link to getAvailableScopes()") > **getAvailableScopes**: () => `Promise`<[`ScopesListResponse`](https://docs.gravityrail.com/sdk/interfaces/ScopesListResponse.md)> Defined in: [packages/sdk/src/client/client.ts:850](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L850) #### Returns[​](#returns-312 "Direct link to Returns") `Promise`<[`ScopesListResponse`](https://docs.gravityrail.com/sdk/interfaces/ScopesListResponse.md)> #### Implementation of[​](#implementation-of-311 "Direct link to Implementation of") `AppsBindings.getAvailableScopes` *** ### getAvailableSlots()[​](#getavailableslots "Direct link to getAvailableSlots()") > **getAvailableSlots**: (`wid`, `calendarId`, `request`) => `Promise`<[`AvailableSlotsResponse`](https://docs.gravityrail.com/sdk/interfaces/AvailableSlotsResponse.md)> Defined in: [packages/sdk/src/client/client.ts:703](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L703) Get available booking slots for a calendar within a date range. #### Parameters[​](#parameters-313 "Direct link to Parameters") ##### wid[​](#wid-253 "Direct link to wid") `string` ##### calendarId[​](#calendarid-4 "Direct link to calendarId") `number` ##### request[​](#request-9 "Direct link to request") [`AvailableSlotsRequest`](https://docs.gravityrail.com/sdk/interfaces/AvailableSlotsRequest.md) #### Returns[​](#returns-313 "Direct link to Returns") `Promise`<[`AvailableSlotsResponse`](https://docs.gravityrail.com/sdk/interfaces/AvailableSlotsResponse.md)> #### Implementation of[​](#implementation-of-312 "Direct link to Implementation of") `CalendarsBindings.getAvailableSlots` *** ### getAvailableWorkspaceFeatures()[​](#getavailableworkspacefeatures "Direct link to getAvailableWorkspaceFeatures()") > **getAvailableWorkspaceFeatures**: () => `Promise`<[`WorkspaceFeatureInfo`](https://docs.gravityrail.com/sdk/interfaces/WorkspaceFeatureInfo.md)\[]> Defined in: [packages/sdk/src/client/client.ts:413](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L413) List all available workspace feature flags from the registry. #### Returns[​](#returns-314 "Direct link to Returns") `Promise`<[`WorkspaceFeatureInfo`](https://docs.gravityrail.com/sdk/interfaces/WorkspaceFeatureInfo.md)\[]> #### Implementation of[​](#implementation-of-313 "Direct link to Implementation of") `WorkspacesBindings.getAvailableWorkspaceFeatures` *** ### getBuilder()[​](#getbuilder "Direct link to getBuilder()") > **getBuilder**: (`builderId`) => `Promise`<[`BuilderResponse`](https://docs.gravityrail.com/sdk/interfaces/BuilderResponse.md)> Defined in: [packages/sdk/src/client/client.ts:836](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L836) Get a specific builder by UUID #### Parameters[​](#parameters-314 "Direct link to Parameters") ##### builderId[​](#builderid-2 "Direct link to builderId") `string` #### Returns[​](#returns-315 "Direct link to Returns") `Promise`<[`BuilderResponse`](https://docs.gravityrail.com/sdk/interfaces/BuilderResponse.md)> #### Implementation of[​](#implementation-of-314 "Direct link to Implementation of") `AppsBindings.getBuilder` *** ### getBuilderApps()[​](#getbuilderapps "Direct link to getBuilderApps()") > **getBuilderApps**: (`builderId`) => `Promise`<[`AppListResponse`](https://docs.gravityrail.com/sdk/type-aliases/AppListResponse.md)> Defined in: [packages/sdk/src/client/client.ts:837](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L837) Get apps for a specific builder #### Parameters[​](#parameters-315 "Direct link to Parameters") ##### builderId[​](#builderid-3 "Direct link to builderId") `string` #### Returns[​](#returns-316 "Direct link to Returns") `Promise`<[`AppListResponse`](https://docs.gravityrail.com/sdk/type-aliases/AppListResponse.md)> #### Implementation of[​](#implementation-of-315 "Direct link to Implementation of") `AppsBindings.getBuilderApps` *** ### getBusinessHoursStatus()[​](#getbusinesshoursstatus "Direct link to getBusinessHoursStatus()") > **getBusinessHoursStatus**: (`wid`) => `Promise`<{ `isBusinessHours`: `boolean`; }> Defined in: [packages/sdk/src/client/client.ts:412](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L412) Check whether the workspace is currently within business hours. #### Parameters[​](#parameters-316 "Direct link to Parameters") ##### wid[​](#wid-254 "Direct link to wid") `string` #### Returns[​](#returns-317 "Direct link to Returns") `Promise`<{ `isBusinessHours`: `boolean`; }> #### Implementation of[​](#implementation-of-316 "Direct link to Implementation of") `WorkspacesBindings.getBusinessHoursStatus` *** ### getBusinessProfile()[​](#getbusinessprofile "Direct link to getBusinessProfile()") > **getBusinessProfile**: (`orgUuid`) => `Promise`<[`BusinessProfile`](https://docs.gravityrail.com/sdk/type-aliases/BusinessProfile.md)> Defined in: [packages/sdk/src/client/client.ts:461](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L461) 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[​](#parameters-317 "Direct link to Parameters") ##### orgUuid[​](#orguuid-6 "Direct link to orgUuid") `string` #### Returns[​](#returns-318 "Direct link to Returns") `Promise`<[`BusinessProfile`](https://docs.gravityrail.com/sdk/type-aliases/BusinessProfile.md)> #### Implementation of[​](#implementation-of-317 "Direct link to Implementation of") `OrgBindings.getBusinessProfile` *** ### getCalendar()[​](#getcalendar "Direct link to getCalendar()") > **getCalendar**: (`wid`, `id`, `includeSchedules?`) => `Promise`<[`Calendar`](https://docs.gravityrail.com/sdk/type-aliases/Calendar.md)> Defined in: [packages/sdk/src/client/client.ts:694](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L694) Get a single calendar by ID, optionally including its schedules. #### Parameters[​](#parameters-318 "Direct link to Parameters") ##### wid[​](#wid-255 "Direct link to wid") `string` ##### id[​](#id-40 "Direct link to id") `number` ##### includeSchedules?[​](#includeschedules "Direct link to includeSchedules?") `boolean` #### Returns[​](#returns-319 "Direct link to Returns") `Promise`<[`Calendar`](https://docs.gravityrail.com/sdk/type-aliases/Calendar.md)> #### Implementation of[​](#implementation-of-318 "Direct link to Implementation of") `CalendarsBindings.getCalendar` *** ### getCalendarEvent()[​](#getcalendarevent "Direct link to getCalendarEvent()") > **getCalendarEvent**: (`wid`, `eventId`) => `Promise`<[`EventResponse`](https://docs.gravityrail.com/sdk/interfaces/EventResponse.md)> Defined in: [packages/sdk/src/client/client.ts:705](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L705) Get a single calendar event by ID. #### Parameters[​](#parameters-319 "Direct link to Parameters") ##### wid[​](#wid-256 "Direct link to wid") `string` ##### eventId[​](#eventid-2 "Direct link to eventId") `number` #### Returns[​](#returns-320 "Direct link to Returns") `Promise`<[`EventResponse`](https://docs.gravityrail.com/sdk/interfaces/EventResponse.md)> #### Implementation of[​](#implementation-of-319 "Direct link to Implementation of") `CalendarsBindings.getCalendarEvent` *** ### getCalendarEvents()[​](#getcalendarevents "Direct link to getCalendarEvents()") > **getCalendarEvents**: (`wid`, `options`) => `Promise`<[`PaginatedResponse`](https://docs.gravityrail.com/sdk/interfaces/PaginatedResponse.md)<[`EventResponse`](https://docs.gravityrail.com/sdk/interfaces/EventResponse.md)>> Defined in: [packages/sdk/src/client/client.ts:704](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L704) List calendar events with optional filtering by date range, status, and member. #### Parameters[​](#parameters-320 "Direct link to Parameters") ##### wid[​](#wid-257 "Direct link to wid") `string` ##### options?[​](#options-8 "Direct link to options?") [`CalendarEventsQueryParams`](https://docs.gravityrail.com/sdk/interfaces/CalendarEventsQueryParams.md) = `{}` #### Returns[​](#returns-321 "Direct link to Returns") `Promise`<[`PaginatedResponse`](https://docs.gravityrail.com/sdk/interfaces/PaginatedResponse.md)<[`EventResponse`](https://docs.gravityrail.com/sdk/interfaces/EventResponse.md)>> #### Implementation of[​](#implementation-of-320 "Direct link to Implementation of") `CalendarsBindings.getCalendarEvents` *** ### getCalendarEventType()[​](#getcalendareventtype "Direct link to getCalendarEventType()") > **getCalendarEventType**: (`wid`, `id`) => `Promise`<[`EventTypeResponse`](https://docs.gravityrail.com/sdk/interfaces/EventTypeResponse.md)> Defined in: [packages/sdk/src/client/client.ts:712](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L712) Get a single calendar event type by ID. #### Parameters[​](#parameters-321 "Direct link to Parameters") ##### wid[​](#wid-258 "Direct link to wid") `string` ##### id[​](#id-41 "Direct link to id") `number` #### Returns[​](#returns-322 "Direct link to Returns") `Promise`<[`EventTypeResponse`](https://docs.gravityrail.com/sdk/interfaces/EventTypeResponse.md)> #### Implementation of[​](#implementation-of-321 "Direct link to Implementation of") `CalendarsBindings.getCalendarEventType` *** ### getCalendarEventTypes()[​](#getcalendareventtypes "Direct link to getCalendarEventTypes()") > **getCalendarEventTypes**: (`wid`) => `Promise`<[`PaginatedResponse`](https://docs.gravityrail.com/sdk/interfaces/PaginatedResponse.md)<[`EventTypeResponse`](https://docs.gravityrail.com/sdk/interfaces/EventTypeResponse.md)>> Defined in: [packages/sdk/src/client/client.ts:711](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L711) List all calendar event types in the workspace. #### Parameters[​](#parameters-322 "Direct link to Parameters") ##### wid[​](#wid-259 "Direct link to wid") `string` #### Returns[​](#returns-323 "Direct link to Returns") `Promise`<[`PaginatedResponse`](https://docs.gravityrail.com/sdk/interfaces/PaginatedResponse.md)<[`EventTypeResponse`](https://docs.gravityrail.com/sdk/interfaces/EventTypeResponse.md)>> #### Implementation of[​](#implementation-of-322 "Direct link to Implementation of") `CalendarsBindings.getCalendarEventTypes` *** ### getCalendars()[​](#getcalendars "Direct link to getCalendars()") > **getCalendars**: (`wid`, `params?`) => `Promise`<[`PaginatedResponse`](https://docs.gravityrail.com/sdk/interfaces/PaginatedResponse.md)<[`Calendar`](https://docs.gravityrail.com/sdk/type-aliases/Calendar.md)>> Defined in: [packages/sdk/src/client/client.ts:693](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L693) List calendars in a workspace with optional pagination. #### Parameters[​](#parameters-323 "Direct link to Parameters") ##### wid[​](#wid-260 "Direct link to wid") `string` ##### params?[​](#params-6 "Direct link to params?") ###### includeSchedules?[​](#includeschedules-1 "Direct link to includeSchedules?") `boolean` ###### page?[​](#page-5 "Direct link to page?") `number` ###### pageSize?[​](#pagesize-4 "Direct link to pageSize?") `number` #### Returns[​](#returns-324 "Direct link to Returns") `Promise`<[`PaginatedResponse`](https://docs.gravityrail.com/sdk/interfaces/PaginatedResponse.md)<[`Calendar`](https://docs.gravityrail.com/sdk/type-aliases/Calendar.md)>> #### Implementation of[​](#implementation-of-323 "Direct link to Implementation of") `CalendarsBindings.getCalendars` *** ### getCalendarSchedules()[​](#getcalendarschedules "Direct link to getCalendarSchedules()") > **getCalendarSchedules**: (`wid`, `calendarId`) => `Promise`<[`CalendarSchedule`](https://docs.gravityrail.com/sdk/type-aliases/CalendarSchedule.md)\[]> Defined in: [packages/sdk/src/client/client.ts:698](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L698) List all schedules for a calendar. #### Parameters[​](#parameters-324 "Direct link to Parameters") ##### wid[​](#wid-261 "Direct link to wid") `string` ##### calendarId[​](#calendarid-5 "Direct link to calendarId") `number` #### Returns[​](#returns-325 "Direct link to Returns") `Promise`<[`CalendarSchedule`](https://docs.gravityrail.com/sdk/type-aliases/CalendarSchedule.md)\[]> #### Implementation of[​](#implementation-of-324 "Direct link to Implementation of") `CalendarsBindings.getCalendarSchedules` *** ### getCallRecordingDownloadUrl()[​](#getcallrecordingdownloadurl "Direct link to getCallRecordingDownloadUrl()") > **getCallRecordingDownloadUrl**: (`wid`, `chatId`, `options`) => `Promise`<`CallRecordingDownloadUrlResponse`> Defined in: [packages/sdk/src/client/client.ts:192](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L192) 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[​](#parameters-325 "Direct link to Parameters") ##### wid[​](#wid-262 "Direct link to wid") `string` ##### chatId[​](#chatid-3 "Direct link to chatId") `number` ##### options?[​](#options-9 "Direct link to options?") ###### expiresIn?[​](#expiresin "Direct link to expiresIn?") `number` #### Returns[​](#returns-326 "Direct link to Returns") `Promise`<`CallRecordingDownloadUrlResponse`> #### Implementation of[​](#implementation-of-325 "Direct link to Implementation of") `CallsBindings.getCallRecordingDownloadUrl` *** ### getCelContext()[​](#getcelcontext "Direct link to getCelContext()") > **getCelContext**: (`wid`, `request`) => `Promise`<[`CELContextResponse`](https://docs.gravityrail.com/sdk/interfaces/CELContextResponse.md)> Defined in: [packages/sdk/src/client/client.ts:193](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L193) 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[​](#parameters-326 "Direct link to Parameters") ##### wid[​](#wid-263 "Direct link to wid") `string` ##### request[​](#request-10 "Direct link to request") [`CELContextRequest`](https://docs.gravityrail.com/sdk/interfaces/CELContextRequest.md) #### Returns[​](#returns-327 "Direct link to Returns") `Promise`<[`CELContextResponse`](https://docs.gravityrail.com/sdk/interfaces/CELContextResponse.md)> #### Implementation of[​](#implementation-of-326 "Direct link to Implementation of") `CallsBindings.getCelContext` *** ### getChat()[​](#getchat "Direct link to getChat()") > **getChat**: (`wid`, `id`) => `Promise`<[`ChatResponse`](https://docs.gravityrail.com/sdk/interfaces/ChatResponse.md)> Defined in: [packages/sdk/src/client/client.ts:141](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L141) Get a single chat by ID. #### Parameters[​](#parameters-327 "Direct link to Parameters") ##### wid[​](#wid-264 "Direct link to wid") `string` ##### id[​](#id-42 "Direct link to id") `number` #### Returns[​](#returns-328 "Direct link to Returns") `Promise`<[`ChatResponse`](https://docs.gravityrail.com/sdk/interfaces/ChatResponse.md)> #### Implementation of[​](#implementation-of-327 "Direct link to Implementation of") `ChatsBindings.getChat` *** ### getChatAssignmentTasks()[​](#getchatassignmenttasks "Direct link to getChatAssignmentTasks()") > **getChatAssignmentTasks**: (`wid`, `chatId`) => `Promise`<`object`\[]> Defined in: [packages/sdk/src/client/client.ts:165](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L165) Get assignment tasks linked to a chat. #### Parameters[​](#parameters-328 "Direct link to Parameters") ##### wid[​](#wid-265 "Direct link to wid") `string` ##### chatId[​](#chatid-4 "Direct link to chatId") `number` #### Returns[​](#returns-329 "Direct link to Returns") `Promise`<`object`\[]> #### Implementation of[​](#implementation-of-328 "Direct link to Implementation of") `ChatsBindings.getChatAssignmentTasks` *** ### getChatCallbacks()[​](#getchatcallbacks "Direct link to getChatCallbacks()") > **getChatCallbacks**: (`wid`, `chatId`) => `Promise`<[`ScheduledCallbackListResponse`](https://docs.gravityrail.com/sdk/interfaces/ScheduledCallbackListResponse.md)> Defined in: [packages/sdk/src/client/client.ts:142](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L142) List scheduled callbacks for a chat (newest first). #### Parameters[​](#parameters-329 "Direct link to Parameters") ##### wid[​](#wid-266 "Direct link to wid") `string` ##### chatId[​](#chatid-5 "Direct link to chatId") `number` #### Returns[​](#returns-330 "Direct link to Returns") `Promise`<[`ScheduledCallbackListResponse`](https://docs.gravityrail.com/sdk/interfaces/ScheduledCallbackListResponse.md)> #### Implementation of[​](#implementation-of-329 "Direct link to Implementation of") `ChatsBindings.getChatCallbacks` *** ### getChatEmails()[​](#getchatemails "Direct link to getChatEmails()") > **getChatEmails**: (`wid`, `inboxId`, `chatId`, `options`) => `Promise`<`ChatEmailsResponse`> Defined in: [packages/sdk/src/client/client.ts:760](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L760) List emails associated with a chat with pagination. #### Parameters[​](#parameters-330 "Direct link to Parameters") ##### wid[​](#wid-267 "Direct link to wid") `string` ##### inboxId[​](#inboxid-2 "Direct link to inboxId") `number` ##### chatId[​](#chatid-6 "Direct link to chatId") `number` ##### options?[​](#options-10 "Direct link to options?") ###### includeAttachments?[​](#includeattachments "Direct link to includeAttachments?") `boolean` ###### page?[​](#page-6 "Direct link to page?") `number` ###### pageSize?[​](#pagesize-5 "Direct link to pageSize?") `number` #### Returns[​](#returns-331 "Direct link to Returns") `Promise`<`ChatEmailsResponse`> #### Implementation of[​](#implementation-of-330 "Direct link to Implementation of") `CommunicationsBindings.getChatEmails` *** ### getChatFilter()[​](#getchatfilter "Direct link to getChatFilter()") > **getChatFilter**: (`wid`, `id`) => `Promise`<[`ChatFilterResponse`](https://docs.gravityrail.com/sdk/interfaces/ChatFilterResponse.md)> Defined in: [packages/sdk/src/client/client.ts:179](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L179) Get a chat filter by ID. #### Parameters[​](#parameters-331 "Direct link to Parameters") ##### wid[​](#wid-268 "Direct link to wid") `string` ##### id[​](#id-43 "Direct link to id") `number` #### Returns[​](#returns-332 "Direct link to Returns") `Promise`<[`ChatFilterResponse`](https://docs.gravityrail.com/sdk/interfaces/ChatFilterResponse.md)> #### Implementation of[​](#implementation-of-331 "Direct link to Implementation of") `ChatsBindings.getChatFilter` *** ### getChatFilterByUuid()[​](#getchatfilterbyuuid "Direct link to getChatFilterByUuid()") > **getChatFilterByUuid**: (`wid`, `uuid`) => `Promise`<[`ChatFilterResponse`](https://docs.gravityrail.com/sdk/interfaces/ChatFilterResponse.md)> Defined in: [packages/sdk/src/client/client.ts:180](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L180) Get a chat filter by UUID. #### Parameters[​](#parameters-332 "Direct link to Parameters") ##### wid[​](#wid-269 "Direct link to wid") `string` ##### uuid[​](#uuid-9 "Direct link to uuid") `string` #### Returns[​](#returns-333 "Direct link to Returns") `Promise`<[`ChatFilterResponse`](https://docs.gravityrail.com/sdk/interfaces/ChatFilterResponse.md)> #### Implementation of[​](#implementation-of-332 "Direct link to Implementation of") `ChatsBindings.getChatFilterByUuid` *** ### getChatFilterCount()[​](#getchatfiltercount "Direct link to getChatFilterCount()") > **getChatFilterCount**: (`wid`, `filterId`) => `Promise`<{ `count`: `number`; }> Defined in: [packages/sdk/src/client/client.ts:184](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L184) Get the count of chats matching a saved filter. #### Parameters[​](#parameters-333 "Direct link to Parameters") ##### wid[​](#wid-270 "Direct link to wid") `string` ##### filterId[​](#filterid-2 "Direct link to filterId") `number` #### Returns[​](#returns-334 "Direct link to Returns") `Promise`<{ `count`: `number`; }> #### Implementation of[​](#implementation-of-333 "Direct link to Implementation of") `ChatsBindings.getChatFilterCount` *** ### getChatFilters()[​](#getchatfilters "Direct link to getChatFilters()") > **getChatFilters**: (`wid`) => `Promise`<[`ChatFilterResponse`](https://docs.gravityrail.com/sdk/interfaces/ChatFilterResponse.md)\[]> Defined in: [packages/sdk/src/client/client.ts:178](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L178) List all chat filters in a workspace. #### Parameters[​](#parameters-334 "Direct link to Parameters") ##### wid[​](#wid-271 "Direct link to wid") `string` #### Returns[​](#returns-335 "Direct link to Returns") `Promise`<[`ChatFilterResponse`](https://docs.gravityrail.com/sdk/interfaces/ChatFilterResponse.md)\[]> #### Implementation of[​](#implementation-of-334 "Direct link to Implementation of") `ChatsBindings.getChatFilters` *** ### getChatLabel()[​](#getchatlabel "Direct link to getChatLabel()") > **getChatLabel**: (`wid`, `id`) => `Promise`<[`ChatLabelResponse`](https://docs.gravityrail.com/sdk/interfaces/ChatLabelResponse.md)> Defined in: [packages/sdk/src/client/client.ts:173](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L173) Get a chat label by ID. #### Parameters[​](#parameters-335 "Direct link to Parameters") ##### wid[​](#wid-272 "Direct link to wid") `string` ##### id[​](#id-44 "Direct link to id") `number` #### Returns[​](#returns-336 "Direct link to Returns") `Promise`<[`ChatLabelResponse`](https://docs.gravityrail.com/sdk/interfaces/ChatLabelResponse.md)> #### Implementation of[​](#implementation-of-335 "Direct link to Implementation of") `ChatsBindings.getChatLabel` *** ### getChatLabelByUuid()[​](#getchatlabelbyuuid "Direct link to getChatLabelByUuid()") > **getChatLabelByUuid**: (`wid`, `uuid`) => `Promise`<[`ChatLabelResponse`](https://docs.gravityrail.com/sdk/interfaces/ChatLabelResponse.md)> Defined in: [packages/sdk/src/client/client.ts:174](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L174) Get a chat label by UUID. #### Parameters[​](#parameters-336 "Direct link to Parameters") ##### wid[​](#wid-273 "Direct link to wid") `string` ##### uuid[​](#uuid-10 "Direct link to uuid") `string` #### Returns[​](#returns-337 "Direct link to Returns") `Promise`<[`ChatLabelResponse`](https://docs.gravityrail.com/sdk/interfaces/ChatLabelResponse.md)> #### Implementation of[​](#implementation-of-336 "Direct link to Implementation of") `ChatsBindings.getChatLabelByUuid` *** ### getChatLabels()[​](#getchatlabels "Direct link to getChatLabels()") > **getChatLabels**: (`wid`) => `Promise`<[`ChatLabelResponse`](https://docs.gravityrail.com/sdk/interfaces/ChatLabelResponse.md)\[]> Defined in: [packages/sdk/src/client/client.ts:172](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L172) List all chat labels in a workspace. #### Parameters[​](#parameters-337 "Direct link to Parameters") ##### wid[​](#wid-274 "Direct link to wid") `string` #### Returns[​](#returns-338 "Direct link to Returns") `Promise`<[`ChatLabelResponse`](https://docs.gravityrail.com/sdk/interfaces/ChatLabelResponse.md)\[]> #### Implementation of[​](#implementation-of-337 "Direct link to Implementation of") `ChatsBindings.getChatLabels` *** ### getChatMessages()[​](#getchatmessages "Direct link to getChatMessages()") > **getChatMessages**: (`wid`, `id`, `limit?`, `offset?`) => `Promise`<[`ChatMessage`](https://docs.gravityrail.com/sdk/interfaces/ChatMessage.md)\[]> Defined in: [packages/sdk/src/client/client.ts:159](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L159) List messages in a chat with optional pagination. `id` is the numeric chat id (documented) or the chat uuid (accepted). #### Parameters[​](#parameters-338 "Direct link to Parameters") ##### wid[​](#wid-275 "Direct link to wid") `string` ##### id[​](#id-45 "Direct link to id") `string` | `number` ##### limit?[​](#limit-3 "Direct link to limit?") `number` ##### offset?[​](#offset "Direct link to offset?") `number` #### Returns[​](#returns-339 "Direct link to Returns") `Promise`<[`ChatMessage`](https://docs.gravityrail.com/sdk/interfaces/ChatMessage.md)\[]> #### Implementation of[​](#implementation-of-338 "Direct link to Implementation of") `ChatsBindings.getChatMessages` *** ### getChatModels()[​](#getchatmodels "Direct link to getChatModels()") > **getChatModels**: (`provider?`) => `Promise`<[`AIModelsResponse`](https://docs.gravityrail.com/sdk/interfaces/AIModelsResponse.md)> Defined in: [packages/sdk/src/client/client.ts:773](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L773) Get available chat AI models #### Parameters[​](#parameters-339 "Direct link to Parameters") ##### provider?[​](#provider-1 "Direct link to provider?") `string` #### Returns[​](#returns-340 "Direct link to Returns") `Promise`<[`AIModelsResponse`](https://docs.gravityrail.com/sdk/interfaces/AIModelsResponse.md)> #### Implementation of[​](#implementation-of-339 "Direct link to Implementation of") `ToolkitsBindings.getChatModels` *** ### getChatPhoneCalls()[​](#getchatphonecalls "Direct link to getChatPhoneCalls()") > **getChatPhoneCalls**: (`wid`, `chatId`) => `Promise`<[`PhoneCall`](https://docs.gravityrail.com/sdk/interfaces/PhoneCall.md)\[]> Defined in: [packages/sdk/src/client/client.ts:171](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L171) Get phone calls associated with a chat. #### Parameters[​](#parameters-340 "Direct link to Parameters") ##### wid[​](#wid-276 "Direct link to wid") `string` ##### chatId[​](#chatid-7 "Direct link to chatId") `number` #### Returns[​](#returns-341 "Direct link to Returns") `Promise`<[`PhoneCall`](https://docs.gravityrail.com/sdk/interfaces/PhoneCall.md)\[]> #### Implementation of[​](#implementation-of-340 "Direct link to Implementation of") `ChatsBindings.getChatPhoneCalls` *** ### getChats()[​](#getchats "Direct link to getChats()") > **getChats**: (`wid`, `options`) => `Promise`<[`PaginatedResponse`](https://docs.gravityrail.com/sdk/interfaces/PaginatedResponse.md)<[`ChatResponse`](https://docs.gravityrail.com/sdk/interfaces/ChatResponse.md)>> Defined in: [packages/sdk/src/client/client.ts:140](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L140) List chats with optional filtering, sorting, and pagination. #### Parameters[​](#parameters-341 "Direct link to Parameters") ##### wid[​](#wid-277 "Direct link to wid") `string` ##### options?[​](#options-11 "Direct link to options?") [`GetChatsOptions`](https://docs.gravityrail.com/sdk/interfaces/GetChatsOptions.md) = `{}` #### Returns[​](#returns-342 "Direct link to Returns") `Promise`<[`PaginatedResponse`](https://docs.gravityrail.com/sdk/interfaces/PaginatedResponse.md)<[`ChatResponse`](https://docs.gravityrail.com/sdk/interfaces/ChatResponse.md)>> #### Implementation of[​](#implementation-of-341 "Direct link to Implementation of") `ChatsBindings.getChats` *** ### getChatsDailyCreationStats()[​](#getchatsdailycreationstats "Direct link to getChatsDailyCreationStats()") > **getChatsDailyCreationStats**: (`wid`, `options?`) => `Promise`<{ `dailyStats`: `object`\[]; }> Defined in: [packages/sdk/src/client/client.ts:148](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L148) Get daily chat creation statistics with optional filtering. #### Parameters[​](#parameters-342 "Direct link to Parameters") ##### wid[​](#wid-278 "Direct link to wid") `string` ##### options?[​](#options-12 "Direct link to options?") ###### archived?[​](#archived "Direct link to archived?") `boolean` ###### isTest?[​](#istest "Direct link to isTest?") `boolean` #### Returns[​](#returns-343 "Direct link to Returns") `Promise`<{ `dailyStats`: `object`\[]; }> #### Implementation of[​](#implementation-of-342 "Direct link to Implementation of") `ChatsBindings.getChatsDailyCreationStats` *** ### getChatSkills()[​](#getchatskills "Direct link to getChatSkills()") > **getChatSkills**: (`wid`, `chatId`) => `Promise`<{ `loadedSkills`: `string`\[]; `revealedSkills`: `string`\[]; }> Defined in: [packages/sdk/src/client/client.ts:146](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L146) Get loaded and revealed skills for a chat. #### Parameters[​](#parameters-343 "Direct link to Parameters") ##### wid[​](#wid-279 "Direct link to wid") `string` ##### chatId[​](#chatid-8 "Direct link to chatId") `number` #### Returns[​](#returns-344 "Direct link to Returns") `Promise`<{ `loadedSkills`: `string`\[]; `revealedSkills`: `string`\[]; }> #### Implementation of[​](#implementation-of-343 "Direct link to Implementation of") `ChatsBindings.getChatSkills` *** ### getChatsNeedsResponse()[​](#getchatsneedsresponse "Direct link to getChatsNeedsResponse()") > **getChatsNeedsResponse**: (`wid`) => `Promise`<`number`\[]> Defined in: [packages/sdk/src/client/client.ts:147](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L147) List chat IDs that need a response. #### Parameters[​](#parameters-344 "Direct link to Parameters") ##### wid[​](#wid-280 "Direct link to wid") `string` #### Returns[​](#returns-345 "Direct link to Returns") `Promise`<`number`\[]> #### Implementation of[​](#implementation-of-344 "Direct link to Implementation of") `ChatsBindings.getChatsNeedsResponse` *** ### getChatTodos()[​](#getchattodos "Direct link to getChatTodos()") > **getChatTodos**: (`wid`, `chatId`) => `Promise`<{ `todos`: [`TodoItemResponse`](https://docs.gravityrail.com/sdk/interfaces/TodoItemResponse.md)\[]; }> Defined in: [packages/sdk/src/client/client.ts:145](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L145) Get todo items extracted from a chat. #### Parameters[​](#parameters-345 "Direct link to Parameters") ##### wid[​](#wid-281 "Direct link to wid") `string` ##### chatId[​](#chatid-9 "Direct link to chatId") `number` #### Returns[​](#returns-346 "Direct link to Returns") `Promise`<{ `todos`: [`TodoItemResponse`](https://docs.gravityrail.com/sdk/interfaces/TodoItemResponse.md)\[]; }> #### Implementation of[​](#implementation-of-345 "Direct link to Implementation of") `ChatsBindings.getChatTodos` *** ### getChatTokenUsage()[​](#getchattokenusage "Direct link to getChatTokenUsage()") > **getChatTokenUsage**: (`wid`, `chatId`) => `Promise`<[`ChatTokenUsageResponse`](https://docs.gravityrail.com/sdk/interfaces/ChatTokenUsageResponse.md)> Defined in: [packages/sdk/src/client/client.ts:144](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L144) Get token usage statistics for a chat. #### Parameters[​](#parameters-346 "Direct link to Parameters") ##### wid[​](#wid-282 "Direct link to wid") `string` ##### chatId[​](#chatid-10 "Direct link to chatId") `number` #### Returns[​](#returns-347 "Direct link to Returns") `Promise`<[`ChatTokenUsageResponse`](https://docs.gravityrail.com/sdk/interfaces/ChatTokenUsageResponse.md)> #### Implementation of[​](#implementation-of-346 "Direct link to Implementation of") `ChatsBindings.getChatTokenUsage` *** ### getChatToolCallMessages()[​](#getchattoolcallmessages "Direct link to getChatToolCallMessages()") > **getChatToolCallMessages**: (`wid`, `chatId`, `callId`, `limit`, `offset`) => `Promise`<[`ChatMessage`](https://docs.gravityrail.com/sdk/interfaces/ChatMessage.md)\[]> Defined in: [packages/sdk/src/client/client.ts:160](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L160) List messages associated with a specific tool call in a chat. #### Parameters[​](#parameters-347 "Direct link to Parameters") ##### wid[​](#wid-283 "Direct link to wid") `string` ##### chatId[​](#chatid-11 "Direct link to chatId") `number` ##### callId[​](#callid "Direct link to callId") `string` ##### limit?[​](#limit-4 "Direct link to limit?") `number` = `100` ##### offset?[​](#offset-1 "Direct link to offset?") `number` = `0` #### Returns[​](#returns-348 "Direct link to Returns") `Promise`<[`ChatMessage`](https://docs.gravityrail.com/sdk/interfaces/ChatMessage.md)\[]> #### Implementation of[​](#implementation-of-347 "Direct link to Implementation of") `ChatsBindings.getChatToolCallMessages` *** ### getChatTools()[​](#getchattools "Direct link to getChatTools()") > **getChatTools**: (`wid`, `chatId`) => `Promise`<[`ToolsResponse`](https://docs.gravityrail.com/sdk/interfaces/ToolsResponse.md)> Defined in: [packages/sdk/src/client/client.ts:161](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L161) Get the tools available in a chat. #### Parameters[​](#parameters-348 "Direct link to Parameters") ##### wid[​](#wid-284 "Direct link to wid") `string` ##### chatId[​](#chatid-12 "Direct link to chatId") `number` #### Returns[​](#returns-349 "Direct link to Returns") `Promise`<[`ToolsResponse`](https://docs.gravityrail.com/sdk/interfaces/ToolsResponse.md)> #### Implementation of[​](#implementation-of-348 "Direct link to Implementation of") `ChatsBindings.getChatTools` *** ### getClientWorkspace()[​](#getclientworkspace "Direct link to getClientWorkspace()") > **getClientWorkspace**: (`wid`, `workspaceId`) => `Promise`<[`ClientWorkspace`](https://docs.gravityrail.com/sdk/interfaces/ClientWorkspace.md)> Defined in: [packages/sdk/src/client/client.ts:423](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L423) Get a single client workspace by ID. #### Parameters[​](#parameters-349 "Direct link to Parameters") ##### wid[​](#wid-285 "Direct link to wid") `string` ##### workspaceId[​](#workspaceid-1 "Direct link to workspaceId") `number` #### Returns[​](#returns-350 "Direct link to Returns") `Promise`<[`ClientWorkspace`](https://docs.gravityrail.com/sdk/interfaces/ClientWorkspace.md)> #### Implementation of[​](#implementation-of-349 "Direct link to Implementation of") `WorkspacesBindings.getClientWorkspace` *** ### getConfluenceStatus()[​](#getconfluencestatus "Direct link to getConfluenceStatus()") > **getConfluenceStatus**: (`wid`) => `Promise`<`ConfluenceConnectionStatus`> Defined in: [packages/sdk/src/client/client.ts:974](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L974) #### Parameters[​](#parameters-350 "Direct link to Parameters") ##### wid[​](#wid-286 "Direct link to wid") `string` #### Returns[​](#returns-351 "Direct link to Returns") `Promise`<`ConfluenceConnectionStatus`> #### Implementation of[​](#implementation-of-350 "Direct link to Implementation of") `IntegrationsBindings.getConfluenceStatus` *** ### getConnectionSyncCapabilities()[​](#getconnectionsynccapabilities "Direct link to getConnectionSyncCapabilities()") > **getConnectionSyncCapabilities**: (`wid`, `connectionId`) => `Promise`<[`SyncCapabilities`](https://docs.gravityrail.com/sdk/interfaces/SyncCapabilities.md)> Defined in: [packages/sdk/src/client/client.ts:1022](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L1022) #### Parameters[​](#parameters-351 "Direct link to Parameters") ##### wid[​](#wid-287 "Direct link to wid") `string` ##### connectionId[​](#connectionid-26 "Direct link to connectionId") `number` #### Returns[​](#returns-352 "Direct link to Returns") `Promise`<[`SyncCapabilities`](https://docs.gravityrail.com/sdk/interfaces/SyncCapabilities.md)> #### Implementation of[​](#implementation-of-351 "Direct link to Implementation of") `IntegrationsBindings.getConnectionSyncCapabilities` *** ### getConnectionSyncCheckpoint()[​](#getconnectionsynccheckpoint "Direct link to getConnectionSyncCheckpoint()") > **getConnectionSyncCheckpoint**: (`wid`, `connectionId`, `direction`, `syncKey`) => `Promise`<[`SyncCheckpoint`](https://docs.gravityrail.com/sdk/interfaces/SyncCheckpoint.md)> Defined in: [packages/sdk/src/client/client.ts:1025](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L1025) #### Parameters[​](#parameters-352 "Direct link to Parameters") ##### wid[​](#wid-288 "Direct link to wid") `string` ##### connectionId[​](#connectionid-27 "Direct link to connectionId") `number` ##### direction?[​](#direction "Direct link to direction?") `SyncDirection` = `'inbound'` ##### syncKey?[​](#synckey "Direct link to syncKey?") `string` = `'default'` #### Returns[​](#returns-353 "Direct link to Returns") `Promise`<[`SyncCheckpoint`](https://docs.gravityrail.com/sdk/interfaces/SyncCheckpoint.md)> #### Implementation of[​](#implementation-of-352 "Direct link to Implementation of") `IntegrationsBindings.getConnectionSyncCheckpoint` *** ### getConnectionSyncConfig()[​](#getconnectionsyncconfig "Direct link to getConnectionSyncConfig()") > **getConnectionSyncConfig**: (`wid`, `connectionId`) => `Promise`<[`ConnectionSyncConfig`](https://docs.gravityrail.com/sdk/interfaces/ConnectionSyncConfig.md)> Defined in: [packages/sdk/src/client/client.ts:1023](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L1023) #### Parameters[​](#parameters-353 "Direct link to Parameters") ##### wid[​](#wid-289 "Direct link to wid") `string` ##### connectionId[​](#connectionid-28 "Direct link to connectionId") `number` #### Returns[​](#returns-354 "Direct link to Returns") `Promise`<[`ConnectionSyncConfig`](https://docs.gravityrail.com/sdk/interfaces/ConnectionSyncConfig.md)> #### Implementation of[​](#implementation-of-353 "Direct link to Implementation of") `IntegrationsBindings.getConnectionSyncConfig` *** ### getConsentState()[​](#getconsentstate "Direct link to getConsentState()") > **getConsentState**: () => `Promise`<`ConsentStateResponse`> Defined in: [packages/sdk/src/client/client.ts:525](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L525) Get current consent state for the authenticated account. #### Returns[​](#returns-355 "Direct link to Returns") `Promise`<`ConsentStateResponse`> #### Implementation of[​](#implementation-of-354 "Direct link to Implementation of") `AuthBindings.getConsentState` *** ### getCredentialChangeInviteDetails()[​](#getcredentialchangeinvitedetails "Direct link to getCredentialChangeInviteDetails()") > **getCredentialChangeInviteDetails**: (`token`) => `Promise`<[`CredentialChangeInviteDetails`](https://docs.gravityrail.com/sdk/interfaces/CredentialChangeInviteDetails.md)> Defined in: [packages/sdk/src/client/client.ts:523](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L523) Get details of a credential change invitation. The user must be logged in and be the target of the invitation. #### Parameters[​](#parameters-354 "Direct link to Parameters") ##### token[​](#token-2 "Direct link to token") `string` #### Returns[​](#returns-356 "Direct link to Returns") `Promise`<[`CredentialChangeInviteDetails`](https://docs.gravityrail.com/sdk/interfaces/CredentialChangeInviteDetails.md)> #### Implementation of[​](#implementation-of-355 "Direct link to Implementation of") `AuthBindings.getCredentialChangeInviteDetails` *** ### getCredentialUpdateInvites()[​](#getcredentialupdateinvites "Direct link to getCredentialUpdateInvites()") > **getCredentialUpdateInvites**: (`wid`, `memberId?`, `pageOpts?`) => `Promise`<[`PaginatedResponse`](https://docs.gravityrail.com/sdk/interfaces/PaginatedResponse.md)<[`PendingCredentialChangeInvite`](https://docs.gravityrail.com/sdk/interfaces/PendingCredentialChangeInvite.md)>> Defined in: [packages/sdk/src/client/client.ts:265](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L265) List pending credential update invitations for the workspace, paginated. Admin-only. Optionally filter by member. #### Parameters[​](#parameters-355 "Direct link to Parameters") ##### wid[​](#wid-290 "Direct link to wid") `string` ##### memberId?[​](#memberid-14 "Direct link to memberId?") `number` ##### pageOpts?[​](#pageopts "Direct link to pageOpts?") ###### page?[​](#page-7 "Direct link to page?") `number` ###### pageSize?[​](#pagesize-6 "Direct link to pageSize?") `number` #### Returns[​](#returns-357 "Direct link to Returns") `Promise`<[`PaginatedResponse`](https://docs.gravityrail.com/sdk/interfaces/PaginatedResponse.md)<[`PendingCredentialChangeInvite`](https://docs.gravityrail.com/sdk/interfaces/PendingCredentialChangeInvite.md)>> #### Implementation of[​](#implementation-of-356 "Direct link to Implementation of") `MembersBindings.getCredentialUpdateInvites` *** ### getCurrentMember()[​](#getcurrentmember "Direct link to getCurrentMember()") > **getCurrentMember**: (`wid`) => `Promise`<[`CurrentMemberResponse`](https://docs.gravityrail.com/sdk/interfaces/CurrentMemberResponse.md)> Defined in: [packages/sdk/src/client/client.ts:219](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L219) Get the currently authenticated member for a workspace. #### Parameters[​](#parameters-356 "Direct link to Parameters") ##### wid[​](#wid-291 "Direct link to wid") `string` #### Returns[​](#returns-358 "Direct link to Returns") `Promise`<[`CurrentMemberResponse`](https://docs.gravityrail.com/sdk/interfaces/CurrentMemberResponse.md)> #### Implementation of[​](#implementation-of-357 "Direct link to Implementation of") `MembersBindings.getCurrentMember` *** ### getCustomToolkit()[​](#getcustomtoolkit "Direct link to getCustomToolkit()") > **getCustomToolkit**: (`wid`, `toolkitId`) => `Promise`<[`CustomToolkit`](https://docs.gravityrail.com/sdk/type-aliases/CustomToolkit.md)> Defined in: [packages/sdk/src/client/client.ts:780](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L780) Get a specific custom toolkit #### Parameters[​](#parameters-357 "Direct link to Parameters") ##### wid[​](#wid-292 "Direct link to wid") `string` ##### toolkitId[​](#toolkitid-5 "Direct link to toolkitId") `number` #### Returns[​](#returns-359 "Direct link to Returns") `Promise`<[`CustomToolkit`](https://docs.gravityrail.com/sdk/type-aliases/CustomToolkit.md)> #### Implementation of[​](#implementation-of-358 "Direct link to Implementation of") `ToolkitsBindings.getCustomToolkit` *** ### getCustomToolkits()[​](#getcustomtoolkits "Direct link to getCustomToolkits()") > **getCustomToolkits**: (`wid`) => `Promise`<[`CustomToolkit`](https://docs.gravityrail.com/sdk/type-aliases/CustomToolkit.md)\[]> Defined in: [packages/sdk/src/client/client.ts:779](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L779) List all custom toolkits in a workspace #### Parameters[​](#parameters-358 "Direct link to Parameters") ##### wid[​](#wid-293 "Direct link to wid") `string` #### Returns[​](#returns-360 "Direct link to Returns") `Promise`<[`CustomToolkit`](https://docs.gravityrail.com/sdk/type-aliases/CustomToolkit.md)\[]> #### Implementation of[​](#implementation-of-359 "Direct link to Implementation of") `ToolkitsBindings.getCustomToolkits` *** ### getDataRecord()[​](#getdatarecord "Direct link to getDataRecord()") > **getDataRecord**: (`wid`, `recordId`) => `Promise`<[`DataRecordResponse`](https://docs.gravityrail.com/sdk/interfaces/DataRecordResponse.md)> Defined in: [packages/sdk/src/client/client.ts:207](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L207) Get a single data record by ID. #### Parameters[​](#parameters-359 "Direct link to Parameters") ##### wid[​](#wid-294 "Direct link to wid") `string` ##### recordId[​](#recordid-1 "Direct link to recordId") `number` #### Returns[​](#returns-361 "Direct link to Returns") `Promise`<[`DataRecordResponse`](https://docs.gravityrail.com/sdk/interfaces/DataRecordResponse.md)> #### Implementation of[​](#implementation-of-360 "Direct link to Implementation of") `DataTypesBindings.getDataRecord` *** ### getDataRecordChanges()[​](#getdatarecordchanges "Direct link to getDataRecordChanges()") > **getDataRecordChanges**: (`wid`, `dataTypeId`, `recordId`) => `Promise`<[`DataRecordUpdateResponse`](https://docs.gravityrail.com/sdk/interfaces/DataRecordUpdateResponse.md)\[]> Defined in: [packages/sdk/src/client/client.ts:211](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L211) Get the change history for a data record. #### Parameters[​](#parameters-360 "Direct link to Parameters") ##### wid[​](#wid-295 "Direct link to wid") `string` ##### dataTypeId[​](#datatypeid-2 "Direct link to dataTypeId") `number` ##### recordId[​](#recordid-2 "Direct link to recordId") `number` #### Returns[​](#returns-362 "Direct link to Returns") `Promise`<[`DataRecordUpdateResponse`](https://docs.gravityrail.com/sdk/interfaces/DataRecordUpdateResponse.md)\[]> #### Implementation of[​](#implementation-of-361 "Direct link to Implementation of") `DataTypesBindings.getDataRecordChanges` *** ### getDataRecords()[​](#getdatarecords "Direct link to getDataRecords()") > **getDataRecords**: (`wid`, `dataTypeId`, `options?`) => `Promise`<[`DataRecordsPaginatedResponse`](https://docs.gravityrail.com/sdk/interfaces/DataRecordsPaginatedResponse.md)> Defined in: [packages/sdk/src/client/client.ts:206](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L206) List data records for a data type with optional filtering and pagination. #### Parameters[​](#parameters-361 "Direct link to Parameters") ##### wid[​](#wid-296 "Direct link to wid") `string` ##### dataTypeId[​](#datatypeid-3 "Direct link to dataTypeId") `number` ##### options?[​](#options-13 "Direct link to options?") ###### memberId?[​](#memberid-15 "Direct link to memberId?") `number` ###### memberIds?[​](#memberids "Direct link to memberIds?") `number`\[] Batch form of memberId — one request hydrates a whole table page. ###### page?[​](#page-8 "Direct link to page?") `number` ###### pageSize?[​](#pagesize-7 "Direct link to pageSize?") `number` ###### search?[​](#search-2 "Direct link to search?") `string` ###### searchField?[​](#searchfield "Direct link to searchField?") `string` #### Returns[​](#returns-363 "Direct link to Returns") `Promise`<[`DataRecordsPaginatedResponse`](https://docs.gravityrail.com/sdk/interfaces/DataRecordsPaginatedResponse.md)> #### Implementation of[​](#implementation-of-362 "Direct link to Implementation of") `DataTypesBindings.getDataRecords` *** ### getDataType()[​](#getdatatype "Direct link to getDataType()") > **getDataType**: (`wid`, `id`) => `Promise`<[`DataTypeResponse`](https://docs.gravityrail.com/sdk/interfaces/DataTypeResponse.md)> Defined in: [packages/sdk/src/client/client.ts:197](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L197) Get a single data type by numeric ID, or by UUID when a UUID string is supplied. #### Parameters[​](#parameters-362 "Direct link to Parameters") ##### wid[​](#wid-297 "Direct link to wid") `string` ##### id[​](#id-46 "Direct link to id") `string` | `number` #### Returns[​](#returns-364 "Direct link to Returns") `Promise`<[`DataTypeResponse`](https://docs.gravityrail.com/sdk/interfaces/DataTypeResponse.md)> #### Implementation of[​](#implementation-of-363 "Direct link to Implementation of") `DataTypesBindings.getDataType` *** ### getDataTypeBySlug()[​](#getdatatypebyslug "Direct link to getDataTypeBySlug()") > **getDataTypeBySlug**: (`wid`, `slug`) => `Promise`<[`DataTypeResponse`](https://docs.gravityrail.com/sdk/interfaces/DataTypeResponse.md)> Defined in: [packages/sdk/src/client/client.ts:199](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L199) Get a single data type by its slug. #### Parameters[​](#parameters-363 "Direct link to Parameters") ##### wid[​](#wid-298 "Direct link to wid") `string` ##### slug[​](#slug-6 "Direct link to slug") `string` #### Returns[​](#returns-365 "Direct link to Returns") `Promise`<[`DataTypeResponse`](https://docs.gravityrail.com/sdk/interfaces/DataTypeResponse.md)> #### Implementation of[​](#implementation-of-364 "Direct link to Implementation of") `DataTypesBindings.getDataTypeBySlug` *** ### getDataTypeByUuid()[​](#getdatatypebyuuid "Direct link to getDataTypeByUuid()") > **getDataTypeByUuid**: (`wid`, `uuid`) => `Promise`<[`DataTypeResponse`](https://docs.gravityrail.com/sdk/interfaces/DataTypeResponse.md)> Defined in: [packages/sdk/src/client/client.ts:198](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L198) Get a single data type by UUID. #### Parameters[​](#parameters-364 "Direct link to Parameters") ##### wid[​](#wid-299 "Direct link to wid") `string` ##### uuid[​](#uuid-11 "Direct link to uuid") `string` #### Returns[​](#returns-366 "Direct link to Returns") `Promise`<[`DataTypeResponse`](https://docs.gravityrail.com/sdk/interfaces/DataTypeResponse.md)> #### Implementation of[​](#implementation-of-365 "Direct link to Implementation of") `DataTypesBindings.getDataTypeByUuid` *** ### getDataTypes()[​](#getdatatypes "Direct link to getDataTypes()") > **getDataTypes**: (`wid`, `options?`) => `Promise`<[`DataTypeResponse`](https://docs.gravityrail.com/sdk/interfaces/DataTypeResponse.md)\[]> Defined in: [packages/sdk/src/client/client.ts:196](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L196) List all data types for a workspace, optionally filtering by archived status. #### Parameters[​](#parameters-365 "Direct link to Parameters") ##### wid[​](#wid-300 "Direct link to wid") `string` ##### options?[​](#options-14 "Direct link to options?") ###### archived?[​](#archived-1 "Direct link to archived?") `boolean` #### Returns[​](#returns-367 "Direct link to Returns") `Promise`<[`DataTypeResponse`](https://docs.gravityrail.com/sdk/interfaces/DataTypeResponse.md)\[]> #### Implementation of[​](#implementation-of-366 "Direct link to Implementation of") `DataTypesBindings.getDataTypes` *** ### getDiscordBot()[​](#getdiscordbot "Direct link to getDiscordBot()") > **getDiscordBot**: (`wid`, `botId`) => `Promise`<[`DiscordBot`](https://docs.gravityrail.com/sdk/type-aliases/DiscordBot.md)> Defined in: [packages/sdk/src/client/client.ts:887](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L887) Get a specific Discord bot by ID. #### Parameters[​](#parameters-366 "Direct link to Parameters") ##### wid[​](#wid-301 "Direct link to wid") `string` ##### botId[​](#botid-1 "Direct link to botId") `number` #### Returns[​](#returns-368 "Direct link to Returns") `Promise`<[`DiscordBot`](https://docs.gravityrail.com/sdk/type-aliases/DiscordBot.md)> #### Implementation of[​](#implementation-of-367 "Direct link to Implementation of") `IntegrationsBindings.getDiscordBot` *** ### getDiscordBotAccounts()[​](#getdiscordbotaccounts "Direct link to getDiscordBotAccounts()") > **getDiscordBotAccounts**: (`wid`, `botId`, `options`) => `Promise`<[`PaginatedResponse`](https://docs.gravityrail.com/sdk/interfaces/PaginatedResponse.md)<[`DiscordBotAccount`](https://docs.gravityrail.com/sdk/interfaces/DiscordBotAccount.md)>> Defined in: [packages/sdk/src/client/client.ts:896](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L896) Get Discord account links for a bot (members linked to Discord users). #### Parameters[​](#parameters-367 "Direct link to Parameters") ##### wid[​](#wid-302 "Direct link to wid") `string` ##### botId[​](#botid-2 "Direct link to botId") `number` ##### options?[​](#options-15 "Direct link to options?") ###### page?[​](#page-9 "Direct link to page?") `number` ###### pageSize?[​](#pagesize-8 "Direct link to pageSize?") `number` #### Returns[​](#returns-369 "Direct link to Returns") `Promise`<[`PaginatedResponse`](https://docs.gravityrail.com/sdk/interfaces/PaginatedResponse.md)<[`DiscordBotAccount`](https://docs.gravityrail.com/sdk/interfaces/DiscordBotAccount.md)>> #### Implementation of[​](#implementation-of-368 "Direct link to Implementation of") `IntegrationsBindings.getDiscordBotAccounts` *** ### getDiscordBotByUuid()[​](#getdiscordbotbyuuid "Direct link to getDiscordBotByUuid()") > **getDiscordBotByUuid**: (`wid`, `uuid`) => `Promise`<[`DiscordBot`](https://docs.gravityrail.com/sdk/type-aliases/DiscordBot.md)> Defined in: [packages/sdk/src/client/client.ts:888](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L888) Get a Discord bot by UUID. #### Parameters[​](#parameters-368 "Direct link to Parameters") ##### wid[​](#wid-303 "Direct link to wid") `string` ##### uuid[​](#uuid-12 "Direct link to uuid") `string` #### Returns[​](#returns-370 "Direct link to Returns") `Promise`<[`DiscordBot`](https://docs.gravityrail.com/sdk/type-aliases/DiscordBot.md)> #### Implementation of[​](#implementation-of-369 "Direct link to Implementation of") `IntegrationsBindings.getDiscordBotByUuid` *** ### getDiscordBots()[​](#getdiscordbots "Direct link to getDiscordBots()") > **getDiscordBots**: (`wid`, `options`) => `Promise`<[`PaginatedResponse`](https://docs.gravityrail.com/sdk/interfaces/PaginatedResponse.md)<[`DiscordBot`](https://docs.gravityrail.com/sdk/type-aliases/DiscordBot.md)>> Defined in: [packages/sdk/src/client/client.ts:886](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L886) List all Discord bots configured for a workspace. #### Parameters[​](#parameters-369 "Direct link to Parameters") ##### wid[​](#wid-304 "Direct link to wid") `string` ##### options?[​](#options-16 "Direct link to options?") ###### page?[​](#page-10 "Direct link to page?") `number` ###### pageSize?[​](#pagesize-9 "Direct link to pageSize?") `number` ###### search?[​](#search-3 "Direct link to search?") `string` ###### sortBy?[​](#sortby-1 "Direct link to sortBy?") [`DiscordBotSortField`](https://docs.gravityrail.com/sdk/type-aliases/DiscordBotSortField.md) ###### sortOrder?[​](#sortorder-1 "Direct link to sortOrder?") [`SortOrder`](https://docs.gravityrail.com/sdk/type-aliases/SortOrder.md) #### Returns[​](#returns-371 "Direct link to Returns") `Promise`<[`PaginatedResponse`](https://docs.gravityrail.com/sdk/interfaces/PaginatedResponse.md)<[`DiscordBot`](https://docs.gravityrail.com/sdk/type-aliases/DiscordBot.md)>> #### Implementation of[​](#implementation-of-370 "Direct link to Implementation of") `IntegrationsBindings.getDiscordBots` *** ### getDiscordGuilds()[​](#getdiscordguilds "Direct link to getDiscordGuilds()") > **getDiscordGuilds**: (`wid`, `botId`, `options`) => `Promise`<[`PaginatedResponse`](https://docs.gravityrail.com/sdk/interfaces/PaginatedResponse.md)<[`DiscordGuild`](https://docs.gravityrail.com/sdk/interfaces/DiscordGuild.md)>> Defined in: [packages/sdk/src/client/client.ts:895](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L895) Get Discord guilds (servers) that have interacted with a bot. #### Parameters[​](#parameters-370 "Direct link to Parameters") ##### wid[​](#wid-305 "Direct link to wid") `string` ##### botId[​](#botid-3 "Direct link to botId") `number` ##### options?[​](#options-17 "Direct link to options?") ###### page?[​](#page-11 "Direct link to page?") `number` ###### pageSize?[​](#pagesize-10 "Direct link to pageSize?") `number` #### Returns[​](#returns-372 "Direct link to Returns") `Promise`<[`PaginatedResponse`](https://docs.gravityrail.com/sdk/interfaces/PaginatedResponse.md)<[`DiscordGuild`](https://docs.gravityrail.com/sdk/interfaces/DiscordGuild.md)>> #### Implementation of[​](#implementation-of-371 "Direct link to Implementation of") `IntegrationsBindings.getDiscordGuilds` *** ### getDiscordThreads()[​](#getdiscordthreads "Direct link to getDiscordThreads()") > **getDiscordThreads**: (`wid`, `botId`, `options`) => `Promise`<[`PaginatedResponse`](https://docs.gravityrail.com/sdk/interfaces/PaginatedResponse.md)<[`DiscordThread`](https://docs.gravityrail.com/sdk/interfaces/DiscordThread.md)>> Defined in: [packages/sdk/src/client/client.ts:894](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L894) Get Discord threads for a bot. #### Parameters[​](#parameters-371 "Direct link to Parameters") ##### wid[​](#wid-306 "Direct link to wid") `string` ##### botId[​](#botid-4 "Direct link to botId") `number` ##### options?[​](#options-18 "Direct link to options?") ###### page?[​](#page-12 "Direct link to page?") `number` ###### pageSize?[​](#pagesize-11 "Direct link to pageSize?") `number` #### Returns[​](#returns-373 "Direct link to Returns") `Promise`<[`PaginatedResponse`](https://docs.gravityrail.com/sdk/interfaces/PaginatedResponse.md)<[`DiscordThread`](https://docs.gravityrail.com/sdk/interfaces/DiscordThread.md)>> #### Implementation of[​](#implementation-of-372 "Direct link to Implementation of") `IntegrationsBindings.getDiscordThreads` *** ### getDomainMapping()[​](#getdomainmapping "Direct link to getDomainMapping()") > **getDomainMapping**: (`customDomain`) => `Promise`<[`DomainMapping`](https://docs.gravityrail.com/sdk/interfaces/DomainMapping.md)> Defined in: [packages/sdk/src/client/client.ts:503](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L503) Get the organization and workspace mapping for a custom domain. #### Parameters[​](#parameters-372 "Direct link to Parameters") ##### customDomain[​](#customdomain "Direct link to customDomain") `string` #### Returns[​](#returns-374 "Direct link to Returns") `Promise`<[`DomainMapping`](https://docs.gravityrail.com/sdk/interfaces/DomainMapping.md)> #### Implementation of[​](#implementation-of-373 "Direct link to Implementation of") `AuthBindings.getDomainMapping` *** ### getEventRule()[​](#geteventrule "Direct link to getEventRule()") > **getEventRule**: (`wid`, `id`) => `Promise`<[`EventRuleResponse`](https://docs.gravityrail.com/sdk/type-aliases/EventRuleResponse.md)> Defined in: [packages/sdk/src/client/client.ts:626](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L626) Get a single event rule by ID. #### Parameters[​](#parameters-373 "Direct link to Parameters") ##### wid[​](#wid-307 "Direct link to wid") `string` ##### id[​](#id-47 "Direct link to id") `number` #### Returns[​](#returns-375 "Direct link to Returns") `Promise`<[`EventRuleResponse`](https://docs.gravityrail.com/sdk/type-aliases/EventRuleResponse.md)> #### Implementation of[​](#implementation-of-374 "Direct link to Implementation of") `EventsBindings.getEventRule` *** ### getEventRules()[​](#geteventrules "Direct link to getEventRules()") > **getEventRules**: (`wid`, `params?`) => `Promise`<[`PaginatedResponse`](https://docs.gravityrail.com/sdk/interfaces/PaginatedResponse.md)<[`EventRuleResponse`](https://docs.gravityrail.com/sdk/type-aliases/EventRuleResponse.md)>> Defined in: [packages/sdk/src/client/client.ts:623](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L623) List event rules in the workspace, paginated. #### Parameters[​](#parameters-374 "Direct link to Parameters") ##### wid[​](#wid-308 "Direct link to wid") `string` ##### params?[​](#params-7 "Direct link to params?") ###### page?[​](#page-13 "Direct link to page?") `number` ###### pageSize?[​](#pagesize-12 "Direct link to pageSize?") `number` #### Returns[​](#returns-376 "Direct link to Returns") `Promise`<[`PaginatedResponse`](https://docs.gravityrail.com/sdk/interfaces/PaginatedResponse.md)<[`EventRuleResponse`](https://docs.gravityrail.com/sdk/type-aliases/EventRuleResponse.md)>> #### Implementation of[​](#implementation-of-375 "Direct link to Implementation of") `EventsBindings.getEventRules` *** ### getExperiment()[​](#getexperiment "Direct link to getExperiment()") > **getExperiment**: (`wid`, `experimentId`) => `Promise`<`Experiment`> Defined in: [packages/sdk/src/client/client.ts:358](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L358) Get a single experiment by ID (includes groups). #### Parameters[​](#parameters-375 "Direct link to Parameters") ##### wid[​](#wid-309 "Direct link to wid") `string` ##### experimentId[​](#experimentid-5 "Direct link to experimentId") `number` #### Returns[​](#returns-377 "Direct link to Returns") `Promise`<`Experiment`> #### Implementation of[​](#implementation-of-376 "Direct link to Implementation of") `ExperimentsBindings.getExperiment` *** ### getExperiments()[​](#getexperiments "Direct link to getExperiments()") > **getExperiments**: (`wid`, `params?`) => `Promise`<[`PaginatedResponse`](https://docs.gravityrail.com/sdk/interfaces/PaginatedResponse.md)<`Experiment`>> Defined in: [packages/sdk/src/client/client.ts:357](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L357) List experiments with group summaries and assignment counts. #### Parameters[​](#parameters-376 "Direct link to Parameters") ##### wid[​](#wid-310 "Direct link to wid") `string` ##### params?[​](#params-8 "Direct link to params?") ###### includeArchived?[​](#includearchived-1 "Direct link to includeArchived?") `boolean` ###### page?[​](#page-14 "Direct link to page?") `number` ###### pageSize?[​](#pagesize-13 "Direct link to pageSize?") `number` #### Returns[​](#returns-378 "Direct link to Returns") `Promise`<[`PaginatedResponse`](https://docs.gravityrail.com/sdk/interfaces/PaginatedResponse.md)<`Experiment`>> #### Implementation of[​](#implementation-of-377 "Direct link to Implementation of") `ExperimentsBindings.getExperiments` *** ### getExperimentStats()[​](#getexperimentstats "Direct link to getExperimentStats()") > **getExperimentStats**: (`wid`, `experimentId`) => `Promise`<`ExperimentStats`> Defined in: [packages/sdk/src/client/client.ts:365](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L365) Aggregate assignment and exposure counts by group. #### Parameters[​](#parameters-377 "Direct link to Parameters") ##### wid[​](#wid-311 "Direct link to wid") `string` ##### experimentId[​](#experimentid-6 "Direct link to experimentId") `number` #### Returns[​](#returns-379 "Direct link to Returns") `Promise`<`ExperimentStats`> #### Implementation of[​](#implementation-of-378 "Direct link to Implementation of") `ExperimentsBindings.getExperimentStats` *** ### getFeatureBySlug()[​](#getfeaturebyslug "Direct link to getFeatureBySlug()") > **getFeatureBySlug**: (`slug`) => `Promise`<[`FeatureDefinition`](https://docs.gravityrail.com/sdk/interfaces/FeatureDefinition.md)> Defined in: [packages/sdk/src/client/client.ts:803](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L803) Get a specific feature definition by slug #### Parameters[​](#parameters-378 "Direct link to Parameters") ##### slug[​](#slug-7 "Direct link to slug") `string` #### Returns[​](#returns-380 "Direct link to Returns") `Promise`<[`FeatureDefinition`](https://docs.gravityrail.com/sdk/interfaces/FeatureDefinition.md)> #### Implementation of[​](#implementation-of-379 "Direct link to Implementation of") `ToolkitsBindings.getFeatureBySlug` *** ### getFeatureRegistry()[​](#getfeatureregistry "Direct link to getFeatureRegistry()") > **getFeatureRegistry**: () => `Promise`<`FeaturesRegistryResponse`> Defined in: [packages/sdk/src/client/client.ts:801](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L801) Get the full feature registry with all metadata #### Returns[​](#returns-381 "Direct link to Returns") `Promise`<`FeaturesRegistryResponse`> #### Implementation of[​](#implementation-of-380 "Direct link to Implementation of") `ToolkitsBindings.getFeatureRegistry` *** ### getFhirConnection()[​](#getfhirconnection "Direct link to getFhirConnection()") > **getFhirConnection**: (`wid`, `connectionId`) => `Promise`<[`FhirConnection`](https://docs.gravityrail.com/sdk/type-aliases/FhirConnection.md)> Defined in: [packages/sdk/src/client/client.ts:922](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L922) Get a specific FHIR connection by ID. #### Parameters[​](#parameters-379 "Direct link to Parameters") ##### wid[​](#wid-312 "Direct link to wid") `string` ##### connectionId[​](#connectionid-29 "Direct link to connectionId") `number` #### Returns[​](#returns-382 "Direct link to Returns") `Promise`<[`FhirConnection`](https://docs.gravityrail.com/sdk/type-aliases/FhirConnection.md)> #### Implementation of[​](#implementation-of-381 "Direct link to Implementation of") `IntegrationsBindings.getFhirConnection` *** ### getFhirConnectionByUuid()[​](#getfhirconnectionbyuuid "Direct link to getFhirConnectionByUuid()") > **getFhirConnectionByUuid**: (`wid`, `uuid`) => `Promise`<[`FhirConnection`](https://docs.gravityrail.com/sdk/type-aliases/FhirConnection.md)> Defined in: [packages/sdk/src/client/client.ts:923](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L923) Get a FHIR connection by UUID. #### Parameters[​](#parameters-380 "Direct link to Parameters") ##### wid[​](#wid-313 "Direct link to wid") `string` ##### uuid[​](#uuid-13 "Direct link to uuid") `string` #### Returns[​](#returns-383 "Direct link to Returns") `Promise`<[`FhirConnection`](https://docs.gravityrail.com/sdk/type-aliases/FhirConnection.md)> #### Implementation of[​](#implementation-of-382 "Direct link to Implementation of") `IntegrationsBindings.getFhirConnectionByUuid` *** ### getFhirConnections()[​](#getfhirconnections "Direct link to getFhirConnections()") > **getFhirConnections**: (`wid`, `options`) => `Promise`<[`PaginatedResponse`](https://docs.gravityrail.com/sdk/interfaces/PaginatedResponse.md)<[`FhirConnection`](https://docs.gravityrail.com/sdk/type-aliases/FhirConnection.md)>> Defined in: [packages/sdk/src/client/client.ts:921](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L921) List all FHIR connections configured for a workspace. #### Parameters[​](#parameters-381 "Direct link to Parameters") ##### wid[​](#wid-314 "Direct link to wid") `string` ##### options?[​](#options-19 "Direct link to options?") ###### page?[​](#page-15 "Direct link to page?") `number` ###### pageSize?[​](#pagesize-14 "Direct link to pageSize?") `number` ###### search?[​](#search-4 "Direct link to search?") `string` ###### sortBy?[​](#sortby-2 "Direct link to sortBy?") [`FhirConnectionSortField`](https://docs.gravityrail.com/sdk/type-aliases/FhirConnectionSortField.md) ###### sortOrder?[​](#sortorder-2 "Direct link to sortOrder?") [`SortOrder`](https://docs.gravityrail.com/sdk/type-aliases/SortOrder.md) #### Returns[​](#returns-384 "Direct link to Returns") `Promise`<[`PaginatedResponse`](https://docs.gravityrail.com/sdk/interfaces/PaginatedResponse.md)<[`FhirConnection`](https://docs.gravityrail.com/sdk/type-aliases/FhirConnection.md)>> #### Implementation of[​](#implementation-of-383 "Direct link to Implementation of") `IntegrationsBindings.getFhirConnections` *** ### getFieldIndexStatus()[​](#getfieldindexstatus "Direct link to getFieldIndexStatus()") > **getFieldIndexStatus**: (`wid`, `dataTypeId`, `fieldSlug`) => `Promise`<{ `fieldName`: `string`; `fieldSlug`: `string`; `indexStatus`: `string`; `shouldIndex`: `string`; }> Defined in: [packages/sdk/src/client/client.ts:214](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L214) Get the index status for a data type field. #### Parameters[​](#parameters-382 "Direct link to Parameters") ##### wid[​](#wid-315 "Direct link to wid") `string` ##### dataTypeId[​](#datatypeid-4 "Direct link to dataTypeId") `number` ##### fieldSlug[​](#fieldslug "Direct link to fieldSlug") `string` #### Returns[​](#returns-385 "Direct link to Returns") `Promise`<{ `fieldName`: `string`; `fieldSlug`: `string`; `indexStatus`: `string`; `shouldIndex`: `string`; }> #### Implementation of[​](#implementation-of-384 "Direct link to Implementation of") `DataTypesBindings.getFieldIndexStatus` *** ### getFile()[​](#getfile "Direct link to getFile()") > **getFile**: (`wid`, `id`) => `Promise`<[`File`](https://docs.gravityrail.com/sdk/type-aliases/File.md)> Defined in: [packages/sdk/src/client/client.ts:588](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L588) Get a single file by ID. #### Parameters[​](#parameters-383 "Direct link to Parameters") ##### wid[​](#wid-316 "Direct link to wid") `string` ##### id[​](#id-48 "Direct link to id") `number` #### Returns[​](#returns-386 "Direct link to Returns") `Promise`<[`File`](https://docs.gravityrail.com/sdk/type-aliases/File.md)> #### Implementation of[​](#implementation-of-385 "Direct link to Implementation of") `FilesBindings.getFile` *** ### getFileLabel()[​](#getfilelabel "Direct link to getFileLabel()") > **getFileLabel**: (`wid`, `id`) => `Promise`<[`FileLabelResponse`](https://docs.gravityrail.com/sdk/interfaces/FileLabelResponse.md)> Defined in: [packages/sdk/src/client/client.ts:604](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L604) Get a single file label by ID. #### Parameters[​](#parameters-384 "Direct link to Parameters") ##### wid[​](#wid-317 "Direct link to wid") `string` ##### id[​](#id-49 "Direct link to id") `number` #### Returns[​](#returns-387 "Direct link to Returns") `Promise`<[`FileLabelResponse`](https://docs.gravityrail.com/sdk/interfaces/FileLabelResponse.md)> #### Implementation of[​](#implementation-of-386 "Direct link to Implementation of") `FilesBindings.getFileLabel` *** ### getFileLabelByUuid()[​](#getfilelabelbyuuid "Direct link to getFileLabelByUuid()") > **getFileLabelByUuid**: (`wid`, `uuid`) => `Promise`<[`FileLabelResponse`](https://docs.gravityrail.com/sdk/interfaces/FileLabelResponse.md)> Defined in: [packages/sdk/src/client/client.ts:605](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L605) Get a single file label by UUID. #### Parameters[​](#parameters-385 "Direct link to Parameters") ##### wid[​](#wid-318 "Direct link to wid") `string` ##### uuid[​](#uuid-14 "Direct link to uuid") `string` #### Returns[​](#returns-388 "Direct link to Returns") `Promise`<[`FileLabelResponse`](https://docs.gravityrail.com/sdk/interfaces/FileLabelResponse.md)> #### Implementation of[​](#implementation-of-387 "Direct link to Implementation of") `FilesBindings.getFileLabelByUuid` *** ### getFileLabels()[​](#getfilelabels "Direct link to getFileLabels()") > **getFileLabels**: (`wid`) => `Promise`<[`FileLabelResponse`](https://docs.gravityrail.com/sdk/interfaces/FileLabelResponse.md)\[]> Defined in: [packages/sdk/src/client/client.ts:603](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L603) List all file labels in the workspace. #### Parameters[​](#parameters-386 "Direct link to Parameters") ##### wid[​](#wid-319 "Direct link to wid") `string` #### Returns[​](#returns-389 "Direct link to Returns") `Promise`<[`FileLabelResponse`](https://docs.gravityrail.com/sdk/interfaces/FileLabelResponse.md)\[]> #### Implementation of[​](#implementation-of-388 "Direct link to Implementation of") `FilesBindings.getFileLabels` *** ### getFiles()[​](#getfiles "Direct link to getFiles()") > **getFiles**: (`wid`, `options`) => `Promise`<[`PaginatedResponse`](https://docs.gravityrail.com/sdk/interfaces/PaginatedResponse.md)<[`File`](https://docs.gravityrail.com/sdk/type-aliases/File.md)>> Defined in: [packages/sdk/src/client/client.ts:587](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L587) List files in a workspace with optional folder filtering, sorting, and search. #### Parameters[​](#parameters-387 "Direct link to Parameters") ##### wid[​](#wid-320 "Direct link to wid") `string` ##### options?[​](#options-20 "Direct link to options?") ###### folderId?[​](#folderid "Direct link to folderId?") `number` ###### page?[​](#page-16 "Direct link to page?") `number` ###### pageSize?[​](#pagesize-15 "Direct link to pageSize?") `number` ###### search?[​](#search-5 "Direct link to search?") `string` ###### sortBy?[​](#sortby-3 "Direct link to sortBy?") [`FileSortField`](https://docs.gravityrail.com/sdk/type-aliases/FileSortField.md) ###### sortOrder?[​](#sortorder-3 "Direct link to sortOrder?") [`SortOrder`](https://docs.gravityrail.com/sdk/type-aliases/SortOrder.md) #### Returns[​](#returns-390 "Direct link to Returns") `Promise`<[`PaginatedResponse`](https://docs.gravityrail.com/sdk/interfaces/PaginatedResponse.md)<[`File`](https://docs.gravityrail.com/sdk/type-aliases/File.md)>> #### Implementation of[​](#implementation-of-389 "Direct link to Implementation of") `FilesBindings.getFiles` *** ### getFileSharing()[​](#getfilesharing "Direct link to getFileSharing()") > **getFileSharing**: (`wid`, `fileId`) => `Promise`<[`FileSharingResponse`](https://docs.gravityrail.com/sdk/type-aliases/FileSharingResponse.md)> Defined in: [packages/sdk/src/client/client.ts:609](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L609) Get sharing settings for a file. #### Parameters[​](#parameters-388 "Direct link to Parameters") ##### wid[​](#wid-321 "Direct link to wid") `string` ##### fileId[​](#fileid-1 "Direct link to fileId") `number` #### Returns[​](#returns-391 "Direct link to Returns") `Promise`<[`FileSharingResponse`](https://docs.gravityrail.com/sdk/type-aliases/FileSharingResponse.md)> #### Implementation of[​](#implementation-of-390 "Direct link to Implementation of") `FilesBindings.getFileSharing` *** ### getFirstRunState()[​](#getfirstrunstate "Direct link to getFirstRunState()") > **getFirstRunState**: (`wid`) => `Promise`<[`FirstRunState`](https://docs.gravityrail.com/sdk/interfaces/FirstRunState.md)> Defined in: [packages/sdk/src/client/client.ts:409](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L409) Get the full first-run onboarding state for a workspace. #### Parameters[​](#parameters-389 "Direct link to Parameters") ##### wid[​](#wid-322 "Direct link to wid") `string` #### Returns[​](#returns-392 "Direct link to Returns") `Promise`<[`FirstRunState`](https://docs.gravityrail.com/sdk/interfaces/FirstRunState.md)> #### Implementation of[​](#implementation-of-391 "Direct link to Implementation of") `WorkspacesBindings.getFirstRunState` *** ### getFolder()[​](#getfolder "Direct link to getFolder()") > **getFolder**: (`wid`, `id`) => `Promise`<[`FileFolderResponse`](https://docs.gravityrail.com/sdk/interfaces/FileFolderResponse.md)> Defined in: [packages/sdk/src/client/client.ts:597](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L597) Get a single folder by ID. #### Parameters[​](#parameters-390 "Direct link to Parameters") ##### wid[​](#wid-323 "Direct link to wid") `string` ##### id[​](#id-50 "Direct link to id") `number` #### Returns[​](#returns-393 "Direct link to Returns") `Promise`<[`FileFolderResponse`](https://docs.gravityrail.com/sdk/interfaces/FileFolderResponse.md)> #### Implementation of[​](#implementation-of-392 "Direct link to Implementation of") `FilesBindings.getFolder` *** ### getFolders()[​](#getfolders "Direct link to getFolders()") > **getFolders**: (`wid`, `parentIdOrOpts`) => `Promise`<[`FileFolderResponse`](https://docs.gravityrail.com/sdk/interfaces/FileFolderResponse.md)\[]> Defined in: [packages/sdk/src/client/client.ts:596](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L596) 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[​](#parameters-391 "Direct link to Parameters") ##### wid[​](#wid-324 "Direct link to wid") `string` ##### parentIdOrOpts[​](#parentidoropts "Direct link to parentIdOrOpts") `number` | { `parentId`: `number`; } #### Returns[​](#returns-394 "Direct link to Returns") `Promise`<[`FileFolderResponse`](https://docs.gravityrail.com/sdk/interfaces/FileFolderResponse.md)\[]> #### Implementation of[​](#implementation-of-393 "Direct link to Implementation of") `FilesBindings.getFolders` *** ### getFolderSharing()[​](#getfoldersharing "Direct link to getFolderSharing()") > **getFolderSharing**: (`wid`, `folderId`) => `Promise`<[`FolderSharingResponse`](https://docs.gravityrail.com/sdk/type-aliases/FolderSharingResponse.md)> Defined in: [packages/sdk/src/client/client.ts:612](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L612) Get sharing settings for a folder. #### Parameters[​](#parameters-392 "Direct link to Parameters") ##### wid[​](#wid-325 "Direct link to wid") `string` ##### folderId[​](#folderid-1 "Direct link to folderId") `number` #### Returns[​](#returns-395 "Direct link to Returns") `Promise`<[`FolderSharingResponse`](https://docs.gravityrail.com/sdk/type-aliases/FolderSharingResponse.md)> #### Implementation of[​](#implementation-of-394 "Direct link to Implementation of") `FilesBindings.getFolderSharing` *** ### getGlobalApiKeys()[​](#getglobalapikeys "Direct link to getGlobalApiKeys()") > **getGlobalApiKeys**: () => `Promise`<[`ApiKey`](https://docs.gravityrail.com/sdk/interfaces/ApiKey.md)\[]> Defined in: [packages/sdk/src/client/client.ts:809](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L809) List all account-level API keys. #### Returns[​](#returns-396 "Direct link to Returns") `Promise`<[`ApiKey`](https://docs.gravityrail.com/sdk/interfaces/ApiKey.md)\[]> #### Implementation of[​](#implementation-of-395 "Direct link to Implementation of") `BillingBindings.getGlobalApiKeys` *** ### getGoogleCalendarStatus()[​](#getgooglecalendarstatus "Direct link to getGoogleCalendarStatus()") > **getGoogleCalendarStatus**: (`wid`) => `Promise`<[`GoogleCalendarInsufficientScopesResponse`](https://docs.gravityrail.com/sdk/interfaces/GoogleCalendarInsufficientScopesResponse.md) | [`GoogleCalendarStatusResponse`](https://docs.gravityrail.com/sdk/interfaces/GoogleCalendarStatusResponse.md)> Defined in: [packages/sdk/src/client/client.ts:719](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L719) Get the Google Calendar integration status for the workspace. #### Parameters[​](#parameters-393 "Direct link to Parameters") ##### wid[​](#wid-326 "Direct link to wid") `string` #### Returns[​](#returns-397 "Direct link to Returns") `Promise`<[`GoogleCalendarInsufficientScopesResponse`](https://docs.gravityrail.com/sdk/interfaces/GoogleCalendarInsufficientScopesResponse.md) | [`GoogleCalendarStatusResponse`](https://docs.gravityrail.com/sdk/interfaces/GoogleCalendarStatusResponse.md)> #### Implementation of[​](#implementation-of-396 "Direct link to Implementation of") `CalendarsBindings.getGoogleCalendarStatus` *** ### getGranteeGrants()[​](#getgranteegrants "Direct link to getGranteeGrants()") > **getGranteeGrants**: (`wid`, `memberId`, `params?`) => `Promise`<[`PaginatedResponse`](https://docs.gravityrail.com/sdk/interfaces/PaginatedResponse.md)<[`AccessGrant`](https://docs.gravityrail.com/sdk/type-aliases/AccessGrant.md)>> Defined in: [packages/sdk/src/client/client.ts:394](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L394) List access grants *received* by a member (grantee view) — the "what can this agent do without asking?" list. Filter with status=active and/or a capabilityClass (e.g. 'tool.always\_allow'). #### Parameters[​](#parameters-394 "Direct link to Parameters") ##### wid[​](#wid-327 "Direct link to wid") `string` ##### memberId[​](#memberid-16 "Direct link to memberId") `number` ##### params?[​](#params-9 "Direct link to params?") ###### capabilityClass?[​](#capabilityclass "Direct link to capabilityClass?") `string` ###### page?[​](#page-17 "Direct link to page?") `number` ###### pageSize?[​](#pagesize-16 "Direct link to pageSize?") `number` ###### status?[​](#status-2 "Direct link to status?") `string` #### Returns[​](#returns-398 "Direct link to Returns") `Promise`<[`PaginatedResponse`](https://docs.gravityrail.com/sdk/interfaces/PaginatedResponse.md)<[`AccessGrant`](https://docs.gravityrail.com/sdk/type-aliases/AccessGrant.md)>> #### Implementation of[​](#implementation-of-397 "Direct link to Implementation of") `AccessGrantsBindings.getGranteeGrants` *** ### getHealthieAvailableSlots()[​](#gethealthieavailableslots "Direct link to getHealthieAvailableSlots()") > **getHealthieAvailableSlots**: (`wid`, `request`) => `Promise`<`AvailableDayResponse`\[]> Defined in: [packages/sdk/src/client/client.ts:968](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L968) #### Parameters[​](#parameters-395 "Direct link to Parameters") ##### wid[​](#wid-328 "Direct link to wid") `string` ##### request[​](#request-11 "Direct link to request") `GetAvailableSlotsRequest` #### Returns[​](#returns-399 "Direct link to Returns") `Promise`<`AvailableDayResponse`\[]> #### Implementation of[​](#implementation-of-398 "Direct link to Implementation of") `IntegrationsBindings.getHealthieAvailableSlots` *** ### getHealthieReconciliationMatches()[​](#gethealthiereconciliationmatches "Direct link to getHealthieReconciliationMatches()") > **getHealthieReconciliationMatches**: (`wid`, `params?`) => `Promise`<`HealthieReconciliationMatch`\[]> Defined in: [packages/sdk/src/client/client.ts:963](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L963) #### Parameters[​](#parameters-396 "Direct link to Parameters") ##### wid[​](#wid-329 "Direct link to wid") `string` ##### params?[​](#params-10 "Direct link to params?") ###### limit?[​](#limit-5 "Direct link to limit?") `number` ###### offset?[​](#offset-2 "Direct link to offset?") `number` #### Returns[​](#returns-400 "Direct link to Returns") `Promise`<`HealthieReconciliationMatch`\[]> #### Implementation of[​](#implementation-of-399 "Direct link to Implementation of") `IntegrationsBindings.getHealthieReconciliationMatches` *** ### getHealthieStatus()[​](#gethealthiestatus "Direct link to getHealthieStatus()") > **getHealthieStatus**: (`wid`) => `Promise`<`HealthieConnectionStatus`> Defined in: [packages/sdk/src/client/client.ts:957](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L957) #### Parameters[​](#parameters-397 "Direct link to Parameters") ##### wid[​](#wid-330 "Direct link to wid") `string` #### Returns[​](#returns-401 "Direct link to Returns") `Promise`<`HealthieConnectionStatus`> #### Implementation of[​](#implementation-of-400 "Direct link to Implementation of") `IntegrationsBindings.getHealthieStatus` *** ### getHubspotContactProperties()[​](#gethubspotcontactproperties "Direct link to getHubspotContactProperties()") > **getHubspotContactProperties**: (`wid`) => `Promise`<[`HubSpotPropertyDefinition`](https://docs.gravityrail.com/sdk/interfaces/HubSpotPropertyDefinition.md)\[]> Defined in: [packages/sdk/src/client/client.ts:1016](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L1016) #### Parameters[​](#parameters-398 "Direct link to Parameters") ##### wid[​](#wid-331 "Direct link to wid") `string` #### Returns[​](#returns-402 "Direct link to Returns") `Promise`<[`HubSpotPropertyDefinition`](https://docs.gravityrail.com/sdk/interfaces/HubSpotPropertyDefinition.md)\[]> #### Implementation of[​](#implementation-of-401 "Direct link to Implementation of") `IntegrationsBindings.getHubspotContactProperties` *** ### getHubspotManagedRules()[​](#gethubspotmanagedrules "Direct link to getHubspotManagedRules()") > **getHubspotManagedRules**: (`wid`) => `Promise`<[`ManagedRuleStatus`](https://docs.gravityrail.com/sdk/interfaces/ManagedRuleStatus.md)\[]> Defined in: [packages/sdk/src/client/client.ts:1017](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L1017) #### Parameters[​](#parameters-399 "Direct link to Parameters") ##### wid[​](#wid-332 "Direct link to wid") `string` #### Returns[​](#returns-403 "Direct link to Returns") `Promise`<[`ManagedRuleStatus`](https://docs.gravityrail.com/sdk/interfaces/ManagedRuleStatus.md)\[]> #### Implementation of[​](#implementation-of-402 "Direct link to Implementation of") `IntegrationsBindings.getHubspotManagedRules` *** ### getHubspotReconciliationMatches()[​](#gethubspotreconciliationmatches "Direct link to getHubspotReconciliationMatches()") > **getHubspotReconciliationMatches**: (`wid`, `params?`) => `Promise`<`HubspotReconciliationMatch`\[]> Defined in: [packages/sdk/src/client/client.ts:1009](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L1009) #### Parameters[​](#parameters-400 "Direct link to Parameters") ##### wid[​](#wid-333 "Direct link to wid") `string` ##### params?[​](#params-11 "Direct link to params?") ###### limit?[​](#limit-6 "Direct link to limit?") `number` ###### offset?[​](#offset-3 "Direct link to offset?") `number` #### Returns[​](#returns-404 "Direct link to Returns") `Promise`<`HubspotReconciliationMatch`\[]> #### Implementation of[​](#implementation-of-403 "Direct link to Implementation of") `IntegrationsBindings.getHubspotReconciliationMatches` *** ### getHubspotStatus()[​](#gethubspotstatus "Direct link to getHubspotStatus()") > **getHubspotStatus**: (`wid`) => `Promise`<`HubspotConnectionStatus`> Defined in: [packages/sdk/src/client/client.ts:1004](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L1004) #### Parameters[​](#parameters-401 "Direct link to Parameters") ##### wid[​](#wid-334 "Direct link to wid") `string` #### Returns[​](#returns-405 "Direct link to Returns") `Promise`<`HubspotConnectionStatus`> #### Implementation of[​](#implementation-of-404 "Direct link to Implementation of") `IntegrationsBindings.getHubspotStatus` *** ### getHubspotSyncLogs()[​](#gethubspotsynclogs "Direct link to getHubspotSyncLogs()") > **getHubspotSyncLogs**: (`wid`, `params?`) => `Promise`<[`SyncLogsResponse`](https://docs.gravityrail.com/sdk/interfaces/SyncLogsResponse.md)> Defined in: [packages/sdk/src/client/client.ts:1018](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L1018) #### Parameters[​](#parameters-402 "Direct link to Parameters") ##### wid[​](#wid-335 "Direct link to wid") `string` ##### params?[​](#params-12 "Direct link to params?") ###### cursor?[​](#cursor "Direct link to cursor?") `string` ###### pageSize?[​](#pagesize-17 "Direct link to pageSize?") `number` #### Returns[​](#returns-406 "Direct link to Returns") `Promise`<[`SyncLogsResponse`](https://docs.gravityrail.com/sdk/interfaces/SyncLogsResponse.md)> #### Implementation of[​](#implementation-of-405 "Direct link to Implementation of") `IntegrationsBindings.getHubspotSyncLogs` *** ### getHubspotTransformPresets()[​](#gethubspottransformpresets "Direct link to getHubspotTransformPresets()") > **getHubspotTransformPresets**: (`wid`) => `Promise`<[`TransformPreset`](https://docs.gravityrail.com/sdk/interfaces/TransformPreset.md)\[]> Defined in: [packages/sdk/src/client/client.ts:1019](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L1019) #### Parameters[​](#parameters-403 "Direct link to Parameters") ##### wid[​](#wid-336 "Direct link to wid") `string` #### Returns[​](#returns-407 "Direct link to Returns") `Promise`<[`TransformPreset`](https://docs.gravityrail.com/sdk/interfaces/TransformPreset.md)\[]> #### Implementation of[​](#implementation-of-406 "Direct link to Implementation of") `IntegrationsBindings.getHubspotTransformPresets` *** ### getICalFeedUrl()[​](#geticalfeedurl "Direct link to getICalFeedUrl()") > **getICalFeedUrl**: (`wid`, `calendarId`) => `Promise`<[`ICalFeedUrlResponse`](https://docs.gravityrail.com/sdk/interfaces/ICalFeedUrlResponse.md)> Defined in: [packages/sdk/src/client/client.ts:718](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L718) Get the iCal feed URL for a calendar. #### Parameters[​](#parameters-404 "Direct link to Parameters") ##### wid[​](#wid-337 "Direct link to wid") `string` ##### calendarId[​](#calendarid-6 "Direct link to calendarId") `number` #### Returns[​](#returns-408 "Direct link to Returns") `Promise`<[`ICalFeedUrlResponse`](https://docs.gravityrail.com/sdk/interfaces/ICalFeedUrlResponse.md)> #### Implementation of[​](#implementation-of-407 "Direct link to Implementation of") `CalendarsBindings.getICalFeedUrl` *** ### getInbox()[​](#getinbox "Direct link to getInbox()") > **getInbox**: (`wid`, `id`) => `Promise`<[`Inbox`](https://docs.gravityrail.com/sdk/type-aliases/Inbox.md)> Defined in: [packages/sdk/src/client/client.ts:748](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L748) Get an inbox by ID. #### Parameters[​](#parameters-405 "Direct link to Parameters") ##### wid[​](#wid-338 "Direct link to wid") `string` ##### id[​](#id-51 "Direct link to id") `number` #### Returns[​](#returns-409 "Direct link to Returns") `Promise`<[`Inbox`](https://docs.gravityrail.com/sdk/type-aliases/Inbox.md)> #### Implementation of[​](#implementation-of-408 "Direct link to Implementation of") `CommunicationsBindings.getInbox` *** ### getInboxEmail()[​](#getinboxemail "Direct link to getInboxEmail()") > **getInboxEmail**: (`wid`, `inboxId`, `emailId`) => `Promise`<[`Email`](https://docs.gravityrail.com/sdk/interfaces/Email.md)> Defined in: [packages/sdk/src/client/client.ts:753](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L753) Get a single email from an inbox. #### Parameters[​](#parameters-406 "Direct link to Parameters") ##### wid[​](#wid-339 "Direct link to wid") `string` ##### inboxId[​](#inboxid-3 "Direct link to inboxId") `number` ##### emailId[​](#emailid-2 "Direct link to emailId") `number` #### Returns[​](#returns-410 "Direct link to Returns") `Promise`<[`Email`](https://docs.gravityrail.com/sdk/interfaces/Email.md)> #### Implementation of[​](#implementation-of-409 "Direct link to Implementation of") `CommunicationsBindings.getInboxEmail` *** ### getInboxEmails()[​](#getinboxemails "Direct link to getInboxEmails()") > **getInboxEmails**: (`wid`, `inboxId`, `options`) => `Promise`<[`PaginatedResponse`](https://docs.gravityrail.com/sdk/interfaces/PaginatedResponse.md)<[`Email`](https://docs.gravityrail.com/sdk/interfaces/Email.md)>> Defined in: [packages/sdk/src/client/client.ts:752](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L752) List emails in an inbox with pagination and optional attachment inclusion. #### Parameters[​](#parameters-407 "Direct link to Parameters") ##### wid[​](#wid-340 "Direct link to wid") `string` ##### inboxId[​](#inboxid-4 "Direct link to inboxId") `number` ##### options?[​](#options-21 "Direct link to options?") ###### includeAttachments?[​](#includeattachments-1 "Direct link to includeAttachments?") `boolean` ###### page?[​](#page-18 "Direct link to page?") `number` ###### pageSize?[​](#pagesize-18 "Direct link to pageSize?") `number` #### Returns[​](#returns-411 "Direct link to Returns") `Promise`<[`PaginatedResponse`](https://docs.gravityrail.com/sdk/interfaces/PaginatedResponse.md)<[`Email`](https://docs.gravityrail.com/sdk/interfaces/Email.md)>> #### Implementation of[​](#implementation-of-410 "Direct link to Implementation of") `CommunicationsBindings.getInboxEmails` *** ### getInboxes()[​](#getinboxes "Direct link to getInboxes()") > **getInboxes**: (`wid`) => `Promise`<[`PaginatedResponse`](https://docs.gravityrail.com/sdk/interfaces/PaginatedResponse.md)<[`Inbox`](https://docs.gravityrail.com/sdk/type-aliases/Inbox.md)>> Defined in: [packages/sdk/src/client/client.ts:747](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L747) List all inboxes in a workspace. #### Parameters[​](#parameters-408 "Direct link to Parameters") ##### wid[​](#wid-341 "Direct link to wid") `string` #### Returns[​](#returns-412 "Direct link to Returns") `Promise`<[`PaginatedResponse`](https://docs.gravityrail.com/sdk/interfaces/PaginatedResponse.md)<[`Inbox`](https://docs.gravityrail.com/sdk/type-aliases/Inbox.md)>> #### Implementation of[​](#implementation-of-411 "Direct link to Implementation of") `CommunicationsBindings.getInboxes` *** ### getInboxThreads()[​](#getinboxthreads "Direct link to getInboxThreads()") > **getInboxThreads**: (`wid`, `inboxId`) => `Promise`<[`InboxThreadsPageResponse`](https://docs.gravityrail.com/sdk/interfaces/InboxThreadsPageResponse.md)> Defined in: [packages/sdk/src/client/client.ts:758](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L758) List email threads in an inbox. #### Parameters[​](#parameters-409 "Direct link to Parameters") ##### wid[​](#wid-342 "Direct link to wid") `string` ##### inboxId[​](#inboxid-5 "Direct link to inboxId") `number` #### Returns[​](#returns-413 "Direct link to Returns") `Promise`<[`InboxThreadsPageResponse`](https://docs.gravityrail.com/sdk/interfaces/InboxThreadsPageResponse.md)> #### Implementation of[​](#implementation-of-412 "Direct link to Implementation of") `CommunicationsBindings.getInboxThreads` *** ### getInquiry()[​](#getinquiry "Direct link to getInquiry()") > **getInquiry**: (`inquiryId`) => `Promise`<[`InquiryResponse`](https://docs.gravityrail.com/sdk/interfaces/InquiryResponse.md)> Defined in: [packages/sdk/src/client/client.ts:844](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L844) Get a specific inquiry (superuser only) #### Parameters[​](#parameters-410 "Direct link to Parameters") ##### inquiryId[​](#inquiryid-1 "Direct link to inquiryId") `number` #### Returns[​](#returns-414 "Direct link to Returns") `Promise`<[`InquiryResponse`](https://docs.gravityrail.com/sdk/interfaces/InquiryResponse.md)> #### Implementation of[​](#implementation-of-413 "Direct link to Implementation of") `AppsBindings.getInquiry` *** ### getJourney()[​](#getjourney "Direct link to getJourney()") > **getJourney**: (`wid`, `journeyId`) => `Promise`<`Journey`> Defined in: [packages/sdk/src/client/client.ts:326](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L326) Get a single journey by ID (includes steps and goals). #### Parameters[​](#parameters-411 "Direct link to Parameters") ##### wid[​](#wid-343 "Direct link to wid") `string` ##### journeyId[​](#journeyid-12 "Direct link to journeyId") `number` #### Returns[​](#returns-415 "Direct link to Returns") `Promise`<`Journey`> #### Implementation of[​](#implementation-of-414 "Direct link to Implementation of") `JourneysBindings.getJourney` *** ### getJourneyHealth()[​](#getjourneyhealth "Direct link to getJourneyHealth()") > **getJourneyHealth**: (`wid`, `journeyId`) => `Promise`<`JourneyHealthResponse`> Defined in: [packages/sdk/src/client/client.ts:327](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L327) 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[​](#parameters-412 "Direct link to Parameters") ##### wid[​](#wid-344 "Direct link to wid") `string` ##### journeyId[​](#journeyid-13 "Direct link to journeyId") `number` #### Returns[​](#returns-416 "Direct link to Returns") `Promise`<`JourneyHealthResponse`> #### Implementation of[​](#implementation-of-415 "Direct link to Implementation of") `JourneysBindings.getJourneyHealth` *** ### getJourneyMembers()[​](#getjourneymembers "Direct link to getJourneyMembers()") > **getJourneyMembers**: (`wid`, `journeyId`, `params?`) => `Promise`<[`PaginatedResponse`](https://docs.gravityrail.com/sdk/interfaces/PaginatedResponse.md)<`MemberJourney`>> Defined in: [packages/sdk/src/client/client.ts:340](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L340) List enrolled members for a journey (paginated). #### Parameters[​](#parameters-413 "Direct link to Parameters") ##### wid[​](#wid-345 "Direct link to wid") `string` ##### journeyId[​](#journeyid-14 "Direct link to journeyId") `number` ##### params?[​](#params-13 "Direct link to params?") ###### currentTaskId?[​](#currenttaskid "Direct link to currentTaskId?") `number` Only enrollments whose current step is this JourneyStep id. ###### enrolledAfter?[​](#enrolledafter "Direct link to enrolledAfter?") `string` ISO 8601 timestamp — only enrollments on/after this time. ###### enrolledBefore?[​](#enrolledbefore "Direct link to enrolledBefore?") `string` ISO 8601 timestamp — only enrollments on/before this time. ###### page?[​](#page-19 "Direct link to page?") `number` ###### pageSize?[​](#pagesize-19 "Direct link to pageSize?") `number` ###### runtimeFailureEdgeId?[​](#runtimefailureedgeid "Direct link to 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?[​](#search-6 "Direct link to search?") `string` ###### status?[​](#status-3 "Direct link to status?") `string` MemberJourneyStatus filter (e.g., 'active', 'completed'). #### Returns[​](#returns-417 "Direct link to Returns") `Promise`<[`PaginatedResponse`](https://docs.gravityrail.com/sdk/interfaces/PaginatedResponse.md)<`MemberJourney`>> #### Implementation of[​](#implementation-of-416 "Direct link to Implementation of") `JourneysBindings.getJourneyMembers` *** ### getJourneyNotes()[​](#getjourneynotes "Direct link to getJourneyNotes()") > **getJourneyNotes**: (`wid`, `journeyId`) => `Promise`<`JourneyNoteResponse`\[]> Defined in: [packages/sdk/src/client/client.ts:351](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L351) List notes for a journey. #### Parameters[​](#parameters-414 "Direct link to Parameters") ##### wid[​](#wid-346 "Direct link to wid") `string` ##### journeyId[​](#journeyid-15 "Direct link to journeyId") `number` #### Returns[​](#returns-418 "Direct link to Returns") `Promise`<`JourneyNoteResponse`\[]> #### Implementation of[​](#implementation-of-417 "Direct link to Implementation of") `JourneysBindings.getJourneyNotes` *** ### getJourneys()[​](#getjourneys "Direct link to getJourneys()") > **getJourneys**: (`wid`, `includeArchived`, `pageOpts?`) => `Promise`<[`PaginatedResponse`](https://docs.gravityrail.com/sdk/interfaces/PaginatedResponse.md)<`Journey`>> Defined in: [packages/sdk/src/client/client.ts:325](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L325) List journeys, optionally including archived, paginated. #### Parameters[​](#parameters-415 "Direct link to Parameters") ##### wid[​](#wid-347 "Direct link to wid") `string` ##### includeArchived?[​](#includearchived-2 "Direct link to includeArchived?") `boolean` = `false` ##### pageOpts?[​](#pageopts-1 "Direct link to pageOpts?") ###### page?[​](#page-20 "Direct link to page?") `number` ###### pageSize?[​](#pagesize-20 "Direct link to pageSize?") `number` #### Returns[​](#returns-419 "Direct link to Returns") `Promise`<[`PaginatedResponse`](https://docs.gravityrail.com/sdk/interfaces/PaginatedResponse.md)<`Journey`>> #### Implementation of[​](#implementation-of-418 "Direct link to Implementation of") `JourneysBindings.getJourneys` *** ### getLinkablePhones()[​](#getlinkablephones "Direct link to getLinkablePhones()") > **getLinkablePhones**: (`wid`) => `Promise`<`object`\[]> Defined in: [packages/sdk/src/client/client.ts:745](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L745) List provider phones available for linking to workspace phone numbers. #### Parameters[​](#parameters-416 "Direct link to Parameters") ##### wid[​](#wid-348 "Direct link to wid") `string` #### Returns[​](#returns-420 "Direct link to Returns") `Promise`<`object`\[]> #### Implementation of[​](#implementation-of-419 "Direct link to Implementation of") `CommunicationsBindings.getLinkablePhones` *** ### getLinkedHealthieMembers()[​](#getlinkedhealthiemembers "Direct link to getLinkedHealthieMembers()") > **getLinkedHealthieMembers**: (`wid`, `params?`) => `Promise`<[`PaginatedResponse`](https://docs.gravityrail.com/sdk/interfaces/PaginatedResponse.md)<`LinkedHealthieMember`>> Defined in: [packages/sdk/src/client/client.ts:962](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L962) #### Parameters[​](#parameters-417 "Direct link to Parameters") ##### wid[​](#wid-349 "Direct link to wid") `string` ##### params?[​](#params-14 "Direct link to params?") ###### page?[​](#page-21 "Direct link to page?") `number` ###### pageSize?[​](#pagesize-21 "Direct link to pageSize?") `number` ###### search?[​](#search-7 "Direct link to search?") `string` #### Returns[​](#returns-421 "Direct link to Returns") `Promise`<[`PaginatedResponse`](https://docs.gravityrail.com/sdk/interfaces/PaginatedResponse.md)<`LinkedHealthieMember`>> #### Implementation of[​](#implementation-of-420 "Direct link to Implementation of") `IntegrationsBindings.getLinkedHealthieMembers` *** ### getLinkedHubspotMembers()[​](#getlinkedhubspotmembers "Direct link to getLinkedHubspotMembers()") > **getLinkedHubspotMembers**: (`wid`, `params?`) => `Promise`<[`PaginatedResponse`](https://docs.gravityrail.com/sdk/interfaces/PaginatedResponse.md)<`LinkedHubspotMember`>> Defined in: [packages/sdk/src/client/client.ts:1013](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L1013) #### Parameters[​](#parameters-418 "Direct link to Parameters") ##### wid[​](#wid-350 "Direct link to wid") `string` ##### params?[​](#params-15 "Direct link to params?") ###### page?[​](#page-22 "Direct link to page?") `number` ###### pageSize?[​](#pagesize-22 "Direct link to pageSize?") `number` ###### search?[​](#search-8 "Direct link to search?") `string` #### Returns[​](#returns-422 "Direct link to Returns") `Promise`<[`PaginatedResponse`](https://docs.gravityrail.com/sdk/interfaces/PaginatedResponse.md)<`LinkedHubspotMember`>> #### Implementation of[​](#implementation-of-421 "Direct link to Implementation of") `IntegrationsBindings.getLinkedHubspotMembers` *** ### getLinkedMondayMembers()[​](#getlinkedmondaymembers "Direct link to getLinkedMondayMembers()") > **getLinkedMondayMembers**: (`wid`, `params?`) => `Promise`<[`PaginatedResponse`](https://docs.gravityrail.com/sdk/interfaces/PaginatedResponse.md)<`LinkedMondayMember`>> Defined in: [packages/sdk/src/client/client.ts:876](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L876) #### Parameters[​](#parameters-419 "Direct link to Parameters") ##### wid[​](#wid-351 "Direct link to wid") `string` ##### params?[​](#params-16 "Direct link to params?") ###### board\_id?[​](#board_id "Direct link to board_id?") `string` ###### page?[​](#page-23 "Direct link to page?") `number` ###### pageSize?[​](#pagesize-23 "Direct link to pageSize?") `number` ###### search?[​](#search-9 "Direct link to search?") `string` #### Returns[​](#returns-423 "Direct link to Returns") `Promise`<[`PaginatedResponse`](https://docs.gravityrail.com/sdk/interfaces/PaginatedResponse.md)<`LinkedMondayMember`>> #### Implementation of[​](#implementation-of-422 "Direct link to Implementation of") `IntegrationsBindings.getLinkedMondayMembers` *** ### getLinkedRecords()[​](#getlinkedrecords "Direct link to getLinkedRecords()") > **getLinkedRecords**: (`wid`, `params?`) => `Promise`<[`PaginatedResponse`](https://docs.gravityrail.com/sdk/interfaces/PaginatedResponse.md)<`LinkedMondayRecord`>> Defined in: [packages/sdk/src/client/client.ts:881](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L881) #### Parameters[​](#parameters-420 "Direct link to Parameters") ##### wid[​](#wid-352 "Direct link to wid") `string` ##### params?[​](#params-17 "Direct link to params?") ###### board\_id?[​](#board_id-1 "Direct link to board_id?") `string` ###### page?[​](#page-24 "Direct link to page?") `number` ###### pageSize?[​](#pagesize-24 "Direct link to pageSize?") `number` #### Returns[​](#returns-424 "Direct link to Returns") `Promise`<[`PaginatedResponse`](https://docs.gravityrail.com/sdk/interfaces/PaginatedResponse.md)<`LinkedMondayRecord`>> #### Implementation of[​](#implementation-of-423 "Direct link to Implementation of") `IntegrationsBindings.getLinkedRecords` *** ### getLinkedSalesforceMembers()[​](#getlinkedsalesforcemembers "Direct link to getLinkedSalesforceMembers()") > **getLinkedSalesforceMembers**: (`wid`, `params?`) => `Promise`<[`PaginatedResponse`](https://docs.gravityrail.com/sdk/interfaces/PaginatedResponse.md)<`LinkedSalesforceMember`>> Defined in: [packages/sdk/src/client/client.ts:994](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L994) #### Parameters[​](#parameters-421 "Direct link to Parameters") ##### wid[​](#wid-353 "Direct link to wid") `string` ##### params?[​](#params-18 "Direct link to params?") ###### page?[​](#page-25 "Direct link to page?") `number` ###### pageSize?[​](#pagesize-25 "Direct link to pageSize?") `number` ###### search?[​](#search-10 "Direct link to search?") `string` #### Returns[​](#returns-425 "Direct link to Returns") `Promise`<[`PaginatedResponse`](https://docs.gravityrail.com/sdk/interfaces/PaginatedResponse.md)<`LinkedSalesforceMember`>> #### Implementation of[​](#implementation-of-424 "Direct link to Implementation of") `IntegrationsBindings.getLinkedSalesforceMembers` *** ### getLiveOperators()[​](#getliveoperators "Direct link to getLiveOperators()") > **getLiveOperators**: (`wid`) => `Promise`<[`LiveOperatorsResponse`](https://docs.gravityrail.com/sdk/interfaces/LiveOperatorsResponse.md)> Defined in: [packages/sdk/src/client/client.ts:379](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L379) Get all currently live (online) operators in a workspace. #### Parameters[​](#parameters-422 "Direct link to Parameters") ##### wid[​](#wid-354 "Direct link to wid") `string` #### Returns[​](#returns-426 "Direct link to Returns") `Promise`<[`LiveOperatorsResponse`](https://docs.gravityrail.com/sdk/interfaces/LiveOperatorsResponse.md)> #### Implementation of[​](#implementation-of-425 "Direct link to Implementation of") `OperatorBindings.getLiveOperators` *** ### getMcpServer()[​](#getmcpserver "Direct link to getMcpServer()") > **getMcpServer**: (`wid`, `serverId`) => `Promise`<[`McpServerResponse`](https://docs.gravityrail.com/sdk/interfaces/McpServerResponse.md)> Defined in: [packages/sdk/src/client/client.ts:790](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L790) Get a specific MCP server #### Parameters[​](#parameters-423 "Direct link to Parameters") ##### wid[​](#wid-355 "Direct link to wid") `string` ##### serverId[​](#serverid-3 "Direct link to serverId") `number` #### Returns[​](#returns-427 "Direct link to Returns") `Promise`<[`McpServerResponse`](https://docs.gravityrail.com/sdk/interfaces/McpServerResponse.md)> #### Implementation of[​](#implementation-of-426 "Direct link to Implementation of") `ToolkitsBindings.getMcpServer` *** ### getMcpServerPrompts()[​](#getmcpserverprompts "Direct link to getMcpServerPrompts()") > **getMcpServerPrompts**: (`wid`, `serverId`) => `Promise`<[`McpServerPromptsResponse`](https://docs.gravityrail.com/sdk/interfaces/McpServerPromptsResponse.md)> Defined in: [packages/sdk/src/client/client.ts:798](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L798) Get prompts for an MCP server. Returns 403 with `detail.code === 'auth_required'` when the current user needs to authenticate first. #### Parameters[​](#parameters-424 "Direct link to Parameters") ##### wid[​](#wid-356 "Direct link to wid") `string` ##### serverId[​](#serverid-4 "Direct link to serverId") `number` #### Returns[​](#returns-428 "Direct link to Returns") `Promise`<[`McpServerPromptsResponse`](https://docs.gravityrail.com/sdk/interfaces/McpServerPromptsResponse.md)> #### Implementation of[​](#implementation-of-427 "Direct link to Implementation of") `ToolkitsBindings.getMcpServerPrompts` *** ### getMcpServerResources()[​](#getmcpserverresources "Direct link to getMcpServerResources()") > **getMcpServerResources**: (`wid`, `serverId`) => `Promise`<[`McpServerResourcesResponse`](https://docs.gravityrail.com/sdk/interfaces/McpServerResourcesResponse.md)> Defined in: [packages/sdk/src/client/client.ts:797](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L797) Get resources for an MCP server. Returns 403 with `detail.code === 'auth_required'` when the current user needs to authenticate first. #### Parameters[​](#parameters-425 "Direct link to Parameters") ##### wid[​](#wid-357 "Direct link to wid") `string` ##### serverId[​](#serverid-5 "Direct link to serverId") `number` #### Returns[​](#returns-429 "Direct link to Returns") `Promise`<[`McpServerResourcesResponse`](https://docs.gravityrail.com/sdk/interfaces/McpServerResourcesResponse.md)> #### Implementation of[​](#implementation-of-428 "Direct link to Implementation of") `ToolkitsBindings.getMcpServerResources` *** ### getMcpServers()[​](#getmcpservers "Direct link to getMcpServers()") > **getMcpServers**: (`wid`) => `Promise`<[`McpServerResponse`](https://docs.gravityrail.com/sdk/interfaces/McpServerResponse.md)\[]> Defined in: [packages/sdk/src/client/client.ts:789](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L789) List all MCP servers in a workspace #### Parameters[​](#parameters-426 "Direct link to Parameters") ##### wid[​](#wid-358 "Direct link to wid") `string` #### Returns[​](#returns-430 "Direct link to Returns") `Promise`<[`McpServerResponse`](https://docs.gravityrail.com/sdk/interfaces/McpServerResponse.md)\[]> #### Implementation of[​](#implementation-of-429 "Direct link to Implementation of") `ToolkitsBindings.getMcpServers` *** ### getMcpServerTools()[​](#getmcpservertools "Direct link to getMcpServerTools()") > **getMcpServerTools**: (`wid`, `serverId`) => `Promise`<[`McpServerToolsResponse`](https://docs.gravityrail.com/sdk/interfaces/McpServerToolsResponse.md)> Defined in: [packages/sdk/src/client/client.ts:796](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L796) Get tools for an MCP server. Returns 403 with `detail.code === 'auth_required'` when the current user needs to authenticate first. #### Parameters[​](#parameters-427 "Direct link to Parameters") ##### wid[​](#wid-359 "Direct link to wid") `string` ##### serverId[​](#serverid-6 "Direct link to serverId") `number` #### Returns[​](#returns-431 "Direct link to Returns") `Promise`<[`McpServerToolsResponse`](https://docs.gravityrail.com/sdk/interfaces/McpServerToolsResponse.md)> #### Implementation of[​](#implementation-of-430 "Direct link to Implementation of") `ToolkitsBindings.getMcpServerTools` *** ### getMemberExperiments()[​](#getmemberexperiments "Direct link to getMemberExperiments()") > **getMemberExperiments**: (`wid`, `memberId`) => `Promise`<`MemberExperimentAssignment`\[]> Defined in: [packages/sdk/src/client/client.ts:366](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L366) List experiment assignments for a member (member profile panel). #### Parameters[​](#parameters-428 "Direct link to Parameters") ##### wid[​](#wid-360 "Direct link to wid") `string` ##### memberId[​](#memberid-17 "Direct link to memberId") `number` #### Returns[​](#returns-432 "Direct link to Returns") `Promise`<`MemberExperimentAssignment`\[]> #### Implementation of[​](#implementation-of-431 "Direct link to Implementation of") `ExperimentsBindings.getMemberExperiments` *** ### getMemberFieldDefinitions()[​](#getmemberfielddefinitions "Direct link to getMemberFieldDefinitions()") > **getMemberFieldDefinitions**: (`wid`) => `Promise`<[`MemberFieldDefinitionListResponse`](https://docs.gravityrail.com/sdk/interfaces/MemberFieldDefinitionListResponse.md)> Defined in: [packages/sdk/src/client/client.ts:258](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L258) Get available field definitions for this workspace. Returns field keys/labels from active app connections and user-created fields. #### Parameters[​](#parameters-429 "Direct link to Parameters") ##### wid[​](#wid-361 "Direct link to wid") `string` #### Returns[​](#returns-433 "Direct link to Returns") `Promise`<[`MemberFieldDefinitionListResponse`](https://docs.gravityrail.com/sdk/interfaces/MemberFieldDefinitionListResponse.md)> #### Implementation of[​](#implementation-of-432 "Direct link to Implementation of") `MembersBindings.getMemberFieldDefinitions` *** ### getMemberFields()[​](#getmemberfields "Direct link to getMemberFields()") > **getMemberFields**: (`wid`, `memberId`) => `Promise`<[`MemberFieldListResponse`](https://docs.gravityrail.com/sdk/interfaces/MemberFieldListResponse.md)> Defined in: [packages/sdk/src/client/client.ts:257](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L257) Get all fields for a member. Returns key-value fields including service-owned fields (which are read-only). #### Parameters[​](#parameters-430 "Direct link to Parameters") ##### wid[​](#wid-362 "Direct link to wid") `string` ##### memberId[​](#memberid-18 "Direct link to memberId") `number` #### Returns[​](#returns-434 "Direct link to Returns") `Promise`<[`MemberFieldListResponse`](https://docs.gravityrail.com/sdk/interfaces/MemberFieldListResponse.md)> #### Implementation of[​](#implementation-of-433 "Direct link to Implementation of") `MembersBindings.getMemberFields` *** ### getMemberFilter()[​](#getmemberfilter "Direct link to getMemberFilter()") > **getMemberFilter**: (`wid`, `filterId`) => `Promise`<[`MemberFilterResponse`](https://docs.gravityrail.com/sdk/interfaces/MemberFilterResponse.md)> Defined in: [packages/sdk/src/client/client.ts:238](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L238) Get a single member filter by ID. #### Parameters[​](#parameters-431 "Direct link to Parameters") ##### wid[​](#wid-363 "Direct link to wid") `string` ##### filterId[​](#filterid-3 "Direct link to filterId") `number` #### Returns[​](#returns-435 "Direct link to Returns") `Promise`<[`MemberFilterResponse`](https://docs.gravityrail.com/sdk/interfaces/MemberFilterResponse.md)> #### Implementation of[​](#implementation-of-434 "Direct link to Implementation of") `MembersBindings.getMemberFilter` *** ### getMemberFilterCount()[​](#getmemberfiltercount "Direct link to getMemberFilterCount()") > **getMemberFilterCount**: (`wid`, `filterId`) => `Promise`<{ `count`: `number`; }> Defined in: [packages/sdk/src/client/client.ts:243](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L243) Get the count of members matching a saved filter. #### Parameters[​](#parameters-432 "Direct link to Parameters") ##### wid[​](#wid-364 "Direct link to wid") `string` ##### filterId[​](#filterid-4 "Direct link to filterId") `number` #### Returns[​](#returns-436 "Direct link to Returns") `Promise`<{ `count`: `number`; }> #### Implementation of[​](#implementation-of-435 "Direct link to Implementation of") `MembersBindings.getMemberFilterCount` *** ### getMemberFilters()[​](#getmemberfilters "Direct link to getMemberFilters()") > **getMemberFilters**: (`wid`) => `Promise`<[`MemberFilterResponse`](https://docs.gravityrail.com/sdk/interfaces/MemberFilterResponse.md)\[]> Defined in: [packages/sdk/src/client/client.ts:237](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L237) List all saved member filters for a workspace. #### Parameters[​](#parameters-433 "Direct link to Parameters") ##### wid[​](#wid-365 "Direct link to wid") `string` #### Returns[​](#returns-437 "Direct link to Returns") `Promise`<[`MemberFilterResponse`](https://docs.gravityrail.com/sdk/interfaces/MemberFilterResponse.md)\[]> #### Implementation of[​](#implementation-of-436 "Direct link to Implementation of") `MembersBindings.getMemberFilters` *** ### getMemberGrants()[​](#getmembergrants "Direct link to getMemberGrants()") > **getMemberGrants**: (`wid`, `memberId`) => `Promise`<[`AccessGrant`](https://docs.gravityrail.com/sdk/type-aliases/AccessGrant.md)\[]> Defined in: [packages/sdk/src/client/client.ts:393](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L393) Get all access grants for a specific member. #### Parameters[​](#parameters-434 "Direct link to Parameters") ##### wid[​](#wid-366 "Direct link to wid") `string` ##### memberId[​](#memberid-19 "Direct link to memberId") `number` #### Returns[​](#returns-438 "Direct link to Returns") `Promise`<[`AccessGrant`](https://docs.gravityrail.com/sdk/type-aliases/AccessGrant.md)\[]> #### Implementation of[​](#implementation-of-437 "Direct link to Implementation of") `AccessGrantsBindings.getMemberGrants` *** ### getMemberJourneys()[​](#getmemberjourneys "Direct link to getMemberJourneys()") > **getMemberJourneys**: (`wid`, `memberId`) => `Promise`<`MemberJourney`\[]> Defined in: [packages/sdk/src/client/client.ts:345](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L345) Get all journey enrollments for a member. #### Parameters[​](#parameters-435 "Direct link to Parameters") ##### wid[​](#wid-367 "Direct link to wid") `string` ##### memberId[​](#memberid-20 "Direct link to memberId") `number` #### Returns[​](#returns-439 "Direct link to Returns") `Promise`<`MemberJourney`\[]> #### Implementation of[​](#implementation-of-438 "Direct link to Implementation of") `JourneysBindings.getMemberJourneys` *** ### getMemberLabel()[​](#getmemberlabel "Direct link to getMemberLabel()") > **getMemberLabel**: (`wid`, `id`) => `Promise`<[`MemberLabelResponse`](https://docs.gravityrail.com/sdk/interfaces/MemberLabelResponse.md)> Defined in: [packages/sdk/src/client/client.ts:245](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L245) Get a single member label by ID. #### Parameters[​](#parameters-436 "Direct link to Parameters") ##### wid[​](#wid-368 "Direct link to wid") `string` ##### id[​](#id-52 "Direct link to id") `number` #### Returns[​](#returns-440 "Direct link to Returns") `Promise`<[`MemberLabelResponse`](https://docs.gravityrail.com/sdk/interfaces/MemberLabelResponse.md)> #### Implementation of[​](#implementation-of-439 "Direct link to Implementation of") `MembersBindings.getMemberLabel` *** ### getMemberLabelByUuid()[​](#getmemberlabelbyuuid "Direct link to getMemberLabelByUuid()") > **getMemberLabelByUuid**: (`wid`, `uuid`) => `Promise`<[`MemberLabelResponse`](https://docs.gravityrail.com/sdk/interfaces/MemberLabelResponse.md)> Defined in: [packages/sdk/src/client/client.ts:246](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L246) Get a single member label by UUID. #### Parameters[​](#parameters-437 "Direct link to Parameters") ##### wid[​](#wid-369 "Direct link to wid") `string` ##### uuid[​](#uuid-15 "Direct link to uuid") `string` #### Returns[​](#returns-441 "Direct link to Returns") `Promise`<[`MemberLabelResponse`](https://docs.gravityrail.com/sdk/interfaces/MemberLabelResponse.md)> #### Implementation of[​](#implementation-of-440 "Direct link to Implementation of") `MembersBindings.getMemberLabelByUuid` *** ### getMemberLabels()[​](#getmemberlabels "Direct link to getMemberLabels()") > **getMemberLabels**: (`wid`) => `Promise`<[`MemberLabelResponse`](https://docs.gravityrail.com/sdk/interfaces/MemberLabelResponse.md)\[]> Defined in: [packages/sdk/src/client/client.ts:244](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L244) List all member labels for a workspace. #### Parameters[​](#parameters-438 "Direct link to Parameters") ##### wid[​](#wid-370 "Direct link to wid") `string` #### Returns[​](#returns-442 "Direct link to Returns") `Promise`<[`MemberLabelResponse`](https://docs.gravityrail.com/sdk/interfaces/MemberLabelResponse.md)\[]> #### Implementation of[​](#implementation-of-441 "Direct link to Implementation of") `MembersBindings.getMemberLabels` *** ### getMemberMemories()[​](#getmembermemories "Direct link to getMemberMemories()") > **getMemberMemories**: (`wid`, `memberId`, `options?`) => `Promise`<[`MemberMemoriesResponse`](https://docs.gravityrail.com/sdk/type-aliases/MemberMemoriesResponse.md)> Defined in: [packages/sdk/src/client/client.ts:272](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L272) #### Parameters[​](#parameters-439 "Direct link to Parameters") ##### wid[​](#wid-371 "Direct link to wid") `string` ##### memberId[​](#memberid-21 "Direct link to memberId") `number` ##### options?[​](#options-22 "Direct link to options?") ###### limit?[​](#limit-7 "Direct link to limit?") `number` ###### query?[​](#query "Direct link to query?") `string` ###### type?[​](#type-1 "Direct link to type?") [`MemoryType`](https://docs.gravityrail.com/sdk/type-aliases/MemoryType.md) | `"all"` #### Returns[​](#returns-443 "Direct link to Returns") `Promise`<[`MemberMemoriesResponse`](https://docs.gravityrail.com/sdk/type-aliases/MemberMemoriesResponse.md)> #### Implementation of[​](#implementation-of-442 "Direct link to Implementation of") `MembersBindings.getMemberMemories` *** ### getMemberMemory()[​](#getmembermemory "Direct link to getMemberMemory()") > **getMemberMemory**: (`wid`, `memberId`, `key`) => `Promise`<[`GeneratedMemoryResponse`](https://docs.gravityrail.com/sdk/interfaces/GeneratedMemoryResponse.md)> Defined in: [packages/sdk/src/client/client.ts:273](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L273) #### Parameters[​](#parameters-440 "Direct link to Parameters") ##### wid[​](#wid-372 "Direct link to wid") `string` ##### memberId[​](#memberid-22 "Direct link to memberId") `number` ##### key[​](#key-1 "Direct link to key") `string` #### Returns[​](#returns-444 "Direct link to Returns") `Promise`<[`GeneratedMemoryResponse`](https://docs.gravityrail.com/sdk/interfaces/GeneratedMemoryResponse.md)> #### Implementation of[​](#implementation-of-443 "Direct link to Implementation of") `MembersBindings.getMemberMemory` *** ### getMemberRecordCounts()[​](#getmemberrecordcounts "Direct link to getMemberRecordCounts()") > **getMemberRecordCounts**: (`wid`, `memberId`) => `Promise`<{ `counts`: `Record`<`number`, `number`>; }> Defined in: [packages/sdk/src/client/client.ts:216](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L216) Get record counts per data type for a specific member. Returns a mapping of data type ID to record count. #### Parameters[​](#parameters-441 "Direct link to Parameters") ##### wid[​](#wid-373 "Direct link to wid") `string` ##### memberId[​](#memberid-23 "Direct link to memberId") `number` #### Returns[​](#returns-445 "Direct link to Returns") `Promise`<{ `counts`: `Record`<`number`, `number`>; }> #### Implementation of[​](#implementation-of-444 "Direct link to Implementation of") `DataTypesBindings.getMemberRecordCounts` *** ### getMemberRole()[​](#getmemberrole "Direct link to getMemberRole()") > **getMemberRole**: (`wid`, `id`) => `Promise`<[`MemberRoleResponse`](https://docs.gravityrail.com/sdk/interfaces/MemberRoleResponse.md)> Defined in: [packages/sdk/src/client/client.ts:251](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L251) Get a single member role by ID. #### Parameters[​](#parameters-442 "Direct link to Parameters") ##### wid[​](#wid-374 "Direct link to wid") `string` ##### id[​](#id-53 "Direct link to id") `number` #### Returns[​](#returns-446 "Direct link to Returns") `Promise`<[`MemberRoleResponse`](https://docs.gravityrail.com/sdk/interfaces/MemberRoleResponse.md)> #### Implementation of[​](#implementation-of-445 "Direct link to Implementation of") `MembersBindings.getMemberRole` *** ### getMemberRoleByUuid()[​](#getmemberrolebyuuid "Direct link to getMemberRoleByUuid()") > **getMemberRoleByUuid**: (`wid`, `uuid`) => `Promise`<[`MemberRoleResponse`](https://docs.gravityrail.com/sdk/interfaces/MemberRoleResponse.md)> Defined in: [packages/sdk/src/client/client.ts:252](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L252) Get a single member role by UUID. #### Parameters[​](#parameters-443 "Direct link to Parameters") ##### wid[​](#wid-375 "Direct link to wid") `string` ##### uuid[​](#uuid-16 "Direct link to uuid") `string` #### Returns[​](#returns-447 "Direct link to Returns") `Promise`<[`MemberRoleResponse`](https://docs.gravityrail.com/sdk/interfaces/MemberRoleResponse.md)> #### Implementation of[​](#implementation-of-446 "Direct link to Implementation of") `MembersBindings.getMemberRoleByUuid` *** ### getMemberRoles()[​](#getmemberroles "Direct link to getMemberRoles()") > **getMemberRoles**: (`wid`) => `Promise`<[`MemberRoleResponse`](https://docs.gravityrail.com/sdk/interfaces/MemberRoleResponse.md)\[]> Defined in: [packages/sdk/src/client/client.ts:250](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L250) List all member roles for a workspace. #### Parameters[​](#parameters-444 "Direct link to Parameters") ##### wid[​](#wid-376 "Direct link to wid") `string` #### Returns[​](#returns-448 "Direct link to Returns") `Promise`<[`MemberRoleResponse`](https://docs.gravityrail.com/sdk/interfaces/MemberRoleResponse.md)\[]> #### Implementation of[​](#implementation-of-447 "Direct link to Implementation of") `MembersBindings.getMemberRoles` *** ### getMembersMessageActivity()[​](#getmembersmessageactivity "Direct link to getMembersMessageActivity()") > **getMembersMessageActivity**: (`wid`, `memberIds`, `days`) => `Promise`<`Record`<`number`, `number`\[]>> Defined in: [packages/sdk/src/client/client.ts:236](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L236) Get message activity counts for the specified members over a time period. #### Parameters[​](#parameters-445 "Direct link to Parameters") ##### wid[​](#wid-377 "Direct link to wid") `string` ##### memberIds[​](#memberids-1 "Direct link to memberIds") `number`\[] ##### days?[​](#days "Direct link to days?") `number` = `30` #### Returns[​](#returns-449 "Direct link to Returns") `Promise`<`Record`<`number`, `number`\[]>> #### Implementation of[​](#implementation-of-448 "Direct link to Implementation of") `MembersBindings.getMembersMessageActivity` *** ### getMemberSyncLinks()[​](#getmembersynclinks "Direct link to getMemberSyncLinks()") > **getMemberSyncLinks**: (`wid`, `memberId`) => `Promise`<[`MemberSyncLink`](https://docs.gravityrail.com/sdk/interfaces/MemberSyncLink.md)\[]> Defined in: [packages/sdk/src/client/client.ts:277](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L277) Get all sync links for a member across app connections. #### Parameters[​](#parameters-446 "Direct link to Parameters") ##### wid[​](#wid-378 "Direct link to wid") `string` ##### memberId[​](#memberid-24 "Direct link to memberId") `number` #### Returns[​](#returns-450 "Direct link to Returns") `Promise`<[`MemberSyncLink`](https://docs.gravityrail.com/sdk/interfaces/MemberSyncLink.md)\[]> #### Implementation of[​](#implementation-of-449 "Direct link to Implementation of") `MembersBindings.getMemberSyncLinks` *** ### getMemberSyncSummary()[​](#getmembersyncsummary "Direct link to getMemberSyncSummary()") > **getMemberSyncSummary**: (`wid`, `connectionId`) => `Promise`<`MemberSyncSummary`> Defined in: [packages/sdk/src/client/client.ts:1029](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L1029) #### Parameters[​](#parameters-447 "Direct link to Parameters") ##### wid[​](#wid-379 "Direct link to wid") `string` ##### connectionId[​](#connectionid-30 "Direct link to connectionId") `number` #### Returns[​](#returns-451 "Direct link to Returns") `Promise`<`MemberSyncSummary`> #### Implementation of[​](#implementation-of-450 "Direct link to Implementation of") `IntegrationsBindings.getMemberSyncSummary` *** ### getMemberUsage()[​](#getmemberusage "Direct link to getMemberUsage()") > **getMemberUsage**: (`wid`, `memberId`, `params?`) => `Promise`<`MemberUsageReport`> Defined in: [packages/sdk/src/client/client.ts:825](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L825) Get usage report for a specific member within an optional date range. #### Parameters[​](#parameters-448 "Direct link to Parameters") ##### wid[​](#wid-380 "Direct link to wid") `string` ##### memberId[​](#memberid-25 "Direct link to memberId") `number` ##### params?[​](#params-19 "Direct link to params?") `MemberUsageReportParams` #### Returns[​](#returns-452 "Direct link to Returns") `Promise`<`MemberUsageReport`> #### Implementation of[​](#implementation-of-451 "Direct link to Implementation of") `BillingBindings.getMemberUsage` *** ### getMenuItems()[​](#getmenuitems "Direct link to getMenuItems()") > **getMenuItems**: (`wid`, `siteId`, `parentId?`) => `Promise`<[`MenuItemResponse`](https://docs.gravityrail.com/sdk/interfaces/MenuItemResponse.md)\[]> Defined in: [packages/sdk/src/client/client.ts:579](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L579) List menu items for a site, optionally filtered by parent item. #### Parameters[​](#parameters-449 "Direct link to Parameters") ##### wid[​](#wid-381 "Direct link to wid") `string` ##### siteId[​](#siteid-9 "Direct link to siteId") `number` ##### parentId?[​](#parentid "Direct link to parentId?") `number` | `null` #### Returns[​](#returns-453 "Direct link to Returns") `Promise`<[`MenuItemResponse`](https://docs.gravityrail.com/sdk/interfaces/MenuItemResponse.md)\[]> #### Implementation of[​](#implementation-of-452 "Direct link to Implementation of") `SitesBindings.getMenuItems` *** ### getMessageTiming()[​](#getmessagetiming "Direct link to getMessageTiming()") > **getMessageTiming**: (`wid`, `chatId`) => `Promise`<[`MessageTimingResponse`](https://docs.gravityrail.com/sdk/interfaces/MessageTimingResponse.md)> Defined in: [packages/sdk/src/client/client.ts:190](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L190) Get message timing data for a chat recording. #### Parameters[​](#parameters-450 "Direct link to Parameters") ##### wid[​](#wid-382 "Direct link to wid") `string` ##### chatId[​](#chatid-13 "Direct link to chatId") `number` #### Returns[​](#returns-454 "Direct link to Returns") `Promise`<[`MessageTimingResponse`](https://docs.gravityrail.com/sdk/interfaces/MessageTimingResponse.md)> #### Implementation of[​](#implementation-of-453 "Direct link to Implementation of") `CallsBindings.getMessageTiming` *** ### getMilestone()[​](#getmilestone "Direct link to getMilestone()") > **getMilestone**: (`wid`, `id`) => `Promise`<[`Milestone`](https://docs.gravityrail.com/sdk/interfaces/Milestone.md)> Defined in: [packages/sdk/src/client/client.ts:725](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L725) Get a single milestone by ID. #### Parameters[​](#parameters-451 "Direct link to Parameters") ##### wid[​](#wid-383 "Direct link to wid") `string` ##### id[​](#id-54 "Direct link to id") `number` #### Returns[​](#returns-455 "Direct link to Returns") `Promise`<[`Milestone`](https://docs.gravityrail.com/sdk/interfaces/Milestone.md)> #### Implementation of[​](#implementation-of-454 "Direct link to Implementation of") `CalendarsBindings.getMilestone` *** ### getMilestones()[​](#getmilestones "Direct link to getMilestones()") > **getMilestones**: (`wid`, `options`) => `Promise`<[`PaginatedResponse`](https://docs.gravityrail.com/sdk/interfaces/PaginatedResponse.md)<[`Milestone`](https://docs.gravityrail.com/sdk/interfaces/Milestone.md)>> Defined in: [packages/sdk/src/client/client.ts:724](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L724) List milestones in a workspace with optional pagination and sorting. #### Parameters[​](#parameters-452 "Direct link to Parameters") ##### wid[​](#wid-384 "Direct link to wid") `string` ##### options?[​](#options-23 "Direct link to options?") ###### page?[​](#page-26 "Direct link to page?") `number` ###### pageSize?[​](#pagesize-26 "Direct link to pageSize?") `number` ###### search?[​](#search-11 "Direct link to search?") `string` ###### sortBy?[​](#sortby-4 "Direct link to sortBy?") [`MilestoneSortField`](https://docs.gravityrail.com/sdk/type-aliases/MilestoneSortField.md) ###### sortOrder?[​](#sortorder-4 "Direct link to sortOrder?") [`SortOrder`](https://docs.gravityrail.com/sdk/type-aliases/SortOrder.md) #### Returns[​](#returns-456 "Direct link to Returns") `Promise`<[`PaginatedResponse`](https://docs.gravityrail.com/sdk/interfaces/PaginatedResponse.md)<[`Milestone`](https://docs.gravityrail.com/sdk/interfaces/Milestone.md)>> #### Implementation of[​](#implementation-of-455 "Direct link to Implementation of") `CalendarsBindings.getMilestones` *** ### getMondayBoardColumns()[​](#getmondayboardcolumns "Direct link to getMondayBoardColumns()") > **getMondayBoardColumns**: (`wid`, `boardId`) => `Promise`<[`ColumnsResponse`](https://docs.gravityrail.com/sdk/interfaces/ColumnsResponse.md)> Defined in: [packages/sdk/src/client/client.ts:858](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L858) Get columns for a specific Monday.com board #### Parameters[​](#parameters-453 "Direct link to Parameters") ##### wid[​](#wid-385 "Direct link to wid") `string` ##### boardId[​](#boardid-2 "Direct link to boardId") `string` #### Returns[​](#returns-457 "Direct link to Returns") `Promise`<[`ColumnsResponse`](https://docs.gravityrail.com/sdk/interfaces/ColumnsResponse.md)> #### Implementation of[​](#implementation-of-456 "Direct link to Implementation of") `IntegrationsBindings.getMondayBoardColumns` *** ### getMondayBoardGroups()[​](#getmondayboardgroups "Direct link to getMondayBoardGroups()") > **getMondayBoardGroups**: (`wid`, `boardId`) => `Promise`<[`GroupsResponse`](https://docs.gravityrail.com/sdk/interfaces/GroupsResponse.md)> Defined in: [packages/sdk/src/client/client.ts:859](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L859) Get groups for a specific Monday.com board #### Parameters[​](#parameters-454 "Direct link to Parameters") ##### wid[​](#wid-386 "Direct link to wid") `string` ##### boardId[​](#boardid-3 "Direct link to boardId") `string` #### Returns[​](#returns-458 "Direct link to Returns") `Promise`<[`GroupsResponse`](https://docs.gravityrail.com/sdk/interfaces/GroupsResponse.md)> #### Implementation of[​](#implementation-of-457 "Direct link to Implementation of") `IntegrationsBindings.getMondayBoardGroups` *** ### getMondayBoards()[​](#getmondayboards "Direct link to getMondayBoards()") > **getMondayBoards**: (`wid`) => `Promise`<[`BoardsResponse`](https://docs.gravityrail.com/sdk/interfaces/BoardsResponse.md)> Defined in: [packages/sdk/src/client/client.ts:857](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L857) Get list of boards from the workspace Monday.com connection #### Parameters[​](#parameters-455 "Direct link to Parameters") ##### wid[​](#wid-387 "Direct link to wid") `string` #### Returns[​](#returns-459 "Direct link to Returns") `Promise`<[`BoardsResponse`](https://docs.gravityrail.com/sdk/interfaces/BoardsResponse.md)> #### Implementation of[​](#implementation-of-458 "Direct link to Implementation of") `IntegrationsBindings.getMondayBoards` *** ### getMondayConnectionBoardColumns()[​](#getmondayconnectionboardcolumns "Direct link to getMondayConnectionBoardColumns()") > **getMondayConnectionBoardColumns**: (`wid`, `boardId`) => `Promise`<[`MondayColumn`](https://docs.gravityrail.com/sdk/interfaces/MondayColumn.md)\[]> Defined in: [packages/sdk/src/client/client.ts:872](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L872) #### Parameters[​](#parameters-456 "Direct link to Parameters") ##### wid[​](#wid-388 "Direct link to wid") `string` ##### boardId[​](#boardid-4 "Direct link to boardId") `string` #### Returns[​](#returns-460 "Direct link to Returns") `Promise`<[`MondayColumn`](https://docs.gravityrail.com/sdk/interfaces/MondayColumn.md)\[]> #### Implementation of[​](#implementation-of-459 "Direct link to Implementation of") `IntegrationsBindings.getMondayConnectionBoardColumns` *** ### getMondayConnectionBoardGroups()[​](#getmondayconnectionboardgroups "Direct link to getMondayConnectionBoardGroups()") > **getMondayConnectionBoardGroups**: (`wid`, `boardId`) => `Promise`<[`MondayGroup`](https://docs.gravityrail.com/sdk/interfaces/MondayGroup.md)\[]> Defined in: [packages/sdk/src/client/client.ts:873](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L873) #### Parameters[​](#parameters-457 "Direct link to Parameters") ##### wid[​](#wid-389 "Direct link to wid") `string` ##### boardId[​](#boardid-5 "Direct link to boardId") `string` #### Returns[​](#returns-461 "Direct link to Returns") `Promise`<[`MondayGroup`](https://docs.gravityrail.com/sdk/interfaces/MondayGroup.md)\[]> #### Implementation of[​](#implementation-of-460 "Direct link to Implementation of") `IntegrationsBindings.getMondayConnectionBoardGroups` *** ### getMondayConnectionBoards()[​](#getmondayconnectionboards "Direct link to getMondayConnectionBoards()") > **getMondayConnectionBoards**: (`wid`) => `Promise`<[`MondayBoard`](https://docs.gravityrail.com/sdk/interfaces/MondayBoard.md)\[]> Defined in: [packages/sdk/src/client/client.ts:871](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L871) #### Parameters[​](#parameters-458 "Direct link to Parameters") ##### wid[​](#wid-390 "Direct link to wid") `string` #### Returns[​](#returns-462 "Direct link to Returns") `Promise`<[`MondayBoard`](https://docs.gravityrail.com/sdk/interfaces/MondayBoard.md)\[]> #### Implementation of[​](#implementation-of-461 "Direct link to Implementation of") `IntegrationsBindings.getMondayConnectionBoards` *** ### getMondayConnectionStatus()[​](#getmondayconnectionstatus "Direct link to getMondayConnectionStatus()") > **getMondayConnectionStatus**: (`wid`) => `Promise`<`MondayConnectionStatus`> Defined in: [packages/sdk/src/client/client.ts:864](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L864) #### Parameters[​](#parameters-459 "Direct link to Parameters") ##### wid[​](#wid-391 "Direct link to wid") `string` #### Returns[​](#returns-463 "Direct link to Returns") `Promise`<`MondayConnectionStatus`> #### Implementation of[​](#implementation-of-462 "Direct link to Implementation of") `IntegrationsBindings.getMondayConnectionStatus` *** ### getMondayCurrentUserInfo()[​](#getmondaycurrentuserinfo "Direct link to getMondayCurrentUserInfo()") > **getMondayCurrentUserInfo**: (`wid`) => `Promise`<[`MondayCurrentUserInfoResponse`](https://docs.gravityrail.com/sdk/interfaces/MondayCurrentUserInfoResponse.md)> Defined in: [packages/sdk/src/client/client.ts:860](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L860) Get info about the current user's Monday.com connection #### Parameters[​](#parameters-460 "Direct link to Parameters") ##### wid[​](#wid-392 "Direct link to wid") `string` #### Returns[​](#returns-464 "Direct link to Returns") `Promise`<[`MondayCurrentUserInfoResponse`](https://docs.gravityrail.com/sdk/interfaces/MondayCurrentUserInfoResponse.md)> #### Implementation of[​](#implementation-of-463 "Direct link to Implementation of") `IntegrationsBindings.getMondayCurrentUserInfo` *** ### getMondayReconciliationMatches()[​](#getmondayreconciliationmatches "Direct link to getMondayReconciliationMatches()") > **getMondayReconciliationMatches**: (`wid`, `params?`) => `Promise`<`MondayReconciliationMatch`\[]> Defined in: [packages/sdk/src/client/client.ts:877](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L877) #### Parameters[​](#parameters-461 "Direct link to Parameters") ##### wid[​](#wid-393 "Direct link to wid") `string` ##### params?[​](#params-20 "Direct link to params?") ###### limit?[​](#limit-8 "Direct link to limit?") `number` ###### offset?[​](#offset-4 "Direct link to offset?") `number` #### Returns[​](#returns-465 "Direct link to Returns") `Promise`<`MondayReconciliationMatch`\[]> #### Implementation of[​](#implementation-of-464 "Direct link to Implementation of") `IntegrationsBindings.getMondayReconciliationMatches` *** ### getMondaySyncConfig()[​](#getmondaysyncconfig "Direct link to getMondaySyncConfig()") > **getMondaySyncConfig**: (`wid`) => `Promise`<`MondaySyncConfigResponse`> Defined in: [packages/sdk/src/client/client.ts:874](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L874) #### Parameters[​](#parameters-462 "Direct link to Parameters") ##### wid[​](#wid-394 "Direct link to wid") `string` #### Returns[​](#returns-466 "Direct link to Returns") `Promise`<`MondaySyncConfigResponse`> #### Implementation of[​](#implementation-of-465 "Direct link to Implementation of") `IntegrationsBindings.getMondaySyncConfig` *** ### getMyCredentials()[​](#getmycredentials "Direct link to getMyCredentials()") > **getMyCredentials**: (`wid`) => `Promise`<[`MemberCredential`](https://docs.gravityrail.com/sdk/interfaces/MemberCredential.md)\[]> Defined in: [packages/sdk/src/client/client.ts:897](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L897) Get the current member's credentials (connected accounts). #### Parameters[​](#parameters-463 "Direct link to Parameters") ##### wid[​](#wid-395 "Direct link to wid") `string` #### Returns[​](#returns-467 "Direct link to Returns") `Promise`<[`MemberCredential`](https://docs.gravityrail.com/sdk/interfaces/MemberCredential.md)\[]> #### Implementation of[​](#implementation-of-466 "Direct link to Implementation of") `IntegrationsBindings.getMyCredentials` *** ### getMyCustomer()[​](#getmycustomer "Direct link to getMyCustomer()") > **getMyCustomer**: (`uuid`) => `Promise`<`MyCustomerResponse`> Defined in: [packages/sdk/src/client/client.ts:1059](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L1059) #### Parameters[​](#parameters-464 "Direct link to Parameters") ##### uuid[​](#uuid-17 "Direct link to uuid") `string` #### Returns[​](#returns-468 "Direct link to Returns") `Promise`<`MyCustomerResponse`> #### Implementation of[​](#implementation-of-467 "Direct link to Implementation of") `CustomersBindings.getMyCustomer` *** ### getMyCustomerAccounts()[​](#getmycustomeraccounts "Direct link to getMyCustomerAccounts()") > **getMyCustomerAccounts**: (`uuid`) => `Promise`<`CustomerAccount`\[]> Defined in: [packages/sdk/src/client/client.ts:1060](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L1060) #### Parameters[​](#parameters-465 "Direct link to Parameters") ##### uuid[​](#uuid-18 "Direct link to uuid") `string` #### Returns[​](#returns-469 "Direct link to Returns") `Promise`<`CustomerAccount`\[]> #### Implementation of[​](#implementation-of-468 "Direct link to Implementation of") `CustomersBindings.getMyCustomerAccounts` *** ### getMyCustomerCreditGrants()[​](#getmycustomercreditgrants "Direct link to getMyCustomerCreditGrants()") > **getMyCustomerCreditGrants**: (`uuid`, `opts?`) => `Promise`<`CreditGrantListResponse`> Defined in: [packages/sdk/src/client/client.ts:1069](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L1069) #### Parameters[​](#parameters-466 "Direct link to Parameters") ##### uuid[​](#uuid-19 "Direct link to uuid") `string` ##### opts?[​](#opts-1 "Direct link to opts?") ###### page?[​](#page-27 "Direct link to page?") `number` ###### pageSize?[​](#pagesize-27 "Direct link to pageSize?") `number` ###### subscriptionId?[​](#subscriptionid-2 "Direct link to subscriptionId?") `number` #### Returns[​](#returns-470 "Direct link to Returns") `Promise`<`CreditGrantListResponse`> #### Implementation of[​](#implementation-of-469 "Direct link to Implementation of") `CustomersBindings.getMyCustomerCreditGrants` *** ### getMyCustomerInvoices()[​](#getmycustomerinvoices "Direct link to getMyCustomerInvoices()") > **getMyCustomerInvoices**: (`uuid`) => `Promise`<`InvoiceResponse`\[]> Defined in: [packages/sdk/src/client/client.ts:1062](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L1062) #### Parameters[​](#parameters-467 "Direct link to Parameters") ##### uuid[​](#uuid-20 "Direct link to uuid") `string` #### Returns[​](#returns-471 "Direct link to Returns") `Promise`<`InvoiceResponse`\[]> #### Implementation of[​](#implementation-of-470 "Direct link to Implementation of") `CustomersBindings.getMyCustomerInvoices` *** ### getMyCustomerPaymentMethods()[​](#getmycustomerpaymentmethods "Direct link to getMyCustomerPaymentMethods()") > **getMyCustomerPaymentMethods**: (`uuid`) => `Promise`<[`StripePaymentMethod`](https://docs.gravityrail.com/sdk/interfaces/StripePaymentMethod.md)\[]> Defined in: [packages/sdk/src/client/client.ts:1065](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L1065) #### Parameters[​](#parameters-468 "Direct link to Parameters") ##### uuid[​](#uuid-21 "Direct link to uuid") `string` #### Returns[​](#returns-472 "Direct link to Returns") `Promise`<[`StripePaymentMethod`](https://docs.gravityrail.com/sdk/interfaces/StripePaymentMethod.md)\[]> #### Implementation of[​](#implementation-of-471 "Direct link to Implementation of") `CustomersBindings.getMyCustomerPaymentMethods` *** ### getMyCustomers()[​](#getmycustomers "Direct link to getMyCustomers()") > **getMyCustomers**: () => `Promise`<`MyCustomerResponse`\[]> Defined in: [packages/sdk/src/client/client.ts:1058](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L1058) #### Returns[​](#returns-473 "Direct link to Returns") `Promise`<`MyCustomerResponse`\[]> #### Implementation of[​](#implementation-of-472 "Direct link to Implementation of") `CustomersBindings.getMyCustomers` *** ### getMyCustomerSubscriptions()[​](#getmycustomersubscriptions "Direct link to getMyCustomerSubscriptions()") > **getMyCustomerSubscriptions**: (`uuid`, `opts?`) => `Promise`<{ `items`: `SubscriptionResponse`\[]; `page`: `number`; `pageSize`: `number`; `total`: `number`; }> Defined in: [packages/sdk/src/client/client.ts:1061](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L1061) #### Parameters[​](#parameters-469 "Direct link to Parameters") ##### uuid[​](#uuid-22 "Direct link to uuid") `string` ##### opts?[​](#opts-2 "Direct link to opts?") ###### page?[​](#page-28 "Direct link to page?") `number` ###### pageSize?[​](#pagesize-28 "Direct link to pageSize?") `number` ###### status?[​](#status-4 "Direct link to status?") `string` #### Returns[​](#returns-474 "Direct link to Returns") `Promise`<{ `items`: `SubscriptionResponse`\[]; `page`: `number`; `pageSize`: `number`; `total`: `number`; }> #### Implementation of[​](#implementation-of-473 "Direct link to Implementation of") `CustomersBindings.getMyCustomerSubscriptions` *** ### getMyGivenGrants()[​](#getmygivengrants "Direct link to getMyGivenGrants()") > **getMyGivenGrants**: (`wid`, `params?`) => `Promise`<[`PaginatedResponse`](https://docs.gravityrail.com/sdk/interfaces/PaginatedResponse.md)<[`AccessGrant`](https://docs.gravityrail.com/sdk/type-aliases/AccessGrant.md)>> Defined in: [packages/sdk/src/client/client.ts:387](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L387) List access grants given by the current member. #### Parameters[​](#parameters-470 "Direct link to Parameters") ##### wid[​](#wid-396 "Direct link to wid") `string` ##### params?[​](#params-21 "Direct link to params?") ###### page?[​](#page-29 "Direct link to page?") `number` ###### pageSize?[​](#pagesize-29 "Direct link to pageSize?") `number` ###### status?[​](#status-5 "Direct link to status?") `string` #### Returns[​](#returns-475 "Direct link to Returns") `Promise`<[`PaginatedResponse`](https://docs.gravityrail.com/sdk/interfaces/PaginatedResponse.md)<[`AccessGrant`](https://docs.gravityrail.com/sdk/type-aliases/AccessGrant.md)>> #### Implementation of[​](#implementation-of-474 "Direct link to Implementation of") `AccessGrantsBindings.getMyGivenGrants` *** ### getMyOrganizations()[​](#getmyorganizations "Direct link to getMyOrganizations()") > **getMyOrganizations**: () => `Promise`<`AdminAccountOrgMembershipResponse`\[]> Defined in: [packages/sdk/src/client/client.ts:518](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L518) List all organizations the current account belongs to. #### Returns[​](#returns-476 "Direct link to Returns") `Promise`<`AdminAccountOrgMembershipResponse`\[]> #### Implementation of[​](#implementation-of-475 "Direct link to Implementation of") `AuthBindings.getMyOrganizations` *** ### getMyPronunciations()[​](#getmypronunciations "Direct link to getMyPronunciations()") > **getMyPronunciations**: () => `Promise`<[`PronunciationEntryResponse`](https://docs.gravityrail.com/sdk/interfaces/PronunciationEntryResponse.md)\[]> Defined in: [packages/sdk/src/client/client.ts:1049](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L1049) List the current user's personal pronunciation entries. #### Returns[​](#returns-477 "Direct link to Returns") `Promise`<[`PronunciationEntryResponse`](https://docs.gravityrail.com/sdk/interfaces/PronunciationEntryResponse.md)\[]> #### Implementation of[​](#implementation-of-476 "Direct link to Implementation of") `PronunciationsBindings.getMyPronunciations` *** ### getMyReceivedGrants()[​](#getmyreceivedgrants "Direct link to getMyReceivedGrants()") > **getMyReceivedGrants**: (`wid`, `params?`) => `Promise`<[`PaginatedResponse`](https://docs.gravityrail.com/sdk/interfaces/PaginatedResponse.md)<[`AccessGrant`](https://docs.gravityrail.com/sdk/type-aliases/AccessGrant.md)>> Defined in: [packages/sdk/src/client/client.ts:386](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L386) List access grants received by the current member. #### Parameters[​](#parameters-471 "Direct link to Parameters") ##### wid[​](#wid-397 "Direct link to wid") `string` ##### params?[​](#params-22 "Direct link to params?") ###### page?[​](#page-30 "Direct link to page?") `number` ###### pageSize?[​](#pagesize-30 "Direct link to pageSize?") `number` ###### status?[​](#status-6 "Direct link to status?") `string` #### Returns[​](#returns-478 "Direct link to Returns") `Promise`<[`PaginatedResponse`](https://docs.gravityrail.com/sdk/interfaces/PaginatedResponse.md)<[`AccessGrant`](https://docs.gravityrail.com/sdk/type-aliases/AccessGrant.md)>> #### Implementation of[​](#implementation-of-477 "Direct link to Implementation of") `AccessGrantsBindings.getMyReceivedGrants` *** ### getMyReseller()[​](#getmyreseller "Direct link to getMyReseller()") > **getMyReseller**: (`uuid`) => `Promise`<`MyResellerResponse`> Defined in: [packages/sdk/src/client/client.ts:1073](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L1073) #### Parameters[​](#parameters-472 "Direct link to Parameters") ##### uuid[​](#uuid-23 "Direct link to uuid") `string` #### Returns[​](#returns-479 "Direct link to Returns") `Promise`<`MyResellerResponse`> #### Implementation of[​](#implementation-of-478 "Direct link to Implementation of") `ResellersBindings.getMyReseller` *** ### getMyResellerAccounts()[​](#getmyreselleraccounts "Direct link to getMyResellerAccounts()") > **getMyResellerAccounts**: (`uuid`) => `Promise`<`ResellerAccount`\[]> Defined in: [packages/sdk/src/client/client.ts:1074](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L1074) #### Parameters[​](#parameters-473 "Direct link to Parameters") ##### uuid[​](#uuid-24 "Direct link to uuid") `string` #### Returns[​](#returns-480 "Direct link to Returns") `Promise`<`ResellerAccount`\[]> #### Implementation of[​](#implementation-of-479 "Direct link to Implementation of") `ResellersBindings.getMyResellerAccounts` *** ### getMyResellerProducts()[​](#getmyresellerproducts "Direct link to getMyResellerProducts()") > **getMyResellerProducts**: (`uuid`) => `Promise`<[`Product`](https://docs.gravityrail.com/sdk/type-aliases/Product.md)\[]> Defined in: [packages/sdk/src/client/client.ts:1075](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L1075) #### Parameters[​](#parameters-474 "Direct link to Parameters") ##### uuid[​](#uuid-25 "Direct link to uuid") `string` #### Returns[​](#returns-481 "Direct link to Returns") `Promise`<[`Product`](https://docs.gravityrail.com/sdk/type-aliases/Product.md)\[]> #### Implementation of[​](#implementation-of-480 "Direct link to Implementation of") `ResellersBindings.getMyResellerProducts` *** ### getMyResellers()[​](#getmyresellers "Direct link to getMyResellers()") > **getMyResellers**: () => `Promise`<`MyResellerResponse`\[]> Defined in: [packages/sdk/src/client/client.ts:1072](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L1072) #### Returns[​](#returns-482 "Direct link to Returns") `Promise`<`MyResellerResponse`\[]> #### Implementation of[​](#implementation-of-481 "Direct link to Implementation of") `ResellersBindings.getMyResellers` *** ### getMyResellerSubscriptions()[​](#getmyresellersubscriptions "Direct link to getMyResellerSubscriptions()") > **getMyResellerSubscriptions**: (`uuid`, `opts?`) => `Promise`<{ `items`: `SubscriptionResponse`\[]; `page`: `number`; `pageSize`: `number`; `total`: `number`; }> Defined in: [packages/sdk/src/client/client.ts:1076](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L1076) #### Parameters[​](#parameters-475 "Direct link to Parameters") ##### uuid[​](#uuid-26 "Direct link to uuid") `string` ##### opts?[​](#opts-3 "Direct link to opts?") ###### page?[​](#page-31 "Direct link to page?") `number` ###### pageSize?[​](#pagesize-31 "Direct link to pageSize?") `number` ###### status?[​](#status-7 "Direct link to status?") `string` #### Returns[​](#returns-483 "Direct link to Returns") `Promise`<{ `items`: `SubscriptionResponse`\[]; `page`: `number`; `pageSize`: `number`; `total`: `number`; }> #### Implementation of[​](#implementation-of-482 "Direct link to Implementation of") `ResellersBindings.getMyResellerSubscriptions` *** ### getNotification()[​](#getnotification "Direct link to getNotification()") > **getNotification**: (`wid`, `id`) => `Promise`<[`NotificationResponse`](https://docs.gravityrail.com/sdk/interfaces/NotificationResponse.md)> Defined in: [packages/sdk/src/client/client.ts:416](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L416) Get a single notification by ID. #### Parameters[​](#parameters-476 "Direct link to Parameters") ##### wid[​](#wid-398 "Direct link to wid") `string` ##### id[​](#id-55 "Direct link to id") `number` #### Returns[​](#returns-484 "Direct link to Returns") `Promise`<[`NotificationResponse`](https://docs.gravityrail.com/sdk/interfaces/NotificationResponse.md)> #### Implementation of[​](#implementation-of-483 "Direct link to Implementation of") `WorkspacesBindings.getNotification` *** ### getNotificationRules()[​](#getnotificationrules "Direct link to getNotificationRules()") > **getNotificationRules**: (`wid`) => `Promise`<[`NotificationRule`](https://docs.gravityrail.com/sdk/interfaces/NotificationRule.md)\[]> Defined in: [packages/sdk/src/client/client.ts:762](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L762) List all notification rules in a workspace. #### Parameters[​](#parameters-477 "Direct link to Parameters") ##### wid[​](#wid-399 "Direct link to wid") `string` #### Returns[​](#returns-485 "Direct link to Returns") `Promise`<[`NotificationRule`](https://docs.gravityrail.com/sdk/interfaces/NotificationRule.md)\[]> #### Implementation of[​](#implementation-of-484 "Direct link to Implementation of") `CommunicationsBindings.getNotificationRules` *** ### getNotifications()[​](#getnotifications "Direct link to getNotifications()") > **getNotifications**: (`wid`, `options`) => `Promise`<[`PaginatedResponse`](https://docs.gravityrail.com/sdk/interfaces/PaginatedResponse.md)<[`NotificationResponse`](https://docs.gravityrail.com/sdk/interfaces/NotificationResponse.md)>> Defined in: [packages/sdk/src/client/client.ts:415](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L415) List notifications for the current user in a workspace. #### Parameters[​](#parameters-478 "Direct link to Parameters") ##### wid[​](#wid-400 "Direct link to wid") `string` ##### options?[​](#options-24 "Direct link to options?") ###### page?[​](#page-32 "Direct link to page?") `number` ###### pageSize?[​](#pagesize-32 "Direct link to pageSize?") `number` #### Returns[​](#returns-486 "Direct link to Returns") `Promise`<[`PaginatedResponse`](https://docs.gravityrail.com/sdk/interfaces/PaginatedResponse.md)<[`NotificationResponse`](https://docs.gravityrail.com/sdk/interfaces/NotificationResponse.md)>> #### Implementation of[​](#implementation-of-485 "Direct link to Implementation of") `WorkspacesBindings.getNotifications` *** ### getOAuthAuthorizationUrl()[​](#getoauthauthorizationurl "Direct link to getOAuthAuthorizationUrl()") > **getOAuthAuthorizationUrl**: (`providerSlug`, `options?`) => `Promise`<[`OAuthAuthorizeResponse`](https://docs.gravityrail.com/sdk/interfaces/OAuthAuthorizeResponse.md)> Defined in: [packages/sdk/src/client/client.ts:853](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L853) #### Parameters[​](#parameters-479 "Direct link to Parameters") ##### providerSlug[​](#providerslug-1 "Direct link to providerSlug") [`OAuthProviderSlug`](https://docs.gravityrail.com/sdk/type-aliases/OAuthProviderSlug.md) ##### options?[​](#options-25 "Direct link to options?") `OAuthAuthorizeOptions` #### Returns[​](#returns-487 "Direct link to Returns") `Promise`<[`OAuthAuthorizeResponse`](https://docs.gravityrail.com/sdk/interfaces/OAuthAuthorizeResponse.md)> #### Implementation of[​](#implementation-of-486 "Direct link to Implementation of") `AppsBindings.getOAuthAuthorizationUrl` *** ### getOAuthConnectionStatus()[​](#getoauthconnectionstatus "Direct link to getOAuthConnectionStatus()") > **getOAuthConnectionStatus**: (`providerSlug`) => `Promise`<[`OAuthConnectionStatus`](https://docs.gravityrail.com/sdk/interfaces/OAuthConnectionStatus.md) | `null`> Defined in: [packages/sdk/src/client/client.ts:851](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L851) #### Parameters[​](#parameters-480 "Direct link to Parameters") ##### providerSlug[​](#providerslug-2 "Direct link to providerSlug") [`OAuthProviderSlug`](https://docs.gravityrail.com/sdk/type-aliases/OAuthProviderSlug.md) #### Returns[​](#returns-488 "Direct link to Returns") `Promise`<[`OAuthConnectionStatus`](https://docs.gravityrail.com/sdk/interfaces/OAuthConnectionStatus.md) | `null`> #### Implementation of[​](#implementation-of-487 "Direct link to Implementation of") `AppsBindings.getOAuthConnectionStatus` *** ### getOperatorChatMessages()[​](#getoperatorchatmessages "Direct link to getOperatorChatMessages()") > **getOperatorChatMessages**: (`wid`, `chatId`, `limit`, `offset`) => `Promise`<[`ChatMessage`](https://docs.gravityrail.com/sdk/interfaces/ChatMessage.md)\[]> Defined in: [packages/sdk/src/client/client.ts:382](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L382) Get paginated chat messages for an operator chat. #### Parameters[​](#parameters-481 "Direct link to Parameters") ##### wid[​](#wid-401 "Direct link to wid") `string` ##### chatId[​](#chatid-14 "Direct link to chatId") `number` ##### limit?[​](#limit-9 "Direct link to limit?") `number` = `50` ##### offset?[​](#offset-5 "Direct link to offset?") `number` = `0` #### Returns[​](#returns-489 "Direct link to Returns") `Promise`<[`ChatMessage`](https://docs.gravityrail.com/sdk/interfaces/ChatMessage.md)\[]> #### Implementation of[​](#implementation-of-488 "Direct link to Implementation of") `OperatorBindings.getOperatorChatMessages` *** ### getOperatorGroup()[​](#getoperatorgroup "Direct link to getOperatorGroup()") > **getOperatorGroup**: (`wid`, `groupId`) => `Promise`<[`OperatorGroup`](https://docs.gravityrail.com/sdk/type-aliases/OperatorGroup.md)> Defined in: [packages/sdk/src/client/client.ts:373](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L373) Get a single operator group by ID. #### Parameters[​](#parameters-482 "Direct link to Parameters") ##### wid[​](#wid-402 "Direct link to wid") `string` ##### groupId[​](#groupid-4 "Direct link to groupId") `number` #### Returns[​](#returns-490 "Direct link to Returns") `Promise`<[`OperatorGroup`](https://docs.gravityrail.com/sdk/type-aliases/OperatorGroup.md)> #### Implementation of[​](#implementation-of-489 "Direct link to Implementation of") `OperatorBindings.getOperatorGroup` *** ### getOperatorGroups()[​](#getoperatorgroups "Direct link to getOperatorGroups()") > **getOperatorGroups**: (`wid`) => `Promise`<[`OperatorGroup`](https://docs.gravityrail.com/sdk/type-aliases/OperatorGroup.md)\[]> Defined in: [packages/sdk/src/client/client.ts:372](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L372) List all operator groups for a workspace. #### Parameters[​](#parameters-483 "Direct link to Parameters") ##### wid[​](#wid-403 "Direct link to wid") `string` #### Returns[​](#returns-491 "Direct link to Returns") `Promise`<[`OperatorGroup`](https://docs.gravityrail.com/sdk/type-aliases/OperatorGroup.md)\[]> #### Implementation of[​](#implementation-of-490 "Direct link to Implementation of") `OperatorBindings.getOperatorGroups` *** ### getOrCreateQualificationForWorkflow()[​](#getorcreatequalificationforworkflow "Direct link to getOrCreateQualificationForWorkflow()") > **getOrCreateQualificationForWorkflow**: (`wid`, `workflowId`) => `Promise`<[`QualificationResponse`](https://docs.gravityrail.com/sdk/interfaces/QualificationResponse.md)> Defined in: [packages/sdk/src/client/client.ts:299](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L299) Fetch (auto-creating if absent) the qualification for a workflow. #### Parameters[​](#parameters-484 "Direct link to Parameters") ##### wid[​](#wid-404 "Direct link to wid") `string` ##### workflowId[​](#workflowid-5 "Direct link to workflowId") `number` #### Returns[​](#returns-492 "Direct link to Returns") `Promise`<[`QualificationResponse`](https://docs.gravityrail.com/sdk/interfaces/QualificationResponse.md)> #### Implementation of[​](#implementation-of-491 "Direct link to Implementation of") `QualificationsBindings.getOrCreateQualificationForWorkflow` *** ### getOrgBillingCustomer()[​](#getorgbillingcustomer "Direct link to getOrgBillingCustomer()") > **getOrgBillingCustomer**: (`orgIdOrUuid`) => `Promise`<{ `customerName`: `string` | `null`; `customerUuid`: `string` | `null`; `hasAccess`: `boolean`; }> Defined in: [packages/sdk/src/client/client.ts:466](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L466) Get the billing customer UUID for an organization. #### Parameters[​](#parameters-485 "Direct link to Parameters") ##### orgIdOrUuid[​](#orgidoruuid-6 "Direct link to orgIdOrUuid") `string` | `number` #### Returns[​](#returns-493 "Direct link to Returns") `Promise`<{ `customerName`: `string` | `null`; `customerUuid`: `string` | `null`; `hasAccess`: `boolean`; }> #### Implementation of[​](#implementation-of-492 "Direct link to Implementation of") `OrgBindings.getOrgBillingCustomer` *** ### getOrgDomain()[​](#getorgdomain "Direct link to getOrgDomain()") > **getOrgDomain**: (`orgIdOrUuid`, `domainUuid`) => `Promise`<[`OrgDomain`](https://docs.gravityrail.com/sdk/type-aliases/OrgDomain.md)> Defined in: [packages/sdk/src/client/client.ts:450](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L450) Get a registered organization domain by UUID. #### Parameters[​](#parameters-486 "Direct link to Parameters") ##### orgIdOrUuid[​](#orgidoruuid-7 "Direct link to orgIdOrUuid") `string` | `number` ##### domainUuid[​](#domainuuid-5 "Direct link to domainUuid") `string` #### Returns[​](#returns-494 "Direct link to Returns") `Promise`<[`OrgDomain`](https://docs.gravityrail.com/sdk/type-aliases/OrgDomain.md)> #### Implementation of[​](#implementation-of-493 "Direct link to Implementation of") `OrgBindings.getOrgDomain` *** ### getOrgDomainEmail()[​](#getorgdomainemail "Direct link to getOrgDomainEmail()") > **getOrgDomainEmail**: (`orgIdOrUuid`, `domainUuid`) => `Promise`<[`EmailDomainConfigGetResponse`](https://docs.gravityrail.com/sdk/type-aliases/EmailDomainConfigGetResponse.md)> Defined in: [packages/sdk/src/client/client.ts:454](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L454) Get email DNS provisioning and verification status for an org domain. #### Parameters[​](#parameters-487 "Direct link to Parameters") ##### orgIdOrUuid[​](#orgidoruuid-8 "Direct link to orgIdOrUuid") `string` | `number` ##### domainUuid[​](#domainuuid-6 "Direct link to domainUuid") `string` #### Returns[​](#returns-495 "Direct link to Returns") `Promise`<[`EmailDomainConfigGetResponse`](https://docs.gravityrail.com/sdk/type-aliases/EmailDomainConfigGetResponse.md)> #### Implementation of[​](#implementation-of-494 "Direct link to Implementation of") `OrgBindings.getOrgDomainEmail` *** ### getOrgDomainSite()[​](#getorgdomainsite "Direct link to getOrgDomainSite()") > **getOrgDomainSite**: (`orgIdOrUuid`, `domainUuid`) => `Promise`<[`SiteDomainConfigGetResponse`](https://docs.gravityrail.com/sdk/type-aliases/SiteDomainConfigGetResponse.md)> Defined in: [packages/sdk/src/client/client.ts:458](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L458) Get site CNAME provisioning and verification status for an org domain. #### Parameters[​](#parameters-488 "Direct link to Parameters") ##### orgIdOrUuid[​](#orgidoruuid-9 "Direct link to orgIdOrUuid") `string` | `number` ##### domainUuid[​](#domainuuid-7 "Direct link to domainUuid") `string` #### Returns[​](#returns-496 "Direct link to Returns") `Promise`<[`SiteDomainConfigGetResponse`](https://docs.gravityrail.com/sdk/type-aliases/SiteDomainConfigGetResponse.md)> #### Implementation of[​](#implementation-of-495 "Direct link to Implementation of") `OrgBindings.getOrgDomainSite` *** ### getOrgSupportRequest()[​](#getorgsupportrequest "Direct link to getOrgSupportRequest()") > **getOrgSupportRequest**: (`orgUuid`, `uuid`) => `Promise`<`SupportRequest`> Defined in: [packages/sdk/src/client/client.ts:1085](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L1085) #### Parameters[​](#parameters-489 "Direct link to Parameters") ##### orgUuid[​](#orguuid-7 "Direct link to orgUuid") `string` ##### uuid[​](#uuid-27 "Direct link to uuid") `string` #### Returns[​](#returns-497 "Direct link to Returns") `Promise`<`SupportRequest`> #### Implementation of[​](#implementation-of-496 "Direct link to Implementation of") `SupportRequestsBindings.getOrgSupportRequest` *** ### getOwnedMembers()[​](#getownedmembers "Direct link to getOwnedMembers()") > **getOwnedMembers**: (`wid`) => `Promise`<[`WorkspaceMemberResponse`](https://docs.gravityrail.com/sdk/interfaces/WorkspaceMemberResponse.md)\[]> Defined in: [packages/sdk/src/client/client.ts:220](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L220) 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[​](#parameters-490 "Direct link to Parameters") ##### wid[​](#wid-405 "Direct link to wid") `string` #### Returns[​](#returns-498 "Direct link to Returns") `Promise`<[`WorkspaceMemberResponse`](https://docs.gravityrail.com/sdk/interfaces/WorkspaceMemberResponse.md)\[]> #### Implementation of[​](#implementation-of-497 "Direct link to Implementation of") `MembersBindings.getOwnedMembers` *** ### getPage()[​](#getpage "Direct link to getPage()") > **getPage**: (`wid`, `siteId`, `pageId`) => `Promise`<[`PageResponse`](https://docs.gravityrail.com/sdk/interfaces/PageResponse.md)> Defined in: [packages/sdk/src/client/client.ts:572](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L572) Get a single page by ID within a site. #### Parameters[​](#parameters-491 "Direct link to Parameters") ##### wid[​](#wid-406 "Direct link to wid") `string` ##### siteId[​](#siteid-10 "Direct link to siteId") `number` ##### pageId[​](#pageid-1 "Direct link to pageId") `number` #### Returns[​](#returns-499 "Direct link to Returns") `Promise`<[`PageResponse`](https://docs.gravityrail.com/sdk/interfaces/PageResponse.md)> #### Implementation of[​](#implementation-of-498 "Direct link to Implementation of") `SitesBindings.getPage` *** ### getPageBySlug()[​](#getpagebyslug "Direct link to getPageBySlug()") > **getPageBySlug**: (`wid`, `siteId`, `slug`) => `Promise`<[`PageResponse`](https://docs.gravityrail.com/sdk/interfaces/PageResponse.md)> Defined in: [packages/sdk/src/client/client.ts:573](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L573) Get a single page by its slug within a site. #### Parameters[​](#parameters-492 "Direct link to Parameters") ##### wid[​](#wid-407 "Direct link to wid") `string` ##### siteId[​](#siteid-11 "Direct link to siteId") `number` ##### slug[​](#slug-8 "Direct link to slug") `string` #### Returns[​](#returns-500 "Direct link to Returns") `Promise`<[`PageResponse`](https://docs.gravityrail.com/sdk/interfaces/PageResponse.md)> #### Implementation of[​](#implementation-of-499 "Direct link to Implementation of") `SitesBindings.getPageBySlug` *** ### getPasswordStatus()[​](#getpasswordstatus "Direct link to getPasswordStatus()") > **getPasswordStatus**: () => `Promise`<{ `hasPassword`: `boolean`; }> Defined in: [packages/sdk/src/client/client.ts:499](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L499) Check whether the current account has a password set. #### Returns[​](#returns-501 "Direct link to Returns") `Promise`<{ `hasPassword`: `boolean`; }> #### Implementation of[​](#implementation-of-500 "Direct link to Implementation of") `AuthBindings.getPasswordStatus` *** ### getPatientSyncStatus()[​](#getpatientsyncstatus "Direct link to getPatientSyncStatus()") > **getPatientSyncStatus**: (`wid`) => `Promise`<[`PatientSyncConnectionStatus`](https://docs.gravityrail.com/sdk/interfaces/PatientSyncConnectionStatus.md)> Defined in: [packages/sdk/src/client/client.ts:954](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L954) Read the PatientSync connection status (never returns the API key). #### Parameters[​](#parameters-493 "Direct link to Parameters") ##### wid[​](#wid-408 "Direct link to wid") `string` #### Returns[​](#returns-502 "Direct link to Returns") `Promise`<[`PatientSyncConnectionStatus`](https://docs.gravityrail.com/sdk/interfaces/PatientSyncConnectionStatus.md)> #### Implementation of[​](#implementation-of-501 "Direct link to Implementation of") `IntegrationsBindings.getPatientSyncStatus` *** ### getPendingCredentialChanges()[​](#getpendingcredentialchanges "Direct link to getPendingCredentialChanges()") > **getPendingCredentialChanges**: () => `Promise`<[`PendingCredentialChange`](https://docs.gravityrail.com/sdk/interfaces/PendingCredentialChange.md)\[]> Defined in: [packages/sdk/src/client/client.ts:521](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L521) Get all pending (non-applied) credential change requests. #### Returns[​](#returns-503 "Direct link to Returns") `Promise`<[`PendingCredentialChange`](https://docs.gravityrail.com/sdk/interfaces/PendingCredentialChange.md)\[]> #### Implementation of[​](#implementation-of-502 "Direct link to Implementation of") `AuthBindings.getPendingCredentialChanges` *** ### getPersona()[​](#getpersona "Direct link to getPersona()") > **getPersona**: (`wid`, `id`) => `Promise`<[`Persona`](https://docs.gravityrail.com/sdk/type-aliases/Persona.md)> Defined in: [packages/sdk/src/client/client.ts:319](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L319) #### Parameters[​](#parameters-494 "Direct link to Parameters") ##### wid[​](#wid-409 "Direct link to wid") `string` ##### id[​](#id-56 "Direct link to id") `number` #### Returns[​](#returns-504 "Direct link to Returns") `Promise`<[`Persona`](https://docs.gravityrail.com/sdk/type-aliases/Persona.md)> #### Implementation of[​](#implementation-of-503 "Direct link to Implementation of") `PersonasBindings.getPersona` *** ### getPhoneCalls()[​](#getphonecalls "Direct link to getPhoneCalls()") > **getPhoneCalls**: (`wid`, `options`) => `Promise`<[`PaginatedResponse`](https://docs.gravityrail.com/sdk/interfaces/PaginatedResponse.md)<[`PhoneCall`](https://docs.gravityrail.com/sdk/interfaces/PhoneCall.md)>> Defined in: [packages/sdk/src/client/client.ts:187](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L187) List workspace phone calls with optional filtering. #### Parameters[​](#parameters-495 "Direct link to Parameters") ##### wid[​](#wid-410 "Direct link to wid") `string` ##### options?[​](#options-26 "Direct link to options?") ###### chatId?[​](#chatid-15 "Direct link to chatId?") `number` ###### dateFrom?[​](#datefrom "Direct link to dateFrom?") `string` ###### dateTo?[​](#dateto "Direct link to dateTo?") `string` ###### inbound?[​](#inbound "Direct link to inbound?") `boolean` ###### page?[​](#page-33 "Direct link to page?") `number` ###### pageSize?[​](#pagesize-33 "Direct link to pageSize?") `number` ###### phoneNumberId?[​](#phonenumberid-1 "Direct link to phoneNumberId?") `string` | `number` ###### status?[​](#status-8 "Direct link to status?") `string` ###### workflowId?[​](#workflowid-6 "Direct link to workflowId?") `number` #### Returns[​](#returns-505 "Direct link to Returns") `Promise`<[`PaginatedResponse`](https://docs.gravityrail.com/sdk/interfaces/PaginatedResponse.md)<[`PhoneCall`](https://docs.gravityrail.com/sdk/interfaces/PhoneCall.md)>> #### Implementation of[​](#implementation-of-504 "Direct link to Implementation of") `CallsBindings.getPhoneCalls` *** ### getPhoneNumber()[​](#getphonenumber "Direct link to getPhoneNumber()") > **getPhoneNumber**: (`wid`, `id`) => `Promise`<[`PhoneNumber`](https://docs.gravityrail.com/sdk/interfaces/PhoneNumber.md)> Defined in: [packages/sdk/src/client/client.ts:734](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L734) Get a phone number by ID or UUID. #### Parameters[​](#parameters-496 "Direct link to Parameters") ##### wid[​](#wid-411 "Direct link to wid") `string` ##### id[​](#id-57 "Direct link to id") `string` | `number` #### Returns[​](#returns-506 "Direct link to Returns") `Promise`<[`PhoneNumber`](https://docs.gravityrail.com/sdk/interfaces/PhoneNumber.md)> #### Implementation of[​](#implementation-of-505 "Direct link to Implementation of") `CommunicationsBindings.getPhoneNumber` *** ### getPhoneNumberCalls()[​](#getphonenumbercalls "Direct link to getPhoneNumberCalls()") > **getPhoneNumberCalls**: (`wid`, `id`, `page`, `pageSize`, `filters?`) => `Promise`<[`PaginatedResponse`](https://docs.gravityrail.com/sdk/interfaces/PaginatedResponse.md)<[`PhoneCall`](https://docs.gravityrail.com/sdk/interfaces/PhoneCall.md)>> Defined in: [packages/sdk/src/client/client.ts:739](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L739) List paginated call records for a phone number. Routes through the workspace-wide /calls endpoint with a phoneNumberId filter. #### Parameters[​](#parameters-497 "Direct link to Parameters") ##### wid[​](#wid-412 "Direct link to wid") `string` ##### id[​](#id-58 "Direct link to id") `number` ##### page?[​](#page-34 "Direct link to page?") `number` = `1` ##### pageSize?[​](#pagesize-34 "Direct link to pageSize?") `number` = `10` ##### filters?[​](#filters "Direct link to filters?") ###### dateFrom?[​](#datefrom-1 "Direct link to dateFrom?") `string` ###### dateTo?[​](#dateto-1 "Direct link to dateTo?") `string` ###### inbound?[​](#inbound-1 "Direct link to inbound?") `boolean` ###### status?[​](#status-9 "Direct link to status?") `string` #### Returns[​](#returns-507 "Direct link to Returns") `Promise`<[`PaginatedResponse`](https://docs.gravityrail.com/sdk/interfaces/PaginatedResponse.md)<[`PhoneCall`](https://docs.gravityrail.com/sdk/interfaces/PhoneCall.md)>> #### Implementation of[​](#implementation-of-506 "Direct link to Implementation of") `CommunicationsBindings.getPhoneNumberCalls` *** ### getPhoneNumberMessages()[​](#getphonenumbermessages "Direct link to getPhoneNumberMessages()") > **getPhoneNumberMessages**: (`wid`, `id`, `page`, `pageSize`, `filters?`) => `Promise`<[`PaginatedResponse`](https://docs.gravityrail.com/sdk/interfaces/PaginatedResponse.md)<[`SMSMessage`](https://docs.gravityrail.com/sdk/interfaces/SMSMessage.md)>> Defined in: [packages/sdk/src/client/client.ts:740](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L740) List paginated SMS messages for a phone number. #### Parameters[​](#parameters-498 "Direct link to Parameters") ##### wid[​](#wid-413 "Direct link to wid") `string` ##### id[​](#id-59 "Direct link to id") `number` ##### page?[​](#page-35 "Direct link to page?") `number` = `1` ##### pageSize?[​](#pagesize-35 "Direct link to pageSize?") `number` = `10` ##### filters?[​](#filters-1 "Direct link to filters?") ###### dateFrom?[​](#datefrom-2 "Direct link to dateFrom?") `string` ###### dateTo?[​](#dateto-2 "Direct link to dateTo?") `string` ###### inbound?[​](#inbound-2 "Direct link to inbound?") `boolean` ###### status?[​](#status-10 "Direct link to status?") `string` #### Returns[​](#returns-508 "Direct link to Returns") `Promise`<[`PaginatedResponse`](https://docs.gravityrail.com/sdk/interfaces/PaginatedResponse.md)<[`SMSMessage`](https://docs.gravityrail.com/sdk/interfaces/SMSMessage.md)>> #### Implementation of[​](#implementation-of-507 "Direct link to Implementation of") `CommunicationsBindings.getPhoneNumberMessages` *** ### getPhoneNumbers()[​](#getphonenumbers "Direct link to getPhoneNumbers()") > **getPhoneNumbers**: (`wid`, `options?`) => `Promise`<[`PhoneNumber`](https://docs.gravityrail.com/sdk/interfaces/PhoneNumber.md)\[]> Defined in: [packages/sdk/src/client/client.ts:731](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L731) List phone numbers in a workspace, optionally including archived. #### Parameters[​](#parameters-499 "Direct link to Parameters") ##### wid[​](#wid-414 "Direct link to wid") `string` ##### options?[​](#options-27 "Direct link to options?") ###### isArchived?[​](#isarchived "Direct link to isArchived?") `boolean` #### Returns[​](#returns-509 "Direct link to Returns") `Promise`<[`PhoneNumber`](https://docs.gravityrail.com/sdk/interfaces/PhoneNumber.md)\[]> #### Implementation of[​](#implementation-of-508 "Direct link to Implementation of") `CommunicationsBindings.getPhoneNumbers` *** ### getPhoneNumberVoicemails()[​](#getphonenumbervoicemails "Direct link to getPhoneNumberVoicemails()") > **getPhoneNumberVoicemails**: (`wid`, `id`, `page`, `pageSize`, `status?`) => `Promise`<[`PaginatedResponse`](https://docs.gravityrail.com/sdk/interfaces/PaginatedResponse.md)<`Voicemail`>> Defined in: [packages/sdk/src/client/client.ts:741](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L741) List paginated voicemails for a phone number. #### Parameters[​](#parameters-500 "Direct link to Parameters") ##### wid[​](#wid-415 "Direct link to wid") `string` ##### id[​](#id-60 "Direct link to id") `number` ##### page?[​](#page-36 "Direct link to page?") `number` = `1` ##### pageSize?[​](#pagesize-36 "Direct link to pageSize?") `number` = `10` ##### status?[​](#status-11 "Direct link to status?") `VoicemailStatus` #### Returns[​](#returns-510 "Direct link to Returns") `Promise`<[`PaginatedResponse`](https://docs.gravityrail.com/sdk/interfaces/PaginatedResponse.md)<`Voicemail`>> #### Implementation of[​](#implementation-of-509 "Direct link to Implementation of") `CommunicationsBindings.getPhoneNumberVoicemails` *** ### getPhoneUsageReport()[​](#getphoneusagereport "Direct link to getPhoneUsageReport()") > **getPhoneUsageReport**: (`wid`, `params?`) => `Promise`<[`PhoneUsageReport`](https://docs.gravityrail.com/sdk/interfaces/PhoneUsageReport.md)> Defined in: [packages/sdk/src/client/client.ts:823](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L823) Get phone call usage report for a workspace within an optional date range. #### Parameters[​](#parameters-501 "Direct link to Parameters") ##### wid[​](#wid-416 "Direct link to wid") `string` ##### params?[​](#params-23 "Direct link to params?") [`PhoneUsageReportParams`](https://docs.gravityrail.com/sdk/interfaces/PhoneUsageReportParams.md) #### Returns[​](#returns-511 "Direct link to Returns") `Promise`<[`PhoneUsageReport`](https://docs.gravityrail.com/sdk/interfaces/PhoneUsageReport.md)> #### Implementation of[​](#implementation-of-510 "Direct link to Implementation of") `BillingBindings.getPhoneUsageReport` *** ### getPlatformApp()[​](#getplatformapp "Direct link to getPlatformApp()") > **getPlatformApp**: (`wid`, `appUuid`) => `Promise`<[`PlatformAppConnectionResponse`](https://docs.gravityrail.com/sdk/interfaces/PlatformAppConnectionResponse.md)> Defined in: [packages/sdk/src/client/client.ts:1036](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L1036) Get platform app connection details by UUID. #### Parameters[​](#parameters-502 "Direct link to Parameters") ##### wid[​](#wid-417 "Direct link to wid") `string` ##### appUuid[​](#appuuid-1 "Direct link to appUuid") `string` #### Returns[​](#returns-512 "Direct link to Returns") `Promise`<[`PlatformAppConnectionResponse`](https://docs.gravityrail.com/sdk/interfaces/PlatformAppConnectionResponse.md)> #### Implementation of[​](#implementation-of-511 "Direct link to Implementation of") `IntegrationsBindings.getPlatformApp` *** ### getPresenceStatus()[​](#getpresencestatus "Direct link to getPresenceStatus()") > **getPresenceStatus**: (`wid`) => `Promise`<[`PresenceStatusResponse`](https://docs.gravityrail.com/sdk/interfaces/PresenceStatusResponse.md)> Defined in: [packages/sdk/src/client/client.ts:380](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L380) Get the current member's presence status. #### Parameters[​](#parameters-503 "Direct link to Parameters") ##### wid[​](#wid-418 "Direct link to wid") `string` #### Returns[​](#returns-513 "Direct link to Returns") `Promise`<[`PresenceStatusResponse`](https://docs.gravityrail.com/sdk/interfaces/PresenceStatusResponse.md)> #### Implementation of[​](#implementation-of-512 "Direct link to Implementation of") `OperatorBindings.getPresenceStatus` *** ### getProduct()[​](#getproduct "Direct link to getProduct()") > **getProduct**: (`id`) => `Promise`<[`Product`](https://docs.gravityrail.com/sdk/type-aliases/Product.md)> Defined in: [packages/sdk/src/client/client.ts:428](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L428) Get a product by ID using the global endpoint. #### Parameters[​](#parameters-504 "Direct link to Parameters") ##### id[​](#id-61 "Direct link to id") `number` #### Returns[​](#returns-514 "Direct link to Returns") `Promise`<[`Product`](https://docs.gravityrail.com/sdk/type-aliases/Product.md)> #### Implementation of[​](#implementation-of-513 "Direct link to Implementation of") `WorkspacesBindings.getProduct` *** ### getProducts()[​](#getproducts "Direct link to getProducts()") > **getProducts**: (`wid`, `featured?`) => `Promise`<[`Product`](https://docs.gravityrail.com/sdk/type-aliases/Product.md)\[]> Defined in: [packages/sdk/src/client/client.ts:427](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L427) List products available from a reseller workspace, optionally filtering by featured status. #### Parameters[​](#parameters-505 "Direct link to Parameters") ##### wid[​](#wid-419 "Direct link to wid") `string` ##### featured?[​](#featured "Direct link to featured?") `boolean` #### Returns[​](#returns-515 "Direct link to Returns") `Promise`<[`Product`](https://docs.gravityrail.com/sdk/type-aliases/Product.md)\[]> #### Implementation of[​](#implementation-of-514 "Direct link to Implementation of") `WorkspacesBindings.getProducts` *** ### getPronunciationEntries()[​](#getpronunciationentries "Direct link to getPronunciationEntries()") > **getPronunciationEntries**: (`orgUuid`, `options`) => `Promise`<[`PronunciationEntryResponse`](https://docs.gravityrail.com/sdk/interfaces/PronunciationEntryResponse.md)\[]> Defined in: [packages/sdk/src/client/client.ts:1043](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L1043) List pronunciation entries for an organization, optionally filtered by scope. #### Parameters[​](#parameters-506 "Direct link to Parameters") ##### orgUuid[​](#orguuid-8 "Direct link to orgUuid") `string` ##### options?[​](#options-28 "Direct link to options?") ###### accountId?[​](#accountid "Direct link to accountId?") `number` ###### scope?[​](#scope-1 "Direct link to scope?") `"account"` | `"org"` #### Returns[​](#returns-516 "Direct link to Returns") `Promise`<[`PronunciationEntryResponse`](https://docs.gravityrail.com/sdk/interfaces/PronunciationEntryResponse.md)\[]> #### Implementation of[​](#implementation-of-515 "Direct link to Implementation of") `PronunciationsBindings.getPronunciationEntries` *** ### getPublicFeatureRegistry()[​](#getpublicfeatureregistry "Direct link to getPublicFeatureRegistry()") > **getPublicFeatureRegistry**: () => `Promise`<`FeaturesRegistryResponse`> Defined in: [packages/sdk/src/client/client.ts:802](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L802) Get the public feature registry (no auth required). Returns only features marked for product page display. #### Returns[​](#returns-517 "Direct link to Returns") `Promise`<`FeaturesRegistryResponse`> #### Implementation of[​](#implementation-of-516 "Direct link to Implementation of") `ToolkitsBindings.getPublicFeatureRegistry` *** ### getPublicFile()[​](#getpublicfile "Direct link to getPublicFile()") > **getPublicFile**: (`wid`, `fileId`) => `Promise`<[`PublicFileMetadata`](https://docs.gravityrail.com/sdk/interfaces/PublicFileMetadata.md)> Defined in: [packages/sdk/src/client/client.ts:618](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L618) Get metadata for a publicly shared file (unauthenticated). #### Parameters[​](#parameters-507 "Direct link to Parameters") ##### wid[​](#wid-420 "Direct link to wid") `string` ##### fileId[​](#fileid-2 "Direct link to fileId") `number` #### Returns[​](#returns-518 "Direct link to Returns") `Promise`<[`PublicFileMetadata`](https://docs.gravityrail.com/sdk/interfaces/PublicFileMetadata.md)> #### Implementation of[​](#implementation-of-517 "Direct link to Implementation of") `FilesBindings.getPublicFile` *** ### getPublicFolder()[​](#getpublicfolder "Direct link to getPublicFolder()") > **getPublicFolder**: (`wid`, `folderId`, `page`, `pageSize`) => `Promise`<[`PublicFolderContents`](https://docs.gravityrail.com/sdk/interfaces/PublicFolderContents.md)> Defined in: [packages/sdk/src/client/client.ts:619](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L619) Get contents of a publicly shared folder (unauthenticated). #### Parameters[​](#parameters-508 "Direct link to Parameters") ##### wid[​](#wid-421 "Direct link to wid") `string` ##### folderId[​](#folderid-2 "Direct link to folderId") `number` ##### page?[​](#page-37 "Direct link to page?") `number` = `1` ##### pageSize?[​](#pagesize-37 "Direct link to pageSize?") `number` = `100` #### Returns[​](#returns-519 "Direct link to Returns") `Promise`<[`PublicFolderContents`](https://docs.gravityrail.com/sdk/interfaces/PublicFolderContents.md)> #### Implementation of[​](#implementation-of-518 "Direct link to Implementation of") `FilesBindings.getPublicFolder` *** ### getPublicFolderFiles()[​](#getpublicfolderfiles "Direct link to getPublicFolderFiles()") > **getPublicFolderFiles**: (`wid`, `folderId`, `page`, `pageSize`) => `Promise`<{ `files`: [`PublicFileMetadata`](https://docs.gravityrail.com/sdk/interfaces/PublicFileMetadata.md)\[]; `pagination?`: `any`; }> Defined in: [packages/sdk/src/client/client.ts:620](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L620) List files within a publicly shared folder (unauthenticated). #### Parameters[​](#parameters-509 "Direct link to Parameters") ##### wid[​](#wid-422 "Direct link to wid") `string` ##### folderId[​](#folderid-3 "Direct link to folderId") `number` ##### page?[​](#page-38 "Direct link to page?") `number` = `1` ##### pageSize?[​](#pagesize-38 "Direct link to pageSize?") `number` = `100` #### Returns[​](#returns-520 "Direct link to Returns") `Promise`<{ `files`: [`PublicFileMetadata`](https://docs.gravityrail.com/sdk/interfaces/PublicFileMetadata.md)\[]; `pagination?`: `any`; }> #### Implementation of[​](#implementation-of-519 "Direct link to Implementation of") `FilesBindings.getPublicFolderFiles` *** ### getPublicProduct()[​](#getpublicproduct "Direct link to getPublicProduct()") > **getPublicProduct**: (`id`) => `Promise`<[`Product`](https://docs.gravityrail.com/sdk/type-aliases/Product.md)> Defined in: [packages/sdk/src/client/client.ts:431](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L431) Get a publicly accessible product by ID. #### Parameters[​](#parameters-510 "Direct link to Parameters") ##### id[​](#id-62 "Direct link to id") `number` #### Returns[​](#returns-521 "Direct link to Returns") `Promise`<[`Product`](https://docs.gravityrail.com/sdk/type-aliases/Product.md)> #### Implementation of[​](#implementation-of-520 "Direct link to Implementation of") `WorkspacesBindings.getPublicProduct` *** ### getPublicProducts()[​](#getpublicproducts "Direct link to getPublicProducts()") > **getPublicProducts**: (`workspaceUuid`, `featured?`) => `Promise`<[`Product`](https://docs.gravityrail.com/sdk/type-aliases/Product.md)\[]> Defined in: [packages/sdk/src/client/client.ts:430](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L430) List public products for a workspace's storefront. No auth required. #### Parameters[​](#parameters-511 "Direct link to Parameters") ##### workspaceUuid[​](#workspaceuuid-8 "Direct link to workspaceUuid") `string` ##### featured?[​](#featured-1 "Direct link to featured?") `boolean` #### Returns[​](#returns-522 "Direct link to Returns") `Promise`<[`Product`](https://docs.gravityrail.com/sdk/type-aliases/Product.md)\[]> #### Implementation of[​](#implementation-of-521 "Direct link to Implementation of") `WorkspacesBindings.getPublicProducts` *** ### getPublicWorkspaces()[​](#getpublicworkspaces "Direct link to getPublicWorkspaces()") > **getPublicWorkspaces**: () => `Promise`<[`PublicWorkspace`](https://docs.gravityrail.com/sdk/interfaces/PublicWorkspace.md)\[]> Defined in: [packages/sdk/src/client/client.ts:401](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L401) List all publicly visible workspaces. #### Returns[​](#returns-523 "Direct link to Returns") `Promise`<[`PublicWorkspace`](https://docs.gravityrail.com/sdk/interfaces/PublicWorkspace.md)\[]> #### Implementation of[​](#implementation-of-522 "Direct link to Implementation of") `WorkspacesBindings.getPublicWorkspaces` *** ### getQualification()[​](#getqualification "Direct link to getQualification()") > **getQualification**: (`wid`, `id`) => `Promise`<[`QualificationResponse`](https://docs.gravityrail.com/sdk/interfaces/QualificationResponse.md)> Defined in: [packages/sdk/src/client/client.ts:298](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L298) Get a single qualification by ID. #### Parameters[​](#parameters-512 "Direct link to Parameters") ##### wid[​](#wid-423 "Direct link to wid") `string` ##### id[​](#id-63 "Direct link to id") `number` #### Returns[​](#returns-524 "Direct link to Returns") `Promise`<[`QualificationResponse`](https://docs.gravityrail.com/sdk/interfaces/QualificationResponse.md)> #### Implementation of[​](#implementation-of-523 "Direct link to Implementation of") `QualificationsBindings.getQualification` *** ### getQualifications()[​](#getqualifications "Direct link to getQualifications()") > **getQualifications**: (`wid`, `params?`) => `Promise`<[`PaginatedResponse`](https://docs.gravityrail.com/sdk/interfaces/PaginatedResponse.md)<[`QualificationResponse`](https://docs.gravityrail.com/sdk/interfaces/QualificationResponse.md)>> Defined in: [packages/sdk/src/client/client.ts:297](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L297) List qualifications in a workspace, paginated. #### Parameters[​](#parameters-513 "Direct link to Parameters") ##### wid[​](#wid-424 "Direct link to wid") `string` ##### params?[​](#params-24 "Direct link to params?") ###### page?[​](#page-39 "Direct link to page?") `number` ###### pageSize?[​](#pagesize-39 "Direct link to pageSize?") `number` #### Returns[​](#returns-525 "Direct link to Returns") `Promise`<[`PaginatedResponse`](https://docs.gravityrail.com/sdk/interfaces/PaginatedResponse.md)<[`QualificationResponse`](https://docs.gravityrail.com/sdk/interfaces/QualificationResponse.md)>> #### Implementation of[​](#implementation-of-524 "Direct link to Implementation of") `QualificationsBindings.getQualifications` *** ### getQueryFields()[​](#getqueryfields "Direct link to getQueryFields()") > **getQueryFields**: (`wid`) => `Promise`<[`QueryFieldsResponse`](https://docs.gravityrail.com/sdk/interfaces/QueryFieldsResponse.md)> Defined in: [packages/sdk/src/client/client.ts:313](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L313) Queryable namespace: native fields, operators per type, DataType record fields. #### Parameters[​](#parameters-514 "Direct link to Parameters") ##### wid[​](#wid-425 "Direct link to wid") `string` #### Returns[​](#returns-526 "Direct link to Returns") `Promise`<[`QueryFieldsResponse`](https://docs.gravityrail.com/sdk/interfaces/QueryFieldsResponse.md)> #### Implementation of[​](#implementation-of-525 "Direct link to Implementation of") `QueriesBindings.getQueryFields` *** ### getRealtimeModels()[​](#getrealtimemodels "Direct link to getRealtimeModels()") > **getRealtimeModels**: (`provider?`) => `Promise`<[`AIModelsResponse`](https://docs.gravityrail.com/sdk/interfaces/AIModelsResponse.md)> Defined in: [packages/sdk/src/client/client.ts:774](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L774) Get available realtime AI models #### Parameters[​](#parameters-515 "Direct link to Parameters") ##### provider?[​](#provider-2 "Direct link to provider?") `string` #### Returns[​](#returns-527 "Direct link to Returns") `Promise`<[`AIModelsResponse`](https://docs.gravityrail.com/sdk/interfaces/AIModelsResponse.md)> #### Implementation of[​](#implementation-of-526 "Direct link to Implementation of") `ToolkitsBindings.getRealtimeModels` *** ### getRecommendedVoices()[​](#getrecommendedvoices "Direct link to getRecommendedVoices()") > **getRecommendedVoices**: () => `Promise`<[`RecommendedVoiceResponse`](https://docs.gravityrail.com/sdk/interfaces/RecommendedVoiceResponse.md)\[]> Defined in: [packages/sdk/src/client/client.ts:1054](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L1054) List recommended voices for pronunciation preview. #### Returns[​](#returns-528 "Direct link to Returns") `Promise`<[`RecommendedVoiceResponse`](https://docs.gravityrail.com/sdk/interfaces/RecommendedVoiceResponse.md)\[]> #### Implementation of[​](#implementation-of-527 "Direct link to Implementation of") `PronunciationsBindings.getRecommendedVoices` *** ### getResellerWorkspaces()[​](#getresellerworkspaces "Direct link to getResellerWorkspaces()") > **getResellerWorkspaces**: (`wid`, `params?`) => `Promise`<[`PaginatedResponse`](https://docs.gravityrail.com/sdk/interfaces/PaginatedResponse.md)<[`ClientWorkspace`](https://docs.gravityrail.com/sdk/interfaces/ClientWorkspace.md)>> Defined in: [packages/sdk/src/client/client.ts:421](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L421) List client workspaces managed by this reseller workspace, paginated. #### Parameters[​](#parameters-516 "Direct link to Parameters") ##### wid[​](#wid-426 "Direct link to wid") `string` ##### params?[​](#params-25 "Direct link to params?") ###### page?[​](#page-40 "Direct link to page?") `number` ###### pageSize?[​](#pagesize-40 "Direct link to pageSize?") `number` #### Returns[​](#returns-529 "Direct link to Returns") `Promise`<[`PaginatedResponse`](https://docs.gravityrail.com/sdk/interfaces/PaginatedResponse.md)<[`ClientWorkspace`](https://docs.gravityrail.com/sdk/interfaces/ClientWorkspace.md)>> #### Implementation of[​](#implementation-of-528 "Direct link to Implementation of") `WorkspacesBindings.getResellerWorkspaces` *** ### getRoutine()[​](#getroutine "Direct link to getRoutine()") > **getRoutine**: (`wid`, `id`) => `Promise`<[`RoutineResponse`](https://docs.gravityrail.com/sdk/interfaces/RoutineResponse.md)> Defined in: [packages/sdk/src/client/client.ts:635](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L635) Get a single routine by ID. #### Parameters[​](#parameters-517 "Direct link to Parameters") ##### wid[​](#wid-427 "Direct link to wid") `string` ##### id[​](#id-64 "Direct link to id") `number` #### Returns[​](#returns-530 "Direct link to Returns") `Promise`<[`RoutineResponse`](https://docs.gravityrail.com/sdk/interfaces/RoutineResponse.md)> #### Implementation of[​](#implementation-of-529 "Direct link to Implementation of") `EventsBindings.getRoutine` *** ### getRoutineRuns()[​](#getroutineruns "Direct link to getRoutineRuns()") > **getRoutineRuns**: (`wid`, `options`) => `Promise`<[`PaginatedResponse`](https://docs.gravityrail.com/sdk/interfaces/PaginatedResponse.md)<[`RoutineRunResponse`](https://docs.gravityrail.com/sdk/interfaces/RoutineRunResponse.md)>> Defined in: [packages/sdk/src/client/client.ts:640](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L640) List routine run history with optional filtering by routine and status. #### Parameters[​](#parameters-518 "Direct link to Parameters") ##### wid[​](#wid-428 "Direct link to wid") `string` ##### options?[​](#options-29 "Direct link to options?") ###### page?[​](#page-41 "Direct link to page?") `number` ###### pageSize?[​](#pagesize-41 "Direct link to pageSize?") `number` ###### routineId?[​](#routineid "Direct link to routineId?") `number` ###### sortBy?[​](#sortby-5 "Direct link to sortBy?") `"createdAt"` ###### sortOrder?[​](#sortorder-5 "Direct link to sortOrder?") [`SortOrder`](https://docs.gravityrail.com/sdk/type-aliases/SortOrder.md) ###### status?[​](#status-12 "Direct link to status?") `string` #### Returns[​](#returns-531 "Direct link to Returns") `Promise`<[`PaginatedResponse`](https://docs.gravityrail.com/sdk/interfaces/PaginatedResponse.md)<[`RoutineRunResponse`](https://docs.gravityrail.com/sdk/interfaces/RoutineRunResponse.md)>> #### Implementation of[​](#implementation-of-530 "Direct link to Implementation of") `EventsBindings.getRoutineRuns` *** ### getRoutines()[​](#getroutines "Direct link to getRoutines()") > **getRoutines**: (`wid`, `options`) => `Promise`<[`PaginatedResponse`](https://docs.gravityrail.com/sdk/interfaces/PaginatedResponse.md)<[`RoutineResponse`](https://docs.gravityrail.com/sdk/interfaces/RoutineResponse.md)>> Defined in: [packages/sdk/src/client/client.ts:634](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L634) List routines with optional pagination and active status filtering. #### Parameters[​](#parameters-519 "Direct link to Parameters") ##### wid[​](#wid-429 "Direct link to wid") `string` ##### options?[​](#options-30 "Direct link to options?") [`RoutinesQueryParams`](https://docs.gravityrail.com/sdk/interfaces/RoutinesQueryParams.md) = `{}` #### Returns[​](#returns-532 "Direct link to Returns") `Promise`<[`PaginatedResponse`](https://docs.gravityrail.com/sdk/interfaces/PaginatedResponse.md)<[`RoutineResponse`](https://docs.gravityrail.com/sdk/interfaces/RoutineResponse.md)>> #### Implementation of[​](#implementation-of-531 "Direct link to Implementation of") `EventsBindings.getRoutines` *** ### getRuleExecutions()[​](#getruleexecutions "Direct link to getRuleExecutions()") > **getRuleExecutions**: (`wid`, `options`) => `Promise`<[`CursorPaginatedResponse`](https://docs.gravityrail.com/sdk/interfaces/CursorPaginatedResponse.md)<[`RuleExecutionResponse`](https://docs.gravityrail.com/sdk/interfaces/RuleExecutionResponse.md)>> Defined in: [packages/sdk/src/client/client.ts:633](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L633) List event rule executions with cursor-based pagination and filtering. #### Parameters[​](#parameters-520 "Direct link to Parameters") ##### wid[​](#wid-430 "Direct link to wid") `string` ##### options?[​](#options-31 "Direct link to options?") [`RuleExecutionsQueryParams`](https://docs.gravityrail.com/sdk/interfaces/RuleExecutionsQueryParams.md) = `{}` #### Returns[​](#returns-533 "Direct link to Returns") `Promise`<[`CursorPaginatedResponse`](https://docs.gravityrail.com/sdk/interfaces/CursorPaginatedResponse.md)<[`RuleExecutionResponse`](https://docs.gravityrail.com/sdk/interfaces/RuleExecutionResponse.md)>> #### Implementation of[​](#implementation-of-532 "Direct link to Implementation of") `EventsBindings.getRuleExecutions` *** ### getSalesforceReconciliationMatches()[​](#getsalesforcereconciliationmatches "Direct link to getSalesforceReconciliationMatches()") > **getSalesforceReconciliationMatches**: (`wid`, `params?`) => `Promise`<`SalesforceReconciliationMatch`\[]> Defined in: [packages/sdk/src/client/client.ts:990](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L990) #### Parameters[​](#parameters-521 "Direct link to Parameters") ##### wid[​](#wid-431 "Direct link to wid") `string` ##### params?[​](#params-26 "Direct link to params?") ###### limit?[​](#limit-10 "Direct link to limit?") `number` ###### offset?[​](#offset-6 "Direct link to offset?") `number` #### Returns[​](#returns-534 "Direct link to Returns") `Promise`<`SalesforceReconciliationMatch`\[]> #### Implementation of[​](#implementation-of-533 "Direct link to Implementation of") `IntegrationsBindings.getSalesforceReconciliationMatches` *** ### getSalesforceStatus()[​](#getsalesforcestatus "Direct link to getSalesforceStatus()") > **getSalesforceStatus**: (`wid`) => `Promise`<`SalesforceConnectionStatus`> Defined in: [packages/sdk/src/client/client.ts:985](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L985) #### Parameters[​](#parameters-522 "Direct link to Parameters") ##### wid[​](#wid-432 "Direct link to wid") `string` #### Returns[​](#returns-535 "Direct link to Returns") `Promise`<`SalesforceConnectionStatus`> #### Implementation of[​](#implementation-of-534 "Direct link to Implementation of") `IntegrationsBindings.getSalesforceStatus` *** ### getSalesforceSyncConfig()[​](#getsalesforcesyncconfig "Direct link to getSalesforceSyncConfig()") > **getSalesforceSyncConfig**: (`wid`) => `Promise`<[`SalesforceSyncConfigResponse`](https://docs.gravityrail.com/sdk/interfaces/SalesforceSyncConfigResponse.md)> Defined in: [packages/sdk/src/client/client.ts:995](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L995) #### Parameters[​](#parameters-523 "Direct link to Parameters") ##### wid[​](#wid-433 "Direct link to wid") `string` #### Returns[​](#returns-536 "Direct link to Returns") `Promise`<[`SalesforceSyncConfigResponse`](https://docs.gravityrail.com/sdk/interfaces/SalesforceSyncConfigResponse.md)> #### Implementation of[​](#implementation-of-535 "Direct link to Implementation of") `IntegrationsBindings.getSalesforceSyncConfig` *** ### getScenario()[​](#getscenario "Direct link to getScenario()") > **getScenario**: (`wid`, `scenarioId`) => `Promise`<[`Scenario`](https://docs.gravityrail.com/sdk/type-aliases/Scenario.md)> Defined in: [packages/sdk/src/client/client.ts:302](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L302) #### Parameters[​](#parameters-524 "Direct link to Parameters") ##### wid[​](#wid-434 "Direct link to wid") `string` ##### scenarioId[​](#scenarioid-1 "Direct link to scenarioId") `number` #### Returns[​](#returns-537 "Direct link to Returns") `Promise`<[`Scenario`](https://docs.gravityrail.com/sdk/type-aliases/Scenario.md)> #### Implementation of[​](#implementation-of-536 "Direct link to Implementation of") `QualificationsBindings.getScenario` *** ### getSite()[​](#getsite "Direct link to getSite()") > **getSite**: (`wid`, `id`) => `Promise`<[`Site`](https://docs.gravityrail.com/sdk/type-aliases/Site.md)> Defined in: [packages/sdk/src/client/client.ts:545](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L545) Get a single site by ID. #### Parameters[​](#parameters-525 "Direct link to Parameters") ##### wid[​](#wid-435 "Direct link to wid") `string` ##### id[​](#id-65 "Direct link to id") `number` #### Returns[​](#returns-538 "Direct link to Returns") `Promise`<[`Site`](https://docs.gravityrail.com/sdk/type-aliases/Site.md)> #### Implementation of[​](#implementation-of-537 "Direct link to Implementation of") `SitesBindings.getSite` *** ### getSiteByUuid()[​](#getsitebyuuid "Direct link to getSiteByUuid()") > **getSiteByUuid**: (`wid`, `uuid`) => `Promise`<[`Site`](https://docs.gravityrail.com/sdk/type-aliases/Site.md)> Defined in: [packages/sdk/src/client/client.ts:559](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L559) Get a single site by UUID. #### Parameters[​](#parameters-526 "Direct link to Parameters") ##### wid[​](#wid-436 "Direct link to wid") `string` ##### uuid[​](#uuid-28 "Direct link to uuid") `string` #### Returns[​](#returns-539 "Direct link to Returns") `Promise`<[`Site`](https://docs.gravityrail.com/sdk/type-aliases/Site.md)> #### Implementation of[​](#implementation-of-538 "Direct link to Implementation of") `SitesBindings.getSiteByUuid` *** ### getSiteCounts()[​](#getsitecounts "Direct link to getSiteCounts()") > **getSiteCounts**: (`wid`, `siteId`) => `Promise`<[`SiteCountsResponse`](https://docs.gravityrail.com/sdk/interfaces/SiteCountsResponse.md)> Defined in: [packages/sdk/src/client/client.ts:577](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L577) Get aggregate counts (pages, menu items, etc.) for a site. #### Parameters[​](#parameters-527 "Direct link to Parameters") ##### wid[​](#wid-437 "Direct link to wid") `string` ##### siteId[​](#siteid-12 "Direct link to siteId") `number` #### Returns[​](#returns-540 "Direct link to Returns") `Promise`<[`SiteCountsResponse`](https://docs.gravityrail.com/sdk/interfaces/SiteCountsResponse.md)> #### Implementation of[​](#implementation-of-539 "Direct link to Implementation of") `SitesBindings.getSiteCounts` *** ### getSiteMenu()[​](#getsitemenu "Direct link to getSiteMenu()") > **getSiteMenu**: (`wid`, `siteId`) => `Promise`<[`MenuTreeResponse`](https://docs.gravityrail.com/sdk/interfaces/MenuTreeResponse.md)> Defined in: [packages/sdk/src/client/client.ts:578](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L578) Get the full menu tree for a site. #### Parameters[​](#parameters-528 "Direct link to Parameters") ##### wid[​](#wid-438 "Direct link to wid") `string` ##### siteId[​](#siteid-13 "Direct link to siteId") `number` #### Returns[​](#returns-541 "Direct link to Returns") `Promise`<[`MenuTreeResponse`](https://docs.gravityrail.com/sdk/interfaces/MenuTreeResponse.md)> #### Implementation of[​](#implementation-of-540 "Direct link to Implementation of") `SitesBindings.getSiteMenu` *** ### getSitePages()[​](#getsitepages "Direct link to getSitePages()") > **getSitePages**: (`wid`, `siteId`, `options`) => `Promise`<[`PaginatedResponse`](https://docs.gravityrail.com/sdk/interfaces/PaginatedResponse.md)<[`PageResponse`](https://docs.gravityrail.com/sdk/interfaces/PageResponse.md)>> Defined in: [packages/sdk/src/client/client.ts:571](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L571) List pages for a site with optional pagination, sorting, and search. #### Parameters[​](#parameters-529 "Direct link to Parameters") ##### wid[​](#wid-439 "Direct link to wid") `string` ##### siteId[​](#siteid-14 "Direct link to siteId") `number` ##### options?[​](#options-32 "Direct link to options?") [`PagesQueryParams`](https://docs.gravityrail.com/sdk/interfaces/PagesQueryParams.md) = `{}` #### Returns[​](#returns-542 "Direct link to Returns") `Promise`<[`PaginatedResponse`](https://docs.gravityrail.com/sdk/interfaces/PaginatedResponse.md)<[`PageResponse`](https://docs.gravityrail.com/sdk/interfaces/PageResponse.md)>> #### Implementation of[​](#implementation-of-541 "Direct link to Implementation of") `SitesBindings.getSitePages` *** ### getSiteRenderedMenu()[​](#getsiterenderedmenu "Direct link to getSiteRenderedMenu()") > **getSiteRenderedMenu**: (`wid`, `siteUuid`) => `Promise`<[`MenuTreeResponse`](https://docs.gravityrail.com/sdk/interfaces/MenuTreeResponse.md)> Defined in: [packages/sdk/src/client/client.ts:561](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L561) Get the rendered navigation menu for a site, including all translations. #### Parameters[​](#parameters-530 "Direct link to Parameters") ##### wid[​](#wid-440 "Direct link to wid") `string` ##### siteUuid[​](#siteuuid-2 "Direct link to siteUuid") `string` #### Returns[​](#returns-543 "Direct link to Returns") `Promise`<[`MenuTreeResponse`](https://docs.gravityrail.com/sdk/interfaces/MenuTreeResponse.md)> #### Implementation of[​](#implementation-of-542 "Direct link to Implementation of") `SitesBindings.getSiteRenderedMenu` *** ### getSiteRenderedPage()[​](#getsiterenderedpage "Direct link to getSiteRenderedPage()") > **getSiteRenderedPage**: (`wid`, `siteUuid`, `pageSlugOrId`) => `Promise`<[`RenderedPageResponse`](https://docs.gravityrail.com/sdk/interfaces/RenderedPageResponse.md)> Defined in: [packages/sdk/src/client/client.ts:560](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L560) Get a fully rendered page from a site by slug or ID. #### Parameters[​](#parameters-531 "Direct link to Parameters") ##### wid[​](#wid-441 "Direct link to wid") `string` ##### siteUuid[​](#siteuuid-3 "Direct link to siteUuid") `string` ##### pageSlugOrId[​](#pageslugorid "Direct link to pageSlugOrId") `string` | `number` #### Returns[​](#returns-544 "Direct link to Returns") `Promise`<[`RenderedPageResponse`](https://docs.gravityrail.com/sdk/interfaces/RenderedPageResponse.md)> #### Implementation of[​](#implementation-of-543 "Direct link to Implementation of") `SitesBindings.getSiteRenderedPage` *** ### getSites()[​](#getsites "Direct link to getSites()") > **getSites**: (`wid`) => `Promise`<[`Site`](https://docs.gravityrail.com/sdk/type-aliases/Site.md)\[]> Defined in: [packages/sdk/src/client/client.ts:542](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L542) List all sites in a workspace. #### Parameters[​](#parameters-532 "Direct link to Parameters") ##### wid[​](#wid-442 "Direct link to wid") `string` #### Returns[​](#returns-545 "Direct link to Returns") `Promise`<[`Site`](https://docs.gravityrail.com/sdk/type-aliases/Site.md)\[]> #### Implementation of[​](#implementation-of-544 "Direct link to Implementation of") `SitesBindings.getSites` *** ### getSiteSharing()[​](#getsitesharing "Direct link to getSiteSharing()") > **getSiteSharing**: (`wid`, `siteId`) => `Promise`<[`SiteSharingResponse`](https://docs.gravityrail.com/sdk/interfaces/SiteSharingResponse.md)> Defined in: [packages/sdk/src/client/client.ts:546](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L546) Get a site's sharing settings. #### Parameters[​](#parameters-533 "Direct link to Parameters") ##### wid[​](#wid-443 "Direct link to wid") `string` ##### siteId[​](#siteid-15 "Direct link to siteId") `number` #### Returns[​](#returns-546 "Direct link to Returns") `Promise`<[`SiteSharingResponse`](https://docs.gravityrail.com/sdk/interfaces/SiteSharingResponse.md)> #### Implementation of[​](#implementation-of-545 "Direct link to Implementation of") `SitesBindings.getSiteSharing` *** ### getSiteSource()[​](#getsitesource "Direct link to getSiteSource()") > **getSiteSource**: (`wid`, `siteId`) => `Promise`<[`SiteSource`](https://docs.gravityrail.com/sdk/interfaces/SiteSource.md)> Defined in: [packages/sdk/src/client/client.ts:548](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L548) Get a site's source tree. #### Parameters[​](#parameters-534 "Direct link to Parameters") ##### wid[​](#wid-444 "Direct link to wid") `string` ##### siteId[​](#siteid-16 "Direct link to siteId") `number` #### Returns[​](#returns-547 "Direct link to Returns") `Promise`<[`SiteSource`](https://docs.gravityrail.com/sdk/interfaces/SiteSource.md)> #### Implementation of[​](#implementation-of-546 "Direct link to Implementation of") `SitesBindings.getSiteSource` *** ### getSiteSourceTemplates()[​](#getsitesourcetemplates "Direct link to getSiteSourceTemplates()") > **getSiteSourceTemplates**: (`wid`, `siteId`) => `Promise`<[`SiteSourceTemplates`](https://docs.gravityrail.com/sdk/interfaces/SiteSourceTemplates.md)> Defined in: [packages/sdk/src/client/client.ts:549](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L549) Starter templates the caller may seed (superuser-only ones filtered server-side). #### Parameters[​](#parameters-535 "Direct link to Parameters") ##### wid[​](#wid-445 "Direct link to wid") `string` ##### siteId[​](#siteid-17 "Direct link to siteId") `number` #### Returns[​](#returns-548 "Direct link to Returns") `Promise`<[`SiteSourceTemplates`](https://docs.gravityrail.com/sdk/interfaces/SiteSourceTemplates.md)> #### Implementation of[​](#implementation-of-547 "Direct link to Implementation of") `SitesBindings.getSiteSourceTemplates` *** ### getSlackApp()[​](#getslackapp "Direct link to getSlackApp()") > **getSlackApp**: (`wid`, `appId`) => `Promise`<[`SlackApp`](https://docs.gravityrail.com/sdk/type-aliases/SlackApp.md)> Defined in: [packages/sdk/src/client/client.ts:902](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L902) Get a specific Slack app by ID. #### Parameters[​](#parameters-536 "Direct link to Parameters") ##### wid[​](#wid-446 "Direct link to wid") `string` ##### appId[​](#appid-4 "Direct link to appId") `number` #### Returns[​](#returns-549 "Direct link to Returns") `Promise`<[`SlackApp`](https://docs.gravityrail.com/sdk/type-aliases/SlackApp.md)> #### Implementation of[​](#implementation-of-548 "Direct link to Implementation of") `IntegrationsBindings.getSlackApp` *** ### getSlackAppAccounts()[​](#getslackappaccounts "Direct link to getSlackAppAccounts()") > **getSlackAppAccounts**: (`wid`, `appId`, `options`) => `Promise`<[`PaginatedResponse`](https://docs.gravityrail.com/sdk/interfaces/PaginatedResponse.md)<[`SlackAccount`](https://docs.gravityrail.com/sdk/interfaces/SlackAccount.md)>> Defined in: [packages/sdk/src/client/client.ts:908](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L908) Get Slack account links for an app (members linked to Slack users). #### Parameters[​](#parameters-537 "Direct link to Parameters") ##### wid[​](#wid-447 "Direct link to wid") `string` ##### appId[​](#appid-5 "Direct link to appId") `number` ##### options?[​](#options-33 "Direct link to options?") ###### page?[​](#page-42 "Direct link to page?") `number` ###### pageSize?[​](#pagesize-42 "Direct link to pageSize?") `number` #### Returns[​](#returns-550 "Direct link to Returns") `Promise`<[`PaginatedResponse`](https://docs.gravityrail.com/sdk/interfaces/PaginatedResponse.md)<[`SlackAccount`](https://docs.gravityrail.com/sdk/interfaces/SlackAccount.md)>> #### Implementation of[​](#implementation-of-549 "Direct link to Implementation of") `IntegrationsBindings.getSlackAppAccounts` *** ### getSlackApps()[​](#getslackapps "Direct link to getSlackApps()") > **getSlackApps**: (`wid`, `options`) => `Promise`<[`PaginatedResponse`](https://docs.gravityrail.com/sdk/interfaces/PaginatedResponse.md)<[`SlackApp`](https://docs.gravityrail.com/sdk/type-aliases/SlackApp.md)>> Defined in: [packages/sdk/src/client/client.ts:901](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L901) List all Slack apps configured for a workspace. #### Parameters[​](#parameters-538 "Direct link to Parameters") ##### wid[​](#wid-448 "Direct link to wid") `string` ##### options?[​](#options-34 "Direct link to options?") ###### page?[​](#page-43 "Direct link to page?") `number` ###### pageSize?[​](#pagesize-43 "Direct link to pageSize?") `number` ###### search?[​](#search-12 "Direct link to search?") `string` ###### sortBy?[​](#sortby-6 "Direct link to sortBy?") [`SlackAppSortField`](https://docs.gravityrail.com/sdk/type-aliases/SlackAppSortField.md) ###### sortOrder?[​](#sortorder-6 "Direct link to sortOrder?") [`SortOrder`](https://docs.gravityrail.com/sdk/type-aliases/SortOrder.md) #### Returns[​](#returns-551 "Direct link to Returns") `Promise`<[`PaginatedResponse`](https://docs.gravityrail.com/sdk/interfaces/PaginatedResponse.md)<[`SlackApp`](https://docs.gravityrail.com/sdk/type-aliases/SlackApp.md)>> #### Implementation of[​](#implementation-of-550 "Direct link to Implementation of") `IntegrationsBindings.getSlackApps` *** ### getSlackInstallations()[​](#getslackinstallations "Direct link to getSlackInstallations()") > **getSlackInstallations**: (`wid`, `appId`, `options`) => `Promise`<[`PaginatedResponse`](https://docs.gravityrail.com/sdk/interfaces/PaginatedResponse.md)<[`SlackAppInstallation`](https://docs.gravityrail.com/sdk/interfaces/SlackAppInstallation.md)>> Defined in: [packages/sdk/src/client/client.ts:907](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L907) Get Slack workspace installations for an app. #### Parameters[​](#parameters-539 "Direct link to Parameters") ##### wid[​](#wid-449 "Direct link to wid") `string` ##### appId[​](#appid-6 "Direct link to appId") `number` ##### options?[​](#options-35 "Direct link to options?") ###### page?[​](#page-44 "Direct link to page?") `number` ###### pageSize?[​](#pagesize-44 "Direct link to pageSize?") `number` #### Returns[​](#returns-552 "Direct link to Returns") `Promise`<[`PaginatedResponse`](https://docs.gravityrail.com/sdk/interfaces/PaginatedResponse.md)<[`SlackAppInstallation`](https://docs.gravityrail.com/sdk/interfaces/SlackAppInstallation.md)>> #### Implementation of[​](#implementation-of-551 "Direct link to Implementation of") `IntegrationsBindings.getSlackInstallations` *** ### getSlackThreads()[​](#getslackthreads "Direct link to getSlackThreads()") > **getSlackThreads**: (`wid`, `appId`, `options`) => `Promise`<[`PaginatedResponse`](https://docs.gravityrail.com/sdk/interfaces/PaginatedResponse.md)<[`SlackThread`](https://docs.gravityrail.com/sdk/interfaces/SlackThread.md)>> Defined in: [packages/sdk/src/client/client.ts:906](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L906) Get Slack threads for an app. #### Parameters[​](#parameters-540 "Direct link to Parameters") ##### wid[​](#wid-450 "Direct link to wid") `string` ##### appId[​](#appid-7 "Direct link to appId") `number` ##### options?[​](#options-36 "Direct link to options?") ###### page?[​](#page-45 "Direct link to page?") `number` ###### pageSize?[​](#pagesize-45 "Direct link to pageSize?") `number` #### Returns[​](#returns-553 "Direct link to Returns") `Promise`<[`PaginatedResponse`](https://docs.gravityrail.com/sdk/interfaces/PaginatedResponse.md)<[`SlackThread`](https://docs.gravityrail.com/sdk/interfaces/SlackThread.md)>> #### Implementation of[​](#implementation-of-552 "Direct link to Implementation of") `IntegrationsBindings.getSlackThreads` *** ### getSMSUsageReport()[​](#getsmsusagereport "Direct link to getSMSUsageReport()") > **getSMSUsageReport**: (`wid`, `params?`) => `Promise`<[`SMSUsageReport`](https://docs.gravityrail.com/sdk/interfaces/SMSUsageReport.md)> Defined in: [packages/sdk/src/client/client.ts:822](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L822) Get SMS usage report for a workspace within an optional date range. #### Parameters[​](#parameters-541 "Direct link to Parameters") ##### wid[​](#wid-451 "Direct link to wid") `string` ##### params?[​](#params-27 "Direct link to params?") [`SMSUsageReportParams`](https://docs.gravityrail.com/sdk/interfaces/SMSUsageReportParams.md) #### Returns[​](#returns-554 "Direct link to Returns") `Promise`<[`SMSUsageReport`](https://docs.gravityrail.com/sdk/interfaces/SMSUsageReport.md)> #### Implementation of[​](#implementation-of-553 "Direct link to Implementation of") `BillingBindings.getSMSUsageReport` *** ### getStepMemberCounts()[​](#getstepmembercounts "Direct link to getStepMemberCounts()") > **getStepMemberCounts**: (`wid`, `journeyId`) => `Promise`<`StepMemberCountResponse`\[]> Defined in: [packages/sdk/src/client/client.ts:347](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L347) Get member counts by status for each journey step. #### Parameters[​](#parameters-542 "Direct link to Parameters") ##### wid[​](#wid-452 "Direct link to wid") `string` ##### journeyId[​](#journeyid-16 "Direct link to journeyId") `number` #### Returns[​](#returns-555 "Direct link to Returns") `Promise`<`StepMemberCountResponse`\[]> #### Implementation of[​](#implementation-of-554 "Direct link to Implementation of") `JourneysBindings.getStepMemberCounts` *** ### getStepMembers()[​](#getstepmembers "Direct link to getStepMembers()") > **getStepMembers**: (`wid`, `journeyId`, `stepUuid`, `params`) => `Promise`<[`PaginatedResponse`](https://docs.gravityrail.com/sdk/interfaces/PaginatedResponse.md)<`StepMemberResponse`>> Defined in: [packages/sdk/src/client/client.ts:346](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L346) List members currently or historically associated with one journey step. #### Parameters[​](#parameters-543 "Direct link to Parameters") ##### wid[​](#wid-453 "Direct link to wid") `string` ##### journeyId[​](#journeyid-17 "Direct link to journeyId") `number` ##### stepUuid[​](#stepuuid-2 "Direct link to stepUuid") `string` ##### params?[​](#params-28 "Direct link to params?") ###### mode?[​](#mode "Direct link to mode?") `"all"` | `"current"` ###### page?[​](#page-46 "Direct link to page?") `number` ###### pageSize?[​](#pagesize-46 "Direct link to pageSize?") `number` ###### status?[​](#status-13 "Direct link to status?") `string` #### Returns[​](#returns-556 "Direct link to Returns") `Promise`<[`PaginatedResponse`](https://docs.gravityrail.com/sdk/interfaces/PaginatedResponse.md)<`StepMemberResponse`>> #### Implementation of[​](#implementation-of-555 "Direct link to Implementation of") `JourneysBindings.getStepMembers` *** ### getSTTModels()[​](#getsttmodels "Direct link to getSTTModels()") > **getSTTModels**: (`provider?`) => `Promise`<[`STTModelsResponse`](https://docs.gravityrail.com/sdk/interfaces/STTModelsResponse.md)> Defined in: [packages/sdk/src/client/client.ts:775](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L775) 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[​](#parameters-544 "Direct link to Parameters") ##### provider?[​](#provider-3 "Direct link to provider?") `string` #### Returns[​](#returns-557 "Direct link to Returns") `Promise`<[`STTModelsResponse`](https://docs.gravityrail.com/sdk/interfaces/STTModelsResponse.md)> #### Implementation of[​](#implementation-of-556 "Direct link to Implementation of") `ToolkitsBindings.getSTTModels` *** ### getSubscriptions()[​](#getsubscriptions "Direct link to getSubscriptions()") > **getSubscriptions**: () => `Promise`<`SubscriptionResponse`\[]> Defined in: [packages/sdk/src/client/client.ts:812](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L812) List all subscriptions for the current account. #### Returns[​](#returns-558 "Direct link to Returns") `Promise`<`SubscriptionResponse`\[]> #### Implementation of[​](#implementation-of-557 "Direct link to Implementation of") `BillingBindings.getSubscriptions` *** ### getSupervisor()[​](#getsupervisor "Direct link to getSupervisor()") > **getSupervisor**: (`wid`, `id`) => `Promise`<[`CustomTool`](https://docs.gravityrail.com/sdk/type-aliases/CustomTool.md)> Defined in: [packages/sdk/src/client/client.ts:687](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L687) Get a single supervisor by ID. #### Parameters[​](#parameters-545 "Direct link to Parameters") ##### wid[​](#wid-454 "Direct link to wid") `string` ##### id[​](#id-66 "Direct link to id") `number` #### Returns[​](#returns-559 "Direct link to Returns") `Promise`<[`CustomTool`](https://docs.gravityrail.com/sdk/type-aliases/CustomTool.md)> #### Implementation of[​](#implementation-of-558 "Direct link to Implementation of") `WorkflowsBindings.getSupervisor` *** ### getSupervisors()[​](#getsupervisors "Direct link to getSupervisors()") > **getSupervisors**: (`wid`) => `Promise`<[`CustomTool`](https://docs.gravityrail.com/sdk/type-aliases/CustomTool.md)\[]> Defined in: [packages/sdk/src/client/client.ts:686](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L686) List all supervisors in a workspace. #### Parameters[​](#parameters-546 "Direct link to Parameters") ##### wid[​](#wid-455 "Direct link to wid") `string` #### Returns[​](#returns-560 "Direct link to Returns") `Promise`<[`CustomTool`](https://docs.gravityrail.com/sdk/type-aliases/CustomTool.md)\[]> #### Implementation of[​](#implementation-of-559 "Direct link to Implementation of") `WorkflowsBindings.getSupervisors` *** ### getSupportRequest()[​](#getsupportrequest "Direct link to getSupportRequest()") > **getSupportRequest**: (`uuid`) => `Promise`<`SupportRequest`> Defined in: [packages/sdk/src/client/client.ts:1081](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L1081) #### Parameters[​](#parameters-547 "Direct link to Parameters") ##### uuid[​](#uuid-29 "Direct link to uuid") `string` #### Returns[​](#returns-561 "Direct link to Returns") `Promise`<`SupportRequest`> #### Implementation of[​](#implementation-of-560 "Direct link to Implementation of") `SupportRequestsBindings.getSupportRequest` *** ### getSyncRunItems()[​](#getsyncrunitems "Direct link to getSyncRunItems()") > **getSyncRunItems**: (`wid`, `connectionId`, `runId`, `limit`) => `Promise`<`SyncRunItemDetail`\[]> Defined in: [packages/sdk/src/client/client.ts:1028](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L1028) #### Parameters[​](#parameters-548 "Direct link to Parameters") ##### wid[​](#wid-456 "Direct link to wid") `string` ##### connectionId[​](#connectionid-31 "Direct link to connectionId") `number` ##### runId[​](#runid-3 "Direct link to runId") `string` ##### limit?[​](#limit-11 "Direct link to limit?") `number` = `500` #### Returns[​](#returns-562 "Direct link to Returns") `Promise`<`SyncRunItemDetail`\[]> #### Implementation of[​](#implementation-of-561 "Direct link to Implementation of") `IntegrationsBindings.getSyncRunItems` *** ### getSyncRuns()[​](#getsyncruns "Direct link to getSyncRuns()") > **getSyncRuns**: (`wid`, `connectionId`, `limit`) => `Promise`<`SyncRunSummary`\[]> Defined in: [packages/sdk/src/client/client.ts:1027](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L1027) #### Parameters[​](#parameters-549 "Direct link to Parameters") ##### wid[​](#wid-457 "Direct link to wid") `string` ##### connectionId[​](#connectionid-32 "Direct link to connectionId") `number` ##### limit?[​](#limit-12 "Direct link to limit?") `number` = `20` #### Returns[​](#returns-563 "Direct link to Returns") `Promise`<`SyncRunSummary`\[]> #### Implementation of[​](#implementation-of-562 "Direct link to Implementation of") `IntegrationsBindings.getSyncRuns` *** ### getTask()[​](#gettask "Direct link to getTask()") > **getTask**: (`wid`, `id`) => `Promise`<[`Task`](https://docs.gravityrail.com/sdk/type-aliases/Task.md)> Defined in: [packages/sdk/src/client/client.ts:125](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L125) Get a single task by ID. #### Parameters[​](#parameters-550 "Direct link to Parameters") ##### wid[​](#wid-458 "Direct link to wid") `string` ##### id[​](#id-67 "Direct link to id") `string` | `number` #### Returns[​](#returns-564 "Direct link to Returns") `Promise`<[`Task`](https://docs.gravityrail.com/sdk/type-aliases/Task.md)> #### Implementation of[​](#implementation-of-563 "Direct link to Implementation of") `TasksBindings.getTask` *** ### getTaskChats()[​](#gettaskchats "Direct link to getTaskChats()") > **getTaskChats**: (`wid`, `workflowId`, `taskId`, `fromDate?`, `toDate?`, `limit`, `offset`) => `Promise`<[`TaskChatsListResponse`](https://docs.gravityrail.com/sdk/interfaces/TaskChatsListResponse.md)> Defined in: [packages/sdk/src/client/client.ts:661](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L661) List chats for a specific task within a workflow. #### Parameters[​](#parameters-551 "Direct link to Parameters") ##### wid[​](#wid-459 "Direct link to wid") `string` ##### workflowId[​](#workflowid-7 "Direct link to workflowId") `number` ##### taskId[​](#taskid-1 "Direct link to taskId") `number` ##### fromDate?[​](#fromdate "Direct link to fromDate?") `string` ##### toDate?[​](#todate "Direct link to toDate?") `string` ##### limit?[​](#limit-13 "Direct link to limit?") `number` = `100` ##### offset?[​](#offset-7 "Direct link to offset?") `number` = `0` #### Returns[​](#returns-565 "Direct link to Returns") `Promise`<[`TaskChatsListResponse`](https://docs.gravityrail.com/sdk/interfaces/TaskChatsListResponse.md)> #### Implementation of[​](#implementation-of-564 "Direct link to Implementation of") `WorkflowsBindings.getTaskChats` *** ### getTasks()[​](#gettasks "Direct link to getTasks()") > **getTasks**: (`wid`, `options`) => `Promise`<[`Task`](https://docs.gravityrail.com/sdk/type-aliases/Task.md)\[]> Defined in: [packages/sdk/src/client/client.ts:124](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L124) List all tasks in a workspace, optionally filtering by workflow or including archived. #### Parameters[​](#parameters-552 "Direct link to Parameters") ##### wid[​](#wid-460 "Direct link to wid") `string` ##### options?[​](#options-37 "Direct link to options?") ###### includeArchived?[​](#includearchived-3 "Direct link to includeArchived?") `boolean` ###### sortBy?[​](#sortby-7 "Direct link to sortBy?") `"name"` | `"workflowId"` | `"createdAt"` ###### sortOrder?[​](#sortorder-7 "Direct link to sortOrder?") `"asc"` | `"desc"` ###### workflowId?[​](#workflowid-8 "Direct link to workflowId?") `number` #### Returns[​](#returns-566 "Direct link to Returns") `Promise`<[`Task`](https://docs.gravityrail.com/sdk/type-aliases/Task.md)\[]> #### Implementation of[​](#implementation-of-565 "Direct link to Implementation of") `TasksBindings.getTasks` *** ### getTeamsApp()[​](#getteamsapp "Direct link to getTeamsApp()") > **getTeamsApp**: (`wid`, `appId`) => `Promise`<[`TeamsAppResponse`](https://docs.gravityrail.com/sdk/interfaces/TeamsAppResponse.md)> Defined in: [packages/sdk/src/client/client.ts:912](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L912) #### Parameters[​](#parameters-553 "Direct link to Parameters") ##### wid[​](#wid-461 "Direct link to wid") `string` ##### appId[​](#appid-8 "Direct link to appId") `number` #### Returns[​](#returns-567 "Direct link to Returns") `Promise`<[`TeamsAppResponse`](https://docs.gravityrail.com/sdk/interfaces/TeamsAppResponse.md)> #### Implementation of[​](#implementation-of-566 "Direct link to Implementation of") `IntegrationsBindings.getTeamsApp` *** ### getTeamsAppAccounts()[​](#getteamsappaccounts "Direct link to getTeamsAppAccounts()") > **getTeamsAppAccounts**: (`wid`, `appId`, `options`) => `Promise`<[`PaginatedResponse`](https://docs.gravityrail.com/sdk/interfaces/PaginatedResponse.md)<[`TeamsAccountResponse`](https://docs.gravityrail.com/sdk/interfaces/TeamsAccountResponse.md)>> Defined in: [packages/sdk/src/client/client.ts:918](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L918) #### Parameters[​](#parameters-554 "Direct link to Parameters") ##### wid[​](#wid-462 "Direct link to wid") `string` ##### appId[​](#appid-9 "Direct link to appId") `number` ##### options?[​](#options-38 "Direct link to options?") ###### page?[​](#page-47 "Direct link to page?") `number` ###### pageSize?[​](#pagesize-47 "Direct link to pageSize?") `number` #### Returns[​](#returns-568 "Direct link to Returns") `Promise`<[`PaginatedResponse`](https://docs.gravityrail.com/sdk/interfaces/PaginatedResponse.md)<[`TeamsAccountResponse`](https://docs.gravityrail.com/sdk/interfaces/TeamsAccountResponse.md)>> #### Implementation of[​](#implementation-of-567 "Direct link to Implementation of") `IntegrationsBindings.getTeamsAppAccounts` *** ### getTeamsApps()[​](#getteamsapps "Direct link to getTeamsApps()") > **getTeamsApps**: (`wid`, `options`) => `Promise`<[`PaginatedResponse`](https://docs.gravityrail.com/sdk/interfaces/PaginatedResponse.md)<[`TeamsAppResponse`](https://docs.gravityrail.com/sdk/interfaces/TeamsAppResponse.md)>> Defined in: [packages/sdk/src/client/client.ts:911](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L911) List all Teams apps configured for a workspace. #### Parameters[​](#parameters-555 "Direct link to Parameters") ##### wid[​](#wid-463 "Direct link to wid") `string` ##### options?[​](#options-39 "Direct link to options?") ###### page?[​](#page-48 "Direct link to page?") `number` ###### pageSize?[​](#pagesize-48 "Direct link to pageSize?") `number` ###### search?[​](#search-13 "Direct link to search?") `string` ###### sortBy?[​](#sortby-8 "Direct link to sortBy?") [`TeamsAppSortField`](https://docs.gravityrail.com/sdk/type-aliases/TeamsAppSortField.md) ###### sortOrder?[​](#sortorder-8 "Direct link to sortOrder?") [`SortOrder`](https://docs.gravityrail.com/sdk/type-aliases/SortOrder.md) #### Returns[​](#returns-569 "Direct link to Returns") `Promise`<[`PaginatedResponse`](https://docs.gravityrail.com/sdk/interfaces/PaginatedResponse.md)<[`TeamsAppResponse`](https://docs.gravityrail.com/sdk/interfaces/TeamsAppResponse.md)>> #### Implementation of[​](#implementation-of-568 "Direct link to Implementation of") `IntegrationsBindings.getTeamsApps` *** ### getTeamsConversations()[​](#getteamsconversations "Direct link to getTeamsConversations()") > **getTeamsConversations**: (`wid`, `appId`, `options`) => `Promise`<[`PaginatedResponse`](https://docs.gravityrail.com/sdk/interfaces/PaginatedResponse.md)<[`TeamsConversation`](https://docs.gravityrail.com/sdk/type-aliases/TeamsConversation.md)>> Defined in: [packages/sdk/src/client/client.ts:916](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L916) #### Parameters[​](#parameters-556 "Direct link to Parameters") ##### wid[​](#wid-464 "Direct link to wid") `string` ##### appId[​](#appid-10 "Direct link to appId") `number` ##### options?[​](#options-40 "Direct link to options?") ###### page?[​](#page-49 "Direct link to page?") `number` ###### pageSize?[​](#pagesize-49 "Direct link to pageSize?") `number` #### Returns[​](#returns-570 "Direct link to Returns") `Promise`<[`PaginatedResponse`](https://docs.gravityrail.com/sdk/interfaces/PaginatedResponse.md)<[`TeamsConversation`](https://docs.gravityrail.com/sdk/type-aliases/TeamsConversation.md)>> #### Implementation of[​](#implementation-of-569 "Direct link to Implementation of") `IntegrationsBindings.getTeamsConversations` *** ### getTeamsInstallations()[​](#getteamsinstallations "Direct link to getTeamsInstallations()") > **getTeamsInstallations**: (`wid`, `appId`, `options`) => `Promise`<[`PaginatedResponse`](https://docs.gravityrail.com/sdk/interfaces/PaginatedResponse.md)<[`TeamsAppInstallationResponse`](https://docs.gravityrail.com/sdk/interfaces/TeamsAppInstallationResponse.md)>> Defined in: [packages/sdk/src/client/client.ts:917](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L917) #### Parameters[​](#parameters-557 "Direct link to Parameters") ##### wid[​](#wid-465 "Direct link to wid") `string` ##### appId[​](#appid-11 "Direct link to appId") `number` ##### options?[​](#options-41 "Direct link to options?") ###### page?[​](#page-50 "Direct link to page?") `number` ###### pageSize?[​](#pagesize-50 "Direct link to pageSize?") `number` #### Returns[​](#returns-571 "Direct link to Returns") `Promise`<[`PaginatedResponse`](https://docs.gravityrail.com/sdk/interfaces/PaginatedResponse.md)<[`TeamsAppInstallationResponse`](https://docs.gravityrail.com/sdk/interfaces/TeamsAppInstallationResponse.md)>> #### Implementation of[​](#implementation-of-570 "Direct link to Implementation of") `IntegrationsBindings.getTeamsInstallations` *** ### getTemplateContext()[​](#gettemplatecontext "Direct link to getTemplateContext()") > **getTemplateContext**: (`wid`, `request`) => `Promise`<[`TemplateContextResponse`](https://docs.gravityrail.com/sdk/interfaces/TemplateContextResponse.md)> Defined in: [packages/sdk/src/client/client.ts:770](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L770) 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[​](#parameters-558 "Direct link to Parameters") ##### wid[​](#wid-466 "Direct link to wid") `string` ##### request[​](#request-12 "Direct link to request") [`TemplateContextRequest`](https://docs.gravityrail.com/sdk/interfaces/TemplateContextRequest.md) #### Returns[​](#returns-572 "Direct link to Returns") `Promise`<[`TemplateContextResponse`](https://docs.gravityrail.com/sdk/interfaces/TemplateContextResponse.md)> #### Implementation of[​](#implementation-of-571 "Direct link to Implementation of") `ToolkitsBindings.getTemplateContext` *** ### getTestChatRun()[​](#gettestchatrun "Direct link to getTestChatRun()") > **getTestChatRun**: (`wid`, `runId`) => `Promise`<[`TestChatRunResponse`](https://docs.gravityrail.com/sdk/interfaces/TestChatRunResponse.md)> Defined in: [packages/sdk/src/client/client.ts:306](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L306) #### Parameters[​](#parameters-559 "Direct link to Parameters") ##### wid[​](#wid-467 "Direct link to wid") `string` ##### runId[​](#runid-4 "Direct link to runId") `number` #### Returns[​](#returns-573 "Direct link to Returns") `Promise`<[`TestChatRunResponse`](https://docs.gravityrail.com/sdk/interfaces/TestChatRunResponse.md)> #### Implementation of[​](#implementation-of-572 "Direct link to Implementation of") `QualificationsBindings.getTestChatRun` *** ### getThemeSettings()[​](#getthemesettings "Direct link to getThemeSettings()") > **getThemeSettings**: (`wid`, `siteId`, `theme?`) => `Promise`<[`ThemeSettingsResponse`](https://docs.gravityrail.com/sdk/interfaces/ThemeSettingsResponse.md)> Defined in: [packages/sdk/src/client/client.ts:557](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L557) 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[​](#parameters-560 "Direct link to Parameters") ##### wid[​](#wid-468 "Direct link to wid") `string` ##### siteId[​](#siteid-18 "Direct link to siteId") `number` ##### theme?[​](#theme "Direct link to theme?") `string` #### Returns[​](#returns-574 "Direct link to Returns") `Promise`<[`ThemeSettingsResponse`](https://docs.gravityrail.com/sdk/interfaces/ThemeSettingsResponse.md)> #### Implementation of[​](#implementation-of-573 "Direct link to Implementation of") `SitesBindings.getThemeSettings` *** ### getThreadEmails()[​](#getthreademails "Direct link to getThreadEmails()") > **getThreadEmails**: (`wid`, `inboxId`, `assignmentId`, `options`) => `Promise`<`ThreadEmailsResponse`> Defined in: [packages/sdk/src/client/client.ts:759](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L759) List emails in a thread by assignment ID with pagination. #### Parameters[​](#parameters-561 "Direct link to Parameters") ##### wid[​](#wid-469 "Direct link to wid") `string` ##### inboxId[​](#inboxid-6 "Direct link to inboxId") `number` ##### assignmentId[​](#assignmentid-4 "Direct link to assignmentId") `number` ##### options?[​](#options-42 "Direct link to options?") ###### includeAttachments?[​](#includeattachments-2 "Direct link to includeAttachments?") `boolean` ###### page?[​](#page-51 "Direct link to page?") `number` ###### pageSize?[​](#pagesize-51 "Direct link to pageSize?") `number` #### Returns[​](#returns-575 "Direct link to Returns") `Promise`<`ThreadEmailsResponse`> #### Implementation of[​](#implementation-of-574 "Direct link to Implementation of") `CommunicationsBindings.getThreadEmails` *** ### getTool()[​](#gettool "Direct link to getTool()") > **getTool**: (`wid`, `chatId`, `toolName`) => `Promise`<[`ToolResponse`](https://docs.gravityrail.com/sdk/interfaces/ToolResponse.md)> Defined in: [packages/sdk/src/client/client.ts:769](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L769) Get details for a specific tool by name within a chat context. Searches tools available to the chat's assistant. #### Parameters[​](#parameters-562 "Direct link to Parameters") ##### wid[​](#wid-470 "Direct link to wid") `string` ##### chatId[​](#chatid-16 "Direct link to chatId") `number` ##### toolName[​](#toolname-1 "Direct link to toolName") `string` #### Returns[​](#returns-576 "Direct link to Returns") `Promise`<[`ToolResponse`](https://docs.gravityrail.com/sdk/interfaces/ToolResponse.md)> #### Implementation of[​](#implementation-of-575 "Direct link to Implementation of") `ToolkitsBindings.getTool` *** ### getToolCallNames()[​](#gettoolcallnames "Direct link to getToolCallNames()") > **getToolCallNames**: (`wid`) => `Promise`<`string`\[]> Defined in: [packages/sdk/src/client/client.ts:149](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L149) Get distinct tool call names used across workspace chats. #### Parameters[​](#parameters-563 "Direct link to Parameters") ##### wid[​](#wid-471 "Direct link to wid") `string` #### Returns[​](#returns-577 "Direct link to Returns") `Promise`<`string`\[]> #### Implementation of[​](#implementation-of-576 "Direct link to Implementation of") `ChatsBindings.getToolCallNames` *** ### getToolkits()[​](#gettoolkits "Direct link to getToolkits()") > **getToolkits**: (`wid`) => `Promise`<[`ToolkitsResponse`](https://docs.gravityrail.com/sdk/interfaces/ToolkitsResponse.md)> Defined in: [packages/sdk/src/client/client.ts:768](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L768) Get available toolkits for the workspace #### Parameters[​](#parameters-564 "Direct link to Parameters") ##### wid[​](#wid-472 "Direct link to wid") `string` #### Returns[​](#returns-578 "Direct link to Returns") `Promise`<[`ToolkitsResponse`](https://docs.gravityrail.com/sdk/interfaces/ToolkitsResponse.md)> #### Implementation of[​](#implementation-of-577 "Direct link to Implementation of") `ToolkitsBindings.getToolkits` *** ### getTTSModels()[​](#getttsmodels "Direct link to getTTSModels()") > **getTTSModels**: (`provider?`) => `Promise`<[`AIModelsResponse`](https://docs.gravityrail.com/sdk/interfaces/AIModelsResponse.md)> Defined in: [packages/sdk/src/client/client.ts:776](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L776) Get available text-to-speech models #### Parameters[​](#parameters-565 "Direct link to Parameters") ##### provider?[​](#provider-4 "Direct link to provider?") `string` #### Returns[​](#returns-579 "Direct link to Returns") `Promise`<[`AIModelsResponse`](https://docs.gravityrail.com/sdk/interfaces/AIModelsResponse.md)> #### Implementation of[​](#implementation-of-578 "Direct link to Implementation of") `ToolkitsBindings.getTTSModels` *** ### getTwoFactorStatus()[​](#gettwofactorstatus "Direct link to getTwoFactorStatus()") > **getTwoFactorStatus**: () => `Promise`<[`TwoFactorStatus`](https://docs.gravityrail.com/sdk/type-aliases/TwoFactorStatus.md)> Defined in: [packages/sdk/src/client/client.ts:506](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L506) Get the current two-factor authentication status and configured methods. #### Returns[​](#returns-580 "Direct link to Returns") `Promise`<[`TwoFactorStatus`](https://docs.gravityrail.com/sdk/type-aliases/TwoFactorStatus.md)> #### Implementation of[​](#implementation-of-579 "Direct link to Implementation of") `AuthBindings.getTwoFactorStatus` *** ### getUnreadNotificationCount()[​](#getunreadnotificationcount "Direct link to getUnreadNotificationCount()") > **getUnreadNotificationCount**: (`wid`) => `Promise`<`number`> Defined in: [packages/sdk/src/client/client.ts:417](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L417) Get the count of unread notifications for the current user. #### Parameters[​](#parameters-566 "Direct link to Parameters") ##### wid[​](#wid-473 "Direct link to wid") `string` #### Returns[​](#returns-581 "Direct link to Returns") `Promise`<`number`> #### Implementation of[​](#implementation-of-580 "Direct link to Implementation of") `WorkspacesBindings.getUnreadNotificationCount` *** ### getUsageDashboard()[​](#getusagedashboard "Direct link to getUsageDashboard()") > **getUsageDashboard**: (`wid`) => `Promise`<[`UsageDashboardResponse`](https://docs.gravityrail.com/sdk/type-aliases/UsageDashboardResponse.md)> Defined in: [packages/sdk/src/client/client.ts:443](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L443) Get billing dashboard data for a workspace. This endpoint is available to organization owners (with org:info 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[​](#parameters-567 "Direct link to Parameters") ##### wid[​](#wid-474 "Direct link to wid") `string` #### Returns[​](#returns-582 "Direct link to Returns") `Promise`<[`UsageDashboardResponse`](https://docs.gravityrail.com/sdk/type-aliases/UsageDashboardResponse.md)> #### Implementation of[​](#implementation-of-581 "Direct link to Implementation of") `WorkspacesBindings.getUsageDashboard` *** ### getUserAccount()[​](#getuseraccount "Direct link to getUserAccount()") > **getUserAccount**: () => `Promise`<[`Account`](https://docs.gravityrail.com/sdk/interfaces/Account.md)> Defined in: [packages/sdk/src/client/client.ts:486](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L486) Get the authenticated user's account. #### Returns[​](#returns-583 "Direct link to Returns") `Promise`<[`Account`](https://docs.gravityrail.com/sdk/interfaces/Account.md)> #### Implementation of[​](#implementation-of-582 "Direct link to Implementation of") `AuthBindings.getUserAccount` *** ### getVapidPublicKey()[​](#getvapidpublickey "Direct link to getVapidPublicKey()") > **getVapidPublicKey**: () => `Promise`<`string` | `null`> Defined in: [packages/sdk/src/client/client.ts:467](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L467) Get the VAPID public key for Web Push subscription registration. #### Returns[​](#returns-584 "Direct link to Returns") `Promise`<`string` | `null`> #### Implementation of[​](#implementation-of-583 "Direct link to Implementation of") `WorkspacesBindings.getVapidPublicKey` *** ### getVariableRegistry()[​](#getvariableregistry "Direct link to getVariableRegistry()") > **getVariableRegistry**: (`wid`, `request`) => `Promise`<[`VariableRegistryResponse`](https://docs.gravityrail.com/sdk/interfaces/VariableRegistryResponse.md)> Defined in: [packages/sdk/src/client/client.ts:772](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L772) 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[​](#parameters-568 "Direct link to Parameters") ##### wid[​](#wid-475 "Direct link to wid") `string` ##### request?[​](#request-13 "Direct link to request?") [`VariableRegistryRequest`](https://docs.gravityrail.com/sdk/interfaces/VariableRegistryRequest.md) = `{}` #### Returns[​](#returns-585 "Direct link to Returns") `Promise`<[`VariableRegistryResponse`](https://docs.gravityrail.com/sdk/interfaces/VariableRegistryResponse.md)> #### Implementation of[​](#implementation-of-584 "Direct link to Implementation of") `ToolkitsBindings.getVariableRegistry` *** ### getVoiceModels()[​](#getvoicemodels "Direct link to getVoiceModels()") > **getVoiceModels**: (`provider?`) => `Promise`<[`VoiceModelsResponse`](https://docs.gravityrail.com/sdk/type-aliases/VoiceModelsResponse.md)> Defined in: [packages/sdk/src/client/client.ts:777](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L777) Get available voice models with metadata #### Parameters[​](#parameters-569 "Direct link to Parameters") ##### provider?[​](#provider-5 "Direct link to provider?") `string` #### Returns[​](#returns-586 "Direct link to Returns") `Promise`<[`VoiceModelsResponse`](https://docs.gravityrail.com/sdk/type-aliases/VoiceModelsResponse.md)> #### Implementation of[​](#implementation-of-585 "Direct link to Implementation of") `ToolkitsBindings.getVoiceModels` *** ### getVoiceToken()[​](#getvoicetoken "Direct link to getVoiceToken()") > **getVoiceToken**: (`wid`) => `Promise`<[`VoiceTokenResponse`](https://docs.gravityrail.com/sdk/interfaces/VoiceTokenResponse.md)> Defined in: [packages/sdk/src/client/client.ts:189](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L189) Get a voice authentication token for real-time audio. #### Parameters[​](#parameters-570 "Direct link to Parameters") ##### wid[​](#wid-476 "Direct link to wid") `string` #### Returns[​](#returns-587 "Direct link to Returns") `Promise`<[`VoiceTokenResponse`](https://docs.gravityrail.com/sdk/interfaces/VoiceTokenResponse.md)> #### Implementation of[​](#implementation-of-586 "Direct link to Implementation of") `CallsBindings.getVoiceToken` *** ### getVoiceUsageReport()[​](#getvoiceusagereport "Direct link to getVoiceUsageReport()") > **getVoiceUsageReport**: (`wid`, `params?`) => `Promise`<[`VoiceUsageReport`](https://docs.gravityrail.com/sdk/interfaces/VoiceUsageReport.md)> Defined in: [packages/sdk/src/client/client.ts:824](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L824) Get voice (STT/TTS) usage report for a workspace within an optional date range. #### Parameters[​](#parameters-571 "Direct link to Parameters") ##### wid[​](#wid-477 "Direct link to wid") `string` ##### params?[​](#params-29 "Direct link to params?") [`VoiceUsageReportParams`](https://docs.gravityrail.com/sdk/interfaces/VoiceUsageReportParams.md) #### Returns[​](#returns-588 "Direct link to Returns") `Promise`<[`VoiceUsageReport`](https://docs.gravityrail.com/sdk/interfaces/VoiceUsageReport.md)> #### Implementation of[​](#implementation-of-587 "Direct link to Implementation of") `BillingBindings.getVoiceUsageReport` *** ### getWebAuthnAuthOptions()[​](#getwebauthnauthoptions "Direct link to getWebAuthnAuthOptions()") > **getWebAuthnAuthOptions**: (`tempToken`) => `Promise`<{ `credentialRequestOptions`: { `allowCredentials`: `object`\[]; `challenge`: `string`; `rpId`: `string`; `timeout`: `number`; `userVerification`: `string`; }; }> Defined in: [packages/sdk/src/client/client.ts:513](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L513) Get WebAuthn credential request options for two-factor login verification. #### Parameters[​](#parameters-572 "Direct link to Parameters") ##### tempToken[​](#temptoken "Direct link to tempToken") `string` #### Returns[​](#returns-589 "Direct link to Returns") `Promise`<{ `credentialRequestOptions`: { `allowCredentials`: `object`\[]; `challenge`: `string`; `rpId`: `string`; `timeout`: `number`; `userVerification`: `string`; }; }> #### Implementation of[​](#implementation-of-588 "Direct link to Implementation of") `AuthBindings.getWebAuthnAuthOptions` *** ### getWebhookLogs()[​](#getwebhooklogs "Direct link to getWebhookLogs()") > **getWebhookLogs**: (`wid`, `options`) => `Promise`<[`PaginatedResponse`](https://docs.gravityrail.com/sdk/interfaces/PaginatedResponse.md)<[`WebhookLogResponse`](https://docs.gravityrail.com/sdk/interfaces/WebhookLogResponse.md)>> Defined in: [packages/sdk/src/client/client.ts:632](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L632) List webhook logs with optional filtering by event type and success status. #### Parameters[​](#parameters-573 "Direct link to Parameters") ##### wid[​](#wid-478 "Direct link to wid") `string` ##### options?[​](#options-43 "Direct link to options?") [`WebhookLogsQueryParams`](https://docs.gravityrail.com/sdk/interfaces/WebhookLogsQueryParams.md) = `{}` #### Returns[​](#returns-590 "Direct link to Returns") `Promise`<[`PaginatedResponse`](https://docs.gravityrail.com/sdk/interfaces/PaginatedResponse.md)<[`WebhookLogResponse`](https://docs.gravityrail.com/sdk/interfaces/WebhookLogResponse.md)>> #### Implementation of[​](#implementation-of-589 "Direct link to Implementation of") `EventsBindings.getWebhookLogs` *** ### getWorkflow()[​](#getworkflow "Direct link to getWorkflow()") > **getWorkflow**: (`wid`, `id`) => `Promise`<[`Workflow`](https://docs.gravityrail.com/sdk/type-aliases/Workflow.md)> Defined in: [packages/sdk/src/client/client.ts:646](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L646) Get a single workflow by ID. #### Parameters[​](#parameters-574 "Direct link to Parameters") ##### wid[​](#wid-479 "Direct link to wid") `string` ##### id[​](#id-68 "Direct link to id") `string` | `number` #### Returns[​](#returns-591 "Direct link to Returns") `Promise`<[`Workflow`](https://docs.gravityrail.com/sdk/type-aliases/Workflow.md)> #### Implementation of[​](#implementation-of-590 "Direct link to Implementation of") `WorkflowsBindings.getWorkflow` *** ### getWorkflowAccessValidation()[​](#getworkflowaccessvalidation "Direct link to getWorkflowAccessValidation()") > **getWorkflowAccessValidation**: (`wid`, `workflowId`) => `Promise`<[`WorkflowAccessValidationResponse`](https://docs.gravityrail.com/sdk/interfaces/WorkflowAccessValidationResponse.md)> Defined in: [packages/sdk/src/client/client.ts:662](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L662) #### Parameters[​](#parameters-575 "Direct link to Parameters") ##### wid[​](#wid-480 "Direct link to wid") `string` ##### workflowId[​](#workflowid-9 "Direct link to workflowId") `number` #### Returns[​](#returns-592 "Direct link to Returns") `Promise`<[`WorkflowAccessValidationResponse`](https://docs.gravityrail.com/sdk/interfaces/WorkflowAccessValidationResponse.md)> #### Implementation of[​](#implementation-of-591 "Direct link to Implementation of") `WorkflowsBindings.getWorkflowAccessValidation` *** ### getWorkflowActivity()[​](#getworkflowactivity "Direct link to getWorkflowActivity()") > **getWorkflowActivity**: (`wid`, `id`, `options?`) => `Promise`<[`WorkflowActivity`](https://docs.gravityrail.com/sdk/interfaces/WorkflowActivity.md)> Defined in: [packages/sdk/src/client/client.ts:647](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L647) Get activity metrics for a single workflow. #### Parameters[​](#parameters-576 "Direct link to Parameters") ##### wid[​](#wid-481 "Direct link to wid") `string` ##### id[​](#id-69 "Direct link to id") `number` ##### options?[​](#options-44 "Direct link to options?") ###### days?[​](#days-1 "Direct link to days?") `number` #### Returns[​](#returns-593 "Direct link to Returns") `Promise`<[`WorkflowActivity`](https://docs.gravityrail.com/sdk/interfaces/WorkflowActivity.md)> #### Implementation of[​](#implementation-of-592 "Direct link to Implementation of") `WorkflowsBindings.getWorkflowActivity` *** ### getWorkflowConfigValidation()[​](#getworkflowconfigvalidation "Direct link to getWorkflowConfigValidation()") > **getWorkflowConfigValidation**: (`wid`, `workflowId`) => `Promise`<[`WorkflowConfigValidationResponse`](https://docs.gravityrail.com/sdk/interfaces/WorkflowConfigValidationResponse.md)> Defined in: [packages/sdk/src/client/client.ts:663](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L663) #### Parameters[​](#parameters-577 "Direct link to Parameters") ##### wid[​](#wid-482 "Direct link to wid") `string` ##### workflowId[​](#workflowid-10 "Direct link to workflowId") `number` #### Returns[​](#returns-594 "Direct link to Returns") `Promise`<[`WorkflowConfigValidationResponse`](https://docs.gravityrail.com/sdk/interfaces/WorkflowConfigValidationResponse.md)> #### Implementation of[​](#implementation-of-593 "Direct link to Implementation of") `WorkflowsBindings.getWorkflowConfigValidation` *** ### getWorkflowContributors()[​](#getworkflowcontributors "Direct link to getWorkflowContributors()") > **getWorkflowContributors**: (`wid`, `workflowId`) => `Promise`<[`WorkflowContributorResponse`](https://docs.gravityrail.com/sdk/interfaces/WorkflowContributorResponse.md)\[]> Defined in: [packages/sdk/src/client/client.ts:668](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L668) List all contributors for a workflow. #### Parameters[​](#parameters-578 "Direct link to Parameters") ##### wid[​](#wid-483 "Direct link to wid") `string` ##### workflowId[​](#workflowid-11 "Direct link to workflowId") `number` #### Returns[​](#returns-595 "Direct link to Returns") `Promise`<[`WorkflowContributorResponse`](https://docs.gravityrail.com/sdk/interfaces/WorkflowContributorResponse.md)\[]> #### Implementation of[​](#implementation-of-594 "Direct link to Implementation of") `WorkflowsBindings.getWorkflowContributors` *** ### getWorkflowDeletionPreview()[​](#getworkflowdeletionpreview "Direct link to getWorkflowDeletionPreview()") > **getWorkflowDeletionPreview**: (`wid`, `id`) => `Promise`<{ `hasAssignments`: `boolean`; `items`: `object`\[]; `total`: `number`; }> Defined in: [packages/sdk/src/client/client.ts:653](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L653) Preview the impact of deleting a workflow, including affected tasks and assignments. #### Parameters[​](#parameters-579 "Direct link to Parameters") ##### wid[​](#wid-484 "Direct link to wid") `string` ##### id[​](#id-70 "Direct link to id") `number` #### Returns[​](#returns-596 "Direct link to Returns") `Promise`<{ `hasAssignments`: `boolean`; `items`: `object`\[]; `total`: `number`; }> #### Implementation of[​](#implementation-of-595 "Direct link to Implementation of") `WorkflowsBindings.getWorkflowDeletionPreview` *** ### getWorkflowDiagram()[​](#getworkflowdiagram "Direct link to getWorkflowDiagram()") > **getWorkflowDiagram**: (`wid`, `id`, `options`) => `Promise`<{ `archivedTaskCount`: `number`; `includeArchived`: `boolean`; `mermaid`: `string`; `taskCount`: `number`; }> Defined in: [packages/sdk/src/client/client.ts:649](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L649) 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[​](#parameters-580 "Direct link to Parameters") ##### wid[​](#wid-485 "Direct link to wid") `string` ##### id[​](#id-71 "Direct link to id") `number` ##### options?[​](#options-45 "Direct link to options?") ###### includeArchived?[​](#includearchived-4 "Direct link to includeArchived?") `boolean` #### Returns[​](#returns-597 "Direct link to Returns") `Promise`<{ `archivedTaskCount`: `number`; `includeArchived`: `boolean`; `mermaid`: `string`; `taskCount`: `number`; }> #### Implementation of[​](#implementation-of-596 "Direct link to Implementation of") `WorkflowsBindings.getWorkflowDiagram` *** ### getWorkflowNotes()[​](#getworkflownotes "Direct link to getWorkflowNotes()") > **getWorkflowNotes**: (`wid`, `workflowId`) => `Promise`<[`WorkflowNoteResponse`](https://docs.gravityrail.com/sdk/interfaces/WorkflowNoteResponse.md)\[]> Defined in: [packages/sdk/src/client/client.ts:664](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L664) List all notes for a specific workflow. #### Parameters[​](#parameters-581 "Direct link to Parameters") ##### wid[​](#wid-486 "Direct link to wid") `string` ##### workflowId[​](#workflowid-12 "Direct link to workflowId") `number` #### Returns[​](#returns-598 "Direct link to Returns") `Promise`<[`WorkflowNoteResponse`](https://docs.gravityrail.com/sdk/interfaces/WorkflowNoteResponse.md)\[]> #### Implementation of[​](#implementation-of-597 "Direct link to Implementation of") `WorkflowsBindings.getWorkflowNotes` *** ### getWorkflows()[​](#getworkflows "Direct link to getWorkflows()") > **getWorkflows**: (`wid`, `archived`) => `Promise`<[`Workflow`](https://docs.gravityrail.com/sdk/type-aliases/Workflow.md)\[]> Defined in: [packages/sdk/src/client/client.ts:645](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L645) List all workflows in a workspace, optionally including archived ones. #### Parameters[​](#parameters-582 "Direct link to Parameters") ##### wid[​](#wid-487 "Direct link to wid") `string` ##### archived?[​](#archived-2 "Direct link to archived?") `boolean` = `false` #### Returns[​](#returns-599 "Direct link to Returns") `Promise`<[`Workflow`](https://docs.gravityrail.com/sdk/type-aliases/Workflow.md)\[]> #### Implementation of[​](#implementation-of-598 "Direct link to Implementation of") `WorkflowsBindings.getWorkflows` *** ### getWorkflowsActivityBatch()[​](#getworkflowsactivitybatch "Direct link to getWorkflowsActivityBatch()") > **getWorkflowsActivityBatch**: (`wid`, `workflowIds`, `options?`) => `Promise`<`Record`<`string`, [`WorkflowActivity`](https://docs.gravityrail.com/sdk/interfaces/WorkflowActivity.md)>> Defined in: [packages/sdk/src/client/client.ts:648](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L648) Get activity metrics for multiple workflows in a single request. #### Parameters[​](#parameters-583 "Direct link to Parameters") ##### wid[​](#wid-488 "Direct link to wid") `string` ##### workflowIds[​](#workflowids "Direct link to workflowIds") `number`\[] ##### options?[​](#options-46 "Direct link to options?") ###### days?[​](#days-2 "Direct link to days?") `number` #### Returns[​](#returns-600 "Direct link to Returns") `Promise`<`Record`<`string`, [`WorkflowActivity`](https://docs.gravityrail.com/sdk/interfaces/WorkflowActivity.md)>> #### Implementation of[​](#implementation-of-599 "Direct link to Implementation of") `WorkflowsBindings.getWorkflowsActivityBatch` *** ### getWorkflowTaskAssignmentStats()[​](#getworkflowtaskassignmentstats "Direct link to getWorkflowTaskAssignmentStats()") > **getWorkflowTaskAssignmentStats**: (`wid`, `id`, `fromDate?`, `toDate?`) => `Promise`<`Record`<`number`, [`TaskAssignmentStatsResponse`](https://docs.gravityrail.com/sdk/interfaces/TaskAssignmentStatsResponse.md)>> Defined in: [packages/sdk/src/client/client.ts:660](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L660) Get task assignment statistics for a workflow within an optional date range. #### Parameters[​](#parameters-584 "Direct link to Parameters") ##### wid[​](#wid-489 "Direct link to wid") `string` ##### id[​](#id-72 "Direct link to id") `number` ##### fromDate?[​](#fromdate-1 "Direct link to fromDate?") `string` ##### toDate?[​](#todate-1 "Direct link to toDate?") `string` #### Returns[​](#returns-601 "Direct link to Returns") `Promise`<`Record`<`number`, [`TaskAssignmentStatsResponse`](https://docs.gravityrail.com/sdk/interfaces/TaskAssignmentStatsResponse.md)>> #### Implementation of[​](#implementation-of-600 "Direct link to Implementation of") `WorkflowsBindings.getWorkflowTaskAssignmentStats` *** ### getWorkflowTemplates()[​](#getworkflowtemplates "Direct link to getWorkflowTemplates()") > **getWorkflowTemplates**: (`wid`) => `Promise`<[`WorkflowTemplateResponse`](https://docs.gravityrail.com/sdk/interfaces/WorkflowTemplateResponse.md)\[]> Defined in: [packages/sdk/src/client/client.ts:658](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L658) List available workflow templates. #### Parameters[​](#parameters-585 "Direct link to Parameters") ##### wid[​](#wid-490 "Direct link to wid") `string` #### Returns[​](#returns-602 "Direct link to Returns") `Promise`<[`WorkflowTemplateResponse`](https://docs.gravityrail.com/sdk/interfaces/WorkflowTemplateResponse.md)\[]> #### Implementation of[​](#implementation-of-601 "Direct link to Implementation of") `WorkflowsBindings.getWorkflowTemplates` *** ### getWorkflowThumbnailUrl()[​](#getworkflowthumbnailurl "Direct link to getWorkflowThumbnailUrl()") > **getWorkflowThumbnailUrl**: (`wid`, `id`) => `string` Defined in: [packages/sdk/src/client/client.ts:650](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L650) 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[​](#parameters-586 "Direct link to Parameters") ##### wid[​](#wid-491 "Direct link to wid") `string` ##### id[​](#id-73 "Direct link to id") `number` #### Returns[​](#returns-603 "Direct link to Returns") `string` #### Implementation of[​](#implementation-of-602 "Direct link to Implementation of") `WorkflowsBindings.getWorkflowThumbnailUrl` *** ### getWorkflowVersion()[​](#getworkflowversion "Direct link to getWorkflowVersion()") > **getWorkflowVersion**: (`wid`, `workflowUuid`, `versionNumber`) => `Promise`<`WorkflowVersionDetailResponse`> Defined in: [packages/sdk/src/client/client.ts:674](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L674) Get a specific version of a workflow by version number. #### Parameters[​](#parameters-587 "Direct link to Parameters") ##### wid[​](#wid-492 "Direct link to wid") `string` ##### workflowUuid[​](#workflowuuid-3 "Direct link to workflowUuid") `string` ##### versionNumber[​](#versionnumber-2 "Direct link to versionNumber") `number` #### Returns[​](#returns-604 "Direct link to Returns") `Promise`<`WorkflowVersionDetailResponse`> #### Implementation of[​](#implementation-of-603 "Direct link to Implementation of") `WorkflowsBindings.getWorkflowVersion` *** ### getWorkflowVersionActive()[​](#getworkflowversionactive "Direct link to getWorkflowVersionActive()") > **getWorkflowVersionActive**: (`wid`, `workflowUuid`) => `Promise`<`WorkflowVersionDetailResponse`> Defined in: [packages/sdk/src/client/client.ts:673](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L673) Get the active version of a workflow. #### Parameters[​](#parameters-588 "Direct link to Parameters") ##### wid[​](#wid-493 "Direct link to wid") `string` ##### workflowUuid[​](#workflowuuid-4 "Direct link to workflowUuid") `string` #### Returns[​](#returns-605 "Direct link to Returns") `Promise`<`WorkflowVersionDetailResponse`> #### Implementation of[​](#implementation-of-604 "Direct link to Implementation of") `WorkflowsBindings.getWorkflowVersionActive` *** ### getWorkflowVersions()[​](#getworkflowversions "Direct link to getWorkflowVersions()") > **getWorkflowVersions**: (`wid`, `workflowUuid`) => `Promise`<`WorkflowVersionListResponse`> Defined in: [packages/sdk/src/client/client.ts:672](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L672) List all versions of a workflow. #### Parameters[​](#parameters-589 "Direct link to Parameters") ##### wid[​](#wid-494 "Direct link to wid") `string` ##### workflowUuid[​](#workflowuuid-5 "Direct link to workflowUuid") `string` #### Returns[​](#returns-606 "Direct link to Returns") `Promise`<`WorkflowVersionListResponse`> #### Implementation of[​](#implementation-of-605 "Direct link to Implementation of") `WorkflowsBindings.getWorkflowVersions` *** ### getWorkspace()[​](#getworkspace "Direct link to getWorkspace()") > **getWorkspace**: (`wid`) => `Promise`<[`Workspace`](https://docs.gravityrail.com/sdk/interfaces/Workspace.md)> Defined in: [packages/sdk/src/client/client.ts:402](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L402) Get a single workspace by ID. #### Parameters[​](#parameters-590 "Direct link to Parameters") ##### wid[​](#wid-495 "Direct link to wid") `string` #### Returns[​](#returns-607 "Direct link to Returns") `Promise`<[`Workspace`](https://docs.gravityrail.com/sdk/interfaces/Workspace.md)> #### Implementation of[​](#implementation-of-606 "Direct link to Implementation of") `WorkspacesBindings.getWorkspace` *** ### getWorkspaceBuilder()[​](#getworkspacebuilder "Direct link to getWorkspaceBuilder()") > **getWorkspaceBuilder**: (`wid`, `builderId`) => `Promise`<[`WorkspaceBuilderInfo`](https://docs.gravityrail.com/sdk/interfaces/WorkspaceBuilderInfo.md)> Defined in: [packages/sdk/src/client/client.ts:681](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L681) Get information about a specific workspace builder. #### Parameters[​](#parameters-591 "Direct link to Parameters") ##### wid[​](#wid-496 "Direct link to wid") `string` ##### builderId[​](#builderid-4 "Direct link to builderId") `string` #### Returns[​](#returns-608 "Direct link to Returns") `Promise`<[`WorkspaceBuilderInfo`](https://docs.gravityrail.com/sdk/interfaces/WorkspaceBuilderInfo.md)> #### Implementation of[​](#implementation-of-607 "Direct link to Implementation of") `WorkflowsBindings.getWorkspaceBuilder` *** ### getWorkspaceBuilders()[​](#getworkspacebuilders "Direct link to getWorkspaceBuilders()") > **getWorkspaceBuilders**: (`wid`) => `Promise`<[`WorkspaceBuilderInfo`](https://docs.gravityrail.com/sdk/interfaces/WorkspaceBuilderInfo.md)\[]> Defined in: [packages/sdk/src/client/client.ts:680](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L680) Get list of available workspace builders. #### Parameters[​](#parameters-592 "Direct link to Parameters") ##### wid[​](#wid-497 "Direct link to wid") `string` #### Returns[​](#returns-609 "Direct link to Returns") `Promise`<[`WorkspaceBuilderInfo`](https://docs.gravityrail.com/sdk/interfaces/WorkspaceBuilderInfo.md)\[]> #### Implementation of[​](#implementation-of-608 "Direct link to Implementation of") `WorkflowsBindings.getWorkspaceBuilders` *** ### getWorkspaceBySlug()[​](#getworkspacebyslug "Direct link to getWorkspaceBySlug()") > **getWorkspaceBySlug**: (`wid`) => `Promise`<[`Workspace`](https://docs.gravityrail.com/sdk/interfaces/Workspace.md)> Defined in: [packages/sdk/src/client/client.ts:441](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L441) Get a single workspace by ID. #### Parameters[​](#parameters-593 "Direct link to Parameters") ##### wid[​](#wid-498 "Direct link to wid") `string` #### Returns[​](#returns-610 "Direct link to Returns") `Promise`<[`Workspace`](https://docs.gravityrail.com/sdk/interfaces/Workspace.md)> #### Implementation of[​](#implementation-of-609 "Direct link to Implementation of") `WorkspacesBindings.getWorkspaceBySlug` *** ### getWorkspaceCounts()[​](#getworkspacecounts "Direct link to getWorkspaceCounts()") > **getWorkspaceCounts**: (`wid`) => `Promise`<[`WorkspaceCounts`](https://docs.gravityrail.com/sdk/interfaces/WorkspaceCounts.md)> Defined in: [packages/sdk/src/client/client.ts:411](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L411) Get entity counts (members, tasks, workflows, etc.) for a workspace. #### Parameters[​](#parameters-594 "Direct link to Parameters") ##### wid[​](#wid-499 "Direct link to wid") `string` #### Returns[​](#returns-611 "Direct link to Returns") `Promise`<[`WorkspaceCounts`](https://docs.gravityrail.com/sdk/interfaces/WorkspaceCounts.md)> #### Implementation of[​](#implementation-of-610 "Direct link to Implementation of") `WorkspacesBindings.getWorkspaceCounts` *** ### getWorkspaceDefaults()[​](#getworkspacedefaults "Direct link to getWorkspaceDefaults()") > **getWorkspaceDefaults**: (`wid`) => `Promise`<[`WorkspaceDefaults`](https://docs.gravityrail.com/sdk/interfaces/WorkspaceDefaults.md)> Defined in: [packages/sdk/src/client/client.ts:407](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L407) Get the default settings for a workspace. #### Parameters[​](#parameters-595 "Direct link to Parameters") ##### wid[​](#wid-500 "Direct link to wid") `string` #### Returns[​](#returns-612 "Direct link to Returns") `Promise`<[`WorkspaceDefaults`](https://docs.gravityrail.com/sdk/interfaces/WorkspaceDefaults.md)> #### Implementation of[​](#implementation-of-611 "Direct link to Implementation of") `WorkspacesBindings.getWorkspaceDefaults` *** ### getWorkspaceEmailDomains()[​](#getworkspaceemaildomains "Direct link to getWorkspaceEmailDomains()") > **getWorkspaceEmailDomains**: (`wid`) => `Promise`<[`WorkspaceAvailableDomainsResponse`](https://docs.gravityrail.com/sdk/interfaces/WorkspaceAvailableDomainsResponse.md)> Defined in: [packages/sdk/src/client/client.ts:444](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L444) List org domains available for workspace email inbox routing. #### Parameters[​](#parameters-596 "Direct link to Parameters") ##### wid[​](#wid-501 "Direct link to wid") `string` #### Returns[​](#returns-613 "Direct link to Returns") `Promise`<[`WorkspaceAvailableDomainsResponse`](https://docs.gravityrail.com/sdk/interfaces/WorkspaceAvailableDomainsResponse.md)> #### Implementation of[​](#implementation-of-612 "Direct link to Implementation of") `WorkspacesBindings.getWorkspaceEmailDomains` *** ### getWorkspaceInvitation()[​](#getworkspaceinvitation "Direct link to getWorkspaceInvitation()") > **getWorkspaceInvitation**: (`requestId`) => `Promise`<[`InvitationResponse`](https://docs.gravityrail.com/sdk/type-aliases/InvitationResponse.md)> Defined in: [packages/sdk/src/client/client.ts:473](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L473) #### Parameters[​](#parameters-597 "Direct link to Parameters") ##### requestId[​](#requestid-4 "Direct link to requestId") `number` #### Returns[​](#returns-614 "Direct link to Returns") `Promise`<[`InvitationResponse`](https://docs.gravityrail.com/sdk/type-aliases/InvitationResponse.md)> #### Implementation of[​](#implementation-of-613 "Direct link to Implementation of") `WorkspacesBindings.getWorkspaceInvitation` *** ### getWorkspaceMember()[​](#getworkspacemember "Direct link to getWorkspaceMember()") > **getWorkspaceMember**: (`wid`, `memberId`) => `Promise`<[`WorkspaceMemberResponse`](https://docs.gravityrail.com/sdk/interfaces/WorkspaceMemberResponse.md)> Defined in: [packages/sdk/src/client/client.ts:225](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L225) Get a single workspace member by ID. #### Parameters[​](#parameters-598 "Direct link to Parameters") ##### wid[​](#wid-502 "Direct link to wid") `string` ##### memberId[​](#memberid-26 "Direct link to memberId") `number` #### Returns[​](#returns-615 "Direct link to Returns") `Promise`<[`WorkspaceMemberResponse`](https://docs.gravityrail.com/sdk/interfaces/WorkspaceMemberResponse.md)> #### Implementation of[​](#implementation-of-614 "Direct link to Implementation of") `MembersBindings.getWorkspaceMember` *** ### getWorkspaceMembers()[​](#getworkspacemembers "Direct link to getWorkspaceMembers()") > **getWorkspaceMembers**: (`wid`, `page`, `pageSize`, `filters?`, `search?`, `role?`, `sortBy?`, `sortOrder?`, `memberType?`, `isArchived`, `isManager?`, `memberTypes?`, `hasAccount?`, `excludeIds?`, `memberFilterId?`, `query?`) => `Promise`<[`PaginatedResponse`](https://docs.gravityrail.com/sdk/interfaces/PaginatedResponse.md)<[`WorkspaceMemberResponse`](https://docs.gravityrail.com/sdk/interfaces/WorkspaceMemberResponse.md)>> Defined in: [packages/sdk/src/client/client.ts:224](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L224) List workspace members with pagination, filtering, and sorting. #### Parameters[​](#parameters-599 "Direct link to Parameters") ##### wid[​](#wid-503 "Direct link to wid") `string` ##### page?[​](#page-52 "Direct link to page?") `number` = `1` ##### pageSize?[​](#pagesize-52 "Direct link to pageSize?") `number` = `10` ##### filters?[​](#filters-2 "Direct link to filters?") `any`\[] | { `query?`: `string`; `role?`: `string`; } ##### search?[​](#search-14 "Direct link to search?") `string` ##### role?[​](#role "Direct link to role?") `string` ##### sortBy?[​](#sortby-9 "Direct link to sortBy?") [`MemberSortField`](https://docs.gravityrail.com/sdk/type-aliases/MemberSortField.md) ##### sortOrder?[​](#sortorder-9 "Direct link to sortOrder?") [`SortOrder`](https://docs.gravityrail.com/sdk/type-aliases/SortOrder.md) ##### memberType?[​](#membertype-1 "Direct link to memberType?") `"member"` | `"anonymous"` | `"test"` | `"agent"` ##### isArchived?[​](#isarchived-1 "Direct link to isArchived?") `boolean` = `false` ##### isManager?[​](#ismanager "Direct link to isManager?") `boolean` ##### memberTypes?[​](#membertypes "Direct link to memberTypes?") (`"member"` | `"anonymous"` | `"test"` | `"agent"`)\[] ##### hasAccount?[​](#hasaccount "Direct link to hasAccount?") `boolean` ##### excludeIds?[​](#excludeids "Direct link to excludeIds?") `number`\[] ##### memberFilterId?[​](#memberfilterid "Direct link to memberFilterId?") `number` Apply a saved member filter by id (rules AND query predicate). ##### query?[​](#query-1 "Direct link to query?") [`QueryPredicate`](https://docs.gravityrail.com/sdk/type-aliases/QueryPredicate.md) Transient query-engine IR predicate (the unsaved counterpart of a saved filter's query). #### Returns[​](#returns-616 "Direct link to Returns") `Promise`<[`PaginatedResponse`](https://docs.gravityrail.com/sdk/interfaces/PaginatedResponse.md)<[`WorkspaceMemberResponse`](https://docs.gravityrail.com/sdk/interfaces/WorkspaceMemberResponse.md)>> #### Implementation of[​](#implementation-of-615 "Direct link to Implementation of") `MembersBindings.getWorkspaceMembers` *** ### getWorkspaceNotices()[​](#getworkspacenotices "Direct link to getWorkspaceNotices()") > **getWorkspaceNotices**: (`wid`) => `Promise`<[`NoticesResponse`](https://docs.gravityrail.com/sdk/interfaces/NoticesResponse.md)> Defined in: [packages/sdk/src/client/client.ts:414](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L414) Get active notices for a workspace. #### Parameters[​](#parameters-600 "Direct link to Parameters") ##### wid[​](#wid-504 "Direct link to wid") `string` #### Returns[​](#returns-617 "Direct link to Returns") `Promise`<[`NoticesResponse`](https://docs.gravityrail.com/sdk/interfaces/NoticesResponse.md)> #### Implementation of[​](#implementation-of-616 "Direct link to Implementation of") `WorkspacesBindings.getWorkspaceNotices` *** ### getWorkspaceProduct()[​](#getworkspaceproduct "Direct link to getWorkspaceProduct()") > **getWorkspaceProduct**: (`wid`, `id`) => `Promise`<[`Product`](https://docs.gravityrail.com/sdk/type-aliases/Product.md)> Defined in: [packages/sdk/src/client/client.ts:429](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L429) Get a product from a reseller workspace. Requires workspace admin scope. #### Parameters[​](#parameters-601 "Direct link to Parameters") ##### wid[​](#wid-505 "Direct link to wid") `string` ##### id[​](#id-74 "Direct link to id") `number` #### Returns[​](#returns-618 "Direct link to Returns") `Promise`<[`Product`](https://docs.gravityrail.com/sdk/type-aliases/Product.md)> #### Implementation of[​](#implementation-of-617 "Direct link to Implementation of") `WorkspacesBindings.getWorkspaceProduct` *** ### getWorkspaces()[​](#getworkspaces "Direct link to getWorkspaces()") > **getWorkspaces**: () => `Promise`<[`Workspace`](https://docs.gravityrail.com/sdk/interfaces/Workspace.md)\[]> Defined in: [packages/sdk/src/client/client.ts:400](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L400) List all workspaces accessible to the current user. #### Returns[​](#returns-619 "Direct link to Returns") `Promise`<[`Workspace`](https://docs.gravityrail.com/sdk/interfaces/Workspace.md)\[]> #### Implementation of[​](#implementation-of-618 "Direct link to Implementation of") `WorkspacesBindings.getWorkspaces` *** ### getWorkspaceScopes()[​](#getworkspacescopes "Direct link to getWorkspaceScopes()") > **getWorkspaceScopes**: () => `Promise`<[`WorkspaceScopesResponse`](https://docs.gravityrail.com/sdk/interfaces/WorkspaceScopesResponse.md)> Defined in: [packages/sdk/src/client/client.ts:442](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L442) 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[​](#returns-620 "Direct link to Returns") `Promise`<[`WorkspaceScopesResponse`](https://docs.gravityrail.com/sdk/interfaces/WorkspaceScopesResponse.md)> #### Implementation of[​](#implementation-of-619 "Direct link to Implementation of") `WorkspacesBindings.getWorkspaceScopes` *** ### getWorkspaceSiteDomains()[​](#getworkspacesitedomains "Direct link to getWorkspaceSiteDomains()") > **getWorkspaceSiteDomains**: (`wid`) => `Promise`<[`WorkspaceAvailableDomainsResponse`](https://docs.gravityrail.com/sdk/interfaces/WorkspaceAvailableDomainsResponse.md)> Defined in: [packages/sdk/src/client/client.ts:445](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L445) List org domains available for workspace custom site routing. #### Parameters[​](#parameters-602 "Direct link to Parameters") ##### wid[​](#wid-506 "Direct link to wid") `string` #### Returns[​](#returns-621 "Direct link to Returns") `Promise`<[`WorkspaceAvailableDomainsResponse`](https://docs.gravityrail.com/sdk/interfaces/WorkspaceAvailableDomainsResponse.md)> #### Implementation of[​](#implementation-of-620 "Direct link to Implementation of") `WorkspacesBindings.getWorkspaceSiteDomains` *** ### getWorkspaceSubscriptions()[​](#getworkspacesubscriptions "Direct link to getWorkspaceSubscriptions()") > **getWorkspaceSubscriptions**: (`wid`) => `Promise`<`SubscriptionResponse`\[]> Defined in: [packages/sdk/src/client/client.ts:813](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L813) List all subscriptions associated with a workspace. #### Parameters[​](#parameters-603 "Direct link to Parameters") ##### wid[​](#wid-507 "Direct link to wid") `string` #### Returns[​](#returns-622 "Direct link to Returns") `Promise`<`SubscriptionResponse`\[]> #### Implementation of[​](#implementation-of-621 "Direct link to Implementation of") `BillingBindings.getWorkspaceSubscriptions` *** ### getWorkspaceSupportRequest()[​](#getworkspacesupportrequest "Direct link to getWorkspaceSupportRequest()") > **getWorkspaceSupportRequest**: (`workspaceUuid`, `uuid`) => `Promise`<`SupportRequest`> Defined in: [packages/sdk/src/client/client.ts:1089](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L1089) #### Parameters[​](#parameters-604 "Direct link to Parameters") ##### workspaceUuid[​](#workspaceuuid-9 "Direct link to workspaceUuid") `string` ##### uuid[​](#uuid-30 "Direct link to uuid") `string` #### Returns[​](#returns-623 "Direct link to Returns") `Promise`<`SupportRequest`> #### Implementation of[​](#implementation-of-622 "Direct link to Implementation of") `SupportRequestsBindings.getWorkspaceSupportRequest` *** ### getWorkspaceThemes()[​](#getworkspacethemes "Direct link to getWorkspaceThemes()") > **getWorkspaceThemes**: (`wid`) => `Promise`<[`ThemesListResponse`](https://docs.gravityrail.com/sdk/interfaces/ThemesListResponse.md)> Defined in: [packages/sdk/src/client/client.ts:439](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L439) List available themes for a workspace. #### Parameters[​](#parameters-605 "Direct link to Parameters") ##### wid[​](#wid-508 "Direct link to wid") `string` #### Returns[​](#returns-624 "Direct link to Returns") `Promise`<[`ThemesListResponse`](https://docs.gravityrail.com/sdk/interfaces/ThemesListResponse.md)> #### Implementation of[​](#implementation-of-623 "Direct link to Implementation of") `WorkspacesBindings.getWorkspaceThemes` *** ### importFromBoard()[​](#importfromboard "Direct link to importFromBoard()") > **importFromBoard**: (`wid`, `data`) => `Promise`<`MondayImportResponse`> Defined in: [packages/sdk/src/client/client.ts:882](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L882) #### Parameters[​](#parameters-606 "Direct link to Parameters") ##### wid[​](#wid-509 "Direct link to wid") `string` ##### data[​](#data-73 "Direct link to data") `MondayImportRequest` #### Returns[​](#returns-625 "Direct link to Returns") `Promise`<`MondayImportResponse`> #### Implementation of[​](#implementation-of-624 "Direct link to Implementation of") `IntegrationsBindings.importFromBoard` *** ### importHubspotMembers()[​](#importhubspotmembers "Direct link to importHubspotMembers()") > **importHubspotMembers**: (`wid`, `data`) => `Promise`<[`ImportHubSpotMembersResponse`](https://docs.gravityrail.com/sdk/interfaces/ImportHubSpotMembersResponse.md)> Defined in: [packages/sdk/src/client/client.ts:1015](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L1015) #### Parameters[​](#parameters-607 "Direct link to Parameters") ##### wid[​](#wid-510 "Direct link to wid") `string` ##### data[​](#data-74 "Direct link to data") [`ImportHubSpotMembersRequest`](https://docs.gravityrail.com/sdk/interfaces/ImportHubSpotMembersRequest.md) #### Returns[​](#returns-626 "Direct link to Returns") `Promise`<[`ImportHubSpotMembersResponse`](https://docs.gravityrail.com/sdk/interfaces/ImportHubSpotMembersResponse.md)> #### Implementation of[​](#implementation-of-625 "Direct link to Implementation of") `IntegrationsBindings.importHubspotMembers` *** ### importMembers()[​](#importmembers "Direct link to importMembers()") > **importMembers**: (`wid`, `file`, `newMemberRoleId`, `onProgress?`, `options?`) => `Promise`<{ `success`: `boolean`; }> Defined in: [packages/sdk/src/client/client.ts:234](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L234) Import members from a CSV file, streaming progress updates via callback. `identityConflictPolicy` (default 'skip') controls how a row matching an existing member ONLY by phone with different identity fields is handled. Send 'overwrite\_identity\_fields' only after the operator confirms a preview. #### Parameters[​](#parameters-608 "Direct link to Parameters") ##### wid[​](#wid-511 "Direct link to wid") `string` ##### file[​](#file-3 "Direct link to file") `File` ##### newMemberRoleId[​](#newmemberroleid "Direct link to newMemberRoleId") `number` ##### onProgress?[​](#onprogress "Direct link to onProgress?") (`progress`) => `void` ##### options?[​](#options-47 "Direct link to options?") ###### identityConflictPolicy?[​](#identityconflictpolicy "Direct link to identityConflictPolicy?") [`IdentityConflictPolicy`](https://docs.gravityrail.com/sdk/type-aliases/IdentityConflictPolicy.md) ###### trustEmailAddresses?[​](#trustemailaddresses "Direct link to trustEmailAddresses?") `boolean` ###### trustPhoneNumbers?[​](#trustphonenumbers "Direct link to trustPhoneNumbers?") `boolean` #### Returns[​](#returns-627 "Direct link to Returns") `Promise`<{ `success`: `boolean`; }> #### Implementation of[​](#implementation-of-626 "Direct link to Implementation of") `MembersBindings.importMembers` *** ### importPronunciationEntries()[​](#importpronunciationentries "Direct link to importPronunciationEntries()") > **importPronunciationEntries**: (`orgUuid`, `entries`) => `Promise`<[`PronunciationImportResult`](https://docs.gravityrail.com/sdk/interfaces/PronunciationImportResult.md)> Defined in: [packages/sdk/src/client/client.ts:1048](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L1048) Bulk import pronunciation entries into an organization. #### Parameters[​](#parameters-609 "Direct link to Parameters") ##### orgUuid[​](#orguuid-9 "Direct link to orgUuid") `string` ##### entries[​](#entries "Direct link to entries") [`PronunciationImportEntry`](https://docs.gravityrail.com/sdk/interfaces/PronunciationImportEntry.md)\[] #### Returns[​](#returns-628 "Direct link to Returns") `Promise`<[`PronunciationImportResult`](https://docs.gravityrail.com/sdk/interfaces/PronunciationImportResult.md)> #### Implementation of[​](#implementation-of-627 "Direct link to Implementation of") `PronunciationsBindings.importPronunciationEntries` *** ### importSalesforceMembers()[​](#importsalesforcemembers "Direct link to importSalesforceMembers()") > **importSalesforceMembers**: (`wid`, `data`) => `Promise`<[`ImportSalesforceMembersResponse`](https://docs.gravityrail.com/sdk/interfaces/ImportSalesforceMembersResponse.md)> Defined in: [packages/sdk/src/client/client.ts:999](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L999) #### Parameters[​](#parameters-610 "Direct link to Parameters") ##### wid[​](#wid-512 "Direct link to wid") `string` ##### data[​](#data-75 "Direct link to data") [`ImportSalesforceMembersRequest`](https://docs.gravityrail.com/sdk/interfaces/ImportSalesforceMembersRequest.md) #### Returns[​](#returns-629 "Direct link to Returns") `Promise`<[`ImportSalesforceMembersResponse`](https://docs.gravityrail.com/sdk/interfaces/ImportSalesforceMembersResponse.md)> #### Implementation of[​](#implementation-of-628 "Direct link to Implementation of") `IntegrationsBindings.importSalesforceMembers` *** ### importSiteSourceZip()[​](#importsitesourcezip "Direct link to importSiteSourceZip()") > **importSiteSourceZip**: (`wid`, `siteId`, `file`) => `Promise`<[`SiteSource`](https://docs.gravityrail.com/sdk/interfaces/SiteSource.md)> Defined in: [packages/sdk/src/client/client.ts:556](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L556) 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[​](#parameters-611 "Direct link to Parameters") ##### wid[​](#wid-513 "Direct link to wid") `string` ##### siteId[​](#siteid-19 "Direct link to siteId") `number` ##### file[​](#file-4 "Direct link to file") `Blob` #### Returns[​](#returns-630 "Direct link to Returns") `Promise`<[`SiteSource`](https://docs.gravityrail.com/sdk/interfaces/SiteSource.md)> #### Implementation of[​](#implementation-of-629 "Direct link to Implementation of") `SitesBindings.importSiteSourceZip` *** ### importWorkspace()[​](#importworkspace "Direct link to importWorkspace()") > **importWorkspace**: (`wid`, `exportData`, `importMappings`, `createNew`) => `Promise`<[`WorkspaceImportPreviewResponse`](https://docs.gravityrail.com/sdk/interfaces/WorkspaceImportPreviewResponse.md)> Defined in: [packages/sdk/src/client/client.ts:437](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L437) Import workspace configuration from exported data. #### Parameters[​](#parameters-612 "Direct link to Parameters") ##### wid[​](#wid-514 "Direct link to wid") `string` ##### exportData[​](#exportdata "Direct link to exportData") [`WorkspaceExportData`](https://docs.gravityrail.com/sdk/interfaces/WorkspaceExportData.md) ##### importMappings[​](#importmappings "Direct link to importMappings") [`WorkspaceImportMapping`](https://docs.gravityrail.com/sdk/interfaces/WorkspaceImportMapping.md) ##### createNew[​](#createnew "Direct link to createNew") [`WorkspaceCreateNewEntities`](https://docs.gravityrail.com/sdk/interfaces/WorkspaceCreateNewEntities.md) #### Returns[​](#returns-631 "Direct link to Returns") `Promise`<[`WorkspaceImportPreviewResponse`](https://docs.gravityrail.com/sdk/interfaces/WorkspaceImportPreviewResponse.md)> #### Implementation of[​](#implementation-of-630 "Direct link to Implementation of") `WorkspacesBindings.importWorkspace` *** ### initiateCall()[​](#initiatecall "Direct link to initiateCall()") > **initiateCall**: (`wid`, `request`) => `Promise`<[`InitiateCallResponse`](https://docs.gravityrail.com/sdk/interfaces/InitiateCallResponse.md)> Defined in: [packages/sdk/src/client/client.ts:188](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L188) Initiate a new outbound call. #### Parameters[​](#parameters-613 "Direct link to Parameters") ##### wid[​](#wid-515 "Direct link to wid") `string` ##### request[​](#request-14 "Direct link to request") [`InitiateCallRequest`](https://docs.gravityrail.com/sdk/interfaces/InitiateCallRequest.md) #### Returns[​](#returns-632 "Direct link to Returns") `Promise`<[`InitiateCallResponse`](https://docs.gravityrail.com/sdk/interfaces/InitiateCallResponse.md)> #### Implementation of[​](#implementation-of-631 "Direct link to Implementation of") `CallsBindings.initiateCall` *** ### initiateOutboundCall()[​](#initiateoutboundcall "Direct link to initiateOutboundCall()") > **initiateOutboundCall**: (`wid`, `chatId`, `phoneNumberId`) => `Promise`<[`OutboundCallResponse`](https://docs.gravityrail.com/sdk/interfaces/OutboundCallResponse.md)> Defined in: [packages/sdk/src/client/client.ts:162](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L162) Initiate an outbound phone call from a chat. #### Parameters[​](#parameters-614 "Direct link to Parameters") ##### wid[​](#wid-516 "Direct link to wid") `string` ##### chatId[​](#chatid-17 "Direct link to chatId") `number` ##### phoneNumberId[​](#phonenumberid-2 "Direct link to phoneNumberId") `number` #### Returns[​](#returns-633 "Direct link to Returns") `Promise`<[`OutboundCallResponse`](https://docs.gravityrail.com/sdk/interfaces/OutboundCallResponse.md)> #### Implementation of[​](#implementation-of-632 "Direct link to Implementation of") `ChatsBindings.initiateOutboundCall` *** ### inspectPrompt()[​](#inspectprompt "Direct link to inspectPrompt()") > **inspectPrompt**: (`wid`, `options`) => `Promise`<`PromptInspectionResult`> Defined in: [packages/sdk/src/client/client.ts:397](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L397) Inspect the full composed prompt for a task (static) or chat (live). #### Parameters[​](#parameters-615 "Direct link to Parameters") ##### wid[​](#wid-517 "Direct link to wid") `string` ##### options[​](#options-48 "Direct link to options") `InspectPromptOptions` #### Returns[​](#returns-634 "Direct link to Returns") `Promise`<`PromptInspectionResult`> #### Implementation of[​](#implementation-of-633 "Direct link to Implementation of") `PromptsBindings.inspectPrompt` *** ### inviteMemberCredentialUpdate()[​](#invitemembercredentialupdate "Direct link to inviteMemberCredentialUpdate()") > **inviteMemberCredentialUpdate**: (`wid`, `memberId`, `credentialType`, `newValue`) => `Promise`<[`CredentialChangeInviteResponse`](https://docs.gravityrail.com/sdk/interfaces/CredentialChangeInviteResponse.md)> Defined in: [packages/sdk/src/client/client.ts:263](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L263) Invite a member to update their credential (email or phone). Admin-only. Sends invitation to member's current contact method. #### Parameters[​](#parameters-616 "Direct link to Parameters") ##### wid[​](#wid-518 "Direct link to wid") `string` ##### memberId[​](#memberid-27 "Direct link to memberId") `number` ##### credentialType[​](#credentialtype "Direct link to credentialType") [`CredentialType`](https://docs.gravityrail.com/sdk/type-aliases/CredentialType.md) ##### newValue[​](#newvalue "Direct link to newValue") `string` #### Returns[​](#returns-635 "Direct link to Returns") `Promise`<[`CredentialChangeInviteResponse`](https://docs.gravityrail.com/sdk/interfaces/CredentialChangeInviteResponse.md)> #### Implementation of[​](#implementation-of-634 "Direct link to Implementation of") `MembersBindings.inviteMemberCredentialUpdate` *** ### inviteToWorkspace()[​](#invitetoworkspace "Direct link to inviteToWorkspace()") > **inviteToWorkspace**: (`workspaceUuid`, `emailOrAccountId`, `message?`, `memberRoleId?`, `name?`) => `Promise`<[`InvitationResponse`](https://docs.gravityrail.com/sdk/type-aliases/InvitationResponse.md)> Defined in: [packages/sdk/src/client/client.ts:481](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L481) Invite someone to a workspace (requires workspace admin permission). Uses the workspace-scoped route: POST /api/v2/w/{workspaceUuid}/invitations #### Parameters[​](#parameters-617 "Direct link to Parameters") ##### workspaceUuid[​](#workspaceuuid-10 "Direct link to workspaceUuid") `string` ##### emailOrAccountId[​](#emailoraccountid "Direct link to emailOrAccountId") `string` | `number` ##### message?[​](#message-1 "Direct link to message?") `string` ##### memberRoleId?[​](#memberroleid-1 "Direct link to memberRoleId?") `number` ##### name?[​](#name-9 "Direct link to name?") `string` #### Returns[​](#returns-636 "Direct link to Returns") `Promise`<[`InvitationResponse`](https://docs.gravityrail.com/sdk/type-aliases/InvitationResponse.md)> #### Implementation of[​](#implementation-of-635 "Direct link to Implementation of") `WorkspacesBindings.inviteToWorkspace` *** ### leaveWorkspace()[​](#leaveworkspace "Direct link to leaveWorkspace()") > **leaveWorkspace**: (`wid`) => `Promise`<{ `message`: `string`; }> Defined in: [packages/sdk/src/client/client.ts:406](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L406) Leave a workspace as the current user. #### Parameters[​](#parameters-618 "Direct link to Parameters") ##### wid[​](#wid-519 "Direct link to wid") `string` #### Returns[​](#returns-637 "Direct link to Returns") `Promise`<{ `message`: `string`; }> #### Implementation of[​](#implementation-of-636 "Direct link to Implementation of") `WorkspacesBindings.leaveWorkspace` *** ### linkCalendarToGoogle()[​](#linkcalendartogoogle "Direct link to linkCalendarToGoogle()") > **linkCalendarToGoogle**: (`wid`, `calendarId`, `request`) => `Promise`<[`LinkCalendarResponse`](https://docs.gravityrail.com/sdk/interfaces/LinkCalendarResponse.md)> Defined in: [packages/sdk/src/client/client.ts:721](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L721) Link a calendar to a Google Calendar for two-way sync. #### Parameters[​](#parameters-619 "Direct link to Parameters") ##### wid[​](#wid-520 "Direct link to wid") `string` ##### calendarId[​](#calendarid-7 "Direct link to calendarId") `number` ##### request[​](#request-15 "Direct link to request") [`LinkCalendarRequest`](https://docs.gravityrail.com/sdk/interfaces/LinkCalendarRequest.md) #### Returns[​](#returns-638 "Direct link to Returns") `Promise`<[`LinkCalendarResponse`](https://docs.gravityrail.com/sdk/interfaces/LinkCalendarResponse.md)> #### Implementation of[​](#implementation-of-637 "Direct link to Implementation of") `CalendarsBindings.linkCalendarToGoogle` *** ### linkCalendarToHealthie()[​](#linkcalendartohealthie "Direct link to linkCalendarToHealthie()") > **linkCalendarToHealthie**: (`wid`, `data`) => `Promise`<`LinkCalendarToHealthieResponse`> Defined in: [packages/sdk/src/client/client.ts:959](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L959) #### Parameters[​](#parameters-620 "Direct link to Parameters") ##### wid[​](#wid-521 "Direct link to wid") `string` ##### data[​](#data-76 "Direct link to data") `LinkCalendarToHealthieRequest` #### Returns[​](#returns-639 "Direct link to Returns") `Promise`<`LinkCalendarToHealthieResponse`> #### Implementation of[​](#implementation-of-638 "Direct link to Implementation of") `IntegrationsBindings.linkCalendarToHealthie` *** ### linkMemberToHealthie()[​](#linkmembertohealthie "Direct link to linkMemberToHealthie()") > **linkMemberToHealthie**: (`wid`, `data`) => `Promise`<{ `healthie_patient_id`: `string`; `member_id`: `number`; `status`: `string`; }> Defined in: [packages/sdk/src/client/client.ts:964](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L964) #### Parameters[​](#parameters-621 "Direct link to Parameters") ##### wid[​](#wid-522 "Direct link to wid") `string` ##### data[​](#data-77 "Direct link to data") `LinkMemberToHealthieRequest` #### Returns[​](#returns-640 "Direct link to Returns") `Promise`<{ `healthie_patient_id`: `string`; `member_id`: `number`; `status`: `string`; }> #### Implementation of[​](#implementation-of-639 "Direct link to Implementation of") `IntegrationsBindings.linkMemberToHealthie` *** ### linkMemberToHubspot()[​](#linkmembertohubspot "Direct link to linkMemberToHubspot()") > **linkMemberToHubspot**: (`wid`, `data`) => `Promise`<{ `hubspotRecordId`: `string`; `memberId`: `number`; `status`: `string`; }> Defined in: [packages/sdk/src/client/client.ts:1010](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L1010) #### Parameters[​](#parameters-622 "Direct link to Parameters") ##### wid[​](#wid-523 "Direct link to wid") `string` ##### data[​](#data-78 "Direct link to data") `LinkMemberToHubspotRequest` #### Returns[​](#returns-641 "Direct link to Returns") `Promise`<{ `hubspotRecordId`: `string`; `memberId`: `number`; `status`: `string`; }> #### Implementation of[​](#implementation-of-640 "Direct link to Implementation of") `IntegrationsBindings.linkMemberToHubspot` *** ### linkMemberToMonday()[​](#linkmembertomonday "Direct link to linkMemberToMonday()") > **linkMemberToMonday**: (`wid`, `data`) => `Promise`<{ `memberId`: `number`; `mondayItemId`: `string`; `status`: `string`; }> Defined in: [packages/sdk/src/client/client.ts:878](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L878) #### Parameters[​](#parameters-623 "Direct link to Parameters") ##### wid[​](#wid-524 "Direct link to wid") `string` ##### data[​](#data-79 "Direct link to data") `LinkMemberToMondayRequest` #### Returns[​](#returns-642 "Direct link to Returns") `Promise`<{ `memberId`: `number`; `mondayItemId`: `string`; `status`: `string`; }> #### Implementation of[​](#implementation-of-641 "Direct link to Implementation of") `IntegrationsBindings.linkMemberToMonday` *** ### linkMemberToSalesforce()[​](#linkmembertosalesforce "Direct link to linkMemberToSalesforce()") > **linkMemberToSalesforce**: (`wid`, `data`) => `Promise`<{ `memberId`: `number`; `salesforceRecordId`: `string`; `status`: `string`; }> Defined in: [packages/sdk/src/client/client.ts:991](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L991) #### Parameters[​](#parameters-624 "Direct link to Parameters") ##### wid[​](#wid-525 "Direct link to wid") `string` ##### data[​](#data-80 "Direct link to data") `LinkMemberToSalesforceRequest` #### Returns[​](#returns-643 "Direct link to Returns") `Promise`<{ `memberId`: `number`; `salesforceRecordId`: `string`; `status`: `string`; }> #### Implementation of[​](#implementation-of-642 "Direct link to Implementation of") `IntegrationsBindings.linkMemberToSalesforce` *** ### linkPhoneNumber()[​](#linkphonenumber "Direct link to linkPhoneNumber()") > **linkPhoneNumber**: (`wid`, `id`, `providerPhoneUuid`) => `Promise`<[`PhoneNumber`](https://docs.gravityrail.com/sdk/interfaces/PhoneNumber.md)> Defined in: [packages/sdk/src/client/client.ts:746](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L746) Link or unlink a workspace phone number to/from a provider phone. #### Parameters[​](#parameters-625 "Direct link to Parameters") ##### wid[​](#wid-526 "Direct link to wid") `string` ##### id[​](#id-75 "Direct link to id") `number` ##### providerPhoneUuid[​](#providerphoneuuid "Direct link to providerPhoneUuid") `string` | `null` #### Returns[​](#returns-644 "Direct link to Returns") `Promise`<[`PhoneNumber`](https://docs.gravityrail.com/sdk/interfaces/PhoneNumber.md)> #### Implementation of[​](#implementation-of-643 "Direct link to Implementation of") `CommunicationsBindings.linkPhoneNumber` *** ### listAbilities()[​](#listabilities "Direct link to listAbilities()") > **listAbilities**: (`wid`, `options`) => `Promise`<[`AbilityResponse`](https://docs.gravityrail.com/sdk/type-aliases/AbilityResponse.md)\[]> Defined in: [packages/sdk/src/client/client.ts:134](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L134) List configured ability instances for a workflow or task scope. Exactly one of workflowId / taskId must be provided. #### Parameters[​](#parameters-626 "Direct link to Parameters") ##### wid[​](#wid-527 "Direct link to wid") `string` ##### options[​](#options-49 "Direct link to options") ###### taskId?[​](#taskid-2 "Direct link to taskId?") `number` ###### workflowId?[​](#workflowid-13 "Direct link to workflowId?") `number` #### Returns[​](#returns-645 "Direct link to Returns") `Promise`<[`AbilityResponse`](https://docs.gravityrail.com/sdk/type-aliases/AbilityResponse.md)\[]> #### Implementation of[​](#implementation-of-644 "Direct link to Implementation of") `TasksBindings.listAbilities` *** ### listAgentAbilities()[​](#listagentabilities "Direct link to listAgentAbilities()") > **listAgentAbilities**: (`wid`, `id`, `options`) => `Promise`<[`AbilityResponse`](https://docs.gravityrail.com/sdk/type-aliases/AbilityResponse.md)\[]> Defined in: [packages/sdk/src/client/client.ts:294](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L294) 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[​](#parameters-627 "Direct link to Parameters") ##### wid[​](#wid-528 "Direct link to wid") `string` ##### id[​](#id-76 "Direct link to id") `number` ##### options[​](#options-50 "Direct link to options") ###### taskId[​](#taskid-3 "Direct link to taskId") `number` #### Returns[​](#returns-646 "Direct link to Returns") `Promise`<[`AbilityResponse`](https://docs.gravityrail.com/sdk/type-aliases/AbilityResponse.md)\[]> #### Implementation of[​](#implementation-of-645 "Direct link to Implementation of") `AgentsBindings.listAgentAbilities` *** ### listAppConnections()[​](#listappconnections "Direct link to listAppConnections()") > **listAppConnections**: (`wid`) => `Promise`<[`AppConnectionItem`](https://docs.gravityrail.com/sdk/type-aliases/AppConnectionItem.md)\[]> Defined in: [packages/sdk/src/client/client.ts:1034](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L1034) List all active app connections across all types. Returns a union of platform apps, MCP servers, Discord bots, Slack apps, and FHIR connections. #### Parameters[​](#parameters-628 "Direct link to Parameters") ##### wid[​](#wid-529 "Direct link to wid") `string` #### Returns[​](#returns-647 "Direct link to Returns") `Promise`<[`AppConnectionItem`](https://docs.gravityrail.com/sdk/type-aliases/AppConnectionItem.md)\[]> #### Implementation of[​](#implementation-of-646 "Direct link to Implementation of") `IntegrationsBindings.listAppConnections` *** ### listApps()[​](#listapps "Direct link to listApps()") > **listApps**: (`params?`) => `Promise`<[`AppListResponse`](https://docs.gravityrail.com/sdk/type-aliases/AppListResponse.md)> Defined in: [packages/sdk/src/client/client.ts:828](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L828) List apps - either public apps, account's apps, or all apps visible to a workspace #### Parameters[​](#parameters-629 "Direct link to Parameters") ##### params?[​](#params-30 "Direct link to params?") ###### builderId?[​](#builderid-5 "Direct link to builderId?") `number` ###### public?[​](#public "Direct link to public?") `boolean` ###### workspaceUuid?[​](#workspaceuuid-11 "Direct link to workspaceUuid?") `string` #### Returns[​](#returns-648 "Direct link to Returns") `Promise`<[`AppListResponse`](https://docs.gravityrail.com/sdk/type-aliases/AppListResponse.md)> #### Implementation of[​](#implementation-of-647 "Direct link to Implementation of") `AppsBindings.listApps` *** ### listAvailableAppConnections()[​](#listavailableappconnections "Direct link to listAvailableAppConnections()") > **listAvailableAppConnections**: (`wid`) => `Promise`<[`AppConnectionDirectoryResponse`](https://docs.gravityrail.com/sdk/interfaces/AppConnectionDirectoryResponse.md)> Defined in: [packages/sdk/src/client/client.ts:1033](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L1033) List all app connection definitions the workspace can access. Returns static metadata only (no instance counts or active data). #### Parameters[​](#parameters-630 "Direct link to Parameters") ##### wid[​](#wid-530 "Direct link to wid") `string` #### Returns[​](#returns-649 "Direct link to Returns") `Promise`<[`AppConnectionDirectoryResponse`](https://docs.gravityrail.com/sdk/interfaces/AppConnectionDirectoryResponse.md)> #### Implementation of[​](#implementation-of-648 "Direct link to Implementation of") `IntegrationsBindings.listAvailableAppConnections` *** ### listBuilders()[​](#listbuilders "Direct link to listBuilders()") > **listBuilders**: (`all?`) => `Promise`<[`BuilderListResponse`](https://docs.gravityrail.com/sdk/interfaces/BuilderListResponse.md)> Defined in: [packages/sdk/src/client/client.ts:835](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L835) List all builders (optionally all with superuser access) #### Parameters[​](#parameters-631 "Direct link to Parameters") ##### all?[​](#all "Direct link to all?") `boolean` #### Returns[​](#returns-650 "Direct link to Returns") `Promise`<[`BuilderListResponse`](https://docs.gravityrail.com/sdk/interfaces/BuilderListResponse.md)> #### Implementation of[​](#implementation-of-649 "Direct link to Implementation of") `AppsBindings.listBuilders` *** ### listChatRecordings()[​](#listchatrecordings "Direct link to listChatRecordings()") > **listChatRecordings**: (`wid`, `chatId`, `options`) => `Promise`<`RecordingListResponse`> Defined in: [packages/sdk/src/client/client.ts:191](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L191) List the recorded audio chunks for a chat (metadata only). #### Parameters[​](#parameters-632 "Direct link to Parameters") ##### wid[​](#wid-531 "Direct link to wid") `string` ##### chatId[​](#chatid-18 "Direct link to chatId") `number` ##### options?[​](#options-51 "Direct link to options?") ###### role?[​](#role-1 "Direct link to role?") `"member"` | `"assistant"` #### Returns[​](#returns-651 "Direct link to Returns") `Promise`<`RecordingListResponse`> #### Implementation of[​](#implementation-of-650 "Direct link to Implementation of") `CallsBindings.listChatRecordings` *** ### listConfluencePages()[​](#listconfluencepages "Direct link to listConfluencePages()") > **listConfluencePages**: (`wid`, `spaceId`, `params?`) => `Promise`<`ConfluencePagesResponse`> Defined in: [packages/sdk/src/client/client.ts:980](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L980) #### Parameters[​](#parameters-633 "Direct link to Parameters") ##### wid[​](#wid-532 "Direct link to wid") `string` ##### spaceId[​](#spaceid "Direct link to spaceId") `string` ##### params?[​](#params-31 "Direct link to params?") ###### cursor?[​](#cursor-1 "Direct link to cursor?") `string` ###### limit?[​](#limit-14 "Direct link to limit?") `number` #### Returns[​](#returns-652 "Direct link to Returns") `Promise`<`ConfluencePagesResponse`> #### Implementation of[​](#implementation-of-651 "Direct link to Implementation of") `IntegrationsBindings.listConfluencePages` *** ### listConfluenceSpaces()[​](#listconfluencespaces "Direct link to listConfluenceSpaces()") > **listConfluenceSpaces**: (`wid`, `params?`) => `Promise`<`ConfluenceSpacesResponse`> Defined in: [packages/sdk/src/client/client.ts:979](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L979) #### Parameters[​](#parameters-634 "Direct link to Parameters") ##### wid[​](#wid-533 "Direct link to wid") `string` ##### params?[​](#params-32 "Direct link to params?") ###### cursor?[​](#cursor-2 "Direct link to cursor?") `string` ###### limit?[​](#limit-15 "Direct link to limit?") `number` #### Returns[​](#returns-653 "Direct link to Returns") `Promise`<`ConfluenceSpacesResponse`> #### Implementation of[​](#implementation-of-652 "Direct link to Implementation of") `IntegrationsBindings.listConfluenceSpaces` *** ### listConnectionMemberFieldKeys()[​](#listconnectionmemberfieldkeys "Direct link to listConnectionMemberFieldKeys()") > **listConnectionMemberFieldKeys**: (`wid`, `connectionId`) => `Promise`<`ConnectionMemberFieldKeysResponse`> Defined in: [packages/sdk/src/client/client.ts:1039](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L1039) #### Parameters[​](#parameters-635 "Direct link to Parameters") ##### wid[​](#wid-534 "Direct link to wid") `string` ##### connectionId[​](#connectionid-33 "Direct link to connectionId") `number` #### Returns[​](#returns-654 "Direct link to Returns") `Promise`<`ConnectionMemberFieldKeysResponse`> #### Implementation of[​](#implementation-of-653 "Direct link to Implementation of") `IntegrationsBindings.listConnectionMemberFieldKeys` *** ### listGoogleCalendars()[​](#listgooglecalendars "Direct link to listGoogleCalendars()") > **listGoogleCalendars**: (`wid`) => `Promise`<[`GoogleCalendarInfo`](https://docs.gravityrail.com/sdk/interfaces/GoogleCalendarInfo.md)\[]> Defined in: [packages/sdk/src/client/client.ts:720](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L720) List Google Calendars available for linking. #### Parameters[​](#parameters-636 "Direct link to Parameters") ##### wid[​](#wid-535 "Direct link to wid") `string` #### Returns[​](#returns-655 "Direct link to Returns") `Promise`<[`GoogleCalendarInfo`](https://docs.gravityrail.com/sdk/interfaces/GoogleCalendarInfo.md)\[]> #### Implementation of[​](#implementation-of-654 "Direct link to Implementation of") `CalendarsBindings.listGoogleCalendars` *** ### listHealthieAppointmentTypes()[​](#listhealthieappointmenttypes "Direct link to listHealthieAppointmentTypes()") > **listHealthieAppointmentTypes**: (`wid`, `providerId?`) => `Promise`<`HealthieAppointmentTypeResponse`\[]> Defined in: [packages/sdk/src/client/client.ts:966](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L966) #### Parameters[​](#parameters-637 "Direct link to Parameters") ##### wid[​](#wid-536 "Direct link to wid") `string` ##### providerId?[​](#providerid "Direct link to providerId?") `string` #### Returns[​](#returns-656 "Direct link to Returns") `Promise`<`HealthieAppointmentTypeResponse`\[]> #### Implementation of[​](#implementation-of-655 "Direct link to Implementation of") `IntegrationsBindings.listHealthieAppointmentTypes` *** ### listHealthiePatients()[​](#listhealthiepatients "Direct link to listHealthiePatients()") > **listHealthiePatients**: (`wid`, `keywords?`) => `Promise`<`HealthiePatientResponse`\[]> Defined in: [packages/sdk/src/client/client.ts:967](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L967) #### Parameters[​](#parameters-638 "Direct link to Parameters") ##### wid[​](#wid-537 "Direct link to wid") `string` ##### keywords?[​](#keywords "Direct link to keywords?") `string` #### Returns[​](#returns-657 "Direct link to Returns") `Promise`<`HealthiePatientResponse`\[]> #### Implementation of[​](#implementation-of-656 "Direct link to Implementation of") `IntegrationsBindings.listHealthiePatients` *** ### listHealthieProviders()[​](#listhealthieproviders "Direct link to listHealthieProviders()") > **listHealthieProviders**: (`wid`) => `Promise`<`HealthieProvider`\[]> Defined in: [packages/sdk/src/client/client.ts:958](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L958) #### Parameters[​](#parameters-639 "Direct link to Parameters") ##### wid[​](#wid-538 "Direct link to wid") `string` #### Returns[​](#returns-658 "Direct link to Returns") `Promise`<`HealthieProvider`\[]> #### Implementation of[​](#implementation-of-657 "Direct link to Implementation of") `IntegrationsBindings.listHealthieProviders` *** ### listInquiries()[​](#listinquiries "Direct link to listInquiries()") > **listInquiries**: (`params?`) => `Promise`<[`InquiryListResponse`](https://docs.gravityrail.com/sdk/interfaces/InquiryListResponse.md)> Defined in: [packages/sdk/src/client/client.ts:843](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L843) List all inquiries (superuser only) #### Parameters[​](#parameters-640 "Direct link to Parameters") ##### params?[​](#params-33 "Direct link to params?") ###### inquiryType?[​](#inquirytype-1 "Direct link to inquiryType?") `string` ###### page?[​](#page-53 "Direct link to page?") `number` ###### pageSize?[​](#pagesize-53 "Direct link to pageSize?") `number` #### Returns[​](#returns-659 "Direct link to Returns") `Promise`<[`InquiryListResponse`](https://docs.gravityrail.com/sdk/interfaces/InquiryListResponse.md)> #### Implementation of[​](#implementation-of-658 "Direct link to Implementation of") `AppsBindings.listInquiries` *** ### listOAuthAccounts()[​](#listoauthaccounts "Direct link to listOAuthAccounts()") > **listOAuthAccounts**: (`providerSlug`) => `Promise`<`OAuthAccountsResponse`> Defined in: [packages/sdk/src/client/client.ts:852](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L852) #### Parameters[​](#parameters-641 "Direct link to Parameters") ##### providerSlug[​](#providerslug-3 "Direct link to providerSlug") [`OAuthProviderSlug`](https://docs.gravityrail.com/sdk/type-aliases/OAuthProviderSlug.md) #### Returns[​](#returns-660 "Direct link to Returns") `Promise`<`OAuthAccountsResponse`> #### Implementation of[​](#implementation-of-659 "Direct link to Implementation of") `AppsBindings.listOAuthAccounts` *** ### listOrgDomains()[​](#listorgdomains "Direct link to listOrgDomains()") > **listOrgDomains**: (`orgIdOrUuid`) => `Promise`<[`OrgDomainListResponse`](https://docs.gravityrail.com/sdk/type-aliases/OrgDomainListResponse.md)> Defined in: [packages/sdk/src/client/client.ts:448](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L448) List domains registered to an organization. #### Parameters[​](#parameters-642 "Direct link to Parameters") ##### orgIdOrUuid[​](#orgidoruuid-10 "Direct link to orgIdOrUuid") `string` | `number` #### Returns[​](#returns-661 "Direct link to Returns") `Promise`<[`OrgDomainListResponse`](https://docs.gravityrail.com/sdk/type-aliases/OrgDomainListResponse.md)> #### Implementation of[​](#implementation-of-660 "Direct link to Implementation of") `OrgBindings.listOrgDomains` *** ### listOrgSupportRequests()[​](#listorgsupportrequests "Direct link to listOrgSupportRequests()") > **listOrgSupportRequests**: (`orgUuid`, `params?`) => `Promise`<[`PaginatedResponse`](https://docs.gravityrail.com/sdk/interfaces/PaginatedResponse.md)<`SupportRequest`>> Defined in: [packages/sdk/src/client/client.ts:1084](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L1084) #### Parameters[​](#parameters-643 "Direct link to Parameters") ##### orgUuid[​](#orguuid-10 "Direct link to orgUuid") `string` ##### params?[​](#params-34 "Direct link to params?") `SupportRequestListParams` #### Returns[​](#returns-662 "Direct link to Returns") `Promise`<[`PaginatedResponse`](https://docs.gravityrail.com/sdk/interfaces/PaginatedResponse.md)<`SupportRequest`>> #### Implementation of[​](#implementation-of-661 "Direct link to Implementation of") `SupportRequestsBindings.listOrgSupportRequests` *** ### listPersonas()[​](#listpersonas "Direct link to listPersonas()") > **listPersonas**: (`wid`, `params?`) => `Promise`<[`PaginatedResponse`](https://docs.gravityrail.com/sdk/interfaces/PaginatedResponse.md)<[`Persona`](https://docs.gravityrail.com/sdk/type-aliases/Persona.md)>> Defined in: [packages/sdk/src/client/client.ts:318](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L318) List personas in the workspace, paginated. #### Parameters[​](#parameters-644 "Direct link to Parameters") ##### wid[​](#wid-539 "Direct link to wid") `string` ##### params?[​](#params-35 "Direct link to params?") ###### page?[​](#page-54 "Direct link to page?") `number` ###### pageSize?[​](#pagesize-54 "Direct link to pageSize?") `number` #### Returns[​](#returns-663 "Direct link to Returns") `Promise`<[`PaginatedResponse`](https://docs.gravityrail.com/sdk/interfaces/PaginatedResponse.md)<[`Persona`](https://docs.gravityrail.com/sdk/type-aliases/Persona.md)>> #### Implementation of[​](#implementation-of-662 "Direct link to Implementation of") `PersonasBindings.listPersonas` *** ### listPushSubscriptions()[​](#listpushsubscriptions "Direct link to listPushSubscriptions()") > **listPushSubscriptions**: (`wid`) => `Promise`<`object`\[]> Defined in: [packages/sdk/src/client/client.ts:470](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L470) List all active Web Push subscriptions for the current user. #### Parameters[​](#parameters-645 "Direct link to Parameters") ##### wid[​](#wid-540 "Direct link to wid") `string` #### Returns[​](#returns-664 "Direct link to Returns") `Promise`<`object`\[]> #### Implementation of[​](#implementation-of-663 "Direct link to Implementation of") `WorkspacesBindings.listPushSubscriptions` *** ### listScenarios()[​](#listscenarios "Direct link to listScenarios()") > **listScenarios**: (`wid`, `qualificationId`, `params?`) => `Promise`<[`Scenario`](https://docs.gravityrail.com/sdk/type-aliases/Scenario.md)\[]> Defined in: [packages/sdk/src/client/client.ts:300](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L300) #### Parameters[​](#parameters-646 "Direct link to Parameters") ##### wid[​](#wid-541 "Direct link to wid") `string` ##### qualificationId[​](#qualificationid-1 "Direct link to qualificationId") `number` ##### params?[​](#params-36 "Direct link to params?") ###### includeArchived?[​](#includearchived-5 "Direct link to includeArchived?") `boolean` #### Returns[​](#returns-665 "Direct link to Returns") `Promise`<[`Scenario`](https://docs.gravityrail.com/sdk/type-aliases/Scenario.md)\[]> #### Implementation of[​](#implementation-of-664 "Direct link to Implementation of") `QualificationsBindings.listScenarios` *** ### listSelfServeProducts()[​](#listselfserveproducts "Direct link to listSelfServeProducts()") > **listSelfServeProducts**: (`productType?`) => `Promise`<[`Product`](https://docs.gravityrail.com/sdk/type-aliases/Product.md)\[]> Defined in: [packages/sdk/src/client/client.ts:820](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L820) List self-service, purchasable plans (org or workspace). Only plans with a paid Stripe price are returned. No auth required. #### Parameters[​](#parameters-647 "Direct link to Parameters") ##### productType?[​](#producttype "Direct link to productType?") `"workspace"` | `"org"` #### Returns[​](#returns-666 "Direct link to Returns") `Promise`<[`Product`](https://docs.gravityrail.com/sdk/type-aliases/Product.md)\[]> #### Implementation of[​](#implementation-of-665 "Direct link to Implementation of") `BillingBindings.listSelfServeProducts` *** ### listSupportRequests()[​](#listsupportrequests "Direct link to listSupportRequests()") > **listSupportRequests**: (`params?`) => `Promise`<[`PaginatedResponse`](https://docs.gravityrail.com/sdk/interfaces/PaginatedResponse.md)<`SupportRequest`>> Defined in: [packages/sdk/src/client/client.ts:1080](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L1080) #### Parameters[​](#parameters-648 "Direct link to Parameters") ##### params?[​](#params-37 "Direct link to params?") `SupportRequestListParams` #### Returns[​](#returns-667 "Direct link to Returns") `Promise`<[`PaginatedResponse`](https://docs.gravityrail.com/sdk/interfaces/PaginatedResponse.md)<`SupportRequest`>> #### Implementation of[​](#implementation-of-666 "Direct link to Implementation of") `SupportRequestsBindings.listSupportRequests` *** ### listTestChatRuns()[​](#listtestchatruns "Direct link to listTestChatRuns()") > **listTestChatRuns**: (`wid`, `workflowId`, `params?`) => `Promise`<[`TestChatRunResponse`](https://docs.gravityrail.com/sdk/interfaces/TestChatRunResponse.md)\[]> Defined in: [packages/sdk/src/client/client.ts:305](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L305) #### Parameters[​](#parameters-649 "Direct link to Parameters") ##### wid[​](#wid-542 "Direct link to wid") `string` ##### workflowId[​](#workflowid-14 "Direct link to workflowId") `number` ##### params?[​](#params-38 "Direct link to params?") ###### assistantChatModelId?[​](#assistantchatmodelid "Direct link to assistantChatModelId?") `string` ###### limit?[​](#limit-16 "Direct link to limit?") `number` ###### scenarioId?[​](#scenarioid-2 "Direct link to scenarioId?") `number` #### Returns[​](#returns-668 "Direct link to Returns") `Promise`<[`TestChatRunResponse`](https://docs.gravityrail.com/sdk/interfaces/TestChatRunResponse.md)\[]> #### Implementation of[​](#implementation-of-667 "Direct link to Implementation of") `QualificationsBindings.listTestChatRuns` *** ### listWorkspaceInvitations()[​](#listworkspaceinvitations "Direct link to listWorkspaceInvitations()") > **listWorkspaceInvitations**: (`params?`) => `Promise`<[`InvitationListResponse`](https://docs.gravityrail.com/sdk/type-aliases/InvitationListResponse.md)> Defined in: [packages/sdk/src/client/client.ts:471](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L471) List user's own invitations (both org and workspace). For admin listing of a specific workspace's invitations, use listWorkspaceInvitationsAdmin. #### Parameters[​](#parameters-650 "Direct link to Parameters") ##### params?[​](#params-39 "Direct link to params?") [`ListInvitationsParams`](https://docs.gravityrail.com/sdk/interfaces/ListInvitationsParams.md) #### Returns[​](#returns-669 "Direct link to Returns") `Promise`<[`InvitationListResponse`](https://docs.gravityrail.com/sdk/type-aliases/InvitationListResponse.md)> #### Implementation of[​](#implementation-of-668 "Direct link to Implementation of") `WorkspacesBindings.listWorkspaceInvitations` *** ### listWorkspaceInvitationsAdmin()[​](#listworkspaceinvitationsadmin "Direct link to listWorkspaceInvitationsAdmin()") > **listWorkspaceInvitationsAdmin**: (`workspaceUuid`, `params?`) => `Promise`<[`InvitationListResponse`](https://docs.gravityrail.com/sdk/type-aliases/InvitationListResponse.md)> Defined in: [packages/sdk/src/client/client.ts:472](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L472) List invitations for a specific workspace (requires workspace admin permission). Uses the workspace-scoped route: /api/v2/w/{workspaceUuid}/invitations #### Parameters[​](#parameters-651 "Direct link to Parameters") ##### workspaceUuid[​](#workspaceuuid-12 "Direct link to workspaceUuid") `string` ##### params?[​](#params-40 "Direct link to params?") ###### accountId?[​](#accountid-1 "Direct link to accountId?") `number` ###### page?[​](#page-55 "Direct link to page?") `number` ###### pageSize?[​](#pagesize-55 "Direct link to pageSize?") `number` ###### status?[​](#status-14 "Direct link to status?") [`InvitationStatus`](https://docs.gravityrail.com/sdk/enumerations/InvitationStatus.md) #### Returns[​](#returns-670 "Direct link to Returns") `Promise`<[`InvitationListResponse`](https://docs.gravityrail.com/sdk/type-aliases/InvitationListResponse.md)> #### Implementation of[​](#implementation-of-669 "Direct link to Implementation of") `WorkspacesBindings.listWorkspaceInvitationsAdmin` *** ### listWorkspaceSupportRequests()[​](#listworkspacesupportrequests "Direct link to listWorkspaceSupportRequests()") > **listWorkspaceSupportRequests**: (`workspaceUuid`, `params?`) => `Promise`<[`PaginatedResponse`](https://docs.gravityrail.com/sdk/interfaces/PaginatedResponse.md)<`SupportRequest`>> Defined in: [packages/sdk/src/client/client.ts:1088](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L1088) #### Parameters[​](#parameters-652 "Direct link to Parameters") ##### workspaceUuid[​](#workspaceuuid-13 "Direct link to workspaceUuid") `string` ##### params?[​](#params-41 "Direct link to params?") `SupportRequestListParams` #### Returns[​](#returns-671 "Direct link to Returns") `Promise`<[`PaginatedResponse`](https://docs.gravityrail.com/sdk/interfaces/PaginatedResponse.md)<`SupportRequest`>> #### Implementation of[​](#implementation-of-670 "Direct link to Implementation of") `SupportRequestsBindings.listWorkspaceSupportRequests` *** ### login()[​](#login "Direct link to login()") > **login**: (`phoneNumber`, `wid?`, `organizationUuid?`) => `Promise`<[`SMSLoginResponse`](https://docs.gravityrail.com/sdk/interfaces/SMSLoginResponse.md)> Defined in: [packages/sdk/src/client/client.ts:488](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L488) Initiate SMS login by sending a verification code to the given phone number. #### Parameters[​](#parameters-653 "Direct link to Parameters") ##### phoneNumber[​](#phonenumber-1 "Direct link to phoneNumber") `string` ##### wid?[​](#wid-543 "Direct link to wid?") `string` ##### organizationUuid?[​](#organizationuuid-3 "Direct link to organizationUuid?") `string` #### Returns[​](#returns-672 "Direct link to Returns") `Promise`<[`SMSLoginResponse`](https://docs.gravityrail.com/sdk/interfaces/SMSLoginResponse.md)> #### Implementation of[​](#implementation-of-671 "Direct link to Implementation of") `AuthBindings.login` *** ### logout()[​](#logout "Direct link to logout()") > **logout**: () => `Promise`<{ `success`: `boolean`; }> Defined in: [packages/sdk/src/client/client.ts:500](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L500) Log out the current session by clearing auth cookies. #### Returns[​](#returns-673 "Direct link to Returns") `Promise`<{ `success`: `boolean`; }> #### Implementation of[​](#implementation-of-672 "Direct link to Implementation of") `AuthBindings.logout` *** ### markEmailAsRead()[​](#markemailasread "Direct link to markEmailAsRead()") > **markEmailAsRead**: (`wid`, `inboxId`, `emailId`) => `Promise`<[`Email`](https://docs.gravityrail.com/sdk/interfaces/Email.md)> Defined in: [packages/sdk/src/client/client.ts:754](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L754) Mark an email as read. #### Parameters[​](#parameters-654 "Direct link to Parameters") ##### wid[​](#wid-544 "Direct link to wid") `string` ##### inboxId[​](#inboxid-7 "Direct link to inboxId") `number` ##### emailId[​](#emailid-3 "Direct link to emailId") `number` #### Returns[​](#returns-674 "Direct link to Returns") `Promise`<[`Email`](https://docs.gravityrail.com/sdk/interfaces/Email.md)> #### Implementation of[​](#implementation-of-673 "Direct link to Implementation of") `CommunicationsBindings.markEmailAsRead` *** ### markEmailAsUnread()[​](#markemailasunread "Direct link to markEmailAsUnread()") > **markEmailAsUnread**: (`wid`, `inboxId`, `emailId`) => `Promise`<[`Email`](https://docs.gravityrail.com/sdk/interfaces/Email.md)> Defined in: [packages/sdk/src/client/client.ts:755](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L755) Mark an email as unread. #### Parameters[​](#parameters-655 "Direct link to Parameters") ##### wid[​](#wid-545 "Direct link to wid") `string` ##### inboxId[​](#inboxid-8 "Direct link to inboxId") `number` ##### emailId[​](#emailid-4 "Direct link to emailId") `number` #### Returns[​](#returns-675 "Direct link to Returns") `Promise`<[`Email`](https://docs.gravityrail.com/sdk/interfaces/Email.md)> #### Implementation of[​](#implementation-of-674 "Direct link to Implementation of") `CommunicationsBindings.markEmailAsUnread` *** ### markNotificationAsRead()[​](#marknotificationasread "Direct link to markNotificationAsRead()") > **markNotificationAsRead**: (`wid`, `id`) => `Promise`<[`NotificationResponse`](https://docs.gravityrail.com/sdk/interfaces/NotificationResponse.md)> Defined in: [packages/sdk/src/client/client.ts:418](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L418) Mark a notification as read. #### Parameters[​](#parameters-656 "Direct link to Parameters") ##### wid[​](#wid-546 "Direct link to wid") `string` ##### id[​](#id-77 "Direct link to id") `number` #### Returns[​](#returns-676 "Direct link to Returns") `Promise`<[`NotificationResponse`](https://docs.gravityrail.com/sdk/interfaces/NotificationResponse.md)> #### Implementation of[​](#implementation-of-675 "Direct link to Implementation of") `WorkspacesBindings.markNotificationAsRead` *** ### previewImportMembers()[​](#previewimportmembers "Direct link to previewImportMembers()") > **previewImportMembers**: (`wid`, `file`, `newMemberRoleId`, `options?`) => `Promise`<[`MemberImportPreviewResponse`](https://docs.gravityrail.com/sdk/interfaces/MemberImportPreviewResponse.md)> Defined in: [packages/sdk/src/client/client.ts:233](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L233) Read-only preview classifying each CSV row before any write (GRA-5545). Returns create/update/unchanged/conflict/error counts. For phone-only identity conflicts it also returns existing vs incoming identity so the operator can decide whether to skip or explicitly overwrite before committing. Requires MEMBERS\_ADMIN and is bulk-PHI audited server-side. #### Parameters[​](#parameters-657 "Direct link to Parameters") ##### wid[​](#wid-547 "Direct link to wid") `string` ##### file[​](#file-5 "Direct link to file") `File` ##### newMemberRoleId[​](#newmemberroleid-1 "Direct link to newMemberRoleId") `number` ##### options?[​](#options-52 "Direct link to options?") ###### trustEmailAddresses?[​](#trustemailaddresses-1 "Direct link to trustEmailAddresses?") `boolean` ###### trustPhoneNumbers?[​](#trustphonenumbers-1 "Direct link to trustPhoneNumbers?") `boolean` #### Returns[​](#returns-677 "Direct link to Returns") `Promise`<[`MemberImportPreviewResponse`](https://docs.gravityrail.com/sdk/interfaces/MemberImportPreviewResponse.md)> #### Implementation of[​](#implementation-of-676 "Direct link to Implementation of") `MembersBindings.previewImportMembers` *** ### previewImportWorkspace()[​](#previewimportworkspace "Direct link to previewImportWorkspace()") > **previewImportWorkspace**: (`wid`, `exportData`, `importMappings`, `createNew`) => `Promise`<`any`> Defined in: [packages/sdk/src/client/client.ts:438](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L438) Preview a workspace import using the legacy untyped interface. #### Parameters[​](#parameters-658 "Direct link to Parameters") ##### wid[​](#wid-548 "Direct link to wid") `string` ##### exportData[​](#exportdata-1 "Direct link to exportData") `any` ##### importMappings?[​](#importmappings-1 "Direct link to importMappings?") `any` = `{}` ##### createNew?[​](#createnew-1 "Direct link to createNew?") `any` = `{}` #### Returns[​](#returns-678 "Direct link to Returns") `Promise`<`any`> #### Implementation of[​](#implementation-of-677 "Direct link to Implementation of") `WorkspacesBindings.previewImportWorkspace` *** ### previewPronunciation()[​](#previewpronunciation "Direct link to previewPronunciation()") > **previewPronunciation**: (`data`) => `Promise`<`ArrayBuffer`> Defined in: [packages/sdk/src/client/client.ts:1055](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L1055) Generate an audio preview of a pronunciation respelling using a specified voice. #### Parameters[​](#parameters-659 "Direct link to Parameters") ##### data[​](#data-81 "Direct link to data") ###### respelling[​](#respelling "Direct link to respelling") `string` ###### voiceModel[​](#voicemodel "Direct link to voiceModel") `string` #### Returns[​](#returns-679 "Direct link to Returns") `Promise`<`ArrayBuffer`> #### Implementation of[​](#implementation-of-678 "Direct link to Implementation of") `PronunciationsBindings.previewPronunciation` *** ### previewQuery()[​](#previewquery "Direct link to previewQuery()") > **previewQuery**: (`wid`, `query`, `mode?`) => `Promise`<[`RunQueryResponse`](https://docs.gravityrail.com/sdk/interfaces/RunQueryResponse.md)> Defined in: [packages/sdk/src/client/client.ts:315](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L315) Bounded sample run (limit capped server-side). #### Parameters[​](#parameters-660 "Direct link to Parameters") ##### wid[​](#wid-549 "Direct link to wid") `string` ##### query[​](#query-2 "Direct link to query") [`QueryIR`](https://docs.gravityrail.com/sdk/interfaces/QueryIR.md) ##### mode?[​](#mode-1 "Direct link to mode?") [`QueryRunMode`](https://docs.gravityrail.com/sdk/type-aliases/QueryRunMode.md) #### Returns[​](#returns-680 "Direct link to Returns") `Promise`<[`RunQueryResponse`](https://docs.gravityrail.com/sdk/interfaces/RunQueryResponse.md)> #### Implementation of[​](#implementation-of-679 "Direct link to Implementation of") `QueriesBindings.previewQuery` *** ### previewSchedule()[​](#previewschedule "Direct link to previewSchedule()") > **previewSchedule**: (`wid`, `request`) => `Promise`<[`SchedulePreviewResponse`](https://docs.gravityrail.com/sdk/interfaces/SchedulePreviewResponse.md)> Defined in: [packages/sdk/src/client/client.ts:642](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L642) Preview the next N run times for a cron expression. #### Parameters[​](#parameters-661 "Direct link to Parameters") ##### wid[​](#wid-550 "Direct link to wid") `string` ##### request[​](#request-16 "Direct link to request") [`SchedulePreviewRequest`](https://docs.gravityrail.com/sdk/interfaces/SchedulePreviewRequest.md) #### Returns[​](#returns-681 "Direct link to Returns") `Promise`<[`SchedulePreviewResponse`](https://docs.gravityrail.com/sdk/interfaces/SchedulePreviewResponse.md)> #### Implementation of[​](#implementation-of-680 "Direct link to Implementation of") `EventsBindings.previewSchedule` *** ### previewTemplate()[​](#previewtemplate "Direct link to previewTemplate()") > **previewTemplate**: (`wid`, `request`) => `Promise`<[`TemplatePreviewResponse`](https://docs.gravityrail.com/sdk/interfaces/TemplatePreviewResponse.md)> Defined in: [packages/sdk/src/client/client.ts:771](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L771) 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[​](#parameters-662 "Direct link to Parameters") ##### wid[​](#wid-551 "Direct link to wid") `string` ##### request[​](#request-17 "Direct link to request") [`TemplatePreviewRequest`](https://docs.gravityrail.com/sdk/interfaces/TemplatePreviewRequest.md) #### Returns[​](#returns-682 "Direct link to Returns") `Promise`<[`TemplatePreviewResponse`](https://docs.gravityrail.com/sdk/interfaces/TemplatePreviewResponse.md)> #### Implementation of[​](#implementation-of-681 "Direct link to Implementation of") `ToolkitsBindings.previewTemplate` *** ### previewThinkingSound()[​](#previewthinkingsound "Direct link to previewThinkingSound()") > **previewThinkingSound**: (`wid`, `request`) => `Promise`<`ArrayBuffer`> Defined in: [packages/sdk/src/client/client.ts:685](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L685) Generate a thinking sound audio preview. #### Parameters[​](#parameters-663 "Direct link to Parameters") ##### wid[​](#wid-552 "Direct link to wid") `string` ##### request[​](#request-18 "Direct link to request") [`ThinkingSoundPreviewRequest`](https://docs.gravityrail.com/sdk/interfaces/ThinkingSoundPreviewRequest.md) #### Returns[​](#returns-683 "Direct link to Returns") `Promise`<`ArrayBuffer`> #### Implementation of[​](#implementation-of-682 "Direct link to Implementation of") `WorkflowsBindings.previewThinkingSound` *** ### previewTTS()[​](#previewtts "Direct link to previewTTS()") > **previewTTS**: (`wid`, `request`) => `Promise`<`ArrayBuffer`> Defined in: [packages/sdk/src/client/client.ts:684](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L684) Generate a text-to-speech audio preview for a given voice model. #### Parameters[​](#parameters-664 "Direct link to Parameters") ##### wid[​](#wid-553 "Direct link to wid") `string` ##### request[​](#request-19 "Direct link to request") [`TTSPreviewRequest`](https://docs.gravityrail.com/sdk/interfaces/TTSPreviewRequest.md) #### Returns[​](#returns-684 "Direct link to Returns") `Promise`<`ArrayBuffer`> #### Implementation of[​](#implementation-of-683 "Direct link to Implementation of") `WorkflowsBindings.previewTTS` *** ### previewWorkspaceImport()[​](#previewworkspaceimport "Direct link to previewWorkspaceImport()") > **previewWorkspaceImport**: (`wid`, `exportData`, `importMappings`, `createNew`, `autoMap?`) => `Promise`<[`WorkspaceImportPreviewResponse`](https://docs.gravityrail.com/sdk/interfaces/WorkspaceImportPreviewResponse.md)> Defined in: [packages/sdk/src/client/client.ts:436](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L436) Preview the result of importing workspace configuration without applying changes. #### Parameters[​](#parameters-665 "Direct link to Parameters") ##### wid[​](#wid-554 "Direct link to wid") `string` ##### exportData[​](#exportdata-2 "Direct link to exportData") [`WorkspaceExportData`](https://docs.gravityrail.com/sdk/interfaces/WorkspaceExportData.md) ##### importMappings[​](#importmappings-2 "Direct link to importMappings") [`WorkspaceImportMapping`](https://docs.gravityrail.com/sdk/interfaces/WorkspaceImportMapping.md) ##### createNew[​](#createnew-2 "Direct link to createNew") [`WorkspaceCreateNewEntities`](https://docs.gravityrail.com/sdk/interfaces/WorkspaceCreateNewEntities.md) ##### autoMap?[​](#automap "Direct link to autoMap?") [`WorkspaceAutoMapEntities`](https://docs.gravityrail.com/sdk/interfaces/WorkspaceAutoMapEntities.md) #### Returns[​](#returns-685 "Direct link to Returns") `Promise`<[`WorkspaceImportPreviewResponse`](https://docs.gravityrail.com/sdk/interfaces/WorkspaceImportPreviewResponse.md)> #### Implementation of[​](#implementation-of-684 "Direct link to Implementation of") `WorkspacesBindings.previewWorkspaceImport` *** ### provisionClientWorkspace()[​](#provisionclientworkspace "Direct link to provisionClientWorkspace()") > **provisionClientWorkspace**: (`wid`, `workspaceId`) => `Promise`<{ `message`: `string`; `status`: `string`; }> Defined in: [packages/sdk/src/client/client.ts:426](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L426) Provision a client workspace, setting up its database and resources. #### Parameters[​](#parameters-666 "Direct link to Parameters") ##### wid[​](#wid-555 "Direct link to wid") `string` ##### workspaceId[​](#workspaceid-2 "Direct link to workspaceId") `number` #### Returns[​](#returns-686 "Direct link to Returns") `Promise`<{ `message`: `string`; `status`: `string`; }> #### Implementation of[​](#implementation-of-685 "Direct link to Implementation of") `WorkspacesBindings.provisionClientWorkspace` *** ### publishSiteSource()[​](#publishsitesource "Direct link to publishSiteSource()") > **publishSiteSource**: (`wid`, `siteId`, `options?`) => `Promise`<[`SiteSourcePublishResponse`](https://docs.gravityrail.com/sdk/interfaces/SiteSourcePublishResponse.md)> Defined in: [packages/sdk/src/client/client.ts:552](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L552) 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[​](#parameters-667 "Direct link to Parameters") ##### wid[​](#wid-556 "Direct link to wid") `string` ##### siteId[​](#siteid-20 "Direct link to siteId") `number` ##### options?[​](#options-53 "Direct link to options?") ###### name?[​](#name-10 "Direct link to name?") `string` | `null` ###### note?[​](#note "Direct link to note?") `string` | `null` #### Returns[​](#returns-687 "Direct link to Returns") `Promise`<[`SiteSourcePublishResponse`](https://docs.gravityrail.com/sdk/interfaces/SiteSourcePublishResponse.md)> #### Implementation of[​](#implementation-of-686 "Direct link to Implementation of") `SitesBindings.publishSiteSource` *** ### publishWorkflowVersion()[​](#publishworkflowversion "Direct link to publishWorkflowVersion()") > **publishWorkflowVersion**: (`wid`, `workflowUuid`, `data`) => `Promise`<`WorkflowVersionResponse`> Defined in: [packages/sdk/src/client/client.ts:675](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L675) Publish the live workflow as a new immutable version. #### Parameters[​](#parameters-668 "Direct link to Parameters") ##### wid[​](#wid-557 "Direct link to wid") `string` ##### workflowUuid[​](#workflowuuid-6 "Direct link to workflowUuid") `string` ##### data[​](#data-82 "Direct link to data") `PublishVersionRequest` #### Returns[​](#returns-688 "Direct link to Returns") `Promise`<`WorkflowVersionResponse`> #### Implementation of[​](#implementation-of-687 "Direct link to Implementation of") `WorkflowsBindings.publishWorkflowVersion` *** ### purchaseCredits()[​](#purchasecredits "Direct link to purchaseCredits()") > **purchaseCredits**: (`subscriptionId`, `amountCents`) => `Promise`<{ `amountChargedCents`: `number`; `creditsAdded`: `number`; `grantId`: `number`; `newBalance`: `number`; `success`: `boolean`; }> Defined in: [packages/sdk/src/client/client.ts:818](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L818) Purchase extra credits on a subscription (org-level). #### Parameters[​](#parameters-669 "Direct link to Parameters") ##### subscriptionId[​](#subscriptionid-3 "Direct link to subscriptionId") `number` ##### amountCents[​](#amountcents "Direct link to amountCents") `number` #### Returns[​](#returns-689 "Direct link to Returns") `Promise`<{ `amountChargedCents`: `number`; `creditsAdded`: `number`; `grantId`: `number`; `newBalance`: `number`; `success`: `boolean`; }> #### Implementation of[​](#implementation-of-688 "Direct link to Implementation of") `BillingBindings.purchaseCredits` *** ### rateMessage()[​](#ratemessage "Direct link to rateMessage()") > **rateMessage**: (`wid`, `chatId`, `messageUuid`, `rating`) => `Promise`<{ `detail?`: `string`; `status`: `string`; }> Defined in: [packages/sdk/src/client/client.ts:164](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L164) Rate a chat message by its UUID. #### Parameters[​](#parameters-670 "Direct link to Parameters") ##### wid[​](#wid-558 "Direct link to wid") `string` ##### chatId[​](#chatid-19 "Direct link to chatId") `number` ##### messageUuid[​](#messageuuid "Direct link to messageUuid") `string` ##### rating[​](#rating "Direct link to rating") `number` #### Returns[​](#returns-690 "Direct link to Returns") `Promise`<{ `detail?`: `string`; `status`: `string`; }> #### Implementation of[​](#implementation-of-689 "Direct link to Implementation of") `ChatsBindings.rateMessage` *** ### reactivateSubscription()[​](#reactivatesubscription "Direct link to reactivateSubscription()") > **reactivateSubscription**: (`subscriptionId`) => `Promise`<{ `message`: `string`; }> Defined in: [packages/sdk/src/client/client.ts:815](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L815) Reactivate a previously cancelled subscription. #### Parameters[​](#parameters-671 "Direct link to Parameters") ##### subscriptionId[​](#subscriptionid-4 "Direct link to subscriptionId") `number` #### Returns[​](#returns-691 "Direct link to Returns") `Promise`<{ `message`: `string`; }> #### Implementation of[​](#implementation-of-690 "Direct link to Implementation of") `BillingBindings.reactivateSubscription` *** ### reenrollMember()[​](#reenrollmember "Direct link to reenrollMember()") > **reenrollMember**: (`wid`, `journeyId`, `data`) => `Promise`<`MemberJourney`> Defined in: [packages/sdk/src/client/client.ts:343](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L343) Re-enroll a canceled member back to enrolled status. #### Parameters[​](#parameters-672 "Direct link to Parameters") ##### wid[​](#wid-559 "Direct link to wid") `string` ##### journeyId[​](#journeyid-18 "Direct link to journeyId") `number` ##### data[​](#data-83 "Direct link to data") `ReenrollMemberFormData` #### Returns[​](#returns-692 "Direct link to Returns") `Promise`<`MemberJourney`> #### Implementation of[​](#implementation-of-691 "Direct link to Implementation of") `JourneysBindings.reenrollMember` *** ### regenerateClientSecret()[​](#regenerateclientsecret "Direct link to regenerateClientSecret()") > **regenerateClientSecret**: (`appId`) => `Promise`<[`AppCredentialResponse`](https://docs.gravityrail.com/sdk/interfaces/AppCredentialResponse.md)> Defined in: [packages/sdk/src/client/client.ts:834](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L834) Regenerate client secret for an app #### Parameters[​](#parameters-673 "Direct link to Parameters") ##### appId[​](#appid-12 "Direct link to appId") `string` #### Returns[​](#returns-693 "Direct link to Returns") `Promise`<[`AppCredentialResponse`](https://docs.gravityrail.com/sdk/interfaces/AppCredentialResponse.md)> #### Implementation of[​](#implementation-of-692 "Direct link to Implementation of") `AppsBindings.regenerateClientSecret` *** ### registerDiscordSlashCommands()[​](#registerdiscordslashcommands "Direct link to registerDiscordSlashCommands()") > **registerDiscordSlashCommands**: (`wid`, `botId`) => `Promise`<`void`> Defined in: [packages/sdk/src/client/client.ts:892](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L892) Register slash commands for a Discord bot. #### Parameters[​](#parameters-674 "Direct link to Parameters") ##### wid[​](#wid-560 "Direct link to wid") `string` ##### botId[​](#botid-5 "Direct link to botId") `number` #### Returns[​](#returns-694 "Direct link to Returns") `Promise`<`void`> #### Implementation of[​](#implementation-of-693 "Direct link to Implementation of") `IntegrationsBindings.registerDiscordSlashCommands` *** ### registerLinkedRolesMetadata()[​](#registerlinkedrolesmetadata "Direct link to registerLinkedRolesMetadata()") > **registerLinkedRolesMetadata**: (`wid`, `botId`) => `Promise`<{ `fields`: `string`\[]; `registered`: `number`; }> Defined in: [packages/sdk/src/client/client.ts:893](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L893) Register role connection metadata schema for Discord Linked Roles. This defines what metadata fields are available for linked roles. #### Parameters[​](#parameters-675 "Direct link to Parameters") ##### wid[​](#wid-561 "Direct link to wid") `string` ##### botId[​](#botid-6 "Direct link to botId") `number` #### Returns[​](#returns-695 "Direct link to Returns") `Promise`<{ `fields`: `string`\[]; `registered`: `number`; }> #### Implementation of[​](#implementation-of-694 "Direct link to Implementation of") `IntegrationsBindings.registerLinkedRolesMetadata` *** ### registerOrgDomain()[​](#registerorgdomain "Direct link to registerOrgDomain()") > **registerOrgDomain**: (`orgIdOrUuid`, `domain`) => `Promise`<[`OrgDomain`](https://docs.gravityrail.com/sdk/type-aliases/OrgDomain.md)> Defined in: [packages/sdk/src/client/client.ts:449](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L449) Register a domain with an organization and return the TXT ownership proof. #### Parameters[​](#parameters-676 "Direct link to Parameters") ##### orgIdOrUuid[​](#orgidoruuid-11 "Direct link to orgIdOrUuid") `string` | `number` ##### domain[​](#domain-1 "Direct link to domain") `string` #### Returns[​](#returns-696 "Direct link to Returns") `Promise`<[`OrgDomain`](https://docs.gravityrail.com/sdk/type-aliases/OrgDomain.md)> #### Implementation of[​](#implementation-of-695 "Direct link to Implementation of") `OrgBindings.registerOrgDomain` *** ### registerPushSubscription()[​](#registerpushsubscription "Direct link to registerPushSubscription()") > **registerPushSubscription**: (`wid`, `subscription`) => `Promise`<{ `createdAt`: `string`; `endpoint`: `string`; `id`: `number`; }> Defined in: [packages/sdk/src/client/client.ts:468](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L468) Register a Web Push subscription for the current user. #### Parameters[​](#parameters-677 "Direct link to Parameters") ##### wid[​](#wid-562 "Direct link to wid") `string` ##### subscription[​](#subscription "Direct link to subscription") ###### authKey[​](#authkey "Direct link to authKey") `string` ###### endpoint[​](#endpoint "Direct link to endpoint") `string` ###### p256dhKey[​](#p256dhkey "Direct link to p256dhKey") `string` ###### userAgent?[​](#useragent "Direct link to userAgent?") `string` #### Returns[​](#returns-697 "Direct link to Returns") `Promise`<{ `createdAt`: `string`; `endpoint`: `string`; `id`: `number`; }> #### Implementation of[​](#implementation-of-696 "Direct link to Implementation of") `WorkspacesBindings.registerPushSubscription` *** ### reindexFolder()[​](#reindexfolder "Direct link to reindexFolder()") > **reindexFolder**: (`wid`, `id`) => `Promise`<{ `message`: `string`; `status`: `string`; }> Defined in: [packages/sdk/src/client/client.ts:601](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L601) Trigger reindexing of a folder's contents for search. #### Parameters[​](#parameters-678 "Direct link to Parameters") ##### wid[​](#wid-563 "Direct link to wid") `string` ##### id[​](#id-78 "Direct link to id") `number` #### Returns[​](#returns-698 "Direct link to Returns") `Promise`<{ `message`: `string`; `status`: `string`; }> #### Implementation of[​](#implementation-of-697 "Direct link to Implementation of") `FilesBindings.reindexFolder` *** ### releasePhoneNumber()[​](#releasephonenumber "Direct link to releasePhoneNumber()") > **releasePhoneNumber**: (`wid`, `id`) => `Promise`<`void`> Defined in: [packages/sdk/src/client/client.ts:744](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L744) #### Parameters[​](#parameters-679 "Direct link to Parameters") ##### wid[​](#wid-564 "Direct link to wid") `string` ##### id[​](#id-79 "Direct link to id") `number` #### Returns[​](#returns-699 "Direct link to Returns") `Promise`<`void`> #### Implementation of[​](#implementation-of-698 "Direct link to Implementation of") `CommunicationsBindings.releasePhoneNumber` *** ### removeFileRole()[​](#removefilerole "Direct link to removeFileRole()") > **removeFileRole**: (`wid`, `fileId`, `roleId`) => `Promise`<`void`> Defined in: [packages/sdk/src/client/client.ts:611](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L611) Remove a role's access to a file. #### Parameters[​](#parameters-680 "Direct link to Parameters") ##### wid[​](#wid-565 "Direct link to wid") `string` ##### fileId[​](#fileid-3 "Direct link to fileId") `number` ##### roleId[​](#roleid "Direct link to roleId") `number` #### Returns[​](#returns-700 "Direct link to Returns") `Promise`<`void`> #### Implementation of[​](#implementation-of-699 "Direct link to Implementation of") `FilesBindings.removeFileRole` *** ### removeFolderRole()[​](#removefolderrole "Direct link to removeFolderRole()") > **removeFolderRole**: (`wid`, `folderId`, `roleId`) => `Promise`<`void`> Defined in: [packages/sdk/src/client/client.ts:614](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L614) Remove a role's access to a folder. #### Parameters[​](#parameters-681 "Direct link to Parameters") ##### wid[​](#wid-566 "Direct link to wid") `string` ##### folderId[​](#folderid-4 "Direct link to folderId") `number` ##### roleId[​](#roleid-1 "Direct link to roleId") `number` #### Returns[​](#returns-701 "Direct link to Returns") `Promise`<`void`> #### Implementation of[​](#implementation-of-700 "Direct link to Implementation of") `FilesBindings.removeFolderRole` *** ### removeGroupMember()[​](#removegroupmember "Direct link to removeGroupMember()") > **removeGroupMember**: (`wid`, `groupId`, `memberId`) => `Promise`<`void`> Defined in: [packages/sdk/src/client/client.ts:378](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L378) Remove a member from an operator group. #### Parameters[​](#parameters-682 "Direct link to Parameters") ##### wid[​](#wid-567 "Direct link to wid") `string` ##### groupId[​](#groupid-5 "Direct link to groupId") `number` ##### memberId[​](#memberid-28 "Direct link to memberId") `number` #### Returns[​](#returns-702 "Direct link to Returns") `Promise`<`void`> #### Implementation of[​](#implementation-of-701 "Direct link to Implementation of") `OperatorBindings.removeGroupMember` *** ### reopenWorkspaceSupportRequest()[​](#reopenworkspacesupportrequest "Direct link to reopenWorkspaceSupportRequest()") > **reopenWorkspaceSupportRequest**: (`workspaceUuid`, `uuid`, `data`) => `Promise`<`SupportRequest`> Defined in: [packages/sdk/src/client/client.ts:1093](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L1093) Reopen a resolved support request (e.g. staff resolved it prematurely). The server rejects requests that are not in the `resolved` state. #### Parameters[​](#parameters-683 "Direct link to Parameters") ##### workspaceUuid[​](#workspaceuuid-14 "Direct link to workspaceUuid") `string` ##### uuid[​](#uuid-31 "Direct link to uuid") `string` ##### data?[​](#data-84 "Direct link to data?") `ReopenSupportRequestRequest` = `{}` #### Returns[​](#returns-703 "Direct link to Returns") `Promise`<`SupportRequest`> #### Implementation of[​](#implementation-of-702 "Direct link to Implementation of") `SupportRequestsBindings.reopenWorkspaceSupportRequest` *** ### reorderEventRules()[​](#reordereventrules "Direct link to reorderEventRules()") > **reorderEventRules**: (`wid`, `ruleIds`) => `Promise`<{ `status`: `string`; }> Defined in: [packages/sdk/src/client/client.ts:631](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L631) Reorder event rules by specifying the desired rule ID sequence. #### Parameters[​](#parameters-684 "Direct link to Parameters") ##### wid[​](#wid-568 "Direct link to wid") `string` ##### ruleIds[​](#ruleids "Direct link to ruleIds") `number`\[] #### Returns[​](#returns-704 "Direct link to Returns") `Promise`<{ `status`: `string`; }> #### Implementation of[​](#implementation-of-703 "Direct link to Implementation of") `EventsBindings.reorderEventRules` *** ### reorderMenuItems()[​](#reordermenuitems "Direct link to reorderMenuItems()") > **reorderMenuItems**: (`wid`, `siteId`, `data`) => `Promise`<`void`> Defined in: [packages/sdk/src/client/client.ts:583](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L583) Reorder menu items within a site's navigation. #### Parameters[​](#parameters-685 "Direct link to Parameters") ##### wid[​](#wid-569 "Direct link to wid") `string` ##### siteId[​](#siteid-21 "Direct link to siteId") `number` ##### data[​](#data-85 "Direct link to data") [`ReorderMenuItemsData`](https://docs.gravityrail.com/sdk/interfaces/ReorderMenuItemsData.md) #### Returns[​](#returns-705 "Direct link to Returns") `Promise`<`void`> #### Implementation of[​](#implementation-of-704 "Direct link to Implementation of") `SitesBindings.reorderMenuItems` *** ### replyToEmail()[​](#replytoemail "Direct link to replyToEmail()") > **replyToEmail**: (`wid`, `inboxId`, `emailId`, `content`) => `Promise`<[`Email`](https://docs.gravityrail.com/sdk/interfaces/Email.md)> Defined in: [packages/sdk/src/client/client.ts:761](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L761) Reply to an email from the inbox. #### Parameters[​](#parameters-686 "Direct link to Parameters") ##### wid[​](#wid-570 "Direct link to wid") `string` ##### inboxId[​](#inboxid-9 "Direct link to inboxId") `number` ##### emailId[​](#emailid-5 "Direct link to emailId") `number` ##### content[​](#content-1 "Direct link to content") `string` #### Returns[​](#returns-706 "Direct link to Returns") `Promise`<[`Email`](https://docs.gravityrail.com/sdk/interfaces/Email.md)> #### Implementation of[​](#implementation-of-705 "Direct link to Implementation of") `CommunicationsBindings.replyToEmail` *** ### requestCredentialChange()[​](#requestcredentialchange "Direct link to requestCredentialChange()") > **requestCredentialChange**: (`credentialType`, `newValue`) => `Promise`<[`CredentialChangeRequestResponse`](https://docs.gravityrail.com/sdk/interfaces/CredentialChangeRequestResponse.md)> Defined in: [packages/sdk/src/client/client.ts:519](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L519) Request to change email or phone credential. Sends an OTP to the NEW credential to verify ownership. #### Parameters[​](#parameters-687 "Direct link to Parameters") ##### credentialType[​](#credentialtype-1 "Direct link to credentialType") [`CredentialType`](https://docs.gravityrail.com/sdk/type-aliases/CredentialType.md) ##### newValue[​](#newvalue-1 "Direct link to newValue") `string` #### Returns[​](#returns-707 "Direct link to Returns") `Promise`<[`CredentialChangeRequestResponse`](https://docs.gravityrail.com/sdk/interfaces/CredentialChangeRequestResponse.md)> #### Implementation of[​](#implementation-of-706 "Direct link to Implementation of") `AuthBindings.requestCredentialChange` *** ### requestCrossDomainToken()[​](#requestcrossdomaintoken "Direct link to requestCrossDomainToken()") > **requestCrossDomainToken**: () => `Promise`<{ `token`: `string`; }> Defined in: [packages/sdk/src/client/client.ts:501](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L501) Request a cross-domain authentication token for single sign-on across domains. #### Returns[​](#returns-708 "Direct link to Returns") `Promise`<{ `token`: `string`; }> #### Implementation of[​](#implementation-of-707 "Direct link to Implementation of") `AuthBindings.requestCrossDomainToken` *** ### requestMagicLink()[​](#requestmagiclink "Direct link to requestMagicLink()") > **requestMagicLink**: (`email`, `organizationUuid?`, `redirectUrl?`) => `Promise`<[`RequestMagicLinkResponse`](https://docs.gravityrail.com/sdk/interfaces/RequestMagicLinkResponse.md)> Defined in: [packages/sdk/src/client/client.ts:493](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L493) Request a magic link to be sent to the given email address for passwordless login. #### Parameters[​](#parameters-688 "Direct link to Parameters") ##### email[​](#email-4 "Direct link to email") `string` ##### organizationUuid?[​](#organizationuuid-4 "Direct link to organizationUuid?") `string` ##### redirectUrl?[​](#redirecturl "Direct link to redirectUrl?") `string` #### Returns[​](#returns-709 "Direct link to Returns") `Promise`<[`RequestMagicLinkResponse`](https://docs.gravityrail.com/sdk/interfaces/RequestMagicLinkResponse.md)> #### Implementation of[​](#implementation-of-708 "Direct link to Implementation of") `AuthBindings.requestMagicLink` *** ### requestPhoneNumber()[​](#requestphonenumber "Direct link to requestPhoneNumber()") > **requestPhoneNumber**: (`wid`, `phoneNumber`) => `Promise`<{ `message`: `string`; `status`: `string`; }> Defined in: [packages/sdk/src/client/client.ts:733](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L733) Request provisioning of a specific phone number. #### Parameters[​](#parameters-689 "Direct link to Parameters") ##### wid[​](#wid-571 "Direct link to wid") `string` ##### phoneNumber[​](#phonenumber-2 "Direct link to phoneNumber") `string` #### Returns[​](#returns-710 "Direct link to Returns") `Promise`<{ `message`: `string`; `status`: `string`; }> #### Implementation of[​](#implementation-of-709 "Direct link to Implementation of") `CommunicationsBindings.requestPhoneNumber` *** ### requestWorkspaceMembership()[​](#requestworkspacemembership "Direct link to requestWorkspaceMembership()") > **requestWorkspaceMembership**: (`workspaceUuid`, `message?`) => `Promise`<[`InvitationResponse`](https://docs.gravityrail.com/sdk/type-aliases/InvitationResponse.md)> Defined in: [packages/sdk/src/client/client.ts:477](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L477) Request membership to a public workspace. Creates a membership request that workspace admins can approve or deny. #### Parameters[​](#parameters-690 "Direct link to Parameters") ##### workspaceUuid[​](#workspaceuuid-15 "Direct link to workspaceUuid") `string` ##### message?[​](#message-2 "Direct link to message?") `string` #### Returns[​](#returns-711 "Direct link to Returns") `Promise`<[`InvitationResponse`](https://docs.gravityrail.com/sdk/type-aliases/InvitationResponse.md)> #### Implementation of[​](#implementation-of-710 "Direct link to Implementation of") `WorkspacesBindings.requestWorkspaceMembership` *** ### resendCode()[​](#resendcode "Direct link to resendCode()") > **resendCode**: (`phoneNumber`, `organizationUuid?`) => `Promise`<[`SMSLoginResponse`](https://docs.gravityrail.com/sdk/interfaces/SMSLoginResponse.md)> Defined in: [packages/sdk/src/client/client.ts:489](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L489) Resend the SMS verification code to the given phone number. #### Parameters[​](#parameters-691 "Direct link to Parameters") ##### phoneNumber[​](#phonenumber-3 "Direct link to phoneNumber") `string` ##### organizationUuid?[​](#organizationuuid-5 "Direct link to organizationUuid?") `string` #### Returns[​](#returns-712 "Direct link to Returns") `Promise`<[`SMSLoginResponse`](https://docs.gravityrail.com/sdk/interfaces/SMSLoginResponse.md)> #### Implementation of[​](#implementation-of-711 "Direct link to Implementation of") `AuthBindings.resendCode` *** ### resetRoutineRuns()[​](#resetroutineruns "Direct link to resetRoutineRuns()") > **resetRoutineRuns**: (`wid`, `routineId`) => `Promise`<{ `deletedRunsCount`: `number`; `message`: `string`; `status`: `string`; }> Defined in: [packages/sdk/src/client/client.ts:641](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L641) Delete all run history for a routine. #### Parameters[​](#parameters-692 "Direct link to Parameters") ##### wid[​](#wid-572 "Direct link to wid") `string` ##### routineId[​](#routineid-1 "Direct link to routineId") `number` #### Returns[​](#returns-713 "Direct link to Returns") `Promise`<{ `deletedRunsCount`: `number`; `message`: `string`; `status`: `string`; }> #### Implementation of[​](#implementation-of-712 "Direct link to Implementation of") `EventsBindings.resetRoutineRuns` *** ### resetSiteSource()[​](#resetsitesource "Direct link to resetSiteSource()") > **resetSiteSource**: (`wid`, `siteId`, `options`) => `Promise`<[`SiteSource`](https://docs.gravityrail.com/sdk/interfaces/SiteSource.md)> Defined in: [packages/sdk/src/client/client.ts:553](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L553) 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[​](#parameters-693 "Direct link to Parameters") ##### wid[​](#wid-573 "Direct link to wid") `string` ##### siteId[​](#siteid-22 "Direct link to siteId") `number` ##### options[​](#options-54 "Direct link to options") ###### deleteExisting[​](#deleteexisting "Direct link to deleteExisting") `boolean` ###### loadDefaults[​](#loaddefaults "Direct link to loadDefaults") `boolean` ###### template?[​](#template "Direct link to template?") `string` #### Returns[​](#returns-714 "Direct link to Returns") `Promise`<[`SiteSource`](https://docs.gravityrail.com/sdk/interfaces/SiteSource.md)> #### Implementation of[​](#implementation-of-713 "Direct link to Implementation of") `SitesBindings.resetSiteSource` *** ### resolveAccessGrant()[​](#resolveaccessgrant "Direct link to resolveAccessGrant()") > **resolveAccessGrant**: (`wid`, `uuid`, `data`) => `Promise`<[`AccessGrant`](https://docs.gravityrail.com/sdk/type-aliases/AccessGrant.md)> Defined in: [packages/sdk/src/client/client.ts:390](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L390) Resolve a pending access grant by approving or denying it. #### Parameters[​](#parameters-694 "Direct link to Parameters") ##### wid[​](#wid-574 "Direct link to wid") `string` ##### uuid[​](#uuid-32 "Direct link to uuid") `string` ##### data[​](#data-86 "Direct link to data") [`ResolveGrantRequest`](https://docs.gravityrail.com/sdk/interfaces/ResolveGrantRequest.md) #### Returns[​](#returns-715 "Direct link to Returns") `Promise`<[`AccessGrant`](https://docs.gravityrail.com/sdk/type-aliases/AccessGrant.md)> #### Implementation of[​](#implementation-of-714 "Direct link to Implementation of") `AccessGrantsBindings.resolveAccessGrant` *** ### resolveAgentTools()[​](#resolveagenttools "Direct link to resolveAgentTools()") > **resolveAgentTools**: (`wid`, `id`, `options`) => `Promise`<[`ToolsResponse`](https://docs.gravityrail.com/sdk/interfaces/ToolsResponse.md)> Defined in: [packages/sdk/src/client/client.ts:293](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L293) Resolve runtime tools for an agent on a simulated channel. #### Parameters[​](#parameters-695 "Direct link to Parameters") ##### wid[​](#wid-575 "Direct link to wid") `string` ##### id[​](#id-80 "Direct link to id") `number` ##### options[​](#options-55 "Direct link to options") ###### channel[​](#channel "Direct link to channel") `string` ###### taskId?[​](#taskid-4 "Direct link to taskId?") `number` ###### taskUuid?[​](#taskuuid-3 "Direct link to taskUuid?") `string` #### Returns[​](#returns-716 "Direct link to Returns") `Promise`<[`ToolsResponse`](https://docs.gravityrail.com/sdk/interfaces/ToolsResponse.md)> #### Implementation of[​](#implementation-of-715 "Direct link to Implementation of") `AgentsBindings.resolveAgentTools` *** ### resolveAnonymousMember()[​](#resolveanonymousmember "Direct link to resolveAnonymousMember()") > **resolveAnonymousMember**: (`wid`, `resolutionId`, `request`) => `Promise`<[`AnonymousMemberResolutionResponse`](https://docs.gravityrail.com/sdk/interfaces/AnonymousMemberResolutionResponse.md)> Defined in: [packages/sdk/src/client/client.ts:269](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L269) 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[​](#parameters-696 "Direct link to Parameters") ##### wid[​](#wid-576 "Direct link to wid") `string` ##### resolutionId[​](#resolutionid-2 "Direct link to resolutionId") `number` ##### request[​](#request-20 "Direct link to request") [`ResolveAnonymousMemberRequest`](https://docs.gravityrail.com/sdk/interfaces/ResolveAnonymousMemberRequest.md) #### Returns[​](#returns-717 "Direct link to Returns") `Promise`<[`AnonymousMemberResolutionResponse`](https://docs.gravityrail.com/sdk/interfaces/AnonymousMemberResolutionResponse.md)> #### Implementation of[​](#implementation-of-716 "Direct link to Implementation of") `MembersBindings.resolveAnonymousMember` *** ### revokeAccessGrant()[​](#revokeaccessgrant "Direct link to revokeAccessGrant()") > **revokeAccessGrant**: (`wid`, `uuid`, `data`) => `Promise`<[`AccessGrant`](https://docs.gravityrail.com/sdk/type-aliases/AccessGrant.md)> Defined in: [packages/sdk/src/client/client.ts:391](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L391) Revoke a previously approved access grant. #### Parameters[​](#parameters-697 "Direct link to Parameters") ##### wid[​](#wid-577 "Direct link to wid") `string` ##### uuid[​](#uuid-33 "Direct link to uuid") `string` ##### data[​](#data-87 "Direct link to data") [`RevokeGrantRequest`](https://docs.gravityrail.com/sdk/interfaces/RevokeGrantRequest.md) #### Returns[​](#returns-718 "Direct link to Returns") `Promise`<[`AccessGrant`](https://docs.gravityrail.com/sdk/type-aliases/AccessGrant.md)> #### Implementation of[​](#implementation-of-717 "Direct link to Implementation of") `AccessGrantsBindings.revokeAccessGrant` *** ### revokeApiKey()[​](#revokeapikey "Direct link to revokeApiKey()") > **revokeApiKey**: (`wid`, `id`) => `Promise`<`void`> Defined in: [packages/sdk/src/client/client.ts:808](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L808) Revoke a workspace API key. #### Parameters[​](#parameters-698 "Direct link to Parameters") ##### wid[​](#wid-578 "Direct link to wid") `string` ##### id[​](#id-81 "Direct link to id") `number` #### Returns[​](#returns-719 "Direct link to Returns") `Promise`<`void`> #### Implementation of[​](#implementation-of-718 "Direct link to Implementation of") `BillingBindings.revokeApiKey` *** ### revokeGlobalApiKey()[​](#revokeglobalapikey "Direct link to revokeGlobalApiKey()") > **revokeGlobalApiKey**: (`id`) => `Promise`<`void`> Defined in: [packages/sdk/src/client/client.ts:811](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L811) Revoke an account-level API key. #### Parameters[​](#parameters-699 "Direct link to Parameters") ##### id[​](#id-82 "Direct link to id") `number` #### Returns[​](#returns-720 "Direct link to Returns") `Promise`<`void`> #### Implementation of[​](#implementation-of-719 "Direct link to Implementation of") `BillingBindings.revokeGlobalApiKey` *** ### revokeICalToken()[​](#revokeicaltoken "Direct link to revokeICalToken()") > **revokeICalToken**: (`wid`, `calendarId`) => `Promise`<{ `message`: `string`; `success`: `boolean`; }> Defined in: [packages/sdk/src/client/client.ts:717](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L717) Revoke the iCal feed token for a calendar, disabling external feed access. #### Parameters[​](#parameters-700 "Direct link to Parameters") ##### wid[​](#wid-579 "Direct link to wid") `string` ##### calendarId[​](#calendarid-8 "Direct link to calendarId") `number` #### Returns[​](#returns-721 "Direct link to Returns") `Promise`<{ `message`: `string`; `success`: `boolean`; }> #### Implementation of[​](#implementation-of-720 "Direct link to Implementation of") `CalendarsBindings.revokeICalToken` *** ### rollbackSiteSource()[​](#rollbacksitesource "Direct link to rollbackSiteSource()") > **rollbackSiteSource**: (`wid`, `siteId`, `releaseUuid`) => `Promise`<[`SiteSource`](https://docs.gravityrail.com/sdk/interfaces/SiteSource.md)> Defined in: [packages/sdk/src/client/client.ts:554](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L554) 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[​](#parameters-701 "Direct link to Parameters") ##### wid[​](#wid-580 "Direct link to wid") `string` ##### siteId[​](#siteid-23 "Direct link to siteId") `number` ##### releaseUuid[​](#releaseuuid "Direct link to releaseUuid") `string` #### Returns[​](#returns-722 "Direct link to Returns") `Promise`<[`SiteSource`](https://docs.gravityrail.com/sdk/interfaces/SiteSource.md)> #### Implementation of[​](#implementation-of-721 "Direct link to Implementation of") `SitesBindings.rollbackSiteSource` *** ### runQuery()[​](#runquery "Direct link to runQuery()") > **runQuery**: (`wid`, `query`, `mode?`) => `Promise`<[`RunQueryResponse`](https://docs.gravityrail.com/sdk/interfaces/RunQueryResponse.md)> Defined in: [packages/sdk/src/client/client.ts:316](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L316) Execute a query (rows / count / aggregate). #### Parameters[​](#parameters-702 "Direct link to Parameters") ##### wid[​](#wid-581 "Direct link to wid") `string` ##### query[​](#query-3 "Direct link to query") [`QueryIR`](https://docs.gravityrail.com/sdk/interfaces/QueryIR.md) ##### mode?[​](#mode-2 "Direct link to mode?") [`QueryRunMode`](https://docs.gravityrail.com/sdk/type-aliases/QueryRunMode.md) #### Returns[​](#returns-723 "Direct link to Returns") `Promise`<[`RunQueryResponse`](https://docs.gravityrail.com/sdk/interfaces/RunQueryResponse.md)> #### Implementation of[​](#implementation-of-722 "Direct link to Implementation of") `QueriesBindings.runQuery` *** ### runRoutine()[​](#runroutine "Direct link to runRoutine()") > **runRoutine**: (`wid`, `id`, `params`) => `Promise`<{ `message`: `string`; `status`: `string`; }> Defined in: [packages/sdk/src/client/client.ts:639](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L639) Manually trigger a routine for a specific member or member filter. #### Parameters[​](#parameters-703 "Direct link to Parameters") ##### wid[​](#wid-582 "Direct link to wid") `string` ##### id[​](#id-83 "Direct link to id") `number` ##### params[​](#params-42 "Direct link to params") ###### memberFilterId?[​](#memberfilterid-1 "Direct link to memberFilterId?") `number` ###### memberId?[​](#memberid-29 "Direct link to memberId?") `number` #### Returns[​](#returns-724 "Direct link to Returns") `Promise`<{ `message`: `string`; `status`: `string`; }> #### Implementation of[​](#implementation-of-723 "Direct link to Implementation of") `EventsBindings.runRoutine` *** ### searchEventRules()[​](#searcheventrules "Direct link to searchEventRules()") > **searchEventRules**: (`wid`, `params`) => `Promise`<[`EventRuleResponse`](https://docs.gravityrail.com/sdk/type-aliases/EventRuleResponse.md)\[]> Defined in: [packages/sdk/src/client/client.ts:625](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L625) Search event rules by object type, event type, action type, and related entities. #### Parameters[​](#parameters-704 "Direct link to Parameters") ##### wid[​](#wid-583 "Direct link to wid") `string` ##### params[​](#params-43 "Direct link to params") ###### actionType?[​](#actiontype "Direct link to actionType?") [`EventRuleActionType`](https://docs.gravityrail.com/sdk/enumerations/EventRuleActionType.md) ###### dataTypeId?[​](#datatypeid-5 "Direct link to dataTypeId?") `number` ###### eventType?[​](#eventtype-1 "Direct link to eventType?") [`EventRuleEventType`](https://docs.gravityrail.com/sdk/enumerations/EventRuleEventType.md) ###### includeDisabled?[​](#includedisabled "Direct link to includeDisabled?") `boolean` ###### journeyStepId?[​](#journeystepid "Direct link to journeyStepId?") `number` ###### objectType?[​](#objecttype "Direct link to objectType?") [`EventRuleObjectType`](https://docs.gravityrail.com/sdk/enumerations/EventRuleObjectType.md) ###### routineId?[​](#routineid-2 "Direct link to routineId?") `number` ###### taskId?[​](#taskid-5 "Direct link to taskId?") `number` ###### workflowId?[​](#workflowid-15 "Direct link to workflowId?") `number` #### Returns[​](#returns-725 "Direct link to Returns") `Promise`<[`EventRuleResponse`](https://docs.gravityrail.com/sdk/type-aliases/EventRuleResponse.md)\[]> #### Implementation of[​](#implementation-of-724 "Direct link to Implementation of") `EventsBindings.searchEventRules` *** ### searchFolder()[​](#searchfolder "Direct link to searchFolder()") > **searchFolder**: (`wid`, `id`, `params`) => `Promise`<[`FolderSearchResultResponse`](https://docs.gravityrail.com/sdk/interfaces/FolderSearchResultResponse.md)\[]> Defined in: [packages/sdk/src/client/client.ts:602](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L602) Search for content within a folder using semantic search. #### Parameters[​](#parameters-705 "Direct link to Parameters") ##### wid[​](#wid-584 "Direct link to wid") `string` ##### id[​](#id-84 "Direct link to id") `number` ##### params[​](#params-44 "Direct link to params") [`FolderSearchParams`](https://docs.gravityrail.com/sdk/interfaces/FolderSearchParams.md) #### Returns[​](#returns-726 "Direct link to Returns") `Promise`<[`FolderSearchResultResponse`](https://docs.gravityrail.com/sdk/interfaces/FolderSearchResultResponse.md)\[]> #### Implementation of[​](#implementation-of-725 "Direct link to Implementation of") `FilesBindings.searchFolder` *** ### searchHubspotRecords()[​](#searchhubspotrecords "Direct link to searchHubspotRecords()") > **searchHubspotRecords**: (`wid`, `data`) => `Promise`<[`HubSpotSearchResponse`](https://docs.gravityrail.com/sdk/interfaces/HubSpotSearchResponse.md)> Defined in: [packages/sdk/src/client/client.ts:1014](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L1014) #### Parameters[​](#parameters-706 "Direct link to Parameters") ##### wid[​](#wid-585 "Direct link to wid") `string` ##### data[​](#data-88 "Direct link to data") [`HubSpotSearchRequest`](https://docs.gravityrail.com/sdk/interfaces/HubSpotSearchRequest.md) #### Returns[​](#returns-727 "Direct link to Returns") `Promise`<[`HubSpotSearchResponse`](https://docs.gravityrail.com/sdk/interfaces/HubSpotSearchResponse.md)> #### Implementation of[​](#implementation-of-726 "Direct link to Implementation of") `IntegrationsBindings.searchHubspotRecords` *** ### searchSalesforceRecords()[​](#searchsalesforcerecords "Direct link to searchSalesforceRecords()") > **searchSalesforceRecords**: (`wid`, `data`) => `Promise`<[`SalesforceSearchResponse`](https://docs.gravityrail.com/sdk/interfaces/SalesforceSearchResponse.md)> Defined in: [packages/sdk/src/client/client.ts:998](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L998) #### Parameters[​](#parameters-707 "Direct link to Parameters") ##### wid[​](#wid-586 "Direct link to wid") `string` ##### data[​](#data-89 "Direct link to data") [`SalesforceSearchRequest`](https://docs.gravityrail.com/sdk/interfaces/SalesforceSearchRequest.md) #### Returns[​](#returns-728 "Direct link to Returns") `Promise`<[`SalesforceSearchResponse`](https://docs.gravityrail.com/sdk/interfaces/SalesforceSearchResponse.md)> #### Implementation of[​](#implementation-of-727 "Direct link to Implementation of") `IntegrationsBindings.searchSalesforceRecords` *** ### selectCurrentAssignmentTask()[​](#selectcurrentassignmenttask "Direct link to selectCurrentAssignmentTask()") > **selectCurrentAssignmentTask**: (`wid`, `id`, `assignmentTaskId`) => `Promise`<`void`> Defined in: [packages/sdk/src/client/client.ts:533](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L533) Set the current active task for an assignment. #### Parameters[​](#parameters-708 "Direct link to Parameters") ##### wid[​](#wid-587 "Direct link to wid") `string` ##### id[​](#id-85 "Direct link to id") `number` ##### assignmentTaskId[​](#assignmenttaskid-1 "Direct link to assignmentTaskId") `number` #### Returns[​](#returns-729 "Direct link to Returns") `Promise`<`void`> #### Implementation of[​](#implementation-of-728 "Direct link to Implementation of") `AuthBindings.selectCurrentAssignmentTask` *** ### sendAssistantMessage()[​](#sendassistantmessage "Direct link to 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](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L163) Send a message as the assistant in a chat, optionally including tool calls. #### Parameters[​](#parameters-709 "Direct link to Parameters") ##### wid[​](#wid-588 "Direct link to wid") `string` ##### chatId[​](#chatid-20 "Direct link to chatId") `string` | `number` ##### message[​](#message-3 "Direct link to message") `string` ##### toolCalls?[​](#toolcalls "Direct link to toolCalls?") `object`\[] #### Returns[​](#returns-730 "Direct link to Returns") `Promise`<{ `content`: `string`; `message`: `string`; `message_id`: `string`; `message_uuid`: `string`; `received_at`: `string` | `null`; `role`: `string`; `success`: `boolean`; }> #### Implementation of[​](#implementation-of-729 "Direct link to Implementation of") `ChatsBindings.sendAssistantMessage` *** ### sendChatMessage()[​](#sendchatmessage "Direct link to sendChatMessage()") > **sendChatMessage**: (`wid`, `chatId`, `content`) => `Promise`<[`ChatMessage`](https://docs.gravityrail.com/sdk/interfaces/ChatMessage.md)> Defined in: [packages/sdk/src/client/client.ts:170](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L170) Send a user message in a chat (works for DM and regular chats). #### Parameters[​](#parameters-710 "Direct link to Parameters") ##### wid[​](#wid-589 "Direct link to wid") `string` ##### chatId[​](#chatid-21 "Direct link to chatId") `number` ##### content[​](#content-2 "Direct link to content") `string` #### Returns[​](#returns-731 "Direct link to Returns") `Promise`<[`ChatMessage`](https://docs.gravityrail.com/sdk/interfaces/ChatMessage.md)> #### Implementation of[​](#implementation-of-730 "Direct link to Implementation of") `ChatsBindings.sendChatMessage` *** ### sendEmailVerification()[​](#sendemailverification "Direct link to sendEmailVerification()") > **sendEmailVerification**: (`email`, `organizationUuid?`) => `Promise`<[`SMSLoginResponse`](https://docs.gravityrail.com/sdk/interfaces/SMSLoginResponse.md)> Defined in: [packages/sdk/src/client/client.ts:495](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L495) Send a verification code to the given email address for login. #### Parameters[​](#parameters-711 "Direct link to Parameters") ##### email[​](#email-5 "Direct link to email") `string` ##### organizationUuid?[​](#organizationuuid-6 "Direct link to organizationUuid?") `string` #### Returns[​](#returns-732 "Direct link to Returns") `Promise`<[`SMSLoginResponse`](https://docs.gravityrail.com/sdk/interfaces/SMSLoginResponse.md)> #### Implementation of[​](#implementation-of-731 "Direct link to Implementation of") `AuthBindings.sendEmailVerification` *** ### sendMemberPhoneConfirmation()[​](#sendmemberphoneconfirmation "Direct link to sendMemberPhoneConfirmation()") > **sendMemberPhoneConfirmation**: (`wid`, `memberId`) => `Promise`<{ `status`: `string`; }> Defined in: [packages/sdk/src/client/client.ts:231](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L231) 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[​](#parameters-712 "Direct link to Parameters") ##### wid[​](#wid-590 "Direct link to wid") `string` ##### memberId[​](#memberid-30 "Direct link to memberId") `number` #### Returns[​](#returns-733 "Direct link to Returns") `Promise`<{ `status`: `string`; }> #### Implementation of[​](#implementation-of-732 "Direct link to Implementation of") `MembersBindings.sendMemberPhoneConfirmation` *** ### sendOperatorMessage()[​](#sendoperatormessage "Direct link to 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:383](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L383) Send a message in an operator chat. #### Parameters[​](#parameters-713 "Direct link to Parameters") ##### wid[​](#wid-591 "Direct link to wid") `string` ##### chatId[​](#chatid-22 "Direct link to chatId") `number` ##### content[​](#content-3 "Direct link to content") `string` #### Returns[​](#returns-734 "Direct link to Returns") `Promise`<{ `content`: `string`; `createdAt`: `string` | `null`; `id`: `number`; `role`: `string`; `uuid`: `string` | `null`; }> #### Implementation of[​](#implementation-of-733 "Direct link to Implementation of") `OperatorBindings.sendOperatorMessage` *** ### setDefaultGooglePlatformAccount()[​](#setdefaultgoogleplatformaccount "Direct link to setDefaultGooglePlatformAccount()") > **setDefaultGooglePlatformAccount**: (`wid`, `connectionUuid`, `credentialUuid`) => `Promise`<{ `accounts`: `unknown`\[]; `total`: `number`; }> Defined in: [packages/sdk/src/client/client.ts:1040](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L1040) 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[​](#parameters-714 "Direct link to Parameters") ##### wid[​](#wid-592 "Direct link to wid") `string` ##### connectionUuid[​](#connectionuuid "Direct link to connectionUuid") `string` ##### credentialUuid[​](#credentialuuid-1 "Direct link to credentialUuid") `string` #### Returns[​](#returns-735 "Direct link to Returns") `Promise`<{ `accounts`: `unknown`\[]; `total`: `number`; }> #### Implementation of[​](#implementation-of-734 "Direct link to Implementation of") `IntegrationsBindings.setDefaultGooglePlatformAccount` *** ### setDefaultMyCustomerPaymentMethod()[​](#setdefaultmycustomerpaymentmethod "Direct link to setDefaultMyCustomerPaymentMethod()") > **setDefaultMyCustomerPaymentMethod**: (`uuid`, `paymentMethodId`) => `Promise`<{ `message`: `string`; `success`: `string`; }> Defined in: [packages/sdk/src/client/client.ts:1068](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L1068) #### Parameters[​](#parameters-715 "Direct link to Parameters") ##### uuid[​](#uuid-34 "Direct link to uuid") `string` ##### paymentMethodId[​](#paymentmethodid-2 "Direct link to paymentMethodId") `string` #### Returns[​](#returns-736 "Direct link to Returns") `Promise`<{ `message`: `string`; `success`: `string`; }> #### Implementation of[​](#implementation-of-735 "Direct link to Implementation of") `CustomersBindings.setDefaultMyCustomerPaymentMethod` *** ### setPassword()[​](#setpassword "Direct link to setPassword()") > **setPassword**: (`newPassword`) => `Promise`<{ `message`: `string`; `success`: `boolean`; }> Defined in: [packages/sdk/src/client/client.ts:498](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L498) Set a password for an account that does not yet have one. #### Parameters[​](#parameters-716 "Direct link to Parameters") ##### newPassword[​](#newpassword-1 "Direct link to newPassword") `string` #### Returns[​](#returns-737 "Direct link to Returns") `Promise`<{ `message`: `string`; `success`: `boolean`; }> #### Implementation of[​](#implementation-of-736 "Direct link to Implementation of") `AuthBindings.setPassword` *** ### setupTOTP()[​](#setuptotp "Direct link to setupTOTP()") > **setupTOTP**: (`data`) => `Promise`<[`TOTPSetupResponse`](https://docs.gravityrail.com/sdk/interfaces/TOTPSetupResponse.md)> Defined in: [packages/sdk/src/client/client.ts:507](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L507) Initiate TOTP two-factor setup and receive the secret and QR code URI. #### Parameters[​](#parameters-717 "Direct link to Parameters") ##### data[​](#data-90 "Direct link to data") [`SetupTOTPRequest`](https://docs.gravityrail.com/sdk/interfaces/SetupTOTPRequest.md) #### Returns[​](#returns-738 "Direct link to Returns") `Promise`<[`TOTPSetupResponse`](https://docs.gravityrail.com/sdk/interfaces/TOTPSetupResponse.md)> #### Implementation of[​](#implementation-of-737 "Direct link to Implementation of") `AuthBindings.setupTOTP` *** ### setupWebAuthn()[​](#setupwebauthn "Direct link to setupWebAuthn()") > **setupWebAuthn**: (`data`) => `Promise`<`any`> Defined in: [packages/sdk/src/client/client.ts:509](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L509) Initiate WebAuthn (passkey/security key) two-factor setup. #### Parameters[​](#parameters-718 "Direct link to Parameters") ##### data[​](#data-91 "Direct link to data") [`SetupWebAuthnRequest`](https://docs.gravityrail.com/sdk/interfaces/SetupWebAuthnRequest.md) #### Returns[​](#returns-739 "Direct link to Returns") `Promise`<`any`> #### Implementation of[​](#implementation-of-738 "Direct link to Implementation of") `AuthBindings.setupWebAuthn` *** ### siteGoogleOAuthInitiate()[​](#sitegoogleoauthinitiate "Direct link to siteGoogleOAuthInitiate()") > **siteGoogleOAuthInitiate**: (`wid`, `siteUuid`, `origin`) => `Promise`<{ `authorizationUrl`: `string`; }> Defined in: [packages/sdk/src/client/client.ts:566](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L566) Initiate Google OAuth flow for site-specific authentication. #### Parameters[​](#parameters-719 "Direct link to Parameters") ##### wid[​](#wid-593 "Direct link to wid") `string` ##### siteUuid[​](#siteuuid-4 "Direct link to siteUuid") `string` ##### origin[​](#origin-1 "Direct link to origin") `string` #### Returns[​](#returns-740 "Direct link to Returns") `Promise`<{ `authorizationUrl`: `string`; }> #### Implementation of[​](#implementation-of-739 "Direct link to Implementation of") `SitesBindings.siteGoogleOAuthInitiate` *** ### siteSendEmailCode()[​](#sitesendemailcode "Direct link to siteSendEmailCode()") > **siteSendEmailCode**: (`wid`, `siteUuid`, `email`) => `Promise`<{ `message`: `string`; `success`: `boolean`; }> Defined in: [packages/sdk/src/client/client.ts:564](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L564) Send an email verification code for site-specific authentication. #### Parameters[​](#parameters-720 "Direct link to Parameters") ##### wid[​](#wid-594 "Direct link to wid") `string` ##### siteUuid[​](#siteuuid-5 "Direct link to siteUuid") `string` ##### email[​](#email-6 "Direct link to email") `string` #### Returns[​](#returns-741 "Direct link to Returns") `Promise`<{ `message`: `string`; `success`: `boolean`; }> #### Implementation of[​](#implementation-of-740 "Direct link to Implementation of") `SitesBindings.siteSendEmailCode` *** ### siteSendPhoneCode()[​](#sitesendphonecode "Direct link to siteSendPhoneCode()") > **siteSendPhoneCode**: (`wid`, `siteUuid`, `phoneNumber`) => `Promise`<{ `message`: `string`; `success`: `boolean`; }> Defined in: [packages/sdk/src/client/client.ts:563](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L563) Send a phone verification code for site-specific authentication. #### Parameters[​](#parameters-721 "Direct link to Parameters") ##### wid[​](#wid-595 "Direct link to wid") `string` ##### siteUuid[​](#siteuuid-6 "Direct link to siteUuid") `string` ##### phoneNumber[​](#phonenumber-4 "Direct link to phoneNumber") `string` #### Returns[​](#returns-742 "Direct link to Returns") `Promise`<{ `message`: `string`; `success`: `boolean`; }> #### Implementation of[​](#implementation-of-741 "Direct link to Implementation of") `SitesBindings.siteSendPhoneCode` *** ### siteSignup()[​](#sitesignup "Direct link to siteSignup()") > **siteSignup**: (`wid`, `siteUuid`) => `Promise`<[`SiteSignupResponse`](https://docs.gravityrail.com/sdk/interfaces/SiteSignupResponse.md)> Defined in: [packages/sdk/src/client/client.ts:562](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L562) Sign up a new user through a site's public registration. #### Parameters[​](#parameters-722 "Direct link to Parameters") ##### wid[​](#wid-596 "Direct link to wid") `string` ##### siteUuid[​](#siteuuid-7 "Direct link to siteUuid") `string` #### Returns[​](#returns-743 "Direct link to Returns") `Promise`<[`SiteSignupResponse`](https://docs.gravityrail.com/sdk/interfaces/SiteSignupResponse.md)> #### Implementation of[​](#implementation-of-742 "Direct link to Implementation of") `SitesBindings.siteSignup` *** ### siteVerifyCode()[​](#siteverifycode "Direct link to siteVerifyCode()") > **siteVerifyCode**: (`wid`, `siteUuid`, `code`, `phoneNumber?`, `email?`) => `Promise`<{ `accountId`: `number`; `memberId?`: `number`; `token`: `string`; }> Defined in: [packages/sdk/src/client/client.ts:565](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L565) Verify a phone or email code and complete site authentication. #### Parameters[​](#parameters-723 "Direct link to Parameters") ##### wid[​](#wid-597 "Direct link to wid") `string` ##### siteUuid[​](#siteuuid-8 "Direct link to siteUuid") `string` ##### code[​](#code "Direct link to code") `string` ##### phoneNumber?[​](#phonenumber-5 "Direct link to phoneNumber?") `string` ##### email?[​](#email-7 "Direct link to email?") `string` #### Returns[​](#returns-744 "Direct link to Returns") `Promise`<{ `accountId`: `number`; `memberId?`: `number`; `token`: `string`; }> #### Implementation of[​](#implementation-of-743 "Direct link to Implementation of") `SitesBindings.siteVerifyCode` *** ### skipStep()[​](#skipstep "Direct link to skipStep()") > **skipStep**: (`wid`, `journeyId`, `stepUuid`, `data`) => `Promise`<`MemberJourneyStep`> Defined in: [packages/sdk/src/client/client.ts:349](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L349) Skip a journey step in the current execution context. #### Parameters[​](#parameters-724 "Direct link to Parameters") ##### wid[​](#wid-598 "Direct link to wid") `string` ##### journeyId[​](#journeyid-19 "Direct link to journeyId") `number` ##### stepUuid[​](#stepuuid-3 "Direct link to stepUuid") `string` ##### data?[​](#data-92 "Direct link to data?") `SkipStepFormData` = `{}` #### Returns[​](#returns-745 "Direct link to Returns") `Promise`<`MemberJourneyStep`> #### Implementation of[​](#implementation-of-744 "Direct link to Implementation of") `JourneysBindings.skipStep` *** ### startConfluenceOAuth()[​](#startconfluenceoauth "Direct link to startConfluenceOAuth()") > **startConfluenceOAuth**: (`wid`) => `Promise`<`ConfluenceConnectionStatus`> Defined in: [packages/sdk/src/client/client.ts:973](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L973) #### Parameters[​](#parameters-725 "Direct link to Parameters") ##### wid[​](#wid-599 "Direct link to wid") `string` #### Returns[​](#returns-746 "Direct link to Returns") `Promise`<`ConfluenceConnectionStatus`> #### Implementation of[​](#implementation-of-745 "Direct link to Implementation of") `IntegrationsBindings.startConfluenceOAuth` *** ### startHubspotOAuth()[​](#starthubspotoauth "Direct link to startHubspotOAuth()") > **startHubspotOAuth**: (`wid`) => `Promise`<`HubspotConnectionStatus`> Defined in: [packages/sdk/src/client/client.ts:1003](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L1003) #### Parameters[​](#parameters-726 "Direct link to Parameters") ##### wid[​](#wid-600 "Direct link to wid") `string` #### Returns[​](#returns-747 "Direct link to Returns") `Promise`<`HubspotConnectionStatus`> #### Implementation of[​](#implementation-of-746 "Direct link to Implementation of") `IntegrationsBindings.startHubspotOAuth` *** ### startSalesforceOAuth()[​](#startsalesforceoauth "Direct link to startSalesforceOAuth()") > **startSalesforceOAuth**: (`wid`) => `Promise`<`SalesforceConnectionStatus`> Defined in: [packages/sdk/src/client/client.ts:984](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L984) #### Parameters[​](#parameters-727 "Direct link to Parameters") ##### wid[​](#wid-601 "Direct link to wid") `string` #### Returns[​](#returns-748 "Direct link to Returns") `Promise`<`SalesforceConnectionStatus`> #### Implementation of[​](#implementation-of-747 "Direct link to Implementation of") `IntegrationsBindings.startSalesforceOAuth` *** ### startSyncRun()[​](#startsyncrun "Direct link to startSyncRun()") > **startSyncRun**: (`wid`, `connectionId`, `options?`) => `Promise`<`Response`> Defined in: [packages/sdk/src/client/client.ts:1026](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L1026) 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[​](#parameters-728 "Direct link to Parameters") ##### wid[​](#wid-602 "Direct link to wid") `string` ##### connectionId[​](#connectionid-34 "Direct link to connectionId") `number` ##### options?[​](#options-56 "Direct link to options?") ###### boardId?[​](#boardid-6 "Direct link to boardId?") `string` ###### dryRun?[​](#dryrun-1 "Direct link to dryRun?") `boolean` ###### entityType?[​](#entitytype "Direct link to entityType?") [`SyncEntityType`](https://docs.gravityrail.com/sdk/type-aliases/SyncEntityType.md) ###### recordLimit?[​](#recordlimit "Direct link to recordLimit?") `number` Preview cap (1..200). Server enforces `dryRun=true` when this is set. Omit for uncapped runs. ###### resetCheckpoints?[​](#resetcheckpoints "Direct link to resetCheckpoints?") `boolean` #### Returns[​](#returns-749 "Direct link to Returns") `Promise`<`Response`> #### Implementation of[​](#implementation-of-748 "Direct link to Implementation of") `IntegrationsBindings.startSyncRun` *** ### startTestChatRun()[​](#starttestchatrun "Direct link to startTestChatRun()") > **startTestChatRun**: (`wid`, `workflowId`, `data`) => `Promise`<[`StartTestChatRunResponse`](https://docs.gravityrail.com/sdk/interfaces/StartTestChatRunResponse.md)> Defined in: [packages/sdk/src/client/client.ts:307](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L307) #### Parameters[​](#parameters-729 "Direct link to Parameters") ##### wid[​](#wid-603 "Direct link to wid") `string` ##### workflowId[​](#workflowid-16 "Direct link to workflowId") `number` ##### data?[​](#data-93 "Direct link to data?") [`StartTestChatRunRequest`](https://docs.gravityrail.com/sdk/interfaces/StartTestChatRunRequest.md) = `{}` #### Returns[​](#returns-750 "Direct link to Returns") `Promise`<[`StartTestChatRunResponse`](https://docs.gravityrail.com/sdk/interfaces/StartTestChatRunResponse.md)> #### Implementation of[​](#implementation-of-749 "Direct link to Implementation of") `QualificationsBindings.startTestChatRun` *** ### submitBusinessProfile()[​](#submitbusinessprofile "Direct link to submitBusinessProfile()") > **submitBusinessProfile**: (`orgUuid`) => `Promise`<[`BusinessProfileSubmitResponse`](https://docs.gravityrail.com/sdk/interfaces/BusinessProfileSubmitResponse.md)> Defined in: [packages/sdk/src/client/client.ts:463](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L463) 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[​](#parameters-730 "Direct link to Parameters") ##### orgUuid[​](#orguuid-11 "Direct link to orgUuid") `string` #### Returns[​](#returns-751 "Direct link to Returns") `Promise`<[`BusinessProfileSubmitResponse`](https://docs.gravityrail.com/sdk/interfaces/BusinessProfileSubmitResponse.md)> #### Implementation of[​](#implementation-of-750 "Direct link to Implementation of") `OrgBindings.submitBusinessProfile` *** ### suggestPronunciations()[​](#suggestpronunciations "Direct link to suggestPronunciations()") > **suggestPronunciations**: (`term`, `language?`) => `Promise`<`string`\[]> Defined in: [packages/sdk/src/client/client.ts:1053](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L1053) Get AI-suggested respellings for a given term. #### Parameters[​](#parameters-731 "Direct link to Parameters") ##### term[​](#term "Direct link to term") `string` ##### language?[​](#language "Direct link to language?") `string` #### Returns[​](#returns-752 "Direct link to Returns") `Promise`<`string`\[]> #### Implementation of[​](#implementation-of-751 "Direct link to Implementation of") `PronunciationsBindings.suggestPronunciations` *** ### summarizeChat()[​](#summarizechat "Direct link to summarizeChat()") > **summarizeChat**: (`wid`, `id`, `updateLabels?`) => `Promise`<[`ChatResponse`](https://docs.gravityrail.com/sdk/interfaces/ChatResponse.md)> Defined in: [packages/sdk/src/client/client.ts:158](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L158) Generate an AI summary for a chat, optionally updating its labels. #### Parameters[​](#parameters-732 "Direct link to Parameters") ##### wid[​](#wid-604 "Direct link to wid") `string` ##### id[​](#id-86 "Direct link to id") `number` ##### updateLabels?[​](#updatelabels "Direct link to updateLabels?") `boolean` #### Returns[​](#returns-753 "Direct link to Returns") `Promise`<[`ChatResponse`](https://docs.gravityrail.com/sdk/interfaces/ChatResponse.md)> #### Implementation of[​](#implementation-of-752 "Direct link to Implementation of") `ChatsBindings.summarizeChat` *** ### switchMember()[​](#switchmember "Direct link to switchMember()") > **switchMember**: (`wid`, `memberUuid`) => `Promise`<[`WorkspaceMemberResponse`](https://docs.gravityrail.com/sdk/interfaces/WorkspaceMemberResponse.md)> Defined in: [packages/sdk/src/client/client.ts:221](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L221) 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[​](#parameters-733 "Direct link to Parameters") ##### wid[​](#wid-605 "Direct link to wid") `string` ##### memberUuid[​](#memberuuid "Direct link to memberUuid") `string` #### Returns[​](#returns-754 "Direct link to Returns") `Promise`<[`WorkspaceMemberResponse`](https://docs.gravityrail.com/sdk/interfaces/WorkspaceMemberResponse.md)> #### Implementation of[​](#implementation-of-753 "Direct link to Implementation of") `MembersBindings.switchMember` *** ### syncCalendarWithGoogle()[​](#synccalendarwithgoogle "Direct link to syncCalendarWithGoogle()") > **syncCalendarWithGoogle**: (`wid`, `calendarId`) => `Promise`<[`SyncCalendarResponse`](https://docs.gravityrail.com/sdk/interfaces/SyncCalendarResponse.md)> Defined in: [packages/sdk/src/client/client.ts:723](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L723) Trigger a manual sync between a calendar and its linked Google Calendar. #### Parameters[​](#parameters-734 "Direct link to Parameters") ##### wid[​](#wid-606 "Direct link to wid") `string` ##### calendarId[​](#calendarid-9 "Direct link to calendarId") `number` #### Returns[​](#returns-755 "Direct link to Returns") `Promise`<[`SyncCalendarResponse`](https://docs.gravityrail.com/sdk/interfaces/SyncCalendarResponse.md)> #### Implementation of[​](#implementation-of-754 "Direct link to Implementation of") `CalendarsBindings.syncCalendarWithGoogle` *** ### syncCalendarWithHealthie()[​](#synccalendarwithhealthie "Direct link to syncCalendarWithHealthie()") > **syncCalendarWithHealthie**: (`wid`, `calendarId`) => `Promise`<`LinkCalendarToHealthieResponse`> Defined in: [packages/sdk/src/client/client.ts:961](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L961) #### Parameters[​](#parameters-735 "Direct link to Parameters") ##### wid[​](#wid-607 "Direct link to wid") `string` ##### calendarId[​](#calendarid-10 "Direct link to calendarId") `number` #### Returns[​](#returns-756 "Direct link to Returns") `Promise`<`LinkCalendarToHealthieResponse`> #### Implementation of[​](#implementation-of-755 "Direct link to Implementation of") `IntegrationsBindings.syncCalendarWithHealthie` *** ### testFhirConnection()[​](#testfhirconnection "Direct link to testFhirConnection()") > **testFhirConnection**: (`wid`, `connectionId`) => `Promise`<{ `message`: `string`; `success`: `boolean`; }> Defined in: [packages/sdk/src/client/client.ts:927](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L927) Test a FHIR connection. #### Parameters[​](#parameters-736 "Direct link to Parameters") ##### wid[​](#wid-608 "Direct link to wid") `string` ##### connectionId[​](#connectionid-35 "Direct link to connectionId") `number` #### Returns[​](#returns-757 "Direct link to Returns") `Promise`<{ `message`: `string`; `success`: `boolean`; }> #### Implementation of[​](#implementation-of-756 "Direct link to Implementation of") `IntegrationsBindings.testFhirConnection` *** ### testMcpServerConnection()[​](#testmcpserverconnection "Direct link to testMcpServerConnection()") > **testMcpServerConnection**: (`wid`, `serverId`) => `Promise`<[`McpTestConnectionResponse`](https://docs.gravityrail.com/sdk/interfaces/McpTestConnectionResponse.md)> Defined in: [packages/sdk/src/client/client.ts:799](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L799) Test connection to an MCP server. #### Parameters[​](#parameters-737 "Direct link to Parameters") ##### wid[​](#wid-609 "Direct link to wid") `string` ##### serverId[​](#serverid-7 "Direct link to serverId") `number` #### Returns[​](#returns-758 "Direct link to Returns") `Promise`<[`McpTestConnectionResponse`](https://docs.gravityrail.com/sdk/interfaces/McpTestConnectionResponse.md)> #### Implementation of[​](#implementation-of-757 "Direct link to Implementation of") `ToolkitsBindings.testMcpServerConnection` *** ### testMondayConnection()[​](#testmondayconnection "Direct link to testMondayConnection()") > **testMondayConnection**: (`wid`) => `Promise`<{ `accountName?`: `string`; `status`: `string`; `userName?`: `string`; }> Defined in: [packages/sdk/src/client/client.ts:866](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L866) #### Parameters[​](#parameters-738 "Direct link to Parameters") ##### wid[​](#wid-610 "Direct link to wid") `string` #### Returns[​](#returns-759 "Direct link to Returns") `Promise`<{ `accountName?`: `string`; `status`: `string`; `userName?`: `string`; }> #### Implementation of[​](#implementation-of-758 "Direct link to Implementation of") `IntegrationsBindings.testMondayConnection` *** ### testRunJourney()[​](#testrunjourney "Direct link to testRunJourney()") > **testRunJourney**: (`wid`, `journeyId`, `memberId`) => `Promise`<`JourneyTestRunResponse`> Defined in: [packages/sdk/src/client/client.ts:350](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L350) 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[​](#parameters-739 "Direct link to Parameters") ##### wid[​](#wid-611 "Direct link to wid") `string` ##### journeyId[​](#journeyid-20 "Direct link to journeyId") `number` ##### memberId[​](#memberid-31 "Direct link to memberId") `number` #### Returns[​](#returns-760 "Direct link to Returns") `Promise`<`JourneyTestRunResponse`> #### Implementation of[​](#implementation-of-759 "Direct link to Implementation of") `JourneysBindings.testRunJourney` *** ### testWebhook()[​](#testwebhook "Direct link to testWebhook()") > **testWebhook**: (`wid`, `id`, `request`) => `Promise`<[`TestWebhookResponse`](https://docs.gravityrail.com/sdk/interfaces/TestWebhookResponse.md)> Defined in: [packages/sdk/src/client/client.ts:630](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L630) Send a one-off test webhook for an existing webhook event rule. #### Parameters[​](#parameters-740 "Direct link to Parameters") ##### wid[​](#wid-612 "Direct link to wid") `string` ##### id[​](#id-87 "Direct link to id") `number` ##### request[​](#request-21 "Direct link to request") [`TestWebhookRequest`](https://docs.gravityrail.com/sdk/interfaces/TestWebhookRequest.md) #### Returns[​](#returns-761 "Direct link to Returns") `Promise`<[`TestWebhookResponse`](https://docs.gravityrail.com/sdk/interfaces/TestWebhookResponse.md)> #### Implementation of[​](#implementation-of-760 "Direct link to Implementation of") `EventsBindings.testWebhook` *** ### toggleFieldIndex()[​](#togglefieldindex "Direct link to toggleFieldIndex()") > **toggleFieldIndex**: (`wid`, `dataTypeId`, `fieldSlug`, `shouldIndex`) => `Promise`<{ `indexStatus?`: `string`; `message`: `string`; `status`: `string`; }> Defined in: [packages/sdk/src/client/client.ts:213](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L213) Toggle search indexing for a data type field. #### Parameters[​](#parameters-741 "Direct link to Parameters") ##### wid[​](#wid-613 "Direct link to wid") `string` ##### dataTypeId[​](#datatypeid-6 "Direct link to dataTypeId") `number` ##### fieldSlug[​](#fieldslug-1 "Direct link to fieldSlug") `string` ##### shouldIndex[​](#shouldindex "Direct link to shouldIndex") `boolean` #### Returns[​](#returns-762 "Direct link to Returns") `Promise`<{ `indexStatus?`: `string`; `message`: `string`; `status`: `string`; }> #### Implementation of[​](#implementation-of-761 "Direct link to Implementation of") `DataTypesBindings.toggleFieldIndex` *** ### unarchiveAgent()[​](#unarchiveagent "Direct link to unarchiveAgent()") > **unarchiveAgent**: (`wid`, `id`) => `Promise`<[`AgentResponse`](https://docs.gravityrail.com/sdk/interfaces/AgentResponse.md)> Defined in: [packages/sdk/src/client/client.ts:292](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L292) Restore an archived agent back to active status. #### Parameters[​](#parameters-742 "Direct link to Parameters") ##### wid[​](#wid-614 "Direct link to wid") `string` ##### id[​](#id-88 "Direct link to id") `number` #### Returns[​](#returns-763 "Direct link to Returns") `Promise`<[`AgentResponse`](https://docs.gravityrail.com/sdk/interfaces/AgentResponse.md)> #### Implementation of[​](#implementation-of-762 "Direct link to Implementation of") `AgentsBindings.unarchiveAgent` *** ### unarchiveChat()[​](#unarchivechat "Direct link to unarchiveChat()") > **unarchiveChat**: (`wid`, `id`) => `Promise`<`void`> Defined in: [packages/sdk/src/client/client.ts:151](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L151) Unarchive a chat. #### Parameters[​](#parameters-743 "Direct link to Parameters") ##### wid[​](#wid-615 "Direct link to wid") `string` ##### id[​](#id-89 "Direct link to id") `number` #### Returns[​](#returns-764 "Direct link to Returns") `Promise`<`void`> #### Implementation of[​](#implementation-of-763 "Direct link to Implementation of") `ChatsBindings.unarchiveChat` *** ### unarchiveDataType()[​](#unarchivedatatype "Direct link to unarchiveDataType()") > **unarchiveDataType**: (`wid`, `id`) => `Promise`<{ `status`: `string`; }> Defined in: [packages/sdk/src/client/client.ts:204](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L204) Restore an archived data type back to active status. #### Parameters[​](#parameters-744 "Direct link to Parameters") ##### wid[​](#wid-616 "Direct link to wid") `string` ##### id[​](#id-90 "Direct link to id") `number` #### Returns[​](#returns-765 "Direct link to Returns") `Promise`<{ `status`: `string`; }> #### Implementation of[​](#implementation-of-764 "Direct link to Implementation of") `DataTypesBindings.unarchiveDataType` *** ### unarchiveMember()[​](#unarchivemember "Direct link to unarchiveMember()") > **unarchiveMember**: (`wid`, `memberId`) => `Promise`<[`WorkspaceMemberResponse`](https://docs.gravityrail.com/sdk/interfaces/WorkspaceMemberResponse.md)> Defined in: [packages/sdk/src/client/client.ts:230](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L230) Unarchive a previously archived workspace member. #### Parameters[​](#parameters-745 "Direct link to Parameters") ##### wid[​](#wid-617 "Direct link to wid") `string` ##### memberId[​](#memberid-32 "Direct link to memberId") `number` #### Returns[​](#returns-766 "Direct link to Returns") `Promise`<[`WorkspaceMemberResponse`](https://docs.gravityrail.com/sdk/interfaces/WorkspaceMemberResponse.md)> #### Implementation of[​](#implementation-of-765 "Direct link to Implementation of") `MembersBindings.unarchiveMember` *** ### unarchiveTask()[​](#unarchivetask "Direct link to unarchiveTask()") > **unarchiveTask**: (`wid`, `id`) => `Promise`<[`Task`](https://docs.gravityrail.com/sdk/type-aliases/Task.md)> Defined in: [packages/sdk/src/client/client.ts:130](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L130) Restore an archived task back to active status. #### Parameters[​](#parameters-746 "Direct link to Parameters") ##### wid[​](#wid-618 "Direct link to wid") `string` ##### id[​](#id-91 "Direct link to id") `number` #### Returns[​](#returns-767 "Direct link to Returns") `Promise`<[`Task`](https://docs.gravityrail.com/sdk/type-aliases/Task.md)> #### Implementation of[​](#implementation-of-766 "Direct link to Implementation of") `TasksBindings.unarchiveTask` *** ### unarchiveWorkflow()[​](#unarchiveworkflow "Direct link to unarchiveWorkflow()") > **unarchiveWorkflow**: (`wid`, `id`) => `Promise`<{ `status`: `string`; }> Defined in: [packages/sdk/src/client/client.ts:656](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L656) Unarchive a previously archived workflow. #### Parameters[​](#parameters-747 "Direct link to Parameters") ##### wid[​](#wid-619 "Direct link to wid") `string` ##### id[​](#id-92 "Direct link to id") `number` #### Returns[​](#returns-768 "Direct link to Returns") `Promise`<{ `status`: `string`; }> #### Implementation of[​](#implementation-of-767 "Direct link to Implementation of") `WorkflowsBindings.unarchiveWorkflow` *** ### unenrollMembers()[​](#unenrollmembers "Direct link to unenrollMembers()") > **unenrollMembers**: (`wid`, `journeyId`, `data`) => `Promise`<`MemberJourney`\[]> Defined in: [packages/sdk/src/client/client.ts:342](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L342) Unenroll one or more members from a journey. #### Parameters[​](#parameters-748 "Direct link to Parameters") ##### wid[​](#wid-620 "Direct link to wid") `string` ##### journeyId[​](#journeyid-21 "Direct link to journeyId") `number` ##### data[​](#data-94 "Direct link to data") `UnenrollMemberFormData` #### Returns[​](#returns-769 "Direct link to Returns") `Promise`<`MemberJourney`\[]> #### Implementation of[​](#implementation-of-768 "Direct link to Implementation of") `JourneysBindings.unenrollMembers` *** ### unlinkCalendarFromGoogle()[​](#unlinkcalendarfromgoogle "Direct link to unlinkCalendarFromGoogle()") > **unlinkCalendarFromGoogle**: (`wid`, `calendarId`) => `Promise`<[`UnlinkCalendarResponse`](https://docs.gravityrail.com/sdk/interfaces/UnlinkCalendarResponse.md)> Defined in: [packages/sdk/src/client/client.ts:722](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L722) Unlink a calendar from its connected Google Calendar. #### Parameters[​](#parameters-749 "Direct link to Parameters") ##### wid[​](#wid-621 "Direct link to wid") `string` ##### calendarId[​](#calendarid-11 "Direct link to calendarId") `number` #### Returns[​](#returns-770 "Direct link to Returns") `Promise`<[`UnlinkCalendarResponse`](https://docs.gravityrail.com/sdk/interfaces/UnlinkCalendarResponse.md)> #### Implementation of[​](#implementation-of-769 "Direct link to Implementation of") `CalendarsBindings.unlinkCalendarFromGoogle` *** ### unlinkCalendarFromHealthie()[​](#unlinkcalendarfromhealthie "Direct link to unlinkCalendarFromHealthie()") > **unlinkCalendarFromHealthie**: (`wid`, `calendarId`) => `Promise`<{ `status`: `string`; }> Defined in: [packages/sdk/src/client/client.ts:960](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L960) #### Parameters[​](#parameters-750 "Direct link to Parameters") ##### wid[​](#wid-622 "Direct link to wid") `string` ##### calendarId[​](#calendarid-12 "Direct link to calendarId") `number` #### Returns[​](#returns-771 "Direct link to Returns") `Promise`<{ `status`: `string`; }> #### Implementation of[​](#implementation-of-770 "Direct link to Implementation of") `IntegrationsBindings.unlinkCalendarFromHealthie` *** ### unlinkCredential()[​](#unlinkcredential "Direct link to unlinkCredential()") > **unlinkCredential**: (`wid`, `credentialId`) => `Promise`<`void`> Defined in: [packages/sdk/src/client/client.ts:898](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L898) Unlink a credential from the current member's account. #### Parameters[​](#parameters-751 "Direct link to Parameters") ##### wid[​](#wid-623 "Direct link to wid") `string` ##### credentialId[​](#credentialid "Direct link to credentialId") `number` #### Returns[​](#returns-772 "Direct link to Returns") `Promise`<`void`> #### Implementation of[​](#implementation-of-771 "Direct link to Implementation of") `IntegrationsBindings.unlinkCredential` *** ### unlinkMemberFromHealthie()[​](#unlinkmemberfromhealthie "Direct link to unlinkMemberFromHealthie()") > **unlinkMemberFromHealthie**: (`wid`, `memberId`) => `Promise`<{ `member_id`: `number`; `status`: `string`; }> Defined in: [packages/sdk/src/client/client.ts:965](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L965) #### Parameters[​](#parameters-752 "Direct link to Parameters") ##### wid[​](#wid-624 "Direct link to wid") `string` ##### memberId[​](#memberid-33 "Direct link to memberId") `number` #### Returns[​](#returns-773 "Direct link to Returns") `Promise`<{ `member_id`: `number`; `status`: `string`; }> #### Implementation of[​](#implementation-of-772 "Direct link to Implementation of") `IntegrationsBindings.unlinkMemberFromHealthie` *** ### unlinkMemberFromHubspot()[​](#unlinkmemberfromhubspot "Direct link to unlinkMemberFromHubspot()") > **unlinkMemberFromHubspot**: (`wid`, `memberId`) => `Promise`<{ `memberId`: `number`; `status`: `string`; }> Defined in: [packages/sdk/src/client/client.ts:1012](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L1012) #### Parameters[​](#parameters-753 "Direct link to Parameters") ##### wid[​](#wid-625 "Direct link to wid") `string` ##### memberId[​](#memberid-34 "Direct link to memberId") `number` #### Returns[​](#returns-774 "Direct link to Returns") `Promise`<{ `memberId`: `number`; `status`: `string`; }> #### Implementation of[​](#implementation-of-773 "Direct link to Implementation of") `IntegrationsBindings.unlinkMemberFromHubspot` *** ### unlinkMemberFromMonday()[​](#unlinkmemberfrommonday "Direct link to unlinkMemberFromMonday()") > **unlinkMemberFromMonday**: (`wid`, `memberId`, `boardId`) => `Promise`<{ `memberId`: `number`; `status`: `string`; }> Defined in: [packages/sdk/src/client/client.ts:880](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L880) #### Parameters[​](#parameters-754 "Direct link to Parameters") ##### wid[​](#wid-626 "Direct link to wid") `string` ##### memberId[​](#memberid-35 "Direct link to memberId") `number` ##### boardId[​](#boardid-7 "Direct link to boardId") `string` #### Returns[​](#returns-775 "Direct link to Returns") `Promise`<{ `memberId`: `number`; `status`: `string`; }> #### Implementation of[​](#implementation-of-774 "Direct link to Implementation of") `IntegrationsBindings.unlinkMemberFromMonday` *** ### unlinkMemberFromSalesforce()[​](#unlinkmemberfromsalesforce "Direct link to unlinkMemberFromSalesforce()") > **unlinkMemberFromSalesforce**: (`wid`, `memberId`) => `Promise`<{ `memberId`: `number`; `status`: `string`; }> Defined in: [packages/sdk/src/client/client.ts:993](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L993) #### Parameters[​](#parameters-755 "Direct link to Parameters") ##### wid[​](#wid-627 "Direct link to wid") `string` ##### memberId[​](#memberid-36 "Direct link to memberId") `number` #### Returns[​](#returns-776 "Direct link to Returns") `Promise`<{ `memberId`: `number`; `status`: `string`; }> #### Implementation of[​](#implementation-of-775 "Direct link to Implementation of") `IntegrationsBindings.unlinkMemberFromSalesforce` *** ### unregisterPushSubscription()[​](#unregisterpushsubscription "Direct link to unregisterPushSubscription()") > **unregisterPushSubscription**: (`wid`, `endpoint`) => `Promise`<{ `deleted`: `boolean`; }> Defined in: [packages/sdk/src/client/client.ts:469](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L469) Unregister a Web Push subscription by endpoint URL. #### Parameters[​](#parameters-756 "Direct link to Parameters") ##### wid[​](#wid-628 "Direct link to wid") `string` ##### endpoint[​](#endpoint-1 "Direct link to endpoint") `string` #### Returns[​](#returns-777 "Direct link to Returns") `Promise`<{ `deleted`: `boolean`; }> #### Implementation of[​](#implementation-of-776 "Direct link to Implementation of") `WorkspacesBindings.unregisterPushSubscription` *** ### updateAbility()[​](#updateability "Direct link to updateAbility()") > **updateAbility**: (`wid`, `abilityUuid`, `body`) => `Promise`<[`AbilityResponse`](https://docs.gravityrail.com/sdk/type-aliases/AbilityResponse.md)> Defined in: [packages/sdk/src/client/client.ts:136](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L136) Update a configured ability (configure / enable / disable) by UUID. #### Parameters[​](#parameters-757 "Direct link to Parameters") ##### wid[​](#wid-629 "Direct link to wid") `string` ##### abilityUuid[​](#abilityuuid-1 "Direct link to abilityUuid") `string` ##### body[​](#body-2 "Direct link to body") `Record`<`string`, `unknown`> #### Returns[​](#returns-778 "Direct link to Returns") `Promise`<[`AbilityResponse`](https://docs.gravityrail.com/sdk/type-aliases/AbilityResponse.md)> #### Implementation of[​](#implementation-of-777 "Direct link to Implementation of") `TasksBindings.updateAbility` *** ### updateAgent()[​](#updateagent "Direct link to updateAgent()") > **updateAgent**: (`wid`, `id`, `agent`) => `Promise`<[`AgentResponse`](https://docs.gravityrail.com/sdk/interfaces/AgentResponse.md)> Defined in: [packages/sdk/src/client/client.ts:289](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L289) Update an existing agent. #### Parameters[​](#parameters-758 "Direct link to Parameters") ##### wid[​](#wid-630 "Direct link to wid") `string` ##### id[​](#id-93 "Direct link to id") `number` ##### agent[​](#agent-1 "Direct link to agent") [`UpdateAgentRequest`](https://docs.gravityrail.com/sdk/interfaces/UpdateAgentRequest.md) #### Returns[​](#returns-779 "Direct link to Returns") `Promise`<[`AgentResponse`](https://docs.gravityrail.com/sdk/interfaces/AgentResponse.md)> #### Implementation of[​](#implementation-of-778 "Direct link to Implementation of") `AgentsBindings.updateAgent` *** ### updateApp()[​](#updateapp "Direct link to updateApp()") > **updateApp**: (`appId`, `request`) => `Promise`<[`App`](https://docs.gravityrail.com/sdk/type-aliases/App.md)> Defined in: [packages/sdk/src/client/client.ts:832](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L832) Update an app #### Parameters[​](#parameters-759 "Direct link to Parameters") ##### appId[​](#appid-13 "Direct link to appId") `string` ##### request[​](#request-22 "Direct link to request") [`UpdateAppRequest`](https://docs.gravityrail.com/sdk/interfaces/UpdateAppRequest.md) #### Returns[​](#returns-780 "Direct link to Returns") `Promise`<[`App`](https://docs.gravityrail.com/sdk/type-aliases/App.md)> #### Implementation of[​](#implementation-of-779 "Direct link to Implementation of") `AppsBindings.updateApp` *** ### updateAssignment()[​](#updateassignment "Direct link to updateAssignment()") > **updateAssignment**: (`wid`, `id`, `assignment`) => `Promise`<[`AssignmentResponse`](https://docs.gravityrail.com/sdk/interfaces/AssignmentResponse.md)> Defined in: [packages/sdk/src/client/client.ts:530](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L530) Update an assignment by ID. #### Parameters[​](#parameters-760 "Direct link to Parameters") ##### wid[​](#wid-631 "Direct link to wid") `string` ##### id[​](#id-94 "Direct link to id") `number` ##### assignment[​](#assignment "Direct link to assignment") [`UpdateAssignmentFormData`](https://docs.gravityrail.com/sdk/interfaces/UpdateAssignmentFormData.md) #### Returns[​](#returns-781 "Direct link to Returns") `Promise`<[`AssignmentResponse`](https://docs.gravityrail.com/sdk/interfaces/AssignmentResponse.md)> #### Implementation of[​](#implementation-of-780 "Direct link to Implementation of") `AuthBindings.updateAssignment` *** ### updateBuilder()[​](#updatebuilder "Direct link to updateBuilder()") > **updateBuilder**: (`builderId`, `request`) => `Promise`<[`BuilderResponse`](https://docs.gravityrail.com/sdk/interfaces/BuilderResponse.md)> Defined in: [packages/sdk/src/client/client.ts:839](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L839) Update an existing builder #### Parameters[​](#parameters-761 "Direct link to Parameters") ##### builderId[​](#builderid-6 "Direct link to builderId") `string` ##### request[​](#request-23 "Direct link to request") [`UpdateBuilderRequest`](https://docs.gravityrail.com/sdk/interfaces/UpdateBuilderRequest.md) #### Returns[​](#returns-782 "Direct link to Returns") `Promise`<[`BuilderResponse`](https://docs.gravityrail.com/sdk/interfaces/BuilderResponse.md)> #### Implementation of[​](#implementation-of-781 "Direct link to Implementation of") `AppsBindings.updateBuilder` *** ### updateBusinessProfile()[​](#updatebusinessprofile "Direct link to updateBusinessProfile()") > **updateBusinessProfile**: (`orgUuid`, `data`) => `Promise`<[`BusinessProfile`](https://docs.gravityrail.com/sdk/type-aliases/BusinessProfile.md)> Defined in: [packages/sdk/src/client/client.ts:462](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L462) 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[​](#parameters-762 "Direct link to Parameters") ##### orgUuid[​](#orguuid-12 "Direct link to orgUuid") `string` ##### data[​](#data-95 "Direct link to data") [`UpdateBusinessProfileRequest`](https://docs.gravityrail.com/sdk/interfaces/UpdateBusinessProfileRequest.md) #### Returns[​](#returns-783 "Direct link to Returns") `Promise`<[`BusinessProfile`](https://docs.gravityrail.com/sdk/type-aliases/BusinessProfile.md)> #### Implementation of[​](#implementation-of-782 "Direct link to Implementation of") `OrgBindings.updateBusinessProfile` *** ### updateCalendar()[​](#updatecalendar "Direct link to updateCalendar()") > **updateCalendar**: (`wid`, `id`, `calendar`) => `Promise`<[`Calendar`](https://docs.gravityrail.com/sdk/type-aliases/Calendar.md)> Defined in: [packages/sdk/src/client/client.ts:696](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L696) Update a calendar's configuration. #### Parameters[​](#parameters-763 "Direct link to Parameters") ##### wid[​](#wid-632 "Direct link to wid") `string` ##### id[​](#id-95 "Direct link to id") `number` ##### calendar[​](#calendar-1 "Direct link to calendar") `Partial`<[`CalendarFormData`](https://docs.gravityrail.com/sdk/interfaces/CalendarFormData.md)> #### Returns[​](#returns-784 "Direct link to Returns") `Promise`<[`Calendar`](https://docs.gravityrail.com/sdk/type-aliases/Calendar.md)> #### Implementation of[​](#implementation-of-783 "Direct link to Implementation of") `CalendarsBindings.updateCalendar` *** ### updateCalendarEvent()[​](#updatecalendarevent "Direct link to updateCalendarEvent()") > **updateCalendarEvent**: (`wid`, `eventId`, `event`) => `Promise`<[`EventResponse`](https://docs.gravityrail.com/sdk/interfaces/EventResponse.md)> Defined in: [packages/sdk/src/client/client.ts:707](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L707) Update an existing calendar event. #### Parameters[​](#parameters-764 "Direct link to Parameters") ##### wid[​](#wid-633 "Direct link to wid") `string` ##### eventId[​](#eventid-3 "Direct link to eventId") `number` ##### event[​](#event-1 "Direct link to event") `Partial`<[`CalendarEventFormData`](https://docs.gravityrail.com/sdk/interfaces/CalendarEventFormData.md)> #### Returns[​](#returns-785 "Direct link to Returns") `Promise`<[`EventResponse`](https://docs.gravityrail.com/sdk/interfaces/EventResponse.md)> #### Implementation of[​](#implementation-of-784 "Direct link to Implementation of") `CalendarsBindings.updateCalendarEvent` *** ### updateCalendarEventType()[​](#updatecalendareventtype "Direct link to updateCalendarEventType()") > **updateCalendarEventType**: (`wid`, `id`, `eventType`) => `Promise`<[`EventTypeResponse`](https://docs.gravityrail.com/sdk/interfaces/EventTypeResponse.md)> Defined in: [packages/sdk/src/client/client.ts:714](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L714) Update an existing calendar event type. #### Parameters[​](#parameters-765 "Direct link to Parameters") ##### wid[​](#wid-634 "Direct link to wid") `string` ##### id[​](#id-96 "Direct link to id") `number` ##### eventType[​](#eventtype-2 "Direct link to eventType") `Partial`<[`CalendarEventTypeFormData`](https://docs.gravityrail.com/sdk/interfaces/CalendarEventTypeFormData.md)> #### Returns[​](#returns-786 "Direct link to Returns") `Promise`<[`EventTypeResponse`](https://docs.gravityrail.com/sdk/interfaces/EventTypeResponse.md)> #### Implementation of[​](#implementation-of-785 "Direct link to Implementation of") `CalendarsBindings.updateCalendarEventType` *** ### updateCalendarSchedule()[​](#updatecalendarschedule "Direct link to updateCalendarSchedule()") > **updateCalendarSchedule**: (`wid`, `calendarId`, `scheduleId`, `schedule`) => `Promise`<[`CalendarSchedule`](https://docs.gravityrail.com/sdk/type-aliases/CalendarSchedule.md)> Defined in: [packages/sdk/src/client/client.ts:700](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L700) Update an existing calendar schedule. #### Parameters[​](#parameters-766 "Direct link to Parameters") ##### wid[​](#wid-635 "Direct link to wid") `string` ##### calendarId[​](#calendarid-13 "Direct link to calendarId") `number` ##### scheduleId[​](#scheduleid-1 "Direct link to scheduleId") `number` ##### schedule[​](#schedule-1 "Direct link to schedule") `Partial`<[`CalendarScheduleFormData`](https://docs.gravityrail.com/sdk/interfaces/CalendarScheduleFormData.md)> #### Returns[​](#returns-787 "Direct link to Returns") `Promise`<[`CalendarSchedule`](https://docs.gravityrail.com/sdk/type-aliases/CalendarSchedule.md)> #### Implementation of[​](#implementation-of-786 "Direct link to Implementation of") `CalendarsBindings.updateCalendarSchedule` *** ### updateChat()[​](#updatechat "Direct link to updateChat()") > **updateChat**: (`wid`, `id`, `chat`) => `Promise`<[`ChatResponse`](https://docs.gravityrail.com/sdk/interfaces/ChatResponse.md)> Defined in: [packages/sdk/src/client/client.ts:155](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L155) Update a chat's properties. #### Parameters[​](#parameters-767 "Direct link to Parameters") ##### wid[​](#wid-636 "Direct link to wid") `string` ##### id[​](#id-97 "Direct link to id") `number` ##### chat[​](#chat-1 "Direct link to chat") `Partial`<[`ChatFormData`](https://docs.gravityrail.com/sdk/interfaces/ChatFormData.md)> #### Returns[​](#returns-788 "Direct link to Returns") `Promise`<[`ChatResponse`](https://docs.gravityrail.com/sdk/interfaces/ChatResponse.md)> #### Implementation of[​](#implementation-of-787 "Direct link to Implementation of") `ChatsBindings.updateChat` *** ### updateChatFilter()[​](#updatechatfilter "Direct link to updateChatFilter()") > **updateChatFilter**: (`wid`, `id`, `filter`) => `Promise`<[`ChatFilterResponse`](https://docs.gravityrail.com/sdk/interfaces/ChatFilterResponse.md)> Defined in: [packages/sdk/src/client/client.ts:182](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L182) Update a chat filter. #### Parameters[​](#parameters-768 "Direct link to Parameters") ##### wid[​](#wid-637 "Direct link to wid") `string` ##### id[​](#id-98 "Direct link to id") `number` ##### filter[​](#filter-1 "Direct link to filter") `Partial`<[`ChatFilterFormData`](https://docs.gravityrail.com/sdk/interfaces/ChatFilterFormData.md)> #### Returns[​](#returns-789 "Direct link to Returns") `Promise`<[`ChatFilterResponse`](https://docs.gravityrail.com/sdk/interfaces/ChatFilterResponse.md)> #### Implementation of[​](#implementation-of-788 "Direct link to Implementation of") `ChatsBindings.updateChatFilter` *** ### updateChatLabel()[​](#updatechatlabel "Direct link to updateChatLabel()") > **updateChatLabel**: (`wid`, `id`, `label`) => `Promise`<[`ChatLabelResponse`](https://docs.gravityrail.com/sdk/interfaces/ChatLabelResponse.md)> Defined in: [packages/sdk/src/client/client.ts:176](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L176) Update a chat label. #### Parameters[​](#parameters-769 "Direct link to Parameters") ##### wid[​](#wid-638 "Direct link to wid") `string` ##### id[​](#id-99 "Direct link to id") `number` ##### label[​](#label-3 "Direct link to label") `Partial`<[`ChatLabelFormData`](https://docs.gravityrail.com/sdk/interfaces/ChatLabelFormData.md)> #### Returns[​](#returns-790 "Direct link to Returns") `Promise`<[`ChatLabelResponse`](https://docs.gravityrail.com/sdk/interfaces/ChatLabelResponse.md)> #### Implementation of[​](#implementation-of-789 "Direct link to Implementation of") `ChatsBindings.updateChatLabel` *** ### updateChatMute()[​](#updatechatmute "Direct link to updateChatMute()") > **updateChatMute**: (`wid`, `id`, `muted`) => `Promise`<{ `id`: `number`; `muted`: `boolean`; }> Defined in: [packages/sdk/src/client/client.ts:156](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L156) Update the mute status of a chat. #### Parameters[​](#parameters-770 "Direct link to Parameters") ##### wid[​](#wid-639 "Direct link to wid") `string` ##### id[​](#id-100 "Direct link to id") `number` ##### muted[​](#muted "Direct link to muted") `boolean` #### Returns[​](#returns-791 "Direct link to Returns") `Promise`<{ `id`: `number`; `muted`: `boolean`; }> #### Implementation of[​](#implementation-of-790 "Direct link to Implementation of") `ChatsBindings.updateChatMute` *** ### updateChatNeedsResponse()[​](#updatechatneedsresponse "Direct link to updateChatNeedsResponse()") > **updateChatNeedsResponse**: (`wid`, `id`, `needsResponse`) => `Promise`<{ `id`: `number`; `needsResponse`: `boolean`; }> Defined in: [packages/sdk/src/client/client.ts:157](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L157) Update the needs-response flag on a chat. #### Parameters[​](#parameters-771 "Direct link to Parameters") ##### wid[​](#wid-640 "Direct link to wid") `string` ##### id[​](#id-101 "Direct link to id") `number` ##### needsResponse[​](#needsresponse "Direct link to needsResponse") `boolean` #### Returns[​](#returns-792 "Direct link to Returns") `Promise`<{ `id`: `number`; `needsResponse`: `boolean`; }> #### Implementation of[​](#implementation-of-791 "Direct link to Implementation of") `ChatsBindings.updateChatNeedsResponse` *** ### updateClientWorkspace()[​](#updateclientworkspace "Direct link to updateClientWorkspace()") > **updateClientWorkspace**: (`wid`, `workspaceId`, `data`) => `Promise`<[`ClientWorkspace`](https://docs.gravityrail.com/sdk/interfaces/ClientWorkspace.md)> Defined in: [packages/sdk/src/client/client.ts:424](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L424) Update a client workspace's name or slug. #### Parameters[​](#parameters-772 "Direct link to Parameters") ##### wid[​](#wid-641 "Direct link to wid") `string` ##### workspaceId[​](#workspaceid-3 "Direct link to workspaceId") `number` ##### data[​](#data-96 "Direct link to data") ###### name?[​](#name-11 "Direct link to name?") `string` ###### slug?[​](#slug-9 "Direct link to slug?") `string` #### Returns[​](#returns-793 "Direct link to Returns") `Promise`<[`ClientWorkspace`](https://docs.gravityrail.com/sdk/interfaces/ClientWorkspace.md)> #### Implementation of[​](#implementation-of-792 "Direct link to Implementation of") `WorkspacesBindings.updateClientWorkspace` *** ### updateConnection()[​](#updateconnection "Direct link to updateConnection()") > **updateConnection**: (`wid`, `journeyId`, `connectionId`, `data`) => `Promise`<`JourneyStepConnectionResponse`> Defined in: [packages/sdk/src/client/client.ts:335](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L335) Update a connection (edge) by ID. #### Parameters[​](#parameters-773 "Direct link to Parameters") ##### wid[​](#wid-642 "Direct link to wid") `string` ##### journeyId[​](#journeyid-22 "Direct link to journeyId") `number` ##### connectionId[​](#connectionid-36 "Direct link to connectionId") `number` ##### data[​](#data-97 "Direct link to data") `Partial`<`JourneyStepConnectionFormData`> #### Returns[​](#returns-794 "Direct link to Returns") `Promise`<`JourneyStepConnectionResponse`> #### Implementation of[​](#implementation-of-793 "Direct link to Implementation of") `JourneysBindings.updateConnection` *** ### updateConnectionSyncConfig()[​](#updateconnectionsyncconfig "Direct link to updateConnectionSyncConfig()") > **updateConnectionSyncConfig**: (`wid`, `connectionId`, `data`) => `Promise`<[`ConnectionSyncConfig`](https://docs.gravityrail.com/sdk/interfaces/ConnectionSyncConfig.md)> Defined in: [packages/sdk/src/client/client.ts:1024](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L1024) #### Parameters[​](#parameters-774 "Direct link to Parameters") ##### wid[​](#wid-643 "Direct link to wid") `string` ##### connectionId[​](#connectionid-37 "Direct link to connectionId") `number` ##### data[​](#data-98 "Direct link to data") [`ConnectionSyncConfig`](https://docs.gravityrail.com/sdk/interfaces/ConnectionSyncConfig.md) #### Returns[​](#returns-795 "Direct link to Returns") `Promise`<[`ConnectionSyncConfig`](https://docs.gravityrail.com/sdk/interfaces/ConnectionSyncConfig.md)> #### Implementation of[​](#implementation-of-794 "Direct link to Implementation of") `IntegrationsBindings.updateConnectionSyncConfig` *** ### updateConsent()[​](#updateconsent "Direct link to updateConsent()") > **updateConsent**: (`consents`) => `Promise`<`ConsentStateResponse`> Defined in: [packages/sdk/src/client/client.ts:526](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L526) Record consent decisions (batch). #### Parameters[​](#parameters-775 "Direct link to Parameters") ##### consents[​](#consents "Direct link to consents") `object`\[] #### Returns[​](#returns-796 "Direct link to Returns") `Promise`<`ConsentStateResponse`> #### Implementation of[​](#implementation-of-795 "Direct link to Implementation of") `AuthBindings.updateConsent` *** ### updateCurrentMember()[​](#updatecurrentmember "Direct link to updateCurrentMember()") > **updateCurrentMember**: (`wid`, `member`) => `Promise`<[`WorkspaceMemberResponse`](https://docs.gravityrail.com/sdk/interfaces/WorkspaceMemberResponse.md)> Defined in: [packages/sdk/src/client/client.ts:223](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L223) Update the currently authenticated member's profile. #### Parameters[​](#parameters-776 "Direct link to Parameters") ##### wid[​](#wid-644 "Direct link to wid") `string` ##### member[​](#member-1 "Direct link to member") `Partial`<[`MemberFormData`](https://docs.gravityrail.com/sdk/interfaces/MemberFormData.md)> #### Returns[​](#returns-797 "Direct link to Returns") `Promise`<[`WorkspaceMemberResponse`](https://docs.gravityrail.com/sdk/interfaces/WorkspaceMemberResponse.md)> #### Implementation of[​](#implementation-of-796 "Direct link to Implementation of") `MembersBindings.updateCurrentMember` *** ### updateCustomTool()[​](#updatecustomtool "Direct link to updateCustomTool()") > **updateCustomTool**: (`wid`, `toolkitId`, `toolId`, `data`) => `Promise`<[`CustomTool`](https://docs.gravityrail.com/sdk/type-aliases/CustomTool.md)> Defined in: [packages/sdk/src/client/client.ts:787](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L787) Update an existing custom tool #### Parameters[​](#parameters-777 "Direct link to Parameters") ##### wid[​](#wid-645 "Direct link to wid") `string` ##### toolkitId[​](#toolkitid-6 "Direct link to toolkitId") `number` ##### toolId[​](#toolid-1 "Direct link to toolId") `number` ##### data[​](#data-99 "Direct link to data") [`CustomToolUpdateFormData`](https://docs.gravityrail.com/sdk/interfaces/CustomToolUpdateFormData.md) #### Returns[​](#returns-798 "Direct link to Returns") `Promise`<[`CustomTool`](https://docs.gravityrail.com/sdk/type-aliases/CustomTool.md)> #### Implementation of[​](#implementation-of-797 "Direct link to Implementation of") `ToolkitsBindings.updateCustomTool` *** ### updateCustomToolkit()[​](#updatecustomtoolkit "Direct link to updateCustomToolkit()") > **updateCustomToolkit**: (`wid`, `toolkitId`, `data`) => `Promise`<[`CustomToolkit`](https://docs.gravityrail.com/sdk/type-aliases/CustomToolkit.md)> Defined in: [packages/sdk/src/client/client.ts:782](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L782) Update an existing custom toolkit #### Parameters[​](#parameters-778 "Direct link to Parameters") ##### wid[​](#wid-646 "Direct link to wid") `string` ##### toolkitId[​](#toolkitid-7 "Direct link to toolkitId") `number` ##### data[​](#data-100 "Direct link to data") [`CustomToolkitUpdateFormData`](https://docs.gravityrail.com/sdk/interfaces/CustomToolkitUpdateFormData.md) #### Returns[​](#returns-799 "Direct link to Returns") `Promise`<[`CustomToolkit`](https://docs.gravityrail.com/sdk/type-aliases/CustomToolkit.md)> #### Implementation of[​](#implementation-of-798 "Direct link to Implementation of") `ToolkitsBindings.updateCustomToolkit` *** ### updateDataRecord()[​](#updatedatarecord "Direct link to updateDataRecord()") > **updateDataRecord**: (`wid`, `dataTypeId`, `recordId`, `record`) => `Promise`<[`DataRecordResponse`](https://docs.gravityrail.com/sdk/interfaces/DataRecordResponse.md)> Defined in: [packages/sdk/src/client/client.ts:209](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L209) Update an existing data record's field values. #### Parameters[​](#parameters-779 "Direct link to Parameters") ##### wid[​](#wid-647 "Direct link to wid") `string` ##### dataTypeId[​](#datatypeid-7 "Direct link to dataTypeId") `number` ##### recordId[​](#recordid-3 "Direct link to recordId") `number` ##### record[​](#record-1 "Direct link to record") [`DataRecordFormData`](https://docs.gravityrail.com/sdk/interfaces/DataRecordFormData.md) #### Returns[​](#returns-800 "Direct link to Returns") `Promise`<[`DataRecordResponse`](https://docs.gravityrail.com/sdk/interfaces/DataRecordResponse.md)> #### Implementation of[​](#implementation-of-799 "Direct link to Implementation of") `DataTypesBindings.updateDataRecord` *** ### updateDataType()[​](#updatedatatype "Direct link to updateDataType()") > **updateDataType**: (`wid`, `id`, `dataType`) => `Promise`<[`DataTypeResponse`](https://docs.gravityrail.com/sdk/interfaces/DataTypeResponse.md)> Defined in: [packages/sdk/src/client/client.ts:201](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L201) Update an existing data type definition. #### Parameters[​](#parameters-780 "Direct link to Parameters") ##### wid[​](#wid-648 "Direct link to wid") `string` ##### id[​](#id-102 "Direct link to id") `number` ##### dataType[​](#datatype-1 "Direct link to dataType") `Partial`<[`DataTypeFormData`](https://docs.gravityrail.com/sdk/interfaces/DataTypeFormData.md)> #### Returns[​](#returns-801 "Direct link to Returns") `Promise`<[`DataTypeResponse`](https://docs.gravityrail.com/sdk/interfaces/DataTypeResponse.md)> #### Implementation of[​](#implementation-of-800 "Direct link to Implementation of") `DataTypesBindings.updateDataType` *** ### updateDiscordBot()[​](#updatediscordbot "Direct link to updateDiscordBot()") > **updateDiscordBot**: (`wid`, `botId`, `data`) => `Promise`<[`DiscordBot`](https://docs.gravityrail.com/sdk/type-aliases/DiscordBot.md)> Defined in: [packages/sdk/src/client/client.ts:890](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L890) Update an existing Discord bot configuration. #### Parameters[​](#parameters-781 "Direct link to Parameters") ##### wid[​](#wid-649 "Direct link to wid") `string` ##### botId[​](#botid-7 "Direct link to botId") `number` ##### data[​](#data-101 "Direct link to data") [`UpdateDiscordBotRequest`](https://docs.gravityrail.com/sdk/interfaces/UpdateDiscordBotRequest.md) #### Returns[​](#returns-802 "Direct link to Returns") `Promise`<[`DiscordBot`](https://docs.gravityrail.com/sdk/type-aliases/DiscordBot.md)> #### Implementation of[​](#implementation-of-801 "Direct link to Implementation of") `IntegrationsBindings.updateDiscordBot` *** ### updateEventAttendee()[​](#updateeventattendee "Direct link to updateEventAttendee()") > **updateEventAttendee**: (`wid`, `eventId`, `attendeeId`, `update`) => `Promise`<`void`> Defined in: [packages/sdk/src/client/client.ts:710](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L710) Update an attendee's details on a calendar event. #### Parameters[​](#parameters-782 "Direct link to Parameters") ##### wid[​](#wid-650 "Direct link to wid") `string` ##### eventId[​](#eventid-4 "Direct link to eventId") `number` ##### attendeeId[​](#attendeeid "Direct link to attendeeId") `number` ##### update[​](#update "Direct link to update") [`UpdateAttendeeRequest`](https://docs.gravityrail.com/sdk/interfaces/UpdateAttendeeRequest.md) #### Returns[​](#returns-803 "Direct link to Returns") `Promise`<`void`> #### Implementation of[​](#implementation-of-802 "Direct link to Implementation of") `CalendarsBindings.updateEventAttendee` *** ### updateEventRule()[​](#updateeventrule "Direct link to updateEventRule()") > **updateEventRule**: (`wid`, `id`, `rule`) => `Promise`<[`EventRuleResponse`](https://docs.gravityrail.com/sdk/type-aliases/EventRuleResponse.md)> Defined in: [packages/sdk/src/client/client.ts:628](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L628) Update an existing event rule. #### Parameters[​](#parameters-783 "Direct link to Parameters") ##### wid[​](#wid-651 "Direct link to wid") `string` ##### id[​](#id-103 "Direct link to id") `number` ##### rule[​](#rule-2 "Direct link to rule") [`UpdateEventRuleFormData`](https://docs.gravityrail.com/sdk/interfaces/UpdateEventRuleFormData.md) #### Returns[​](#returns-804 "Direct link to Returns") `Promise`<[`EventRuleResponse`](https://docs.gravityrail.com/sdk/type-aliases/EventRuleResponse.md)> #### Implementation of[​](#implementation-of-803 "Direct link to Implementation of") `EventsBindings.updateEventRule` *** ### updateExperiment()[​](#updateexperiment "Direct link to updateExperiment()") > **updateExperiment**: (`wid`, `experimentId`, `data`) => `Promise`<`Experiment`> Defined in: [packages/sdk/src/client/client.ts:360](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L360) Update experiment metadata or lifecycle status. #### Parameters[​](#parameters-784 "Direct link to Parameters") ##### wid[​](#wid-652 "Direct link to wid") `string` ##### experimentId[​](#experimentid-7 "Direct link to experimentId") `number` ##### data[​](#data-102 "Direct link to data") `ExperimentUpdateData` #### Returns[​](#returns-805 "Direct link to Returns") `Promise`<`Experiment`> #### Implementation of[​](#implementation-of-804 "Direct link to Implementation of") `ExperimentsBindings.updateExperiment` *** ### updateExperimentAssignment()[​](#updateexperimentassignment "Direct link to updateExperimentAssignment()") > **updateExperimentAssignment**: (`wid`, `experimentId`, `memberId`, `data`) => `Promise`<`MemberExperimentAssignment`> Defined in: [packages/sdk/src/client/client.ts:368](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L368) Move an assigned member to a different experiment group. #### Parameters[​](#parameters-785 "Direct link to Parameters") ##### wid[​](#wid-653 "Direct link to wid") `string` ##### experimentId[​](#experimentid-8 "Direct link to experimentId") `number` ##### memberId[​](#memberid-37 "Direct link to memberId") `number` ##### data[​](#data-103 "Direct link to data") ###### groupId[​](#groupid-6 "Direct link to groupId") `number` #### Returns[​](#returns-806 "Direct link to Returns") `Promise`<`MemberExperimentAssignment`> #### Implementation of[​](#implementation-of-805 "Direct link to Implementation of") `ExperimentsBindings.updateExperimentAssignment` *** ### updateExperimentGroup()[​](#updateexperimentgroup "Direct link to updateExperimentGroup()") > **updateExperimentGroup**: (`wid`, `experimentId`, `groupId`, `data`) => `Promise`<`ExperimentGroup`> Defined in: [packages/sdk/src/client/client.ts:363](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L363) Update a group within an experiment. #### Parameters[​](#parameters-786 "Direct link to Parameters") ##### wid[​](#wid-654 "Direct link to wid") `string` ##### experimentId[​](#experimentid-9 "Direct link to experimentId") `number` ##### groupId[​](#groupid-7 "Direct link to groupId") `number` ##### data[​](#data-104 "Direct link to data") `ExperimentGroupUpdateData` #### Returns[​](#returns-807 "Direct link to Returns") `Promise`<`ExperimentGroup`> #### Implementation of[​](#implementation-of-806 "Direct link to Implementation of") `ExperimentsBindings.updateExperimentGroup` *** ### updateFhirConnection()[​](#updatefhirconnection "Direct link to updateFhirConnection()") > **updateFhirConnection**: (`wid`, `connectionId`, `data`) => `Promise`<[`FhirConnection`](https://docs.gravityrail.com/sdk/type-aliases/FhirConnection.md)> Defined in: [packages/sdk/src/client/client.ts:925](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L925) Update an existing FHIR connection configuration. #### Parameters[​](#parameters-787 "Direct link to Parameters") ##### wid[​](#wid-655 "Direct link to wid") `string` ##### connectionId[​](#connectionid-38 "Direct link to connectionId") `number` ##### data[​](#data-105 "Direct link to data") [`UpdateFhirConnectionRequest`](https://docs.gravityrail.com/sdk/interfaces/UpdateFhirConnectionRequest.md) #### Returns[​](#returns-808 "Direct link to Returns") `Promise`<[`FhirConnection`](https://docs.gravityrail.com/sdk/type-aliases/FhirConnection.md)> #### Implementation of[​](#implementation-of-807 "Direct link to Implementation of") `IntegrationsBindings.updateFhirConnection` *** ### updateFile()[​](#updatefile "Direct link to updateFile()") > **updateFile**: (`wid`, `id`, `file`) => `Promise`<[`File`](https://docs.gravityrail.com/sdk/type-aliases/File.md)> Defined in: [packages/sdk/src/client/client.ts:592](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L592) Update an existing file's metadata. #### Parameters[​](#parameters-788 "Direct link to Parameters") ##### wid[​](#wid-656 "Direct link to wid") `string` ##### id[​](#id-104 "Direct link to id") `number` ##### file[​](#file-6 "Direct link to file") `Partial`<[`FileFormData`](https://docs.gravityrail.com/sdk/interfaces/FileFormData.md)> #### Returns[​](#returns-809 "Direct link to Returns") `Promise`<[`File`](https://docs.gravityrail.com/sdk/type-aliases/File.md)> #### Implementation of[​](#implementation-of-808 "Direct link to Implementation of") `FilesBindings.updateFile` *** ### updateFileLabel()[​](#updatefilelabel "Direct link to updateFileLabel()") > **updateFileLabel**: (`wid`, `id`, `label`) => `Promise`<[`FileLabelResponse`](https://docs.gravityrail.com/sdk/interfaces/FileLabelResponse.md)> Defined in: [packages/sdk/src/client/client.ts:607](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L607) Update a file label's properties. #### Parameters[​](#parameters-789 "Direct link to Parameters") ##### wid[​](#wid-657 "Direct link to wid") `string` ##### id[​](#id-105 "Direct link to id") `number` ##### label[​](#label-4 "Direct link to label") `Partial`<[`FileLabelFormData`](https://docs.gravityrail.com/sdk/interfaces/FileLabelFormData.md)> #### Returns[​](#returns-810 "Direct link to Returns") `Promise`<[`FileLabelResponse`](https://docs.gravityrail.com/sdk/interfaces/FileLabelResponse.md)> #### Implementation of[​](#implementation-of-809 "Direct link to Implementation of") `FilesBindings.updateFileLabel` *** ### updateFileRoles()[​](#updatefileroles "Direct link to updateFileRoles()") > **updateFileRoles**: (`wid`, `fileId`, `data`) => `Promise`<[`FileRoleAssociationResponse`](https://docs.gravityrail.com/sdk/interfaces/FileRoleAssociationResponse.md)\[]> Defined in: [packages/sdk/src/client/client.ts:610](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L610) Update the role associations for a file's sharing permissions. #### Parameters[​](#parameters-790 "Direct link to Parameters") ##### wid[​](#wid-658 "Direct link to wid") `string` ##### fileId[​](#fileid-4 "Direct link to fileId") `number` ##### data[​](#data-106 "Direct link to data") [`UpdateFileRoleAssociationsRequest`](https://docs.gravityrail.com/sdk/interfaces/UpdateFileRoleAssociationsRequest.md) #### Returns[​](#returns-811 "Direct link to Returns") `Promise`<[`FileRoleAssociationResponse`](https://docs.gravityrail.com/sdk/interfaces/FileRoleAssociationResponse.md)\[]> #### Implementation of[​](#implementation-of-810 "Direct link to Implementation of") `FilesBindings.updateFileRoles` *** ### updateFileSharing()[​](#updatefilesharing "Direct link to updateFileSharing()") > **updateFileSharing**: (`wid`, `fileId`, `data`) => `Promise`<[`FileSharingResponse`](https://docs.gravityrail.com/sdk/type-aliases/FileSharingResponse.md)> Defined in: [packages/sdk/src/client/client.ts:615](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L615) Update all sharing settings for a file in a single request. #### Parameters[​](#parameters-791 "Direct link to Parameters") ##### wid[​](#wid-659 "Direct link to wid") `string` ##### fileId[​](#fileid-5 "Direct link to fileId") `number` ##### data[​](#data-107 "Direct link to data") [`UpdateFileSharingRequest`](https://docs.gravityrail.com/sdk/interfaces/UpdateFileSharingRequest.md) #### Returns[​](#returns-812 "Direct link to Returns") `Promise`<[`FileSharingResponse`](https://docs.gravityrail.com/sdk/type-aliases/FileSharingResponse.md)> #### Implementation of[​](#implementation-of-811 "Direct link to Implementation of") `FilesBindings.updateFileSharing` *** ### updateFirstRunState()[​](#updatefirstrunstate "Direct link to updateFirstRunState()") > **updateFirstRunState**: (`wid`, `state`) => `Promise`<[`FirstRunState`](https://docs.gravityrail.com/sdk/interfaces/FirstRunState.md)> Defined in: [packages/sdk/src/client/client.ts:410](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L410) Update the first-run onboarding state for a workspace. #### Parameters[​](#parameters-792 "Direct link to Parameters") ##### wid[​](#wid-660 "Direct link to wid") `string` ##### state[​](#state-1 "Direct link to state") [`FirstRunState`](https://docs.gravityrail.com/sdk/interfaces/FirstRunState.md) #### Returns[​](#returns-813 "Direct link to Returns") `Promise`<[`FirstRunState`](https://docs.gravityrail.com/sdk/interfaces/FirstRunState.md)> #### Implementation of[​](#implementation-of-812 "Direct link to Implementation of") `WorkspacesBindings.updateFirstRunState` *** ### updateFolder()[​](#updatefolder "Direct link to updateFolder()") > **updateFolder**: (`wid`, `id`, `directory`) => `Promise`<[`FileFolderResponse`](https://docs.gravityrail.com/sdk/interfaces/FileFolderResponse.md)> Defined in: [packages/sdk/src/client/client.ts:599](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L599) Update a folder's properties. #### Parameters[​](#parameters-793 "Direct link to Parameters") ##### wid[​](#wid-661 "Direct link to wid") `string` ##### id[​](#id-106 "Direct link to id") `number` ##### directory[​](#directory-1 "Direct link to directory") `Partial`<[`FileFolderFormData`](https://docs.gravityrail.com/sdk/interfaces/FileFolderFormData.md)> #### Returns[​](#returns-814 "Direct link to Returns") `Promise`<[`FileFolderResponse`](https://docs.gravityrail.com/sdk/interfaces/FileFolderResponse.md)> #### Implementation of[​](#implementation-of-813 "Direct link to Implementation of") `FilesBindings.updateFolder` *** ### updateFolderRoles()[​](#updatefolderroles "Direct link to updateFolderRoles()") > **updateFolderRoles**: (`wid`, `folderId`, `data`) => `Promise`<[`FileRoleAssociationResponse`](https://docs.gravityrail.com/sdk/interfaces/FileRoleAssociationResponse.md)\[]> Defined in: [packages/sdk/src/client/client.ts:613](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L613) Update the role associations for a folder's sharing permissions. #### Parameters[​](#parameters-794 "Direct link to Parameters") ##### wid[​](#wid-662 "Direct link to wid") `string` ##### folderId[​](#folderid-5 "Direct link to folderId") `number` ##### data[​](#data-108 "Direct link to data") [`UpdateFileRoleAssociationsRequest`](https://docs.gravityrail.com/sdk/interfaces/UpdateFileRoleAssociationsRequest.md) #### Returns[​](#returns-815 "Direct link to Returns") `Promise`<[`FileRoleAssociationResponse`](https://docs.gravityrail.com/sdk/interfaces/FileRoleAssociationResponse.md)\[]> #### Implementation of[​](#implementation-of-814 "Direct link to Implementation of") `FilesBindings.updateFolderRoles` *** ### updateFolderSharing()[​](#updatefoldersharing "Direct link to updateFolderSharing()") > **updateFolderSharing**: (`wid`, `folderId`, `data`) => `Promise`<[`FolderSharingResponse`](https://docs.gravityrail.com/sdk/type-aliases/FolderSharingResponse.md)> Defined in: [packages/sdk/src/client/client.ts:616](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L616) Update all sharing settings for a folder in a single request. #### Parameters[​](#parameters-795 "Direct link to Parameters") ##### wid[​](#wid-663 "Direct link to wid") `string` ##### folderId[​](#folderid-6 "Direct link to folderId") `number` ##### data[​](#data-109 "Direct link to data") [`UpdateFileSharingRequest`](https://docs.gravityrail.com/sdk/interfaces/UpdateFileSharingRequest.md) #### Returns[​](#returns-816 "Direct link to Returns") `Promise`<[`FolderSharingResponse`](https://docs.gravityrail.com/sdk/type-aliases/FolderSharingResponse.md)> #### Implementation of[​](#implementation-of-815 "Direct link to Implementation of") `FilesBindings.updateFolderSharing` *** ### updateGoal()[​](#updategoal "Direct link to updateGoal()") > **updateGoal**: (`wid`, `journeyId`, `goalUuid`, `data`) => `Promise`<`JourneyGoalResponse`> Defined in: [packages/sdk/src/client/client.ts:338](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L338) Update an existing goal. #### Parameters[​](#parameters-796 "Direct link to Parameters") ##### wid[​](#wid-664 "Direct link to wid") `string` ##### journeyId[​](#journeyid-23 "Direct link to journeyId") `number` ##### goalUuid[​](#goaluuid-1 "Direct link to goalUuid") `string` ##### data[​](#data-110 "Direct link to data") `Partial`<`JourneyGoalFormData`> #### Returns[​](#returns-817 "Direct link to Returns") `Promise`<`JourneyGoalResponse`> #### Implementation of[​](#implementation-of-816 "Direct link to Implementation of") `JourneysBindings.updateGoal` *** ### updateInbox()[​](#updateinbox "Direct link to updateInbox()") > **updateInbox**: (`wid`, `id`, `inbox`) => `Promise`<[`Inbox`](https://docs.gravityrail.com/sdk/type-aliases/Inbox.md)> Defined in: [packages/sdk/src/client/client.ts:750](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L750) Update an inbox. #### Parameters[​](#parameters-797 "Direct link to Parameters") ##### wid[​](#wid-665 "Direct link to wid") `string` ##### id[​](#id-107 "Direct link to id") `number` ##### inbox[​](#inbox-1 "Direct link to inbox") [`InboxUpdateRequest`](https://docs.gravityrail.com/sdk/interfaces/InboxUpdateRequest.md) #### Returns[​](#returns-818 "Direct link to Returns") `Promise`<[`Inbox`](https://docs.gravityrail.com/sdk/type-aliases/Inbox.md)> #### Implementation of[​](#implementation-of-817 "Direct link to Implementation of") `CommunicationsBindings.updateInbox` *** ### updateInquiry()[​](#updateinquiry "Direct link to updateInquiry()") > **updateInquiry**: (`inquiryId`, `data`) => `Promise`<[`InquiryResponse`](https://docs.gravityrail.com/sdk/interfaces/InquiryResponse.md)> Defined in: [packages/sdk/src/client/client.ts:845](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L845) Update an inquiry (superuser only) #### Parameters[​](#parameters-798 "Direct link to Parameters") ##### inquiryId[​](#inquiryid-2 "Direct link to inquiryId") `number` ##### data[​](#data-111 "Direct link to data") ###### notes?[​](#notes "Direct link to notes?") `string` = `...` ###### status?[​](#status-15 "Direct link to status?") `"in_progress"` | `"new"` | `"done"` = `...` #### Returns[​](#returns-819 "Direct link to Returns") `Promise`<[`InquiryResponse`](https://docs.gravityrail.com/sdk/interfaces/InquiryResponse.md)> #### Implementation of[​](#implementation-of-818 "Direct link to Implementation of") `AppsBindings.updateInquiry` *** ### updateJourney()[​](#updatejourney "Direct link to updateJourney()") > **updateJourney**: (`wid`, `journeyId`, `data`) => `Promise`<`Journey`> Defined in: [packages/sdk/src/client/client.ts:329](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L329) Update an existing journey. #### Parameters[​](#parameters-799 "Direct link to Parameters") ##### wid[​](#wid-666 "Direct link to wid") `string` ##### journeyId[​](#journeyid-24 "Direct link to journeyId") `number` ##### data[​](#data-112 "Direct link to data") `Partial`<`JourneyFormData`> #### Returns[​](#returns-820 "Direct link to Returns") `Promise`<`Journey`> #### Implementation of[​](#implementation-of-819 "Direct link to Implementation of") `JourneysBindings.updateJourney` *** ### updateJourneyNote()[​](#updatejourneynote "Direct link to updateJourneyNote()") > **updateJourneyNote**: (`wid`, `journeyId`, `noteId`, `data`) => `Promise`<`JourneyNoteResponse`> Defined in: [packages/sdk/src/client/client.ts:353](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L353) Update an existing journey note. #### Parameters[​](#parameters-800 "Direct link to Parameters") ##### wid[​](#wid-667 "Direct link to wid") `string` ##### journeyId[​](#journeyid-25 "Direct link to journeyId") `number` ##### noteId[​](#noteid-2 "Direct link to noteId") `number` ##### data[​](#data-113 "Direct link to data") `Partial`<`JourneyNoteFormData`> #### Returns[​](#returns-821 "Direct link to Returns") `Promise`<`JourneyNoteResponse`> #### Implementation of[​](#implementation-of-820 "Direct link to Implementation of") `JourneysBindings.updateJourneyNote` *** ### updateMcpServer()[​](#updatemcpserver "Direct link to updateMcpServer()") > **updateMcpServer**: (`wid`, `serverId`, `data`) => `Promise`<[`McpServerResponse`](https://docs.gravityrail.com/sdk/interfaces/McpServerResponse.md)> Defined in: [packages/sdk/src/client/client.ts:792](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L792) Update an existing MCP server #### Parameters[​](#parameters-801 "Direct link to Parameters") ##### wid[​](#wid-668 "Direct link to wid") `string` ##### serverId[​](#serverid-8 "Direct link to serverId") `number` ##### data[​](#data-114 "Direct link to data") [`McpServerUpdateFormData`](https://docs.gravityrail.com/sdk/interfaces/McpServerUpdateFormData.md) #### Returns[​](#returns-822 "Direct link to Returns") `Promise`<[`McpServerResponse`](https://docs.gravityrail.com/sdk/interfaces/McpServerResponse.md)> #### Implementation of[​](#implementation-of-821 "Direct link to Implementation of") `ToolkitsBindings.updateMcpServer` *** ### updateMember()[​](#updatemember "Direct link to updateMember()") > **updateMember**: (`wid`, `memberId`, `data`) => `Promise`<[`WorkspaceMemberResponse`](https://docs.gravityrail.com/sdk/interfaces/WorkspaceMemberResponse.md)> Defined in: [packages/sdk/src/client/client.ts:227](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L227) Update a workspace member by ID. #### Parameters[​](#parameters-802 "Direct link to Parameters") ##### wid[​](#wid-669 "Direct link to wid") `string` ##### memberId[​](#memberid-38 "Direct link to memberId") `number` ##### data[​](#data-115 "Direct link to data") [`UpdateWorkspaceMemberRequest`](https://docs.gravityrail.com/sdk/interfaces/UpdateWorkspaceMemberRequest.md) #### Returns[​](#returns-823 "Direct link to Returns") `Promise`<[`WorkspaceMemberResponse`](https://docs.gravityrail.com/sdk/interfaces/WorkspaceMemberResponse.md)> #### Implementation of[​](#implementation-of-822 "Direct link to Implementation of") `MembersBindings.updateMember` *** ### updateMemberField()[​](#updatememberfield "Direct link to updateMemberField()") > **updateMemberField**: (`wid`, `memberId`, `fieldId`, `request`) => `Promise`<[`MemberFieldResponse`](https://docs.gravityrail.com/sdk/interfaces/MemberFieldResponse.md)> Defined in: [packages/sdk/src/client/client.ts:260](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L260) Update a member field value. Only user-created fields (no service\_id) can be modified. #### Parameters[​](#parameters-803 "Direct link to Parameters") ##### wid[​](#wid-670 "Direct link to wid") `string` ##### memberId[​](#memberid-39 "Direct link to memberId") `number` ##### fieldId[​](#fieldid-1 "Direct link to fieldId") `number` ##### request[​](#request-24 "Direct link to request") [`UpdateMemberFieldRequest`](https://docs.gravityrail.com/sdk/interfaces/UpdateMemberFieldRequest.md) #### Returns[​](#returns-824 "Direct link to Returns") `Promise`<[`MemberFieldResponse`](https://docs.gravityrail.com/sdk/interfaces/MemberFieldResponse.md)> #### Implementation of[​](#implementation-of-823 "Direct link to Implementation of") `MembersBindings.updateMemberField` *** ### updateMemberFilter()[​](#updatememberfilter "Direct link to updateMemberFilter()") > **updateMemberFilter**: (`wid`, `filterId`, `data`) => `Promise`<[`MemberFilterResponse`](https://docs.gravityrail.com/sdk/interfaces/MemberFilterResponse.md)> Defined in: [packages/sdk/src/client/client.ts:240](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L240) Update a saved member filter. #### Parameters[​](#parameters-804 "Direct link to Parameters") ##### wid[​](#wid-671 "Direct link to wid") `string` ##### filterId[​](#filterid-5 "Direct link to filterId") `number` ##### data[​](#data-116 "Direct link to data") `Partial`<[`MemberFilterFormData`](https://docs.gravityrail.com/sdk/interfaces/MemberFilterFormData.md)> #### Returns[​](#returns-825 "Direct link to Returns") `Promise`<[`MemberFilterResponse`](https://docs.gravityrail.com/sdk/interfaces/MemberFilterResponse.md)> #### Implementation of[​](#implementation-of-824 "Direct link to Implementation of") `MembersBindings.updateMemberFilter` *** ### updateMemberLabel()[​](#updatememberlabel "Direct link to updateMemberLabel()") > **updateMemberLabel**: (`wid`, `id`, `label`) => `Promise`<[`MemberLabelResponse`](https://docs.gravityrail.com/sdk/interfaces/MemberLabelResponse.md)> Defined in: [packages/sdk/src/client/client.ts:248](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L248) Update a member label. #### Parameters[​](#parameters-805 "Direct link to Parameters") ##### wid[​](#wid-672 "Direct link to wid") `string` ##### id[​](#id-108 "Direct link to id") `number` ##### label[​](#label-5 "Direct link to label") `Partial`<[`MemberLabelFormData`](https://docs.gravityrail.com/sdk/interfaces/MemberLabelFormData.md)> #### Returns[​](#returns-826 "Direct link to Returns") `Promise`<[`MemberLabelResponse`](https://docs.gravityrail.com/sdk/interfaces/MemberLabelResponse.md)> #### Implementation of[​](#implementation-of-825 "Direct link to Implementation of") `MembersBindings.updateMemberLabel` *** ### updateMemberRole()[​](#updatememberrole "Direct link to updateMemberRole()") > **updateMemberRole**: (`wid`, `id`, `memberRole`) => `Promise`<[`MemberRoleResponse`](https://docs.gravityrail.com/sdk/interfaces/MemberRoleResponse.md)> Defined in: [packages/sdk/src/client/client.ts:254](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L254) Update a member role. #### Parameters[​](#parameters-806 "Direct link to Parameters") ##### wid[​](#wid-673 "Direct link to wid") `string` ##### id[​](#id-109 "Direct link to id") `number` ##### memberRole[​](#memberrole-2 "Direct link to memberRole") [`MemberRoleFormData`](https://docs.gravityrail.com/sdk/interfaces/MemberRoleFormData.md) #### Returns[​](#returns-827 "Direct link to Returns") `Promise`<[`MemberRoleResponse`](https://docs.gravityrail.com/sdk/interfaces/MemberRoleResponse.md)> #### Implementation of[​](#implementation-of-826 "Direct link to Implementation of") `MembersBindings.updateMemberRole` *** ### updateMenuItem()[​](#updatemenuitem "Direct link to updateMenuItem()") > **updateMenuItem**: (`wid`, `siteId`, `itemId`, `item`) => `Promise`<[`MenuItemResponse`](https://docs.gravityrail.com/sdk/interfaces/MenuItemResponse.md)> Defined in: [packages/sdk/src/client/client.ts:581](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L581) Update a menu item's properties. #### Parameters[​](#parameters-807 "Direct link to Parameters") ##### wid[​](#wid-674 "Direct link to wid") `string` ##### siteId[​](#siteid-24 "Direct link to siteId") `number` ##### itemId[​](#itemid-1 "Direct link to itemId") `number` ##### item[​](#item-1 "Direct link to item") `Partial`<[`MenuItemFormData`](https://docs.gravityrail.com/sdk/interfaces/MenuItemFormData.md)> #### Returns[​](#returns-828 "Direct link to Returns") `Promise`<[`MenuItemResponse`](https://docs.gravityrail.com/sdk/interfaces/MenuItemResponse.md)> #### Implementation of[​](#implementation-of-827 "Direct link to Implementation of") `SitesBindings.updateMenuItem` *** ### updateMilestone()[​](#updatemilestone "Direct link to updateMilestone()") > **updateMilestone**: (`wid`, `id`, `milestone`) => `Promise`<[`Milestone`](https://docs.gravityrail.com/sdk/interfaces/Milestone.md)> Defined in: [packages/sdk/src/client/client.ts:727](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L727) Update an existing milestone with partial data. #### Parameters[​](#parameters-808 "Direct link to Parameters") ##### wid[​](#wid-675 "Direct link to wid") `string` ##### id[​](#id-110 "Direct link to id") `number` ##### milestone[​](#milestone-1 "Direct link to milestone") `Partial`<[`MilestoneFormData`](https://docs.gravityrail.com/sdk/type-aliases/MilestoneFormData.md)> #### Returns[​](#returns-829 "Direct link to Returns") `Promise`<[`Milestone`](https://docs.gravityrail.com/sdk/interfaces/Milestone.md)> #### Implementation of[​](#implementation-of-828 "Direct link to Implementation of") `CalendarsBindings.updateMilestone` *** ### updateMondaySyncConfig()[​](#updatemondaysyncconfig "Direct link to updateMondaySyncConfig()") > **updateMondaySyncConfig**: (`wid`, `syncConfig`) => `Promise`<`MondaySyncConfigResponse`> Defined in: [packages/sdk/src/client/client.ts:875](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L875) #### Parameters[​](#parameters-809 "Direct link to Parameters") ##### wid[​](#wid-676 "Direct link to wid") `string` ##### syncConfig[​](#syncconfig "Direct link to syncConfig") `Record`<`string`, `unknown`> #### Returns[​](#returns-830 "Direct link to Returns") `Promise`<`MondaySyncConfigResponse`> #### Implementation of[​](#implementation-of-829 "Direct link to Implementation of") `IntegrationsBindings.updateMondaySyncConfig` *** ### updateMyCustomer()[​](#updatemycustomer "Direct link to updateMyCustomer()") > **updateMyCustomer**: (`uuid`, `data`) => `Promise`<`MyCustomerResponse`> Defined in: [packages/sdk/src/client/client.ts:1063](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L1063) #### Parameters[​](#parameters-810 "Direct link to Parameters") ##### uuid[​](#uuid-35 "Direct link to uuid") `string` ##### data[​](#data-117 "Direct link to data") `UpdateCustomerRequest` #### Returns[​](#returns-831 "Direct link to Returns") `Promise`<`MyCustomerResponse`> #### Implementation of[​](#implementation-of-830 "Direct link to Implementation of") `CustomersBindings.updateMyCustomer` *** ### updateMyPronunciation()[​](#updatemypronunciation "Direct link to updateMyPronunciation()") > **updateMyPronunciation**: (`id`, `data`) => `Promise`<[`PronunciationEntryResponse`](https://docs.gravityrail.com/sdk/interfaces/PronunciationEntryResponse.md)> Defined in: [packages/sdk/src/client/client.ts:1051](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L1051) Update a personal pronunciation entry. #### Parameters[​](#parameters-811 "Direct link to Parameters") ##### id[​](#id-111 "Direct link to id") `number` ##### data[​](#data-118 "Direct link to data") [`UpdatePronunciationEntryFormData`](https://docs.gravityrail.com/sdk/interfaces/UpdatePronunciationEntryFormData.md) #### Returns[​](#returns-832 "Direct link to Returns") `Promise`<[`PronunciationEntryResponse`](https://docs.gravityrail.com/sdk/interfaces/PronunciationEntryResponse.md)> #### Implementation of[​](#implementation-of-831 "Direct link to Implementation of") `PronunciationsBindings.updateMyPronunciation` *** ### updateMyReseller()[​](#updatemyreseller "Direct link to updateMyReseller()") > **updateMyReseller**: (`uuid`, `data`) => `Promise`<`MyResellerResponse`> Defined in: [packages/sdk/src/client/client.ts:1077](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L1077) #### Parameters[​](#parameters-812 "Direct link to Parameters") ##### uuid[​](#uuid-36 "Direct link to uuid") `string` ##### data[​](#data-119 "Direct link to data") `UpdateResellerRequest` #### Returns[​](#returns-833 "Direct link to Returns") `Promise`<`MyResellerResponse`> #### Implementation of[​](#implementation-of-832 "Direct link to Implementation of") `ResellersBindings.updateMyReseller` *** ### updateNotificationRule()[​](#updatenotificationrule "Direct link to updateNotificationRule()") > **updateNotificationRule**: (`wid`, `ruleId`, `rule`) => `Promise`<[`NotificationRule`](https://docs.gravityrail.com/sdk/interfaces/NotificationRule.md)> Defined in: [packages/sdk/src/client/client.ts:764](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L764) Update a notification rule. #### Parameters[​](#parameters-813 "Direct link to Parameters") ##### wid[​](#wid-677 "Direct link to wid") `string` ##### ruleId[​](#ruleid-1 "Direct link to ruleId") `number` ##### rule[​](#rule-3 "Direct link to rule") [`NotificationRuleUpdate`](https://docs.gravityrail.com/sdk/interfaces/NotificationRuleUpdate.md) #### Returns[​](#returns-834 "Direct link to Returns") `Promise`<[`NotificationRule`](https://docs.gravityrail.com/sdk/interfaces/NotificationRule.md)> #### Implementation of[​](#implementation-of-833 "Direct link to Implementation of") `CommunicationsBindings.updateNotificationRule` *** ### updateOperatorGroup()[​](#updateoperatorgroup "Direct link to updateOperatorGroup()") > **updateOperatorGroup**: (`wid`, `groupId`, `data`) => `Promise`<[`OperatorGroup`](https://docs.gravityrail.com/sdk/type-aliases/OperatorGroup.md)> Defined in: [packages/sdk/src/client/client.ts:375](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L375) Update an operator group. #### Parameters[​](#parameters-814 "Direct link to Parameters") ##### wid[​](#wid-678 "Direct link to wid") `string` ##### groupId[​](#groupid-8 "Direct link to groupId") `number` ##### data[​](#data-120 "Direct link to data") [`UpdateOperatorGroupRequest`](https://docs.gravityrail.com/sdk/interfaces/UpdateOperatorGroupRequest.md) #### Returns[​](#returns-835 "Direct link to Returns") `Promise`<[`OperatorGroup`](https://docs.gravityrail.com/sdk/type-aliases/OperatorGroup.md)> #### Implementation of[​](#implementation-of-834 "Direct link to Implementation of") `OperatorBindings.updateOperatorGroup` *** ### updatePage()[​](#updatepage "Direct link to updatePage()") > **updatePage**: (`wid`, `siteId`, `pageId`, `page`) => `Promise`<[`PageResponse`](https://docs.gravityrail.com/sdk/interfaces/PageResponse.md)> Defined in: [packages/sdk/src/client/client.ts:575](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L575) Update a page's content or metadata. #### Parameters[​](#parameters-815 "Direct link to Parameters") ##### wid[​](#wid-679 "Direct link to wid") `string` ##### siteId[​](#siteid-25 "Direct link to siteId") `number` ##### pageId[​](#pageid-2 "Direct link to pageId") `number` ##### page[​](#page-56 "Direct link to page") `Partial`<[`PageFormData`](https://docs.gravityrail.com/sdk/interfaces/PageFormData.md)> #### Returns[​](#returns-836 "Direct link to Returns") `Promise`<[`PageResponse`](https://docs.gravityrail.com/sdk/interfaces/PageResponse.md)> #### Implementation of[​](#implementation-of-835 "Direct link to Implementation of") `SitesBindings.updatePage` *** ### updatePersona()[​](#updatepersona "Direct link to updatePersona()") > **updatePersona**: (`wid`, `id`, `data`) => `Promise`<[`Persona`](https://docs.gravityrail.com/sdk/type-aliases/Persona.md)> Defined in: [packages/sdk/src/client/client.ts:321](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L321) #### Parameters[​](#parameters-816 "Direct link to Parameters") ##### wid[​](#wid-680 "Direct link to wid") `string` ##### id[​](#id-112 "Direct link to id") `number` ##### data[​](#data-121 "Direct link to data") [`UpdatePersonaRequest`](https://docs.gravityrail.com/sdk/interfaces/UpdatePersonaRequest.md) #### Returns[​](#returns-837 "Direct link to Returns") `Promise`<[`Persona`](https://docs.gravityrail.com/sdk/type-aliases/Persona.md)> #### Implementation of[​](#implementation-of-836 "Direct link to Implementation of") `PersonasBindings.updatePersona` *** ### updatePhoneNumber()[​](#updatephonenumber "Direct link to updatePhoneNumber()") > **updatePhoneNumber**: (`wid`, `id`, `phoneNumber`) => `Promise`<[`PhoneNumber`](https://docs.gravityrail.com/sdk/interfaces/PhoneNumber.md)> Defined in: [packages/sdk/src/client/client.ts:736](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L736) Update a phone number record. #### Parameters[​](#parameters-817 "Direct link to Parameters") ##### wid[​](#wid-681 "Direct link to wid") `string` ##### id[​](#id-113 "Direct link to id") `number` ##### phoneNumber[​](#phonenumber-6 "Direct link to phoneNumber") [`PhoneNumberFormData`](https://docs.gravityrail.com/sdk/interfaces/PhoneNumberFormData.md) #### Returns[​](#returns-838 "Direct link to Returns") `Promise`<[`PhoneNumber`](https://docs.gravityrail.com/sdk/interfaces/PhoneNumber.md)> #### Implementation of[​](#implementation-of-837 "Direct link to Implementation of") `CommunicationsBindings.updatePhoneNumber` *** ### updatePlatformApp()[​](#updateplatformapp "Direct link to updatePlatformApp()") > **updatePlatformApp**: (`wid`, `appUuid`, `data`) => `Promise`<[`PlatformAppConnectionResponse`](https://docs.gravityrail.com/sdk/interfaces/PlatformAppConnectionResponse.md)> Defined in: [packages/sdk/src/client/client.ts:1037](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L1037) Update platform app config, enabled status, or name. #### Parameters[​](#parameters-818 "Direct link to Parameters") ##### wid[​](#wid-682 "Direct link to wid") `string` ##### appUuid[​](#appuuid-2 "Direct link to appUuid") `string` ##### data[​](#data-122 "Direct link to data") [`UpdateAppConnectionRequest`](https://docs.gravityrail.com/sdk/interfaces/UpdateAppConnectionRequest.md) #### Returns[​](#returns-839 "Direct link to Returns") `Promise`<[`PlatformAppConnectionResponse`](https://docs.gravityrail.com/sdk/interfaces/PlatformAppConnectionResponse.md)> #### Implementation of[​](#implementation-of-838 "Direct link to Implementation of") `IntegrationsBindings.updatePlatformApp` *** ### updateProduct()[​](#updateproduct "Direct link to updateProduct()") > **updateProduct**: (`wid`, `id`, `updates`) => `Promise`<[`Product`](https://docs.gravityrail.com/sdk/type-aliases/Product.md)> Defined in: [packages/sdk/src/client/client.ts:433](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L433) Update an existing product. #### Parameters[​](#parameters-819 "Direct link to Parameters") ##### wid[​](#wid-683 "Direct link to wid") `string` ##### id[​](#id-114 "Direct link to id") `number` ##### updates[​](#updates "Direct link to updates") `any` #### Returns[​](#returns-840 "Direct link to Returns") `Promise`<[`Product`](https://docs.gravityrail.com/sdk/type-aliases/Product.md)> #### Implementation of[​](#implementation-of-839 "Direct link to Implementation of") `WorkspacesBindings.updateProduct` *** ### updatePronunciationEntry()[​](#updatepronunciationentry "Direct link to updatePronunciationEntry()") > **updatePronunciationEntry**: (`orgUuid`, `id`, `data`) => `Promise`<[`PronunciationEntryResponse`](https://docs.gravityrail.com/sdk/interfaces/PronunciationEntryResponse.md)> Defined in: [packages/sdk/src/client/client.ts:1045](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L1045) Update an existing organization pronunciation entry. #### Parameters[​](#parameters-820 "Direct link to Parameters") ##### orgUuid[​](#orguuid-13 "Direct link to orgUuid") `string` ##### id[​](#id-115 "Direct link to id") `number` ##### data[​](#data-123 "Direct link to data") [`UpdatePronunciationEntryFormData`](https://docs.gravityrail.com/sdk/interfaces/UpdatePronunciationEntryFormData.md) #### Returns[​](#returns-841 "Direct link to Returns") `Promise`<[`PronunciationEntryResponse`](https://docs.gravityrail.com/sdk/interfaces/PronunciationEntryResponse.md)> #### Implementation of[​](#implementation-of-840 "Direct link to Implementation of") `PronunciationsBindings.updatePronunciationEntry` *** ### updateRoutine()[​](#updateroutine "Direct link to updateRoutine()") > **updateRoutine**: (`wid`, `id`, `routine`) => `Promise`<[`RoutineResponse`](https://docs.gravityrail.com/sdk/interfaces/RoutineResponse.md)> Defined in: [packages/sdk/src/client/client.ts:637](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L637) Update an existing routine. #### Parameters[​](#parameters-821 "Direct link to Parameters") ##### wid[​](#wid-684 "Direct link to wid") `string` ##### id[​](#id-116 "Direct link to id") `number` ##### routine[​](#routine-1 "Direct link to routine") [`UpdateRoutineRequest`](https://docs.gravityrail.com/sdk/interfaces/UpdateRoutineRequest.md) #### Returns[​](#returns-842 "Direct link to Returns") `Promise`<[`RoutineResponse`](https://docs.gravityrail.com/sdk/interfaces/RoutineResponse.md)> #### Implementation of[​](#implementation-of-841 "Direct link to Implementation of") `EventsBindings.updateRoutine` *** ### updateSalesforceSyncConfig()[​](#updatesalesforcesyncconfig "Direct link to updateSalesforceSyncConfig()") > **updateSalesforceSyncConfig**: (`wid`, `data`) => `Promise`<[`SalesforceSyncConfigResponse`](https://docs.gravityrail.com/sdk/interfaces/SalesforceSyncConfigResponse.md)> Defined in: [packages/sdk/src/client/client.ts:996](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L996) #### Parameters[​](#parameters-822 "Direct link to Parameters") ##### wid[​](#wid-685 "Direct link to wid") `string` ##### data[​](#data-124 "Direct link to data") [`UpdateSalesforceSyncConfigRequest`](https://docs.gravityrail.com/sdk/interfaces/UpdateSalesforceSyncConfigRequest.md) #### Returns[​](#returns-843 "Direct link to Returns") `Promise`<[`SalesforceSyncConfigResponse`](https://docs.gravityrail.com/sdk/interfaces/SalesforceSyncConfigResponse.md)> #### Implementation of[​](#implementation-of-842 "Direct link to Implementation of") `IntegrationsBindings.updateSalesforceSyncConfig` *** ### updateScenario()[​](#updatescenario "Direct link to updateScenario()") > **updateScenario**: (`wid`, `scenarioId`, `data`) => `Promise`<[`Scenario`](https://docs.gravityrail.com/sdk/type-aliases/Scenario.md)> Defined in: [packages/sdk/src/client/client.ts:303](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L303) #### Parameters[​](#parameters-823 "Direct link to Parameters") ##### wid[​](#wid-686 "Direct link to wid") `string` ##### scenarioId[​](#scenarioid-3 "Direct link to scenarioId") `number` ##### data[​](#data-125 "Direct link to data") [`UpdateScenarioRequest`](https://docs.gravityrail.com/sdk/interfaces/UpdateScenarioRequest.md) #### Returns[​](#returns-844 "Direct link to Returns") `Promise`<[`Scenario`](https://docs.gravityrail.com/sdk/type-aliases/Scenario.md)> #### Implementation of[​](#implementation-of-843 "Direct link to Implementation of") `QualificationsBindings.updateScenario` *** ### updateSite()[​](#updatesite "Direct link to updateSite()") > **updateSite**: (`wid`, `id`, `site`) => `Promise`<[`Site`](https://docs.gravityrail.com/sdk/type-aliases/Site.md)> Defined in: [packages/sdk/src/client/client.ts:569](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L569) Update a site's configuration. #### Parameters[​](#parameters-824 "Direct link to Parameters") ##### wid[​](#wid-687 "Direct link to wid") `string` ##### id[​](#id-117 "Direct link to id") `number` ##### site[​](#site-1 "Direct link to site") `Partial`<[`SiteFormData`](https://docs.gravityrail.com/sdk/interfaces/SiteFormData.md)> #### Returns[​](#returns-845 "Direct link to Returns") `Promise`<[`Site`](https://docs.gravityrail.com/sdk/type-aliases/Site.md)> #### Implementation of[​](#implementation-of-844 "Direct link to Implementation of") `SitesBindings.updateSite` *** ### updateSiteSharing()[​](#updatesitesharing "Direct link to updateSiteSharing()") > **updateSiteSharing**: (`wid`, `siteId`, `data`) => `Promise`<[`SiteSharingResponse`](https://docs.gravityrail.com/sdk/interfaces/SiteSharingResponse.md)> Defined in: [packages/sdk/src/client/client.ts:547](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L547) Update a site's sharing settings. #### Parameters[​](#parameters-825 "Direct link to Parameters") ##### wid[​](#wid-688 "Direct link to wid") `string` ##### siteId[​](#siteid-26 "Direct link to siteId") `number` ##### data[​](#data-126 "Direct link to data") [`UpdateFileSharingRequest`](https://docs.gravityrail.com/sdk/interfaces/UpdateFileSharingRequest.md) #### Returns[​](#returns-846 "Direct link to Returns") `Promise`<[`SiteSharingResponse`](https://docs.gravityrail.com/sdk/interfaces/SiteSharingResponse.md)> #### Implementation of[​](#implementation-of-845 "Direct link to Implementation of") `SitesBindings.updateSiteSharing` *** ### updateSlackApp()[​](#updateslackapp "Direct link to updateSlackApp()") > **updateSlackApp**: (`wid`, `appId`, `data`) => `Promise`<[`SlackApp`](https://docs.gravityrail.com/sdk/type-aliases/SlackApp.md)> Defined in: [packages/sdk/src/client/client.ts:904](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L904) Update an existing Slack app configuration. #### Parameters[​](#parameters-826 "Direct link to Parameters") ##### wid[​](#wid-689 "Direct link to wid") `string` ##### appId[​](#appid-14 "Direct link to appId") `number` ##### data[​](#data-127 "Direct link to data") [`UpdateSlackAppRequest`](https://docs.gravityrail.com/sdk/interfaces/UpdateSlackAppRequest.md) #### Returns[​](#returns-847 "Direct link to Returns") `Promise`<[`SlackApp`](https://docs.gravityrail.com/sdk/type-aliases/SlackApp.md)> #### Implementation of[​](#implementation-of-846 "Direct link to Implementation of") `IntegrationsBindings.updateSlackApp` *** ### updateStep()[​](#updatestep "Direct link to updateStep()") > **updateStep**: (`wid`, `journeyId`, `stepUuid`, `data`) => `Promise`<`JourneyStepResponse`> Defined in: [packages/sdk/src/client/client.ts:332](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L332) Update an existing step. #### Parameters[​](#parameters-827 "Direct link to Parameters") ##### wid[​](#wid-690 "Direct link to wid") `string` ##### journeyId[​](#journeyid-26 "Direct link to journeyId") `number` ##### stepUuid[​](#stepuuid-4 "Direct link to stepUuid") `string` ##### data[​](#data-128 "Direct link to data") `Partial`<`JourneyStepFormData`> #### Returns[​](#returns-848 "Direct link to Returns") `Promise`<`JourneyStepResponse`> #### Implementation of[​](#implementation-of-847 "Direct link to Implementation of") `JourneysBindings.updateStep` *** ### updateSubscription()[​](#updatesubscription "Direct link to updateSubscription()") > **updateSubscription**: (`subscriptionId`, `updates`) => `Promise`<{ `message`: `string`; }> Defined in: [packages/sdk/src/client/client.ts:816](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L816) Update a subscription's budget, plan period, or credit settings. #### Parameters[​](#parameters-828 "Direct link to Parameters") ##### subscriptionId[​](#subscriptionid-5 "Direct link to subscriptionId") `number` ##### updates[​](#updates-1 "Direct link to updates") ###### extraUsageEnabled?[​](#extrausageenabled "Direct link to extraUsageEnabled?") `boolean` ###### monthlyReloadLimitCents?[​](#monthlyreloadlimitcents "Direct link to monthlyReloadLimitCents?") `number` | `null` ###### planPeriod?[​](#planperiod-1 "Direct link to planPeriod?") `string` ###### reloadAmountCents?[​](#reloadamountcents "Direct link to reloadAmountCents?") `number` | `null` ###### reloadThresholdCents?[​](#reloadthresholdcents "Direct link to reloadThresholdCents?") `number` | `null` #### Returns[​](#returns-849 "Direct link to Returns") `Promise`<{ `message`: `string`; }> #### Implementation of[​](#implementation-of-848 "Direct link to Implementation of") `BillingBindings.updateSubscription` *** ### updateSupervisor()[​](#updatesupervisor "Direct link to updateSupervisor()") > **updateSupervisor**: (`wid`, `id`, `supervisor`) => `Promise`<[`CustomTool`](https://docs.gravityrail.com/sdk/type-aliases/CustomTool.md)> Defined in: [packages/sdk/src/client/client.ts:689](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L689) Update an existing supervisor with partial data. #### Parameters[​](#parameters-829 "Direct link to Parameters") ##### wid[​](#wid-691 "Direct link to wid") `string` ##### id[​](#id-118 "Direct link to id") `number` ##### supervisor[​](#supervisor-1 "Direct link to supervisor") `Partial`<[`SupervisorFormData`](https://docs.gravityrail.com/sdk/interfaces/SupervisorFormData.md)> #### Returns[​](#returns-850 "Direct link to Returns") `Promise`<[`CustomTool`](https://docs.gravityrail.com/sdk/type-aliases/CustomTool.md)> #### Implementation of[​](#implementation-of-849 "Direct link to Implementation of") `WorkflowsBindings.updateSupervisor` *** ### updateTask()[​](#updatetask "Direct link to updateTask()") > **updateTask**: (`wid`, `id`, `task`) => `Promise`<[`Task`](https://docs.gravityrail.com/sdk/type-aliases/Task.md)> Defined in: [packages/sdk/src/client/client.ts:127](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L127) Update an existing task with partial data. #### Parameters[​](#parameters-830 "Direct link to Parameters") ##### wid[​](#wid-692 "Direct link to wid") `string` ##### id[​](#id-119 "Direct link to id") `number` ##### task[​](#task-1 "Direct link to task") `Partial`<[`TaskFormData`](https://docs.gravityrail.com/sdk/interfaces/TaskFormData.md)> #### Returns[​](#returns-851 "Direct link to Returns") `Promise`<[`Task`](https://docs.gravityrail.com/sdk/type-aliases/Task.md)> #### Implementation of[​](#implementation-of-850 "Direct link to Implementation of") `TasksBindings.updateTask` *** ### updateTeamsApp()[​](#updateteamsapp "Direct link to updateTeamsApp()") > **updateTeamsApp**: (`wid`, `appId`, `data`) => `Promise`<[`TeamsAppResponse`](https://docs.gravityrail.com/sdk/interfaces/TeamsAppResponse.md)> Defined in: [packages/sdk/src/client/client.ts:914](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L914) #### Parameters[​](#parameters-831 "Direct link to Parameters") ##### wid[​](#wid-693 "Direct link to wid") `string` ##### appId[​](#appid-15 "Direct link to appId") `number` ##### data[​](#data-129 "Direct link to data") [`UpdateTeamsAppRequest`](https://docs.gravityrail.com/sdk/interfaces/UpdateTeamsAppRequest.md) #### Returns[​](#returns-852 "Direct link to Returns") `Promise`<[`TeamsAppResponse`](https://docs.gravityrail.com/sdk/interfaces/TeamsAppResponse.md)> #### Implementation of[​](#implementation-of-851 "Direct link to Implementation of") `IntegrationsBindings.updateTeamsApp` *** ### updateThemeSettings()[​](#updatethemesettings "Direct link to updateThemeSettings()") > **updateThemeSettings**: (`wid`, `siteId`, `values`) => `Promise`<[`ThemeSettingsResponse`](https://docs.gravityrail.com/sdk/interfaces/ThemeSettingsResponse.md)> Defined in: [packages/sdk/src/client/client.ts:558](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L558) Save values for the active theme's settings (validated against the schema). #### Parameters[​](#parameters-832 "Direct link to Parameters") ##### wid[​](#wid-694 "Direct link to wid") `string` ##### siteId[​](#siteid-27 "Direct link to siteId") `number` ##### values[​](#values "Direct link to values") `Record`<`string`, `unknown`> #### Returns[​](#returns-853 "Direct link to Returns") `Promise`<[`ThemeSettingsResponse`](https://docs.gravityrail.com/sdk/interfaces/ThemeSettingsResponse.md)> #### Implementation of[​](#implementation-of-852 "Direct link to Implementation of") `SitesBindings.updateThemeSettings` *** ### updateTwoFactorMethod()[​](#updatetwofactormethod "Direct link to updateTwoFactorMethod()") > **updateTwoFactorMethod**: (`data`) => `Promise`<[`TwoFactorOperationResponse`](https://docs.gravityrail.com/sdk/interfaces/TwoFactorOperationResponse.md)> Defined in: [packages/sdk/src/client/client.ts:517](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L517) Update settings for a two-factor authentication method. #### Parameters[​](#parameters-833 "Direct link to Parameters") ##### data[​](#data-130 "Direct link to data") [`UpdateTwoFactorMethodRequest`](https://docs.gravityrail.com/sdk/interfaces/UpdateTwoFactorMethodRequest.md) #### Returns[​](#returns-854 "Direct link to Returns") `Promise`<[`TwoFactorOperationResponse`](https://docs.gravityrail.com/sdk/interfaces/TwoFactorOperationResponse.md)> #### Implementation of[​](#implementation-of-853 "Direct link to Implementation of") `AuthBindings.updateTwoFactorMethod` *** ### updateUserAccount()[​](#updateuseraccount "Direct link to updateUserAccount()") > **updateUserAccount**: (`info`) => `Promise`<[`Account`](https://docs.gravityrail.com/sdk/interfaces/Account.md)> Defined in: [packages/sdk/src/client/client.ts:487](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L487) Update the authenticated user's account information. #### Parameters[​](#parameters-834 "Direct link to Parameters") ##### info[​](#info "Direct link to info") [`AccountFormData`](https://docs.gravityrail.com/sdk/interfaces/AccountFormData.md) #### Returns[​](#returns-855 "Direct link to Returns") `Promise`<[`Account`](https://docs.gravityrail.com/sdk/interfaces/Account.md)> #### Implementation of[​](#implementation-of-854 "Direct link to Implementation of") `AuthBindings.updateUserAccount` *** ### updateVoicemailStatus()[​](#updatevoicemailstatus "Direct link to updateVoicemailStatus()") > **updateVoicemailStatus**: (`wid`, `phoneNumberId`, `voicemailId`, `status`) => `Promise`<`Voicemail`> Defined in: [packages/sdk/src/client/client.ts:743](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L743) Update voicemail status. #### Parameters[​](#parameters-835 "Direct link to Parameters") ##### wid[​](#wid-695 "Direct link to wid") `string` ##### phoneNumberId[​](#phonenumberid-3 "Direct link to phoneNumberId") `number` ##### voicemailId[​](#voicemailid-1 "Direct link to voicemailId") `number` ##### status[​](#status-16 "Direct link to status") `VoicemailStatus` #### Returns[​](#returns-856 "Direct link to Returns") `Promise`<`Voicemail`> #### Implementation of[​](#implementation-of-855 "Direct link to Implementation of") `CommunicationsBindings.updateVoicemailStatus` *** ### updateWorkflow()[​](#updateworkflow "Direct link to updateWorkflow()") > **updateWorkflow**: (`wid`, `id`, `workflow`) => `Promise`<[`Workflow`](https://docs.gravityrail.com/sdk/type-aliases/Workflow.md)> Defined in: [packages/sdk/src/client/client.ts:652](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L652) Update an existing workflow. #### Parameters[​](#parameters-836 "Direct link to Parameters") ##### wid[​](#wid-696 "Direct link to wid") `string` ##### id[​](#id-120 "Direct link to id") `number` ##### workflow[​](#workflow-1 "Direct link to workflow") `Partial`<[`WorkflowFormData`](https://docs.gravityrail.com/sdk/interfaces/WorkflowFormData.md)> #### Returns[​](#returns-857 "Direct link to Returns") `Promise`<[`Workflow`](https://docs.gravityrail.com/sdk/type-aliases/Workflow.md)> #### Implementation of[​](#implementation-of-856 "Direct link to Implementation of") `WorkflowsBindings.updateWorkflow` *** ### updateWorkflowContributor()[​](#updateworkflowcontributor "Direct link to updateWorkflowContributor()") > **updateWorkflowContributor**: (`wid`, `workflowId`, `contributorId`, `data`) => `Promise`<[`WorkflowContributorResponse`](https://docs.gravityrail.com/sdk/interfaces/WorkflowContributorResponse.md)> Defined in: [packages/sdk/src/client/client.ts:670](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L670) Update a workflow contributor's settings. #### Parameters[​](#parameters-837 "Direct link to Parameters") ##### wid[​](#wid-697 "Direct link to wid") `string` ##### workflowId[​](#workflowid-17 "Direct link to workflowId") `number` ##### contributorId[​](#contributorid-1 "Direct link to contributorId") `number` ##### data[​](#data-131 "Direct link to data") [`UpdateWorkflowContributorRequest`](https://docs.gravityrail.com/sdk/interfaces/UpdateWorkflowContributorRequest.md) #### Returns[​](#returns-858 "Direct link to Returns") `Promise`<[`WorkflowContributorResponse`](https://docs.gravityrail.com/sdk/interfaces/WorkflowContributorResponse.md)> #### Implementation of[​](#implementation-of-857 "Direct link to Implementation of") `WorkflowsBindings.updateWorkflowContributor` *** ### updateWorkflowNote()[​](#updateworkflownote "Direct link to updateWorkflowNote()") > **updateWorkflowNote**: (`wid`, `workflowId`, `noteId`, `data`) => `Promise`<[`WorkflowNoteResponse`](https://docs.gravityrail.com/sdk/interfaces/WorkflowNoteResponse.md)> Defined in: [packages/sdk/src/client/client.ts:666](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L666) Update an existing workflow note with partial data. #### Parameters[​](#parameters-838 "Direct link to Parameters") ##### wid[​](#wid-698 "Direct link to wid") `string` ##### workflowId[​](#workflowid-18 "Direct link to workflowId") `number` ##### noteId[​](#noteid-3 "Direct link to noteId") `number` ##### data[​](#data-132 "Direct link to data") `Partial`<[`WorkflowNoteFormData`](https://docs.gravityrail.com/sdk/interfaces/WorkflowNoteFormData.md)> #### Returns[​](#returns-859 "Direct link to Returns") `Promise`<[`WorkflowNoteResponse`](https://docs.gravityrail.com/sdk/interfaces/WorkflowNoteResponse.md)> #### Implementation of[​](#implementation-of-858 "Direct link to Implementation of") `WorkflowsBindings.updateWorkflowNote` *** ### updateWorkflowVersion()[​](#updateworkflowversion "Direct link to updateWorkflowVersion()") > **updateWorkflowVersion**: (`wid`, `workflowUuid`, `versionNumber`, `data`) => `Promise`<`WorkflowVersionResponse`> Defined in: [packages/sdk/src/client/client.ts:676](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L676) #### Parameters[​](#parameters-839 "Direct link to Parameters") ##### wid[​](#wid-699 "Direct link to wid") `string` ##### workflowUuid[​](#workflowuuid-7 "Direct link to workflowUuid") `string` ##### versionNumber[​](#versionnumber-3 "Direct link to versionNumber") `number` ##### data[​](#data-133 "Direct link to data") `UpdateVersionRequest` #### Returns[​](#returns-860 "Direct link to Returns") `Promise`<`WorkflowVersionResponse`> #### Implementation of[​](#implementation-of-859 "Direct link to Implementation of") `WorkflowsBindings.updateWorkflowVersion` *** ### updateWorkspace()[​](#updateworkspace "Direct link to updateWorkspace()") > **updateWorkspace**: (`wid`, `workspace`) => `Promise`<[`Workspace`](https://docs.gravityrail.com/sdk/interfaces/Workspace.md)> Defined in: [packages/sdk/src/client/client.ts:404](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L404) Update an existing workspace. #### Parameters[​](#parameters-840 "Direct link to Parameters") ##### wid[​](#wid-700 "Direct link to wid") `string` ##### workspace[​](#workspace-1 "Direct link to workspace") `Partial`<[`WorkspaceFormData`](https://docs.gravityrail.com/sdk/interfaces/WorkspaceFormData.md)> #### Returns[​](#returns-861 "Direct link to Returns") `Promise`<[`Workspace`](https://docs.gravityrail.com/sdk/interfaces/Workspace.md)> #### Implementation of[​](#implementation-of-860 "Direct link to Implementation of") `WorkspacesBindings.updateWorkspace` *** ### updateWorkspaceDefaults()[​](#updateworkspacedefaults "Direct link to updateWorkspaceDefaults()") > **updateWorkspaceDefaults**: (`wid`, `defaults`) => `Promise`<[`WorkspaceDefaults`](https://docs.gravityrail.com/sdk/interfaces/WorkspaceDefaults.md)> Defined in: [packages/sdk/src/client/client.ts:408](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L408) Update the default settings for a workspace. #### Parameters[​](#parameters-841 "Direct link to Parameters") ##### wid[​](#wid-701 "Direct link to wid") `string` ##### defaults[​](#defaults "Direct link to defaults") [`WorkspaceDefaultsFormData`](https://docs.gravityrail.com/sdk/interfaces/WorkspaceDefaultsFormData.md) #### Returns[​](#returns-862 "Direct link to Returns") `Promise`<[`WorkspaceDefaults`](https://docs.gravityrail.com/sdk/interfaces/WorkspaceDefaults.md)> #### Implementation of[​](#implementation-of-861 "Direct link to Implementation of") `WorkspacesBindings.updateWorkspaceDefaults` *** ### updateWorkspaceInvitationAdmin()[​](#updateworkspaceinvitationadmin "Direct link to updateWorkspaceInvitationAdmin()") > **updateWorkspaceInvitationAdmin**: (`workspaceUuid`, `invitationId`, `data`) => `Promise`<[`InvitationResponse`](https://docs.gravityrail.com/sdk/type-aliases/InvitationResponse.md)> Defined in: [packages/sdk/src/client/client.ts:474](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L474) Update an invitation status (requires workspace admin permission). Uses the workspace-scoped route: PUT /api/v2/w/{workspaceUuid}/invitations/{id} #### Parameters[​](#parameters-842 "Direct link to Parameters") ##### workspaceUuid[​](#workspaceuuid-16 "Direct link to workspaceUuid") `string` ##### invitationId[​](#invitationid-4 "Direct link to invitationId") `number` ##### data[​](#data-134 "Direct link to data") [`UpdateInvitationFormData`](https://docs.gravityrail.com/sdk/interfaces/UpdateInvitationFormData.md) #### Returns[​](#returns-863 "Direct link to Returns") `Promise`<[`InvitationResponse`](https://docs.gravityrail.com/sdk/type-aliases/InvitationResponse.md)> #### Implementation of[​](#implementation-of-862 "Direct link to Implementation of") `WorkspacesBindings.updateWorkspaceInvitationAdmin` *** ### updateWorkspaceThemes()[​](#updateworkspacethemes "Direct link to updateWorkspaceThemes()") > **updateWorkspaceThemes**: (`wid`, `themes`) => `Promise`<[`Workspace`](https://docs.gravityrail.com/sdk/interfaces/Workspace.md)> Defined in: [packages/sdk/src/client/client.ts:440](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L440) Update the active themes for a workspace. #### Parameters[​](#parameters-843 "Direct link to Parameters") ##### wid[​](#wid-702 "Direct link to wid") `string` ##### themes[​](#themes "Direct link to themes") `string`\[] #### Returns[​](#returns-864 "Direct link to Returns") `Promise`<[`Workspace`](https://docs.gravityrail.com/sdk/interfaces/Workspace.md)> #### Implementation of[​](#implementation-of-863 "Direct link to Implementation of") `WorkspacesBindings.updateWorkspaceThemes` *** ### uploadFile()[​](#uploadfile "Direct link to uploadFile()") > **uploadFile**: (`wid`, `request`) => `Promise`<[`File`](https://docs.gravityrail.com/sdk/type-aliases/File.md)> Defined in: [packages/sdk/src/client/client.ts:591](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L591) Upload in-memory file content through the API's database-backed file path. #### Parameters[​](#parameters-844 "Direct link to Parameters") ##### wid[​](#wid-703 "Direct link to wid") `string` ##### request[​](#request-25 "Direct link to request") [`UploadFileRequest`](https://docs.gravityrail.com/sdk/interfaces/UploadFileRequest.md) #### Returns[​](#returns-865 "Direct link to Returns") `Promise`<[`File`](https://docs.gravityrail.com/sdk/type-aliases/File.md)> #### Implementation of[​](#implementation-of-864 "Direct link to Implementation of") `FilesBindings.uploadFile` *** ### upsertDataRecord()[​](#upsertdatarecord "Direct link to upsertDataRecord()") > **upsertDataRecord**: (`wid`, `dataTypeId`, `externalId`, `data`) => `Promise`<[`DataRecordResponse`](https://docs.gravityrail.com/sdk/interfaces/DataRecordResponse.md)> Defined in: [packages/sdk/src/client/client.ts:212](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L212) Upsert a data record by external ID, creating or updating as needed. #### Parameters[​](#parameters-845 "Direct link to Parameters") ##### wid[​](#wid-704 "Direct link to wid") `string` ##### dataTypeId[​](#datatypeid-8 "Direct link to dataTypeId") `number` ##### externalId[​](#externalid "Direct link to externalId") `string` | `number` ##### data[​](#data-135 "Direct link to data") ###### fieldValues[​](#fieldvalues "Direct link to fieldValues") `Record`<`string`, `any`> ###### memberExternalId?[​](#memberexternalid "Direct link to memberExternalId?") `string` | `null` ###### memberId?[​](#memberid-40 "Direct link to memberId?") `number` | `null` #### Returns[​](#returns-866 "Direct link to Returns") `Promise`<[`DataRecordResponse`](https://docs.gravityrail.com/sdk/interfaces/DataRecordResponse.md)> #### Implementation of[​](#implementation-of-865 "Direct link to Implementation of") `DataTypesBindings.upsertDataRecord` *** ### validateDataTypeSlug()[​](#validatedatatypeslug "Direct link to validateDataTypeSlug()") > **validateDataTypeSlug**: (`wid`, `slug`, `excludeId?`) => `Promise`<{ `available`: `boolean`; `suggestedSlug?`: `string`; }> Defined in: [packages/sdk/src/client/client.ts:215](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L215) Validate if a data type slug is available. Returns availability and a suggested alternative if taken. #### Parameters[​](#parameters-846 "Direct link to Parameters") ##### wid[​](#wid-705 "Direct link to wid") `string` ##### slug[​](#slug-10 "Direct link to slug") `string` ##### excludeId?[​](#excludeid "Direct link to excludeId?") `number` #### Returns[​](#returns-867 "Direct link to Returns") `Promise`<{ `available`: `boolean`; `suggestedSlug?`: `string`; }> #### Implementation of[​](#implementation-of-866 "Direct link to Implementation of") `DataTypesBindings.validateDataTypeSlug` *** ### validateMagicLink()[​](#validatemagiclink "Direct link to validateMagicLink()") > **validateMagicLink**: (`token`) => `Promise`<[`ValidateMagicLinkResponse`](https://docs.gravityrail.com/sdk/interfaces/ValidateMagicLinkResponse.md)> Defined in: [packages/sdk/src/client/client.ts:494](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L494) Validate a magic link token to complete authentication. #### Parameters[​](#parameters-847 "Direct link to Parameters") ##### token[​](#token-3 "Direct link to token") `string` #### Returns[​](#returns-868 "Direct link to Returns") `Promise`<[`ValidateMagicLinkResponse`](https://docs.gravityrail.com/sdk/interfaces/ValidateMagicLinkResponse.md)> #### Implementation of[​](#implementation-of-867 "Direct link to Implementation of") `AuthBindings.validateMagicLink` *** ### validateQuery()[​](#validatequery "Direct link to validateQuery()") > **validateQuery**: (`wid`, `query`) => `Promise`<[`ValidateQueryResponse`](https://docs.gravityrail.com/sdk/interfaces/ValidateQueryResponse.md)> Defined in: [packages/sdk/src/client/client.ts:314](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L314) Structure / field / access / cost validation without execution. #### Parameters[​](#parameters-848 "Direct link to Parameters") ##### wid[​](#wid-706 "Direct link to wid") `string` ##### query[​](#query-4 "Direct link to query") [`QueryIR`](https://docs.gravityrail.com/sdk/interfaces/QueryIR.md) #### Returns[​](#returns-869 "Direct link to Returns") `Promise`<[`ValidateQueryResponse`](https://docs.gravityrail.com/sdk/interfaces/ValidateQueryResponse.md)> #### Implementation of[​](#implementation-of-868 "Direct link to Implementation of") `QueriesBindings.validateQuery` *** ### validateWorkflowName()[​](#validateworkflowname "Direct link to validateWorkflowName()") > **validateWorkflowName**: (`wid`, `name`) => `Promise`<`ValidateNameResponse`> Defined in: [packages/sdk/src/client/client.ts:683](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L683) Validate if a workflow name is available. Returns availability and a suggested alternative if taken. #### Parameters[​](#parameters-849 "Direct link to Parameters") ##### wid[​](#wid-707 "Direct link to wid") `string` ##### name[​](#name-12 "Direct link to name") `string` #### Returns[​](#returns-870 "Direct link to Returns") `Promise`<`ValidateNameResponse`> #### Implementation of[​](#implementation-of-869 "Direct link to Implementation of") `WorkflowsBindings.validateWorkflowName` *** ### verifyCodeWith2FA()[​](#verifycodewith2fa "Direct link to verifyCodeWith2FA()") > **verifyCodeWith2FA**: (`phoneNumber`, `code`, `organizationUuid?`) => `Promise`<[`VerifyCodeResponse`](https://docs.gravityrail.com/sdk/interfaces/VerifyCodeResponse.md)> Defined in: [packages/sdk/src/client/client.ts:490](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L490) Verify an SMS code and complete authentication, handling 2FA if required. #### Parameters[​](#parameters-850 "Direct link to Parameters") ##### phoneNumber[​](#phonenumber-7 "Direct link to phoneNumber") `string` ##### code[​](#code-1 "Direct link to code") `string` ##### organizationUuid?[​](#organizationuuid-7 "Direct link to organizationUuid?") `string` #### Returns[​](#returns-871 "Direct link to Returns") `Promise`<[`VerifyCodeResponse`](https://docs.gravityrail.com/sdk/interfaces/VerifyCodeResponse.md)> #### Implementation of[​](#implementation-of-870 "Direct link to Implementation of") `AuthBindings.verifyCodeWith2FA` *** ### verifyCredentialChange()[​](#verifycredentialchange "Direct link to verifyCredentialChange()") > **verifyCredentialChange**: (`requestId`, `otpCode`) => `Promise`<[`CredentialChangeVerifyResponse`](https://docs.gravityrail.com/sdk/interfaces/CredentialChangeVerifyResponse.md)> Defined in: [packages/sdk/src/client/client.ts:520](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L520) Verify a credential change request with OTP code. On success, applies the credential change to the account. #### Parameters[​](#parameters-851 "Direct link to Parameters") ##### requestId[​](#requestid-5 "Direct link to requestId") `number` ##### otpCode[​](#otpcode "Direct link to otpCode") `string` #### Returns[​](#returns-872 "Direct link to Returns") `Promise`<[`CredentialChangeVerifyResponse`](https://docs.gravityrail.com/sdk/interfaces/CredentialChangeVerifyResponse.md)> #### Implementation of[​](#implementation-of-871 "Direct link to Implementation of") `AuthBindings.verifyCredentialChange` *** ### verifyEmail()[​](#verifyemail "Direct link to verifyEmail()") > **verifyEmail**: (`email`, `code`, `organizationUuid?`) => `Promise`<[`VerifyCodeResponse`](https://docs.gravityrail.com/sdk/interfaces/VerifyCodeResponse.md)> Defined in: [packages/sdk/src/client/client.ts:496](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L496) Verify an email code and complete authentication, handling 2FA if required. #### Parameters[​](#parameters-852 "Direct link to Parameters") ##### email[​](#email-8 "Direct link to email") `string` ##### code[​](#code-2 "Direct link to code") `string` ##### organizationUuid?[​](#organizationuuid-8 "Direct link to organizationUuid?") `string` #### Returns[​](#returns-873 "Direct link to Returns") `Promise`<[`VerifyCodeResponse`](https://docs.gravityrail.com/sdk/interfaces/VerifyCodeResponse.md)> #### Implementation of[​](#implementation-of-872 "Direct link to Implementation of") `AuthBindings.verifyEmail` *** ### verifyOrgDomainEmail()[​](#verifyorgdomainemail "Direct link to verifyOrgDomainEmail()") > **verifyOrgDomainEmail**: (`orgIdOrUuid`, `domainUuid`) => `Promise`<[`EmailVerificationResponse`](https://docs.gravityrail.com/sdk/interfaces/EmailVerificationResponse.md)> Defined in: [packages/sdk/src/client/client.ts:455](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L455) Verify email DNS records, including MX. #### Parameters[​](#parameters-853 "Direct link to Parameters") ##### orgIdOrUuid[​](#orgidoruuid-12 "Direct link to orgIdOrUuid") `string` | `number` ##### domainUuid[​](#domainuuid-8 "Direct link to domainUuid") `string` #### Returns[​](#returns-874 "Direct link to Returns") `Promise`<[`EmailVerificationResponse`](https://docs.gravityrail.com/sdk/interfaces/EmailVerificationResponse.md)> #### Implementation of[​](#implementation-of-873 "Direct link to Implementation of") `OrgBindings.verifyOrgDomainEmail` *** ### verifyOrgDomainOwnership()[​](#verifyorgdomainownership "Direct link to verifyOrgDomainOwnership()") > **verifyOrgDomainOwnership**: (`orgIdOrUuid`, `domainUuid`) => `Promise`<[`OwnershipVerificationResponse`](https://docs.gravityrail.com/sdk/interfaces/OwnershipVerificationResponse.md)> Defined in: [packages/sdk/src/client/client.ts:451](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L451) Verify domain ownership by checking the \_gravity-verify TXT record. #### Parameters[​](#parameters-854 "Direct link to Parameters") ##### orgIdOrUuid[​](#orgidoruuid-13 "Direct link to orgIdOrUuid") `string` | `number` ##### domainUuid[​](#domainuuid-9 "Direct link to domainUuid") `string` #### Returns[​](#returns-875 "Direct link to Returns") `Promise`<[`OwnershipVerificationResponse`](https://docs.gravityrail.com/sdk/interfaces/OwnershipVerificationResponse.md)> #### Implementation of[​](#implementation-of-874 "Direct link to Implementation of") `OrgBindings.verifyOrgDomainOwnership` *** ### verifyOrgDomainSite()[​](#verifyorgdomainsite "Direct link to verifyOrgDomainSite()") > **verifyOrgDomainSite**: (`orgIdOrUuid`, `domainUuid`) => `Promise`<[`SiteVerificationResponse`](https://docs.gravityrail.com/sdk/interfaces/SiteVerificationResponse.md)> Defined in: [packages/sdk/src/client/client.ts:459](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L459) Verify the site CNAME points at the Gravity Rail sites domain. #### Parameters[​](#parameters-855 "Direct link to Parameters") ##### orgIdOrUuid[​](#orgidoruuid-14 "Direct link to orgIdOrUuid") `string` | `number` ##### domainUuid[​](#domainuuid-10 "Direct link to domainUuid") `string` #### Returns[​](#returns-876 "Direct link to Returns") `Promise`<[`SiteVerificationResponse`](https://docs.gravityrail.com/sdk/interfaces/SiteVerificationResponse.md)> #### Implementation of[​](#implementation-of-875 "Direct link to Implementation of") `OrgBindings.verifyOrgDomainSite` *** ### verifyRecoveryCodeAuth()[​](#verifyrecoverycodeauth "Direct link to verifyRecoveryCodeAuth()") > **verifyRecoveryCodeAuth**: (`tempToken`, `code`) => `Promise`<{ `accountId`: `number`; `token`: `string`; }> Defined in: [packages/sdk/src/client/client.ts:512](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L512) Verify a recovery code during login to complete two-factor authentication. #### Parameters[​](#parameters-856 "Direct link to Parameters") ##### tempToken[​](#temptoken-1 "Direct link to tempToken") `string` ##### code[​](#code-3 "Direct link to code") `string` #### Returns[​](#returns-877 "Direct link to Returns") `Promise`<{ `accountId`: `number`; `token`: `string`; }> #### Implementation of[​](#implementation-of-876 "Direct link to Implementation of") `AuthBindings.verifyRecoveryCodeAuth` *** ### verifyTOTPAuth()[​](#verifytotpauth "Direct link to verifyTOTPAuth()") > **verifyTOTPAuth**: (`tempToken`, `code`) => `Promise`<{ `accountId`: `number`; `token`: `string`; }> Defined in: [packages/sdk/src/client/client.ts:511](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L511) Verify a TOTP code during login to complete two-factor authentication. #### Parameters[​](#parameters-857 "Direct link to Parameters") ##### tempToken[​](#temptoken-2 "Direct link to tempToken") `string` ##### code[​](#code-4 "Direct link to code") `string` #### Returns[​](#returns-878 "Direct link to Returns") `Promise`<{ `accountId`: `number`; `token`: `string`; }> #### Implementation of[​](#implementation-of-877 "Direct link to Implementation of") `AuthBindings.verifyTOTPAuth` *** ### verifyTOTPSetup()[​](#verifytotpsetup "Direct link to verifyTOTPSetup()") > **verifyTOTPSetup**: (`data`) => `Promise`<[`TwoFactorOperationResponse`](https://docs.gravityrail.com/sdk/interfaces/TwoFactorOperationResponse.md)> Defined in: [packages/sdk/src/client/client.ts:508](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L508) Verify a TOTP code to complete two-factor setup. #### Parameters[​](#parameters-858 "Direct link to Parameters") ##### data[​](#data-136 "Direct link to data") [`VerifyTOTPSetupRequest`](https://docs.gravityrail.com/sdk/interfaces/VerifyTOTPSetupRequest.md) #### Returns[​](#returns-879 "Direct link to Returns") `Promise`<[`TwoFactorOperationResponse`](https://docs.gravityrail.com/sdk/interfaces/TwoFactorOperationResponse.md)> #### Implementation of[​](#implementation-of-878 "Direct link to Implementation of") `AuthBindings.verifyTOTPSetup` *** ### verifyWebAuthnAuth()[​](#verifywebauthnauth "Direct link to verifyWebAuthnAuth()") > **verifyWebAuthnAuth**: (`tempToken`, `assertionResponse`) => `Promise`<{ `accountId`: `number`; `token`: `string`; }> Defined in: [packages/sdk/src/client/client.ts:514](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L514) Verify a WebAuthn assertion during login to complete two-factor authentication. #### Parameters[​](#parameters-859 "Direct link to Parameters") ##### tempToken[​](#temptoken-3 "Direct link to tempToken") `string` ##### assertionResponse[​](#assertionresponse "Direct link to assertionResponse") `any` #### Returns[​](#returns-880 "Direct link to Returns") `Promise`<{ `accountId`: `number`; `token`: `string`; }> #### Implementation of[​](#implementation-of-879 "Direct link to Implementation of") `AuthBindings.verifyWebAuthnAuth` *** ### verifyWebAuthnSetup()[​](#verifywebauthnsetup "Direct link to verifyWebAuthnSetup()") > **verifyWebAuthnSetup**: (`data`) => `Promise`<[`TwoFactorOperationResponse`](https://docs.gravityrail.com/sdk/interfaces/TwoFactorOperationResponse.md)> Defined in: [packages/sdk/src/client/client.ts:510](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L510) Verify a WebAuthn assertion to complete two-factor setup. #### Parameters[​](#parameters-860 "Direct link to Parameters") ##### data[​](#data-137 "Direct link to data") [`VerifyWebAuthnSetupRequest`](https://docs.gravityrail.com/sdk/interfaces/VerifyWebAuthnSetupRequest.md) #### Returns[​](#returns-881 "Direct link to Returns") `Promise`<[`TwoFactorOperationResponse`](https://docs.gravityrail.com/sdk/interfaces/TwoFactorOperationResponse.md)> #### Implementation of[​](#implementation-of-880 "Direct link to Implementation of") `AuthBindings.verifyWebAuthnSetup` *** ### workspaceInvitations[​](#workspaceinvitations "Direct link to workspaceInvitations") > **workspaceInvitations**: `WorkspaceInvitationsApi` Defined in: [packages/sdk/src/client/client.ts:118](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L118) ## Methods[​](#methods "Direct link to Methods") ### getActingMember()[​](#getactingmember "Direct link to getActingMember()") > **getActingMember**(): `string` | `undefined` Defined in: [packages/sdk/src/client/client.ts:1273](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L1273) Get the current acting member UUID. Returns undefined if no member switch is active. #### Returns[​](#returns-882 "Direct link to Returns") `string` | `undefined` *** ### setActingMember()[​](#setactingmember "Direct link to setActingMember()") > **setActingMember**(`memberUuid`): `void` Defined in: [packages/sdk/src/client/client.ts:1261](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L1261) Set the acting member UUID for member identity switching. When set, all API requests will include the X-Acting-Member header. The backend will validate that the authenticated account owns this member and use it as the effective identity for the request. Propagates to all API modules. #### Parameters[​](#parameters-861 "Direct link to Parameters") ##### memberUuid[​](#memberuuid-1 "Direct link to memberUuid") `string` | `undefined` #### Returns[​](#returns-883 "Direct link to Returns") `void` *** ### setEnhancedAuthHandler()[​](#setenhancedauthhandler "Direct link to setEnhancedAuthHandler()") > **setEnhancedAuthHandler**(`handler`): `void` Defined in: [packages/sdk/src/client/client.ts:1191](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L1191) Set the handler for enhanced authentication requirements (RFC 9470 Step-Up Auth). This handler is called when a 401 response includes WWW-Authenticate header with error="insufficient\_user\_authentication". Propagates to all API modules. #### Parameters[​](#parameters-862 "Direct link to Parameters") ##### handler[​](#handler "Direct link to handler") [`EnhancedAuthHandler`](https://docs.gravityrail.com/sdk/type-aliases/EnhancedAuthHandler.md) | `undefined` #### Returns[​](#returns-884 "Direct link to Returns") `void` *** ### setOrgAuthHandler()[​](#setorgauthhandler "Direct link to setOrgAuthHandler()") > **setOrgAuthHandler**(`handler`): `void` Defined in: [packages/sdk/src/client/client.ts:1206](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L1206) Set the handler for organization authentication requirements. This handler is called when a 401 response includes WWW-Authenticate header with realm="org". Propagates to all API modules. #### Parameters[​](#parameters-863 "Direct link to Parameters") ##### handler[​](#handler-1 "Direct link to handler") [`OrgAuthHandler`](https://docs.gravityrail.com/sdk/type-aliases/OrgAuthHandler.md) | `undefined` #### Returns[​](#returns-885 "Direct link to Returns") `void` *** ### setOrgSession()[​](#setorgsession "Direct link to setOrgSession()") > **setOrgSession**(`session`, `orgUuid?`): `void` Defined in: [packages/sdk/src/client/client.ts:1226](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L1226) Set the org session credential for cross-domain / non-browser clients (e.g. CLI). Opaque gr\_sess\_ values use X-Org-Session. Legacy orgToken JWE values still use X-Org-Token during the migration window. `orgUuid` is the org that issued the session. Pass it so the SDK can detect a stale session (e.g. switching orgs mid-session) and re-fire the org-auth handler instead of silently 401-ing. Propagates to all API modules. #### Parameters[​](#parameters-864 "Direct link to Parameters") ##### session[​](#session "Direct link to session") `string` | `undefined` ##### orgUuid?[​](#orguuid-14 "Direct link to orgUuid?") `string` #### Returns[​](#returns-886 "Direct link to Returns") `void` *** ### ~~setOrgToken()~~[​](#setorgtoken "Direct link to setorgtoken") > **setOrgToken**(`token`, `orgUuid?`): `void` Defined in: [packages/sdk/src/client/client.ts:1238](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L1238) #### Parameters[​](#parameters-865 "Direct link to Parameters") ##### token[​](#token-4 "Direct link to token") `string` | `undefined` ##### orgUuid?[​](#orguuid-15 "Direct link to orgUuid?") `string` #### Returns[​](#returns-887 "Direct link to Returns") `void` #### Deprecated[​](#deprecated "Direct link to Deprecated") Legacy compatibility for stateless orgToken JWE credentials. Prefer setOrgSession() for opaque org browser sessions. *** ### updateApiKey()[​](#updateapikey "Direct link to updateApiKey()") > **updateApiKey**(`newApiKey`): `void` Defined in: [packages/sdk/src/client/client.ts:1246](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L1246) Update the API key across all modules. Used after successful re-authentication. #### Parameters[​](#parameters-866 "Direct link to Parameters") ##### newApiKey[​](#newapikey "Direct link to newApiKey") `string` #### Returns[​](#returns-888 "Direct link to Returns") `void` *** ### workspace()[​](#workspace-2 "Direct link to workspace()") > **workspace**(`workspaceUuid`): [`GravityRailWorkspaceClient`](https://docs.gravityrail.com/sdk/type-aliases/GravityRailWorkspaceClient.md) Defined in: [packages/sdk/src/client/client.ts:1181](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/client.ts#L1181) Return a workspace-scoped client facade. Methods on the returned client are the same public SDK methods, but with the workspace UUID pre-bound: ``` const workspace = client.workspace("workspace-uuid"); await workspace.getAccessGrants({ status: "approved" }); ``` #### Parameters[​](#parameters-867 "Direct link to Parameters") ##### workspaceUuid[​](#workspaceuuid-17 "Direct link to workspaceUuid") `string` #### Returns[​](#returns-889 "Direct link to Returns") [`GravityRailWorkspaceClient`](https://docs.gravityrail.com/sdk/type-aliases/GravityRailWorkspaceClient.md) --- # Class: JourneyBuilder Defined in: [packages/sdk/src/workspace-builder/journeys.ts:70](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/journeys.ts#L70) ## Extends[​](#extends "Direct link to Extends") * `WorkspaceBuilderResource` ## Constructors[​](#constructors "Direct link to Constructors") ### Constructor[​](#constructor "Direct link to Constructor") > **new JourneyBuilder**(`name`, `options?`): `JourneyBuilder` Defined in: [packages/sdk/src/workspace-builder/journeys.ts:75](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/journeys.ts#L75) #### Parameters[​](#parameters "Direct link to Parameters") ##### name[​](#name "Direct link to name") `string` ##### options?[​](#options "Direct link to options?") `AnyRecord` = `{}` #### Returns[​](#returns "Direct link to Returns") `JourneyBuilder` #### Overrides[​](#overrides "Direct link to Overrides") `WorkspaceBuilderResource.constructor` ## Properties[​](#properties "Direct link to Properties") ### \_created[​](#_created "Direct link to _created") > **\_created**: `boolean` = `false` Defined in: [packages/sdk/src/workspace-builder/resource.ts:23](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/resource.ts#L23) #### Inherited from[​](#inherited-from "Direct link to Inherited from") `WorkspaceBuilderResource._created` *** ### \_existed[​](#_existed "Direct link to _existed") > **\_existed**: `boolean` = `false` Defined in: [packages/sdk/src/workspace-builder/resource.ts:24](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/resource.ts#L24) #### Inherited from[​](#inherited-from-1 "Direct link to Inherited from") `WorkspaceBuilderResource._existed` *** ### \_id?[​](#_id "Direct link to _id?") > `optional` **\_id**: `number` Defined in: [packages/sdk/src/workspace-builder/resource.ts:21](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/resource.ts#L21) #### Inherited from[​](#inherited-from-2 "Direct link to Inherited from") `WorkspaceBuilderResource._id` *** ### \_uuid?[​](#_uuid "Direct link to _uuid?") > `optional` **\_uuid**: `string` Defined in: [packages/sdk/src/workspace-builder/resource.ts:22](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/resource.ts#L22) #### Inherited from[​](#inherited-from-3 "Direct link to Inherited from") `WorkspaceBuilderResource._uuid` *** ### description[​](#description "Direct link to description") > `readonly` **description**: `string` Defined in: [packages/sdk/src/workspace-builder/journeys.ts:71](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/journeys.ts#L71) *** ### goals[​](#goals "Direct link to goals") > `readonly` **goals**: `JourneyGoalDraft`\[] = `[]` Defined in: [packages/sdk/src/workspace-builder/journeys.ts:73](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/journeys.ts#L73) *** ### name[​](#name-1 "Direct link to name") > `readonly` **name**: `string` Defined in: [packages/sdk/src/workspace-builder/journeys.ts:76](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/journeys.ts#L76) *** ### steps[​](#steps "Direct link to steps") > `readonly` **steps**: [`JourneyStepBuilder`](https://docs.gravityrail.com/sdk/classes/JourneyStepBuilder.md)\[] = `[]` Defined in: [packages/sdk/src/workspace-builder/journeys.ts:72](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/journeys.ts#L72) ## Accessors[​](#accessors "Direct link to Accessors") ### id[​](#id "Direct link to id") #### Get Signature[​](#get-signature "Direct link to Get Signature") > **get** **id**(): `number` Defined in: [packages/sdk/src/workspace-builder/resource.ts:27](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/resource.ts#L27) Server-assigned numeric id — available after apply() or adopt(). ##### Returns[​](#returns-1 "Direct link to Returns") `number` #### Inherited from[​](#inherited-from-4 "Direct link to Inherited from") `WorkspaceBuilderResource.id` *** ### uuid[​](#uuid "Direct link to uuid") #### Get Signature[​](#get-signature-1 "Direct link to Get Signature") > **get** **uuid**(): `string` Defined in: [packages/sdk/src/workspace-builder/resource.ts:38](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/resource.ts#L38) Server-assigned uuid — available after apply() or adopt(). ##### Returns[​](#returns-2 "Direct link to Returns") `string` #### Inherited from[​](#inherited-from-5 "Direct link to Inherited from") `WorkspaceBuilderResource.uuid` ## Methods[​](#methods "Direct link to Methods") ### adopt()[​](#adopt "Direct link to adopt()") > **adopt**(`existing`): `void` Defined in: [packages/sdk/src/workspace-builder/resource.ts:55](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/resource.ts#L55) #### Parameters[​](#parameters-1 "Direct link to Parameters") ##### existing[​](#existing "Direct link to existing") `AnyRecord` #### Returns[​](#returns-3 "Direct link to Returns") `void` #### Inherited from[​](#inherited-from-6 "Direct link to Inherited from") `WorkspaceBuilderResource.adopt` *** ### apply()[​](#apply "Direct link to apply()") > **apply**(`client`): `Promise`<`void`> Defined in: [packages/sdk/src/workspace-builder/journeys.ts:114](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/journeys.ts#L114) #### Parameters[​](#parameters-2 "Direct link to Parameters") ##### client[​](#client "Direct link to client") [`GravityRailWorkspaceClient`](https://docs.gravityrail.com/sdk/type-aliases/GravityRailWorkspaceClient.md) #### Returns[​](#returns-4 "Direct link to Returns") `Promise`<`void`> #### Overrides[​](#overrides-1 "Direct link to Overrides") `WorkspaceBuilderResource.apply` *** ### goal()[​](#goal "Direct link to goal()") > **goal**(`name`, `options?`): `JourneyBuilder` Defined in: [packages/sdk/src/workspace-builder/journeys.ts:95](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/journeys.ts#L95) #### Parameters[​](#parameters-3 "Direct link to Parameters") ##### name[​](#name-2 "Direct link to name") `string` ##### options?[​](#options-1 "Direct link to options?") `AnyRecord` = `{}` #### Returns[​](#returns-5 "Direct link to Returns") `JourneyBuilder` *** ### matchKey()[​](#matchkey "Direct link to matchKey()") > **matchKey**(): `string` | `undefined` Defined in: [packages/sdk/src/workspace-builder/resource.ts:51](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/resource.ts#L51) #### Returns[​](#returns-6 "Direct link to Returns") `string` | `undefined` #### Inherited from[​](#inherited-from-7 "Direct link to Inherited from") `WorkspaceBuilderResource.matchKey` *** ### planLine()[​](#planline "Direct link to planLine()") > **planLine**(): `string` Defined in: [packages/sdk/src/workspace-builder/journeys.ts:107](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/journeys.ts#L107) #### Returns[​](#returns-7 "Direct link to Returns") `string` #### Overrides[​](#overrides-2 "Direct link to Overrides") `WorkspaceBuilderResource.planLine` *** ### step()[​](#step "Direct link to step()") > **step**(`name`, `options?`): [`JourneyStepBuilder`](https://docs.gravityrail.com/sdk/classes/JourneyStepBuilder.md) Defined in: [packages/sdk/src/workspace-builder/journeys.ts:83](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/journeys.ts#L83) #### Parameters[​](#parameters-4 "Direct link to Parameters") ##### name[​](#name-3 "Direct link to name") `string` ##### options?[​](#options-2 "Direct link to options?") `AnyRecord` = `{}` #### Returns[​](#returns-8 "Direct link to Returns") [`JourneyStepBuilder`](https://docs.gravityrail.com/sdk/classes/JourneyStepBuilder.md) --- # Class: JourneyStepBuilder Defined in: [packages/sdk/src/workspace-builder/journeys.ts:28](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/journeys.ts#L28) ## Extends[​](#extends "Direct link to Extends") * `WorkspaceBuilderResource` ## Constructors[​](#constructors "Direct link to Constructors") ### Constructor[​](#constructor "Direct link to Constructor") > **new JourneyStepBuilder**(`name`, `journey`, `order?`, `workflow?`, `description?`): `JourneyStepBuilder` Defined in: [packages/sdk/src/workspace-builder/journeys.ts:31](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/journeys.ts#L31) #### Parameters[​](#parameters "Direct link to Parameters") ##### name[​](#name "Direct link to name") `string` ##### journey[​](#journey "Direct link to journey") [`JourneyBuilder`](https://docs.gravityrail.com/sdk/classes/JourneyBuilder.md) ##### order?[​](#order "Direct link to order?") `number` = `0` ##### workflow?[​](#workflow "Direct link to workflow?") [`WorkflowBuilder`](https://docs.gravityrail.com/sdk/classes/WorkflowBuilder.md) ##### description?[​](#description "Direct link to description?") `string` = `''` #### Returns[​](#returns "Direct link to Returns") `JourneyStepBuilder` #### Overrides[​](#overrides "Direct link to Overrides") `WorkspaceBuilderResource.constructor` ## Properties[​](#properties "Direct link to Properties") ### \_created[​](#_created "Direct link to _created") > **\_created**: `boolean` = `false` Defined in: [packages/sdk/src/workspace-builder/resource.ts:23](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/resource.ts#L23) #### Inherited from[​](#inherited-from "Direct link to Inherited from") `WorkspaceBuilderResource._created` *** ### \_existed[​](#_existed "Direct link to _existed") > **\_existed**: `boolean` = `false` Defined in: [packages/sdk/src/workspace-builder/resource.ts:24](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/resource.ts#L24) #### Inherited from[​](#inherited-from-1 "Direct link to Inherited from") `WorkspaceBuilderResource._existed` *** ### \_id?[​](#_id "Direct link to _id?") > `optional` **\_id**: `number` Defined in: [packages/sdk/src/workspace-builder/resource.ts:21](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/resource.ts#L21) #### Inherited from[​](#inherited-from-2 "Direct link to Inherited from") `WorkspaceBuilderResource._id` *** ### \_uuid?[​](#_uuid "Direct link to _uuid?") > `optional` **\_uuid**: `string` Defined in: [packages/sdk/src/workspace-builder/resource.ts:22](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/resource.ts#L22) #### Inherited from[​](#inherited-from-3 "Direct link to Inherited from") `WorkspaceBuilderResource._uuid` *** ### connections[​](#connections "Direct link to connections") > `readonly` **connections**: `StepConnectionDraft`\[] = `[]` Defined in: [packages/sdk/src/workspace-builder/journeys.ts:29](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/journeys.ts#L29) *** ### description[​](#description-1 "Direct link to description") > `readonly` **description**: `string` = `''` Defined in: [packages/sdk/src/workspace-builder/journeys.ts:36](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/journeys.ts#L36) *** ### journey[​](#journey-1 "Direct link to journey") > `readonly` **journey**: [`JourneyBuilder`](https://docs.gravityrail.com/sdk/classes/JourneyBuilder.md) Defined in: [packages/sdk/src/workspace-builder/journeys.ts:33](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/journeys.ts#L33) *** ### name[​](#name-1 "Direct link to name") > `readonly` **name**: `string` Defined in: [packages/sdk/src/workspace-builder/journeys.ts:32](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/journeys.ts#L32) *** ### order[​](#order-1 "Direct link to order") > `readonly` **order**: `number` = `0` Defined in: [packages/sdk/src/workspace-builder/journeys.ts:34](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/journeys.ts#L34) *** ### workflow?[​](#workflow-1 "Direct link to workflow?") > `readonly` `optional` **workflow**: [`WorkflowBuilder`](https://docs.gravityrail.com/sdk/classes/WorkflowBuilder.md) Defined in: [packages/sdk/src/workspace-builder/journeys.ts:35](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/journeys.ts#L35) ## Accessors[​](#accessors "Direct link to Accessors") ### id[​](#id "Direct link to id") #### Get Signature[​](#get-signature "Direct link to Get Signature") > **get** **id**(): `number` Defined in: [packages/sdk/src/workspace-builder/resource.ts:27](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/resource.ts#L27) Server-assigned numeric id — available after apply() or adopt(). ##### Returns[​](#returns-1 "Direct link to Returns") `number` #### Inherited from[​](#inherited-from-4 "Direct link to Inherited from") `WorkspaceBuilderResource.id` *** ### uuid[​](#uuid "Direct link to uuid") #### Get Signature[​](#get-signature-1 "Direct link to Get Signature") > **get** **uuid**(): `string` Defined in: [packages/sdk/src/workspace-builder/resource.ts:38](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/resource.ts#L38) Server-assigned uuid — available after apply() or adopt(). ##### Returns[​](#returns-2 "Direct link to Returns") `string` #### Inherited from[​](#inherited-from-5 "Direct link to Inherited from") `WorkspaceBuilderResource.uuid` ## Methods[​](#methods "Direct link to Methods") ### adopt()[​](#adopt "Direct link to adopt()") > **adopt**(`existing`): `void` Defined in: [packages/sdk/src/workspace-builder/resource.ts:55](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/resource.ts#L55) #### Parameters[​](#parameters-1 "Direct link to Parameters") ##### existing[​](#existing "Direct link to existing") `AnyRecord` #### Returns[​](#returns-3 "Direct link to Returns") `void` #### Inherited from[​](#inherited-from-6 "Direct link to Inherited from") `WorkspaceBuilderResource.adopt` *** ### apply()[​](#apply "Direct link to apply()") > **apply**(`client`): `Promise`<`void`> Defined in: [packages/sdk/src/workspace-builder/journeys.ts:55](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/journeys.ts#L55) #### Parameters[​](#parameters-2 "Direct link to Parameters") ##### client[​](#client "Direct link to client") [`GravityRailWorkspaceClient`](https://docs.gravityrail.com/sdk/type-aliases/GravityRailWorkspaceClient.md) #### Returns[​](#returns-4 "Direct link to Returns") `Promise`<`void`> #### Overrides[​](#overrides-1 "Direct link to Overrides") `WorkspaceBuilderResource.apply` *** ### connectsTo()[​](#connectsto "Direct link to connectsTo()") > **connectsTo**(`child`, `condition?`, `required?`, `timeoutSeconds?`): `JourneyStepBuilder` Defined in: [packages/sdk/src/workspace-builder/journeys.ts:41](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/journeys.ts#L41) #### Parameters[​](#parameters-3 "Direct link to Parameters") ##### child[​](#child "Direct link to child") `JourneyStepBuilder` ##### condition?[​](#condition "Direct link to condition?") `string` ##### required?[​](#required "Direct link to required?") `boolean` = `false` ##### timeoutSeconds?[​](#timeoutseconds "Direct link to timeoutSeconds?") `number` #### Returns[​](#returns-5 "Direct link to Returns") `JourneyStepBuilder` *** ### matchKey()[​](#matchkey "Direct link to matchKey()") > **matchKey**(): `string` | `undefined` Defined in: [packages/sdk/src/workspace-builder/resource.ts:51](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/resource.ts#L51) #### Returns[​](#returns-6 "Direct link to Returns") `string` | `undefined` #### Inherited from[​](#inherited-from-7 "Direct link to Inherited from") `WorkspaceBuilderResource.matchKey` *** ### planLine()[​](#planline "Direct link to planLine()") > **planLine**(): `string` Defined in: [packages/sdk/src/workspace-builder/journeys.ts:51](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/journeys.ts#L51) #### Returns[​](#returns-7 "Direct link to Returns") `string` #### Overrides[​](#overrides-2 "Direct link to Overrides") `WorkspaceBuilderResource.planLine` --- # Class: MemberFilterBuilder Defined in: [packages/sdk/src/workspace-builder/automation.ts:17](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/automation.ts#L17) ## Extends[​](#extends "Direct link to Extends") * `WorkspaceBuilderResource` ## Constructors[​](#constructors "Direct link to Constructors") ### Constructor[​](#constructor "Direct link to Constructor") > **new MemberFilterBuilder**(`name`, `options?`): `MemberFilterBuilder` Defined in: [packages/sdk/src/workspace-builder/automation.ts:21](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/automation.ts#L21) #### Parameters[​](#parameters "Direct link to Parameters") ##### name[​](#name "Direct link to name") `string` ##### options?[​](#options "Direct link to options?") `AnyRecord` = `{}` #### Returns[​](#returns "Direct link to Returns") `MemberFilterBuilder` #### Overrides[​](#overrides "Direct link to Overrides") `WorkspaceBuilderResource.constructor` ## Properties[​](#properties "Direct link to Properties") ### \_created[​](#_created "Direct link to _created") > **\_created**: `boolean` = `false` Defined in: [packages/sdk/src/workspace-builder/resource.ts:23](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/resource.ts#L23) #### Inherited from[​](#inherited-from "Direct link to Inherited from") `WorkspaceBuilderResource._created` *** ### \_existed[​](#_existed "Direct link to _existed") > **\_existed**: `boolean` = `false` Defined in: [packages/sdk/src/workspace-builder/resource.ts:24](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/resource.ts#L24) #### Inherited from[​](#inherited-from-1 "Direct link to Inherited from") `WorkspaceBuilderResource._existed` *** ### \_id?[​](#_id "Direct link to _id?") > `optional` **\_id**: `number` Defined in: [packages/sdk/src/workspace-builder/resource.ts:21](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/resource.ts#L21) #### Inherited from[​](#inherited-from-2 "Direct link to Inherited from") `WorkspaceBuilderResource._id` *** ### \_uuid?[​](#_uuid "Direct link to _uuid?") > `optional` **\_uuid**: `string` Defined in: [packages/sdk/src/workspace-builder/resource.ts:22](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/resource.ts#L22) #### Inherited from[​](#inherited-from-3 "Direct link to Inherited from") `WorkspaceBuilderResource._uuid` *** ### description[​](#description "Direct link to description") > `readonly` **description**: `string` Defined in: [packages/sdk/src/workspace-builder/automation.ts:18](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/automation.ts#L18) *** ### name[​](#name-1 "Direct link to name") > `readonly` **name**: `string` Defined in: [packages/sdk/src/workspace-builder/automation.ts:22](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/automation.ts#L22) *** ### rules[​](#rules "Direct link to rules") > `readonly` **rules**: [`MemberFilterRuleFormData`](https://docs.gravityrail.com/sdk/interfaces/MemberFilterRuleFormData.md)\[] = `[]` Defined in: [packages/sdk/src/workspace-builder/automation.ts:19](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/automation.ts#L19) ## Accessors[​](#accessors "Direct link to Accessors") ### id[​](#id "Direct link to id") #### Get Signature[​](#get-signature "Direct link to Get Signature") > **get** **id**(): `number` Defined in: [packages/sdk/src/workspace-builder/resource.ts:27](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/resource.ts#L27) Server-assigned numeric id — available after apply() or adopt(). ##### Returns[​](#returns-1 "Direct link to Returns") `number` #### Inherited from[​](#inherited-from-4 "Direct link to Inherited from") `WorkspaceBuilderResource.id` *** ### uuid[​](#uuid "Direct link to uuid") #### Get Signature[​](#get-signature-1 "Direct link to Get Signature") > **get** **uuid**(): `string` Defined in: [packages/sdk/src/workspace-builder/resource.ts:38](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/resource.ts#L38) Server-assigned uuid — available after apply() or adopt(). ##### Returns[​](#returns-2 "Direct link to Returns") `string` #### Inherited from[​](#inherited-from-5 "Direct link to Inherited from") `WorkspaceBuilderResource.uuid` ## Methods[​](#methods "Direct link to Methods") ### addRule()[​](#addrule "Direct link to addRule()") > **addRule**(`objectType`, `filterType`, `options?`): `MemberFilterBuilder` Defined in: [packages/sdk/src/workspace-builder/automation.ts:29](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/automation.ts#L29) #### Parameters[​](#parameters-1 "Direct link to Parameters") ##### objectType[​](#objecttype "Direct link to objectType") [`MemberFilterObjectType`](https://docs.gravityrail.com/sdk/type-aliases/MemberFilterObjectType.md) ##### filterType[​](#filtertype "Direct link to filterType") [`MemberFilterFilterType`](https://docs.gravityrail.com/sdk/type-aliases/MemberFilterFilterType.md) ##### options?[​](#options-1 "Direct link to options?") ###### objectIds?[​](#objectids "Direct link to objectIds?") `number`\[] ###### query?[​](#query "Direct link to query?") `string` #### Returns[​](#returns-3 "Direct link to Returns") `MemberFilterBuilder` *** ### adopt()[​](#adopt "Direct link to adopt()") > **adopt**(`existing`): `void` Defined in: [packages/sdk/src/workspace-builder/resource.ts:55](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/resource.ts#L55) #### Parameters[​](#parameters-2 "Direct link to Parameters") ##### existing[​](#existing "Direct link to existing") `AnyRecord` #### Returns[​](#returns-4 "Direct link to Returns") `void` #### Inherited from[​](#inherited-from-6 "Direct link to Inherited from") `WorkspaceBuilderResource.adopt` *** ### apply()[​](#apply "Direct link to apply()") > **apply**(`client`): `Promise`<`void`> Defined in: [packages/sdk/src/workspace-builder/automation.ts:47](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/automation.ts#L47) #### Parameters[​](#parameters-3 "Direct link to Parameters") ##### client[​](#client "Direct link to client") [`GravityRailWorkspaceClient`](https://docs.gravityrail.com/sdk/type-aliases/GravityRailWorkspaceClient.md) #### Returns[​](#returns-5 "Direct link to Returns") `Promise`<`void`> #### Overrides[​](#overrides-1 "Direct link to Overrides") `WorkspaceBuilderResource.apply` *** ### matchKey()[​](#matchkey "Direct link to matchKey()") > **matchKey**(): `string` | `undefined` Defined in: [packages/sdk/src/workspace-builder/resource.ts:51](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/resource.ts#L51) #### Returns[​](#returns-6 "Direct link to Returns") `string` | `undefined` #### Inherited from[​](#inherited-from-7 "Direct link to Inherited from") `WorkspaceBuilderResource.matchKey` *** ### planLine()[​](#planline "Direct link to planLine()") > **planLine**(): `string` Defined in: [packages/sdk/src/workspace-builder/automation.ts:43](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/automation.ts#L43) #### Returns[​](#returns-7 "Direct link to Returns") `string` #### Overrides[​](#overrides-2 "Direct link to Overrides") `WorkspaceBuilderResource.planLine` --- # Class: MemberImportValidationError Defined in: [packages/sdk/src/api/members.ts:56](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/members.ts#L56) Thrown by previewImportMembers / importMembers when the server returns a structured validation-error payload (`{ message, errors: string[] }`). Carries the per-row error strings (column/field names only — PHI-safe by the server contract) on a typed field instead of an untyped `(error as any)` cast. ## Extends[​](#extends "Direct link to Extends") * `Error` ## Constructors[​](#constructors "Direct link to Constructors") ### Constructor[​](#constructor "Direct link to Constructor") > **new MemberImportValidationError**(`message`, `validationErrors`): `MemberImportValidationError` Defined in: [packages/sdk/src/api/members.ts:59](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/members.ts#L59) #### Parameters[​](#parameters "Direct link to Parameters") ##### message[​](#message "Direct link to message") `string` ##### validationErrors[​](#validationerrors "Direct link to validationErrors") `string`\[] #### Returns[​](#returns "Direct link to Returns") `MemberImportValidationError` #### Overrides[​](#overrides "Direct link to Overrides") `Error.constructor` ## Properties[​](#properties "Direct link to Properties") ### cause?[​](#cause "Direct link to cause?") > `optional` **cause**: `unknown` Defined in: node\_modules/typescript/lib/lib.es2022.error.d.ts:24 #### Inherited from[​](#inherited-from "Direct link to Inherited from") `Error.cause` *** ### message[​](#message-1 "Direct link to message") > **message**: `string` Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1075 #### Inherited from[​](#inherited-from-1 "Direct link to Inherited from") `Error.message` *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1074 #### Inherited from[​](#inherited-from-2 "Direct link to Inherited from") `Error.name` *** ### stack?[​](#stack "Direct link to stack?") > `optional` **stack**: `string` Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1076 #### Inherited from[​](#inherited-from-3 "Direct link to Inherited from") `Error.stack` *** ### stackTraceLimit[​](#stacktracelimit "Direct link to stackTraceLimit") > `static` **stackTraceLimit**: `number` Defined in: node\_modules/@types/node/globals.d.ts:67 The `Error.stackTraceLimit` property specifies the number of stack frames collected by a stack trace (whether generated by `new Error().stack` or `Error.captureStackTrace(obj)`). The default value is `10` but may be set to any valid JavaScript number. Changes will affect any stack trace captured *after* the value has been changed. If set to a non-number value, or set to a negative number, stack traces will not capture any frames. #### Inherited from[​](#inherited-from-4 "Direct link to Inherited from") `Error.stackTraceLimit` *** ### validationErrors[​](#validationerrors-1 "Direct link to validationErrors") > `readonly` **validationErrors**: `string`\[] Defined in: [packages/sdk/src/api/members.ts:57](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/members.ts#L57) ## Methods[​](#methods "Direct link to Methods") ### captureStackTrace()[​](#capturestacktrace "Direct link to captureStackTrace()") > `static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` Defined in: node\_modules/@types/node/globals.d.ts:51 Creates a `.stack` property on `targetObject`, which when accessed returns a string representing the location in the code at which `Error.captureStackTrace()` was called. ``` const myObject = {}; Error.captureStackTrace(myObject); myObject.stack; // Similar to `new Error().stack` ``` The first line of the trace will be prefixed with `${myObject.name}: ${myObject.message}`. The optional `constructorOpt` argument accepts a function. If given, all frames above `constructorOpt`, including `constructorOpt`, will be omitted from the generated stack trace. The `constructorOpt` argument is useful for hiding implementation details of error generation from the user. For instance: ``` function a() { b(); } function b() { c(); } function c() { // Create an error without stack trace to avoid calculating the stack trace twice. const { stackTraceLimit } = Error; Error.stackTraceLimit = 0; const error = new Error(); Error.stackTraceLimit = stackTraceLimit; // Capture the stack trace above function b Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace throw error; } a(); ``` #### Parameters[​](#parameters-1 "Direct link to Parameters") ##### targetObject[​](#targetobject "Direct link to targetObject") `object` ##### constructorOpt?[​](#constructoropt "Direct link to constructorOpt?") `Function` #### Returns[​](#returns-1 "Direct link to Returns") `void` #### Inherited from[​](#inherited-from-5 "Direct link to Inherited from") `Error.captureStackTrace` *** ### prepareStackTrace()[​](#preparestacktrace "Direct link to prepareStackTrace()") > `static` **prepareStackTrace**(`err`, `stackTraces`): `any` Defined in: node\_modules/@types/node/globals.d.ts:55 #### Parameters[​](#parameters-2 "Direct link to Parameters") ##### err[​](#err "Direct link to err") `Error` ##### stackTraces[​](#stacktraces "Direct link to stackTraces") `CallSite`\[] #### Returns[​](#returns-2 "Direct link to Returns") `any` #### See[​](#see "Direct link to See") #### Inherited from[​](#inherited-from-6 "Direct link to Inherited from") `Error.prepareStackTrace` --- # Class: MemberLabelBuilder Defined in: [packages/sdk/src/workspace-builder/forms.ts:225](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/forms.ts#L225) ## Extends[​](#extends "Direct link to Extends") * `WorkspaceBuilderResource` ## Constructors[​](#constructors "Direct link to Constructors") ### Constructor[​](#constructor "Direct link to Constructor") > **new MemberLabelBuilder**(`name`, `slug?`, `color?`, `description?`): `MemberLabelBuilder` Defined in: [packages/sdk/src/workspace-builder/forms.ts:231](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/forms.ts#L231) #### Parameters[​](#parameters "Direct link to Parameters") ##### name[​](#name "Direct link to name") `string` ##### slug?[​](#slug "Direct link to slug?") `string` ##### color?[​](#color "Direct link to color?") `string` = `'8b5cf6'` ##### description?[​](#description "Direct link to description?") `string` = `''` #### Returns[​](#returns "Direct link to Returns") `MemberLabelBuilder` #### Overrides[​](#overrides "Direct link to Overrides") `WorkspaceBuilderResource.constructor` ## Properties[​](#properties "Direct link to Properties") ### \_created[​](#_created "Direct link to _created") > **\_created**: `boolean` = `false` Defined in: [packages/sdk/src/workspace-builder/resource.ts:23](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/resource.ts#L23) #### Inherited from[​](#inherited-from "Direct link to Inherited from") `WorkspaceBuilderResource._created` *** ### \_existed[​](#_existed "Direct link to _existed") > **\_existed**: `boolean` = `false` Defined in: [packages/sdk/src/workspace-builder/resource.ts:24](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/resource.ts#L24) #### Inherited from[​](#inherited-from-1 "Direct link to Inherited from") `WorkspaceBuilderResource._existed` *** ### \_id?[​](#_id "Direct link to _id?") > `optional` **\_id**: `number` Defined in: [packages/sdk/src/workspace-builder/resource.ts:21](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/resource.ts#L21) #### Inherited from[​](#inherited-from-2 "Direct link to Inherited from") `WorkspaceBuilderResource._id` *** ### \_uuid?[​](#_uuid "Direct link to _uuid?") > `optional` **\_uuid**: `string` Defined in: [packages/sdk/src/workspace-builder/resource.ts:22](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/resource.ts#L22) #### Inherited from[​](#inherited-from-3 "Direct link to Inherited from") `WorkspaceBuilderResource._uuid` *** ### color[​](#color-1 "Direct link to color") > `readonly` **color**: `string` Defined in: [packages/sdk/src/workspace-builder/forms.ts:228](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/forms.ts#L228) *** ### description[​](#description-1 "Direct link to description") > `readonly` **description**: `string` Defined in: [packages/sdk/src/workspace-builder/forms.ts:229](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/forms.ts#L229) *** ### name[​](#name-1 "Direct link to name") > `readonly` **name**: `string` Defined in: [packages/sdk/src/workspace-builder/forms.ts:226](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/forms.ts#L226) *** ### slug[​](#slug-1 "Direct link to slug") > `readonly` **slug**: `string` Defined in: [packages/sdk/src/workspace-builder/forms.ts:227](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/forms.ts#L227) ## Accessors[​](#accessors "Direct link to Accessors") ### id[​](#id "Direct link to id") #### Get Signature[​](#get-signature "Direct link to Get Signature") > **get** **id**(): `number` Defined in: [packages/sdk/src/workspace-builder/resource.ts:27](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/resource.ts#L27) Server-assigned numeric id — available after apply() or adopt(). ##### Returns[​](#returns-1 "Direct link to Returns") `number` #### Inherited from[​](#inherited-from-4 "Direct link to Inherited from") `WorkspaceBuilderResource.id` *** ### uuid[​](#uuid "Direct link to uuid") #### Get Signature[​](#get-signature-1 "Direct link to Get Signature") > **get** **uuid**(): `string` Defined in: [packages/sdk/src/workspace-builder/resource.ts:38](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/resource.ts#L38) Server-assigned uuid — available after apply() or adopt(). ##### Returns[​](#returns-2 "Direct link to Returns") `string` #### Inherited from[​](#inherited-from-5 "Direct link to Inherited from") `WorkspaceBuilderResource.uuid` ## Methods[​](#methods "Direct link to Methods") ### adopt()[​](#adopt "Direct link to adopt()") > **adopt**(`existing`): `void` Defined in: [packages/sdk/src/workspace-builder/resource.ts:55](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/resource.ts#L55) #### Parameters[​](#parameters-1 "Direct link to Parameters") ##### existing[​](#existing "Direct link to existing") `AnyRecord` #### Returns[​](#returns-3 "Direct link to Returns") `void` #### Inherited from[​](#inherited-from-6 "Direct link to Inherited from") `WorkspaceBuilderResource.adopt` *** ### apply()[​](#apply "Direct link to apply()") > **apply**(`client`): `Promise`<`void`> Defined in: [packages/sdk/src/workspace-builder/forms.ts:247](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/forms.ts#L247) #### Parameters[​](#parameters-2 "Direct link to Parameters") ##### client[​](#client "Direct link to client") [`GravityRailWorkspaceClient`](https://docs.gravityrail.com/sdk/type-aliases/GravityRailWorkspaceClient.md) #### Returns[​](#returns-4 "Direct link to Returns") `Promise`<`void`> #### Overrides[​](#overrides-1 "Direct link to Overrides") `WorkspaceBuilderResource.apply` *** ### matchKey()[​](#matchkey "Direct link to matchKey()") > **matchKey**(): `string` Defined in: [packages/sdk/src/workspace-builder/forms.ts:239](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/forms.ts#L239) #### Returns[​](#returns-5 "Direct link to Returns") `string` #### Overrides[​](#overrides-2 "Direct link to Overrides") `WorkspaceBuilderResource.matchKey` *** ### planLine()[​](#planline "Direct link to planLine()") > **planLine**(): `string` Defined in: [packages/sdk/src/workspace-builder/forms.ts:243](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/forms.ts#L243) #### Returns[​](#returns-6 "Direct link to Returns") `string` #### Overrides[​](#overrides-3 "Direct link to Overrides") `WorkspaceBuilderResource.planLine` --- # Class: NotificationRuleBuilder Defined in: [packages/sdk/src/workspace-builder/automation.ts:138](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/automation.ts#L138) ## Extends[​](#extends "Direct link to Extends") * `WorkspaceBuilderResource` ## Constructors[​](#constructors "Direct link to Constructors") ### Constructor[​](#constructor "Direct link to Constructor") > **new NotificationRuleBuilder**(`name`, `options?`): `NotificationRuleBuilder` Defined in: [packages/sdk/src/workspace-builder/automation.ts:147](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/automation.ts#L147) #### Parameters[​](#parameters "Direct link to Parameters") ##### name[​](#name "Direct link to name") `string` ##### options?[​](#options "Direct link to options?") `AnyRecord` = `{}` #### Returns[​](#returns "Direct link to Returns") `NotificationRuleBuilder` #### Overrides[​](#overrides "Direct link to Overrides") `WorkspaceBuilderResource.constructor` ## Properties[​](#properties "Direct link to Properties") ### \_created[​](#_created "Direct link to _created") > **\_created**: `boolean` = `false` Defined in: [packages/sdk/src/workspace-builder/resource.ts:23](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/resource.ts#L23) #### Inherited from[​](#inherited-from "Direct link to Inherited from") `WorkspaceBuilderResource._created` *** ### \_existed[​](#_existed "Direct link to _existed") > **\_existed**: `boolean` = `false` Defined in: [packages/sdk/src/workspace-builder/resource.ts:24](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/resource.ts#L24) #### Inherited from[​](#inherited-from-1 "Direct link to Inherited from") `WorkspaceBuilderResource._existed` *** ### \_id?[​](#_id "Direct link to _id?") > `optional` **\_id**: `number` Defined in: [packages/sdk/src/workspace-builder/resource.ts:21](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/resource.ts#L21) #### Inherited from[​](#inherited-from-2 "Direct link to Inherited from") `WorkspaceBuilderResource._id` *** ### \_uuid?[​](#_uuid "Direct link to _uuid?") > `optional` **\_uuid**: `string` Defined in: [packages/sdk/src/workspace-builder/resource.ts:22](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/resource.ts#L22) #### Inherited from[​](#inherited-from-3 "Direct link to Inherited from") `WorkspaceBuilderResource._uuid` *** ### memberId[​](#memberid "Direct link to memberId") > `readonly` **memberId**: `number` Defined in: [packages/sdk/src/workspace-builder/automation.ts:140](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/automation.ts#L140) *** ### name[​](#name-1 "Direct link to name") > `readonly` **name**: `string` Defined in: [packages/sdk/src/workspace-builder/automation.ts:148](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/automation.ts#L148) *** ### noticeType[​](#noticetype "Direct link to noticeType") > `readonly` **noticeType**: `string` Defined in: [packages/sdk/src/workspace-builder/automation.ts:139](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/automation.ts#L139) *** ### notifyEmail[​](#notifyemail "Direct link to notifyEmail") > `readonly` **notifyEmail**: `boolean` Defined in: [packages/sdk/src/workspace-builder/automation.ts:144](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/automation.ts#L144) *** ### notifySms[​](#notifysms "Direct link to notifySms") > `readonly` **notifySms**: `boolean` Defined in: [packages/sdk/src/workspace-builder/automation.ts:143](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/automation.ts#L143) *** ### notifyVoice[​](#notifyvoice "Direct link to notifyVoice") > `readonly` **notifyVoice**: `boolean` Defined in: [packages/sdk/src/workspace-builder/automation.ts:145](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/automation.ts#L145) *** ### prompt?[​](#prompt "Direct link to prompt?") > `readonly` `optional` **prompt**: `string` Defined in: [packages/sdk/src/workspace-builder/automation.ts:142](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/automation.ts#L142) *** ### workflow?[​](#workflow "Direct link to workflow?") > `readonly` `optional` **workflow**: [`WorkflowBuilder`](https://docs.gravityrail.com/sdk/classes/WorkflowBuilder.md) Defined in: [packages/sdk/src/workspace-builder/automation.ts:141](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/automation.ts#L141) ## Accessors[​](#accessors "Direct link to Accessors") ### id[​](#id "Direct link to id") #### Get Signature[​](#get-signature "Direct link to Get Signature") > **get** **id**(): `number` Defined in: [packages/sdk/src/workspace-builder/resource.ts:27](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/resource.ts#L27) Server-assigned numeric id — available after apply() or adopt(). ##### Returns[​](#returns-1 "Direct link to Returns") `number` #### Inherited from[​](#inherited-from-4 "Direct link to Inherited from") `WorkspaceBuilderResource.id` *** ### uuid[​](#uuid "Direct link to uuid") #### Get Signature[​](#get-signature-1 "Direct link to Get Signature") > **get** **uuid**(): `string` Defined in: [packages/sdk/src/workspace-builder/resource.ts:38](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/resource.ts#L38) Server-assigned uuid — available after apply() or adopt(). ##### Returns[​](#returns-2 "Direct link to Returns") `string` #### Inherited from[​](#inherited-from-5 "Direct link to Inherited from") `WorkspaceBuilderResource.uuid` ## Methods[​](#methods "Direct link to Methods") ### adopt()[​](#adopt "Direct link to adopt()") > **adopt**(`existing`): `void` Defined in: [packages/sdk/src/workspace-builder/resource.ts:55](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/resource.ts#L55) #### Parameters[​](#parameters-1 "Direct link to Parameters") ##### existing[​](#existing "Direct link to existing") `AnyRecord` #### Returns[​](#returns-3 "Direct link to Returns") `void` #### Inherited from[​](#inherited-from-6 "Direct link to Inherited from") `WorkspaceBuilderResource.adopt` *** ### apply()[​](#apply "Direct link to apply()") > **apply**(`client`): `Promise`<`void`> Defined in: [packages/sdk/src/workspace-builder/automation.ts:168](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/automation.ts#L168) #### Parameters[​](#parameters-2 "Direct link to Parameters") ##### client[​](#client "Direct link to client") [`GravityRailWorkspaceClient`](https://docs.gravityrail.com/sdk/type-aliases/GravityRailWorkspaceClient.md) #### Returns[​](#returns-4 "Direct link to Returns") `Promise`<`void`> #### Overrides[​](#overrides-1 "Direct link to Overrides") `WorkspaceBuilderResource.apply` *** ### matchKey()[​](#matchkey "Direct link to matchKey()") > **matchKey**(): `string` | `undefined` Defined in: [packages/sdk/src/workspace-builder/resource.ts:51](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/resource.ts#L51) #### Returns[​](#returns-5 "Direct link to Returns") `string` | `undefined` #### Inherited from[​](#inherited-from-7 "Direct link to Inherited from") `WorkspaceBuilderResource.matchKey` *** ### planLine()[​](#planline "Direct link to planLine()") > **planLine**(): `string` Defined in: [packages/sdk/src/workspace-builder/automation.ts:161](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/automation.ts#L161) #### Returns[​](#returns-6 "Direct link to Returns") `string` #### Overrides[​](#overrides-2 "Direct link to Overrides") `WorkspaceBuilderResource.planLine` --- # Class: OrgApi Defined in: [packages/sdk/src/api/org.ts:63](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/org.ts#L63) ## Extends[​](#extends "Direct link to Extends") * [`BaseApiClient`](https://docs.gravityrail.com/sdk/classes/BaseApiClient.md) ## Constructors[​](#constructors "Direct link to Constructors") ### Constructor[​](#constructor "Direct link to Constructor") > **new OrgApi**(`apiKey`, `baseUrl`, `customFetch?`): `OrgApi` Defined in: [packages/sdk/src/api/base.ts:173](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/base.ts#L173) #### Parameters[​](#parameters "Direct link to Parameters") ##### apiKey[​](#apikey "Direct link to apiKey") `string` | `undefined` ##### baseUrl[​](#baseurl "Direct link to baseUrl") `string` ##### customFetch?[​](#customfetch "Direct link to customFetch?") {(`input`, `init?`): `Promise`<`Response`>; (`input`, `init?`): `Promise`<`Response`>; } #### Returns[​](#returns "Direct link to Returns") `OrgApi` #### Inherited from[​](#inherited-from "Direct link to Inherited from") [`BaseApiClient`](https://docs.gravityrail.com/sdk/classes/BaseApiClient.md).[`constructor`](https://docs.gravityrail.com/sdk/classes/BaseApiClient.md#constructor) ## Methods[​](#methods "Direct link to Methods") ### approveA2PMessages()[​](#approvea2pmessages "Direct link to approveA2PMessages()") > **approveA2PMessages**(`orgUuid`, `sampleMessages`): `Promise`<{ `status`: `string`; }> Defined in: [packages/sdk/src/api/org.ts:608](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/org.ts#L608) Approve sample messages for the org's A2P campaign. #### Parameters[​](#parameters-1 "Direct link to Parameters") ##### orgUuid[​](#orguuid "Direct link to orgUuid") `string` ##### sampleMessages[​](#samplemessages "Direct link to sampleMessages") `string`\[] #### Returns[​](#returns-1 "Direct link to Returns") `Promise`<{ `status`: `string`; }> *** ### assignPhoneToWorkspace()[​](#assignphonetoworkspace "Direct link to assignPhoneToWorkspace()") > **assignPhoneToWorkspace**(`orgUuid`, `providerPhoneUuid`, `workspaceUuid`): `Promise`<[`ProviderPhoneNumber`](https://docs.gravityrail.com/sdk/interfaces/ProviderPhoneNumber.md)> Defined in: [packages/sdk/src/api/org.ts:320](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/org.ts#L320) Assign a phone number to a workspace. #### Parameters[​](#parameters-2 "Direct link to Parameters") ##### orgUuid[​](#orguuid-1 "Direct link to orgUuid") `string` ##### providerPhoneUuid[​](#providerphoneuuid "Direct link to providerPhoneUuid") `string` ##### workspaceUuid[​](#workspaceuuid "Direct link to workspaceUuid") `string` #### Returns[​](#returns-2 "Direct link to Returns") `Promise`<[`ProviderPhoneNumber`](https://docs.gravityrail.com/sdk/interfaces/ProviderPhoneNumber.md)> *** ### cancelBusinessProfile()[​](#cancelbusinessprofile "Direct link to cancelBusinessProfile()") > **cancelBusinessProfile**(`orgUuid`): `Promise`<[`BusinessProfileCancelResponse`](https://docs.gravityrail.com/sdk/interfaces/BusinessProfileCancelResponse.md)> Defined in: [packages/sdk/src/api/org.ts:667](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/org.ts#L667) Cancel an in-flight Twilio review. Resets the cached profile state to `draft` so the user can edit and resubmit. #### Parameters[​](#parameters-3 "Direct link to Parameters") ##### orgUuid[​](#orguuid-2 "Direct link to orgUuid") `string` #### Returns[​](#returns-3 "Direct link to Returns") `Promise`<[`BusinessProfileCancelResponse`](https://docs.gravityrail.com/sdk/interfaces/BusinessProfileCancelResponse.md)> *** ### checkAccountMembership()[​](#checkaccountmembership "Direct link to checkAccountMembership()") > **checkAccountMembership**(`orgUuid`, `accountUuid`): `Promise`<{ `isMember`: `boolean`; }> Defined in: [packages/sdk/src/api/org.ts:121](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/org.ts#L121) Check if an account is already a member of an organization. #### Parameters[​](#parameters-4 "Direct link to Parameters") ##### orgUuid[​](#orguuid-3 "Direct link to orgUuid") `string` ##### accountUuid[​](#accountuuid "Direct link to accountUuid") `string` #### Returns[​](#returns-4 "Direct link to Returns") `Promise`<{ `isMember`: `boolean`; }> *** ### createOrganizationInvitation()[​](#createorganizationinvitation "Direct link to createOrganizationInvitation()") > **createOrganizationInvitation**(`orgIdOrUuid`, `data`): `Promise`<[`InvitationResponse`](https://docs.gravityrail.com/sdk/type-aliases/InvitationResponse.md)> Defined in: [packages/sdk/src/api/org.ts:179](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/org.ts#L179) Create a new invitation to join the organization. #### Parameters[​](#parameters-5 "Direct link to Parameters") ##### orgIdOrUuid[​](#orgidoruuid "Direct link to orgIdOrUuid") `string` | `number` ##### data[​](#data "Direct link to data") [`CreateOrganizationInvitationFormData`](https://docs.gravityrail.com/sdk/interfaces/CreateOrganizationInvitationFormData.md) #### Returns[​](#returns-5 "Direct link to Returns") `Promise`<[`InvitationResponse`](https://docs.gravityrail.com/sdk/type-aliases/InvitationResponse.md)> *** ### createOrganizationWorkspace()[​](#createorganizationworkspace "Direct link to createOrganizationWorkspace()") > **createOrganizationWorkspace**(`orgIdOrUuid`, `data`): `Promise`<`OrgWorkspace`> Defined in: [packages/sdk/src/api/org.ts:282](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/org.ts#L282) Create a workspace in an organization. #### Parameters[​](#parameters-6 "Direct link to Parameters") ##### orgIdOrUuid[​](#orgidoruuid-1 "Direct link to orgIdOrUuid") `string` | `number` ##### data[​](#data-1 "Direct link to data") `OrgCreateWorkspaceFormData` #### Returns[​](#returns-6 "Direct link to Returns") `Promise`<`OrgWorkspace`> *** ### deleteOrganizationInvitation()[​](#deleteorganizationinvitation "Direct link to deleteOrganizationInvitation()") > **deleteOrganizationInvitation**(`orgIdOrUuid`, `invitationId`): `Promise`<`void`> Defined in: [packages/sdk/src/api/org.ts:216](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/org.ts#L216) Delete (cancel) an organization invitation. #### Parameters[​](#parameters-7 "Direct link to Parameters") ##### orgIdOrUuid[​](#orgidoruuid-2 "Direct link to orgIdOrUuid") `string` | `number` ##### invitationId[​](#invitationid "Direct link to invitationId") `number` #### Returns[​](#returns-7 "Direct link to Returns") `Promise`<`void`> *** ### deleteOrgDomain()[​](#deleteorgdomain "Direct link to deleteOrgDomain()") > **deleteOrgDomain**(`orgIdOrUuid`, `domainUuid`): `Promise`<`void`> Defined in: [packages/sdk/src/api/org.ts:459](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/org.ts#L459) Delete a registered organization domain. #### Parameters[​](#parameters-8 "Direct link to Parameters") ##### orgIdOrUuid[​](#orgidoruuid-3 "Direct link to orgIdOrUuid") `string` | `number` ##### domainUuid[​](#domainuuid "Direct link to domainUuid") `string` #### Returns[​](#returns-8 "Direct link to Returns") `Promise`<`void`> *** ### deletePhoneNumber()[​](#deletephonenumber "Direct link to deletePhoneNumber()") > **deletePhoneNumber**(`orgUuid`, `providerPhoneUuid`): `Promise`<`void`> Defined in: [packages/sdk/src/api/org.ts:408](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/org.ts#L408) Delete a phone number from the org (releases from Twilio). #### Parameters[​](#parameters-9 "Direct link to Parameters") ##### orgUuid[​](#orguuid-4 "Direct link to orgUuid") `string` ##### providerPhoneUuid[​](#providerphoneuuid-1 "Direct link to providerPhoneUuid") `string` #### Returns[​](#returns-9 "Direct link to Returns") `Promise`<`void`> *** ### disableOrgDomainEmail()[​](#disableorgdomainemail "Direct link to disableOrgDomainEmail()") > **disableOrgDomainEmail**(`orgIdOrUuid`, `domainUuid`, `confirm?`): `Promise`<[`EmailDisableResponse`](https://docs.gravityrail.com/sdk/type-aliases/EmailDisableResponse.md)> Defined in: [packages/sdk/src/api/org.ts:503](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/org.ts#L503) Disable email support for an org domain. #### Parameters[​](#parameters-10 "Direct link to Parameters") ##### orgIdOrUuid[​](#orgidoruuid-4 "Direct link to orgIdOrUuid") `string` | `number` ##### domainUuid[​](#domainuuid-1 "Direct link to domainUuid") `string` ##### confirm?[​](#confirm "Direct link to confirm?") `boolean` = `false` #### Returns[​](#returns-10 "Direct link to Returns") `Promise`<[`EmailDisableResponse`](https://docs.gravityrail.com/sdk/type-aliases/EmailDisableResponse.md)> *** ### disableOrgDomainSite()[​](#disableorgdomainsite "Direct link to disableOrgDomainSite()") > **disableOrgDomainSite**(`orgIdOrUuid`, `domainUuid`, `confirm?`): `Promise`<[`SiteDisableResponse`](https://docs.gravityrail.com/sdk/type-aliases/SiteDisableResponse.md)> Defined in: [packages/sdk/src/api/org.ts:559](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/org.ts#L559) Disable custom site routing for an org domain. #### Parameters[​](#parameters-11 "Direct link to Parameters") ##### orgIdOrUuid[​](#orgidoruuid-5 "Direct link to orgIdOrUuid") `string` | `number` ##### domainUuid[​](#domainuuid-2 "Direct link to domainUuid") `string` ##### confirm?[​](#confirm-1 "Direct link to confirm?") `boolean` = `false` #### Returns[​](#returns-11 "Direct link to Returns") `Promise`<[`SiteDisableResponse`](https://docs.gravityrail.com/sdk/type-aliases/SiteDisableResponse.md)> *** ### enableOrgDomainEmail()[​](#enableorgdomainemail "Direct link to enableOrgDomainEmail()") > **enableOrgDomainEmail**(`orgIdOrUuid`, `domainUuid`): `Promise`<[`EmailDomainConfig`](https://docs.gravityrail.com/sdk/type-aliases/EmailDomainConfig.md)> Defined in: [packages/sdk/src/api/org.ts:466](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/org.ts#L466) Enable email DNS provisioning for a verified org domain. #### Parameters[​](#parameters-12 "Direct link to Parameters") ##### orgIdOrUuid[​](#orgidoruuid-6 "Direct link to orgIdOrUuid") `string` | `number` ##### domainUuid[​](#domainuuid-3 "Direct link to domainUuid") `string` #### Returns[​](#returns-12 "Direct link to Returns") `Promise`<[`EmailDomainConfig`](https://docs.gravityrail.com/sdk/type-aliases/EmailDomainConfig.md)> *** ### enableOrgDomainSite()[​](#enableorgdomainsite "Direct link to enableOrgDomainSite()") > **enableOrgDomainSite**(`orgIdOrUuid`, `domainUuid`): `Promise`<[`SiteDomainConfig`](https://docs.gravityrail.com/sdk/type-aliases/SiteDomainConfig.md)> Defined in: [packages/sdk/src/api/org.ts:524](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/org.ts#L524) Enable custom site routing for a verified org domain. #### Parameters[​](#parameters-13 "Direct link to Parameters") ##### orgIdOrUuid[​](#orgidoruuid-7 "Direct link to orgIdOrUuid") `string` | `number` ##### domainUuid[​](#domainuuid-4 "Direct link to domainUuid") `string` #### Returns[​](#returns-13 "Direct link to Returns") `Promise`<[`SiteDomainConfig`](https://docs.gravityrail.com/sdk/type-aliases/SiteDomainConfig.md)> *** ### getA2PBrandEnrollmentUrl()[​](#geta2pbrandenrollmenturl "Direct link to getA2PBrandEnrollmentUrl()") > **getA2PBrandEnrollmentUrl**(`orgUuid`, `brandUuid`): `Promise`<[`A2PBrandEnrollmentUrlResponse`](https://docs.gravityrail.com/sdk/interfaces/A2PBrandEnrollmentUrlResponse.md)> Defined in: [packages/sdk/src/api/org.ts:780](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/org.ts#L780) The brand-addressable enrollment form URL (carries `?brand=…`). Outreach appends each patient's `external_id`. `url` is null until a Site is linked. #### Parameters[​](#parameters-14 "Direct link to Parameters") ##### orgUuid[​](#orguuid-5 "Direct link to orgUuid") `string` ##### brandUuid[​](#branduuid "Direct link to brandUuid") `string` #### Returns[​](#returns-14 "Direct link to Returns") `Promise`<[`A2PBrandEnrollmentUrlResponse`](https://docs.gravityrail.com/sdk/interfaces/A2PBrandEnrollmentUrlResponse.md)> *** ### getA2PCampaignConfig()[​](#geta2pcampaignconfig "Direct link to getA2PCampaignConfig()") > **getA2PCampaignConfig**(`orgUuid`, `brandUuid`): `Promise`<[`A2PCampaignConfigResponse`](https://docs.gravityrail.com/sdk/interfaces/A2PCampaignConfigResponse.md)> Defined in: [packages/sdk/src/api/org.ts:686](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/org.ts#L686) Fetch a brand's resolved A2P campaign config. The response carries both the raw `overrides` and the `resolved` payload (defaults + overrides) the editor previews — including the canonical SMS consent text. #### Parameters[​](#parameters-15 "Direct link to Parameters") ##### orgUuid[​](#orguuid-6 "Direct link to orgUuid") `string` ##### brandUuid[​](#branduuid-1 "Direct link to brandUuid") `string` #### Returns[​](#returns-15 "Direct link to Returns") `Promise`<[`A2PCampaignConfigResponse`](https://docs.gravityrail.com/sdk/interfaces/A2PCampaignConfigResponse.md)> *** ### getA2PStatus()[​](#geta2pstatus "Direct link to getA2PStatus()") > **getA2PStatus**(`orgUuid`): `Promise`<`OrgA2PStatus`> Defined in: [packages/sdk/src/api/org.ts:584](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/org.ts#L584) Get the org's A2P brand registration status. #### Parameters[​](#parameters-16 "Direct link to Parameters") ##### orgUuid[​](#orguuid-7 "Direct link to orgUuid") `string` #### Returns[​](#returns-16 "Direct link to Returns") `Promise`<`OrgA2PStatus`> *** ### getActingMember()[​](#getactingmember "Direct link to getActingMember()") > **getActingMember**(): `string` | `undefined` Defined in: [packages/sdk/src/api/base.ts:226](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/base.ts#L226) Get the current acting member UUID. #### Returns[​](#returns-17 "Direct link to Returns") `string` | `undefined` #### Inherited from[​](#inherited-from-1 "Direct link to Inherited from") [`BaseApiClient`](https://docs.gravityrail.com/sdk/classes/BaseApiClient.md).[`getActingMember`](https://docs.gravityrail.com/sdk/classes/BaseApiClient.md#getactingmember) *** ### getBusinessProfile()[​](#getbusinessprofile "Direct link to getBusinessProfile()") > **getBusinessProfile**(`orgUuid`): `Promise`<[`BusinessProfile`](https://docs.gravityrail.com/sdk/type-aliases/BusinessProfile.md)> Defined in: [packages/sdk/src/api/org.ts:632](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/org.ts#L632) 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[​](#parameters-17 "Direct link to Parameters") ##### orgUuid[​](#orguuid-8 "Direct link to orgUuid") `string` #### Returns[​](#returns-18 "Direct link to Returns") `Promise`<[`BusinessProfile`](https://docs.gravityrail.com/sdk/type-aliases/BusinessProfile.md)> *** ### getCurrentOrgMember()[​](#getcurrentorgmember "Direct link to getCurrentOrgMember()") > **getCurrentOrgMember**(`orgIdOrUuid`): `Promise`<[`CurrentOrgMember`](https://docs.gravityrail.com/sdk/interfaces/CurrentOrgMember.md)> Defined in: [packages/sdk/src/api/org.ts:82](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/org.ts#L82) Get the current user's membership in an organization. Returns the user's org membership details including their role and scopes. #### Parameters[​](#parameters-18 "Direct link to Parameters") ##### orgIdOrUuid[​](#orgidoruuid-8 "Direct link to orgIdOrUuid") `string` | `number` #### Returns[​](#returns-19 "Direct link to Returns") `Promise`<[`CurrentOrgMember`](https://docs.gravityrail.com/sdk/interfaces/CurrentOrgMember.md)> *** ### getOrganization()[​](#getorganization "Direct link to getOrganization()") > **getOrganization**(`idOrUuid`): `Promise`<`OrganizationResponse`> Defined in: [packages/sdk/src/api/org.ts:74](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/org.ts#L74) Get organization by ID or UUID. Returns different response based on user's role: * Admins/Owners: AdminOrganization with full details * Members: MemberOrgView with basic info and workspace list Use `viewType` field to determine the response type: * 'admin': AdminOrganization * 'member': MemberOrgView #### Parameters[​](#parameters-19 "Direct link to Parameters") ##### idOrUuid[​](#idoruuid "Direct link to idOrUuid") `string` | `number` #### Returns[​](#returns-20 "Direct link to Returns") `Promise`<`OrganizationResponse`> *** ### getOrganizationInvitation()[​](#getorganizationinvitation "Direct link to getOrganizationInvitation()") > **getOrganizationInvitation**(`orgIdOrUuid`, `invitationId`): `Promise`<[`InvitationResponse`](https://docs.gravityrail.com/sdk/type-aliases/InvitationResponse.md)> Defined in: [packages/sdk/src/api/org.ts:192](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/org.ts#L192) Get a specific organization invitation. #### Parameters[​](#parameters-20 "Direct link to Parameters") ##### orgIdOrUuid[​](#orgidoruuid-9 "Direct link to orgIdOrUuid") `string` | `number` ##### invitationId[​](#invitationid-1 "Direct link to invitationId") `number` #### Returns[​](#returns-21 "Direct link to Returns") `Promise`<[`InvitationResponse`](https://docs.gravityrail.com/sdk/type-aliases/InvitationResponse.md)> *** ### getOrganizationMembers()[​](#getorganizationmembers "Direct link to getOrganizationMembers()") > **getOrganizationMembers**(`orgIdOrUuid`, `options?`): `Promise`<[`OrgMemberListResponse`](https://docs.gravityrail.com/sdk/interfaces/OrgMemberListResponse.md)> Defined in: [packages/sdk/src/api/org.ts:102](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/org.ts#L102) List members of an organization. #### Parameters[​](#parameters-21 "Direct link to Parameters") ##### orgIdOrUuid[​](#orgidoruuid-10 "Direct link to orgIdOrUuid") `string` | `number` ##### options?[​](#options "Direct link to options?") ###### page?[​](#page "Direct link to page?") `number` ###### pageSize?[​](#pagesize "Direct link to pageSize?") `number` ###### search?[​](#search "Direct link to search?") `string` #### Returns[​](#returns-22 "Direct link to Returns") `Promise`<[`OrgMemberListResponse`](https://docs.gravityrail.com/sdk/interfaces/OrgMemberListResponse.md)> *** ### getOrganizationWorkspace()[​](#getorganizationworkspace "Direct link to getOrganizationWorkspace()") > **getOrganizationWorkspace**(`orgIdOrUuid`, `workspaceUuid`): `Promise`<`OrgWorkspace`> Defined in: [packages/sdk/src/api/org.ts:272](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/org.ts#L272) Get a single workspace in an organization. #### Parameters[​](#parameters-22 "Direct link to Parameters") ##### orgIdOrUuid[​](#orgidoruuid-11 "Direct link to orgIdOrUuid") `string` | `number` ##### workspaceUuid[​](#workspaceuuid-1 "Direct link to workspaceUuid") `string` #### Returns[​](#returns-23 "Direct link to Returns") `Promise`<`OrgWorkspace`> *** ### getOrganizationWorkspaces()[​](#getorganizationworkspaces "Direct link to getOrganizationWorkspaces()") > **getOrganizationWorkspaces**(`orgIdOrUuid`, `options?`): `Promise`<[`PaginatedResponse`](https://docs.gravityrail.com/sdk/interfaces/PaginatedResponse.md)<`OrgWorkspace`>> Defined in: [packages/sdk/src/api/org.ts:247](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/org.ts#L247) List workspaces in an organization with pagination. #### Parameters[​](#parameters-23 "Direct link to Parameters") ##### orgIdOrUuid[​](#orgidoruuid-12 "Direct link to orgIdOrUuid") `string` | `number` ##### options?[​](#options-1 "Direct link to options?") ###### page?[​](#page-1 "Direct link to page?") `number` ###### pageSize?[​](#pagesize-1 "Direct link to pageSize?") `number` ###### search?[​](#search-1 "Direct link to search?") `string` ###### sortBy?[​](#sortby "Direct link to sortBy?") [`WorkspaceSortField`](https://docs.gravityrail.com/sdk/type-aliases/WorkspaceSortField.md) ###### sortOrder?[​](#sortorder "Direct link to sortOrder?") [`SortOrder`](https://docs.gravityrail.com/sdk/type-aliases/SortOrder.md) #### Returns[​](#returns-24 "Direct link to Returns") `Promise`<[`PaginatedResponse`](https://docs.gravityrail.com/sdk/interfaces/PaginatedResponse.md)<`OrgWorkspace`>> *** ### getOrgBillingCustomer()[​](#getorgbillingcustomer "Direct link to getOrgBillingCustomer()") > **getOrgBillingCustomer**(`orgIdOrUuid`): `Promise`<{ `customerName`: `string` | `null`; `customerUuid`: `string` | `null`; `hasAccess`: `boolean`; }> Defined in: [packages/sdk/src/api/org.ts:89](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/org.ts#L89) Get the billing customer UUID for an organization. #### Parameters[​](#parameters-24 "Direct link to Parameters") ##### orgIdOrUuid[​](#orgidoruuid-13 "Direct link to orgIdOrUuid") `string` | `number` #### Returns[​](#returns-25 "Direct link to Returns") `Promise`<{ `customerName`: `string` | `null`; `customerUuid`: `string` | `null`; `hasAccess`: `boolean`; }> *** ### getOrgDomain()[​](#getorgdomain "Direct link to getOrgDomain()") > **getOrgDomain**(`orgIdOrUuid`, `domainUuid`): `Promise`<[`OrgDomain`](https://docs.gravityrail.com/sdk/type-aliases/OrgDomain.md)> Defined in: [packages/sdk/src/api/org.ts:439](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/org.ts#L439) Get a registered organization domain by UUID. #### Parameters[​](#parameters-25 "Direct link to Parameters") ##### orgIdOrUuid[​](#orgidoruuid-14 "Direct link to orgIdOrUuid") `string` | `number` ##### domainUuid[​](#domainuuid-5 "Direct link to domainUuid") `string` #### Returns[​](#returns-26 "Direct link to Returns") `Promise`<[`OrgDomain`](https://docs.gravityrail.com/sdk/type-aliases/OrgDomain.md)> *** ### getOrgDomainEmail()[​](#getorgdomainemail "Direct link to getOrgDomainEmail()") > **getOrgDomainEmail**(`orgIdOrUuid`, `domainUuid`): `Promise`<[`EmailDomainConfigGetResponse`](https://docs.gravityrail.com/sdk/type-aliases/EmailDomainConfigGetResponse.md)> Defined in: [packages/sdk/src/api/org.ts:478](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/org.ts#L478) Get email DNS provisioning and verification status for an org domain. #### Parameters[​](#parameters-26 "Direct link to Parameters") ##### orgIdOrUuid[​](#orgidoruuid-15 "Direct link to orgIdOrUuid") `string` | `number` ##### domainUuid[​](#domainuuid-6 "Direct link to domainUuid") `string` #### Returns[​](#returns-27 "Direct link to Returns") `Promise`<[`EmailDomainConfigGetResponse`](https://docs.gravityrail.com/sdk/type-aliases/EmailDomainConfigGetResponse.md)> *** ### getOrgDomainSite()[​](#getorgdomainsite "Direct link to getOrgDomainSite()") > **getOrgDomainSite**(`orgIdOrUuid`, `domainUuid`): `Promise`<[`SiteDomainConfigGetResponse`](https://docs.gravityrail.com/sdk/type-aliases/SiteDomainConfigGetResponse.md)> Defined in: [packages/sdk/src/api/org.ts:536](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/org.ts#L536) Get site CNAME provisioning and verification status for an org domain. #### Parameters[​](#parameters-27 "Direct link to Parameters") ##### orgIdOrUuid[​](#orgidoruuid-16 "Direct link to orgIdOrUuid") `string` | `number` ##### domainUuid[​](#domainuuid-7 "Direct link to domainUuid") `string` #### Returns[​](#returns-28 "Direct link to Returns") `Promise`<[`SiteDomainConfigGetResponse`](https://docs.gravityrail.com/sdk/type-aliases/SiteDomainConfigGetResponse.md)> *** ### getWorkspaceMemberRoles()[​](#getworkspacememberroles "Direct link to getWorkspaceMemberRoles()") > **getWorkspaceMemberRoles**(`orgIdOrUuid`, `workspaceUuid`): `Promise`<[`MemberRoleResponse`](https://docs.gravityrail.com/sdk/interfaces/MemberRoleResponse.md)\[]> Defined in: [packages/sdk/src/api/org.ts:792](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/org.ts#L792) List available member roles for a workspace in the organization. #### Parameters[​](#parameters-28 "Direct link to Parameters") ##### orgIdOrUuid[​](#orgidoruuid-17 "Direct link to orgIdOrUuid") `string` | `number` ##### workspaceUuid[​](#workspaceuuid-2 "Direct link to workspaceUuid") `string` #### Returns[​](#returns-29 "Direct link to Returns") `Promise`<[`MemberRoleResponse`](https://docs.gravityrail.com/sdk/interfaces/MemberRoleResponse.md)\[]> *** ### joinWorkspace()[​](#joinworkspace "Direct link to joinWorkspace()") > **joinWorkspace**(`orgIdOrUuid`, `workspaceUuid`, `data`): `Promise`<`OrgJoinWorkspaceResponse`> Defined in: [packages/sdk/src/api/org.ts:802](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/org.ts#L802) Join a workspace as the current org admin/owner. #### Parameters[​](#parameters-29 "Direct link to Parameters") ##### orgIdOrUuid[​](#orgidoruuid-18 "Direct link to orgIdOrUuid") `string` | `number` ##### workspaceUuid[​](#workspaceuuid-3 "Direct link to workspaceUuid") `string` ##### data[​](#data-2 "Direct link to data") `OrgJoinWorkspaceRequest` #### Returns[​](#returns-30 "Direct link to Returns") `Promise`<`OrgJoinWorkspaceResponse`> *** ### linkA2PEnrollmentSite()[​](#linka2penrollmentsite "Direct link to linkA2PEnrollmentSite()") > **linkA2PEnrollmentSite**(`orgUuid`, `brandUuid`, `data`): `Promise`<[`A2PCampaignConfigResponse`](https://docs.gravityrail.com/sdk/interfaces/A2PCampaignConfigResponse.md)> Defined in: [packages/sdk/src/api/org.ts:731](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/org.ts#L731) Link the brand to a published enrollment Site (sets `site_uuid`). Returns the refreshed campaign config so the editor's link state updates inline. #### Parameters[​](#parameters-30 "Direct link to Parameters") ##### orgUuid[​](#orguuid-9 "Direct link to orgUuid") `string` ##### brandUuid[​](#branduuid-2 "Direct link to brandUuid") `string` ##### data[​](#data-3 "Direct link to data") [`LinkA2PEnrollmentSiteRequest`](https://docs.gravityrail.com/sdk/interfaces/LinkA2PEnrollmentSiteRequest.md) #### Returns[​](#returns-31 "Direct link to Returns") `Promise`<[`A2PCampaignConfigResponse`](https://docs.gravityrail.com/sdk/interfaces/A2PCampaignConfigResponse.md)> *** ### listA2PBrands()[​](#lista2pbrands "Direct link to listA2PBrands()") > **listA2PBrands**(`orgUuid`): `Promise`<[`OrgA2PBrandListResponse`](https://docs.gravityrail.com/sdk/interfaces/OrgA2PBrandListResponse.md)> Defined in: [packages/sdk/src/api/org.ts:677](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/org.ts#L677) List the org's A2P brands (broker resources). The SMS-consent editor uses this to pick which brand's consent config to edit. #### Parameters[​](#parameters-31 "Direct link to Parameters") ##### orgUuid[​](#orguuid-10 "Direct link to orgUuid") `string` #### Returns[​](#returns-32 "Direct link to Returns") `Promise`<[`OrgA2PBrandListResponse`](https://docs.gravityrail.com/sdk/interfaces/OrgA2PBrandListResponse.md)> *** ### listA2PEnrollmentSiteCandidates()[​](#lista2penrollmentsitecandidates "Direct link to listA2PEnrollmentSiteCandidates()") > **listA2PEnrollmentSiteCandidates**(`orgUuid`, `brandUuid`): `Promise`<[`A2PEnrollmentSiteCandidatesResponse`](https://docs.gravityrail.com/sdk/interfaces/A2PEnrollmentSiteCandidatesResponse.md)> Defined in: [packages/sdk/src/api/org.ts:718](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/org.ts#L718) Published Sites across the org's workspaces that can be linked as this brand's enrollment (opt-in) surface. Org-authorized, so it works even when the admin isn't a member of the workspace holding the Site. #### Parameters[​](#parameters-32 "Direct link to Parameters") ##### orgUuid[​](#orguuid-11 "Direct link to orgUuid") `string` ##### brandUuid[​](#branduuid-3 "Direct link to brandUuid") `string` #### Returns[​](#returns-33 "Direct link to Returns") `Promise`<[`A2PEnrollmentSiteCandidatesResponse`](https://docs.gravityrail.com/sdk/interfaces/A2PEnrollmentSiteCandidatesResponse.md)> *** ### listOrganizationInvitations()[​](#listorganizationinvitations "Direct link to listOrganizationInvitations()") > **listOrganizationInvitations**(`orgIdOrUuid`, `options?`): `Promise`<[`InvitationListResponse`](https://docs.gravityrail.com/sdk/type-aliases/InvitationListResponse.md)> Defined in: [packages/sdk/src/api/org.ts:158](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/org.ts#L158) List invitations for an organization. #### Parameters[​](#parameters-33 "Direct link to Parameters") ##### orgIdOrUuid[​](#orgidoruuid-19 "Direct link to orgIdOrUuid") `string` | `number` ##### options?[​](#options-2 "Direct link to options?") ###### page?[​](#page-2 "Direct link to page?") `number` ###### pageSize?[​](#pagesize-2 "Direct link to pageSize?") `number` ###### status?[​](#status "Direct link to status?") [`InvitationStatus`](https://docs.gravityrail.com/sdk/enumerations/InvitationStatus.md) #### Returns[​](#returns-34 "Direct link to Returns") `Promise`<[`InvitationListResponse`](https://docs.gravityrail.com/sdk/type-aliases/InvitationListResponse.md)> *** ### listOrgDomains()[​](#listorgdomains "Direct link to listOrgDomains()") > **listOrgDomains**(`orgIdOrUuid`): `Promise`<[`OrgDomainListResponse`](https://docs.gravityrail.com/sdk/type-aliases/OrgDomainListResponse.md)> Defined in: [packages/sdk/src/api/org.ts:422](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/org.ts#L422) List domains registered to an organization. #### Parameters[​](#parameters-34 "Direct link to Parameters") ##### orgIdOrUuid[​](#orgidoruuid-20 "Direct link to orgIdOrUuid") `string` | `number` #### Returns[​](#returns-35 "Direct link to Returns") `Promise`<[`OrgDomainListResponse`](https://docs.gravityrail.com/sdk/type-aliases/OrgDomainListResponse.md)> *** ### listPhoneNumbers()[​](#listphonenumbers "Direct link to listPhoneNumbers()") > **listPhoneNumbers**(`orgUuid`): `Promise`<[`ProviderPhoneNumber`](https://docs.gravityrail.com/sdk/interfaces/ProviderPhoneNumber.md)\[]> Defined in: [packages/sdk/src/api/org.ts:313](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/org.ts#L313) List all provider phone numbers owned by this organization. #### Parameters[​](#parameters-35 "Direct link to Parameters") ##### orgUuid[​](#orguuid-12 "Direct link to orgUuid") `string` #### Returns[​](#returns-36 "Direct link to Returns") `Promise`<[`ProviderPhoneNumber`](https://docs.gravityrail.com/sdk/interfaces/ProviderPhoneNumber.md)\[]> *** ### provisionA2PEnrollmentSite()[​](#provisiona2penrollmentsite "Direct link to provisionA2PEnrollmentSite()") > **provisionA2PEnrollmentSite**(`orgUuid`, `brandUuid`, `data?`): `Promise`<[`A2PCampaignConfigResponse`](https://docs.gravityrail.com/sdk/interfaces/A2PCampaignConfigResponse.md)> Defined in: [packages/sdk/src/api/org.ts:751](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/org.ts#L751) Provision (or reuse) a patient-enrollment Site for the brand and link it — the one-click path behind the SMS Consent tab. `workspaceUuid` is required only when the org has multiple workspaces. Returns the refreshed campaign config so the editor's link state updates inline. Idempotent. #### Parameters[​](#parameters-36 "Direct link to Parameters") ##### orgUuid[​](#orguuid-13 "Direct link to orgUuid") `string` ##### brandUuid[​](#branduuid-4 "Direct link to brandUuid") `string` ##### data?[​](#data-4 "Direct link to data?") [`ProvisionA2PEnrollmentSiteRequest`](https://docs.gravityrail.com/sdk/interfaces/ProvisionA2PEnrollmentSiteRequest.md) = `{}` #### Returns[​](#returns-37 "Direct link to Returns") `Promise`<[`A2PCampaignConfigResponse`](https://docs.gravityrail.com/sdk/interfaces/A2PCampaignConfigResponse.md)> *** ### purchasePhoneNumber()[​](#purchasephonenumber "Direct link to purchasePhoneNumber()") > **purchasePhoneNumber**(`orgUuid`, `phoneNumber`, `numberType`, `opts?`): `Promise`<[`ProviderPhoneNumber`](https://docs.gravityrail.com/sdk/interfaces/ProviderPhoneNumber.md)> Defined in: [packages/sdk/src/api/org.ts:387](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/org.ts#L387) Purchase a phone number from Twilio for this org inventory (org admin only). Numbers in regulated countries (e.g. Australia) require a Twilio regulatory bundle and an address — pass `bundleSid` and `addressSid` for those. #### Parameters[​](#parameters-37 "Direct link to Parameters") ##### orgUuid[​](#orguuid-14 "Direct link to orgUuid") `string` ##### phoneNumber[​](#phonenumber "Direct link to phoneNumber") `string` ##### numberType[​](#numbertype "Direct link to numberType") `"local"` | `"toll_free"` ##### opts?[​](#opts "Direct link to opts?") ###### addressSid?[​](#addresssid "Direct link to addressSid?") `string` ###### bundleSid?[​](#bundlesid "Direct link to bundleSid?") `string` ###### country?[​](#country "Direct link to country?") `string` #### Returns[​](#returns-38 "Direct link to Returns") `Promise`<[`ProviderPhoneNumber`](https://docs.gravityrail.com/sdk/interfaces/ProviderPhoneNumber.md)> *** ### reassignPhone()[​](#reassignphone "Direct link to reassignPhone()") > **reassignPhone**(`orgUuid`, `providerPhoneUuid`, `newWorkspaceUuid`): `Promise`<[`ProviderPhoneNumber`](https://docs.gravityrail.com/sdk/interfaces/ProviderPhoneNumber.md)> Defined in: [packages/sdk/src/api/org.ts:334](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/org.ts#L334) Reassign a phone number to a different workspace. #### Parameters[​](#parameters-38 "Direct link to Parameters") ##### orgUuid[​](#orguuid-15 "Direct link to orgUuid") `string` ##### providerPhoneUuid[​](#providerphoneuuid-2 "Direct link to providerPhoneUuid") `string` ##### newWorkspaceUuid[​](#newworkspaceuuid "Direct link to newWorkspaceUuid") `string` #### Returns[​](#returns-39 "Direct link to Returns") `Promise`<[`ProviderPhoneNumber`](https://docs.gravityrail.com/sdk/interfaces/ProviderPhoneNumber.md)> *** ### registerOrgDomain()[​](#registerorgdomain "Direct link to registerOrgDomain()") > **registerOrgDomain**(`orgIdOrUuid`, `domain`): `Promise`<[`OrgDomain`](https://docs.gravityrail.com/sdk/type-aliases/OrgDomain.md)> Defined in: [packages/sdk/src/api/org.ts:429](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/org.ts#L429) Register a domain with an organization and return the TXT ownership proof. #### Parameters[​](#parameters-39 "Direct link to Parameters") ##### orgIdOrUuid[​](#orgidoruuid-21 "Direct link to orgIdOrUuid") `string` | `number` ##### domain[​](#domain "Direct link to domain") `string` #### Returns[​](#returns-40 "Direct link to Returns") `Promise`<[`OrgDomain`](https://docs.gravityrail.com/sdk/type-aliases/OrgDomain.md)> *** ### releasePhone()[​](#releasephone "Direct link to releasePhone()") > **releasePhone**(`orgUuid`, `providerPhoneUuid`): `Promise`<[`ProviderPhoneNumber`](https://docs.gravityrail.com/sdk/interfaces/ProviderPhoneNumber.md)> Defined in: [packages/sdk/src/api/org.ts:348](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/org.ts#L348) Release a phone number from its current workspace. #### Parameters[​](#parameters-40 "Direct link to Parameters") ##### orgUuid[​](#orguuid-16 "Direct link to orgUuid") `string` ##### providerPhoneUuid[​](#providerphoneuuid-3 "Direct link to providerPhoneUuid") `string` #### Returns[​](#returns-41 "Direct link to Returns") `Promise`<[`ProviderPhoneNumber`](https://docs.gravityrail.com/sdk/interfaces/ProviderPhoneNumber.md)> *** ### removeOrganizationMember()[​](#removeorganizationmember "Direct link to removeOrganizationMember()") > **removeOrganizationMember**(`orgIdOrUuid`, `memberId`): `Promise`<`void`> Defined in: [packages/sdk/src/api/org.ts:145](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/org.ts#L145) Remove a member from an organization. #### Parameters[​](#parameters-41 "Direct link to Parameters") ##### orgIdOrUuid[​](#orgidoruuid-22 "Direct link to orgIdOrUuid") `string` | `number` ##### memberId[​](#memberid "Direct link to memberId") `number` #### Returns[​](#returns-42 "Direct link to Returns") `Promise`<`void`> *** ### resendOrganizationInvitation()[​](#resendorganizationinvitation "Direct link to resendOrganizationInvitation()") > **resendOrganizationInvitation**(`orgIdOrUuid`, `invitationId`): `Promise`<{ `message`: `string`; }> Defined in: [packages/sdk/src/api/org.ts:228](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/org.ts#L228) Resend an organization invitation email. #### Parameters[​](#parameters-42 "Direct link to Parameters") ##### orgIdOrUuid[​](#orgidoruuid-23 "Direct link to orgIdOrUuid") `string` | `number` ##### invitationId[​](#invitationid-2 "Direct link to invitationId") `number` #### Returns[​](#returns-43 "Direct link to Returns") `Promise`<{ `message`: `string`; }> *** ### searchPhoneNumbers()[​](#searchphonenumbers "Direct link to searchPhoneNumbers()") > **searchPhoneNumbers**(`orgUuid`, `params?`): `Promise`<`AvailablePhoneNumberResponse`\[]> Defined in: [packages/sdk/src/api/org.ts:358](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/org.ts#L358) Search for available phone numbers to purchase from Twilio. #### Parameters[​](#parameters-43 "Direct link to Parameters") ##### orgUuid[​](#orguuid-17 "Direct link to orgUuid") `string` ##### params?[​](#params "Direct link to params?") ###### areaCode?[​](#areacode "Direct link to areaCode?") `string` ###### contains?[​](#contains "Direct link to contains?") `string` ###### country?[​](#country-1 "Direct link to country?") `string` ISO 3166-1 alpha-2 country code (e.g. 'US', 'AU'). Defaults to 'US'. ###### limit?[​](#limit "Direct link to limit?") `number` ###### numberType?[​](#numbertype-1 "Direct link to numberType?") `"local"` | `"toll_free"` #### Returns[​](#returns-44 "Direct link to Returns") `Promise`<`AvailablePhoneNumberResponse`\[]> *** ### setActingMember()[​](#setactingmember "Direct link to setActingMember()") > **setActingMember**(`memberUuid`): `void` Defined in: [packages/sdk/src/api/base.ts:219](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/base.ts#L219) Set the acting member UUID for member identity switching. When set, all API requests will include the X-Acting-Member header. The backend will validate that the authenticated account owns this member and use it as the effective identity for the request. #### Parameters[​](#parameters-44 "Direct link to Parameters") ##### memberUuid[​](#memberuuid "Direct link to memberUuid") `string` | `undefined` #### Returns[​](#returns-45 "Direct link to Returns") `void` #### Inherited from[​](#inherited-from-2 "Direct link to Inherited from") [`BaseApiClient`](https://docs.gravityrail.com/sdk/classes/BaseApiClient.md).[`setActingMember`](https://docs.gravityrail.com/sdk/classes/BaseApiClient.md#setactingmember) *** ### setEnhancedAuthHandler()[​](#setenhancedauthhandler "Direct link to setEnhancedAuthHandler()") > **setEnhancedAuthHandler**(`handler`): `void` Defined in: [packages/sdk/src/api/base.ts:193](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/base.ts#L193) Set the handler for enhanced authentication requirements (RFC 9470 Step-Up Auth). This handler is called when a 401 response includes WWW-Authenticate header with error="insufficient\_user\_authentication". #### Parameters[​](#parameters-45 "Direct link to Parameters") ##### handler[​](#handler "Direct link to handler") [`EnhancedAuthHandler`](https://docs.gravityrail.com/sdk/type-aliases/EnhancedAuthHandler.md) | `undefined` #### Returns[​](#returns-46 "Direct link to Returns") `void` #### Inherited from[​](#inherited-from-3 "Direct link to Inherited from") [`BaseApiClient`](https://docs.gravityrail.com/sdk/classes/BaseApiClient.md).[`setEnhancedAuthHandler`](https://docs.gravityrail.com/sdk/classes/BaseApiClient.md#setenhancedauthhandler) *** ### setOrgAuthHandler()[​](#setorgauthhandler "Direct link to setOrgAuthHandler()") > **setOrgAuthHandler**(`handler`): `void` Defined in: [packages/sdk/src/api/base.ts:202](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/base.ts#L202) Set the handler for organization authentication requirements. This handler is called when a 401 response includes WWW-Authenticate header with realm="org". The handler should redirect the user to complete org auth. #### Parameters[​](#parameters-46 "Direct link to Parameters") ##### handler[​](#handler-1 "Direct link to handler") [`OrgAuthHandler`](https://docs.gravityrail.com/sdk/type-aliases/OrgAuthHandler.md) | `undefined` #### Returns[​](#returns-47 "Direct link to Returns") `void` #### Inherited from[​](#inherited-from-4 "Direct link to Inherited from") [`BaseApiClient`](https://docs.gravityrail.com/sdk/classes/BaseApiClient.md).[`setOrgAuthHandler`](https://docs.gravityrail.com/sdk/classes/BaseApiClient.md#setorgauthhandler) *** ### setOrgSession()[​](#setorgsession "Direct link to setOrgSession()") > **setOrgSession**(`session`, `orgUuid?`): `void` Defined in: [packages/sdk/src/api/base.ts:240](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/base.ts#L240) Set the opaque org session credential for cross-domain requests. Opaque gr\_sess\_ values use X-Org-Session. Legacy orgToken JWE values still use X-Org-Token through setOrgToken() during the migration window. `orgUuid` is the org that issued the credential; passing it lets the 401 handler detect a stale session when a subsequent request targets a different org and re-fire the org-auth handler instead of silently 401-ing. Callers without that context (legacy / unknown) may omit it. #### Parameters[​](#parameters-47 "Direct link to Parameters") ##### session[​](#session "Direct link to session") `string` | `undefined` ##### orgUuid?[​](#orguuid-18 "Direct link to orgUuid?") `string` #### Returns[​](#returns-48 "Direct link to Returns") `void` #### Inherited from[​](#inherited-from-5 "Direct link to Inherited from") [`BaseApiClient`](https://docs.gravityrail.com/sdk/classes/BaseApiClient.md).[`setOrgSession`](https://docs.gravityrail.com/sdk/classes/BaseApiClient.md#setorgsession) *** ### ~~setOrgToken()~~[​](#setorgtoken "Direct link to setorgtoken") > **setOrgToken**(`token`, `orgUuid?`): `void` Defined in: [packages/sdk/src/api/base.ts:249](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/base.ts#L249) #### Parameters[​](#parameters-48 "Direct link to Parameters") ##### token[​](#token "Direct link to token") `string` | `undefined` ##### orgUuid?[​](#orguuid-19 "Direct link to orgUuid?") `string` #### Returns[​](#returns-49 "Direct link to Returns") `void` #### Deprecated[​](#deprecated "Direct link to Deprecated") Legacy compatibility for stateless orgToken JWE credentials. Prefer setOrgSession() for opaque org browser sessions. #### Inherited from[​](#inherited-from-6 "Direct link to Inherited from") [`BaseApiClient`](https://docs.gravityrail.com/sdk/classes/BaseApiClient.md).[`setOrgToken`](https://docs.gravityrail.com/sdk/classes/BaseApiClient.md#setorgtoken) *** ### startA2PRegistration()[​](#starta2pregistration "Direct link to startA2PRegistration()") > **startA2PRegistration**(`orgUuid`, `brandName`, `brandDescription`): `Promise`<{ `status`: `string`; `workflowId`: `string`; }> Defined in: [packages/sdk/src/api/org.ts:591](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/org.ts#L591) Start org-level A2P brand registration. #### Parameters[​](#parameters-49 "Direct link to Parameters") ##### orgUuid[​](#orguuid-20 "Direct link to orgUuid") `string` ##### brandName[​](#brandname "Direct link to brandName") `string` ##### brandDescription[​](#branddescription "Direct link to brandDescription") `string` #### Returns[​](#returns-50 "Direct link to Returns") `Promise`<{ `status`: `string`; `workflowId`: `string`; }> *** ### submitBusinessProfile()[​](#submitbusinessprofile "Direct link to submitBusinessProfile()") > **submitBusinessProfile**(`orgUuid`): `Promise`<[`BusinessProfileSubmitResponse`](https://docs.gravityrail.com/sdk/interfaces/BusinessProfileSubmitResponse.md)> Defined in: [packages/sdk/src/api/org.ts:657](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/org.ts#L657) 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[​](#parameters-50 "Direct link to Parameters") ##### orgUuid[​](#orguuid-21 "Direct link to orgUuid") `string` #### Returns[​](#returns-51 "Direct link to Returns") `Promise`<[`BusinessProfileSubmitResponse`](https://docs.gravityrail.com/sdk/interfaces/BusinessProfileSubmitResponse.md)> *** ### unlinkA2PEnrollmentSite()[​](#unlinka2penrollmentsite "Direct link to unlinkA2PEnrollmentSite()") > **unlinkA2PEnrollmentSite**(`orgUuid`, `brandUuid`): `Promise`<[`A2PCampaignConfigResponse`](https://docs.gravityrail.com/sdk/interfaces/A2PCampaignConfigResponse.md)> Defined in: [packages/sdk/src/api/org.ts:766](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/org.ts#L766) Clear the brand's enrollment-site link. #### Parameters[​](#parameters-51 "Direct link to Parameters") ##### orgUuid[​](#orguuid-22 "Direct link to orgUuid") `string` ##### brandUuid[​](#branduuid-5 "Direct link to brandUuid") `string` #### Returns[​](#returns-52 "Direct link to Returns") `Promise`<[`A2PCampaignConfigResponse`](https://docs.gravityrail.com/sdk/interfaces/A2PCampaignConfigResponse.md)> *** ### updateA2PCampaignConfig()[​](#updatea2pcampaignconfig "Direct link to updateA2PCampaignConfig()") > **updateA2PCampaignConfig**(`orgUuid`, `brandUuid`, `data`): `Promise`<[`A2PCampaignConfigResponse`](https://docs.gravityrail.com/sdk/interfaces/A2PCampaignConfigResponse.md)> Defined in: [packages/sdk/src/api/org.ts:699](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/org.ts#L699) Partial-update a brand's A2P campaign config. Returns the freshly resolved config so the editor's live preview updates without a second round-trip. #### Parameters[​](#parameters-52 "Direct link to Parameters") ##### orgUuid[​](#orguuid-23 "Direct link to orgUuid") `string` ##### brandUuid[​](#branduuid-6 "Direct link to brandUuid") `string` ##### data[​](#data-5 "Direct link to data") [`UpdateA2PCampaignConfigRequest`](https://docs.gravityrail.com/sdk/interfaces/UpdateA2PCampaignConfigRequest.md) #### Returns[​](#returns-53 "Direct link to Returns") `Promise`<[`A2PCampaignConfigResponse`](https://docs.gravityrail.com/sdk/interfaces/A2PCampaignConfigResponse.md)> *** ### updateApiKey()[​](#updateapikey "Direct link to updateApiKey()") > **updateApiKey**(`newApiKey`): `void` Defined in: [packages/sdk/src/api/base.ts:209](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/base.ts#L209) Update the API key (used after successful re-authentication). #### Parameters[​](#parameters-53 "Direct link to Parameters") ##### newApiKey[​](#newapikey "Direct link to newApiKey") `string` #### Returns[​](#returns-54 "Direct link to Returns") `void` #### Inherited from[​](#inherited-from-7 "Direct link to Inherited from") [`BaseApiClient`](https://docs.gravityrail.com/sdk/classes/BaseApiClient.md).[`updateApiKey`](https://docs.gravityrail.com/sdk/classes/BaseApiClient.md#updateapikey) *** ### updateBusinessProfile()[​](#updatebusinessprofile "Direct link to updateBusinessProfile()") > **updateBusinessProfile**(`orgUuid`, `data`): `Promise`<[`BusinessProfile`](https://docs.gravityrail.com/sdk/type-aliases/BusinessProfile.md)> Defined in: [packages/sdk/src/api/org.ts:642](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/org.ts#L642) 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[​](#parameters-54 "Direct link to Parameters") ##### orgUuid[​](#orguuid-24 "Direct link to orgUuid") `string` ##### data[​](#data-6 "Direct link to data") [`UpdateBusinessProfileRequest`](https://docs.gravityrail.com/sdk/interfaces/UpdateBusinessProfileRequest.md) #### Returns[​](#returns-55 "Direct link to Returns") `Promise`<[`BusinessProfile`](https://docs.gravityrail.com/sdk/type-aliases/BusinessProfile.md)> *** ### updateOrganizationInvitation()[​](#updateorganizationinvitation "Direct link to updateOrganizationInvitation()") > **updateOrganizationInvitation**(`orgIdOrUuid`, `invitationId`, `data`): `Promise`<[`InvitationResponse`](https://docs.gravityrail.com/sdk/type-aliases/InvitationResponse.md)> Defined in: [packages/sdk/src/api/org.ts:202](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/org.ts#L202) Update an organization invitation. #### Parameters[​](#parameters-55 "Direct link to Parameters") ##### orgIdOrUuid[​](#orgidoruuid-24 "Direct link to orgIdOrUuid") `string` | `number` ##### invitationId[​](#invitationid-3 "Direct link to invitationId") `number` ##### data[​](#data-7 "Direct link to data") [`UpdateInvitationFormData`](https://docs.gravityrail.com/sdk/interfaces/UpdateInvitationFormData.md) #### Returns[​](#returns-56 "Direct link to Returns") `Promise`<[`InvitationResponse`](https://docs.gravityrail.com/sdk/type-aliases/InvitationResponse.md)> *** ### updateOrganizationMember()[​](#updateorganizationmember "Direct link to updateOrganizationMember()") > **updateOrganizationMember**(`orgIdOrUuid`, `memberId`, `data`): `Promise`<[`OrgMember`](https://docs.gravityrail.com/sdk/interfaces/OrgMember.md)> Defined in: [packages/sdk/src/api/org.ts:131](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/org.ts#L131) Update an organization member's role. #### Parameters[​](#parameters-56 "Direct link to Parameters") ##### orgIdOrUuid[​](#orgidoruuid-25 "Direct link to orgIdOrUuid") `string` | `number` ##### memberId[​](#memberid-1 "Direct link to memberId") `number` ##### data[​](#data-8 "Direct link to data") [`UpdateOrgMemberRequest`](https://docs.gravityrail.com/sdk/interfaces/UpdateOrgMemberRequest.md) #### Returns[​](#returns-57 "Direct link to Returns") `Promise`<[`OrgMember`](https://docs.gravityrail.com/sdk/interfaces/OrgMember.md)> *** ### updateOrganizationWorkspace()[​](#updateorganizationworkspace "Direct link to updateOrganizationWorkspace()") > **updateOrganizationWorkspace**(`orgIdOrUuid`, `workspaceUuid`, `data`): `Promise`<`OrgWorkspace`> Defined in: [packages/sdk/src/api/org.ts:295](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/org.ts#L295) Update a workspace in an organization. #### Parameters[​](#parameters-57 "Direct link to Parameters") ##### orgIdOrUuid[​](#orgidoruuid-26 "Direct link to orgIdOrUuid") `string` | `number` ##### workspaceUuid[​](#workspaceuuid-4 "Direct link to workspaceUuid") `string` ##### data[​](#data-9 "Direct link to data") `OrgWorkspaceFormData` #### Returns[​](#returns-58 "Direct link to Returns") `Promise`<`OrgWorkspace`> *** ### verifyOrgDomainEmail()[​](#verifyorgdomainemail "Direct link to verifyOrgDomainEmail()") > **verifyOrgDomainEmail**(`orgIdOrUuid`, `domainUuid`): `Promise`<[`EmailVerificationResponse`](https://docs.gravityrail.com/sdk/interfaces/EmailVerificationResponse.md)> Defined in: [packages/sdk/src/api/org.ts:490](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/org.ts#L490) Verify email DNS records, including MX. #### Parameters[​](#parameters-58 "Direct link to Parameters") ##### orgIdOrUuid[​](#orgidoruuid-27 "Direct link to orgIdOrUuid") `string` | `number` ##### domainUuid[​](#domainuuid-8 "Direct link to domainUuid") `string` #### Returns[​](#returns-59 "Direct link to Returns") `Promise`<[`EmailVerificationResponse`](https://docs.gravityrail.com/sdk/interfaces/EmailVerificationResponse.md)> *** ### verifyOrgDomainOwnership()[​](#verifyorgdomainownership "Direct link to verifyOrgDomainOwnership()") > **verifyOrgDomainOwnership**(`orgIdOrUuid`, `domainUuid`): `Promise`<[`OwnershipVerificationResponse`](https://docs.gravityrail.com/sdk/interfaces/OwnershipVerificationResponse.md)> Defined in: [packages/sdk/src/api/org.ts:446](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/org.ts#L446) Verify domain ownership by checking the \_gravity-verify TXT record. #### Parameters[​](#parameters-59 "Direct link to Parameters") ##### orgIdOrUuid[​](#orgidoruuid-28 "Direct link to orgIdOrUuid") `string` | `number` ##### domainUuid[​](#domainuuid-9 "Direct link to domainUuid") `string` #### Returns[​](#returns-60 "Direct link to Returns") `Promise`<[`OwnershipVerificationResponse`](https://docs.gravityrail.com/sdk/interfaces/OwnershipVerificationResponse.md)> *** ### verifyOrgDomainSite()[​](#verifyorgdomainsite "Direct link to verifyOrgDomainSite()") > **verifyOrgDomainSite**(`orgIdOrUuid`, `domainUuid`): `Promise`<[`SiteVerificationResponse`](https://docs.gravityrail.com/sdk/interfaces/SiteVerificationResponse.md)> Defined in: [packages/sdk/src/api/org.ts:546](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/org.ts#L546) Verify the site CNAME points at the Gravity Rail sites domain. #### Parameters[​](#parameters-60 "Direct link to Parameters") ##### orgIdOrUuid[​](#orgidoruuid-29 "Direct link to orgIdOrUuid") `string` | `number` ##### domainUuid[​](#domainuuid-10 "Direct link to domainUuid") `string` #### Returns[​](#returns-61 "Direct link to Returns") `Promise`<[`SiteVerificationResponse`](https://docs.gravityrail.com/sdk/interfaces/SiteVerificationResponse.md)> --- # Class: QueriesApi Defined in: [packages/sdk/src/api/queries.ts:17](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/queries.ts#L17) Unified Query Engine API (`/w/{wid}/queries/*`). Carries the JSON Query IR (see `query-engine-types.ts`) — the same tree the query-builder UI renders. PHI note: query operands may be sensitive; never log request bodies. ## Extends[​](#extends "Direct link to Extends") * [`BaseApiClient`](https://docs.gravityrail.com/sdk/classes/BaseApiClient.md) ## Constructors[​](#constructors "Direct link to Constructors") ### Constructor[​](#constructor "Direct link to Constructor") > **new QueriesApi**(`apiKey`, `baseUrl`, `customFetch?`): `QueriesApi` Defined in: [packages/sdk/src/api/base.ts:173](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/base.ts#L173) #### Parameters[​](#parameters "Direct link to Parameters") ##### apiKey[​](#apikey "Direct link to apiKey") `string` | `undefined` ##### baseUrl[​](#baseurl "Direct link to baseUrl") `string` ##### customFetch?[​](#customfetch "Direct link to customFetch?") {(`input`, `init?`): `Promise`<`Response`>; (`input`, `init?`): `Promise`<`Response`>; } #### Returns[​](#returns "Direct link to Returns") `QueriesApi` #### Inherited from[​](#inherited-from "Direct link to Inherited from") [`BaseApiClient`](https://docs.gravityrail.com/sdk/classes/BaseApiClient.md).[`constructor`](https://docs.gravityrail.com/sdk/classes/BaseApiClient.md#constructor) ## Methods[​](#methods "Direct link to Methods") ### getActingMember()[​](#getactingmember "Direct link to getActingMember()") > **getActingMember**(): `string` | `undefined` Defined in: [packages/sdk/src/api/base.ts:226](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/base.ts#L226) Get the current acting member UUID. #### Returns[​](#returns-1 "Direct link to Returns") `string` | `undefined` #### Inherited from[​](#inherited-from-1 "Direct link to Inherited from") [`BaseApiClient`](https://docs.gravityrail.com/sdk/classes/BaseApiClient.md).[`getActingMember`](https://docs.gravityrail.com/sdk/classes/BaseApiClient.md#getactingmember) *** ### getQueryFields()[​](#getqueryfields "Direct link to getQueryFields()") > **getQueryFields**(`wid`): `Promise`<[`QueryFieldsResponse`](https://docs.gravityrail.com/sdk/interfaces/QueryFieldsResponse.md)> Defined in: [packages/sdk/src/api/queries.ts:19](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/queries.ts#L19) Queryable namespace: native fields, operators per type, DataType record fields. #### Parameters[​](#parameters-1 "Direct link to Parameters") ##### wid[​](#wid "Direct link to wid") `string` #### Returns[​](#returns-2 "Direct link to Returns") `Promise`<[`QueryFieldsResponse`](https://docs.gravityrail.com/sdk/interfaces/QueryFieldsResponse.md)> *** ### previewQuery()[​](#previewquery "Direct link to previewQuery()") > **previewQuery**(`wid`, `query`, `mode?`): `Promise`<[`RunQueryResponse`](https://docs.gravityrail.com/sdk/interfaces/RunQueryResponse.md)> Defined in: [packages/sdk/src/api/queries.ts:34](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/queries.ts#L34) Bounded sample run (limit capped server-side). #### Parameters[​](#parameters-2 "Direct link to Parameters") ##### wid[​](#wid-1 "Direct link to wid") `string` ##### query[​](#query "Direct link to query") [`QueryIR`](https://docs.gravityrail.com/sdk/interfaces/QueryIR.md) ##### mode?[​](#mode "Direct link to mode?") [`QueryRunMode`](https://docs.gravityrail.com/sdk/type-aliases/QueryRunMode.md) #### Returns[​](#returns-3 "Direct link to Returns") `Promise`<[`RunQueryResponse`](https://docs.gravityrail.com/sdk/interfaces/RunQueryResponse.md)> *** ### runQuery()[​](#runquery "Direct link to runQuery()") > **runQuery**(`wid`, `query`, `mode?`): `Promise`<[`RunQueryResponse`](https://docs.gravityrail.com/sdk/interfaces/RunQueryResponse.md)> Defined in: [packages/sdk/src/api/queries.ts:42](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/queries.ts#L42) Execute a query (rows / count / aggregate). #### Parameters[​](#parameters-3 "Direct link to Parameters") ##### wid[​](#wid-2 "Direct link to wid") `string` ##### query[​](#query-1 "Direct link to query") [`QueryIR`](https://docs.gravityrail.com/sdk/interfaces/QueryIR.md) ##### mode?[​](#mode-1 "Direct link to mode?") [`QueryRunMode`](https://docs.gravityrail.com/sdk/type-aliases/QueryRunMode.md) #### Returns[​](#returns-4 "Direct link to Returns") `Promise`<[`RunQueryResponse`](https://docs.gravityrail.com/sdk/interfaces/RunQueryResponse.md)> *** ### setActingMember()[​](#setactingmember "Direct link to setActingMember()") > **setActingMember**(`memberUuid`): `void` Defined in: [packages/sdk/src/api/base.ts:219](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/base.ts#L219) Set the acting member UUID for member identity switching. When set, all API requests will include the X-Acting-Member header. The backend will validate that the authenticated account owns this member and use it as the effective identity for the request. #### Parameters[​](#parameters-4 "Direct link to Parameters") ##### memberUuid[​](#memberuuid "Direct link to memberUuid") `string` | `undefined` #### Returns[​](#returns-5 "Direct link to Returns") `void` #### Inherited from[​](#inherited-from-2 "Direct link to Inherited from") [`BaseApiClient`](https://docs.gravityrail.com/sdk/classes/BaseApiClient.md).[`setActingMember`](https://docs.gravityrail.com/sdk/classes/BaseApiClient.md#setactingmember) *** ### setEnhancedAuthHandler()[​](#setenhancedauthhandler "Direct link to setEnhancedAuthHandler()") > **setEnhancedAuthHandler**(`handler`): `void` Defined in: [packages/sdk/src/api/base.ts:193](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/base.ts#L193) Set the handler for enhanced authentication requirements (RFC 9470 Step-Up Auth). This handler is called when a 401 response includes WWW-Authenticate header with error="insufficient\_user\_authentication". #### Parameters[​](#parameters-5 "Direct link to Parameters") ##### handler[​](#handler "Direct link to handler") [`EnhancedAuthHandler`](https://docs.gravityrail.com/sdk/type-aliases/EnhancedAuthHandler.md) | `undefined` #### Returns[​](#returns-6 "Direct link to Returns") `void` #### Inherited from[​](#inherited-from-3 "Direct link to Inherited from") [`BaseApiClient`](https://docs.gravityrail.com/sdk/classes/BaseApiClient.md).[`setEnhancedAuthHandler`](https://docs.gravityrail.com/sdk/classes/BaseApiClient.md#setenhancedauthhandler) *** ### setOrgAuthHandler()[​](#setorgauthhandler "Direct link to setOrgAuthHandler()") > **setOrgAuthHandler**(`handler`): `void` Defined in: [packages/sdk/src/api/base.ts:202](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/base.ts#L202) Set the handler for organization authentication requirements. This handler is called when a 401 response includes WWW-Authenticate header with realm="org". The handler should redirect the user to complete org auth. #### Parameters[​](#parameters-6 "Direct link to Parameters") ##### handler[​](#handler-1 "Direct link to handler") [`OrgAuthHandler`](https://docs.gravityrail.com/sdk/type-aliases/OrgAuthHandler.md) | `undefined` #### Returns[​](#returns-7 "Direct link to Returns") `void` #### Inherited from[​](#inherited-from-4 "Direct link to Inherited from") [`BaseApiClient`](https://docs.gravityrail.com/sdk/classes/BaseApiClient.md).[`setOrgAuthHandler`](https://docs.gravityrail.com/sdk/classes/BaseApiClient.md#setorgauthhandler) *** ### setOrgSession()[​](#setorgsession "Direct link to setOrgSession()") > **setOrgSession**(`session`, `orgUuid?`): `void` Defined in: [packages/sdk/src/api/base.ts:240](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/base.ts#L240) Set the opaque org session credential for cross-domain requests. Opaque gr\_sess\_ values use X-Org-Session. Legacy orgToken JWE values still use X-Org-Token through setOrgToken() during the migration window. `orgUuid` is the org that issued the credential; passing it lets the 401 handler detect a stale session when a subsequent request targets a different org and re-fire the org-auth handler instead of silently 401-ing. Callers without that context (legacy / unknown) may omit it. #### Parameters[​](#parameters-7 "Direct link to Parameters") ##### session[​](#session "Direct link to session") `string` | `undefined` ##### orgUuid?[​](#orguuid "Direct link to orgUuid?") `string` #### Returns[​](#returns-8 "Direct link to Returns") `void` #### Inherited from[​](#inherited-from-5 "Direct link to Inherited from") [`BaseApiClient`](https://docs.gravityrail.com/sdk/classes/BaseApiClient.md).[`setOrgSession`](https://docs.gravityrail.com/sdk/classes/BaseApiClient.md#setorgsession) *** ### ~~setOrgToken()~~[​](#setorgtoken "Direct link to setorgtoken") > **setOrgToken**(`token`, `orgUuid?`): `void` Defined in: [packages/sdk/src/api/base.ts:249](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/base.ts#L249) #### Parameters[​](#parameters-8 "Direct link to Parameters") ##### token[​](#token "Direct link to token") `string` | `undefined` ##### orgUuid?[​](#orguuid-1 "Direct link to orgUuid?") `string` #### Returns[​](#returns-9 "Direct link to Returns") `void` #### Deprecated[​](#deprecated "Direct link to Deprecated") Legacy compatibility for stateless orgToken JWE credentials. Prefer setOrgSession() for opaque org browser sessions. #### Inherited from[​](#inherited-from-6 "Direct link to Inherited from") [`BaseApiClient`](https://docs.gravityrail.com/sdk/classes/BaseApiClient.md).[`setOrgToken`](https://docs.gravityrail.com/sdk/classes/BaseApiClient.md#setorgtoken) *** ### updateApiKey()[​](#updateapikey "Direct link to updateApiKey()") > **updateApiKey**(`newApiKey`): `void` Defined in: [packages/sdk/src/api/base.ts:209](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/base.ts#L209) Update the API key (used after successful re-authentication). #### Parameters[​](#parameters-9 "Direct link to Parameters") ##### newApiKey[​](#newapikey "Direct link to newApiKey") `string` #### Returns[​](#returns-10 "Direct link to Returns") `void` #### Inherited from[​](#inherited-from-7 "Direct link to Inherited from") [`BaseApiClient`](https://docs.gravityrail.com/sdk/classes/BaseApiClient.md).[`updateApiKey`](https://docs.gravityrail.com/sdk/classes/BaseApiClient.md#updateapikey) *** ### validateQuery()[​](#validatequery "Direct link to validateQuery()") > **validateQuery**(`wid`, `query`): `Promise`<[`ValidateQueryResponse`](https://docs.gravityrail.com/sdk/interfaces/ValidateQueryResponse.md)> Defined in: [packages/sdk/src/api/queries.ts:26](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/queries.ts#L26) Structure / field / access / cost validation without execution. #### Parameters[​](#parameters-10 "Direct link to Parameters") ##### wid[​](#wid-3 "Direct link to wid") `string` ##### query[​](#query-2 "Direct link to query") [`QueryIR`](https://docs.gravityrail.com/sdk/interfaces/QueryIR.md) #### Returns[​](#returns-11 "Direct link to Returns") `Promise`<[`ValidateQueryResponse`](https://docs.gravityrail.com/sdk/interfaces/ValidateQueryResponse.md)> --- # Class: RoleUpdate Defined in: [packages/sdk/src/workspace-builder/role-update.ts:5](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/role-update.ts#L5) ## Extends[​](#extends "Direct link to Extends") * `WorkspaceBuilderResource` ## Constructors[​](#constructors "Direct link to Constructors") ### Constructor[​](#constructor "Direct link to Constructor") > **new RoleUpdate**(`roleId`, `workflowIds?`, `dataTypeIds?`): `RoleUpdate` Defined in: [packages/sdk/src/workspace-builder/role-update.ts:6](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/role-update.ts#L6) #### Parameters[​](#parameters "Direct link to Parameters") ##### roleId[​](#roleid "Direct link to roleId") `number` ##### workflowIds?[​](#workflowids "Direct link to workflowIds?") `number`\[] ##### dataTypeIds?[​](#datatypeids "Direct link to dataTypeIds?") `number`\[] #### Returns[​](#returns "Direct link to Returns") `RoleUpdate` #### Overrides[​](#overrides "Direct link to Overrides") `WorkspaceBuilderResource.constructor` ## Properties[​](#properties "Direct link to Properties") ### \_created[​](#_created "Direct link to _created") > **\_created**: `boolean` = `false` Defined in: [packages/sdk/src/workspace-builder/resource.ts:23](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/resource.ts#L23) #### Inherited from[​](#inherited-from "Direct link to Inherited from") `WorkspaceBuilderResource._created` *** ### \_existed[​](#_existed "Direct link to _existed") > **\_existed**: `boolean` = `false` Defined in: [packages/sdk/src/workspace-builder/resource.ts:24](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/resource.ts#L24) #### Inherited from[​](#inherited-from-1 "Direct link to Inherited from") `WorkspaceBuilderResource._existed` *** ### \_id?[​](#_id "Direct link to _id?") > `optional` **\_id**: `number` Defined in: [packages/sdk/src/workspace-builder/resource.ts:21](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/resource.ts#L21) #### Inherited from[​](#inherited-from-2 "Direct link to Inherited from") `WorkspaceBuilderResource._id` *** ### \_uuid?[​](#_uuid "Direct link to _uuid?") > `optional` **\_uuid**: `string` Defined in: [packages/sdk/src/workspace-builder/resource.ts:22](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/resource.ts#L22) #### Inherited from[​](#inherited-from-3 "Direct link to Inherited from") `WorkspaceBuilderResource._uuid` *** ### dataTypeIds?[​](#datatypeids-1 "Direct link to dataTypeIds?") > `readonly` `optional` **dataTypeIds**: `number`\[] Defined in: [packages/sdk/src/workspace-builder/role-update.ts:9](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/role-update.ts#L9) *** ### roleId[​](#roleid-1 "Direct link to roleId") > `readonly` **roleId**: `number` Defined in: [packages/sdk/src/workspace-builder/role-update.ts:7](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/role-update.ts#L7) *** ### workflowIds?[​](#workflowids-1 "Direct link to workflowIds?") > `readonly` `optional` **workflowIds**: `number`\[] Defined in: [packages/sdk/src/workspace-builder/role-update.ts:8](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/role-update.ts#L8) ## Accessors[​](#accessors "Direct link to Accessors") ### id[​](#id "Direct link to id") #### Get Signature[​](#get-signature "Direct link to Get Signature") > **get** **id**(): `number` Defined in: [packages/sdk/src/workspace-builder/resource.ts:27](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/resource.ts#L27) Server-assigned numeric id — available after apply() or adopt(). ##### Returns[​](#returns-1 "Direct link to Returns") `number` #### Inherited from[​](#inherited-from-4 "Direct link to Inherited from") `WorkspaceBuilderResource.id` *** ### uuid[​](#uuid "Direct link to uuid") #### Get Signature[​](#get-signature-1 "Direct link to Get Signature") > **get** **uuid**(): `string` Defined in: [packages/sdk/src/workspace-builder/resource.ts:38](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/resource.ts#L38) Server-assigned uuid — available after apply() or adopt(). ##### Returns[​](#returns-2 "Direct link to Returns") `string` #### Inherited from[​](#inherited-from-5 "Direct link to Inherited from") `WorkspaceBuilderResource.uuid` ## Methods[​](#methods "Direct link to Methods") ### adopt()[​](#adopt "Direct link to adopt()") > **adopt**(`existing`): `void` Defined in: [packages/sdk/src/workspace-builder/resource.ts:55](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/resource.ts#L55) #### Parameters[​](#parameters-1 "Direct link to Parameters") ##### existing[​](#existing "Direct link to existing") `AnyRecord` #### Returns[​](#returns-3 "Direct link to Returns") `void` #### Inherited from[​](#inherited-from-6 "Direct link to Inherited from") `WorkspaceBuilderResource.adopt` *** ### apply()[​](#apply "Direct link to apply()") > **apply**(`client`): `Promise`<`void`> Defined in: [packages/sdk/src/workspace-builder/role-update.ts:21](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/role-update.ts#L21) #### Parameters[​](#parameters-2 "Direct link to Parameters") ##### client[​](#client "Direct link to client") [`GravityRailWorkspaceClient`](https://docs.gravityrail.com/sdk/type-aliases/GravityRailWorkspaceClient.md) #### Returns[​](#returns-4 "Direct link to Returns") `Promise`<`void`> #### Overrides[​](#overrides-1 "Direct link to Overrides") `WorkspaceBuilderResource.apply` *** ### matchKey()[​](#matchkey "Direct link to matchKey()") > **matchKey**(): `string` | `undefined` Defined in: [packages/sdk/src/workspace-builder/resource.ts:51](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/resource.ts#L51) #### Returns[​](#returns-5 "Direct link to Returns") `string` | `undefined` #### Inherited from[​](#inherited-from-7 "Direct link to Inherited from") `WorkspaceBuilderResource.matchKey` *** ### planLine()[​](#planline "Direct link to planLine()") > **planLine**(): `string` Defined in: [packages/sdk/src/workspace-builder/role-update.ts:14](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/role-update.ts#L14) #### Returns[​](#returns-6 "Direct link to Returns") `string` #### Overrides[​](#overrides-2 "Direct link to Overrides") `WorkspaceBuilderResource.planLine` --- # Class: RoutineBuilder Defined in: [packages/sdk/src/workspace-builder/automation.ts:67](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/automation.ts#L67) ## Extends[​](#extends "Direct link to Extends") * `WorkspaceBuilderResource` ## Constructors[​](#constructors "Direct link to Constructors") ### Constructor[​](#constructor "Direct link to Constructor") > **new RoutineBuilder**(`name`, `cronSchedule?`, `options?`): `RoutineBuilder` Defined in: [packages/sdk/src/workspace-builder/automation.ts:72](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/automation.ts#L72) #### Parameters[​](#parameters "Direct link to Parameters") ##### name[​](#name "Direct link to name") `string` ##### cronSchedule?[​](#cronschedule "Direct link to cronSchedule?") `string` = `''` ##### options?[​](#options "Direct link to options?") `AnyRecord` = `{}` #### Returns[​](#returns "Direct link to Returns") `RoutineBuilder` #### Overrides[​](#overrides "Direct link to Overrides") `WorkspaceBuilderResource.constructor` ## Properties[​](#properties "Direct link to Properties") ### \_created[​](#_created "Direct link to _created") > **\_created**: `boolean` = `false` Defined in: [packages/sdk/src/workspace-builder/resource.ts:23](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/resource.ts#L23) #### Inherited from[​](#inherited-from "Direct link to Inherited from") `WorkspaceBuilderResource._created` *** ### \_existed[​](#_existed "Direct link to _existed") > **\_existed**: `boolean` = `false` Defined in: [packages/sdk/src/workspace-builder/resource.ts:24](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/resource.ts#L24) #### Inherited from[​](#inherited-from-1 "Direct link to Inherited from") `WorkspaceBuilderResource._existed` *** ### \_id?[​](#_id "Direct link to _id?") > `optional` **\_id**: `number` Defined in: [packages/sdk/src/workspace-builder/resource.ts:21](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/resource.ts#L21) #### Inherited from[​](#inherited-from-2 "Direct link to Inherited from") `WorkspaceBuilderResource._id` *** ### \_uuid?[​](#_uuid "Direct link to _uuid?") > `optional` **\_uuid**: `string` Defined in: [packages/sdk/src/workspace-builder/resource.ts:22](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/resource.ts#L22) #### Inherited from[​](#inherited-from-3 "Direct link to Inherited from") `WorkspaceBuilderResource._uuid` *** ### active[​](#active "Direct link to active") > `readonly` **active**: `boolean` Defined in: [packages/sdk/src/workspace-builder/automation.ts:68](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/automation.ts#L68) *** ### cronSchedule[​](#cronschedule-1 "Direct link to cronSchedule") > `readonly` **cronSchedule**: `string` = `''` Defined in: [packages/sdk/src/workspace-builder/automation.ts:74](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/automation.ts#L74) *** ### description[​](#description "Direct link to description") > `readonly` **description**: `string` Defined in: [packages/sdk/src/workspace-builder/automation.ts:69](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/automation.ts#L69) *** ### name[​](#name-1 "Direct link to name") > `readonly` **name**: `string` Defined in: [packages/sdk/src/workspace-builder/automation.ts:73](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/automation.ts#L73) *** ### rules[​](#rules "Direct link to rules") > `readonly` **rules**: `RoutineRuleDraft`\[] = `[]` Defined in: [packages/sdk/src/workspace-builder/automation.ts:70](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/automation.ts#L70) ## Accessors[​](#accessors "Direct link to Accessors") ### id[​](#id "Direct link to id") #### Get Signature[​](#get-signature "Direct link to Get Signature") > **get** **id**(): `number` Defined in: [packages/sdk/src/workspace-builder/resource.ts:27](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/resource.ts#L27) Server-assigned numeric id — available after apply() or adopt(). ##### Returns[​](#returns-1 "Direct link to Returns") `number` #### Inherited from[​](#inherited-from-4 "Direct link to Inherited from") `WorkspaceBuilderResource.id` *** ### uuid[​](#uuid "Direct link to uuid") #### Get Signature[​](#get-signature-1 "Direct link to Get Signature") > **get** **uuid**(): `string` Defined in: [packages/sdk/src/workspace-builder/resource.ts:38](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/resource.ts#L38) Server-assigned uuid — available after apply() or adopt(). ##### Returns[​](#returns-2 "Direct link to Returns") `string` #### Inherited from[​](#inherited-from-5 "Direct link to Inherited from") `WorkspaceBuilderResource.uuid` ## Methods[​](#methods "Direct link to Methods") ### addRule()[​](#addrule "Direct link to addRule()") > **addRule**(`actionType`, `options?`): `RoutineBuilder` Defined in: [packages/sdk/src/workspace-builder/automation.ts:82](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/automation.ts#L82) #### Parameters[​](#parameters-1 "Direct link to Parameters") ##### actionType[​](#actiontype "Direct link to actionType") `string` ##### options?[​](#options-1 "Direct link to options?") ###### actionParams?[​](#actionparams "Direct link to actionParams?") `AnyRecord` ###### memberFilter?[​](#memberfilter "Direct link to memberFilter?") [`MemberFilterBuilder`](https://docs.gravityrail.com/sdk/classes/MemberFilterBuilder.md) ###### workflow?[​](#workflow "Direct link to workflow?") [`WorkflowBuilder`](https://docs.gravityrail.com/sdk/classes/WorkflowBuilder.md) #### Returns[​](#returns-3 "Direct link to Returns") `RoutineBuilder` *** ### adopt()[​](#adopt "Direct link to adopt()") > **adopt**(`existing`): `void` Defined in: [packages/sdk/src/workspace-builder/resource.ts:55](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/resource.ts#L55) #### Parameters[​](#parameters-2 "Direct link to Parameters") ##### existing[​](#existing "Direct link to existing") `AnyRecord` #### Returns[​](#returns-4 "Direct link to Returns") `void` #### Inherited from[​](#inherited-from-6 "Direct link to Inherited from") `WorkspaceBuilderResource.adopt` *** ### apply()[​](#apply "Direct link to apply()") > **apply**(`client`): `Promise`<`void`> Defined in: [packages/sdk/src/workspace-builder/automation.ts:108](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/automation.ts#L108) #### Parameters[​](#parameters-3 "Direct link to Parameters") ##### client[​](#client "Direct link to client") [`GravityRailWorkspaceClient`](https://docs.gravityrail.com/sdk/type-aliases/GravityRailWorkspaceClient.md) #### Returns[​](#returns-5 "Direct link to Returns") `Promise`<`void`> #### Overrides[​](#overrides-1 "Direct link to Overrides") `WorkspaceBuilderResource.apply` *** ### matchKey()[​](#matchkey "Direct link to matchKey()") > **matchKey**(): `string` | `undefined` Defined in: [packages/sdk/src/workspace-builder/resource.ts:51](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/resource.ts#L51) #### Returns[​](#returns-6 "Direct link to Returns") `string` | `undefined` #### Inherited from[​](#inherited-from-7 "Direct link to Inherited from") `WorkspaceBuilderResource.matchKey` *** ### planLine()[​](#planline "Direct link to planLine()") > **planLine**(): `string` Defined in: [packages/sdk/src/workspace-builder/automation.ts:99](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/automation.ts#L99) #### Returns[​](#returns-7 "Direct link to Returns") `string` #### Overrides[​](#overrides-2 "Direct link to Overrides") `WorkspaceBuilderResource.planLine` --- # Class: ScopeManager Defined in: [packages/sdk/src/scopes.ts:601](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/scopes.ts#L601) Manager for scope operations and validations ## Constructors[​](#constructors "Direct link to Constructors") ### Constructor[​](#constructor "Direct link to Constructor") > **new ScopeManager**(): `ScopeManager` #### Returns[​](#returns "Direct link to Returns") `ScopeManager` ## Methods[​](#methods "Direct link to Methods") ### expandScopes()[​](#expandscopes "Direct link to expandScopes()") > `static` **expandScopes**(`scopeNames`): `Set`<`string`> Defined in: [packages/sdk/src/scopes.ts:628](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/scopes.ts#L628) Expand a list of scope names to include all implied scopes #### Parameters[​](#parameters "Direct link to Parameters") ##### scopeNames[​](#scopenames "Direct link to scopeNames") `string`\[] #### Returns[​](#returns-1 "Direct link to Returns") `Set`<`string`> *** ### formatScopeDescription()[​](#formatscopedescription "Direct link to formatScopeDescription()") > `static` **formatScopeDescription**(`scopeNames`): `Record`<[`ScopeCategory`](https://docs.gravityrail.com/sdk/enumerations/ScopeCategory.md), `object`\[]> Defined in: [packages/sdk/src/scopes.ts:674](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/scopes.ts#L674) Format scope descriptions grouped by category #### Parameters[​](#parameters-1 "Direct link to Parameters") ##### scopeNames[​](#scopenames-1 "Direct link to scopeNames") `string`\[] #### Returns[​](#returns-2 "Direct link to Returns") `Record`<[`ScopeCategory`](https://docs.gravityrail.com/sdk/enumerations/ScopeCategory.md), `object`\[]> *** ### formatScopeString()[​](#formatscopestring "Direct link to formatScopeString()") > `static` **formatScopeString**(`scopes`): `string` Defined in: [packages/sdk/src/scopes.ts:735](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/scopes.ts#L735) Convert scope array to space-separated string #### Parameters[​](#parameters-2 "Direct link to Parameters") ##### scopes[​](#scopes "Direct link to scopes") `string`\[] #### Returns[​](#returns-3 "Direct link to Returns") `string` *** ### getAllScopes()[​](#getallscopes "Direct link to getAllScopes()") > `static` **getAllScopes**(): `Record`<[`ScopeName`](https://docs.gravityrail.com/sdk/type-aliases/ScopeName.md), `ScopeDefinition`> Defined in: [packages/sdk/src/scopes.ts:612](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/scopes.ts#L612) Get all available scopes #### Returns[​](#returns-4 "Direct link to Returns") `Record`<[`ScopeName`](https://docs.gravityrail.com/sdk/type-aliases/ScopeName.md), `ScopeDefinition`> *** ### getDangerousScopes()[​](#getdangerousscopes "Direct link to getDangerousScopes()") > `static` **getDangerousScopes**(`scopeNames`): `ScopeDefinition`\[] Defined in: [packages/sdk/src/scopes.ts:664](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/scopes.ts#L664) Get all dangerous scopes from a list of scope names #### Parameters[​](#parameters-3 "Direct link to Parameters") ##### scopeNames[​](#scopenames-2 "Direct link to scopeNames") `string`\[] #### Returns[​](#returns-5 "Direct link to Returns") `ScopeDefinition`\[] *** ### getScope()[​](#getscope "Direct link to getScope()") > `static` **getScope**(`name`): `ScopeDefinition` Defined in: [packages/sdk/src/scopes.ts:605](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/scopes.ts#L605) Get a scope by name #### Parameters[​](#parameters-4 "Direct link to Parameters") ##### name[​](#name "Direct link to name") `"workspace:read"` | `"workspace:write"` | `"workspace:admin"` | `"members:read"` | `"members:write"` | `"members:admin"` | `"member_roles:read"` | `"member_roles:write"` | `"member_roles:admin"` | `"chats:read"` | `"chats:write"` | `"chats:admin"` | `"dm:read"` | `"dm:write"` | `"dm:admin"` | `"journeys:read"` | `"journeys:write"` | `"journeys:admin"` | `"experiments:read"` | `"experiments:write"` | `"experiments:admin"` | `"workflows:read"` | `"workflows:write"` | `"workflows:admin"` | `"assignments:read"` | `"assignments:write"` | `"assignments:admin"` | `"automations:read"` | `"automations:write"` | `"automations:admin"` | `"datatypes:read"` | `"datatypes:write"` | `"datatypes:admin"` | `"records:read"` | `"records:write"` | `"records:admin"` | `"files:read"` | `"files:write"` | `"files:admin"` | `"sites:read"` | `"sites:write"` | `"sites:admin"` | `"agents:read"` | `"agents:write"` | `"agents:admin"` | `"calendars:read"` | `"calendars:write"` | `"calendars:admin"` | `"inboxes:read"` | `"inboxes:write"` | `"inboxes:admin"` | `"phones:read"` | `"phones:write"` | `"phones:admin"` | `"webhooks:read"` | `"webhooks:write"` | `"webhooks:admin"` | `"webhooks:raw"` | `"apps:read"` | `"apps:write"` | `"apps:admin"` | `"labels:read"` | `"labels:write"` | `"analytics:read"` | `"operator:read"` | `"operator:write"` | `"export:read"` | `"export:write"` | `"export:admin"` | `"org:info"` | `"org:read"` | `"org:write"` | `"org:admin"` | `"org:manage_admins"` | `"org:delete"` #### Returns[​](#returns-6 "Direct link to Returns") `ScopeDefinition` *** ### getScopesByCategory()[​](#getscopesbycategory "Direct link to getScopesByCategory()") > `static` **getScopesByCategory**(`category`): `ScopeDefinition`\[] Defined in: [packages/sdk/src/scopes.ts:619](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/scopes.ts#L619) Get all scopes in a specific category #### Parameters[​](#parameters-5 "Direct link to Parameters") ##### category[​](#category "Direct link to category") [`ScopeCategory`](https://docs.gravityrail.com/sdk/enumerations/ScopeCategory.md) #### Returns[​](#returns-7 "Direct link to Returns") `ScopeDefinition`\[] *** ### parseScopeString()[​](#parsescopestring "Direct link to parseScopeString()") > `static` **parseScopeString**(`scopeString`): `string`\[] Defined in: [packages/sdk/src/scopes.ts:728](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/scopes.ts#L728) Parse a space-separated scope string into an array #### Parameters[​](#parameters-6 "Direct link to Parameters") ##### scopeString[​](#scopestring "Direct link to scopeString") `string` #### Returns[​](#returns-8 "Direct link to Returns") `string`\[] *** ### validateScopes()[​](#validatescopes "Direct link to validateScopes()") > `static` **validateScopes**(`scopeNames`): `string`\[] Defined in: [packages/sdk/src/scopes.ts:653](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/scopes.ts#L653) Validate that all scope names are valid #### Parameters[​](#parameters-7 "Direct link to Parameters") ##### scopeNames[​](#scopenames-3 "Direct link to scopeNames") `string`\[] #### Returns[​](#returns-9 "Direct link to Returns") `string`\[] List of invalid scope names, or empty array if all valid #### Throws[​](#throws "Direct link to Throws") Error if any scope names are invalid --- # Class: SupervisorsApi Defined in: [packages/sdk/src/api/supervisors.ts:18](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/supervisors.ts#L18) ## Extends[​](#extends "Direct link to Extends") * [`BaseApiClient`](https://docs.gravityrail.com/sdk/classes/BaseApiClient.md) ## Constructors[​](#constructors "Direct link to Constructors") ### Constructor[​](#constructor "Direct link to Constructor") > **new SupervisorsApi**(`apiKey`, `baseUrl`, `customFetch?`): `SupervisorsApi` Defined in: [packages/sdk/src/api/base.ts:173](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/base.ts#L173) #### Parameters[​](#parameters "Direct link to Parameters") ##### apiKey[​](#apikey "Direct link to apiKey") `string` | `undefined` ##### baseUrl[​](#baseurl "Direct link to baseUrl") `string` ##### customFetch?[​](#customfetch "Direct link to customFetch?") {(`input`, `init?`): `Promise`<`Response`>; (`input`, `init?`): `Promise`<`Response`>; } #### Returns[​](#returns "Direct link to Returns") `SupervisorsApi` #### Inherited from[​](#inherited-from "Direct link to Inherited from") [`BaseApiClient`](https://docs.gravityrail.com/sdk/classes/BaseApiClient.md).[`constructor`](https://docs.gravityrail.com/sdk/classes/BaseApiClient.md#constructor) ## Methods[​](#methods "Direct link to Methods") ### createSupervisor()[​](#createsupervisor "Direct link to createSupervisor()") > **createSupervisor**(`wid`, `supervisor`): `Promise`<[`CustomTool`](https://docs.gravityrail.com/sdk/type-aliases/CustomTool.md)> Defined in: [packages/sdk/src/api/supervisors.ts:30](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/supervisors.ts#L30) Create a new supervisor in a workspace. #### Parameters[​](#parameters-1 "Direct link to Parameters") ##### wid[​](#wid "Direct link to wid") `string` ##### supervisor[​](#supervisor "Direct link to supervisor") [`SupervisorFormData`](https://docs.gravityrail.com/sdk/interfaces/SupervisorFormData.md) #### Returns[​](#returns-1 "Direct link to Returns") `Promise`<[`CustomTool`](https://docs.gravityrail.com/sdk/type-aliases/CustomTool.md)> *** ### deleteSupervisor()[​](#deletesupervisor "Direct link to deleteSupervisor()") > **deleteSupervisor**(`wid`, `id`): `Promise`<`void`> Defined in: [packages/sdk/src/api/supervisors.ts:50](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/supervisors.ts#L50) Delete a supervisor by ID. #### Parameters[​](#parameters-2 "Direct link to Parameters") ##### wid[​](#wid-1 "Direct link to wid") `string` ##### id[​](#id "Direct link to id") `number` #### Returns[​](#returns-2 "Direct link to Returns") `Promise`<`void`> *** ### getActingMember()[​](#getactingmember "Direct link to getActingMember()") > **getActingMember**(): `string` | `undefined` Defined in: [packages/sdk/src/api/base.ts:226](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/base.ts#L226) Get the current acting member UUID. #### Returns[​](#returns-3 "Direct link to Returns") `string` | `undefined` #### Inherited from[​](#inherited-from-1 "Direct link to Inherited from") [`BaseApiClient`](https://docs.gravityrail.com/sdk/classes/BaseApiClient.md).[`getActingMember`](https://docs.gravityrail.com/sdk/classes/BaseApiClient.md#getactingmember) *** ### getSupervisor()[​](#getsupervisor "Direct link to getSupervisor()") > **getSupervisor**(`wid`, `id`): `Promise`<[`CustomTool`](https://docs.gravityrail.com/sdk/type-aliases/CustomTool.md)> Defined in: [packages/sdk/src/api/supervisors.ts:25](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/supervisors.ts#L25) Get a single supervisor by ID. #### Parameters[​](#parameters-3 "Direct link to Parameters") ##### wid[​](#wid-2 "Direct link to wid") `string` ##### id[​](#id-1 "Direct link to id") `number` #### Returns[​](#returns-4 "Direct link to Returns") `Promise`<[`CustomTool`](https://docs.gravityrail.com/sdk/type-aliases/CustomTool.md)> *** ### getSupervisors()[​](#getsupervisors "Direct link to getSupervisors()") > **getSupervisors**(`wid`): `Promise`<[`CustomTool`](https://docs.gravityrail.com/sdk/type-aliases/CustomTool.md)\[]> Defined in: [packages/sdk/src/api/supervisors.ts:20](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/supervisors.ts#L20) List all supervisors in a workspace. #### Parameters[​](#parameters-4 "Direct link to Parameters") ##### wid[​](#wid-3 "Direct link to wid") `string` #### Returns[​](#returns-5 "Direct link to Returns") `Promise`<[`CustomTool`](https://docs.gravityrail.com/sdk/type-aliases/CustomTool.md)\[]> *** ### setActingMember()[​](#setactingmember "Direct link to setActingMember()") > **setActingMember**(`memberUuid`): `void` Defined in: [packages/sdk/src/api/base.ts:219](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/base.ts#L219) Set the acting member UUID for member identity switching. When set, all API requests will include the X-Acting-Member header. The backend will validate that the authenticated account owns this member and use it as the effective identity for the request. #### Parameters[​](#parameters-5 "Direct link to Parameters") ##### memberUuid[​](#memberuuid "Direct link to memberUuid") `string` | `undefined` #### Returns[​](#returns-6 "Direct link to Returns") `void` #### Inherited from[​](#inherited-from-2 "Direct link to Inherited from") [`BaseApiClient`](https://docs.gravityrail.com/sdk/classes/BaseApiClient.md).[`setActingMember`](https://docs.gravityrail.com/sdk/classes/BaseApiClient.md#setactingmember) *** ### setEnhancedAuthHandler()[​](#setenhancedauthhandler "Direct link to setEnhancedAuthHandler()") > **setEnhancedAuthHandler**(`handler`): `void` Defined in: [packages/sdk/src/api/base.ts:193](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/base.ts#L193) Set the handler for enhanced authentication requirements (RFC 9470 Step-Up Auth). This handler is called when a 401 response includes WWW-Authenticate header with error="insufficient\_user\_authentication". #### Parameters[​](#parameters-6 "Direct link to Parameters") ##### handler[​](#handler "Direct link to handler") [`EnhancedAuthHandler`](https://docs.gravityrail.com/sdk/type-aliases/EnhancedAuthHandler.md) | `undefined` #### Returns[​](#returns-7 "Direct link to Returns") `void` #### Inherited from[​](#inherited-from-3 "Direct link to Inherited from") [`BaseApiClient`](https://docs.gravityrail.com/sdk/classes/BaseApiClient.md).[`setEnhancedAuthHandler`](https://docs.gravityrail.com/sdk/classes/BaseApiClient.md#setenhancedauthhandler) *** ### setOrgAuthHandler()[​](#setorgauthhandler "Direct link to setOrgAuthHandler()") > **setOrgAuthHandler**(`handler`): `void` Defined in: [packages/sdk/src/api/base.ts:202](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/base.ts#L202) Set the handler for organization authentication requirements. This handler is called when a 401 response includes WWW-Authenticate header with realm="org". The handler should redirect the user to complete org auth. #### Parameters[​](#parameters-7 "Direct link to Parameters") ##### handler[​](#handler-1 "Direct link to handler") [`OrgAuthHandler`](https://docs.gravityrail.com/sdk/type-aliases/OrgAuthHandler.md) | `undefined` #### Returns[​](#returns-8 "Direct link to Returns") `void` #### Inherited from[​](#inherited-from-4 "Direct link to Inherited from") [`BaseApiClient`](https://docs.gravityrail.com/sdk/classes/BaseApiClient.md).[`setOrgAuthHandler`](https://docs.gravityrail.com/sdk/classes/BaseApiClient.md#setorgauthhandler) *** ### setOrgSession()[​](#setorgsession "Direct link to setOrgSession()") > **setOrgSession**(`session`, `orgUuid?`): `void` Defined in: [packages/sdk/src/api/base.ts:240](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/base.ts#L240) Set the opaque org session credential for cross-domain requests. Opaque gr\_sess\_ values use X-Org-Session. Legacy orgToken JWE values still use X-Org-Token through setOrgToken() during the migration window. `orgUuid` is the org that issued the credential; passing it lets the 401 handler detect a stale session when a subsequent request targets a different org and re-fire the org-auth handler instead of silently 401-ing. Callers without that context (legacy / unknown) may omit it. #### Parameters[​](#parameters-8 "Direct link to Parameters") ##### session[​](#session "Direct link to session") `string` | `undefined` ##### orgUuid?[​](#orguuid "Direct link to orgUuid?") `string` #### Returns[​](#returns-9 "Direct link to Returns") `void` #### Inherited from[​](#inherited-from-5 "Direct link to Inherited from") [`BaseApiClient`](https://docs.gravityrail.com/sdk/classes/BaseApiClient.md).[`setOrgSession`](https://docs.gravityrail.com/sdk/classes/BaseApiClient.md#setorgsession) *** ### ~~setOrgToken()~~[​](#setorgtoken "Direct link to setorgtoken") > **setOrgToken**(`token`, `orgUuid?`): `void` Defined in: [packages/sdk/src/api/base.ts:249](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/base.ts#L249) #### Parameters[​](#parameters-9 "Direct link to Parameters") ##### token[​](#token "Direct link to token") `string` | `undefined` ##### orgUuid?[​](#orguuid-1 "Direct link to orgUuid?") `string` #### Returns[​](#returns-10 "Direct link to Returns") `void` #### Deprecated[​](#deprecated "Direct link to Deprecated") Legacy compatibility for stateless orgToken JWE credentials. Prefer setOrgSession() for opaque org browser sessions. #### Inherited from[​](#inherited-from-6 "Direct link to Inherited from") [`BaseApiClient`](https://docs.gravityrail.com/sdk/classes/BaseApiClient.md).[`setOrgToken`](https://docs.gravityrail.com/sdk/classes/BaseApiClient.md#setorgtoken) *** ### updateApiKey()[​](#updateapikey "Direct link to updateApiKey()") > **updateApiKey**(`newApiKey`): `void` Defined in: [packages/sdk/src/api/base.ts:209](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/base.ts#L209) Update the API key (used after successful re-authentication). #### Parameters[​](#parameters-10 "Direct link to Parameters") ##### newApiKey[​](#newapikey "Direct link to newApiKey") `string` #### Returns[​](#returns-11 "Direct link to Returns") `void` #### Inherited from[​](#inherited-from-7 "Direct link to Inherited from") [`BaseApiClient`](https://docs.gravityrail.com/sdk/classes/BaseApiClient.md).[`updateApiKey`](https://docs.gravityrail.com/sdk/classes/BaseApiClient.md#updateapikey) *** ### updateSupervisor()[​](#updatesupervisor "Direct link to updateSupervisor()") > **updateSupervisor**(`wid`, `id`, `supervisor`): `Promise`<[`CustomTool`](https://docs.gravityrail.com/sdk/type-aliases/CustomTool.md)> Defined in: [packages/sdk/src/api/supervisors.ts:38](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/supervisors.ts#L38) Update an existing supervisor with partial data. #### Parameters[​](#parameters-11 "Direct link to Parameters") ##### wid[​](#wid-4 "Direct link to wid") `string` ##### id[​](#id-2 "Direct link to id") `number` ##### supervisor[​](#supervisor-1 "Direct link to supervisor") `Partial`<[`SupervisorFormData`](https://docs.gravityrail.com/sdk/interfaces/SupervisorFormData.md)> #### Returns[​](#returns-12 "Direct link to Returns") `Promise`<[`CustomTool`](https://docs.gravityrail.com/sdk/type-aliases/CustomTool.md)> --- # Class: TaskBuilder Defined in: [packages/sdk/src/workspace-builder/workflows.ts:75](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/workflows.ts#L75) ## Extends[​](#extends "Direct link to Extends") * `WorkspaceBuilderResource` ## Constructors[​](#constructors "Direct link to Constructors") ### Constructor[​](#constructor "Direct link to Constructor") > **new TaskBuilder**(`name`, `workflow`, `prompt?`, `start?`, `description?`): `TaskBuilder` Defined in: [packages/sdk/src/workspace-builder/workflows.ts:79](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/workflows.ts#L79) #### Parameters[​](#parameters "Direct link to Parameters") ##### name[​](#name "Direct link to name") `string` ##### workflow[​](#workflow "Direct link to workflow") [`WorkflowBuilder`](https://docs.gravityrail.com/sdk/classes/WorkflowBuilder.md) ##### prompt?[​](#prompt "Direct link to prompt?") `string` = `''` ##### start?[​](#start "Direct link to start?") `boolean` = `false` ##### description?[​](#description "Direct link to description?") `string` = `''` #### Returns[​](#returns "Direct link to Returns") `TaskBuilder` #### Overrides[​](#overrides "Direct link to Overrides") `WorkspaceBuilderResource.constructor` ## Properties[​](#properties "Direct link to Properties") ### \_created[​](#_created "Direct link to _created") > **\_created**: `boolean` = `false` Defined in: [packages/sdk/src/workspace-builder/resource.ts:23](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/resource.ts#L23) #### Inherited from[​](#inherited-from "Direct link to Inherited from") `WorkspaceBuilderResource._created` *** ### \_existed[​](#_existed "Direct link to _existed") > **\_existed**: `boolean` = `false` Defined in: [packages/sdk/src/workspace-builder/resource.ts:24](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/resource.ts#L24) #### Inherited from[​](#inherited-from-1 "Direct link to Inherited from") `WorkspaceBuilderResource._existed` *** ### \_id?[​](#_id "Direct link to _id?") > `optional` **\_id**: `number` Defined in: [packages/sdk/src/workspace-builder/resource.ts:21](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/resource.ts#L21) #### Inherited from[​](#inherited-from-2 "Direct link to Inherited from") `WorkspaceBuilderResource._id` *** ### \_uuid?[​](#_uuid "Direct link to _uuid?") > `optional` **\_uuid**: `string` Defined in: [packages/sdk/src/workspace-builder/resource.ts:22](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/resource.ts#L22) #### Inherited from[​](#inherited-from-3 "Direct link to Inherited from") `WorkspaceBuilderResource._uuid` *** ### description[​](#description-1 "Direct link to description") > `readonly` **description**: `string` = `''` Defined in: [packages/sdk/src/workspace-builder/workflows.ts:84](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/workflows.ts#L84) *** ### eventRules[​](#eventrules "Direct link to eventRules") > `readonly` **eventRules**: `WorkspaceBuilderEventRule`\[] = `[]` Defined in: [packages/sdk/src/workspace-builder/workflows.ts:77](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/workflows.ts#L77) *** ### name[​](#name-1 "Direct link to name") > `readonly` **name**: `string` Defined in: [packages/sdk/src/workspace-builder/workflows.ts:80](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/workflows.ts#L80) *** ### prompt[​](#prompt-1 "Direct link to prompt") > `readonly` **prompt**: `string` = `''` Defined in: [packages/sdk/src/workspace-builder/workflows.ts:82](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/workflows.ts#L82) *** ### start[​](#start-1 "Direct link to start") > `readonly` **start**: `boolean` = `false` Defined in: [packages/sdk/src/workspace-builder/workflows.ts:83](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/workflows.ts#L83) *** ### transitions[​](#transitions "Direct link to transitions") > `readonly` **transitions**: `TaskTransition`\[] = `[]` Defined in: [packages/sdk/src/workspace-builder/workflows.ts:76](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/workflows.ts#L76) *** ### workflow[​](#workflow-1 "Direct link to workflow") > `readonly` **workflow**: [`WorkflowBuilder`](https://docs.gravityrail.com/sdk/classes/WorkflowBuilder.md) Defined in: [packages/sdk/src/workspace-builder/workflows.ts:81](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/workflows.ts#L81) ## Accessors[​](#accessors "Direct link to Accessors") ### id[​](#id "Direct link to id") #### Get Signature[​](#get-signature "Direct link to Get Signature") > **get** **id**(): `number` Defined in: [packages/sdk/src/workspace-builder/resource.ts:27](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/resource.ts#L27) Server-assigned numeric id — available after apply() or adopt(). ##### Returns[​](#returns-1 "Direct link to Returns") `number` #### Inherited from[​](#inherited-from-4 "Direct link to Inherited from") `WorkspaceBuilderResource.id` *** ### uuid[​](#uuid "Direct link to uuid") #### Get Signature[​](#get-signature-1 "Direct link to Get Signature") > **get** **uuid**(): `string` Defined in: [packages/sdk/src/workspace-builder/resource.ts:38](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/resource.ts#L38) Server-assigned uuid — available after apply() or adopt(). ##### Returns[​](#returns-2 "Direct link to Returns") `string` #### Inherited from[​](#inherited-from-5 "Direct link to Inherited from") `WorkspaceBuilderResource.uuid` ## Methods[​](#methods "Direct link to Methods") ### adopt()[​](#adopt "Direct link to adopt()") > **adopt**(`existing`): `void` Defined in: [packages/sdk/src/workspace-builder/resource.ts:55](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/resource.ts#L55) #### Parameters[​](#parameters-1 "Direct link to Parameters") ##### existing[​](#existing "Direct link to existing") `AnyRecord` #### Returns[​](#returns-3 "Direct link to Returns") `void` #### Inherited from[​](#inherited-from-6 "Direct link to Inherited from") `WorkspaceBuilderResource.adopt` *** ### apply()[​](#apply "Direct link to apply()") > **apply**(`client`): `Promise`<`void`> Defined in: [packages/sdk/src/workspace-builder/workflows.ts:131](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/workflows.ts#L131) #### Parameters[​](#parameters-2 "Direct link to Parameters") ##### client[​](#client "Direct link to client") [`GravityRailWorkspaceClient`](https://docs.gravityrail.com/sdk/type-aliases/GravityRailWorkspaceClient.md) #### Returns[​](#returns-4 "Direct link to Returns") `Promise`<`void`> #### Overrides[​](#overrides-1 "Direct link to Overrides") `WorkspaceBuilderResource.apply` *** ### initialMessage()[​](#initialmessage "Direct link to initialMessage()") > **initialMessage**(`message`, `suggestions?`): `TaskBuilder` Defined in: [packages/sdk/src/workspace-builder/workflows.ts:120](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/workflows.ts#L120) #### Parameters[​](#parameters-3 "Direct link to Parameters") ##### message[​](#message "Direct link to message") `string` ##### suggestions?[​](#suggestions "Direct link to suggestions?") `string`\[] #### Returns[​](#returns-5 "Direct link to Returns") `TaskBuilder` *** ### matchKey()[​](#matchkey "Direct link to matchKey()") > **matchKey**(): `string` | `undefined` Defined in: [packages/sdk/src/workspace-builder/resource.ts:51](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/resource.ts#L51) #### Returns[​](#returns-6 "Direct link to Returns") `string` | `undefined` #### Inherited from[​](#inherited-from-7 "Direct link to Inherited from") `WorkspaceBuilderResource.matchKey` *** ### onEnter()[​](#onenter "Direct link to onEnter()") > **onEnter**(`action`, `params?`, `name?`): `TaskBuilder` Defined in: [packages/sdk/src/workspace-builder/workflows.ts:110](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/workflows.ts#L110) #### Parameters[​](#parameters-4 "Direct link to Parameters") ##### action[​](#action "Direct link to action") `string` ##### params?[​](#params "Direct link to params?") `AnyRecord` = `{}` ##### name?[​](#name-2 "Direct link to name?") `string` #### Returns[​](#returns-7 "Direct link to Returns") `TaskBuilder` *** ### planLine()[​](#planline "Direct link to planLine()") > **planLine**(): `string` Defined in: [packages/sdk/src/workspace-builder/workflows.ts:127](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/workflows.ts#L127) #### Returns[​](#returns-8 "Direct link to Returns") `string` #### Overrides[​](#overrides-2 "Direct link to Overrides") `WorkspaceBuilderResource.planLine` *** ### transitionsTo()[​](#transitionsto "Direct link to transitionsTo()") > **transitionsTo**(`child`, `when`, `autoNext?`, `required?`, `celCondition?`): `TaskBuilder` Defined in: [packages/sdk/src/workspace-builder/workflows.ts:89](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/workflows.ts#L89) #### Parameters[​](#parameters-5 "Direct link to Parameters") ##### child[​](#child "Direct link to child") `TaskBuilder` ##### when[​](#when "Direct link to when") `string` ##### autoNext?[​](#autonext "Direct link to autoNext?") `boolean` = `false` ##### required?[​](#required "Direct link to required?") `boolean` = `false` ##### celCondition?[​](#celcondition "Direct link to celCondition?") `string` #### Returns[​](#returns-9 "Direct link to Returns") `TaskBuilder` --- # Class: TemplatesApi Defined in: [packages/sdk/src/api/templates.ts:84](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/templates.ts#L84) ## Extends[​](#extends "Direct link to Extends") * [`BaseApiClient`](https://docs.gravityrail.com/sdk/classes/BaseApiClient.md) ## Constructors[​](#constructors "Direct link to Constructors") ### Constructor[​](#constructor "Direct link to Constructor") > **new TemplatesApi**(`apiKey`, `baseUrl`, `customFetch?`): `TemplatesApi` Defined in: [packages/sdk/src/api/base.ts:173](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/base.ts#L173) #### Parameters[​](#parameters "Direct link to Parameters") ##### apiKey[​](#apikey "Direct link to apiKey") `string` | `undefined` ##### baseUrl[​](#baseurl "Direct link to baseUrl") `string` ##### customFetch?[​](#customfetch "Direct link to customFetch?") {(`input`, `init?`): `Promise`<`Response`>; (`input`, `init?`): `Promise`<`Response`>; } #### Returns[​](#returns "Direct link to Returns") `TemplatesApi` #### Inherited from[​](#inherited-from "Direct link to Inherited from") [`BaseApiClient`](https://docs.gravityrail.com/sdk/classes/BaseApiClient.md).[`constructor`](https://docs.gravityrail.com/sdk/classes/BaseApiClient.md#constructor) ## Methods[​](#methods "Direct link to Methods") ### getActingMember()[​](#getactingmember "Direct link to getActingMember()") > **getActingMember**(): `string` | `undefined` Defined in: [packages/sdk/src/api/base.ts:226](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/base.ts#L226) Get the current acting member UUID. #### Returns[​](#returns-1 "Direct link to Returns") `string` | `undefined` #### Inherited from[​](#inherited-from-1 "Direct link to Inherited from") [`BaseApiClient`](https://docs.gravityrail.com/sdk/classes/BaseApiClient.md).[`getActingMember`](https://docs.gravityrail.com/sdk/classes/BaseApiClient.md#getactingmember) *** ### getTemplateContext()[​](#gettemplatecontext "Direct link to getTemplateContext()") > **getTemplateContext**(`wid`, `request`): `Promise`<[`TemplateContextResponse`](https://docs.gravityrail.com/sdk/interfaces/TemplateContextResponse.md)> Defined in: [packages/sdk/src/api/templates.ts:91](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/templates.ts#L91) 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[​](#parameters-1 "Direct link to Parameters") ##### wid[​](#wid "Direct link to wid") `string` ##### request[​](#request "Direct link to request") [`TemplateContextRequest`](https://docs.gravityrail.com/sdk/interfaces/TemplateContextRequest.md) #### Returns[​](#returns-2 "Direct link to Returns") `Promise`<[`TemplateContextResponse`](https://docs.gravityrail.com/sdk/interfaces/TemplateContextResponse.md)> *** ### getVariableRegistry()[​](#getvariableregistry "Direct link to getVariableRegistry()") > **getVariableRegistry**(`wid`, `request?`): `Promise`<[`VariableRegistryResponse`](https://docs.gravityrail.com/sdk/interfaces/VariableRegistryResponse.md)> Defined in: [packages/sdk/src/api/templates.ts:123](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/templates.ts#L123) 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[​](#parameters-2 "Direct link to Parameters") ##### wid[​](#wid-1 "Direct link to wid") `string` ##### request?[​](#request-1 "Direct link to request?") [`VariableRegistryRequest`](https://docs.gravityrail.com/sdk/interfaces/VariableRegistryRequest.md) = `{}` #### Returns[​](#returns-3 "Direct link to Returns") `Promise`<[`VariableRegistryResponse`](https://docs.gravityrail.com/sdk/interfaces/VariableRegistryResponse.md)> *** ### previewTemplate()[​](#previewtemplate "Direct link to previewTemplate()") > **previewTemplate**(`wid`, `request`): `Promise`<[`TemplatePreviewResponse`](https://docs.gravityrail.com/sdk/interfaces/TemplatePreviewResponse.md)> Defined in: [packages/sdk/src/api/templates.ts:107](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/templates.ts#L107) 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[​](#parameters-3 "Direct link to Parameters") ##### wid[​](#wid-2 "Direct link to wid") `string` ##### request[​](#request-2 "Direct link to request") [`TemplatePreviewRequest`](https://docs.gravityrail.com/sdk/interfaces/TemplatePreviewRequest.md) #### Returns[​](#returns-4 "Direct link to Returns") `Promise`<[`TemplatePreviewResponse`](https://docs.gravityrail.com/sdk/interfaces/TemplatePreviewResponse.md)> *** ### setActingMember()[​](#setactingmember "Direct link to setActingMember()") > **setActingMember**(`memberUuid`): `void` Defined in: [packages/sdk/src/api/base.ts:219](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/base.ts#L219) Set the acting member UUID for member identity switching. When set, all API requests will include the X-Acting-Member header. The backend will validate that the authenticated account owns this member and use it as the effective identity for the request. #### Parameters[​](#parameters-4 "Direct link to Parameters") ##### memberUuid[​](#memberuuid "Direct link to memberUuid") `string` | `undefined` #### Returns[​](#returns-5 "Direct link to Returns") `void` #### Inherited from[​](#inherited-from-2 "Direct link to Inherited from") [`BaseApiClient`](https://docs.gravityrail.com/sdk/classes/BaseApiClient.md).[`setActingMember`](https://docs.gravityrail.com/sdk/classes/BaseApiClient.md#setactingmember) *** ### setEnhancedAuthHandler()[​](#setenhancedauthhandler "Direct link to setEnhancedAuthHandler()") > **setEnhancedAuthHandler**(`handler`): `void` Defined in: [packages/sdk/src/api/base.ts:193](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/base.ts#L193) Set the handler for enhanced authentication requirements (RFC 9470 Step-Up Auth). This handler is called when a 401 response includes WWW-Authenticate header with error="insufficient\_user\_authentication". #### Parameters[​](#parameters-5 "Direct link to Parameters") ##### handler[​](#handler "Direct link to handler") [`EnhancedAuthHandler`](https://docs.gravityrail.com/sdk/type-aliases/EnhancedAuthHandler.md) | `undefined` #### Returns[​](#returns-6 "Direct link to Returns") `void` #### Inherited from[​](#inherited-from-3 "Direct link to Inherited from") [`BaseApiClient`](https://docs.gravityrail.com/sdk/classes/BaseApiClient.md).[`setEnhancedAuthHandler`](https://docs.gravityrail.com/sdk/classes/BaseApiClient.md#setenhancedauthhandler) *** ### setOrgAuthHandler()[​](#setorgauthhandler "Direct link to setOrgAuthHandler()") > **setOrgAuthHandler**(`handler`): `void` Defined in: [packages/sdk/src/api/base.ts:202](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/base.ts#L202) Set the handler for organization authentication requirements. This handler is called when a 401 response includes WWW-Authenticate header with realm="org". The handler should redirect the user to complete org auth. #### Parameters[​](#parameters-6 "Direct link to Parameters") ##### handler[​](#handler-1 "Direct link to handler") [`OrgAuthHandler`](https://docs.gravityrail.com/sdk/type-aliases/OrgAuthHandler.md) | `undefined` #### Returns[​](#returns-7 "Direct link to Returns") `void` #### Inherited from[​](#inherited-from-4 "Direct link to Inherited from") [`BaseApiClient`](https://docs.gravityrail.com/sdk/classes/BaseApiClient.md).[`setOrgAuthHandler`](https://docs.gravityrail.com/sdk/classes/BaseApiClient.md#setorgauthhandler) *** ### setOrgSession()[​](#setorgsession "Direct link to setOrgSession()") > **setOrgSession**(`session`, `orgUuid?`): `void` Defined in: [packages/sdk/src/api/base.ts:240](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/base.ts#L240) Set the opaque org session credential for cross-domain requests. Opaque gr\_sess\_ values use X-Org-Session. Legacy orgToken JWE values still use X-Org-Token through setOrgToken() during the migration window. `orgUuid` is the org that issued the credential; passing it lets the 401 handler detect a stale session when a subsequent request targets a different org and re-fire the org-auth handler instead of silently 401-ing. Callers without that context (legacy / unknown) may omit it. #### Parameters[​](#parameters-7 "Direct link to Parameters") ##### session[​](#session "Direct link to session") `string` | `undefined` ##### orgUuid?[​](#orguuid "Direct link to orgUuid?") `string` #### Returns[​](#returns-8 "Direct link to Returns") `void` #### Inherited from[​](#inherited-from-5 "Direct link to Inherited from") [`BaseApiClient`](https://docs.gravityrail.com/sdk/classes/BaseApiClient.md).[`setOrgSession`](https://docs.gravityrail.com/sdk/classes/BaseApiClient.md#setorgsession) *** ### ~~setOrgToken()~~[​](#setorgtoken "Direct link to setorgtoken") > **setOrgToken**(`token`, `orgUuid?`): `void` Defined in: [packages/sdk/src/api/base.ts:249](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/base.ts#L249) #### Parameters[​](#parameters-8 "Direct link to Parameters") ##### token[​](#token "Direct link to token") `string` | `undefined` ##### orgUuid?[​](#orguuid-1 "Direct link to orgUuid?") `string` #### Returns[​](#returns-9 "Direct link to Returns") `void` #### Deprecated[​](#deprecated "Direct link to Deprecated") Legacy compatibility for stateless orgToken JWE credentials. Prefer setOrgSession() for opaque org browser sessions. #### Inherited from[​](#inherited-from-6 "Direct link to Inherited from") [`BaseApiClient`](https://docs.gravityrail.com/sdk/classes/BaseApiClient.md).[`setOrgToken`](https://docs.gravityrail.com/sdk/classes/BaseApiClient.md#setorgtoken) *** ### updateApiKey()[​](#updateapikey "Direct link to updateApiKey()") > **updateApiKey**(`newApiKey`): `void` Defined in: [packages/sdk/src/api/base.ts:209](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/base.ts#L209) Update the API key (used after successful re-authentication). #### Parameters[​](#parameters-9 "Direct link to Parameters") ##### newApiKey[​](#newapikey "Direct link to newApiKey") `string` #### Returns[​](#returns-10 "Direct link to Returns") `void` #### Inherited from[​](#inherited-from-7 "Direct link to Inherited from") [`BaseApiClient`](https://docs.gravityrail.com/sdk/classes/BaseApiClient.md).[`updateApiKey`](https://docs.gravityrail.com/sdk/classes/BaseApiClient.md#updateapikey) --- # Class: WorkflowBuilder Defined in: [packages/sdk/src/workspace-builder/workflows.ts:145](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/workflows.ts#L145) ## Extends[​](#extends "Direct link to Extends") * `WorkspaceBuilderResource` ## Constructors[​](#constructors "Direct link to Constructors") ### Constructor[​](#constructor "Direct link to Constructor") > **new WorkflowBuilder**(`name`, `options?`): `WorkflowBuilder` Defined in: [packages/sdk/src/workspace-builder/workflows.ts:152](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/workflows.ts#L152) #### Parameters[​](#parameters "Direct link to Parameters") ##### name[​](#name "Direct link to name") `string` ##### options?[​](#options "Direct link to options?") `AnyRecord` = `{}` #### Returns[​](#returns "Direct link to Returns") `WorkflowBuilder` #### Overrides[​](#overrides "Direct link to Overrides") `WorkspaceBuilderResource.constructor` ## Properties[​](#properties "Direct link to Properties") ### \_created[​](#_created "Direct link to _created") > **\_created**: `boolean` = `false` Defined in: [packages/sdk/src/workspace-builder/resource.ts:23](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/resource.ts#L23) #### Inherited from[​](#inherited-from "Direct link to Inherited from") `WorkspaceBuilderResource._created` *** ### \_existed[​](#_existed "Direct link to _existed") > **\_existed**: `boolean` = `false` Defined in: [packages/sdk/src/workspace-builder/resource.ts:24](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/resource.ts#L24) #### Inherited from[​](#inherited-from-1 "Direct link to Inherited from") `WorkspaceBuilderResource._existed` *** ### \_id?[​](#_id "Direct link to _id?") > `optional` **\_id**: `number` Defined in: [packages/sdk/src/workspace-builder/resource.ts:21](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/resource.ts#L21) #### Inherited from[​](#inherited-from-2 "Direct link to Inherited from") `WorkspaceBuilderResource._id` *** ### \_uuid?[​](#_uuid "Direct link to _uuid?") > `optional` **\_uuid**: `string` Defined in: [packages/sdk/src/workspace-builder/resource.ts:22](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/resource.ts#L22) #### Inherited from[​](#inherited-from-3 "Direct link to Inherited from") `WorkspaceBuilderResource._uuid` *** ### abilities[​](#abilities "Direct link to abilities") > `readonly` **abilities**: `AbilityDef`\[] = `[]` Defined in: [packages/sdk/src/workspace-builder/workflows.ts:150](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/workflows.ts#L150) *** ### description[​](#description "Direct link to description") > `readonly` **description**: `string` Defined in: [packages/sdk/src/workspace-builder/workflows.ts:146](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/workflows.ts#L146) *** ### name[​](#name-1 "Direct link to name") > `readonly` **name**: `string` Defined in: [packages/sdk/src/workspace-builder/workflows.ts:153](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/workflows.ts#L153) *** ### prompt?[​](#prompt "Direct link to prompt?") > `readonly` `optional` **prompt**: `string` Defined in: [packages/sdk/src/workspace-builder/workflows.ts:147](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/workflows.ts#L147) *** ### tasks[​](#tasks "Direct link to tasks") > `readonly` **tasks**: [`TaskBuilder`](https://docs.gravityrail.com/sdk/classes/TaskBuilder.md)\[] = `[]` Defined in: [packages/sdk/src/workspace-builder/workflows.ts:149](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/workflows.ts#L149) ## Accessors[​](#accessors "Direct link to Accessors") ### id[​](#id "Direct link to id") #### Get Signature[​](#get-signature "Direct link to Get Signature") > **get** **id**(): `number` Defined in: [packages/sdk/src/workspace-builder/resource.ts:27](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/resource.ts#L27) Server-assigned numeric id — available after apply() or adopt(). ##### Returns[​](#returns-1 "Direct link to Returns") `number` #### Inherited from[​](#inherited-from-4 "Direct link to Inherited from") `WorkspaceBuilderResource.id` *** ### startTask[​](#starttask "Direct link to startTask") #### Get Signature[​](#get-signature-1 "Direct link to Get Signature") > **get** **startTask**(): [`TaskBuilder`](https://docs.gravityrail.com/sdk/classes/TaskBuilder.md) | `undefined` Defined in: [packages/sdk/src/workspace-builder/workflows.ts:179](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/workflows.ts#L179) ##### Returns[​](#returns-2 "Direct link to Returns") [`TaskBuilder`](https://docs.gravityrail.com/sdk/classes/TaskBuilder.md) | `undefined` *** ### uuid[​](#uuid "Direct link to uuid") #### Get Signature[​](#get-signature-2 "Direct link to Get Signature") > **get** **uuid**(): `string` Defined in: [packages/sdk/src/workspace-builder/resource.ts:38](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/resource.ts#L38) Server-assigned uuid — available after apply() or adopt(). ##### Returns[​](#returns-3 "Direct link to Returns") `string` #### Inherited from[​](#inherited-from-5 "Direct link to Inherited from") `WorkspaceBuilderResource.uuid` ## Methods[​](#methods "Direct link to Methods") ### ability()[​](#ability "Direct link to ability()") > **ability**(`abilityType`, `options?`): `WorkflowBuilder` Defined in: [packages/sdk/src/workspace-builder/workflows.ts:174](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/workflows.ts#L174) #### Parameters[​](#parameters-1 "Direct link to Parameters") ##### abilityType[​](#abilitytype "Direct link to abilityType") `string` ##### options?[​](#options-1 "Direct link to options?") `AnyRecord` = `{}` #### Returns[​](#returns-4 "Direct link to Returns") `WorkflowBuilder` *** ### adopt()[​](#adopt "Direct link to adopt()") > **adopt**(`existing`): `void` Defined in: [packages/sdk/src/workspace-builder/workflows.ts:187](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/workflows.ts#L187) #### Parameters[​](#parameters-2 "Direct link to Parameters") ##### existing[​](#existing "Direct link to existing") `AnyRecord` #### Returns[​](#returns-5 "Direct link to Returns") `void` #### Overrides[​](#overrides-1 "Direct link to Overrides") `WorkspaceBuilderResource.adopt` *** ### apply()[​](#apply "Direct link to apply()") > **apply**(`client`): `Promise`<`void`> Defined in: [packages/sdk/src/workspace-builder/workflows.ts:211](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/workflows.ts#L211) #### Parameters[​](#parameters-3 "Direct link to Parameters") ##### client[​](#client "Direct link to client") [`GravityRailWorkspaceClient`](https://docs.gravityrail.com/sdk/type-aliases/GravityRailWorkspaceClient.md) #### Returns[​](#returns-6 "Direct link to Returns") `Promise`<`void`> #### Overrides[​](#overrides-2 "Direct link to Overrides") `WorkspaceBuilderResource.apply` *** ### matchKey()[​](#matchkey "Direct link to matchKey()") > **matchKey**(): `string` Defined in: [packages/sdk/src/workspace-builder/workflows.ts:183](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/workflows.ts#L183) #### Returns[​](#returns-7 "Direct link to Returns") `string` #### Overrides[​](#overrides-3 "Direct link to Overrides") `WorkspaceBuilderResource.matchKey` *** ### needsDefaultAgent()[​](#needsdefaultagent "Direct link to needsDefaultAgent()") > **needsDefaultAgent**(): `boolean` Defined in: [packages/sdk/src/workspace-builder/workflows.ts:203](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/workflows.ts#L203) #### Returns[​](#returns-8 "Direct link to Returns") `boolean` *** ### planLine()[​](#planline "Direct link to planLine()") > **planLine**(): `string` Defined in: [packages/sdk/src/workspace-builder/workflows.ts:196](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/workflows.ts#L196) #### Returns[​](#returns-9 "Direct link to Returns") `string` #### Overrides[​](#overrides-4 "Direct link to Overrides") `WorkspaceBuilderResource.planLine` *** ### setAgentId()[​](#setagentid "Direct link to setAgentId()") > **setAgentId**(`agentId`): `void` Defined in: [packages/sdk/src/workspace-builder/workflows.ts:207](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/workflows.ts#L207) #### Parameters[​](#parameters-4 "Direct link to Parameters") ##### agentId[​](#agentid "Direct link to agentId") `number` #### Returns[​](#returns-10 "Direct link to Returns") `void` *** ### task()[​](#task "Direct link to task()") > **task**(`name`, `options?`): [`TaskBuilder`](https://docs.gravityrail.com/sdk/classes/TaskBuilder.md) Defined in: [packages/sdk/src/workspace-builder/workflows.ts:162](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/workflows.ts#L162) #### Parameters[​](#parameters-5 "Direct link to Parameters") ##### name[​](#name-2 "Direct link to name") `string` ##### options?[​](#options-2 "Direct link to options?") `AnyRecord` = `{}` #### Returns[​](#returns-11 "Direct link to Returns") [`TaskBuilder`](https://docs.gravityrail.com/sdk/classes/TaskBuilder.md) --- # Class: WorkspaceBuilder Defined in: [packages/sdk/src/workspace-builder/orchestrator.ts:46](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/orchestrator.ts#L46) ## Constructors[​](#constructors "Direct link to Constructors") ### Constructor[​](#constructor "Direct link to Constructor") > **new WorkspaceBuilder**(`client`): `WorkspaceBuilder` Defined in: [packages/sdk/src/workspace-builder/orchestrator.ts:49](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/orchestrator.ts#L49) #### Parameters[​](#parameters "Direct link to Parameters") ##### client[​](#client "Direct link to client") [`GravityRailWorkspaceClient`](https://docs.gravityrail.com/sdk/type-aliases/GravityRailWorkspaceClient.md) #### Returns[​](#returns "Direct link to Returns") `WorkspaceBuilder` ## Properties[​](#properties "Direct link to Properties") ### client[​](#client-1 "Direct link to client") > `readonly` **client**: [`GravityRailWorkspaceClient`](https://docs.gravityrail.com/sdk/type-aliases/GravityRailWorkspaceClient.md) Defined in: [packages/sdk/src/workspace-builder/orchestrator.ts:49](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/orchestrator.ts#L49) *** ### resources[​](#resources "Direct link to resources") > `readonly` **resources**: `WorkspaceBuilderResource`\[] = `[]` Defined in: [packages/sdk/src/workspace-builder/orchestrator.ts:47](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/orchestrator.ts#L47) ## Methods[​](#methods "Direct link to Methods") ### agent()[​](#agent "Direct link to agent()") > **agent**(`name`, `options?`): [`AgentBuilder`](https://docs.gravityrail.com/sdk/classes/AgentBuilder.md) Defined in: [packages/sdk/src/workspace-builder/orchestrator.ts:83](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/orchestrator.ts#L83) #### Parameters[​](#parameters-1 "Direct link to Parameters") ##### name[​](#name "Direct link to name") `string` ##### options?[​](#options "Direct link to options?") `AnyRecord` = `{}` #### Returns[​](#returns-1 "Direct link to Returns") [`AgentBuilder`](https://docs.gravityrail.com/sdk/classes/AgentBuilder.md) *** ### apply()[​](#apply "Direct link to apply()") > **apply**(): `Promise`<`ResourceSummary`> Defined in: [packages/sdk/src/workspace-builder/orchestrator.ts:157](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/orchestrator.ts#L157) #### Returns[​](#returns-2 "Direct link to Returns") `Promise`<`ResourceSummary`> *** ### form()[​](#form "Direct link to form()") > **form**(`name`, `options?`): [`FormBuilder`](https://docs.gravityrail.com/sdk/classes/FormBuilder.md) Defined in: [packages/sdk/src/workspace-builder/orchestrator.ts:51](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/orchestrator.ts#L51) #### Parameters[​](#parameters-2 "Direct link to Parameters") ##### name[​](#name-1 "Direct link to name") `string` ##### options?[​](#options-1 "Direct link to options?") `AnyRecord` & `object` = `{}` #### Returns[​](#returns-3 "Direct link to Returns") [`FormBuilder`](https://docs.gravityrail.com/sdk/classes/FormBuilder.md) *** ### journey()[​](#journey "Direct link to journey()") > **journey**(`name`, `options?`): [`JourneyBuilder`](https://docs.gravityrail.com/sdk/classes/JourneyBuilder.md) Defined in: [packages/sdk/src/workspace-builder/orchestrator.ts:77](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/orchestrator.ts#L77) #### Parameters[​](#parameters-3 "Direct link to Parameters") ##### name[​](#name-2 "Direct link to name") `string` ##### options?[​](#options-2 "Direct link to options?") `AnyRecord` = `{}` #### Returns[​](#returns-4 "Direct link to Returns") [`JourneyBuilder`](https://docs.gravityrail.com/sdk/classes/JourneyBuilder.md) *** ### label()[​](#label "Direct link to label()") > **label**(`name`, `options?`): [`MemberLabelBuilder`](https://docs.gravityrail.com/sdk/classes/MemberLabelBuilder.md) Defined in: [packages/sdk/src/workspace-builder/orchestrator.ts:63](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/orchestrator.ts#L63) #### Parameters[​](#parameters-4 "Direct link to Parameters") ##### name[​](#name-3 "Direct link to name") `string` ##### options?[​](#options-3 "Direct link to options?") ###### color?[​](#color "Direct link to color?") `string` ###### description?[​](#description "Direct link to description?") `string` ###### slug?[​](#slug "Direct link to slug?") `string` #### Returns[​](#returns-5 "Direct link to Returns") [`MemberLabelBuilder`](https://docs.gravityrail.com/sdk/classes/MemberLabelBuilder.md) *** ### memberFilter()[​](#memberfilter "Direct link to memberFilter()") > **memberFilter**(`name`, `options?`): [`MemberFilterBuilder`](https://docs.gravityrail.com/sdk/classes/MemberFilterBuilder.md) Defined in: [packages/sdk/src/workspace-builder/orchestrator.ts:95](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/orchestrator.ts#L95) #### Parameters[​](#parameters-5 "Direct link to Parameters") ##### name[​](#name-4 "Direct link to name") `string` ##### options?[​](#options-4 "Direct link to options?") `AnyRecord` = `{}` #### Returns[​](#returns-6 "Direct link to Returns") [`MemberFilterBuilder`](https://docs.gravityrail.com/sdk/classes/MemberFilterBuilder.md) *** ### notificationRule()[​](#notificationrule "Direct link to notificationRule()") > **notificationRule**(`name`, `options?`): [`NotificationRuleBuilder`](https://docs.gravityrail.com/sdk/classes/NotificationRuleBuilder.md) Defined in: [packages/sdk/src/workspace-builder/orchestrator.ts:101](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/orchestrator.ts#L101) #### Parameters[​](#parameters-6 "Direct link to Parameters") ##### name[​](#name-5 "Direct link to name") `string` ##### options?[​](#options-5 "Direct link to options?") `AnyRecord` = `{}` #### Returns[​](#returns-7 "Direct link to Returns") [`NotificationRuleBuilder`](https://docs.gravityrail.com/sdk/classes/NotificationRuleBuilder.md) *** ### plan()[​](#plan "Direct link to plan()") > **plan**(): `void` Defined in: [packages/sdk/src/workspace-builder/orchestrator.ts:113](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/orchestrator.ts#L113) #### Returns[​](#returns-8 "Direct link to Returns") `void` *** ### preview()[​](#preview "Direct link to preview()") > **preview**(): `Promise`<`void`> Defined in: [packages/sdk/src/workspace-builder/orchestrator.ts:130](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/orchestrator.ts#L130) #### Returns[​](#returns-9 "Direct link to Returns") `Promise`<`void`> *** ### roleUpdate()[​](#roleupdate "Direct link to roleUpdate()") > **roleUpdate**(`roleId`, `workflowIds?`, `dataTypeIds?`): [`RoleUpdate`](https://docs.gravityrail.com/sdk/classes/RoleUpdate.md) Defined in: [packages/sdk/src/workspace-builder/orchestrator.ts:107](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/orchestrator.ts#L107) #### Parameters[​](#parameters-7 "Direct link to Parameters") ##### roleId[​](#roleid "Direct link to roleId") `number` ##### workflowIds?[​](#workflowids "Direct link to workflowIds?") `number`\[] ##### dataTypeIds?[​](#datatypeids "Direct link to dataTypeIds?") `number`\[] #### Returns[​](#returns-10 "Direct link to Returns") [`RoleUpdate`](https://docs.gravityrail.com/sdk/classes/RoleUpdate.md) *** ### routine()[​](#routine "Direct link to routine()") > **routine**(`name`, `cronSchedule?`, `options?`): [`RoutineBuilder`](https://docs.gravityrail.com/sdk/classes/RoutineBuilder.md) Defined in: [packages/sdk/src/workspace-builder/orchestrator.ts:89](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/orchestrator.ts#L89) #### Parameters[​](#parameters-8 "Direct link to Parameters") ##### name[​](#name-6 "Direct link to name") `string` ##### cronSchedule?[​](#cronschedule "Direct link to cronSchedule?") `string` = `''` ##### options?[​](#options-6 "Direct link to options?") `AnyRecord` = `{}` #### Returns[​](#returns-11 "Direct link to Returns") [`RoutineBuilder`](https://docs.gravityrail.com/sdk/classes/RoutineBuilder.md) *** ### workflow()[​](#workflow "Direct link to workflow()") > **workflow**(`name`, `options?`): [`WorkflowBuilder`](https://docs.gravityrail.com/sdk/classes/WorkflowBuilder.md) Defined in: [packages/sdk/src/workspace-builder/orchestrator.ts:57](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/orchestrator.ts#L57) #### Parameters[​](#parameters-9 "Direct link to Parameters") ##### name[​](#name-7 "Direct link to name") `string` ##### options?[​](#options-7 "Direct link to options?") `AnyRecord` = `{}` #### Returns[​](#returns-12 "Direct link to Returns") [`WorkflowBuilder`](https://docs.gravityrail.com/sdk/classes/WorkflowBuilder.md) --- # Enumeration: AccessGrantResourceType Defined in: [packages/sdk/src/types/access-grant-types.ts:14](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/access-grant-types.ts#L14) ## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members") ### APP\_CONNECTION[​](#app_connection "Direct link to APP_CONNECTION") > **APP\_CONNECTION**: `"app_connection"` Defined in: [packages/sdk/src/types/access-grant-types.ts:23](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/access-grant-types.ts#L23) *** ### ASSIGNMENT[​](#assignment "Direct link to ASSIGNMENT") > **ASSIGNMENT**: `"assignment"` Defined in: [packages/sdk/src/types/access-grant-types.ts:22](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/access-grant-types.ts#L22) *** ### CALENDAR[​](#calendar "Direct link to CALENDAR") > **CALENDAR**: `"calendar"` Defined in: [packages/sdk/src/types/access-grant-types.ts:19](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/access-grant-types.ts#L19) *** ### CAPABILITY[​](#capability "Direct link to CAPABILITY") > **CAPABILITY**: `"capability"` Defined in: [packages/sdk/src/types/access-grant-types.ts:24](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/access-grant-types.ts#L24) *** ### DATA\_RECORD[​](#data_record "Direct link to DATA_RECORD") > **DATA\_RECORD**: `"data_record"` Defined in: [packages/sdk/src/types/access-grant-types.ts:15](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/access-grant-types.ts#L15) *** ### DATA\_TYPE[​](#data_type "Direct link to DATA_TYPE") > **DATA\_TYPE**: `"data_type"` Defined in: [packages/sdk/src/types/access-grant-types.ts:16](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/access-grant-types.ts#L16) *** ### FILE[​](#file "Direct link to FILE") > **FILE**: `"file"` Defined in: [packages/sdk/src/types/access-grant-types.ts:17](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/access-grant-types.ts#L17) *** ### FOLDER[​](#folder "Direct link to FOLDER") > **FOLDER**: `"folder"` Defined in: [packages/sdk/src/types/access-grant-types.ts:18](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/access-grant-types.ts#L18) *** ### INBOX[​](#inbox "Direct link to INBOX") > **INBOX**: `"inbox"` Defined in: [packages/sdk/src/types/access-grant-types.ts:20](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/access-grant-types.ts#L20) *** ### SITE[​](#site "Direct link to SITE") > **SITE**: `"site"` Defined in: [packages/sdk/src/types/access-grant-types.ts:21](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/access-grant-types.ts#L21) --- # Enumeration: AccessGrantStatus Defined in: [packages/sdk/src/types/access-grant-types.ts:34](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/access-grant-types.ts#L34) ## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members") ### ACTIVE[​](#active "Direct link to ACTIVE") > **ACTIVE**: `"active"` Defined in: [packages/sdk/src/types/access-grant-types.ts:36](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/access-grant-types.ts#L36) *** ### DENIED[​](#denied "Direct link to DENIED") > **DENIED**: `"denied"` Defined in: [packages/sdk/src/types/access-grant-types.ts:37](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/access-grant-types.ts#L37) *** ### EXPIRED[​](#expired "Direct link to EXPIRED") > **EXPIRED**: `"expired"` Defined in: [packages/sdk/src/types/access-grant-types.ts:38](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/access-grant-types.ts#L38) *** ### PENDING[​](#pending "Direct link to PENDING") > **PENDING**: `"pending"` Defined in: [packages/sdk/src/types/access-grant-types.ts:35](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/access-grant-types.ts#L35) *** ### REVOKED[​](#revoked "Direct link to REVOKED") > **REVOKED**: `"revoked"` Defined in: [packages/sdk/src/types/access-grant-types.ts:39](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/access-grant-types.ts#L39) --- # Enumeration: AccessGrantTrigger Defined in: [packages/sdk/src/types/access-grant-types.ts:42](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/access-grant-types.ts#L42) ## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members") ### ADMIN\_OVERRIDE[​](#admin_override "Direct link to ADMIN_OVERRIDE") > **ADMIN\_OVERRIDE**: `"admin_override"` Defined in: [packages/sdk/src/types/access-grant-types.ts:45](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/access-grant-types.ts#L45) *** ### MEMBER\_SELF[​](#member_self "Direct link to MEMBER_SELF") > **MEMBER\_SELF**: `"member_self"` Defined in: [packages/sdk/src/types/access-grant-types.ts:46](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/access-grant-types.ts#L46) *** ### OPERATOR\_REQUEST[​](#operator_request "Direct link to OPERATOR_REQUEST") > **OPERATOR\_REQUEST**: `"operator_request"` Defined in: [packages/sdk/src/types/access-grant-types.ts:44](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/access-grant-types.ts#L44) *** ### WORKFLOW\_AUTO[​](#workflow_auto "Direct link to WORKFLOW_AUTO") > **WORKFLOW\_AUTO**: `"workflow_auto"` Defined in: [packages/sdk/src/types/access-grant-types.ts:43](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/access-grant-types.ts#L43) --- # Enumeration: AccessLevel Defined in: [packages/sdk/src/types/core-types.ts:24](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/core-types.ts#L24) ## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members") ### PRIVATE[​](#private "Direct link to PRIVATE") > **PRIVATE**: `"private"` Defined in: [packages/sdk/src/types/core-types.ts:25](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/core-types.ts#L25) *** ### PUBLIC[​](#public "Direct link to PUBLIC") > **PUBLIC**: `"public"` Defined in: [packages/sdk/src/types/core-types.ts:26](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/core-types.ts#L26) *** ### WORKSPACE[​](#workspace "Direct link to WORKSPACE") > **WORKSPACE**: `"workspace"` Defined in: [packages/sdk/src/types/core-types.ts:27](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/core-types.ts#L27) --- # Enumeration: AttendeeResponseStatus Defined in: [packages/sdk/src/types/calendar-types.ts:152](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/calendar-types.ts#L152) ## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members") ### ACCEPTED[​](#accepted "Direct link to ACCEPTED") > **ACCEPTED**: `"ACCEPTED"` Defined in: [packages/sdk/src/types/calendar-types.ts:154](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/calendar-types.ts#L154) *** ### DECLINED[​](#declined "Direct link to DECLINED") > **DECLINED**: `"DECLINED"` Defined in: [packages/sdk/src/types/calendar-types.ts:155](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/calendar-types.ts#L155) *** ### PENDING[​](#pending "Direct link to PENDING") > **PENDING**: `"PENDING"` Defined in: [packages/sdk/src/types/calendar-types.ts:153](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/calendar-types.ts#L153) *** ### TENTATIVE[​](#tentative "Direct link to TENTATIVE") > **TENTATIVE**: `"TENTATIVE"` Defined in: [packages/sdk/src/types/calendar-types.ts:156](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/calendar-types.ts#L156) --- # Enumeration: AttendeeStatus Defined in: [packages/sdk/src/types/calendar-types.ts:147](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/calendar-types.ts#L147) ## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members") ### OPTIONAL[​](#optional "Direct link to OPTIONAL") > **OPTIONAL**: `"OPTIONAL"` Defined in: [packages/sdk/src/types/calendar-types.ts:149](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/calendar-types.ts#L149) *** ### REQUIRED[​](#required "Direct link to REQUIRED") > **REQUIRED**: `"REQUIRED"` Defined in: [packages/sdk/src/types/calendar-types.ts:148](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/calendar-types.ts#L148) --- # Enumeration: CalendarEventStatus Defined in: [packages/sdk/src/types/calendar-types.ts:139](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/calendar-types.ts#L139) ## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members") ### CANCELLED[​](#cancelled "Direct link to CANCELLED") > **CANCELLED**: `"CANCELLED"` Defined in: [packages/sdk/src/types/calendar-types.ts:142](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/calendar-types.ts#L142) *** ### COMPLETED[​](#completed "Direct link to COMPLETED") > **COMPLETED**: `"COMPLETED"` Defined in: [packages/sdk/src/types/calendar-types.ts:144](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/calendar-types.ts#L144) *** ### CONFIRMED[​](#confirmed "Direct link to CONFIRMED") > **CONFIRMED**: `"CONFIRMED"` Defined in: [packages/sdk/src/types/calendar-types.ts:141](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/calendar-types.ts#L141) *** ### NO\_SHOW[​](#no_show "Direct link to NO_SHOW") > **NO\_SHOW**: `"NO_SHOW"` Defined in: [packages/sdk/src/types/calendar-types.ts:143](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/calendar-types.ts#L143) *** ### TENTATIVE[​](#tentative "Direct link to TENTATIVE") > **TENTATIVE**: `"TENTATIVE"` Defined in: [packages/sdk/src/types/calendar-types.ts:140](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/calendar-types.ts#L140) --- # Enumeration: CalendarPermissionType Defined in: [packages/sdk/src/types/calendar-types.ts:51](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/calendar-types.ts#L51) ## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members") ### ADMIN[​](#admin "Direct link to ADMIN") > **ADMIN**: `"ADMIN"` Defined in: [packages/sdk/src/types/calendar-types.ts:56](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/calendar-types.ts#L56) *** ### FREE\_BUSY[​](#free_busy "Direct link to FREE_BUSY") > **FREE\_BUSY**: `"FREE_BUSY"` Defined in: [packages/sdk/src/types/calendar-types.ts:53](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/calendar-types.ts#L53) *** ### NONE[​](#none "Direct link to NONE") > **NONE**: `"NONE"` Defined in: [packages/sdk/src/types/calendar-types.ts:52](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/calendar-types.ts#L52) *** ### READ[​](#read "Direct link to READ") > **READ**: `"READ"` Defined in: [packages/sdk/src/types/calendar-types.ts:54](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/calendar-types.ts#L54) *** ### WRITE[​](#write "Direct link to WRITE") > **WRITE**: `"WRITE"` Defined in: [packages/sdk/src/types/calendar-types.ts:55](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/calendar-types.ts#L55) --- # Enumeration: CalendarScheduleAvailabilityType Defined in: [packages/sdk/src/types/calendar-types.ts:103](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/calendar-types.ts#L103) ## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members") ### AVAILABLE[​](#available "Direct link to AVAILABLE") > **AVAILABLE**: `"AVAILABLE"` Defined in: [packages/sdk/src/types/calendar-types.ts:104](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/calendar-types.ts#L104) *** ### UNAVAILABLE[​](#unavailable "Direct link to UNAVAILABLE") > **UNAVAILABLE**: `"UNAVAILABLE"` Defined in: [packages/sdk/src/types/calendar-types.ts:105](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/calendar-types.ts#L105) --- # Enumeration: CalendarScheduleRecurrence Defined in: [packages/sdk/src/types/calendar-types.ts:95](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/calendar-types.ts#L95) ## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members") ### CUSTOM[​](#custom "Direct link to CUSTOM") > **CUSTOM**: `"CUSTOM"` Defined in: [packages/sdk/src/types/calendar-types.ts:100](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/calendar-types.ts#L100) *** ### DAILY[​](#daily "Direct link to DAILY") > **DAILY**: `"DAILY"` Defined in: [packages/sdk/src/types/calendar-types.ts:97](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/calendar-types.ts#L97) *** ### MONTHLY[​](#monthly "Direct link to MONTHLY") > **MONTHLY**: `"MONTHLY"` Defined in: [packages/sdk/src/types/calendar-types.ts:99](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/calendar-types.ts#L99) *** ### ONCE[​](#once "Direct link to ONCE") > **ONCE**: `"ONCE"` Defined in: [packages/sdk/src/types/calendar-types.ts:96](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/calendar-types.ts#L96) *** ### WEEKLY[​](#weekly "Direct link to WEEKLY") > **WEEKLY**: `"WEEKLY"` Defined in: [packages/sdk/src/types/calendar-types.ts:98](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/calendar-types.ts#L98) --- # Enumeration: CalendarSource Defined in: [packages/sdk/src/types/calendar-types.ts:59](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/calendar-types.ts#L59) ## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members") ### GOOGLE[​](#google "Direct link to GOOGLE") > **GOOGLE**: `"google"` Defined in: [packages/sdk/src/types/calendar-types.ts:61](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/calendar-types.ts#L61) *** ### INTERNAL[​](#internal "Direct link to INTERNAL") > **INTERNAL**: `"internal"` Defined in: [packages/sdk/src/types/calendar-types.ts:60](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/calendar-types.ts#L60) *** ### OUTLOOK[​](#outlook "Direct link to OUTLOOK") > **OUTLOOK**: `"outlook"` Defined in: [packages/sdk/src/types/calendar-types.ts:62](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/calendar-types.ts#L62) --- # Enumeration: CapabilityClass Defined in: [packages/sdk/src/types/access-grant-types.ts:28](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/access-grant-types.ts#L28) Capability classes grantable via capability-typed grants. ## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members") ### ATTENTION\_INTERRUPT\_RUNG[​](#attention_interrupt_rung "Direct link to ATTENTION_INTERRUPT_RUNG") > **ATTENTION\_INTERRUPT\_RUNG**: `"attention.interrupt_rung"` Defined in: [packages/sdk/src/types/access-grant-types.ts:31](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/access-grant-types.ts#L31) *** ### SELF\_MODIFICATION\_SCHEDULE[​](#self_modification_schedule "Direct link to SELF_MODIFICATION_SCHEDULE") > **SELF\_MODIFICATION\_SCHEDULE**: `"self_modification.schedule"` Defined in: [packages/sdk/src/types/access-grant-types.ts:30](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/access-grant-types.ts#L30) *** ### TOOL\_ALWAYS\_ALLOW[​](#tool_always_allow "Direct link to TOOL_ALWAYS_ALLOW") > **TOOL\_ALWAYS\_ALLOW**: `"tool.always_allow"` Defined in: [packages/sdk/src/types/access-grant-types.ts:29](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/access-grant-types.ts#L29) --- # Enumeration: ConsentMethod Defined in: [packages/sdk/src/types/access-grant-types.ts:49](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/access-grant-types.ts#L49) ## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members") ### ADMIN\_OVERRIDE[​](#admin_override "Direct link to ADMIN_OVERRIDE") > **ADMIN\_OVERRIDE**: `"admin_override"` Defined in: [packages/sdk/src/types/access-grant-types.ts:55](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/access-grant-types.ts#L55) *** ### AUTO\_POLICY[​](#auto_policy "Direct link to AUTO_POLICY") > **AUTO\_POLICY**: `"auto_policy"` Defined in: [packages/sdk/src/types/access-grant-types.ts:50](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/access-grant-types.ts#L50) *** ### DTMF[​](#dtmf "Direct link to DTMF") > **DTMF**: `"dtmf"` Defined in: [packages/sdk/src/types/access-grant-types.ts:52](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/access-grant-types.ts#L52) *** ### TEXT\_CONFIRM[​](#text_confirm "Direct link to TEXT_CONFIRM") > **TEXT\_CONFIRM**: `"text_confirm"` Defined in: [packages/sdk/src/types/access-grant-types.ts:53](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/access-grant-types.ts#L53) *** ### UI\_BUTTON[​](#ui_button "Direct link to UI_BUTTON") > **UI\_BUTTON**: `"ui_button"` Defined in: [packages/sdk/src/types/access-grant-types.ts:54](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/access-grant-types.ts#L54) *** ### VERBAL[​](#verbal "Direct link to VERBAL") > **VERBAL**: `"verbal"` Defined in: [packages/sdk/src/types/access-grant-types.ts:51](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/access-grant-types.ts#L51) --- # Enumeration: CriterionType Defined in: [packages/sdk/src/types/qualification-types.ts:25](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/qualification-types.ts#L25) ## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members") ### EXPRESSION[​](#expression "Direct link to EXPRESSION") > **EXPRESSION**: `"expression"` Defined in: [packages/sdk/src/types/qualification-types.ts:26](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/qualification-types.ts#L26) *** ### RUBRIC[​](#rubric "Direct link to RUBRIC") > **RUBRIC**: `"rubric"` Defined in: [packages/sdk/src/types/qualification-types.ts:27](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/qualification-types.ts#L27) --- # Enumeration: DataCategory Defined in: [packages/sdk/src/types/data-types.ts:84](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L84) ## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members") ### CREDENTIAL[​](#credential "Direct link to CREDENTIAL") > **CREDENTIAL**: `"credential"` Defined in: [packages/sdk/src/types/data-types.ts:89](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L89) *** ### FINANCIAL[​](#financial "Direct link to FINANCIAL") > **FINANCIAL**: `"financial"` Defined in: [packages/sdk/src/types/data-types.ts:87](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L87) *** ### IDENTIFIER[​](#identifier "Direct link to IDENTIFIER") > **IDENTIFIER**: `"identifier"` Defined in: [packages/sdk/src/types/data-types.ts:91](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L91) *** ### OPERATIONAL[​](#operational "Direct link to OPERATIONAL") > **OPERATIONAL**: `"operational"` Defined in: [packages/sdk/src/types/data-types.ts:88](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L88) *** ### PERSONAL[​](#personal "Direct link to PERSONAL") > **PERSONAL**: `"personal"` Defined in: [packages/sdk/src/types/data-types.ts:90](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L90) *** ### PHI[​](#phi "Direct link to PHI") > **PHI**: `"phi"` Defined in: [packages/sdk/src/types/data-types.ts:85](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L85) *** ### PII[​](#pii "Direct link to PII") > **PII**: `"pii"` Defined in: [packages/sdk/src/types/data-types.ts:86](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L86) --- # Enumeration: DataFieldType Defined in: [packages/sdk/src/types/data-types.ts:44](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L44) ## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members") ### ARRAY[​](#array "Direct link to ARRAY") > **ARRAY**: `"array"` Defined in: [packages/sdk/src/types/data-types.ts:59](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L59) *** ### BOOLEAN[​](#boolean "Direct link to BOOLEAN") > **BOOLEAN**: `"boolean"` Defined in: [packages/sdk/src/types/data-types.ts:55](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L55) *** ### DATE[​](#date "Direct link to DATE") > **DATE**: `"date"` Defined in: [packages/sdk/src/types/data-types.ts:52](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L52) *** ### DATETIME[​](#datetime "Direct link to DATETIME") > **DATETIME**: `"datetime"` Defined in: [packages/sdk/src/types/data-types.ts:53](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L53) *** ### EMAIL[​](#email "Direct link to EMAIL") > **EMAIL**: `"email"` Defined in: [packages/sdk/src/types/data-types.ts:46](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L46) *** ### ENUM[​](#enum "Direct link to ENUM") > **ENUM**: `"enum"` Defined in: [packages/sdk/src/types/data-types.ts:45](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L45) *** ### FILE[​](#file "Direct link to FILE") > **FILE**: `"file"` Defined in: [packages/sdk/src/types/data-types.ts:56](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L56) *** ### FUNCTION[​](#function "Direct link to FUNCTION") > **FUNCTION**: `"function"` Defined in: [packages/sdk/src/types/data-types.ts:58](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L58) *** ### INTEGER[​](#integer "Direct link to INTEGER") > **INTEGER**: `"integer"` Defined in: [packages/sdk/src/types/data-types.ts:51](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L51) *** ### LONGTEXT[​](#longtext "Direct link to LONGTEXT") > **LONGTEXT**: `"longtext"` Defined in: [packages/sdk/src/types/data-types.ts:49](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L49) *** ### NUMBER[​](#number "Direct link to NUMBER") > **NUMBER**: `"number"` Defined in: [packages/sdk/src/types/data-types.ts:50](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L50) *** ### OBJECT[​](#object "Direct link to OBJECT") > **OBJECT**: `"object"` Defined in: [packages/sdk/src/types/data-types.ts:60](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L60) *** ### PHONE[​](#phone "Direct link to PHONE") > **PHONE**: `"phone"` Defined in: [packages/sdk/src/types/data-types.ts:47](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L47) *** ### REFERENCE[​](#reference "Direct link to REFERENCE") > **REFERENCE**: `"reference"` Defined in: [packages/sdk/src/types/data-types.ts:57](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L57) *** ### TEXT[​](#text "Direct link to TEXT") > **TEXT**: `"text"` Defined in: [packages/sdk/src/types/data-types.ts:48](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L48) *** ### TIME\_OF\_DAY[​](#time_of_day "Direct link to TIME_OF_DAY") > **TIME\_OF\_DAY**: `"time_of_day"` Defined in: [packages/sdk/src/types/data-types.ts:54](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L54) *** ### US\_ZIP\_CODE[​](#us_zip_code "Direct link to US_ZIP_CODE") > **US\_ZIP\_CODE**: `"us_zip_code"` Defined in: [packages/sdk/src/types/data-types.ts:61](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L61) --- # Enumeration: DataSensitivity Defined in: [packages/sdk/src/types/data-types.ts:76](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L76) ## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members") ### CONFIDENTIAL[​](#confidential "Direct link to CONFIDENTIAL") > **CONFIDENTIAL**: `"confidential"` Defined in: [packages/sdk/src/types/data-types.ts:79](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L79) *** ### INTERNAL[​](#internal "Direct link to INTERNAL") > **INTERNAL**: `"internal"` Defined in: [packages/sdk/src/types/data-types.ts:78](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L78) *** ### PUBLIC[​](#public "Direct link to PUBLIC") > **PUBLIC**: `"public"` Defined in: [packages/sdk/src/types/data-types.ts:77](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L77) *** ### RESTRICTED[​](#restricted "Direct link to RESTRICTED") > **RESTRICTED**: `"restricted"` Defined in: [packages/sdk/src/types/data-types.ts:80](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L80) *** ### SECRET[​](#secret "Direct link to SECRET") > **SECRET**: `"secret"` Defined in: [packages/sdk/src/types/data-types.ts:81](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L81) --- # Enumeration: DataTypeRecordScope Defined in: [packages/sdk/src/types/data-types.ts:71](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L71) ## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members") ### MEMBER[​](#member "Direct link to MEMBER") > **MEMBER**: `"member"` Defined in: [packages/sdk/src/types/data-types.ts:73](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L73) *** ### WORKSPACE[​](#workspace "Direct link to WORKSPACE") > **WORKSPACE**: `"workspace"` Defined in: [packages/sdk/src/types/data-types.ts:72](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L72) --- # Enumeration: DriverMode Defined in: [packages/sdk/src/types/qualification-types.ts:30](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/qualification-types.ts#L30) ## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members") ### AUTO[​](#auto "Direct link to AUTO") > **AUTO**: `"auto"` Defined in: [packages/sdk/src/types/qualification-types.ts:31](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/qualification-types.ts#L31) *** ### HUMAN[​](#human "Direct link to HUMAN") > **HUMAN**: `"human"` Defined in: [packages/sdk/src/types/qualification-types.ts:32](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/qualification-types.ts#L32) --- # Enumeration: EventRuleActionType Defined in: [packages/sdk/src/types/event-types.ts:72](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L72) ## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members") ### ASSIGNMENT\_CONCLUDE[​](#assignment_conclude "Direct link to ASSIGNMENT_CONCLUDE") > **ASSIGNMENT\_CONCLUDE**: `"assignment:conclude"` Defined in: [packages/sdk/src/types/event-types.ts:90](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L90) *** ### ASSISTANT\_MESSAGE[​](#assistant_message "Direct link to ASSISTANT_MESSAGE") > **ASSISTANT\_MESSAGE**: `"assistant:message"` Defined in: [packages/sdk/src/types/event-types.ts:78](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L78) *** ### CEL\_MUTATE[​](#cel_mutate "Direct link to CEL_MUTATE") > **CEL\_MUTATE**: `"record:cel_mutate"` Defined in: [packages/sdk/src/types/event-types.ts:80](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L80) *** ### CHAT\_CONTINUE[​](#chat_continue "Direct link to CHAT_CONTINUE") > **CHAT\_CONTINUE**: `"chat:continue"` Defined in: [packages/sdk/src/types/event-types.ts:83](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L83) *** ### CHAT\_CREATE[​](#chat_create "Direct link to CHAT_CREATE") > **CHAT\_CREATE**: `"chat:create"` Defined in: [packages/sdk/src/types/event-types.ts:82](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L82) *** ### CHAT\_PAUSE[​](#chat_pause "Direct link to CHAT_PAUSE") > **CHAT\_PAUSE**: `"chat:pause"` Defined in: [packages/sdk/src/types/event-types.ts:84](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L84) *** ### CHAT\_SUMMARIZE[​](#chat_summarize "Direct link to CHAT_SUMMARIZE") > **CHAT\_SUMMARIZE**: `"chat:summarize"` Defined in: [packages/sdk/src/types/event-types.ts:85](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L85) *** ### CONNECTION\_SYNC[​](#connection_sync "Direct link to CONNECTION_SYNC") > **CONNECTION\_SYNC**: `"connection:sync"` Defined in: [packages/sdk/src/types/event-types.ts:95](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L95) *** ### CONNECTOR\_OPERATION[​](#connector_operation "Direct link to CONNECTOR_OPERATION") > **CONNECTOR\_OPERATION**: `"connector:operation"` Defined in: [packages/sdk/src/types/event-types.ts:96](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L96) *** ### ECW\_REFRESH\_MEMBER\_ENCOUNTERS[​](#ecw_refresh_member_encounters "Direct link to ECW_REFRESH_MEMBER_ENCOUNTERS") > **ECW\_REFRESH\_MEMBER\_ENCOUNTERS**: `"ecw:refresh_member_encounters"` Defined in: [packages/sdk/src/types/event-types.ts:97](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L97) *** ### EMAIL\_SEND[​](#email_send "Direct link to EMAIL_SEND") > **EMAIL\_SEND**: `"email:send"` Defined in: [packages/sdk/src/types/event-types.ts:86](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L86) *** ### FORM\_FIELD\_UPDATE[​](#form_field_update "Direct link to FORM_FIELD_UPDATE") > **FORM\_FIELD\_UPDATE**: `"form:update_field"` Defined in: [packages/sdk/src/types/event-types.ts:79](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L79) *** ### INVOKE\_CUSTOM\_TOOL[​](#invoke_custom_tool "Direct link to INVOKE_CUSTOM_TOOL") > **INVOKE\_CUSTOM\_TOOL**: `"custom_tool:invoke"` Defined in: [packages/sdk/src/types/event-types.ts:87](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L87) *** ### JOURNEY\_ENROLL[​](#journey_enroll "Direct link to JOURNEY_ENROLL") > **JOURNEY\_ENROLL**: `"journey:enroll"` Defined in: [packages/sdk/src/types/event-types.ts:91](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L91) *** ### MEMBER\_LABEL\_ACTION[​](#member_label_action "Direct link to MEMBER_LABEL_ACTION") > **MEMBER\_LABEL\_ACTION**: `"member:label"` Defined in: [packages/sdk/src/types/event-types.ts:74](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L74) *** ### MEMBER\_NOTIFY\_ACTION[​](#member_notify_action "Direct link to MEMBER_NOTIFY_ACTION") > **MEMBER\_NOTIFY\_ACTION**: `"member:notify"` Defined in: [packages/sdk/src/types/event-types.ts:73](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L73) *** ### MEMBER\_UPSERT[​](#member_upsert "Direct link to MEMBER_UPSERT") > **MEMBER\_UPSERT**: `"member:upsert"` Defined in: [packages/sdk/src/types/event-types.ts:75](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L75) *** ### MESSAGE\_VALIDATION[​](#message_validation "Direct link to MESSAGE_VALIDATION") > **MESSAGE\_VALIDATION**: `"message:validation"` Defined in: [packages/sdk/src/types/event-types.ts:81](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L81) *** ### MONDAY\_REFRESH[​](#monday_refresh "Direct link to MONDAY_REFRESH") > **MONDAY\_REFRESH**: `"monday:refresh"` Defined in: [packages/sdk/src/types/event-types.ts:89](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L89) *** ### MONDAY\_UPSERT\_ITEM[​](#monday_upsert_item "Direct link to MONDAY_UPSERT_ITEM") > **MONDAY\_UPSERT\_ITEM**: `"monday:upsert_item"` Defined in: [packages/sdk/src/types/event-types.ts:88](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L88) *** ### PHONE\_CALL[​](#phone_call "Direct link to PHONE_CALL") > **PHONE\_CALL**: `"phone:call"` Defined in: [packages/sdk/src/types/event-types.ts:94](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L94) *** ### PLAY\_AUDIO[​](#play_audio "Direct link to PLAY_AUDIO") > **PLAY\_AUDIO**: `"audio:play"` Defined in: [packages/sdk/src/types/event-types.ts:98](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L98) *** ### SEND\_WEBHOOK[​](#send_webhook "Direct link to SEND_WEBHOOK") > **SEND\_WEBHOOK**: `"webhook:send"` Defined in: [packages/sdk/src/types/event-types.ts:76](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L76) *** ### SMS\_SEND[​](#sms_send "Direct link to SMS_SEND") > **SMS\_SEND**: `"sms:send"` Defined in: [packages/sdk/src/types/event-types.ts:92](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L92) *** ### SWITCH\_TASK\_ACTION[​](#switch_task_action "Direct link to SWITCH_TASK_ACTION") > **SWITCH\_TASK\_ACTION**: `"task:switch"` Defined in: [packages/sdk/src/types/event-types.ts:77](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L77) *** ### WHATSAPP\_SEND[​](#whatsapp_send "Direct link to WHATSAPP_SEND") > **WHATSAPP\_SEND**: `"whatsapp:send"` Defined in: [packages/sdk/src/types/event-types.ts:93](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L93) --- # Enumeration: EventRuleEventType Defined in: [packages/sdk/src/types/event-types.ts:42](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L42) ## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members") ### ASSIGNMENT\_CONCLUDED[​](#assignment_concluded "Direct link to ASSIGNMENT_CONCLUDED") > **ASSIGNMENT\_CONCLUDED**: `"assignment:concluded"` Defined in: [packages/sdk/src/types/event-types.ts:63](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L63) *** ### ASSISTANT\_MESSAGE[​](#assistant_message "Direct link to ASSISTANT_MESSAGE") > **ASSISTANT\_MESSAGE**: `"workflow:assistant_message"` Defined in: [packages/sdk/src/types/event-types.ts:55](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L55) *** ### CALENDAR\_EVENT\_CANCELLED[​](#calendar_event_cancelled "Direct link to CALENDAR_EVENT_CANCELLED") > **CALENDAR\_EVENT\_CANCELLED**: `"calendar_event:cancelled"` Defined in: [packages/sdk/src/types/event-types.ts:59](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L59) *** ### CALENDAR\_EVENT\_CREATED[​](#calendar_event_created "Direct link to CALENDAR_EVENT_CREATED") > **CALENDAR\_EVENT\_CREATED**: `"calendar_event:created"` Defined in: [packages/sdk/src/types/event-types.ts:57](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L57) *** ### CALENDAR\_EVENT\_ENDED[​](#calendar_event_ended "Direct link to CALENDAR_EVENT_ENDED") > **CALENDAR\_EVENT\_ENDED**: `"calendar_event:ended"` Defined in: [packages/sdk/src/types/event-types.ts:61](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L61) *** ### CALENDAR\_EVENT\_STARTING[​](#calendar_event_starting "Direct link to CALENDAR_EVENT_STARTING") > **CALENDAR\_EVENT\_STARTING**: `"calendar_event:starting"` Defined in: [packages/sdk/src/types/event-types.ts:60](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L60) *** ### CALENDAR\_EVENT\_UPDATED[​](#calendar_event_updated "Direct link to CALENDAR_EVENT_UPDATED") > **CALENDAR\_EVENT\_UPDATED**: `"calendar_event:updated"` Defined in: [packages/sdk/src/types/event-types.ts:58](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L58) *** ### CALL\_COMPLETED[​](#call_completed "Direct link to CALL_COMPLETED") > **CALL\_COMPLETED**: `"call:completed"` Defined in: [packages/sdk/src/types/event-types.ts:68](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L68) *** ### CALL\_STARTED[​](#call_started "Direct link to CALL_STARTED") > **CALL\_STARTED**: `"call:started"` Defined in: [packages/sdk/src/types/event-types.ts:67](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L67) *** ### CALL\_SUMMARY[​](#call_summary "Direct link to CALL_SUMMARY") > **CALL\_SUMMARY**: `"call:summary"` Defined in: [packages/sdk/src/types/event-types.ts:69](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L69) *** ### CHAT\_CALLBACK[​](#chat_callback "Direct link to CHAT_CALLBACK") > **CHAT\_CALLBACK**: `"chat:callback"` Defined in: [packages/sdk/src/types/event-types.ts:52](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L52) *** ### CHAT\_CREATED[​](#chat_created "Direct link to CHAT_CREATED") > **CHAT\_CREATED**: `"chat:created"` Defined in: [packages/sdk/src/types/event-types.ts:51](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L51) *** ### CONNECTOR\_EVENT[​](#connector_event "Direct link to CONNECTOR_EVENT") > **CONNECTOR\_EVENT**: `"connector:event"` Defined in: [packages/sdk/src/types/event-types.ts:62](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L62) *** ### DATA\_RECORD\_CREATED[​](#data_record_created "Direct link to DATA_RECORD_CREATED") > **DATA\_RECORD\_CREATED**: `"data_record:created"` Defined in: [packages/sdk/src/types/event-types.ts:49](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L49) *** ### DATA\_RECORD\_UPDATED[​](#data_record_updated "Direct link to DATA_RECORD_UPDATED") > **DATA\_RECORD\_UPDATED**: `"data_record:updated"` Defined in: [packages/sdk/src/types/event-types.ts:50](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L50) *** ### JOURNEY\_COMPLETED[​](#journey_completed "Direct link to JOURNEY_COMPLETED") > **JOURNEY\_COMPLETED**: `"journey:completed"` Defined in: [packages/sdk/src/types/event-types.ts:66](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L66) *** ### JOURNEY\_ENROLLED[​](#journey_enrolled "Direct link to JOURNEY_ENROLLED") > **JOURNEY\_ENROLLED**: `"journey:enrolled"` Defined in: [packages/sdk/src/types/event-types.ts:65](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L65) *** ### JOURNEY\_STEP\_EXECUTE[​](#journey_step_execute "Direct link to JOURNEY_STEP_EXECUTE") > **JOURNEY\_STEP\_EXECUTE**: `"journey_step:execute"` Defined in: [packages/sdk/src/types/event-types.ts:64](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L64) *** ### MEMBER\_JOINED[​](#member_joined "Direct link to MEMBER_JOINED") > **MEMBER\_JOINED**: `"workspace:member_joined"` Defined in: [packages/sdk/src/types/event-types.ts:47](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L47) *** ### MEMBER\_LEFT[​](#member_left "Direct link to MEMBER_LEFT") > **MEMBER\_LEFT**: `"workspace:member_left"` Defined in: [packages/sdk/src/types/event-types.ts:48](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L48) *** ### MEMBER\_UPDATED[​](#member_updated "Direct link to MEMBER_UPDATED") > **MEMBER\_UPDATED**: `"member:updated"` Defined in: [packages/sdk/src/types/event-types.ts:53](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L53) *** ### ROUTINE\_TRIGGERED[​](#routine_triggered "Direct link to ROUTINE_TRIGGERED") > **ROUTINE\_TRIGGERED**: `"routine:triggered"` Defined in: [packages/sdk/src/types/event-types.ts:54](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L54) *** ### TASK\_COMMAND[​](#task_command "Direct link to TASK_COMMAND") > **TASK\_COMMAND**: `"task:command"` Defined in: [packages/sdk/src/types/event-types.ts:45](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L45) *** ### TASK\_ENTER[​](#task_enter "Direct link to TASK_ENTER") > **TASK\_ENTER**: `"task:enter"` Defined in: [packages/sdk/src/types/event-types.ts:44](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L44) *** ### TASK\_EXECUTE[​](#task_execute "Direct link to TASK_EXECUTE") > **TASK\_EXECUTE**: `"task:execute"` Defined in: [packages/sdk/src/types/event-types.ts:43](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L43) *** ### TASK\_EXIT[​](#task_exit "Direct link to TASK_EXIT") > **TASK\_EXIT**: `"task:exit"` Defined in: [packages/sdk/src/types/event-types.ts:46](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L46) *** ### USER\_MESSAGE[​](#user_message "Direct link to USER_MESSAGE") > **USER\_MESSAGE**: `"workflow:user_message"` Defined in: [packages/sdk/src/types/event-types.ts:56](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L56) --- # Enumeration: EventRuleObjectType Defined in: [packages/sdk/src/types/event-types.ts:28](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L28) Client enums — preserve UPPER\_SNAKE member names used across the app. OpenAPI codegen emits lowercase const-objects in `generated/event_rule.ts`. The app imports these enums everywhere (config objects, switch statements, i18n keys). We keep hand-written enums here and assert below that every generated string-literal value has a matching client member. When the backend adds a new event/action/object type, add it to the Pydantic model, run `yarn generate:types`, then add the UPPER\_SNAKE member here. ## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members") ### CALENDAR[​](#calendar "Direct link to CALENDAR") > **CALENDAR**: `"calendar"` Defined in: [packages/sdk/src/types/event-types.ts:36](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L36) *** ### CALENDAR\_EVENT\_TYPE[​](#calendar_event_type "Direct link to CALENDAR_EVENT_TYPE") > **CALENDAR\_EVENT\_TYPE**: `"calendar_event_type"` Defined in: [packages/sdk/src/types/event-types.ts:37](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L37) *** ### CALL[​](#call "Direct link to CALL") > **CALL**: `"call"` Defined in: [packages/sdk/src/types/event-types.ts:39](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L39) *** ### CHAT[​](#chat "Direct link to CHAT") > **CHAT**: `"chat"` Defined in: [packages/sdk/src/types/event-types.ts:31](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L31) *** ### DATA\_RECORD[​](#data_record "Direct link to DATA_RECORD") > **DATA\_RECORD**: `"data_record"` Defined in: [packages/sdk/src/types/event-types.ts:32](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L32) *** ### JOURNEY[​](#journey "Direct link to JOURNEY") > **JOURNEY**: `"journey"` Defined in: [packages/sdk/src/types/event-types.ts:38](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L38) *** ### MEMBER[​](#member "Direct link to MEMBER") > **MEMBER**: `"member"` Defined in: [packages/sdk/src/types/event-types.ts:33](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L33) *** ### ROUTINE[​](#routine "Direct link to ROUTINE") > **ROUTINE**: `"routine"` Defined in: [packages/sdk/src/types/event-types.ts:34](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L34) *** ### TASK[​](#task "Direct link to TASK") > **TASK**: `"task"` Defined in: [packages/sdk/src/types/event-types.ts:29](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L29) *** ### WORKFLOW[​](#workflow "Direct link to WORKFLOW") > **WORKFLOW**: `"workflow"` Defined in: [packages/sdk/src/types/event-types.ts:35](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L35) *** ### WORKSPACE[​](#workspace "Direct link to WORKSPACE") > **WORKSPACE**: `"workspace"` Defined in: [packages/sdk/src/types/event-types.ts:30](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L30) --- # Enumeration: FeatureCategory Defined in: [packages/sdk/src/features/registry.ts:20](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/features/registry.ts#L20) Categories for organizing features in UI. ## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members") ### COMMUNICATION[​](#communication "Direct link to COMMUNICATION") > **COMMUNICATION**: `"communication"` Defined in: [packages/sdk/src/features/registry.ts:21](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/features/registry.ts#L21) *** ### COMPLIANCE[​](#compliance "Direct link to COMPLIANCE") > **COMPLIANCE**: `"compliance"` Defined in: [packages/sdk/src/features/registry.ts:24](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/features/registry.ts#L24) *** ### DEVELOPER[​](#developer "Direct link to DEVELOPER") > **DEVELOPER**: `"developer"` Defined in: [packages/sdk/src/features/registry.ts:25](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/features/registry.ts#L25) *** ### INTEGRATION[​](#integration "Direct link to INTEGRATION") > **INTEGRATION**: `"integration"` Defined in: [packages/sdk/src/features/registry.ts:23](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/features/registry.ts#L23) *** ### PLATFORM[​](#platform "Direct link to PLATFORM") > **PLATFORM**: `"platform"` Defined in: [packages/sdk/src/features/registry.ts:22](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/features/registry.ts#L22) *** ### RESELLER[​](#reseller "Direct link to RESELLER") > **RESELLER**: `"reseller"` Defined in: [packages/sdk/src/features/registry.ts:26](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/features/registry.ts#L26) *** ### SPECIAL[​](#special "Direct link to SPECIAL") > **SPECIAL**: `"special"` Defined in: [packages/sdk/src/features/registry.ts:27](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/features/registry.ts#L27) --- # Enumeration: FeatureVisibility Defined in: [packages/sdk/src/features/registry.ts:33](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/features/registry.ts#L33) Controls how disabled features appear in the UI. ## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members") ### CONTACT\_ADMIN[​](#contact_admin "Direct link to CONTACT_ADMIN") > **CONTACT\_ADMIN**: `"contact"` Defined in: [packages/sdk/src/features/registry.ts:39](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/features/registry.ts#L39) Shown with "contact admin" call-to-action *** ### HIDDEN[​](#hidden "Direct link to HIDDEN") > **HIDDEN**: `"hidden"` Defined in: [packages/sdk/src/features/registry.ts:35](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/features/registry.ts#L35) Not shown when disabled *** ### UPGRADE\_PROMPT[​](#upgrade_prompt "Direct link to UPGRADE_PROMPT") > **UPGRADE\_PROMPT**: `"upgrade"` Defined in: [packages/sdk/src/features/registry.ts:37](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/features/registry.ts#L37) Shown with upgrade call-to-action --- # Enumeration: FhirClientType Defined in: [packages/sdk/src/types/fhir-connection-types.ts:63](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L63) Client type for FHIR connections (eCW Backend Services). * backend\_bulk: Two-legged auth for bulk data operations * backend\_single\_patient: Two-legged auth with full patient data access ## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members") ### BACKEND\_BULK[​](#backend_bulk "Direct link to BACKEND_BULK") > **BACKEND\_BULK**: `"backend_bulk"` Defined in: [packages/sdk/src/types/fhir-connection-types.ts:64](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L64) *** ### BACKEND\_SINGLE\_PATIENT[​](#backend_single_patient "Direct link to BACKEND_SINGLE_PATIENT") > **BACKEND\_SINGLE\_PATIENT**: `"backend_single_patient"` Defined in: [packages/sdk/src/types/fhir-connection-types.ts:65](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L65) --- # Enumeration: FhirConnectionState Defined in: [packages/sdk/src/types/fhir-connection-types.ts:52](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L52) State of a FHIR connection. ## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members") ### CONFIGURED[​](#configured "Direct link to CONFIGURED") > **CONFIGURED**: `"configured"` Defined in: [packages/sdk/src/types/fhir-connection-types.ts:54](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L54) *** ### CONFIGURING[​](#configuring "Direct link to CONFIGURING") > **CONFIGURING**: `"configuring"` Defined in: [packages/sdk/src/types/fhir-connection-types.ts:53](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L53) *** ### ERROR[​](#error "Direct link to ERROR") > **ERROR**: `"error"` Defined in: [packages/sdk/src/types/fhir-connection-types.ts:55](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L55) --- # Enumeration: FhirVendor Defined in: [packages/sdk/src/types/fhir-connection-types.ts:42](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L42) Supported FHIR/EHR vendors. ## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members") ### ATHENA[​](#athena "Direct link to ATHENA") > **ATHENA**: `"athena"` Defined in: [packages/sdk/src/types/fhir-connection-types.ts:46](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L46) *** ### CERNER[​](#cerner "Direct link to CERNER") > **CERNER**: `"cerner"` Defined in: [packages/sdk/src/types/fhir-connection-types.ts:45](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L45) *** ### ECLINICALWORKS[​](#eclinicalworks "Direct link to ECLINICALWORKS") > **ECLINICALWORKS**: `"eclinicalworks"` Defined in: [packages/sdk/src/types/fhir-connection-types.ts:43](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L43) *** ### EPIC[​](#epic "Direct link to EPIC") > **EPIC**: `"epic"` Defined in: [packages/sdk/src/types/fhir-connection-types.ts:44](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L44) --- # Enumeration: IndexStatus Defined in: [packages/sdk/src/types/data-types.ts:64](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L64) ## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members") ### ERROR[​](#error "Direct link to ERROR") > **ERROR**: `"error"` Defined in: [packages/sdk/src/types/data-types.ts:68](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L68) *** ### INDEXED[​](#indexed "Direct link to INDEXED") > **INDEXED**: `"indexed"` Defined in: [packages/sdk/src/types/data-types.ts:67](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L67) *** ### INDEXING[​](#indexing "Direct link to INDEXING") > **INDEXING**: `"indexing"` Defined in: [packages/sdk/src/types/data-types.ts:66](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L66) *** ### NOT\_INDEXED[​](#not_indexed "Direct link to NOT_INDEXED") > **NOT\_INDEXED**: `"not_indexed"` Defined in: [packages/sdk/src/types/data-types.ts:65](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L65) --- # Enumeration: InvitationStatus Defined in: [packages/sdk/src/types/invitation-types.ts:20](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/invitation-types.ts#L20) Client enum — preserves UPPER\_SNAKE member names used across the app. ## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members") ### BLOCKED[​](#blocked "Direct link to BLOCKED") > **BLOCKED**: `"blocked"` Defined in: [packages/sdk/src/types/invitation-types.ts:26](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/invitation-types.ts#L26) *** ### DECLINED[​](#declined "Direct link to DECLINED") > **DECLINED**: `"declined"` Defined in: [packages/sdk/src/types/invitation-types.ts:25](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/invitation-types.ts#L25) *** ### DENIED[​](#denied "Direct link to DENIED") > **DENIED**: `"denied"` Defined in: [packages/sdk/src/types/invitation-types.ts:24](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/invitation-types.ts#L24) *** ### GRANTED[​](#granted "Direct link to GRANTED") > **GRANTED**: `"granted"` Defined in: [packages/sdk/src/types/invitation-types.ts:23](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/invitation-types.ts#L23) *** ### INVITED[​](#invited "Direct link to INVITED") > **INVITED**: `"invited"` Defined in: [packages/sdk/src/types/invitation-types.ts:22](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/invitation-types.ts#L22) *** ### REQUESTED[​](#requested "Direct link to REQUESTED") > **REQUESTED**: `"requested"` Defined in: [packages/sdk/src/types/invitation-types.ts:21](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/invitation-types.ts#L21) --- # Enumeration: McpServerState Defined in: [packages/sdk/src/types/mcp-server-types.ts:16](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/mcp-server-types.ts#L16) ## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members") ### AUTHORIZE[​](#authorize "Direct link to AUTHORIZE") > **AUTHORIZE**: `"authorize"` Defined in: [packages/sdk/src/types/mcp-server-types.ts:18](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/mcp-server-types.ts#L18) *** ### READY[​](#ready "Direct link to READY") > **READY**: `"ready"` Defined in: [packages/sdk/src/types/mcp-server-types.ts:19](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/mcp-server-types.ts#L19) *** ### REGISTER[​](#register "Direct link to REGISTER") > **REGISTER**: `"register"` Defined in: [packages/sdk/src/types/mcp-server-types.ts:17](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/mcp-server-types.ts#L17) --- # Enumeration: MemberFeature Defined in: [packages/sdk/src/types/billing-types.ts:202](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L202) Member product feature flags. Matches the Python MemberFeature enum in lib/constants.py ## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members") ### EMAIL[​](#email "Direct link to EMAIL") > **EMAIL**: `"email"` Defined in: [packages/sdk/src/types/billing-types.ts:207](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L207) *** ### PHONE[​](#phone "Direct link to PHONE") > **PHONE**: `"phone"` Defined in: [packages/sdk/src/types/billing-types.ts:205](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L205) *** ### WEB\_CHAT[​](#web_chat "Direct link to WEB_CHAT") > **WEB\_CHAT**: `"web_chat"` Defined in: [packages/sdk/src/types/billing-types.ts:203](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L203) *** ### WEB\_VOICE[​](#web_voice "Direct link to WEB_VOICE") > **WEB\_VOICE**: `"web_voice"` Defined in: [packages/sdk/src/types/billing-types.ts:204](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L204) *** ### WHATSAPP[​](#whatsapp "Direct link to WHATSAPP") > **WHATSAPP**: `"whatsapp"` Defined in: [packages/sdk/src/types/billing-types.ts:206](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L206) --- # Enumeration: MemberType Defined in: [packages/sdk/src/types/member-types.ts:114](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L114) ## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members") ### AGENT[​](#agent "Direct link to AGENT") > **AGENT**: `"agent"` Defined in: [packages/sdk/src/types/member-types.ts:118](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L118) *** ### ANONYMOUS[​](#anonymous "Direct link to ANONYMOUS") > **ANONYMOUS**: `"anonymous"` Defined in: [packages/sdk/src/types/member-types.ts:115](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L115) *** ### MEMBER[​](#member "Direct link to MEMBER") > **MEMBER**: `"member"` Defined in: [packages/sdk/src/types/member-types.ts:117](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L117) *** ### TEST[​](#test "Direct link to TEST") > **TEST**: `"test"` Defined in: [packages/sdk/src/types/member-types.ts:116](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L116) --- # Enumeration: OrgFeature Defined in: [packages/sdk/src/types/billing-types.ts:215](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L215) Organization product feature flags. These features apply at the organization level, affecting all workspaces. Matches the Python OrgFeature enum in lib/constants.py ## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members") ### AUDIT\_LOGS[​](#audit_logs "Direct link to AUDIT_LOGS") > **AUDIT\_LOGS**: `"audit_logs"` Defined in: [packages/sdk/src/types/billing-types.ts:218](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L218) *** ### CUSTOM\_BRANDING[​](#custom_branding "Direct link to CUSTOM_BRANDING") > **CUSTOM\_BRANDING**: `"custom_branding"` Defined in: [packages/sdk/src/types/billing-types.ts:225](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L225) *** ### HIPAA\_COMPLIANCE[​](#hipaa_compliance "Direct link to HIPAA_COMPLIANCE") > **HIPAA\_COMPLIANCE**: `"hipaa_compliance"` Defined in: [packages/sdk/src/types/billing-types.ts:221](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L221) *** ### PRIORITY\_SUPPORT[​](#priority_support "Direct link to PRIORITY_SUPPORT") > **PRIORITY\_SUPPORT**: `"priority_support"` Defined in: [packages/sdk/src/types/billing-types.ts:226](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L226) *** ### SOC2\_COMPLIANCE[​](#soc2_compliance "Direct link to SOC2_COMPLIANCE") > **SOC2\_COMPLIANCE**: `"soc2_compliance"` Defined in: [packages/sdk/src/types/billing-types.ts:222](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L222) *** ### SSO[​](#sso "Direct link to SSO") > **SSO**: `"sso"` Defined in: [packages/sdk/src/types/billing-types.ts:217](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L217) --- # Enumeration: ProductType Defined in: [packages/sdk/src/types/billing-types.ts:292](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L292) ## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members") ### ADDON[​](#addon "Direct link to ADDON") > **ADDON**: `"addon"` Defined in: [packages/sdk/src/types/billing-types.ts:295](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L295) *** ### ORG[​](#org "Direct link to ORG") > **ORG**: `"org"` Defined in: [packages/sdk/src/types/billing-types.ts:294](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L294) *** ### WORKSPACE[​](#workspace "Direct link to WORKSPACE") > **WORKSPACE**: `"workspace"` Defined in: [packages/sdk/src/types/billing-types.ts:293](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L293) --- # Enumeration: Resource Defined in: [packages/sdk/src/types/billing-types.ts:243](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L243) Unified resource identifiers for products, limits, inclusions, and overages. Matches the Python Resource enum in lib/constants.py All values use snake\_case for consistency with backend. ## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members") ### CREDIT[​](#credit "Direct link to CREDIT") > **CREDIT**: `"credit"` Defined in: [packages/sdk/src/types/billing-types.ts:245](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L245) *** ### EMAIL[​](#email "Direct link to EMAIL") > **EMAIL**: `"email"` Defined in: [packages/sdk/src/types/billing-types.ts:251](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L251) *** ### INBOX[​](#inbox "Direct link to INBOX") > **INBOX**: `"inbox"` Defined in: [packages/sdk/src/types/billing-types.ts:256](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L256) *** ### MEMBER[​](#member "Direct link to MEMBER") > **MEMBER**: `"member"` Defined in: [packages/sdk/src/types/billing-types.ts:258](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L258) *** ### ORG\_ADMIN[​](#org_admin "Direct link to ORG_ADMIN") > **ORG\_ADMIN**: `"org_admin"` Defined in: [packages/sdk/src/types/billing-types.ts:260](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L260) *** ### PHONE\_CALL[​](#phone_call "Direct link to PHONE_CALL") > **PHONE\_CALL**: `"phone_call"` Defined in: [packages/sdk/src/types/billing-types.ts:252](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L252) *** ### PHONE\_NUMBER[​](#phone_number "Direct link to PHONE_NUMBER") > **PHONE\_NUMBER**: `"phone_number"` Defined in: [packages/sdk/src/types/billing-types.ts:255](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L255) *** ### SITE[​](#site "Direct link to SITE") > **SITE**: `"site"` Defined in: [packages/sdk/src/types/billing-types.ts:257](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L257) *** ### SMS[​](#sms "Direct link to SMS") > **SMS**: `"sms"` Defined in: [packages/sdk/src/types/billing-types.ts:250](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L250) *** ### STORAGE\_MB[​](#storage_mb "Direct link to STORAGE_MB") > **STORAGE\_MB**: `"storage_mb"` Defined in: [packages/sdk/src/types/billing-types.ts:263](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L263) *** ### STT[​](#stt "Direct link to STT") > **STT**: `"stt"` Defined in: [packages/sdk/src/types/billing-types.ts:246](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L246) *** ### TTS[​](#tts "Direct link to TTS") > **TTS**: `"tts"` Defined in: [packages/sdk/src/types/billing-types.ts:247](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L247) *** ### WORKSPACE[​](#workspace "Direct link to WORKSPACE") > **WORKSPACE**: `"workspace"` Defined in: [packages/sdk/src/types/billing-types.ts:259](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L259) --- # Enumeration: Scope Defined in: [packages/sdk/src/types/core-types.ts:99](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/core-types.ts#L99) Permission scopes for workspace access control. Maps to lib/context/scopes.py - keep in sync. Naming convention: NAMESPACE\_ACTION Actions: READ, WRITE, ADMIN ## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members") ### AGENTS\_ADMIN[​](#agents_admin "Direct link to AGENTS_ADMIN") > **AGENTS\_ADMIN**: `"agents:admin"` Defined in: [packages/sdk/src/types/core-types.ts:173](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/core-types.ts#L173) *** ### AGENTS\_READ[​](#agents_read "Direct link to AGENTS_READ") > **AGENTS\_READ**: `"agents:read"` Defined in: [packages/sdk/src/types/core-types.ts:171](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/core-types.ts#L171) *** ### AGENTS\_WRITE[​](#agents_write "Direct link to AGENTS_WRITE") > **AGENTS\_WRITE**: `"agents:write"` Defined in: [packages/sdk/src/types/core-types.ts:172](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/core-types.ts#L172) *** ### ANALYTICS\_READ[​](#analytics_read "Direct link to ANALYTICS_READ") > **ANALYTICS\_READ**: `"analytics:read"` Defined in: [packages/sdk/src/types/core-types.ts:207](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/core-types.ts#L207) *** ### APPS\_ADMIN[​](#apps_admin "Direct link to APPS_ADMIN") > **APPS\_ADMIN**: `"apps:admin"` Defined in: [packages/sdk/src/types/core-types.ts:199](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/core-types.ts#L199) *** ### APPS\_READ[​](#apps_read "Direct link to APPS_READ") > **APPS\_READ**: `"apps:read"` Defined in: [packages/sdk/src/types/core-types.ts:197](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/core-types.ts#L197) *** ### APPS\_WRITE[​](#apps_write "Direct link to APPS_WRITE") > **APPS\_WRITE**: `"apps:write"` Defined in: [packages/sdk/src/types/core-types.ts:198](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/core-types.ts#L198) *** ### ASSIGNMENTS\_ADMIN[​](#assignments_admin "Direct link to ASSIGNMENTS_ADMIN") > **ASSIGNMENTS\_ADMIN**: `"assignments:admin"` Defined in: [packages/sdk/src/types/core-types.ts:143](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/core-types.ts#L143) *** ### ASSIGNMENTS\_READ[​](#assignments_read "Direct link to ASSIGNMENTS_READ") > **ASSIGNMENTS\_READ**: `"assignments:read"` Defined in: [packages/sdk/src/types/core-types.ts:141](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/core-types.ts#L141) *** ### ASSIGNMENTS\_WRITE[​](#assignments_write "Direct link to ASSIGNMENTS_WRITE") > **ASSIGNMENTS\_WRITE**: `"assignments:write"` Defined in: [packages/sdk/src/types/core-types.ts:142](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/core-types.ts#L142) *** ### AUTOMATIONS\_ADMIN[​](#automations_admin "Direct link to AUTOMATIONS_ADMIN") > **AUTOMATIONS\_ADMIN**: `"automations:admin"` Defined in: [packages/sdk/src/types/core-types.ts:148](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/core-types.ts#L148) *** ### AUTOMATIONS\_READ[​](#automations_read "Direct link to AUTOMATIONS_READ") > **AUTOMATIONS\_READ**: `"automations:read"` Defined in: [packages/sdk/src/types/core-types.ts:146](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/core-types.ts#L146) *** ### AUTOMATIONS\_WRITE[​](#automations_write "Direct link to AUTOMATIONS_WRITE") > **AUTOMATIONS\_WRITE**: `"automations:write"` Defined in: [packages/sdk/src/types/core-types.ts:147](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/core-types.ts#L147) *** ### CALENDARS\_ADMIN[​](#calendars_admin "Direct link to CALENDARS_ADMIN") > **CALENDARS\_ADMIN**: `"calendars:admin"` Defined in: [packages/sdk/src/types/core-types.ts:178](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/core-types.ts#L178) *** ### CALENDARS\_READ[​](#calendars_read "Direct link to CALENDARS_READ") > **CALENDARS\_READ**: `"calendars:read"` Defined in: [packages/sdk/src/types/core-types.ts:176](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/core-types.ts#L176) *** ### CALENDARS\_WRITE[​](#calendars_write "Direct link to CALENDARS_WRITE") > **CALENDARS\_WRITE**: `"calendars:write"` Defined in: [packages/sdk/src/types/core-types.ts:177](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/core-types.ts#L177) *** ### CHATS\_ADMIN[​](#chats_admin "Direct link to CHATS_ADMIN") > **CHATS\_ADMIN**: `"chats:admin"` Defined in: [packages/sdk/src/types/core-types.ts:118](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/core-types.ts#L118) *** ### CHATS\_READ[​](#chats_read "Direct link to CHATS_READ") > **CHATS\_READ**: `"chats:read"` Defined in: [packages/sdk/src/types/core-types.ts:116](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/core-types.ts#L116) *** ### CHATS\_WRITE[​](#chats_write "Direct link to CHATS_WRITE") > **CHATS\_WRITE**: `"chats:write"` Defined in: [packages/sdk/src/types/core-types.ts:117](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/core-types.ts#L117) *** ### DATATYPES\_ADMIN[​](#datatypes_admin "Direct link to DATATYPES_ADMIN") > **DATATYPES\_ADMIN**: `"datatypes:admin"` Defined in: [packages/sdk/src/types/core-types.ts:153](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/core-types.ts#L153) *** ### DATATYPES\_READ[​](#datatypes_read "Direct link to DATATYPES_READ") > **DATATYPES\_READ**: `"datatypes:read"` Defined in: [packages/sdk/src/types/core-types.ts:151](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/core-types.ts#L151) *** ### DATATYPES\_WRITE[​](#datatypes_write "Direct link to DATATYPES_WRITE") > **DATATYPES\_WRITE**: `"datatypes:write"` Defined in: [packages/sdk/src/types/core-types.ts:152](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/core-types.ts#L152) *** ### DIRECT\_MESSAGES\_ADMIN[​](#direct_messages_admin "Direct link to DIRECT_MESSAGES_ADMIN") > **DIRECT\_MESSAGES\_ADMIN**: `"dm:admin"` Defined in: [packages/sdk/src/types/core-types.ts:123](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/core-types.ts#L123) *** ### DIRECT\_MESSAGES\_READ[​](#direct_messages_read "Direct link to DIRECT_MESSAGES_READ") > **DIRECT\_MESSAGES\_READ**: `"dm:read"` Defined in: [packages/sdk/src/types/core-types.ts:121](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/core-types.ts#L121) *** ### DIRECT\_MESSAGES\_WRITE[​](#direct_messages_write "Direct link to DIRECT_MESSAGES_WRITE") > **DIRECT\_MESSAGES\_WRITE**: `"dm:write"` Defined in: [packages/sdk/src/types/core-types.ts:122](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/core-types.ts#L122) *** ### EXPERIMENTS\_ADMIN[​](#experiments_admin "Direct link to EXPERIMENTS_ADMIN") > **EXPERIMENTS\_ADMIN**: `"experiments:admin"` Defined in: [packages/sdk/src/types/core-types.ts:133](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/core-types.ts#L133) *** ### EXPERIMENTS\_READ[​](#experiments_read "Direct link to EXPERIMENTS_READ") > **EXPERIMENTS\_READ**: `"experiments:read"` Defined in: [packages/sdk/src/types/core-types.ts:131](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/core-types.ts#L131) *** ### EXPERIMENTS\_WRITE[​](#experiments_write "Direct link to EXPERIMENTS_WRITE") > **EXPERIMENTS\_WRITE**: `"experiments:write"` Defined in: [packages/sdk/src/types/core-types.ts:132](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/core-types.ts#L132) *** ### EXPORT\_ADMIN[​](#export_admin "Direct link to EXPORT_ADMIN") > **EXPORT\_ADMIN**: `"export:admin"` Defined in: [packages/sdk/src/types/core-types.ts:216](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/core-types.ts#L216) *** ### EXPORT\_READ[​](#export_read "Direct link to EXPORT_READ") > **EXPORT\_READ**: `"export:read"` Defined in: [packages/sdk/src/types/core-types.ts:214](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/core-types.ts#L214) *** ### EXPORT\_WRITE[​](#export_write "Direct link to EXPORT_WRITE") > **EXPORT\_WRITE**: `"export:write"` Defined in: [packages/sdk/src/types/core-types.ts:215](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/core-types.ts#L215) *** ### FILES\_ADMIN[​](#files_admin "Direct link to FILES_ADMIN") > **FILES\_ADMIN**: `"files:admin"` Defined in: [packages/sdk/src/types/core-types.ts:163](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/core-types.ts#L163) *** ### FILES\_READ[​](#files_read "Direct link to FILES_READ") > **FILES\_READ**: `"files:read"` Defined in: [packages/sdk/src/types/core-types.ts:161](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/core-types.ts#L161) *** ### FILES\_WRITE[​](#files_write "Direct link to FILES_WRITE") > **FILES\_WRITE**: `"files:write"` Defined in: [packages/sdk/src/types/core-types.ts:162](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/core-types.ts#L162) *** ### INBOXES\_ADMIN[​](#inboxes_admin "Direct link to INBOXES_ADMIN") > **INBOXES\_ADMIN**: `"inboxes:admin"` Defined in: [packages/sdk/src/types/core-types.ts:183](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/core-types.ts#L183) *** ### INBOXES\_READ[​](#inboxes_read "Direct link to INBOXES_READ") > **INBOXES\_READ**: `"inboxes:read"` Defined in: [packages/sdk/src/types/core-types.ts:181](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/core-types.ts#L181) *** ### INBOXES\_WRITE[​](#inboxes_write "Direct link to INBOXES_WRITE") > **INBOXES\_WRITE**: `"inboxes:write"` Defined in: [packages/sdk/src/types/core-types.ts:182](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/core-types.ts#L182) *** ### JOURNEYS\_ADMIN[​](#journeys_admin "Direct link to JOURNEYS_ADMIN") > **JOURNEYS\_ADMIN**: `"journeys:admin"` Defined in: [packages/sdk/src/types/core-types.ts:128](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/core-types.ts#L128) *** ### JOURNEYS\_READ[​](#journeys_read "Direct link to JOURNEYS_READ") > **JOURNEYS\_READ**: `"journeys:read"` Defined in: [packages/sdk/src/types/core-types.ts:126](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/core-types.ts#L126) *** ### JOURNEYS\_WRITE[​](#journeys_write "Direct link to JOURNEYS_WRITE") > **JOURNEYS\_WRITE**: `"journeys:write"` Defined in: [packages/sdk/src/types/core-types.ts:127](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/core-types.ts#L127) *** ### LABELS\_READ[​](#labels_read "Direct link to LABELS_READ") > **LABELS\_READ**: `"labels:read"` Defined in: [packages/sdk/src/types/core-types.ts:202](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/core-types.ts#L202) *** ### ~~LABELS\_WRITE~~[​](#labels_write "Direct link to labels_write") > **LABELS\_WRITE**: `"labels:write"` Defined in: [packages/sdk/src/types/core-types.ts:204](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/core-types.ts#L204) #### Deprecated[​](#deprecated "Direct link to Deprecated") Use parent resource write scope (MEMBERS\_WRITE, CHATS\_WRITE, FILES\_WRITE) *** ### MEMBER\_ROLES\_ADMIN[​](#member_roles_admin "Direct link to MEMBER_ROLES_ADMIN") > **MEMBER\_ROLES\_ADMIN**: `"member_roles:admin"` Defined in: [packages/sdk/src/types/core-types.ts:113](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/core-types.ts#L113) *** ### MEMBER\_ROLES\_READ[​](#member_roles_read "Direct link to MEMBER_ROLES_READ") > **MEMBER\_ROLES\_READ**: `"member_roles:read"` Defined in: [packages/sdk/src/types/core-types.ts:111](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/core-types.ts#L111) *** ### MEMBER\_ROLES\_WRITE[​](#member_roles_write "Direct link to MEMBER_ROLES_WRITE") > **MEMBER\_ROLES\_WRITE**: `"member_roles:write"` Defined in: [packages/sdk/src/types/core-types.ts:112](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/core-types.ts#L112) *** ### MEMBERS\_ADMIN[​](#members_admin "Direct link to MEMBERS_ADMIN") > **MEMBERS\_ADMIN**: `"members:admin"` Defined in: [packages/sdk/src/types/core-types.ts:108](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/core-types.ts#L108) *** ### MEMBERS\_READ[​](#members_read "Direct link to MEMBERS_READ") > **MEMBERS\_READ**: `"members:read"` Defined in: [packages/sdk/src/types/core-types.ts:106](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/core-types.ts#L106) *** ### MEMBERS\_WRITE[​](#members_write "Direct link to MEMBERS_WRITE") > **MEMBERS\_WRITE**: `"members:write"` Defined in: [packages/sdk/src/types/core-types.ts:107](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/core-types.ts#L107) *** ### OPERATOR\_READ[​](#operator_read "Direct link to OPERATOR_READ") > **OPERATOR\_READ**: `"operator:read"` Defined in: [packages/sdk/src/types/core-types.ts:210](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/core-types.ts#L210) *** ### OPERATOR\_WRITE[​](#operator_write "Direct link to OPERATOR_WRITE") > **OPERATOR\_WRITE**: `"operator:write"` Defined in: [packages/sdk/src/types/core-types.ts:211](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/core-types.ts#L211) *** ### ORG\_ADMIN[​](#org_admin "Direct link to ORG_ADMIN") > **ORG\_ADMIN**: `"org:admin"` Defined in: [packages/sdk/src/types/core-types.ts:222](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/core-types.ts#L222) *** ### ORG\_DELETE[​](#org_delete "Direct link to ORG_DELETE") > **ORG\_DELETE**: `"org:delete"` Defined in: [packages/sdk/src/types/core-types.ts:224](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/core-types.ts#L224) *** ### ORG\_INFO[​](#org_info "Direct link to ORG_INFO") > **ORG\_INFO**: `"org:info"` Defined in: [packages/sdk/src/types/core-types.ts:219](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/core-types.ts#L219) *** ### ORG\_MANAGE\_ADMINS[​](#org_manage_admins "Direct link to ORG_MANAGE_ADMINS") > **ORG\_MANAGE\_ADMINS**: `"org:manage_admins"` Defined in: [packages/sdk/src/types/core-types.ts:223](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/core-types.ts#L223) *** ### ORG\_READ[​](#org_read "Direct link to ORG_READ") > **ORG\_READ**: `"org:read"` Defined in: [packages/sdk/src/types/core-types.ts:220](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/core-types.ts#L220) *** ### ORG\_WRITE[​](#org_write "Direct link to ORG_WRITE") > **ORG\_WRITE**: `"org:write"` Defined in: [packages/sdk/src/types/core-types.ts:221](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/core-types.ts#L221) *** ### PHONES\_ADMIN[​](#phones_admin "Direct link to PHONES_ADMIN") > **PHONES\_ADMIN**: `"phones:admin"` Defined in: [packages/sdk/src/types/core-types.ts:188](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/core-types.ts#L188) *** ### PHONES\_READ[​](#phones_read "Direct link to PHONES_READ") > **PHONES\_READ**: `"phones:read"` Defined in: [packages/sdk/src/types/core-types.ts:186](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/core-types.ts#L186) *** ### PHONES\_WRITE[​](#phones_write "Direct link to PHONES_WRITE") > **PHONES\_WRITE**: `"phones:write"` Defined in: [packages/sdk/src/types/core-types.ts:187](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/core-types.ts#L187) *** ### RECORDS\_ADMIN[​](#records_admin "Direct link to RECORDS_ADMIN") > **RECORDS\_ADMIN**: `"records:admin"` Defined in: [packages/sdk/src/types/core-types.ts:158](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/core-types.ts#L158) *** ### RECORDS\_READ[​](#records_read "Direct link to RECORDS_READ") > **RECORDS\_READ**: `"records:read"` Defined in: [packages/sdk/src/types/core-types.ts:156](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/core-types.ts#L156) *** ### RECORDS\_WRITE[​](#records_write "Direct link to RECORDS_WRITE") > **RECORDS\_WRITE**: `"records:write"` Defined in: [packages/sdk/src/types/core-types.ts:157](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/core-types.ts#L157) *** ### SITES\_ADMIN[​](#sites_admin "Direct link to SITES_ADMIN") > **SITES\_ADMIN**: `"sites:admin"` Defined in: [packages/sdk/src/types/core-types.ts:168](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/core-types.ts#L168) *** ### SITES\_READ[​](#sites_read "Direct link to SITES_READ") > **SITES\_READ**: `"sites:read"` Defined in: [packages/sdk/src/types/core-types.ts:166](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/core-types.ts#L166) *** ### SITES\_WRITE[​](#sites_write "Direct link to SITES_WRITE") > **SITES\_WRITE**: `"sites:write"` Defined in: [packages/sdk/src/types/core-types.ts:167](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/core-types.ts#L167) *** ### WEBHOOKS\_ADMIN[​](#webhooks_admin "Direct link to WEBHOOKS_ADMIN") > **WEBHOOKS\_ADMIN**: `"webhooks:admin"` Defined in: [packages/sdk/src/types/core-types.ts:193](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/core-types.ts#L193) *** ### WEBHOOKS\_RAW[​](#webhooks_raw "Direct link to WEBHOOKS_RAW") > **WEBHOOKS\_RAW**: `"webhooks:raw"` Defined in: [packages/sdk/src/types/core-types.ts:194](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/core-types.ts#L194) *** ### WEBHOOKS\_READ[​](#webhooks_read "Direct link to WEBHOOKS_READ") > **WEBHOOKS\_READ**: `"webhooks:read"` Defined in: [packages/sdk/src/types/core-types.ts:191](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/core-types.ts#L191) *** ### WEBHOOKS\_WRITE[​](#webhooks_write "Direct link to WEBHOOKS_WRITE") > **WEBHOOKS\_WRITE**: `"webhooks:write"` Defined in: [packages/sdk/src/types/core-types.ts:192](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/core-types.ts#L192) *** ### WORKFLOWS\_ADMIN[​](#workflows_admin "Direct link to WORKFLOWS_ADMIN") > **WORKFLOWS\_ADMIN**: `"workflows:admin"` Defined in: [packages/sdk/src/types/core-types.ts:138](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/core-types.ts#L138) *** ### WORKFLOWS\_READ[​](#workflows_read "Direct link to WORKFLOWS_READ") > **WORKFLOWS\_READ**: `"workflows:read"` Defined in: [packages/sdk/src/types/core-types.ts:136](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/core-types.ts#L136) *** ### WORKFLOWS\_WRITE[​](#workflows_write "Direct link to WORKFLOWS_WRITE") > **WORKFLOWS\_WRITE**: `"workflows:write"` Defined in: [packages/sdk/src/types/core-types.ts:137](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/core-types.ts#L137) *** ### WORKSPACE\_ADMIN[​](#workspace_admin "Direct link to WORKSPACE_ADMIN") > **WORKSPACE\_ADMIN**: `"workspace:admin"` Defined in: [packages/sdk/src/types/core-types.ts:103](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/core-types.ts#L103) *** ### WORKSPACE\_READ[​](#workspace_read "Direct link to WORKSPACE_READ") > **WORKSPACE\_READ**: `"workspace:read"` Defined in: [packages/sdk/src/types/core-types.ts:101](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/core-types.ts#L101) *** ### WORKSPACE\_WRITE[​](#workspace_write "Direct link to WORKSPACE_WRITE") > **WORKSPACE\_WRITE**: `"workspace:write"` Defined in: [packages/sdk/src/types/core-types.ts:102](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/core-types.ts#L102) --- # Enumeration: ScopeCategory Defined in: [packages/sdk/src/scopes.ts:15](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/scopes.ts#L15) Categories of scopes for organization Must match namespaces used in Python Scope enum ## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members") ### AGENTS[​](#agents "Direct link to AGENTS") > **AGENTS**: `"agents"` Defined in: [packages/sdk/src/scopes.ts:30](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/scopes.ts#L30) *** ### ANALYTICS[​](#analytics "Direct link to ANALYTICS") > **ANALYTICS**: `"analytics"` Defined in: [packages/sdk/src/scopes.ts:37](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/scopes.ts#L37) *** ### APPS[​](#apps "Direct link to APPS") > **APPS**: `"apps"` Defined in: [packages/sdk/src/scopes.ts:35](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/scopes.ts#L35) *** ### ASSIGNMENTS[​](#assignments "Direct link to ASSIGNMENTS") > **ASSIGNMENTS**: `"assignments"` Defined in: [packages/sdk/src/scopes.ts:22](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/scopes.ts#L22) *** ### AUTOMATIONS[​](#automations "Direct link to AUTOMATIONS") > **AUTOMATIONS**: `"automations"` Defined in: [packages/sdk/src/scopes.ts:23](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/scopes.ts#L23) *** ### CALENDARS[​](#calendars "Direct link to CALENDARS") > **CALENDARS**: `"calendars"` Defined in: [packages/sdk/src/scopes.ts:31](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/scopes.ts#L31) *** ### CHATS[​](#chats "Direct link to CHATS") > **CHATS**: `"chats"` Defined in: [packages/sdk/src/scopes.ts:19](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/scopes.ts#L19) *** ### DATATYPES[​](#datatypes "Direct link to DATATYPES") > **DATATYPES**: `"datatypes"` Defined in: [packages/sdk/src/scopes.ts:24](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/scopes.ts#L24) *** ### DM[​](#dm "Direct link to DM") > **DM**: `"dm"` Defined in: [packages/sdk/src/scopes.ts:20](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/scopes.ts#L20) *** ### EXPERIMENTS[​](#experiments "Direct link to EXPERIMENTS") > **EXPERIMENTS**: `"experiments"` Defined in: [packages/sdk/src/scopes.ts:28](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/scopes.ts#L28) *** ### EXPORT[​](#export "Direct link to EXPORT") > **EXPORT**: `"export"` Defined in: [packages/sdk/src/scopes.ts:39](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/scopes.ts#L39) *** ### FILES[​](#files "Direct link to FILES") > **FILES**: `"files"` Defined in: [packages/sdk/src/scopes.ts:26](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/scopes.ts#L26) *** ### INBOXES[​](#inboxes "Direct link to INBOXES") > **INBOXES**: `"inboxes"` Defined in: [packages/sdk/src/scopes.ts:32](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/scopes.ts#L32) *** ### JOURNEYS[​](#journeys "Direct link to JOURNEYS") > **JOURNEYS**: `"journeys"` Defined in: [packages/sdk/src/scopes.ts:27](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/scopes.ts#L27) *** ### LABELS[​](#labels "Direct link to LABELS") > **LABELS**: `"labels"` Defined in: [packages/sdk/src/scopes.ts:36](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/scopes.ts#L36) *** ### MEMBER\_ROLES[​](#member_roles "Direct link to MEMBER_ROLES") > **MEMBER\_ROLES**: `"member_roles"` Defined in: [packages/sdk/src/scopes.ts:18](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/scopes.ts#L18) *** ### MEMBERS[​](#members "Direct link to MEMBERS") > **MEMBERS**: `"members"` Defined in: [packages/sdk/src/scopes.ts:17](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/scopes.ts#L17) *** ### OPERATOR[​](#operator "Direct link to OPERATOR") > **OPERATOR**: `"operator"` Defined in: [packages/sdk/src/scopes.ts:38](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/scopes.ts#L38) *** ### ORG[​](#org "Direct link to ORG") > **ORG**: `"org"` Defined in: [packages/sdk/src/scopes.ts:40](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/scopes.ts#L40) *** ### PHONES[​](#phones "Direct link to PHONES") > **PHONES**: `"phones"` Defined in: [packages/sdk/src/scopes.ts:33](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/scopes.ts#L33) *** ### RECORDS[​](#records "Direct link to RECORDS") > **RECORDS**: `"records"` Defined in: [packages/sdk/src/scopes.ts:25](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/scopes.ts#L25) *** ### SITES[​](#sites "Direct link to SITES") > **SITES**: `"sites"` Defined in: [packages/sdk/src/scopes.ts:29](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/scopes.ts#L29) *** ### WEBHOOKS[​](#webhooks "Direct link to WEBHOOKS") > **WEBHOOKS**: `"webhooks"` Defined in: [packages/sdk/src/scopes.ts:34](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/scopes.ts#L34) *** ### WORKFLOWS[​](#workflows "Direct link to WORKFLOWS") > **WORKFLOWS**: `"workflows"` Defined in: [packages/sdk/src/scopes.ts:21](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/scopes.ts#L21) *** ### WORKSPACE[​](#workspace "Direct link to WORKSPACE") > **WORKSPACE**: `"workspace"` Defined in: [packages/sdk/src/scopes.ts:16](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/scopes.ts#L16) --- # Enumeration: ToolkitState Defined in: [packages/sdk/src/types/toolkit-types.ts:22](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/toolkit-types.ts#L22) Legacy enum kept for callers using UPPER\_SNAKE member names (e.g. ToolkitState.ENABLED). ## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members") ### AUTH[​](#auth "Direct link to AUTH") > **AUTH**: `"auth"` Defined in: [packages/sdk/src/types/toolkit-types.ts:25](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/toolkit-types.ts#L25) *** ### DISABLED[​](#disabled "Direct link to DISABLED") > **DISABLED**: `"disabled"` Defined in: [packages/sdk/src/types/toolkit-types.ts:23](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/toolkit-types.ts#L23) *** ### ENABLED[​](#enabled "Direct link to ENABLED") > **ENABLED**: `"enabled"` Defined in: [packages/sdk/src/types/toolkit-types.ts:24](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/toolkit-types.ts#L24) --- # Enumeration: WorkspaceFeature Defined in: [packages/sdk/src/types/billing-types.ts:146](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L146) Workspace product feature flags. Matches the Python WorkspaceFeature enum in lib/constants.py ## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members") ### AGENT\_MEMORY[​](#agent_memory "Direct link to AGENT_MEMORY") > **AGENT\_MEMORY**: `"agent_memory"` Defined in: [packages/sdk/src/types/billing-types.ts:193](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L193) *** ### BROWSER[​](#browser "Direct link to BROWSER") > **BROWSER**: `"browser"` Defined in: [packages/sdk/src/types/billing-types.ts:159](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L159) *** ### CALENDAR[​](#calendar "Direct link to CALENDAR") > **CALENDAR**: `"calendar"` Defined in: [packages/sdk/src/types/billing-types.ts:161](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L161) *** ### CONFLUENCE[​](#confluence "Direct link to CONFLUENCE") > **CONFLUENCE**: `"confluence"` Defined in: [packages/sdk/src/types/billing-types.ts:190](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L190) *** ### CRM\_HUBSPOT[​](#crm_hubspot "Direct link to CRM_HUBSPOT") > **CRM\_HUBSPOT**: `"crm_hubspot"` Defined in: [packages/sdk/src/types/billing-types.ts:187](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L187) *** ### CRM\_SALESFORCE[​](#crm_salesforce "Direct link to CRM_SALESFORCE") > **CRM\_SALESFORCE**: `"crm_salesforce"` Defined in: [packages/sdk/src/types/billing-types.ts:186](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L186) *** ### DIRECT\_MESSAGES[​](#direct_messages "Direct link to DIRECT_MESSAGES") > **DIRECT\_MESSAGES**: `"direct_messages"` Defined in: [packages/sdk/src/types/billing-types.ts:162](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L162) *** ### DISCORD[​](#discord "Direct link to DISCORD") > **DISCORD**: `"discord"` Defined in: [packages/sdk/src/types/billing-types.ts:151](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L151) *** ### EHR\_ECLINICALWORKS[​](#ehr_eclinicalworks "Direct link to EHR_ECLINICALWORKS") > **EHR\_ECLINICALWORKS**: `"ehr_eclinicalworks"` Defined in: [packages/sdk/src/types/billing-types.ts:182](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L182) *** ### EHR\_FHIR[​](#ehr_fhir "Direct link to EHR_FHIR") > **EHR\_FHIR**: `"ehr_fhir"` Defined in: [packages/sdk/src/types/billing-types.ts:181](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L181) *** ### EHR\_HEALTHIE[​](#ehr_healthie "Direct link to EHR_HEALTHIE") > **EHR\_HEALTHIE**: `"ehr_healthie"` Defined in: [packages/sdk/src/types/billing-types.ts:183](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L183) *** ### EMAIL[​](#email "Direct link to EMAIL") > **EMAIL**: `"email"` Defined in: [packages/sdk/src/types/billing-types.ts:149](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L149) *** ### EXPERIMENTS[​](#experiments "Direct link to EXPERIMENTS") > **EXPERIMENTS**: `"experiments"` Defined in: [packages/sdk/src/types/billing-types.ts:164](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L164) *** ### FORMS[​](#forms "Direct link to FORMS") > **FORMS**: `"forms"` Defined in: [packages/sdk/src/types/billing-types.ts:157](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L157) *** ### GCALENDAR[​](#gcalendar "Direct link to GCALENDAR") > **GCALENDAR**: `"gcalendar"` Defined in: [packages/sdk/src/types/billing-types.ts:170](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L170) *** ### GMAIL[​](#gmail "Direct link to GMAIL") > **GMAIL**: `"gmail"` Defined in: [packages/sdk/src/types/billing-types.ts:169](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L169) *** ### HIPAA\_COMPLIANCE[​](#hipaa_compliance "Direct link to HIPAA_COMPLIANCE") > **HIPAA\_COMPLIANCE**: `"hipaa_compliance"` Defined in: [packages/sdk/src/types/billing-types.ts:177](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L177) *** ### IMAGE\_GENERATION[​](#image_generation "Direct link to IMAGE_GENERATION") > **IMAGE\_GENERATION**: `"image_generation"` Defined in: [packages/sdk/src/types/billing-types.ts:194](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L194) *** ### JOURNEYS[​](#journeys "Direct link to JOURNEYS") > **JOURNEYS**: `"journeys"` Defined in: [packages/sdk/src/types/billing-types.ts:163](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L163) *** ### MAPS[​](#maps "Direct link to MAPS") > **MAPS**: `"maps"` Defined in: [packages/sdk/src/types/billing-types.ts:158](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L158) *** ### MONDAY[​](#monday "Direct link to MONDAY") > **MONDAY**: `"monday"` Defined in: [packages/sdk/src/types/billing-types.ts:171](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L171) *** ### OPERATOR[​](#operator "Direct link to OPERATOR") > **OPERATOR**: `"operator"` Defined in: [packages/sdk/src/types/billing-types.ts:165](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L165) *** ### PHONE[​](#phone "Direct link to PHONE") > **PHONE**: `"phone"` Defined in: [packages/sdk/src/types/billing-types.ts:148](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L148) *** ### PRESENCE[​](#presence "Direct link to PRESENCE") > **PRESENCE**: `"presence"` Defined in: [packages/sdk/src/types/billing-types.ts:166](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L166) *** ### RESELL\_PRODUCTS[​](#resell_products "Direct link to RESELL_PRODUCTS") > **RESELL\_PRODUCTS**: `"resell_products"` Defined in: [packages/sdk/src/types/billing-types.ts:174](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L174) *** ### SITES[​](#sites "Direct link to SITES") > **SITES**: `"sites"` Defined in: [packages/sdk/src/types/billing-types.ts:156](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L156) *** ### SLACK[​](#slack "Direct link to SLACK") > **SLACK**: `"slack"` Defined in: [packages/sdk/src/types/billing-types.ts:152](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L152) *** ### SOC2\_COMPLIANCE[​](#soc2_compliance "Direct link to SOC2_COMPLIANCE") > **SOC2\_COMPLIANCE**: `"soc2_compliance"` Defined in: [packages/sdk/src/types/billing-types.ts:178](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L178) *** ### TEAMS[​](#teams "Direct link to TEAMS") > **TEAMS**: `"teams"` Defined in: [packages/sdk/src/types/billing-types.ts:153](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L153) *** ### WEB\_SEARCH[​](#web_search "Direct link to WEB_SEARCH") > **WEB\_SEARCH**: `"web_search"` Defined in: [packages/sdk/src/types/billing-types.ts:160](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L160) *** ### WHATSAPP[​](#whatsapp "Direct link to WHATSAPP") > **WHATSAPP**: `"whatsapp"` Defined in: [packages/sdk/src/types/billing-types.ts:150](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L150) *** ### WORKFLOW\_VERSIONING[​](#workflow_versioning "Direct link to WORKFLOW_VERSIONING") > **WORKFLOW\_VERSIONING**: `"workflow_versioning"` Defined in: [packages/sdk/src/types/billing-types.ts:195](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L195) --- # Enumeration: WorkspaceProvisionStatus Defined in: [packages/sdk/src/types/workspace-types.ts:63](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/workspace-types.ts#L63) ## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members") ### AVAILABLE[​](#available "Direct link to AVAILABLE") > **AVAILABLE**: `2` Defined in: [packages/sdk/src/types/workspace-types.ts:66](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/workspace-types.ts#L66) *** ### DELETED[​](#deleted "Direct link to DELETED") > **DELETED**: `7` Defined in: [packages/sdk/src/types/workspace-types.ts:71](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/workspace-types.ts#L71) *** ### DISABLED[​](#disabled "Direct link to DISABLED") > **DISABLED**: `4` Defined in: [packages/sdk/src/types/workspace-types.ts:68](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/workspace-types.ts#L68) *** ### ERROR[​](#error "Direct link to ERROR") > **ERROR**: `8` Defined in: [packages/sdk/src/types/workspace-types.ts:72](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/workspace-types.ts#L72) *** ### MAINTENANCE[​](#maintenance "Direct link to MAINTENANCE") > **MAINTENANCE**: `3` Defined in: [packages/sdk/src/types/workspace-types.ts:67](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/workspace-types.ts#L67) *** ### NEEDS\_MIGRATION[​](#needs_migration "Direct link to NEEDS_MIGRATION") > **NEEDS\_MIGRATION**: `9` Defined in: [packages/sdk/src/types/workspace-types.ts:73](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/workspace-types.ts#L73) *** ### PROVISIONING[​](#provisioning "Direct link to PROVISIONING") > **PROVISIONING**: `1` Defined in: [packages/sdk/src/types/workspace-types.ts:65](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/workspace-types.ts#L65) *** ### SCHEMA\_CREATED[​](#schema_created "Direct link to SCHEMA_CREATED") > **SCHEMA\_CREATED**: `6` Defined in: [packages/sdk/src/types/workspace-types.ts:70](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/workspace-types.ts#L70) *** ### SCHEMA\_MISSING[​](#schema_missing "Direct link to SCHEMA_MISSING") > **SCHEMA\_MISSING**: `5` Defined in: [packages/sdk/src/types/workspace-types.ts:69](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/workspace-types.ts#L69) *** ### UNPROVISIONED[​](#unprovisioned "Direct link to UNPROVISIONED") > **UNPROVISIONED**: `0` Defined in: [packages/sdk/src/types/workspace-types.ts:64](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/workspace-types.ts#L64) --- # Function: areDependenciesSatisfied() > **areDependenciesSatisfied**(`slug`, `enabledFeatures`): `boolean` Defined in: [packages/sdk/src/features/registry.ts:170](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/features/registry.ts#L170) Check if all dependencies for a feature are satisfied. ## Parameters[​](#parameters "Direct link to Parameters") ### slug[​](#slug "Direct link to slug") `string` The feature slug to check ### enabledFeatures[​](#enabledfeatures "Direct link to enabledFeatures") `string`\[] Array of currently enabled feature slugs ## Returns[​](#returns "Direct link to Returns") `boolean` True if all dependencies are satisfied --- # Function: canPreviewVoice() > **canPreviewVoice**(`entity`): `boolean` Defined in: [packages/sdk/src/types/model-config-types.ts:216](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/model-config-types.ts#L216) Check if an entity's voice can be previewed. ## Parameters[​](#parameters "Direct link to Parameters") ### entity[​](#entity "Direct link to entity") An object with optional realtimeModelConfig #### realtimeModelConfig?[​](#realtimemodelconfig "Direct link to realtimeModelConfig?") [`RealtimeModelConfig`](https://docs.gravityrail.com/sdk/type-aliases/RealtimeModelConfig.md) | `null` ## Returns[​](#returns "Direct link to Returns") `boolean` True if the entity's voice supports TTS preview --- # Function: clearRegistry() > **clearRegistry**(): `void` Defined in: [packages/sdk/src/features/registry.ts:263](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/features/registry.ts#L263) Clear the feature registry. This is primarily useful for testing. ## Returns[​](#returns "Direct link to Returns") `void` --- # Function: createWorkspaceClient() > **createWorkspaceClient**(`root`, `workspaceUuid`): [`GravityRailWorkspaceClient`](https://docs.gravityrail.com/sdk/type-aliases/GravityRailWorkspaceClient.md) Defined in: [packages/sdk/src/client/workspace-client.ts:728](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/workspace-client.ts#L728) ## Parameters[​](#parameters "Direct link to Parameters") ### root[​](#root "Direct link to root") [`GravityRailClient`](https://docs.gravityrail.com/sdk/classes/GravityRailClient.md) ### workspaceUuid[​](#workspaceuuid "Direct link to workspaceUuid") `string` ## Returns[​](#returns "Direct link to Returns") [`GravityRailWorkspaceClient`](https://docs.gravityrail.com/sdk/type-aliases/GravityRailWorkspaceClient.md) --- # Function: decodePermissions() > **decodePermissions**(`accessMode`): [`ObjectPermissionFlags`](https://docs.gravityrail.com/sdk/interfaces/ObjectPermissionFlags.md) Defined in: [packages/sdk/src/types/core-types.ts:55](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/core-types.ts#L55) ## Parameters[​](#parameters "Direct link to Parameters") ### accessMode[​](#accessmode "Direct link to accessMode") `number` ## Returns[​](#returns "Direct link to Returns") [`ObjectPermissionFlags`](https://docs.gravityrail.com/sdk/interfaces/ObjectPermissionFlags.md) --- # Function: encodePermissions() > **encodePermissions**(`permissions`): `number` Defined in: [packages/sdk/src/types/core-types.ts:68](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/core-types.ts#L68) ## Parameters[​](#parameters "Direct link to Parameters") ### permissions[​](#permissions "Direct link to permissions") [`ObjectPermissionFlags`](https://docs.gravityrail.com/sdk/interfaces/ObjectPermissionFlags.md) ## Returns[​](#returns "Direct link to Returns") `number` --- # Function: eventRuleActionParams() > **eventRuleActionParams**<`T`>(`params`): `T` Defined in: [packages/sdk/src/types/event-types.ts:124](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L124) Narrow actionParams — OpenAPI types this as Record\. ## Type Parameters[​](#type-parameters "Direct link to Type Parameters") ### T[​](#t "Direct link to T") `T` ## Parameters[​](#parameters "Direct link to Parameters") ### params[​](#params "Direct link to params") `Record`<`string`, `unknown`> | `null` | `undefined` ## Returns[​](#returns "Direct link to Returns") `T` --- # Function: formatAppContextAsMarkdown() > **formatAppContextAsMarkdown**(`context`): `string` Defined in: [packages/sdk/src/app-context.ts:116](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/app-context.ts#L116) Format app context as markdown for display in bug reports, etc. ## Parameters[​](#parameters "Direct link to Parameters") ### context[​](#context "Direct link to context") [`AppContext`](https://docs.gravityrail.com/sdk/interfaces/AppContext.md) | `undefined` ## Returns[​](#returns "Direct link to Returns") `string` --- # Function: getAllFeatures() > **getAllFeatures**(): `Record`<`string`, [`FeatureDefinition`](https://docs.gravityrail.com/sdk/interfaces/FeatureDefinition.md)> Defined in: [packages/sdk/src/features/registry.ts:119](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/features/registry.ts#L119) Get all registered features. ## Returns[​](#returns "Direct link to Returns") `Record`<`string`, [`FeatureDefinition`](https://docs.gravityrail.com/sdk/interfaces/FeatureDefinition.md)> Record mapping slugs to feature definitions --- # Function: getAllResourceSlugs() > **getAllResourceSlugs**(): [`Resource`](https://docs.gravityrail.com/sdk/enumerations/Resource.md)\[] Defined in: [packages/sdk/src/types/resource-metadata.ts:140](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/resource-metadata.ts#L140) Get all available resource slugs ## Returns[​](#returns "Direct link to Returns") [`Resource`](https://docs.gravityrail.com/sdk/enumerations/Resource.md)\[] --- # Function: getApplicableResources() > **getApplicableResources**(`scope`, `enabledFeatures?`): [`Resource`](https://docs.gravityrail.com/sdk/enumerations/Resource.md)\[] Defined in: [packages/sdk/src/types/resource-metadata.ts:160](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/resource-metadata.ts#L160) Get resources applicable to a given scope and optional feature set. ## Parameters[​](#parameters "Direct link to Parameters") ### scope[​](#scope "Direct link to scope") [`ResourceScope`](https://docs.gravityrail.com/sdk/type-aliases/ResourceScope.md) 'workspace', 'org', or 'any' to filter by where resources can be configured ### enabledFeatures?[​](#enabledfeatures "Direct link to enabledFeatures?") Optional list of enabled features. If provided, resources requiring features not in this list will be excluded. If null/undefined, all resources matching the scope are returned. [`WorkspaceFeature`](https://docs.gravityrail.com/sdk/enumerations/WorkspaceFeature.md)\[] | `null` ## Returns[​](#returns "Direct link to Returns") [`Resource`](https://docs.gravityrail.com/sdk/enumerations/Resource.md)\[] --- # Function: getApplicableResourceSlugs() > **getApplicableResourceSlugs**(`productType`): [`Resource`](https://docs.gravityrail.com/sdk/enumerations/Resource.md)\[] Defined in: [packages/sdk/src/types/resource-metadata.ts:198](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/resource-metadata.ts#L198) Get resources applicable to a product type. This is a convenience wrapper around getApplicableResources that derives scope from product type. Does not filter by features - use getApplicableResources directly for feature-based filtering. ## Parameters[​](#parameters "Direct link to Parameters") ### productType[​](#producttype "Direct link to productType") [`ProductType`](https://docs.gravityrail.com/sdk/enumerations/ProductType.md) ## Returns[​](#returns "Direct link to Returns") [`Resource`](https://docs.gravityrail.com/sdk/enumerations/Resource.md)\[] --- # Function: getAvailableFeaturesForUpgrade() > **getAvailableFeaturesForUpgrade**(`enabledFeatures`): [`FeatureDefinition`](https://docs.gravityrail.com/sdk/interfaces/FeatureDefinition.md)\[] Defined in: [packages/sdk/src/features/registry.ts:224](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/features/registry.ts#L224) Get features that can be shown as upgrade options. ## Parameters[​](#parameters "Direct link to Parameters") ### enabledFeatures[​](#enabledfeatures "Direct link to enabledFeatures") `string`\[] Array of currently enabled feature slugs ## Returns[​](#returns "Direct link to Returns") [`FeatureDefinition`](https://docs.gravityrail.com/sdk/interfaces/FeatureDefinition.md)\[] Array of features available for upgrade --- # Function: getCookieValue() > **getCookieValue**(`name`): `string` | `undefined` Defined in: [packages/sdk/src/api/base.ts:2](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/base.ts#L2) ## Parameters[​](#parameters "Direct link to Parameters") ### name[​](#name "Direct link to name") `string` ## Returns[​](#returns "Direct link to Returns") `string` | `undefined` --- # Function: getFeature() > **getFeature**(`slug`): [`FeatureDefinition`](https://docs.gravityrail.com/sdk/interfaces/FeatureDefinition.md) | `undefined` Defined in: [packages/sdk/src/features/registry.ts:110](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/features/registry.ts#L110) Get a feature definition by slug. ## Parameters[​](#parameters "Direct link to Parameters") ### slug[​](#slug "Direct link to slug") `string` The feature slug (e.g., "calendar", "gmail") ## Returns[​](#returns "Direct link to Returns") [`FeatureDefinition`](https://docs.gravityrail.com/sdk/interfaces/FeatureDefinition.md) | `undefined` The feature definition, or undefined if not found --- # Function: getFeaturesByCategory() > **getFeaturesByCategory**(`category`): [`FeatureDefinition`](https://docs.gravityrail.com/sdk/interfaces/FeatureDefinition.md)\[] Defined in: [packages/sdk/src/features/registry.ts:129](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/features/registry.ts#L129) Get all features in a specific category. ## Parameters[​](#parameters "Direct link to Parameters") ### category[​](#category "Direct link to category") [`FeatureCategory`](https://docs.gravityrail.com/sdk/enumerations/FeatureCategory.md) The category to filter by ## Returns[​](#returns "Direct link to Returns") [`FeatureDefinition`](https://docs.gravityrail.com/sdk/interfaces/FeatureDefinition.md)\[] Array of features in the category --- # Function: getFeaturesByVisibility() > **getFeaturesByVisibility**(`visibility`): [`FeatureDefinition`](https://docs.gravityrail.com/sdk/interfaces/FeatureDefinition.md)\[] Defined in: [packages/sdk/src/features/registry.ts:139](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/features/registry.ts#L139) Get all features with a specific visibility setting. ## Parameters[​](#parameters "Direct link to Parameters") ### visibility[​](#visibility "Direct link to visibility") [`FeatureVisibility`](https://docs.gravityrail.com/sdk/enumerations/FeatureVisibility.md) The visibility type to filter by ## Returns[​](#returns "Direct link to Returns") [`FeatureDefinition`](https://docs.gravityrail.com/sdk/interfaces/FeatureDefinition.md)\[] Array of features with the specified visibility --- # Function: getMissingDependencies() > **getMissingDependencies**(`slug`, `enabledFeatures`): `string`\[] Defined in: [packages/sdk/src/features/registry.ts:186](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/features/registry.ts#L186) Get the list of missing dependencies for a feature. ## Parameters[​](#parameters "Direct link to Parameters") ### slug[​](#slug "Direct link to slug") `string` The feature slug to check ### enabledFeatures[​](#enabledfeatures "Direct link to enabledFeatures") `string`\[] Array of currently enabled feature slugs ## Returns[​](#returns "Direct link to Returns") `string`\[] Array of missing dependency slugs --- # Function: getResourceMetadata() > **getResourceMetadata**(`resource`): [`ResourceMetadata`](https://docs.gravityrail.com/sdk/interfaces/ResourceMetadata.md) | `undefined` Defined in: [packages/sdk/src/types/resource-metadata.ts:133](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/resource-metadata.ts#L133) Get metadata for a specific resource ## Parameters[​](#parameters "Direct link to Parameters") ### resource[​](#resource "Direct link to resource") [`Resource`](https://docs.gravityrail.com/sdk/enumerations/Resource.md) ## Returns[​](#returns "Direct link to Returns") [`ResourceMetadata`](https://docs.gravityrail.com/sdk/interfaces/ResourceMetadata.md) | `undefined` --- # Function: getScopeFromProductType() > **getScopeFromProductType**(`productType`): [`ResourceScope`](https://docs.gravityrail.com/sdk/type-aliases/ResourceScope.md) Defined in: [packages/sdk/src/types/resource-metadata.ts:147](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/resource-metadata.ts#L147) Get the scope ('workspace' or 'org') for a product type. ## Parameters[​](#parameters "Direct link to Parameters") ### productType[​](#producttype "Direct link to productType") [`ProductType`](https://docs.gravityrail.com/sdk/enumerations/ProductType.md) ## Returns[​](#returns "Direct link to Returns") [`ResourceScope`](https://docs.gravityrail.com/sdk/type-aliases/ResourceScope.md) --- # Function: getTTSProvider() > **getTTSProvider**(`ttsModel`): `string` | `null` Defined in: [packages/sdk/src/types/model-config-types.ts:50](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/model-config-types.ts#L50) Extract the provider from a TTSModel ID (e.g. "elevenlabs:tts:eleven\_flash\_v2\_5" -> "elevenlabs"). ## Parameters[​](#parameters "Direct link to Parameters") ### ttsModel[​](#ttsmodel "Direct link to ttsModel") `string` | `null` | `undefined` ## Returns[​](#returns "Direct link to Returns") `string` | `null` --- # Function: getVoiceModelId() > **getVoiceModelId**(`entity`): `string` | `null` Defined in: [packages/sdk/src/types/model-config-types.ts:203](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/model-config-types.ts#L203) Get the canonical voice model ID from a realtime model config. Voice model IDs follow the format: `{provider}:voice:{voiceName}` Examples: * `openai:voice:ash` * `elevenlabs:voice:catt` * `google:voice:puck` ## Parameters[​](#parameters "Direct link to Parameters") ### entity[​](#entity "Direct link to entity") An object with optional realtimeModelConfig #### realtimeModelConfig?[​](#realtimemodelconfig "Direct link to realtimeModelConfig?") [`RealtimeModelConfig`](https://docs.gravityrail.com/sdk/type-aliases/RealtimeModelConfig.md) | `null` ## Returns[​](#returns "Direct link to Returns") `string` | `null` The canonical voice model ID, or null if no voice is configured --- # Function: initializeFeatures() > **initializeFeatures**(`features`): `void` Defined in: [packages/sdk/src/features/registry.ts:97](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/features/registry.ts#L97) Initialize the feature registry with definitions from the API. ## Parameters[​](#parameters "Direct link to Parameters") ### features[​](#features "Direct link to features") [`FeatureDefinition`](https://docs.gravityrail.com/sdk/interfaces/FeatureDefinition.md)\[] Array of feature definitions from the API ## Returns[​](#returns "Direct link to Returns") `void` --- # Function: isChatType() > **isChatType**(`value`): `value is ChatType` Defined in: [packages/sdk/src/constants/chat-types.ts:59](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/constants/chat-types.ts#L59) Type guard to check if a string is a valid ChatType. ## Parameters[​](#parameters "Direct link to Parameters") ### value[​](#value "Direct link to value") `string` ## Returns[​](#returns "Direct link to Returns") `value is ChatType` --- # Function: isFeatureAvailable() > **isFeatureAvailable**(`slug`, `enabledFeatures`): `boolean` Defined in: [packages/sdk/src/features/registry.ts:150](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/features/registry.ts#L150) Check if a feature is available (enabled and dependencies met). ## Parameters[​](#parameters "Direct link to Parameters") ### slug[​](#slug "Direct link to slug") `string` The feature slug to check ### enabledFeatures[​](#enabledfeatures "Direct link to enabledFeatures") `string`\[] Array of currently enabled feature slugs ## Returns[​](#returns "Direct link to Returns") `boolean` True if the feature is enabled and all dependencies are met --- # Function: isRegistryInitialized() > **isRegistryInitialized**(): `boolean` Defined in: [packages/sdk/src/features/registry.ts:254](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/features/registry.ts#L254) Check if the feature registry has been initialized. ## Returns[​](#returns "Direct link to Returns") `boolean` True if features have been loaded --- # Function: isSMSDeliveryFailureStatus() > **isSMSDeliveryFailureStatus**(`status`): `status is SMSDeliveryFailureStatus` Defined in: [packages/sdk/src/types/chat-types.ts:235](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L235) ## Parameters[​](#parameters "Direct link to Parameters") ### status[​](#status "Direct link to status") `string` | `null` | `undefined` ## Returns[​](#returns "Direct link to Returns") `status is SMSDeliveryFailureStatus` --- # Function: requiresAssistantParticipant() > **requiresAssistantParticipant**(`chatType`): `boolean` Defined in: [packages/sdk/src/constants/chat-types.ts:52](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/constants/chat-types.ts#L52) Check if a chat type requires an assistant participant record. ## Parameters[​](#parameters "Direct link to Parameters") ### chatType[​](#chattype "Direct link to chatType") `string` ## Returns[​](#returns "Direct link to Returns") `boolean` --- # Function: runWorkspaceScript() > **runWorkspaceScript**(`client`, `build`, `mode?`): `Promise`<`void` | `ResourceSummary`> Defined in: [packages/sdk/src/workspace-builder/orchestrator.ts:700](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/workspace-builder/orchestrator.ts#L700) ## Parameters[​](#parameters "Direct link to Parameters") ### client[​](#client "Direct link to client") [`GravityRailWorkspaceClient`](https://docs.gravityrail.com/sdk/type-aliases/GravityRailWorkspaceClient.md) ### build[​](#build "Direct link to build") (`workspace`) => `void` | `Promise`<`void`> ### mode?[​](#mode "Direct link to mode?") `string` = `'plan'` ## Returns[​](#returns "Direct link to Returns") `Promise`<`void` | `ResourceSummary`> --- # Function: usesBuiltinAssistant() > **usesBuiltinAssistant**(`chatType`): `boolean` Defined in: [packages/sdk/src/constants/chat-types.ts:45](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/constants/chat-types.ts#L45) Check if a chat type uses a builtin assistant. ## Parameters[​](#parameters "Direct link to Parameters") ### chatType[​](#chattype "Direct link to chatType") `string` ## Returns[​](#returns "Direct link to Returns") `boolean` --- # Function: validateFeatureDependencies() > **validateFeatureDependencies**(`enabledFeatures`): `string`\[] Defined in: [packages/sdk/src/features/registry.ts:201](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/features/registry.ts#L201) Validate that all feature dependencies are satisfied. ## Parameters[​](#parameters "Direct link to Parameters") ### enabledFeatures[​](#enabledfeatures "Direct link to enabledFeatures") `string`\[] Array of enabled feature slugs ## Returns[​](#returns "Direct link to Returns") `string`\[] Array of error messages for unsatisfied dependencies --- # Interface: A2PBrandEnrollmentUrlResponse Defined in: [packages/sdk/src/types/organization-types.ts:278](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/organization-types.ts#L278) ## Properties[​](#properties "Direct link to Properties") ### url[​](#url "Direct link to url") > **url**: `string` | `null` Defined in: [packages/sdk/src/types/organization-types.ts:280](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/organization-types.ts#L280) Brand-addressable enrollment URL (carries ?brand=…); null until linked. --- # Interface: A2PCampaignConfigResponse Defined in: [packages/sdk/src/types/organization-types.ts:245](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/organization-types.ts#L245) Stored overrides (raw) + the resolved preview for one brand. ## Properties[​](#properties "Direct link to Properties") ### enrollmentSiteUuid?[​](#enrollmentsiteuuid "Direct link to enrollmentSiteUuid?") > `optional` **enrollmentSiteUuid**: `string` | `null` Defined in: [packages/sdk/src/types/organization-types.ts:249](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/organization-types.ts#L249) The Site (`A2PBrand.site_uuid`) linked as this brand's opt-in surface. *** ### overrides[​](#overrides "Direct link to overrides") > **overrides**: `Record`<`string`, `unknown`> Defined in: [packages/sdk/src/types/organization-types.ts:246](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/organization-types.ts#L246) *** ### resolved[​](#resolved "Direct link to resolved") > **resolved**: [`ResolvedA2PCampaignConfig`](https://docs.gravityrail.com/sdk/interfaces/ResolvedA2PCampaignConfig.md) Defined in: [packages/sdk/src/types/organization-types.ts:247](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/organization-types.ts#L247) --- # Interface: A2PEnrollmentSiteCandidate Defined in: [packages/sdk/src/types/organization-types.ts:253](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/organization-types.ts#L253) A published Site the org may link as a brand's enrollment surface. ## Properties[​](#properties "Direct link to Properties") ### siteName[​](#sitename "Direct link to siteName") > **siteName**: `string` Defined in: [packages/sdk/src/types/organization-types.ts:257](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/organization-types.ts#L257) *** ### siteUuid[​](#siteuuid "Direct link to siteUuid") > **siteUuid**: `string` Defined in: [packages/sdk/src/types/organization-types.ts:256](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/organization-types.ts#L256) *** ### workspaceName[​](#workspacename "Direct link to workspaceName") > **workspaceName**: `string` Defined in: [packages/sdk/src/types/organization-types.ts:255](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/organization-types.ts#L255) *** ### workspaceUuid[​](#workspaceuuid "Direct link to workspaceUuid") > **workspaceUuid**: `string` Defined in: [packages/sdk/src/types/organization-types.ts:254](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/organization-types.ts#L254) --- # Interface: A2PEnrollmentSiteCandidatesResponse Defined in: [packages/sdk/src/types/organization-types.ts:260](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/organization-types.ts#L260) ## Properties[​](#properties "Direct link to Properties") ### candidates[​](#candidates "Direct link to candidates") > **candidates**: [`A2PEnrollmentSiteCandidate`](https://docs.gravityrail.com/sdk/interfaces/A2PEnrollmentSiteCandidate.md)\[] Defined in: [packages/sdk/src/types/organization-types.ts:261](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/organization-types.ts#L261) --- # Interface: AbilityConfigIssue Defined in: [packages/sdk/src/types/generated/task.ts:24](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L24) A non-blocking diagnostic about an ability's configuration. Emitted by :meth:`AbilityBase.collect_config_issues` and aggregated by the workflow-level config validation route. Kept distinct from :class:`ResourceAccessGap` because access gaps are role-centric and have a specific remediation ("Grant missing access"), whereas config issues describe drift in the ability's own references (e.g. a file that was deleted after the ability was saved). ## Properties[​](#properties "Direct link to Properties") ### abilityType[​](#abilitytype "Direct link to abilityType") > **abilityType**: `string` Defined in: [packages/sdk/src/types/generated/task.ts:27](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L27) *** ### code[​](#code "Direct link to code") > **code**: [`AbilityConfigIssueCode`](https://docs.gravityrail.com/sdk/type-aliases/AbilityConfigIssueCode.md) Defined in: [packages/sdk/src/types/generated/task.ts:26](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L26) *** ### eventType?[​](#eventtype "Direct link to eventType?") > `optional` **eventType**: `string` | `null` Defined in: [packages/sdk/src/types/generated/task.ts:33](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L33) *** ### message[​](#message "Direct link to message") > **message**: `string` Defined in: [packages/sdk/src/types/generated/task.ts:34](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L34) *** ### objectType?[​](#objecttype "Direct link to objectType?") > `optional` **objectType**: `string` | `null` Defined in: [packages/sdk/src/types/generated/task.ts:32](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L32) *** ### resourceId?[​](#resourceid "Direct link to resourceId?") > `optional` **resourceId**: `string` | `number` | `null` Defined in: [packages/sdk/src/types/generated/task.ts:30](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L30) *** ### resourceName?[​](#resourcename "Direct link to resourceName?") > `optional` **resourceName**: `string` | `null` Defined in: [packages/sdk/src/types/generated/task.ts:31](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L31) *** ### resourceType?[​](#resourcetype "Direct link to resourceType?") > `optional` **resourceType**: `string` | `null` Defined in: [packages/sdk/src/types/generated/task.ts:29](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L29) *** ### severity[​](#severity "Direct link to severity") > **severity**: [`AbilityConfigIssueSeverity`](https://docs.gravityrail.com/sdk/type-aliases/AbilityConfigIssueSeverity.md) Defined in: [packages/sdk/src/types/generated/task.ts:25](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L25) *** ### taskId?[​](#taskid "Direct link to taskId?") > `optional` **taskId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/task.ts:28](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L28) --- # Interface: AbilityTypeResponse Defined in: [packages/sdk/src/types/generated/ability.ts:59](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/ability.ts#L59) Response model for an ability type from the code registry. ## Properties[​](#properties "Direct link to Properties") ### category?[​](#category "Direct link to category?") > `optional` **category**: `string` | `null` Defined in: [packages/sdk/src/types/generated/ability.ts:62](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/ability.ts#L62) *** ### channels?[​](#channels "Direct link to channels?") > `optional` **channels**: `string`\[] | `null` Defined in: [packages/sdk/src/types/generated/ability.ts:74](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/ability.ts#L74) Channels this ability is available on (sorted). null means all channels. Declarative introspection metadata, not an enforcement point — the ability's resolve() remains authoritative. *** ### configSchema?[​](#configschema "Direct link to configSchema?") > `optional` **configSchema**: `AbilityTypeResponseConfigSchema` Defined in: [packages/sdk/src/types/generated/ability.ts:64](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/ability.ts#L64) *** ### description?[​](#description "Direct link to description?") > `optional` **description**: `string` | `null` Defined in: [packages/sdk/src/types/generated/ability.ts:63](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/ability.ts#L63) *** ### requiredFeature?[​](#requiredfeature "Direct link to requiredFeature?") > `optional` **requiredFeature**: `string` | `null` Defined in: [packages/sdk/src/types/generated/ability.ts:70](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/ability.ts#L70) Workspace feature slug required for this ability to be available *** ### requiresChat?[​](#requireschat "Direct link to requiresChat?") > `optional` **requiresChat**: `boolean` Defined in: [packages/sdk/src/types/generated/ability.ts:72](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/ability.ts#L72) If true, the ability only resolves inside a chat context *** ### singleton?[​](#singleton "Direct link to singleton?") > `optional` **singleton**: `boolean` Defined in: [packages/sdk/src/types/generated/ability.ts:66](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/ability.ts#L66) If true, only one instance of this ability can exist per scope *** ### slug[​](#slug "Direct link to slug") > **slug**: `string` Defined in: [packages/sdk/src/types/generated/ability.ts:60](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/ability.ts#L60) *** ### system?[​](#system "Direct link to system?") > `optional` **system**: `boolean` Defined in: [packages/sdk/src/types/generated/ability.ts:68](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/ability.ts#L68) If true, this is an auto-injected system ability hidden from users *** ### title[​](#title "Direct link to title") > **title**: `string` Defined in: [packages/sdk/src/types/generated/ability.ts:61](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/ability.ts#L61) --- # Interface: AbilityTypesResponse Defined in: [packages/sdk/src/types/generated/ability.ts:82](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/ability.ts#L82) Response model for listing available ability types. ## Properties[​](#properties "Direct link to Properties") ### types[​](#types "Direct link to types") > **types**: [`AbilityTypeResponse`](https://docs.gravityrail.com/sdk/interfaces/AbilityTypeResponse.md)\[] Defined in: [packages/sdk/src/types/generated/ability.ts:83](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/ability.ts#L83) --- # Interface: AccessGrantDecision Defined in: [packages/sdk/src/types/chat-types.ts:356](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L356) ## Properties[​](#properties "Direct link to Properties") ### decision[​](#decision "Direct link to decision") > **decision**: `"approve"` | `"approve_always"` | `"reject"` Defined in: [packages/sdk/src/types/chat-types.ts:357](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L357) *** ### interruptId?[​](#interruptid "Direct link to interruptId?") > `optional` **interruptId**: `string` Defined in: [packages/sdk/src/types/chat-types.ts:359](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L359) LangGraph interrupt ID echoed back from the human\_input\_request event. --- # Interface: Account Defined in: [packages/sdk/src/types/generated/account.ts:15](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L15) Base account response for non-admin endpoints. Note: With Verified Credential Architecture, if email/phone is set, it's verified by construction. The \*\_verified\_at timestamps record when. Credentials are IMMUTABLE once set. ## Properties[​](#properties "Direct link to Properties") ### avatarUrl[​](#avatarurl "Direct link to avatarUrl") > **avatarUrl**: `string` | `null` Defined in: [packages/sdk/src/types/generated/account.ts:19](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L19) *** ### createdAt[​](#createdat "Direct link to createdAt") > **createdAt**: `string` Defined in: [packages/sdk/src/types/generated/account.ts:25](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L25) *** ### email[​](#email "Direct link to email") > **email**: `string` | `null` Defined in: [packages/sdk/src/types/generated/account.ts:20](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L20) *** ### emailVerifiedAt[​](#emailverifiedat "Direct link to emailVerifiedAt") > **emailVerifiedAt**: `string` | `null` Defined in: [packages/sdk/src/types/generated/account.ts:22](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L22) *** ### enabled[​](#enabled "Direct link to enabled") > **enabled**: `boolean` Defined in: [packages/sdk/src/types/generated/account.ts:27](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L27) *** ### id[​](#id "Direct link to id") > **id**: `number` Defined in: [packages/sdk/src/types/generated/account.ts:16](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L16) *** ### isSuperuser[​](#issuperuser "Direct link to isSuperuser") > **isSuperuser**: `boolean` Defined in: [packages/sdk/src/types/generated/account.ts:26](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L26) *** ### locale[​](#locale "Direct link to locale") > **locale**: `string` | `null` Defined in: [packages/sdk/src/types/generated/account.ts:32](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L32) *** ### loggedIn[​](#loggedin "Direct link to loggedIn") > **loggedIn**: `boolean` Defined in: [packages/sdk/src/types/generated/account.ts:18](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L18) *** ### name[​](#name "Direct link to name") > **name**: `string` | `null` Defined in: [packages/sdk/src/types/generated/account.ts:24](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L24) *** ### optedOut[​](#optedout "Direct link to optedOut") > **optedOut**: `boolean` Defined in: [packages/sdk/src/types/generated/account.ts:30](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L30) *** ### phone[​](#phone "Direct link to phone") > **phone**: `string` | `null` Defined in: [packages/sdk/src/types/generated/account.ts:21](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L21) *** ### phoneVerifiedAt[​](#phoneverifiedat "Direct link to phoneVerifiedAt") > **phoneVerifiedAt**: `string` | `null` Defined in: [packages/sdk/src/types/generated/account.ts:23](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L23) *** ### signupWorkspaceId[​](#signupworkspaceid "Direct link to signupWorkspaceId") > **signupWorkspaceId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/account.ts:28](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L28) *** ### stripeCustomerId[​](#stripecustomerid "Direct link to stripeCustomerId") > **stripeCustomerId**: `string` | `null` Defined in: [packages/sdk/src/types/generated/account.ts:31](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L31) *** ### timezone[​](#timezone "Direct link to timezone") > **timezone**: `string` | `null` Defined in: [packages/sdk/src/types/generated/account.ts:33](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L33) *** ### tosAccepted[​](#tosaccepted "Direct link to tosAccepted") > **tosAccepted**: `boolean` Defined in: [packages/sdk/src/types/generated/account.ts:29](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L29) *** ### uuid[​](#uuid "Direct link to uuid") > **uuid**: `string` Defined in: [packages/sdk/src/types/generated/account.ts:17](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L17) --- # Interface: AccountFormData Defined in: [packages/sdk/src/types/account-types.ts:92](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L92) ## Properties[​](#properties "Direct link to Properties") ### locale?[​](#locale "Direct link to locale?") > `optional` **locale**: `string` Defined in: [packages/sdk/src/types/account-types.ts:97](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L97) *** ### name?[​](#name "Direct link to name?") > `optional` **name**: `string` Defined in: [packages/sdk/src/types/account-types.ts:93](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L93) *** ### optedOut?[​](#optedout "Direct link to optedOut?") > `optional` **optedOut**: `boolean` Defined in: [packages/sdk/src/types/account-types.ts:96](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L96) *** ### timezone?[​](#timezone "Direct link to timezone?") > `optional` **timezone**: `string` Defined in: [packages/sdk/src/types/account-types.ts:98](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L98) *** ### tosAccepted?[​](#tosaccepted "Direct link to tosAccepted?") > `optional` **tosAccepted**: `boolean` Defined in: [packages/sdk/src/types/account-types.ts:95](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L95) --- # Interface: AccountLookupResponse Defined in: [packages/sdk/src/types/account-types.ts:443](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L443) ## Properties[​](#properties "Direct link to Properties") ### accountId?[​](#accountid "Direct link to accountId?") > `optional` **accountId**: `number` Defined in: [packages/sdk/src/types/account-types.ts:445](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L445) *** ### accountUuid?[​](#accountuuid "Direct link to accountUuid?") > `optional` **accountUuid**: `string` Defined in: [packages/sdk/src/types/account-types.ts:446](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L446) *** ### found[​](#found "Direct link to found") > **found**: `boolean` Defined in: [packages/sdk/src/types/account-types.ts:444](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L444) *** ### name?[​](#name "Direct link to name?") > `optional` **name**: `string` | `null` Defined in: [packages/sdk/src/types/account-types.ts:447](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L447) --- # Interface: AccountReportItem Defined in: [packages/sdk/src/types/account-types.ts:339](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L339) ## Properties[​](#properties "Direct link to Properties") ### created\_at[​](#created_at "Direct link to created_at") > **created\_at**: `string` Defined in: [packages/sdk/src/types/account-types.ts:345](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L345) *** ### email?[​](#email "Direct link to email?") > `optional` **email**: `string` | `null` Defined in: [packages/sdk/src/types/account-types.ts:342](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L342) *** ### id[​](#id "Direct link to id") > **id**: `number` Defined in: [packages/sdk/src/types/account-types.ts:340](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L340) *** ### name?[​](#name "Direct link to name?") > `optional` **name**: `string` | `null` Defined in: [packages/sdk/src/types/account-types.ts:344](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L344) *** ### organization\_id?[​](#organization_id "Direct link to organization_id?") > `optional` **organization\_id**: `number` | `null` Defined in: [packages/sdk/src/types/account-types.ts:346](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L346) *** ### phone?[​](#phone "Direct link to phone?") > `optional` **phone**: `string` | `null` Defined in: [packages/sdk/src/types/account-types.ts:343](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L343) *** ### uuid[​](#uuid "Direct link to uuid") > **uuid**: `string` Defined in: [packages/sdk/src/types/account-types.ts:341](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L341) --- # Interface: AccountState Defined in: [packages/sdk/src/types/account-types.ts:112](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L112) ## Properties[​](#properties "Direct link to Properties") ### items[​](#items "Direct link to items") > **items**: [`Account`](https://docs.gravityrail.com/sdk/interfaces/Account.md)\[] Defined in: [packages/sdk/src/types/account-types.ts:113](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L113) *** ### page[​](#page "Direct link to page") > **page**: `number` Defined in: [packages/sdk/src/types/account-types.ts:115](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L115) *** ### pageSize[​](#pagesize "Direct link to pageSize") > **pageSize**: `number` Defined in: [packages/sdk/src/types/account-types.ts:116](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L116) *** ### sortBy[​](#sortby "Direct link to sortBy") > **sortBy**: [`AccountSortField`](https://docs.gravityrail.com/sdk/type-aliases/AccountSortField.md) Defined in: [packages/sdk/src/types/account-types.ts:118](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L118) *** ### sortOrder[​](#sortorder "Direct link to sortOrder") > **sortOrder**: [`SortOrder`](https://docs.gravityrail.com/sdk/type-aliases/SortOrder.md) Defined in: [packages/sdk/src/types/account-types.ts:119](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L119) *** ### total[​](#total "Direct link to total") > **total**: `number` Defined in: [packages/sdk/src/types/account-types.ts:114](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L114) *** ### totalPages[​](#totalpages "Direct link to totalPages") > **totalPages**: `number` Defined in: [packages/sdk/src/types/account-types.ts:117](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L117) --- # Interface: AddGroupMemberRequest Defined in: [packages/sdk/src/types/operator-types.ts:192](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/operator-types.ts#L192) ## Properties[​](#properties "Direct link to Properties") ### memberId[​](#memberid "Direct link to memberId") > **memberId**: `number` Defined in: [packages/sdk/src/types/operator-types.ts:193](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/operator-types.ts#L193) *** ### priority?[​](#priority "Direct link to priority?") > `optional` **priority**: `number` Defined in: [packages/sdk/src/types/operator-types.ts:194](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/operator-types.ts#L194) --- # Interface: Address Defined in: [packages/sdk/src/types/generated/organization.ts:12](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L12) Twilio Address resource. ## Properties[​](#properties "Direct link to Properties") ### city[​](#city "Direct link to city") > **city**: `string` Defined in: [packages/sdk/src/types/generated/organization.ts:27](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L27) #### Min Length[​](#min-length "Direct link to Min Length") 1 #### Max Length[​](#max-length "Direct link to Max Length") 50 *** ### customerName[​](#customername "Direct link to customerName") > **customerName**: `string` Defined in: [packages/sdk/src/types/generated/organization.ts:17](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L17) #### Min Length[​](#min-length-1 "Direct link to Min Length") 1 #### Max Length[​](#max-length-1 "Direct link to Max Length") 100 *** ### isoCountry[​](#isocountry "Direct link to isoCountry") > **isoCountry**: `string` Defined in: [packages/sdk/src/types/generated/organization.ts:42](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L42) #### Min Length[​](#min-length-2 "Direct link to Min Length") 2 #### Max Length[​](#max-length-2 "Direct link to Max Length") 2 *** ### postalCode[​](#postalcode "Direct link to postalCode") > **postalCode**: `string` Defined in: [packages/sdk/src/types/generated/organization.ts:37](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L37) #### Min Length[​](#min-length-3 "Direct link to Min Length") 1 #### Max Length[​](#max-length-3 "Direct link to Max Length") 20 *** ### region[​](#region "Direct link to region") > **region**: `string` Defined in: [packages/sdk/src/types/generated/organization.ts:32](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L32) #### Min Length[​](#min-length-4 "Direct link to Min Length") 1 #### Max Length[​](#max-length-4 "Direct link to Max Length") 50 *** ### street[​](#street "Direct link to street") > **street**: `string` Defined in: [packages/sdk/src/types/generated/organization.ts:22](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L22) #### Min Length[​](#min-length-5 "Direct link to Min Length") 1 #### Max Length[​](#max-length-5 "Direct link to Max Length") 100 --- # Interface: AdminBulkWorkflowAccessValidationResponse Defined in: [packages/sdk/src/types/generated/task.ts:58](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L58) Response model for admin cross-workspace workflow access validation. ## Properties[​](#properties "Direct link to Properties") ### totalWarnings[​](#totalwarnings "Direct link to totalWarnings") > **totalWarnings**: `number` Defined in: [packages/sdk/src/types/generated/task.ts:63](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L63) *** ### totalWorkspacesFailed[​](#totalworkspacesfailed "Direct link to totalWorkspacesFailed") > **totalWorkspacesFailed**: `number` Defined in: [packages/sdk/src/types/generated/task.ts:62](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L62) *** ### totalWorkspacesScanned[​](#totalworkspacesscanned "Direct link to totalWorkspacesScanned") > **totalWorkspacesScanned**: `number` Defined in: [packages/sdk/src/types/generated/task.ts:60](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L60) *** ### totalWorkspacesWithGaps[​](#totalworkspaceswithgaps "Direct link to totalWorkspacesWithGaps") > **totalWorkspacesWithGaps**: `number` Defined in: [packages/sdk/src/types/generated/task.ts:61](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L61) *** ### workspaces[​](#workspaces "Direct link to workspaces") > **workspaces**: [`AdminWorkspaceAccessGapSummary`](https://docs.gravityrail.com/sdk/interfaces/AdminWorkspaceAccessGapSummary.md)\[] Defined in: [packages/sdk/src/types/generated/task.ts:59](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L59) --- # Interface: AdminChatDetailResponse Defined in: [packages/sdk/src/types/generated/chat.ts:38](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L38) Chat detail with paginated messages for admin review. ## Properties[​](#properties "Direct link to Properties") ### chat[​](#chat "Direct link to chat") > **chat**: [`AdminChatResponse`](https://docs.gravityrail.com/sdk/interfaces/AdminChatResponse.md) Defined in: [packages/sdk/src/types/generated/chat.ts:39](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L39) *** ### messages[​](#messages "Direct link to messages") > **messages**: `PaginatedResponseOpenAIMessageResponse` Defined in: [packages/sdk/src/types/generated/chat.ts:40](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L40) --- # Interface: AdminChatResponse Defined in: [packages/sdk/src/types/generated/chat.ts:46](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L46) Lightweight chat summary for admin listing. ## Properties[​](#properties "Direct link to Properties") ### archived[​](#archived "Direct link to archived") > **archived**: `boolean` Defined in: [packages/sdk/src/types/generated/chat.ts:54](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L54) *** ### channel[​](#channel "Direct link to channel") > **channel**: `string` Defined in: [packages/sdk/src/types/generated/chat.ts:51](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L51) *** ### chatType[​](#chattype "Direct link to chatType") > **chatType**: `string` Defined in: [packages/sdk/src/types/generated/chat.ts:52](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L52) *** ### createdAt[​](#createdat "Direct link to createdAt") > **createdAt**: `string` Defined in: [packages/sdk/src/types/generated/chat.ts:58](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L58) *** ### id[​](#id "Direct link to id") > **id**: `number` Defined in: [packages/sdk/src/types/generated/chat.ts:47](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L47) *** ### isTest[​](#istest "Direct link to isTest") > **isTest**: `boolean` Defined in: [packages/sdk/src/types/generated/chat.ts:56](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L56) *** ### lastMessageReceivedAt[​](#lastmessagereceivedat "Direct link to lastMessageReceivedAt") > **lastMessageReceivedAt**: `string` | `null` Defined in: [packages/sdk/src/types/generated/chat.ts:60](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L60) *** ### messageCount[​](#messagecount "Direct link to messageCount") > **messageCount**: `number` Defined in: [packages/sdk/src/types/generated/chat.ts:57](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L57) *** ### needsResponse[​](#needsresponse "Direct link to needsResponse") > **needsResponse**: `boolean` Defined in: [packages/sdk/src/types/generated/chat.ts:55](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L55) *** ### ownerMemberId[​](#ownermemberid "Direct link to ownerMemberId") > **ownerMemberId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/chat.ts:62](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L62) *** ### ownerName[​](#ownername "Direct link to ownerName") > **ownerName**: `string` | `null` Defined in: [packages/sdk/src/types/generated/chat.ts:61](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L61) *** ### participants[​](#participants "Direct link to participants") > **participants**: [`ChatParticipantResponse`](https://docs.gravityrail.com/sdk/interfaces/ChatParticipantResponse.md)\[] Defined in: [packages/sdk/src/types/generated/chat.ts:63](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L63) *** ### paused[​](#paused "Direct link to paused") > **paused**: `boolean` Defined in: [packages/sdk/src/types/generated/chat.ts:53](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L53) *** ### summary[​](#summary "Direct link to summary") > **summary**: `string` | `null` Defined in: [packages/sdk/src/types/generated/chat.ts:50](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L50) *** ### title[​](#title "Direct link to title") > **title**: `string` | `null` Defined in: [packages/sdk/src/types/generated/chat.ts:49](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L49) *** ### updatedAt[​](#updatedat "Direct link to updatedAt") > **updatedAt**: `string` Defined in: [packages/sdk/src/types/generated/chat.ts:59](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L59) *** ### uuid[​](#uuid "Direct link to uuid") > **uuid**: `string` Defined in: [packages/sdk/src/types/generated/chat.ts:48](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L48) --- # Interface: AdminChatsOptions Defined in: [packages/sdk/src/types/chat-types.ts:390](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L390) ## Properties[​](#properties "Direct link to Properties") ### archived?[​](#archived "Direct link to archived?") > `optional` **archived**: `boolean` Defined in: [packages/sdk/src/types/chat-types.ts:397](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L397) *** ### channel?[​](#channel "Direct link to channel?") > `optional` **channel**: `string` Defined in: [packages/sdk/src/types/chat-types.ts:395](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L395) *** ### chatType?[​](#chattype "Direct link to chatType?") > `optional` **chatType**: `string` Defined in: [packages/sdk/src/types/chat-types.ts:396](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L396) *** ### memberId?[​](#memberid "Direct link to memberId?") > `optional` **memberId**: `number` Defined in: [packages/sdk/src/types/chat-types.ts:394](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L394) *** ### page?[​](#page "Direct link to page?") > `optional` **page**: `number` Defined in: [packages/sdk/src/types/chat-types.ts:391](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L391) *** ### pageSize?[​](#pagesize "Direct link to pageSize?") > `optional` **pageSize**: `number` Defined in: [packages/sdk/src/types/chat-types.ts:392](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L392) *** ### search?[​](#search "Direct link to search?") > `optional` **search**: `string` Defined in: [packages/sdk/src/types/chat-types.ts:393](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L393) --- # Interface: AdminPidsFindingResponse Defined in: [packages/sdk/src/types/pids-types.ts:14](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/pids-types.ts#L14) A single prompt-injection finding, as returned by the admin API. ## Properties[​](#properties "Direct link to Properties") ### attackCategories[​](#attackcategories "Direct link to attackCategories") > **attackCategories**: `Record`<`string`, `number`> Defined in: [packages/sdk/src/types/pids-types.ts:22](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/pids-types.ts#L22) Per-category combined confidence (0..1). *** ### channel[​](#channel "Direct link to channel") > **channel**: `string` Defined in: [packages/sdk/src/types/pids-types.ts:20](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/pids-types.ts#L20) *** ### chatId[​](#chatid "Direct link to chatId") > **chatId**: `number` | `null` Defined in: [packages/sdk/src/types/pids-types.ts:18](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/pids-types.ts#L18) *** ### confidence[​](#confidence "Direct link to confidence") > **confidence**: `number` Defined in: [packages/sdk/src/types/pids-types.ts:23](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/pids-types.ts#L23) *** ### createdAt[​](#createdat "Direct link to createdAt") > **createdAt**: `string` Defined in: [packages/sdk/src/types/pids-types.ts:36](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/pids-types.ts#L36) *** ### detectorVersion[​](#detectorversion "Direct link to detectorVersion") > **detectorVersion**: `string` Defined in: [packages/sdk/src/types/pids-types.ts:29](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/pids-types.ts#L29) *** ### id[​](#id "Direct link to id") > **id**: `number` Defined in: [packages/sdk/src/types/pids-types.ts:15](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/pids-types.ts#L15) *** ### langfuseTraceId[​](#langfusetraceid "Direct link to langfuseTraceId") > **langfuseTraceId**: `string` Defined in: [packages/sdk/src/types/pids-types.ts:16](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/pids-types.ts#L16) *** ### memberId[​](#memberid "Direct link to memberId") > **memberId**: `number` | `null` Defined in: [packages/sdk/src/types/pids-types.ts:19](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/pids-types.ts#L19) *** ### reviewedAt[​](#reviewedat "Direct link to reviewedAt") > **reviewedAt**: `string` | `null` Defined in: [packages/sdk/src/types/pids-types.ts:32](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/pids-types.ts#L32) *** ### reviewedByMemberId[​](#reviewedbymemberid "Direct link to reviewedByMemberId") > **reviewedByMemberId**: `number` | `null` Defined in: [packages/sdk/src/types/pids-types.ts:33](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/pids-types.ts#L33) *** ### reviewerDisposition[​](#reviewerdisposition "Direct link to reviewerDisposition") > **reviewerDisposition**: `"true_positive"` | `"false_positive"` | `"needs_more_context"` | `null` Defined in: [packages/sdk/src/types/pids-types.ts:34](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/pids-types.ts#L34) *** ### source[​](#source "Direct link to source") > **source**: `"scheduled"` | `"backfill"` | `"pre_llm"` Defined in: [packages/sdk/src/types/pids-types.ts:31](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/pids-types.ts#L31) scheduled | backfill | pre\_llm. *** ### stage1MatchedPatterns[​](#stage1matchedpatterns "Direct link to stage1MatchedPatterns") > **stage1MatchedPatterns**: `string`\[] Defined in: [packages/sdk/src/types/pids-types.ts:25](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/pids-types.ts#L25) Stage-1 rule names that matched (never raw matched text). *** ### stage2Status[​](#stage2status "Direct link to stage2Status") > **stage2Status**: `string` Defined in: [packages/sdk/src/types/pids-types.ts:28](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/pids-types.ts#L28) *** ### stage2Verdict[​](#stage2verdict "Direct link to stage2Verdict") > **stage2Verdict**: `Record`<`string`, `unknown`> | `null` Defined in: [packages/sdk/src/types/pids-types.ts:27](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/pids-types.ts#L27) Stage-2 LLM judge verdict (per-category quoted spans = PHI). *** ### wazuhEmittedAt[​](#wazuhemittedat "Direct link to wazuhEmittedAt") > **wazuhEmittedAt**: `string` | `null` Defined in: [packages/sdk/src/types/pids-types.ts:35](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/pids-types.ts#L35) *** ### workspaceUuid[​](#workspaceuuid "Direct link to workspaceUuid") > **workspaceUuid**: `string` Defined in: [packages/sdk/src/types/pids-types.ts:17](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/pids-types.ts#L17) --- # Interface: AdminWorkspaceAccessGapSummary Defined in: [packages/sdk/src/types/generated/task.ts:69](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L69) Access gap summary for a single workspace in admin cross-workspace validation. ## Properties[​](#properties "Direct link to Properties") ### totalWarnings[​](#totalwarnings "Direct link to totalWarnings") > **totalWarnings**: `number` Defined in: [packages/sdk/src/types/generated/task.ts:73](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L73) *** ### workflows[​](#workflows "Direct link to workflows") > **workflows**: [`WorkflowAccessGapSummary`](https://docs.gravityrail.com/sdk/interfaces/WorkflowAccessGapSummary.md)\[] Defined in: [packages/sdk/src/types/generated/task.ts:72](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L72) *** ### workspaceName[​](#workspacename "Direct link to workspaceName") > **workspaceName**: `string` Defined in: [packages/sdk/src/types/generated/task.ts:71](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L71) *** ### workspaceUuid[​](#workspaceuuid "Direct link to workspaceUuid") > **workspaceUuid**: `string` Defined in: [packages/sdk/src/types/generated/task.ts:70](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L70) --- # Interface: AgentChatParticipant Defined in: [packages/sdk/src/types/chat-types.ts:137](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L137) ## Properties[​](#properties "Direct link to Properties") ### chatModel?[​](#chatmodel "Direct link to chatModel?") > `optional` **chatModel**: `string` Defined in: [packages/sdk/src/types/chat-types.ts:141](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L141) *** ### memberId?[​](#memberid "Direct link to memberId?") > `optional` **memberId**: `number` Defined in: [packages/sdk/src/types/chat-types.ts:140](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L140) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/chat-types.ts:138](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L138) *** ### realtimeModel?[​](#realtimemodel "Direct link to realtimeModel?") > `optional` **realtimeModel**: `string` Defined in: [packages/sdk/src/types/chat-types.ts:142](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L142) *** ### role[​](#role "Direct link to role") > **role**: `"assistant"` Defined in: [packages/sdk/src/types/chat-types.ts:139](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L139) --- # Interface: AgentConfigFormData Defined in: [packages/sdk/src/types/member-types.ts:207](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L207) ## Properties[​](#properties "Direct link to Properties") ### chatModelConfig?[​](#chatmodelconfig "Direct link to chatModelConfig?") > `optional` **chatModelConfig**: `Record`<`string`, `unknown`> Defined in: [packages/sdk/src/types/member-types.ts:209](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L209) *** ### chatModelId?[​](#chatmodelid "Direct link to chatModelId?") > `optional` **chatModelId**: `string` Defined in: [packages/sdk/src/types/member-types.ts:208](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L208) *** ### codeInterpreterEnabled?[​](#codeinterpreterenabled "Direct link to codeInterpreterEnabled?") > `optional` **codeInterpreterEnabled**: `boolean` Defined in: [packages/sdk/src/types/member-types.ts:215](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L215) *** ### maxDailyActions?[​](#maxdailyactions "Direct link to maxDailyActions?") > `optional` **maxDailyActions**: `number` Defined in: [packages/sdk/src/types/member-types.ts:213](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L213) *** ### memoryConfig?[​](#memoryconfig "Direct link to memoryConfig?") > `optional` **memoryConfig**: [`AgentMemoryConfig`](https://docs.gravityrail.com/sdk/interfaces/AgentMemoryConfig.md) Defined in: [packages/sdk/src/types/member-types.ts:216](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L216) *** ### realtimeModelConfig?[​](#realtimemodelconfig "Direct link to realtimeModelConfig?") > `optional` **realtimeModelConfig**: `Record`<`string`, `unknown`> Defined in: [packages/sdk/src/types/member-types.ts:211](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L211) *** ### realtimeModelId?[​](#realtimemodelid "Direct link to realtimeModelId?") > `optional` **realtimeModelId**: `string` Defined in: [packages/sdk/src/types/member-types.ts:210](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L210) *** ### systemPrompt?[​](#systemprompt "Direct link to systemPrompt?") > `optional` **systemPrompt**: `string` Defined in: [packages/sdk/src/types/member-types.ts:212](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L212) *** ### tools?[​](#tools "Direct link to tools?") > `optional` **tools**: `string`\[] Defined in: [packages/sdk/src/types/member-types.ts:214](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L214) --- # Interface: AgentConfigResponse Defined in: [packages/sdk/src/types/generated/member.ts:11](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L11) Response model for agent configuration. ## Properties[​](#properties "Direct link to Properties") ### chatModelConfig?[​](#chatmodelconfig "Direct link to chatModelConfig?") > `optional` **chatModelConfig**: `AgentConfigResponseChatModelConfig` Defined in: [packages/sdk/src/types/generated/member.ts:14](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L14) *** ### chatModelId[​](#chatmodelid "Direct link to chatModelId") > **chatModelId**: `string` Defined in: [packages/sdk/src/types/generated/member.ts:13](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L13) *** ### codeInterpreterEnabled?[​](#codeinterpreterenabled "Direct link to codeInterpreterEnabled?") > `optional` **codeInterpreterEnabled**: `boolean` Defined in: [packages/sdk/src/types/generated/member.ts:20](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L20) *** ### createdAt[​](#createdat "Direct link to createdAt") > **createdAt**: `string` Defined in: [packages/sdk/src/types/generated/member.ts:22](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L22) *** ### id[​](#id "Direct link to id") > **id**: `number` Defined in: [packages/sdk/src/types/generated/member.ts:12](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L12) *** ### maxDailyActions?[​](#maxdailyactions "Direct link to maxDailyActions?") > `optional` **maxDailyActions**: `number` | `null` Defined in: [packages/sdk/src/types/generated/member.ts:18](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L18) *** ### memoryConfig?[​](#memoryconfig "Direct link to memoryConfig?") > `optional` **memoryConfig**: `AgentConfigResponseMemoryConfig` Defined in: [packages/sdk/src/types/generated/member.ts:21](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L21) *** ### realtimeModelConfig?[​](#realtimemodelconfig "Direct link to realtimeModelConfig?") > `optional` **realtimeModelConfig**: `AgentConfigResponseRealtimeModelConfig` Defined in: [packages/sdk/src/types/generated/member.ts:16](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L16) *** ### realtimeModelId?[​](#realtimemodelid "Direct link to realtimeModelId?") > `optional` **realtimeModelId**: `string` | `null` Defined in: [packages/sdk/src/types/generated/member.ts:15](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L15) *** ### systemPrompt[​](#systemprompt "Direct link to systemPrompt") > **systemPrompt**: `string` Defined in: [packages/sdk/src/types/generated/member.ts:17](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L17) *** ### tools?[​](#tools "Direct link to tools?") > `optional` **tools**: `string`\[] | `null` Defined in: [packages/sdk/src/types/generated/member.ts:19](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L19) *** ### updatedAt[​](#updatedat "Direct link to updatedAt") > **updatedAt**: `string` Defined in: [packages/sdk/src/types/generated/member.ts:23](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L23) --- # Interface: AgentExport Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:43](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L43) ## Properties[​](#properties "Direct link to Properties") ### chatModel?[​](#chatmodel "Direct link to chatModel?") > `optional` **chatModel**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:48](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L48) *** ### description?[​](#description "Direct link to description?") > `optional` **description**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:46](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L46) *** ### identity?[​](#identity "Direct link to identity?") > `optional` **identity**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:47](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L47) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:45](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L45) *** ### realtimeModel?[​](#realtimemodel "Direct link to realtimeModel?") > `optional` **realtimeModel**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:49](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L49) *** ### ttsModel?[​](#ttsmodel "Direct link to ttsModel?") > `optional` **ttsModel**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:50](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L50) *** ### uuid[​](#uuid "Direct link to uuid") > **uuid**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:44](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L44) *** ### voice?[​](#voice "Direct link to voice?") > `optional` **voice**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:51](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L51) --- # Interface: AgentMemoryConfig Defined in: [packages/sdk/src/types/member-types.ts:103](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L103) ## Properties[​](#properties "Direct link to Properties") ### enabled?[​](#enabled "Direct link to enabled?") > `optional` **enabled**: `boolean` Defined in: [packages/sdk/src/types/member-types.ts:104](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L104) *** ### episodic?[​](#episodic "Direct link to episodic?") > `optional` **episodic**: `boolean` Defined in: [packages/sdk/src/types/member-types.ts:110](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L110) *** ### preferences?[​](#preferences "Direct link to preferences?") > `optional` **preferences**: `boolean` Defined in: [packages/sdk/src/types/member-types.ts:107](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L107) *** ### read?[​](#read "Direct link to read?") > `optional` **read**: `boolean` Defined in: [packages/sdk/src/types/member-types.ts:105](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L105) *** ### semantic?[​](#semantic "Direct link to semantic?") > `optional` **semantic**: `boolean` Defined in: [packages/sdk/src/types/member-types.ts:108](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L108) *** ### summaries?[​](#summaries "Direct link to summaries?") > `optional` **summaries**: `boolean` Defined in: [packages/sdk/src/types/member-types.ts:109](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L109) *** ### write?[​](#write "Direct link to write?") > `optional` **write**: `boolean` Defined in: [packages/sdk/src/types/member-types.ts:106](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L106) --- # Interface: AgentResponse Defined in: [packages/sdk/src/types/generated/member.ts:38](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L38) Response model for an agent (Member + agent config via JTI). Agents are first-class members that can communicate via DMs, email, SMS, and voice. They have their own identity (name, description) and AI configuration (model, system prompt). ## Properties[​](#properties "Direct link to Properties") ### config[​](#config "Direct link to config") > **config**: [`AgentConfigResponse`](https://docs.gravityrail.com/sdk/interfaces/AgentConfigResponse.md) Defined in: [packages/sdk/src/types/generated/member.ts:55](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L55) *** ### createdAt[​](#createdat "Direct link to createdAt") > **createdAt**: `string` Defined in: [packages/sdk/src/types/generated/member.ts:52](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L52) *** ### description?[​](#description "Direct link to description?") > `optional` **description**: `string` | `null` Defined in: [packages/sdk/src/types/generated/member.ts:42](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L42) *** ### email?[​](#email "Direct link to email?") > `optional` **email**: `string` | `null` Defined in: [packages/sdk/src/types/generated/member.ts:43](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L43) *** ### externalId?[​](#externalid "Direct link to externalId?") > `optional` **externalId**: `string` | `null` Defined in: [packages/sdk/src/types/generated/member.ts:45](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L45) *** ### id[​](#id "Direct link to id") > **id**: `number` Defined in: [packages/sdk/src/types/generated/member.ts:39](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L39) *** ### isArchived?[​](#isarchived "Direct link to isArchived?") > `optional` **isArchived**: `boolean` Defined in: [packages/sdk/src/types/generated/member.ts:49](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L49) *** ### labels?[​](#labels "Direct link to labels?") > `optional` **labels**: [`MemberLabelResponse`](https://docs.gravityrail.com/sdk/interfaces/MemberLabelResponse.md)\[] Defined in: [packages/sdk/src/types/generated/member.ts:54](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L54) *** ### memberRoleId[​](#memberroleid "Direct link to memberRoleId") > **memberRoleId**: `number` Defined in: [packages/sdk/src/types/generated/member.ts:46](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L46) *** ### memberRoleName?[​](#memberrolename "Direct link to memberRoleName?") > `optional` **memberRoleName**: `string` | `null` Defined in: [packages/sdk/src/types/generated/member.ts:47](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L47) *** ### memberType?[​](#membertype "Direct link to memberType?") > `optional` **memberType**: `string` Defined in: [packages/sdk/src/types/generated/member.ts:48](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L48) *** ### name?[​](#name "Direct link to name?") > `optional` **name**: `string` | `null` Defined in: [packages/sdk/src/types/generated/member.ts:41](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L41) *** ### ownerId?[​](#ownerid "Direct link to ownerId?") > `optional` **ownerId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/member.ts:50](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L50) *** ### ownerName?[​](#ownername "Direct link to ownerName?") > `optional` **ownerName**: `string` | `null` Defined in: [packages/sdk/src/types/generated/member.ts:51](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L51) *** ### phone?[​](#phone "Direct link to phone?") > `optional` **phone**: `string` | `null` Defined in: [packages/sdk/src/types/generated/member.ts:44](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L44) *** ### updatedAt[​](#updatedat "Direct link to updatedAt") > **updatedAt**: `string` Defined in: [packages/sdk/src/types/generated/member.ts:53](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L53) *** ### uuid[​](#uuid "Direct link to uuid") > **uuid**: `string` Defined in: [packages/sdk/src/types/generated/member.ts:40](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L40) --- # Interface: AIModelsResponse Defined in: [packages/sdk/src/types/generated/ai\_model.ts:42](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/ai_model.ts#L42) Response model for chat models list. ## Properties[​](#properties "Direct link to Properties") ### models[​](#models "Direct link to models") > **models**: [`ChatModelResponse`](https://docs.gravityrail.com/sdk/interfaces/ChatModelResponse.md)\[] Defined in: [packages/sdk/src/types/generated/ai\_model.ts:43](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/ai_model.ts#L43) --- # Interface: AIModelUsageResponse Defined in: [packages/sdk/src/types/generated/usage.ts:11](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/usage.ts#L11) AI model usage breakdown response. ## Properties[​](#properties "Direct link to Properties") ### cachedMultiplier?[​](#cachedmultiplier "Direct link to cachedMultiplier?") > `optional` **cachedMultiplier**: `number` | `null` Defined in: [packages/sdk/src/types/generated/usage.ts:18](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/usage.ts#L18) *** ### credits[​](#credits "Direct link to credits") > **credits**: `number` Defined in: [packages/sdk/src/types/generated/usage.ts:14](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/usage.ts#L14) *** ### inputMultiplier?[​](#inputmultiplier "Direct link to inputMultiplier?") > `optional` **inputMultiplier**: `number` | `null` Defined in: [packages/sdk/src/types/generated/usage.ts:16](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/usage.ts#L16) *** ### messageCount[​](#messagecount "Direct link to messageCount") > **messageCount**: `number` Defined in: [packages/sdk/src/types/generated/usage.ts:19](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/usage.ts#L19) *** ### modelId[​](#modelid "Direct link to modelId") > **modelId**: `string` Defined in: [packages/sdk/src/types/generated/usage.ts:12](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/usage.ts#L12) *** ### multiplier[​](#multiplier "Direct link to multiplier") > **multiplier**: `number` Defined in: [packages/sdk/src/types/generated/usage.ts:15](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/usage.ts#L15) *** ### outputMultiplier?[​](#outputmultiplier "Direct link to outputMultiplier?") > `optional` **outputMultiplier**: `number` | `null` Defined in: [packages/sdk/src/types/generated/usage.ts:17](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/usage.ts#L17) *** ### rawTokens[​](#rawtokens "Direct link to rawTokens") > **rawTokens**: `number` Defined in: [packages/sdk/src/types/generated/usage.ts:13](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/usage.ts#L13) --- # Interface: AIUsageDetailsResponse Defined in: [packages/sdk/src/types/generated/usage.ts:25](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/usage.ts#L25) AI usage details response. ## Properties[​](#properties "Direct link to Properties") ### chat[​](#chat "Direct link to chat") > **chat**: `number` Defined in: [packages/sdk/src/types/generated/usage.ts:27](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/usage.ts#L27) *** ### image[​](#image "Direct link to image") > **image**: `number` Defined in: [packages/sdk/src/types/generated/usage.ts:29](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/usage.ts#L29) *** ### models[​](#models "Direct link to models") > **models**: [`AIModelUsageResponse`](https://docs.gravityrail.com/sdk/interfaces/AIModelUsageResponse.md)\[] Defined in: [packages/sdk/src/types/generated/usage.ts:31](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/usage.ts#L31) *** ### realtime[​](#realtime "Direct link to realtime") > **realtime**: `number` Defined in: [packages/sdk/src/types/generated/usage.ts:28](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/usage.ts#L28) *** ### total[​](#total "Direct link to total") > **total**: `number` Defined in: [packages/sdk/src/types/generated/usage.ts:26](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/usage.ts#L26) *** ### video[​](#video "Direct link to video") > **video**: `number` Defined in: [packages/sdk/src/types/generated/usage.ts:30](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/usage.ts#L30) --- # Interface: AIUsageReport Defined in: [packages/sdk/src/types/generated/reports.ts:12](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/reports.ts#L12) Complete AI usage report for a workspace. ## Properties[​](#properties "Direct link to Properties") ### byProvider[​](#byprovider "Direct link to byProvider") > **byProvider**: [`ProviderUsageSummary`](https://docs.gravityrail.com/sdk/interfaces/ProviderUsageSummary.md)\[] Defined in: [packages/sdk/src/types/generated/reports.ts:23](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/reports.ts#L23) *** ### byType[​](#bytype "Direct link to byType") > **byType**: `Partial`<`Record`<[`ModelType`](https://docs.gravityrail.com/sdk/type-aliases/ModelType.md), `AIUsageTypeSummary`>> Defined in: [packages/sdk/src/types/generated/reports.ts:24](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/reports.ts#L24) *** ### reportPeriodEnd[​](#reportperiodend "Direct link to reportPeriodEnd") > **reportPeriodEnd**: `string` Defined in: [packages/sdk/src/types/generated/reports.ts:16](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/reports.ts#L16) *** ### reportPeriodStart[​](#reportperiodstart "Direct link to reportPeriodStart") > **reportPeriodStart**: `string` Defined in: [packages/sdk/src/types/generated/reports.ts:15](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/reports.ts#L15) *** ### topModels[​](#topmodels "Direct link to topModels") > **topModels**: [`ModelUsageStats`](https://docs.gravityrail.com/sdk/interfaces/ModelUsageStats.md)\[] Defined in: [packages/sdk/src/types/generated/reports.ts:25](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/reports.ts#L25) *** ### totalAudioInputTokens?[​](#totalaudioinputtokens "Direct link to totalAudioInputTokens?") > `optional` **totalAudioInputTokens**: `number` Defined in: [packages/sdk/src/types/generated/reports.ts:20](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/reports.ts#L20) *** ### totalAudioOutputTokens?[​](#totalaudiooutputtokens "Direct link to totalAudioOutputTokens?") > `optional` **totalAudioOutputTokens**: `number` Defined in: [packages/sdk/src/types/generated/reports.ts:21](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/reports.ts#L21) *** ### totalCachedTokens[​](#totalcachedtokens "Direct link to totalCachedTokens") > **totalCachedTokens**: `number` Defined in: [packages/sdk/src/types/generated/reports.ts:19](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/reports.ts#L19) *** ### totalCredits[​](#totalcredits "Direct link to totalCredits") > **totalCredits**: `number` Defined in: [packages/sdk/src/types/generated/reports.ts:22](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/reports.ts#L22) *** ### totalMessages[​](#totalmessages "Direct link to totalMessages") > **totalMessages**: `number` Defined in: [packages/sdk/src/types/generated/reports.ts:17](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/reports.ts#L17) *** ### totalTokens[​](#totaltokens "Direct link to totalTokens") > **totalTokens**: `number` Defined in: [packages/sdk/src/types/generated/reports.ts:18](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/reports.ts#L18) *** ### workspaceId[​](#workspaceid "Direct link to workspaceId") > **workspaceId**: `string` Defined in: [packages/sdk/src/types/generated/reports.ts:13](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/reports.ts#L13) *** ### workspaceName[​](#workspacename "Direct link to workspaceName") > **workspaceName**: `string` Defined in: [packages/sdk/src/types/generated/reports.ts:14](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/reports.ts#L14) --- # Interface: AIUsageReportParams Defined in: [packages/sdk/src/api/reports.ts:34](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/reports.ts#L34) ## Properties[​](#properties "Direct link to Properties") ### end\_date?[​](#end_date "Direct link to end_date?") > `optional` **end\_date**: `string` Defined in: [packages/sdk/src/api/reports.ts:36](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/reports.ts#L36) *** ### start\_date?[​](#start_date "Direct link to start_date?") > `optional` **start\_date**: `string` Defined in: [packages/sdk/src/api/reports.ts:35](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/reports.ts#L35) --- # Interface: AllModelsResponse Defined in: [packages/sdk/src/types/generated/ai\_model.ts:11](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/ai_model.ts#L11) Response model for all models combined. ## Properties[​](#properties "Direct link to Properties") ### chat[​](#chat "Direct link to chat") > **chat**: [`ModelMetadataResponse`](https://docs.gravityrail.com/sdk/interfaces/ModelMetadataResponse.md)\[] Defined in: [packages/sdk/src/types/generated/ai\_model.ts:12](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/ai_model.ts#L12) *** ### image[​](#image "Direct link to image") > **image**: [`ModelMetadataResponse`](https://docs.gravityrail.com/sdk/interfaces/ModelMetadataResponse.md)\[] Defined in: [packages/sdk/src/types/generated/ai\_model.ts:14](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/ai_model.ts#L14) *** ### realtime[​](#realtime "Direct link to realtime") > **realtime**: [`ModelMetadataResponse`](https://docs.gravityrail.com/sdk/interfaces/ModelMetadataResponse.md)\[] Defined in: [packages/sdk/src/types/generated/ai\_model.ts:13](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/ai_model.ts#L13) *** ### stt[​](#stt "Direct link to stt") > **stt**: [`ModelMetadataResponse`](https://docs.gravityrail.com/sdk/interfaces/ModelMetadataResponse.md)\[] Defined in: [packages/sdk/src/types/generated/ai\_model.ts:15](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/ai_model.ts#L15) *** ### tts[​](#tts "Direct link to tts") > **tts**: [`ModelMetadataResponse`](https://docs.gravityrail.com/sdk/interfaces/ModelMetadataResponse.md)\[] Defined in: [packages/sdk/src/types/generated/ai\_model.ts:16](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/ai_model.ts#L16) --- # Interface: AnalyticsFilter Defined in: [packages/sdk/src/types/stats-types.ts:49](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/stats-types.ts#L49) ## Properties[​](#properties "Direct link to Properties") ### dataTypeIds?[​](#datatypeids "Direct link to dataTypeIds?") > `optional` **dataTypeIds**: `number`\[] Defined in: [packages/sdk/src/types/stats-types.ts:57](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/stats-types.ts#L57) *** ### dateRange?[​](#daterange "Direct link to dateRange?") > `optional` **dateRange**: `object` Defined in: [packages/sdk/src/types/stats-types.ts:50](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/stats-types.ts#L50) #### end[​](#end "Direct link to end") > **end**: `string` #### start[​](#start "Direct link to start") > **start**: `string` *** ### memberIds?[​](#memberids "Direct link to memberIds?") > `optional` **memberIds**: `number`\[] Defined in: [packages/sdk/src/types/stats-types.ts:54](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/stats-types.ts#L54) *** ### siteIds?[​](#siteids "Direct link to siteIds?") > `optional` **siteIds**: `number`\[] Defined in: [packages/sdk/src/types/stats-types.ts:56](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/stats-types.ts#L56) *** ### taskIds?[​](#taskids "Direct link to taskIds?") > `optional` **taskIds**: `number`\[] Defined in: [packages/sdk/src/types/stats-types.ts:55](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/stats-types.ts#L55) --- # Interface: AnalyticsQuery Defined in: [packages/sdk/src/types/stats-types.ts:60](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/stats-types.ts#L60) ## Properties[​](#properties "Direct link to Properties") ### filters?[​](#filters "Direct link to filters?") > `optional` **filters**: [`AnalyticsFilter`](https://docs.gravityrail.com/sdk/interfaces/AnalyticsFilter.md) Defined in: [packages/sdk/src/types/stats-types.ts:61](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/stats-types.ts#L61) *** ### groupBy?[​](#groupby "Direct link to groupBy?") > `optional` **groupBy**: `"site"` | `"member"` | `"day"` | `"week"` | `"month"` | `"task"` | `"year"` Defined in: [packages/sdk/src/types/stats-types.ts:62](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/stats-types.ts#L62) *** ### limit?[​](#limit "Direct link to limit?") > `optional` **limit**: `number` Defined in: [packages/sdk/src/types/stats-types.ts:65](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/stats-types.ts#L65) *** ### offset?[​](#offset "Direct link to offset?") > `optional` **offset**: `number` Defined in: [packages/sdk/src/types/stats-types.ts:66](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/stats-types.ts#L66) *** ### sortBy?[​](#sortby "Direct link to sortBy?") > `optional` **sortBy**: `string` Defined in: [packages/sdk/src/types/stats-types.ts:63](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/stats-types.ts#L63) *** ### sortOrder?[​](#sortorder "Direct link to sortOrder?") > `optional` **sortOrder**: [`SortOrder`](https://docs.gravityrail.com/sdk/type-aliases/SortOrder.md) Defined in: [packages/sdk/src/types/stats-types.ts:64](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/stats-types.ts#L64) --- # Interface: AnonymousInteractionResponse Defined in: [packages/sdk/src/types/generated/member.ts:61](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L61) Summary of the anonymous member's interaction (usually a single call). ## Properties[​](#properties "Direct link to Properties") ### callCreatedAt[​](#callcreatedat "Direct link to callCreatedAt") > **callCreatedAt**: `string` | `null` Defined in: [packages/sdk/src/types/generated/member.ts:67](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L67) *** ### callDurationSeconds[​](#calldurationseconds "Direct link to callDurationSeconds") > **callDurationSeconds**: `number` | `null` Defined in: [packages/sdk/src/types/generated/member.ts:68](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L68) *** ### callId[​](#callid "Direct link to callId") > **callId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/member.ts:65](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L65) *** ### callStatus[​](#callstatus "Direct link to callStatus") > **callStatus**: `string` | `null` Defined in: [packages/sdk/src/types/generated/member.ts:66](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L66) *** ### chatId[​](#chatid "Direct link to chatId") > **chatId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/member.ts:62](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L62) *** ### chatSummary[​](#chatsummary "Direct link to chatSummary") > **chatSummary**: `string` | `null` Defined in: [packages/sdk/src/types/generated/member.ts:64](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L64) *** ### chatTitle[​](#chattitle "Direct link to chatTitle") > **chatTitle**: `string` | `null` Defined in: [packages/sdk/src/types/generated/member.ts:63](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L63) --- # Interface: AnonymousMemberResolutionResponse Defined in: [packages/sdk/src/types/generated/member.ts:74](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L74) Response model for anonymous member resolution records. ## Properties[​](#properties "Direct link to Properties") ### anonymousMemberId[​](#anonymousmemberid "Direct link to anonymousMemberId") > **anonymousMemberId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/member.ts:76](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L76) *** ### anonymousMemberName[​](#anonymousmembername "Direct link to anonymousMemberName") > **anonymousMemberName**: `string` | `null` Defined in: [packages/sdk/src/types/generated/member.ts:77](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L77) *** ### createdAt[​](#createdat "Direct link to createdAt") > **createdAt**: `string` Defined in: [packages/sdk/src/types/generated/member.ts:86](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L86) *** ### id[​](#id "Direct link to id") > **id**: `number` Defined in: [packages/sdk/src/types/generated/member.ts:75](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L75) *** ### identifierType[​](#identifiertype "Direct link to identifierType") > **identifierType**: `string` Defined in: [packages/sdk/src/types/generated/member.ts:78](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L78) *** ### identifierValue[​](#identifiervalue "Direct link to identifierValue") > **identifierValue**: `string` Defined in: [packages/sdk/src/types/generated/member.ts:79](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L79) *** ### interaction[​](#interaction "Direct link to interaction") > **interaction**: [`AnonymousInteractionResponse`](https://docs.gravityrail.com/sdk/interfaces/AnonymousInteractionResponse.md) | `null` Defined in: [packages/sdk/src/types/generated/member.ts:88](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L88) *** ### resolutionNotes[​](#resolutionnotes "Direct link to resolutionNotes") > **resolutionNotes**: `string` | `null` Defined in: [packages/sdk/src/types/generated/member.ts:85](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L85) *** ### resolvedAt[​](#resolvedat "Direct link to resolvedAt") > **resolvedAt**: `string` | `null` Defined in: [packages/sdk/src/types/generated/member.ts:87](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L87) *** ### resolvedByMemberId[​](#resolvedbymemberid "Direct link to resolvedByMemberId") > **resolvedByMemberId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/member.ts:83](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L83) *** ### resolvedByMemberName[​](#resolvedbymembername "Direct link to resolvedByMemberName") > **resolvedByMemberName**: `string` | `null` Defined in: [packages/sdk/src/types/generated/member.ts:84](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L84) *** ### resolvedToMemberId[​](#resolvedtomemberid "Direct link to resolvedToMemberId") > **resolvedToMemberId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/member.ts:81](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L81) *** ### resolvedToMemberName[​](#resolvedtomembername "Direct link to resolvedToMemberName") > **resolvedToMemberName**: `string` | `null` Defined in: [packages/sdk/src/types/generated/member.ts:82](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L82) *** ### status[​](#status "Direct link to status") > **status**: `string` Defined in: [packages/sdk/src/types/generated/member.ts:80](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L80) --- # Interface: ApiKey Defined in: [packages/sdk/src/types/generated/account.ts:148](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L148) Response model for API key information. ## Properties[​](#properties "Direct link to Properties") ### appId?[​](#appid "Direct link to appId?") > `optional` **appId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/account.ts:158](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L158) *** ### createdAt[​](#createdat "Direct link to createdAt") > **createdAt**: `string` Defined in: [packages/sdk/src/types/generated/account.ts:153](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L153) *** ### enabled[​](#enabled "Direct link to enabled") > **enabled**: `boolean` Defined in: [packages/sdk/src/types/generated/account.ts:156](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L156) *** ### expiresAt?[​](#expiresat "Direct link to expiresAt?") > `optional` **expiresAt**: `string` | `null` Defined in: [packages/sdk/src/types/generated/account.ts:154](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L154) *** ### id[​](#id "Direct link to id") > **id**: `number` Defined in: [packages/sdk/src/types/generated/account.ts:149](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L149) *** ### keyPrefix[​](#keyprefix "Direct link to keyPrefix") > **keyPrefix**: `string` Defined in: [packages/sdk/src/types/generated/account.ts:152](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L152) *** ### lastUsedAt?[​](#lastusedat "Direct link to lastUsedAt?") > `optional` **lastUsedAt**: `string` | `null` Defined in: [packages/sdk/src/types/generated/account.ts:155](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L155) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/generated/account.ts:151](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L151) *** ### scopes[​](#scopes "Direct link to scopes") > **scopes**: `string`\[] Defined in: [packages/sdk/src/types/generated/account.ts:157](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L157) *** ### uuid[​](#uuid "Direct link to uuid") > **uuid**: `string` Defined in: [packages/sdk/src/types/generated/account.ts:150](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L150) --- # Interface: ApiKeyCreated Defined in: [packages/sdk/src/types/generated/account.ts:131](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L131) Response model for when a new API key is created, including the full key. ## Properties[​](#properties "Direct link to Properties") ### appId?[​](#appid "Direct link to appId?") > `optional` **appId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/account.ts:141](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L141) *** ### createdAt[​](#createdat "Direct link to createdAt") > **createdAt**: `string` Defined in: [packages/sdk/src/types/generated/account.ts:136](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L136) *** ### enabled[​](#enabled "Direct link to enabled") > **enabled**: `boolean` Defined in: [packages/sdk/src/types/generated/account.ts:139](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L139) *** ### expiresAt?[​](#expiresat "Direct link to expiresAt?") > `optional` **expiresAt**: `string` | `null` Defined in: [packages/sdk/src/types/generated/account.ts:137](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L137) *** ### id[​](#id "Direct link to id") > **id**: `number` Defined in: [packages/sdk/src/types/generated/account.ts:132](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L132) *** ### key[​](#key "Direct link to key") > **key**: `string` Defined in: [packages/sdk/src/types/generated/account.ts:142](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L142) *** ### keyPrefix[​](#keyprefix "Direct link to keyPrefix") > **keyPrefix**: `string` Defined in: [packages/sdk/src/types/generated/account.ts:135](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L135) *** ### lastUsedAt?[​](#lastusedat "Direct link to lastUsedAt?") > `optional` **lastUsedAt**: `string` | `null` Defined in: [packages/sdk/src/types/generated/account.ts:138](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L138) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/generated/account.ts:134](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L134) *** ### scopes[​](#scopes "Direct link to scopes") > **scopes**: `string`\[] Defined in: [packages/sdk/src/types/generated/account.ts:140](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L140) *** ### uuid[​](#uuid "Direct link to uuid") > **uuid**: `string` Defined in: [packages/sdk/src/types/generated/account.ts:133](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L133) --- # Interface: ApiKeyFormData Defined in: [packages/sdk/src/types/account-types.ts:209](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L209) ## Properties[​](#properties "Direct link to Properties") ### expiresInDays[​](#expiresindays "Direct link to expiresInDays") > **expiresInDays**: `number` Defined in: [packages/sdk/src/types/account-types.ts:211](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L211) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/account-types.ts:210](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L210) *** ### scopes[​](#scopes "Direct link to scopes") > **scopes**: `string`\[] Defined in: [packages/sdk/src/types/account-types.ts:212](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L212) --- # Interface: ApiKeyScope Defined in: [packages/sdk/src/types/account-types.ts:215](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L215) ## Properties[​](#properties "Direct link to Properties") ### description[​](#description "Direct link to description") > **description**: `string` Defined in: [packages/sdk/src/types/account-types.ts:217](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L217) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/account-types.ts:216](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L216) *** ### value[​](#value "Direct link to value") > **value**: `number` Defined in: [packages/sdk/src/types/account-types.ts:218](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L218) --- # Interface: ApiKeyScopesResponse Defined in: [packages/sdk/src/types/account-types.ts:221](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L221) ## Properties[​](#properties "Direct link to Properties") ### scopes[​](#scopes "Direct link to scopes") > **scopes**: [`ApiKeyScope`](https://docs.gravityrail.com/sdk/interfaces/ApiKeyScope.md)\[] Defined in: [packages/sdk/src/types/account-types.ts:222](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L222) --- # Interface: ApiScope Defined in: [packages/sdk/src/api/oauth.ts:127](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/oauth.ts#L127) ## Properties[​](#properties "Direct link to Properties") ### category[​](#category "Direct link to category") > **category**: `string` Defined in: [packages/sdk/src/api/oauth.ts:129](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/oauth.ts#L129) *** ### dangerous[​](#dangerous "Direct link to dangerous") > **dangerous**: `boolean` Defined in: [packages/sdk/src/api/oauth.ts:132](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/oauth.ts#L132) *** ### description[​](#description "Direct link to description") > **description**: `string` Defined in: [packages/sdk/src/api/oauth.ts:130](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/oauth.ts#L130) *** ### implies[​](#implies "Direct link to implies") > **implies**: `string`\[] Defined in: [packages/sdk/src/api/oauth.ts:131](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/oauth.ts#L131) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/api/oauth.ts:128](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/oauth.ts#L128) --- # Interface: ApiValidationError Defined in: [packages/sdk/src/api/base.ts:27](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/base.ts#L27) Structured validation error returned by the backend's workflow-expression validator (CEL / Jinja schema checks). See WorkflowValidationErrorResponse in workflowValidationTypes.ts for the public-facing shape. ## Properties[​](#properties "Direct link to Properties") ### field[​](#field "Direct link to field") > **field**: `string` Defined in: [packages/sdk/src/api/base.ts:28](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/base.ts#L28) *** ### kind[​](#kind "Direct link to kind") > **kind**: `"cel_syntax"` | `"cel_schema"` | `"jinja_syntax"` | `"jinja_schema"` Defined in: [packages/sdk/src/api/base.ts:29](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/base.ts#L29) *** ### location[​](#location "Direct link to location") > **location**: { `column`: `number`; `end`: `number`; `length`: `number`; `line`: `number`; `start`: `number`; } | `null` Defined in: [packages/sdk/src/api/base.ts:32](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/base.ts#L32) *** ### message[​](#message "Direct link to message") > **message**: `string` Defined in: [packages/sdk/src/api/base.ts:30](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/base.ts#L30) *** ### offendingPath[​](#offendingpath "Direct link to offendingPath") > **offendingPath**: `string` | `null` Defined in: [packages/sdk/src/api/base.ts:31](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/base.ts#L31) *** ### suggestion[​](#suggestion "Direct link to suggestion") > **suggestion**: `string` | `null` Defined in: [packages/sdk/src/api/base.ts:39](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/base.ts#L39) --- # Interface: AppBuilder Defined in: [packages/sdk/src/types/app-types.ts:20](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-types.ts#L20) Builder metadata returned with marketplace apps (OpenAPI emits untyped object). ## Properties[​](#properties "Direct link to Properties") ### avatarUrl?[​](#avatarurl "Direct link to avatarUrl?") > `optional` **avatarUrl**: `string` | `null` Defined in: [packages/sdk/src/types/app-types.ts:22](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-types.ts#L22) *** ### hasAvatar?[​](#hasavatar "Direct link to hasAvatar?") > `optional` **hasAvatar**: `boolean` Defined in: [packages/sdk/src/types/app-types.ts:23](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-types.ts#L23) *** ### isVerified?[​](#isverified "Direct link to isVerified?") > `optional` **isVerified**: `boolean` Defined in: [packages/sdk/src/types/app-types.ts:24](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-types.ts#L24) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/app-types.ts:21](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-types.ts#L21) --- # Interface: AppConnectionAccessInterrupt Defined in: [packages/sdk/src/types/chat-types.ts:362](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L362) ## Properties[​](#properties "Direct link to Properties") ### appType[​](#apptype "Direct link to appType") > **appType**: `string` Defined in: [packages/sdk/src/types/chat-types.ts:365](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L365) *** ### connectionId?[​](#connectionid "Direct link to connectionId?") > `optional` **connectionId**: `string` Defined in: [packages/sdk/src/types/chat-types.ts:366](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L366) *** ### connectionName[​](#connectionname "Direct link to connectionName") > **connectionName**: `string` Defined in: [packages/sdk/src/types/chat-types.ts:367](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L367) *** ### connectionType[​](#connectiontype "Direct link to connectionType") > **connectionType**: `string` Defined in: [packages/sdk/src/types/chat-types.ts:368](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L368) *** ### grantUuid[​](#grantuuid "Direct link to grantUuid") > **grantUuid**: `string` Defined in: [packages/sdk/src/types/chat-types.ts:364](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L364) *** ### hasCredential[​](#hascredential "Direct link to hasCredential") > **hasCredential**: `boolean` Defined in: [packages/sdk/src/types/chat-types.ts:369](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L369) *** ### interruptId?[​](#interruptid "Direct link to interruptId?") > `optional` **interruptId**: `string` Defined in: [packages/sdk/src/types/chat-types.ts:371](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L371) LangGraph interrupt ID injected by the backend so it can be echoed back on resume. *** ### type[​](#type "Direct link to type") > **type**: `"app_connection_access"` Defined in: [packages/sdk/src/types/chat-types.ts:363](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L363) --- # Interface: AppConnectionDirectoryEntry Defined in: [packages/sdk/src/types/generated/app\_connection.ts:11](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L11) Static metadata for a single app connection definition. ## Properties[​](#properties "Direct link to Properties") ### category[​](#category "Direct link to category") > **category**: `string` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:17](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L17) *** ### connectionType[​](#connectiontype "Direct link to connectionType") > **connectionType**: `string` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:16](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L16) *** ### description[​](#description "Direct link to description") > **description**: `string` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:14](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L14) *** ### fhirVendor?[​](#fhirvendor "Direct link to fhirVendor?") > `optional` **fhirVendor**: `string` | `null` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:23](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L23) *** ### icon[​](#icon "Direct link to icon") > **icon**: `string` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:15](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L15) *** ### mcpUrl?[​](#mcpurl "Direct link to mcpUrl?") > `optional` **mcpUrl**: `string` | `null` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:20](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L20) *** ### mcpUrlHint?[​](#mcpurlhint "Direct link to mcpUrlHint?") > `optional` **mcpUrlHint**: `string` | `null` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:21](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L21) *** ### multiplicity[​](#multiplicity "Direct link to multiplicity") > **multiplicity**: `string` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:19](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L19) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:13](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L13) *** ### oauthProvider?[​](#oauthprovider "Direct link to oauthProvider?") > `optional` **oauthProvider**: `string` | `null` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:24](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L24) *** ### slug[​](#slug "Direct link to slug") > **slug**: `string` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:12](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L12) *** ### supportsDirectAuth[​](#supportsdirectauth "Direct link to supportsDirectAuth") > **supportsDirectAuth**: `boolean` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:22](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L22) *** ### tags[​](#tags "Direct link to tags") > **tags**: `string`\[] Defined in: [packages/sdk/src/types/generated/app\_connection.ts:18](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L18) --- # Interface: AppConnectionDirectoryResponse Defined in: [packages/sdk/src/types/generated/app\_connection.ts:30](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L30) Response for GET /app-connections/available. ## Properties[​](#properties "Direct link to Properties") ### items[​](#items "Direct link to items") > **items**: [`AppConnectionDirectoryEntry`](https://docs.gravityrail.com/sdk/interfaces/AppConnectionDirectoryEntry.md)\[] Defined in: [packages/sdk/src/types/generated/app\_connection.ts:31](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L31) *** ### total[​](#total "Direct link to total") > **total**: `number` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:32](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L32) --- # Interface: AppContext Defined in: [packages/sdk/src/app-context.ts:66](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/app-context.ts#L66) App context provided to AI assistants This represents the current page/state the user is in, allowing the AI to provide context-aware assistance. ## Properties[​](#properties "Direct link to Properties") ### appUri?[​](#appuri "Direct link to appUri?") > `optional` **appUri**: `string` Defined in: [packages/sdk/src/app-context.ts:68](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/app-context.ts#L68) Current page URI (e.g., 'app:page:workflows/123') *** ### autoApprove?[​](#autoapprove "Direct link to autoApprove?") > `optional` **autoApprove**: `boolean` Defined in: [packages/sdk/src/app-context.ts:74](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/app-context.ts#L74) Auto-approve all tool calls without HITL interruption *** ### deepThink?[​](#deepthink "Direct link to deepThink?") > `optional` **deepThink**: `boolean` Defined in: [packages/sdk/src/app-context.ts:77](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/app-context.ts#L77) Enable deep thinking mode for the current session *** ### pageState?[​](#pagestate "Direct link to pageState?") > `optional` **pageState**: `object` Defined in: [packages/sdk/src/app-context.ts:83](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/app-context.ts#L83) Additional structured page state #### Index Signature[​](#index-signature "Direct link to Index Signature") \[`key`: `string`]: `any` Any other page-specific state #### dataRecord?[​](#datarecord "Direct link to dataRecord?") > `optional` **dataRecord**: [`DataRecordContext`](https://docs.gravityrail.com/sdk/interfaces/DataRecordContext.md) Data record being viewed/edited #### openDrawers?[​](#opendrawers "Direct link to openDrawers?") > `optional` **openDrawers**: `string`\[] Open drawers/modals #### page?[​](#page "Direct link to page?") > `optional` **page**: [`PageContext`](https://docs.gravityrail.com/sdk/interfaces/PageContext.md) Page being viewed/edited #### routeParams?[​](#routeparams "Direct link to routeParams?") > `optional` **routeParams**: `Record`<`string`, `string` | `string`\[]> Route parameters from Next.js #### selectedTabs?[​](#selectedtabs "Direct link to selectedTabs?") > `optional` **selectedTabs**: `string`\[] Selected tabs #### site?[​](#site "Direct link to site?") > `optional` **site**: [`SiteContext`](https://docs.gravityrail.com/sdk/interfaces/SiteContext.md) Site being viewed/edited #### toolkit?[​](#toolkit "Direct link to toolkit?") > `optional` **toolkit**: [`ToolkitContext`](https://docs.gravityrail.com/sdk/interfaces/ToolkitContext.md) Toolkit being viewed #### workflow?[​](#workflow "Direct link to workflow?") > `optional` **workflow**: [`WorkflowContext`](https://docs.gravityrail.com/sdk/interfaces/WorkflowContext.md) Workflow being viewed/edited *** ### pageUrl?[​](#pageurl "Direct link to pageUrl?") > `optional` **pageUrl**: `string` Defined in: [packages/sdk/src/app-context.ts:71](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/app-context.ts#L71) Current browser URL for linking back to this page *** ### pendingSetupSpecIds?[​](#pendingsetupspecids "Direct link to pendingSetupSpecIds?") > `optional` **pendingSetupSpecIds**: `number`\[] Defined in: [packages/sdk/src/app-context.ts:80](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/app-context.ts#L80) Setup spec IDs linked to the current workspace that are pending execution. --- # Interface: AppCredentialResponse Defined in: [packages/sdk/src/types/generated/app.ts:11](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app.ts#L11) Response when regenerating app credentials. ## Properties[​](#properties "Direct link to Properties") ### clientId[​](#clientid "Direct link to clientId") > **clientId**: `string` Defined in: [packages/sdk/src/types/generated/app.ts:12](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app.ts#L12) *** ### clientSecret[​](#clientsecret "Direct link to clientSecret") > **clientSecret**: `string` Defined in: [packages/sdk/src/types/generated/app.ts:13](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app.ts#L13) *** ### message?[​](#message "Direct link to message?") > `optional` **message**: `string` Defined in: [packages/sdk/src/types/generated/app.ts:14](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app.ts#L14) --- # Interface: AssignmentResponse Defined in: [packages/sdk/src/types/generated/task.ts:76](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L76) ## Properties[​](#properties "Direct link to Properties") ### concludedAt?[​](#concludedat "Direct link to concludedAt?") > `optional` **concludedAt**: `string` | `null` Defined in: [packages/sdk/src/types/generated/task.ts:87](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L87) *** ### createdAt[​](#createdat "Direct link to createdAt") > **createdAt**: `string` Defined in: [packages/sdk/src/types/generated/task.ts:82](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L82) *** ### currentTask?[​](#currenttask "Direct link to currentTask?") > `optional` **currentTask**: [`AssignmentTaskResponse`](https://docs.gravityrail.com/sdk/interfaces/AssignmentTaskResponse.md) | `null` Defined in: [packages/sdk/src/types/generated/task.ts:89](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L89) *** ### dataRecords?[​](#datarecords "Direct link to dataRecords?") > `optional` **dataRecords**: [`DataRecordResponse`](https://docs.gravityrail.com/sdk/interfaces/DataRecordResponse.md)\[] Defined in: [packages/sdk/src/types/generated/task.ts:91](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L91) *** ### files[​](#files "Direct link to files") > **files**: [`GeneratedFileResponse`](https://docs.gravityrail.com/sdk/interfaces/GeneratedFileResponse.md)\[] Defined in: [packages/sdk/src/types/generated/task.ts:92](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L92) *** ### id[​](#id "Direct link to id") > **id**: `number` Defined in: [packages/sdk/src/types/generated/task.ts:77](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L77) *** ### isTest[​](#istest "Direct link to isTest") > **isTest**: `boolean` Defined in: [packages/sdk/src/types/generated/task.ts:90](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L90) *** ### memberId[​](#memberid "Direct link to memberId") > **memberId**: `number` Defined in: [packages/sdk/src/types/generated/task.ts:81](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L81) *** ### outcome?[​](#outcome "Direct link to outcome?") > `optional` **outcome**: `string` | `null` Defined in: [packages/sdk/src/types/generated/task.ts:85](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L85) *** ### outcomeReason?[​](#outcomereason "Direct link to outcomeReason?") > `optional` **outcomeReason**: `string` | `null` Defined in: [packages/sdk/src/types/generated/task.ts:86](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L86) *** ### pages?[​](#pages "Direct link to pages?") > `optional` **pages**: [`PageResponse`](https://docs.gravityrail.com/sdk/interfaces/PageResponse.md)\[] Defined in: [packages/sdk/src/types/generated/task.ts:93](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L93) *** ### rootTask?[​](#roottask "Direct link to rootTask?") > `optional` **rootTask**: [`AssignmentTaskResponse`](https://docs.gravityrail.com/sdk/interfaces/AssignmentTaskResponse.md) | `null` Defined in: [packages/sdk/src/types/generated/task.ts:88](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L88) *** ### status?[​](#status "Direct link to status?") > `optional` **status**: `string` Defined in: [packages/sdk/src/types/generated/task.ts:84](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L84) *** ### taskId?[​](#taskid "Direct link to taskId?") > `optional` **taskId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/task.ts:79](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L79) *** ### taskName?[​](#taskname "Direct link to taskName?") > `optional` **taskName**: `string` | `null` Defined in: [packages/sdk/src/types/generated/task.ts:80](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L80) *** ### updatedAt[​](#updatedat "Direct link to updatedAt") > **updatedAt**: `string` Defined in: [packages/sdk/src/types/generated/task.ts:83](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L83) *** ### uuid[​](#uuid "Direct link to uuid") > **uuid**: `string` Defined in: [packages/sdk/src/types/generated/task.ts:78](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L78) *** ### workflowId[​](#workflowid "Direct link to workflowId") > **workflowId**: `number` Defined in: [packages/sdk/src/types/generated/task.ts:94](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L94) *** ### workflowName?[​](#workflowname "Direct link to workflowName?") > `optional` **workflowName**: `string` | `null` Defined in: [packages/sdk/src/types/generated/task.ts:95](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L95) *** ### workflowVersionId?[​](#workflowversionid "Direct link to workflowVersionId?") > `optional` **workflowVersionId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/task.ts:96](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L96) *** ### workflowVersionName?[​](#workflowversionname "Direct link to workflowVersionName?") > `optional` **workflowVersionName**: `string` | `null` Defined in: [packages/sdk/src/types/generated/task.ts:98](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L98) *** ### workflowVersionNumber?[​](#workflowversionnumber "Direct link to workflowVersionNumber?") > `optional` **workflowVersionNumber**: `number` | `null` Defined in: [packages/sdk/src/types/generated/task.ts:97](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L97) --- # Interface: AssignmentsQueryParams Defined in: [packages/sdk/src/types/task-types.ts:113](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/task-types.ts#L113) ## Properties[​](#properties "Direct link to Properties") ### memberId?[​](#memberid "Direct link to memberId?") > `optional` **memberId**: `number` Defined in: [packages/sdk/src/types/task-types.ts:119](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/task-types.ts#L119) *** ### mine?[​](#mine "Direct link to mine?") > `optional` **mine**: `boolean` Defined in: [packages/sdk/src/types/task-types.ts:118](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/task-types.ts#L118) *** ### page?[​](#page "Direct link to page?") > `optional` **page**: `number` Defined in: [packages/sdk/src/types/task-types.ts:114](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/task-types.ts#L114) *** ### pageSize?[​](#pagesize "Direct link to pageSize?") > `optional` **pageSize**: `number` Defined in: [packages/sdk/src/types/task-types.ts:115](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/task-types.ts#L115) *** ### sortBy?[​](#sortby "Direct link to sortBy?") > `optional` **sortBy**: [`AssignmentSortField`](https://docs.gravityrail.com/sdk/type-aliases/AssignmentSortField.md) Defined in: [packages/sdk/src/types/task-types.ts:116](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/task-types.ts#L116) *** ### sortOrder?[​](#sortorder "Direct link to sortOrder?") > `optional` **sortOrder**: [`SortOrder`](https://docs.gravityrail.com/sdk/type-aliases/SortOrder.md) Defined in: [packages/sdk/src/types/task-types.ts:117](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/task-types.ts#L117) *** ### status?[​](#status "Direct link to status?") > `optional` **status**: [`AssignmentStatusType`](https://docs.gravityrail.com/sdk/type-aliases/AssignmentStatusType.md) Defined in: [packages/sdk/src/types/task-types.ts:121](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/task-types.ts#L121) *** ### taskId?[​](#taskid "Direct link to taskId?") > `optional` **taskId**: `number` Defined in: [packages/sdk/src/types/task-types.ts:120](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/task-types.ts#L120) --- # Interface: AssignmentTaskResponse Defined in: [packages/sdk/src/types/generated/task.ts:104](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L104) Response model for assignment task endpoints. ## Properties[​](#properties "Direct link to Properties") ### autoNext[​](#autonext "Direct link to autoNext") > **autoNext**: `boolean` Defined in: [packages/sdk/src/types/generated/task.ts:108](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L108) *** ### children?[​](#children "Direct link to children?") > `optional` **children**: `AssignmentTaskResponse`\[] Defined in: [packages/sdk/src/types/generated/task.ts:114](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L114) *** ### id[​](#id "Direct link to id") > **id**: `number` Defined in: [packages/sdk/src/types/generated/task.ts:105](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L105) *** ### required[​](#required "Direct link to required") > **required**: `boolean` Defined in: [packages/sdk/src/types/generated/task.ts:107](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L107) *** ### taskId[​](#taskid "Direct link to taskId") > **taskId**: `number` Defined in: [packages/sdk/src/types/generated/task.ts:109](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L109) *** ### taskName[​](#taskname "Direct link to taskName") > **taskName**: `string` Defined in: [packages/sdk/src/types/generated/task.ts:111](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L111) *** ### taskUuid[​](#taskuuid "Direct link to taskUuid") > **taskUuid**: `string` Defined in: [packages/sdk/src/types/generated/task.ts:112](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L112) *** ### uuid[​](#uuid "Direct link to uuid") > **uuid**: `string` Defined in: [packages/sdk/src/types/generated/task.ts:106](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L106) *** ### visitedAt[​](#visitedat "Direct link to visitedAt") > **visitedAt**: `string` | `null` Defined in: [packages/sdk/src/types/generated/task.ts:113](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L113) *** ### workflowId[​](#workflowid "Direct link to workflowId") > **workflowId**: `number` Defined in: [packages/sdk/src/types/generated/task.ts:110](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L110) --- # Interface: AssistantMessageActionParams Defined in: [packages/sdk/src/types/event-types.ts:232](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L232) ## Properties[​](#properties "Direct link to Properties") ### inboundMessage?[​](#inboundmessage "Direct link to inboundMessage?") > `optional` **inboundMessage**: `string` Defined in: [packages/sdk/src/types/event-types.ts:241](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L241) *** ### message[​](#message "Direct link to message") > **message**: `string` Defined in: [packages/sdk/src/types/event-types.ts:233](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L233) *** ### messageTranslations?[​](#messagetranslations "Direct link to messageTranslations?") > `optional` **messageTranslations**: `Record`<`string`, `string`> Defined in: [packages/sdk/src/types/event-types.ts:236](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L236) *** ### outboundMessage?[​](#outboundmessage "Direct link to outboundMessage?") > `optional` **outboundMessage**: `string` Defined in: [packages/sdk/src/types/event-types.ts:242](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L242) *** ### suggestions?[​](#suggestions "Direct link to suggestions?") > `optional` **suggestions**: `string`\[] Defined in: [packages/sdk/src/types/event-types.ts:234](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L234) *** ### suggestionTranslations?[​](#suggestiontranslations "Direct link to suggestionTranslations?") > `optional` **suggestionTranslations**: `Record`<`string`, `string`\[]> Defined in: [packages/sdk/src/types/event-types.ts:237](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L237) *** ### waitForResponse?[​](#waitforresponse "Direct link to waitForResponse?") > `optional` **waitForResponse**: `boolean` Defined in: [packages/sdk/src/types/event-types.ts:250](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L250) When false, the injected assistant message does NOT end the agent turn — the loop keeps running so a follow-up model response can be generated after the canned filler. Default true preserves the existing "ends-the-turn" semantics for every existing rule whose JSON lacks the new key. --- # Interface: AttachedAddonInfo Defined in: [packages/sdk/src/types/generated/workspace\_health.ts:11](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/workspace_health.ts#L11) Information about an attached addon product. ## Properties[​](#properties "Direct link to Properties") ### productId[​](#productid "Direct link to productId") > **productId**: `number` Defined in: [packages/sdk/src/types/generated/workspace\_health.ts:13](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/workspace_health.ts#L13) *** ### productName[​](#productname "Direct link to productName") > **productName**: `string` Defined in: [packages/sdk/src/types/generated/workspace\_health.ts:14](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/workspace_health.ts#L14) *** ### providesFeatures[​](#providesfeatures "Direct link to providesFeatures") > **providesFeatures**: `string`\[] Defined in: [packages/sdk/src/types/generated/workspace\_health.ts:15](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/workspace_health.ts#L15) *** ### subscriptionId[​](#subscriptionid "Direct link to subscriptionId") > **subscriptionId**: `number` Defined in: [packages/sdk/src/types/generated/workspace\_health.ts:12](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/workspace_health.ts#L12) --- # Interface: AttendeeResponse Defined in: [packages/sdk/src/types/generated/calendar.ts:12](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/calendar.ts#L12) Response model for event attendees. ## Properties[​](#properties "Direct link to Properties") ### id[​](#id "Direct link to id") > **id**: `number` Defined in: [packages/sdk/src/types/generated/calendar.ts:13](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/calendar.ts#L13) *** ### memberId[​](#memberid "Direct link to memberId") > **memberId**: `number` Defined in: [packages/sdk/src/types/generated/calendar.ts:14](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/calendar.ts#L14) *** ### note[​](#note "Direct link to note") > **note**: `string` | `null` Defined in: [packages/sdk/src/types/generated/calendar.ts:18](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/calendar.ts#L18) *** ### responseAt[​](#responseat "Direct link to responseAt") > **responseAt**: `string` | `null` Defined in: [packages/sdk/src/types/generated/calendar.ts:17](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/calendar.ts#L17) *** ### responseStatus[​](#responsestatus "Direct link to responseStatus") > **responseStatus**: `string` Defined in: [packages/sdk/src/types/generated/calendar.ts:16](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/calendar.ts#L16) *** ### status[​](#status "Direct link to status") > **status**: `string` Defined in: [packages/sdk/src/types/generated/calendar.ts:15](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/calendar.ts#L15) --- # Interface: AudioMessageMetadata Defined in: [packages/sdk/src/types/chat-types.ts:311](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L311) Playback metadata stored alongside an audio assistant message. Server-applied at runtime by rendered\_speech.play\_file\_stream / the artifact handler. Re-read by the chat renderer for display (e.g. annotating the bubble with "guaranteed delivery" if the clip is non-interruptible). ## Properties[​](#properties "Direct link to Properties") ### allowInterrupt?[​](#allowinterrupt "Direct link to allowInterrupt?") > `optional` **allowInterrupt**: `boolean` Defined in: [packages/sdk/src/types/chat-types.ts:313](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L313) When false, the clip plays end-to-end ignoring barge-in. *** ### hangUpOnAudioEnd?[​](#hanguponaudioend "Direct link to hangUpOnAudioEnd?") > `optional` **hangUpOnAudioEnd**: `boolean` Defined in: [packages/sdk/src/types/chat-types.ts:315](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L315) When true, the call hangs up immediately after the clip ends. *** ### volume?[​](#volume "Direct link to volume?") > `optional` **volume**: `number` Defined in: [packages/sdk/src/types/chat-types.ts:317](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L317) Server-side gain percent in \[0, 100]. 80 is unity. --- # Interface: AudioPlaybackAbilityConfig Defined in: [packages/sdk/src/types/ability-types.ts:321](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ability-types.ts#L321) Config for audio\_playback ability ## Properties[​](#properties "Direct link to Properties") ### files?[​](#files "Direct link to files?") > `optional` **files**: [`AudioPlaybackFileEntry`](https://docs.gravityrail.com/sdk/interfaces/AudioPlaybackFileEntry.md)\[] Defined in: [packages/sdk/src/types/ability-types.ts:323](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ability-types.ts#L323) Audio files the agent may play on this task --- # Interface: AudioPlaybackFileEntry Defined in: [packages/sdk/src/types/ability-types.ts:311](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ability-types.ts#L311) A single audio file entry in the audio\_playback ability config ## Properties[​](#properties "Direct link to Properties") ### fileId[​](#fileid "Direct link to fileId") > **fileId**: `number` Defined in: [packages/sdk/src/types/ability-types.ts:313](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ability-types.ts#L313) ID of the workspace file to expose for playback (must be a .wav file) *** ### hint?[​](#hint "Direct link to hint?") > `optional` **hint**: `string` Defined in: [packages/sdk/src/types/ability-types.ts:317](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ability-types.ts#L317) Optional hint for the LLM about when to use this clip *** ### label[​](#label "Direct link to label") > **label**: `string` Defined in: [packages/sdk/src/types/ability-types.ts:315](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ability-types.ts#L315) Short label the LLM uses to pick this clip (e.g. 'voicemail\_greeting') --- # Interface: AuthorizedRep Defined in: [packages/sdk/src/types/generated/organization.ts:85](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L85) Authorized representative — Twilio End-User of type authorized\_representative\_1 / \_2. ## Properties[​](#properties "Direct link to Properties") ### businessTitle[​](#businesstitle "Direct link to businessTitle") > **businessTitle**: `string` Defined in: [packages/sdk/src/types/generated/organization.ts:106](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L106) #### Min Length[​](#min-length "Direct link to Min Length") 1 #### Max Length[​](#max-length "Direct link to Max Length") 50 *** ### email[​](#email "Direct link to email") > **email**: `string` Defined in: [packages/sdk/src/types/generated/organization.ts:96](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L96) *** ### firstName[​](#firstname "Direct link to firstName") > **firstName**: `string` Defined in: [packages/sdk/src/types/generated/organization.ts:90](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L90) #### Min Length[​](#min-length-1 "Direct link to Min Length") 1 #### Max Length[​](#max-length-1 "Direct link to Max Length") 50 *** ### jobPosition[​](#jobposition "Direct link to jobPosition") > **jobPosition**: [`JobPosition`](https://docs.gravityrail.com/sdk/type-aliases/JobPosition.md) Defined in: [packages/sdk/src/types/generated/organization.ts:107](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L107) *** ### lastName[​](#lastname "Direct link to lastName") > **lastName**: `string` Defined in: [packages/sdk/src/types/generated/organization.ts:95](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L95) #### Min Length[​](#min-length-2 "Direct link to Min Length") 1 #### Max Length[​](#max-length-2 "Direct link to Max Length") 50 *** ### phoneNumber[​](#phonenumber "Direct link to phoneNumber") > **phoneNumber**: `string` Defined in: [packages/sdk/src/types/generated/organization.ts:101](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L101) #### Min Length[​](#min-length-3 "Direct link to Min Length") 1 #### Max Length[​](#max-length-3 "Direct link to Max Length") 20 --- # Interface: AuthorizeRequest Defined in: [packages/sdk/src/api/oauth.ts:94](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/oauth.ts#L94) ## Properties[​](#properties "Direct link to Properties") ### clientId[​](#clientid "Direct link to clientId") > **clientId**: `string` Defined in: [packages/sdk/src/api/oauth.ts:95](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/oauth.ts#L95) *** ### codeChallenge?[​](#codechallenge "Direct link to codeChallenge?") > `optional` **codeChallenge**: `string` Defined in: [packages/sdk/src/api/oauth.ts:100](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/oauth.ts#L100) *** ### codeChallengeMethod?[​](#codechallengemethod "Direct link to codeChallengeMethod?") > `optional` **codeChallengeMethod**: `string` Defined in: [packages/sdk/src/api/oauth.ts:101](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/oauth.ts#L101) *** ### redirectUri[​](#redirecturi "Direct link to redirectUri") > **redirectUri**: `string` Defined in: [packages/sdk/src/api/oauth.ts:98](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/oauth.ts#L98) *** ### scopes[​](#scopes "Direct link to scopes") > **scopes**: `string`\[] Defined in: [packages/sdk/src/api/oauth.ts:97](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/oauth.ts#L97) *** ### state?[​](#state "Direct link to state?") > `optional` **state**: `string` Defined in: [packages/sdk/src/api/oauth.ts:99](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/oauth.ts#L99) *** ### workspaceUuid?[​](#workspaceuuid "Direct link to workspaceUuid?") > `optional` **workspaceUuid**: `string` | `null` Defined in: [packages/sdk/src/api/oauth.ts:96](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/oauth.ts#L96) --- # Interface: AuthorizeResponse Defined in: [packages/sdk/src/api/oauth.ts:104](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/oauth.ts#L104) ## Properties[​](#properties "Direct link to Properties") ### code[​](#code "Direct link to code") > **code**: `string` Defined in: [packages/sdk/src/api/oauth.ts:105](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/oauth.ts#L105) *** ### state?[​](#state "Direct link to state?") > `optional` **state**: `string` Defined in: [packages/sdk/src/api/oauth.ts:106](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/oauth.ts#L106) --- # Interface: AvailabilityCheck Defined in: [packages/sdk/src/types/calendar-types.ts:164](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/calendar-types.ts#L164) ## Properties[​](#properties "Direct link to Properties") ### endTime?[​](#endtime "Direct link to endTime?") > `optional` **endTime**: `string` | `null` Defined in: [packages/sdk/src/types/calendar-types.ts:167](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/calendar-types.ts#L167) *** ### eventTypeId[​](#eventtypeid "Direct link to eventTypeId") > **eventTypeId**: `number` Defined in: [packages/sdk/src/types/calendar-types.ts:165](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/calendar-types.ts#L165) *** ### startTime[​](#starttime "Direct link to startTime") > **startTime**: `string` Defined in: [packages/sdk/src/types/calendar-types.ts:166](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/calendar-types.ts#L166) --- # Interface: AvailabilityResponse Defined in: [packages/sdk/src/types/generated/calendar.ts:24](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/calendar.ts#L24) Response model for availability check. ## Properties[​](#properties "Direct link to Properties") ### available[​](#available "Direct link to available") > **available**: `boolean` Defined in: [packages/sdk/src/types/generated/calendar.ts:25](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/calendar.ts#L25) *** ### reason?[​](#reason "Direct link to reason?") > `optional` **reason**: `string` | `null` Defined in: [packages/sdk/src/types/generated/calendar.ts:26](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/calendar.ts#L26) --- # Interface: AvailableMemberRole Defined in: [packages/sdk/src/types/workspace-types.ts:147](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/workspace-types.ts#L147) ## Properties[​](#properties "Direct link to Properties") ### id[​](#id "Direct link to id") > **id**: `number` Defined in: [packages/sdk/src/types/workspace-types.ts:148](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/workspace-types.ts#L148) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/workspace-types.ts:150](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/workspace-types.ts#L150) *** ### uuid[​](#uuid "Direct link to uuid") > **uuid**: `string` Defined in: [packages/sdk/src/types/workspace-types.ts:149](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/workspace-types.ts#L149) --- # Interface: AvailableSlotsRequest Defined in: [packages/sdk/src/types/calendar-types.ts:170](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/calendar-types.ts#L170) ## Properties[​](#properties "Direct link to Properties") ### endDate[​](#enddate "Direct link to endDate") > **endDate**: `string` Defined in: [packages/sdk/src/types/calendar-types.ts:173](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/calendar-types.ts#L173) *** ### eventTypeId[​](#eventtypeid "Direct link to eventTypeId") > **eventTypeId**: `number` Defined in: [packages/sdk/src/types/calendar-types.ts:171](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/calendar-types.ts#L171) *** ### slotIntervalMinutes?[​](#slotintervalminutes "Direct link to slotIntervalMinutes?") > `optional` **slotIntervalMinutes**: `number` Defined in: [packages/sdk/src/types/calendar-types.ts:174](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/calendar-types.ts#L174) *** ### startDate[​](#startdate "Direct link to startDate") > **startDate**: `string` Defined in: [packages/sdk/src/types/calendar-types.ts:172](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/calendar-types.ts#L172) --- # Interface: AvailableSlotsResponse Defined in: [packages/sdk/src/types/generated/calendar.ts:36](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/calendar.ts#L36) Response model for available time slots. Returns consolidated time ranges where consecutive slots are merged. For example, if 9:00, 9:30, and 10:00 are available with 30-min intervals, they will be returned as a single slot: {startTime: 9:00, endTime: 10:30}. ## Properties[​](#properties "Direct link to Properties") ### calendarId[​](#calendarid "Direct link to calendarId") > **calendarId**: `number` Defined in: [packages/sdk/src/types/generated/calendar.ts:39](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/calendar.ts#L39) *** ### eventTypeId[​](#eventtypeid "Direct link to eventTypeId") > **eventTypeId**: `number` Defined in: [packages/sdk/src/types/generated/calendar.ts:38](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/calendar.ts#L38) *** ### slots[​](#slots "Direct link to slots") > **slots**: [`TimeSlot`](https://docs.gravityrail.com/sdk/interfaces/TimeSlot.md)\[] Defined in: [packages/sdk/src/types/generated/calendar.ts:37](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/calendar.ts#L37) --- # Interface: AWSRealtimeModelConfig Defined in: [packages/sdk/src/types/model-config-types.ts:101](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/model-config-types.ts#L101) Base configuration for all realtime models. Contains common fields that apply to all realtime model providers. ## Extends[​](#extends "Direct link to Extends") * [`BaseRealtimeModelConfig`](https://docs.gravityrail.com/sdk/interfaces/BaseRealtimeModelConfig.md) ## Properties[​](#properties "Direct link to Properties") ### interruptionSound?[​](#interruptionsound "Direct link to interruptionSound?") > `optional` **interruptionSound**: [`InterruptionSound`](https://docs.gravityrail.com/sdk/type-aliases/InterruptionSound.md) | `null` Defined in: [packages/sdk/src/types/model-config-types.ts:69](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/model-config-types.ts#L69) Sound to play when user stops speaking after interrupting the assistant. Provides immediate auditory feedback that input was received. Default: none. #### Inherited from[​](#inherited-from "Direct link to Inherited from") [`BaseRealtimeModelConfig`](https://docs.gravityrail.com/sdk/interfaces/BaseRealtimeModelConfig.md).[`interruptionSound`](https://docs.gravityrail.com/sdk/interfaces/BaseRealtimeModelConfig.md#interruptionsound) *** ### interruptionSoundVolume?[​](#interruptionsoundvolume "Direct link to interruptionSoundVolume?") > `optional` **interruptionSoundVolume**: `number` | `null` Defined in: [packages/sdk/src/types/model-config-types.ts:71](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/model-config-types.ts#L71) Volume level for the interruption sound (0-100). 0 means muted. Missing or null means full volume (100). #### Inherited from[​](#inherited-from-1 "Direct link to Inherited from") [`BaseRealtimeModelConfig`](https://docs.gravityrail.com/sdk/interfaces/BaseRealtimeModelConfig.md).[`interruptionSoundVolume`](https://docs.gravityrail.com/sdk/interfaces/BaseRealtimeModelConfig.md#interruptionsoundvolume) *** ### thinkingSound?[​](#thinkingsound "Direct link to thinkingSound?") > `optional` **thinkingSound**: [`ThinkingSound`](https://docs.gravityrail.com/sdk/type-aliases/ThinkingSound.md) | `null` Defined in: [packages/sdk/src/types/model-config-types.ts:61](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/model-config-types.ts#L61) Sound to play while the agent is processing tool calls. #### Inherited from[​](#inherited-from-2 "Direct link to Inherited from") [`BaseRealtimeModelConfig`](https://docs.gravityrail.com/sdk/interfaces/BaseRealtimeModelConfig.md).[`thinkingSound`](https://docs.gravityrail.com/sdk/interfaces/BaseRealtimeModelConfig.md#thinkingsound) *** ### thinkingSoundInitialDelay?[​](#thinkingsoundinitialdelay "Direct link to thinkingSoundInitialDelay?") > `optional` **thinkingSoundInitialDelay**: `number` | `null` Defined in: [packages/sdk/src/types/model-config-types.ts:65](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/model-config-types.ts#L65) Initial delay in milliseconds before playing thinking sound. Prevents needless interruption on short tool calls. Default: 500ms. #### Inherited from[​](#inherited-from-3 "Direct link to Inherited from") [`BaseRealtimeModelConfig`](https://docs.gravityrail.com/sdk/interfaces/BaseRealtimeModelConfig.md).[`thinkingSoundInitialDelay`](https://docs.gravityrail.com/sdk/interfaces/BaseRealtimeModelConfig.md#thinkingsoundinitialdelay) *** ### thinkingSoundVolume?[​](#thinkingsoundvolume "Direct link to thinkingSoundVolume?") > `optional` **thinkingSoundVolume**: `number` | `null` Defined in: [packages/sdk/src/types/model-config-types.ts:63](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/model-config-types.ts#L63) Volume level for the thinking sound (0-100). 0 means muted. Missing or null means full volume (100). #### Inherited from[​](#inherited-from-4 "Direct link to Inherited from") [`BaseRealtimeModelConfig`](https://docs.gravityrail.com/sdk/interfaces/BaseRealtimeModelConfig.md).[`thinkingSoundVolume`](https://docs.gravityrail.com/sdk/interfaces/BaseRealtimeModelConfig.md#thinkingsoundvolume) *** ### thinkingSpeechPhrases?[​](#thinkingspeechphrases "Direct link to thinkingSpeechPhrases?") > `optional` **thinkingSpeechPhrases**: `string`\[] | `null` Defined in: [packages/sdk/src/types/model-config-types.ts:67](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/model-config-types.ts#L67) When `thinkingSound` is 'speech', one of these phrases is spoken while the agent runs a tool. Phrases rotate round-robin per session. #### Inherited from[​](#inherited-from-5 "Direct link to Inherited from") [`BaseRealtimeModelConfig`](https://docs.gravityrail.com/sdk/interfaces/BaseRealtimeModelConfig.md).[`thinkingSpeechPhrases`](https://docs.gravityrail.com/sdk/interfaces/BaseRealtimeModelConfig.md#thinkingspeechphrases) *** ### ttsModel?[​](#ttsmodel "Direct link to ttsModel?") > `optional` **ttsModel**: `"native"` | `null` Defined in: [packages/sdk/src/types/model-config-types.ts:102](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/model-config-types.ts#L102) TTS model ID in provider:tts:model format (e.g. 'elevenlabs:tts:eleven\_flash\_v2\_5'), or 'native'. #### Overrides[​](#overrides "Direct link to Overrides") [`BaseRealtimeModelConfig`](https://docs.gravityrail.com/sdk/interfaces/BaseRealtimeModelConfig.md).[`ttsModel`](https://docs.gravityrail.com/sdk/interfaces/BaseRealtimeModelConfig.md#ttsmodel) *** ### voiceModel?[​](#voicemodel "Direct link to voiceModel?") > `optional` **voiceModel**: `string` | `null` Defined in: [packages/sdk/src/types/model-config-types.ts:75](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/model-config-types.ts#L75) Canonical voice identifier (e.g., elevenlabs:voice:catt) that selects the specific agent voice. #### Inherited from[​](#inherited-from-6 "Direct link to Inherited from") [`BaseRealtimeModelConfig`](https://docs.gravityrail.com/sdk/interfaces/BaseRealtimeModelConfig.md).[`voiceModel`](https://docs.gravityrail.com/sdk/interfaces/BaseRealtimeModelConfig.md#voicemodel) --- # Interface: BaseChatModelConfig Defined in: [packages/sdk/src/types/model-config-types.ts:147](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/model-config-types.ts#L147) Base configuration for all chat models. Can be extended for provider-specific options. ## Extended by[​](#extended-by "Direct link to Extended by") * [`GeminiChatModelConfig`](https://docs.gravityrail.com/sdk/interfaces/GeminiChatModelConfig.md) * [`ClaudeChatModelConfig`](https://docs.gravityrail.com/sdk/interfaces/ClaudeChatModelConfig.md) * [`OpenAIChatModelConfig`](https://docs.gravityrail.com/sdk/interfaces/OpenAIChatModelConfig.md) * [`XAIChatModelConfig`](https://docs.gravityrail.com/sdk/interfaces/XAIChatModelConfig.md) --- # Interface: BaseRealtimeModelConfig Defined in: [packages/sdk/src/types/model-config-types.ts:59](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/model-config-types.ts#L59) Base configuration for all realtime models. Contains common fields that apply to all realtime model providers. ## Extended by[​](#extended-by "Direct link to Extended by") * [`OpenAIRealtimeModelConfig`](https://docs.gravityrail.com/sdk/interfaces/OpenAIRealtimeModelConfig.md) * [`GeminiRealtimeModelConfig`](https://docs.gravityrail.com/sdk/interfaces/GeminiRealtimeModelConfig.md) * [`CustomRealtimeModelConfig`](https://docs.gravityrail.com/sdk/interfaces/CustomRealtimeModelConfig.md) * [`AWSRealtimeModelConfig`](https://docs.gravityrail.com/sdk/interfaces/AWSRealtimeModelConfig.md) * [`XAIRealtimeModelConfig`](https://docs.gravityrail.com/sdk/interfaces/XAIRealtimeModelConfig.md) ## Properties[​](#properties "Direct link to Properties") ### interruptionSound?[​](#interruptionsound "Direct link to interruptionSound?") > `optional` **interruptionSound**: [`InterruptionSound`](https://docs.gravityrail.com/sdk/type-aliases/InterruptionSound.md) | `null` Defined in: [packages/sdk/src/types/model-config-types.ts:69](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/model-config-types.ts#L69) Sound to play when user stops speaking after interrupting the assistant. Provides immediate auditory feedback that input was received. Default: none. *** ### interruptionSoundVolume?[​](#interruptionsoundvolume "Direct link to interruptionSoundVolume?") > `optional` **interruptionSoundVolume**: `number` | `null` Defined in: [packages/sdk/src/types/model-config-types.ts:71](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/model-config-types.ts#L71) Volume level for the interruption sound (0-100). 0 means muted. Missing or null means full volume (100). *** ### thinkingSound?[​](#thinkingsound "Direct link to thinkingSound?") > `optional` **thinkingSound**: [`ThinkingSound`](https://docs.gravityrail.com/sdk/type-aliases/ThinkingSound.md) | `null` Defined in: [packages/sdk/src/types/model-config-types.ts:61](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/model-config-types.ts#L61) Sound to play while the agent is processing tool calls. *** ### thinkingSoundInitialDelay?[​](#thinkingsoundinitialdelay "Direct link to thinkingSoundInitialDelay?") > `optional` **thinkingSoundInitialDelay**: `number` | `null` Defined in: [packages/sdk/src/types/model-config-types.ts:65](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/model-config-types.ts#L65) Initial delay in milliseconds before playing thinking sound. Prevents needless interruption on short tool calls. Default: 500ms. *** ### thinkingSoundVolume?[​](#thinkingsoundvolume "Direct link to thinkingSoundVolume?") > `optional` **thinkingSoundVolume**: `number` | `null` Defined in: [packages/sdk/src/types/model-config-types.ts:63](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/model-config-types.ts#L63) Volume level for the thinking sound (0-100). 0 means muted. Missing or null means full volume (100). *** ### thinkingSpeechPhrases?[​](#thinkingspeechphrases "Direct link to thinkingSpeechPhrases?") > `optional` **thinkingSpeechPhrases**: `string`\[] | `null` Defined in: [packages/sdk/src/types/model-config-types.ts:67](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/model-config-types.ts#L67) When `thinkingSound` is 'speech', one of these phrases is spoken while the agent runs a tool. Phrases rotate round-robin per session. *** ### ttsModel?[​](#ttsmodel "Direct link to ttsModel?") > `optional` **ttsModel**: [`TTSModel`](https://docs.gravityrail.com/sdk/type-aliases/TTSModel.md) | `null` Defined in: [packages/sdk/src/types/model-config-types.ts:73](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/model-config-types.ts#L73) TTS model ID in provider:tts:model format (e.g. 'elevenlabs:tts:eleven\_flash\_v2\_5'), or 'native'. *** ### voiceModel?[​](#voicemodel "Direct link to voiceModel?") > `optional` **voiceModel**: `string` | `null` Defined in: [packages/sdk/src/types/model-config-types.ts:75](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/model-config-types.ts#L75) Canonical voice identifier (e.g., elevenlabs:voice:catt) that selects the specific agent voice. --- # Interface: BillingResourceCounts Defined in: [packages/sdk/src/types/generated/billing.ts:202](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/billing.ts#L202) Resource counts for the workspace. Field names match the Resource enum values (singular snake\_case): * member -> Resource.MEMBER (all members) * phone\_number -> Resource.PHONE\_NUMBER * site -> Resource.SITE * inbox -> Resource.INBOX ## Properties[​](#properties "Direct link to Properties") ### inbox?[​](#inbox "Direct link to inbox?") > `optional` **inbox**: `number` Defined in: [packages/sdk/src/types/generated/billing.ts:206](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/billing.ts#L206) *** ### member?[​](#member "Direct link to member?") > `optional` **member**: `number` Defined in: [packages/sdk/src/types/generated/billing.ts:203](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/billing.ts#L203) *** ### phoneNumber?[​](#phonenumber "Direct link to phoneNumber?") > `optional` **phoneNumber**: `number` Defined in: [packages/sdk/src/types/generated/billing.ts:204](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/billing.ts#L204) *** ### site?[​](#site "Direct link to site?") > `optional` **site**: `number` Defined in: [packages/sdk/src/types/generated/billing.ts:205](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/billing.ts#L205) --- # Interface: BillingStatistics Defined in: [packages/sdk/src/types/stats-types.ts:125](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/stats-types.ts#L125) ## Properties[​](#properties "Direct link to Properties") ### costBreakdown[​](#costbreakdown "Direct link to costBreakdown") > **costBreakdown**: `object`\[] Defined in: [packages/sdk/src/types/stats-types.ts:129](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/stats-types.ts#L129) #### amount[​](#amount "Direct link to amount") > **amount**: `number` #### category[​](#category "Direct link to category") > **category**: `string` #### unit[​](#unit "Direct link to unit") > **unit**: `string` *** ### currentPeriodUsage[​](#currentperiodusage "Direct link to currentPeriodUsage") > **currentPeriodUsage**: [`UsageStatistics`](https://docs.gravityrail.com/sdk/interfaces/UsageStatistics.md) Defined in: [packages/sdk/src/types/stats-types.ts:126](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/stats-types.ts#L126) *** ### previousPeriodUsage[​](#previousperiodusage "Direct link to previousPeriodUsage") > **previousPeriodUsage**: [`UsageStatistics`](https://docs.gravityrail.com/sdk/interfaces/UsageStatistics.md) Defined in: [packages/sdk/src/types/stats-types.ts:127](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/stats-types.ts#L127) *** ### projectedUsage[​](#projectedusage "Direct link to projectedUsage") > **projectedUsage**: [`UsageStatistics`](https://docs.gravityrail.com/sdk/interfaces/UsageStatistics.md) Defined in: [packages/sdk/src/types/stats-types.ts:128](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/stats-types.ts#L128) --- # Interface: BillingUsageInfo Defined in: [packages/sdk/src/types/generated/billing.ts:389](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/billing.ts#L389) Usage information for billing period. ## Properties[​](#properties "Direct link to Properties") ### cachedUsage?[​](#cachedusage "Direct link to cachedUsage?") > `optional` **cachedUsage**: `UsageInfoCachedUsage` Defined in: [packages/sdk/src/types/generated/billing.ts:393](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/billing.ts#L393) *** ### discrepancies?[​](#discrepancies "Direct link to discrepancies?") > `optional` **discrepancies**: `UsageInfoDiscrepancies` Defined in: [packages/sdk/src/types/generated/billing.ts:395](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/billing.ts#L395) *** ### lastSynced?[​](#lastsynced "Direct link to lastSynced?") > `optional` **lastSynced**: `string` | `null` Defined in: [packages/sdk/src/types/generated/billing.ts:396](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/billing.ts#L396) *** ### periodEnd[​](#periodend "Direct link to periodEnd") > **periodEnd**: `string` Defined in: [packages/sdk/src/types/generated/billing.ts:391](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/billing.ts#L391) *** ### periodStart[​](#periodstart "Direct link to periodStart") > **periodStart**: `string` Defined in: [packages/sdk/src/types/generated/billing.ts:390](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/billing.ts#L390) *** ### platformUsage?[​](#platformusage "Direct link to platformUsage?") > `optional` **platformUsage**: `UsageInfoPlatformUsage` Defined in: [packages/sdk/src/types/generated/billing.ts:392](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/billing.ts#L392) *** ### stripeOverage?[​](#stripeoverage "Direct link to stripeOverage?") > `optional` **stripeOverage**: `UsageInfoStripeOverage` Defined in: [packages/sdk/src/types/generated/billing.ts:394](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/billing.ts#L394) *** ### syncError?[​](#syncerror "Direct link to syncError?") > `optional` **syncError**: `string` | `null` Defined in: [packages/sdk/src/types/generated/billing.ts:398](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/billing.ts#L398) *** ### syncStatus?[​](#syncstatus "Direct link to syncStatus?") > `optional` **syncStatus**: `string` Defined in: [packages/sdk/src/types/generated/billing.ts:397](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/billing.ts#L397) --- # Interface: BoardsResponse Defined in: [packages/sdk/src/api/monday.ts:37](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/monday.ts#L37) ## Properties[​](#properties "Direct link to Properties") ### boards[​](#boards "Direct link to boards") > **boards**: [`MondayBoard`](https://docs.gravityrail.com/sdk/interfaces/MondayBoard.md)\[] Defined in: [packages/sdk/src/api/monday.ts:38](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/monday.ts#L38) --- # Interface: BuilderListResponse Defined in: [packages/sdk/src/types/builder-types.ts:15](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/builder-types.ts#L15) ## Properties[​](#properties "Direct link to Properties") ### items[​](#items "Direct link to items") > **items**: [`BuilderResponse`](https://docs.gravityrail.com/sdk/interfaces/BuilderResponse.md)\[] Defined in: [packages/sdk/src/types/builder-types.ts:16](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/builder-types.ts#L16) *** ### total[​](#total "Direct link to total") > **total**: `number` Defined in: [packages/sdk/src/types/builder-types.ts:17](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/builder-types.ts#L17) --- # Interface: BuilderResponse Defined in: [packages/sdk/src/types/generated/builder.ts:11](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/builder.ts#L11) Response model for a builder. ## Properties[​](#properties "Direct link to Properties") ### appCount[​](#appcount "Direct link to appCount") > **appCount**: `number` Defined in: [packages/sdk/src/types/generated/builder.ts:23](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/builder.ts#L23) *** ### avatarImageMimeType?[​](#avatarimagemimetype "Direct link to avatarImageMimeType?") > `optional` **avatarImageMimeType**: `string` | `null` Defined in: [packages/sdk/src/types/generated/builder.ts:19](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/builder.ts#L19) *** ### avatarUrl?[​](#avatarurl "Direct link to avatarUrl?") > `optional` **avatarUrl**: `string` | `null` Defined in: [packages/sdk/src/types/generated/builder.ts:18](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/builder.ts#L18) *** ### createdAt[​](#createdat "Direct link to createdAt") > **createdAt**: `string` Defined in: [packages/sdk/src/types/generated/builder.ts:24](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/builder.ts#L24) *** ### description[​](#description "Direct link to description") > **description**: `string` | `null` Defined in: [packages/sdk/src/types/generated/builder.ts:15](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/builder.ts#L15) *** ### hasAvatar?[​](#hasavatar "Direct link to hasAvatar?") > `optional` **hasAvatar**: `boolean` | `null` Defined in: [packages/sdk/src/types/generated/builder.ts:17](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/builder.ts#L17) *** ### id[​](#id "Direct link to id") > **id**: `number` Defined in: [packages/sdk/src/types/generated/builder.ts:12](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/builder.ts#L12) *** ### isActive[​](#isactive "Direct link to isActive") > **isActive**: `boolean` Defined in: [packages/sdk/src/types/generated/builder.ts:20](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/builder.ts#L20) *** ### isDynamic?[​](#isdynamic "Direct link to isDynamic?") > `optional` **isDynamic**: `boolean` | `null` Defined in: [packages/sdk/src/types/generated/builder.ts:22](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/builder.ts#L22) *** ### isVerified[​](#isverified "Direct link to isVerified") > **isVerified**: `boolean` Defined in: [packages/sdk/src/types/generated/builder.ts:21](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/builder.ts#L21) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/generated/builder.ts:14](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/builder.ts#L14) *** ### siteUrl[​](#siteurl "Direct link to siteUrl") > **siteUrl**: `string` | `null` Defined in: [packages/sdk/src/types/generated/builder.ts:16](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/builder.ts#L16) *** ### updatedAt[​](#updatedat "Direct link to updatedAt") > **updatedAt**: `string` Defined in: [packages/sdk/src/types/generated/builder.ts:25](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/builder.ts#L25) *** ### uuid[​](#uuid "Direct link to uuid") > **uuid**: `string` Defined in: [packages/sdk/src/types/generated/builder.ts:13](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/builder.ts#L13) --- # Interface: BuildWorkspaceRequest Defined in: [packages/sdk/src/types/workspace-builder-types.ts:65](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/workspace-builder-types.ts#L65) ## Properties[​](#properties "Direct link to Properties") ### builderId[​](#builderid "Direct link to builderId") > **builderId**: `string` Defined in: [packages/sdk/src/types/workspace-builder-types.ts:66](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/workspace-builder-types.ts#L66) *** ### params[​](#params "Direct link to params") > **params**: `Record`<`string`, `unknown`> Defined in: [packages/sdk/src/types/workspace-builder-types.ts:67](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/workspace-builder-types.ts#L67) --- # Interface: BuildWorkspaceResponse Defined in: [packages/sdk/src/types/generated/workspace\_builder.ts:21](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/workspace_builder.ts#L21) Response containing the created workflow details. ## Properties[​](#properties "Direct link to Properties") ### workflowId[​](#workflowid "Direct link to workflowId") > **workflowId**: `number` Defined in: [packages/sdk/src/types/generated/workspace\_builder.ts:22](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/workspace_builder.ts#L22) *** ### workflowUuid[​](#workflowuuid "Direct link to workflowUuid") > **workflowUuid**: `string` Defined in: [packages/sdk/src/types/generated/workspace\_builder.ts:23](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/workspace_builder.ts#L23) --- # Interface: BulkCreateDataRecordRequest Defined in: [packages/sdk/src/types/data-types.ts:235](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L235) ## Properties[​](#properties "Direct link to Properties") ### dataTypeId[​](#datatypeid "Direct link to dataTypeId") > **dataTypeId**: `number` Defined in: [packages/sdk/src/types/data-types.ts:236](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L236) *** ### records[​](#records "Direct link to records") > **records**: [`DataRecordFormData`](https://docs.gravityrail.com/sdk/interfaces/DataRecordFormData.md)\[] Defined in: [packages/sdk/src/types/data-types.ts:237](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L237) *** ### upsert?[​](#upsert "Direct link to upsert?") > `optional` **upsert**: `boolean` Defined in: [packages/sdk/src/types/data-types.ts:238](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L238) --- # Interface: BulkCreateDataRecordResponse Defined in: [packages/sdk/src/types/data-types.ts:227](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L227) ## Properties[​](#properties "Direct link to Properties") ### errors?[​](#errors "Direct link to errors?") > `optional` **errors**: `string`\[] Defined in: [packages/sdk/src/types/data-types.ts:232](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L232) *** ### importedCount[​](#importedcount "Direct link to importedCount") > **importedCount**: `number` Defined in: [packages/sdk/src/types/data-types.ts:228](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L228) *** ### results[​](#results "Direct link to results") > **results**: [`BulkRecordResult`](https://docs.gravityrail.com/sdk/interfaces/BulkRecordResult.md)\[] Defined in: [packages/sdk/src/types/data-types.ts:231](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L231) *** ### success[​](#success "Direct link to success") > **success**: `boolean` Defined in: [packages/sdk/src/types/data-types.ts:230](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L230) *** ### totalCount[​](#totalcount "Direct link to totalCount") > **totalCount**: `number` Defined in: [packages/sdk/src/types/data-types.ts:229](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L229) --- # Interface: BulkCreateMembersRequest Defined in: [packages/sdk/src/types/member-types.ts:201](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L201) ## Properties[​](#properties "Direct link to Properties") ### members[​](#members "Direct link to members") > **members**: [`BulkMemberItem`](https://docs.gravityrail.com/sdk/interfaces/BulkMemberItem.md)\[] Defined in: [packages/sdk/src/types/member-types.ts:202](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L202) *** ### upsert?[​](#upsert "Direct link to upsert?") > `optional` **upsert**: `boolean` Defined in: [packages/sdk/src/types/member-types.ts:203](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L203) --- # Interface: BulkCreateMembersResponse Defined in: [packages/sdk/src/types/generated/member.ts:107](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L107) Bulk create members response. ## Properties[​](#properties "Direct link to Properties") ### errors?[​](#errors "Direct link to errors?") > `optional` **errors**: `string`\[] | `null` Defined in: [packages/sdk/src/types/generated/member.ts:112](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L112) *** ### importedCount[​](#importedcount "Direct link to importedCount") > **importedCount**: `number` Defined in: [packages/sdk/src/types/generated/member.ts:108](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L108) *** ### results[​](#results "Direct link to results") > **results**: [`BulkMemberResult`](https://docs.gravityrail.com/sdk/interfaces/BulkMemberResult.md)\[] Defined in: [packages/sdk/src/types/generated/member.ts:111](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L111) *** ### success[​](#success "Direct link to success") > **success**: `boolean` Defined in: [packages/sdk/src/types/generated/member.ts:110](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L110) *** ### totalCount[​](#totalcount "Direct link to totalCount") > **totalCount**: `number` Defined in: [packages/sdk/src/types/generated/member.ts:109](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L109) --- # Interface: BulkMemberItem Defined in: [packages/sdk/src/types/member-types.ts:185](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L185) ## Properties[​](#properties "Direct link to Properties") ### description?[​](#description "Direct link to description?") > `optional` **description**: `string` Defined in: [packages/sdk/src/types/member-types.ts:189](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L189) *** ### email?[​](#email "Direct link to email?") > `optional` **email**: `string` Defined in: [packages/sdk/src/types/member-types.ts:186](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L186) *** ### externalId?[​](#externalid "Direct link to externalId?") > `optional` **externalId**: `string` Defined in: [packages/sdk/src/types/member-types.ts:190](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L190) *** ### labels?[​](#labels "Direct link to labels?") > `optional` **labels**: `string`\[] Defined in: [packages/sdk/src/types/member-types.ts:192](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L192) *** ### locale?[​](#locale "Direct link to locale?") > `optional` **locale**: `string` Defined in: [packages/sdk/src/types/member-types.ts:197](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L197) *** ### memberRoleId?[​](#memberroleid "Direct link to memberRoleId?") > `optional` **memberRoleId**: `number` Defined in: [packages/sdk/src/types/member-types.ts:191](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L191) *** ### name?[​](#name "Direct link to name?") > `optional` **name**: `string` Defined in: [packages/sdk/src/types/member-types.ts:188](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L188) *** ### notifyEmail?[​](#notifyemail "Direct link to notifyEmail?") > `optional` **notifyEmail**: `boolean` Defined in: [packages/sdk/src/types/member-types.ts:194](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L194) *** ### notifySms?[​](#notifysms "Direct link to notifySms?") > `optional` **notifySms**: `boolean` Defined in: [packages/sdk/src/types/member-types.ts:193](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L193) *** ### notifyVoice?[​](#notifyvoice "Direct link to notifyVoice?") > `optional` **notifyVoice**: `boolean` Defined in: [packages/sdk/src/types/member-types.ts:195](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L195) *** ### notifyWhatsapp?[​](#notifywhatsapp "Direct link to notifyWhatsapp?") > `optional` **notifyWhatsapp**: `boolean` Defined in: [packages/sdk/src/types/member-types.ts:196](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L196) *** ### phone?[​](#phone "Direct link to phone?") > `optional` **phone**: `string` Defined in: [packages/sdk/src/types/member-types.ts:187](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L187) *** ### timezone?[​](#timezone "Direct link to timezone?") > `optional` **timezone**: `string` Defined in: [packages/sdk/src/types/member-types.ts:198](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L198) --- # Interface: BulkMemberResult Defined in: [packages/sdk/src/types/generated/member.ts:137](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L137) Per-member output for bulk creation. ## Properties[​](#properties "Direct link to Properties") ### error?[​](#error "Direct link to error?") > `optional` **error**: `string` | `null` Defined in: [packages/sdk/src/types/generated/member.ts:142](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L142) *** ### externalId?[​](#externalid "Direct link to externalId?") > `optional` **externalId**: `string` | `null` Defined in: [packages/sdk/src/types/generated/member.ts:141](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L141) *** ### index[​](#index "Direct link to index") > **index**: `number` Defined in: [packages/sdk/src/types/generated/member.ts:138](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L138) *** ### memberId?[​](#memberid "Direct link to memberId?") > `optional` **memberId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/member.ts:140](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L140) *** ### status[​](#status "Direct link to status") > **status**: [`BulkMemberResultStatus`](https://docs.gravityrail.com/sdk/type-aliases/BulkMemberResultStatus.md) Defined in: [packages/sdk/src/types/generated/member.ts:139](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L139) --- # Interface: BulkRecordResult Defined in: [packages/sdk/src/types/data-types.ts:220](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L220) ## Properties[​](#properties "Direct link to Properties") ### error?[​](#error "Direct link to error?") > `optional` **error**: `string` Defined in: [packages/sdk/src/types/data-types.ts:224](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L224) *** ### index[​](#index "Direct link to index") > **index**: `number` Defined in: [packages/sdk/src/types/data-types.ts:221](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L221) *** ### recordId?[​](#recordid "Direct link to recordId?") > `optional` **recordId**: `number` Defined in: [packages/sdk/src/types/data-types.ts:223](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L223) *** ### status[​](#status "Direct link to status") > **status**: `"created"` | `"updated"` | `"failed"` Defined in: [packages/sdk/src/types/data-types.ts:222](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L222) --- # Interface: BusinessHoursDay Defined in: [packages/sdk/src/types/workspace-types.ts:117](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/workspace-types.ts#L117) ## Properties[​](#properties "Direct link to Properties") ### day[​](#day "Direct link to day") > **day**: `"monday"` | `"tuesday"` | `"wednesday"` | `"thursday"` | `"friday"` | `"saturday"` | `"sunday"` Defined in: [packages/sdk/src/types/workspace-types.ts:118](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/workspace-types.ts#L118) *** ### enabled[​](#enabled "Direct link to enabled") > **enabled**: `boolean` Defined in: [packages/sdk/src/types/workspace-types.ts:119](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/workspace-types.ts#L119) *** ### end[​](#end "Direct link to end") > **end**: `string` | `null` Defined in: [packages/sdk/src/types/workspace-types.ts:121](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/workspace-types.ts#L121) *** ### start[​](#start "Direct link to start") > **start**: `string` | `null` Defined in: [packages/sdk/src/types/workspace-types.ts:120](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/workspace-types.ts#L120) --- # Interface: BusinessInfo Defined in: [packages/sdk/src/types/generated/organization.ts:159](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L159) Business identity fields stored on the Twilio business End-User. Field shape mirrors Twilio's `customer_profile_business_information` EndUser type. `dba` is intentionally absent — Twilio's schema has no DBA attribute, and unknown attributes are rejected with code 70002. ## Properties[​](#properties "Direct link to Properties") ### businessType[​](#businesstype "Direct link to businessType") > **businessType**: [`BusinessType`](https://docs.gravityrail.com/sdk/type-aliases/BusinessType.md) Defined in: [packages/sdk/src/types/generated/organization.ts:166](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L166) *** ### industry[​](#industry "Direct link to industry") > **industry**: [`BusinessIndustry`](https://docs.gravityrail.com/sdk/type-aliases/BusinessIndustry.md) Defined in: [packages/sdk/src/types/generated/organization.ts:165](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L165) *** ### legalName[​](#legalname "Direct link to legalName") > **legalName**: `string` Defined in: [packages/sdk/src/types/generated/organization.ts:164](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L164) #### Min Length[​](#min-length "Direct link to Min Length") 1 #### Max Length[​](#max-length "Direct link to Max Length") 100 *** ### regionsOfOperation[​](#regionsofoperation "Direct link to regionsOfOperation") > **regionsOfOperation**: [`Region`](https://docs.gravityrail.com/sdk/type-aliases/Region.md)\[] Defined in: [packages/sdk/src/types/generated/organization.ts:174](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L174) #### Min Items[​](#min-items "Direct link to Min Items") 1 *** ### registrationIdentifier[​](#registrationidentifier "Direct link to registrationIdentifier") > **registrationIdentifier**: [`RegistrationIdentifier`](https://docs.gravityrail.com/sdk/type-aliases/RegistrationIdentifier.md) Defined in: [packages/sdk/src/types/generated/organization.ts:172](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L172) *** ### registrationNumber[​](#registrationnumber "Direct link to registrationNumber") > **registrationNumber**: `string` Defined in: [packages/sdk/src/types/generated/organization.ts:171](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L171) #### Min Length[​](#min-length-1 "Direct link to Min Length") 1 #### Max Length[​](#max-length-1 "Direct link to Max Length") 64 *** ### websiteUrl[​](#websiteurl "Direct link to websiteUrl") > **websiteUrl**: `string` Defined in: [packages/sdk/src/types/generated/organization.ts:179](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L179) #### Min Length[​](#min-length-2 "Direct link to Min Length") 1 #### Max Length[​](#max-length-2 "Direct link to Max Length") 2083 --- # Interface: BusinessProfileCancelResponse Defined in: [packages/sdk/src/types/generated/organization.ts:182](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L182) Public organization configuration types. Server response shapes are generated from Pydantic via emit\_openapi.py → Orval. Client-only request types and unions are defined below. ## Properties[​](#properties "Direct link to Properties") ### status[​](#status "Direct link to status") > **status**: `string` Defined in: [packages/sdk/src/types/generated/organization.ts:183](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L183) --- # Interface: BusinessProfileSubmitResponse Defined in: [packages/sdk/src/types/generated/organization.ts:223](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L223) Public organization configuration types. Server response shapes are generated from Pydantic via emit\_openapi.py → Orval. Client-only request types and unions are defined below. ## Properties[​](#properties "Direct link to Properties") ### status[​](#status "Direct link to status") > **status**: `BusinessProfileSubmitResponseStatus` Defined in: [packages/sdk/src/types/generated/organization.ts:224](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L224) *** ### workflowId[​](#workflowid "Direct link to workflowId") > **workflowId**: `string` Defined in: [packages/sdk/src/types/generated/organization.ts:225](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L225) --- # Interface: CalendarBookingAbilityConfig Defined in: [packages/sdk/src/types/ability-types.ts:84](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ability-types.ts#L84) Config for calendar\_booking ability ## Properties[​](#properties "Direct link to Properties") ### calendarUuid[​](#calendaruuid "Direct link to calendarUuid") > **calendarUuid**: `string` Defined in: [packages/sdk/src/types/ability-types.ts:85](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ability-types.ts#L85) *** ### canEditBookings?[​](#caneditbookings "Direct link to canEditBookings?") > `optional` **canEditBookings**: `boolean` Defined in: [packages/sdk/src/types/ability-types.ts:88](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ability-types.ts#L88) *** ### eventTypeUuid?[​](#eventtypeuuid "Direct link to eventTypeUuid?") > `optional` **eventTypeUuid**: `string` Defined in: [packages/sdk/src/types/ability-types.ts:87](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ability-types.ts#L87) Optional: specific event type UUID, or undefined to allow all event types --- # Interface: CalendarEventFormData Defined in: [packages/sdk/src/types/calendar-types.ts:126](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/calendar-types.ts#L126) ## Properties[​](#properties "Direct link to Properties") ### assignmentId?[​](#assignmentid "Direct link to assignmentId?") > `optional` **assignmentId**: `number` | `null` Defined in: [packages/sdk/src/types/calendar-types.ts:136](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/calendar-types.ts#L136) *** ### attendeeIds[​](#attendeeids "Direct link to attendeeIds") > **attendeeIds**: `number`\[] Defined in: [packages/sdk/src/types/calendar-types.ts:133](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/calendar-types.ts#L133) *** ### calendarId[​](#calendarid "Direct link to calendarId") > **calendarId**: `number` Defined in: [packages/sdk/src/types/calendar-types.ts:127](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/calendar-types.ts#L127) *** ### description?[​](#description "Direct link to description?") > `optional` **description**: `string` | `null` Defined in: [packages/sdk/src/types/calendar-types.ts:130](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/calendar-types.ts#L130) *** ### eventTypeId[​](#eventtypeid "Direct link to eventTypeId") > **eventTypeId**: `number` Defined in: [packages/sdk/src/types/calendar-types.ts:128](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/calendar-types.ts#L128) *** ### location?[​](#location "Direct link to location?") > `optional` **location**: `string` | `null` Defined in: [packages/sdk/src/types/calendar-types.ts:131](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/calendar-types.ts#L131) *** ### startTime[​](#starttime "Direct link to startTime") > **startTime**: `string` Defined in: [packages/sdk/src/types/calendar-types.ts:132](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/calendar-types.ts#L132) *** ### taskId?[​](#taskid "Direct link to taskId?") > `optional` **taskId**: `number` | `null` Defined in: [packages/sdk/src/types/calendar-types.ts:135](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/calendar-types.ts#L135) *** ### title[​](#title "Direct link to title") > **title**: `string` Defined in: [packages/sdk/src/types/calendar-types.ts:129](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/calendar-types.ts#L129) *** ### workflowId?[​](#workflowid "Direct link to workflowId?") > `optional` **workflowId**: `number` | `null` Defined in: [packages/sdk/src/types/calendar-types.ts:134](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/calendar-types.ts#L134) --- # Interface: CalendarEventsQueryParams Defined in: [packages/sdk/src/types/calendar-types.ts:177](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/calendar-types.ts#L177) ## Properties[​](#properties "Direct link to Properties") ### calendarId?[​](#calendarid "Direct link to calendarId?") > `optional` **calendarId**: `number` Defined in: [packages/sdk/src/types/calendar-types.ts:178](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/calendar-types.ts#L178) *** ### endDate?[​](#enddate "Direct link to endDate?") > `optional` **endDate**: `string` Defined in: [packages/sdk/src/types/calendar-types.ts:180](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/calendar-types.ts#L180) *** ### limit?[​](#limit "Direct link to limit?") > `optional` **limit**: `number` Defined in: [packages/sdk/src/types/calendar-types.ts:183](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/calendar-types.ts#L183) *** ### memberId?[​](#memberid "Direct link to memberId?") > `optional` **memberId**: `number` Defined in: [packages/sdk/src/types/calendar-types.ts:182](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/calendar-types.ts#L182) *** ### offset?[​](#offset "Direct link to offset?") > `optional` **offset**: `number` Defined in: [packages/sdk/src/types/calendar-types.ts:184](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/calendar-types.ts#L184) *** ### startDate?[​](#startdate "Direct link to startDate?") > `optional` **startDate**: `string` Defined in: [packages/sdk/src/types/calendar-types.ts:179](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/calendar-types.ts#L179) *** ### status?[​](#status "Direct link to status?") > `optional` **status**: [`CalendarEventStatus`](https://docs.gravityrail.com/sdk/enumerations/CalendarEventStatus.md) Defined in: [packages/sdk/src/types/calendar-types.ts:181](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/calendar-types.ts#L181) --- # Interface: CalendarEventTypeFormData Defined in: [packages/sdk/src/types/calendar-types.ts:108](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/calendar-types.ts#L108) ## Properties[​](#properties "Direct link to Properties") ### active?[​](#active "Direct link to active?") > `optional` **active**: `boolean` Defined in: [packages/sdk/src/types/calendar-types.ts:118](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/calendar-types.ts#L118) *** ### bufferAfterMinutes?[​](#bufferafterminutes "Direct link to bufferAfterMinutes?") > `optional` **bufferAfterMinutes**: `number` Defined in: [packages/sdk/src/types/calendar-types.ts:114](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/calendar-types.ts#L114) *** ### bufferBeforeMinutes?[​](#bufferbeforeminutes "Direct link to bufferBeforeMinutes?") > `optional` **bufferBeforeMinutes**: `number` Defined in: [packages/sdk/src/types/calendar-types.ts:113](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/calendar-types.ts#L113) *** ### color?[​](#color "Direct link to color?") > `optional` **color**: `string` | `null` Defined in: [packages/sdk/src/types/calendar-types.ts:117](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/calendar-types.ts#L117) *** ### defaultDurationMinutes[​](#defaultdurationminutes "Direct link to defaultDurationMinutes") > **defaultDurationMinutes**: `number` Defined in: [packages/sdk/src/types/calendar-types.ts:112](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/calendar-types.ts#L112) *** ### description?[​](#description "Direct link to description?") > `optional` **description**: `string` | `null` Defined in: [packages/sdk/src/types/calendar-types.ts:111](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/calendar-types.ts#L111) *** ### eventRules?[​](#eventrules "Direct link to eventRules?") > `optional` **eventRules**: [`EventRuleInput`](https://docs.gravityrail.com/sdk/interfaces/EventRuleInput.md)\[] Defined in: [packages/sdk/src/types/calendar-types.ts:123](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/calendar-types.ts#L123) Ordered event rules scoped to this event type. Server syncs by UUID: same-UUID updates, new UUID creates, omitted UUIDs are deleted. *** ### maxAttendees?[​](#maxattendees "Direct link to maxAttendees?") > `optional` **maxAttendees**: `number` | `null` Defined in: [packages/sdk/src/types/calendar-types.ts:116](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/calendar-types.ts#L116) *** ### minAttendees?[​](#minattendees "Direct link to minAttendees?") > `optional` **minAttendees**: `number` Defined in: [packages/sdk/src/types/calendar-types.ts:115](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/calendar-types.ts#L115) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/calendar-types.ts:109](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/calendar-types.ts#L109) *** ### slug?[​](#slug "Direct link to slug?") > `optional` **slug**: `string` Defined in: [packages/sdk/src/types/calendar-types.ts:110](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/calendar-types.ts#L110) --- # Interface: CalendarFormData Defined in: [packages/sdk/src/types/calendar-types.ts:65](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/calendar-types.ts#L65) ## Properties[​](#properties "Direct link to Properties") ### color?[​](#color "Direct link to color?") > `optional` **color**: `string` | `null` Defined in: [packages/sdk/src/types/calendar-types.ts:70](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/calendar-types.ts#L70) *** ### description?[​](#description "Direct link to description?") > `optional` **description**: `string` | `null` Defined in: [packages/sdk/src/types/calendar-types.ts:68](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/calendar-types.ts#L68) *** ### eventRules?[​](#eventrules "Direct link to eventRules?") > `optional` **eventRules**: [`EventRuleInput`](https://docs.gravityrail.com/sdk/interfaces/EventRuleInput.md)\[] Defined in: [packages/sdk/src/types/calendar-types.ts:78](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/calendar-types.ts#L78) Ordered event rules to attach to the calendar in the same request. Server syncs by UUID: same-UUID updates, new UUID creates, omitted UUIDs are deleted. Omit (undefined) to leave existing rules unchanged. *** ### eventTypeIds?[​](#eventtypeids "Direct link to eventTypeIds?") > `optional` **eventTypeIds**: `number`\[] Defined in: [packages/sdk/src/types/calendar-types.ts:72](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/calendar-types.ts#L72) *** ### isPublic?[​](#ispublic "Direct link to isPublic?") > `optional` **isPublic**: `boolean` Defined in: [packages/sdk/src/types/calendar-types.ts:71](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/calendar-types.ts#L71) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/calendar-types.ts:66](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/calendar-types.ts#L66) *** ### slug?[​](#slug "Direct link to slug?") > `optional` **slug**: `string` Defined in: [packages/sdk/src/types/calendar-types.ts:67](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/calendar-types.ts#L67) *** ### timezone?[​](#timezone "Direct link to timezone?") > `optional` **timezone**: `string` Defined in: [packages/sdk/src/types/calendar-types.ts:69](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/calendar-types.ts#L69) --- # Interface: CalendarScheduleFormData Defined in: [packages/sdk/src/types/calendar-types.ts:81](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/calendar-types.ts#L81) ## Properties[​](#properties "Direct link to Properties") ### availabilityType[​](#availabilitytype "Direct link to availabilityType") > **availabilityType**: [`CalendarScheduleAvailabilityType`](https://docs.gravityrail.com/sdk/enumerations/CalendarScheduleAvailabilityType.md) Defined in: [packages/sdk/src/types/calendar-types.ts:84](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/calendar-types.ts#L84) *** ### daysOfWeek?[​](#daysofweek "Direct link to daysOfWeek?") > `optional` **daysOfWeek**: `string`\[] | `null` Defined in: [packages/sdk/src/types/calendar-types.ts:90](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/calendar-types.ts#L90) *** ### description?[​](#description "Direct link to description?") > `optional` **description**: `string` | `null` Defined in: [packages/sdk/src/types/calendar-types.ts:83](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/calendar-types.ts#L83) *** ### endTime[​](#endtime "Direct link to endTime") > **endTime**: `string` Defined in: [packages/sdk/src/types/calendar-types.ts:87](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/calendar-types.ts#L87) *** ### eventTypeIds?[​](#eventtypeids "Direct link to eventTypeIds?") > `optional` **eventTypeIds**: `number`\[] | `null` Defined in: [packages/sdk/src/types/calendar-types.ts:92](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/calendar-types.ts#L92) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/calendar-types.ts:82](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/calendar-types.ts#L82) *** ### priority?[​](#priority "Direct link to priority?") > `optional` **priority**: `number` Defined in: [packages/sdk/src/types/calendar-types.ts:91](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/calendar-types.ts#L91) *** ### recurrenceEndDate?[​](#recurrenceenddate "Direct link to recurrenceEndDate?") > `optional` **recurrenceEndDate**: `string` | `null` Defined in: [packages/sdk/src/types/calendar-types.ts:89](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/calendar-types.ts#L89) *** ### recurrenceRule?[​](#recurrencerule "Direct link to recurrenceRule?") > `optional` **recurrenceRule**: `Record`<`string`, `any`> | `null` Defined in: [packages/sdk/src/types/calendar-types.ts:88](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/calendar-types.ts#L88) *** ### recurrenceType[​](#recurrencetype "Direct link to recurrenceType") > **recurrenceType**: [`CalendarScheduleRecurrence`](https://docs.gravityrail.com/sdk/enumerations/CalendarScheduleRecurrence.md) Defined in: [packages/sdk/src/types/calendar-types.ts:85](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/calendar-types.ts#L85) *** ### startTime[​](#starttime "Direct link to startTime") > **startTime**: `string` Defined in: [packages/sdk/src/types/calendar-types.ts:86](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/calendar-types.ts#L86) --- # Interface: CancelCredentialChangeInviteResponse Defined in: [packages/sdk/src/types/generated/account.ts:164](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L164) Response after canceling a credential change invitation. ## Properties[​](#properties "Direct link to Properties") ### message[​](#message "Direct link to message") > **message**: `string` Defined in: [packages/sdk/src/types/generated/account.ts:166](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L166) *** ### success[​](#success "Direct link to success") > **success**: `boolean` Defined in: [packages/sdk/src/types/generated/account.ts:165](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L165) --- # Interface: CancelCredentialChangeResponse Defined in: [packages/sdk/src/types/generated/account.ts:172](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L172) Response after canceling a credential change request. ## Properties[​](#properties "Direct link to Properties") ### message[​](#message "Direct link to message") > **message**: `string` Defined in: [packages/sdk/src/types/generated/account.ts:174](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L174) *** ### success[​](#success "Direct link to success") > **success**: `boolean` Defined in: [packages/sdk/src/types/generated/account.ts:173](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L173) --- # Interface: CELContextRequest Defined in: [packages/sdk/src/types/cel-types.ts:29](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/cel-types.ts#L29) Parameters for requesting CEL context. ## Properties[​](#properties "Direct link to Properties") ### contextType?[​](#contexttype "Direct link to contextType?") > `optional` **contextType**: `"event_rule"` | `"task_guard"` | `"edge_condition"` | `"journey_goal_completion"` | `"experiment_eligibility"` | `"function_field"` | `"validate_field"` | `"qualification_criterion"` | `"sync_filter"` Defined in: [packages/sdk/src/types/cel-types.ts:35](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/cel-types.ts#L35) *** ### dataTypeId?[​](#datatypeid "Direct link to dataTypeId?") > `optional` **dataTypeId**: `number` Defined in: [packages/sdk/src/types/cel-types.ts:32](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/cel-types.ts#L32) *** ### eventType?[​](#eventtype "Direct link to eventType?") > `optional` **eventType**: `string` Defined in: [packages/sdk/src/types/cel-types.ts:33](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/cel-types.ts#L33) *** ### objectType?[​](#objecttype "Direct link to objectType?") > `optional` **objectType**: `string` Defined in: [packages/sdk/src/types/cel-types.ts:34](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/cel-types.ts#L34) *** ### syncDirection?[​](#syncdirection "Direct link to syncDirection?") > `optional` **syncDirection**: `"outbound"` | `"inbound"` Defined in: [packages/sdk/src/types/cel-types.ts:45](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/cel-types.ts#L45) *** ### taskId?[​](#taskid "Direct link to taskId?") > `optional` **taskId**: `number` Defined in: [packages/sdk/src/types/cel-types.ts:31](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/cel-types.ts#L31) *** ### workflowId?[​](#workflowid "Direct link to workflowId?") > `optional` **workflowId**: `number` Defined in: [packages/sdk/src/types/cel-types.ts:30](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/cel-types.ts#L30) --- # Interface: CELContextResponse Defined in: [packages/sdk/src/types/cel-types.ts:51](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/cel-types.ts#L51) Response containing available CEL context for editing. ## Properties[​](#properties "Direct link to Properties") ### customFunctions[​](#customfunctions "Direct link to customFunctions") > **customFunctions**: [`CELFunction`](https://docs.gravityrail.com/sdk/interfaces/CELFunction.md)\[] Defined in: [packages/sdk/src/types/cel-types.ts:54](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/cel-types.ts#L54) *** ### namespaces[​](#namespaces "Direct link to namespaces") > **namespaces**: `string`\[] Defined in: [packages/sdk/src/types/cel-types.ts:53](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/cel-types.ts#L53) *** ### operators[​](#operators "Direct link to operators") > **operators**: `string`\[] Defined in: [packages/sdk/src/types/cel-types.ts:55](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/cel-types.ts#L55) *** ### variables[​](#variables "Direct link to variables") > **variables**: [`CELVariable`](https://docs.gravityrail.com/sdk/interfaces/CELVariable.md)\[] Defined in: [packages/sdk/src/types/cel-types.ts:52](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/cel-types.ts#L52) --- # Interface: CELFunction Defined in: [packages/sdk/src/types/cel-types.ts:19](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/cel-types.ts#L19) A CEL custom function available for use in expressions. ## Properties[​](#properties "Direct link to Properties") ### description[​](#description "Direct link to description") > **description**: `string` Defined in: [packages/sdk/src/types/cel-types.ts:22](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/cel-types.ts#L22) *** ### examples[​](#examples "Direct link to examples") > **examples**: `string`\[] Defined in: [packages/sdk/src/types/cel-types.ts:23](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/cel-types.ts#L23) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/cel-types.ts:20](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/cel-types.ts#L20) *** ### signature[​](#signature "Direct link to signature") > **signature**: `string` Defined in: [packages/sdk/src/types/cel-types.ts:21](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/cel-types.ts#L21) --- # Interface: CELVariable Defined in: [packages/sdk/src/types/cel-types.ts:8](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/cel-types.ts#L8) A CEL variable available for autocomplete. ## Properties[​](#properties "Direct link to Properties") ### description[​](#description "Direct link to description") > **description**: `string` Defined in: [packages/sdk/src/types/cel-types.ts:11](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/cel-types.ts#L11) *** ### example[​](#example "Direct link to example") > **example**: `unknown` Defined in: [packages/sdk/src/types/cel-types.ts:12](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/cel-types.ts#L12) *** ### namespace[​](#namespace "Direct link to namespace") > **namespace**: `string` Defined in: [packages/sdk/src/types/cel-types.ts:13](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/cel-types.ts#L13) *** ### path[​](#path "Direct link to path") > **path**: `string` Defined in: [packages/sdk/src/types/cel-types.ts:9](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/cel-types.ts#L9) *** ### type[​](#type "Direct link to type") > **type**: `string` Defined in: [packages/sdk/src/types/cel-types.ts:10](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/cel-types.ts#L10) --- # Interface: ChangeWorkspaceProductRequest Defined in: [packages/sdk/src/types/generated/workspace\_health.ts:26](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/workspace_health.ts#L26) Request body for switching a workspace's product (plan). The caller supplies the target product id only — the server resolves the active workspace SubscriptionItem, updates the matching Stripe workspace line item when one exists (`proration_behavior=none`), and re-syncs workspace features. Provisioning is not re-run. ## Properties[​](#properties "Direct link to Properties") ### productId[​](#productid "Direct link to productId") > **productId**: `number` Defined in: [packages/sdk/src/types/generated/workspace\_health.ts:27](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/workspace_health.ts#L27) --- # Interface: ChangeWorkspaceProductResponse Defined in: [packages/sdk/src/types/generated/workspace\_health.ts:33](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/workspace_health.ts#L33) Response payload for a successful workspace product switch. ## Properties[​](#properties "Direct link to Properties") ### addedFeatures[​](#addedfeatures "Direct link to addedFeatures") > **addedFeatures**: `string`\[] Defined in: [packages/sdk/src/types/generated/workspace\_health.ts:41](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/workspace_health.ts#L41) *** ### newProductId[​](#newproductid "Direct link to newProductId") > **newProductId**: `number` Defined in: [packages/sdk/src/types/generated/workspace\_health.ts:38](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/workspace_health.ts#L38) *** ### newProductName[​](#newproductname "Direct link to newProductName") > **newProductName**: `string` Defined in: [packages/sdk/src/types/generated/workspace\_health.ts:40](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/workspace_health.ts#L40) *** ### previousProductId[​](#previousproductid "Direct link to previousProductId") > **previousProductId**: `number` Defined in: [packages/sdk/src/types/generated/workspace\_health.ts:37](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/workspace_health.ts#L37) *** ### previousProductName[​](#previousproductname "Direct link to previousProductName") > **previousProductName**: `string` Defined in: [packages/sdk/src/types/generated/workspace\_health.ts:39](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/workspace_health.ts#L39) *** ### removedFeatures[​](#removedfeatures "Direct link to removedFeatures") > **removedFeatures**: `string`\[] Defined in: [packages/sdk/src/types/generated/workspace\_health.ts:42](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/workspace_health.ts#L42) *** ### stripeSkipReason?[​](#stripeskipreason "Direct link to stripeSkipReason?") > `optional` **stripeSkipReason**: `string` | `null` Defined in: [packages/sdk/src/types/generated/workspace\_health.ts:44](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/workspace_health.ts#L44) *** ### stripeUpdated?[​](#stripeupdated "Direct link to stripeUpdated?") > `optional` **stripeUpdated**: `boolean` Defined in: [packages/sdk/src/types/generated/workspace\_health.ts:43](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/workspace_health.ts#L43) *** ### subscriptionId[​](#subscriptionid "Direct link to subscriptionId") > **subscriptionId**: `number` Defined in: [packages/sdk/src/types/generated/workspace\_health.ts:35](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/workspace_health.ts#L35) *** ### subscriptionItemId[​](#subscriptionitemid "Direct link to subscriptionItemId") > **subscriptionItemId**: `number` Defined in: [packages/sdk/src/types/generated/workspace\_health.ts:36](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/workspace_health.ts#L36) *** ### workspaceUuid[​](#workspaceuuid "Direct link to workspaceUuid") > **workspaceUuid**: `string` Defined in: [packages/sdk/src/types/generated/workspace\_health.ts:34](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/workspace_health.ts#L34) --- # Interface: ChannelErrorBreakdown Defined in: [packages/sdk/src/types/health-dashboard-types.ts:38](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/health-dashboard-types.ts#L38) ## Properties[​](#properties "Direct link to Properties") ### byCodes[​](#bycodes "Direct link to byCodes") > **byCodes**: [`ErrorCodeBucket`](https://docs.gravityrail.com/sdk/interfaces/ErrorCodeBucket.md)\[] Defined in: [packages/sdk/src/types/health-dashboard-types.ts:39](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/health-dashboard-types.ts#L39) *** ### topResources[​](#topresources "Direct link to topResources") > **topResources**: [`TopOffender`](https://docs.gravityrail.com/sdk/interfaces/TopOffender.md)\[] Defined in: [packages/sdk/src/types/health-dashboard-types.ts:40](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/health-dashboard-types.ts#L40) --- # Interface: ChannelFailures Defined in: [packages/sdk/src/types/generated/health\_dashboard.ts:11](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/health_dashboard.ts#L11) Channel delivery failure and volume counts. ## Properties[​](#properties "Direct link to Properties") ### emailFailures?[​](#emailfailures "Direct link to emailFailures?") > `optional` **emailFailures**: `number` Defined in: [packages/sdk/src/types/generated/health\_dashboard.ts:18](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/health_dashboard.ts#L18) *** ### emailTotal?[​](#emailtotal "Direct link to emailTotal?") > `optional` **emailTotal**: `number` Defined in: [packages/sdk/src/types/generated/health\_dashboard.ts:19](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/health_dashboard.ts#L19) *** ### smsFailures?[​](#smsfailures "Direct link to smsFailures?") > `optional` **smsFailures**: `number` Defined in: [packages/sdk/src/types/generated/health\_dashboard.ts:12](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/health_dashboard.ts#L12) *** ### smsOutboundChats?[​](#smsoutboundchats "Direct link to smsOutboundChats?") > `optional` **smsOutboundChats**: `number` Defined in: [packages/sdk/src/types/generated/health\_dashboard.ts:15](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/health_dashboard.ts#L15) *** ### smsResponded?[​](#smsresponded "Direct link to smsResponded?") > `optional` **smsResponded**: `number` Defined in: [packages/sdk/src/types/generated/health\_dashboard.ts:14](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/health_dashboard.ts#L14) *** ### smsTopFailurePhoneNumberId?[​](#smstopfailurephonenumberid "Direct link to smsTopFailurePhoneNumberId?") > `optional` **smsTopFailurePhoneNumberId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/health\_dashboard.ts:20](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/health_dashboard.ts#L20) *** ### smsTotal?[​](#smstotal "Direct link to smsTotal?") > `optional` **smsTotal**: `number` Defined in: [packages/sdk/src/types/generated/health\_dashboard.ts:13](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/health_dashboard.ts#L13) *** ### voiceFailures?[​](#voicefailures "Direct link to voiceFailures?") > `optional` **voiceFailures**: `number` Defined in: [packages/sdk/src/types/generated/health\_dashboard.ts:16](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/health_dashboard.ts#L16) *** ### voiceTopFailurePhoneNumberId?[​](#voicetopfailurephonenumberid "Direct link to voiceTopFailurePhoneNumberId?") > `optional` **voiceTopFailurePhoneNumberId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/health\_dashboard.ts:21](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/health_dashboard.ts#L21) *** ### voiceTotal?[​](#voicetotal "Direct link to voiceTotal?") > `optional` **voiceTotal**: `number` Defined in: [packages/sdk/src/types/generated/health\_dashboard.ts:17](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/health_dashboard.ts#L17) --- # Interface: CharlestonPmdAbilityConfig Defined in: [packages/sdk/src/types/ability-types.ts:327](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ability-types.ts#L327) Config for the Charleston Nephrology PMD paging ability. ## Properties[​](#properties "Direct link to Properties") ### escalationWorkflowUuid?[​](#escalationworkflowuuid "Direct link to escalationWorkflowUuid?") > `optional` **escalationWorkflowUuid**: `string` | `null` Defined in: [packages/sdk/src/types/ability-types.ts:346](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ability-types.ts#L346) UUID of the workspace Workflow an answered after-hours escalation call is connected to. Required at save time. The final phone ladder is no longer time-window constrained: once both PMD pages go unread on an after-hours-ladder route, group members are always called in priority order. The manual-escalation contact list was removed entirely: manual escalation now sends the OperatorGroup a generic, PHI-free incident notification that links to the incident DataRecord. *** ### operatorGroupUuid[​](#operatorgroupuuid "Direct link to operatorGroupUuid") > **operatorGroupUuid**: `string` Defined in: [packages/sdk/src/types/ability-types.ts:334](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ability-types.ts#L334) UUID of the workspace OperatorGroup whose members are the roster for manual-escalation notifications and the after-hours escalation-call ladder. Picked from the workspace's OperatorGroup list in the ability config UI. *** ### patientsyncBackstopContactMemberUuid?[​](#patientsyncbackstopcontactmemberuuid "Direct link to patientsyncBackstopContactMemberUuid?") > `optional` **patientsyncBackstopContactMemberUuid**: `string` | `null` Defined in: [packages/sdk/src/types/ability-types.ts:364](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ability-types.ts#L364) Contact Member who owns the backstop outbound chat (phone overridden at dial). *** ### patientsyncBackstopWorkflowUuid?[​](#patientsyncbackstopworkflowuuid "Direct link to patientsyncBackstopWorkflowUuid?") > `optional` **patientsyncBackstopWorkflowUuid**: `string` | `null` Defined in: [packages/sdk/src/types/ability-types.ts:362](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ability-types.ts#L362) Optional PatientSync call-center backstop: after the escalation ladder is exhausted, POST incident context to PatientSync and dial the returned number with this voice Workflow. Requires patientsync\_transfer feature. *** ### simulationOutcome?[​](#simulationoutcome "Direct link to simulationOutcome?") > `optional` **simulationOutcome**: [`CharlestonPmdSimulationOutcome`](https://docs.gravityrail.com/sdk/type-aliases/CharlestonPmdSimulationOutcome.md) | `null` Defined in: [packages/sdk/src/types/ability-types.ts:356](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ability-types.ts#L356) Workflow-scoped PMD paging simulation switch. Absent/null = NORMAL production behavior (real PatientSync pages, real contacts) — production Workflow 7 leaves this unset. Any allowed value makes THIS workflow's pages simulated: PatientSync is never contacted and human contact is restricted to Members labeled 'cna\_pmd\_simulation\_safe\_contact'. Set it only on a cloned test Workflow, never production. The value is a PHI-free enum and never changes the send tool's argument schema. --- # Interface: ChatActivityEvent Defined in: [packages/sdk/src/types/operator-types.ts:139](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/operator-types.ts#L139) Server -> Client: Chat activity event (from workspace pub/sub) ## Properties[​](#properties "Direct link to Properties") ### channel?[​](#channel "Direct link to channel?") > `optional` **channel**: [`Channel`](https://docs.gravityrail.com/sdk/type-aliases/Channel.md) Defined in: [packages/sdk/src/types/operator-types.ts:143](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/operator-types.ts#L143) *** ### chatId[​](#chatid "Direct link to chatId") > **chatId**: `number` Defined in: [packages/sdk/src/types/operator-types.ts:141](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/operator-types.ts#L141) *** ### chatTitle?[​](#chattitle "Direct link to chatTitle?") > `optional` **chatTitle**: `string` Defined in: [packages/sdk/src/types/operator-types.ts:146](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/operator-types.ts#L146) *** ### event[​](#event "Direct link to event") > **event**: `"message"` | `"started"` | `"message_complete"` | `"ended"` Defined in: [packages/sdk/src/types/operator-types.ts:142](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/operator-types.ts#L142) *** ### memberName?[​](#membername "Direct link to memberName?") > `optional` **memberName**: `string` Defined in: [packages/sdk/src/types/operator-types.ts:145](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/operator-types.ts#L145) *** ### role?[​](#role "Direct link to role?") > `optional` **role**: `"user"` | `"assistant"` Defined in: [packages/sdk/src/types/operator-types.ts:144](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/operator-types.ts#L144) *** ### timestamp[​](#timestamp "Direct link to timestamp") > **timestamp**: `string` Defined in: [packages/sdk/src/types/operator-types.ts:147](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/operator-types.ts#L147) *** ### type[​](#type "Direct link to type") > **type**: `"chat_activity"` Defined in: [packages/sdk/src/types/operator-types.ts:140](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/operator-types.ts#L140) --- # Interface: ChatCompletionError Defined in: [packages/sdk/src/types/communication-types.ts:266](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/communication-types.ts#L266) ## Properties[​](#properties "Direct link to Properties") ### debug\_details?[​](#debug_details "Direct link to debug_details?") > `optional` **debug\_details**: `string` Defined in: [packages/sdk/src/types/communication-types.ts:271](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/communication-types.ts#L271) *** ### error\_code[​](#error_code "Direct link to error_code") > **error\_code**: `string` Defined in: [packages/sdk/src/types/communication-types.ts:268](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/communication-types.ts#L268) *** ### error\_type[​](#error_type "Direct link to error_type") > **error\_type**: `string` Defined in: [packages/sdk/src/types/communication-types.ts:269](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/communication-types.ts#L269) *** ### id[​](#id "Direct link to id") > **id**: `string` Defined in: [packages/sdk/src/types/communication-types.ts:267](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/communication-types.ts#L267) *** ### timestamp[​](#timestamp "Direct link to timestamp") > **timestamp**: `string` Defined in: [packages/sdk/src/types/communication-types.ts:272](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/communication-types.ts#L272) *** ### user\_message[​](#user_message "Direct link to user_message") > **user\_message**: `string` Defined in: [packages/sdk/src/types/communication-types.ts:270](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/communication-types.ts#L270) --- # Interface: ChatContinueActionParams Defined in: [packages/sdk/src/types/event-types.ts:282](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L282) ## Properties[​](#properties "Direct link to Properties") ### assistantPrompt?[​](#assistantprompt "Direct link to assistantPrompt?") > `optional` **assistantPrompt**: `string` Defined in: [packages/sdk/src/types/event-types.ts:283](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L283) *** ### updateType?[​](#updatetype "Direct link to updateType?") > `optional` **updateType**: `string` Defined in: [packages/sdk/src/types/event-types.ts:284](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L284) --- # Interface: ChatCreateActionParams Defined in: [packages/sdk/src/types/event-types.ts:272](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L272) ## Properties[​](#properties "Direct link to Properties") ### channel?[​](#channel "Direct link to channel?") > `optional` **channel**: `string` Defined in: [packages/sdk/src/types/event-types.ts:275](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L275) *** ### channels?[​](#channels "Direct link to channels?") > `optional` **channels**: `string`\[] Defined in: [packages/sdk/src/types/event-types.ts:276](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L276) *** ### inboxUUID?[​](#inboxuuid "Direct link to inboxUUID?") > `optional` **inboxUUID**: `string` Defined in: [packages/sdk/src/types/event-types.ts:278](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L278) *** ### initialUserMessage?[​](#initialusermessage "Direct link to initialUserMessage?") > `optional` **initialUserMessage**: `string` Defined in: [packages/sdk/src/types/event-types.ts:279](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L279) *** ### phoneNumberUUID?[​](#phonenumberuuid "Direct link to phoneNumberUUID?") > `optional` **phoneNumberUUID**: `string` Defined in: [packages/sdk/src/types/event-types.ts:277](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L277) *** ### taskUUID?[​](#taskuuid "Direct link to taskUUID?") > `optional` **taskUUID**: `string` Defined in: [packages/sdk/src/types/event-types.ts:274](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L274) *** ### workflowUUID?[​](#workflowuuid "Direct link to workflowUUID?") > `optional` **workflowUUID**: `string` Defined in: [packages/sdk/src/types/event-types.ts:273](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L273) --- # Interface: ChatFilterFormData Defined in: [packages/sdk/src/types/chat-types.ts:445](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L445) ## Properties[​](#properties "Direct link to Properties") ### description?[​](#description "Direct link to description?") > `optional` **description**: `string` Defined in: [packages/sdk/src/types/chat-types.ts:447](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L447) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/chat-types.ts:446](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L446) *** ### pinned?[​](#pinned "Direct link to pinned?") > `optional` **pinned**: `boolean` Defined in: [packages/sdk/src/types/chat-types.ts:448](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L448) *** ### rules[​](#rules "Direct link to rules") > **rules**: [`ChatFilterRuleFormData`](https://docs.gravityrail.com/sdk/interfaces/ChatFilterRuleFormData.md)\[] Defined in: [packages/sdk/src/types/chat-types.ts:449](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L449) --- # Interface: ChatFilterResponse Defined in: [packages/sdk/src/types/generated/chat.ts:90](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L90) Response model for a chat filter. ## Properties[​](#properties "Direct link to Properties") ### createdAt[​](#createdat "Direct link to createdAt") > **createdAt**: `string` Defined in: [packages/sdk/src/types/generated/chat.ts:96](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L96) *** ### description[​](#description "Direct link to description") > **description**: `string` | `null` Defined in: [packages/sdk/src/types/generated/chat.ts:94](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L94) *** ### id[​](#id "Direct link to id") > **id**: `number` Defined in: [packages/sdk/src/types/generated/chat.ts:91](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L91) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/generated/chat.ts:93](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L93) *** ### pinned?[​](#pinned "Direct link to pinned?") > `optional` **pinned**: `boolean` | `null` Defined in: [packages/sdk/src/types/generated/chat.ts:95](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L95) *** ### rules[​](#rules "Direct link to rules") > **rules**: [`ChatFilterRuleResponse`](https://docs.gravityrail.com/sdk/interfaces/ChatFilterRuleResponse.md)\[] Defined in: [packages/sdk/src/types/generated/chat.ts:98](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L98) *** ### updatedAt[​](#updatedat "Direct link to updatedAt") > **updatedAt**: `string` Defined in: [packages/sdk/src/types/generated/chat.ts:97](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L97) *** ### uuid[​](#uuid "Direct link to uuid") > **uuid**: `string` Defined in: [packages/sdk/src/types/generated/chat.ts:92](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L92) --- # Interface: ChatFilterRuleFormData Defined in: [packages/sdk/src/types/chat-types.ts:438](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L438) ## Properties[​](#properties "Direct link to Properties") ### filterType[​](#filtertype "Direct link to filterType") > **filterType**: [`ChatFilterFilterType`](https://docs.gravityrail.com/sdk/type-aliases/ChatFilterFilterType.md) Defined in: [packages/sdk/src/types/chat-types.ts:440](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L440) *** ### objectIds?[​](#objectids "Direct link to objectIds?") > `optional` **objectIds**: `number`\[] Defined in: [packages/sdk/src/types/chat-types.ts:441](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L441) *** ### objectType[​](#objecttype "Direct link to objectType") > **objectType**: [`ChatFilterObjectType`](https://docs.gravityrail.com/sdk/type-aliases/ChatFilterObjectType.md) Defined in: [packages/sdk/src/types/chat-types.ts:439](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L439) *** ### query?[​](#query "Direct link to query?") > `optional` **query**: `string` Defined in: [packages/sdk/src/types/chat-types.ts:442](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L442) --- # Interface: ChatFilterRuleResponse Defined in: [packages/sdk/src/types/generated/chat.ts:104](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L104) Response model for a chat filter rule. ## Properties[​](#properties "Direct link to Properties") ### chatFilterId[​](#chatfilterid "Direct link to chatFilterId") > **chatFilterId**: `number` Defined in: [packages/sdk/src/types/generated/chat.ts:107](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L107) *** ### filterType[​](#filtertype "Direct link to filterType") > **filterType**: `string` Defined in: [packages/sdk/src/types/generated/chat.ts:109](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L109) *** ### id[​](#id "Direct link to id") > **id**: `number` Defined in: [packages/sdk/src/types/generated/chat.ts:105](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L105) *** ### objectIds?[​](#objectids "Direct link to objectIds?") > `optional` **objectIds**: `number`\[] | `null` Defined in: [packages/sdk/src/types/generated/chat.ts:110](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L110) *** ### objectType[​](#objecttype "Direct link to objectType") > **objectType**: `string` Defined in: [packages/sdk/src/types/generated/chat.ts:108](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L108) *** ### query?[​](#query "Direct link to query?") > `optional` **query**: `string` | `null` Defined in: [packages/sdk/src/types/generated/chat.ts:111](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L111) *** ### uuid[​](#uuid "Direct link to uuid") > **uuid**: `string` Defined in: [packages/sdk/src/types/generated/chat.ts:106](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L106) --- # Interface: ChatFormData Defined in: [packages/sdk/src/types/chat-types.ts:85](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L85) ## Properties[​](#properties "Direct link to Properties") ### agentEnabled?[​](#agentenabled "Direct link to agentEnabled?") > `optional` **agentEnabled**: `boolean` Defined in: [packages/sdk/src/types/chat-types.ts:96](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L96) *** ### ~~agentMemberId?~~[​](#agentmemberid "Direct link to agentmemberid") > `optional` **agentMemberId**: `number` | `null` Defined in: [packages/sdk/src/types/chat-types.ts:99](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L99) #### Deprecated[​](#deprecated "Direct link to Deprecated") Use assistantMemberId. Kept as a client-side alias. *** ### assistantMemberId?[​](#assistantmemberid "Direct link to assistantMemberId?") > `optional` **assistantMemberId**: `number` | `null` Defined in: [packages/sdk/src/types/chat-types.ts:97](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L97) *** ### channel[​](#channel "Direct link to channel") > **channel**: `string` Defined in: [packages/sdk/src/types/chat-types.ts:88](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L88) *** ### chatType?[​](#chattype "Direct link to chatType?") > `optional` **chatType**: `string` Defined in: [packages/sdk/src/types/chat-types.ts:89](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L89) *** ### id?[​](#id "Direct link to id?") > `optional` **id**: `number` Defined in: [packages/sdk/src/types/chat-types.ts:86](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L86) *** ### inboxId?[​](#inboxid "Direct link to inboxId?") > `optional` **inboxId**: `number` | `null` Defined in: [packages/sdk/src/types/chat-types.ts:92](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L92) *** ### initialMessage?[​](#initialmessage "Direct link to initialMessage?") > `optional` **initialMessage**: `string` | `null` Defined in: [packages/sdk/src/types/chat-types.ts:111](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L111) Optional human-typed initial SMS/email message body. Treated as PHI: never log it client-side beyond the textarea state. Empty/whitespace-only values are dropped before sending. *** ### isTest?[​](#istest "Direct link to isTest?") > `optional` **isTest**: `boolean` Defined in: [packages/sdk/src/types/chat-types.ts:104](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L104) *** ### labelIds?[​](#labelids "Direct link to labelIds?") > `optional` **labelIds**: `number`\[] Defined in: [packages/sdk/src/types/chat-types.ts:103](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L103) *** ### memberId?[​](#memberid "Direct link to memberId?") > `optional` **memberId**: `number` | `null` Defined in: [packages/sdk/src/types/chat-types.ts:94](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L94) *** ### muted?[​](#muted "Direct link to muted?") > `optional` **muted**: `boolean` Defined in: [packages/sdk/src/types/chat-types.ts:101](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L101) *** ### needsResponse?[​](#needsresponse "Direct link to needsResponse?") > `optional` **needsResponse**: `boolean` Defined in: [packages/sdk/src/types/chat-types.ts:102](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L102) *** ### participants?[​](#participants "Direct link to participants?") > `optional` **participants**: [`ChatParticipantFormData`](https://docs.gravityrail.com/sdk/interfaces/ChatParticipantFormData.md)\[] Defined in: [packages/sdk/src/types/chat-types.ts:95](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L95) *** ### paused?[​](#paused "Direct link to paused?") > `optional` **paused**: `boolean` Defined in: [packages/sdk/src/types/chat-types.ts:100](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L100) *** ### phoneNumberId?[​](#phonenumberid "Direct link to phoneNumberId?") > `optional` **phoneNumberId**: `number` | `null` Defined in: [packages/sdk/src/types/chat-types.ts:91](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L91) *** ### siteId?[​](#siteid "Direct link to siteId?") > `optional` **siteId**: `number` | `null` Defined in: [packages/sdk/src/types/chat-types.ts:93](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L93) *** ### title?[​](#title "Direct link to title?") > `optional` **title**: `string` Defined in: [packages/sdk/src/types/chat-types.ts:87](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L87) *** ### workflowId?[​](#workflowid "Direct link to workflowId?") > `optional` **workflowId**: `number` | `null` Defined in: [packages/sdk/src/types/chat-types.ts:90](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L90) *** ### workflowVersionNumber?[​](#workflowversionnumber "Direct link to workflowVersionNumber?") > `optional` **workflowVersionNumber**: `number` | `null` Defined in: [packages/sdk/src/types/chat-types.ts:105](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L105) --- # Interface: ChatInterruptResponse Defined in: [packages/sdk/src/types/generated/chat.ts:122](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L122) Pending HITL interrupt on a chat. Canonical API shape (camelCase) for `GET /chats/:id` and AG-UI `human_input_request` events. Built from LangGraph `interrupt()` payloads via `build_chat_interrupt_response`. Resume via `POST …/inference/hitl` echoing `interruptId` (request body). ## Indexable[​](#indexable "Direct link to Indexable") \[`key`: `string`]: `unknown` ## Properties[​](#properties "Direct link to Properties") ### checkoutUrl?[​](#checkouturl "Direct link to checkoutUrl?") > `optional` **checkoutUrl**: `string` | `null` Defined in: [packages/sdk/src/types/generated/chat.ts:132](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L132) *** ### description?[​](#description "Direct link to description?") > `optional` **description**: `string` | `null` Defined in: [packages/sdk/src/types/generated/chat.ts:126](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L126) *** ### interruptId?[​](#interruptid "Direct link to interruptId?") > `optional` **interruptId**: `string` | `null` Defined in: [packages/sdk/src/types/generated/chat.ts:124](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L124) *** ### openuiMarkup?[​](#openuimarkup "Direct link to openuiMarkup?") > `optional` **openuiMarkup**: `string` | `null` Defined in: [packages/sdk/src/types/generated/chat.ts:125](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L125) *** ### paymentComplete?[​](#paymentcomplete "Direct link to paymentComplete?") > `optional` **paymentComplete**: `boolean` | `null` Defined in: [packages/sdk/src/types/generated/chat.ts:135](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L135) *** ### price?[​](#price "Direct link to price?") > `optional` **price**: `string` | `null` Defined in: [packages/sdk/src/types/generated/chat.ts:134](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L134) *** ### productName?[​](#productname "Direct link to productName?") > `optional` **productName**: `string` | `null` Defined in: [packages/sdk/src/types/generated/chat.ts:133](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L133) *** ### specData?[​](#specdata "Direct link to specData?") > `optional` **specData**: `ChatInterruptResponseSpecData` Defined in: [packages/sdk/src/types/generated/chat.ts:130](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L130) *** ### specId?[​](#specid "Direct link to specId?") > `optional` **specId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/chat.ts:128](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L128) *** ### specStatus?[​](#specstatus "Direct link to specStatus?") > `optional` **specStatus**: `string` | `null` Defined in: [packages/sdk/src/types/generated/chat.ts:131](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L131) *** ### specTitle?[​](#spectitle "Direct link to specTitle?") > `optional` **specTitle**: `string` | `null` Defined in: [packages/sdk/src/types/generated/chat.ts:129](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L129) *** ### type?[​](#type "Direct link to type?") > `optional` **type**: `string` | `null` Defined in: [packages/sdk/src/types/generated/chat.ts:123](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L123) *** ### userPrompt?[​](#userprompt "Direct link to userPrompt?") > `optional` **userPrompt**: `string` | `null` Defined in: [packages/sdk/src/types/generated/chat.ts:127](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L127) --- # Interface: ChatLabelFormData Defined in: [packages/sdk/src/types/chat-types.ts:77](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L77) ## Properties[​](#properties "Direct link to Properties") ### color[​](#color "Direct link to color") > **color**: `string` Defined in: [packages/sdk/src/types/chat-types.ts:81](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L81) *** ### description?[​](#description "Direct link to description?") > `optional` **description**: `string` | `null` Defined in: [packages/sdk/src/types/chat-types.ts:80](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L80) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/chat-types.ts:78](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L78) *** ### slug?[​](#slug "Direct link to slug?") > `optional` **slug**: `string` Defined in: [packages/sdk/src/types/chat-types.ts:79](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L79) --- # Interface: ChatLabelResponse Defined in: [packages/sdk/src/types/generated/chat.ts:144](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L144) Response model for chat label endpoints. ## Properties[​](#properties "Direct link to Properties") ### color[​](#color "Direct link to color") > **color**: `string` Defined in: [packages/sdk/src/types/generated/chat.ts:149](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L149) *** ### description[​](#description "Direct link to description") > **description**: `string` | `null` Defined in: [packages/sdk/src/types/generated/chat.ts:150](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L150) *** ### id[​](#id "Direct link to id") > **id**: `number` Defined in: [packages/sdk/src/types/generated/chat.ts:145](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L145) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/generated/chat.ts:147](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L147) *** ### slug[​](#slug "Direct link to slug") > **slug**: `string` Defined in: [packages/sdk/src/types/generated/chat.ts:148](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L148) *** ### uuid[​](#uuid "Direct link to uuid") > **uuid**: `string` Defined in: [packages/sdk/src/types/generated/chat.ts:146](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L146) --- # Interface: ChatMessage Defined in: [packages/sdk/src/types/chat-types.ts:242](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L242) ## Properties[​](#properties "Direct link to Properties") ### audioFileUuid?[​](#audiofileuuid "Direct link to audioFileUuid?") > `optional` **audioFileUuid**: `string` | `null` Defined in: [packages/sdk/src/types/chat-types.ts:268](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L268) First-class audio assistant message. audioFileUuid points at a workspace File whose bytes the chat renderer should play. Set together with audioMetadata: an audio message has both fields, a text message has neither. *** ### audioMetadata?[​](#audiometadata "Direct link to audioMetadata?") > `optional` **audioMetadata**: [`AudioMessageMetadata`](https://docs.gravityrail.com/sdk/interfaces/AudioMessageMetadata.md) | `null` Defined in: [packages/sdk/src/types/chat-types.ts:269](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L269) *** ### content[​](#content "Direct link to content") > **content**: `string` | [`MessageContentPart`](https://docs.gravityrail.com/sdk/type-aliases/MessageContentPart.md)\[] Defined in: [packages/sdk/src/types/chat-types.ts:245](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L245) *** ### created\_at?[​](#created_at "Direct link to created_at?") > `optional` **created\_at**: `string` Defined in: [packages/sdk/src/types/chat-types.ts:254](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L254) *** ### email\_id?[​](#email_id "Direct link to email_id?") > `optional` **email\_id**: `number` Defined in: [packages/sdk/src/types/chat-types.ts:258](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L258) *** ### error?[​](#error "Direct link to error?") > `optional` **error**: `object` Defined in: [packages/sdk/src/types/chat-types.ts:255](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L255) #### code[​](#code "Direct link to code") > **code**: `string` #### message[​](#message "Direct link to message") > **message**: `string` *** ### error\_details?[​](#error_details "Direct link to error_details?") > `optional` **error\_details**: [`ChatCompletionError`](https://docs.gravityrail.com/sdk/interfaces/ChatCompletionError.md) Defined in: [packages/sdk/src/types/chat-types.ts:253](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L253) *** ### failed?[​](#failed "Direct link to failed?") > `optional` **failed**: `boolean` Defined in: [packages/sdk/src/types/chat-types.ts:250](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L250) *** ### id[​](#id "Direct link to id") > **id**: `string` Defined in: [packages/sdk/src/types/chat-types.ts:243](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L243) *** ### inbox\_id?[​](#inbox_id "Direct link to inbox_id?") > `optional` **inbox\_id**: `number` Defined in: [packages/sdk/src/types/chat-types.ts:259](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L259) *** ### memberId?[​](#memberid "Direct link to memberId?") > `optional` **memberId**: `number` | `null` Defined in: [packages/sdk/src/types/chat-types.ts:260](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L260) *** ### originalContent?[​](#originalcontent "Direct link to originalContent?") > `optional` **originalContent**: `string` | [`MessageContentPart`](https://docs.gravityrail.com/sdk/type-aliases/MessageContentPart.md)\[] Defined in: [packages/sdk/src/types/chat-types.ts:246](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L246) *** ### reasoning\_content?[​](#reasoning_content "Direct link to reasoning_content?") > `optional` **reasoning\_content**: `string` Defined in: [packages/sdk/src/types/chat-types.ts:249](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L249) *** ### role[​](#role "Direct link to role") > **role**: [`MessageRole`](https://docs.gravityrail.com/sdk/type-aliases/MessageRole.md) Defined in: [packages/sdk/src/types/chat-types.ts:244](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L244) *** ### sendAsAssistant?[​](#sendasassistant "Direct link to sendAsAssistant?") > `optional` **sendAsAssistant**: `boolean` Defined in: [packages/sdk/src/types/chat-types.ts:257](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L257) *** ### smsDeliveryErrorCode?[​](#smsdeliveryerrorcode "Direct link to smsDeliveryErrorCode?") > `optional` **smsDeliveryErrorCode**: `string` | `null` Defined in: [packages/sdk/src/types/chat-types.ts:272](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L272) *** ### smsDeliveryFailureReason?[​](#smsdeliveryfailurereason "Direct link to smsDeliveryFailureReason?") > `optional` **smsDeliveryFailureReason**: `string` | `null` Defined in: [packages/sdk/src/types/chat-types.ts:275](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L275) Friendly failure reason string. Only set when smsDeliveryStatus is failed or undelivered. *** ### smsDeliveryStatus?[​](#smsdeliverystatus "Direct link to smsDeliveryStatus?") > `optional` **smsDeliveryStatus**: [`SMSDeliveryStatus`](https://docs.gravityrail.com/sdk/type-aliases/SMSDeliveryStatus.md) | `null` Defined in: [packages/sdk/src/types/chat-types.ts:271](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L271) SMS delivery status (queued/sending/sent/delivered/undelivered/failed). Only set for SMS messages. *** ### smsDeliveryUpdatedAt?[​](#smsdeliveryupdatedat "Direct link to smsDeliveryUpdatedAt?") > `optional` **smsDeliveryUpdatedAt**: `string` | `null` Defined in: [packages/sdk/src/types/chat-types.ts:273](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L273) *** ### suggestions?[​](#suggestions "Direct link to suggestions?") > `optional` **suggestions**: `string`\[] Defined in: [packages/sdk/src/types/chat-types.ts:256](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L256) *** ### taskId?[​](#taskid "Direct link to taskId?") > `optional` **taskId**: `number` | `null` Defined in: [packages/sdk/src/types/chat-types.ts:262](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L262) *** ### tokenUsage?[​](#tokenusage "Direct link to tokenUsage?") > `optional` **tokenUsage**: [`MessageTokenUsageResponse`](https://docs.gravityrail.com/sdk/interfaces/MessageTokenUsageResponse.md) Defined in: [packages/sdk/src/types/chat-types.ts:261](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L261) *** ### tool\_call\_id?[​](#tool_call_id "Direct link to tool_call_id?") > `optional` **tool\_call\_id**: `string` Defined in: [packages/sdk/src/types/chat-types.ts:252](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L252) *** ### tool\_calls?[​](#tool_calls "Direct link to tool_calls?") > `optional` **tool\_calls**: [`ToolCall`](https://docs.gravityrail.com/sdk/interfaces/ToolCall.md)\[] Defined in: [packages/sdk/src/types/chat-types.ts:251](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L251) *** ### truncatedAtMs?[​](#truncatedatms "Direct link to truncatedAtMs?") > `optional` **truncatedAtMs**: `number` Defined in: [packages/sdk/src/types/chat-types.ts:248](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L248) *** ### truncationReason?[​](#truncationreason "Direct link to truncationReason?") > `optional` **truncationReason**: [`TruncationReason`](https://docs.gravityrail.com/sdk/type-aliases/TruncationReason.md) Defined in: [packages/sdk/src/types/chat-types.ts:247](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L247) --- # Interface: ChatMessageChunk Defined in: [packages/sdk/src/types/chat-types.ts:283](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L283) ## Properties[​](#properties "Direct link to Properties") ### choices?[​](#choices "Direct link to choices?") > `optional` **choices**: `object`\[] Defined in: [packages/sdk/src/types/chat-types.ts:286](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L286) #### delta?[​](#delta "Direct link to delta?") > `optional` **delta**: `object` ##### delta.content?[​](#deltacontent "Direct link to delta.content?") > `optional` **content**: `string` ##### delta.created\_at?[​](#deltacreated_at "Direct link to delta.created_at?") > `optional` **created\_at**: `string` ##### delta.memberId?[​](#deltamemberid "Direct link to delta.memberId?") > `optional` **memberId**: `number` | `null` ##### delta.name?[​](#deltaname "Direct link to delta.name?") > `optional` **name**: `string` ##### delta.reasoning\_content?[​](#deltareasoning_content "Direct link to delta.reasoning_content?") > `optional` **reasoning\_content**: `string` ##### delta.role?[​](#deltarole "Direct link to delta.role?") > `optional` **role**: [`MessageRole`](https://docs.gravityrail.com/sdk/type-aliases/MessageRole.md) ##### delta.sendAsAssistant?[​](#deltasendasassistant "Direct link to delta.sendAsAssistant?") > `optional` **sendAsAssistant**: `boolean` ##### delta.suggestions?[​](#deltasuggestions "Direct link to delta.suggestions?") > `optional` **suggestions**: `string`\[] ##### delta.tool\_call\_id?[​](#deltatool_call_id "Direct link to delta.tool_call_id?") > `optional` **tool\_call\_id**: `string` ##### delta.tool\_calls?[​](#deltatool_calls "Direct link to delta.tool_calls?") > `optional` **tool\_calls**: [`ToolCall`](https://docs.gravityrail.com/sdk/interfaces/ToolCall.md)\[] #### index?[​](#index "Direct link to index?") > `optional` **index**: `number` *** ### id[​](#id "Direct link to id") > **id**: `string` Defined in: [packages/sdk/src/types/chat-types.ts:284](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L284) *** ### object[​](#object "Direct link to object") > **object**: `string` Defined in: [packages/sdk/src/types/chat-types.ts:285](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L285) --- # Interface: ChatMessageObject Defined in: [packages/sdk/src/types/chat-types.ts:278](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L278) ## Properties[​](#properties "Direct link to Properties") ### data[​](#data "Direct link to data") > **data**: `any` Defined in: [packages/sdk/src/types/chat-types.ts:280](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L280) *** ### object[​](#object "Direct link to object") > **object**: `string` Defined in: [packages/sdk/src/types/chat-types.ts:279](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L279) --- # Interface: ChatModelResponse Defined in: [packages/sdk/src/types/generated/ai\_model.ts:22](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/ai_model.ts#L22) Response model for a chat model. ## Properties[​](#properties "Direct link to Properties") ### available?[​](#available "Direct link to available?") > `optional` **available**: `boolean` Defined in: [packages/sdk/src/types/generated/ai\_model.ts:30](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/ai_model.ts#L30) *** ### cachedMultiplier?[​](#cachedmultiplier "Direct link to cachedMultiplier?") > `optional` **cachedMultiplier**: `number` | `null` Defined in: [packages/sdk/src/types/generated/ai\_model.ts:36](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/ai_model.ts#L36) *** ### description?[​](#description "Direct link to description?") > `optional` **description**: `string` | `null` Defined in: [packages/sdk/src/types/generated/ai\_model.ts:27](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/ai_model.ts#L27) *** ### id[​](#id "Direct link to id") > **id**: `string` Defined in: [packages/sdk/src/types/generated/ai\_model.ts:23](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/ai_model.ts#L23) *** ### inputMultiplier?[​](#inputmultiplier "Direct link to inputMultiplier?") > `optional` **inputMultiplier**: `number` | `null` Defined in: [packages/sdk/src/types/generated/ai\_model.ts:34](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/ai_model.ts#L34) *** ### multiplier?[​](#multiplier "Direct link to multiplier?") > `optional` **multiplier**: `number` Defined in: [packages/sdk/src/types/generated/ai\_model.ts:33](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/ai_model.ts#L33) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/generated/ai\_model.ts:24](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/ai_model.ts#L24) *** ### outputMultiplier?[​](#outputmultiplier "Direct link to outputMultiplier?") > `optional` **outputMultiplier**: `number` | `null` Defined in: [packages/sdk/src/types/generated/ai\_model.ts:35](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/ai_model.ts#L35) *** ### provider[​](#provider "Direct link to provider") > **provider**: [`ModelProvider`](https://docs.gravityrail.com/sdk/type-aliases/ModelProvider.md) Defined in: [packages/sdk/src/types/generated/ai\_model.ts:25](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/ai_model.ts#L25) *** ### recommended?[​](#recommended "Direct link to recommended?") > `optional` **recommended**: `boolean` Defined in: [packages/sdk/src/types/generated/ai\_model.ts:31](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/ai_model.ts#L31) *** ### replacement?[​](#replacement "Direct link to replacement?") > `optional` **replacement**: `string` | `null` Defined in: [packages/sdk/src/types/generated/ai\_model.ts:32](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/ai_model.ts#L32) *** ### state?[​](#state "Direct link to state?") > `optional` **state**: `string` Defined in: [packages/sdk/src/types/generated/ai\_model.ts:29](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/ai_model.ts#L29) *** ### tagline?[​](#tagline "Direct link to tagline?") > `optional` **tagline**: `string` | `null` Defined in: [packages/sdk/src/types/generated/ai\_model.ts:28](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/ai_model.ts#L28) *** ### type?[​](#type "Direct link to type?") > `optional` **type**: [`ModelType`](https://docs.gravityrail.com/sdk/type-aliases/ModelType.md) Defined in: [packages/sdk/src/types/generated/ai\_model.ts:26](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/ai_model.ts#L26) --- # Interface: ChatNoteSyncConfig Defined in: [packages/sdk/src/types/app-connection-types.ts:225](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L225) ## Properties[​](#properties "Direct link to Properties") ### bodyTemplate[​](#bodytemplate "Direct link to bodyTemplate") > **bodyTemplate**: `string` Defined in: [packages/sdk/src/types/app-connection-types.ts:226](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L226) *** ### delaySeconds[​](#delayseconds "Direct link to delaySeconds") > **delaySeconds**: `number` Defined in: [packages/sdk/src/types/app-connection-types.ts:227](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L227) *** ### filters[​](#filters "Direct link to filters") > **filters**: [`ChatNoteSyncFilters`](https://docs.gravityrail.com/sdk/interfaces/ChatNoteSyncFilters.md) Defined in: [packages/sdk/src/types/app-connection-types.ts:228](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L228) --- # Interface: ChatNoteSyncFilters Defined in: [packages/sdk/src/types/app-connection-types.ts:220](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L220) ## Properties[​](#properties "Direct link to Properties") ### excludeTestChats[​](#excludetestchats "Direct link to excludeTestChats") > **excludeTestChats**: `boolean` Defined in: [packages/sdk/src/types/app-connection-types.ts:222](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L222) *** ### workflowIds[​](#workflowids "Direct link to workflowIds") > **workflowIds**: `number`\[] Defined in: [packages/sdk/src/types/app-connection-types.ts:221](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L221) --- # Interface: ChatParticipantFormData Defined in: [packages/sdk/src/types/chat-types.ts:114](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L114) ## Properties[​](#properties "Direct link to Properties") ### additionalInstructions?[​](#additionalinstructions "Direct link to additionalInstructions?") > `optional` **additionalInstructions**: `string` Defined in: [packages/sdk/src/types/chat-types.ts:117](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L117) *** ### memberId[​](#memberid "Direct link to memberId") > **memberId**: `number` Defined in: [packages/sdk/src/types/chat-types.ts:115](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L115) *** ### role?[​](#role "Direct link to role?") > `optional` **role**: `string` Defined in: [packages/sdk/src/types/chat-types.ts:116](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L116) --- # Interface: ChatParticipantResponse Defined in: [packages/sdk/src/types/generated/chat.ts:189](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L189) ## Properties[​](#properties "Direct link to Properties") ### additionalInstructions?[​](#additionalinstructions "Direct link to additionalInstructions?") > `optional` **additionalInstructions**: `string` | `null` Defined in: [packages/sdk/src/types/generated/chat.ts:191](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L191) *** ### chatModel?[​](#chatmodel "Direct link to chatModel?") > `optional` **chatModel**: `string` | `null` Defined in: [packages/sdk/src/types/generated/chat.ts:195](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L195) *** ### chatModelConfig?[​](#chatmodelconfig "Direct link to chatModelConfig?") > `optional` **chatModelConfig**: `ChatParticipantResponseChatModelConfig` Defined in: [packages/sdk/src/types/generated/chat.ts:197](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L197) *** ### memberId?[​](#memberid "Direct link to memberId?") > `optional` **memberId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/chat.ts:193](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L193) *** ### memberType?[​](#membertype "Direct link to memberType?") > `optional` **memberType**: `string` | `null` Defined in: [packages/sdk/src/types/generated/chat.ts:194](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L194) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/generated/chat.ts:190](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L190) *** ### realtimeModel?[​](#realtimemodel "Direct link to realtimeModel?") > `optional` **realtimeModel**: `string` | `null` Defined in: [packages/sdk/src/types/generated/chat.ts:196](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L196) *** ### realtimeModelConfig?[​](#realtimemodelconfig "Direct link to realtimeModelConfig?") > `optional` **realtimeModelConfig**: `ChatParticipantResponseRealtimeModelConfig` Defined in: [packages/sdk/src/types/generated/chat.ts:198](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L198) *** ### role[​](#role "Direct link to role") > **role**: `string` Defined in: [packages/sdk/src/types/generated/chat.ts:192](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L192) --- # Interface: ChatPauseActionParams Defined in: [packages/sdk/src/types/event-types.ts:287](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L287) ## Properties[​](#properties "Direct link to Properties") ### message?[​](#message "Direct link to message?") > `optional` **message**: `string` Defined in: [packages/sdk/src/types/event-types.ts:288](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L288) --- # Interface: ChatResponse Defined in: [packages/sdk/src/types/generated/chat.ts:208](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L208) Response model for chat endpoints. ## Properties[​](#properties "Direct link to Properties") ### archived[​](#archived "Direct link to archived") > **archived**: `boolean` Defined in: [packages/sdk/src/types/generated/chat.ts:211](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L211) *** ### assignmentId[​](#assignmentid "Direct link to assignmentId") > **assignmentId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/chat.ts:219](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L219) *** ### canSendAsAssistant[​](#cansendasassistant "Direct link to canSendAsAssistant") > **canSendAsAssistant**: `boolean` Defined in: [packages/sdk/src/types/generated/chat.ts:234](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L234) *** ### channel[​](#channel "Direct link to channel") > **channel**: `string` Defined in: [packages/sdk/src/types/generated/chat.ts:213](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L213) *** ### chatType[​](#chattype "Direct link to chatType") > **chatType**: `string` Defined in: [packages/sdk/src/types/generated/chat.ts:214](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L214) *** ### createdAt[​](#createdat "Direct link to createdAt") > **createdAt**: `string` Defined in: [packages/sdk/src/types/generated/chat.ts:226](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L226) *** ### folderId[​](#folderid "Direct link to folderId") > **folderId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/chat.ts:225](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L225) *** ### fromMessageId[​](#frommessageid "Direct link to fromMessageId") > **fromMessageId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/chat.ts:221](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L221) *** ### id[​](#id "Direct link to id") > **id**: `number` Defined in: [packages/sdk/src/types/generated/chat.ts:209](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L209) *** ### inboxId[​](#inboxid "Direct link to inboxId") > **inboxId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/chat.ts:223](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L223) *** ### initialMessageError?[​](#initialmessageerror "Direct link to initialMessageError?") > `optional` **initialMessageError**: `string` | `null` Defined in: [packages/sdk/src/types/generated/chat.ts:238](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L238) *** ### interrupt?[​](#interrupt "Direct link to interrupt?") > `optional` **interrupt**: [`ChatInterruptResponse`](https://docs.gravityrail.com/sdk/interfaces/ChatInterruptResponse.md) | `null` Defined in: [packages/sdk/src/types/generated/chat.ts:237](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L237) *** ### isTest[​](#istest "Direct link to isTest") > **isTest**: `boolean` Defined in: [packages/sdk/src/types/generated/chat.ts:236](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L236) *** ### labels[​](#labels "Direct link to labels") > **labels**: [`ChatLabelResponse`](https://docs.gravityrail.com/sdk/interfaces/ChatLabelResponse.md)\[] Defined in: [packages/sdk/src/types/generated/chat.ts:235](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L235) *** ### lastMessageReceivedAt[​](#lastmessagereceivedat "Direct link to lastMessageReceivedAt") > **lastMessageReceivedAt**: `string` | `null` Defined in: [packages/sdk/src/types/generated/chat.ts:231](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L231) *** ### messageCount[​](#messagecount "Direct link to messageCount") > **messageCount**: `number` Defined in: [packages/sdk/src/types/generated/chat.ts:232](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L232) *** ### muted[​](#muted "Direct link to muted") > **muted**: `boolean` Defined in: [packages/sdk/src/types/generated/chat.ts:212](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L212) *** ### needsResponse[​](#needsresponse "Direct link to needsResponse") > **needsResponse**: `boolean` Defined in: [packages/sdk/src/types/generated/chat.ts:218](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L218) *** ### participants[​](#participants "Direct link to participants") > **participants**: [`ChatParticipantResponse`](https://docs.gravityrail.com/sdk/interfaces/ChatParticipantResponse.md)\[] Defined in: [packages/sdk/src/types/generated/chat.ts:233](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L233) *** ### paused[​](#paused "Direct link to paused") > **paused**: `boolean` Defined in: [packages/sdk/src/types/generated/chat.ts:215](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L215) *** ### pausedAt[​](#pausedat "Direct link to pausedAt") > **pausedAt**: `string` | `null` Defined in: [packages/sdk/src/types/generated/chat.ts:216](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L216) *** ### pausedReason[​](#pausedreason "Direct link to pausedReason") > **pausedReason**: `string` | `null` Defined in: [packages/sdk/src/types/generated/chat.ts:217](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L217) *** ### phoneNumberId[​](#phonenumberid "Direct link to phoneNumberId") > **phoneNumberId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/chat.ts:222](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L222) *** ### siteId[​](#siteid "Direct link to siteId") > **siteId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/chat.ts:224](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L224) *** ### summary[​](#summary "Direct link to summary") > **summary**: `string` | `null` Defined in: [packages/sdk/src/types/generated/chat.ts:229](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L229) *** ### summaryUpdatedAt[​](#summaryupdatedat "Direct link to summaryUpdatedAt") > **summaryUpdatedAt**: `string` | `null` Defined in: [packages/sdk/src/types/generated/chat.ts:230](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L230) *** ### title[​](#title "Direct link to title") > **title**: `string` | `null` Defined in: [packages/sdk/src/types/generated/chat.ts:228](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L228) *** ### updatedAt[​](#updatedat "Direct link to updatedAt") > **updatedAt**: `string` Defined in: [packages/sdk/src/types/generated/chat.ts:227](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L227) *** ### uuid[​](#uuid "Direct link to uuid") > **uuid**: `string` Defined in: [packages/sdk/src/types/generated/chat.ts:210](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L210) *** ### workflowId[​](#workflowid "Direct link to workflowId") > **workflowId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/chat.ts:220](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L220) --- # Interface: ChatState Defined in: [packages/sdk/src/types/chat-types.ts:54](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L54) ## Properties[​](#properties "Direct link to Properties") ### items[​](#items "Direct link to items") > **items**: [`ChatResponse`](https://docs.gravityrail.com/sdk/interfaces/ChatResponse.md)\[] Defined in: [packages/sdk/src/types/chat-types.ts:55](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L55) *** ### page[​](#page "Direct link to page") > **page**: `number` Defined in: [packages/sdk/src/types/chat-types.ts:57](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L57) *** ### pageSize[​](#pagesize "Direct link to pageSize") > **pageSize**: `number` Defined in: [packages/sdk/src/types/chat-types.ts:58](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L58) *** ### sortBy[​](#sortby "Direct link to sortBy") > **sortBy**: [`ChatSortField`](https://docs.gravityrail.com/sdk/type-aliases/ChatSortField.md) Defined in: [packages/sdk/src/types/chat-types.ts:60](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L60) *** ### sortOrder[​](#sortorder "Direct link to sortOrder") > **sortOrder**: [`SortOrder`](https://docs.gravityrail.com/sdk/type-aliases/SortOrder.md) Defined in: [packages/sdk/src/types/chat-types.ts:61](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L61) *** ### total[​](#total "Direct link to total") > **total**: `number` Defined in: [packages/sdk/src/types/chat-types.ts:56](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L56) *** ### totalPages[​](#totalpages "Direct link to totalPages") > **totalPages**: `number` Defined in: [packages/sdk/src/types/chat-types.ts:59](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L59) --- # Interface: ChatSummarizeActionParams Defined in: [packages/sdk/src/types/event-types.ts:291](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L291) ## Properties[​](#properties "Direct link to Properties") ### chatModel?[​](#chatmodel "Direct link to chatModel?") > `optional` **chatModel**: `string` Defined in: [packages/sdk/src/types/event-types.ts:293](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L293) *** ### summarizationPrompt?[​](#summarizationprompt "Direct link to summarizationPrompt?") > `optional` **summarizationPrompt**: `string` Defined in: [packages/sdk/src/types/event-types.ts:292](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L292) --- # Interface: ChatTokenUsageResponse Defined in: [packages/sdk/src/types/generated/chat.ts:244](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L244) Aggregated token usage for a chat. ## Properties[​](#properties "Direct link to Properties") ### audioInputTokens?[​](#audioinputtokens "Direct link to audioInputTokens?") > `optional` **audioInputTokens**: `number` Defined in: [packages/sdk/src/types/generated/chat.ts:249](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L249) *** ### audioOutputTokens?[​](#audiooutputtokens "Direct link to audioOutputTokens?") > `optional` **audioOutputTokens**: `number` Defined in: [packages/sdk/src/types/generated/chat.ts:250](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L250) *** ### cachedTokens?[​](#cachedtokens "Direct link to cachedTokens?") > `optional` **cachedTokens**: `number` Defined in: [packages/sdk/src/types/generated/chat.ts:248](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L248) *** ### completionTokens?[​](#completiontokens "Direct link to completionTokens?") > `optional` **completionTokens**: `number` Defined in: [packages/sdk/src/types/generated/chat.ts:246](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L246) *** ### credits?[​](#credits "Direct link to credits?") > `optional` **credits**: `number` Defined in: [packages/sdk/src/types/generated/chat.ts:251](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L251) *** ### creditsPerHour?[​](#creditsperhour "Direct link to creditsPerHour?") > `optional` **creditsPerHour**: `number` | `null` Defined in: [packages/sdk/src/types/generated/chat.ts:258](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L258) *** ### creditsRemaining?[​](#creditsremaining "Direct link to creditsRemaining?") > `optional` **creditsRemaining**: `number` | `null` Defined in: [packages/sdk/src/types/generated/chat.ts:252](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L252) *** ### extraUsageEnabled?[​](#extrausageenabled "Direct link to extraUsageEnabled?") > `optional` **extraUsageEnabled**: `boolean` | `null` Defined in: [packages/sdk/src/types/generated/chat.ts:253](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L253) *** ### promptTokens?[​](#prompttokens "Direct link to promptTokens?") > `optional` **promptTokens**: `number` Defined in: [packages/sdk/src/types/generated/chat.ts:245](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L245) *** ### sttUsage?[​](#sttusage "Direct link to sttUsage?") > `optional` **sttUsage**: [`VoiceUsageResponse`](https://docs.gravityrail.com/sdk/interfaces/VoiceUsageResponse.md)\[] Defined in: [packages/sdk/src/types/generated/chat.ts:255](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L255) *** ### totalTokens?[​](#totaltokens "Direct link to totalTokens?") > `optional` **totalTokens**: `number` Defined in: [packages/sdk/src/types/generated/chat.ts:247](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L247) *** ### ttsUsage?[​](#ttsusage "Direct link to ttsUsage?") > `optional` **ttsUsage**: [`VoiceUsageResponse`](https://docs.gravityrail.com/sdk/interfaces/VoiceUsageResponse.md)\[] Defined in: [packages/sdk/src/types/generated/chat.ts:256](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L256) *** ### usageByModel?[​](#usagebymodel "Direct link to usageByModel?") > `optional` **usageByModel**: [`ModelUsageResponse`](https://docs.gravityrail.com/sdk/interfaces/ModelUsageResponse.md)\[] Defined in: [packages/sdk/src/types/generated/chat.ts:254](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L254) *** ### voiceDurationSeconds?[​](#voicedurationseconds "Direct link to voiceDurationSeconds?") > `optional` **voiceDurationSeconds**: `number` | `null` Defined in: [packages/sdk/src/types/generated/chat.ts:257](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L257) --- # Interface: ChildTaskFormData Defined in: [packages/sdk/src/types/task-types.ts:81](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/task-types.ts#L81) ## Properties[​](#properties "Direct link to Properties") ### autoNext[​](#autonext "Direct link to autoNext") > **autoNext**: `boolean` Defined in: [packages/sdk/src/types/task-types.ts:85](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/task-types.ts#L85) *** ### celCondition[​](#celcondition "Direct link to celCondition") > **celCondition**: `string` | `null` Defined in: [packages/sdk/src/types/task-types.ts:84](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/task-types.ts#L84) *** ### choicePrompt[​](#choiceprompt "Direct link to choicePrompt") > **choicePrompt**: `string` | `null` Defined in: [packages/sdk/src/types/task-types.ts:83](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/task-types.ts#L83) *** ### required[​](#required "Direct link to required") > **required**: `boolean` Defined in: [packages/sdk/src/types/task-types.ts:86](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/task-types.ts#L86) *** ### taskId[​](#taskid "Direct link to taskId") > **taskId**: `number` Defined in: [packages/sdk/src/types/task-types.ts:82](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/task-types.ts#L82) --- # Interface: ChildTaskResponse Defined in: [packages/sdk/src/types/generated/task.ts:120](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L120) Response model for child task endpoints. ## Properties[​](#properties "Direct link to Properties") ### autoNext[​](#autonext "Direct link to autoNext") > **autoNext**: `boolean` Defined in: [packages/sdk/src/types/generated/task.ts:128](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L128) *** ### celCondition[​](#celcondition "Direct link to celCondition") > **celCondition**: `string` | `null` Defined in: [packages/sdk/src/types/generated/task.ts:126](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L126) *** ### choicePrompt[​](#choiceprompt "Direct link to choicePrompt") > **choicePrompt**: `string` | `null` Defined in: [packages/sdk/src/types/generated/task.ts:125](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L125) *** ### id[​](#id "Direct link to id") > **id**: `number` Defined in: [packages/sdk/src/types/generated/task.ts:121](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L121) *** ### order[​](#order "Direct link to order") > **order**: `number` Defined in: [packages/sdk/src/types/generated/task.ts:127](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L127) *** ### required[​](#required "Direct link to required") > **required**: `boolean` Defined in: [packages/sdk/src/types/generated/task.ts:129](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L129) *** ### taskId[​](#taskid "Direct link to taskId") > **taskId**: `number` Defined in: [packages/sdk/src/types/generated/task.ts:122](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L122) *** ### taskName[​](#taskname "Direct link to taskName") > **taskName**: `string` Defined in: [packages/sdk/src/types/generated/task.ts:123](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L123) *** ### taskUuid[​](#taskuuid "Direct link to taskUuid") > **taskUuid**: `string` Defined in: [packages/sdk/src/types/generated/task.ts:124](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L124) --- # Interface: ClaudeChatModelConfig Defined in: [packages/sdk/src/types/model-config-types.ts:154](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/model-config-types.ts#L154) Base configuration for all chat models. Can be extended for provider-specific options. ## Extends[​](#extends "Direct link to Extends") * [`BaseChatModelConfig`](https://docs.gravityrail.com/sdk/interfaces/BaseChatModelConfig.md) ## Properties[​](#properties "Direct link to Properties") ### thinkingBudgetTokens?[​](#thinkingbudgettokens "Direct link to thinkingBudgetTokens?") > `optional` **thinkingBudgetTokens**: `number` | `null` Defined in: [packages/sdk/src/types/model-config-types.ts:156](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/model-config-types.ts#L156) *** ### thinkingEnabled?[​](#thinkingenabled "Direct link to thinkingEnabled?") > `optional` **thinkingEnabled**: `boolean` | `null` Defined in: [packages/sdk/src/types/model-config-types.ts:155](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/model-config-types.ts#L155) --- # Interface: CleanupChatsResponse Defined in: [packages/sdk/src/types/communication-types.ts:275](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/communication-types.ts#L275) ## Properties[​](#properties "Direct link to Properties") ### totalUpdated[​](#totalupdated "Direct link to totalUpdated") > **totalUpdated**: `number` Defined in: [packages/sdk/src/types/communication-types.ts:276](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/communication-types.ts#L276) --- # Interface: ClientWorkspace Defined in: [packages/sdk/src/types/workspace-types.ts:103](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/workspace-types.ts#L103) ## Properties[​](#properties "Direct link to Properties") ### createdAt[​](#createdat "Direct link to createdAt") > **createdAt**: `string` Defined in: [packages/sdk/src/types/workspace-types.ts:107](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/workspace-types.ts#L107) *** ### id[​](#id "Direct link to id") > **id**: `number` Defined in: [packages/sdk/src/types/workspace-types.ts:104](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/workspace-types.ts#L104) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/workspace-types.ts:105](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/workspace-types.ts#L105) *** ### slug[​](#slug "Direct link to slug") > **slug**: `string` Defined in: [packages/sdk/src/types/workspace-types.ts:109](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/workspace-types.ts#L109) *** ### status[​](#status "Direct link to status") > **status**: `number` Defined in: [packages/sdk/src/types/workspace-types.ts:108](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/workspace-types.ts#L108) *** ### uuid[​](#uuid "Direct link to uuid") > **uuid**: `string` Defined in: [packages/sdk/src/types/workspace-types.ts:106](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/workspace-types.ts#L106) --- # Interface: ColumnsResponse Defined in: [packages/sdk/src/api/monday.ts:41](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/monday.ts#L41) ## Properties[​](#properties "Direct link to Properties") ### columns[​](#columns "Direct link to columns") > **columns**: [`MondayColumn`](https://docs.gravityrail.com/sdk/interfaces/MondayColumn.md)\[] Defined in: [packages/sdk/src/api/monday.ts:42](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/monday.ts#L42) --- # Interface: CommunicationDetailsResponse Defined in: [packages/sdk/src/types/generated/usage.ts:37](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/usage.ts#L37) Communication details including phone numbers and daily breakdowns. ## Properties[​](#properties "Direct link to Properties") ### phone[​](#phone "Direct link to phone") > **phone**: [`PhoneCommunicationDetailsResponse`](https://docs.gravityrail.com/sdk/interfaces/PhoneCommunicationDetailsResponse.md) Defined in: [packages/sdk/src/types/generated/usage.ts:39](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/usage.ts#L39) *** ### sms[​](#sms "Direct link to sms") > **sms**: [`SMSCommunicationDetailsResponse`](https://docs.gravityrail.com/sdk/interfaces/SMSCommunicationDetailsResponse.md) Defined in: [packages/sdk/src/types/generated/usage.ts:38](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/usage.ts#L38) --- # Interface: CompareWithStripeResponse Defined in: [packages/sdk/src/types/generated/billing.ts:18](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/billing.ts#L18) Response model for comparing products with Stripe ## Properties[​](#properties "Direct link to Properties") ### comparisonResults[​](#comparisonresults "Direct link to comparisonResults") > **comparisonResults**: [`StripeComparisonResult`](https://docs.gravityrail.com/sdk/interfaces/StripeComparisonResult.md)\[] Defined in: [packages/sdk/src/types/generated/billing.ts:20](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/billing.ts#L20) *** ### lastCompared[​](#lastcompared "Direct link to lastCompared") > **lastCompared**: `string` Defined in: [packages/sdk/src/types/generated/billing.ts:21](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/billing.ts#L21) *** ### workspaceUuid[​](#workspaceuuid "Direct link to workspaceUuid") > **workspaceUuid**: `string` Defined in: [packages/sdk/src/types/generated/billing.ts:19](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/billing.ts#L19) --- # Interface: ConcludeAssignmentActionParams Defined in: [packages/sdk/src/types/event-types.ts:304](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L304) ## Properties[​](#properties "Direct link to Properties") ### outcome[​](#outcome "Direct link to outcome") > **outcome**: `string` Defined in: [packages/sdk/src/types/event-types.ts:308](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L308) *** ### reason?[​](#reason "Direct link to reason?") > `optional` **reason**: `string` Defined in: [packages/sdk/src/types/event-types.ts:309](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L309) --- # Interface: ConfigurePatientSyncRequest Defined in: [packages/sdk/src/api/patientsync-connections.ts:9](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/patientsync-connections.ts#L9) Upsert the workspace's PatientSync connection. On first configure `apiBaseUrl` + `apiKey` are required; later configures apply only the fields provided (so the key can be rotated or the form changed independently). `apiKey` is write-only — it is never returned by any endpoint. ## Properties[​](#properties "Direct link to Properties") ### apiBaseUrl?[​](#apibaseurl "Direct link to apiBaseUrl?") > `optional` **apiBaseUrl**: `string` Defined in: [packages/sdk/src/api/patientsync-connections.ts:10](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/patientsync-connections.ts#L10) *** ### apiKey?[​](#apikey "Direct link to apiKey?") > `optional` **apiKey**: `string` Defined in: [packages/sdk/src/api/patientsync-connections.ts:11](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/patientsync-connections.ts#L11) *** ### enabled?[​](#enabled "Direct link to enabled?") > `optional` **enabled**: `boolean` Defined in: [packages/sdk/src/api/patientsync-connections.ts:15](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/patientsync-connections.ts#L15) *** ### fallbackDid?[​](#fallbackdid "Direct link to fallbackDid?") > `optional` **fallbackDid**: `string` Defined in: [packages/sdk/src/api/patientsync-connections.ts:14](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/patientsync-connections.ts#L14) *** ### formSlug?[​](#formslug "Direct link to formSlug?") > `optional` **formSlug**: `string` Defined in: [packages/sdk/src/api/patientsync-connections.ts:13](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/patientsync-connections.ts#L13) *** ### requestor?[​](#requestor "Direct link to requestor?") > `optional` **requestor**: `string` Defined in: [packages/sdk/src/api/patientsync-connections.ts:12](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/patientsync-connections.ts#L12) --- # Interface: ConflictPolicy Defined in: [packages/sdk/src/types/app-connection-types.ts:483](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L483) ## Properties[​](#properties "Direct link to Properties") ### mode[​](#mode "Direct link to mode") > **mode**: [`ConflictPolicyMode`](https://docs.gravityrail.com/sdk/type-aliases/ConflictPolicyMode.md) Defined in: [packages/sdk/src/types/app-connection-types.ts:484](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L484) --- # Interface: ConfluenceConnectionResponse Defined in: [packages/sdk/src/types/generated/app\_connection.ts:38](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L38) Serialized Confluence connection for API responses. ## Properties[​](#properties "Direct link to Properties") ### cloudId?[​](#cloudid "Direct link to cloudId?") > `optional` **cloudId**: `string` | `null` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:45](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L45) *** ### connectionType?[​](#connectiontype "Direct link to connectionType?") > `optional` **connectionType**: `"confluence_connection"` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:39](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L39) *** ### createdAt?[​](#createdat "Direct link to createdAt?") > `optional` **createdAt**: `string` | `null` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:49](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L49) *** ### creatorId?[​](#creatorid "Direct link to creatorId?") > `optional` **creatorId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:44](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L44) *** ### enabled[​](#enabled "Direct link to enabled") > **enabled**: `boolean` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:43](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L43) *** ### id[​](#id "Direct link to id") > **id**: `number` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:40](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L40) *** ### lastConnectedAt?[​](#lastconnectedat "Direct link to lastConnectedAt?") > `optional` **lastConnectedAt**: `string` | `null` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:48](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L48) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:42](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L42) *** ### siteUrl?[​](#siteurl "Direct link to siteUrl?") > `optional` **siteUrl**: `string` | `null` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:46](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L46) *** ### state?[​](#state "Direct link to state?") > `optional` **state**: `string` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:47](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L47) *** ### syncConfig?[​](#syncconfig "Direct link to syncConfig?") > `optional` **syncConfig**: `ConfluenceConnectionResponseSyncConfig` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:51](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L51) *** ### updatedAt?[​](#updatedat "Direct link to updatedAt?") > `optional` **updatedAt**: `string` | `null` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:50](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L50) *** ### uuid[​](#uuid "Direct link to uuid") > **uuid**: `string` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:41](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L41) --- # Interface: ConnectionSyncConfig Defined in: [packages/sdk/src/types/app-connection-types.ts:518](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L518) ## Properties[​](#properties "Direct link to Properties") ### automations[​](#automations "Direct link to automations") > **automations**: [`ManagedAutomationConfig`](https://docs.gravityrail.com/sdk/interfaces/ManagedAutomationConfig.md)\[] Defined in: [packages/sdk/src/types/app-connection-types.ts:522](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L522) *** ### chatNoteSync?[​](#chatnotesync "Direct link to chatNoteSync?") > `optional` **chatNoteSync**: [`ChatNoteSyncConfig`](https://docs.gravityrail.com/sdk/interfaces/ChatNoteSyncConfig.md) | `null` Defined in: [packages/sdk/src/types/app-connection-types.ts:526](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L526) *** ### connectionParams?[​](#connectionparams "Direct link to connectionParams?") > `optional` **connectionParams**: `Record`<`string`, `unknown`> Defined in: [packages/sdk/src/types/app-connection-types.ts:521](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L521) *** ### defaultLifecycleStage?[​](#defaultlifecyclestage "Direct link to defaultLifecycleStage?") > `optional` **defaultLifecycleStage**: `string` | `null` Defined in: [packages/sdk/src/types/app-connection-types.ts:525](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L525) *** ### entities[​](#entities "Direct link to entities") > **entities**: [`EntitySyncConfig`](https://docs.gravityrail.com/sdk/interfaces/EntitySyncConfig.md)\[] Defined in: [packages/sdk/src/types/app-connection-types.ts:520](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L520) *** ### noteSync?[​](#notesync "Direct link to noteSync?") > `optional` **noteSync**: [`HubSpotNoteSyncConfig`](https://docs.gravityrail.com/sdk/interfaces/HubSpotNoteSyncConfig.md)\[] Defined in: [packages/sdk/src/types/app-connection-types.ts:523](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L523) *** ### syncKey[​](#synckey "Direct link to syncKey") > **syncKey**: `string` Defined in: [packages/sdk/src/types/app-connection-types.ts:519](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L519) *** ### taskSync?[​](#tasksync "Direct link to taskSync?") > `optional` **taskSync**: [`HubSpotTaskSyncConfig`](https://docs.gravityrail.com/sdk/interfaces/HubSpotTaskSyncConfig.md)\[] Defined in: [packages/sdk/src/types/app-connection-types.ts:524](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L524) --- # Interface: ContributorChatParticipant Defined in: [packages/sdk/src/types/chat-types.ts:151](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L151) ## Properties[​](#properties "Direct link to Properties") ### additionalInstructions?[​](#additionalinstructions "Direct link to additionalInstructions?") > `optional` **additionalInstructions**: `string` Defined in: [packages/sdk/src/types/chat-types.ts:155](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L155) *** ### memberId[​](#memberid "Direct link to memberId") > **memberId**: `number` Defined in: [packages/sdk/src/types/chat-types.ts:154](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L154) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/chat-types.ts:152](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L152) *** ### role[​](#role "Direct link to role") > **role**: `"contributor"` Defined in: [packages/sdk/src/types/chat-types.ts:153](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L153) --- # Interface: ConversationControlAbilityConfig Defined in: [packages/sdk/src/types/ability-types.ts:387](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ability-types.ts#L387) Config for conversation\_control ability ## Properties[​](#properties "Direct link to Properties") ### restartWorkflow?[​](#restartworkflow "Direct link to restartWorkflow?") > `optional` **restartWorkflow**: `boolean` Defined in: [packages/sdk/src/types/ability-types.ts:393](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ability-types.ts#L393) Enable restarting with the default workflow for phone channels (default: true) *** ### scheduleCallback?[​](#schedulecallback "Direct link to scheduleCallback?") > `optional` **scheduleCallback**: `boolean` Defined in: [packages/sdk/src/types/ability-types.ts:389](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ability-types.ts#L389) Enable scheduling callbacks to continue conversation later (default: true) *** ### startOver?[​](#startover "Direct link to startOver?") > `optional` **startOver**: `boolean` Defined in: [packages/sdk/src/types/ability-types.ts:391](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ability-types.ts#L391) Enable restarting the assignment from scratch (default: false) --- # Interface: ConversationHistoryAbilityConfig Defined in: [packages/sdk/src/types/ability-types.ts:266](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ability-types.ts#L266) Config for conversation\_history ability ## Properties[​](#properties "Direct link to Properties") ### include\_chats?[​](#include_chats "Direct link to include_chats?") > `optional` **include\_chats**: `number` Defined in: [packages/sdk/src/types/ability-types.ts:272](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ability-types.ts#L272) Include up to N recent chat summaries directly in the prompt (default: 0) *** ### list\_chats?[​](#list_chats "Direct link to list_chats?") > `optional` **list\_chats**: `boolean` Defined in: [packages/sdk/src/types/ability-types.ts:268](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ability-types.ts#L268) Enable listing prior chat conversations (default: true) *** ### memory\_basic\_read?[​](#memory_basic_read "Direct link to memory_basic_read?") > `optional` **memory\_basic\_read**: `boolean` Defined in: [packages/sdk/src/types/ability-types.ts:274](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ability-types.ts#L274) Load saved basic memories into the prompt (default: false) *** ### memory\_basic\_write?[​](#memory_basic_write "Direct link to memory_basic_write?") > `optional` **memory\_basic\_write**: `boolean` Defined in: [packages/sdk/src/types/ability-types.ts:276](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ability-types.ts#L276) Enable tools to save/delete basic memories (default: false) *** ### memory\_enabled?[​](#memory_enabled "Direct link to memory_enabled?") > `optional` **memory\_enabled**: `boolean` Defined in: [packages/sdk/src/types/ability-types.ts:278](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ability-types.ts#L278) Send conversations for automatic memory extraction. Requires agent\_memory feature. (default: false) *** ### memory\_episodic?[​](#memory_episodic "Direct link to memory_episodic?") > `optional` **memory\_episodic**: `boolean` Defined in: [packages/sdk/src/types/ability-types.ts:286](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ability-types.ts#L286) Recall episodic memories (default: false) *** ### memory\_preferences?[​](#memory_preferences "Direct link to memory_preferences?") > `optional` **memory\_preferences**: `boolean` Defined in: [packages/sdk/src/types/ability-types.ts:280](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ability-types.ts#L280) Recall user preference memories (default: false) *** ### memory\_semantic?[​](#memory_semantic "Direct link to memory_semantic?") > `optional` **memory\_semantic**: `boolean` Defined in: [packages/sdk/src/types/ability-types.ts:282](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ability-types.ts#L282) Recall semantic fact memories (default: false) *** ### memory\_summaries?[​](#memory_summaries "Direct link to memory_summaries?") > `optional` **memory\_summaries**: `boolean` Defined in: [packages/sdk/src/types/ability-types.ts:284](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ability-types.ts#L284) Recall conversation summary memories (default: false) *** ### read\_messages?[​](#read_messages "Direct link to read_messages?") > `optional` **read\_messages**: `boolean` Defined in: [packages/sdk/src/types/ability-types.ts:270](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ability-types.ts#L270) Enable reading messages from prior chats (default: true) --- # Interface: ConvertedFileResponse Defined in: [packages/sdk/src/types/generated/file.ts:12](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/file.ts#L12) Response model for file conversion endpoints. ## Properties[​](#properties "Direct link to Properties") ### content[​](#content "Direct link to content") > **content**: `string` Defined in: [packages/sdk/src/types/generated/file.ts:13](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/file.ts#L13) *** ### filename[​](#filename "Direct link to filename") > **filename**: `string` Defined in: [packages/sdk/src/types/generated/file.ts:15](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/file.ts#L15) *** ### format[​](#format "Direct link to format") > **format**: `ConvertedFileResponseFormat` Defined in: [packages/sdk/src/types/generated/file.ts:14](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/file.ts#L14) *** ### message[​](#message "Direct link to message") > **message**: `string` Defined in: [packages/sdk/src/types/generated/file.ts:16](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/file.ts#L16) --- # Interface: CreateAccessGrantRequest Defined in: [packages/sdk/src/types/access-grant-types.ts:58](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/access-grant-types.ts#L58) ## Properties[​](#properties "Direct link to Properties") ### accessMode?[​](#accessmode "Direct link to accessMode?") > `optional` **accessMode**: `number` Defined in: [packages/sdk/src/types/access-grant-types.ts:67](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/access-grant-types.ts#L67) *** ### assignmentId?[​](#assignmentid "Direct link to assignmentId?") > `optional` **assignmentId**: `number` Defined in: [packages/sdk/src/types/access-grant-types.ts:69](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/access-grant-types.ts#L69) *** ### autoApprove?[​](#autoapprove "Direct link to autoApprove?") > `optional` **autoApprove**: `boolean` Defined in: [packages/sdk/src/types/access-grant-types.ts:73](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/access-grant-types.ts#L73) *** ### bounds?[​](#bounds "Direct link to bounds?") > `optional` **bounds**: `Record`<`string`, `unknown`> Defined in: [packages/sdk/src/types/access-grant-types.ts:66](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/access-grant-types.ts#L66) Declared structural limits for capability grants — never PHI. *** ### capabilityClass?[​](#capabilityclass "Direct link to capabilityClass?") > `optional` **capabilityClass**: `string` Defined in: [packages/sdk/src/types/access-grant-types.ts:64](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/access-grant-types.ts#L64) Capability grants only (resourceType 'capability'). *** ### chatId?[​](#chatid "Direct link to chatId?") > `optional` **chatId**: `number` Defined in: [packages/sdk/src/types/access-grant-types.ts:70](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/access-grant-types.ts#L70) *** ### consentMethod?[​](#consentmethod "Direct link to consentMethod?") > `optional` **consentMethod**: [`ConsentMethod`](https://docs.gravityrail.com/sdk/enumerations/ConsentMethod.md) Defined in: [packages/sdk/src/types/access-grant-types.ts:72](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/access-grant-types.ts#L72) *** ### dataTypeId?[​](#datatypeid "Direct link to dataTypeId?") > `optional` **dataTypeId**: `number` Defined in: [packages/sdk/src/types/access-grant-types.ts:62](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/access-grant-types.ts#L62) *** ### expiresAt?[​](#expiresat "Direct link to expiresAt?") > `optional` **expiresAt**: `string` Defined in: [packages/sdk/src/types/access-grant-types.ts:71](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/access-grant-types.ts#L71) *** ### granteeMemberId[​](#granteememberid "Direct link to granteeMemberId") > **granteeMemberId**: `number` Defined in: [packages/sdk/src/types/access-grant-types.ts:59](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/access-grant-types.ts#L59) *** ### resourceId?[​](#resourceid "Direct link to resourceId?") > `optional` **resourceId**: `number` Defined in: [packages/sdk/src/types/access-grant-types.ts:61](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/access-grant-types.ts#L61) *** ### resourceType[​](#resourcetype "Direct link to resourceType") > **resourceType**: [`AccessGrantResourceType`](https://docs.gravityrail.com/sdk/enumerations/AccessGrantResourceType.md) Defined in: [packages/sdk/src/types/access-grant-types.ts:60](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/access-grant-types.ts#L60) *** ### trigger[​](#trigger "Direct link to trigger") > **trigger**: [`AccessGrantTrigger`](https://docs.gravityrail.com/sdk/enumerations/AccessGrantTrigger.md) Defined in: [packages/sdk/src/types/access-grant-types.ts:68](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/access-grant-types.ts#L68) --- # Interface: CreateAccountOrgMembershipRequest Defined in: [packages/sdk/src/types/account-types.ts:452](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L452) ## Properties[​](#properties "Direct link to Properties") ### organizationId[​](#organizationid "Direct link to organizationId") > **organizationId**: `number` Defined in: [packages/sdk/src/types/account-types.ts:453](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L453) *** ### role[​](#role "Direct link to role") > **role**: [`OrgMemberRole`](https://docs.gravityrail.com/sdk/type-aliases/OrgMemberRole.md) Defined in: [packages/sdk/src/types/account-types.ts:454](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L454) --- # Interface: CreateAccountOrgMembershipResponse Defined in: [packages/sdk/src/types/account-types.ts:457](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L457) ## Properties[​](#properties "Direct link to Properties") ### accountId[​](#accountid "Direct link to accountId") > **accountId**: `number` Defined in: [packages/sdk/src/types/account-types.ts:458](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L458) *** ### message[​](#message "Direct link to message") > **message**: `string` Defined in: [packages/sdk/src/types/account-types.ts:463](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L463) *** ### organizationId[​](#organizationid "Direct link to organizationId") > **organizationId**: `number` Defined in: [packages/sdk/src/types/account-types.ts:459](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L459) *** ### organizationName[​](#organizationname "Direct link to organizationName") > **organizationName**: `string` Defined in: [packages/sdk/src/types/account-types.ts:461](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L461) *** ### organizationUuid[​](#organizationuuid "Direct link to organizationUuid") > **organizationUuid**: `string` Defined in: [packages/sdk/src/types/account-types.ts:460](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L460) *** ### role[​](#role "Direct link to role") > **role**: `string` Defined in: [packages/sdk/src/types/account-types.ts:462](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L462) --- # Interface: CreateAgentRequest Defined in: [packages/sdk/src/types/member-types.ts:441](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L441) ## Properties[​](#properties "Direct link to Properties") ### chatModelConfig?[​](#chatmodelconfig "Direct link to chatModelConfig?") > `optional` **chatModelConfig**: `Record`<`string`, `unknown`> Defined in: [packages/sdk/src/types/member-types.ts:452](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L452) *** ### chatModelId[​](#chatmodelid "Direct link to chatModelId") > **chatModelId**: `string` Defined in: [packages/sdk/src/types/member-types.ts:451](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L451) *** ### codeInterpreterEnabled?[​](#codeinterpreterenabled "Direct link to codeInterpreterEnabled?") > `optional` **codeInterpreterEnabled**: `boolean` Defined in: [packages/sdk/src/types/member-types.ts:458](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L458) *** ### description?[​](#description "Direct link to description?") > `optional` **description**: `string` Defined in: [packages/sdk/src/types/member-types.ts:443](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L443) *** ### email?[​](#email "Direct link to email?") > `optional` **email**: `string` Defined in: [packages/sdk/src/types/member-types.ts:444](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L444) *** ### externalId?[​](#externalid "Direct link to externalId?") > `optional` **externalId**: `string` Defined in: [packages/sdk/src/types/member-types.ts:446](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L446) *** ### labelIds?[​](#labelids "Direct link to labelIds?") > `optional` **labelIds**: `number`\[] Defined in: [packages/sdk/src/types/member-types.ts:449](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L449) *** ### maxDailyActions?[​](#maxdailyactions "Direct link to maxDailyActions?") > `optional` **maxDailyActions**: `number` Defined in: [packages/sdk/src/types/member-types.ts:456](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L456) *** ### memberRoleId?[​](#memberroleid "Direct link to memberRoleId?") > `optional` **memberRoleId**: `number` Defined in: [packages/sdk/src/types/member-types.ts:448](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L448) Omitted → backend defaults to the workspace's canonical Agent role (#16207). *** ### memoryConfig?[​](#memoryconfig "Direct link to memoryConfig?") > `optional` **memoryConfig**: [`AgentMemoryConfig`](https://docs.gravityrail.com/sdk/interfaces/AgentMemoryConfig.md) Defined in: [packages/sdk/src/types/member-types.ts:459](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L459) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/member-types.ts:442](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L442) *** ### ownerId?[​](#ownerid "Direct link to ownerId?") > `optional` **ownerId**: `number` Defined in: [packages/sdk/src/types/member-types.ts:450](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L450) *** ### phone?[​](#phone "Direct link to phone?") > `optional` **phone**: `string` Defined in: [packages/sdk/src/types/member-types.ts:445](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L445) *** ### realtimeModelConfig?[​](#realtimemodelconfig "Direct link to realtimeModelConfig?") > `optional` **realtimeModelConfig**: `Record`<`string`, `unknown`> Defined in: [packages/sdk/src/types/member-types.ts:454](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L454) *** ### realtimeModelId?[​](#realtimemodelid "Direct link to realtimeModelId?") > `optional` **realtimeModelId**: `string` Defined in: [packages/sdk/src/types/member-types.ts:453](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L453) *** ### systemPrompt[​](#systemprompt "Direct link to systemPrompt") > **systemPrompt**: `string` Defined in: [packages/sdk/src/types/member-types.ts:455](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L455) *** ### tools?[​](#tools "Direct link to tools?") > `optional` **tools**: `string`\[] Defined in: [packages/sdk/src/types/member-types.ts:457](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L457) --- # Interface: CreateAnonymousMemberRequest Defined in: [packages/sdk/src/types/member-types.ts:494](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L494) ## Properties[​](#properties "Direct link to Properties") ### identifierType[​](#identifiertype "Direct link to identifierType") > **identifierType**: `string` Defined in: [packages/sdk/src/types/member-types.ts:495](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L495) *** ### identifierValue[​](#identifiervalue "Direct link to identifierValue") > **identifierValue**: `string` Defined in: [packages/sdk/src/types/member-types.ts:496](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L496) *** ### memberRoleId?[​](#memberroleid "Direct link to memberRoleId?") > `optional` **memberRoleId**: `number` Defined in: [packages/sdk/src/types/member-types.ts:498](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L498) *** ### name?[​](#name "Direct link to name?") > `optional` **name**: `string` Defined in: [packages/sdk/src/types/member-types.ts:497](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L497) --- # Interface: CreateAppConnectionRequest Defined in: [packages/sdk/src/types/app-connection-types.ts:619](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L619) Request body for enabling a platform app connection. ## Properties[​](#properties "Direct link to Properties") ### config?[​](#config "Direct link to config?") > `optional` **config**: `Record`<`string`, `unknown`> Defined in: [packages/sdk/src/types/app-connection-types.ts:622](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L622) *** ### name?[​](#name "Direct link to name?") > `optional` **name**: `string` Defined in: [packages/sdk/src/types/app-connection-types.ts:621](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L621) *** ### slug[​](#slug "Direct link to slug") > **slug**: `string` Defined in: [packages/sdk/src/types/app-connection-types.ts:620](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L620) --- # Interface: CreateAppRequest Defined in: [packages/sdk/src/types/app-types.ts:39](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-types.ts#L39) ## Properties[​](#properties "Direct link to Properties") ### allowedWorkspaces?[​](#allowedworkspaces "Direct link to allowedWorkspaces?") > `optional` **allowedWorkspaces**: `number`\[] Defined in: [packages/sdk/src/types/app-types.ts:49](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-types.ts#L49) *** ### authorizationServerUrl?[​](#authorizationserverurl "Direct link to authorizationServerUrl?") > `optional` **authorizationServerUrl**: `string` Defined in: [packages/sdk/src/types/app-types.ts:46](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-types.ts#L46) *** ### builderId[​](#builderid "Direct link to builderId") > **builderId**: `number` Defined in: [packages/sdk/src/types/app-types.ts:41](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-types.ts#L41) *** ### description?[​](#description "Direct link to description?") > `optional` **description**: `string` Defined in: [packages/sdk/src/types/app-types.ts:42](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-types.ts#L42) *** ### grantTypes?[​](#granttypes "Direct link to grantTypes?") > `optional` **grantTypes**: `string`\[] Defined in: [packages/sdk/src/types/app-types.ts:48](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-types.ts#L48) *** ### isPublic?[​](#ispublic "Direct link to isPublic?") > `optional` **isPublic**: `boolean` Defined in: [packages/sdk/src/types/app-types.ts:50](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-types.ts#L50) *** ### mcpUrl?[​](#mcpurl "Direct link to mcpUrl?") > `optional` **mcpUrl**: `string` Defined in: [packages/sdk/src/types/app-types.ts:44](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-types.ts#L44) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/app-types.ts:40](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-types.ts#L40) *** ### redirectUris?[​](#redirecturis "Direct link to redirectUris?") > `optional` **redirectUris**: `string`\[] Defined in: [packages/sdk/src/types/app-types.ts:45](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-types.ts#L45) *** ### responseTypes?[​](#responsetypes "Direct link to responseTypes?") > `optional` **responseTypes**: `string`\[] Defined in: [packages/sdk/src/types/app-types.ts:47](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-types.ts#L47) *** ### scopes?[​](#scopes "Direct link to scopes?") > `optional` **scopes**: `string`\[] Defined in: [packages/sdk/src/types/app-types.ts:43](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-types.ts#L43) --- # Interface: CreateAssignmentFormData Defined in: [packages/sdk/src/types/task-types.ts:129](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/task-types.ts#L129) ## Properties[​](#properties "Direct link to Properties") ### dataRecords?[​](#datarecords "Direct link to dataRecords?") > `optional` **dataRecords**: [`DataRecordAssociationFormData`](https://docs.gravityrail.com/sdk/interfaces/DataRecordAssociationFormData.md)\[] Defined in: [packages/sdk/src/types/task-types.ts:134](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/task-types.ts#L134) *** ### files?[​](#files "Direct link to files?") > `optional` **files**: [`FileAssociationFormData`](https://docs.gravityrail.com/sdk/interfaces/FileAssociationFormData.md)\[] Defined in: [packages/sdk/src/types/task-types.ts:135](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/task-types.ts#L135) *** ### isTest?[​](#istest "Direct link to isTest?") > `optional` **isTest**: `boolean` Defined in: [packages/sdk/src/types/task-types.ts:133](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/task-types.ts#L133) *** ### memberId?[​](#memberid "Direct link to memberId?") > `optional` **memberId**: `number` Defined in: [packages/sdk/src/types/task-types.ts:132](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/task-types.ts#L132) *** ### taskId?[​](#taskid "Direct link to taskId?") > `optional` **taskId**: `number` Defined in: [packages/sdk/src/types/task-types.ts:130](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/task-types.ts#L130) *** ### workflowId?[​](#workflowid "Direct link to workflowId?") > `optional` **workflowId**: `number` Defined in: [packages/sdk/src/types/task-types.ts:131](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/task-types.ts#L131) --- # Interface: CreateBuilderRequest Defined in: [packages/sdk/src/types/builder-types.ts:20](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/builder-types.ts#L20) ## Properties[​](#properties "Direct link to Properties") ### avatarImage?[​](#avatarimage "Direct link to avatarImage?") > `optional` **avatarImage**: `string` Defined in: [packages/sdk/src/types/builder-types.ts:24](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/builder-types.ts#L24) *** ### avatarImageMimeType?[​](#avatarimagemimetype "Direct link to avatarImageMimeType?") > `optional` **avatarImageMimeType**: `string` Defined in: [packages/sdk/src/types/builder-types.ts:25](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/builder-types.ts#L25) *** ### description?[​](#description "Direct link to description?") > `optional` **description**: `string` Defined in: [packages/sdk/src/types/builder-types.ts:22](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/builder-types.ts#L22) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/builder-types.ts:21](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/builder-types.ts#L21) *** ### siteUrl?[​](#siteurl "Direct link to siteUrl?") > `optional` **siteUrl**: `string` Defined in: [packages/sdk/src/types/builder-types.ts:23](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/builder-types.ts#L23) --- # Interface: CreateCredentialChangeInviteRequest Defined in: [packages/sdk/src/types/account-types.ts:488](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L488) ## Properties[​](#properties "Direct link to Properties") ### credentialType[​](#credentialtype "Direct link to credentialType") > **credentialType**: [`CredentialType`](https://docs.gravityrail.com/sdk/type-aliases/CredentialType.md) Defined in: [packages/sdk/src/types/account-types.ts:489](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L489) *** ### newValue[​](#newvalue "Direct link to newValue") > **newValue**: `string` Defined in: [packages/sdk/src/types/account-types.ts:490](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L490) --- # Interface: CreateDiscordBotRequest Defined in: [packages/sdk/src/types/discord-bot-types.ts:39](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/discord-bot-types.ts#L39) Form data for creating a Discord bot. ## Properties[​](#properties "Direct link to Properties") ### allowDm?[​](#allowdm "Direct link to allowDm?") > `optional` **allowDm**: `boolean` Defined in: [packages/sdk/src/types/discord-bot-types.ts:52](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/discord-bot-types.ts#L52) *** ### allowedChannelIds?[​](#allowedchannelids "Direct link to allowedChannelIds?") > `optional` **allowedChannelIds**: `string`\[] Defined in: [packages/sdk/src/types/discord-bot-types.ts:60](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/discord-bot-types.ts#L60) *** ### allowedGuildIds?[​](#allowedguildids "Direct link to allowedGuildIds?") > `optional` **allowedGuildIds**: `string`\[] Defined in: [packages/sdk/src/types/discord-bot-types.ts:59](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/discord-bot-types.ts#L59) *** ### applicationId[​](#applicationid "Direct link to applicationId") > **applicationId**: `string` Defined in: [packages/sdk/src/types/discord-bot-types.ts:41](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/discord-bot-types.ts#L41) *** ### botToken[​](#bottoken "Direct link to botToken") > **botToken**: `string` Defined in: [packages/sdk/src/types/discord-bot-types.ts:42](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/discord-bot-types.ts#L42) *** ### clientSecret?[​](#clientsecret "Direct link to clientSecret?") > `optional` **clientSecret**: `string` Defined in: [packages/sdk/src/types/discord-bot-types.ts:44](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/discord-bot-types.ts#L44) *** ### defaultWorkflowId?[​](#defaultworkflowid "Direct link to defaultWorkflowId?") > `optional` **defaultWorkflowId**: `number` | `null` Defined in: [packages/sdk/src/types/discord-bot-types.ts:56](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/discord-bot-types.ts#L56) Default workflow ID for #### Mention[​](#mention "Direct link to Mention") responses (null = manager mode) *** ### enableGateway?[​](#enablegateway "Direct link to enableGateway?") > `optional` **enableGateway**: `boolean` Defined in: [packages/sdk/src/types/discord-bot-types.ts:54](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/discord-bot-types.ts#L54) Enable Discord Gateway for #### Mention[​](#mention-1 "Direct link to Mention") responses (requires MESSAGE\_CONTENT intent) *** ### memberId?[​](#memberid "Direct link to memberId?") > `optional` **memberId**: `number` | `null` Defined in: [packages/sdk/src/types/discord-bot-types.ts:58](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/discord-bot-types.ts#L58) Agent member ID who handles all bot interactions (mutually exclusive with defaultWorkflowId) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/discord-bot-types.ts:40](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/discord-bot-types.ts#L40) *** ### publicKey[​](#publickey "Direct link to publicKey") > **publicKey**: `string` Defined in: [packages/sdk/src/types/discord-bot-types.ts:43](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/discord-bot-types.ts#L43) *** ### replyInThread?[​](#replyinthread "Direct link to replyInThread?") > `optional` **replyInThread**: `boolean` Defined in: [packages/sdk/src/types/discord-bot-types.ts:47](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/discord-bot-types.ts#L47) *** ### respondMode?[​](#respondmode "Direct link to respondMode?") > `optional` **respondMode**: [`DiscordRespondMode`](https://docs.gravityrail.com/sdk/type-aliases/DiscordRespondMode.md) Defined in: [packages/sdk/src/types/discord-bot-types.ts:49](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/discord-bot-types.ts#L49) How bot responds: 'mentions' (only @mentions), 'auto' (AI decides), 'off' (slash commands only) *** ### respondWhen?[​](#respondwhen "Direct link to respondWhen?") > `optional` **respondWhen**: `string` Defined in: [packages/sdk/src/types/discord-bot-types.ts:51](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/discord-bot-types.ts#L51) Custom prompt for AI to decide when to respond (only used when respondMode is 'auto') *** ### slashCommands?[​](#slashcommands "Direct link to slashCommands?") > `optional` **slashCommands**: [`SlashCommandConfigResponse`](https://docs.gravityrail.com/sdk/interfaces/SlashCommandConfigResponse.md)\[] Defined in: [packages/sdk/src/types/discord-bot-types.ts:46](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/discord-bot-types.ts#L46) Custom slash commands - each command triggers a workflow --- # Interface: CreateFhirConnectionRequest Defined in: [packages/sdk/src/types/fhir-connection-types.ts:71](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L71) Form data for creating a FHIR connection. ## Properties[​](#properties "Direct link to Properties") ### clientId[​](#clientid "Direct link to clientId") > **clientId**: `string` Defined in: [packages/sdk/src/types/fhir-connection-types.ts:77](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L77) *** ### clientSecret?[​](#clientsecret "Direct link to clientSecret?") > `optional` **clientSecret**: `string` Defined in: [packages/sdk/src/types/fhir-connection-types.ts:78](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L78) *** ### clientType?[​](#clienttype "Direct link to clientType?") > `optional` **clientType**: [`FhirClientType`](https://docs.gravityrail.com/sdk/enumerations/FhirClientType.md) Defined in: [packages/sdk/src/types/fhir-connection-types.ts:74](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L74) *** ### fhirBaseUrl[​](#fhirbaseurl "Direct link to fhirBaseUrl") > **fhirBaseUrl**: `string` Defined in: [packages/sdk/src/types/fhir-connection-types.ts:75](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L75) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/fhir-connection-types.ts:72](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L72) *** ### practiceId?[​](#practiceid "Direct link to practiceId?") > `optional` **practiceId**: `string` Defined in: [packages/sdk/src/types/fhir-connection-types.ts:76](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L76) *** ### rateLimitPerMinute?[​](#ratelimitperminute "Direct link to rateLimitPerMinute?") > `optional` **rateLimitPerMinute**: `number` Defined in: [packages/sdk/src/types/fhir-connection-types.ts:80](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L80) *** ### tokenEndpoint?[​](#tokenendpoint "Direct link to tokenEndpoint?") > `optional` **tokenEndpoint**: `string` Defined in: [packages/sdk/src/types/fhir-connection-types.ts:79](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L79) *** ### vendor[​](#vendor "Direct link to vendor") > **vendor**: [`FhirVendor`](https://docs.gravityrail.com/sdk/enumerations/FhirVendor.md) Defined in: [packages/sdk/src/types/fhir-connection-types.ts:73](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L73) *** ### vendorConfig?[​](#vendorconfig "Direct link to vendorConfig?") > `optional` **vendorConfig**: `Record`<`string`, `unknown`> Defined in: [packages/sdk/src/types/fhir-connection-types.ts:81](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L81) --- # Interface: CreateMemberFieldRequest Defined in: [packages/sdk/src/types/member-field-types.ts:15](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-field-types.ts#L15) ## Properties[​](#properties "Direct link to Properties") ### key[​](#key "Direct link to key") > **key**: `string` Defined in: [packages/sdk/src/types/member-field-types.ts:16](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-field-types.ts#L16) *** ### serviceId?[​](#serviceid "Direct link to serviceId?") > `optional` **serviceId**: `number` Defined in: [packages/sdk/src/types/member-field-types.ts:18](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-field-types.ts#L18) *** ### value[​](#value "Direct link to value") > **value**: `string` Defined in: [packages/sdk/src/types/member-field-types.ts:17](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-field-types.ts#L17) --- # Interface: CreateOperatorGroupRequest Defined in: [packages/sdk/src/types/operator-types.ts:180](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/operator-types.ts#L180) ## Properties[​](#properties "Direct link to Properties") ### members?[​](#members "Direct link to members?") > `optional` **members**: [`OperatorGroupMemberInput`](https://docs.gravityrail.com/sdk/interfaces/OperatorGroupMemberInput.md)\[] Defined in: [packages/sdk/src/types/operator-types.ts:183](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/operator-types.ts#L183) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/operator-types.ts:181](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/operator-types.ts#L181) *** ### routingStrategy?[​](#routingstrategy "Direct link to routingStrategy?") > `optional` **routingStrategy**: [`RoutingStrategy`](https://docs.gravityrail.com/sdk/type-aliases/RoutingStrategy.md) Defined in: [packages/sdk/src/types/operator-types.ts:182](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/operator-types.ts#L182) --- # Interface: CreateOrganizationInvitationFormData Defined in: [packages/sdk/src/types/invitation-types.ts:49](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/invitation-types.ts#L49) ## Properties[​](#properties "Direct link to Properties") ### email[​](#email "Direct link to email") > **email**: `string` Defined in: [packages/sdk/src/types/invitation-types.ts:50](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/invitation-types.ts#L50) *** ### message?[​](#message "Direct link to message?") > `optional` **message**: `string` Defined in: [packages/sdk/src/types/invitation-types.ts:53](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/invitation-types.ts#L53) *** ### name?[​](#name "Direct link to name?") > `optional` **name**: `string` Defined in: [packages/sdk/src/types/invitation-types.ts:51](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/invitation-types.ts#L51) *** ### role?[​](#role "Direct link to role?") > `optional` **role**: [`OrgMemberRole`](https://docs.gravityrail.com/sdk/type-aliases/OrgMemberRole.md) Defined in: [packages/sdk/src/types/invitation-types.ts:52](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/invitation-types.ts#L52) --- # Interface: CreateOrganizationRequest Defined in: [packages/sdk/src/types/account-types.ts:273](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L273) ## Properties[​](#properties "Direct link to Properties") ### contactEmail?[​](#contactemail "Direct link to contactEmail?") > `optional` **contactEmail**: `string` Defined in: [packages/sdk/src/types/account-types.ts:277](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L277) *** ### contactPhone?[​](#contactphone "Direct link to contactPhone?") > `optional` **contactPhone**: `string` Defined in: [packages/sdk/src/types/account-types.ts:278](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L278) *** ### logo?[​](#logo "Direct link to logo?") > `optional` **logo**: `string` Defined in: [packages/sdk/src/types/account-types.ts:279](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L279) *** ### logoMimeType?[​](#logomimetype "Direct link to logoMimeType?") > `optional` **logoMimeType**: `string` Defined in: [packages/sdk/src/types/account-types.ts:280](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L280) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/account-types.ts:274](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L274) *** ### primary?[​](#primary "Direct link to primary?") > `optional` **primary**: `boolean` Defined in: [packages/sdk/src/types/account-types.ts:276](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L276) *** ### slug?[​](#slug "Direct link to slug?") > `optional` **slug**: `string` Defined in: [packages/sdk/src/types/account-types.ts:275](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L275) --- # Interface: CreatePersonaRequest Defined in: [packages/sdk/src/types/qualification-types.ts:97](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/qualification-types.ts#L97) ## Properties[​](#properties "Direct link to Properties") ### age?[​](#age "Direct link to age?") > `optional` **age**: `number` Defined in: [packages/sdk/src/types/qualification-types.ts:100](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/qualification-types.ts#L100) *** ### dataRecords?[​](#datarecords "Direct link to dataRecords?") > `optional` **dataRecords**: `Record`<`string`, [`ScenarioDataRecord`](https://docs.gravityrail.com/sdk/interfaces/ScenarioDataRecord.md)> Defined in: [packages/sdk/src/types/qualification-types.ts:105](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/qualification-types.ts#L105) *** ### description?[​](#description "Direct link to description?") > `optional` **description**: `string` Defined in: [packages/sdk/src/types/qualification-types.ts:99](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/qualification-types.ts#L99) *** ### hasEmail?[​](#hasemail "Direct link to hasEmail?") > `optional` **hasEmail**: `boolean` Defined in: [packages/sdk/src/types/qualification-types.ts:102](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/qualification-types.ts#L102) *** ### hasPhone?[​](#hasphone "Direct link to hasPhone?") > `optional` **hasPhone**: `boolean` Defined in: [packages/sdk/src/types/qualification-types.ts:101](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/qualification-types.ts#L101) *** ### identity?[​](#identity "Direct link to identity?") > `optional` **identity**: `string` Defined in: [packages/sdk/src/types/qualification-types.ts:104](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/qualification-types.ts#L104) *** ### memberRoleUuid?[​](#memberroleuuid "Direct link to memberRoleUuid?") > `optional` **memberRoleUuid**: `string` | `null` Defined in: [packages/sdk/src/types/qualification-types.ts:103](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/qualification-types.ts#L103) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/qualification-types.ts:98](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/qualification-types.ts#L98) --- # Interface: CreatePhoneVoiceOutboundChatInput Defined in: [packages/sdk/src/types/chat-types.ts:121](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L121) Input for creating a workflow assignment chat that places an outbound PSTN call. ## Properties[​](#properties "Direct link to Properties") ### chatType?[​](#chattype "Direct link to chatType?") > `optional` **chatType**: `string` Defined in: [packages/sdk/src/types/chat-types.ts:127](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L127) Defaults to `assignment`. *** ### memberId[​](#memberid "Direct link to memberId") > **memberId**: `number` Defined in: [packages/sdk/src/types/chat-types.ts:122](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L122) *** ### phoneNumberId[​](#phonenumberid "Direct link to phoneNumberId") > **phoneNumberId**: `number` Defined in: [packages/sdk/src/types/chat-types.ts:124](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L124) *** ### title?[​](#title "Direct link to title?") > `optional` **title**: `string` Defined in: [packages/sdk/src/types/chat-types.ts:125](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L125) *** ### workflowId[​](#workflowid "Direct link to workflowId") > **workflowId**: `number` Defined in: [packages/sdk/src/types/chat-types.ts:123](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L123) --- # Interface: CreateProductRequest Defined in: [packages/sdk/src/types/billing-types.ts:373](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L373) ## Properties[​](#properties "Direct link to Properties") ### aiMultiplier?[​](#aimultiplier "Direct link to aiMultiplier?") > `optional` **aiMultiplier**: `number` | `null` Defined in: [packages/sdk/src/types/billing-types.ts:403](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L403) *** ### audience?[​](#audience "Direct link to audience?") > `optional` **audience**: `string` | `null` Defined in: [packages/sdk/src/types/billing-types.ts:380](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L380) *** ### color?[​](#color "Direct link to color?") > `optional` **color**: `string` | `null` Defined in: [packages/sdk/src/types/billing-types.ts:384](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L384) *** ### concierge?[​](#concierge "Direct link to concierge?") > `optional` **concierge**: `boolean` Defined in: [packages/sdk/src/types/billing-types.ts:393](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L393) *** ### creditInclusion?[​](#creditinclusion "Direct link to creditInclusion?") > `optional` **creditInclusion**: `number` | `null` Defined in: [packages/sdk/src/types/billing-types.ts:402](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L402) *** ### description[​](#description "Direct link to description") > **description**: `string` Defined in: [packages/sdk/src/types/billing-types.ts:379](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L379) *** ### icon?[​](#icon "Direct link to icon?") > `optional` **icon**: `string` | `null` Defined in: [packages/sdk/src/types/billing-types.ts:383](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L383) *** ### isFeatured?[​](#isfeatured "Direct link to isFeatured?") > `optional` **isFeatured**: `boolean` Defined in: [packages/sdk/src/types/billing-types.ts:391](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L391) *** ### isPopular?[​](#ispopular "Direct link to isPopular?") > `optional` **isPopular**: `boolean` Defined in: [packages/sdk/src/types/billing-types.ts:389](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L389) *** ### isPublic?[​](#ispublic "Direct link to isPublic?") > `optional` **isPublic**: `boolean` Defined in: [packages/sdk/src/types/billing-types.ts:392](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L392) *** ### isRecommended?[​](#isrecommended "Direct link to isRecommended?") > `optional` **isRecommended**: `boolean` Defined in: [packages/sdk/src/types/billing-types.ts:390](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L390) *** ### limits?[​](#limits "Direct link to limits?") > `optional` **limits**: [`ProductLimits`](https://docs.gravityrail.com/sdk/type-aliases/ProductLimits.md) | `null` Defined in: [packages/sdk/src/types/billing-types.ts:406](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L406) *** ### metadata?[​](#metadata "Direct link to metadata?") > `optional` **metadata**: [`ProductMetadata`](https://docs.gravityrail.com/sdk/interfaces/ProductMetadata.md) Defined in: [packages/sdk/src/types/billing-types.ts:395](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L395) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/billing-types.ts:377](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L377) *** ### plans?[​](#plans "Direct link to plans?") > `optional` **plans**: `Partial`<`Record`<`"month"` | `"year"` | `"quarter"`, [`PlanConfiguration`](https://docs.gravityrail.com/sdk/interfaces/PlanConfiguration.md)>> | `null` Defined in: [packages/sdk/src/types/billing-types.ts:409](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L409) *** ### productType?[​](#producttype "Direct link to productType?") > `optional` **productType**: `string` Defined in: [packages/sdk/src/types/billing-types.ts:381](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L381) *** ### providesFeatures?[​](#providesfeatures "Direct link to providesFeatures?") > `optional` **providesFeatures**: `string`\[] Defined in: [packages/sdk/src/types/billing-types.ts:399](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L399) *** ### publicUrl?[​](#publicurl "Direct link to publicUrl?") > `optional` **publicUrl**: `string` | `null` Defined in: [packages/sdk/src/types/billing-types.ts:385](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L385) *** ### requiresFeatures?[​](#requiresfeatures "Direct link to requiresFeatures?") > `optional` **requiresFeatures**: `string`\[] Defined in: [packages/sdk/src/types/billing-types.ts:398](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L398) *** ### selfService?[​](#selfservice "Direct link to selfService?") > `optional` **selfService**: `boolean` Defined in: [packages/sdk/src/types/billing-types.ts:388](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L388) *** ### serviceRates?[​](#servicerates "Direct link to serviceRates?") > `optional` **serviceRates**: `Record`<`string`, `number`> | `null` Defined in: [packages/sdk/src/types/billing-types.ts:404](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L404) *** ### stripeProductId?[​](#stripeproductid "Direct link to stripeProductId?") > `optional` **stripeProductId**: `string` | `null` Defined in: [packages/sdk/src/types/billing-types.ts:376](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L376) *** ### subscriberUrl?[​](#subscriberurl "Direct link to subscriberUrl?") > `optional` **subscriberUrl**: `string` | `null` Defined in: [packages/sdk/src/types/billing-types.ts:386](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L386) *** ### supportLevels?[​](#supportlevels "Direct link to supportLevels?") > `optional` **supportLevels**: `string`\[] Defined in: [packages/sdk/src/types/billing-types.ts:387](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L387) *** ### tagline?[​](#tagline "Direct link to tagline?") > `optional` **tagline**: `string` | `null` Defined in: [packages/sdk/src/types/billing-types.ts:378](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L378) *** ### templateWorkspaceUuid?[​](#templateworkspaceuuid "Direct link to templateWorkspaceUuid?") > `optional` **templateWorkspaceUuid**: `string` Defined in: [packages/sdk/src/types/billing-types.ts:394](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L394) *** ### trialPeriodDays?[​](#trialperioddays "Direct link to trialPeriodDays?") > `optional` **trialPeriodDays**: `number` Defined in: [packages/sdk/src/types/billing-types.ts:382](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L382) *** ### workspaceId?[​](#workspaceid "Direct link to workspaceId?") > `optional` **workspaceId**: `number` | `null` Defined in: [packages/sdk/src/types/billing-types.ts:374](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L374) *** ### workspaceUuid[​](#workspaceuuid "Direct link to workspaceUuid") > **workspaceUuid**: `string` Defined in: [packages/sdk/src/types/billing-types.ts:375](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L375) --- # Interface: CreatePronunciationEntryFormData Defined in: [packages/sdk/src/types/pronunciation-types.ts:16](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/pronunciation-types.ts#L16) ## Properties[​](#properties "Direct link to Properties") ### accountId?[​](#accountid "Direct link to accountId?") > `optional` **accountId**: `number` | `null` Defined in: [packages/sdk/src/types/pronunciation-types.ts:19](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/pronunciation-types.ts#L19) *** ### respelling[​](#respelling "Direct link to respelling") > **respelling**: `string` Defined in: [packages/sdk/src/types/pronunciation-types.ts:18](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/pronunciation-types.ts#L18) *** ### term[​](#term "Direct link to term") > **term**: `string` Defined in: [packages/sdk/src/types/pronunciation-types.ts:17](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/pronunciation-types.ts#L17) --- # Interface: CreateRoutineRequest Defined in: [packages/sdk/src/types/event-types.ts:562](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L562) ## Properties[​](#properties "Direct link to Properties") ### cronString?[​](#cronstring "Direct link to cronString?") > `optional` **cronString**: `string` Defined in: [packages/sdk/src/types/event-types.ts:570](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L570) *** ### description?[​](#description "Direct link to description?") > `optional` **description**: `string` Defined in: [packages/sdk/src/types/event-types.ts:564](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L564) *** ### eventRules?[​](#eventrules "Direct link to eventRules?") > `optional` **eventRules**: [`EventRuleInput`](https://docs.gravityrail.com/sdk/interfaces/EventRuleInput.md)\[] Defined in: [packages/sdk/src/types/event-types.ts:586](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L586) Ordered event rules to attach in the same request. Server syncs by UUID: same-UUID updates, new UUID creates, omitted UUIDs are deleted. *** ### intervalSeconds?[​](#intervalseconds "Direct link to intervalSeconds?") > `optional` **intervalSeconds**: `number` Defined in: [packages/sdk/src/types/event-types.ts:568](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L568) *** ### limit?[​](#limit "Direct link to limit?") > `optional` **limit**: `number` Defined in: [packages/sdk/src/types/event-types.ts:579](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L579) *** ### memberFilterId?[​](#memberfilterid "Direct link to memberFilterId?") > `optional` **memberFilterId**: `number` | `null` Defined in: [packages/sdk/src/types/event-types.ts:576](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L576) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/event-types.ts:563](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L563) *** ### repeatCount?[​](#repeatcount "Direct link to repeatCount?") > `optional` **repeatCount**: `number` Defined in: [packages/sdk/src/types/event-types.ts:569](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L569) *** ### scheduledTime?[​](#scheduledtime "Direct link to scheduledTime?") > `optional` **scheduledTime**: `string` Defined in: [packages/sdk/src/types/event-types.ts:567](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L567) *** ### scheduleEnabled?[​](#scheduleenabled "Direct link to scheduleEnabled?") > `optional` **scheduleEnabled**: `boolean` Defined in: [packages/sdk/src/types/event-types.ts:565](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L565) *** ### scheduleMode?[​](#schedulemode "Direct link to scheduleMode?") > `optional` **scheduleMode**: `"ONCE"` | `"CRON"` | `"INTERVAL"` Defined in: [packages/sdk/src/types/event-types.ts:566](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L566) *** ### startDate?[​](#startdate "Direct link to startDate?") > `optional` **startDate**: `string` Defined in: [packages/sdk/src/types/event-types.ts:575](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L575) *** ### targetMemberId?[​](#targetmemberid "Direct link to targetMemberId?") > `optional` **targetMemberId**: `number` | `null` Defined in: [packages/sdk/src/types/event-types.ts:577](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L577) *** ### timezone?[​](#timezone "Direct link to timezone?") > `optional` **timezone**: `string` Defined in: [packages/sdk/src/types/event-types.ts:574](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L574) IANA timezone the cronString is interpreted in (e.g. "America/Los\_Angeles"). Omit to default to the workspace timezone, else UTC. Only meaningful for CRON mode. *** ### visibility?[​](#visibility "Direct link to visibility?") > `optional` **visibility**: `"private"` | `"workspace"` Defined in: [packages/sdk/src/types/event-types.ts:580](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L580) *** ### webhookEnabled?[​](#webhookenabled "Direct link to webhookEnabled?") > `optional` **webhookEnabled**: `boolean` Defined in: [packages/sdk/src/types/event-types.ts:583](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L583) When true, the server generates a webhook secret and returns its plaintext exactly once in the create response. *** ### workflowId?[​](#workflowid "Direct link to workflowId?") > `optional` **workflowId**: `number` | `null` Defined in: [packages/sdk/src/types/event-types.ts:578](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L578) --- # Interface: CreateScenarioRequest Defined in: [packages/sdk/src/types/qualification-types.ts:70](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/qualification-types.ts#L70) ## Properties[​](#properties "Direct link to Properties") ### channel?[​](#channel "Direct link to channel?") > `optional` **channel**: `string` Defined in: [packages/sdk/src/types/qualification-types.ts:76](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/qualification-types.ts#L76) *** ### criteria?[​](#criteria "Direct link to criteria?") > `optional` **criteria**: [`CriterionInput`](https://docs.gravityrail.com/sdk/interfaces/CriterionInput.md)\[] Defined in: [packages/sdk/src/types/qualification-types.ts:79](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/qualification-types.ts#L79) *** ### dataRecords?[​](#datarecords "Direct link to dataRecords?") > `optional` **dataRecords**: `Record`<`string`, [`ScenarioDataRecord`](https://docs.gravityrail.com/sdk/interfaces/ScenarioDataRecord.md)> Defined in: [packages/sdk/src/types/qualification-types.ts:77](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/qualification-types.ts#L77) *** ### description?[​](#description "Direct link to description?") > `optional` **description**: `string` Defined in: [packages/sdk/src/types/qualification-types.ts:73](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/qualification-types.ts#L73) *** ### goal?[​](#goal "Direct link to goal?") > `optional` **goal**: `string` Defined in: [packages/sdk/src/types/qualification-types.ts:75](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/qualification-types.ts#L75) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/qualification-types.ts:72](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/qualification-types.ts#L72) *** ### order?[​](#order "Direct link to order?") > `optional` **order**: `number` Defined in: [packages/sdk/src/types/qualification-types.ts:78](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/qualification-types.ts#L78) *** ### personaId?[​](#personaid "Direct link to personaId?") > `optional` **personaId**: `number` Defined in: [packages/sdk/src/types/qualification-types.ts:74](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/qualification-types.ts#L74) *** ### simulatedDatetime?[​](#simulateddatetime "Direct link to simulatedDatetime?") > `optional` **simulatedDatetime**: `string` | `null` Defined in: [packages/sdk/src/types/qualification-types.ts:80](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/qualification-types.ts#L80) *** ### slug[​](#slug "Direct link to slug") > **slug**: `string` Defined in: [packages/sdk/src/types/qualification-types.ts:71](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/qualification-types.ts#L71) --- # Interface: CreateSignupResponse Defined in: [packages/sdk/src/types/generated/member.ts:193](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L193) Response model for the create-signup endpoint. ## Properties[​](#properties "Direct link to Properties") ### account[​](#account "Direct link to account") > **account**: [`SignupAccountResponse`](https://docs.gravityrail.com/sdk/interfaces/SignupAccountResponse.md) Defined in: [packages/sdk/src/types/generated/member.ts:195](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L195) *** ### member[​](#member "Direct link to member") > **member**: [`SignupMemberResponse`](https://docs.gravityrail.com/sdk/interfaces/SignupMemberResponse.md) Defined in: [packages/sdk/src/types/generated/member.ts:196](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L196) *** ### token[​](#token "Direct link to token") > **token**: `string` Defined in: [packages/sdk/src/types/generated/member.ts:194](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L194) *** ### warnings?[​](#warnings "Direct link to warnings?") > `optional` **warnings**: [`DataRecordFieldWarning`](https://docs.gravityrail.com/sdk/interfaces/DataRecordFieldWarning.md)\[] Defined in: [packages/sdk/src/types/generated/member.ts:198](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L198) *** ### wasCreated[​](#wascreated "Direct link to wasCreated") > **wasCreated**: `boolean` Defined in: [packages/sdk/src/types/generated/member.ts:197](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L197) --- # Interface: CreateSlackAppRequest Defined in: [packages/sdk/src/types/slack-app-types.ts:76](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/slack-app-types.ts#L76) Form data for creating a Slack app. ## Properties[​](#properties "Direct link to Properties") ### allowDm?[​](#allowdm "Direct link to allowDm?") > `optional` **allowDm**: `boolean` Defined in: [packages/sdk/src/types/slack-app-types.ts:103](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/slack-app-types.ts#L103) *** ### allowedChannelIds?[​](#allowedchannelids "Direct link to allowedChannelIds?") > `optional` **allowedChannelIds**: `string`\[] Defined in: [packages/sdk/src/types/slack-app-types.ts:105](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/slack-app-types.ts#L105) *** ### appLevelToken?[​](#appleveltoken "Direct link to appLevelToken?") > `optional` **appLevelToken**: `string` Defined in: [packages/sdk/src/types/slack-app-types.ts:89](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/slack-app-types.ts#L89) App-level token (xapp-...) - only required if socketModeEnabled is true *** ### clientId?[​](#clientid "Direct link to clientId?") > `optional` **clientId**: `string` Defined in: [packages/sdk/src/types/slack-app-types.ts:80](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/slack-app-types.ts#L80) *** ### clientSecret?[​](#clientsecret "Direct link to clientSecret?") > `optional` **clientSecret**: `string` Defined in: [packages/sdk/src/types/slack-app-types.ts:81](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/slack-app-types.ts#L81) *** ### defaultWorkflowId[​](#defaultworkflowid "Direct link to defaultWorkflowId") > **defaultWorkflowId**: `number` Defined in: [packages/sdk/src/types/slack-app-types.ts:79](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/slack-app-types.ts#L79) Default workflow for inbound Slack messages (required) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/slack-app-types.ts:77](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/slack-app-types.ts#L77) *** ### replyInThread?[​](#replyinthread "Direct link to replyInThread?") > `optional` **replyInThread**: `boolean` Defined in: [packages/sdk/src/types/slack-app-types.ts:104](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/slack-app-types.ts#L104) *** ### respondMode?[​](#respondmode "Direct link to respondMode?") > `optional` **respondMode**: [`SlackRespondMode`](https://docs.gravityrail.com/sdk/type-aliases/SlackRespondMode.md) Defined in: [packages/sdk/src/types/slack-app-types.ts:97](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/slack-app-types.ts#L97) How the bot responds to messages: * 'mentions': Only respond when explicitly #### Mentioned[​](#mentioned "Direct link to Mentioned") (default) * 'auto': Use AI to decide whether to respond * 'off': Don't auto-respond (only slash commands work) *** ### respondWhen?[​](#respondwhen "Direct link to respondWhen?") > `optional` **respondWhen**: `string` Defined in: [packages/sdk/src/types/slack-app-types.ts:102](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/slack-app-types.ts#L102) Custom prompt for AI to decide when to respond. Only used when respondMode is 'auto'. *** ### signingSecret?[​](#signingsecret "Direct link to signingSecret?") > `optional` **signingSecret**: `string` Defined in: [packages/sdk/src/types/slack-app-types.ts:82](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/slack-app-types.ts#L82) *** ### slashCommands?[​](#slashcommands "Direct link to slashCommands?") > `optional` **slashCommands**: [`SlackSlashCommandConfigResponse`](https://docs.gravityrail.com/sdk/interfaces/SlackSlashCommandConfigResponse.md)\[] Defined in: [packages/sdk/src/types/slack-app-types.ts:90](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/slack-app-types.ts#L90) *** ### socketModeEnabled?[​](#socketmodeenabled "Direct link to socketModeEnabled?") > `optional` **socketModeEnabled**: `boolean` Defined in: [packages/sdk/src/types/slack-app-types.ts:87](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/slack-app-types.ts#L87) Enable Socket Mode (optional, defaults to false). Only needed for firewalls or local dev. Events API is recommended for production. --- # Interface: CreateTeamsAppRequest Defined in: [packages/sdk/src/types/teams-app-types.ts:61](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/teams-app-types.ts#L61) Form data for creating a Teams app. ## Properties[​](#properties "Direct link to Properties") ### allowDm?[​](#allowdm "Direct link to allowDm?") > `optional` **allowDm**: `boolean` Defined in: [packages/sdk/src/types/teams-app-types.ts:78](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/teams-app-types.ts#L78) *** ### allowedChannelIds?[​](#allowedchannelids "Direct link to allowedChannelIds?") > `optional` **allowedChannelIds**: `string`\[] Defined in: [packages/sdk/src/types/teams-app-types.ts:80](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/teams-app-types.ts#L80) *** ### commands?[​](#commands "Direct link to commands?") > `optional` **commands**: [`TeamsCommandConfigResponse`](https://docs.gravityrail.com/sdk/interfaces/TeamsCommandConfigResponse.md)\[] Defined in: [packages/sdk/src/types/teams-app-types.ts:75](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/teams-app-types.ts#L75) *** ### defaultWorkflowId[​](#defaultworkflowid "Direct link to defaultWorkflowId") > **defaultWorkflowId**: `number` Defined in: [packages/sdk/src/types/teams-app-types.ts:64](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/teams-app-types.ts#L64) Default workflow for inbound Teams messages (required) *** ### microsoftAppId?[​](#microsoftappid "Direct link to microsoftAppId?") > `optional` **microsoftAppId**: `string` Defined in: [packages/sdk/src/types/teams-app-types.ts:66](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/teams-app-types.ts#L66) Bot Framework MicrosoftAppId (Entra app GUID) *** ### microsoftAppPassword?[​](#microsoftapppassword "Direct link to microsoftAppPassword?") > `optional` **microsoftAppPassword**: `string` Defined in: [packages/sdk/src/types/teams-app-types.ts:68](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/teams-app-types.ts#L68) Bot Framework MicrosoftAppPassword / client secret *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/teams-app-types.ts:62](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/teams-app-types.ts#L62) *** ### replyInThread?[​](#replyinthread "Direct link to replyInThread?") > `optional` **replyInThread**: `boolean` Defined in: [packages/sdk/src/types/teams-app-types.ts:79](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/teams-app-types.ts#L79) *** ### respondMode?[​](#respondmode "Direct link to respondMode?") > `optional` **respondMode**: [`TeamsRespondMode`](https://docs.gravityrail.com/sdk/type-aliases/TeamsRespondMode.md) Defined in: [packages/sdk/src/types/teams-app-types.ts:76](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/teams-app-types.ts#L76) *** ### respondWhen?[​](#respondwhen "Direct link to respondWhen?") > `optional` **respondWhen**: `string` Defined in: [packages/sdk/src/types/teams-app-types.ts:77](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/teams-app-types.ts#L77) *** ### ssoClientId?[​](#ssoclientid "Direct link to ssoClientId?") > `optional` **ssoClientId**: `string` Defined in: [packages/sdk/src/types/teams-app-types.ts:70](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/teams-app-types.ts#L70) Multi-tenant Entra app id used for user SSO + Graph /me *** ### ssoClientSecret?[​](#ssoclientsecret "Direct link to ssoClientSecret?") > `optional` **ssoClientSecret**: `string` Defined in: [packages/sdk/src/types/teams-app-types.ts:72](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/teams-app-types.ts#L72) SSO Entra app client secret *** ### teamsManifestAppId?[​](#teamsmanifestappid "Direct link to teamsManifestAppId?") > `optional` **teamsManifestAppId**: `string` Defined in: [packages/sdk/src/types/teams-app-types.ts:74](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/teams-app-types.ts#L74) Teams app manifest id (GUID), distinct from MicrosoftAppId --- # Interface: CreateWorkflowContributorRequest Defined in: [packages/sdk/src/types/task-types.ts:157](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/task-types.ts#L157) ## Properties[​](#properties "Direct link to Properties") ### channels[​](#channels "Direct link to channels") > **channels**: `string`\[] Defined in: [packages/sdk/src/types/task-types.ts:160](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/task-types.ts#L160) *** ### hint?[​](#hint "Direct link to hint?") > `optional` **hint**: `string` Defined in: [packages/sdk/src/types/task-types.ts:161](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/task-types.ts#L161) *** ### memberId[​](#memberid "Direct link to memberId") > **memberId**: `number` Defined in: [packages/sdk/src/types/task-types.ts:158](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/task-types.ts#L158) *** ### title[​](#title "Direct link to title") > **title**: `string` Defined in: [packages/sdk/src/types/task-types.ts:159](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/task-types.ts#L159) --- # Interface: CreateWorkflowFromTemplateFormData Defined in: [packages/sdk/src/types/task-types.ts:212](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/task-types.ts#L212) ## Properties[​](#properties "Direct link to Properties") ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/task-types.ts:213](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/task-types.ts#L213) --- # Interface: CreateWorkspaceInvitationFormData Defined in: [packages/sdk/src/types/invitation-types.ts:43](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/invitation-types.ts#L43) ## Properties[​](#properties "Direct link to Properties") ### message?[​](#message "Direct link to message?") > `optional` **message**: `string` Defined in: [packages/sdk/src/types/invitation-types.ts:44](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/invitation-types.ts#L44) *** ### siteUuid?[​](#siteuuid "Direct link to siteUuid?") > `optional` **siteUuid**: `string` Defined in: [packages/sdk/src/types/invitation-types.ts:45](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/invitation-types.ts#L45) --- # Interface: CreateWorkspaceMemberRequest Defined in: [packages/sdk/src/types/member-types.ts:343](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L343) ## Properties[​](#properties "Direct link to Properties") ### accountEnabled?[​](#accountenabled "Direct link to accountEnabled?") > `optional` **accountEnabled**: `boolean` Defined in: [packages/sdk/src/types/member-types.ts:362](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L362) *** ### accountTosAccepted?[​](#accounttosaccepted "Direct link to accountTosAccepted?") > `optional` **accountTosAccepted**: `boolean` Defined in: [packages/sdk/src/types/member-types.ts:364](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L364) *** ### accountUuid?[​](#accountuuid "Direct link to accountUuid?") > `optional` **accountUuid**: `string` Defined in: [packages/sdk/src/types/member-types.ts:346](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L346) *** ### dateOfBirth?[​](#dateofbirth "Direct link to dateOfBirth?") > `optional` **dateOfBirth**: `string` Defined in: [packages/sdk/src/types/member-types.ts:350](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L350) *** ### description?[​](#description "Direct link to description?") > `optional` **description**: `string` Defined in: [packages/sdk/src/types/member-types.ts:348](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L348) *** ### email?[​](#email "Direct link to email?") > `optional` **email**: `string` Defined in: [packages/sdk/src/types/member-types.ts:344](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L344) *** ### emailTrusted?[​](#emailtrusted "Direct link to emailTrusted?") > `optional` **emailTrusted**: `boolean` Defined in: [packages/sdk/src/types/member-types.ts:351](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L351) *** ### externalId?[​](#externalid "Direct link to externalId?") > `optional` **externalId**: `string` Defined in: [packages/sdk/src/types/member-types.ts:349](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L349) *** ### isOrgOwner?[​](#isorgowner "Direct link to isOrgOwner?") > `optional` **isOrgOwner**: `boolean` Defined in: [packages/sdk/src/types/member-types.ts:363](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L363) *** ### labelIds?[​](#labelids "Direct link to labelIds?") > `optional` **labelIds**: `number`\[] Defined in: [packages/sdk/src/types/member-types.ts:360](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L360) *** ### locale?[​](#locale "Direct link to locale?") > `optional` **locale**: `string` Defined in: [packages/sdk/src/types/member-types.ts:358](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L358) *** ### memberRoleId[​](#memberroleid "Direct link to memberRoleId") > **memberRoleId**: `number` Defined in: [packages/sdk/src/types/member-types.ts:353](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L353) *** ### memberType?[​](#membertype "Direct link to memberType?") > `optional` **memberType**: [`MemberType`](https://docs.gravityrail.com/sdk/enumerations/MemberType.md) Defined in: [packages/sdk/src/types/member-types.ts:365](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L365) *** ### name?[​](#name "Direct link to name?") > `optional` **name**: `string` Defined in: [packages/sdk/src/types/member-types.ts:347](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L347) *** ### notifyEmail?[​](#notifyemail "Direct link to notifyEmail?") > `optional` **notifyEmail**: `boolean` Defined in: [packages/sdk/src/types/member-types.ts:355](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L355) *** ### notifySms?[​](#notifysms "Direct link to notifySms?") > `optional` **notifySms**: `boolean` Defined in: [packages/sdk/src/types/member-types.ts:354](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L354) *** ### notifyVoice?[​](#notifyvoice "Direct link to notifyVoice?") > `optional` **notifyVoice**: `boolean` Defined in: [packages/sdk/src/types/member-types.ts:356](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L356) *** ### notifyWhatsapp?[​](#notifywhatsapp "Direct link to notifyWhatsapp?") > `optional` **notifyWhatsapp**: `boolean` Defined in: [packages/sdk/src/types/member-types.ts:357](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L357) *** ### ownerId?[​](#ownerid "Direct link to ownerId?") > `optional` **ownerId**: `number` Defined in: [packages/sdk/src/types/member-types.ts:366](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L366) *** ### phone?[​](#phone "Direct link to phone?") > `optional` **phone**: `string` Defined in: [packages/sdk/src/types/member-types.ts:345](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L345) *** ### phoneTrusted?[​](#phonetrusted "Direct link to phoneTrusted?") > `optional` **phoneTrusted**: `boolean` Defined in: [packages/sdk/src/types/member-types.ts:352](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L352) *** ### timezone?[​](#timezone "Direct link to timezone?") > `optional` **timezone**: `string` Defined in: [packages/sdk/src/types/member-types.ts:359](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L359) *** ### tosAccepted?[​](#tosaccepted "Direct link to tosAccepted?") > `optional` **tosAccepted**: `boolean` Defined in: [packages/sdk/src/types/member-types.ts:361](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L361) --- # Interface: CredentialChangeInviteConfirmResponse Defined in: [packages/sdk/src/types/generated/account.ts:180](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L180) Response after confirming a credential change invitation. ## Properties[​](#properties "Direct link to Properties") ### credentialType?[​](#credentialtype "Direct link to credentialType?") > `optional` **credentialType**: `CredentialChangeInviteConfirmResponseCredentialType` Defined in: [packages/sdk/src/types/generated/account.ts:183](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L183) *** ### message[​](#message "Direct link to message") > **message**: `string` Defined in: [packages/sdk/src/types/generated/account.ts:182](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L182) *** ### success[​](#success "Direct link to success") > **success**: `boolean` Defined in: [packages/sdk/src/types/generated/account.ts:181](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L181) --- # Interface: CredentialChangeInviteDetails Defined in: [packages/sdk/src/types/generated/account.ts:199](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L199) Response with details of a credential change invitation. Used for the confirmation page to show what change is being proposed. ## Properties[​](#properties "Direct link to Properties") ### createdAt[​](#createdat "Direct link to createdAt") > **createdAt**: `string` Defined in: [packages/sdk/src/types/generated/account.ts:206](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L206) *** ### credentialType[​](#credentialtype "Direct link to credentialType") > **credentialType**: `CredentialChangeInviteDetailsResponseCredentialType` Defined in: [packages/sdk/src/types/generated/account.ts:201](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L201) *** ### expiresAt[​](#expiresat "Direct link to expiresAt") > **expiresAt**: `string` Defined in: [packages/sdk/src/types/generated/account.ts:207](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L207) *** ### id[​](#id "Direct link to id") > **id**: `number` Defined in: [packages/sdk/src/types/generated/account.ts:200](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L200) *** ### initiatedByName[​](#initiatedbyname "Direct link to initiatedByName") > **initiatedByName**: `string` | `null` Defined in: [packages/sdk/src/types/generated/account.ts:205](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L205) *** ### isExpired[​](#isexpired "Direct link to isExpired") > **isExpired**: `boolean` Defined in: [packages/sdk/src/types/generated/account.ts:208](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L208) *** ### isValid[​](#isvalid "Direct link to isValid") > **isValid**: `boolean` Defined in: [packages/sdk/src/types/generated/account.ts:209](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L209) *** ### newValue[​](#newvalue "Direct link to newValue") > **newValue**: `string` Defined in: [packages/sdk/src/types/generated/account.ts:202](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L202) *** ### workspaceName[​](#workspacename "Direct link to workspaceName") > **workspaceName**: `string` Defined in: [packages/sdk/src/types/generated/account.ts:203](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L203) *** ### workspaceUuid[​](#workspaceuuid "Direct link to workspaceUuid") > **workspaceUuid**: `string` Defined in: [packages/sdk/src/types/generated/account.ts:204](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L204) --- # Interface: CredentialChangeInviteResponse Defined in: [packages/sdk/src/types/generated/account.ts:223](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L223) Response after creating a credential change invitation. ## Properties[​](#properties "Direct link to Properties") ### credentialType[​](#credentialtype "Direct link to credentialType") > **credentialType**: `CredentialChangeInviteResponseCredentialType` Defined in: [packages/sdk/src/types/generated/account.ts:225](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L225) *** ### expiresAt[​](#expiresat "Direct link to expiresAt") > **expiresAt**: `string` Defined in: [packages/sdk/src/types/generated/account.ts:227](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L227) *** ### id[​](#id "Direct link to id") > **id**: `number` Defined in: [packages/sdk/src/types/generated/account.ts:224](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L224) *** ### maskedNewValue[​](#maskednewvalue "Direct link to maskedNewValue") > **maskedNewValue**: `string` Defined in: [packages/sdk/src/types/generated/account.ts:226](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L226) *** ### message[​](#message "Direct link to message") > **message**: `string` Defined in: [packages/sdk/src/types/generated/account.ts:228](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L228) --- # Interface: CredentialChangeRequestResponse Defined in: [packages/sdk/src/types/generated/account.ts:242](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L242) Response after requesting a credential change. ## Properties[​](#properties "Direct link to Properties") ### credentialType[​](#credentialtype "Direct link to credentialType") > **credentialType**: `CredentialChangeRequestResponseCredentialType` Defined in: [packages/sdk/src/types/generated/account.ts:244](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L244) *** ### expiresAt[​](#expiresat "Direct link to expiresAt") > **expiresAt**: `string` Defined in: [packages/sdk/src/types/generated/account.ts:245](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L245) *** ### id[​](#id "Direct link to id") > **id**: `number` Defined in: [packages/sdk/src/types/generated/account.ts:243](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L243) *** ### message[​](#message "Direct link to message") > **message**: `string` Defined in: [packages/sdk/src/types/generated/account.ts:246](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L246) --- # Interface: CredentialChangeVerifyResponse Defined in: [packages/sdk/src/types/generated/account.ts:260](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L260) Response after verifying a credential change. ## Properties[​](#properties "Direct link to Properties") ### credentialType?[​](#credentialtype "Direct link to credentialType?") > `optional` **credentialType**: `CredentialChangeVerifyResponseCredentialType` Defined in: [packages/sdk/src/types/generated/account.ts:263](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L263) *** ### message[​](#message "Direct link to message") > **message**: `string` Defined in: [packages/sdk/src/types/generated/account.ts:262](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L262) *** ### success[​](#success "Direct link to success") > **success**: `boolean` Defined in: [packages/sdk/src/types/generated/account.ts:261](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L261) --- # Interface: CriterionInput Defined in: [packages/sdk/src/types/qualification-types.ts:59](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/qualification-types.ts#L59) ## Properties[​](#properties "Direct link to Properties") ### celExpression?[​](#celexpression "Direct link to celExpression?") > `optional` **celExpression**: `string` Defined in: [packages/sdk/src/types/qualification-types.ts:65](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/qualification-types.ts#L65) *** ### criterionType[​](#criteriontype "Direct link to criterionType") > **criterionType**: [`CriterionType`](https://docs.gravityrail.com/sdk/enumerations/CriterionType.md) Defined in: [packages/sdk/src/types/qualification-types.ts:63](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/qualification-types.ts#L63) *** ### description?[​](#description "Direct link to description?") > `optional` **description**: `string` Defined in: [packages/sdk/src/types/qualification-types.ts:62](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/qualification-types.ts#L62) *** ### evaluationPrompt?[​](#evaluationprompt "Direct link to evaluationPrompt?") > `optional` **evaluationPrompt**: `string` Defined in: [packages/sdk/src/types/qualification-types.ts:66](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/qualification-types.ts#L66) *** ### id?[​](#id "Direct link to id?") > `optional` **id**: `number` Defined in: [packages/sdk/src/types/qualification-types.ts:60](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/qualification-types.ts#L60) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/qualification-types.ts:61](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/qualification-types.ts#L61) *** ### passingThreshold?[​](#passingthreshold "Direct link to passingThreshold?") > `optional` **passingThreshold**: `number` Defined in: [packages/sdk/src/types/qualification-types.ts:67](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/qualification-types.ts#L67) *** ### weight?[​](#weight "Direct link to weight?") > `optional` **weight**: `number` Defined in: [packages/sdk/src/types/qualification-types.ts:64](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/qualification-types.ts#L64) --- # Interface: CriterionResultResponse Defined in: [packages/sdk/src/types/generated/qualification.ts:65](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/qualification.ts#L65) Per-criterion evaluation result for one TestChatRun. The evaluator (CEL vs LLM) is implied by the parent criterion's `criterionType` — no separate `evaluatorType` field. ## Properties[​](#properties "Direct link to Properties") ### createdAt[​](#createdat "Direct link to createdAt") > **createdAt**: `string` Defined in: [packages/sdk/src/types/generated/qualification.ts:75](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/qualification.ts#L75) *** ### criterionId[​](#criterionid "Direct link to criterionId") > **criterionId**: `number` Defined in: [packages/sdk/src/types/generated/qualification.ts:68](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/qualification.ts#L68) *** ### criterionName?[​](#criterionname "Direct link to criterionName?") > `optional` **criterionName**: `string` | `null` Defined in: [packages/sdk/src/types/generated/qualification.ts:69](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/qualification.ts#L69) *** ### criterionType?[​](#criteriontype "Direct link to criterionType?") > `optional` **criterionType**: `string` | `null` Defined in: [packages/sdk/src/types/generated/qualification.ts:70](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/qualification.ts#L70) *** ### evaluationData[​](#evaluationdata "Direct link to evaluationData") > **evaluationData**: `CriterionResultResponseEvaluationData` Defined in: [packages/sdk/src/types/generated/qualification.ts:74](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/qualification.ts#L74) *** ### id[​](#id "Direct link to id") > **id**: `number` Defined in: [packages/sdk/src/types/generated/qualification.ts:66](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/qualification.ts#L66) *** ### passed[​](#passed "Direct link to passed") > **passed**: `boolean` | `null` Defined in: [packages/sdk/src/types/generated/qualification.ts:73](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/qualification.ts#L73) *** ### passingThreshold?[​](#passingthreshold "Direct link to passingThreshold?") > `optional` **passingThreshold**: `number` | `null` Defined in: [packages/sdk/src/types/generated/qualification.ts:71](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/qualification.ts#L71) *** ### score[​](#score "Direct link to score") > **score**: `number` | `null` Defined in: [packages/sdk/src/types/generated/qualification.ts:72](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/qualification.ts#L72) *** ### testChatRunId[​](#testchatrunid "Direct link to testChatRunId") > **testChatRunId**: `number` Defined in: [packages/sdk/src/types/generated/qualification.ts:67](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/qualification.ts#L67) --- # Interface: CurrentMemberResponse Defined in: [packages/sdk/src/types/generated/member.ts:236](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L236) Response for the current user's member profile. Extends WorkspaceMemberResponse with scopes and org role - the effective permissions that the API honors for this user in this workspace context. ## Properties[​](#properties "Direct link to Properties") ### accountEnabled?[​](#accountenabled "Direct link to accountEnabled?") > `optional` **accountEnabled**: `boolean` | `null` Defined in: [packages/sdk/src/types/generated/member.ts:263](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L263) *** ### accountTosAccepted[​](#accounttosaccepted "Direct link to accountTosAccepted") > **accountTosAccepted**: `boolean` | `null` Defined in: [packages/sdk/src/types/generated/member.ts:241](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L241) *** ### accountUuid[​](#accountuuid "Direct link to accountUuid") > **accountUuid**: `string` | `null` Defined in: [packages/sdk/src/types/generated/member.ts:242](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L242) *** ### canLogin?[​](#canlogin "Direct link to canLogin?") > `optional` **canLogin**: `boolean` Defined in: [packages/sdk/src/types/generated/member.ts:272](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L272) *** ### createdAt[​](#createdat "Direct link to createdAt") > **createdAt**: `string` Defined in: [packages/sdk/src/types/generated/member.ts:243](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L243) *** ### dateOfBirth?[​](#dateofbirth "Direct link to dateOfBirth?") > `optional` **dateOfBirth**: `string` | `null` Defined in: [packages/sdk/src/types/generated/member.ts:251](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L251) *** ### description[​](#description "Direct link to description") > **description**: `string` | `null` Defined in: [packages/sdk/src/types/generated/member.ts:246](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L246) *** ### email[​](#email "Direct link to email") > **email**: `string` | `null` Defined in: [packages/sdk/src/types/generated/member.ts:249](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L249) *** ### emailTrusted?[​](#emailtrusted "Direct link to emailTrusted?") > `optional` **emailTrusted**: `boolean` Defined in: [packages/sdk/src/types/generated/member.ts:252](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L252) *** ### experimentGroup?[​](#experimentgroup "Direct link to experimentGroup?") > `optional` **experimentGroup**: `MemberExperimentGroupSummary` | `null` Defined in: [packages/sdk/src/types/generated/member.ts:273](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L273) *** ### externalId[​](#externalid "Direct link to externalId") > **externalId**: `string` | `null` Defined in: [packages/sdk/src/types/generated/member.ts:250](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L250) *** ### homeFolderId?[​](#homefolderid "Direct link to homeFolderId?") > `optional` **homeFolderId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/member.ts:261](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L261) *** ### id[​](#id "Direct link to id") > **id**: `number` Defined in: [packages/sdk/src/types/generated/member.ts:237](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L237) *** ### isArchived?[​](#isarchived "Direct link to isArchived?") > `optional` **isArchived**: `boolean` Defined in: [packages/sdk/src/types/generated/member.ts:269](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L269) *** ### isOrgOwner?[​](#isorgowner "Direct link to isOrgOwner?") > `optional` **isOrgOwner**: `boolean` | `null` Defined in: [packages/sdk/src/types/generated/member.ts:264](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L264) *** ### isSuperuser?[​](#issuperuser "Direct link to isSuperuser?") > `optional` **isSuperuser**: `boolean` | `null` Defined in: [packages/sdk/src/types/generated/member.ts:265](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L265) *** ### labels?[​](#labels "Direct link to labels?") > `optional` **labels**: [`MemberLabelResponse`](https://docs.gravityrail.com/sdk/interfaces/MemberLabelResponse.md)\[] Defined in: [packages/sdk/src/types/generated/member.ts:262](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L262) *** ### locale[​](#locale "Direct link to locale") > **locale**: `string` | `null` Defined in: [packages/sdk/src/types/generated/member.ts:258](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L258) *** ### memberRoleId[​](#memberroleid "Direct link to memberRoleId") > **memberRoleId**: `number` Defined in: [packages/sdk/src/types/generated/member.ts:259](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L259) *** ### memberRoleName[​](#memberrolename "Direct link to memberRoleName") > **memberRoleName**: `string` Defined in: [packages/sdk/src/types/generated/member.ts:260](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L260) *** ### memberType?[​](#membertype "Direct link to memberType?") > `optional` **memberType**: `string` Defined in: [packages/sdk/src/types/generated/member.ts:268](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L268) *** ### name[​](#name "Direct link to name") > **name**: `string` | `null` Defined in: [packages/sdk/src/types/generated/member.ts:245](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L245) *** ### notifyEmail[​](#notifyemail "Direct link to notifyEmail") > **notifyEmail**: `boolean` Defined in: [packages/sdk/src/types/generated/member.ts:255](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L255) *** ### notifySms[​](#notifysms "Direct link to notifySms") > **notifySms**: `boolean` Defined in: [packages/sdk/src/types/generated/member.ts:254](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L254) *** ### notifyVoice[​](#notifyvoice "Direct link to notifyVoice") > **notifyVoice**: `boolean` Defined in: [packages/sdk/src/types/generated/member.ts:256](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L256) *** ### notifyWhatsapp?[​](#notifywhatsapp "Direct link to notifyWhatsapp?") > `optional` **notifyWhatsapp**: `boolean` Defined in: [packages/sdk/src/types/generated/member.ts:257](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L257) *** ### orgRole?[​](#orgrole "Direct link to orgRole?") > `optional` **orgRole**: `string` | `null` Defined in: [packages/sdk/src/types/generated/member.ts:266](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L266) *** ### ownerId?[​](#ownerid "Direct link to ownerId?") > `optional` **ownerId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/member.ts:270](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L270) *** ### ownerName?[​](#ownername "Direct link to ownerName?") > `optional` **ownerName**: `string` | `null` Defined in: [packages/sdk/src/types/generated/member.ts:271](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L271) *** ### phone[​](#phone "Direct link to phone") > **phone**: `string` | `null` Defined in: [packages/sdk/src/types/generated/member.ts:247](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L247) *** ### phoneTrusted?[​](#phonetrusted "Direct link to phoneTrusted?") > `optional` **phoneTrusted**: `boolean` Defined in: [packages/sdk/src/types/generated/member.ts:253](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L253) *** ### phoneType[​](#phonetype "Direct link to phoneType") > **phoneType**: `string` | `null` Defined in: [packages/sdk/src/types/generated/member.ts:248](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L248) *** ### role[​](#role "Direct link to role") > **role**: `string` Defined in: [packages/sdk/src/types/generated/member.ts:239](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L239) *** ### scopes?[​](#scopes "Direct link to scopes?") > `optional` **scopes**: `string`\[] Defined in: [packages/sdk/src/types/generated/member.ts:274](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L274) *** ### timezone?[​](#timezone "Direct link to timezone?") > `optional` **timezone**: `string` | `null` Defined in: [packages/sdk/src/types/generated/member.ts:267](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L267) *** ### tosAccepted[​](#tosaccepted "Direct link to tosAccepted") > **tosAccepted**: `boolean` Defined in: [packages/sdk/src/types/generated/member.ts:240](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L240) *** ### updatedAt[​](#updatedat "Direct link to updatedAt") > **updatedAt**: `string` Defined in: [packages/sdk/src/types/generated/member.ts:244](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L244) *** ### uuid[​](#uuid "Direct link to uuid") > **uuid**: `string` Defined in: [packages/sdk/src/types/generated/member.ts:238](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L238) --- # Interface: CurrentOrgMember Defined in: [packages/sdk/src/types/account-types.ts:426](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L426) Response for the current user's org membership (/me endpoint). Extends OrgMember with scopes - the effective permissions the API honors for this user in this organization context. ## Extends[​](#extends "Direct link to Extends") * [`OrgMember`](https://docs.gravityrail.com/sdk/interfaces/OrgMember.md) ## Properties[​](#properties "Direct link to Properties") ### accountEmail?[​](#accountemail "Direct link to accountEmail?") > `optional` **accountEmail**: `string` | `null` Defined in: [packages/sdk/src/types/account-types.ts:416](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L416) #### Inherited from[​](#inherited-from "Direct link to Inherited from") [`OrgMember`](https://docs.gravityrail.com/sdk/interfaces/OrgMember.md).[`accountEmail`](https://docs.gravityrail.com/sdk/interfaces/OrgMember.md#accountemail) *** ### accountId[​](#accountid "Direct link to accountId") > **accountId**: `number` | `null` Defined in: [packages/sdk/src/types/account-types.ts:407](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L407) #### Inherited from[​](#inherited-from-1 "Direct link to Inherited from") [`OrgMember`](https://docs.gravityrail.com/sdk/interfaces/OrgMember.md).[`accountId`](https://docs.gravityrail.com/sdk/interfaces/OrgMember.md#accountid) *** ### accountName?[​](#accountname "Direct link to accountName?") > `optional` **accountName**: `string` | `null` Defined in: [packages/sdk/src/types/account-types.ts:415](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L415) #### Inherited from[​](#inherited-from-2 "Direct link to Inherited from") [`OrgMember`](https://docs.gravityrail.com/sdk/interfaces/OrgMember.md).[`accountName`](https://docs.gravityrail.com/sdk/interfaces/OrgMember.md#accountname) *** ### accountPhone?[​](#accountphone "Direct link to accountPhone?") > `optional` **accountPhone**: `string` | `null` Defined in: [packages/sdk/src/types/account-types.ts:417](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L417) #### Inherited from[​](#inherited-from-3 "Direct link to Inherited from") [`OrgMember`](https://docs.gravityrail.com/sdk/interfaces/OrgMember.md).[`accountPhone`](https://docs.gravityrail.com/sdk/interfaces/OrgMember.md#accountphone) *** ### accountUuid?[​](#accountuuid "Direct link to accountUuid?") > `optional` **accountUuid**: `string` | `null` Defined in: [packages/sdk/src/types/account-types.ts:418](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L418) #### Inherited from[​](#inherited-from-4 "Direct link to Inherited from") [`OrgMember`](https://docs.gravityrail.com/sdk/interfaces/OrgMember.md).[`accountUuid`](https://docs.gravityrail.com/sdk/interfaces/OrgMember.md#accountuuid) *** ### createdAt[​](#createdat "Direct link to createdAt") > **createdAt**: `string` Defined in: [packages/sdk/src/types/account-types.ts:412](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L412) #### Inherited from[​](#inherited-from-5 "Direct link to Inherited from") [`OrgMember`](https://docs.gravityrail.com/sdk/interfaces/OrgMember.md).[`createdAt`](https://docs.gravityrail.com/sdk/interfaces/OrgMember.md#createdat) *** ### externalId?[​](#externalid "Direct link to externalId?") > `optional` **externalId**: `string` | `null` Defined in: [packages/sdk/src/types/account-types.ts:411](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L411) #### Inherited from[​](#inherited-from-6 "Direct link to Inherited from") [`OrgMember`](https://docs.gravityrail.com/sdk/interfaces/OrgMember.md).[`externalId`](https://docs.gravityrail.com/sdk/interfaces/OrgMember.md#externalid) *** ### id[​](#id "Direct link to id") > **id**: `number` Defined in: [packages/sdk/src/types/account-types.ts:406](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L406) #### Inherited from[​](#inherited-from-7 "Direct link to Inherited from") [`OrgMember`](https://docs.gravityrail.com/sdk/interfaces/OrgMember.md).[`id`](https://docs.gravityrail.com/sdk/interfaces/OrgMember.md#id) *** ### name?[​](#name "Direct link to name?") > `optional` **name**: `string` | `null` Defined in: [packages/sdk/src/types/account-types.ts:410](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L410) #### Inherited from[​](#inherited-from-8 "Direct link to Inherited from") [`OrgMember`](https://docs.gravityrail.com/sdk/interfaces/OrgMember.md).[`name`](https://docs.gravityrail.com/sdk/interfaces/OrgMember.md#name) *** ### organizationId[​](#organizationid "Direct link to organizationId") > **organizationId**: `number` Defined in: [packages/sdk/src/types/account-types.ts:408](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L408) #### Inherited from[​](#inherited-from-9 "Direct link to Inherited from") [`OrgMember`](https://docs.gravityrail.com/sdk/interfaces/OrgMember.md).[`organizationId`](https://docs.gravityrail.com/sdk/interfaces/OrgMember.md#organizationid) *** ### role[​](#role "Direct link to role") > **role**: [`OrgMemberRole`](https://docs.gravityrail.com/sdk/type-aliases/OrgMemberRole.md) Defined in: [packages/sdk/src/types/account-types.ts:409](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L409) #### Inherited from[​](#inherited-from-10 "Direct link to Inherited from") [`OrgMember`](https://docs.gravityrail.com/sdk/interfaces/OrgMember.md).[`role`](https://docs.gravityrail.com/sdk/interfaces/OrgMember.md#role) *** ### scopes[​](#scopes "Direct link to scopes") > **scopes**: `string`\[] Defined in: [packages/sdk/src/types/account-types.ts:427](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L427) *** ### updatedAt[​](#updatedat "Direct link to updatedAt") > **updatedAt**: `string` Defined in: [packages/sdk/src/types/account-types.ts:413](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L413) #### Inherited from[​](#inherited-from-11 "Direct link to Inherited from") [`OrgMember`](https://docs.gravityrail.com/sdk/interfaces/OrgMember.md).[`updatedAt`](https://docs.gravityrail.com/sdk/interfaces/OrgMember.md#updatedat) --- # Interface: CurrentPlanInfo Defined in: [packages/sdk/src/types/generated/workspace\_health.ts:50](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/workspace_health.ts#L50) Information about the workspace's current plan. ## Properties[​](#properties "Direct link to Properties") ### planPeriod[​](#planperiod "Direct link to planPeriod") > **planPeriod**: `string` Defined in: [packages/sdk/src/types/generated/workspace\_health.ts:55](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/workspace_health.ts#L55) *** ### productId[​](#productid "Direct link to productId") > **productId**: `number` Defined in: [packages/sdk/src/types/generated/workspace\_health.ts:52](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/workspace_health.ts#L52) *** ### productName[​](#productname "Direct link to productName") > **productName**: `string` Defined in: [packages/sdk/src/types/generated/workspace\_health.ts:53](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/workspace_health.ts#L53) *** ### productType[​](#producttype "Direct link to productType") > **productType**: `string` Defined in: [packages/sdk/src/types/generated/workspace\_health.ts:54](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/workspace_health.ts#L54) *** ### providesFeatures[​](#providesfeatures "Direct link to providesFeatures") > **providesFeatures**: `string`\[] Defined in: [packages/sdk/src/types/generated/workspace\_health.ts:57](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/workspace_health.ts#L57) *** ### subscriptionId[​](#subscriptionid "Direct link to subscriptionId") > **subscriptionId**: `number` Defined in: [packages/sdk/src/types/generated/workspace\_health.ts:51](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/workspace_health.ts#L51) *** ### subscriptionStatus[​](#subscriptionstatus "Direct link to subscriptionStatus") > **subscriptionStatus**: `string` Defined in: [packages/sdk/src/types/generated/workspace\_health.ts:56](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/workspace_health.ts#L56) --- # Interface: CursorPaginatedResponse\ Defined in: [packages/sdk/src/types/core-types.ts:13](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/core-types.ts#L13) ## Type Parameters[​](#type-parameters "Direct link to Type Parameters") ### T[​](#t "Direct link to T") `T` ## Properties[​](#properties "Direct link to Properties") ### hasMore[​](#hasmore "Direct link to hasMore") > **hasMore**: `boolean` Defined in: [packages/sdk/src/types/core-types.ts:16](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/core-types.ts#L16) *** ### items[​](#items "Direct link to items") > **items**: `T`\[] Defined in: [packages/sdk/src/types/core-types.ts:14](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/core-types.ts#L14) *** ### nextCursor[​](#nextcursor "Direct link to nextCursor") > **nextCursor**: `string` | `null` Defined in: [packages/sdk/src/types/core-types.ts:15](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/core-types.ts#L15) *** ### pageSize[​](#pagesize "Direct link to pageSize") > **pageSize**: `number` Defined in: [packages/sdk/src/types/core-types.ts:17](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/core-types.ts#L17) --- # Interface: CustomRealtimeModelConfig Defined in: [packages/sdk/src/types/model-config-types.ts:93](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/model-config-types.ts#L93) Base configuration for all realtime models. Contains common fields that apply to all realtime model providers. ## Extends[​](#extends "Direct link to Extends") * [`BaseRealtimeModelConfig`](https://docs.gravityrail.com/sdk/interfaces/BaseRealtimeModelConfig.md) ## Properties[​](#properties "Direct link to Properties") ### inferenceModel[​](#inferencemodel "Direct link to inferenceModel") > **inferenceModel**: `string` Defined in: [packages/sdk/src/types/model-config-types.ts:97](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/model-config-types.ts#L97) *** ### inferenceModelConfig?[​](#inferencemodelconfig "Direct link to inferenceModelConfig?") > `optional` **inferenceModelConfig**: [`ChatModelConfig`](https://docs.gravityrail.com/sdk/type-aliases/ChatModelConfig.md) | `null` Defined in: [packages/sdk/src/types/model-config-types.ts:98](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/model-config-types.ts#L98) *** ### interruptionSound?[​](#interruptionsound "Direct link to interruptionSound?") > `optional` **interruptionSound**: [`InterruptionSound`](https://docs.gravityrail.com/sdk/type-aliases/InterruptionSound.md) | `null` Defined in: [packages/sdk/src/types/model-config-types.ts:69](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/model-config-types.ts#L69) Sound to play when user stops speaking after interrupting the assistant. Provides immediate auditory feedback that input was received. Default: none. #### Inherited from[​](#inherited-from "Direct link to Inherited from") [`BaseRealtimeModelConfig`](https://docs.gravityrail.com/sdk/interfaces/BaseRealtimeModelConfig.md).[`interruptionSound`](https://docs.gravityrail.com/sdk/interfaces/BaseRealtimeModelConfig.md#interruptionsound) *** ### interruptionSoundVolume?[​](#interruptionsoundvolume "Direct link to interruptionSoundVolume?") > `optional` **interruptionSoundVolume**: `number` | `null` Defined in: [packages/sdk/src/types/model-config-types.ts:71](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/model-config-types.ts#L71) Volume level for the interruption sound (0-100). 0 means muted. Missing or null means full volume (100). #### Inherited from[​](#inherited-from-1 "Direct link to Inherited from") [`BaseRealtimeModelConfig`](https://docs.gravityrail.com/sdk/interfaces/BaseRealtimeModelConfig.md).[`interruptionSoundVolume`](https://docs.gravityrail.com/sdk/interfaces/BaseRealtimeModelConfig.md#interruptionsoundvolume) *** ### sttConfig?[​](#sttconfig "Direct link to sttConfig?") > `optional` **sttConfig**: `Record`<`string`, `unknown`> | `null` Defined in: [packages/sdk/src/types/model-config-types.ts:95](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/model-config-types.ts#L95) *** ### sttModel?[​](#sttmodel "Direct link to sttModel?") > `optional` **sttModel**: `string` | `null` Defined in: [packages/sdk/src/types/model-config-types.ts:94](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/model-config-types.ts#L94) *** ### thinkingSound?[​](#thinkingsound "Direct link to thinkingSound?") > `optional` **thinkingSound**: [`ThinkingSound`](https://docs.gravityrail.com/sdk/type-aliases/ThinkingSound.md) | `null` Defined in: [packages/sdk/src/types/model-config-types.ts:61](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/model-config-types.ts#L61) Sound to play while the agent is processing tool calls. #### Inherited from[​](#inherited-from-2 "Direct link to Inherited from") [`BaseRealtimeModelConfig`](https://docs.gravityrail.com/sdk/interfaces/BaseRealtimeModelConfig.md).[`thinkingSound`](https://docs.gravityrail.com/sdk/interfaces/BaseRealtimeModelConfig.md#thinkingsound) *** ### thinkingSoundInitialDelay?[​](#thinkingsoundinitialdelay "Direct link to thinkingSoundInitialDelay?") > `optional` **thinkingSoundInitialDelay**: `number` | `null` Defined in: [packages/sdk/src/types/model-config-types.ts:65](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/model-config-types.ts#L65) Initial delay in milliseconds before playing thinking sound. Prevents needless interruption on short tool calls. Default: 500ms. #### Inherited from[​](#inherited-from-3 "Direct link to Inherited from") [`BaseRealtimeModelConfig`](https://docs.gravityrail.com/sdk/interfaces/BaseRealtimeModelConfig.md).[`thinkingSoundInitialDelay`](https://docs.gravityrail.com/sdk/interfaces/BaseRealtimeModelConfig.md#thinkingsoundinitialdelay) *** ### thinkingSoundVolume?[​](#thinkingsoundvolume "Direct link to thinkingSoundVolume?") > `optional` **thinkingSoundVolume**: `number` | `null` Defined in: [packages/sdk/src/types/model-config-types.ts:63](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/model-config-types.ts#L63) Volume level for the thinking sound (0-100). 0 means muted. Missing or null means full volume (100). #### Inherited from[​](#inherited-from-4 "Direct link to Inherited from") [`BaseRealtimeModelConfig`](https://docs.gravityrail.com/sdk/interfaces/BaseRealtimeModelConfig.md).[`thinkingSoundVolume`](https://docs.gravityrail.com/sdk/interfaces/BaseRealtimeModelConfig.md#thinkingsoundvolume) *** ### thinkingSpeechPhrases?[​](#thinkingspeechphrases "Direct link to thinkingSpeechPhrases?") > `optional` **thinkingSpeechPhrases**: `string`\[] | `null` Defined in: [packages/sdk/src/types/model-config-types.ts:67](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/model-config-types.ts#L67) When `thinkingSound` is 'speech', one of these phrases is spoken while the agent runs a tool. Phrases rotate round-robin per session. #### Inherited from[​](#inherited-from-5 "Direct link to Inherited from") [`BaseRealtimeModelConfig`](https://docs.gravityrail.com/sdk/interfaces/BaseRealtimeModelConfig.md).[`thinkingSpeechPhrases`](https://docs.gravityrail.com/sdk/interfaces/BaseRealtimeModelConfig.md#thinkingspeechphrases) *** ### ttsModel?[​](#ttsmodel "Direct link to ttsModel?") > `optional` **ttsModel**: [`TTSModel`](https://docs.gravityrail.com/sdk/type-aliases/TTSModel.md) | `null` Defined in: [packages/sdk/src/types/model-config-types.ts:73](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/model-config-types.ts#L73) TTS model ID in provider:tts:model format (e.g. 'elevenlabs:tts:eleven\_flash\_v2\_5'), or 'native'. #### Inherited from[​](#inherited-from-6 "Direct link to Inherited from") [`BaseRealtimeModelConfig`](https://docs.gravityrail.com/sdk/interfaces/BaseRealtimeModelConfig.md).[`ttsModel`](https://docs.gravityrail.com/sdk/interfaces/BaseRealtimeModelConfig.md#ttsmodel) *** ### voiceModel?[​](#voicemodel "Direct link to voiceModel?") > `optional` **voiceModel**: `string` | `null` Defined in: [packages/sdk/src/types/model-config-types.ts:75](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/model-config-types.ts#L75) Canonical voice identifier (e.g., elevenlabs:voice:catt) that selects the specific agent voice. #### Inherited from[​](#inherited-from-7 "Direct link to Inherited from") [`BaseRealtimeModelConfig`](https://docs.gravityrail.com/sdk/interfaces/BaseRealtimeModelConfig.md).[`voiceModel`](https://docs.gravityrail.com/sdk/interfaces/BaseRealtimeModelConfig.md#voicemodel) --- # Interface: CustomToolExport Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:265](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L265) ## Properties[​](#properties "Direct link to Properties") ### description?[​](#description "Direct link to description?") > `optional` **description**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:269](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L269) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:268](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L268) *** ### parameters[​](#parameters "Direct link to parameters") > **parameters**: `any` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:270](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L270) *** ### toolkitUuid[​](#toolkituuid "Direct link to toolkitUuid") > **toolkitUuid**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:267](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L267) *** ### uuid[​](#uuid "Direct link to uuid") > **uuid**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:266](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L266) --- # Interface: CustomToolFormData Defined in: [packages/sdk/src/types/custom-tool-types.ts:55](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/custom-tool-types.ts#L55) ## Properties[​](#properties "Direct link to Properties") ### abilities?[​](#abilities "Direct link to abilities?") > `optional` **abilities**: [`AbilityResponse`](https://docs.gravityrail.com/sdk/type-aliases/AbilityResponse.md)\[] Defined in: [packages/sdk/src/types/custom-tool-types.ts:65](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/custom-tool-types.ts#L65) *** ### chatModel?[​](#chatmodel "Direct link to chatModel?") > `optional` **chatModel**: `string` Defined in: [packages/sdk/src/types/custom-tool-types.ts:60](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/custom-tool-types.ts#L60) *** ### dataTypes?[​](#datatypes "Direct link to dataTypes?") > `optional` **dataTypes**: `any`\[] Defined in: [packages/sdk/src/types/custom-tool-types.ts:64](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/custom-tool-types.ts#L64) *** ### description?[​](#description "Direct link to description?") > `optional` **description**: `string` Defined in: [packages/sdk/src/types/custom-tool-types.ts:58](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/custom-tool-types.ts#L58) *** ### displayName?[​](#displayname "Direct link to displayName?") > `optional` **displayName**: `string` Defined in: [packages/sdk/src/types/custom-tool-types.ts:57](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/custom-tool-types.ts#L57) *** ### files?[​](#files "Direct link to files?") > `optional` **files**: `any`\[] Defined in: [packages/sdk/src/types/custom-tool-types.ts:63](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/custom-tool-types.ts#L63) *** ### inputSchema?[​](#inputschema "Direct link to inputSchema?") > `optional` **inputSchema**: `any` Defined in: [packages/sdk/src/types/custom-tool-types.ts:61](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/custom-tool-types.ts#L61) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/custom-tool-types.ts:56](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/custom-tool-types.ts#L56) *** ### outputSchema?[​](#outputschema "Direct link to outputSchema?") > `optional` **outputSchema**: `any` Defined in: [packages/sdk/src/types/custom-tool-types.ts:62](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/custom-tool-types.ts#L62) *** ### prompt?[​](#prompt "Direct link to prompt?") > `optional` **prompt**: `string` Defined in: [packages/sdk/src/types/custom-tool-types.ts:59](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/custom-tool-types.ts#L59) --- # Interface: CustomToolkitExport Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:259](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L259) ## Properties[​](#properties "Direct link to Properties") ### description?[​](#description "Direct link to description?") > `optional` **description**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:262](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L262) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:261](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L261) *** ### uuid[​](#uuid "Direct link to uuid") > **uuid**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:260](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L260) --- # Interface: CustomToolkitFormData Defined in: [packages/sdk/src/types/custom-tool-types.ts:81](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/custom-tool-types.ts#L81) ## Properties[​](#properties "Direct link to Properties") ### abilities?[​](#abilities "Direct link to abilities?") > `optional` **abilities**: [`AbilityResponse`](https://docs.gravityrail.com/sdk/type-aliases/AbilityResponse.md)\[] Defined in: [packages/sdk/src/types/custom-tool-types.ts:87](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/custom-tool-types.ts#L87) *** ### customTools?[​](#customtools "Direct link to customTools?") > `optional` **customTools**: [`CustomToolFormData`](https://docs.gravityrail.com/sdk/interfaces/CustomToolFormData.md)\[] Defined in: [packages/sdk/src/types/custom-tool-types.ts:85](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/custom-tool-types.ts#L85) *** ### description?[​](#description "Direct link to description?") > `optional` **description**: `string` Defined in: [packages/sdk/src/types/custom-tool-types.ts:84](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/custom-tool-types.ts#L84) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/custom-tool-types.ts:82](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/custom-tool-types.ts#L82) *** ### ownerId?[​](#ownerid "Direct link to ownerId?") > `optional` **ownerId**: `number` Defined in: [packages/sdk/src/types/custom-tool-types.ts:86](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/custom-tool-types.ts#L86) *** ### slug?[​](#slug "Direct link to slug?") > `optional` **slug**: `string` Defined in: [packages/sdk/src/types/custom-tool-types.ts:83](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/custom-tool-types.ts#L83) --- # Interface: CustomToolkitUpdateFormData Defined in: [packages/sdk/src/types/custom-tool-types.ts:90](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/custom-tool-types.ts#L90) ## Properties[​](#properties "Direct link to Properties") ### abilities?[​](#abilities "Direct link to abilities?") > `optional` **abilities**: [`AbilityResponse`](https://docs.gravityrail.com/sdk/type-aliases/AbilityResponse.md)\[] Defined in: [packages/sdk/src/types/custom-tool-types.ts:95](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/custom-tool-types.ts#L95) *** ### customTools?[​](#customtools "Direct link to customTools?") > `optional` **customTools**: [`CustomToolFormData`](https://docs.gravityrail.com/sdk/interfaces/CustomToolFormData.md)\[] Defined in: [packages/sdk/src/types/custom-tool-types.ts:94](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/custom-tool-types.ts#L94) *** ### description?[​](#description "Direct link to description?") > `optional` **description**: `string` Defined in: [packages/sdk/src/types/custom-tool-types.ts:93](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/custom-tool-types.ts#L93) *** ### name?[​](#name "Direct link to name?") > `optional` **name**: `string` Defined in: [packages/sdk/src/types/custom-tool-types.ts:91](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/custom-tool-types.ts#L91) *** ### slug?[​](#slug "Direct link to slug?") > `optional` **slug**: `string` Defined in: [packages/sdk/src/types/custom-tool-types.ts:92](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/custom-tool-types.ts#L92) --- # Interface: CustomToolUpdateFormData Defined in: [packages/sdk/src/types/custom-tool-types.ts:68](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/custom-tool-types.ts#L68) ## Properties[​](#properties "Direct link to Properties") ### abilities?[​](#abilities "Direct link to abilities?") > `optional` **abilities**: [`AbilityResponse`](https://docs.gravityrail.com/sdk/type-aliases/AbilityResponse.md)\[] Defined in: [packages/sdk/src/types/custom-tool-types.ts:78](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/custom-tool-types.ts#L78) *** ### chatModel?[​](#chatmodel "Direct link to chatModel?") > `optional` **chatModel**: `string` Defined in: [packages/sdk/src/types/custom-tool-types.ts:73](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/custom-tool-types.ts#L73) *** ### dataTypes?[​](#datatypes "Direct link to dataTypes?") > `optional` **dataTypes**: `any`\[] Defined in: [packages/sdk/src/types/custom-tool-types.ts:77](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/custom-tool-types.ts#L77) *** ### description?[​](#description "Direct link to description?") > `optional` **description**: `string` Defined in: [packages/sdk/src/types/custom-tool-types.ts:71](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/custom-tool-types.ts#L71) *** ### displayName?[​](#displayname "Direct link to displayName?") > `optional` **displayName**: `string` Defined in: [packages/sdk/src/types/custom-tool-types.ts:70](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/custom-tool-types.ts#L70) *** ### files?[​](#files "Direct link to files?") > `optional` **files**: `any`\[] Defined in: [packages/sdk/src/types/custom-tool-types.ts:76](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/custom-tool-types.ts#L76) *** ### inputSchema?[​](#inputschema "Direct link to inputSchema?") > `optional` **inputSchema**: `any` Defined in: [packages/sdk/src/types/custom-tool-types.ts:74](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/custom-tool-types.ts#L74) *** ### name?[​](#name "Direct link to name?") > `optional` **name**: `string` Defined in: [packages/sdk/src/types/custom-tool-types.ts:69](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/custom-tool-types.ts#L69) *** ### outputSchema?[​](#outputschema "Direct link to outputSchema?") > `optional` **outputSchema**: `any` Defined in: [packages/sdk/src/types/custom-tool-types.ts:75](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/custom-tool-types.ts#L75) *** ### prompt?[​](#prompt "Direct link to prompt?") > `optional` **prompt**: `string` Defined in: [packages/sdk/src/types/custom-tool-types.ts:72](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/custom-tool-types.ts#L72) --- # Interface: DailyPhoneRowResponse Defined in: [packages/sdk/src/types/generated/usage.ts:45](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/usage.ts#L45) Daily phone call usage row for charts and exports. ## Properties[​](#properties "Direct link to Properties") ### date[​](#date "Direct link to date") > **date**: `string` Defined in: [packages/sdk/src/types/generated/usage.ts:46](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/usage.ts#L46) *** ### inbound[​](#inbound "Direct link to inbound") > **inbound**: `number` Defined in: [packages/sdk/src/types/generated/usage.ts:50](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/usage.ts#L50) *** ### outbound[​](#outbound "Direct link to outbound") > **outbound**: `number` Defined in: [packages/sdk/src/types/generated/usage.ts:51](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/usage.ts#L51) *** ### phoneName[​](#phonename "Direct link to phoneName") > **phoneName**: `string` | `null` Defined in: [packages/sdk/src/types/generated/usage.ts:49](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/usage.ts#L49) *** ### phoneNumber[​](#phonenumber "Direct link to phoneNumber") > **phoneNumber**: `string` Defined in: [packages/sdk/src/types/generated/usage.ts:48](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/usage.ts#L48) *** ### phoneNumberId[​](#phonenumberid "Direct link to phoneNumberId") > **phoneNumberId**: `number` Defined in: [packages/sdk/src/types/generated/usage.ts:47](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/usage.ts#L47) *** ### totalDurationSeconds[​](#totaldurationseconds "Direct link to totalDurationSeconds") > **totalDurationSeconds**: `number` Defined in: [packages/sdk/src/types/generated/usage.ts:52](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/usage.ts#L52) --- # Interface: DailySMSRowResponse Defined in: [packages/sdk/src/types/generated/usage.ts:58](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/usage.ts#L58) Daily SMS usage row for charts and exports. ## Properties[​](#properties "Direct link to Properties") ### date[​](#date "Direct link to date") > **date**: `string` Defined in: [packages/sdk/src/types/generated/usage.ts:59](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/usage.ts#L59) *** ### inbound[​](#inbound "Direct link to inbound") > **inbound**: `number` Defined in: [packages/sdk/src/types/generated/usage.ts:63](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/usage.ts#L63) *** ### outbound[​](#outbound "Direct link to outbound") > **outbound**: `number` Defined in: [packages/sdk/src/types/generated/usage.ts:64](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/usage.ts#L64) *** ### phoneName[​](#phonename "Direct link to phoneName") > **phoneName**: `string` | `null` Defined in: [packages/sdk/src/types/generated/usage.ts:62](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/usage.ts#L62) *** ### phoneNumber[​](#phonenumber "Direct link to phoneNumber") > **phoneNumber**: `string` Defined in: [packages/sdk/src/types/generated/usage.ts:61](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/usage.ts#L61) *** ### phoneNumberId[​](#phonenumberid "Direct link to phoneNumberId") > **phoneNumberId**: `number` Defined in: [packages/sdk/src/types/generated/usage.ts:60](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/usage.ts#L60) *** ### totalChars[​](#totalchars "Direct link to totalChars") > **totalChars**: `number` Defined in: [packages/sdk/src/types/generated/usage.ts:65](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/usage.ts#L65) *** ### totalSegments?[​](#totalsegments "Direct link to totalSegments?") > `optional` **totalSegments**: `number` Defined in: [packages/sdk/src/types/generated/usage.ts:66](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/usage.ts#L66) --- # Interface: DashboardMetrics Defined in: [packages/sdk/src/types/stats-types.ts:71](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/stats-types.ts#L71) ## Properties[​](#properties "Direct link to Properties") ### activeChats[​](#activechats "Direct link to activeChats") > **activeChats**: `number` Defined in: [packages/sdk/src/types/stats-types.ts:77](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/stats-types.ts#L77) *** ### activeMembers[​](#activemembers "Direct link to activeMembers") > **activeMembers**: `number` Defined in: [packages/sdk/src/types/stats-types.ts:73](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/stats-types.ts#L73) *** ### activeSites[​](#activesites "Direct link to activeSites") > **activeSites**: `number` Defined in: [packages/sdk/src/types/stats-types.ts:79](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/stats-types.ts#L79) *** ### completedTasks[​](#completedtasks "Direct link to completedTasks") > **completedTasks**: `number` Defined in: [packages/sdk/src/types/stats-types.ts:75](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/stats-types.ts#L75) *** ### memberGrowth[​](#membergrowth "Direct link to memberGrowth") > **memberGrowth**: [`TimeSeriesData`](https://docs.gravityrail.com/sdk/interfaces/TimeSeriesData.md) Defined in: [packages/sdk/src/types/stats-types.ts:81](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/stats-types.ts#L81) *** ### recentActivity[​](#recentactivity "Direct link to recentActivity") > **recentActivity**: [`TimeSeriesData`](https://docs.gravityrail.com/sdk/interfaces/TimeSeriesData.md) Defined in: [packages/sdk/src/types/stats-types.ts:80](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/stats-types.ts#L80) *** ### taskCompletion[​](#taskcompletion "Direct link to taskCompletion") > **taskCompletion**: [`TimeSeriesData`](https://docs.gravityrail.com/sdk/interfaces/TimeSeriesData.md) Defined in: [packages/sdk/src/types/stats-types.ts:82](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/stats-types.ts#L82) *** ### totalChats[​](#totalchats "Direct link to totalChats") > **totalChats**: `number` Defined in: [packages/sdk/src/types/stats-types.ts:76](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/stats-types.ts#L76) *** ### totalMembers[​](#totalmembers "Direct link to totalMembers") > **totalMembers**: `number` Defined in: [packages/sdk/src/types/stats-types.ts:72](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/stats-types.ts#L72) *** ### totalSites[​](#totalsites "Direct link to totalSites") > **totalSites**: `number` Defined in: [packages/sdk/src/types/stats-types.ts:78](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/stats-types.ts#L78) *** ### totalTasks[​](#totaltasks "Direct link to totalTasks") > **totalTasks**: `number` Defined in: [packages/sdk/src/types/stats-types.ts:74](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/stats-types.ts#L74) --- # Interface: DataAccessAbilityConfig Defined in: [packages/sdk/src/types/ability-types.ts:154](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ability-types.ts#L154) Config for data\_access ability ## Properties[​](#properties "Direct link to Properties") ### autoCreate?[​](#autocreate "Direct link to autoCreate?") > `optional` **autoCreate**: `boolean` Defined in: [packages/sdk/src/types/ability-types.ts:184](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ability-types.ts#L184) When true, auto-create a record for the assignment if one doesn't exist (default: false) *** ### canCreate?[​](#cancreate "Direct link to canCreate?") > `optional` **canCreate**: `boolean` Defined in: [packages/sdk/src/types/ability-types.ts:158](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ability-types.ts#L158) Whether the agent can create new records (default: false) *** ### canDelete?[​](#candelete "Direct link to canDelete?") > `optional` **canDelete**: `boolean` Defined in: [packages/sdk/src/types/ability-types.ts:170](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ability-types.ts#L170) Whether the agent can delete records (default: false) *** ### canEdit?[​](#canedit "Direct link to canEdit?") > `optional` **canEdit**: `boolean` Defined in: [packages/sdk/src/types/ability-types.ts:162](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ability-types.ts#L162) Whether the agent can update existing records (default: false) *** ### canGeolocate?[​](#cangeolocate "Direct link to canGeolocate?") > `optional` **canGeolocate**: `boolean` Defined in: [packages/sdk/src/types/ability-types.ts:168](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ability-types.ts#L168) Whether the agent can search records by geographic location (default: false) *** ### canListAll?[​](#canlistall "Direct link to canListAll?") > `optional` **canListAll**: `boolean` Defined in: [packages/sdk/src/types/ability-types.ts:166](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ability-types.ts#L166) Whether the agent can list all members' records (default: false) *** ### canRead?[​](#canread "Direct link to canRead?") > `optional` **canRead**: `boolean` Defined in: [packages/sdk/src/types/ability-types.ts:160](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ability-types.ts#L160) Whether the agent can list and search records (default: true) *** ### canVerify?[​](#canverify "Direct link to canVerify?") > `optional` **canVerify**: `boolean` Defined in: [packages/sdk/src/types/ability-types.ts:164](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ability-types.ts#L164) Whether the agent can verify record data (default: false) *** ### createFields?[​](#createfields "Direct link to createFields?") > `optional` **createFields**: `string`\[] Defined in: [packages/sdk/src/types/ability-types.ts:182](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ability-types.ts#L182) Field slugs the agent can set when creating records. If empty/undefined, all fields are available. *** ### dataTypeUuid[​](#datatypeuuid "Direct link to dataTypeUuid") > **dataTypeUuid**: `string` Defined in: [packages/sdk/src/types/ability-types.ts:156](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ability-types.ts#L156) UUID of the data type to provide tools for *** ### readFields?[​](#readfields "Direct link to readFields?") > `optional` **readFields**: `string`\[] Defined in: [packages/sdk/src/types/ability-types.ts:172](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ability-types.ts#L172) Field slugs the agent can read. If empty/undefined, all fields are readable. *** ### readLimit?[​](#readlimit "Direct link to readLimit?") > `optional` **readLimit**: `number` Defined in: [packages/sdk/src/types/ability-types.ts:174](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ability-types.ts#L174) Maximum records returned by list tools. If empty/undefined, the default page size is used. *** ### readSortDirection?[​](#readsortdirection "Direct link to readSortDirection?") > `optional` **readSortDirection**: `"asc"` | `"desc"` Defined in: [packages/sdk/src/types/ability-types.ts:178](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ability-types.ts#L178) Sort direction for list tool results. *** ### readSortField?[​](#readsortfield "Direct link to readSortField?") > `optional` **readSortField**: `string` Defined in: [packages/sdk/src/types/ability-types.ts:176](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ability-types.ts#L176) Field slug, created\_at, or updated\_at used to order list tool results. *** ### scope?[​](#scope "Direct link to scope?") > `optional` **scope**: `"member"` | `"assignment"` Defined in: [packages/sdk/src/types/ability-types.ts:198](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ability-types.ts#L198) Scope for the generated agent Form tool record access (reads/writes). Applies to any Form, not only collections. * "member" (default): all of the current Member's records, including from prior Assignments (lifetime history). * "assignment": only records linked to the current Assignment via AssignmentDataRecordAssociation. Use this when the agent should never see or modify records from a prior Assignment for the same Member. Omit when the value is "member" so existing configs round-trip without churn. *** ### writeFields?[​](#writefields "Direct link to writeFields?") > `optional` **writeFields**: `string`\[] Defined in: [packages/sdk/src/types/ability-types.ts:180](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ability-types.ts#L180) Field slugs the agent can write/update. If empty/undefined, all fields are writable. --- # Interface: DataAccessGrantInterrupt Defined in: [packages/sdk/src/types/chat-types.ts:374](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L374) ## Properties[​](#properties "Direct link to Properties") ### accessMode[​](#accessmode "Direct link to accessMode") > **accessMode**: `string` Defined in: [packages/sdk/src/types/chat-types.ts:379](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L379) *** ### dataTypeName[​](#datatypename "Direct link to dataTypeName") > **dataTypeName**: `string` Defined in: [packages/sdk/src/types/chat-types.ts:378](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L378) *** ### dataTypeSlug[​](#datatypeslug "Direct link to dataTypeSlug") > **dataTypeSlug**: `string` Defined in: [packages/sdk/src/types/chat-types.ts:377](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L377) *** ### dateFrom?[​](#datefrom "Direct link to dateFrom?") > `optional` **dateFrom**: `string` | `null` Defined in: [packages/sdk/src/types/chat-types.ts:381](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L381) *** ### dateTo?[​](#dateto "Direct link to dateTo?") > `optional` **dateTo**: `string` | `null` Defined in: [packages/sdk/src/types/chat-types.ts:382](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L382) *** ### grantUuid[​](#grantuuid "Direct link to grantUuid") > **grantUuid**: `string` Defined in: [packages/sdk/src/types/chat-types.ts:376](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L376) *** ### interruptId?[​](#interruptid "Direct link to interruptId?") > `optional` **interruptId**: `string` Defined in: [packages/sdk/src/types/chat-types.ts:384](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L384) LangGraph interrupt ID injected by the backend so it can be echoed back on resume. *** ### limit?[​](#limit "Direct link to limit?") > `optional` **limit**: `number` | `null` Defined in: [packages/sdk/src/types/chat-types.ts:380](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L380) *** ### type[​](#type "Direct link to type") > **type**: `"data_access_grant"` Defined in: [packages/sdk/src/types/chat-types.ts:375](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L375) --- # Interface: DataField Defined in: [packages/sdk/src/types/data-types.ts:96](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L96) ## Properties[​](#properties "Direct link to Properties") ### adminOnly?[​](#adminonly "Direct link to adminOnly?") > `optional` **adminOnly**: `boolean` Defined in: [packages/sdk/src/types/data-types.ts:107](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L107) *** ### createdAt[​](#createdat "Direct link to createdAt") > **createdAt**: `string` Defined in: [packages/sdk/src/types/data-types.ts:110](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L110) *** ### defaultValue?[​](#defaultvalue "Direct link to defaultValue?") > `optional` **defaultValue**: `any` Defined in: [packages/sdk/src/types/data-types.ts:108](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L108) *** ### description?[​](#description "Direct link to description?") > `optional` **description**: `string` Defined in: [packages/sdk/src/types/data-types.ts:100](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L100) *** ### fieldType[​](#fieldtype "Direct link to fieldType") > **fieldType**: [`DataFieldType`](https://docs.gravityrail.com/sdk/enumerations/DataFieldType.md) Defined in: [packages/sdk/src/types/data-types.ts:102](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L102) *** ### id?[​](#id "Direct link to id?") > `optional` **id**: `number` Defined in: [packages/sdk/src/types/data-types.ts:97](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L97) *** ### indexStatus?[​](#indexstatus "Direct link to indexStatus?") > `optional` **indexStatus**: [`IndexStatus`](https://docs.gravityrail.com/sdk/enumerations/IndexStatus.md) Defined in: [packages/sdk/src/types/data-types.ts:106](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L106) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/data-types.ts:98](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L98) *** ### options?[​](#options "Direct link to options?") > `optional` **options**: [`EnumOption`](https://docs.gravityrail.com/sdk/interfaces/EnumOption.md)\[] Defined in: [packages/sdk/src/types/data-types.ts:103](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L103) *** ### order[​](#order "Direct link to order") > **order**: `number` Defined in: [packages/sdk/src/types/data-types.ts:109](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L109) *** ### referencedTypeId?[​](#referencedtypeid "Direct link to referencedTypeId?") > `optional` **referencedTypeId**: `number` Defined in: [packages/sdk/src/types/data-types.ts:104](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L104) *** ### required[​](#required "Direct link to required") > **required**: `boolean` Defined in: [packages/sdk/src/types/data-types.ts:101](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L101) *** ### shouldIndex?[​](#shouldindex "Direct link to shouldIndex?") > `optional` **shouldIndex**: `boolean` Defined in: [packages/sdk/src/types/data-types.ts:105](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L105) *** ### slug[​](#slug "Direct link to slug") > **slug**: `string` Defined in: [packages/sdk/src/types/data-types.ts:99](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L99) *** ### updatedAt[​](#updatedat "Direct link to updatedAt") > **updatedAt**: `string` Defined in: [packages/sdk/src/types/data-types.ts:111](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L111) --- # Interface: DataFieldFormData Defined in: [packages/sdk/src/types/data-types.ts:114](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L114) ## Properties[​](#properties "Direct link to Properties") ### adminOnly?[​](#adminonly "Direct link to adminOnly?") > `optional` **adminOnly**: `boolean` Defined in: [packages/sdk/src/types/data-types.ts:123](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L123) *** ### defaultValue?[​](#defaultvalue "Direct link to defaultValue?") > `optional` **defaultValue**: `any` Defined in: [packages/sdk/src/types/data-types.ts:124](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L124) *** ### description?[​](#description "Direct link to description?") > `optional` **description**: `string` Defined in: [packages/sdk/src/types/data-types.ts:117](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L117) *** ### fieldType[​](#fieldtype "Direct link to fieldType") > **fieldType**: [`DataFieldType`](https://docs.gravityrail.com/sdk/enumerations/DataFieldType.md) Defined in: [packages/sdk/src/types/data-types.ts:119](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L119) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/data-types.ts:115](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L115) *** ### options?[​](#options "Direct link to options?") > `optional` **options**: [`EnumOption`](https://docs.gravityrail.com/sdk/interfaces/EnumOption.md)\[] Defined in: [packages/sdk/src/types/data-types.ts:120](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L120) *** ### order?[​](#order "Direct link to order?") > `optional` **order**: `number` Defined in: [packages/sdk/src/types/data-types.ts:125](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L125) *** ### referencedTypeId?[​](#referencedtypeid "Direct link to referencedTypeId?") > `optional` **referencedTypeId**: `number` Defined in: [packages/sdk/src/types/data-types.ts:121](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L121) *** ### required[​](#required "Direct link to required") > **required**: `boolean` Defined in: [packages/sdk/src/types/data-types.ts:118](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L118) *** ### shouldIndex?[​](#shouldindex "Direct link to shouldIndex?") > `optional` **shouldIndex**: `boolean` Defined in: [packages/sdk/src/types/data-types.ts:122](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L122) *** ### slug[​](#slug "Direct link to slug") > **slug**: `string` Defined in: [packages/sdk/src/types/data-types.ts:116](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L116) --- # Interface: DataIntegrityReportItem Defined in: [packages/sdk/src/types/data-types.ts:196](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L196) ## Properties[​](#properties "Direct link to Properties") ### dataTypeId[​](#datatypeid "Direct link to dataTypeId") > **dataTypeId**: `number` Defined in: [packages/sdk/src/types/data-types.ts:197](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L197) *** ### dataTypeName[​](#datatypename "Direct link to dataTypeName") > **dataTypeName**: `string` Defined in: [packages/sdk/src/types/data-types.ts:199](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L199) *** ### dataTypeSlug[​](#datatypeslug "Direct link to dataTypeSlug") > **dataTypeSlug**: `string` Defined in: [packages/sdk/src/types/data-types.ts:198](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L198) *** ### invalidRecords[​](#invalidrecords "Direct link to invalidRecords") > **invalidRecords**: `number` Defined in: [packages/sdk/src/types/data-types.ts:201](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L201) *** ### issues[​](#issues "Direct link to issues") > **issues**: `string`\[] Defined in: [packages/sdk/src/types/data-types.ts:202](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L202) *** ### totalRecords[​](#totalrecords "Direct link to totalRecords") > **totalRecords**: `number` Defined in: [packages/sdk/src/types/data-types.ts:200](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L200) --- # Interface: DataRecordAssociationFormData Defined in: [packages/sdk/src/types/data-types.ts:177](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L177) ## Properties[​](#properties "Direct link to Properties") ### accessMode?[​](#accessmode "Direct link to accessMode?") > `optional` **accessMode**: `number` Defined in: [packages/sdk/src/types/data-types.ts:179](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L179) *** ### dataRecordId[​](#datarecordid "Direct link to dataRecordId") > **dataRecordId**: `number` Defined in: [packages/sdk/src/types/data-types.ts:178](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L178) --- # Interface: DataRecordContext Defined in: [packages/sdk/src/app-context.ts:46](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/app-context.ts#L46) Information about a data record in the context ## Properties[​](#properties "Direct link to Properties") ### id[​](#id "Direct link to id") > **id**: `number` Defined in: [packages/sdk/src/app-context.ts:47](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/app-context.ts#L47) *** ### name?[​](#name "Direct link to name?") > `optional` **name**: `string` Defined in: [packages/sdk/src/app-context.ts:49](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/app-context.ts#L49) *** ### type?[​](#type "Direct link to type?") > `optional` **type**: `string` Defined in: [packages/sdk/src/app-context.ts:48](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/app-context.ts#L48) --- # Interface: DataRecordFieldWarning Defined in: [packages/sdk/src/types/generated/member.ts:288](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L288) A soft-warning entry for a DataRecord field schema mismatch. Emitted when an API caller sends a field slug that is not declared on the target DataType's schema. The server silently skips the field (for backward-compatibility — callers depend on unknown slugs being ignored rather than rejected with 400) and attaches one of these to the response so the caller can surface or fix the drift. API-facing camelCase to match other signup response fields. ## Properties[​](#properties "Direct link to Properties") ### code[​](#code "Direct link to code") > **code**: `"unknown_data_record_field"` Defined in: [packages/sdk/src/types/generated/member.ts:289](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L289) *** ### dataTypeSlug[​](#datatypeslug "Direct link to dataTypeSlug") > **dataTypeSlug**: `string` Defined in: [packages/sdk/src/types/generated/member.ts:290](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L290) *** ### fieldSlug[​](#fieldslug "Direct link to fieldSlug") > **fieldSlug**: `string` Defined in: [packages/sdk/src/types/generated/member.ts:291](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L291) *** ### message[​](#message "Direct link to message") > **message**: `string` Defined in: [packages/sdk/src/types/generated/member.ts:292](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L292) --- # Interface: DataRecordFormData Defined in: [packages/sdk/src/types/data-types.ts:165](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L165) ## Properties[​](#properties "Direct link to Properties") ### dataTypeId[​](#datatypeid "Direct link to dataTypeId") > **dataTypeId**: `number` Defined in: [packages/sdk/src/types/data-types.ts:166](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L166) *** ### externalId?[​](#externalid "Direct link to externalId?") > `optional` **externalId**: `string` Defined in: [packages/sdk/src/types/data-types.ts:168](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L168) *** ### fieldValues[​](#fieldvalues "Direct link to fieldValues") > **fieldValues**: `Record`<`string`, `unknown`> Defined in: [packages/sdk/src/types/data-types.ts:169](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L169) *** ### memberId?[​](#memberid "Direct link to memberId?") > `optional` **memberId**: `number` | `null` Defined in: [packages/sdk/src/types/data-types.ts:167](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L167) --- # Interface: DataRecordReportItem Defined in: [packages/sdk/src/types/data-types.ts:186](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L186) ## Properties[​](#properties "Direct link to Properties") ### account?[​](#account "Direct link to account?") > `optional` **account**: [`AccountReportItem`](https://docs.gravityrail.com/sdk/interfaces/AccountReportItem.md) Defined in: [packages/sdk/src/types/data-types.ts:191](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L191) *** ### createdAt[​](#createdat "Direct link to createdAt") > **createdAt**: `string` Defined in: [packages/sdk/src/types/data-types.ts:192](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L192) *** ### dataTypeId[​](#datatypeid "Direct link to dataTypeId") > **dataTypeId**: `number` Defined in: [packages/sdk/src/types/data-types.ts:188](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L188) *** ### dataTypeSlug[​](#datatypeslug "Direct link to dataTypeSlug") > **dataTypeSlug**: `string` Defined in: [packages/sdk/src/types/data-types.ts:189](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L189) *** ### id[​](#id "Direct link to id") > **id**: `number` Defined in: [packages/sdk/src/types/data-types.ts:187](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L187) *** ### member?[​](#member "Direct link to member?") > `optional` **member**: [`MemberReportItem`](https://docs.gravityrail.com/sdk/interfaces/MemberReportItem.md) Defined in: [packages/sdk/src/types/data-types.ts:190](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L190) *** ### updatedAt[​](#updatedat "Direct link to updatedAt") > **updatedAt**: `string` Defined in: [packages/sdk/src/types/data-types.ts:193](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L193) --- # Interface: DataRecordResponse Defined in: [packages/sdk/src/types/generated/data.ts:62](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/data.ts#L62) ## Extended by[​](#extended-by "Direct link to Extended by") * [`DataRecordWithAccessMode`](https://docs.gravityrail.com/sdk/interfaces/DataRecordWithAccessMode.md) ## Properties[​](#properties "Direct link to Properties") ### accessMode?[​](#accessmode "Direct link to accessMode?") > `optional` **accessMode**: `number` | `null` Defined in: [packages/sdk/src/types/generated/data.ts:71](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/data.ts#L71) *** ### createdAt[​](#createdat "Direct link to createdAt") > **createdAt**: `string` Defined in: [packages/sdk/src/types/generated/data.ts:68](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/data.ts#L68) *** ### dataTypeId[​](#datatypeid "Direct link to dataTypeId") > **dataTypeId**: `number` Defined in: [packages/sdk/src/types/generated/data.ts:64](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/data.ts#L64) *** ### externalId?[​](#externalid "Direct link to externalId?") > `optional` **externalId**: `string` | `null` Defined in: [packages/sdk/src/types/generated/data.ts:70](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/data.ts#L70) *** ### fieldValues[​](#fieldvalues "Direct link to fieldValues") > **fieldValues**: `DataRecordResponseFieldValues` Defined in: [packages/sdk/src/types/generated/data.ts:67](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/data.ts#L67) *** ### id[​](#id "Direct link to id") > **id**: `number` Defined in: [packages/sdk/src/types/generated/data.ts:63](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/data.ts#L63) *** ### memberId[​](#memberid "Direct link to memberId") > **memberId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/data.ts:65](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/data.ts#L65) *** ### memberName?[​](#membername "Direct link to memberName?") > `optional` **memberName**: `string` | `null` Defined in: [packages/sdk/src/types/generated/data.ts:66](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/data.ts#L66) *** ### retirement?[​](#retirement "Direct link to retirement?") > `optional` **retirement**: [`DataRecordRetirementResponse`](https://docs.gravityrail.com/sdk/interfaces/DataRecordRetirementResponse.md) | `null` Defined in: [packages/sdk/src/types/generated/data.ts:72](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/data.ts#L72) *** ### updatedAt[​](#updatedat "Direct link to updatedAt") > **updatedAt**: `string` Defined in: [packages/sdk/src/types/generated/data.ts:69](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/data.ts#L69) --- # Interface: DataRecordRetirementResponse Defined in: [packages/sdk/src/types/generated/data.ts:88](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/data.ts#L88) Derived lifecycle-retirement status for a connector-backed record. Populated only on the human Forms/CRUD read responses (list + single GET) so the UI can show an "Archived in Monday" / "Deleted in Monday" badge. Derived at read time from `ConnectionEntityExclusion` + active-link state — there is no stored retirement column on `DataRecord`. PHI-safe: closed-vocabulary `status` / `reason` / `source` codes only. No field values, no remote item/board IDs, no connection metadata. ## Properties[​](#properties "Direct link to Properties") ### reason[​](#reason "Direct link to reason") > **reason**: [`DataRecordRetirementResponseReason`](https://docs.gravityrail.com/sdk/type-aliases/DataRecordRetirementResponseReason.md) Defined in: [packages/sdk/src/types/generated/data.ts:90](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/data.ts#L90) *** ### source?[​](#source "Direct link to source?") > `optional` **source**: `"monday"` Defined in: [packages/sdk/src/types/generated/data.ts:91](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/data.ts#L91) *** ### status?[​](#status "Direct link to status?") > `optional` **status**: `"retired"` Defined in: [packages/sdk/src/types/generated/data.ts:89](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/data.ts#L89) --- # Interface: DataRecordsPaginatedResponse Defined in: [packages/sdk/src/types/data-types.ts:24](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L24) ## Properties[​](#properties "Direct link to Properties") ### items[​](#items "Direct link to items") > **items**: [`DataRecordResponse`](https://docs.gravityrail.com/sdk/interfaces/DataRecordResponse.md)\[] Defined in: [packages/sdk/src/types/data-types.ts:25](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L25) *** ### page[​](#page "Direct link to page") > **page**: `number` Defined in: [packages/sdk/src/types/data-types.ts:27](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L27) *** ### pageSize[​](#pagesize "Direct link to pageSize") > **pageSize**: `number` Defined in: [packages/sdk/src/types/data-types.ts:28](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L28) *** ### total[​](#total "Direct link to total") > **total**: `number` Defined in: [packages/sdk/src/types/data-types.ts:26](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L26) *** ### totalPages[​](#totalpages "Direct link to totalPages") > **totalPages**: `number` Defined in: [packages/sdk/src/types/data-types.ts:29](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L29) --- # Interface: DataRecordUpdateResponse Defined in: [packages/sdk/src/types/generated/data.ts:102](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/data.ts#L102) ## Properties[​](#properties "Direct link to Properties") ### actorMemberId[​](#actormemberid "Direct link to actorMemberId") > **actorMemberId**: `number` Defined in: [packages/sdk/src/types/generated/data.ts:105](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/data.ts#L105) *** ### assignmentTaskId?[​](#assignmenttaskid "Direct link to assignmentTaskId?") > `optional` **assignmentTaskId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/data.ts:112](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/data.ts#L112) *** ### createdAt[​](#createdat "Direct link to createdAt") > **createdAt**: `string` Defined in: [packages/sdk/src/types/generated/data.ts:110](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/data.ts#L110) *** ### dataRecordId[​](#datarecordid "Direct link to dataRecordId") > **dataRecordId**: `number` Defined in: [packages/sdk/src/types/generated/data.ts:104](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/data.ts#L104) *** ### fieldName[​](#fieldname "Direct link to fieldName") > **fieldName**: `string` Defined in: [packages/sdk/src/types/generated/data.ts:107](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/data.ts#L107) *** ### id[​](#id "Direct link to id") > **id**: `number` Defined in: [packages/sdk/src/types/generated/data.ts:103](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/data.ts#L103) *** ### memberName?[​](#membername "Direct link to memberName?") > `optional` **memberName**: `string` | `null` Defined in: [packages/sdk/src/types/generated/data.ts:113](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/data.ts#L113) *** ### newValue[​](#newvalue "Direct link to newValue") > **newValue**: `string` | `null` Defined in: [packages/sdk/src/types/generated/data.ts:109](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/data.ts#L109) *** ### oldValue[​](#oldvalue "Direct link to oldValue") > **oldValue**: `string` | `null` Defined in: [packages/sdk/src/types/generated/data.ts:108](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/data.ts#L108) *** ### recordMemberId?[​](#recordmemberid "Direct link to recordMemberId?") > `optional` **recordMemberId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/data.ts:106](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/data.ts#L106) *** ### updatedAt[​](#updatedat "Direct link to updatedAt") > **updatedAt**: `string` Defined in: [packages/sdk/src/types/generated/data.ts:111](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/data.ts#L111) --- # Interface: DataRecordWithAccessMode Defined in: [packages/sdk/src/types/data-types.ts:182](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L182) ## Extends[​](#extends "Direct link to Extends") * [`DataRecordResponse`](https://docs.gravityrail.com/sdk/interfaces/DataRecordResponse.md) ## Properties[​](#properties "Direct link to Properties") ### accessMode?[​](#accessmode "Direct link to accessMode?") > `optional` **accessMode**: `number` | `null` Defined in: [packages/sdk/src/types/data-types.ts:183](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L183) #### Overrides[​](#overrides "Direct link to Overrides") [`DataRecordResponse`](https://docs.gravityrail.com/sdk/interfaces/DataRecordResponse.md).[`accessMode`](https://docs.gravityrail.com/sdk/interfaces/DataRecordResponse.md#accessmode) *** ### createdAt[​](#createdat "Direct link to createdAt") > **createdAt**: `string` Defined in: [packages/sdk/src/types/generated/data.ts:68](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/data.ts#L68) #### Inherited from[​](#inherited-from "Direct link to Inherited from") [`DataRecordResponse`](https://docs.gravityrail.com/sdk/interfaces/DataRecordResponse.md).[`createdAt`](https://docs.gravityrail.com/sdk/interfaces/DataRecordResponse.md#createdat) *** ### dataTypeId[​](#datatypeid "Direct link to dataTypeId") > **dataTypeId**: `number` Defined in: [packages/sdk/src/types/generated/data.ts:64](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/data.ts#L64) #### Inherited from[​](#inherited-from-1 "Direct link to Inherited from") [`DataRecordResponse`](https://docs.gravityrail.com/sdk/interfaces/DataRecordResponse.md).[`dataTypeId`](https://docs.gravityrail.com/sdk/interfaces/DataRecordResponse.md#datatypeid) *** ### externalId?[​](#externalid "Direct link to externalId?") > `optional` **externalId**: `string` | `null` Defined in: [packages/sdk/src/types/generated/data.ts:70](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/data.ts#L70) #### Inherited from[​](#inherited-from-2 "Direct link to Inherited from") [`DataRecordResponse`](https://docs.gravityrail.com/sdk/interfaces/DataRecordResponse.md).[`externalId`](https://docs.gravityrail.com/sdk/interfaces/DataRecordResponse.md#externalid) *** ### fieldValues[​](#fieldvalues "Direct link to fieldValues") > **fieldValues**: `DataRecordResponseFieldValues` Defined in: [packages/sdk/src/types/generated/data.ts:67](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/data.ts#L67) #### Inherited from[​](#inherited-from-3 "Direct link to Inherited from") [`DataRecordResponse`](https://docs.gravityrail.com/sdk/interfaces/DataRecordResponse.md).[`fieldValues`](https://docs.gravityrail.com/sdk/interfaces/DataRecordResponse.md#fieldvalues) *** ### id[​](#id "Direct link to id") > **id**: `number` Defined in: [packages/sdk/src/types/generated/data.ts:63](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/data.ts#L63) #### Inherited from[​](#inherited-from-4 "Direct link to Inherited from") [`DataRecordResponse`](https://docs.gravityrail.com/sdk/interfaces/DataRecordResponse.md).[`id`](https://docs.gravityrail.com/sdk/interfaces/DataRecordResponse.md#id) *** ### memberId[​](#memberid "Direct link to memberId") > **memberId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/data.ts:65](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/data.ts#L65) #### Inherited from[​](#inherited-from-5 "Direct link to Inherited from") [`DataRecordResponse`](https://docs.gravityrail.com/sdk/interfaces/DataRecordResponse.md).[`memberId`](https://docs.gravityrail.com/sdk/interfaces/DataRecordResponse.md#memberid) *** ### memberName?[​](#membername "Direct link to memberName?") > `optional` **memberName**: `string` | `null` Defined in: [packages/sdk/src/types/generated/data.ts:66](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/data.ts#L66) #### Inherited from[​](#inherited-from-6 "Direct link to Inherited from") [`DataRecordResponse`](https://docs.gravityrail.com/sdk/interfaces/DataRecordResponse.md).[`memberName`](https://docs.gravityrail.com/sdk/interfaces/DataRecordResponse.md#membername) *** ### retirement?[​](#retirement "Direct link to retirement?") > `optional` **retirement**: [`DataRecordRetirementResponse`](https://docs.gravityrail.com/sdk/interfaces/DataRecordRetirementResponse.md) | `null` Defined in: [packages/sdk/src/types/generated/data.ts:72](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/data.ts#L72) #### Inherited from[​](#inherited-from-7 "Direct link to Inherited from") [`DataRecordResponse`](https://docs.gravityrail.com/sdk/interfaces/DataRecordResponse.md).[`retirement`](https://docs.gravityrail.com/sdk/interfaces/DataRecordResponse.md#retirement) *** ### updatedAt[​](#updatedat "Direct link to updatedAt") > **updatedAt**: `string` Defined in: [packages/sdk/src/types/generated/data.ts:69](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/data.ts#L69) #### Inherited from[​](#inherited-from-8 "Direct link to Inherited from") [`DataRecordResponse`](https://docs.gravityrail.com/sdk/interfaces/DataRecordResponse.md).[`updatedAt`](https://docs.gravityrail.com/sdk/interfaces/DataRecordResponse.md#updatedat) --- # Interface: DataTypeExport Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:32](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L32) ## Properties[​](#properties "Direct link to Properties") ### description?[​](#description "Direct link to description?") > `optional` **description**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:37](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L37) *** ### fields[​](#fields "Direct link to fields") > **fields**: [`SchemaField`](https://docs.gravityrail.com/sdk/interfaces/SchemaField.md)\[] Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:41](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L41) *** ### isCollection[​](#iscollection "Direct link to isCollection") > **isCollection**: `boolean` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:39](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L39) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:35](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L35) *** ### prompt?[​](#prompt "Direct link to prompt?") > `optional` **prompt**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:38](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L38) *** ### recordScope[​](#recordscope "Direct link to recordScope") > **recordScope**: [`DataTypeRecordScope`](https://docs.gravityrail.com/sdk/enumerations/DataTypeRecordScope.md) Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:40](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L40) *** ### slug[​](#slug "Direct link to slug") > **slug**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:36](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L36) *** ### templateUuid?[​](#templateuuid "Direct link to templateUuid?") > `optional` **templateUuid**: `string` | `null` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:34](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L34) *** ### uuid[​](#uuid "Direct link to uuid") > **uuid**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:33](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L33) --- # Interface: DataTypeExportItem Defined in: [packages/sdk/src/types/data-types.ts:205](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L205) ## Properties[​](#properties "Direct link to Properties") ### createdAt[​](#createdat "Direct link to createdAt") > **createdAt**: `string` Defined in: [packages/sdk/src/types/data-types.ts:210](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L210) *** ### fields[​](#fields "Direct link to fields") > **fields**: [`DataField`](https://docs.gravityrail.com/sdk/interfaces/DataField.md)\[] Defined in: [packages/sdk/src/types/data-types.ts:209](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L209) *** ### id[​](#id "Direct link to id") > **id**: `number` Defined in: [packages/sdk/src/types/data-types.ts:206](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L206) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/data-types.ts:208](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L208) *** ### slug[​](#slug "Direct link to slug") > **slug**: `string` Defined in: [packages/sdk/src/types/data-types.ts:207](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L207) *** ### updatedAt[​](#updatedat "Direct link to updatedAt") > **updatedAt**: `string` Defined in: [packages/sdk/src/types/data-types.ts:211](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L211) --- # Interface: DataTypeFormData Defined in: [packages/sdk/src/types/data-types.ts:146](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L146) ## Properties[​](#properties "Direct link to Properties") ### categories?[​](#categories "Direct link to categories?") > `optional` **categories**: [`DataCategory`](https://docs.gravityrail.com/sdk/enumerations/DataCategory.md)\[] Defined in: [packages/sdk/src/types/data-types.ts:154](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L154) *** ### createRules?[​](#createrules "Direct link to createRules?") > `optional` **createRules**: [`EventRuleInput`](https://docs.gravityrail.com/sdk/interfaces/EventRuleInput.md)\[] Defined in: [packages/sdk/src/types/data-types.ts:159](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L159) *** ### description?[​](#description "Direct link to description?") > `optional` **description**: `string` Defined in: [packages/sdk/src/types/data-types.ts:149](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L149) *** ### ~~eventRules?~~[​](#eventrules "Direct link to eventrules") > `optional` **eventRules**: [`EventRuleInput`](https://docs.gravityrail.com/sdk/interfaces/EventRuleInput.md)\[] Defined in: [packages/sdk/src/types/data-types.ts:162](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L162) #### Deprecated[​](#deprecated "Direct link to Deprecated") use createRules/updateRules; kept for backward compatibility with form state *** ### fields?[​](#fields "Direct link to fields?") > `optional` **fields**: [`DataFieldFormData`](https://docs.gravityrail.com/sdk/interfaces/DataFieldFormData.md)\[] Defined in: [packages/sdk/src/types/data-types.ts:155](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L155) *** ### isCollection?[​](#iscollection "Direct link to isCollection?") > `optional` **isCollection**: `boolean` Defined in: [packages/sdk/src/types/data-types.ts:151](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L151) *** ### memberRoleAccess?[​](#memberroleaccess "Direct link to memberRoleAccess?") > `optional` **memberRoleAccess**: [`DataTypeMemberRoleAccessInput`](https://docs.gravityrail.com/sdk/interfaces/DataTypeMemberRoleAccessInput.md)\[] Defined in: [packages/sdk/src/types/data-types.ts:156](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L156) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/data-types.ts:147](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L147) *** ### ownerId?[​](#ownerid "Direct link to ownerId?") > `optional` **ownerId**: `number` | `null` Defined in: [packages/sdk/src/types/data-types.ts:158](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L158) *** ### pinned?[​](#pinned "Direct link to pinned?") > `optional` **pinned**: `boolean` Defined in: [packages/sdk/src/types/data-types.ts:157](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L157) *** ### prompt?[​](#prompt "Direct link to prompt?") > `optional` **prompt**: `string` Defined in: [packages/sdk/src/types/data-types.ts:150](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L150) *** ### recordScope?[​](#recordscope "Direct link to recordScope?") > `optional` **recordScope**: [`DataTypeRecordScope`](https://docs.gravityrail.com/sdk/enumerations/DataTypeRecordScope.md) Defined in: [packages/sdk/src/types/data-types.ts:152](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L152) *** ### sensitivity?[​](#sensitivity "Direct link to sensitivity?") > `optional` **sensitivity**: [`DataSensitivity`](https://docs.gravityrail.com/sdk/enumerations/DataSensitivity.md) Defined in: [packages/sdk/src/types/data-types.ts:153](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L153) *** ### slug?[​](#slug "Direct link to slug?") > `optional` **slug**: `string` Defined in: [packages/sdk/src/types/data-types.ts:148](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L148) *** ### updateRules?[​](#updaterules "Direct link to updateRules?") > `optional` **updateRules**: [`EventRuleInput`](https://docs.gravityrail.com/sdk/interfaces/EventRuleInput.md)\[] Defined in: [packages/sdk/src/types/data-types.ts:160](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L160) --- # Interface: DataTypeMemberRoleAccessInput Defined in: [packages/sdk/src/types/data-types.ts:172](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L172) ## Properties[​](#properties "Direct link to Properties") ### accessMode[​](#accessmode "Direct link to accessMode") > **accessMode**: `number` Defined in: [packages/sdk/src/types/data-types.ts:174](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L174) *** ### memberRoleId[​](#memberroleid "Direct link to memberRoleId") > **memberRoleId**: `number` Defined in: [packages/sdk/src/types/data-types.ts:173](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L173) --- # Interface: DataTypeMemberRoleAccessResponse Defined in: [packages/sdk/src/types/generated/data.ts:116](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/data.ts#L116) ## Properties[​](#properties "Direct link to Properties") ### accessMode[​](#accessmode "Direct link to accessMode") > **accessMode**: `number` Defined in: [packages/sdk/src/types/generated/data.ts:119](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/data.ts#L119) *** ### memberRoleId[​](#memberroleid "Direct link to memberRoleId") > **memberRoleId**: `number` Defined in: [packages/sdk/src/types/generated/data.ts:117](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/data.ts#L117) *** ### memberRoleName[​](#memberrolename "Direct link to memberRoleName") > **memberRoleName**: `string` Defined in: [packages/sdk/src/types/generated/data.ts:118](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/data.ts#L118) --- # Interface: DataTypeResponse Defined in: [packages/sdk/src/types/generated/data.ts:122](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/data.ts#L122) ## Properties[​](#properties "Direct link to Properties") ### accessMode?[​](#accessmode "Direct link to accessMode?") > `optional` **accessMode**: `number` | `null` Defined in: [packages/sdk/src/types/generated/data.ts:127](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/data.ts#L127) *** ### archived?[​](#archived "Direct link to archived?") > `optional` **archived**: `boolean` Defined in: [packages/sdk/src/types/generated/data.ts:132](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/data.ts#L132) *** ### categories[​](#categories "Direct link to categories") > **categories**: `string`\[] Defined in: [packages/sdk/src/types/generated/data.ts:136](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/data.ts#L136) *** ### createdAt[​](#createdat "Direct link to createdAt") > **createdAt**: `string` Defined in: [packages/sdk/src/types/generated/data.ts:137](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/data.ts#L137) *** ### createRules[​](#createrules "Direct link to createRules") > **createRules**: `EventRuleResponse`\[] Defined in: [packages/sdk/src/types/generated/data.ts:139](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/data.ts#L139) *** ### description[​](#description "Direct link to description") > **description**: `string` | `null` Defined in: [packages/sdk/src/types/generated/data.ts:128](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/data.ts#L128) *** ### fields[​](#fields "Direct link to fields") > **fields**: [`SchemaField`](https://docs.gravityrail.com/sdk/interfaces/SchemaField.md)\[] Defined in: [packages/sdk/src/types/generated/data.ts:141](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/data.ts#L141) *** ### id[​](#id "Direct link to id") > **id**: `number` Defined in: [packages/sdk/src/types/generated/data.ts:123](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/data.ts#L123) *** ### isCollection[​](#iscollection "Direct link to isCollection") > **isCollection**: `boolean` Defined in: [packages/sdk/src/types/generated/data.ts:130](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/data.ts#L130) *** ### memberRoleAccess?[​](#memberroleaccess "Direct link to memberRoleAccess?") > `optional` **memberRoleAccess**: [`DataTypeMemberRoleAccessResponse`](https://docs.gravityrail.com/sdk/interfaces/DataTypeMemberRoleAccessResponse.md)\[] Defined in: [packages/sdk/src/types/generated/data.ts:142](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/data.ts#L142) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/generated/data.ts:124](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/data.ts#L124) *** ### ownerId?[​](#ownerid "Direct link to ownerId?") > `optional` **ownerId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/data.ts:133](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/data.ts#L133) *** ### pinned?[​](#pinned "Direct link to pinned?") > `optional` **pinned**: `boolean` | `null` Defined in: [packages/sdk/src/types/generated/data.ts:131](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/data.ts#L131) *** ### prompt[​](#prompt "Direct link to prompt") > **prompt**: `string` | `null` Defined in: [packages/sdk/src/types/generated/data.ts:129](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/data.ts#L129) *** ### recordCount?[​](#recordcount "Direct link to recordCount?") > `optional` **recordCount**: `number` | `null` Defined in: [packages/sdk/src/types/generated/data.ts:143](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/data.ts#L143) *** ### recordScope[​](#recordscope "Direct link to recordScope") > **recordScope**: `string` Defined in: [packages/sdk/src/types/generated/data.ts:134](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/data.ts#L134) *** ### sensitivity[​](#sensitivity "Direct link to sensitivity") > **sensitivity**: `string` Defined in: [packages/sdk/src/types/generated/data.ts:135](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/data.ts#L135) *** ### slug[​](#slug "Direct link to slug") > **slug**: `string` Defined in: [packages/sdk/src/types/generated/data.ts:126](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/data.ts#L126) *** ### updatedAt[​](#updatedat "Direct link to updatedAt") > **updatedAt**: `string` Defined in: [packages/sdk/src/types/generated/data.ts:138](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/data.ts#L138) *** ### updateRules[​](#updaterules "Direct link to updateRules") > **updateRules**: `EventRuleResponse`\[] Defined in: [packages/sdk/src/types/generated/data.ts:140](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/data.ts#L140) *** ### uuid[​](#uuid "Direct link to uuid") > **uuid**: `string` Defined in: [packages/sdk/src/types/generated/data.ts:125](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/data.ts#L125) --- # Interface: DayAggregatedData Defined in: [packages/sdk/src/api/reports.ts:72](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/reports.ts#L72) Frontend aggregation of SMSUsageRow entries by day. ## Properties[​](#properties "Direct link to Properties") ### date[​](#date "Direct link to date") > **date**: `string` Defined in: [packages/sdk/src/api/reports.ts:73](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/reports.ts#L73) *** ### inbound[​](#inbound "Direct link to inbound") > **inbound**: `number` Defined in: [packages/sdk/src/api/reports.ts:75](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/reports.ts#L75) *** ### outbound[​](#outbound "Direct link to outbound") > **outbound**: `number` Defined in: [packages/sdk/src/api/reports.ts:76](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/reports.ts#L76) *** ### totalChars[​](#totalchars "Direct link to totalChars") > **totalChars**: `number` Defined in: [packages/sdk/src/api/reports.ts:77](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/reports.ts#L77) *** ### totalMessages[​](#totalmessages "Direct link to totalMessages") > **totalMessages**: `number` Defined in: [packages/sdk/src/api/reports.ts:74](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/reports.ts#L74) *** ### totalSegments[​](#totalsegments "Direct link to totalSegments") > **totalSegments**: `number` Defined in: [packages/sdk/src/api/reports.ts:78](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/reports.ts#L78) --- # Interface: DayCallAggregatedData Defined in: [packages/sdk/src/api/reports.ts:93](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/reports.ts#L93) Frontend aggregation of PhoneUsageRow entries by day. ## Properties[​](#properties "Direct link to Properties") ### date[​](#date "Direct link to date") > **date**: `string` Defined in: [packages/sdk/src/api/reports.ts:94](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/reports.ts#L94) *** ### inbound[​](#inbound "Direct link to inbound") > **inbound**: `number` Defined in: [packages/sdk/src/api/reports.ts:96](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/reports.ts#L96) *** ### outbound[​](#outbound "Direct link to outbound") > **outbound**: `number` Defined in: [packages/sdk/src/api/reports.ts:97](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/reports.ts#L97) *** ### totalCalls[​](#totalcalls "Direct link to totalCalls") > **totalCalls**: `number` Defined in: [packages/sdk/src/api/reports.ts:95](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/reports.ts#L95) *** ### totalDurationSeconds[​](#totaldurationseconds "Direct link to totalDurationSeconds") > **totalDurationSeconds**: `number` Defined in: [packages/sdk/src/api/reports.ts:98](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/reports.ts#L98) --- # Interface: DeleteAccountOrgMembershipResponse Defined in: [packages/sdk/src/types/account-types.ts:466](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L466) ## Properties[​](#properties "Direct link to Properties") ### message[​](#message "Direct link to message") > **message**: `string` Defined in: [packages/sdk/src/types/account-types.ts:468](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L468) *** ### status[​](#status "Direct link to status") > **status**: `string` Defined in: [packages/sdk/src/types/account-types.ts:467](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L467) *** ### workspaceMembershipsRemoved[​](#workspacemembershipsremoved "Direct link to workspaceMembershipsRemoved") > **workspaceMembershipsRemoved**: `number` Defined in: [packages/sdk/src/types/account-types.ts:469](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L469) --- # Interface: DetailedAccount Defined in: [packages/sdk/src/types/account-types.ts:88](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L88) ## Extends[​](#extends "Direct link to Extends") * `AdminAccountResponse` ## Properties[​](#properties "Direct link to Properties") ### avatarUrl[​](#avatarurl "Direct link to avatarUrl") > **avatarUrl**: `string` | `null` Defined in: [packages/sdk/src/types/generated/account.ts:70](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L70) #### Inherited from[​](#inherited-from "Direct link to Inherited from") `AdminAccountResponse.avatarUrl` *** ### createdAt[​](#createdat "Direct link to createdAt") > **createdAt**: `string` Defined in: [packages/sdk/src/types/generated/account.ts:76](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L76) #### Inherited from[​](#inherited-from-1 "Direct link to Inherited from") `AdminAccountResponse.createdAt` *** ### customerId?[​](#customerid "Direct link to customerId?") > `optional` **customerId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/account.ts:86](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L86) #### Inherited from[​](#inherited-from-2 "Direct link to Inherited from") `AdminAccountResponse.customerId` *** ### customerName?[​](#customername "Direct link to customerName?") > `optional` **customerName**: `string` | `null` Defined in: [packages/sdk/src/types/generated/account.ts:87](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L87) #### Inherited from[​](#inherited-from-3 "Direct link to Inherited from") `AdminAccountResponse.customerName` *** ### deletionRequestedAt?[​](#deletionrequestedat "Direct link to deletionRequestedAt?") > `optional` **deletionRequestedAt**: `string` | `null` Defined in: [packages/sdk/src/types/generated/account.ts:89](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L89) #### Inherited from[​](#inherited-from-4 "Direct link to Inherited from") `AdminAccountResponse.deletionRequestedAt` *** ### email[​](#email "Direct link to email") > **email**: `string` | `null` Defined in: [packages/sdk/src/types/generated/account.ts:71](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L71) #### Inherited from[​](#inherited-from-5 "Direct link to Inherited from") `AdminAccountResponse.email` *** ### emailVerifiedAt[​](#emailverifiedat "Direct link to emailVerifiedAt") > **emailVerifiedAt**: `string` | `null` Defined in: [packages/sdk/src/types/generated/account.ts:73](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L73) #### Inherited from[​](#inherited-from-6 "Direct link to Inherited from") `AdminAccountResponse.emailVerifiedAt` *** ### enabled[​](#enabled "Direct link to enabled") > **enabled**: `boolean` Defined in: [packages/sdk/src/types/generated/account.ts:78](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L78) #### Inherited from[​](#inherited-from-7 "Direct link to Inherited from") `AdminAccountResponse.enabled` *** ### id[​](#id "Direct link to id") > **id**: `number` Defined in: [packages/sdk/src/types/generated/account.ts:67](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L67) #### Inherited from[​](#inherited-from-8 "Direct link to Inherited from") `AdminAccountResponse.id` *** ### isSuperuser[​](#issuperuser "Direct link to isSuperuser") > **isSuperuser**: `boolean` Defined in: [packages/sdk/src/types/generated/account.ts:77](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L77) #### Inherited from[​](#inherited-from-9 "Direct link to Inherited from") `AdminAccountResponse.isSuperuser` *** ### locale[​](#locale "Direct link to locale") > **locale**: `string` | `null` Defined in: [packages/sdk/src/types/generated/account.ts:83](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L83) #### Inherited from[​](#inherited-from-10 "Direct link to Inherited from") `AdminAccountResponse.locale` *** ### loggedIn[​](#loggedin "Direct link to loggedIn") > **loggedIn**: `boolean` Defined in: [packages/sdk/src/types/generated/account.ts:69](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L69) #### Inherited from[​](#inherited-from-11 "Direct link to Inherited from") `AdminAccountResponse.loggedIn` *** ### name[​](#name "Direct link to name") > **name**: `string` | `null` Defined in: [packages/sdk/src/types/generated/account.ts:75](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L75) #### Inherited from[​](#inherited-from-12 "Direct link to Inherited from") `AdminAccountResponse.name` *** ### optedOut[​](#optedout "Direct link to optedOut") > **optedOut**: `boolean` Defined in: [packages/sdk/src/types/generated/account.ts:81](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L81) #### Inherited from[​](#inherited-from-13 "Direct link to Inherited from") `AdminAccountResponse.optedOut` *** ### pendingDeletion?[​](#pendingdeletion "Direct link to pendingDeletion?") > `optional` **pendingDeletion**: `boolean` Defined in: [packages/sdk/src/types/generated/account.ts:88](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L88) #### Inherited from[​](#inherited-from-14 "Direct link to Inherited from") `AdminAccountResponse.pendingDeletion` *** ### phone[​](#phone "Direct link to phone") > **phone**: `string` | `null` Defined in: [packages/sdk/src/types/generated/account.ts:72](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L72) #### Inherited from[​](#inherited-from-15 "Direct link to Inherited from") `AdminAccountResponse.phone` *** ### phoneVerifiedAt[​](#phoneverifiedat "Direct link to phoneVerifiedAt") > **phoneVerifiedAt**: `string` | `null` Defined in: [packages/sdk/src/types/generated/account.ts:74](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L74) #### Inherited from[​](#inherited-from-16 "Direct link to Inherited from") `AdminAccountResponse.phoneVerifiedAt` *** ### signupWorkspaceId[​](#signupworkspaceid "Direct link to signupWorkspaceId") > **signupWorkspaceId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/account.ts:79](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L79) #### Inherited from[​](#inherited-from-17 "Direct link to Inherited from") `AdminAccountResponse.signupWorkspaceId` *** ### stripeCustomerId[​](#stripecustomerid "Direct link to stripeCustomerId") > **stripeCustomerId**: `string` | `null` Defined in: [packages/sdk/src/types/generated/account.ts:82](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L82) #### Inherited from[​](#inherited-from-18 "Direct link to Inherited from") `AdminAccountResponse.stripeCustomerId` *** ### timezone[​](#timezone "Direct link to timezone") > **timezone**: `string` | `null` Defined in: [packages/sdk/src/types/generated/account.ts:84](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L84) #### Inherited from[​](#inherited-from-19 "Direct link to Inherited from") `AdminAccountResponse.timezone` *** ### tosAccepted[​](#tosaccepted "Direct link to tosAccepted") > **tosAccepted**: `boolean` Defined in: [packages/sdk/src/types/generated/account.ts:80](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L80) #### Inherited from[​](#inherited-from-20 "Direct link to Inherited from") `AdminAccountResponse.tosAccepted` *** ### uuid[​](#uuid "Direct link to uuid") > **uuid**: `string` Defined in: [packages/sdk/src/types/generated/account.ts:68](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L68) #### Inherited from[​](#inherited-from-21 "Direct link to Inherited from") `AdminAccountResponse.uuid` *** ### workspaceUuids[​](#workspaceuuids "Direct link to workspaceUuids") > **workspaceUuids**: `string`\[] Defined in: [packages/sdk/src/types/generated/account.ts:85](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L85) #### Inherited from[​](#inherited-from-22 "Direct link to Inherited from") `AdminAccountResponse.workspaceUuids` --- # Interface: DiscordBotAccount Defined in: [packages/sdk/src/types/discord-bot-types.ts:136](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/discord-bot-types.ts#L136) Discord account link for a specific bot. Maps a workspace member to their Discord account. ## Properties[​](#properties "Direct link to Properties") ### connectedAt[​](#connectedat "Direct link to connectedAt") > **connectedAt**: `string` | `null` Defined in: [packages/sdk/src/types/discord-bot-types.ts:145](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/discord-bot-types.ts#L145) *** ### discordEmail[​](#discordemail "Direct link to discordEmail") > **discordEmail**: `string` | `null` Defined in: [packages/sdk/src/types/discord-bot-types.ts:143](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/discord-bot-types.ts#L143) *** ### discordUserId[​](#discorduserid "Direct link to discordUserId") > **discordUserId**: `string` Defined in: [packages/sdk/src/types/discord-bot-types.ts:141](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/discord-bot-types.ts#L141) *** ### discordUsername[​](#discordusername "Direct link to discordUsername") > **discordUsername**: `string` | `null` Defined in: [packages/sdk/src/types/discord-bot-types.ts:142](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/discord-bot-types.ts#L142) *** ### emailVerified[​](#emailverified "Direct link to emailVerified") > **emailVerified**: `boolean` Defined in: [packages/sdk/src/types/discord-bot-types.ts:144](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/discord-bot-types.ts#L144) *** ### id[​](#id "Direct link to id") > **id**: `number` Defined in: [packages/sdk/src/types/discord-bot-types.ts:137](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/discord-bot-types.ts#L137) *** ### lastUsedAt[​](#lastusedat "Direct link to lastUsedAt") > **lastUsedAt**: `string` | `null` Defined in: [packages/sdk/src/types/discord-bot-types.ts:146](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/discord-bot-types.ts#L146) *** ### memberEmail[​](#memberemail "Direct link to memberEmail") > **memberEmail**: `string` | `null` Defined in: [packages/sdk/src/types/discord-bot-types.ts:140](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/discord-bot-types.ts#L140) *** ### memberId[​](#memberid "Direct link to memberId") > **memberId**: `number` Defined in: [packages/sdk/src/types/discord-bot-types.ts:138](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/discord-bot-types.ts#L138) *** ### memberName[​](#membername "Direct link to memberName") > **memberName**: `string` | `null` Defined in: [packages/sdk/src/types/discord-bot-types.ts:139](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/discord-bot-types.ts#L139) --- # Interface: DiscordGuild Defined in: [packages/sdk/src/types/discord-bot-types.ts:123](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/discord-bot-types.ts#L123) Discord guild (server) derived from thread history. ## Properties[​](#properties "Direct link to Properties") ### guildId[​](#guildid "Direct link to guildId") > **guildId**: `string` Defined in: [packages/sdk/src/types/discord-bot-types.ts:125](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/discord-bot-types.ts#L125) Discord guild/server ID *** ### lastActivityAt[​](#lastactivityat "Direct link to lastActivityAt") > **lastActivityAt**: `string` Defined in: [packages/sdk/src/types/discord-bot-types.ts:129](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/discord-bot-types.ts#L129) Timestamp of the most recent activity *** ### threadCount[​](#threadcount "Direct link to threadCount") > **threadCount**: `number` Defined in: [packages/sdk/src/types/discord-bot-types.ts:127](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/discord-bot-types.ts#L127) Number of threads in this guild --- # Interface: DiscordThread Defined in: [packages/sdk/src/types/discord-bot-types.ts:93](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/discord-bot-types.ts#L93) Discord thread linked to a Gravity Rail chat. ## Properties[​](#properties "Direct link to Properties") ### chatId[​](#chatid "Direct link to chatId") > **chatId**: `number` Defined in: [packages/sdk/src/types/discord-bot-types.ts:95](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/discord-bot-types.ts#L95) *** ### chatTitle[​](#chattitle "Direct link to chatTitle") > **chatTitle**: `string` | `null` Defined in: [packages/sdk/src/types/discord-bot-types.ts:97](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/discord-bot-types.ts#L97) Title of the linked chat *** ### createdAt[​](#createdat "Direct link to createdAt") > **createdAt**: `string` Defined in: [packages/sdk/src/types/discord-bot-types.ts:109](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/discord-bot-types.ts#L109) *** ### currentTaskName[​](#currenttaskname "Direct link to currentTaskName") > **currentTaskName**: `string` | `null` Defined in: [packages/sdk/src/types/discord-bot-types.ts:107](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/discord-bot-types.ts#L107) Name of the current task in this thread *** ### discordBotId[​](#discordbotid "Direct link to discordBotId") > **discordBotId**: `number` Defined in: [packages/sdk/src/types/discord-bot-types.ts:98](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/discord-bot-types.ts#L98) *** ### discordChannelId[​](#discordchannelid "Direct link to discordChannelId") > **discordChannelId**: `string` Defined in: [packages/sdk/src/types/discord-bot-types.ts:100](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/discord-bot-types.ts#L100) *** ### discordGuildId[​](#discordguildid "Direct link to discordGuildId") > **discordGuildId**: `string` | `null` Defined in: [packages/sdk/src/types/discord-bot-types.ts:99](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/discord-bot-types.ts#L99) *** ### discordThreadId[​](#discordthreadid "Direct link to discordThreadId") > **discordThreadId**: `string` Defined in: [packages/sdk/src/types/discord-bot-types.ts:101](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/discord-bot-types.ts#L101) *** ### discordUserId[​](#discorduserid "Direct link to discordUserId") > **discordUserId**: `string` | `null` Defined in: [packages/sdk/src/types/discord-bot-types.ts:102](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/discord-bot-types.ts#L102) *** ### id[​](#id "Direct link to id") > **id**: `number` Defined in: [packages/sdk/src/types/discord-bot-types.ts:94](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/discord-bot-types.ts#L94) *** ### isDm[​](#isdm "Direct link to isDm") > **isDm**: `boolean` Defined in: [packages/sdk/src/types/discord-bot-types.ts:108](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/discord-bot-types.ts#L108) *** ### workflowId[​](#workflowid "Direct link to workflowId") > **workflowId**: `number` | `null` Defined in: [packages/sdk/src/types/discord-bot-types.ts:103](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/discord-bot-types.ts#L103) *** ### workflowName[​](#workflowname "Direct link to workflowName") > **workflowName**: `string` | `null` Defined in: [packages/sdk/src/types/discord-bot-types.ts:105](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/discord-bot-types.ts#L105) Name of the workflow handling this thread --- # Interface: DisplayFileLabelResponse Defined in: [packages/sdk/src/types/file-types.ts:192](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/file-types.ts#L192) ## Properties[​](#properties "Direct link to Properties") ### color?[​](#color "Direct link to color?") > `optional` **color**: `string` | `null` Defined in: [packages/sdk/src/types/file-types.ts:195](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/file-types.ts#L195) *** ### id[​](#id "Direct link to id") > **id**: `number` Defined in: [packages/sdk/src/types/file-types.ts:193](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/file-types.ts#L193) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/file-types.ts:194](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/file-types.ts#L194) --- # Interface: DisplayFileResponse Defined in: [packages/sdk/src/types/file-types.ts:198](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/file-types.ts#L198) ## Properties[​](#properties "Direct link to Properties") ### access[​](#access "Direct link to access") > **access**: `string` Defined in: [packages/sdk/src/types/file-types.ts:209](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/file-types.ts#L209) *** ### cdnUrl[​](#cdnurl "Direct link to cdnUrl") > **cdnUrl**: `string` Defined in: [packages/sdk/src/types/file-types.ts:202](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/file-types.ts#L202) *** ### createdAt[​](#createdat "Direct link to createdAt") > **createdAt**: `string` Defined in: [packages/sdk/src/types/file-types.ts:210](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/file-types.ts#L210) *** ### externalId?[​](#externalid "Direct link to externalId?") > `optional` **externalId**: `string` | `null` Defined in: [packages/sdk/src/types/file-types.ts:206](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/file-types.ts#L206) *** ### filename[​](#filename "Direct link to filename") > **filename**: `string` Defined in: [packages/sdk/src/types/file-types.ts:201](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/file-types.ts#L201) *** ### id[​](#id "Direct link to id") > **id**: `number` Defined in: [packages/sdk/src/types/file-types.ts:199](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/file-types.ts#L199) *** ### labels[​](#labels "Direct link to labels") > **labels**: [`DisplayFileLabelResponse`](https://docs.gravityrail.com/sdk/interfaces/DisplayFileLabelResponse.md)\[] Defined in: [packages/sdk/src/types/file-types.ts:212](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/file-types.ts#L212) *** ### mimeType[​](#mimetype "Direct link to mimeType") > **mimeType**: `string` Defined in: [packages/sdk/src/types/file-types.ts:205](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/file-types.ts#L205) *** ### ownerId?[​](#ownerid "Direct link to ownerId?") > `optional` **ownerId**: `number` | `null` Defined in: [packages/sdk/src/types/file-types.ts:208](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/file-types.ts#L208) *** ### ownerName?[​](#ownername "Direct link to ownerName?") > `optional` **ownerName**: `string` | `null` Defined in: [packages/sdk/src/types/file-types.ts:207](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/file-types.ts#L207) *** ### title[​](#title "Direct link to title") > **title**: `string` Defined in: [packages/sdk/src/types/file-types.ts:200](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/file-types.ts#L200) *** ### updatedAt[​](#updatedat "Direct link to updatedAt") > **updatedAt**: `string` Defined in: [packages/sdk/src/types/file-types.ts:211](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/file-types.ts#L211) *** ### workspaceUuid[​](#workspaceuuid "Direct link to workspaceUuid") > **workspaceUuid**: `string` Defined in: [packages/sdk/src/types/file-types.ts:204](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/file-types.ts#L204) UUID of the workspace that owns this file. --- # Interface: DomainMapping Defined in: [packages/sdk/src/types/communication-types.ts:251](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/communication-types.ts#L251) ## Properties[​](#properties "Direct link to Properties") ### primaryLocale[​](#primarylocale "Direct link to primaryLocale") > **primaryLocale**: `string` Defined in: [packages/sdk/src/types/communication-types.ts:255](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/communication-types.ts#L255) *** ### siteUuid[​](#siteuuid "Direct link to siteUuid") > **siteUuid**: `string` Defined in: [packages/sdk/src/types/communication-types.ts:253](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/communication-types.ts#L253) *** ### theme[​](#theme "Direct link to theme") > **theme**: `string` Defined in: [packages/sdk/src/types/communication-types.ts:254](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/communication-types.ts#L254) *** ### wid[​](#wid "Direct link to wid") > **wid**: `string` Defined in: [packages/sdk/src/types/communication-types.ts:252](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/communication-types.ts#L252) --- # Interface: DuplicateAccountInfo Defined in: [packages/sdk/src/types/account-types.ts:349](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L349) ## Properties[​](#properties "Direct link to Properties") ### createdAt[​](#createdat "Direct link to createdAt") > **createdAt**: `string` Defined in: [packages/sdk/src/types/account-types.ts:356](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L356) *** ### email[​](#email "Direct link to email") > **email**: `string` | `null` Defined in: [packages/sdk/src/types/account-types.ts:352](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L352) *** ### id[​](#id "Direct link to id") > **id**: `number` Defined in: [packages/sdk/src/types/account-types.ts:350](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L350) *** ### name[​](#name "Direct link to name") > **name**: `string` | `null` Defined in: [packages/sdk/src/types/account-types.ts:351](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L351) *** ### organizationId[​](#organizationid "Direct link to organizationId") > **organizationId**: `number` | `null` Defined in: [packages/sdk/src/types/account-types.ts:354](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L354) *** ### organizationName[​](#organizationname "Direct link to organizationName") > **organizationName**: `string` | `null` Defined in: [packages/sdk/src/types/account-types.ts:355](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L355) *** ### phone[​](#phone "Direct link to phone") > **phone**: `string` | `null` Defined in: [packages/sdk/src/types/account-types.ts:353](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L353) --- # Interface: EcwRefreshMemberEncountersActionParams Defined in: [packages/sdk/src/types/event-types.ts:377](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L377) Parameters for the ecw:refresh\_member\_encounters action. Refreshes the local eCW encounter cache for the target member before later actions (such as phone:call) run in the same rule chain. ## Properties[​](#properties "Direct link to Properties") ### connectionId[​](#connectionid "Direct link to connectionId") > **connectionId**: `number` Defined in: [packages/sdk/src/types/event-types.ts:379](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L379) ID of the eCW FHIR connection whose encounter cache should be refreshed. *** ### haltOnFailure?[​](#haltonfailure "Direct link to haltOnFailure?") > `optional` **haltOnFailure**: `boolean` Defined in: [packages/sdk/src/types/event-types.ts:388](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L388) When true (default), a refresh failure raises a non-retryable action error so later rules in the same chain do not run. Set to false only when a time-critical outreach must proceed with stale cache on refresh failure. *** ### lookbackDays?[​](#lookbackdays "Direct link to lookbackDays?") > `optional` **lookbackDays**: `number` Defined in: [packages/sdk/src/types/event-types.ts:381](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L381) Days of encounter history to pull on this refresh. Defaults to 30. --- # Interface: EfficiencyMetricsResponse Defined in: [packages/sdk/src/types/generated/usage.ts:72](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/usage.ts#L72) Efficiency metrics summary. ## Properties[​](#properties "Direct link to Properties") ### averageUtilizationRate[​](#averageutilizationrate "Direct link to averageUtilizationRate") > **averageUtilizationRate**: `number` Defined in: [packages/sdk/src/types/generated/usage.ts:74](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/usage.ts#L74) *** ### workspacesOverBudget[​](#workspacesoverbudget "Direct link to workspacesOverBudget") > **workspacesOverBudget**: `number` Defined in: [packages/sdk/src/types/generated/usage.ts:73](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/usage.ts#L73) --- # Interface: Email Defined in: [packages/sdk/src/types/generated/communication.ts:180](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L180) Response model for an email. ## Properties[​](#properties "Direct link to Properties") ### attachments?[​](#attachments "Direct link to attachments?") > `optional` **attachments**: [`EmailAttachment`](https://docs.gravityrail.com/sdk/interfaces/EmailAttachment.md)\[] | `null` Defined in: [packages/sdk/src/types/generated/communication.ts:199](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L199) *** ### bcc?[​](#bcc "Direct link to bcc?") > `optional` **bcc**: `string` | `null` Defined in: [packages/sdk/src/types/generated/communication.ts:188](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L188) *** ### bodyHtml?[​](#bodyhtml "Direct link to bodyHtml?") > `optional` **bodyHtml**: `string` | `null` Defined in: [packages/sdk/src/types/generated/communication.ts:191](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L191) *** ### bodyText?[​](#bodytext "Direct link to bodyText?") > `optional` **bodyText**: `string` | `null` Defined in: [packages/sdk/src/types/generated/communication.ts:190](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L190) *** ### cc?[​](#cc "Direct link to cc?") > `optional` **cc**: `string` | `null` Defined in: [packages/sdk/src/types/generated/communication.ts:187](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L187) *** ### createdAt[​](#createdat "Direct link to createdAt") > **createdAt**: `string` Defined in: [packages/sdk/src/types/generated/communication.ts:194](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L194) *** ### id[​](#id "Direct link to id") > **id**: `number` Defined in: [packages/sdk/src/types/generated/communication.ts:181](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L181) *** ### inboxId[​](#inboxid "Direct link to inboxId") > **inboxId**: `number` Defined in: [packages/sdk/src/types/generated/communication.ts:183](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L183) *** ### messageId[​](#messageid "Direct link to messageId") > **messageId**: `string` Defined in: [packages/sdk/src/types/generated/communication.ts:184](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L184) *** ### rawHeaders?[​](#rawheaders "Direct link to rawHeaders?") > `optional` **rawHeaders**: `EmailResponseRawHeaders` Defined in: [packages/sdk/src/types/generated/communication.ts:198](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L198) *** ### readAt?[​](#readat "Direct link to readAt?") > `optional` **readAt**: `string` | `null` Defined in: [packages/sdk/src/types/generated/communication.ts:196](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L196) *** ### recipient[​](#recipient "Direct link to recipient") > **recipient**: `string` Defined in: [packages/sdk/src/types/generated/communication.ts:186](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L186) *** ### repliedAt?[​](#repliedat "Direct link to repliedAt?") > `optional` **repliedAt**: `string` | `null` Defined in: [packages/sdk/src/types/generated/communication.ts:197](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L197) *** ### s3Key?[​](#s3key "Direct link to s3Key?") > `optional` **s3Key**: `string` | `null` Defined in: [packages/sdk/src/types/generated/communication.ts:192](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L192) *** ### sender[​](#sender "Direct link to sender") > **sender**: `string` Defined in: [packages/sdk/src/types/generated/communication.ts:185](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L185) *** ### status[​](#status "Direct link to status") > **status**: `string` Defined in: [packages/sdk/src/types/generated/communication.ts:193](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L193) *** ### subject?[​](#subject "Direct link to subject?") > `optional` **subject**: `string` | `null` Defined in: [packages/sdk/src/types/generated/communication.ts:189](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L189) *** ### updatedAt[​](#updatedat "Direct link to updatedAt") > **updatedAt**: `string` Defined in: [packages/sdk/src/types/generated/communication.ts:195](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L195) *** ### uuid[​](#uuid "Direct link to uuid") > **uuid**: `string` Defined in: [packages/sdk/src/types/generated/communication.ts:182](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L182) --- # Interface: EmailAttachment Defined in: [packages/sdk/src/types/generated/communication.ts:154](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L154) Response model for an email attachment. ## Properties[​](#properties "Direct link to Properties") ### contentId?[​](#contentid "Direct link to contentId?") > `optional` **contentId**: `string` | `null` Defined in: [packages/sdk/src/types/generated/communication.ts:161](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L161) *** ### contentType[​](#contenttype "Direct link to contentType") > **contentType**: `string` Defined in: [packages/sdk/src/types/generated/communication.ts:158](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L158) *** ### createdAt[​](#createdat "Direct link to createdAt") > **createdAt**: `string` Defined in: [packages/sdk/src/types/generated/communication.ts:163](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L163) *** ### filename[​](#filename "Direct link to filename") > **filename**: `string` Defined in: [packages/sdk/src/types/generated/communication.ts:157](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L157) *** ### id[​](#id "Direct link to id") > **id**: `number` Defined in: [packages/sdk/src/types/generated/communication.ts:155](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L155) *** ### isInline?[​](#isinline "Direct link to isInline?") > `optional` **isInline**: `boolean` | `null` Defined in: [packages/sdk/src/types/generated/communication.ts:162](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L162) *** ### s3Key[​](#s3key "Direct link to s3Key") > **s3Key**: `string` Defined in: [packages/sdk/src/types/generated/communication.ts:159](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L159) *** ### size?[​](#size "Direct link to size?") > `optional` **size**: `number` | `null` Defined in: [packages/sdk/src/types/generated/communication.ts:160](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L160) *** ### uuid[​](#uuid "Direct link to uuid") > **uuid**: `string` Defined in: [packages/sdk/src/types/generated/communication.ts:156](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L156) --- # Interface: EmailConversionResponse Defined in: [packages/sdk/src/types/generated/communication.ts:135](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L135) Response model for email conversion endpoints. ## Properties[​](#properties "Direct link to Properties") ### content[​](#content "Direct link to content") > **content**: `string` Defined in: [packages/sdk/src/types/generated/communication.ts:136](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L136) *** ### format[​](#format "Direct link to format") > **format**: `ConvertedEmailResponseFormat` Defined in: [packages/sdk/src/types/generated/communication.ts:137](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L137) *** ### message[​](#message "Direct link to message") > **message**: `string` Defined in: [packages/sdk/src/types/generated/communication.ts:139](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L139) *** ### subject[​](#subject "Direct link to subject") > **subject**: `string` Defined in: [packages/sdk/src/types/generated/communication.ts:138](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L138) --- # Interface: EmailCountsResponse Defined in: [packages/sdk/src/types/stats-types.ts:12](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/stats-types.ts#L12) ## Properties[​](#properties "Direct link to Properties") ### emailCount?[​](#emailcount "Direct link to emailCount?") > `optional` **emailCount**: `number` Defined in: [packages/sdk/src/types/stats-types.ts:13](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/stats-types.ts#L13) *** ### unreadCount?[​](#unreadcount "Direct link to unreadCount?") > `optional` **unreadCount**: `number` Defined in: [packages/sdk/src/types/stats-types.ts:14](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/stats-types.ts#L14) --- # Interface: EmailDisableImpactResponse Defined in: [packages/sdk/src/types/generated/organization.ts:297](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L297) Inboxes that will lose routing if email is disabled. Returned when DELETE is called without `confirm=true` so the UI can show a clear "this will break N inboxes" warning before destructive action. ## Properties[​](#properties "Direct link to Properties") ### inboxCount[​](#inboxcount "Direct link to inboxCount") > **inboxCount**: `number` Defined in: [packages/sdk/src/types/generated/organization.ts:298](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L298) *** ### inboxEmails[​](#inboxemails "Direct link to inboxEmails") > **inboxEmails**: `string`\[] Defined in: [packages/sdk/src/types/generated/organization.ts:299](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L299) --- # Interface: EmailDomainConfigResponse Defined in: [packages/sdk/src/types/generated/organization.ts:343](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L343) Full picture of an EmailDomainConfig — DNS records + statuses. ## Properties[​](#properties "Direct link to Properties") ### createdAt[​](#createdat "Direct link to createdAt") > **createdAt**: `string` Defined in: [packages/sdk/src/types/generated/organization.ts:354](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L354) *** ### dkimStatus[​](#dkimstatus "Direct link to dkimStatus") > **dkimStatus**: `string` Defined in: [packages/sdk/src/types/generated/organization.ts:349](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L349) *** ### dmarcStatus[​](#dmarcstatus "Direct link to dmarcStatus") > **dmarcStatus**: `string` Defined in: [packages/sdk/src/types/generated/organization.ts:350](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L350) *** ### dnsRecords[​](#dnsrecords "Direct link to dnsRecords") > **dnsRecords**: `EmailDnsRecord`\[] Defined in: [packages/sdk/src/types/generated/organization.ts:356](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L356) *** ### domain[​](#domain "Direct link to domain") > **domain**: `string` Defined in: [packages/sdk/src/types/generated/organization.ts:346](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L346) *** ### lastCheckedAt?[​](#lastcheckedat "Direct link to lastCheckedAt?") > `optional` **lastCheckedAt**: `string` | `null` Defined in: [packages/sdk/src/types/generated/organization.ts:353](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L353) *** ### mxStatus[​](#mxstatus "Direct link to mxStatus") > **mxStatus**: `string` Defined in: [packages/sdk/src/types/generated/organization.ts:351](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L351) *** ### orgDomainUuid[​](#orgdomainuuid "Direct link to orgDomainUuid") > **orgDomainUuid**: `string` Defined in: [packages/sdk/src/types/generated/organization.ts:345](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L345) *** ### returnPathStatus[​](#returnpathstatus "Direct link to returnPathStatus") > **returnPathStatus**: `string` Defined in: [packages/sdk/src/types/generated/organization.ts:352](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L352) *** ### spfStatus[​](#spfstatus "Direct link to spfStatus") > **spfStatus**: `string` Defined in: [packages/sdk/src/types/generated/organization.ts:348](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L348) *** ### status[​](#status "Direct link to status") > **status**: `string` Defined in: [packages/sdk/src/types/generated/organization.ts:347](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L347) *** ### updatedAt[​](#updatedat "Direct link to updatedAt") > **updatedAt**: `string` Defined in: [packages/sdk/src/types/generated/organization.ts:355](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L355) *** ### uuid[​](#uuid "Direct link to uuid") > **uuid**: `string` Defined in: [packages/sdk/src/types/generated/organization.ts:344](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L344) --- # Interface: EmailSendActionParams Defined in: [packages/sdk/src/types/event-types.ts:350](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L350) ## Properties[​](#properties "Direct link to Properties") ### bodyTemplate?[​](#bodytemplate "Direct link to bodyTemplate?") > `optional` **bodyTemplate**: `string` Defined in: [packages/sdk/src/types/event-types.ts:352](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L352) *** ### contentType?[​](#contenttype "Direct link to contentType?") > `optional` **contentType**: `"text"` | `"html"` Defined in: [packages/sdk/src/types/event-types.ts:355](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L355) *** ### inboxUUID[​](#inboxuuid "Direct link to inboxUUID") > **inboxUUID**: `string` Defined in: [packages/sdk/src/types/event-types.ts:353](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L353) *** ### initialUserMessage?[​](#initialusermessage "Direct link to initialUserMessage?") > `optional` **initialUserMessage**: `string` Defined in: [packages/sdk/src/types/event-types.ts:357](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L357) *** ### subjectTemplate?[​](#subjecttemplate "Direct link to subjectTemplate?") > `optional` **subjectTemplate**: `string` Defined in: [packages/sdk/src/types/event-types.ts:351](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L351) *** ### toEmail?[​](#toemail "Direct link to toEmail?") > `optional` **toEmail**: `string` Defined in: [packages/sdk/src/types/event-types.ts:354](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L354) *** ### workflowUUID?[​](#workflowuuid "Direct link to workflowUUID?") > `optional` **workflowUUID**: `string` Defined in: [packages/sdk/src/types/event-types.ts:356](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L356) --- # Interface: EmailUsageResponse Defined in: [packages/sdk/src/types/generated/usage.ts:80](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/usage.ts#L80) Email usage response. ## Properties[​](#properties "Direct link to Properties") ### received[​](#received "Direct link to received") > **received**: `number` Defined in: [packages/sdk/src/types/generated/usage.ts:83](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/usage.ts#L83) *** ### sent[​](#sent "Direct link to sent") > **sent**: `number` Defined in: [packages/sdk/src/types/generated/usage.ts:82](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/usage.ts#L82) *** ### total[​](#total "Direct link to total") > **total**: `number` Defined in: [packages/sdk/src/types/generated/usage.ts:81](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/usage.ts#L81) --- # Interface: EmailVerificationResponse Defined in: [packages/sdk/src/types/generated/organization.ts:362](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L362) Result of running a "Check DNS" pass. ## Properties[​](#properties "Direct link to Properties") ### config[​](#config "Direct link to config") > **config**: [`EmailDomainConfigResponse`](https://docs.gravityrail.com/sdk/interfaces/EmailDomainConfigResponse.md) Defined in: [packages/sdk/src/types/generated/organization.ts:364](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L364) *** ### status[​](#status "Direct link to status") > **status**: `string` Defined in: [packages/sdk/src/types/generated/organization.ts:363](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L363) --- # Interface: EncounterSyncDataTypeSummary Defined in: [packages/sdk/src/types/generated/app\_connection.ts:92](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L92) Thin descriptor for the linked encounter (or observation) form. ## Properties[​](#properties "Direct link to Properties") ### id[​](#id "Direct link to id") > **id**: `number` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:93](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L93) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:96](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L96) *** ### slug[​](#slug "Direct link to slug") > **slug**: `string` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:95](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L95) *** ### uuid[​](#uuid "Direct link to uuid") > **uuid**: `string` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:94](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L94) --- # Interface: EncounterSyncHistoryItem Defined in: [packages/sdk/src/types/fhir-connection-types.ts:360](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L360) PHI-safe encounter sync run history row. Derived from the shared `sync_runs` DynamoDB table filtered to encounter-sync rows. Counts and sanitized reason codes only — never patient names, encounter content, or other PHI. ## Properties[​](#properties "Direct link to Properties") ### completedAt?[​](#completedat "Direct link to completedAt?") > `optional` **completedAt**: `string` | `null` Defined in: [packages/sdk/src/types/fhir-connection-types.ts:363](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L363) *** ### errorMessage?[​](#errormessage "Direct link to errorMessage?") > `optional` **errorMessage**: `string` | `null` Defined in: [packages/sdk/src/types/fhir-connection-types.ts:377](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L377) *** ### errors[​](#errors "Direct link to errors") > **errors**: `string`\[] Defined in: [packages/sdk/src/types/fhir-connection-types.ts:378](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L378) *** ### failed[​](#failed "Direct link to failed") > **failed**: `number` Defined in: [packages/sdk/src/types/fhir-connection-types.ts:375](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L375) *** ### runId[​](#runid "Direct link to runId") > **runId**: `string` Defined in: [packages/sdk/src/types/fhir-connection-types.ts:361](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L361) *** ### runKind?[​](#runkind "Direct link to runKind?") > `optional` **runKind**: `string` | `null` Defined in: [packages/sdk/src/types/fhir-connection-types.ts:372](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L372) Run scope discriminator. "patient\_refresh" = single-patient refresh, "full\_sweep" = connection-wide sweep / manual backfill. Null on rows written before the journal started tagging run\_kind; callers should treat missing values as full-sweep (legacy default). *** ### skipped[​](#skipped "Direct link to skipped") > **skipped**: `number` Defined in: [packages/sdk/src/types/fhir-connection-types.ts:376](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L376) *** ### source[​](#source "Direct link to source") > **source**: `string` Defined in: [packages/sdk/src/types/fhir-connection-types.ts:365](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L365) *** ### startedAt[​](#startedat "Direct link to startedAt") > **startedAt**: `string` Defined in: [packages/sdk/src/types/fhir-connection-types.ts:362](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L362) *** ### status[​](#status "Direct link to status") > **status**: `string` Defined in: [packages/sdk/src/types/fhir-connection-types.ts:364](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L364) *** ### synced[​](#synced "Direct link to synced") > **synced**: `number` Defined in: [packages/sdk/src/types/fhir-connection-types.ts:374](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L374) *** ### total[​](#total "Direct link to total") > **total**: `number` Defined in: [packages/sdk/src/types/fhir-connection-types.ts:373](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L373) --- # Interface: EncounterSyncRunResponse Defined in: [packages/sdk/src/types/generated/app\_connection.ts:102](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L102) POST response for triggering a manual encounter-sync run. ## Properties[​](#properties "Direct link to Properties") ### message[​](#message "Direct link to message") > **message**: `string` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:104](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L104) *** ### skipped?[​](#skipped "Direct link to skipped?") > `optional` **skipped**: `boolean` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:106](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L106) *** ### success[​](#success "Direct link to success") > **success**: `boolean` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:103](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L103) *** ### workflowId?[​](#workflowid "Direct link to workflowId?") > `optional` **workflowId**: `string` | `null` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:105](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L105) --- # Interface: EncounterSyncStatusResponse Defined in: [packages/sdk/src/types/generated/app\_connection.ts:120](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L120) GET response for the encounter-sync configuration + runtime state. Surfaces both freshness contracts. The demand-refresh fields (`refreshTtlMinutes` / `refreshLookbackDays` etc.) drive on-demand and manual refresh. The scheduled-sync fields (`cadenceHours`, `rollingLookbackDays`, `overlapDays`, `initialLookbackDays`, `scheduledSyncPaused`) drive the daily scheduled encounter-sync dispatcher and are surfaced in the operator UI's "Scheduled sync" section. See docs/projects/archived/daily-ecw-encounter-sync.md. ## Properties[​](#properties "Direct link to Properties") ### cadenceHours[​](#cadencehours "Direct link to cadenceHours") > **cadenceHours**: `number` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:135](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L135) *** ### carePlanHtmlEnabled?[​](#careplanhtmlenabled "Direct link to carePlanHtmlEnabled?") > `optional` **carePlanHtmlEnabled**: `boolean` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:150](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L150) *** ### carePlanItemsDataType?[​](#careplanitemsdatatype "Direct link to carePlanItemsDataType?") > `optional` **carePlanItemsDataType**: [`EncounterSyncDataTypeSummary`](https://docs.gravityrail.com/sdk/interfaces/EncounterSyncDataTypeSummary.md) | `null` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:146](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L146) *** ### carePlanItemsSchemaVersion?[​](#careplanitemsschemaversion "Direct link to carePlanItemsSchemaVersion?") > `optional` **carePlanItemsSchemaVersion**: `number` | `null` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:147](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L147) *** ### ccdaBinaryEnabled?[​](#ccdabinaryenabled "Direct link to ccdaBinaryEnabled?") > `optional` **ccdaBinaryEnabled**: `boolean` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:165](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L165) *** ### clinicalDocumentsSyncEnabled?[​](#clinicaldocumentssyncenabled "Direct link to clinicalDocumentsSyncEnabled?") > `optional` **clinicalDocumentsSyncEnabled**: `boolean` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:161](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L161) *** ### dataType?[​](#datatype "Direct link to dataType?") > `optional` **dataType**: [`EncounterSyncDataTypeSummary`](https://docs.gravityrail.com/sdk/interfaces/EncounterSyncDataTypeSummary.md) | `null` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:136](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L136) *** ### demographicsEnabled?[​](#demographicsenabled "Direct link to demographicsEnabled?") > `optional` **demographicsEnabled**: `boolean` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:148](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L148) *** ### documentReferenceEnabled?[​](#documentreferenceenabled "Direct link to documentReferenceEnabled?") > `optional` **documentReferenceEnabled**: `boolean` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:162](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L162) *** ### enabled[​](#enabled "Direct link to enabled") > **enabled**: `boolean` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:121](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L121) *** ### encounterMedicationsDataType?[​](#encountermedicationsdatatype "Direct link to encounterMedicationsDataType?") > `optional` **encounterMedicationsDataType**: [`EncounterSyncDataTypeSummary`](https://docs.gravityrail.com/sdk/interfaces/EncounterSyncDataTypeSummary.md) | `null` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:155](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L155) *** ### encounterMedicationsSchemaVersion?[​](#encountermedicationsschemaversion "Direct link to encounterMedicationsSchemaVersion?") > `optional` **encounterMedicationsSchemaVersion**: `number` | `null` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:156](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L156) *** ### encounterNotesDataType?[​](#encounternotesdatatype "Direct link to encounterNotesDataType?") > `optional` **encounterNotesDataType**: [`EncounterSyncDataTypeSummary`](https://docs.gravityrail.com/sdk/interfaces/EncounterSyncDataTypeSummary.md) | `null` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:151](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L151) *** ### encounterNotesSchemaVersion?[​](#encounternotesschemaversion "Direct link to encounterNotesSchemaVersion?") > `optional` **encounterNotesSchemaVersion**: `number` | `null` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:152](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L152) *** ### encounterReferralsDataType?[​](#encounterreferralsdatatype "Direct link to encounterReferralsDataType?") > `optional` **encounterReferralsDataType**: [`EncounterSyncDataTypeSummary`](https://docs.gravityrail.com/sdk/interfaces/EncounterSyncDataTypeSummary.md) | `null` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:153](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L153) *** ### encounterReferralsSchemaVersion?[​](#encounterreferralsschemaversion "Direct link to encounterReferralsSchemaVersion?") > `optional` **encounterReferralsSchemaVersion**: `number` | `null` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:154](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L154) *** ### initialLookbackDays[​](#initiallookbackdays "Direct link to initialLookbackDays") > **initialLookbackDays**: `number` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:132](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L132) *** ### lastAttemptedAt?[​](#lastattemptedat "Direct link to lastAttemptedAt?") > `optional` **lastAttemptedAt**: `string` | `null` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:167](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L167) *** ### lastError?[​](#lasterror "Direct link to lastError?") > `optional` **lastError**: `string` | `null` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:170](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L170) *** ### lastPatientRefreshAt?[​](#lastpatientrefreshat "Direct link to lastPatientRefreshAt?") > `optional` **lastPatientRefreshAt**: `string` | `null` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:171](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L171) *** ### lastPatientRefreshError?[​](#lastpatientrefresherror "Direct link to lastPatientRefreshError?") > `optional` **lastPatientRefreshError**: `string` | `null` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:173](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L173) *** ### lastPatientRefreshStatus?[​](#lastpatientrefreshstatus "Direct link to lastPatientRefreshStatus?") > `optional` **lastPatientRefreshStatus**: `string` | `null` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:172](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L172) *** ### lastStatus?[​](#laststatus "Direct link to lastStatus?") > `optional` **lastStatus**: `string` | `null` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:169](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L169) *** ### lastSuccessfulAt?[​](#lastsuccessfulat "Direct link to lastSuccessfulAt?") > `optional` **lastSuccessfulAt**: `string` | `null` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:168](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L168) *** ### manualBackfillLookbackDays[​](#manualbackfilllookbackdays "Direct link to manualBackfillLookbackDays") > **manualBackfillLookbackDays**: `number` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:127](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L127) *** ### medicationRequestsEnabled?[​](#medicationrequestsenabled "Direct link to medicationRequestsEnabled?") > `optional` **medicationRequestsEnabled**: `boolean` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:164](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L164) *** ### observationDataType?[​](#observationdatatype "Direct link to observationDataType?") > `optional` **observationDataType**: [`EncounterSyncDataTypeSummary`](https://docs.gravityrail.com/sdk/interfaces/EncounterSyncDataTypeSummary.md) | `null` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:137](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L137) *** ### observationOverlapDays?[​](#observationoverlapdays "Direct link to observationOverlapDays?") > `optional` **observationOverlapDays**: `number` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:140](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L140) *** ### observationRollingLookbackDays?[​](#observationrollinglookbackdays "Direct link to observationRollingLookbackDays?") > `optional` **observationRollingLookbackDays**: `number` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:141](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L141) *** ### observationSchemaVersion?[​](#observationschemaversion "Direct link to observationSchemaVersion?") > `optional` **observationSchemaVersion**: `number` | `null` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:138](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L138) *** ### observationSyncEnabled?[​](#observationsyncenabled "Direct link to observationSyncEnabled?") > `optional` **observationSyncEnabled**: `boolean` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:139](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L139) *** ### overlapDays[​](#overlapdays "Direct link to overlapDays") > **overlapDays**: `number` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:134](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L134) *** ### patientCcdaDocumentsDataType?[​](#patientccdadocumentsdatatype "Direct link to patientCcdaDocumentsDataType?") > `optional` **patientCcdaDocumentsDataType**: [`EncounterSyncDataTypeSummary`](https://docs.gravityrail.com/sdk/interfaces/EncounterSyncDataTypeSummary.md) | `null` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:159](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L159) *** ### patientCcdaDocumentsSchemaVersion?[​](#patientccdadocumentsschemaversion "Direct link to patientCcdaDocumentsSchemaVersion?") > `optional` **patientCcdaDocumentsSchemaVersion**: `number` | `null` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:160](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L160) *** ### patientCcdaSectionsDataType?[​](#patientccdasectionsdatatype "Direct link to patientCcdaSectionsDataType?") > `optional` **patientCcdaSectionsDataType**: [`EncounterSyncDataTypeSummary`](https://docs.gravityrail.com/sdk/interfaces/EncounterSyncDataTypeSummary.md) | `null` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:157](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L157) *** ### patientCcdaSectionsSchemaVersion?[​](#patientccdasectionsschemaversion "Direct link to patientCcdaSectionsSchemaVersion?") > `optional` **patientCcdaSectionsSchemaVersion**: `number` | `null` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:158](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L158) *** ### patientConditionsDataType?[​](#patientconditionsdatatype "Direct link to patientConditionsDataType?") > `optional` **patientConditionsDataType**: [`EncounterSyncDataTypeSummary`](https://docs.gravityrail.com/sdk/interfaces/EncounterSyncDataTypeSummary.md) | `null` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:144](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L144) *** ### patientConditionsEnabled?[​](#patientconditionsenabled "Direct link to patientConditionsEnabled?") > `optional` **patientConditionsEnabled**: `boolean` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:149](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L149) *** ### patientConditionsSchemaVersion?[​](#patientconditionsschemaversion "Direct link to patientConditionsSchemaVersion?") > `optional` **patientConditionsSchemaVersion**: `number` | `null` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:145](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L145) *** ### patientProfileDataType?[​](#patientprofiledatatype "Direct link to patientProfileDataType?") > `optional` **patientProfileDataType**: [`EncounterSyncDataTypeSummary`](https://docs.gravityrail.com/sdk/interfaces/EncounterSyncDataTypeSummary.md) | `null` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:142](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L142) *** ### patientProfileSchemaVersion?[​](#patientprofileschemaversion "Direct link to patientProfileSchemaVersion?") > `optional` **patientProfileSchemaVersion**: `number` | `null` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:143](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L143) *** ### postCreateVerificationDelayMinutes[​](#postcreateverificationdelayminutes "Direct link to postCreateVerificationDelayMinutes") > **postCreateVerificationDelayMinutes**: `number` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:130](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L130) *** ### postCreateVerificationEnabled[​](#postcreateverificationenabled "Direct link to postCreateVerificationEnabled") > **postCreateVerificationEnabled**: `boolean` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:129](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L129) *** ### postCreateWriteThroughEnabled[​](#postcreatewritethroughenabled "Direct link to postCreateWriteThroughEnabled") > **postCreateWriteThroughEnabled**: `boolean` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:128](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L128) *** ### readerLookbackDays[​](#readerlookbackdays "Direct link to readerLookbackDays") > **readerLookbackDays**: `number` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:126](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L126) *** ### refreshLookbackDays[​](#refreshlookbackdays "Direct link to refreshLookbackDays") > **refreshLookbackDays**: `number` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:125](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L125) *** ### refreshTtlMinutes[​](#refreshttlminutes "Direct link to refreshTtlMinutes") > **refreshTtlMinutes**: `number` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:124](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L124) *** ### rollingLookbackDays[​](#rollinglookbackdays "Direct link to rollingLookbackDays") > **rollingLookbackDays**: `number` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:133](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L133) *** ### scheduledSyncPaused?[​](#scheduledsyncpaused "Direct link to scheduledSyncPaused?") > `optional` **scheduledSyncPaused**: `boolean` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:122](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L122) *** ### schemaVersion?[​](#schemaversion "Direct link to schemaVersion?") > `optional` **schemaVersion**: `number` | `null` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:123](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L123) *** ### serviceRequestReferralsEnabled?[​](#servicerequestreferralsenabled "Direct link to serviceRequestReferralsEnabled?") > `optional` **serviceRequestReferralsEnabled**: `boolean` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:163](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L163) *** ### storeRawCcdaXml?[​](#storerawccdaxml "Direct link to storeRawCcdaXml?") > `optional` **storeRawCcdaXml**: `boolean` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:166](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L166) *** ### workflowStartAutomation?[​](#workflowstartautomation "Direct link to workflowStartAutomation?") > `optional` **workflowStartAutomation**: [`WorkflowStartAutomationResponse`](https://docs.gravityrail.com/sdk/interfaces/WorkflowStartAutomationResponse.md) Defined in: [packages/sdk/src/types/generated/app\_connection.ts:131](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L131) --- # Interface: EngineTimeSeries Defined in: [packages/sdk/src/types/generated/voice\_metrics.ts:20](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/voice_metrics.ts#L20) ## Properties[​](#properties "Direct link to Properties") ### engine[​](#engine "Direct link to engine") > **engine**: `string` Defined in: [packages/sdk/src/types/generated/voice\_metrics.ts:21](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/voice_metrics.ts#L21) *** ### timeSeries[​](#timeseries "Direct link to timeSeries") > **timeSeries**: [`MetricDataPoint`](https://docs.gravityrail.com/sdk/interfaces/MetricDataPoint.md)\[] Defined in: [packages/sdk/src/types/generated/voice\_metrics.ts:22](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/voice_metrics.ts#L22) --- # Interface: EnrichInquiryRequest Defined in: [packages/sdk/src/types/inquiry-types.ts:29](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/inquiry-types.ts#L29) ## Properties[​](#properties "Direct link to Properties") ### businessName?[​](#businessname "Direct link to businessName?") > `optional` **businessName**: `string` Defined in: [packages/sdk/src/types/inquiry-types.ts:33](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/inquiry-types.ts#L33) *** ### cellNumber?[​](#cellnumber "Direct link to cellNumber?") > `optional` **cellNumber**: `string` Defined in: [packages/sdk/src/types/inquiry-types.ts:32](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/inquiry-types.ts#L32) *** ### email?[​](#email "Direct link to email?") > `optional` **email**: `string` Defined in: [packages/sdk/src/types/inquiry-types.ts:31](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/inquiry-types.ts#L31) *** ### message?[​](#message "Direct link to message?") > `optional` **message**: `string` Defined in: [packages/sdk/src/types/inquiry-types.ts:34](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/inquiry-types.ts#L34) *** ### name?[​](#name "Direct link to name?") > `optional` **name**: `string` Defined in: [packages/sdk/src/types/inquiry-types.ts:30](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/inquiry-types.ts#L30) --- # Interface: EntitySyncConfig Defined in: [packages/sdk/src/types/app-connection-types.ts:501](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L501) ## Properties[​](#properties "Direct link to Properties") ### checkpoints[​](#checkpoints "Direct link to checkpoints") > **checkpoints**: `Record`<`string`, [`SyncCheckpoint`](https://docs.gravityrail.com/sdk/interfaces/SyncCheckpoint.md)> Defined in: [packages/sdk/src/types/app-connection-types.ts:511](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L511) *** ### conflictPolicy[​](#conflictpolicy "Direct link to conflictPolicy") > **conflictPolicy**: [`ConflictPolicy`](https://docs.gravityrail.com/sdk/interfaces/ConflictPolicy.md) Defined in: [packages/sdk/src/types/app-connection-types.ts:509](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L509) *** ### entityParams[​](#entityparams "Direct link to entityParams") > **entityParams**: `Record`<`string`, `unknown`> Defined in: [packages/sdk/src/types/app-connection-types.ts:510](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L510) *** ### entityType[​](#entitytype "Direct link to entityType") > **entityType**: [`SyncEntityType`](https://docs.gravityrail.com/sdk/type-aliases/SyncEntityType.md) Defined in: [packages/sdk/src/types/app-connection-types.ts:502](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L502) *** ### inboundEnabled[​](#inboundenabled "Direct link to inboundEnabled") > **inboundEnabled**: `boolean` Defined in: [packages/sdk/src/types/app-connection-types.ts:504](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L504) *** ### inboundFilter[​](#inboundfilter "Direct link to inboundFilter") > **inboundFilter**: `string` | `null` Defined in: [packages/sdk/src/types/app-connection-types.ts:506](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L506) *** ### matchStrategy[​](#matchstrategy "Direct link to matchStrategy") > **matchStrategy**: [`MatchStrategy`](https://docs.gravityrail.com/sdk/interfaces/MatchStrategy.md) Defined in: [packages/sdk/src/types/app-connection-types.ts:508](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L508) *** ### outboundEnabled[​](#outboundenabled "Direct link to outboundEnabled") > **outboundEnabled**: `boolean` Defined in: [packages/sdk/src/types/app-connection-types.ts:503](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L503) *** ### outboundFilter[​](#outboundfilter "Direct link to outboundFilter") > **outboundFilter**: `string` | `null` Defined in: [packages/sdk/src/types/app-connection-types.ts:505](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L505) *** ### rules[​](#rules "Direct link to rules") > **rules**: [`SyncRule`](https://docs.gravityrail.com/sdk/interfaces/SyncRule.md)\[] Defined in: [packages/sdk/src/types/app-connection-types.ts:507](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L507) *** ### trustEmail?[​](#trustemail "Direct link to trustEmail?") > `optional` **trustEmail**: `boolean` Defined in: [packages/sdk/src/types/app-connection-types.ts:513](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L513) Mark imported email addresses as trusted (member entity only). *** ### trustPhone?[​](#trustphone "Direct link to trustPhone?") > `optional` **trustPhone**: `boolean` Defined in: [packages/sdk/src/types/app-connection-types.ts:515](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L515) Mark imported phone numbers as trusted (member entity only). --- # Interface: EnumOption Defined in: [packages/sdk/src/types/data-types.ts:133](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L133) Label-value pair for enum field options. Allows enum fields to have user-friendly labels while storing clean values (e.g., numbers for scoring calculations in CEL expressions). ## Properties[​](#properties "Direct link to Properties") ### label[​](#label "Direct link to label") > **label**: `string` Defined in: [packages/sdk/src/types/data-types.ts:135](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L135) Display label shown to users *** ### value[​](#value "Direct link to value") > **value**: `string` | `number` Defined in: [packages/sdk/src/types/data-types.ts:137](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L137) Stored value (can be string or number) *** ### visibleWhen?[​](#visiblewhen "Direct link to visibleWhen?") > `optional` **visibleWhen**: `string` | `null` Defined in: [packages/sdk/src/types/data-types.ts:143](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L143) CEL expression that must return true for this option to be visible. Uses record.data.\ syntax to reference other field values. CONSTRAINT: Can only reference non-FUNCTION fields. --- # Interface: ErrorCodeBucket Defined in: [packages/sdk/src/types/health-dashboard-types.ts:25](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/health-dashboard-types.ts#L25) ## Properties[​](#properties "Direct link to Properties") ### code[​](#code "Direct link to code") > **code**: `string` Defined in: [packages/sdk/src/types/health-dashboard-types.ts:26](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/health-dashboard-types.ts#L26) *** ### count[​](#count "Direct link to count") > **count**: `number` Defined in: [packages/sdk/src/types/health-dashboard-types.ts:27](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/health-dashboard-types.ts#L27) *** ### label[​](#label "Direct link to label") > **label**: `string` | `null` Defined in: [packages/sdk/src/types/health-dashboard-types.ts:28](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/health-dashboard-types.ts#L28) --- # Interface: ErrorResponse Defined in: [packages/sdk/src/types/account-types.ts:173](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L173) ## Properties[​](#properties "Direct link to Properties") ### detail[​](#detail "Direct link to detail") > **detail**: `string` Defined in: [packages/sdk/src/types/account-types.ts:174](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L174) --- # Interface: EscalationAbilityConfig Defined in: [packages/sdk/src/types/ability-types.ts:242](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ability-types.ts#L242) Config for escalation ability ## Properties[​](#properties "Direct link to Properties") ### notifiedMessage?[​](#notifiedmessage "Direct link to notifiedMessage?") > `optional` **notifiedMessage**: `string` | `null` Defined in: [packages/sdk/src/types/ability-types.ts:246](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ability-types.ts#L246) Message shown when agents are notified. If not set, uses workspace default. *** ### offlineMessage?[​](#offlinemessage "Direct link to offlineMessage?") > `optional` **offlineMessage**: `string` | `null` Defined in: [packages/sdk/src/types/ability-types.ts:250](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ability-types.ts#L250) Message shown outside business hours. If not set, uses workspace default. *** ### onlineMessage?[​](#onlinemessage "Direct link to onlineMessage?") > `optional` **onlineMessage**: `string` | `null` Defined in: [packages/sdk/src/types/ability-types.ts:248](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ability-types.ts#L248) Message shown during business hours. If not set, uses workspace default. *** ### pausedMessage?[​](#pausedmessage "Direct link to pausedMessage?") > `optional` **pausedMessage**: `string` | `null` Defined in: [packages/sdk/src/types/ability-types.ts:244](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ability-types.ts#L244) Message shown when chat is paused for escalation. If not set, uses workspace default. *** ### pauseOnEscalate?[​](#pauseonescalate "Direct link to pauseOnEscalate?") > `optional` **pauseOnEscalate**: `boolean` | `null` Defined in: [packages/sdk/src/types/ability-types.ts:252](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ability-types.ts#L252) Whether to pause the chat on escalation. If not set, uses workspace default. *** ### priorityMemberIds?[​](#prioritymemberids "Direct link to priorityMemberIds?") > `optional` **priorityMemberIds**: `number`\[] | `null` Defined in: [packages/sdk/src/types/ability-types.ts:254](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ability-types.ts#L254) List of member IDs to notify first for this workflow/task escalations. --- # Interface: EventActionMapping Defined in: [packages/sdk/src/types/generated/event\_rule.ts:39](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/event_rule.ts#L39) Mapping of event type to valid action types ## Properties[​](#properties "Direct link to Properties") ### actions[​](#actions "Direct link to actions") > **actions**: `string`\[] Defined in: [packages/sdk/src/types/generated/event\_rule.ts:41](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/event_rule.ts#L41) *** ### eventType[​](#eventtype "Direct link to eventType") > **eventType**: `string` Defined in: [packages/sdk/src/types/generated/event\_rule.ts:40](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/event_rule.ts#L40) --- # Interface: EventActionMappingsResponse Defined in: [packages/sdk/src/types/generated/event\_rule.ts:47](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/event_rule.ts#L47) Response containing all event-action mappings ## Properties[​](#properties "Direct link to Properties") ### mappings[​](#mappings "Direct link to mappings") > **mappings**: [`EventActionMapping`](https://docs.gravityrail.com/sdk/interfaces/EventActionMapping.md)\[] Defined in: [packages/sdk/src/types/generated/event\_rule.ts:48](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/event_rule.ts#L48) --- # Interface: EventResponse Defined in: [packages/sdk/src/types/generated/calendar.ts:208](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/calendar.ts#L208) Response model for calendar events. ## Properties[​](#properties "Direct link to Properties") ### assignmentId[​](#assignmentid "Direct link to assignmentId") > **assignmentId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/calendar.ts:225](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/calendar.ts#L225) *** ### attendees?[​](#attendees "Direct link to attendees?") > `optional` **attendees**: [`AttendeeResponse`](https://docs.gravityrail.com/sdk/interfaces/AttendeeResponse.md)\[] Defined in: [packages/sdk/src/types/generated/calendar.ts:236](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/calendar.ts#L236) *** ### calendarId[​](#calendarid "Direct link to calendarId") > **calendarId**: `number` Defined in: [packages/sdk/src/types/generated/calendar.ts:211](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/calendar.ts#L211) *** ### calendarName[​](#calendarname "Direct link to calendarName") > **calendarName**: `string` Defined in: [packages/sdk/src/types/generated/calendar.ts:212](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/calendar.ts#L212) *** ### cancellationReason[​](#cancellationreason "Direct link to cancellationReason") > **cancellationReason**: `string` | `null` Defined in: [packages/sdk/src/types/generated/calendar.ts:230](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/calendar.ts#L230) *** ### cancelledAt[​](#cancelledat "Direct link to cancelledAt") > **cancelledAt**: `string` | `null` Defined in: [packages/sdk/src/types/generated/calendar.ts:228](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/calendar.ts#L228) *** ### cancelledByMemberId[​](#cancelledbymemberid "Direct link to cancelledByMemberId") > **cancelledByMemberId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/calendar.ts:229](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/calendar.ts#L229) *** ### chatId[​](#chatid "Direct link to chatId") > **chatId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/calendar.ts:226](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/calendar.ts#L226) *** ### createdAt[​](#createdat "Direct link to createdAt") > **createdAt**: `string` Defined in: [packages/sdk/src/types/generated/calendar.ts:237](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/calendar.ts#L237) *** ### creatorMemberId[​](#creatormemberid "Direct link to creatorMemberId") > **creatorMemberId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/calendar.ts:222](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/calendar.ts#L222) *** ### description[​](#description "Direct link to description") > **description**: `string` | `null` Defined in: [packages/sdk/src/types/generated/calendar.ts:217](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/calendar.ts#L217) *** ### endTime[​](#endtime "Direct link to endTime") > **endTime**: `string` Defined in: [packages/sdk/src/types/generated/calendar.ts:220](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/calendar.ts#L220) *** ### eventTypeColor[​](#eventtypecolor "Direct link to eventTypeColor") > **eventTypeColor**: `string` | `null` Defined in: [packages/sdk/src/types/generated/calendar.ts:215](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/calendar.ts#L215) *** ### eventTypeId[​](#eventtypeid "Direct link to eventTypeId") > **eventTypeId**: `number` Defined in: [packages/sdk/src/types/generated/calendar.ts:213](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/calendar.ts#L213) *** ### eventTypeName[​](#eventtypename "Direct link to eventTypeName") > **eventTypeName**: `string` Defined in: [packages/sdk/src/types/generated/calendar.ts:214](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/calendar.ts#L214) *** ### id[​](#id "Direct link to id") > **id**: `number` Defined in: [packages/sdk/src/types/generated/calendar.ts:209](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/calendar.ts#L209) *** ### isRecurringInstance[​](#isrecurringinstance "Direct link to isRecurringInstance") > **isRecurringInstance**: `boolean` Defined in: [packages/sdk/src/types/generated/calendar.ts:233](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/calendar.ts#L233) *** ### location[​](#location "Direct link to location") > **location**: `string` | `null` Defined in: [packages/sdk/src/types/generated/calendar.ts:218](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/calendar.ts#L218) *** ### messageId[​](#messageid "Direct link to messageId") > **messageId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/calendar.ts:227](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/calendar.ts#L227) *** ### originalStartTime[​](#originalstarttime "Direct link to originalStartTime") > **originalStartTime**: `string` | `null` Defined in: [packages/sdk/src/types/generated/calendar.ts:234](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/calendar.ts#L234) *** ### recurrenceRule[​](#recurrencerule "Direct link to recurrenceRule") > **recurrenceRule**: `string` | `null` Defined in: [packages/sdk/src/types/generated/calendar.ts:231](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/calendar.ts#L231) *** ### recurringEventId[​](#recurringeventid "Direct link to recurringEventId") > **recurringEventId**: `string` | `null` Defined in: [packages/sdk/src/types/generated/calendar.ts:232](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/calendar.ts#L232) *** ### remoteEventId[​](#remoteeventid "Direct link to remoteEventId") > **remoteEventId**: `string` | `null` Defined in: [packages/sdk/src/types/generated/calendar.ts:235](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/calendar.ts#L235) *** ### startTime[​](#starttime "Direct link to startTime") > **startTime**: `string` Defined in: [packages/sdk/src/types/generated/calendar.ts:219](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/calendar.ts#L219) *** ### status[​](#status "Direct link to status") > **status**: `string` Defined in: [packages/sdk/src/types/generated/calendar.ts:221](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/calendar.ts#L221) *** ### taskId[​](#taskid "Direct link to taskId") > **taskId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/calendar.ts:224](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/calendar.ts#L224) *** ### title[​](#title "Direct link to title") > **title**: `string` Defined in: [packages/sdk/src/types/generated/calendar.ts:216](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/calendar.ts#L216) *** ### updatedAt[​](#updatedat "Direct link to updatedAt") > **updatedAt**: `string` Defined in: [packages/sdk/src/types/generated/calendar.ts:238](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/calendar.ts#L238) *** ### uuid[​](#uuid "Direct link to uuid") > **uuid**: `string` Defined in: [packages/sdk/src/types/generated/calendar.ts:210](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/calendar.ts#L210) *** ### workflowId[​](#workflowid "Direct link to workflowId") > **workflowId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/calendar.ts:223](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/calendar.ts#L223) --- # Interface: EventRuleExport Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:63](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L63) ## Properties[​](#properties "Direct link to Properties") ### actionParams[​](#actionparams "Direct link to actionParams") > **actionParams**: `Record`<`string`, `any`> Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:70](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L70) *** ### actionType[​](#actiontype "Direct link to actionType") > **actionType**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:69](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L69) *** ### conditions?[​](#conditions "Direct link to conditions?") > `optional` **conditions**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:68](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L68) *** ### eventType[​](#eventtype "Direct link to eventType") > **eventType**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:66](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L66) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:65](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L65) *** ### objectType[​](#objecttype "Direct link to objectType") > **objectType**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:67](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L67) *** ### uuid[​](#uuid "Direct link to uuid") > **uuid**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:64](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L64) --- # Interface: EventRuleExportItem Defined in: [packages/sdk/src/types/event-types.ts:655](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L655) ## Properties[​](#properties "Direct link to Properties") ### actionParams[​](#actionparams "Direct link to actionParams") > **actionParams**: `Record`<`string`, `any`> Defined in: [packages/sdk/src/types/event-types.ts:662](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L662) *** ### actionType[​](#actiontype "Direct link to actionType") > **actionType**: `string` Defined in: [packages/sdk/src/types/event-types.ts:661](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L661) *** ### conditions[​](#conditions "Direct link to conditions") > **conditions**: `string` | `null` Defined in: [packages/sdk/src/types/event-types.ts:660](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L660) *** ### eventType[​](#eventtype "Direct link to eventType") > **eventType**: `string` Defined in: [packages/sdk/src/types/event-types.ts:658](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L658) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/event-types.ts:657](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L657) *** ### objectType[​](#objecttype "Direct link to objectType") > **objectType**: `string` Defined in: [packages/sdk/src/types/event-types.ts:659](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L659) *** ### uuid[​](#uuid "Direct link to uuid") > **uuid**: `string` Defined in: [packages/sdk/src/types/event-types.ts:656](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L656) --- # Interface: EventRuleFormData Defined in: [packages/sdk/src/types/event-types.ts:475](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L475) ## Properties[​](#properties "Direct link to Properties") ### actionParams?[​](#actionparams "Direct link to actionParams?") > `optional` **actionParams**: `Record`<`string`, `any`> Defined in: [packages/sdk/src/types/event-types.ts:483](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L483) *** ### actionType[​](#actiontype "Direct link to actionType") > **actionType**: [`EventRuleActionType`](https://docs.gravityrail.com/sdk/enumerations/EventRuleActionType.md) Defined in: [packages/sdk/src/types/event-types.ts:482](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L482) *** ### active?[​](#active "Direct link to active?") > `optional` **active**: `boolean` Defined in: [packages/sdk/src/types/event-types.ts:485](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L485) *** ### calendarEventTypeId?[​](#calendareventtypeid "Direct link to calendarEventTypeId?") > `optional` **calendarEventTypeId**: `number` | `null` Defined in: [packages/sdk/src/types/event-types.ts:491](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L491) *** ### calendarId?[​](#calendarid "Direct link to calendarId?") > `optional` **calendarId**: `number` | `null` Defined in: [packages/sdk/src/types/event-types.ts:490](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L490) *** ### conditions?[​](#conditions "Direct link to conditions?") > `optional` **conditions**: `string` | `null` Defined in: [packages/sdk/src/types/event-types.ts:481](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L481) *** ### dataTypeId?[​](#datatypeid "Direct link to dataTypeId?") > `optional` **dataTypeId**: `number` | `null` Defined in: [packages/sdk/src/types/event-types.ts:487](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L487) *** ### delay?[​](#delay "Direct link to delay?") > `optional` **delay**: `number` Defined in: [packages/sdk/src/types/event-types.ts:493](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L493) *** ### eventType[​](#eventtype "Direct link to eventType") > **eventType**: [`EventRuleEventType`](https://docs.gravityrail.com/sdk/enumerations/EventRuleEventType.md) Defined in: [packages/sdk/src/types/event-types.ts:480](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L480) *** ### journeyStepId?[​](#journeystepid "Direct link to journeyStepId?") > `optional` **journeyStepId**: `number` | `null` Defined in: [packages/sdk/src/types/event-types.ts:492](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L492) *** ### name?[​](#name "Direct link to name?") > `optional` **name**: `string` | `null` Defined in: [packages/sdk/src/types/event-types.ts:476](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L476) *** ### objectType[​](#objecttype "Direct link to objectType") > **objectType**: [`EventRuleObjectType`](https://docs.gravityrail.com/sdk/enumerations/EventRuleObjectType.md) Defined in: [packages/sdk/src/types/event-types.ts:479](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L479) *** ### order?[​](#order "Direct link to order?") > `optional` **order**: `number` Defined in: [packages/sdk/src/types/event-types.ts:494](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L494) *** ### routineId?[​](#routineid "Direct link to routineId?") > `optional` **routineId**: `number` | `null` Defined in: [packages/sdk/src/types/event-types.ts:488](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L488) *** ### taskId?[​](#taskid "Direct link to taskId?") > `optional` **taskId**: `number` | `null` Defined in: [packages/sdk/src/types/event-types.ts:486](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L486) *** ### triggerParams?[​](#triggerparams "Direct link to triggerParams?") > `optional` **triggerParams**: `Record`<`string`, `any`> Defined in: [packages/sdk/src/types/event-types.ts:484](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L484) *** ### uuid?[​](#uuid "Direct link to uuid?") > `optional` **uuid**: `string` Defined in: [packages/sdk/src/types/event-types.ts:477](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L477) *** ### workflowId?[​](#workflowid "Direct link to workflowId?") > `optional` **workflowId**: `number` | `null` Defined in: [packages/sdk/src/types/event-types.ts:489](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L489) --- # Interface: EventRuleInput Defined in: [packages/sdk/src/types/event-types.ts:515](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L515) Input type for batch event rule operations (create/update with parent object). Used when syncing event rules as part of a task or workflow update. UUID is required and used for matching existing rules. ## Properties[​](#properties "Direct link to Properties") ### actionParams?[​](#actionparams "Direct link to actionParams?") > `optional` **actionParams**: `Record`<`string`, `any`> | `null` Defined in: [packages/sdk/src/types/event-types.ts:521](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L521) *** ### actionType[​](#actiontype "Direct link to actionType") > **actionType**: [`EventRuleActionType`](https://docs.gravityrail.com/sdk/enumerations/EventRuleActionType.md) Defined in: [packages/sdk/src/types/event-types.ts:520](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L520) *** ### active?[​](#active "Direct link to active?") > `optional` **active**: `boolean` Defined in: [packages/sdk/src/types/event-types.ts:524](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L524) *** ### conditions?[​](#conditions "Direct link to conditions?") > `optional` **conditions**: `string` | `null` Defined in: [packages/sdk/src/types/event-types.ts:523](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L523) *** ### delay?[​](#delay "Direct link to delay?") > `optional` **delay**: `number` Defined in: [packages/sdk/src/types/event-types.ts:525](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L525) *** ### eventType[​](#eventtype "Direct link to eventType") > **eventType**: [`EventRuleEventType`](https://docs.gravityrail.com/sdk/enumerations/EventRuleEventType.md) Defined in: [packages/sdk/src/types/event-types.ts:519](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L519) *** ### name?[​](#name "Direct link to name?") > `optional` **name**: `string` | `null` Defined in: [packages/sdk/src/types/event-types.ts:517](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L517) *** ### objectType?[​](#objecttype "Direct link to objectType?") > `optional` **objectType**: [`EventRuleObjectType`](https://docs.gravityrail.com/sdk/enumerations/EventRuleObjectType.md) Defined in: [packages/sdk/src/types/event-types.ts:518](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L518) *** ### triggerParams?[​](#triggerparams "Direct link to triggerParams?") > `optional` **triggerParams**: `Record`<`string`, `any`> | `null` Defined in: [packages/sdk/src/types/event-types.ts:522](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L522) *** ### uuid[​](#uuid "Direct link to uuid") > **uuid**: `string` Defined in: [packages/sdk/src/types/event-types.ts:516](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L516) --- # Interface: EventRuleMetrics Defined in: [packages/sdk/src/types/generated/health\_dashboard.ts:27](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/health_dashboard.ts#L27) Event rule execution failure and volume counts. ## Properties[​](#properties "Direct link to Properties") ### failures?[​](#failures "Direct link to failures?") > `optional` **failures**: `number` Defined in: [packages/sdk/src/types/generated/health\_dashboard.ts:28](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/health_dashboard.ts#L28) *** ### total?[​](#total "Direct link to total?") > `optional` **total**: `number` Defined in: [packages/sdk/src/types/generated/health\_dashboard.ts:29](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/health_dashboard.ts#L29) --- # Interface: EventTypeResponse Defined in: [packages/sdk/src/types/generated/calendar.ts:244](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/calendar.ts#L244) Response model for calendar event types. ## Properties[​](#properties "Direct link to Properties") ### active[​](#active "Direct link to active") > **active**: `boolean` Defined in: [packages/sdk/src/types/generated/calendar.ts:257](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/calendar.ts#L257) *** ### bufferAfterMinutes[​](#bufferafterminutes "Direct link to bufferAfterMinutes") > **bufferAfterMinutes**: `number` Defined in: [packages/sdk/src/types/generated/calendar.ts:253](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/calendar.ts#L253) *** ### bufferBeforeMinutes[​](#bufferbeforeminutes "Direct link to bufferBeforeMinutes") > **bufferBeforeMinutes**: `number` Defined in: [packages/sdk/src/types/generated/calendar.ts:252](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/calendar.ts#L252) *** ### color[​](#color "Direct link to color") > **color**: `string` | `null` Defined in: [packages/sdk/src/types/generated/calendar.ts:256](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/calendar.ts#L256) *** ### createdAt[​](#createdat "Direct link to createdAt") > **createdAt**: `string` Defined in: [packages/sdk/src/types/generated/calendar.ts:258](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/calendar.ts#L258) *** ### defaultDurationMinutes[​](#defaultdurationminutes "Direct link to defaultDurationMinutes") > **defaultDurationMinutes**: `number` Defined in: [packages/sdk/src/types/generated/calendar.ts:251](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/calendar.ts#L251) *** ### description[​](#description "Direct link to description") > **description**: `string` | `null` Defined in: [packages/sdk/src/types/generated/calendar.ts:250](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/calendar.ts#L250) *** ### id[​](#id "Direct link to id") > **id**: `number` Defined in: [packages/sdk/src/types/generated/calendar.ts:245](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/calendar.ts#L245) *** ### maxAttendees[​](#maxattendees "Direct link to maxAttendees") > **maxAttendees**: `number` | `null` Defined in: [packages/sdk/src/types/generated/calendar.ts:255](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/calendar.ts#L255) *** ### minAttendees[​](#minattendees "Direct link to minAttendees") > **minAttendees**: `number` Defined in: [packages/sdk/src/types/generated/calendar.ts:254](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/calendar.ts#L254) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/generated/calendar.ts:248](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/calendar.ts#L248) *** ### slug[​](#slug "Direct link to slug") > **slug**: `string` Defined in: [packages/sdk/src/types/generated/calendar.ts:249](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/calendar.ts#L249) *** ### templateUuid[​](#templateuuid "Direct link to templateUuid") > **templateUuid**: `string` | `null` Defined in: [packages/sdk/src/types/generated/calendar.ts:247](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/calendar.ts#L247) *** ### updatedAt[​](#updatedat "Direct link to updatedAt") > **updatedAt**: `string` Defined in: [packages/sdk/src/types/generated/calendar.ts:259](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/calendar.ts#L259) *** ### uuid[​](#uuid "Direct link to uuid") > **uuid**: `string` Defined in: [packages/sdk/src/types/generated/calendar.ts:246](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/calendar.ts#L246) --- # Interface: ExecuteToolResponse Defined in: [packages/sdk/src/types/generated/task.ts:165](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L165) Response from executing a tool in the context of an assignment. ## Properties[​](#properties "Direct link to Properties") ### chatId?[​](#chatid "Direct link to chatId?") > `optional` **chatId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/task.ts:169](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L169) *** ### result[​](#result "Direct link to result") > **result**: `string` Defined in: [packages/sdk/src/types/generated/task.ts:167](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L167) *** ### success?[​](#success "Direct link to success?") > `optional` **success**: `boolean` Defined in: [packages/sdk/src/types/generated/task.ts:168](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L168) *** ### toolName[​](#toolname "Direct link to toolName") > **toolName**: `string` Defined in: [packages/sdk/src/types/generated/task.ts:166](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L166) --- # Interface: ExpireAnonymousMemberRequest Defined in: [packages/sdk/src/types/member-types.ts:490](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L490) ## Properties[​](#properties "Direct link to Properties") ### notes?[​](#notes "Direct link to notes?") > `optional` **notes**: `string` Defined in: [packages/sdk/src/types/member-types.ts:491](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L491) --- # Interface: ExportStatistics Defined in: [packages/sdk/src/types/stats-types.ts:96](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/stats-types.ts#L96) ## Properties[​](#properties "Direct link to Properties") ### exportedRecords[​](#exportedrecords "Direct link to exportedRecords") > **exportedRecords**: `number` Defined in: [packages/sdk/src/types/stats-types.ts:98](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/stats-types.ts#L98) *** ### exportFormat[​](#exportformat "Direct link to exportFormat") > **exportFormat**: `"csv"` | `"json"` | `"xlsx"` Defined in: [packages/sdk/src/types/stats-types.ts:102](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/stats-types.ts#L102) *** ### failedRecords[​](#failedrecords "Direct link to failedRecords") > **failedRecords**: `number` Defined in: [packages/sdk/src/types/stats-types.ts:99](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/stats-types.ts#L99) *** ### fileSize[​](#filesize "Direct link to fileSize") > **fileSize**: `number` Defined in: [packages/sdk/src/types/stats-types.ts:101](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/stats-types.ts#L101) *** ### processingTime[​](#processingtime "Direct link to processingTime") > **processingTime**: `number` Defined in: [packages/sdk/src/types/stats-types.ts:100](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/stats-types.ts#L100) *** ### totalRecords[​](#totalrecords "Direct link to totalRecords") > **totalRecords**: `number` Defined in: [packages/sdk/src/types/stats-types.ts:97](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/stats-types.ts#L97) --- # Interface: FeatureDefinition Defined in: [packages/sdk/src/features/registry.ts:45](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/features/registry.ts#L45) Complete definition of a workspace feature. ## Properties[​](#properties "Direct link to Properties") ### beta[​](#beta "Direct link to beta") > **beta**: `boolean` Defined in: [packages/sdk/src/features/registry.ts:63](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/features/registry.ts#L63) Whether this is a beta/early access feature *** ### category[​](#category "Direct link to category") > **category**: [`FeatureCategory`](https://docs.gravityrail.com/sdk/enumerations/FeatureCategory.md) Defined in: [packages/sdk/src/features/registry.ts:53](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/features/registry.ts#L53) Feature category for grouping *** ### dependsOn[​](#dependson "Direct link to dependsOn") > **dependsOn**: `string`\[] Defined in: [packages/sdk/src/features/registry.ts:57](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/features/registry.ts#L57) List of feature slugs this feature requires *** ### deprecated?[​](#deprecated "Direct link to deprecated?") > `optional` **deprecated**: `boolean` Defined in: [packages/sdk/src/features/registry.ts:77](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/features/registry.ts#L77) Whether this feature is deprecated and scheduled for removal *** ### description[​](#description "Direct link to description") > **description**: `string` Defined in: [packages/sdk/src/features/registry.ts:51](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/features/registry.ts#L51) Feature description for UI/docs *** ### icon?[​](#icon "Direct link to icon?") > `optional` **icon**: `string` Defined in: [packages/sdk/src/features/registry.ts:67](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/features/registry.ts#L67) Icon name from the icon library *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/features/registry.ts:49](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/features/registry.ts#L49) Human-readable display name *** ### overrideOnly?[​](#overrideonly "Direct link to overrideOnly?") > `optional` **overrideOnly**: `boolean` Defined in: [packages/sdk/src/features/registry.ts:69](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/features/registry.ts#L69) Override-only feature — not in the features array, only controllable via override *** ### productDisplay?[​](#productdisplay "Direct link to productDisplay?") > `optional` **productDisplay**: `boolean` Defined in: [packages/sdk/src/features/registry.ts:71](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/features/registry.ts#L71) Whether this feature should appear on public product cards *** ### productLabel?[​](#productlabel "Direct link to productLabel?") > `optional` **productLabel**: `string` Defined in: [packages/sdk/src/features/registry.ts:73](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/features/registry.ts#L73) Override label for product cards (defaults to name) *** ### productOrder?[​](#productorder "Direct link to productOrder?") > `optional` **productOrder**: `number` Defined in: [packages/sdk/src/features/registry.ts:75](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/features/registry.ts#L75) Sort order on product cards (lower = higher) *** ### recommended[​](#recommended "Direct link to recommended") > **recommended**: `boolean` Defined in: [packages/sdk/src/features/registry.ts:65](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/features/registry.ts#L65) Whether this feature is recommended for new workspaces *** ### slug[​](#slug "Direct link to slug") > **slug**: `string` Defined in: [packages/sdk/src/features/registry.ts:47](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/features/registry.ts#L47) Machine identifier matching WorkspaceFeature enum value *** ### sunsetDate?[​](#sunsetdate "Direct link to sunsetDate?") > `optional` **sunsetDate**: `string` | `null` Defined in: [packages/sdk/src/features/registry.ts:79](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/features/registry.ts#L79) ISO date string after which this feature flag must have no code references *** ### tags[​](#tags "Direct link to tags") > **tags**: `string`\[] Defined in: [packages/sdk/src/features/registry.ts:55](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/features/registry.ts#L55) Searchable tags for filtering *** ### upgradeCta?[​](#upgradecta "Direct link to upgradeCta?") > `optional` **upgradeCta**: `string` Defined in: [packages/sdk/src/features/registry.ts:61](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/features/registry.ts#L61) Custom upgrade call-to-action text *** ### visibility[​](#visibility "Direct link to visibility") > **visibility**: [`FeatureVisibility`](https://docs.gravityrail.com/sdk/enumerations/FeatureVisibility.md) Defined in: [packages/sdk/src/features/registry.ts:59](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/features/registry.ts#L59) How to display when feature is disabled --- # Interface: FeaturesResponse Defined in: [packages/sdk/src/features/registry.ts:85](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/features/registry.ts#L85) Response from the features API endpoint. ## Properties[​](#properties "Direct link to Properties") ### features[​](#features "Direct link to features") > **features**: [`FeatureDefinition`](https://docs.gravityrail.com/sdk/interfaces/FeatureDefinition.md)\[] Defined in: [packages/sdk/src/features/registry.ts:86](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/features/registry.ts#L86) --- # Interface: FeatureSyncStatus Defined in: [packages/sdk/src/types/generated/workspace\_health.ts:63](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/workspace_health.ts#L63) Feature sync status between workspace and subscription. ## Properties[​](#properties "Direct link to Properties") ### dependencyErrors[​](#dependencyerrors "Direct link to dependencyErrors") > **dependencyErrors**: `string`\[] Defined in: [packages/sdk/src/types/generated/workspace\_health.ts:67](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/workspace_health.ts#L67) *** ### extraFeatures[​](#extrafeatures "Direct link to extraFeatures") > **extraFeatures**: `string`\[] Defined in: [packages/sdk/src/types/generated/workspace\_health.ts:66](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/workspace_health.ts#L66) *** ### inSync[​](#insync "Direct link to inSync") > **inSync**: `boolean` Defined in: [packages/sdk/src/types/generated/workspace\_health.ts:64](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/workspace_health.ts#L64) *** ### missingFeatures[​](#missingfeatures "Direct link to missingFeatures") > **missingFeatures**: `string`\[] Defined in: [packages/sdk/src/types/generated/workspace\_health.ts:65](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/workspace_health.ts#L65) --- # Interface: FhirCreateEncounterRequest Defined in: [packages/sdk/src/types/fhir-connection-types.ts:149](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L149) Request to create a telephone encounter. ## Properties[​](#properties "Direct link to Properties") ### locationId?[​](#locationid "Direct link to locationId?") > `optional` **locationId**: `string` Defined in: [packages/sdk/src/types/fhir-connection-types.ts:153](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L153) *** ### notes?[​](#notes "Direct link to notes?") > `optional` **notes**: `string` Defined in: [packages/sdk/src/types/fhir-connection-types.ts:154](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L154) *** ### patientId[​](#patientid "Direct link to patientId") > **patientId**: `string` Defined in: [packages/sdk/src/types/fhir-connection-types.ts:150](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L150) *** ### practitionerId?[​](#practitionerid "Direct link to practitionerId?") > `optional` **practitionerId**: `string` Defined in: [packages/sdk/src/types/fhir-connection-types.ts:152](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L152) *** ### reason[​](#reason "Direct link to reason") > **reason**: `string` Defined in: [packages/sdk/src/types/fhir-connection-types.ts:151](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L151) --- # Interface: FhirCsvColumnMeta Defined in: [packages/sdk/src/types/fhir-connection-types.ts:175](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L175) Per-header classification metadata from the inspect endpoint. ## Properties[​](#properties "Direct link to Properties") ### birthdayRequired[​](#birthdayrequired "Direct link to birthdayRequired") > **birthdayRequired**: `boolean` Defined in: [packages/sdk/src/types/fhir-connection-types.ts:177](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L177) *** ### identifierKind[​](#identifierkind "Direct link to identifierKind") > **identifierKind**: [`FhirCsvIdentifierKind`](https://docs.gravityrail.com/sdk/type-aliases/FhirCsvIdentifierKind.md) Defined in: [packages/sdk/src/types/fhir-connection-types.ts:176](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L176) --- # Interface: FhirCsvImportRunItem Defined in: [packages/sdk/src/types/fhir-connection-types.ts:278](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L278) Per-row item from a completed import run (PHI-minimal). ## Properties[​](#properties "Direct link to Properties") ### detail[​](#detail "Direct link to detail") > **detail**: `string` | `null` Defined in: [packages/sdk/src/types/fhir-connection-types.ts:282](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L282) *** ### index[​](#index "Direct link to index") > **index**: `number` Defined in: [packages/sdk/src/types/fhir-connection-types.ts:279](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L279) *** ### memberId[​](#memberid "Direct link to memberId") > **memberId**: `number` | `null` Defined in: [packages/sdk/src/types/fhir-connection-types.ts:283](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L283) *** ### reasonCode[​](#reasoncode "Direct link to reasonCode") > **reasonCode**: `string` Defined in: [packages/sdk/src/types/fhir-connection-types.ts:281](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L281) *** ### status[​](#status "Direct link to status") > **status**: [`FhirCsvImportRowStatus`](https://docs.gravityrail.com/sdk/type-aliases/FhirCsvImportRowStatus.md) Defined in: [packages/sdk/src/types/fhir-connection-types.ts:280](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L280) --- # Interface: FhirCsvImportRunSummary Defined in: [packages/sdk/src/types/fhir-connection-types.ts:257](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L257) ## Properties[​](#properties "Direct link to Properties") ### alreadyLinked[​](#alreadylinked "Direct link to alreadyLinked") > **alreadyLinked**: `number` Defined in: [packages/sdk/src/types/fhir-connection-types.ts:265](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L265) *** ### ambiguous[​](#ambiguous "Direct link to ambiguous") > **ambiguous**: `number` Defined in: [packages/sdk/src/types/fhir-connection-types.ts:268](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L268) *** ### completedAt[​](#completedat "Direct link to completedAt") > **completedAt**: `string` | `null` Defined in: [packages/sdk/src/types/fhir-connection-types.ts:261](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L261) *** ### conflicted[​](#conflicted "Direct link to conflicted") > **conflicted**: `number` Defined in: [packages/sdk/src/types/fhir-connection-types.ts:269](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L269) *** ### connectionUuid[​](#connectionuuid "Direct link to connectionUuid") > **connectionUuid**: `string` Defined in: [packages/sdk/src/types/fhir-connection-types.ts:259](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L259) *** ### created[​](#created "Direct link to created") > **created**: `number` Defined in: [packages/sdk/src/types/fhir-connection-types.ts:266](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L266) *** ### failed[​](#failed "Direct link to failed") > **failed**: `number` Defined in: [packages/sdk/src/types/fhir-connection-types.ts:271](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L271) *** ### linked[​](#linked "Direct link to linked") > **linked**: `number` Defined in: [packages/sdk/src/types/fhir-connection-types.ts:264](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L264) *** ### notFound[​](#notfound "Direct link to notFound") > **notFound**: `number` Defined in: [packages/sdk/src/types/fhir-connection-types.ts:270](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L270) *** ### runId[​](#runid "Direct link to runId") > **runId**: `string` Defined in: [packages/sdk/src/types/fhir-connection-types.ts:258](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L258) *** ### skipped[​](#skipped "Direct link to skipped") > **skipped**: `number` Defined in: [packages/sdk/src/types/fhir-connection-types.ts:267](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L267) *** ### startedAt[​](#startedat "Direct link to startedAt") > **startedAt**: `string` Defined in: [packages/sdk/src/types/fhir-connection-types.ts:260](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L260) *** ### status[​](#status "Direct link to status") > **status**: [`FhirCsvImportRunStatus`](https://docs.gravityrail.com/sdk/type-aliases/FhirCsvImportRunStatus.md) Defined in: [packages/sdk/src/types/fhir-connection-types.ts:262](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L262) *** ### terminalError[​](#terminalerror "Direct link to terminalError") > **terminalError**: `string` | `null` Defined in: [packages/sdk/src/types/fhir-connection-types.ts:272](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L272) *** ### total[​](#total "Direct link to total") > **total**: `number` Defined in: [packages/sdk/src/types/fhir-connection-types.ts:263](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L263) --- # Interface: FhirCsvImportSettings Defined in: [packages/sdk/src/types/fhir-connection-types.ts:209](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L209) CSV import settings stored in FhirConnection.vendor\_config. `trustEmail` / `trustPhone` are tri-state. `null` means "inherit from EntitySyncConfig" — the connector adapter falls back to the sync-config member-entity defaults at provisioning time. An explicit `true` / `false` overrides the entity default. `inheritedTrustEmail` / `inheritedTrustPhone` carry the entity-level fallback — the value the runtime would resolve to if the connector override were cleared (i.e. `EntitySyncConfig.trustEmail` / `trustPhone`, or `false` when no member entity exists). The UI uses these for the "Inherit (currently: Trust / Do not trust)" label, which describes what selecting Inherit would do — NOT what the current explicit override resolves to today, since those differ whenever an explicit override disagrees with the entity default. ## Properties[​](#properties "Direct link to Properties") ### allowCreateUnmatched[​](#allowcreateunmatched "Direct link to allowCreateUnmatched") > **allowCreateUnmatched**: `boolean` Defined in: [packages/sdk/src/types/fhir-connection-types.ts:210](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L210) *** ### defaultImportedMemberRoleId[​](#defaultimportedmemberroleid "Direct link to defaultImportedMemberRoleId") > **defaultImportedMemberRoleId**: `number` | `null` Defined in: [packages/sdk/src/types/fhir-connection-types.ts:211](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L211) *** ### inheritedTrustEmail[​](#inheritedtrustemail "Direct link to inheritedTrustEmail") > **inheritedTrustEmail**: `boolean` Defined in: [packages/sdk/src/types/fhir-connection-types.ts:214](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L214) *** ### inheritedTrustPhone[​](#inheritedtrustphone "Direct link to inheritedTrustPhone") > **inheritedTrustPhone**: `boolean` Defined in: [packages/sdk/src/types/fhir-connection-types.ts:215](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L215) *** ### trustEmail[​](#trustemail "Direct link to trustEmail") > **trustEmail**: `boolean` | `null` Defined in: [packages/sdk/src/types/fhir-connection-types.ts:212](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L212) *** ### trustPhone[​](#trustphone "Direct link to trustPhone") > **trustPhone**: `boolean` | `null` Defined in: [packages/sdk/src/types/fhir-connection-types.ts:213](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L213) --- # Interface: FhirCsvInspectResponse Defined in: [packages/sdk/src/types/fhir-connection-types.ts:183](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L183) Response from the CSV inspect endpoint (PHI-minimal). ## Properties[​](#properties "Direct link to Properties") ### columnMeta[​](#columnmeta "Direct link to columnMeta") > **columnMeta**: `Record`<`string`, [`FhirCsvColumnMeta`](https://docs.gravityrail.com/sdk/interfaces/FhirCsvColumnMeta.md)> Defined in: [packages/sdk/src/types/fhir-connection-types.ts:187](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L187) *** ### headers[​](#headers "Direct link to headers") > **headers**: `string`\[] Defined in: [packages/sdk/src/types/fhir-connection-types.ts:184](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L184) *** ### suggestedBirthdateColumn[​](#suggestedbirthdatecolumn "Direct link to suggestedBirthdateColumn") > **suggestedBirthdateColumn**: `string` | `null` Defined in: [packages/sdk/src/types/fhir-connection-types.ts:186](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L186) *** ### suggestedIdentifierColumn[​](#suggestedidentifiercolumn "Direct link to suggestedIdentifierColumn") > **suggestedIdentifierColumn**: `string` | `null` Defined in: [packages/sdk/src/types/fhir-connection-types.ts:185](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L185) --- # Interface: FhirFetchCareTeamRequest Defined in: [packages/sdk/src/types/fhir-connection-types.ts:142](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L142) Request to fetch care team for a patient. ## Properties[​](#properties "Direct link to Properties") ### patientId[​](#patientid "Direct link to patientId") > **patientId**: `string` Defined in: [packages/sdk/src/types/fhir-connection-types.ts:143](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L143) --- # Interface: FhirFetchEncountersRequest Defined in: [packages/sdk/src/types/fhir-connection-types.ts:108](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L108) Request to fetch encounters for a patient. ## Properties[​](#properties "Direct link to Properties") ### patientId[​](#patientid "Direct link to patientId") > **patientId**: `string` Defined in: [packages/sdk/src/types/fhir-connection-types.ts:109](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L109) --- # Interface: FhirMethodResponse Defined in: [packages/sdk/src/types/generated/app\_connection.ts:215](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L215) Response model for FHIR API operations. `skipped` distinguishes an intentional no-op (e.g. manual-unlink exclusion) from an execution failure. Clients should surface a non-destructive toast for `success=True, skipped=True` results. ## Properties[​](#properties "Direct link to Properties") ### data?[​](#data "Direct link to data?") > `optional` **data**: `unknown` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:218](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L218) *** ### message[​](#message "Direct link to message") > **message**: `string` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:217](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L217) *** ### skipped?[​](#skipped "Direct link to skipped?") > `optional` **skipped**: `boolean` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:219](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L219) *** ### success[​](#success "Direct link to success") > **success**: `boolean` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:216](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L216) --- # Interface: FhirSearchLocationsRequest Defined in: [packages/sdk/src/types/fhir-connection-types.ts:134](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L134) Request to search for locations. ## Properties[​](#properties "Direct link to Properties") ### address?[​](#address "Direct link to address?") > `optional` **address**: `string` Defined in: [packages/sdk/src/types/fhir-connection-types.ts:136](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L136) *** ### name?[​](#name "Direct link to name?") > `optional` **name**: `string` Defined in: [packages/sdk/src/types/fhir-connection-types.ts:135](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L135) --- # Interface: FhirSearchPatientsRequest Defined in: [packages/sdk/src/types/fhir-connection-types.ts:115](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L115) Request to search for patients. ## Properties[​](#properties "Direct link to Properties") ### birthdate?[​](#birthdate "Direct link to birthdate?") > `optional` **birthdate**: `string` Defined in: [packages/sdk/src/types/fhir-connection-types.ts:120](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L120) *** ### family?[​](#family "Direct link to family?") > `optional` **family**: `string` Defined in: [packages/sdk/src/types/fhir-connection-types.ts:117](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L117) *** ### given?[​](#given "Direct link to given?") > `optional` **given**: `string` Defined in: [packages/sdk/src/types/fhir-connection-types.ts:118](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L118) *** ### identifier?[​](#identifier "Direct link to identifier?") > `optional` **identifier**: `string` Defined in: [packages/sdk/src/types/fhir-connection-types.ts:119](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L119) *** ### name?[​](#name "Direct link to name?") > `optional` **name**: `string` Defined in: [packages/sdk/src/types/fhir-connection-types.ts:116](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L116) --- # Interface: FhirSearchPractitionersRequest Defined in: [packages/sdk/src/types/fhir-connection-types.ts:126](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L126) Request to search for practitioners. ## Properties[​](#properties "Direct link to Properties") ### identifier?[​](#identifier "Direct link to identifier?") > `optional` **identifier**: `string` Defined in: [packages/sdk/src/types/fhir-connection-types.ts:128](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L128) *** ### name?[​](#name "Direct link to name?") > `optional` **name**: `string` Defined in: [packages/sdk/src/types/fhir-connection-types.ts:127](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L127) --- # Interface: FileAccessAbilityConfig Defined in: [packages/sdk/src/types/ability-types.ts:120](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ability-types.ts#L120) Config for file\_access ability - supports multiple folders and files ## Properties[​](#properties "Direct link to Properties") ### files?[​](#files "Direct link to files?") > `optional` **files**: [`FileAccessEntry`](https://docs.gravityrail.com/sdk/interfaces/FileAccessEntry.md)\[] Defined in: [packages/sdk/src/types/ability-types.ts:124](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ability-types.ts#L124) List of individual files with their access permissions *** ### folders?[​](#folders "Direct link to folders?") > `optional` **folders**: [`FolderAccessEntry`](https://docs.gravityrail.com/sdk/interfaces/FolderAccessEntry.md)\[] Defined in: [packages/sdk/src/types/ability-types.ts:122](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ability-types.ts#L122) List of folders with their access permissions --- # Interface: FileAccessEntry Defined in: [packages/sdk/src/types/ability-types.ts:108](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ability-types.ts#L108) Config for a single file access entry ## Properties[​](#properties "Direct link to Properties") ### canRead?[​](#canread "Direct link to canRead?") > `optional` **canRead**: `boolean` Defined in: [packages/sdk/src/types/ability-types.ts:112](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ability-types.ts#L112) Allow reading file contents (default: true) *** ### canWrite?[​](#canwrite "Direct link to canWrite?") > `optional` **canWrite**: `boolean` Defined in: [packages/sdk/src/types/ability-types.ts:114](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ability-types.ts#L114) Allow writing/editing file contents (default: false) *** ### fileId[​](#fileid "Direct link to fileId") > **fileId**: `number` Defined in: [packages/sdk/src/types/ability-types.ts:110](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ability-types.ts#L110) ID of the file to provide access to *** ### hint?[​](#hint "Direct link to hint?") > `optional` **hint**: `string` Defined in: [packages/sdk/src/types/ability-types.ts:116](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ability-types.ts#L116) Optional hint for the LLM about when/how to use this file --- # Interface: FileAssociationFormData Defined in: [packages/sdk/src/types/task-types.ts:124](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/task-types.ts#L124) ## Properties[​](#properties "Direct link to Properties") ### accessMode?[​](#accessmode "Direct link to accessMode?") > `optional` **accessMode**: `number` Defined in: [packages/sdk/src/types/task-types.ts:126](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/task-types.ts#L126) *** ### fileId[​](#fileid "Direct link to fileId") > **fileId**: `number` Defined in: [packages/sdk/src/types/task-types.ts:125](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/task-types.ts#L125) --- # Interface: FileExport Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:54](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L54) ## Properties[​](#properties "Direct link to Properties") ### access[​](#access "Direct link to access") > **access**: `number` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:60](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L60) *** ### description?[​](#description "Direct link to description?") > `optional` **description**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:58](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L58) *** ### mime\_type[​](#mime_type "Direct link to mime_type") > **mime\_type**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:59](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L59) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:57](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L57) *** ### title[​](#title "Direct link to title") > **title**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:56](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L56) *** ### uuid[​](#uuid "Direct link to uuid") > **uuid**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:55](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L55) --- # Interface: FileExportItem Defined in: [packages/sdk/src/types/file-types.ts:113](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/file-types.ts#L113) ## Properties[​](#properties "Direct link to Properties") ### access[​](#access "Direct link to access") > **access**: `number` Defined in: [packages/sdk/src/types/file-types.ts:119](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/file-types.ts#L119) *** ### description[​](#description "Direct link to description") > **description**: `string` | `null` Defined in: [packages/sdk/src/types/file-types.ts:117](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/file-types.ts#L117) *** ### filename[​](#filename "Direct link to filename") > **filename**: `string` Defined in: [packages/sdk/src/types/file-types.ts:116](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/file-types.ts#L116) *** ### mimeType[​](#mimetype "Direct link to mimeType") > **mimeType**: `string` Defined in: [packages/sdk/src/types/file-types.ts:118](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/file-types.ts#L118) *** ### title[​](#title "Direct link to title") > **title**: `string` Defined in: [packages/sdk/src/types/file-types.ts:115](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/file-types.ts#L115) *** ### uuid[​](#uuid "Direct link to uuid") > **uuid**: `string` Defined in: [packages/sdk/src/types/file-types.ts:114](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/file-types.ts#L114) --- # Interface: FileFolderExport Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:274](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L274) ## Properties[​](#properties "Direct link to Properties") ### access[​](#access "Direct link to access") > **access**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:279](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L279) *** ### description?[​](#description "Direct link to description?") > `optional` **description**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:277](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L277) *** ### index[​](#index "Direct link to index") > **index**: `boolean` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:280](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L280) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:276](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L276) *** ### parentUuid?[​](#parentuuid "Direct link to parentUuid?") > `optional` **parentUuid**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:278](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L278) *** ### uuid[​](#uuid "Direct link to uuid") > **uuid**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:275](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L275) --- # Interface: FileFolderFormData Defined in: [packages/sdk/src/types/file-types.ts:94](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/file-types.ts#L94) ## Properties[​](#properties "Direct link to Properties") ### access?[​](#access "Direct link to access?") > `optional` **access**: [`AccessLevel`](https://docs.gravityrail.com/sdk/enumerations/AccessLevel.md) Defined in: [packages/sdk/src/types/file-types.ts:98](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/file-types.ts#L98) *** ### description?[​](#description "Direct link to description?") > `optional` **description**: `string` Defined in: [packages/sdk/src/types/file-types.ts:96](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/file-types.ts#L96) *** ### index?[​](#index "Direct link to index?") > `optional` **index**: `boolean` Defined in: [packages/sdk/src/types/file-types.ts:99](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/file-types.ts#L99) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/file-types.ts:95](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/file-types.ts#L95) *** ### parentId?[​](#parentid "Direct link to parentId?") > `optional` **parentId**: `number` Defined in: [packages/sdk/src/types/file-types.ts:97](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/file-types.ts#L97) --- # Interface: FileFolderRelation Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:334](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L334) ## Properties[​](#properties "Direct link to Properties") ### fileUuid[​](#fileuuid "Direct link to fileUuid") > **fileUuid**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:335](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L335) *** ### folderUuid[​](#folderuuid "Direct link to folderUuid") > **folderUuid**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:336](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L336) --- # Interface: FileFolderResponse Defined in: [packages/sdk/src/types/generated/file.ts:69](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/file.ts#L69) Response model for file directory endpoints. Flat representation — no nested parent/children/files. Use separate endpoints to list children (GET /folders?parent\_id=X) and files (GET /files?folder\_id=X). ## Properties[​](#properties "Direct link to Properties") ### access?[​](#access "Direct link to access?") > `optional` **access**: `string` Defined in: [packages/sdk/src/types/generated/file.ts:79](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/file.ts#L79) *** ### ancestors?[​](#ancestors "Direct link to ancestors?") > `optional` **ancestors**: [`FolderPathSegment`](https://docs.gravityrail.com/sdk/interfaces/FolderPathSegment.md)\[] Defined in: [packages/sdk/src/types/generated/file.ts:86](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/file.ts#L86) *** ### childCount?[​](#childcount "Direct link to childCount?") > `optional` **childCount**: `number` Defined in: [packages/sdk/src/types/generated/file.ts:77](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/file.ts#L77) *** ### createdAt[​](#createdat "Direct link to createdAt") > **createdAt**: `string` Defined in: [packages/sdk/src/types/generated/file.ts:84](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/file.ts#L84) *** ### description?[​](#description "Direct link to description?") > `optional` **description**: `string` | `null` Defined in: [packages/sdk/src/types/generated/file.ts:74](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/file.ts#L74) *** ### fileCount?[​](#filecount "Direct link to fileCount?") > `optional` **fileCount**: `number` Defined in: [packages/sdk/src/types/generated/file.ts:78](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/file.ts#L78) *** ### id[​](#id "Direct link to id") > **id**: `number` Defined in: [packages/sdk/src/types/generated/file.ts:70](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/file.ts#L70) *** ### index?[​](#index "Direct link to index?") > `optional` **index**: `boolean` Defined in: [packages/sdk/src/types/generated/file.ts:81](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/file.ts#L81) *** ### indexingCompletedAt?[​](#indexingcompletedat "Direct link to indexingCompletedAt?") > `optional` **indexingCompletedAt**: `string` | `null` Defined in: [packages/sdk/src/types/generated/file.ts:83](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/file.ts#L83) *** ### indexingStartedAt?[​](#indexingstartedat "Direct link to indexingStartedAt?") > `optional` **indexingStartedAt**: `string` | `null` Defined in: [packages/sdk/src/types/generated/file.ts:82](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/file.ts#L82) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/generated/file.ts:71](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/file.ts#L71) *** ### ownerId?[​](#ownerid "Direct link to ownerId?") > `optional` **ownerId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/file.ts:76](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/file.ts#L76) *** ### parentId?[​](#parentid "Direct link to parentId?") > `optional` **parentId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/file.ts:75](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/file.ts#L75) *** ### path?[​](#path "Direct link to path?") > `optional` **path**: `string` | `null` Defined in: [packages/sdk/src/types/generated/file.ts:73](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/file.ts#L73) *** ### shareable?[​](#shareable "Direct link to shareable?") > `optional` **shareable**: `boolean` Defined in: [packages/sdk/src/types/generated/file.ts:80](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/file.ts#L80) *** ### updatedAt[​](#updatedat "Direct link to updatedAt") > **updatedAt**: `string` Defined in: [packages/sdk/src/types/generated/file.ts:85](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/file.ts#L85) *** ### uuid[​](#uuid "Direct link to uuid") > **uuid**: `string` Defined in: [packages/sdk/src/types/generated/file.ts:72](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/file.ts#L72) --- # Interface: FileFormData Defined in: [packages/sdk/src/types/file-types.ts:57](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/file-types.ts#L57) ## Properties[​](#properties "Direct link to Properties") ### access?[​](#access "Direct link to access?") > `optional` **access**: [`AccessLevel`](https://docs.gravityrail.com/sdk/enumerations/AccessLevel.md) Defined in: [packages/sdk/src/types/file-types.ts:69](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/file-types.ts#L69) *** ### cdnUrl?[​](#cdnurl "Direct link to cdnUrl?") > `optional` **cdnUrl**: `string` Defined in: [packages/sdk/src/types/file-types.ts:71](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/file-types.ts#L71) *** ### data?[​](#data "Direct link to data?") > `optional` **data**: `string` Defined in: [packages/sdk/src/types/file-types.ts:64](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/file-types.ts#L64) *** ### dataBase64?[​](#database64 "Direct link to dataBase64?") > `optional` **dataBase64**: `string` Defined in: [packages/sdk/src/types/file-types.ts:65](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/file-types.ts#L65) *** ### description?[​](#description "Direct link to description?") > `optional` **description**: `string` Defined in: [packages/sdk/src/types/file-types.ts:60](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/file-types.ts#L60) *** ### externalId?[​](#externalid "Direct link to externalId?") > `optional` **externalId**: `string` Defined in: [packages/sdk/src/types/file-types.ts:66](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/file-types.ts#L66) *** ### filename[​](#filename "Direct link to filename") > **filename**: `string` Defined in: [packages/sdk/src/types/file-types.ts:59](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/file-types.ts#L59) *** ### fileSize?[​](#filesize "Direct link to fileSize?") > `optional` **fileSize**: `number` Defined in: [packages/sdk/src/types/file-types.ts:72](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/file-types.ts#L72) *** ### folderId?[​](#folderid "Direct link to folderId?") > `optional` **folderId**: `number` Defined in: [packages/sdk/src/types/file-types.ts:62](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/file-types.ts#L62) *** ### labelIds?[​](#labelids "Direct link to labelIds?") > `optional` **labelIds**: `number`\[] Defined in: [packages/sdk/src/types/file-types.ts:73](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/file-types.ts#L73) *** ### mimeType[​](#mimetype "Direct link to mimeType") > **mimeType**: `string` Defined in: [packages/sdk/src/types/file-types.ts:61](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/file-types.ts#L61) *** ### oauthCredentialId?[​](#oauthcredentialid "Direct link to oauthCredentialId?") > `optional` **oauthCredentialId**: `number` Defined in: [packages/sdk/src/types/file-types.ts:68](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/file-types.ts#L68) *** ### oauthCredentialUuid?[​](#oauthcredentialuuid "Direct link to oauthCredentialUuid?") > `optional` **oauthCredentialUuid**: `string` Defined in: [packages/sdk/src/types/file-types.ts:67](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/file-types.ts#L67) *** ### overwrite?[​](#overwrite "Direct link to overwrite?") > `optional` **overwrite**: `boolean` Defined in: [packages/sdk/src/types/file-types.ts:74](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/file-types.ts#L74) *** ### s3Key?[​](#s3key "Direct link to s3Key?") > `optional` **s3Key**: `string` Defined in: [packages/sdk/src/types/file-types.ts:70](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/file-types.ts#L70) *** ### siteId?[​](#siteid "Direct link to siteId?") > `optional` **siteId**: `number` Defined in: [packages/sdk/src/types/file-types.ts:63](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/file-types.ts#L63) *** ### title?[​](#title "Direct link to title?") > `optional` **title**: `string` Defined in: [packages/sdk/src/types/file-types.ts:58](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/file-types.ts#L58) --- # Interface: FileLabelExport Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:283](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L283) ## Properties[​](#properties "Direct link to Properties") ### color[​](#color "Direct link to color") > **color**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:286](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L286) *** ### description?[​](#description "Direct link to description?") > `optional` **description**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:287](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L287) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:285](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L285) *** ### uuid[​](#uuid "Direct link to uuid") > **uuid**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:284](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L284) --- # Interface: FileLabelFormData Defined in: [packages/sdk/src/types/file-types.ts:51](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/file-types.ts#L51) ## Properties[​](#properties "Direct link to Properties") ### color[​](#color "Direct link to color") > **color**: `string` Defined in: [packages/sdk/src/types/file-types.ts:53](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/file-types.ts#L53) *** ### description?[​](#description "Direct link to description?") > `optional` **description**: `string` Defined in: [packages/sdk/src/types/file-types.ts:54](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/file-types.ts#L54) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/file-types.ts:52](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/file-types.ts#L52) --- # Interface: FileLabelRelation Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:339](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L339) ## Properties[​](#properties "Direct link to Properties") ### fileLabelUuid[​](#filelabeluuid "Direct link to fileLabelUuid") > **fileLabelUuid**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:341](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L341) *** ### fileUuid[​](#fileuuid "Direct link to fileUuid") > **fileUuid**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:340](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L340) --- # Interface: FileLabelResponse Defined in: [packages/sdk/src/types/generated/file.ts:92](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/file.ts#L92) Response model for file label endpoints. ## Properties[​](#properties "Direct link to Properties") ### color[​](#color "Direct link to color") > **color**: `string` Defined in: [packages/sdk/src/types/generated/file.ts:96](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/file.ts#L96) *** ### description[​](#description "Direct link to description") > **description**: `string` | `null` Defined in: [packages/sdk/src/types/generated/file.ts:97](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/file.ts#L97) *** ### id[​](#id "Direct link to id") > **id**: `number` Defined in: [packages/sdk/src/types/generated/file.ts:93](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/file.ts#L93) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/generated/file.ts:95](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/file.ts#L95) *** ### uuid[​](#uuid "Direct link to uuid") > **uuid**: `string` Defined in: [packages/sdk/src/types/generated/file.ts:94](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/file.ts#L94) --- # Interface: FileRoleAssociationResponse Defined in: [packages/sdk/src/types/generated/file.ts:132](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/file.ts#L132) Response model for a file/folder role association. ## Properties[​](#properties "Direct link to Properties") ### accessMode[​](#accessmode "Direct link to accessMode") > **accessMode**: `number` Defined in: [packages/sdk/src/types/generated/file.ts:135](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/file.ts#L135) *** ### memberRoleId[​](#memberroleid "Direct link to memberRoleId") > **memberRoleId**: `number` Defined in: [packages/sdk/src/types/generated/file.ts:133](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/file.ts#L133) *** ### memberRoleName[​](#memberrolename "Direct link to memberRoleName") > **memberRoleName**: `string` Defined in: [packages/sdk/src/types/generated/file.ts:134](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/file.ts#L134) --- # Interface: FilesQueryParams Defined in: [packages/sdk/src/types/file-types.ts:128](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/file-types.ts#L128) ## Properties[​](#properties "Direct link to Properties") ### folderId?[​](#folderid "Direct link to folderId?") > `optional` **folderId**: `number` Defined in: [packages/sdk/src/types/file-types.ts:133](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/file-types.ts#L133) *** ### page?[​](#page "Direct link to page?") > `optional` **page**: `number` Defined in: [packages/sdk/src/types/file-types.ts:129](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/file-types.ts#L129) *** ### pageSize?[​](#pagesize "Direct link to pageSize?") > `optional` **pageSize**: `number` Defined in: [packages/sdk/src/types/file-types.ts:130](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/file-types.ts#L130) *** ### search?[​](#search "Direct link to search?") > `optional` **search**: `string` Defined in: [packages/sdk/src/types/file-types.ts:134](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/file-types.ts#L134) *** ### sortBy?[​](#sortby "Direct link to sortBy?") > `optional` **sortBy**: [`FileSortField`](https://docs.gravityrail.com/sdk/type-aliases/FileSortField.md) Defined in: [packages/sdk/src/types/file-types.ts:131](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/file-types.ts#L131) *** ### sortOrder?[​](#sortorder "Direct link to sortOrder?") > `optional` **sortOrder**: [`SortOrder`](https://docs.gravityrail.com/sdk/type-aliases/SortOrder.md) Defined in: [packages/sdk/src/types/file-types.ts:132](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/file-types.ts#L132) --- # Interface: FileUploadRequest Defined in: [packages/sdk/src/types/file-types.ts:137](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/file-types.ts#L137) ## Properties[​](#properties "Direct link to Properties") ### contentType[​](#contenttype "Direct link to contentType") > **contentType**: `string` Defined in: [packages/sdk/src/types/file-types.ts:138](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/file-types.ts#L138) *** ### fileExtension[​](#fileextension "Direct link to fileExtension") > **fileExtension**: `string` Defined in: [packages/sdk/src/types/file-types.ts:139](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/file-types.ts#L139) --- # Interface: FileUploadResponse Defined in: [packages/sdk/src/types/generated/file.ts:161](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/file.ts#L161) Response model for file upload presigned URL. ## Properties[​](#properties "Direct link to Properties") ### fields[​](#fields "Direct link to fields") > **fields**: `FileUploadResponseFields` Defined in: [packages/sdk/src/types/generated/file.ts:163](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/file.ts#L163) *** ### fileUrl[​](#fileurl "Direct link to fileUrl") > **fileUrl**: `string` Defined in: [packages/sdk/src/types/generated/file.ts:164](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/file.ts#L164) *** ### uploadUrl[​](#uploadurl "Direct link to uploadUrl") > **uploadUrl**: `string` Defined in: [packages/sdk/src/types/generated/file.ts:162](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/file.ts#L162) --- # Interface: FileWithAccessModeFormData Defined in: [packages/sdk/src/types/file-types.ts:107](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/file-types.ts#L107) ## Properties[​](#properties "Direct link to Properties") ### accessMode[​](#accessmode "Direct link to accessMode") > **accessMode**: `number` Defined in: [packages/sdk/src/types/file-types.ts:109](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/file-types.ts#L109) *** ### choicePrompt?[​](#choiceprompt "Direct link to choicePrompt?") > `optional` **choicePrompt**: `string` | `null` Defined in: [packages/sdk/src/types/file-types.ts:110](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/file-types.ts#L110) *** ### id[​](#id "Direct link to id") > **id**: `number` Defined in: [packages/sdk/src/types/file-types.ts:108](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/file-types.ts#L108) --- # Interface: FirstRunState Defined in: [packages/sdk/src/types/workspace-types.ts:57](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/workspace-types.ts#L57) ## Properties[​](#properties "Direct link to Properties") ### collapsed?[​](#collapsed "Direct link to collapsed?") > `optional` **collapsed**: `boolean` Defined in: [packages/sdk/src/types/workspace-types.ts:60](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/workspace-types.ts#L60) *** ### mode[​](#mode "Direct link to mode") > **mode**: [`FirstRunMode`](https://docs.gravityrail.com/sdk/type-aliases/FirstRunMode.md) Defined in: [packages/sdk/src/types/workspace-types.ts:58](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/workspace-types.ts#L58) *** ### statuses?[​](#statuses "Direct link to statuses?") > `optional` **statuses**: `Record`<`string`, `string`> Defined in: [packages/sdk/src/types/workspace-types.ts:59](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/workspace-types.ts#L59) --- # Interface: FolderAccessEntry Defined in: [packages/sdk/src/types/ability-types.ts:92](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ability-types.ts#L92) Config for a single folder access entry ## Properties[​](#properties "Direct link to Properties") ### canCreate?[​](#cancreate "Direct link to canCreate?") > `optional` **canCreate**: `boolean` Defined in: [packages/sdk/src/types/ability-types.ts:102](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ability-types.ts#L102) Allow creating new files in the folder (default: false) *** ### canList?[​](#canlist "Direct link to canList?") > `optional` **canList**: `boolean` Defined in: [packages/sdk/src/types/ability-types.ts:98](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ability-types.ts#L98) Allow listing folder contents (default: true) *** ### canRead?[​](#canread "Direct link to canRead?") > `optional` **canRead**: `boolean` Defined in: [packages/sdk/src/types/ability-types.ts:96](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ability-types.ts#L96) Allow reading file contents (default: true) *** ### canSearch?[​](#cansearch "Direct link to canSearch?") > `optional` **canSearch**: `boolean` Defined in: [packages/sdk/src/types/ability-types.ts:100](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ability-types.ts#L100) Allow searching files (requires folder to be indexed, default: false) *** ### folderId[​](#folderid "Direct link to folderId") > **folderId**: `number` Defined in: [packages/sdk/src/types/ability-types.ts:94](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ability-types.ts#L94) ID of the folder to provide access to *** ### hint?[​](#hint "Direct link to hint?") > `optional` **hint**: `string` Defined in: [packages/sdk/src/types/ability-types.ts:104](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ability-types.ts#L104) Optional hint for the LLM about when/how to use this folder --- # Interface: FolderMemberRoleRelation Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:344](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L344) ## Properties[​](#properties "Direct link to Properties") ### accessMode[​](#accessmode "Direct link to accessMode") > **accessMode**: `number` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:347](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L347) *** ### folderUuid[​](#folderuuid "Direct link to folderUuid") > **folderUuid**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:345](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L345) *** ### memberRoleUuid[​](#memberroleuuid "Direct link to memberRoleUuid") > **memberRoleUuid**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:346](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L346) --- # Interface: FolderPathSegment Defined in: [packages/sdk/src/types/generated/file.ts:172](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/file.ts#L172) One crumb in a folder's root→self path, for breadcrumb address bars. ## Properties[​](#properties "Direct link to Properties") ### id[​](#id "Direct link to id") > **id**: `number` Defined in: [packages/sdk/src/types/generated/file.ts:173](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/file.ts#L173) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/generated/file.ts:174](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/file.ts#L174) --- # Interface: FolderSearchParams Defined in: [packages/sdk/src/types/file-types.ts:142](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/file-types.ts#L142) ## Properties[​](#properties "Direct link to Properties") ### query[​](#query "Direct link to query") > **query**: `string` Defined in: [packages/sdk/src/types/file-types.ts:143](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/file-types.ts#L143) *** ### topK?[​](#topk "Direct link to topK?") > `optional` **topK**: `number` Defined in: [packages/sdk/src/types/file-types.ts:144](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/file-types.ts#L144) --- # Interface: FolderSearchResultResponse Defined in: [packages/sdk/src/types/generated/file.ts:180](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/file.ts#L180) Response model for folder search results. ## Properties[​](#properties "Direct link to Properties") ### content[​](#content "Direct link to content") > **content**: `string` Defined in: [packages/sdk/src/types/generated/file.ts:181](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/file.ts#L181) *** ### fileId[​](#fileid "Direct link to fileId") > **fileId**: `number` Defined in: [packages/sdk/src/types/generated/file.ts:182](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/file.ts#L182) *** ### filename[​](#filename "Direct link to filename") > **filename**: `string` Defined in: [packages/sdk/src/types/generated/file.ts:184](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/file.ts#L184) *** ### fileUuid[​](#fileuuid "Direct link to fileUuid") > **fileUuid**: `string` Defined in: [packages/sdk/src/types/generated/file.ts:183](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/file.ts#L183) *** ### metadata[​](#metadata "Direct link to metadata") > **metadata**: `FolderSearchResultResponseMetadata` Defined in: [packages/sdk/src/types/generated/file.ts:188](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/file.ts#L188) *** ### mimeType[​](#mimetype "Direct link to mimeType") > **mimeType**: `string` Defined in: [packages/sdk/src/types/generated/file.ts:186](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/file.ts#L186) *** ### score[​](#score "Direct link to score") > **score**: `number` Defined in: [packages/sdk/src/types/generated/file.ts:187](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/file.ts#L187) *** ### title[​](#title "Direct link to title") > **title**: `string` | `null` Defined in: [packages/sdk/src/types/generated/file.ts:185](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/file.ts#L185) --- # Interface: FormFieldUpdateActionParams Defined in: [packages/sdk/src/types/event-types.ts:253](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L253) ## Properties[​](#properties "Direct link to Properties") ### createIfMissing?[​](#createifmissing "Direct link to createIfMissing?") > `optional` **createIfMissing**: `boolean` Defined in: [packages/sdk/src/types/event-types.ts:264](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L264) *** ### fieldPath?[​](#fieldpath "Direct link to fieldPath?") > `optional` **fieldPath**: `string` Defined in: [packages/sdk/src/types/event-types.ts:254](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L254) *** ### matchField?[​](#matchfield "Direct link to matchField?") > `optional` **matchField**: `string` Defined in: [packages/sdk/src/types/event-types.ts:258](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L258) *** ### matchValue?[​](#matchvalue "Direct link to matchValue?") > `optional` **matchValue**: `any` Defined in: [packages/sdk/src/types/event-types.ts:259](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L259) *** ### selector?[​](#selector "Direct link to selector?") > `optional` **selector**: `string` Defined in: [packages/sdk/src/types/event-types.ts:262](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L262) *** ### tiebreaker?[​](#tiebreaker "Direct link to tiebreaker?") > `optional` **tiebreaker**: `"newest"` | `"oldest"` Defined in: [packages/sdk/src/types/event-types.ts:260](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L260) *** ### updateType?[​](#updatetype "Direct link to updateType?") > `optional` **updateType**: `"create"` | `"newest"` | `"oldest"` | `"trigger"` | `"matchField"` | `"selector"` Defined in: [packages/sdk/src/types/event-types.ts:256](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L256) *** ### value[​](#value "Direct link to value") > **value**: `any` Defined in: [packages/sdk/src/types/event-types.ts:255](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L255) --- # Interface: ForwardingNumberDef Defined in: [packages/sdk/src/types/ability-types.ts:202](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ability-types.ts#L202) A single forwarding number in the ability config ## Properties[​](#properties "Direct link to Properties") ### celCondition?[​](#celcondition "Direct link to celCondition?") > `optional` **celCondition**: `string` Defined in: [packages/sdk/src/types/ability-types.ts:210](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ability-types.ts#L210) CEL expression that must evaluate to true for this number to be available *** ### choicePrompt?[​](#choiceprompt "Direct link to choicePrompt?") > `optional` **choicePrompt**: `string` Defined in: [packages/sdk/src/types/ability-types.ts:208](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ability-types.ts#L208) Hint for the LLM about when to use this number (e.g., 'for billing inquiries') *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/ability-types.ts:204](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ability-types.ts#L204) Human-readable name for this forwarding destination (e.g., 'Billing Department') *** ### phoneNumber[​](#phonenumber "Direct link to phoneNumber") > **phoneNumber**: `string` Defined in: [packages/sdk/src/types/ability-types.ts:206](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ability-types.ts#L206) Phone number in E.164 format (e.g., '+15551234567') --- # Interface: FunctionTool Defined in: [packages/sdk/src/types/chat-types.ts:159](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L159) ## Properties[​](#properties "Direct link to Properties") ### function[​](#function "Direct link to function") > **function**: `object` Defined in: [packages/sdk/src/types/chat-types.ts:161](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L161) #### description?[​](#description "Direct link to description?") > `optional` **description**: `string` #### name[​](#name "Direct link to name") > **name**: `string` #### parameters[​](#parameters "Direct link to parameters") > **parameters**: `Record`<`string`, `unknown`> *** ### type[​](#type "Direct link to type") > **type**: `"function"` Defined in: [packages/sdk/src/types/chat-types.ts:160](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L160) --- # Interface: GeminiChatModelConfig Defined in: [packages/sdk/src/types/model-config-types.ts:149](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/model-config-types.ts#L149) Base configuration for all chat models. Can be extended for provider-specific options. ## Extends[​](#extends "Direct link to Extends") * [`BaseChatModelConfig`](https://docs.gravityrail.com/sdk/interfaces/BaseChatModelConfig.md) ## Properties[​](#properties "Direct link to Properties") ### includeThoughts?[​](#includethoughts "Direct link to includeThoughts?") > `optional` **includeThoughts**: `boolean` | `null` Defined in: [packages/sdk/src/types/model-config-types.ts:151](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/model-config-types.ts#L151) *** ### thinkingLevel?[​](#thinkinglevel "Direct link to thinkingLevel?") > `optional` **thinkingLevel**: [`GeminiThinkingLevel`](https://docs.gravityrail.com/sdk/type-aliases/GeminiThinkingLevel.md) | `null` Defined in: [packages/sdk/src/types/model-config-types.ts:150](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/model-config-types.ts#L150) --- # Interface: GeminiRealtimeModelConfig Defined in: [packages/sdk/src/types/model-config-types.ts:89](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/model-config-types.ts#L89) Base configuration for all realtime models. Contains common fields that apply to all realtime model providers. ## Extends[​](#extends "Direct link to Extends") * [`BaseRealtimeModelConfig`](https://docs.gravityrail.com/sdk/interfaces/BaseRealtimeModelConfig.md) ## Properties[​](#properties "Direct link to Properties") ### interruptionSound?[​](#interruptionsound "Direct link to interruptionSound?") > `optional` **interruptionSound**: [`InterruptionSound`](https://docs.gravityrail.com/sdk/type-aliases/InterruptionSound.md) | `null` Defined in: [packages/sdk/src/types/model-config-types.ts:69](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/model-config-types.ts#L69) Sound to play when user stops speaking after interrupting the assistant. Provides immediate auditory feedback that input was received. Default: none. #### Inherited from[​](#inherited-from "Direct link to Inherited from") [`BaseRealtimeModelConfig`](https://docs.gravityrail.com/sdk/interfaces/BaseRealtimeModelConfig.md).[`interruptionSound`](https://docs.gravityrail.com/sdk/interfaces/BaseRealtimeModelConfig.md#interruptionsound) *** ### interruptionSoundVolume?[​](#interruptionsoundvolume "Direct link to interruptionSoundVolume?") > `optional` **interruptionSoundVolume**: `number` | `null` Defined in: [packages/sdk/src/types/model-config-types.ts:71](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/model-config-types.ts#L71) Volume level for the interruption sound (0-100). 0 means muted. Missing or null means full volume (100). #### Inherited from[​](#inherited-from-1 "Direct link to Inherited from") [`BaseRealtimeModelConfig`](https://docs.gravityrail.com/sdk/interfaces/BaseRealtimeModelConfig.md).[`interruptionSoundVolume`](https://docs.gravityrail.com/sdk/interfaces/BaseRealtimeModelConfig.md#interruptionsoundvolume) *** ### thinkingSound?[​](#thinkingsound "Direct link to thinkingSound?") > `optional` **thinkingSound**: [`ThinkingSound`](https://docs.gravityrail.com/sdk/type-aliases/ThinkingSound.md) | `null` Defined in: [packages/sdk/src/types/model-config-types.ts:61](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/model-config-types.ts#L61) Sound to play while the agent is processing tool calls. #### Inherited from[​](#inherited-from-2 "Direct link to Inherited from") [`BaseRealtimeModelConfig`](https://docs.gravityrail.com/sdk/interfaces/BaseRealtimeModelConfig.md).[`thinkingSound`](https://docs.gravityrail.com/sdk/interfaces/BaseRealtimeModelConfig.md#thinkingsound) *** ### thinkingSoundInitialDelay?[​](#thinkingsoundinitialdelay "Direct link to thinkingSoundInitialDelay?") > `optional` **thinkingSoundInitialDelay**: `number` | `null` Defined in: [packages/sdk/src/types/model-config-types.ts:65](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/model-config-types.ts#L65) Initial delay in milliseconds before playing thinking sound. Prevents needless interruption on short tool calls. Default: 500ms. #### Inherited from[​](#inherited-from-3 "Direct link to Inherited from") [`BaseRealtimeModelConfig`](https://docs.gravityrail.com/sdk/interfaces/BaseRealtimeModelConfig.md).[`thinkingSoundInitialDelay`](https://docs.gravityrail.com/sdk/interfaces/BaseRealtimeModelConfig.md#thinkingsoundinitialdelay) *** ### thinkingSoundVolume?[​](#thinkingsoundvolume "Direct link to thinkingSoundVolume?") > `optional` **thinkingSoundVolume**: `number` | `null` Defined in: [packages/sdk/src/types/model-config-types.ts:63](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/model-config-types.ts#L63) Volume level for the thinking sound (0-100). 0 means muted. Missing or null means full volume (100). #### Inherited from[​](#inherited-from-4 "Direct link to Inherited from") [`BaseRealtimeModelConfig`](https://docs.gravityrail.com/sdk/interfaces/BaseRealtimeModelConfig.md).[`thinkingSoundVolume`](https://docs.gravityrail.com/sdk/interfaces/BaseRealtimeModelConfig.md#thinkingsoundvolume) *** ### thinkingSpeechPhrases?[​](#thinkingspeechphrases "Direct link to thinkingSpeechPhrases?") > `optional` **thinkingSpeechPhrases**: `string`\[] | `null` Defined in: [packages/sdk/src/types/model-config-types.ts:67](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/model-config-types.ts#L67) When `thinkingSound` is 'speech', one of these phrases is spoken while the agent runs a tool. Phrases rotate round-robin per session. #### Inherited from[​](#inherited-from-5 "Direct link to Inherited from") [`BaseRealtimeModelConfig`](https://docs.gravityrail.com/sdk/interfaces/BaseRealtimeModelConfig.md).[`thinkingSpeechPhrases`](https://docs.gravityrail.com/sdk/interfaces/BaseRealtimeModelConfig.md#thinkingspeechphrases) *** ### ttsModel?[​](#ttsmodel "Direct link to ttsModel?") > `optional` **ttsModel**: `"native"` | `null` Defined in: [packages/sdk/src/types/model-config-types.ts:90](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/model-config-types.ts#L90) TTS model ID in provider:tts:model format (e.g. 'elevenlabs:tts:eleven\_flash\_v2\_5'), or 'native'. #### Overrides[​](#overrides "Direct link to Overrides") [`BaseRealtimeModelConfig`](https://docs.gravityrail.com/sdk/interfaces/BaseRealtimeModelConfig.md).[`ttsModel`](https://docs.gravityrail.com/sdk/interfaces/BaseRealtimeModelConfig.md#ttsmodel) *** ### voiceModel?[​](#voicemodel "Direct link to voiceModel?") > `optional` **voiceModel**: `string` | `null` Defined in: [packages/sdk/src/types/model-config-types.ts:75](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/model-config-types.ts#L75) Canonical voice identifier (e.g., elevenlabs:voice:catt) that selects the specific agent voice. #### Inherited from[​](#inherited-from-6 "Direct link to Inherited from") [`BaseRealtimeModelConfig`](https://docs.gravityrail.com/sdk/interfaces/BaseRealtimeModelConfig.md).[`voiceModel`](https://docs.gravityrail.com/sdk/interfaces/BaseRealtimeModelConfig.md#voicemodel) --- # Interface: GeneratedAccessGrantResponse Defined in: [packages/sdk/src/types/generated/access\_grant.ts:28](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/access_grant.ts#L28) Response model for an access grant. ## Properties[​](#properties "Direct link to Properties") ### accessMode[​](#accessmode "Direct link to accessMode") > **accessMode**: `number` Defined in: [packages/sdk/src/types/generated/access\_grant.ts:42](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/access_grant.ts#L42) *** ### assignmentId?[​](#assignmentid "Direct link to assignmentId?") > `optional` **assignmentId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/access\_grant.ts:45](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/access_grant.ts#L45) *** ### bounds?[​](#bounds "Direct link to bounds?") > `optional` **bounds**: `AccessGrantResponseBounds` Defined in: [packages/sdk/src/types/generated/access\_grant.ts:41](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/access_grant.ts#L41) *** ### capabilityClass?[​](#capabilityclass "Direct link to capabilityClass?") > `optional` **capabilityClass**: `string` | `null` Defined in: [packages/sdk/src/types/generated/access\_grant.ts:40](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/access_grant.ts#L40) *** ### chatId?[​](#chatid "Direct link to chatId?") > `optional` **chatId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/access\_grant.ts:46](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/access_grant.ts#L46) *** ### consentMethod?[​](#consentmethod "Direct link to consentMethod?") > `optional` **consentMethod**: `string` | `null` Defined in: [packages/sdk/src/types/generated/access\_grant.ts:48](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/access_grant.ts#L48) *** ### createdAt[​](#createdat "Direct link to createdAt") > **createdAt**: `string` Defined in: [packages/sdk/src/types/generated/access\_grant.ts:54](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/access_grant.ts#L54) *** ### dataTypeId?[​](#datatypeid "Direct link to dataTypeId?") > `optional` **dataTypeId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/access\_grant.ts:38](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/access_grant.ts#L38) *** ### dataTypeName?[​](#datatypename "Direct link to dataTypeName?") > `optional` **dataTypeName**: `string` | `null` Defined in: [packages/sdk/src/types/generated/access\_grant.ts:39](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/access_grant.ts#L39) *** ### expiresAt?[​](#expiresat "Direct link to expiresAt?") > `optional` **expiresAt**: `string` | `null` Defined in: [packages/sdk/src/types/generated/access\_grant.ts:49](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/access_grant.ts#L49) *** ### granteeMemberId[​](#granteememberid "Direct link to granteeMemberId") > **granteeMemberId**: `number` Defined in: [packages/sdk/src/types/generated/access\_grant.ts:33](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/access_grant.ts#L33) *** ### granteeMemberName?[​](#granteemembername "Direct link to granteeMemberName?") > `optional` **granteeMemberName**: `string` | `null` Defined in: [packages/sdk/src/types/generated/access\_grant.ts:34](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/access_grant.ts#L34) *** ### grantorMemberId[​](#grantormemberid "Direct link to grantorMemberId") > **grantorMemberId**: `number` Defined in: [packages/sdk/src/types/generated/access\_grant.ts:31](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/access_grant.ts#L31) *** ### grantorMemberName?[​](#grantormembername "Direct link to grantorMemberName?") > `optional` **grantorMemberName**: `string` | `null` Defined in: [packages/sdk/src/types/generated/access\_grant.ts:32](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/access_grant.ts#L32) *** ### id[​](#id "Direct link to id") > **id**: `number` Defined in: [packages/sdk/src/types/generated/access\_grant.ts:29](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/access_grant.ts#L29) *** ### memberCredentialId?[​](#membercredentialid "Direct link to memberCredentialId?") > `optional` **memberCredentialId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/access\_grant.ts:44](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/access_grant.ts#L44) *** ### resolvedAt?[​](#resolvedat "Direct link to resolvedAt?") > `optional` **resolvedAt**: `string` | `null` Defined in: [packages/sdk/src/types/generated/access\_grant.ts:55](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/access_grant.ts#L55) *** ### resourceId?[​](#resourceid "Direct link to resourceId?") > `optional` **resourceId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/access\_grant.ts:36](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/access_grant.ts#L36) *** ### resourceLabel?[​](#resourcelabel "Direct link to resourceLabel?") > `optional` **resourceLabel**: `string` | `null` Defined in: [packages/sdk/src/types/generated/access\_grant.ts:37](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/access_grant.ts#L37) *** ### resourceType[​](#resourcetype "Direct link to resourceType") > **resourceType**: `string` Defined in: [packages/sdk/src/types/generated/access\_grant.ts:35](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/access_grant.ts#L35) *** ### revocationReason?[​](#revocationreason "Direct link to revocationReason?") > `optional` **revocationReason**: `string` | `null` Defined in: [packages/sdk/src/types/generated/access\_grant.ts:53](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/access_grant.ts#L53) *** ### revokedAt?[​](#revokedat "Direct link to revokedAt?") > `optional` **revokedAt**: `string` | `null` Defined in: [packages/sdk/src/types/generated/access\_grant.ts:50](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/access_grant.ts#L50) *** ### revokedByMemberId?[​](#revokedbymemberid "Direct link to revokedByMemberId?") > `optional` **revokedByMemberId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/access\_grant.ts:51](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/access_grant.ts#L51) *** ### revokedByMemberName?[​](#revokedbymembername "Direct link to revokedByMemberName?") > `optional` **revokedByMemberName**: `string` | `null` Defined in: [packages/sdk/src/types/generated/access\_grant.ts:52](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/access_grant.ts#L52) *** ### status[​](#status "Direct link to status") > **status**: `string` Defined in: [packages/sdk/src/types/generated/access\_grant.ts:47](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/access_grant.ts#L47) *** ### trigger[​](#trigger "Direct link to trigger") > **trigger**: `string` Defined in: [packages/sdk/src/types/generated/access\_grant.ts:43](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/access_grant.ts#L43) *** ### uuid[​](#uuid "Direct link to uuid") > **uuid**: `string` Defined in: [packages/sdk/src/types/generated/access\_grant.ts:30](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/access_grant.ts#L30) --- # Interface: GeneratedAppListResponse Defined in: [packages/sdk/src/types/generated/app.ts:20](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app.ts#L20) Response for listing apps. ## Properties[​](#properties "Direct link to Properties") ### items[​](#items "Direct link to items") > **items**: `AppResponse`\[] Defined in: [packages/sdk/src/types/generated/app.ts:21](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app.ts#L21) *** ### total[​](#total "Direct link to total") > **total**: `number` Defined in: [packages/sdk/src/types/generated/app.ts:22](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app.ts#L22) --- # Interface: GeneratedBusinessProfileResponse Defined in: [packages/sdk/src/types/generated/organization.ts:205](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L205) GET /business-profile body — built from a live Twilio fetch. `status` is the LIVE Twilio Customer Profile **lifecycle** status (`draft` / `pending-review` / `in-review` / `twilio-approved` / `twilio-rejected`) — never the cached `customer_profile_status` hint (plan §1c). `failureReasons` is the scrubbed, persisted list — those values are post-scrub and safe to expose. `evaluationStatus` is the most recent **compliance evaluation** result (`compliant` / `noncompliant`) when the profile is still pre-submission, otherwise `None`. Twilio models lifecycle and evaluation as two separate enums on two separate resources (`customer_profile_enum_status` vs `customer_profile_evaluation_enum_status`); the frontend needs both to decide whether the Submit button is eligible without making a second round-trip. ## Properties[​](#properties "Direct link to Properties") ### address?[​](#address "Direct link to address?") > `optional` **address**: [`Address`](https://docs.gravityrail.com/sdk/interfaces/Address.md) | `null` Defined in: [packages/sdk/src/types/generated/organization.ts:211](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L211) *** ### authorizedReps?[​](#authorizedreps "Direct link to authorizedReps?") > `optional` **authorizedReps**: [`AuthorizedRep`](https://docs.gravityrail.com/sdk/interfaces/AuthorizedRep.md)\[] Defined in: [packages/sdk/src/types/generated/organization.ts:210](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L210) *** ### businessInfo?[​](#businessinfo "Direct link to businessInfo?") > `optional` **businessInfo**: [`BusinessInfo`](https://docs.gravityrail.com/sdk/interfaces/BusinessInfo.md) | `null` Defined in: [packages/sdk/src/types/generated/organization.ts:209](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L209) *** ### customerProfileSid?[​](#customerprofilesid "Direct link to customerProfileSid?") > `optional` **customerProfileSid**: `string` | `null` Defined in: [packages/sdk/src/types/generated/organization.ts:208](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L208) *** ### evaluationStatus?[​](#evaluationstatus "Direct link to evaluationStatus?") > `optional` **evaluationStatus**: `BusinessProfileResponseEvaluationStatus` Defined in: [packages/sdk/src/types/generated/organization.ts:207](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L207) *** ### failureReasons?[​](#failurereasons "Direct link to failureReasons?") > `optional` **failureReasons**: `string`\[] Defined in: [packages/sdk/src/types/generated/organization.ts:212](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L212) *** ### status?[​](#status "Direct link to status?") > `optional` **status**: `string` | `null` Defined in: [packages/sdk/src/types/generated/organization.ts:206](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L206) --- # Interface: GeneratedCalendarResponse Defined in: [packages/sdk/src/types/generated/calendar.ts:45](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/calendar.ts#L45) Response model for calendars. ## Properties[​](#properties "Direct link to Properties") ### calendarSource[​](#calendarsource "Direct link to calendarSource") > **calendarSource**: `string` Defined in: [packages/sdk/src/types/generated/calendar.ts:59](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/calendar.ts#L59) *** ### color[​](#color "Direct link to color") > **color**: `string` | `null` Defined in: [packages/sdk/src/types/generated/calendar.ts:53](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/calendar.ts#L53) *** ### createdAt[​](#createdat "Direct link to createdAt") > **createdAt**: `string` Defined in: [packages/sdk/src/types/generated/calendar.ts:63](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/calendar.ts#L63) *** ### description[​](#description "Direct link to description") > **description**: `string` | `null` Defined in: [packages/sdk/src/types/generated/calendar.ts:51](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/calendar.ts#L51) *** ### id[​](#id "Direct link to id") > **id**: `number` Defined in: [packages/sdk/src/types/generated/calendar.ts:46](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/calendar.ts#L46) *** ### isPublic[​](#ispublic "Direct link to isPublic") > **isPublic**: `boolean` Defined in: [packages/sdk/src/types/generated/calendar.ts:54](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/calendar.ts#L54) *** ### lastSyncedAt?[​](#lastsyncedat "Direct link to lastSyncedAt?") > `optional` **lastSyncedAt**: `string` | `null` Defined in: [packages/sdk/src/types/generated/calendar.ts:58](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/calendar.ts#L58) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/generated/calendar.ts:49](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/calendar.ts#L49) *** ### ownerId[​](#ownerid "Direct link to ownerId") > **ownerId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/calendar.ts:60](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/calendar.ts#L60) *** ### ownerName[​](#ownername "Direct link to ownerName") > **ownerName**: `string` | `null` Defined in: [packages/sdk/src/types/generated/calendar.ts:61](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/calendar.ts#L61) *** ### remoteCalendarId?[​](#remotecalendarid "Direct link to remoteCalendarId?") > `optional` **remoteCalendarId**: `string` | `null` Defined in: [packages/sdk/src/types/generated/calendar.ts:55](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/calendar.ts#L55) *** ### schedules?[​](#schedules "Direct link to schedules?") > `optional` **schedules**: [`GeneratedCalendarScheduleResponse`](https://docs.gravityrail.com/sdk/interfaces/GeneratedCalendarScheduleResponse.md)\[] Defined in: [packages/sdk/src/types/generated/calendar.ts:62](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/calendar.ts#L62) *** ### slug[​](#slug "Direct link to slug") > **slug**: `string` Defined in: [packages/sdk/src/types/generated/calendar.ts:50](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/calendar.ts#L50) *** ### syncError?[​](#syncerror "Direct link to syncError?") > `optional` **syncError**: `string` | `null` Defined in: [packages/sdk/src/types/generated/calendar.ts:57](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/calendar.ts#L57) *** ### syncStatus?[​](#syncstatus "Direct link to syncStatus?") > `optional` **syncStatus**: `string` | `null` Defined in: [packages/sdk/src/types/generated/calendar.ts:56](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/calendar.ts#L56) *** ### templateUuid[​](#templateuuid "Direct link to templateUuid") > **templateUuid**: `string` | `null` Defined in: [packages/sdk/src/types/generated/calendar.ts:48](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/calendar.ts#L48) *** ### timezone[​](#timezone "Direct link to timezone") > **timezone**: `string` Defined in: [packages/sdk/src/types/generated/calendar.ts:52](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/calendar.ts#L52) *** ### updatedAt[​](#updatedat "Direct link to updatedAt") > **updatedAt**: `string` Defined in: [packages/sdk/src/types/generated/calendar.ts:64](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/calendar.ts#L64) *** ### uuid[​](#uuid "Direct link to uuid") > **uuid**: `string` Defined in: [packages/sdk/src/types/generated/calendar.ts:47](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/calendar.ts#L47) --- # Interface: GeneratedCalendarScheduleResponse Defined in: [packages/sdk/src/types/generated/calendar.ts:70](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/calendar.ts#L70) Response model for calendar schedules. ## Properties[​](#properties "Direct link to Properties") ### availabilityType[​](#availabilitytype "Direct link to availabilityType") > **availabilityType**: `string` Defined in: [packages/sdk/src/types/generated/calendar.ts:75](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/calendar.ts#L75) *** ### createdAt[​](#createdat "Direct link to createdAt") > **createdAt**: `string` Defined in: [packages/sdk/src/types/generated/calendar.ts:84](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/calendar.ts#L84) *** ### daysOfWeek[​](#daysofweek "Direct link to daysOfWeek") > **daysOfWeek**: `string`\[] | `null` Defined in: [packages/sdk/src/types/generated/calendar.ts:81](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/calendar.ts#L81) *** ### description[​](#description "Direct link to description") > **description**: `string` | `null` Defined in: [packages/sdk/src/types/generated/calendar.ts:74](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/calendar.ts#L74) *** ### endTime[​](#endtime "Direct link to endTime") > **endTime**: `string` Defined in: [packages/sdk/src/types/generated/calendar.ts:78](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/calendar.ts#L78) *** ### eventTypeIds?[​](#eventtypeids "Direct link to eventTypeIds?") > `optional` **eventTypeIds**: `number`\[] Defined in: [packages/sdk/src/types/generated/calendar.ts:83](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/calendar.ts#L83) *** ### id[​](#id "Direct link to id") > **id**: `number` Defined in: [packages/sdk/src/types/generated/calendar.ts:71](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/calendar.ts#L71) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/generated/calendar.ts:73](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/calendar.ts#L73) *** ### priority[​](#priority "Direct link to priority") > **priority**: `number` Defined in: [packages/sdk/src/types/generated/calendar.ts:82](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/calendar.ts#L82) *** ### recurrenceEndDate[​](#recurrenceenddate "Direct link to recurrenceEndDate") > **recurrenceEndDate**: `string` | `null` Defined in: [packages/sdk/src/types/generated/calendar.ts:80](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/calendar.ts#L80) *** ### recurrenceRule[​](#recurrencerule "Direct link to recurrenceRule") > **recurrenceRule**: `CalendarScheduleResponseRecurrenceRule` Defined in: [packages/sdk/src/types/generated/calendar.ts:79](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/calendar.ts#L79) *** ### recurrenceType[​](#recurrencetype "Direct link to recurrenceType") > **recurrenceType**: `string` Defined in: [packages/sdk/src/types/generated/calendar.ts:76](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/calendar.ts#L76) *** ### startTime[​](#starttime "Direct link to startTime") > **startTime**: `string` Defined in: [packages/sdk/src/types/generated/calendar.ts:77](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/calendar.ts#L77) *** ### updatedAt[​](#updatedat "Direct link to updatedAt") > **updatedAt**: `string` Defined in: [packages/sdk/src/types/generated/calendar.ts:85](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/calendar.ts#L85) *** ### uuid[​](#uuid "Direct link to uuid") > **uuid**: `string` Defined in: [packages/sdk/src/types/generated/calendar.ts:72](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/calendar.ts#L72) --- # Interface: GeneratedCustomToolkitResponse Defined in: [packages/sdk/src/types/generated/custom\_toolkit.ts:308](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/custom_toolkit.ts#L308) Response model for a custom toolkit. ## Properties[​](#properties "Direct link to Properties") ### abilities?[​](#abilities "Direct link to abilities?") > `optional` **abilities**: `AbilityResponse`\[] Defined in: [packages/sdk/src/types/generated/custom\_toolkit.ts:315](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/custom_toolkit.ts#L315) *** ### createdAt[​](#createdat "Direct link to createdAt") > **createdAt**: `string` Defined in: [packages/sdk/src/types/generated/custom\_toolkit.ts:317](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/custom_toolkit.ts#L317) *** ### customTools?[​](#customtools "Direct link to customTools?") > `optional` **customTools**: [`GeneratedCustomToolResponse`](https://docs.gravityrail.com/sdk/interfaces/GeneratedCustomToolResponse.md)\[] Defined in: [packages/sdk/src/types/generated/custom\_toolkit.ts:314](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/custom_toolkit.ts#L314) *** ### description[​](#description "Direct link to description") > **description**: `string` | `null` Defined in: [packages/sdk/src/types/generated/custom\_toolkit.ts:312](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/custom_toolkit.ts#L312) *** ### id[​](#id "Direct link to id") > **id**: `number` Defined in: [packages/sdk/src/types/generated/custom\_toolkit.ts:309](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/custom_toolkit.ts#L309) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/generated/custom\_toolkit.ts:310](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/custom_toolkit.ts#L310) *** ### ownerId[​](#ownerid "Direct link to ownerId") > **ownerId**: `number` Defined in: [packages/sdk/src/types/generated/custom\_toolkit.ts:316](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/custom_toolkit.ts#L316) *** ### permissions?[​](#permissions "Direct link to permissions?") > `optional` **permissions**: `number` Defined in: [packages/sdk/src/types/generated/custom\_toolkit.ts:319](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/custom_toolkit.ts#L319) *** ### slug[​](#slug "Direct link to slug") > **slug**: `string` Defined in: [packages/sdk/src/types/generated/custom\_toolkit.ts:311](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/custom_toolkit.ts#L311) *** ### state[​](#state "Direct link to state") > **state**: `ToolkitState` Defined in: [packages/sdk/src/types/generated/custom\_toolkit.ts:313](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/custom_toolkit.ts#L313) *** ### updatedAt[​](#updatedat "Direct link to updatedAt") > **updatedAt**: `string` Defined in: [packages/sdk/src/types/generated/custom\_toolkit.ts:318](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/custom_toolkit.ts#L318) --- # Interface: GeneratedCustomToolResponse Defined in: [packages/sdk/src/types/generated/custom\_toolkit.ts:112](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/custom_toolkit.ts#L112) Response model for a custom tool. ## Properties[​](#properties "Direct link to Properties") ### abilities?[​](#abilities "Direct link to abilities?") > `optional` **abilities**: `AbilityResponse`\[] Defined in: [packages/sdk/src/types/generated/custom\_toolkit.ts:125](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/custom_toolkit.ts#L125) *** ### chatModel?[​](#chatmodel "Direct link to chatModel?") > `optional` **chatModel**: `CustomToolResponseChatModel` Defined in: [packages/sdk/src/types/generated/custom\_toolkit.ts:120](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/custom_toolkit.ts#L120) *** ### createdAt[​](#createdat "Direct link to createdAt") > **createdAt**: `string` Defined in: [packages/sdk/src/types/generated/custom\_toolkit.ts:126](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/custom_toolkit.ts#L126) *** ### customToolkitId[​](#customtoolkitid "Direct link to customToolkitId") > **customToolkitId**: `number` Defined in: [packages/sdk/src/types/generated/custom\_toolkit.ts:115](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/custom_toolkit.ts#L115) *** ### dataTypes?[​](#datatypes "Direct link to dataTypes?") > `optional` **dataTypes**: [`DataTypeResponse`](https://docs.gravityrail.com/sdk/interfaces/DataTypeResponse.md)\[] Defined in: [packages/sdk/src/types/generated/custom\_toolkit.ts:124](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/custom_toolkit.ts#L124) *** ### description[​](#description "Direct link to description") > **description**: `string` | `null` Defined in: [packages/sdk/src/types/generated/custom\_toolkit.ts:118](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/custom_toolkit.ts#L118) *** ### displayName?[​](#displayname "Direct link to displayName?") > `optional` **displayName**: `string` | `null` Defined in: [packages/sdk/src/types/generated/custom\_toolkit.ts:117](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/custom_toolkit.ts#L117) *** ### files?[​](#files "Direct link to files?") > `optional` **files**: [`GeneratedFileResponse`](https://docs.gravityrail.com/sdk/interfaces/GeneratedFileResponse.md)\[] Defined in: [packages/sdk/src/types/generated/custom\_toolkit.ts:123](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/custom_toolkit.ts#L123) *** ### id[​](#id "Direct link to id") > **id**: `number` Defined in: [packages/sdk/src/types/generated/custom\_toolkit.ts:113](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/custom_toolkit.ts#L113) *** ### inputSchema?[​](#inputschema "Direct link to inputSchema?") > `optional` **inputSchema**: `CustomToolResponseInputSchema` Defined in: [packages/sdk/src/types/generated/custom\_toolkit.ts:121](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/custom_toolkit.ts#L121) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/generated/custom\_toolkit.ts:116](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/custom_toolkit.ts#L116) *** ### outputSchema?[​](#outputschema "Direct link to outputSchema?") > `optional` **outputSchema**: `CustomToolResponseOutputSchema` Defined in: [packages/sdk/src/types/generated/custom\_toolkit.ts:122](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/custom_toolkit.ts#L122) *** ### prompt[​](#prompt "Direct link to prompt") > **prompt**: `string` | `null` Defined in: [packages/sdk/src/types/generated/custom\_toolkit.ts:119](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/custom_toolkit.ts#L119) *** ### updatedAt[​](#updatedat "Direct link to updatedAt") > **updatedAt**: `string` Defined in: [packages/sdk/src/types/generated/custom\_toolkit.ts:127](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/custom_toolkit.ts#L127) *** ### uuid[​](#uuid "Direct link to uuid") > **uuid**: `string` Defined in: [packages/sdk/src/types/generated/custom\_toolkit.ts:114](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/custom_toolkit.ts#L114) --- # Interface: GeneratedDiscordBotResponse Defined in: [packages/sdk/src/types/generated/app\_connection.ts:59](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L59) Response model for Discord bot. ## Properties[​](#properties "Direct link to Properties") ### allowDm[​](#allowdm "Direct link to allowDm") > **allowDm**: `boolean` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:72](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L72) *** ### allowedChannelIds?[​](#allowedchannelids "Direct link to allowedChannelIds?") > `optional` **allowedChannelIds**: `string`\[] | `null` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:76](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L76) *** ### allowedGuildIds?[​](#allowedguildids "Direct link to allowedGuildIds?") > `optional` **allowedGuildIds**: `string`\[] | `null` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:75](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L75) *** ### applicationId[​](#applicationid "Direct link to applicationId") > **applicationId**: `string` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:66](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L66) *** ### connectionType?[​](#connectiontype "Direct link to connectionType?") > `optional` **connectionType**: `"discord_bot"` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:60](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L60) *** ### createdAt[​](#createdat "Direct link to createdAt") > **createdAt**: `string` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:77](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L77) *** ### creatorId?[​](#creatorid "Direct link to creatorId?") > `optional` **creatorId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:65](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L65) *** ### defaultWorkflowId[​](#defaultworkflowid "Direct link to defaultWorkflowId") > **defaultWorkflowId**: `number` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:74](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L74) *** ### enabled[​](#enabled "Direct link to enabled") > **enabled**: `boolean` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:64](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L64) *** ### enableGateway[​](#enablegateway "Direct link to enableGateway") > **enableGateway**: `boolean` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:73](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L73) *** ### id[​](#id "Direct link to id") > **id**: `number` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:61](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L61) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:63](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L63) *** ### publicKey[​](#publickey "Direct link to publicKey") > **publicKey**: `string` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:67](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L67) *** ### replyInThread[​](#replyinthread "Direct link to replyInThread") > **replyInThread**: `boolean` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:69](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L69) *** ### respondMode[​](#respondmode "Direct link to respondMode") > **respondMode**: `string` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:70](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L70) *** ### respondWhen?[​](#respondwhen "Direct link to respondWhen?") > `optional` **respondWhen**: `string` | `null` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:71](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L71) *** ### slashCommands?[​](#slashcommands "Direct link to slashCommands?") > `optional` **slashCommands**: [`SlashCommandConfigResponse`](https://docs.gravityrail.com/sdk/interfaces/SlashCommandConfigResponse.md)\[] | `null` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:68](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L68) *** ### updatedAt[​](#updatedat "Direct link to updatedAt") > **updatedAt**: `string` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:78](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L78) *** ### uuid[​](#uuid "Direct link to uuid") > **uuid**: `string` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:62](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L62) --- # Interface: GeneratedFhirConnectionResponse Defined in: [packages/sdk/src/types/generated/app\_connection.ts:179](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L179) Response model for FHIR connection. ## Properties[​](#properties "Direct link to Properties") ### approvedScopes?[​](#approvedscopes "Direct link to approvedScopes?") > `optional` **approvedScopes**: `string`\[] | `null` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:194](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L194) *** ### clientId[​](#clientid "Direct link to clientId") > **clientId**: `string` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:191](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L191) *** ### clientType[​](#clienttype "Direct link to clientType") > **clientType**: `string` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:188](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L188) *** ### connectionType?[​](#connectiontype "Direct link to connectionType?") > `optional` **connectionType**: `"fhir_connection"` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:180](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L180) *** ### createdAt[​](#createdat "Direct link to createdAt") > **createdAt**: `string` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:200](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L200) *** ### creatorId?[​](#creatorid "Direct link to creatorId?") > `optional` **creatorId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:185](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L185) *** ### enabled[​](#enabled "Direct link to enabled") > **enabled**: `boolean` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:184](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L184) *** ### errorMessage?[​](#errormessage "Direct link to errorMessage?") > `optional` **errorMessage**: `string` | `null` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:196](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L196) *** ### fhirBaseUrl[​](#fhirbaseurl "Direct link to fhirBaseUrl") > **fhirBaseUrl**: `string` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:189](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L189) *** ### id[​](#id "Direct link to id") > **id**: `number` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:181](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L181) *** ### lastConnectedAt?[​](#lastconnectedat "Direct link to lastConnectedAt?") > `optional` **lastConnectedAt**: `string` | `null` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:197](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L197) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:183](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L183) *** ### practiceId?[​](#practiceid "Direct link to practiceId?") > `optional` **practiceId**: `string` | `null` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:190](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L190) *** ### rateLimitPerMinute[​](#ratelimitperminute "Direct link to rateLimitPerMinute") > **rateLimitPerMinute**: `number` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:198](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L198) *** ### smartMetadata?[​](#smartmetadata "Direct link to smartMetadata?") > `optional` **smartMetadata**: `FhirConnectionResponseSmartMetadata` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:193](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L193) *** ### state[​](#state "Direct link to state") > **state**: `string` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:195](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L195) *** ### templateUuid?[​](#templateuuid "Direct link to templateUuid?") > `optional` **templateUuid**: `string` | `null` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:186](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L186) *** ### tokenEndpoint?[​](#tokenendpoint "Direct link to tokenEndpoint?") > `optional` **tokenEndpoint**: `string` | `null` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:192](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L192) *** ### updatedAt[​](#updatedat "Direct link to updatedAt") > **updatedAt**: `string` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:201](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L201) *** ### uuid[​](#uuid "Direct link to uuid") > **uuid**: `string` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:182](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L182) *** ### vendor[​](#vendor "Direct link to vendor") > **vendor**: `string` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:187](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L187) *** ### vendorConfig?[​](#vendorconfig "Direct link to vendorConfig?") > `optional` **vendorConfig**: `FhirConnectionResponseVendorConfig` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:199](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L199) --- # Interface: GeneratedFileResponse Defined in: [packages/sdk/src/types/generated/file.ts:103](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/file.ts#L103) Response model for file endpoints. ## Properties[​](#properties "Direct link to Properties") ### access?[​](#access "Direct link to access?") > `optional` **access**: `string` Defined in: [packages/sdk/src/types/generated/file.ts:116](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/file.ts#L116) *** ### accessMode?[​](#accessmode "Direct link to accessMode?") > `optional` **accessMode**: `number` | `null` Defined in: [packages/sdk/src/types/generated/file.ts:108](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/file.ts#L108) *** ### cdnUrl[​](#cdnurl "Direct link to cdnUrl") > **cdnUrl**: `string` | `null` Defined in: [packages/sdk/src/types/generated/file.ts:121](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/file.ts#L121) *** ### choicePrompt?[​](#choiceprompt "Direct link to choicePrompt?") > `optional` **choicePrompt**: `string` | `null` Defined in: [packages/sdk/src/types/generated/file.ts:109](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/file.ts#L109) *** ### createdAt[​](#createdat "Direct link to createdAt") > **createdAt**: `string` Defined in: [packages/sdk/src/types/generated/file.ts:118](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/file.ts#L118) *** ### data[​](#data "Direct link to data") > **data**: `string` | `null` Defined in: [packages/sdk/src/types/generated/file.ts:120](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/file.ts#L120) *** ### description[​](#description "Direct link to description") > **description**: `string` | `null` Defined in: [packages/sdk/src/types/generated/file.ts:107](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/file.ts#L107) *** ### externalId[​](#externalid "Direct link to externalId") > **externalId**: `string` | `null` Defined in: [packages/sdk/src/types/generated/file.ts:114](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/file.ts#L114) *** ### filename[​](#filename "Direct link to filename") > **filename**: `string` Defined in: [packages/sdk/src/types/generated/file.ts:110](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/file.ts#L110) *** ### fileSize[​](#filesize "Direct link to fileSize") > **fileSize**: `number` | `null` Defined in: [packages/sdk/src/types/generated/file.ts:122](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/file.ts#L122) *** ### folder[​](#folder "Direct link to folder") > **folder**: [`FileFolderResponse`](https://docs.gravityrail.com/sdk/interfaces/FileFolderResponse.md) | `null` Defined in: [packages/sdk/src/types/generated/file.ts:117](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/file.ts#L117) *** ### folderId[​](#folderid "Direct link to folderId") > **folderId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/file.ts:112](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/file.ts#L112) *** ### id[​](#id "Direct link to id") > **id**: `number` Defined in: [packages/sdk/src/types/generated/file.ts:104](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/file.ts#L104) *** ### isS3Stored?[​](#iss3stored "Direct link to isS3Stored?") > `optional` **isS3Stored**: `boolean` Defined in: [packages/sdk/src/types/generated/file.ts:123](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/file.ts#L123) *** ### labels?[​](#labels "Direct link to labels?") > `optional` **labels**: [`FileLabelResponse`](https://docs.gravityrail.com/sdk/interfaces/FileLabelResponse.md)\[] | `null` Defined in: [packages/sdk/src/types/generated/file.ts:125](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/file.ts#L125) *** ### mimeType[​](#mimetype "Direct link to mimeType") > **mimeType**: `string` Defined in: [packages/sdk/src/types/generated/file.ts:111](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/file.ts#L111) *** ### ownerId?[​](#ownerid "Direct link to ownerId?") > `optional` **ownerId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/file.ts:115](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/file.ts#L115) *** ### permissions?[​](#permissions "Direct link to permissions?") > `optional` **permissions**: `number` Defined in: [packages/sdk/src/types/generated/file.ts:124](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/file.ts#L124) *** ### shareCount?[​](#sharecount "Direct link to shareCount?") > `optional` **shareCount**: `number` Defined in: [packages/sdk/src/types/generated/file.ts:126](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/file.ts#L126) *** ### siteId[​](#siteid "Direct link to siteId") > **siteId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/file.ts:113](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/file.ts#L113) *** ### title[​](#title "Direct link to title") > **title**: `string` Defined in: [packages/sdk/src/types/generated/file.ts:106](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/file.ts#L106) *** ### updatedAt[​](#updatedat "Direct link to updatedAt") > **updatedAt**: `string` Defined in: [packages/sdk/src/types/generated/file.ts:119](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/file.ts#L119) *** ### uuid[​](#uuid "Direct link to uuid") > **uuid**: `string` Defined in: [packages/sdk/src/types/generated/file.ts:105](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/file.ts#L105) --- # Interface: GeneratedFileSharingResponse Defined in: [packages/sdk/src/types/generated/file.ts:141](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/file.ts#L141) Complete sharing state for a file. ## Properties[​](#properties "Direct link to Properties") ### access[​](#access "Direct link to access") > **access**: `string` Defined in: [packages/sdk/src/types/generated/file.ts:144](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/file.ts#L144) *** ### grants[​](#grants "Direct link to grants") > **grants**: [`GeneratedAccessGrantResponse`](https://docs.gravityrail.com/sdk/interfaces/GeneratedAccessGrantResponse.md)\[] Defined in: [packages/sdk/src/types/generated/file.ts:146](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/file.ts#L146) *** ### ownerId[​](#ownerid "Direct link to ownerId") > **ownerId**: `number` Defined in: [packages/sdk/src/types/generated/file.ts:142](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/file.ts#L142) *** ### ownerName[​](#ownername "Direct link to ownerName") > **ownerName**: `string` | `null` Defined in: [packages/sdk/src/types/generated/file.ts:143](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/file.ts#L143) *** ### roleAssociations[​](#roleassociations "Direct link to roleAssociations") > **roleAssociations**: [`FileRoleAssociationResponse`](https://docs.gravityrail.com/sdk/interfaces/FileRoleAssociationResponse.md)\[] Defined in: [packages/sdk/src/types/generated/file.ts:147](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/file.ts#L147) *** ### shareable[​](#shareable "Direct link to shareable") > **shareable**: `boolean` Defined in: [packages/sdk/src/types/generated/file.ts:145](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/file.ts#L145) --- # Interface: GeneratedFolderSharingResponse Defined in: [packages/sdk/src/types/generated/file.ts:196](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/file.ts#L196) Complete sharing state for a folder. ## Properties[​](#properties "Direct link to Properties") ### access[​](#access "Direct link to access") > **access**: `string` Defined in: [packages/sdk/src/types/generated/file.ts:199](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/file.ts#L199) *** ### grants[​](#grants "Direct link to grants") > **grants**: [`GeneratedAccessGrantResponse`](https://docs.gravityrail.com/sdk/interfaces/GeneratedAccessGrantResponse.md)\[] Defined in: [packages/sdk/src/types/generated/file.ts:201](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/file.ts#L201) *** ### ownerId[​](#ownerid "Direct link to ownerId") > **ownerId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/file.ts:197](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/file.ts#L197) *** ### ownerName[​](#ownername "Direct link to ownerName") > **ownerName**: `string` | `null` Defined in: [packages/sdk/src/types/generated/file.ts:198](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/file.ts#L198) *** ### roleAssociations[​](#roleassociations "Direct link to roleAssociations") > **roleAssociations**: [`FileRoleAssociationResponse`](https://docs.gravityrail.com/sdk/interfaces/FileRoleAssociationResponse.md)\[] Defined in: [packages/sdk/src/types/generated/file.ts:202](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/file.ts#L202) *** ### shareable[​](#shareable "Direct link to shareable") > **shareable**: `boolean` Defined in: [packages/sdk/src/types/generated/file.ts:200](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/file.ts#L200) --- # Interface: GeneratedInvitationListResponse Defined in: [packages/sdk/src/types/generated/invitation.ts:12](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/invitation.ts#L12) Response model for listing invitations. ## Properties[​](#properties "Direct link to Properties") ### items[​](#items "Direct link to items") > **items**: `InvitationResponse`\[] Defined in: [packages/sdk/src/types/generated/invitation.ts:14](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/invitation.ts#L14) List of invitations *** ### page[​](#page "Direct link to page") > **page**: `number` Defined in: [packages/sdk/src/types/generated/invitation.ts:18](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/invitation.ts#L18) Current page number *** ### pageSize[​](#pagesize "Direct link to pageSize") > **pageSize**: `number` Defined in: [packages/sdk/src/types/generated/invitation.ts:20](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/invitation.ts#L20) Number of items per page *** ### total[​](#total "Direct link to total") > **total**: `number` Defined in: [packages/sdk/src/types/generated/invitation.ts:16](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/invitation.ts#L16) Total number of invitations --- # Interface: GeneratedMemoryListResponse Defined in: [packages/sdk/src/types/generated/member.ts:592](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L592) ## Properties[​](#properties "Direct link to Properties") ### items[​](#items "Direct link to items") > **items**: [`GeneratedMemoryResponse`](https://docs.gravityrail.com/sdk/interfaces/GeneratedMemoryResponse.md)\[] Defined in: [packages/sdk/src/types/generated/member.ts:593](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L593) *** ### total[​](#total "Direct link to total") > **total**: `number` Defined in: [packages/sdk/src/types/generated/member.ts:594](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L594) --- # Interface: GeneratedMemoryResponse Defined in: [packages/sdk/src/types/generated/member.ts:597](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L597) ## Properties[​](#properties "Direct link to Properties") ### content?[​](#content "Direct link to content?") > `optional` **content**: `string` | `null` Defined in: [packages/sdk/src/types/generated/member.ts:603](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L603) *** ### createdAt?[​](#createdat "Direct link to createdAt?") > `optional` **createdAt**: `string` | `null` Defined in: [packages/sdk/src/types/generated/member.ts:605](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L605) *** ### description[​](#description "Direct link to description") > **description**: `string` Defined in: [packages/sdk/src/types/generated/member.ts:602](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L602) *** ### id?[​](#id "Direct link to id?") > `optional` **id**: `number` | `null` Defined in: [packages/sdk/src/types/generated/member.ts:598](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L598) *** ### key[​](#key "Direct link to key") > **key**: `string` Defined in: [packages/sdk/src/types/generated/member.ts:600](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L600) *** ### priority?[​](#priority "Direct link to priority?") > `optional` **priority**: `number` Defined in: [packages/sdk/src/types/generated/member.ts:604](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L604) *** ### type?[​](#type "Direct link to type?") > `optional` **type**: `string` Defined in: [packages/sdk/src/types/generated/member.ts:601](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L601) *** ### updatedAt?[​](#updatedat "Direct link to updatedAt?") > `optional` **updatedAt**: `string` | `null` Defined in: [packages/sdk/src/types/generated/member.ts:606](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L606) *** ### uuid?[​](#uuid "Direct link to uuid?") > `optional` **uuid**: `string` | `null` Defined in: [packages/sdk/src/types/generated/member.ts:599](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L599) --- # Interface: GeneratedMetricSummary Defined in: [packages/sdk/src/types/generated/voice\_metrics.ts:40](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/voice_metrics.ts#L40) ## Properties[​](#properties "Direct link to Properties") ### avg?[​](#avg "Direct link to avg?") > `optional` **avg**: `number` Defined in: [packages/sdk/src/types/generated/voice\_metrics.ts:41](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/voice_metrics.ts#L41) *** ### count?[​](#count "Direct link to count?") > `optional` **count**: `number` Defined in: [packages/sdk/src/types/generated/voice\_metrics.ts:44](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/voice_metrics.ts#L44) *** ### hasDistribution?[​](#hasdistribution "Direct link to hasDistribution?") > `optional` **hasDistribution**: `boolean` Defined in: [packages/sdk/src/types/generated/voice\_metrics.ts:48](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/voice_metrics.ts#L48) *** ### max?[​](#max "Direct link to max?") > `optional` **max**: `number` Defined in: [packages/sdk/src/types/generated/voice\_metrics.ts:43](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/voice_metrics.ts#L43) *** ### min?[​](#min "Direct link to min?") > `optional` **min**: `number` Defined in: [packages/sdk/src/types/generated/voice\_metrics.ts:42](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/voice_metrics.ts#L42) *** ### p50?[​](#p50 "Direct link to p50?") > `optional` **p50**: `number` Defined in: [packages/sdk/src/types/generated/voice\_metrics.ts:45](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/voice_metrics.ts#L45) *** ### p90?[​](#p90 "Direct link to p90?") > `optional` **p90**: `number` Defined in: [packages/sdk/src/types/generated/voice\_metrics.ts:46](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/voice_metrics.ts#L46) *** ### p99?[​](#p99 "Direct link to p99?") > `optional` **p99**: `number` Defined in: [packages/sdk/src/types/generated/voice\_metrics.ts:47](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/voice_metrics.ts#L47) --- # Interface: GeneratedMilestoneGoalResponse Defined in: [packages/sdk/src/types/generated/milestone.ts:32](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/milestone.ts#L32) Response model for milestone goal data. ## Properties[​](#properties "Direct link to Properties") ### createdAt[​](#createdat "Direct link to createdAt") > **createdAt**: `string` Defined in: [packages/sdk/src/types/generated/milestone.ts:40](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/milestone.ts#L40) *** ### description[​](#description "Direct link to description") > **description**: `string` | `null` Defined in: [packages/sdk/src/types/generated/milestone.ts:35](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/milestone.ts#L35) *** ### id[​](#id "Direct link to id") > **id**: `number` Defined in: [packages/sdk/src/types/generated/milestone.ts:33](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/milestone.ts#L33) *** ### memberFilterId[​](#memberfilterid "Direct link to memberFilterId") > **memberFilterId**: `number` Defined in: [packages/sdk/src/types/generated/milestone.ts:37](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/milestone.ts#L37) *** ### memberFilterName[​](#memberfiltername "Direct link to memberFilterName") > **memberFilterName**: `string` Defined in: [packages/sdk/src/types/generated/milestone.ts:38](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/milestone.ts#L38) *** ### milestoneId[​](#milestoneid "Direct link to milestoneId") > **milestoneId**: `number` Defined in: [packages/sdk/src/types/generated/milestone.ts:36](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/milestone.ts#L36) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/generated/milestone.ts:34](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/milestone.ts#L34) *** ### updatedAt[​](#updatedat "Direct link to updatedAt") > **updatedAt**: `string` Defined in: [packages/sdk/src/types/generated/milestone.ts:41](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/milestone.ts#L41) *** ### value[​](#value "Direct link to value") > **value**: `number` | `null` Defined in: [packages/sdk/src/types/generated/milestone.ts:39](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/milestone.ts#L39) --- # Interface: GeneratedOrgDomainResponse Defined in: [packages/sdk/src/types/generated/organization.ts:491](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L491) Response model for an OrgDomain row. ## Properties[​](#properties "Direct link to Properties") ### createdAt[​](#createdat "Direct link to createdAt") > **createdAt**: `string` Defined in: [packages/sdk/src/types/generated/organization.ts:499](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L499) *** ### domain[​](#domain "Direct link to domain") > **domain**: `string` Defined in: [packages/sdk/src/types/generated/organization.ts:493](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L493) *** ### emailStatus?[​](#emailstatus "Direct link to emailStatus?") > `optional` **emailStatus**: `string` | `null` Defined in: [packages/sdk/src/types/generated/organization.ts:501](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L501) *** ### organizationUuid[​](#organizationuuid "Direct link to organizationUuid") > **organizationUuid**: `string` Defined in: [packages/sdk/src/types/generated/organization.ts:494](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L494) *** ### ownershipDnsRecord[​](#ownershipdnsrecord "Direct link to ownershipDnsRecord") > **ownershipDnsRecord**: [`GeneratedOwnershipDnsRecord`](https://docs.gravityrail.com/sdk/interfaces/GeneratedOwnershipDnsRecord.md) Defined in: [packages/sdk/src/types/generated/organization.ts:496](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L496) *** ### ownershipLastCheckedAt?[​](#ownershiplastcheckedat "Direct link to ownershipLastCheckedAt?") > `optional` **ownershipLastCheckedAt**: `string` | `null` Defined in: [packages/sdk/src/types/generated/organization.ts:498](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L498) *** ### ownershipStatus[​](#ownershipstatus "Direct link to ownershipStatus") > **ownershipStatus**: `string` Defined in: [packages/sdk/src/types/generated/organization.ts:495](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L495) *** ### ownershipVerifiedAt?[​](#ownershipverifiedat "Direct link to ownershipVerifiedAt?") > `optional` **ownershipVerifiedAt**: `string` | `null` Defined in: [packages/sdk/src/types/generated/organization.ts:497](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L497) *** ### siteStatus?[​](#sitestatus "Direct link to siteStatus?") > `optional` **siteStatus**: `string` | `null` Defined in: [packages/sdk/src/types/generated/organization.ts:502](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L502) *** ### updatedAt[​](#updatedat "Direct link to updatedAt") > **updatedAt**: `string` Defined in: [packages/sdk/src/types/generated/organization.ts:500](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L500) *** ### uuid[​](#uuid "Direct link to uuid") > **uuid**: `string` Defined in: [packages/sdk/src/types/generated/organization.ts:492](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L492) --- # Interface: GeneratedOwnershipDnsRecord Defined in: [packages/sdk/src/types/generated/organization.ts:547](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L547) The DNS record the customer must add to prove ownership. ## Properties[​](#properties "Direct link to Properties") ### host[​](#host "Direct link to host") > **host**: `string` Defined in: [packages/sdk/src/types/generated/organization.ts:549](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L549) *** ### ttl?[​](#ttl "Direct link to ttl?") > `optional` **ttl**: `number` Defined in: [packages/sdk/src/types/generated/organization.ts:551](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L551) *** ### type?[​](#type "Direct link to type?") > `optional` **type**: `string` Defined in: [packages/sdk/src/types/generated/organization.ts:548](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L548) *** ### value[​](#value "Direct link to value") > **value**: `string` Defined in: [packages/sdk/src/types/generated/organization.ts:550](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L550) --- # Interface: GeneratedSiteResponse Defined in: [packages/sdk/src/types/generated/site.ts:180](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L180) ## Properties[​](#properties "Direct link to Properties") ### allowSignup[​](#allowsignup "Direct link to allowSignup") > **allowSignup**: `boolean` Defined in: [packages/sdk/src/types/generated/site.ts:197](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L197) *** ### assetsFolderId?[​](#assetsfolderid "Direct link to assetsFolderId?") > `optional` **assetsFolderId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/site.ts:185](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L185) *** ### authorized[​](#authorized "Direct link to authorized") > **authorized**: `boolean` Defined in: [packages/sdk/src/types/generated/site.ts:192](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L192) *** ### availableLocales?[​](#availablelocales "Direct link to availableLocales?") > `optional` **availableLocales**: `string`\[] Defined in: [packages/sdk/src/types/generated/site.ts:229](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L229) *** ### content[​](#content "Direct link to content") > **content**: `string` Defined in: [packages/sdk/src/types/generated/site.ts:191](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L191) *** ### crawl?[​](#crawl "Direct link to crawl?") > `optional` **crawl**: `boolean` Defined in: [packages/sdk/src/types/generated/site.ts:212](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L212) *** ### crawlCompleted?[​](#crawlcompleted "Direct link to crawlCompleted?") > `optional` **crawlCompleted**: `number` | `null` Defined in: [packages/sdk/src/types/generated/site.ts:216](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L216) *** ### crawlCompletedAt?[​](#crawlcompletedat "Direct link to crawlCompletedAt?") > `optional` **crawlCompletedAt**: `string` | `null` Defined in: [packages/sdk/src/types/generated/site.ts:215](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L215) *** ### crawlError?[​](#crawlerror "Direct link to crawlError?") > `optional` **crawlError**: `string` | `null` Defined in: [packages/sdk/src/types/generated/site.ts:218](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L218) *** ### crawlExcludedTags?[​](#crawlexcludedtags "Direct link to crawlExcludedTags?") > `optional` **crawlExcludedTags**: `string`\[] Defined in: [packages/sdk/src/types/generated/site.ts:219](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L219) *** ### crawlFailedAt?[​](#crawlfailedat "Direct link to crawlFailedAt?") > `optional` **crawlFailedAt**: `string` | `null` Defined in: [packages/sdk/src/types/generated/site.ts:217](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L217) *** ### crawlJobId?[​](#crawljobid "Direct link to crawlJobId?") > `optional` **crawlJobId**: `string` | `null` Defined in: [packages/sdk/src/types/generated/site.ts:220](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L220) *** ### crawlLimit?[​](#crawllimit "Direct link to crawlLimit?") > `optional` **crawlLimit**: `number` | `null` Defined in: [packages/sdk/src/types/generated/site.ts:222](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L222) *** ### crawlPrevious?[​](#crawlprevious "Direct link to crawlPrevious?") > `optional` **crawlPrevious**: `number` | `null` Defined in: [packages/sdk/src/types/generated/site.ts:221](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L221) *** ### crawlStartedAt?[​](#crawlstartedat "Direct link to crawlStartedAt?") > `optional` **crawlStartedAt**: `string` | `null` Defined in: [packages/sdk/src/types/generated/site.ts:214](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L214) *** ### crawlUrl?[​](#crawlurl "Direct link to crawlUrl?") > `optional` **crawlUrl**: `string` | `null` Defined in: [packages/sdk/src/types/generated/site.ts:213](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L213) *** ### createdAt[​](#createdat "Direct link to createdAt") > **createdAt**: `string` Defined in: [packages/sdk/src/types/generated/site.ts:202](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L202) *** ### customDomain[​](#customdomain "Direct link to customDomain") > **customDomain**: `string` | `null` Defined in: [packages/sdk/src/types/generated/site.ts:195](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L195) *** ### defaultUrl?[​](#defaulturl "Direct link to defaultUrl?") > `optional` **defaultUrl**: `string` | `null` Defined in: [packages/sdk/src/types/generated/site.ts:211](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L211) *** ### defaultWorkflowId?[​](#defaultworkflowid "Direct link to defaultWorkflowId?") > `optional` **defaultWorkflowId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/site.ts:208](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L208) *** ### googleAdwordsId?[​](#googleadwordsid "Direct link to googleAdwordsId?") > `optional` **googleAdwordsId**: `string` | `null` Defined in: [packages/sdk/src/types/generated/site.ts:224](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L224) *** ### googleAnalyticsId?[​](#googleanalyticsid "Direct link to googleAnalyticsId?") > `optional` **googleAnalyticsId**: `string` | `null` Defined in: [packages/sdk/src/types/generated/site.ts:223](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L223) *** ### homePageId?[​](#homepageid "Direct link to homePageId?") > `optional` **homePageId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/site.ts:209](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L209) *** ### id[​](#id "Direct link to id") > **id**: `number` Defined in: [packages/sdk/src/types/generated/site.ts:181](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L181) *** ### isMapped[​](#ismapped "Direct link to isMapped") > **isMapped**: `boolean` Defined in: [packages/sdk/src/types/generated/site.ts:200](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L200) *** ### isPublic[​](#ispublic "Direct link to isPublic") > **isPublic**: `boolean` Defined in: [packages/sdk/src/types/generated/site.ts:201](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L201) *** ### isReseller[​](#isreseller "Direct link to isReseller") > **isReseller**: `boolean` Defined in: [packages/sdk/src/types/generated/site.ts:204](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L204) *** ### metaDescription[​](#metadescription "Direct link to metaDescription") > **metaDescription**: `string` | `null` Defined in: [packages/sdk/src/types/generated/site.ts:194](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L194) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/generated/site.ts:182](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L182) *** ### organizationLogoUrl?[​](#organizationlogourl "Direct link to organizationLogoUrl?") > `optional` **organizationLogoUrl**: `string` | `null` Defined in: [packages/sdk/src/types/generated/site.ts:227](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L227) *** ### ownerId?[​](#ownerid "Direct link to ownerId?") > `optional` **ownerId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/site.ts:207](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L207) *** ### pageCount?[​](#pagecount "Direct link to pageCount?") > `optional` **pageCount**: `number` | `null` Defined in: [packages/sdk/src/types/generated/site.ts:230](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L230) *** ### permissions?[​](#permissions "Direct link to permissions?") > `optional` **permissions**: `number` Defined in: [packages/sdk/src/types/generated/site.ts:225](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L225) *** ### primaryLocale?[​](#primarylocale "Direct link to primaryLocale?") > `optional` **primaryLocale**: `string` Defined in: [packages/sdk/src/types/generated/site.ts:228](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L228) *** ### redirectUrl[​](#redirecturl "Direct link to redirectUrl") > **redirectUrl**: `string` | `null` Defined in: [packages/sdk/src/types/generated/site.ts:196](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L196) *** ### resolvedThemeSettings?[​](#resolvedthemesettings "Direct link to resolvedThemeSettings?") > `optional` **resolvedThemeSettings**: `SiteResponseResolvedThemeSettings` Defined in: [packages/sdk/src/types/generated/site.ts:190](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L190) *** ### signupMemberRoleId?[​](#signupmemberroleid "Direct link to signupMemberRoleId?") > `optional` **signupMemberRoleId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/site.ts:198](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L198) *** ### signupMemberRoleName?[​](#signupmemberrolename "Direct link to signupMemberRoleName?") > `optional` **signupMemberRoleName**: `string` | `null` Defined in: [packages/sdk/src/types/generated/site.ts:199](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L199) *** ### slug[​](#slug "Direct link to slug") > **slug**: `string` Defined in: [packages/sdk/src/types/generated/site.ts:184](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L184) *** ### sourceFolderId?[​](#sourcefolderid "Direct link to sourceFolderId?") > `optional` **sourceFolderId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/site.ts:186](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L186) *** ### sourceReleaseId?[​](#sourcereleaseid "Direct link to sourceReleaseId?") > `optional` **sourceReleaseId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/site.ts:187](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L187) *** ### tagLine[​](#tagline "Direct link to tagLine") > **tagLine**: `string` | `null` Defined in: [packages/sdk/src/types/generated/site.ts:193](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L193) *** ### theme[​](#theme "Direct link to theme") > **theme**: `SiteResponseTheme` Defined in: [packages/sdk/src/types/generated/site.ts:188](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L188) *** ### themeSettings?[​](#themesettings "Direct link to themeSettings?") > `optional` **themeSettings**: `SiteResponseThemeSettings` Defined in: [packages/sdk/src/types/generated/site.ts:189](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L189) *** ### updatedAt[​](#updatedat "Direct link to updatedAt") > **updatedAt**: `string` Defined in: [packages/sdk/src/types/generated/site.ts:203](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L203) *** ### url[​](#url "Direct link to url") > **url**: `string` | `null` Defined in: [packages/sdk/src/types/generated/site.ts:210](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L210) *** ### uuid[​](#uuid "Direct link to uuid") > **uuid**: `string` Defined in: [packages/sdk/src/types/generated/site.ts:183](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L183) *** ### widgetOrigins?[​](#widgetorigins "Direct link to widgetOrigins?") > `optional` **widgetOrigins**: `string`\[] | `null` Defined in: [packages/sdk/src/types/generated/site.ts:226](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L226) *** ### workspaceName[​](#workspacename "Direct link to workspaceName") > **workspaceName**: `string` Defined in: [packages/sdk/src/types/generated/site.ts:205](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L205) *** ### workspaceUuid?[​](#workspaceuuid "Direct link to workspaceUuid?") > `optional` **workspaceUuid**: `string` | `null` Defined in: [packages/sdk/src/types/generated/site.ts:206](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L206) --- # Interface: GeneratedSlackAppResponse Defined in: [packages/sdk/src/types/generated/app\_connection.ts:380](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L380) Response model for Slack app. ## Properties[​](#properties "Direct link to Properties") ### allowDm[​](#allowdm "Direct link to allowDm") > **allowDm**: `boolean` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:392](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L392) *** ### allowedChannelIds?[​](#allowedchannelids "Direct link to allowedChannelIds?") > `optional` **allowedChannelIds**: `string`\[] | `null` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:394](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L394) *** ### connectionType?[​](#connectiontype "Direct link to connectionType?") > `optional` **connectionType**: `"slack_app"` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:381](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L381) *** ### createdAt[​](#createdat "Direct link to createdAt") > **createdAt**: `string` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:395](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L395) *** ### creatorId?[​](#creatorid "Direct link to creatorId?") > `optional` **creatorId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:386](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L386) *** ### defaultWorkflowId[​](#defaultworkflowid "Direct link to defaultWorkflowId") > **defaultWorkflowId**: `number` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:387](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L387) *** ### enabled[​](#enabled "Direct link to enabled") > **enabled**: `boolean` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:385](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L385) *** ### id[​](#id "Direct link to id") > **id**: `number` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:382](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L382) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:384](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L384) *** ### replyInThread[​](#replyinthread "Direct link to replyInThread") > **replyInThread**: `boolean` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:393](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L393) *** ### respondMode[​](#respondmode "Direct link to respondMode") > **respondMode**: `string` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:390](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L390) *** ### respondWhen?[​](#respondwhen "Direct link to respondWhen?") > `optional` **respondWhen**: `string` | `null` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:391](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L391) *** ### slashCommands?[​](#slashcommands "Direct link to slashCommands?") > `optional` **slashCommands**: [`SlackSlashCommandConfigResponse`](https://docs.gravityrail.com/sdk/interfaces/SlackSlashCommandConfigResponse.md)\[] | `null` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:389](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L389) *** ### socketModeEnabled[​](#socketmodeenabled "Direct link to socketModeEnabled") > **socketModeEnabled**: `boolean` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:388](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L388) *** ### updatedAt[​](#updatedat "Direct link to updatedAt") > **updatedAt**: `string` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:396](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L396) *** ### uuid[​](#uuid "Direct link to uuid") > **uuid**: `string` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:383](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L383) --- # Interface: GeneratedTaskResponse Defined in: [packages/sdk/src/types/generated/task.ts:257](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L257) Response model for task endpoints. ## Properties[​](#properties "Direct link to Properties") ### abilities?[​](#abilities "Direct link to abilities?") > `optional` **abilities**: `AbilityResponse`\[] Defined in: [packages/sdk/src/types/generated/task.ts:279](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L279) *** ### archived[​](#archived "Direct link to archived") > **archived**: `boolean` Defined in: [packages/sdk/src/types/generated/task.ts:270](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L270) *** ### celGuard?[​](#celguard "Direct link to celGuard?") > `optional` **celGuard**: `string` | `null` Defined in: [packages/sdk/src/types/generated/task.ts:276](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L276) *** ### childTasks?[​](#childtasks "Direct link to childTasks?") > `optional` **childTasks**: [`ChildTaskResponse`](https://docs.gravityrail.com/sdk/interfaces/ChildTaskResponse.md)\[] Defined in: [packages/sdk/src/types/generated/task.ts:274](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L274) *** ### configuration?[​](#configuration "Direct link to configuration?") > `optional` **configuration**: `TaskResponseConfiguration` Defined in: [packages/sdk/src/types/generated/task.ts:262](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L262) *** ### createdAt[​](#createdat "Direct link to createdAt") > **createdAt**: `string` Defined in: [packages/sdk/src/types/generated/task.ts:268](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L268) *** ### description[​](#description "Direct link to description") > **description**: `string` | `null` Defined in: [packages/sdk/src/types/generated/task.ts:264](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L264) *** ### enterRules[​](#enterrules "Direct link to enterRules") > **enterRules**: `EventRuleResponse`\[] Defined in: [packages/sdk/src/types/generated/task.ts:272](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L272) *** ### eventRules?[​](#eventrules "Direct link to eventRules?") > `optional` **eventRules**: `EventRuleResponse`\[] Defined in: [packages/sdk/src/types/generated/task.ts:281](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L281) *** ### id[​](#id "Direct link to id") > **id**: `number` Defined in: [packages/sdk/src/types/generated/task.ts:258](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L258) *** ### inheritedAbilities?[​](#inheritedabilities "Direct link to inheritedAbilities?") > `optional` **inheritedAbilities**: `AbilityResponse`\[] Defined in: [packages/sdk/src/types/generated/task.ts:280](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L280) *** ### isAdmin[​](#isadmin "Direct link to isAdmin") > **isAdmin**: `boolean` Defined in: [packages/sdk/src/types/generated/task.ts:271](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L271) *** ### leaveRules[​](#leaverules "Direct link to leaveRules") > **leaveRules**: `EventRuleResponse`\[] Defined in: [packages/sdk/src/types/generated/task.ts:273](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L273) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/generated/task.ts:259](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L259) *** ### ownerId?[​](#ownerid "Direct link to ownerId?") > `optional` **ownerId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/task.ts:267](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L267) *** ### permissions?[​](#permissions "Direct link to permissions?") > `optional` **permissions**: `number` Defined in: [packages/sdk/src/types/generated/task.ts:275](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L275) *** ### posX?[​](#posx "Direct link to posX?") > `optional` **posX**: `number` | `null` Defined in: [packages/sdk/src/types/generated/task.ts:277](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L277) *** ### posY?[​](#posy "Direct link to posY?") > `optional` **posY**: `number` | `null` Defined in: [packages/sdk/src/types/generated/task.ts:278](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L278) *** ### prompt[​](#prompt "Direct link to prompt") > **prompt**: `string` | `null` Defined in: [packages/sdk/src/types/generated/task.ts:266](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L266) *** ### shortPrompt[​](#shortprompt "Direct link to shortPrompt") > **shortPrompt**: `string` | `null` Defined in: [packages/sdk/src/types/generated/task.ts:265](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L265) *** ### taskType[​](#tasktype "Direct link to taskType") > **taskType**: `string` Defined in: [packages/sdk/src/types/generated/task.ts:261](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L261) *** ### updatedAt[​](#updatedat "Direct link to updatedAt") > **updatedAt**: `string` Defined in: [packages/sdk/src/types/generated/task.ts:269](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L269) *** ### uuid[​](#uuid "Direct link to uuid") > **uuid**: `string` Defined in: [packages/sdk/src/types/generated/task.ts:260](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L260) *** ### workflowId[​](#workflowid "Direct link to workflowId") > **workflowId**: `number` Defined in: [packages/sdk/src/types/generated/task.ts:263](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L263) --- # Interface: GeneratedVoiceMetricsResponse Defined in: [packages/sdk/src/types/generated/voice\_metrics.ts:76](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/voice_metrics.ts#L76) ## Properties[​](#properties "Direct link to Properties") ### availableChannels?[​](#availablechannels "Direct link to availableChannels?") > `optional` **availableChannels**: `string`\[] Defined in: [packages/sdk/src/types/generated/voice\_metrics.ts:84](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/voice_metrics.ts#L84) *** ### availableEngines?[​](#availableengines "Direct link to availableEngines?") > `optional` **availableEngines**: `string`\[] Defined in: [packages/sdk/src/types/generated/voice\_metrics.ts:83](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/voice_metrics.ts#L83) *** ### callEnd[​](#callend "Direct link to callEnd") > **callEnd**: `CallEndSection` Defined in: [packages/sdk/src/types/generated/voice\_metrics.ts:79](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/voice_metrics.ts#L79) *** ### chat[​](#chat "Direct link to chat") > **chat**: `MetricSection`\[] Defined in: [packages/sdk/src/types/generated/voice\_metrics.ts:78](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/voice_metrics.ts#L78) *** ### requests[​](#requests "Direct link to requests") > **requests**: `RequestsSection` Defined in: [packages/sdk/src/types/generated/voice\_metrics.ts:80](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/voice_metrics.ts#L80) *** ### timeRange[​](#timerange "Direct link to timeRange") > **timeRange**: [`VoiceMetricsTimeRange`](https://docs.gravityrail.com/sdk/interfaces/VoiceMetricsTimeRange.md) Defined in: [packages/sdk/src/types/generated/voice\_metrics.ts:82](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/voice_metrics.ts#L82) *** ### ttsReconnect[​](#ttsreconnect "Direct link to ttsReconnect") > **ttsReconnect**: `TtsReconnectSection` Defined in: [packages/sdk/src/types/generated/voice\_metrics.ts:81](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/voice_metrics.ts#L81) *** ### voice[​](#voice "Direct link to voice") > **voice**: `MetricSection`\[] Defined in: [packages/sdk/src/types/generated/voice\_metrics.ts:77](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/voice_metrics.ts#L77) --- # Interface: GeneratedVoiceModelResponse Defined in: [packages/sdk/src/types/generated/ai\_model.ts:222](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/ai_model.ts#L222) Response model for a voice model. ## Properties[​](#properties "Direct link to Properties") ### description?[​](#description "Direct link to description?") > `optional` **description**: `string` | `null` Defined in: [packages/sdk/src/types/generated/ai\_model.ts:226](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/ai_model.ts#L226) *** ### id[​](#id "Direct link to id") > **id**: `string` Defined in: [packages/sdk/src/types/generated/ai\_model.ts:223](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/ai_model.ts#L223) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/generated/ai\_model.ts:224](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/ai_model.ts#L224) *** ### provider[​](#provider "Direct link to provider") > **provider**: `string` Defined in: [packages/sdk/src/types/generated/ai\_model.ts:225](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/ai_model.ts#L225) *** ### ttsModels?[​](#ttsmodels "Direct link to ttsModels?") > `optional` **ttsModels**: `string`\[] Defined in: [packages/sdk/src/types/generated/ai\_model.ts:227](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/ai_model.ts#L227) --- # Interface: GeneratedWorkflowResponse Defined in: [packages/sdk/src/types/generated/task.ts:405](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L405) Response model for a workflow. ## Properties[​](#properties "Direct link to Properties") ### abilities?[​](#abilities "Direct link to abilities?") > `optional` **abilities**: `AbilityResponse`\[] Defined in: [packages/sdk/src/types/generated/task.ts:432](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L432) *** ### activeVersionName?[​](#activeversionname "Direct link to activeVersionName?") > `optional` **activeVersionName**: `string` | `null` Defined in: [packages/sdk/src/types/generated/task.ts:435](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L435) *** ### activeVersionNumber?[​](#activeversionnumber "Direct link to activeVersionNumber?") > `optional` **activeVersionNumber**: `number` | `null` Defined in: [packages/sdk/src/types/generated/task.ts:434](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L434) *** ### activeVersionPublishedAt?[​](#activeversionpublishedat "Direct link to activeVersionPublishedAt?") > `optional` **activeVersionPublishedAt**: `string` | `null` Defined in: [packages/sdk/src/types/generated/task.ts:436](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L436) *** ### agentId?[​](#agentid "Direct link to agentId?") > `optional` **agentId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/task.ts:413](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L413) *** ### archived?[​](#archived "Direct link to archived?") > `optional` **archived**: `boolean` Defined in: [packages/sdk/src/types/generated/task.ts:418](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L418) *** ### archivedTaskCount?[​](#archivedtaskcount "Direct link to archivedTaskCount?") > `optional` **archivedTaskCount**: `number` Defined in: [packages/sdk/src/types/generated/task.ts:429](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L429) *** ### chatModelConfig?[​](#chatmodelconfig "Direct link to chatModelConfig?") > `optional` **chatModelConfig**: `WorkflowResponseChatModelConfig` Defined in: [packages/sdk/src/types/generated/task.ts:415](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L415) *** ### chatModelId?[​](#chatmodelid "Direct link to chatModelId?") > `optional` **chatModelId**: `string` | `null` Defined in: [packages/sdk/src/types/generated/task.ts:414](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L414) *** ### contributors?[​](#contributors "Direct link to contributors?") > `optional` **contributors**: [`WorkflowContributorResponse`](https://docs.gravityrail.com/sdk/interfaces/WorkflowContributorResponse.md)\[] Defined in: [packages/sdk/src/types/generated/task.ts:425](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L425) *** ### createdAt[​](#createdat "Direct link to createdAt") > **createdAt**: `string` Defined in: [packages/sdk/src/types/generated/task.ts:426](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L426) *** ### dataTypeSlug?[​](#datatypeslug "Direct link to dataTypeSlug?") > `optional` **dataTypeSlug**: `string` | `null` Defined in: [packages/sdk/src/types/generated/task.ts:420](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L420) *** ### defaultInboxId?[​](#defaultinboxid "Direct link to defaultInboxId?") > `optional` **defaultInboxId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/task.ts:422](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L422) *** ### defaultPhoneNumberId?[​](#defaultphonenumberid "Direct link to defaultPhoneNumberId?") > `optional` **defaultPhoneNumberId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/task.ts:421](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L421) *** ### description[​](#description "Direct link to description") > **description**: `string` | `null` Defined in: [packages/sdk/src/types/generated/task.ts:409](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L409) *** ### eventRules?[​](#eventrules "Direct link to eventRules?") > `optional` **eventRules**: `EventRuleResponse`\[] Defined in: [packages/sdk/src/types/generated/task.ts:433](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L433) *** ### id[​](#id "Direct link to id") > **id**: `number` Defined in: [packages/sdk/src/types/generated/task.ts:406](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L406) *** ### memberRoleAccess?[​](#memberroleaccess "Direct link to memberRoleAccess?") > `optional` **memberRoleAccess**: `WorkflowMemberRoleAccessResponse`\[] Defined in: [packages/sdk/src/types/generated/task.ts:431](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L431) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/generated/task.ts:408](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L408) *** ### ownerId[​](#ownerid "Direct link to ownerId") > **ownerId**: `number` Defined in: [packages/sdk/src/types/generated/task.ts:411](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L411) *** ### permissions?[​](#permissions "Direct link to permissions?") > `optional` **permissions**: `number` Defined in: [packages/sdk/src/types/generated/task.ts:430](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L430) *** ### posX?[​](#posx "Direct link to posX?") > `optional` **posX**: `number` | `null` Defined in: [packages/sdk/src/types/generated/task.ts:423](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L423) *** ### posY?[​](#posy "Direct link to posY?") > `optional` **posY**: `number` | `null` Defined in: [packages/sdk/src/types/generated/task.ts:424](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L424) *** ### prompt?[​](#prompt "Direct link to prompt?") > `optional` **prompt**: `string` | `null` Defined in: [packages/sdk/src/types/generated/task.ts:410](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L410) *** ### realtimeModelConfig?[​](#realtimemodelconfig "Direct link to realtimeModelConfig?") > `optional` **realtimeModelConfig**: `WorkflowResponseRealtimeModelConfig` Defined in: [packages/sdk/src/types/generated/task.ts:417](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L417) *** ### realtimeModelId?[​](#realtimemodelid "Direct link to realtimeModelId?") > `optional` **realtimeModelId**: `string` | `null` Defined in: [packages/sdk/src/types/generated/task.ts:416](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L416) *** ### routingMode?[​](#routingmode "Direct link to routingMode?") > `optional` **routingMode**: `string` Defined in: [packages/sdk/src/types/generated/task.ts:419](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L419) *** ### startTaskId?[​](#starttaskid "Direct link to startTaskId?") > `optional` **startTaskId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/task.ts:412](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L412) *** ### taskCount?[​](#taskcount "Direct link to taskCount?") > `optional` **taskCount**: `number` Defined in: [packages/sdk/src/types/generated/task.ts:428](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L428) *** ### updatedAt[​](#updatedat "Direct link to updatedAt") > **updatedAt**: `string` Defined in: [packages/sdk/src/types/generated/task.ts:427](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L427) *** ### uuid[​](#uuid "Direct link to uuid") > **uuid**: `string` Defined in: [packages/sdk/src/types/generated/task.ts:407](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L407) --- # Interface: GeneratedWorkspaceHealthResponse Defined in: [packages/sdk/src/types/generated/workspace\_health.ts:93](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/workspace_health.ts#L93) Response model for workspace health check. ## Properties[​](#properties "Direct link to Properties") ### attachedAddons?[​](#attachedaddons "Direct link to attachedAddons?") > `optional` **attachedAddons**: [`AttachedAddonInfo`](https://docs.gravityrail.com/sdk/interfaces/AttachedAddonInfo.md)\[] Defined in: [packages/sdk/src/types/generated/workspace\_health.ts:99](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/workspace_health.ts#L99) *** ### currentFeatures[​](#currentfeatures "Direct link to currentFeatures") > **currentFeatures**: `string`\[] Defined in: [packages/sdk/src/types/generated/workspace\_health.ts:102](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/workspace_health.ts#L102) *** ### currentPlan?[​](#currentplan "Direct link to currentPlan?") > `optional` **currentPlan**: [`CurrentPlanInfo`](https://docs.gravityrail.com/sdk/interfaces/CurrentPlanInfo.md) | `null` Defined in: [packages/sdk/src/types/generated/workspace\_health.ts:98](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/workspace_health.ts#L98) *** ### dbStatus[​](#dbstatus "Direct link to dbStatus") > **dbStatus**: `string` Defined in: [packages/sdk/src/types/generated/workspace\_health.ts:96](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/workspace_health.ts#L96) *** ### dbStatusCode[​](#dbstatuscode "Direct link to dbStatusCode") > **dbStatusCode**: `number` Defined in: [packages/sdk/src/types/generated/workspace\_health.ts:97](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/workspace_health.ts#L97) *** ### expectedFeatures[​](#expectedfeatures "Direct link to expectedFeatures") > **expectedFeatures**: `string`\[] Defined in: [packages/sdk/src/types/generated/workspace\_health.ts:101](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/workspace_health.ts#L101) *** ### featureSync[​](#featuresync "Direct link to featureSync") > **featureSync**: [`FeatureSyncStatus`](https://docs.gravityrail.com/sdk/interfaces/FeatureSyncStatus.md) Defined in: [packages/sdk/src/types/generated/workspace\_health.ts:100](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/workspace_health.ts#L100) *** ### workspaceName[​](#workspacename "Direct link to workspaceName") > **workspaceName**: `string` Defined in: [packages/sdk/src/types/generated/workspace\_health.ts:95](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/workspace_health.ts#L95) *** ### workspaceUuid[​](#workspaceuuid "Direct link to workspaceUuid") > **workspaceUuid**: `string` Defined in: [packages/sdk/src/types/generated/workspace\_health.ts:94](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/workspace_health.ts#L94) --- # Interface: GenerateRecoveryCodesRequest Defined in: [packages/sdk/src/types/account-types.ts:381](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L381) ## Properties[​](#properties "Direct link to Properties") ### regenerate?[​](#regenerate "Direct link to regenerate?") > `optional` **regenerate**: `boolean` Defined in: [packages/sdk/src/types/account-types.ts:382](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L382) --- # Interface: GenerateSummariesResponse Defined in: [packages/sdk/src/types/generated/communication.ts:207](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L207) Response model for bulk chat summary generation. ## Properties[​](#properties "Direct link to Properties") ### jobsCreated[​](#jobscreated "Direct link to jobsCreated") > **jobsCreated**: `number` Defined in: [packages/sdk/src/types/generated/communication.ts:209](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L209) *** ### totalChats[​](#totalchats "Direct link to totalChats") > **totalChats**: `number` Defined in: [packages/sdk/src/types/generated/communication.ts:208](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L208) --- # Interface: GetChatsOptions Defined in: [packages/sdk/src/types/chat-types.ts:452](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L452) ## Properties[​](#properties "Direct link to Properties") ### archived?[​](#archived "Direct link to archived?") > `optional` **archived**: `boolean` Defined in: [packages/sdk/src/types/chat-types.ts:460](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L460) *** ### assistantMemberId?[​](#assistantmemberid "Direct link to assistantMemberId?") > `optional` **assistantMemberId**: `number` Defined in: [packages/sdk/src/types/chat-types.ts:465](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L465) *** ### channel?[​](#channel "Direct link to channel?") > `optional` **channel**: [`Channel`](https://docs.gravityrail.com/sdk/type-aliases/Channel.md) Defined in: [packages/sdk/src/types/chat-types.ts:461](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L461) *** ### chatType?[​](#chattype "Direct link to chatType?") > `optional` **chatType**: [`ChatType`](https://docs.gravityrail.com/sdk/type-aliases/ChatType.md) Defined in: [packages/sdk/src/types/chat-types.ts:462](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L462) *** ### createdAfter?[​](#createdafter "Direct link to createdAfter?") > `optional` **createdAfter**: `string` Defined in: [packages/sdk/src/types/chat-types.ts:471](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L471) ISO-8601 timestamp — only return chats created on or after this time. *** ### createdBefore?[​](#createdbefore "Direct link to createdBefore?") > `optional` **createdBefore**: `string` Defined in: [packages/sdk/src/types/chat-types.ts:473](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L473) ISO-8601 timestamp — only return chats created on or before this time. *** ### filters?[​](#filters "Direct link to filters?") > `optional` **filters**: [`ChatFilterRuleFormData`](https://docs.gravityrail.com/sdk/interfaces/ChatFilterRuleFormData.md)\[] Defined in: [packages/sdk/src/types/chat-types.ts:467](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L467) *** ### isAnonymous?[​](#isanonymous "Direct link to isAnonymous?") > `optional` **isAnonymous**: `boolean` Defined in: [packages/sdk/src/types/chat-types.ts:469](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L469) *** ### isTest?[​](#istest "Direct link to isTest?") > `optional` **isTest**: `boolean` Defined in: [packages/sdk/src/types/chat-types.ts:468](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L468) *** ### memberFilterId?[​](#memberfilterid "Direct link to memberFilterId?") > `optional` **memberFilterId**: `number` Defined in: [packages/sdk/src/types/chat-types.ts:464](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L464) *** ### memberId?[​](#memberid "Direct link to memberId?") > `optional` **memberId**: `number` Defined in: [packages/sdk/src/types/chat-types.ts:463](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L463) *** ### mine?[​](#mine "Direct link to mine?") > `optional` **mine**: `boolean` Defined in: [packages/sdk/src/types/chat-types.ts:457](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L457) *** ### needsResponse?[​](#needsresponse "Direct link to needsResponse?") > `optional` **needsResponse**: `boolean` Defined in: [packages/sdk/src/types/chat-types.ts:458](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L458) *** ### page?[​](#page "Direct link to page?") > `optional` **page**: `number` Defined in: [packages/sdk/src/types/chat-types.ts:455](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L455) *** ### pageSize?[​](#pagesize "Direct link to pageSize?") > `optional` **pageSize**: `number` Defined in: [packages/sdk/src/types/chat-types.ts:456](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L456) *** ### paused?[​](#paused "Direct link to paused?") > `optional` **paused**: `boolean` Defined in: [packages/sdk/src/types/chat-types.ts:459](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L459) *** ### search?[​](#search "Direct link to search?") > `optional` **search**: `string` Defined in: [packages/sdk/src/types/chat-types.ts:466](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L466) *** ### sortBy?[​](#sortby "Direct link to sortBy?") > `optional` **sortBy**: [`ChatSortField`](https://docs.gravityrail.com/sdk/type-aliases/ChatSortField.md) Defined in: [packages/sdk/src/types/chat-types.ts:453](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L453) *** ### sortOrder?[​](#sortorder "Direct link to sortOrder?") > `optional` **sortOrder**: [`SortOrder`](https://docs.gravityrail.com/sdk/type-aliases/SortOrder.md) Defined in: [packages/sdk/src/types/chat-types.ts:454](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L454) --- # Interface: GoogleCalendarInfo Defined in: [packages/sdk/src/types/generated/calendar.ts:265](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/calendar.ts#L265) Information about a Google Calendar (from Google's API). ## Properties[​](#properties "Direct link to Properties") ### accessRole[​](#accessrole "Direct link to accessRole") > **accessRole**: `string` Defined in: [packages/sdk/src/types/generated/calendar.ts:271](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/calendar.ts#L271) *** ### backgroundColor?[​](#backgroundcolor "Direct link to backgroundColor?") > `optional` **backgroundColor**: `string` | `null` Defined in: [packages/sdk/src/types/generated/calendar.ts:270](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/calendar.ts#L270) *** ### description?[​](#description "Direct link to description?") > `optional` **description**: `string` | `null` Defined in: [packages/sdk/src/types/generated/calendar.ts:268](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/calendar.ts#L268) *** ### id[​](#id "Direct link to id") > **id**: `string` Defined in: [packages/sdk/src/types/generated/calendar.ts:266](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/calendar.ts#L266) *** ### primary?[​](#primary "Direct link to primary?") > `optional` **primary**: `boolean` Defined in: [packages/sdk/src/types/generated/calendar.ts:272](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/calendar.ts#L272) *** ### summary[​](#summary "Direct link to summary") > **summary**: `string` Defined in: [packages/sdk/src/types/generated/calendar.ts:267](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/calendar.ts#L267) *** ### timeZone[​](#timezone "Direct link to timeZone") > **timeZone**: `string` Defined in: [packages/sdk/src/types/generated/calendar.ts:269](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/calendar.ts#L269) --- # Interface: GoogleCalendarInsufficientScopesResponse Defined in: [packages/sdk/src/types/generated/calendar.ts:278](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/calendar.ts#L278) Response when Google Calendar credentials lack required scopes. ## Properties[​](#properties "Direct link to Properties") ### connected?[​](#connected "Direct link to connected?") > `optional` **connected**: `boolean` Defined in: [packages/sdk/src/types/generated/calendar.ts:279](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/calendar.ts#L279) *** ### email?[​](#email "Direct link to email?") > `optional` **email**: `string` | `null` Defined in: [packages/sdk/src/types/generated/calendar.ts:281](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/calendar.ts#L281) *** ### insufficientScopes?[​](#insufficientscopes "Direct link to insufficientScopes?") > `optional` **insufficientScopes**: `boolean` Defined in: [packages/sdk/src/types/generated/calendar.ts:280](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/calendar.ts#L280) *** ### reAuthUrl[​](#reauthurl "Direct link to reAuthUrl") > **reAuthUrl**: `string` Defined in: [packages/sdk/src/types/generated/calendar.ts:282](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/calendar.ts#L282) --- # Interface: GoogleCalendarStatusResponse Defined in: [packages/sdk/src/types/generated/calendar.ts:288](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/calendar.ts#L288) Response with available Google Calendars that can be linked. ## Properties[​](#properties "Direct link to Properties") ### calendars?[​](#calendars "Direct link to calendars?") > `optional` **calendars**: [`GoogleCalendarInfo`](https://docs.gravityrail.com/sdk/interfaces/GoogleCalendarInfo.md)\[] Defined in: [packages/sdk/src/types/generated/calendar.ts:291](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/calendar.ts#L291) *** ### connected[​](#connected "Direct link to connected") > **connected**: `boolean` Defined in: [packages/sdk/src/types/generated/calendar.ts:289](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/calendar.ts#L289) *** ### email?[​](#email "Direct link to email?") > `optional` **email**: `string` | `null` Defined in: [packages/sdk/src/types/generated/calendar.ts:290](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/calendar.ts#L290) *** ### insufficientScopes?[​](#insufficientscopes "Direct link to insufficientScopes?") > `optional` **insufficientScopes**: `boolean` Defined in: [packages/sdk/src/types/generated/calendar.ts:292](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/calendar.ts#L292) --- # Interface: GoogleWorkspaceIntegrationAbilityConfig Defined in: [packages/sdk/src/types/ability-types.ts:293](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ability-types.ts#L293) Shared config for Gmail, Google Calendar, and Google Drive integration abilities ## Properties[​](#properties "Direct link to Properties") ### accessMode?[​](#accessmode "Direct link to accessMode?") > `optional` **accessMode**: [`GoogleWorkspaceAccessMode`](https://docs.gravityrail.com/sdk/type-aliases/GoogleWorkspaceAccessMode.md) Defined in: [packages/sdk/src/types/ability-types.ts:298](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ability-types.ts#L298) read\_only: list linked accounts and read data only. read\_write: also create or modify data (and reconnect OAuth for Gmail). --- # Interface: GroupsResponse Defined in: [packages/sdk/src/api/monday.ts:50](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/monday.ts#L50) ## Properties[​](#properties "Direct link to Properties") ### groups[​](#groups "Direct link to groups") > **groups**: [`MondayGroup`](https://docs.gravityrail.com/sdk/interfaces/MondayGroup.md)\[] Defined in: [packages/sdk/src/api/monday.ts:51](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/monday.ts#L51) --- # Interface: HealthCheckStatistics Defined in: [packages/sdk/src/types/stats-types.ts:138](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/stats-types.ts#L138) ## Properties[​](#properties "Direct link to Properties") ### errorCount[​](#errorcount "Direct link to errorCount") > **errorCount**: `number` Defined in: [packages/sdk/src/types/stats-types.ts:142](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/stats-types.ts#L142) *** ### lastChecked[​](#lastchecked "Direct link to lastChecked") > **lastChecked**: `string` Defined in: [packages/sdk/src/types/stats-types.ts:144](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/stats-types.ts#L144) *** ### responseTime[​](#responsetime "Direct link to responseTime") > **responseTime**: `number` Defined in: [packages/sdk/src/types/stats-types.ts:141](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/stats-types.ts#L141) *** ### serviceStatus[​](#servicestatus "Direct link to serviceStatus") > **serviceStatus**: `"healthy"` | `"degraded"` | `"unhealthy"` Defined in: [packages/sdk/src/types/stats-types.ts:139](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/stats-types.ts#L139) *** ### uptime[​](#uptime "Direct link to uptime") > **uptime**: `number` Defined in: [packages/sdk/src/types/stats-types.ts:140](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/stats-types.ts#L140) *** ### warningCount[​](#warningcount "Direct link to warningCount") > **warningCount**: `number` Defined in: [packages/sdk/src/types/stats-types.ts:143](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/stats-types.ts#L143) --- # Interface: HealthDetailRequest Defined in: [packages/sdk/src/types/health-dashboard-types.ts:52](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/health-dashboard-types.ts#L52) ## Properties[​](#properties "Direct link to Properties") ### hours?[​](#hours "Direct link to hours?") > `optional` **hours**: `number` Defined in: [packages/sdk/src/types/health-dashboard-types.ts:53](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/health-dashboard-types.ts#L53) --- # Interface: HealthieConnectionResponse Defined in: [packages/sdk/src/types/generated/app\_connection.ts:225](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L225) Serialized Healthie connection for API responses. ## Properties[​](#properties "Direct link to Properties") ### baseUrl?[​](#baseurl "Direct link to baseUrl?") > `optional` **baseUrl**: `string` | `null` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:233](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L233) *** ### connectionType?[​](#connectiontype "Direct link to connectionType?") > `optional` **connectionType**: `"healthie_connection"` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:226](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L226) *** ### createdAt?[​](#createdat "Direct link to createdAt?") > `optional` **createdAt**: `string` | `null` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:236](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L236) *** ### creatorId?[​](#creatorid "Direct link to creatorId?") > `optional` **creatorId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:231](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L231) *** ### enabled[​](#enabled "Direct link to enabled") > **enabled**: `boolean` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:230](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L230) *** ### healthieUserId?[​](#healthieuserid "Direct link to healthieUserId?") > `optional` **healthieUserId**: `string` | `null` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:232](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L232) *** ### id[​](#id "Direct link to id") > **id**: `number` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:227](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L227) *** ### lastConnectedAt?[​](#lastconnectedat "Direct link to lastConnectedAt?") > `optional` **lastConnectedAt**: `string` | `null` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:235](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L235) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:229](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L229) *** ### state?[​](#state "Direct link to state?") > `optional` **state**: `string` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:234](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L234) *** ### updatedAt?[​](#updatedat "Direct link to updatedAt?") > `optional` **updatedAt**: `string` | `null` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:237](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L237) *** ### uuid[​](#uuid "Direct link to uuid") > **uuid**: `string` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:228](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L228) --- # Interface: HealthMetricsRequest Defined in: [packages/sdk/src/types/health-dashboard-types.ts:17](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/health-dashboard-types.ts#L17) ## Properties[​](#properties "Direct link to Properties") ### hours?[​](#hours "Direct link to hours?") > `optional` **hours**: `number` Defined in: [packages/sdk/src/types/health-dashboard-types.ts:20](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/health-dashboard-types.ts#L20) *** ### organizationIds?[​](#organizationids "Direct link to organizationIds?") > `optional` **organizationIds**: `number`\[] Defined in: [packages/sdk/src/types/health-dashboard-types.ts:19](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/health-dashboard-types.ts#L19) *** ### workspaceUuids?[​](#workspaceuuids "Direct link to workspaceUuids?") > `optional` **workspaceUuids**: `string`\[] Defined in: [packages/sdk/src/types/health-dashboard-types.ts:18](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/health-dashboard-types.ts#L18) --- # Interface: HealthMetricsResponse Defined in: [packages/sdk/src/types/generated/health\_dashboard.ts:35](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/health_dashboard.ts#L35) Response for the health metrics endpoint. ## Properties[​](#properties "Direct link to Properties") ### hours[​](#hours "Direct link to hours") > **hours**: `number` Defined in: [packages/sdk/src/types/generated/health\_dashboard.ts:40](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/health_dashboard.ts#L40) *** ### previousSummary?[​](#previoussummary "Direct link to previousSummary?") > `optional` **previousSummary**: [`HealthSummary`](https://docs.gravityrail.com/sdk/interfaces/HealthSummary.md) | `null` Defined in: [packages/sdk/src/types/generated/health\_dashboard.ts:37](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/health_dashboard.ts#L37) *** ### skippedWorkspaces?[​](#skippedworkspaces "Direct link to skippedWorkspaces?") > `optional` **skippedWorkspaces**: [`SkippedWorkspace`](https://docs.gravityrail.com/sdk/interfaces/SkippedWorkspace.md)\[] Defined in: [packages/sdk/src/types/generated/health\_dashboard.ts:39](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/health_dashboard.ts#L39) *** ### summary[​](#summary "Direct link to summary") > **summary**: [`HealthSummary`](https://docs.gravityrail.com/sdk/interfaces/HealthSummary.md) Defined in: [packages/sdk/src/types/generated/health\_dashboard.ts:36](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/health_dashboard.ts#L36) *** ### workspaces[​](#workspaces "Direct link to workspaces") > **workspaces**: [`WorkspaceHealthRow`](https://docs.gravityrail.com/sdk/interfaces/WorkspaceHealthRow.md)\[] Defined in: [packages/sdk/src/types/generated/health\_dashboard.ts:38](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/health_dashboard.ts#L38) --- # Interface: HealthSummary Defined in: [packages/sdk/src/types/generated/health\_dashboard.ts:46](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/health_dashboard.ts#L46) Aggregate summary across all queried workspaces. ## Properties[​](#properties "Direct link to Properties") ### criticalCount?[​](#criticalcount "Direct link to criticalCount?") > `optional` **criticalCount**: `number` Defined in: [packages/sdk/src/types/generated/health\_dashboard.ts:48](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/health_dashboard.ts#L48) *** ### healthyCount?[​](#healthycount "Direct link to healthyCount?") > `optional` **healthyCount**: `number` Defined in: [packages/sdk/src/types/generated/health\_dashboard.ts:50](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/health_dashboard.ts#L50) *** ### totalAccessGapWarnings?[​](#totalaccessgapwarnings "Direct link to totalAccessGapWarnings?") > `optional` **totalAccessGapWarnings**: `number` Defined in: [packages/sdk/src/types/generated/health\_dashboard.ts:65](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/health_dashboard.ts#L65) *** ### totalEmailFailures?[​](#totalemailfailures "Direct link to totalEmailFailures?") > `optional` **totalEmailFailures**: `number` Defined in: [packages/sdk/src/types/generated/health\_dashboard.ts:55](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/health_dashboard.ts#L55) *** ### totalEmailVolume?[​](#totalemailvolume "Direct link to totalEmailVolume?") > `optional` **totalEmailVolume**: `number` Defined in: [packages/sdk/src/types/generated/health\_dashboard.ts:56](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/health_dashboard.ts#L56) *** ### totalEventRuleFailures?[​](#totaleventrulefailures "Direct link to totalEventRuleFailures?") > `optional` **totalEventRuleFailures**: `number` Defined in: [packages/sdk/src/types/generated/health\_dashboard.ts:57](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/health_dashboard.ts#L57) *** ### totalEventRuleVolume?[​](#totaleventrulevolume "Direct link to totalEventRuleVolume?") > `optional` **totalEventRuleVolume**: `number` Defined in: [packages/sdk/src/types/generated/health\_dashboard.ts:58](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/health_dashboard.ts#L58) *** ### totalMemberChats?[​](#totalmemberchats "Direct link to totalMemberChats?") > `optional` **totalMemberChats**: `number` Defined in: [packages/sdk/src/types/generated/health\_dashboard.ts:63](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/health_dashboard.ts#L63) *** ### totalNeedsResponse?[​](#totalneedsresponse "Direct link to totalNeedsResponse?") > `optional` **totalNeedsResponse**: `number` Defined in: [packages/sdk/src/types/generated/health\_dashboard.ts:64](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/health_dashboard.ts#L64) *** ### totalSmsFailures?[​](#totalsmsfailures "Direct link to totalSmsFailures?") > `optional` **totalSmsFailures**: `number` Defined in: [packages/sdk/src/types/generated/health\_dashboard.ts:51](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/health_dashboard.ts#L51) *** ### totalSmsOutboundChats?[​](#totalsmsoutboundchats "Direct link to totalSmsOutboundChats?") > `optional` **totalSmsOutboundChats**: `number` Defined in: [packages/sdk/src/types/generated/health\_dashboard.ts:62](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/health_dashboard.ts#L62) *** ### totalSmsResponded?[​](#totalsmsresponded "Direct link to totalSmsResponded?") > `optional` **totalSmsResponded**: `number` Defined in: [packages/sdk/src/types/generated/health\_dashboard.ts:61](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/health_dashboard.ts#L61) *** ### totalSmsVolume?[​](#totalsmsvolume "Direct link to totalSmsVolume?") > `optional` **totalSmsVolume**: `number` Defined in: [packages/sdk/src/types/generated/health\_dashboard.ts:52](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/health_dashboard.ts#L52) *** ### totalVoiceFailures?[​](#totalvoicefailures "Direct link to totalVoiceFailures?") > `optional` **totalVoiceFailures**: `number` Defined in: [packages/sdk/src/types/generated/health\_dashboard.ts:53](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/health_dashboard.ts#L53) *** ### totalVoiceVolume?[​](#totalvoicevolume "Direct link to totalVoiceVolume?") > `optional` **totalVoiceVolume**: `number` Defined in: [packages/sdk/src/types/generated/health\_dashboard.ts:54](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/health_dashboard.ts#L54) *** ### totalWebhookFailures?[​](#totalwebhookfailures "Direct link to totalWebhookFailures?") > `optional` **totalWebhookFailures**: `number` Defined in: [packages/sdk/src/types/generated/health\_dashboard.ts:59](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/health_dashboard.ts#L59) *** ### totalWebhookVolume?[​](#totalwebhookvolume "Direct link to totalWebhookVolume?") > `optional` **totalWebhookVolume**: `number` Defined in: [packages/sdk/src/types/generated/health\_dashboard.ts:60](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/health_dashboard.ts#L60) *** ### totalWorkspaces?[​](#totalworkspaces "Direct link to totalWorkspaces?") > `optional` **totalWorkspaces**: `number` Defined in: [packages/sdk/src/types/generated/health\_dashboard.ts:47](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/health_dashboard.ts#L47) *** ### warningCount?[​](#warningcount "Direct link to warningCount?") > `optional` **warningCount**: `number` Defined in: [packages/sdk/src/types/generated/health\_dashboard.ts:49](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/health_dashboard.ts#L49) --- # Interface: HITLActionRequest Defined in: [packages/sdk/src/types/chat-types.ts:321](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L321) ## Properties[​](#properties "Direct link to Properties") ### args[​](#args "Direct link to args") > **args**: `Record`<`string`, `any`> Defined in: [packages/sdk/src/types/chat-types.ts:323](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L323) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/chat-types.ts:322](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L322) --- # Interface: HITLDecision Defined in: [packages/sdk/src/types/chat-types.ts:338](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L338) ## Properties[​](#properties "Direct link to Properties") ### editedAction?[​](#editedaction "Direct link to editedAction?") > `optional` **editedAction**: `object` Defined in: [packages/sdk/src/types/chat-types.ts:341](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L341) #### args[​](#args "Direct link to args") > **args**: `Record`<`string`, `unknown`> #### name[​](#name "Direct link to name") > **name**: `string` *** ### message?[​](#message "Direct link to message?") > `optional` **message**: `string` Defined in: [packages/sdk/src/types/chat-types.ts:340](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L340) *** ### type[​](#type "Direct link to type") > **type**: `"edit"` | `"approve"` | `"approve_always"` | `"reject"` Defined in: [packages/sdk/src/types/chat-types.ts:339](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L339) --- # Interface: HITLRequest Defined in: [packages/sdk/src/types/chat-types.ts:331](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L331) ## Properties[​](#properties "Direct link to Properties") ### actionRequests[​](#actionrequests "Direct link to actionRequests") > **actionRequests**: [`HITLActionRequest`](https://docs.gravityrail.com/sdk/interfaces/HITLActionRequest.md)\[] Defined in: [packages/sdk/src/types/chat-types.ts:332](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L332) *** ### interruptId?[​](#interruptid "Direct link to interruptId?") > `optional` **interruptId**: `string` Defined in: [packages/sdk/src/types/chat-types.ts:335](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L335) LangGraph interrupt ID injected by the backend so it can be echoed back on resume. *** ### reviewConfigs[​](#reviewconfigs "Direct link to reviewConfigs") > **reviewConfigs**: [`HITLReviewConfig`](https://docs.gravityrail.com/sdk/interfaces/HITLReviewConfig.md)\[] Defined in: [packages/sdk/src/types/chat-types.ts:333](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L333) --- # Interface: HITLResponse Defined in: [packages/sdk/src/types/chat-types.ts:344](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L344) ## Properties[​](#properties "Direct link to Properties") ### decisions[​](#decisions "Direct link to decisions") > **decisions**: [`HITLDecision`](https://docs.gravityrail.com/sdk/interfaces/HITLDecision.md)\[] Defined in: [packages/sdk/src/types/chat-types.ts:345](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L345) *** ### interruptId?[​](#interruptid "Direct link to interruptId?") > `optional` **interruptId**: `string` Defined in: [packages/sdk/src/types/chat-types.ts:347](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L347) LangGraph interrupt ID echoed back from the human\_input\_request event. --- # Interface: HITLReviewConfig Defined in: [packages/sdk/src/types/chat-types.ts:326](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L326) ## Properties[​](#properties "Direct link to Properties") ### actionName[​](#actionname "Direct link to actionName") > **actionName**: `string` Defined in: [packages/sdk/src/types/chat-types.ts:327](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L327) *** ### requireReview[​](#requirereview "Direct link to requireReview") > **requireReview**: `boolean` Defined in: [packages/sdk/src/types/chat-types.ts:328](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L328) --- # Interface: HubspotConnectionResponse Defined in: [packages/sdk/src/types/generated/app\_connection.ts:243](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L243) Serialized HubSpot connection for API responses. ## Properties[​](#properties "Direct link to Properties") ### connectionType?[​](#connectiontype "Direct link to connectionType?") > `optional` **connectionType**: `"hubspot_connection"` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:244](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L244) *** ### createdAt?[​](#createdat "Direct link to createdAt?") > `optional` **createdAt**: `string` | `null` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:253](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L253) *** ### creatorId?[​](#creatorid "Direct link to creatorId?") > `optional` **creatorId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:249](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L249) *** ### enabled[​](#enabled "Direct link to enabled") > **enabled**: `boolean` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:248](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L248) *** ### id[​](#id "Direct link to id") > **id**: `number` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:245](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L245) *** ### lastConnectedAt?[​](#lastconnectedat "Direct link to lastConnectedAt?") > `optional` **lastConnectedAt**: `string` | `null` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:252](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L252) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:247](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L247) *** ### portalId?[​](#portalid "Direct link to portalId?") > `optional` **portalId**: `string` | `null` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:250](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L250) *** ### state?[​](#state "Direct link to state?") > `optional` **state**: `string` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:251](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L251) *** ### syncConfig?[​](#syncconfig "Direct link to syncConfig?") > `optional` **syncConfig**: `HubspotConnectionResponseSyncConfig` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:255](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L255) *** ### updatedAt?[​](#updatedat "Direct link to updatedAt?") > `optional` **updatedAt**: `string` | `null` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:254](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L254) *** ### uuid[​](#uuid "Direct link to uuid") > **uuid**: `string` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:246](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L246) --- # Interface: HubSpotNoteSyncConfig Defined in: [packages/sdk/src/types/app-connection-types.ts:201](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L201) ## Properties[​](#properties "Direct link to Properties") ### associateToContact[​](#associatetocontact "Direct link to associateToContact") > **associateToContact**: `boolean` Defined in: [packages/sdk/src/types/app-connection-types.ts:204](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L204) *** ### bodyTemplate[​](#bodytemplate "Direct link to bodyTemplate") > **bodyTemplate**: `string` Defined in: [packages/sdk/src/types/app-connection-types.ts:203](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L203) *** ### dataTypeId[​](#datatypeid "Direct link to dataTypeId") > **dataTypeId**: `number` Defined in: [packages/sdk/src/types/app-connection-types.ts:202](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L202) --- # Interface: HubSpotPropertyDefinition Defined in: [packages/sdk/src/types/app-connection-types.ts:303](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L303) ## Properties[​](#properties "Direct link to Properties") ### groupName[​](#groupname "Direct link to groupName") > **groupName**: `string` Defined in: [packages/sdk/src/types/app-connection-types.ts:307](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L307) *** ### label[​](#label "Direct link to label") > **label**: `string` Defined in: [packages/sdk/src/types/app-connection-types.ts:305](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L305) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/app-connection-types.ts:304](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L304) *** ### options[​](#options "Direct link to options") > **options**: [`HubSpotPropertyOption`](https://docs.gravityrail.com/sdk/interfaces/HubSpotPropertyOption.md)\[] Defined in: [packages/sdk/src/types/app-connection-types.ts:308](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L308) *** ### type[​](#type "Direct link to type") > **type**: `string` Defined in: [packages/sdk/src/types/app-connection-types.ts:306](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L306) --- # Interface: HubSpotPropertyOption Defined in: [packages/sdk/src/types/app-connection-types.ts:298](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L298) ## Properties[​](#properties "Direct link to Properties") ### label[​](#label "Direct link to label") > **label**: `string` Defined in: [packages/sdk/src/types/app-connection-types.ts:299](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L299) *** ### value[​](#value "Direct link to value") > **value**: `string` Defined in: [packages/sdk/src/types/app-connection-types.ts:300](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L300) --- # Interface: HubSpotSearchRequest Defined in: [packages/sdk/src/types/app-connection-types.ts:105](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L105) ## Properties[​](#properties "Direct link to Properties") ### after?[​](#after "Direct link to after?") > `optional` **after**: `string` | `null` Defined in: [packages/sdk/src/types/app-connection-types.ts:109](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L109) *** ### limit?[​](#limit "Direct link to limit?") > `optional` **limit**: `number` Defined in: [packages/sdk/src/types/app-connection-types.ts:108](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L108) *** ### objectType[​](#objecttype "Direct link to objectType") > **objectType**: `"contacts"` | `"companies"` Defined in: [packages/sdk/src/types/app-connection-types.ts:107](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L107) *** ### query[​](#query "Direct link to query") > **query**: `string` Defined in: [packages/sdk/src/types/app-connection-types.ts:106](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L106) --- # Interface: HubSpotSearchResponse Defined in: [packages/sdk/src/types/app-connection-types.ts:127](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L127) ## Properties[​](#properties "Direct link to Properties") ### hasMore[​](#hasmore "Direct link to hasMore") > **hasMore**: `boolean` Defined in: [packages/sdk/src/types/app-connection-types.ts:129](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L129) *** ### nextCursor[​](#nextcursor "Direct link to nextCursor") > **nextCursor**: `string` | `null` Defined in: [packages/sdk/src/types/app-connection-types.ts:130](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L130) *** ### results[​](#results "Direct link to results") > **results**: [`HubSpotSearchResult`](https://docs.gravityrail.com/sdk/interfaces/HubSpotSearchResult.md)\[] Defined in: [packages/sdk/src/types/app-connection-types.ts:128](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L128) --- # Interface: HubSpotSearchResult Defined in: [packages/sdk/src/types/app-connection-types.ts:117](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L117) ## Properties[​](#properties "Direct link to Properties") ### company[​](#company "Direct link to company") > **company**: `string` | `null` Defined in: [packages/sdk/src/types/app-connection-types.ts:122](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L122) *** ### email[​](#email "Direct link to email") > **email**: `string` | `null` Defined in: [packages/sdk/src/types/app-connection-types.ts:120](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L120) *** ### existingMember[​](#existingmember "Direct link to existingMember") > **existingMember**: [`HubSpotSearchResultMatch`](https://docs.gravityrail.com/sdk/interfaces/HubSpotSearchResultMatch.md) | `null` Defined in: [packages/sdk/src/types/app-connection-types.ts:124](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L124) *** ### id[​](#id "Direct link to id") > **id**: `string` Defined in: [packages/sdk/src/types/app-connection-types.ts:118](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L118) *** ### name[​](#name "Direct link to name") > **name**: `string` | `null` Defined in: [packages/sdk/src/types/app-connection-types.ts:119](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L119) *** ### objectType[​](#objecttype "Direct link to objectType") > **objectType**: `string` Defined in: [packages/sdk/src/types/app-connection-types.ts:123](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L123) *** ### phone[​](#phone "Direct link to phone") > **phone**: `string` | `null` Defined in: [packages/sdk/src/types/app-connection-types.ts:121](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L121) --- # Interface: HubSpotSearchResultMatch Defined in: [packages/sdk/src/types/app-connection-types.ts:112](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L112) ## Properties[​](#properties "Direct link to Properties") ### matchType[​](#matchtype "Direct link to matchType") > **matchType**: `"email"` | `"phone"` | `"hubspot_id"` Defined in: [packages/sdk/src/types/app-connection-types.ts:114](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L114) *** ### memberId[​](#memberid "Direct link to memberId") > **memberId**: `number` Defined in: [packages/sdk/src/types/app-connection-types.ts:113](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L113) --- # Interface: HubSpotSyncSettingsRequest Defined in: [packages/sdk/src/types/app-connection-types.ts:241](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L241) ## Properties[​](#properties "Direct link to Properties") ### defaultLifecycleStage?[​](#defaultlifecyclestage "Direct link to defaultLifecycleStage?") > `optional` **defaultLifecycleStage**: `string` | `null` Defined in: [packages/sdk/src/types/app-connection-types.ts:247](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L247) *** ### inboundEnabled[​](#inboundenabled "Direct link to inboundEnabled") > **inboundEnabled**: `boolean` Defined in: [packages/sdk/src/types/app-connection-types.ts:243](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L243) *** ### noteSync[​](#notesync "Direct link to noteSync") > **noteSync**: [`HubSpotNoteSyncConfig`](https://docs.gravityrail.com/sdk/interfaces/HubSpotNoteSyncConfig.md)\[] Defined in: [packages/sdk/src/types/app-connection-types.ts:245](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L245) *** ### outboundEnabled[​](#outboundenabled "Direct link to outboundEnabled") > **outboundEnabled**: `boolean` Defined in: [packages/sdk/src/types/app-connection-types.ts:242](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L242) *** ### rules[​](#rules "Direct link to rules") > **rules**: [`SyncRule`](https://docs.gravityrail.com/sdk/interfaces/SyncRule.md)\[] Defined in: [packages/sdk/src/types/app-connection-types.ts:244](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L244) *** ### taskSync[​](#tasksync "Direct link to taskSync") > **taskSync**: [`HubSpotTaskSyncConfig`](https://docs.gravityrail.com/sdk/interfaces/HubSpotTaskSyncConfig.md)\[] Defined in: [packages/sdk/src/types/app-connection-types.ts:246](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L246) --- # Interface: HubSpotSyncSettingsResponse Defined in: [packages/sdk/src/types/app-connection-types.ts:250](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L250) ## Properties[​](#properties "Direct link to Properties") ### defaultLifecycleStage?[​](#defaultlifecyclestage "Direct link to defaultLifecycleStage?") > `optional` **defaultLifecycleStage**: `string` | `null` Defined in: [packages/sdk/src/types/app-connection-types.ts:256](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L256) *** ### inboundEnabled[​](#inboundenabled "Direct link to inboundEnabled") > **inboundEnabled**: `boolean` Defined in: [packages/sdk/src/types/app-connection-types.ts:252](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L252) *** ### noteSync[​](#notesync "Direct link to noteSync") > **noteSync**: [`HubSpotNoteSyncConfig`](https://docs.gravityrail.com/sdk/interfaces/HubSpotNoteSyncConfig.md)\[] Defined in: [packages/sdk/src/types/app-connection-types.ts:254](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L254) *** ### outboundEnabled[​](#outboundenabled "Direct link to outboundEnabled") > **outboundEnabled**: `boolean` Defined in: [packages/sdk/src/types/app-connection-types.ts:251](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L251) *** ### rules[​](#rules "Direct link to rules") > **rules**: [`SyncRule`](https://docs.gravityrail.com/sdk/interfaces/SyncRule.md)\[] Defined in: [packages/sdk/src/types/app-connection-types.ts:253](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L253) *** ### taskSync[​](#tasksync "Direct link to taskSync") > **taskSync**: [`HubSpotTaskSyncConfig`](https://docs.gravityrail.com/sdk/interfaces/HubSpotTaskSyncConfig.md)\[] Defined in: [packages/sdk/src/types/app-connection-types.ts:255](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L255) --- # Interface: HubSpotTaskSyncConfig Defined in: [packages/sdk/src/types/app-connection-types.ts:210](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L210) ## Properties[​](#properties "Direct link to Properties") ### associateToContact[​](#associatetocontact "Direct link to associateToContact") > **associateToContact**: `boolean` Defined in: [packages/sdk/src/types/app-connection-types.ts:216](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L216) *** ### bodyTemplate[​](#bodytemplate "Direct link to bodyTemplate") > **bodyTemplate**: `string` Defined in: [packages/sdk/src/types/app-connection-types.ts:213](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L213) *** ### dataTypeId[​](#datatypeid "Direct link to dataTypeId") > **dataTypeId**: `number` Defined in: [packages/sdk/src/types/app-connection-types.ts:211](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L211) *** ### priority[​](#priority "Direct link to priority") > **priority**: [`HubSpotTaskPriority`](https://docs.gravityrail.com/sdk/type-aliases/HubSpotTaskPriority.md) Defined in: [packages/sdk/src/types/app-connection-types.ts:214](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L214) *** ### status[​](#status "Direct link to status") > **status**: [`HubSpotTaskStatus`](https://docs.gravityrail.com/sdk/type-aliases/HubSpotTaskStatus.md) Defined in: [packages/sdk/src/types/app-connection-types.ts:215](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L215) *** ### subjectTemplate[​](#subjecttemplate "Direct link to subjectTemplate") > **subjectTemplate**: `string` Defined in: [packages/sdk/src/types/app-connection-types.ts:212](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L212) --- # Interface: HumanChatParticipant Defined in: [packages/sdk/src/types/chat-types.ts:131](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L131) ## Properties[​](#properties "Direct link to Properties") ### memberId[​](#memberid "Direct link to memberId") > **memberId**: `number` Defined in: [packages/sdk/src/types/chat-types.ts:134](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L134) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/chat-types.ts:132](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L132) *** ### role[​](#role "Direct link to role") > **role**: `"user"` Defined in: [packages/sdk/src/types/chat-types.ts:133](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L133) --- # Interface: ICalFeedTokenResponse Defined in: [packages/sdk/src/types/generated/calendar.ts:298](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/calendar.ts#L298) Response model for iCal feed token generation. ## Properties[​](#properties "Direct link to Properties") ### calendarId[​](#calendarid "Direct link to calendarId") > **calendarId**: `number` Defined in: [packages/sdk/src/types/generated/calendar.ts:301](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/calendar.ts#L301) *** ### calendarUuid[​](#calendaruuid "Direct link to calendarUuid") > **calendarUuid**: `string` Defined in: [packages/sdk/src/types/generated/calendar.ts:302](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/calendar.ts#L302) *** ### feedUrl[​](#feedurl "Direct link to feedUrl") > **feedUrl**: `string` Defined in: [packages/sdk/src/types/generated/calendar.ts:299](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/calendar.ts#L299) *** ### tokenGeneratedAt[​](#tokengeneratedat "Direct link to tokenGeneratedAt") > **tokenGeneratedAt**: `string` Defined in: [packages/sdk/src/types/generated/calendar.ts:300](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/calendar.ts#L300) --- # Interface: ICalFeedUrlResponse Defined in: [packages/sdk/src/types/generated/calendar.ts:308](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/calendar.ts#L308) Response model for getting iCal feed URL. ## Properties[​](#properties "Direct link to Properties") ### feedUrl[​](#feedurl "Direct link to feedUrl") > **feedUrl**: `string` | `null` Defined in: [packages/sdk/src/types/generated/calendar.ts:309](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/calendar.ts#L309) *** ### hasToken[​](#hastoken "Direct link to hasToken") > **hasToken**: `boolean` Defined in: [packages/sdk/src/types/generated/calendar.ts:310](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/calendar.ts#L310) *** ### tokenGeneratedAt[​](#tokengeneratedat "Direct link to tokenGeneratedAt") > **tokenGeneratedAt**: `string` | `null` Defined in: [packages/sdk/src/types/generated/calendar.ts:311](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/calendar.ts#L311) --- # Interface: ImageGenerationAbilityConfig Defined in: [packages/sdk/src/types/ability-types.ts:376](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ability-types.ts#L376) Config for image\_generation ability ## Properties[​](#properties "Direct link to Properties") ### defaultAspectRatio?[​](#defaultaspectratio "Direct link to defaultAspectRatio?") > `optional` **defaultAspectRatio**: `"auto"` | `"1:1"` | `"16:9"` | `"9:16"` | `"4:3"` | `"3:4"` Defined in: [packages/sdk/src/types/ability-types.ts:381](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ability-types.ts#L381) Preferred aspect ratio the agent uses when the user doesn't request a specific shape. 'auto' lets the agent choose per request (default: 'auto'). *** ### maxImages?[​](#maximages "Direct link to maxImages?") > `optional` **maxImages**: `1` | `2` | `3` | `4` Defined in: [packages/sdk/src/types/ability-types.ts:383](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ability-types.ts#L383) Maximum images the agent may generate in a single request, 1-4 (default: 4) --- # Interface: ImageUrlContent Defined in: [packages/sdk/src/types/chat-types.ts:195](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L195) ## Properties[​](#properties "Direct link to Properties") ### image\_url[​](#image_url "Direct link to image_url") > **image\_url**: `object` Defined in: [packages/sdk/src/types/chat-types.ts:197](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L197) #### detail?[​](#detail "Direct link to detail?") > `optional` **detail**: `"auto"` | `"high"` | `"low"` #### url[​](#url "Direct link to url") > **url**: `string` *** ### type[​](#type "Direct link to type") > **type**: `"image_url"` Defined in: [packages/sdk/src/types/chat-types.ts:196](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L196) --- # Interface: ImportedMemberResult Defined in: [packages/sdk/src/types/app-connection-types.ts:150](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L150) ## Properties[​](#properties "Direct link to Properties") ### error[​](#error "Direct link to error") > **error**: `string` | `null` Defined in: [packages/sdk/src/types/app-connection-types.ts:155](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L155) *** ### hubspotId[​](#hubspotid "Direct link to hubspotId") > **hubspotId**: `string` Defined in: [packages/sdk/src/types/app-connection-types.ts:151](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L151) *** ### memberId[​](#memberid "Direct link to memberId") > **memberId**: `number` | `null` Defined in: [packages/sdk/src/types/app-connection-types.ts:152](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L152) *** ### name[​](#name "Direct link to name") > **name**: `string` | `null` Defined in: [packages/sdk/src/types/app-connection-types.ts:153](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L153) *** ### success[​](#success "Direct link to success") > **success**: `boolean` Defined in: [packages/sdk/src/types/app-connection-types.ts:154](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L154) --- # Interface: ImportedSalesforceMemberResult Defined in: [packages/sdk/src/types/app-connection-types.ts:411](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L411) ## Properties[​](#properties "Direct link to Properties") ### error[​](#error "Direct link to error") > **error**: `string` | `null` Defined in: [packages/sdk/src/types/app-connection-types.ts:416](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L416) *** ### memberId[​](#memberid "Direct link to memberId") > **memberId**: `number` | `null` Defined in: [packages/sdk/src/types/app-connection-types.ts:413](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L413) *** ### name[​](#name "Direct link to name") > **name**: `string` | `null` Defined in: [packages/sdk/src/types/app-connection-types.ts:414](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L414) *** ### salesforceId[​](#salesforceid "Direct link to salesforceId") > **salesforceId**: `string` Defined in: [packages/sdk/src/types/app-connection-types.ts:412](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L412) *** ### success[​](#success "Direct link to success") > **success**: `boolean` Defined in: [packages/sdk/src/types/app-connection-types.ts:415](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L415) --- # Interface: ImportHubSpotMembersRequest Defined in: [packages/sdk/src/types/app-connection-types.ts:141](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L141) ## Properties[​](#properties "Direct link to Properties") ### addToOrg?[​](#addtoorg "Direct link to addToOrg?") > `optional` **addToOrg**: `boolean` Defined in: [packages/sdk/src/types/app-connection-types.ts:144](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L144) *** ### memberRoleId[​](#memberroleid "Direct link to memberRoleId") > **memberRoleId**: `number` Defined in: [packages/sdk/src/types/app-connection-types.ts:143](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L143) *** ### orgRole?[​](#orgrole "Direct link to orgRole?") > `optional` **orgRole**: `string` | `null` Defined in: [packages/sdk/src/types/app-connection-types.ts:145](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L145) *** ### records[​](#records "Direct link to records") > **records**: [`ImportHubSpotRecordRequest`](https://docs.gravityrail.com/sdk/interfaces/ImportHubSpotRecordRequest.md)\[] Defined in: [packages/sdk/src/types/app-connection-types.ts:142](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L142) *** ### trustEmail?[​](#trustemail "Direct link to trustEmail?") > `optional` **trustEmail**: `boolean` Defined in: [packages/sdk/src/types/app-connection-types.ts:146](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L146) *** ### trustPhone?[​](#trustphone "Direct link to trustPhone?") > `optional` **trustPhone**: `boolean` Defined in: [packages/sdk/src/types/app-connection-types.ts:147](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L147) --- # Interface: ImportHubSpotMembersResponse Defined in: [packages/sdk/src/types/app-connection-types.ts:158](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L158) ## Properties[​](#properties "Direct link to Properties") ### failed[​](#failed "Direct link to failed") > **failed**: `number` Defined in: [packages/sdk/src/types/app-connection-types.ts:160](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L160) *** ### imported[​](#imported "Direct link to imported") > **imported**: `number` Defined in: [packages/sdk/src/types/app-connection-types.ts:159](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L159) *** ### results[​](#results "Direct link to results") > **results**: [`ImportedMemberResult`](https://docs.gravityrail.com/sdk/interfaces/ImportedMemberResult.md)\[] Defined in: [packages/sdk/src/types/app-connection-types.ts:161](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L161) --- # Interface: ImportHubSpotRecordRequest Defined in: [packages/sdk/src/types/app-connection-types.ts:133](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L133) ## Properties[​](#properties "Direct link to Properties") ### email?[​](#email "Direct link to email?") > `optional` **email**: `string` | `null` Defined in: [packages/sdk/src/types/app-connection-types.ts:136](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L136) *** ### hubspotId[​](#hubspotid "Direct link to hubspotId") > **hubspotId**: `string` Defined in: [packages/sdk/src/types/app-connection-types.ts:134](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L134) *** ### name?[​](#name "Direct link to name?") > `optional` **name**: `string` | `null` Defined in: [packages/sdk/src/types/app-connection-types.ts:135](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L135) *** ### objectType?[​](#objecttype "Direct link to objectType?") > `optional` **objectType**: `string` Defined in: [packages/sdk/src/types/app-connection-types.ts:138](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L138) *** ### phone?[​](#phone "Direct link to phone?") > `optional` **phone**: `string` | `null` Defined in: [packages/sdk/src/types/app-connection-types.ts:137](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L137) --- # Interface: ImportPreviewItem Defined in: [packages/sdk/src/types/task-types.ts:216](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/task-types.ts#L216) ## Properties[​](#properties "Direct link to Properties") ### action[​](#action "Direct link to action") > **action**: `string` Defined in: [packages/sdk/src/types/task-types.ts:217](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/task-types.ts#L217) *** ### details[​](#details "Direct link to details") > **details**: `string`\[] Defined in: [packages/sdk/src/types/task-types.ts:219](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/task-types.ts#L219) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/task-types.ts:218](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/task-types.ts#L218) --- # Interface: ImportSalesforceMembersRequest Defined in: [packages/sdk/src/types/app-connection-types.ts:402](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L402) ## Properties[​](#properties "Direct link to Properties") ### addToOrg?[​](#addtoorg "Direct link to addToOrg?") > `optional` **addToOrg**: `boolean` Defined in: [packages/sdk/src/types/app-connection-types.ts:405](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L405) *** ### memberRoleId[​](#memberroleid "Direct link to memberRoleId") > **memberRoleId**: `number` Defined in: [packages/sdk/src/types/app-connection-types.ts:404](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L404) *** ### orgRole?[​](#orgrole "Direct link to orgRole?") > `optional` **orgRole**: `string` | `null` Defined in: [packages/sdk/src/types/app-connection-types.ts:406](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L406) *** ### records[​](#records "Direct link to records") > **records**: [`ImportSalesforceRecordRequest`](https://docs.gravityrail.com/sdk/interfaces/ImportSalesforceRecordRequest.md)\[] Defined in: [packages/sdk/src/types/app-connection-types.ts:403](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L403) *** ### trustEmail?[​](#trustemail "Direct link to trustEmail?") > `optional` **trustEmail**: `boolean` Defined in: [packages/sdk/src/types/app-connection-types.ts:407](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L407) *** ### trustPhone?[​](#trustphone "Direct link to trustPhone?") > `optional` **trustPhone**: `boolean` Defined in: [packages/sdk/src/types/app-connection-types.ts:408](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L408) --- # Interface: ImportSalesforceMembersResponse Defined in: [packages/sdk/src/types/app-connection-types.ts:419](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L419) ## Properties[​](#properties "Direct link to Properties") ### failed[​](#failed "Direct link to failed") > **failed**: `number` Defined in: [packages/sdk/src/types/app-connection-types.ts:421](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L421) *** ### imported[​](#imported "Direct link to imported") > **imported**: `number` Defined in: [packages/sdk/src/types/app-connection-types.ts:420](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L420) *** ### results[​](#results "Direct link to results") > **results**: [`ImportedSalesforceMemberResult`](https://docs.gravityrail.com/sdk/interfaces/ImportedSalesforceMemberResult.md)\[] Defined in: [packages/sdk/src/types/app-connection-types.ts:422](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L422) --- # Interface: ImportSalesforceRecordRequest Defined in: [packages/sdk/src/types/app-connection-types.ts:394](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L394) ## Properties[​](#properties "Direct link to Properties") ### email?[​](#email "Direct link to email?") > `optional` **email**: `string` | `null` Defined in: [packages/sdk/src/types/app-connection-types.ts:397](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L397) *** ### name?[​](#name "Direct link to name?") > `optional` **name**: `string` | `null` Defined in: [packages/sdk/src/types/app-connection-types.ts:396](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L396) *** ### objectType?[​](#objecttype "Direct link to objectType?") > `optional` **objectType**: `string` Defined in: [packages/sdk/src/types/app-connection-types.ts:399](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L399) *** ### phone?[​](#phone "Direct link to phone?") > `optional` **phone**: `string` | `null` Defined in: [packages/sdk/src/types/app-connection-types.ts:398](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L398) *** ### salesforceId[​](#salesforceid "Direct link to salesforceId") > **salesforceId**: `string` Defined in: [packages/sdk/src/types/app-connection-types.ts:395](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L395) --- # Interface: ImportStatistics Defined in: [packages/sdk/src/types/stats-types.ts:105](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/stats-types.ts#L105) ## Properties[​](#properties "Direct link to Properties") ### duplicateRecords[​](#duplicaterecords "Direct link to duplicateRecords") > **duplicateRecords**: `number` Defined in: [packages/sdk/src/types/stats-types.ts:109](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/stats-types.ts#L109) *** ### failedRecords[​](#failedrecords "Direct link to failedRecords") > **failedRecords**: `number` Defined in: [packages/sdk/src/types/stats-types.ts:108](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/stats-types.ts#L108) *** ### importedRecords[​](#importedrecords "Direct link to importedRecords") > **importedRecords**: `number` Defined in: [packages/sdk/src/types/stats-types.ts:107](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/stats-types.ts#L107) *** ### processingTime[​](#processingtime "Direct link to processingTime") > **processingTime**: `number` Defined in: [packages/sdk/src/types/stats-types.ts:110](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/stats-types.ts#L110) *** ### totalRecords[​](#totalrecords "Direct link to totalRecords") > **totalRecords**: `number` Defined in: [packages/sdk/src/types/stats-types.ts:106](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/stats-types.ts#L106) *** ### validationErrors[​](#validationerrors "Direct link to validationErrors") > **validationErrors**: `string`\[] Defined in: [packages/sdk/src/types/stats-types.ts:111](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/stats-types.ts#L111) --- # Interface: InboxCreateRequest Defined in: [packages/sdk/src/types/communication-types.ts:200](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/communication-types.ts#L200) ## Properties[​](#properties "Direct link to Properties") ### assistantEnabled?[​](#assistantenabled "Direct link to assistantEnabled?") > `optional` **assistantEnabled**: `boolean` Defined in: [packages/sdk/src/types/communication-types.ts:205](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/communication-types.ts#L205) *** ### autoReplyEnabled?[​](#autoreplyenabled "Direct link to autoReplyEnabled?") > `optional` **autoReplyEnabled**: `boolean` Defined in: [packages/sdk/src/types/communication-types.ts:206](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/communication-types.ts#L206) *** ### defaultWorkflowId?[​](#defaultworkflowid "Direct link to defaultWorkflowId?") > `optional` **defaultWorkflowId**: `number` Defined in: [packages/sdk/src/types/communication-types.ts:204](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/communication-types.ts#L204) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/communication-types.ts:201](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/communication-types.ts#L201) *** ### orgDomainUuid?[​](#orgdomainuuid "Direct link to orgDomainUuid?") > `optional` **orgDomainUuid**: `string` Defined in: [packages/sdk/src/types/communication-types.ts:208](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/communication-types.ts#L208) *** ### recipient?[​](#recipient "Direct link to recipient?") > `optional` **recipient**: `string` Defined in: [packages/sdk/src/types/communication-types.ts:207](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/communication-types.ts#L207) *** ### rules?[​](#rules "Direct link to rules?") > `optional` **rules**: `object` | `null` Defined in: [packages/sdk/src/types/communication-types.ts:203](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/communication-types.ts#L203) *** ### slug?[​](#slug "Direct link to slug?") > `optional` **slug**: `string` Defined in: [packages/sdk/src/types/communication-types.ts:202](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/communication-types.ts#L202) --- # Interface: InboxExport Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:195](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L195) ## Properties[​](#properties "Direct link to Properties") ### assistantEnabled[​](#assistantenabled "Direct link to assistantEnabled") > **assistantEnabled**: `boolean` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:199](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L199) *** ### defaultWorkflowUuid?[​](#defaultworkflowuuid "Direct link to defaultWorkflowUuid?") > `optional` **defaultWorkflowUuid**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:200](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L200) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:197](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L197) *** ### slug[​](#slug "Direct link to slug") > **slug**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:198](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L198) *** ### uuid[​](#uuid "Direct link to uuid") > **uuid**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:196](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L196) --- # Interface: InboxMapping Defined in: [packages/sdk/src/types/communication-types.ts:239](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/communication-types.ts#L239) ## Properties[​](#properties "Direct link to Properties") ### createdAt[​](#createdat "Direct link to createdAt") > **createdAt**: `string` Defined in: [packages/sdk/src/types/communication-types.ts:242](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/communication-types.ts#L242) *** ### emailAddress[​](#emailaddress "Direct link to emailAddress") > **emailAddress**: `string` Defined in: [packages/sdk/src/types/communication-types.ts:241](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/communication-types.ts#L241) *** ### id[​](#id "Direct link to id") > **id**: `number` Defined in: [packages/sdk/src/types/communication-types.ts:240](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/communication-types.ts#L240) --- # Interface: InboxMappingDetailResponse Defined in: [packages/sdk/src/types/generated/communication.ts:223](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L223) Response model for an inbox mapping. ## Properties[​](#properties "Direct link to Properties") ### createdAt[​](#createdat "Direct link to createdAt") > **createdAt**: `string` Defined in: [packages/sdk/src/types/generated/communication.ts:229](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L229) *** ### emailAddress[​](#emailaddress "Direct link to emailAddress") > **emailAddress**: `string` Defined in: [packages/sdk/src/types/generated/communication.ts:225](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L225) *** ### id[​](#id "Direct link to id") > **id**: `number` Defined in: [packages/sdk/src/types/generated/communication.ts:224](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L224) *** ### updatedAt[​](#updatedat "Direct link to updatedAt") > **updatedAt**: `string` Defined in: [packages/sdk/src/types/generated/communication.ts:230](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L230) *** ### workspaceId[​](#workspaceid "Direct link to workspaceId") > **workspaceId**: `number` Defined in: [packages/sdk/src/types/generated/communication.ts:226](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L226) *** ### workspaceName[​](#workspacename "Direct link to workspaceName") > **workspaceName**: `string` Defined in: [packages/sdk/src/types/generated/communication.ts:227](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L227) *** ### workspaceUuid[​](#workspaceuuid "Direct link to workspaceUuid") > **workspaceUuid**: `string` Defined in: [packages/sdk/src/types/generated/communication.ts:228](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L228) --- # Interface: InboxThreadResponse Defined in: [packages/sdk/src/types/generated/communication.ts:260](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L260) A single email thread grouped by chat\_id. ## Properties[​](#properties "Direct link to Properties") ### chatId[​](#chatid "Direct link to chatId") > **chatId**: `number` Defined in: [packages/sdk/src/types/generated/communication.ts:261](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L261) *** ### emailCount[​](#emailcount "Direct link to emailCount") > **emailCount**: `number` Defined in: [packages/sdk/src/types/generated/communication.ts:264](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L264) *** ### latestEmailAt?[​](#latestemailat "Direct link to latestEmailAt?") > `optional` **latestEmailAt**: `string` | `null` Defined in: [packages/sdk/src/types/generated/communication.ts:266](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L266) *** ### participants[​](#participants "Direct link to participants") > **participants**: `string`\[] Defined in: [packages/sdk/src/types/generated/communication.ts:263](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L263) *** ### preview?[​](#preview "Direct link to preview?") > `optional` **preview**: `string` | `null` Defined in: [packages/sdk/src/types/generated/communication.ts:267](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L267) *** ### subject[​](#subject "Direct link to subject") > **subject**: `string` Defined in: [packages/sdk/src/types/generated/communication.ts:262](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L262) *** ### unreadCount[​](#unreadcount "Direct link to unreadCount") > **unreadCount**: `number` Defined in: [packages/sdk/src/types/generated/communication.ts:265](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L265) --- # Interface: InboxThreadsPageResponse Defined in: [packages/sdk/src/types/generated/communication.ts:273](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L273) Paginated threads and unthreaded emails for an inbox. ## Properties[​](#properties "Direct link to Properties") ### threads[​](#threads "Direct link to threads") > **threads**: [`InboxThreadResponse`](https://docs.gravityrail.com/sdk/interfaces/InboxThreadResponse.md)\[] Defined in: [packages/sdk/src/types/generated/communication.ts:274](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L274) *** ### totalThreads[​](#totalthreads "Direct link to totalThreads") > **totalThreads**: `number` Defined in: [packages/sdk/src/types/generated/communication.ts:276](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L276) *** ### totalUnthreaded[​](#totalunthreaded "Direct link to totalUnthreaded") > **totalUnthreaded**: `number` Defined in: [packages/sdk/src/types/generated/communication.ts:277](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L277) *** ### unthreadedEmails[​](#unthreadedemails "Direct link to unthreadedEmails") > **unthreadedEmails**: [`UnthreadedEmailResponse`](https://docs.gravityrail.com/sdk/interfaces/UnthreadedEmailResponse.md)\[] Defined in: [packages/sdk/src/types/generated/communication.ts:275](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L275) --- # Interface: InboxUpdateRequest Defined in: [packages/sdk/src/types/communication-types.ts:211](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/communication-types.ts#L211) ## Properties[​](#properties "Direct link to Properties") ### assistantEnabled?[​](#assistantenabled "Direct link to assistantEnabled?") > `optional` **assistantEnabled**: `boolean` Defined in: [packages/sdk/src/types/communication-types.ts:216](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/communication-types.ts#L216) *** ### autoReplyEnabled?[​](#autoreplyenabled "Direct link to autoReplyEnabled?") > `optional` **autoReplyEnabled**: `boolean` Defined in: [packages/sdk/src/types/communication-types.ts:217](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/communication-types.ts#L217) *** ### defaultWorkflowId?[​](#defaultworkflowid "Direct link to defaultWorkflowId?") > `optional` **defaultWorkflowId**: `number` Defined in: [packages/sdk/src/types/communication-types.ts:215](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/communication-types.ts#L215) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/communication-types.ts:212](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/communication-types.ts#L212) *** ### orgDomainUuid?[​](#orgdomainuuid "Direct link to orgDomainUuid?") > `optional` **orgDomainUuid**: `string` Defined in: [packages/sdk/src/types/communication-types.ts:219](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/communication-types.ts#L219) *** ### recipient?[​](#recipient "Direct link to recipient?") > `optional` **recipient**: `string` Defined in: [packages/sdk/src/types/communication-types.ts:218](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/communication-types.ts#L218) *** ### rules?[​](#rules "Direct link to rules?") > `optional` **rules**: `object` | `null` Defined in: [packages/sdk/src/types/communication-types.ts:214](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/communication-types.ts#L214) *** ### slug?[​](#slug "Direct link to slug?") > `optional` **slug**: `string` Defined in: [packages/sdk/src/types/communication-types.ts:213](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/communication-types.ts#L213) --- # Interface: IncomingInteraction Defined in: [packages/sdk/src/types/operator-types.ts:86](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/operator-types.ts#L86) Server -> Client: Incoming interaction notification. Note: caller\_name and caller\_identifier are always null — the backend strips PHI before publishing through Redis pub/sub. ## Properties[​](#properties "Direct link to Properties") ### caller\_identifier[​](#caller_identifier "Direct link to caller_identifier") > **caller\_identifier**: `null` Defined in: [packages/sdk/src/types/operator-types.ts:96](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/operator-types.ts#L96) Always null — PHI stripped server-side *** ### caller\_name[​](#caller_name "Direct link to caller_name") > **caller\_name**: `null` Defined in: [packages/sdk/src/types/operator-types.ts:94](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/operator-types.ts#L94) Always null — PHI stripped server-side *** ### channel[​](#channel "Direct link to channel") > **channel**: [`Channel`](https://docs.gravityrail.com/sdk/type-aliases/Channel.md) Defined in: [packages/sdk/src/types/operator-types.ts:90](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/operator-types.ts#L90) *** ### chat\_id[​](#chat_id "Direct link to chat_id") > **chat\_id**: `number` | `null` Defined in: [packages/sdk/src/types/operator-types.ts:97](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/operator-types.ts#L97) *** ### interaction\_id[​](#interaction_id "Direct link to interaction_id") > **interaction\_id**: `string` Defined in: [packages/sdk/src/types/operator-types.ts:88](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/operator-types.ts#L88) *** ### timestamp[​](#timestamp "Direct link to timestamp") > **timestamp**: `string` Defined in: [packages/sdk/src/types/operator-types.ts:98](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/operator-types.ts#L98) *** ### type[​](#type "Direct link to type") > **type**: `"incoming_interaction"` Defined in: [packages/sdk/src/types/operator-types.ts:87](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/operator-types.ts#L87) *** ### workflow\_id[​](#workflow_id "Direct link to workflow_id") > **workflow\_id**: `number` | `null` Defined in: [packages/sdk/src/types/operator-types.ts:91](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/operator-types.ts#L91) *** ### workflow\_name[​](#workflow_name "Direct link to workflow_name") > **workflow\_name**: `string` | `null` Defined in: [packages/sdk/src/types/operator-types.ts:92](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/operator-types.ts#L92) *** ### workspace\_uuid[​](#workspace_uuid "Direct link to workspace_uuid") > **workspace\_uuid**: `string` Defined in: [packages/sdk/src/types/operator-types.ts:89](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/operator-types.ts#L89) --- # Interface: IndexStatusResponse Defined in: [packages/sdk/src/types/generated/data.ts:146](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/data.ts#L146) ## Properties[​](#properties "Direct link to Properties") ### fieldId[​](#fieldid "Direct link to fieldId") > **fieldId**: `string` Defined in: [packages/sdk/src/types/generated/data.ts:147](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/data.ts#L147) *** ### fieldName[​](#fieldname "Direct link to fieldName") > **fieldName**: `string` Defined in: [packages/sdk/src/types/generated/data.ts:148](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/data.ts#L148) *** ### indexStatus[​](#indexstatus "Direct link to indexStatus") > **indexStatus**: `string` Defined in: [packages/sdk/src/types/generated/data.ts:150](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/data.ts#L150) *** ### message?[​](#message "Direct link to message?") > `optional` **message**: `string` | `null` Defined in: [packages/sdk/src/types/generated/data.ts:151](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/data.ts#L151) *** ### shouldIndex[​](#shouldindex "Direct link to shouldIndex") > **shouldIndex**: `string` Defined in: [packages/sdk/src/types/generated/data.ts:149](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/data.ts#L149) --- # Interface: InitiateCallRequest Defined in: [packages/sdk/src/types/communication-types.ts:177](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/communication-types.ts#L177) ## Properties[​](#properties "Direct link to Properties") ### memberId[​](#memberid "Direct link to memberId") > **memberId**: `number` Defined in: [packages/sdk/src/types/communication-types.ts:178](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/communication-types.ts#L178) *** ### memberName[​](#membername "Direct link to memberName") > **memberName**: `string` Defined in: [packages/sdk/src/types/communication-types.ts:179](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/communication-types.ts#L179) --- # Interface: InitiateCallResponse Defined in: [packages/sdk/src/types/generated/communication.ts:280](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L280) ## Properties[​](#properties "Direct link to Properties") ### status[​](#status "Direct link to status") > **status**: `string` Defined in: [packages/sdk/src/types/generated/communication.ts:282](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L282) *** ### twilioCallSid[​](#twiliocallsid "Direct link to twilioCallSid") > **twilioCallSid**: `string` Defined in: [packages/sdk/src/types/generated/communication.ts:281](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L281) --- # Interface: InquiryListResponse Defined in: [packages/sdk/src/types/generated/inquiry.ts:39](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/inquiry.ts#L39) Response for listing inquiries. ## Properties[​](#properties "Direct link to Properties") ### items[​](#items "Direct link to items") > **items**: [`InquiryResponse`](https://docs.gravityrail.com/sdk/interfaces/InquiryResponse.md)\[] Defined in: [packages/sdk/src/types/generated/inquiry.ts:40](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/inquiry.ts#L40) *** ### page[​](#page "Direct link to page") > **page**: `number` Defined in: [packages/sdk/src/types/generated/inquiry.ts:42](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/inquiry.ts#L42) *** ### pageSize[​](#pagesize "Direct link to pageSize") > **pageSize**: `number` Defined in: [packages/sdk/src/types/generated/inquiry.ts:43](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/inquiry.ts#L43) *** ### total[​](#total "Direct link to total") > **total**: `number` Defined in: [packages/sdk/src/types/generated/inquiry.ts:41](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/inquiry.ts#L41) --- # Interface: InquiryResponse Defined in: [packages/sdk/src/types/generated/inquiry.ts:49](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/inquiry.ts#L49) Response for an inquiry. ## Properties[​](#properties "Direct link to Properties") ### businessName?[​](#businessname "Direct link to businessName?") > `optional` **businessName**: `string` | `null` Defined in: [packages/sdk/src/types/generated/inquiry.ts:57](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/inquiry.ts#L57) *** ### businessNumber?[​](#businessnumber "Direct link to businessNumber?") > `optional` **businessNumber**: `string` | `null` Defined in: [packages/sdk/src/types/generated/inquiry.ts:56](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/inquiry.ts#L56) *** ### cellNumber?[​](#cellnumber "Direct link to cellNumber?") > `optional` **cellNumber**: `string` | `null` Defined in: [packages/sdk/src/types/generated/inquiry.ts:55](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/inquiry.ts#L55) *** ### country?[​](#country "Direct link to country?") > `optional` **country**: `string` | `null` Defined in: [packages/sdk/src/types/generated/inquiry.ts:58](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/inquiry.ts#L58) *** ### createdAt[​](#createdat "Direct link to createdAt") > **createdAt**: `string` Defined in: [packages/sdk/src/types/generated/inquiry.ts:65](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/inquiry.ts#L65) *** ### email?[​](#email "Direct link to email?") > `optional` **email**: `string` | `null` Defined in: [packages/sdk/src/types/generated/inquiry.ts:53](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/inquiry.ts#L53) *** ### id[​](#id "Direct link to id") > **id**: `number` Defined in: [packages/sdk/src/types/generated/inquiry.ts:50](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/inquiry.ts#L50) *** ### inquiryType[​](#inquirytype "Direct link to inquiryType") > **inquiryType**: `string` Defined in: [packages/sdk/src/types/generated/inquiry.ts:54](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/inquiry.ts#L54) *** ### ipAddress?[​](#ipaddress "Direct link to ipAddress?") > `optional` **ipAddress**: `string` | `null` Defined in: [packages/sdk/src/types/generated/inquiry.ts:62](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/inquiry.ts#L62) *** ### message?[​](#message "Direct link to message?") > `optional` **message**: `string` | `null` Defined in: [packages/sdk/src/types/generated/inquiry.ts:60](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/inquiry.ts#L60) *** ### name?[​](#name "Direct link to name?") > `optional` **name**: `string` | `null` Defined in: [packages/sdk/src/types/generated/inquiry.ts:52](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/inquiry.ts#L52) *** ### notes?[​](#notes "Direct link to notes?") > `optional` **notes**: `string` | `null` Defined in: [packages/sdk/src/types/generated/inquiry.ts:63](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/inquiry.ts#L63) *** ### productId?[​](#productid "Direct link to productId?") > `optional` **productId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/inquiry.ts:61](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/inquiry.ts#L61) *** ### state?[​](#state "Direct link to state?") > `optional` **state**: `string` | `null` Defined in: [packages/sdk/src/types/generated/inquiry.ts:59](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/inquiry.ts#L59) *** ### status?[​](#status "Direct link to status?") > `optional` **status**: `string` | `null` Defined in: [packages/sdk/src/types/generated/inquiry.ts:64](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/inquiry.ts#L64) *** ### updatedAt[​](#updatedat "Direct link to updatedAt") > **updatedAt**: `string` Defined in: [packages/sdk/src/types/generated/inquiry.ts:66](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/inquiry.ts#L66) *** ### uuid[​](#uuid "Direct link to uuid") > **uuid**: `string` Defined in: [packages/sdk/src/types/generated/inquiry.ts:51](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/inquiry.ts#L51) --- # Interface: InteractionAccepted Defined in: [packages/sdk/src/types/operator-types.ts:102](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/operator-types.ts#L102) Server -> Client: Interaction accepted by another operator ## Properties[​](#properties "Direct link to Properties") ### accepted\_by[​](#accepted_by "Direct link to accepted_by") > **accepted\_by**: `string` Defined in: [packages/sdk/src/types/operator-types.ts:105](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/operator-types.ts#L105) *** ### interaction\_id[​](#interaction_id "Direct link to interaction_id") > **interaction\_id**: `string` Defined in: [packages/sdk/src/types/operator-types.ts:104](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/operator-types.ts#L104) *** ### type[​](#type "Direct link to type") > **type**: `"interaction_accepted"` Defined in: [packages/sdk/src/types/operator-types.ts:103](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/operator-types.ts#L103) --- # Interface: InteractionTimedOut Defined in: [packages/sdk/src/types/operator-types.ts:109](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/operator-types.ts#L109) Server -> Client: Interaction timed out ## Properties[​](#properties "Direct link to Properties") ### interaction\_id[​](#interaction_id "Direct link to interaction_id") > **interaction\_id**: `string` Defined in: [packages/sdk/src/types/operator-types.ts:111](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/operator-types.ts#L111) *** ### type[​](#type "Direct link to type") > **type**: `"interaction_timed_out"` Defined in: [packages/sdk/src/types/operator-types.ts:110](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/operator-types.ts#L110) --- # Interface: InvitationAcceptedResponse Defined in: [packages/sdk/src/types/invitation-types.ts:98](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/invitation-types.ts#L98) ## Properties[​](#properties "Direct link to Properties") ### authToken?[​](#authtoken "Direct link to authToken?") > `optional` **authToken**: `string` | `null` Defined in: [packages/sdk/src/types/invitation-types.ts:110](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/invitation-types.ts#L110) *** ### message[​](#message "Direct link to message") > **message**: `string` Defined in: [packages/sdk/src/types/invitation-types.ts:99](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/invitation-types.ts#L99) *** ### organization?[​](#organization "Direct link to organization?") > `optional` **organization**: { `id`: `number`; `name`: `string`; `uuid`: `string`; } | `null` Defined in: [packages/sdk/src/types/invitation-types.ts:105](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/invitation-types.ts#L105) *** ### workspace?[​](#workspace "Direct link to workspace?") > `optional` **workspace**: { `id`: `number`; `name`: `string`; `uuid`: `string`; } | `null` Defined in: [packages/sdk/src/types/invitation-types.ts:100](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/invitation-types.ts#L100) --- # Interface: InvitationDetails Defined in: [packages/sdk/src/types/invitation-types.ts:73](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/invitation-types.ts#L73) ## Properties[​](#properties "Direct link to Properties") ### expiresAt?[​](#expiresat "Direct link to expiresAt?") > `optional` **expiresAt**: `string` | `null` Defined in: [packages/sdk/src/types/invitation-types.ts:93](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/invitation-types.ts#L93) *** ### invitedAccount?[​](#invitedaccount "Direct link to invitedAccount?") > `optional` **invitedAccount**: { `email`: `string`; `name?`: `string` | `null`; } | `null` Defined in: [packages/sdk/src/types/invitation-types.ts:84](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/invitation-types.ts#L84) *** ### invitedEmail?[​](#invitedemail "Direct link to invitedEmail?") > `optional` **invitedEmail**: `string` | `null` Defined in: [packages/sdk/src/types/invitation-types.ts:88](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/invitation-types.ts#L88) *** ### inviter[​](#inviter "Direct link to inviter") > **inviter**: `object` Defined in: [packages/sdk/src/types/invitation-types.ts:89](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/invitation-types.ts#L89) #### name?[​](#name "Direct link to name?") > `optional` **name**: `string` | `null` *** ### message?[​](#message "Direct link to message?") > `optional` **message**: `string` | `null` Defined in: [packages/sdk/src/types/invitation-types.ts:92](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/invitation-types.ts#L92) *** ### organization?[​](#organization "Direct link to organization?") > `optional` **organization**: { `id`: `number`; `name`: `string`; `uuid`: `string`; } | `null` Defined in: [packages/sdk/src/types/invitation-types.ts:79](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/invitation-types.ts#L79) *** ### role?[​](#role "Direct link to role?") > `optional` **role**: [`OrgMemberRole`](https://docs.gravityrail.com/sdk/type-aliases/OrgMemberRole.md) | `null` Defined in: [packages/sdk/src/types/invitation-types.ts:94](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/invitation-types.ts#L94) *** ### workspace?[​](#workspace "Direct link to workspace?") > `optional` **workspace**: { `id`: `number`; `name`: `string`; `uuid`: `string`; } | `null` Defined in: [packages/sdk/src/types/invitation-types.ts:74](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/invitation-types.ts#L74) --- # Interface: InvokeCustomToolActionParams Defined in: [packages/sdk/src/types/event-types.ts:296](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L296) ## Properties[​](#properties "Direct link to Properties") ### customToolId?[​](#customtoolid "Direct link to customToolId?") > `optional` **customToolId**: `number` Defined in: [packages/sdk/src/types/event-types.ts:300](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L300) Legacy integer id of the custom tool. Kept for backward compat with pre-rename rules. *** ### customToolUUID?[​](#customtooluuid "Direct link to customToolUUID?") > `optional` **customToolUUID**: `string` Defined in: [packages/sdk/src/types/event-types.ts:298](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L298) UUID of the custom tool to invoke (canonical identifier, issue #10893). *** ### outputMode?[​](#outputmode "Direct link to outputMode?") > `optional` **outputMode**: `"none"` | `"tool_output"` | `"assistant_message"` Defined in: [packages/sdk/src/types/event-types.ts:301](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L301) --- # Interface: JourneyEnrollActionParams Defined in: [packages/sdk/src/types/event-types.ts:312](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L312) ## Properties[​](#properties "Direct link to Properties") ### journeyUUID[​](#journeyuuid "Direct link to journeyUUID") > **journeyUUID**: `string` Defined in: [packages/sdk/src/types/event-types.ts:314](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L314) UUID of the journey to enroll the member in. --- # Interface: JsonSchema Defined in: [packages/sdk/src/types/custom-tool-types.ts:25](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/custom-tool-types.ts#L25) ## Indexable[​](#indexable "Direct link to Indexable") \[`key`: `string`]: `unknown` ## Properties[​](#properties "Direct link to Properties") ### properties?[​](#properties-1 "Direct link to properties?") > `optional` **properties**: `Record`<`string`, [`JsonSchemaProperty`](https://docs.gravityrail.com/sdk/interfaces/JsonSchemaProperty.md)> Defined in: [packages/sdk/src/types/custom-tool-types.ts:27](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/custom-tool-types.ts#L27) *** ### required?[​](#required "Direct link to required?") > `optional` **required**: `string`\[] Defined in: [packages/sdk/src/types/custom-tool-types.ts:28](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/custom-tool-types.ts#L28) *** ### type?[​](#type "Direct link to type?") > `optional` **type**: `string` Defined in: [packages/sdk/src/types/custom-tool-types.ts:26](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/custom-tool-types.ts#L26) --- # Interface: JsonSchemaProperty Defined in: [packages/sdk/src/types/custom-tool-types.ts:19](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/custom-tool-types.ts#L19) JSON Schema subset used by custom tool input/output definitions. ## Indexable[​](#indexable "Direct link to Indexable") \[`key`: `string`]: `unknown` ## Properties[​](#properties "Direct link to Properties") ### description?[​](#description "Direct link to description?") > `optional` **description**: `string` Defined in: [packages/sdk/src/types/custom-tool-types.ts:21](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/custom-tool-types.ts#L21) *** ### type?[​](#type "Direct link to type?") > `optional` **type**: `string` Defined in: [packages/sdk/src/types/custom-tool-types.ts:20](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/custom-tool-types.ts#L20) --- # Interface: LinkA2PEnrollmentSiteRequest Defined in: [packages/sdk/src/types/organization-types.ts:264](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/organization-types.ts#L264) ## Properties[​](#properties "Direct link to Properties") ### siteUuid[​](#siteuuid "Direct link to siteUuid") > **siteUuid**: `string` Defined in: [packages/sdk/src/types/organization-types.ts:266](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/organization-types.ts#L266) *** ### workspaceUuid[​](#workspaceuuid "Direct link to workspaceUuid") > **workspaceUuid**: `string` Defined in: [packages/sdk/src/types/organization-types.ts:265](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/organization-types.ts#L265) --- # Interface: LinkablePhone Defined in: [packages/sdk/src/types/communication-types.ts:116](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/communication-types.ts#L116) ## Properties[​](#properties "Direct link to Properties") ### friendlyName[​](#friendlyname "Direct link to friendlyName") > **friendlyName**: `string` | `null` Defined in: [packages/sdk/src/types/communication-types.ts:119](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/communication-types.ts#L119) *** ### isAssigned[​](#isassigned "Direct link to isAssigned") > **isAssigned**: `boolean` Defined in: [packages/sdk/src/types/communication-types.ts:121](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/communication-types.ts#L121) *** ### linkedInWorkspace[​](#linkedinworkspace "Direct link to linkedInWorkspace") > **linkedInWorkspace**: `boolean` Defined in: [packages/sdk/src/types/communication-types.ts:123](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/communication-types.ts#L123) *** ### phoneNumber[​](#phonenumber "Direct link to phoneNumber") > **phoneNumber**: `string` Defined in: [packages/sdk/src/types/communication-types.ts:118](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/communication-types.ts#L118) *** ### provider[​](#provider "Direct link to provider") > **provider**: `string` Defined in: [packages/sdk/src/types/communication-types.ts:120](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/communication-types.ts#L120) *** ### uuid[​](#uuid "Direct link to uuid") > **uuid**: `string` Defined in: [packages/sdk/src/types/communication-types.ts:117](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/communication-types.ts#L117) *** ### workspaceId[​](#workspaceid "Direct link to workspaceId") > **workspaceId**: `number` | `null` Defined in: [packages/sdk/src/types/communication-types.ts:122](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/communication-types.ts#L122) --- # Interface: LinkCalendarRequest Defined in: [packages/sdk/src/types/calendar-types.ts:187](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/calendar-types.ts#L187) ## Properties[​](#properties "Direct link to Properties") ### googleCalendarId[​](#googlecalendarid "Direct link to googleCalendarId") > **googleCalendarId**: `string` Defined in: [packages/sdk/src/types/calendar-types.ts:188](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/calendar-types.ts#L188) --- # Interface: LinkCalendarResponse Defined in: [packages/sdk/src/types/calendar-types.ts:191](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/calendar-types.ts#L191) ## Properties[​](#properties "Direct link to Properties") ### googleCalendarId[​](#googlecalendarid "Direct link to googleCalendarId") > **googleCalendarId**: `string` Defined in: [packages/sdk/src/types/calendar-types.ts:194](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/calendar-types.ts#L194) *** ### googleCalendarName?[​](#googlecalendarname "Direct link to googleCalendarName?") > `optional` **googleCalendarName**: `string` Defined in: [packages/sdk/src/types/calendar-types.ts:195](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/calendar-types.ts#L195) *** ### message[​](#message "Direct link to message") > **message**: `string` Defined in: [packages/sdk/src/types/calendar-types.ts:193](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/calendar-types.ts#L193) *** ### status[​](#status "Direct link to status") > **status**: `string` Defined in: [packages/sdk/src/types/calendar-types.ts:192](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/calendar-types.ts#L192) --- # Interface: ListInvitationsParams Defined in: [packages/sdk/src/types/invitation-types.ts:63](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/invitation-types.ts#L63) ## Properties[​](#properties "Direct link to Properties") ### accountId?[​](#accountid "Direct link to accountId?") > `optional` **accountId**: `number` Defined in: [packages/sdk/src/types/invitation-types.ts:66](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/invitation-types.ts#L66) *** ### organizationId?[​](#organizationid "Direct link to organizationId?") > `optional` **organizationId**: `number` Defined in: [packages/sdk/src/types/invitation-types.ts:65](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/invitation-types.ts#L65) *** ### page?[​](#page "Direct link to page?") > `optional` **page**: `number` Defined in: [packages/sdk/src/types/invitation-types.ts:68](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/invitation-types.ts#L68) *** ### pageSize?[​](#pagesize "Direct link to pageSize?") > `optional` **pageSize**: `number` Defined in: [packages/sdk/src/types/invitation-types.ts:69](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/invitation-types.ts#L69) *** ### status?[​](#status "Direct link to status?") > `optional` **status**: [`InvitationStatus`](https://docs.gravityrail.com/sdk/enumerations/InvitationStatus.md) Defined in: [packages/sdk/src/types/invitation-types.ts:67](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/invitation-types.ts#L67) *** ### workspaceId?[​](#workspaceid "Direct link to workspaceId?") > `optional` **workspaceId**: `number` Defined in: [packages/sdk/src/types/invitation-types.ts:64](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/invitation-types.ts#L64) --- # Interface: LiveOperatorEntry Defined in: [packages/sdk/src/types/generated/operator.ts:8](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/operator.ts#L8) Generated by Orval, grouped by scripts/types-codegen/group\_generated.ts (group map from emit\_openapi.py). Do not edit manually. Group: operator ## Properties[​](#properties "Direct link to Properties") ### connectedAt?[​](#connectedat "Direct link to connectedAt?") > `optional` **connectedAt**: `string` Defined in: [packages/sdk/src/types/generated/operator.ts:15](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/operator.ts#L15) *** ### memberId?[​](#memberid "Direct link to memberId?") > `optional` **memberId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/operator.ts:10](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/operator.ts#L10) *** ### memberName?[​](#membername "Direct link to memberName?") > `optional` **memberName**: `string` | `null` Defined in: [packages/sdk/src/types/generated/operator.ts:11](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/operator.ts#L11) *** ### memberRoleName?[​](#memberrolename "Direct link to memberRoleName?") > `optional` **memberRoleName**: `string` | `null` Defined in: [packages/sdk/src/types/generated/operator.ts:13](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/operator.ts#L13) *** ### memberType?[​](#membertype "Direct link to memberType?") > `optional` **memberType**: `string` | `null` Defined in: [packages/sdk/src/types/generated/operator.ts:12](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/operator.ts#L12) *** ### memberUuid[​](#memberuuid "Direct link to memberUuid") > **memberUuid**: `string` Defined in: [packages/sdk/src/types/generated/operator.ts:9](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/operator.ts#L9) *** ### workflowIds?[​](#workflowids "Direct link to workflowIds?") > `optional` **workflowIds**: `number`\[] Defined in: [packages/sdk/src/types/generated/operator.ts:14](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/operator.ts#L14) --- # Interface: LiveOperatorsResponse Defined in: [packages/sdk/src/types/generated/operator.ts:18](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/operator.ts#L18) ## Properties[​](#properties "Direct link to Properties") ### operators[​](#operators "Direct link to operators") > **operators**: [`LiveOperatorEntry`](https://docs.gravityrail.com/sdk/interfaces/LiveOperatorEntry.md)\[] Defined in: [packages/sdk/src/types/generated/operator.ts:19](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/operator.ts#L19) --- # Interface: LoadedSkill Defined in: [packages/sdk/src/types/chat-types.ts:67](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L67) ## Properties[​](#properties "Direct link to Properties") ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/chat-types.ts:68](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L68) --- # Interface: LoginRequest Defined in: [packages/sdk/src/types/account-types.ts:124](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L124) ## Properties[​](#properties "Direct link to Properties") ### organizationUuid?[​](#organizationuuid "Direct link to organizationUuid?") > `optional` **organizationUuid**: `string` Defined in: [packages/sdk/src/types/account-types.ts:126](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L126) *** ### phoneNumber[​](#phonenumber "Direct link to phoneNumber") > **phoneNumber**: `string` Defined in: [packages/sdk/src/types/account-types.ts:125](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L125) --- # Interface: LoginResponse Defined in: [packages/sdk/src/types/generated/account.ts:274](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L274) ## Properties[​](#properties "Direct link to Properties") ### accountId[​](#accountid "Direct link to accountId") > **accountId**: `number` Defined in: [packages/sdk/src/types/generated/account.ts:276](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L276) *** ### accountName?[​](#accountname "Direct link to accountName?") > `optional` **accountName**: `string` | `null` Defined in: [packages/sdk/src/types/generated/account.ts:277](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L277) *** ### accountUuid?[​](#accountuuid "Direct link to accountUuid?") > `optional` **accountUuid**: `string` | `null` Defined in: [packages/sdk/src/types/generated/account.ts:278](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L278) *** ### availableTwoFactorMethods?[​](#availabletwofactormethods "Direct link to availableTwoFactorMethods?") > `optional` **availableTwoFactorMethods**: `unknown`\[] | `null` Defined in: [packages/sdk/src/types/generated/account.ts:280](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L280) *** ### requiresTwoFactor?[​](#requirestwofactor "Direct link to requiresTwoFactor?") > `optional` **requiresTwoFactor**: `boolean` | `null` Defined in: [packages/sdk/src/types/generated/account.ts:279](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L279) *** ### token[​](#token "Direct link to token") > **token**: `string` Defined in: [packages/sdk/src/types/generated/account.ts:275](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L275) --- # Interface: LogoUploadRequest Defined in: [packages/sdk/src/types/account-types.ts:312](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L312) ## Properties[​](#properties "Direct link to Properties") ### contentType[​](#contenttype "Direct link to contentType") > **contentType**: `string` Defined in: [packages/sdk/src/types/account-types.ts:313](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L313) *** ### fileExtension[​](#fileextension "Direct link to fileExtension") > **fileExtension**: `string` Defined in: [packages/sdk/src/types/account-types.ts:314](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L314) --- # Interface: LogoUploadResponse Defined in: [packages/sdk/src/types/account-types.ts:317](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L317) ## Properties[​](#properties "Direct link to Properties") ### fields[​](#fields "Direct link to fields") > **fields**: `Record`<`string`, `string`> Defined in: [packages/sdk/src/types/account-types.ts:319](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L319) *** ### fileUrl[​](#fileurl "Direct link to fileUrl") > **fileUrl**: `string` Defined in: [packages/sdk/src/types/account-types.ts:320](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L320) *** ### uploadUrl[​](#uploadurl "Direct link to uploadUrl") > **uploadUrl**: `string` Defined in: [packages/sdk/src/types/account-types.ts:318](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L318) --- # Interface: ManagedAutomationConfig Defined in: [packages/sdk/src/types/app-connection-types.ts:490](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L490) ## Properties[​](#properties "Direct link to Properties") ### bodyTemplate?[​](#bodytemplate "Direct link to bodyTemplate?") > `optional` **bodyTemplate**: `string` Defined in: [packages/sdk/src/types/app-connection-types.ts:493](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L493) *** ### dataTypeId?[​](#datatypeid "Direct link to dataTypeId?") > `optional` **dataTypeId**: `number` | `null` Defined in: [packages/sdk/src/types/app-connection-types.ts:492](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L492) *** ### priority?[​](#priority "Direct link to priority?") > `optional` **priority**: [`ManagedAutomationPriority`](https://docs.gravityrail.com/sdk/type-aliases/ManagedAutomationPriority.md) Defined in: [packages/sdk/src/types/app-connection-types.ts:495](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L495) *** ### status?[​](#status "Direct link to status?") > `optional` **status**: [`ManagedAutomationStatus`](https://docs.gravityrail.com/sdk/type-aliases/ManagedAutomationStatus.md) Defined in: [packages/sdk/src/types/app-connection-types.ts:496](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L496) *** ### subjectTemplate?[​](#subjecttemplate "Direct link to subjectTemplate?") > `optional` **subjectTemplate**: `string` Defined in: [packages/sdk/src/types/app-connection-types.ts:494](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L494) *** ### type[​](#type "Direct link to type") > **type**: `"task"` | `"note"` | `"labels"` Defined in: [packages/sdk/src/types/app-connection-types.ts:491](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L491) --- # Interface: ManagedRuleStatus Defined in: [packages/sdk/src/types/app-connection-types.ts:232](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L232) ## Properties[​](#properties "Direct link to Properties") ### actionType[​](#actiontype "Direct link to actionType") > **actionType**: `string` Defined in: [packages/sdk/src/types/app-connection-types.ts:236](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L236) *** ### active[​](#active "Direct link to active") > **active**: `boolean` Defined in: [packages/sdk/src/types/app-connection-types.ts:237](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L237) *** ### dataTypeId[​](#datatypeid "Direct link to dataTypeId") > **dataTypeId**: `number` | `null` Defined in: [packages/sdk/src/types/app-connection-types.ts:238](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L238) *** ### eventType[​](#eventtype "Direct link to eventType") > **eventType**: `string` Defined in: [packages/sdk/src/types/app-connection-types.ts:235](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L235) *** ### id[​](#id "Direct link to id") > **id**: `number` Defined in: [packages/sdk/src/types/app-connection-types.ts:233](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L233) *** ### name[​](#name "Direct link to name") > **name**: `string` | `null` Defined in: [packages/sdk/src/types/app-connection-types.ts:234](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L234) --- # Interface: MatchStrategy Defined in: [packages/sdk/src/types/app-connection-types.ts:444](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L444) ## Properties[​](#properties "Direct link to Properties") ### localField?[​](#localfield "Direct link to localField?") > `optional` **localField**: `string` | `null` Defined in: [packages/sdk/src/types/app-connection-types.ts:462](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L462) Local field to match against (custom mode only). Interpretation depends on `localFieldType`: * `"column"` (default): a Member ORM column name. The Monday backend allow-list is `name | email | phone | description`. * `"member_field"`: a `MemberField.key` scoped by the connection's `service_id`. Any non-empty key is accepted. Reads accept `null` because the backend Pydantic model (`lib/app_connections/sync/types.py::MatchStrategy.localField: str | None`) serializes `None` to JSON `null` and existing saved configs may carry it. Writes should prefer `undefined` (or field omission) — JSON `null` round-trips back through the load path but ambiguates "unset" vs. "explicitly null" on save. *** ### localFieldType?[​](#localfieldtype "Direct link to localFieldType?") > `optional` **localFieldType**: `"column"` | `"member_field"` | `null` Defined in: [packages/sdk/src/types/app-connection-types.ts:477](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L477) How to interpret `localField` for `mode="custom"` strategies. `"column"` is the default for legacy configs and non-custom modes. `"member_field"` (GRA-2920) lets a Monday board match by a service-scoped `MemberField` key — e.g. `Board A` writes an MRN via a `managed_field` rule, and `Board B` matches on that key. Reads accept `null` because the backend Pydantic model serializes the default through JSON; writes should pass `"column"` or `"member_field"` explicitly, or omit the field for column-backed legacy behavior. *** ### mode[​](#mode "Direct link to mode") > **mode**: [`MatchStrategyMode`](https://docs.gravityrail.com/sdk/type-aliases/MatchStrategyMode.md) Defined in: [packages/sdk/src/types/app-connection-types.ts:445](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L445) *** ### remoteField?[​](#remotefield "Direct link to remoteField?") > `optional` **remoteField**: `string` | `null` Defined in: [packages/sdk/src/types/app-connection-types.ts:478](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L478) --- # Interface: McpPromptArgumentResponse Defined in: [packages/sdk/src/types/app-connection-types.ts:584](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L584) ## Properties[​](#properties "Direct link to Properties") ### description[​](#description "Direct link to description") > **description**: `string` | `null` Defined in: [packages/sdk/src/types/app-connection-types.ts:586](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L586) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/app-connection-types.ts:585](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L585) *** ### required[​](#required "Direct link to required") > **required**: `boolean` | `null` Defined in: [packages/sdk/src/types/app-connection-types.ts:587](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L587) --- # Interface: McpPromptResponse Defined in: [packages/sdk/src/types/app-connection-types.ts:590](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L590) ## Properties[​](#properties "Direct link to Properties") ### arguments[​](#arguments "Direct link to arguments") > **arguments**: [`McpPromptArgumentResponse`](https://docs.gravityrail.com/sdk/interfaces/McpPromptArgumentResponse.md)\[] Defined in: [packages/sdk/src/types/app-connection-types.ts:593](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L593) *** ### description[​](#description "Direct link to description") > **description**: `string` | `null` Defined in: [packages/sdk/src/types/app-connection-types.ts:592](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L592) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/app-connection-types.ts:591](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L591) --- # Interface: McpResourceResponse Defined in: [packages/sdk/src/types/app-connection-types.ts:569](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L569) ## Properties[​](#properties "Direct link to Properties") ### description[​](#description "Direct link to description") > **description**: `string` | `null` Defined in: [packages/sdk/src/types/app-connection-types.ts:572](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L572) *** ### mimeType[​](#mimetype "Direct link to mimeType") > **mimeType**: `string` | `null` Defined in: [packages/sdk/src/types/app-connection-types.ts:573](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L573) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/app-connection-types.ts:571](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L571) *** ### uri[​](#uri "Direct link to uri") > **uri**: `string` Defined in: [packages/sdk/src/types/app-connection-types.ts:570](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L570) --- # Interface: McpServerAuthRequired Defined in: [packages/sdk/src/types/app-connection-types.ts:557](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L557) Structured 403 detail returned when MCP server tools require auth. ## Properties[​](#properties "Direct link to Properties") ### appUuid?[​](#appuuid "Direct link to appUuid?") > `optional` **appUuid**: `string` Defined in: [packages/sdk/src/types/app-connection-types.ts:562](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L562) *** ### authorizeUrl?[​](#authorizeurl "Direct link to authorizeUrl?") > `optional` **authorizeUrl**: `string` Defined in: [packages/sdk/src/types/app-connection-types.ts:561](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L561) *** ### authType[​](#authtype "Direct link to authType") > **authType**: `"oauth"` | `"direct_auth"` Defined in: [packages/sdk/src/types/app-connection-types.ts:560](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L560) *** ### code[​](#code "Direct link to code") > **code**: `"auth_required"` Defined in: [packages/sdk/src/types/app-connection-types.ts:559](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L559) *** ### message[​](#message "Direct link to message") > **message**: `string` Defined in: [packages/sdk/src/types/app-connection-types.ts:558](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L558) --- # Interface: McpServerExport Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:183](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L183) ## Properties[​](#properties "Direct link to Properties") ### appUuid?[​](#appuuid "Direct link to appUuid?") > `optional` **appUuid**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:190](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L190) *** ### description?[​](#description "Direct link to description?") > `optional` **description**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:187](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L187) *** ### mcpUrl[​](#mcpurl "Direct link to mcpUrl") > **mcpUrl**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:188](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L188) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:185](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L185) *** ### oauthClientId?[​](#oauthclientid "Direct link to oauthClientId?") > `optional` **oauthClientId**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:189](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L189) *** ### scopes[​](#scopes "Direct link to scopes") > **scopes**: `string`\[] Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:192](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L192) *** ### slug[​](#slug "Direct link to slug") > **slug**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:186](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L186) *** ### state[​](#state "Direct link to state") > **state**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:191](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L191) *** ### uuid[​](#uuid "Direct link to uuid") > **uuid**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:184](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L184) --- # Interface: McpServerFormData Defined in: [packages/sdk/src/types/mcp-server-types.ts:22](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/mcp-server-types.ts#L22) ## Properties[​](#properties "Direct link to Properties") ### appUuid?[​](#appuuid "Direct link to appUuid?") > `optional` **appUuid**: `string` Defined in: [packages/sdk/src/types/mcp-server-types.ts:27](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/mcp-server-types.ts#L27) *** ### authMetadata?[​](#authmetadata "Direct link to authMetadata?") > `optional` **authMetadata**: `Record`<`string`, `any`> Defined in: [packages/sdk/src/types/mcp-server-types.ts:32](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/mcp-server-types.ts#L32) *** ### authToken?[​](#authtoken "Direct link to authToken?") > `optional` **authToken**: `string` Defined in: [packages/sdk/src/types/mcp-server-types.ts:28](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/mcp-server-types.ts#L28) *** ### description?[​](#description "Direct link to description?") > `optional` **description**: `string` Defined in: [packages/sdk/src/types/mcp-server-types.ts:25](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/mcp-server-types.ts#L25) *** ### mcpUrl[​](#mcpurl "Direct link to mcpUrl") > **mcpUrl**: `string` Defined in: [packages/sdk/src/types/mcp-server-types.ts:26](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/mcp-server-types.ts#L26) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/mcp-server-types.ts:23](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/mcp-server-types.ts#L23) *** ### oauthAccessToken?[​](#oauthaccesstoken "Direct link to oauthAccessToken?") > `optional` **oauthAccessToken**: `string` Defined in: [packages/sdk/src/types/mcp-server-types.ts:29](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/mcp-server-types.ts#L29) *** ### oauthClientId?[​](#oauthclientid "Direct link to oauthClientId?") > `optional` **oauthClientId**: `string` Defined in: [packages/sdk/src/types/mcp-server-types.ts:30](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/mcp-server-types.ts#L30) *** ### oauthClientSecret?[​](#oauthclientsecret "Direct link to oauthClientSecret?") > `optional` **oauthClientSecret**: `string` Defined in: [packages/sdk/src/types/mcp-server-types.ts:31](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/mcp-server-types.ts#L31) *** ### slug?[​](#slug "Direct link to slug?") > `optional` **slug**: `string` Defined in: [packages/sdk/src/types/mcp-server-types.ts:24](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/mcp-server-types.ts#L24) *** ### supportsDirectAuth?[​](#supportsdirectauth "Direct link to supportsDirectAuth?") > `optional` **supportsDirectAuth**: `boolean` Defined in: [packages/sdk/src/types/mcp-server-types.ts:33](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/mcp-server-types.ts#L33) --- # Interface: McpServerPromptsResponse Defined in: [packages/sdk/src/types/app-connection-types.ts:596](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L596) ## Properties[​](#properties "Direct link to Properties") ### prompts[​](#prompts "Direct link to prompts") > **prompts**: [`McpPromptResponse`](https://docs.gravityrail.com/sdk/interfaces/McpPromptResponse.md)\[] Defined in: [packages/sdk/src/types/app-connection-types.ts:597](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L597) --- # Interface: McpServerResourcesResponse Defined in: [packages/sdk/src/types/app-connection-types.ts:576](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L576) ## Properties[​](#properties "Direct link to Properties") ### resources[​](#resources "Direct link to resources") > **resources**: [`McpResourceResponse`](https://docs.gravityrail.com/sdk/interfaces/McpResourceResponse.md)\[] Defined in: [packages/sdk/src/types/app-connection-types.ts:577](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L577) --- # Interface: McpServerResponse Defined in: [packages/sdk/src/types/generated/app\_connection.ts:263](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L263) Response model for an MCP server. ## Properties[​](#properties "Direct link to Properties") ### appUuid?[​](#appuuid "Direct link to appUuid?") > `optional` **appUuid**: `string` | `null` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:273](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L273) *** ### authMetadata?[​](#authmetadata "Direct link to authMetadata?") > `optional` **authMetadata**: `McpServerResponseAuthMetadata` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:287](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L287) *** ### connectionType?[​](#connectiontype "Direct link to connectionType?") > `optional` **connectionType**: `"mcp_server"` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:264](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L264) *** ### createdAt[​](#createdat "Direct link to createdAt") > **createdAt**: `string` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:281](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L281) *** ### creatorId?[​](#creatorid "Direct link to creatorId?") > `optional` **creatorId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:269](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L269) *** ### creatorName?[​](#creatorname "Direct link to creatorName?") > `optional` **creatorName**: `string` | `null` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:276](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L276) *** ### credentialId?[​](#credentialid "Direct link to credentialId?") > `optional` **credentialId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:274](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L274) *** ### description?[​](#description "Direct link to description?") > `optional` **description**: `string` | `null` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:271](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L271) *** ### enabled[​](#enabled "Direct link to enabled") > **enabled**: `boolean` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:268](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L268) *** ### iconUrl?[​](#iconurl "Direct link to iconUrl?") > `optional` **iconUrl**: `string` | `null` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:289](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L289) *** ### id[​](#id "Direct link to id") > **id**: `number` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:265](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L265) *** ### lastConnectedAt?[​](#lastconnectedat "Direct link to lastConnectedAt?") > `optional` **lastConnectedAt**: `string` | `null` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:283](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L283) *** ### mcpUrl[​](#mcpurl "Direct link to mcpUrl") > **mcpUrl**: `string` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:272](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L272) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:267](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L267) *** ### oauthClientId?[​](#oauthclientid "Direct link to oauthClientId?") > `optional` **oauthClientId**: `string` | `null` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:286](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L286) *** ### permissions?[​](#permissions "Direct link to permissions?") > `optional` **permissions**: `number` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:285](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L285) *** ### registrationUrl?[​](#registrationurl "Direct link to registrationUrl?") > `optional` **registrationUrl**: `string` | `null` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:288](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L288) *** ### serverInstructions?[​](#serverinstructions "Direct link to serverInstructions?") > `optional` **serverInstructions**: `string` | `null` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:280](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L280) *** ### serverName?[​](#servername "Direct link to serverName?") > `optional` **serverName**: `string` | `null` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:278](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L278) *** ### serverVersion?[​](#serverversion "Direct link to serverVersion?") > `optional` **serverVersion**: `string` | `null` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:279](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L279) *** ### slug[​](#slug "Direct link to slug") > **slug**: `string` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:270](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L270) *** ### state[​](#state "Direct link to state") > **state**: `string` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:275](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L275) *** ### supportsDirectAuth[​](#supportsdirectauth "Direct link to supportsDirectAuth") > **supportsDirectAuth**: `boolean` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:277](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L277) *** ### tools?[​](#tools "Direct link to tools?") > `optional` **tools**: [`McpToolResponse`](https://docs.gravityrail.com/sdk/interfaces/McpToolResponse.md)\[] Defined in: [packages/sdk/src/types/generated/app\_connection.ts:284](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L284) *** ### updatedAt[​](#updatedat "Direct link to updatedAt") > **updatedAt**: `string` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:282](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L282) *** ### uuid[​](#uuid "Direct link to uuid") > **uuid**: `string` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:266](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L266) --- # Interface: McpServerToolResponse Defined in: [packages/sdk/src/types/app-connection-types.ts:538](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L538) ## Properties[​](#properties "Direct link to Properties") ### description[​](#description "Direct link to description") > **description**: `string` | `null` Defined in: [packages/sdk/src/types/app-connection-types.ts:540](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L540) *** ### inputSchema[​](#inputschema "Direct link to inputSchema") > **inputSchema**: `Record`<`string`, `unknown`> | `null` Defined in: [packages/sdk/src/types/app-connection-types.ts:541](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L541) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/app-connection-types.ts:539](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L539) --- # Interface: McpServerToolsResponse Defined in: [packages/sdk/src/types/app-connection-types.ts:550](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L550) Successful response from GET /app-connections/mcp-servers/{id}/tools. A 403 with `detail.code === 'auth_required'` indicates the user needs to authenticate first. ## Properties[​](#properties "Direct link to Properties") ### tools[​](#tools "Direct link to tools") > **tools**: [`McpServerToolResponse`](https://docs.gravityrail.com/sdk/interfaces/McpServerToolResponse.md)\[] Defined in: [packages/sdk/src/types/app-connection-types.ts:551](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L551) --- # Interface: McpServerUpdateFormData Defined in: [packages/sdk/src/types/mcp-server-types.ts:36](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/mcp-server-types.ts#L36) ## Properties[​](#properties "Direct link to Properties") ### authMetadata?[​](#authmetadata "Direct link to authMetadata?") > `optional` **authMetadata**: `Record`<`string`, `any`> Defined in: [packages/sdk/src/types/mcp-server-types.ts:45](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/mcp-server-types.ts#L45) *** ### authToken?[​](#authtoken "Direct link to authToken?") > `optional` **authToken**: `string` Defined in: [packages/sdk/src/types/mcp-server-types.ts:41](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/mcp-server-types.ts#L41) *** ### description?[​](#description "Direct link to description?") > `optional` **description**: `string` Defined in: [packages/sdk/src/types/mcp-server-types.ts:39](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/mcp-server-types.ts#L39) *** ### mcpUrl?[​](#mcpurl "Direct link to mcpUrl?") > `optional` **mcpUrl**: `string` Defined in: [packages/sdk/src/types/mcp-server-types.ts:40](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/mcp-server-types.ts#L40) *** ### name?[​](#name "Direct link to name?") > `optional` **name**: `string` Defined in: [packages/sdk/src/types/mcp-server-types.ts:37](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/mcp-server-types.ts#L37) *** ### oauthAccessToken?[​](#oauthaccesstoken "Direct link to oauthAccessToken?") > `optional` **oauthAccessToken**: `string` Defined in: [packages/sdk/src/types/mcp-server-types.ts:42](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/mcp-server-types.ts#L42) *** ### oauthClientId?[​](#oauthclientid "Direct link to oauthClientId?") > `optional` **oauthClientId**: `string` Defined in: [packages/sdk/src/types/mcp-server-types.ts:43](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/mcp-server-types.ts#L43) *** ### oauthClientSecret?[​](#oauthclientsecret "Direct link to oauthClientSecret?") > `optional` **oauthClientSecret**: `string` Defined in: [packages/sdk/src/types/mcp-server-types.ts:44](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/mcp-server-types.ts#L44) *** ### slug?[​](#slug "Direct link to slug?") > `optional` **slug**: `string` Defined in: [packages/sdk/src/types/mcp-server-types.ts:38](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/mcp-server-types.ts#L38) *** ### supportsDirectAuth?[​](#supportsdirectauth "Direct link to supportsDirectAuth?") > `optional` **supportsDirectAuth**: `boolean` Defined in: [packages/sdk/src/types/mcp-server-types.ts:46](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/mcp-server-types.ts#L46) --- # Interface: McpTestConnectionResponse Defined in: [packages/sdk/src/types/app-connection-types.ts:604](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L604) ## Properties[​](#properties "Direct link to Properties") ### error[​](#error "Direct link to error") > **error**: `string` | `null` Defined in: [packages/sdk/src/types/app-connection-types.ts:609](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L609) *** ### latencyMs[​](#latencyms "Direct link to latencyMs") > **latencyMs**: `number` | `null` Defined in: [packages/sdk/src/types/app-connection-types.ts:606](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L606) *** ### serverName[​](#servername "Direct link to serverName") > **serverName**: `string` | `null` Defined in: [packages/sdk/src/types/app-connection-types.ts:607](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L607) *** ### serverVersion[​](#serverversion "Direct link to serverVersion") > **serverVersion**: `string` | `null` Defined in: [packages/sdk/src/types/app-connection-types.ts:608](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L608) *** ### success[​](#success "Direct link to success") > **success**: `boolean` Defined in: [packages/sdk/src/types/app-connection-types.ts:605](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L605) --- # Interface: McpToolResponse Defined in: [packages/sdk/src/types/generated/app\_connection.ts:297](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L297) Response model for a dynamically discovered MCP tool. ## Properties[​](#properties "Direct link to Properties") ### description?[​](#description "Direct link to description?") > `optional` **description**: `string` | `null` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:299](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L299) *** ### inputSchema?[​](#inputschema "Direct link to inputSchema?") > `optional` **inputSchema**: `McpToolResponseInputSchema` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:300](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L300) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:298](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L298) --- # Interface: MemberCredential Defined in: [packages/sdk/src/types/generated/member.ts:319](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L319) Response model for member credentials. ## Properties[​](#properties "Direct link to Properties") ### appConnectionId?[​](#appconnectionid "Direct link to appConnectionId?") > `optional` **appConnectionId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/member.ts:332](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L332) *** ### appConnectionName?[​](#appconnectionname "Direct link to appConnectionName?") > `optional` **appConnectionName**: `string` | `null` Defined in: [packages/sdk/src/types/generated/member.ts:333](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L333) *** ### connectedAt?[​](#connectedat "Direct link to connectedAt?") > `optional` **connectedAt**: `string` | `null` Defined in: [packages/sdk/src/types/generated/member.ts:329](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L329) *** ### createdAt[​](#createdat "Direct link to createdAt") > **createdAt**: `string` Defined in: [packages/sdk/src/types/generated/member.ts:331](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L331) *** ### displayName?[​](#displayname "Direct link to displayName?") > `optional` **displayName**: `string` | `null` Defined in: [packages/sdk/src/types/generated/member.ts:322](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L322) *** ### emailVerified?[​](#emailverified "Direct link to emailVerified?") > `optional` **emailVerified**: `boolean` Defined in: [packages/sdk/src/types/generated/member.ts:328](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L328) *** ### externalEmail?[​](#externalemail "Direct link to externalEmail?") > `optional` **externalEmail**: `string` | `null` Defined in: [packages/sdk/src/types/generated/member.ts:327](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L327) *** ### externalUserId?[​](#externaluserid "Direct link to externalUserId?") > `optional` **externalUserId**: `string` | `null` Defined in: [packages/sdk/src/types/generated/member.ts:325](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L325) *** ### externalUsername?[​](#externalusername "Direct link to externalUsername?") > `optional` **externalUsername**: `string` | `null` Defined in: [packages/sdk/src/types/generated/member.ts:326](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L326) *** ### icon?[​](#icon "Direct link to icon?") > `optional` **icon**: `string` | `null` Defined in: [packages/sdk/src/types/generated/member.ts:334](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L334) *** ### iconUrl?[​](#iconurl "Direct link to iconUrl?") > `optional` **iconUrl**: `string` | `null` Defined in: [packages/sdk/src/types/generated/member.ts:335](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L335) *** ### id[​](#id "Direct link to id") > **id**: `number` Defined in: [packages/sdk/src/types/generated/member.ts:320](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L320) *** ### isDefault?[​](#isdefault "Direct link to isDefault?") > `optional` **isDefault**: `boolean` Defined in: [packages/sdk/src/types/generated/member.ts:323](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L323) *** ### lastUsedAt?[​](#lastusedat "Direct link to lastUsedAt?") > `optional` **lastUsedAt**: `string` | `null` Defined in: [packages/sdk/src/types/generated/member.ts:330](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L330) *** ### provider?[​](#provider "Direct link to provider?") > `optional` **provider**: `string` | `null` Defined in: [packages/sdk/src/types/generated/member.ts:324](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L324) *** ### uuid?[​](#uuid "Direct link to uuid?") > `optional` **uuid**: `string` | `null` Defined in: [packages/sdk/src/types/generated/member.ts:321](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L321) --- # Interface: MemberFieldDefinitionListResponse Defined in: [packages/sdk/src/types/generated/member.ts:351](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L351) Response model for list of field definitions available in a workspace. ## Properties[​](#properties "Direct link to Properties") ### items[​](#items "Direct link to items") > **items**: [`MemberFieldDefinitionResponse`](https://docs.gravityrail.com/sdk/interfaces/MemberFieldDefinitionResponse.md)\[] Defined in: [packages/sdk/src/types/generated/member.ts:352](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L352) --- # Interface: MemberFieldDefinitionResponse Defined in: [packages/sdk/src/types/generated/member.ts:359](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L359) A field definition available in the workspace (from active app connections or user-created fields). ## Properties[​](#properties "Direct link to Properties") ### key[​](#key "Direct link to key") > **key**: `string` Defined in: [packages/sdk/src/types/generated/member.ts:360](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L360) *** ### label[​](#label "Direct link to label") > **label**: `string` Defined in: [packages/sdk/src/types/generated/member.ts:361](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L361) *** ### serviceName?[​](#servicename "Direct link to serviceName?") > `optional` **serviceName**: `string` | `null` Defined in: [packages/sdk/src/types/generated/member.ts:362](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L362) *** ### serviceType?[​](#servicetype "Direct link to serviceType?") > `optional` **serviceType**: `string` | `null` Defined in: [packages/sdk/src/types/generated/member.ts:363](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L363) --- # Interface: MemberFieldListResponse Defined in: [packages/sdk/src/types/generated/member.ts:369](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L369) Response model for list of member fields. ## Properties[​](#properties "Direct link to Properties") ### items[​](#items "Direct link to items") > **items**: [`MemberFieldResponse`](https://docs.gravityrail.com/sdk/interfaces/MemberFieldResponse.md)\[] Defined in: [packages/sdk/src/types/generated/member.ts:370](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L370) *** ### total[​](#total "Direct link to total") > **total**: `number` Defined in: [packages/sdk/src/types/generated/member.ts:371](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L371) --- # Interface: MemberFieldResponse Defined in: [packages/sdk/src/types/generated/member.ts:380](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L380) Response model for a member field. When id is None, this is a placeholder for a managed field definition that doesn't have a value yet for this member. ## Properties[​](#properties "Direct link to Properties") ### createdAt[​](#createdat "Direct link to createdAt") > **createdAt**: `string` | `null` Defined in: [packages/sdk/src/types/generated/member.ts:388](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L388) *** ### id[​](#id "Direct link to id") > **id**: `number` | `null` Defined in: [packages/sdk/src/types/generated/member.ts:381](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L381) *** ### key[​](#key "Direct link to key") > **key**: `string` Defined in: [packages/sdk/src/types/generated/member.ts:383](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L383) *** ### memberId[​](#memberid "Direct link to memberId") > **memberId**: `number` Defined in: [packages/sdk/src/types/generated/member.ts:382](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L382) *** ### serviceId[​](#serviceid "Direct link to serviceId") > **serviceId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/member.ts:385](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L385) *** ### serviceName[​](#servicename "Direct link to serviceName") > **serviceName**: `string` | `null` Defined in: [packages/sdk/src/types/generated/member.ts:386](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L386) *** ### serviceType[​](#servicetype "Direct link to serviceType") > **serviceType**: `string` | `null` Defined in: [packages/sdk/src/types/generated/member.ts:387](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L387) *** ### updatedAt[​](#updatedat "Direct link to updatedAt") > **updatedAt**: `string` | `null` Defined in: [packages/sdk/src/types/generated/member.ts:389](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L389) *** ### value[​](#value "Direct link to value") > **value**: `string` Defined in: [packages/sdk/src/types/generated/member.ts:384](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L384) --- # Interface: MemberFieldVerificationAbilityConfig Defined in: [packages/sdk/src/types/ability-types.ts:416](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ability-types.ts#L416) Config for member\_field\_verification ability ## Properties[​](#properties "Direct link to Properties") ### verifyDateOfBirth?[​](#verifydateofbirth "Direct link to verifyDateOfBirth?") > `optional` **verifyDateOfBirth**: `boolean` Defined in: [packages/sdk/src/types/ability-types.ts:424](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ability-types.ts#L424) Enable verification against the Member date of birth on file (default: true) *** ### verifyEmail?[​](#verifyemail "Direct link to verifyEmail?") > `optional` **verifyEmail**: `boolean` Defined in: [packages/sdk/src/types/ability-types.ts:420](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ability-types.ts#L420) Enable verification against the Member email on file (default: false) *** ### verifyName?[​](#verifyname "Direct link to verifyName?") > `optional` **verifyName**: `boolean` Defined in: [packages/sdk/src/types/ability-types.ts:418](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ability-types.ts#L418) Enable verification against the Member name on file (default: true) *** ### verifyPhone?[​](#verifyphone "Direct link to verifyPhone?") > `optional` **verifyPhone**: `boolean` Defined in: [packages/sdk/src/types/ability-types.ts:422](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ability-types.ts#L422) Enable verification against the Member phone on file (default: false) --- # Interface: MemberFilterExport Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:231](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L231) ## Properties[​](#properties "Direct link to Properties") ### description?[​](#description "Direct link to description?") > `optional` **description**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:234](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L234) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:233](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L233) *** ### uuid[​](#uuid "Direct link to uuid") > **uuid**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:232](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L232) --- # Interface: MemberFilterFormData Defined in: [packages/sdk/src/types/member-types.ts:298](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L298) ## Properties[​](#properties "Direct link to Properties") ### description?[​](#description "Direct link to description?") > `optional` **description**: `string` Defined in: [packages/sdk/src/types/member-types.ts:300](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L300) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/member-types.ts:299](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L299) *** ### pinned?[​](#pinned "Direct link to pinned?") > `optional` **pinned**: `boolean` Defined in: [packages/sdk/src/types/member-types.ts:301](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L301) *** ### query?[​](#query "Direct link to query?") > `optional` **query**: [`QueryPredicate`](https://docs.gravityrail.com/sdk/type-aliases/QueryPredicate.md) | `null` Defined in: [packages/sdk/src/types/member-types.ts:304](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L304) Query-engine predicate (JSON IR) stored on MemberFilter.query. *** ### rules[​](#rules "Direct link to rules") > **rules**: [`MemberFilterRuleFormData`](https://docs.gravityrail.com/sdk/interfaces/MemberFilterRuleFormData.md)\[] Defined in: [packages/sdk/src/types/member-types.ts:302](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L302) --- # Interface: MemberFilterResponse Defined in: [packages/sdk/src/types/generated/member.ts:395](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L395) Response model for a member filter. ## Properties[​](#properties "Direct link to Properties") ### createdAt[​](#createdat "Direct link to createdAt") > **createdAt**: `string` Defined in: [packages/sdk/src/types/generated/member.ts:401](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L401) *** ### description?[​](#description "Direct link to description?") > `optional` **description**: `string` | `null` Defined in: [packages/sdk/src/types/generated/member.ts:399](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L399) *** ### id[​](#id "Direct link to id") > **id**: `number` Defined in: [packages/sdk/src/types/generated/member.ts:396](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L396) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/generated/member.ts:398](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L398) *** ### pinned?[​](#pinned "Direct link to pinned?") > `optional` **pinned**: `boolean` | `null` Defined in: [packages/sdk/src/types/generated/member.ts:400](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L400) *** ### query?[​](#query "Direct link to query?") > `optional` **query**: `MemberFilterResponseQuery` Defined in: [packages/sdk/src/types/generated/member.ts:404](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L404) *** ### rules[​](#rules "Direct link to rules") > **rules**: [`MemberFilterRuleResponse`](https://docs.gravityrail.com/sdk/interfaces/MemberFilterRuleResponse.md)\[] Defined in: [packages/sdk/src/types/generated/member.ts:403](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L403) *** ### updatedAt[​](#updatedat "Direct link to updatedAt") > **updatedAt**: `string` Defined in: [packages/sdk/src/types/generated/member.ts:402](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L402) *** ### uuid[​](#uuid "Direct link to uuid") > **uuid**: `string` Defined in: [packages/sdk/src/types/generated/member.ts:397](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L397) --- # Interface: MemberFilterRuleExport Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:237](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L237) ## Properties[​](#properties "Direct link to Properties") ### field[​](#field "Direct link to field") > **field**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:240](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L240) *** ### filterUuid[​](#filteruuid "Direct link to filterUuid") > **filterUuid**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:239](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L239) *** ### operator[​](#operator "Direct link to operator") > **operator**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:241](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L241) *** ### uuid[​](#uuid "Direct link to uuid") > **uuid**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:238](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L238) *** ### value[​](#value "Direct link to value") > **value**: `any` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:242](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L242) --- # Interface: MemberFilterRuleFormData Defined in: [packages/sdk/src/types/member-types.ts:283](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L283) ## Properties[​](#properties "Direct link to Properties") ### filterType[​](#filtertype "Direct link to filterType") > **filterType**: [`MemberFilterFilterType`](https://docs.gravityrail.com/sdk/type-aliases/MemberFilterFilterType.md) Defined in: [packages/sdk/src/types/member-types.ts:285](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L285) *** ### objectIds?[​](#objectids "Direct link to objectIds?") > `optional` **objectIds**: `number`\[] Defined in: [packages/sdk/src/types/member-types.ts:286](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L286) *** ### objectType[​](#objecttype "Direct link to objectType") > **objectType**: [`MemberFilterObjectType`](https://docs.gravityrail.com/sdk/type-aliases/MemberFilterObjectType.md) Defined in: [packages/sdk/src/types/member-types.ts:284](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L284) *** ### query?[​](#query "Direct link to query?") > `optional` **query**: `string` Defined in: [packages/sdk/src/types/member-types.ts:287](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L287) --- # Interface: MemberFilterRuleResponse Defined in: [packages/sdk/src/types/generated/member.ts:412](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L412) Response model for a member filter rule. ## Properties[​](#properties "Direct link to Properties") ### filterType[​](#filtertype "Direct link to filterType") > **filterType**: `string` Defined in: [packages/sdk/src/types/generated/member.ts:416](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L416) *** ### id[​](#id "Direct link to id") > **id**: `number` Defined in: [packages/sdk/src/types/generated/member.ts:413](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L413) *** ### objectIds?[​](#objectids "Direct link to objectIds?") > `optional` **objectIds**: `number`\[] | `null` Defined in: [packages/sdk/src/types/generated/member.ts:417](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L417) *** ### objectType[​](#objecttype "Direct link to objectType") > **objectType**: `string` Defined in: [packages/sdk/src/types/generated/member.ts:415](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L415) *** ### query?[​](#query "Direct link to query?") > `optional` **query**: `string` | `null` Defined in: [packages/sdk/src/types/generated/member.ts:418](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L418) *** ### uuid[​](#uuid "Direct link to uuid") > **uuid**: `string` Defined in: [packages/sdk/src/types/generated/member.ts:414](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L414) --- # Interface: MemberFormData Defined in: [packages/sdk/src/types/member-types.ts:328](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L328) ## Properties[​](#properties "Direct link to Properties") ### dateOfBirth?[​](#dateofbirth "Direct link to dateOfBirth?") > `optional` **dateOfBirth**: `string` | `null` Defined in: [packages/sdk/src/types/member-types.ts:340](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L340) *** ### description?[​](#description "Direct link to description?") > `optional` **description**: `string` Defined in: [packages/sdk/src/types/member-types.ts:336](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L336) *** ### email?[​](#email "Direct link to email?") > `optional` **email**: `string` Defined in: [packages/sdk/src/types/member-types.ts:338](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L338) *** ### externalId?[​](#externalid "Direct link to externalId?") > `optional` **externalId**: `string` Defined in: [packages/sdk/src/types/member-types.ts:339](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L339) *** ### memberRoleId?[​](#memberroleid "Direct link to memberRoleId?") > `optional` **memberRoleId**: `number` Defined in: [packages/sdk/src/types/member-types.ts:330](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L330) *** ### name?[​](#name "Direct link to name?") > `optional` **name**: `string` Defined in: [packages/sdk/src/types/member-types.ts:335](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L335) *** ### notifyEmail?[​](#notifyemail "Direct link to notifyEmail?") > `optional` **notifyEmail**: `boolean` Defined in: [packages/sdk/src/types/member-types.ts:332](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L332) *** ### notifySms?[​](#notifysms "Direct link to notifySms?") > `optional` **notifySms**: `boolean` Defined in: [packages/sdk/src/types/member-types.ts:331](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L331) *** ### notifyVoice?[​](#notifyvoice "Direct link to notifyVoice?") > `optional` **notifyVoice**: `boolean` Defined in: [packages/sdk/src/types/member-types.ts:333](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L333) *** ### notifyWhatsapp?[​](#notifywhatsapp "Direct link to notifyWhatsapp?") > `optional` **notifyWhatsapp**: `boolean` Defined in: [packages/sdk/src/types/member-types.ts:334](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L334) *** ### phone?[​](#phone "Direct link to phone?") > `optional` **phone**: `string` Defined in: [packages/sdk/src/types/member-types.ts:337](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L337) *** ### tosAccepted?[​](#tosaccepted "Direct link to tosAccepted?") > `optional` **tosAccepted**: `boolean` Defined in: [packages/sdk/src/types/member-types.ts:329](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L329) --- # Interface: MemberImportConflictInfo Defined in: [packages/sdk/src/types/generated/member.ts:424](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L424) Why an import row is a phone-only identity conflict (field names only). ## Properties[​](#properties "Direct link to Properties") ### code[​](#code "Direct link to code") > **code**: `string` Defined in: [packages/sdk/src/types/generated/member.ts:425](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L425) *** ### fields[​](#fields "Direct link to fields") > **fields**: `string`\[] Defined in: [packages/sdk/src/types/generated/member.ts:426](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L426) --- # Interface: MemberImportIdentitySnapshot Defined in: [packages/sdk/src/types/generated/member.ts:434](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L434) Identity values shown to the operator to compare a conflict row. Populated only for conflict rows in the preview response (PHI minimization). ## Properties[​](#properties "Direct link to Properties") ### dateOfBirth?[​](#dateofbirth "Direct link to dateOfBirth?") > `optional` **dateOfBirth**: `string` | `null` Defined in: [packages/sdk/src/types/generated/member.ts:436](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L436) *** ### name?[​](#name "Direct link to name?") > `optional` **name**: `string` | `null` Defined in: [packages/sdk/src/types/generated/member.ts:435](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L435) --- # Interface: MemberImportMatchInfo Defined in: [packages/sdk/src/types/generated/member.ts:442](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L442) Which existing Member an import row matched, and how it matched. ## Properties[​](#properties "Direct link to Properties") ### matchType[​](#matchtype "Direct link to matchType") > **matchType**: [`MemberImportMatchInfoMatchType`](https://docs.gravityrail.com/sdk/type-aliases/MemberImportMatchInfoMatchType.md) Defined in: [packages/sdk/src/types/generated/member.ts:443](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L443) *** ### memberId[​](#memberid "Direct link to memberId") > **memberId**: `number` Defined in: [packages/sdk/src/types/generated/member.ts:444](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L444) *** ### memberUuid[​](#memberuuid "Direct link to memberUuid") > **memberUuid**: `string` Defined in: [packages/sdk/src/types/generated/member.ts:445](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L445) --- # Interface: MemberImportPreviewResponse Defined in: [packages/sdk/src/types/generated/member.ts:462](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L462) Read-only classification of an uploaded CSV before any write occurs. ## Properties[​](#properties "Direct link to Properties") ### rows[​](#rows "Direct link to rows") > **rows**: [`MemberImportPreviewRow`](https://docs.gravityrail.com/sdk/interfaces/MemberImportPreviewRow.md)\[] Defined in: [packages/sdk/src/types/generated/member.ts:465](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L465) *** ### summary[​](#summary "Direct link to summary") > **summary**: [`MemberImportPreviewSummary`](https://docs.gravityrail.com/sdk/interfaces/MemberImportPreviewSummary.md) Defined in: [packages/sdk/src/types/generated/member.ts:464](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L464) *** ### totalRows[​](#totalrows "Direct link to totalRows") > **totalRows**: `number` Defined in: [packages/sdk/src/types/generated/member.ts:463](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L463) --- # Interface: MemberImportPreviewRow Defined in: [packages/sdk/src/types/generated/member.ts:471](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L471) One classified import row in the read-only preview response. ## Properties[​](#properties "Direct link to Properties") ### action[​](#action "Direct link to action") > **action**: [`MemberImportPreviewRowAction`](https://docs.gravityrail.com/sdk/type-aliases/MemberImportPreviewRowAction.md) Defined in: [packages/sdk/src/types/generated/member.ts:473](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L473) *** ### conflict?[​](#conflict "Direct link to conflict?") > `optional` **conflict**: [`MemberImportConflictInfo`](https://docs.gravityrail.com/sdk/interfaces/MemberImportConflictInfo.md) | `null` Defined in: [packages/sdk/src/types/generated/member.ts:475](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L475) *** ### error?[​](#error "Direct link to error?") > `optional` **error**: `string` | `null` Defined in: [packages/sdk/src/types/generated/member.ts:479](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L479) *** ### existingIdentity?[​](#existingidentity "Direct link to existingIdentity?") > `optional` **existingIdentity**: [`MemberImportIdentitySnapshot`](https://docs.gravityrail.com/sdk/interfaces/MemberImportIdentitySnapshot.md) | `null` Defined in: [packages/sdk/src/types/generated/member.ts:476](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L476) *** ### incomingIdentity?[​](#incomingidentity "Direct link to incomingIdentity?") > `optional` **incomingIdentity**: [`MemberImportIdentitySnapshot`](https://docs.gravityrail.com/sdk/interfaces/MemberImportIdentitySnapshot.md) | `null` Defined in: [packages/sdk/src/types/generated/member.ts:477](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L477) *** ### match?[​](#match "Direct link to match?") > `optional` **match**: [`MemberImportMatchInfo`](https://docs.gravityrail.com/sdk/interfaces/MemberImportMatchInfo.md) | `null` Defined in: [packages/sdk/src/types/generated/member.ts:474](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L474) *** ### proposedChanges?[​](#proposedchanges "Direct link to proposedChanges?") > `optional` **proposedChanges**: `string`\[] Defined in: [packages/sdk/src/types/generated/member.ts:478](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L478) *** ### row[​](#row "Direct link to row") > **row**: `number` Defined in: [packages/sdk/src/types/generated/member.ts:472](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L472) --- # Interface: MemberImportPreviewSummary Defined in: [packages/sdk/src/types/generated/member.ts:496](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L496) Counts per classified action for an import preview. ## Properties[​](#properties "Direct link to Properties") ### conflict?[​](#conflict "Direct link to conflict?") > `optional` **conflict**: `number` Defined in: [packages/sdk/src/types/generated/member.ts:500](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L500) *** ### create?[​](#create "Direct link to create?") > `optional` **create**: `number` Defined in: [packages/sdk/src/types/generated/member.ts:497](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L497) *** ### error?[​](#error "Direct link to error?") > `optional` **error**: `number` Defined in: [packages/sdk/src/types/generated/member.ts:501](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L501) *** ### unchanged?[​](#unchanged "Direct link to unchanged?") > `optional` **unchanged**: `number` Defined in: [packages/sdk/src/types/generated/member.ts:499](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L499) *** ### update?[​](#update "Direct link to update?") > `optional` **update**: `number` Defined in: [packages/sdk/src/types/generated/member.ts:498](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L498) --- # Interface: MemberImportStreamConflict Defined in: [packages/sdk/src/types/member-types.ts:132](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L132) A conflict detail in the import stream — field NAMES only, never PHI values. ## Properties[​](#properties "Direct link to Properties") ### code[​](#code "Direct link to code") > **code**: `string` Defined in: [packages/sdk/src/types/member-types.ts:133](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L133) *** ### fields[​](#fields "Direct link to fields") > **fields**: `string`\[] Defined in: [packages/sdk/src/types/member-types.ts:134](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L134) *** ### match[​](#match "Direct link to match") > **match**: `object` Defined in: [packages/sdk/src/types/member-types.ts:135](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L135) #### match\_type[​](#match_type "Direct link to match_type") > **match\_type**: `"email"` | `"phone"` | `"external_id"` | `"account_email"` | `"account_phone"` #### member\_id[​](#member_id "Direct link to member_id") > **member\_id**: `number` #### member\_uuid[​](#member_uuid "Direct link to member_uuid") > **member\_uuid**: `string` --- # Interface: MemberImportStreamEvent Defined in: [packages/sdk/src/types/member-types.ts:148](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L148) One NDJSON event from POST /members/import. PHI-free by contract: only counts, row numbers, codes, field names, and member ids/uuids. ## Properties[​](#properties "Direct link to Properties") ### conflict?[​](#conflict "Direct link to conflict?") > `optional` **conflict**: [`MemberImportStreamConflict`](https://docs.gravityrail.com/sdk/interfaces/MemberImportStreamConflict.md) Defined in: [packages/sdk/src/types/member-types.ts:161](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L161) *** ### conflicted?[​](#conflicted "Direct link to conflicted?") > `optional` **conflicted**: `number` Defined in: [packages/sdk/src/types/member-types.ts:156](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L156) *** ### conflictRows?[​](#conflictrows "Direct link to conflictRows?") > `optional` **conflictRows**: `number`\[] Defined in: [packages/sdk/src/types/member-types.ts:165](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L165) *** ### conflicts?[​](#conflicts "Direct link to conflicts?") > `optional` **conflicts**: `object`\[] Defined in: [packages/sdk/src/types/member-types.ts:166](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L166) #### code[​](#code "Direct link to code") > **code**: `string` #### fields[​](#fields "Direct link to fields") > **fields**: `string`\[] #### member\_id[​](#member_id "Direct link to member_id") > **member\_id**: `number` #### member\_uuid[​](#member_uuid "Direct link to member_uuid") > **member\_uuid**: `string` #### row[​](#row "Direct link to row") > **row**: `number` *** ### created?[​](#created "Direct link to created?") > `optional` **created**: `number` Defined in: [packages/sdk/src/types/member-types.ts:157](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L157) *** ### current?[​](#current "Direct link to current?") > `optional` **current**: `number` Defined in: [packages/sdk/src/types/member-types.ts:152](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L152) *** ### errors?[​](#errors "Direct link to errors?") > `optional` **errors**: `string`\[] Defined in: [packages/sdk/src/types/member-types.ts:163](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L163) *** ### failed?[​](#failed "Direct link to failed?") > `optional` **failed**: `number` Defined in: [packages/sdk/src/types/member-types.ts:155](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L155) *** ### failedRows?[​](#failedrows "Direct link to failedRows?") > `optional` **failedRows**: `number`\[] Defined in: [packages/sdk/src/types/member-types.ts:164](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L164) *** ### message?[​](#message "Direct link to message?") > `optional` **message**: `string` Defined in: [packages/sdk/src/types/member-types.ts:151](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L151) *** ### row?[​](#row-1 "Direct link to row?") > `optional` **row**: `number` Defined in: [packages/sdk/src/types/member-types.ts:150](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L150) *** ### success?[​](#success "Direct link to success?") > `optional` **success**: `number` Defined in: [packages/sdk/src/types/member-types.ts:154](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L154) *** ### total?[​](#total "Direct link to total?") > `optional` **total**: `number` Defined in: [packages/sdk/src/types/member-types.ts:153](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L153) *** ### type[​](#type "Direct link to type") > **type**: `"error"` | `"conflict"` | `"progress"` | `"complete"` Defined in: [packages/sdk/src/types/member-types.ts:149](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L149) *** ### unchanged?[​](#unchanged "Direct link to unchanged?") > `optional` **unchanged**: `number` Defined in: [packages/sdk/src/types/member-types.ts:159](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L159) *** ### updated?[​](#updated "Direct link to updated?") > `optional` **updated**: `number` Defined in: [packages/sdk/src/types/member-types.ts:158](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L158) *** ### updatedMembers?[​](#updatedmembers "Direct link to updatedMembers?") > `optional` **updatedMembers**: `object`\[] Defined in: [packages/sdk/src/types/member-types.ts:173](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L173) #### changes[​](#changes "Direct link to changes") > **changes**: `string`\[] #### memberId[​](#memberid "Direct link to memberId") > **memberId**: `number` #### row[​](#row-2 "Direct link to row") > **row**: `number` --- # Interface: MemberLabelActionParams Defined in: [packages/sdk/src/types/event-types.ts:193](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L193) ## Properties[​](#properties "Direct link to Properties") ### addLabelIds?[​](#addlabelids "Direct link to addLabelIds?") > `optional` **addLabelIds**: `string`\[] Defined in: [packages/sdk/src/types/event-types.ts:194](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L194) *** ### removeLabelIds?[​](#removelabelids "Direct link to removeLabelIds?") > `optional` **removeLabelIds**: `string`\[] Defined in: [packages/sdk/src/types/event-types.ts:195](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L195) --- # Interface: MemberLabelExport Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:203](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L203) ## Properties[​](#properties "Direct link to Properties") ### color?[​](#color "Direct link to color?") > `optional` **color**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:207](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L207) *** ### description?[​](#description "Direct link to description?") > `optional` **description**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:208](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L208) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:205](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L205) *** ### slug[​](#slug "Direct link to slug") > **slug**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:206](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L206) *** ### uuid[​](#uuid "Direct link to uuid") > **uuid**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:204](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L204) --- # Interface: MemberLabelFormData Defined in: [packages/sdk/src/types/member-types.ts:177](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L177) ## Properties[​](#properties "Direct link to Properties") ### color[​](#color "Direct link to color") > **color**: `string` Defined in: [packages/sdk/src/types/member-types.ts:181](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L181) *** ### description?[​](#description "Direct link to description?") > `optional` **description**: `string` Defined in: [packages/sdk/src/types/member-types.ts:180](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L180) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/member-types.ts:178](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L178) *** ### slug?[​](#slug "Direct link to slug?") > `optional` **slug**: `string` Defined in: [packages/sdk/src/types/member-types.ts:179](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L179) --- # Interface: MemberLabelResponse Defined in: [packages/sdk/src/types/generated/member.ts:507](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L507) Response model for assistant label endpoints. ## Properties[​](#properties "Direct link to Properties") ### color[​](#color "Direct link to color") > **color**: `string` Defined in: [packages/sdk/src/types/generated/member.ts:512](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L512) *** ### description[​](#description "Direct link to description") > **description**: `string` | `null` Defined in: [packages/sdk/src/types/generated/member.ts:513](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L513) *** ### id[​](#id "Direct link to id") > **id**: `number` Defined in: [packages/sdk/src/types/generated/member.ts:508](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L508) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/generated/member.ts:510](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L510) *** ### slug[​](#slug "Direct link to slug") > **slug**: `string` Defined in: [packages/sdk/src/types/generated/member.ts:511](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L511) *** ### uuid[​](#uuid "Direct link to uuid") > **uuid**: `string` Defined in: [packages/sdk/src/types/generated/member.ts:509](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L509) --- # Interface: MemberMessageActivity Defined in: [packages/sdk/src/types/member-types.ts:436](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L436) ## Indexable[​](#indexable "Direct link to Indexable") \[`memberId`: `number`]: `number`\[] --- # Interface: MemberNotificationPreferences Defined in: [packages/sdk/src/types/notification-types.ts:19](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/notification-types.ts#L19) ## Properties[​](#properties "Direct link to Properties") ### notifyEmail?[​](#notifyemail "Direct link to notifyEmail?") > `optional` **notifyEmail**: `boolean` Defined in: [packages/sdk/src/types/notification-types.ts:21](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/notification-types.ts#L21) *** ### notifySms?[​](#notifysms "Direct link to notifySms?") > `optional` **notifySms**: `boolean` Defined in: [packages/sdk/src/types/notification-types.ts:20](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/notification-types.ts#L20) *** ### notifyVoice?[​](#notifyvoice "Direct link to notifyVoice?") > `optional` **notifyVoice**: `boolean` Defined in: [packages/sdk/src/types/notification-types.ts:22](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/notification-types.ts#L22) *** ### notifyWhatsapp?[​](#notifywhatsapp "Direct link to notifyWhatsapp?") > `optional` **notifyWhatsapp**: `boolean` Defined in: [packages/sdk/src/types/notification-types.ts:23](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/notification-types.ts#L23) --- # Interface: MemberNotifyActionParams Defined in: [packages/sdk/src/types/notification-types.ts:26](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/notification-types.ts#L26) ## Properties[​](#properties "Direct link to Properties") ### memberId?[​](#memberid "Direct link to memberId?") > `optional` **memberId**: `number` | `null` Defined in: [packages/sdk/src/types/notification-types.ts:27](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/notification-types.ts#L27) *** ### messageTemplate?[​](#messagetemplate "Direct link to messageTemplate?") > `optional` **messageTemplate**: `string` | `null` Defined in: [packages/sdk/src/types/notification-types.ts:29](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/notification-types.ts#L29) *** ### sendToOwner?[​](#sendtoowner "Direct link to sendToOwner?") > `optional` **sendToOwner**: `boolean` Defined in: [packages/sdk/src/types/notification-types.ts:28](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/notification-types.ts#L28) --- # Interface: MemberOrgView Defined in: [packages/sdk/src/types/account-types.ts:262](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L262) Organization info for non-admin members Shows basic org info and user's workspace memberships ## Properties[​](#properties "Direct link to Properties") ### id[​](#id "Direct link to id") > **id**: `number` Defined in: [packages/sdk/src/types/account-types.ts:264](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L264) *** ### logoUrl[​](#logourl "Direct link to logoUrl") > **logoUrl**: `string` | `null` Defined in: [packages/sdk/src/types/account-types.ts:268](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L268) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/account-types.ts:266](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L266) *** ### role[​](#role "Direct link to role") > **role**: `string` Defined in: [packages/sdk/src/types/account-types.ts:269](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L269) *** ### slug[​](#slug "Direct link to slug") > **slug**: `string` | `null` Defined in: [packages/sdk/src/types/account-types.ts:267](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L267) *** ### uuid[​](#uuid "Direct link to uuid") > **uuid**: `string` Defined in: [packages/sdk/src/types/account-types.ts:265](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L265) *** ### viewType[​](#viewtype "Direct link to viewType") > **viewType**: `"member"` Defined in: [packages/sdk/src/types/account-types.ts:263](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L263) *** ### workspaces[​](#workspaces "Direct link to workspaces") > **workspaces**: [`MemberWorkspaceInfo`](https://docs.gravityrail.com/sdk/interfaces/MemberWorkspaceInfo.md)\[] Defined in: [packages/sdk/src/types/account-types.ts:270](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L270) --- # Interface: MemberReportItem Defined in: [packages/sdk/src/types/member-types.ts:409](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L409) ## Properties[​](#properties "Direct link to Properties") ### account\_uuid[​](#account_uuid "Direct link to account_uuid") > **account\_uuid**: `string` Defined in: [packages/sdk/src/types/member-types.ts:411](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L411) *** ### created\_at[​](#created_at "Direct link to created_at") > **created\_at**: `string` Defined in: [packages/sdk/src/types/member-types.ts:416](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L416) *** ### email?[​](#email "Direct link to email?") > `optional` **email**: `string` | `null` Defined in: [packages/sdk/src/types/member-types.ts:412](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L412) *** ### external\_id?[​](#external_id "Direct link to external_id?") > `optional` **external\_id**: `string` | `null` Defined in: [packages/sdk/src/types/member-types.ts:415](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L415) *** ### id[​](#id "Direct link to id") > **id**: `number` Defined in: [packages/sdk/src/types/member-types.ts:410](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L410) *** ### member\_role\_id[​](#member_role_id "Direct link to member_role_id") > **member\_role\_id**: `number` Defined in: [packages/sdk/src/types/member-types.ts:418](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L418) *** ### member\_role\_name[​](#member_role_name "Direct link to member_role_name") > **member\_role\_name**: `string` Defined in: [packages/sdk/src/types/member-types.ts:419](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L419) *** ### name?[​](#name "Direct link to name?") > `optional` **name**: `string` | `null` Defined in: [packages/sdk/src/types/member-types.ts:414](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L414) *** ### phone?[​](#phone "Direct link to phone?") > `optional` **phone**: `string` | `null` Defined in: [packages/sdk/src/types/member-types.ts:413](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L413) *** ### updated\_at[​](#updated_at "Direct link to updated_at") > **updated\_at**: `string` Defined in: [packages/sdk/src/types/member-types.ts:417](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L417) --- # Interface: MemberRoleCalendarAccessResponse Defined in: [packages/sdk/src/types/generated/member.ts:519](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L519) Response model for calendar access within a member role. ## Properties[​](#properties "Direct link to Properties") ### accessMode[​](#accessmode "Direct link to accessMode") > **accessMode**: `number` Defined in: [packages/sdk/src/types/generated/member.ts:521](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L521) *** ### calendarId[​](#calendarid "Direct link to calendarId") > **calendarId**: `number` Defined in: [packages/sdk/src/types/generated/member.ts:520](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L520) --- # Interface: MemberRoleDataTypeAccessResponse Defined in: [packages/sdk/src/types/generated/member.ts:527](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L527) Response model for data type access within a member role. ## Properties[​](#properties "Direct link to Properties") ### accessMode[​](#accessmode "Direct link to accessMode") > **accessMode**: `number` Defined in: [packages/sdk/src/types/generated/member.ts:529](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L529) *** ### dataTypeId[​](#datatypeid "Direct link to dataTypeId") > **dataTypeId**: `number` Defined in: [packages/sdk/src/types/generated/member.ts:528](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L528) --- # Interface: MemberRoleDataTypeRelation Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:134](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L134) ## Properties[​](#properties "Direct link to Properties") ### accessMode[​](#accessmode "Direct link to accessMode") > **accessMode**: `number` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:137](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L137) *** ### dataTypeUuid[​](#datatypeuuid "Direct link to dataTypeUuid") > **dataTypeUuid**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:136](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L136) *** ### memberRoleUuid[​](#memberroleuuid "Direct link to memberRoleUuid") > **memberRoleUuid**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:135](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L135) --- # Interface: MemberRoleExport Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:73](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L73) ## Properties[​](#properties "Direct link to Properties") ### description?[​](#description "Direct link to description?") > `optional` **description**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:77](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L77) *** ### grantedScopes[​](#grantedscopes "Direct link to grantedScopes") > **grantedScopes**: `string`\[] Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:78](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L78) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:76](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L76) *** ### templateUuid?[​](#templateuuid "Direct link to templateUuid?") > `optional` **templateUuid**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:75](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L75) *** ### uuid[​](#uuid "Direct link to uuid") > **uuid**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:74](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L74) --- # Interface: MemberRoleFileAccessResponse Defined in: [packages/sdk/src/types/generated/member.ts:535](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L535) Response model for file access within a member role. ## Properties[​](#properties "Direct link to Properties") ### accessMode[​](#accessmode "Direct link to accessMode") > **accessMode**: `number` Defined in: [packages/sdk/src/types/generated/member.ts:537](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L537) *** ### fileId[​](#fileid "Direct link to fileId") > **fileId**: `number` Defined in: [packages/sdk/src/types/generated/member.ts:536](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L536) --- # Interface: MemberRoleFolderAccessResponse Defined in: [packages/sdk/src/types/generated/member.ts:543](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L543) Response model for folder access within a member role. ## Properties[​](#properties "Direct link to Properties") ### accessMode[​](#accessmode "Direct link to accessMode") > **accessMode**: `number` Defined in: [packages/sdk/src/types/generated/member.ts:545](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L545) *** ### folderId[​](#folderid "Direct link to folderId") > **folderId**: `number` Defined in: [packages/sdk/src/types/generated/member.ts:544](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L544) --- # Interface: MemberRoleFormData Defined in: [packages/sdk/src/types/member-types.ts:314](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L314) ## Properties[​](#properties "Direct link to Properties") ### calendarAccess?[​](#calendaraccess "Direct link to calendarAccess?") > `optional` **calendarAccess**: [`MemberRoleCalendarAccessResponse`](https://docs.gravityrail.com/sdk/interfaces/MemberRoleCalendarAccessResponse.md)\[] Defined in: [packages/sdk/src/types/member-types.ts:324](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L324) *** ### dataTypeAccess?[​](#datatypeaccess "Direct link to dataTypeAccess?") > `optional` **dataTypeAccess**: [`MemberRoleDataTypeAccessResponse`](https://docs.gravityrail.com/sdk/interfaces/MemberRoleDataTypeAccessResponse.md)\[] Defined in: [packages/sdk/src/types/member-types.ts:319](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L319) *** ### fileAccess?[​](#fileaccess "Direct link to fileAccess?") > `optional` **fileAccess**: [`MemberRoleFileAccessResponse`](https://docs.gravityrail.com/sdk/interfaces/MemberRoleFileAccessResponse.md)\[] Defined in: [packages/sdk/src/types/member-types.ts:322](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L322) *** ### folderAccess?[​](#folderaccess "Direct link to folderAccess?") > `optional` **folderAccess**: [`MemberRoleFolderAccessResponse`](https://docs.gravityrail.com/sdk/interfaces/MemberRoleFolderAccessResponse.md)\[] Defined in: [packages/sdk/src/types/member-types.ts:323](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L323) *** ### grantedScopes?[​](#grantedscopes "Direct link to grantedScopes?") > `optional` **grantedScopes**: `string`\[] Defined in: [packages/sdk/src/types/member-types.ts:316](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L316) *** ### inboxAccess?[​](#inboxaccess "Direct link to inboxAccess?") > `optional` **inboxAccess**: [`MemberRoleInboxAccessResponse`](https://docs.gravityrail.com/sdk/interfaces/MemberRoleInboxAccessResponse.md)\[] Defined in: [packages/sdk/src/types/member-types.ts:321](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L321) *** ### name?[​](#name "Direct link to name?") > `optional` **name**: `string` Defined in: [packages/sdk/src/types/member-types.ts:315](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L315) *** ### siteAccess?[​](#siteaccess "Direct link to siteAccess?") > `optional` **siteAccess**: [`MemberRoleSiteAccessResponse`](https://docs.gravityrail.com/sdk/interfaces/MemberRoleSiteAccessResponse.md)\[] Defined in: [packages/sdk/src/types/member-types.ts:318](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L318) *** ### taskAccess?[​](#taskaccess "Direct link to taskAccess?") > `optional` **taskAccess**: [`MemberRoleTaskAccess`](https://docs.gravityrail.com/sdk/interfaces/MemberRoleTaskAccess.md)\[] Defined in: [packages/sdk/src/types/member-types.ts:317](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L317) *** ### workflowAccess?[​](#workflowaccess "Direct link to workflowAccess?") > `optional` **workflowAccess**: [`MemberRoleWorkflowAccessResponse`](https://docs.gravityrail.com/sdk/interfaces/MemberRoleWorkflowAccessResponse.md)\[] Defined in: [packages/sdk/src/types/member-types.ts:320](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L320) --- # Interface: MemberRoleInboxAccessResponse Defined in: [packages/sdk/src/types/generated/member.ts:551](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L551) Response model for inbox access within a member role. ## Properties[​](#properties "Direct link to Properties") ### accessMode[​](#accessmode "Direct link to accessMode") > **accessMode**: `number` Defined in: [packages/sdk/src/types/generated/member.ts:553](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L553) *** ### inboxId[​](#inboxid "Direct link to inboxId") > **inboxId**: `number` Defined in: [packages/sdk/src/types/generated/member.ts:552](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L552) --- # Interface: MemberRoleInboxRelation Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:146](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L146) ## Properties[​](#properties "Direct link to Properties") ### accessMode[​](#accessmode "Direct link to accessMode") > **accessMode**: `number` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:149](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L149) *** ### inboxUuid[​](#inboxuuid "Direct link to inboxUuid") > **inboxUuid**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:148](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L148) *** ### memberRoleUuid[​](#memberroleuuid "Direct link to memberRoleUuid") > **memberRoleUuid**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:147](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L147) --- # Interface: MemberRoleResponse Defined in: [packages/sdk/src/types/generated/member.ts:559](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L559) Response model for member role endpoints. ## Properties[​](#properties "Direct link to Properties") ### calendarAccess?[​](#calendaraccess "Direct link to calendarAccess?") > `optional` **calendarAccess**: [`MemberRoleCalendarAccessResponse`](https://docs.gravityrail.com/sdk/interfaces/MemberRoleCalendarAccessResponse.md)\[] Defined in: [packages/sdk/src/types/generated/member.ts:570](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L570) *** ### createdAt[​](#createdat "Direct link to createdAt") > **createdAt**: `string` Defined in: [packages/sdk/src/types/generated/member.ts:572](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L572) *** ### dataTypeAccess?[​](#datatypeaccess "Direct link to dataTypeAccess?") > `optional` **dataTypeAccess**: [`MemberRoleDataTypeAccessResponse`](https://docs.gravityrail.com/sdk/interfaces/MemberRoleDataTypeAccessResponse.md)\[] Defined in: [packages/sdk/src/types/generated/member.ts:565](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L565) *** ### fileAccess?[​](#fileaccess "Direct link to fileAccess?") > `optional` **fileAccess**: [`MemberRoleFileAccessResponse`](https://docs.gravityrail.com/sdk/interfaces/MemberRoleFileAccessResponse.md)\[] Defined in: [packages/sdk/src/types/generated/member.ts:568](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L568) *** ### folderAccess?[​](#folderaccess "Direct link to folderAccess?") > `optional` **folderAccess**: [`MemberRoleFolderAccessResponse`](https://docs.gravityrail.com/sdk/interfaces/MemberRoleFolderAccessResponse.md)\[] Defined in: [packages/sdk/src/types/generated/member.ts:569](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L569) *** ### grantedScopes?[​](#grantedscopes "Direct link to grantedScopes?") > `optional` **grantedScopes**: `string`\[] Defined in: [packages/sdk/src/types/generated/member.ts:563](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L563) *** ### id[​](#id "Direct link to id") > **id**: `number` Defined in: [packages/sdk/src/types/generated/member.ts:560](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L560) *** ### inboxAccess?[​](#inboxaccess "Direct link to inboxAccess?") > `optional` **inboxAccess**: [`MemberRoleInboxAccessResponse`](https://docs.gravityrail.com/sdk/interfaces/MemberRoleInboxAccessResponse.md)\[] Defined in: [packages/sdk/src/types/generated/member.ts:567](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L567) *** ### memberCount?[​](#membercount "Direct link to memberCount?") > `optional` **memberCount**: `number` Defined in: [packages/sdk/src/types/generated/member.ts:571](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L571) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/generated/member.ts:562](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L562) *** ### siteAccess?[​](#siteaccess "Direct link to siteAccess?") > `optional` **siteAccess**: [`MemberRoleSiteAccessResponse`](https://docs.gravityrail.com/sdk/interfaces/MemberRoleSiteAccessResponse.md)\[] Defined in: [packages/sdk/src/types/generated/member.ts:564](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L564) *** ### updatedAt[​](#updatedat "Direct link to updatedAt") > **updatedAt**: `string` Defined in: [packages/sdk/src/types/generated/member.ts:573](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L573) *** ### uuid[​](#uuid "Direct link to uuid") > **uuid**: `string` Defined in: [packages/sdk/src/types/generated/member.ts:561](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L561) *** ### workflowAccess?[​](#workflowaccess "Direct link to workflowAccess?") > `optional` **workflowAccess**: [`MemberRoleWorkflowAccessResponse`](https://docs.gravityrail.com/sdk/interfaces/MemberRoleWorkflowAccessResponse.md)\[] Defined in: [packages/sdk/src/types/generated/member.ts:566](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L566) --- # Interface: MemberRoleSiteAccessResponse Defined in: [packages/sdk/src/types/generated/member.ts:579](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L579) Response model for site access within a member role. ## Properties[​](#properties "Direct link to Properties") ### accessMode[​](#accessmode "Direct link to accessMode") > **accessMode**: `number` Defined in: [packages/sdk/src/types/generated/member.ts:581](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L581) *** ### siteId[​](#siteid "Direct link to siteId") > **siteId**: `number` Defined in: [packages/sdk/src/types/generated/member.ts:580](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L580) --- # Interface: MemberRoleSiteRelation Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:140](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L140) ## Properties[​](#properties "Direct link to Properties") ### accessMode[​](#accessmode "Direct link to accessMode") > **accessMode**: `number` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:143](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L143) *** ### memberRoleUuid[​](#memberroleuuid "Direct link to memberRoleUuid") > **memberRoleUuid**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:141](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L141) *** ### siteUuid[​](#siteuuid "Direct link to siteUuid") > **siteUuid**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:142](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L142) --- # Interface: MemberRoleTaskAccess Defined in: [packages/sdk/src/types/member-types.ts:308](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L308) ## Properties[​](#properties "Direct link to Properties") ### accessMode[​](#accessmode "Direct link to accessMode") > **accessMode**: `number` Defined in: [packages/sdk/src/types/member-types.ts:310](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L310) *** ### taskId[​](#taskid "Direct link to taskId") > **taskId**: `number` Defined in: [packages/sdk/src/types/member-types.ts:309](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L309) --- # Interface: MemberRoleTaskRelation Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:128](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L128) ## Properties[​](#properties "Direct link to Properties") ### accessMode[​](#accessmode "Direct link to accessMode") > **accessMode**: `number` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:131](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L131) *** ### memberRoleUuid[​](#memberroleuuid "Direct link to memberRoleUuid") > **memberRoleUuid**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:129](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L129) *** ### taskUuid[​](#taskuuid "Direct link to taskUuid") > **taskUuid**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:130](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L130) --- # Interface: MemberRoleWorkflowAccessResponse Defined in: [packages/sdk/src/types/generated/member.ts:587](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L587) Response model for workflow access within a member role. ## Properties[​](#properties "Direct link to Properties") ### accessMode[​](#accessmode "Direct link to accessMode") > **accessMode**: `number` Defined in: [packages/sdk/src/types/generated/member.ts:589](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L589) *** ### workflowId[​](#workflowid "Direct link to workflowId") > **workflowId**: `number` Defined in: [packages/sdk/src/types/generated/member.ts:588](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L588) --- # Interface: MembersQueryParams Defined in: [packages/sdk/src/types/member-types.ts:423](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L423) ## Properties[​](#properties "Direct link to Properties") ### hasAccount?[​](#hasaccount "Direct link to hasAccount?") > `optional` **hasAccount**: `boolean` Defined in: [packages/sdk/src/types/member-types.ts:432](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L432) *** ### labelIds?[​](#labelids "Direct link to labelIds?") > `optional` **labelIds**: `number`\[] Defined in: [packages/sdk/src/types/member-types.ts:429](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L429) *** ### memberRoleId?[​](#memberroleid "Direct link to memberRoleId?") > `optional` **memberRoleId**: `number` Defined in: [packages/sdk/src/types/member-types.ts:430](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L430) *** ### memberType?[​](#membertype "Direct link to memberType?") > `optional` **memberType**: `string` Defined in: [packages/sdk/src/types/member-types.ts:431](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L431) *** ### page?[​](#page "Direct link to page?") > `optional` **page**: `number` Defined in: [packages/sdk/src/types/member-types.ts:424](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L424) *** ### pageSize?[​](#pagesize "Direct link to pageSize?") > `optional` **pageSize**: `number` Defined in: [packages/sdk/src/types/member-types.ts:425](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L425) *** ### search?[​](#search "Direct link to search?") > `optional` **search**: `string` Defined in: [packages/sdk/src/types/member-types.ts:428](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L428) *** ### sortBy?[​](#sortby "Direct link to sortBy?") > `optional` **sortBy**: [`MemberSortField`](https://docs.gravityrail.com/sdk/type-aliases/MemberSortField.md) Defined in: [packages/sdk/src/types/member-types.ts:426](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L426) *** ### sortOrder?[​](#sortorder "Direct link to sortOrder?") > `optional` **sortOrder**: [`SortOrder`](https://docs.gravityrail.com/sdk/type-aliases/SortOrder.md) Defined in: [packages/sdk/src/types/member-types.ts:427](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L427) --- # Interface: MemberSummary Defined in: [packages/sdk/src/types/generated/routine.ts:35](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/routine.ts#L35) Summary of member information for inclusion in routine runs. ## Properties[​](#properties "Direct link to Properties") ### id[​](#id "Direct link to id") > **id**: `number` Defined in: [packages/sdk/src/types/generated/routine.ts:36](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/routine.ts#L36) *** ### name?[​](#name "Direct link to name?") > `optional` **name**: `string` | `null` Defined in: [packages/sdk/src/types/generated/routine.ts:37](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/routine.ts#L37) --- # Interface: MemberSyncLink Defined in: [packages/sdk/src/types/member-types.ts:502](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L502) ## Properties[​](#properties "Direct link to Properties") ### connectionId[​](#connectionid "Direct link to connectionId") > **connectionId**: `number` Defined in: [packages/sdk/src/types/member-types.ts:504](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L504) *** ### connectionName[​](#connectionname "Direct link to connectionName") > **connectionName**: `string` Defined in: [packages/sdk/src/types/member-types.ts:505](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L505) *** ### connectionType[​](#connectiontype "Direct link to connectionType") > **connectionType**: `string` Defined in: [packages/sdk/src/types/member-types.ts:506](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L506) *** ### createdAt[​](#createdat "Direct link to createdAt") > **createdAt**: `string` Defined in: [packages/sdk/src/types/member-types.ts:515](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L515) *** ### entityType[​](#entitytype "Direct link to entityType") > **entityType**: `string` Defined in: [packages/sdk/src/types/member-types.ts:507](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L507) *** ### id[​](#id "Direct link to id") > **id**: `number` Defined in: [packages/sdk/src/types/member-types.ts:503](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L503) *** ### lastError[​](#lasterror "Direct link to lastError") > **lastError**: `string` | `null` Defined in: [packages/sdk/src/types/member-types.ts:512](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L512) *** ### lastSyncDirection[​](#lastsyncdirection "Direct link to lastSyncDirection") > **lastSyncDirection**: `string` | `null` Defined in: [packages/sdk/src/types/member-types.ts:510](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L510) *** ### lastSyncedAt[​](#lastsyncedat "Direct link to lastSyncedAt") > **lastSyncedAt**: `string` | `null` Defined in: [packages/sdk/src/types/member-types.ts:509](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L509) *** ### lastSyncStatus[​](#lastsyncstatus "Direct link to lastSyncStatus") > **lastSyncStatus**: `string` | `null` Defined in: [packages/sdk/src/types/member-types.ts:511](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L511) *** ### propertiesSynced[​](#propertiessynced "Direct link to propertiesSynced") > **propertiesSynced**: `number` Defined in: [packages/sdk/src/types/member-types.ts:513](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L513) *** ### remoteId[​](#remoteid "Direct link to remoteId") > **remoteId**: `string` Defined in: [packages/sdk/src/types/member-types.ts:508](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L508) *** ### syncCount[​](#synccount "Direct link to syncCount") > **syncCount**: `number` Defined in: [packages/sdk/src/types/member-types.ts:514](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L514) --- # Interface: MemberUpsertActionParams Defined in: [packages/sdk/src/types/event-types.ts:200](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L200) ## Properties[​](#properties "Direct link to Properties") ### behavior?[​](#behavior "Direct link to behavior?") > `optional` **behavior**: [`MemberUpsertBehavior`](https://docs.gravityrail.com/sdk/type-aliases/MemberUpsertBehavior.md) Defined in: [packages/sdk/src/types/event-types.ts:202](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L202) Controls create/update behavior: 'upsert' (default), 'create\_only', or 'update\_only' *** ### skipIfExists?[​](#skipifexists "Direct link to skipIfExists?") > `optional` **skipIfExists**: `boolean` Defined in: [packages/sdk/src/types/event-types.ts:204](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L204) If true and member exists, skip instead of failing (only for create\_only) *** ### skipIfNotFound?[​](#skipifnotfound "Direct link to skipIfNotFound?") > `optional` **skipIfNotFound**: `boolean` Defined in: [packages/sdk/src/types/event-types.ts:206](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L206) If true and member not found, skip instead of failing (only for update\_only) --- # Interface: MemberUsageReport Defined in: [packages/sdk/src/types/usage-reporting-types.ts:64](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/usage-reporting-types.ts#L64) ## Properties[​](#properties "Direct link to Properties") ### memberId[​](#memberid "Direct link to memberId") > **memberId**: `number` Defined in: [packages/sdk/src/types/usage-reporting-types.ts:65](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/usage-reporting-types.ts#L65) *** ### periodEnd[​](#periodend "Direct link to periodEnd") > **periodEnd**: `string` Defined in: [packages/sdk/src/types/usage-reporting-types.ts:67](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/usage-reporting-types.ts#L67) *** ### periodStart[​](#periodstart "Direct link to periodStart") > **periodStart**: `string` Defined in: [packages/sdk/src/types/usage-reporting-types.ts:66](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/usage-reporting-types.ts#L66) *** ### totalChats[​](#totalchats "Direct link to totalChats") > **totalChats**: `number` Defined in: [packages/sdk/src/types/usage-reporting-types.ts:68](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/usage-reporting-types.ts#L68) *** ### totalCredits[​](#totalcredits "Direct link to totalCredits") > **totalCredits**: `number` Defined in: [packages/sdk/src/types/usage-reporting-types.ts:70](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/usage-reporting-types.ts#L70) *** ### totalMessages[​](#totalmessages "Direct link to totalMessages") > **totalMessages**: `number` Defined in: [packages/sdk/src/types/usage-reporting-types.ts:69](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/usage-reporting-types.ts#L69) --- # Interface: MemberWorkspaceInfo Defined in: [packages/sdk/src/types/account-types.ts:252](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L252) Workspace info for member view ## Properties[​](#properties "Direct link to Properties") ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/account-types.ts:254](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L254) *** ### slug[​](#slug "Direct link to slug") > **slug**: `string` Defined in: [packages/sdk/src/types/account-types.ts:255](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L255) *** ### uuid[​](#uuid "Direct link to uuid") > **uuid**: `string` Defined in: [packages/sdk/src/types/account-types.ts:253](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L253) --- # Interface: MenuItemExport Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:168](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L168) ## Properties[​](#properties "Direct link to Properties") ### cssClass?[​](#cssclass "Direct link to cssClass?") > `optional` **cssClass**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:179](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L179) *** ### icon?[​](#icon "Direct link to icon?") > `optional` **icon**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:177](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L177) *** ### isActive[​](#isactive "Direct link to isActive") > **isActive**: `boolean` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:180](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L180) *** ### itemType[​](#itemtype "Direct link to itemType") > **itemType**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:172](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L172) *** ### label[​](#label "Direct link to label") > **label**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:171](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L171) *** ### pageUuid?[​](#pageuuid "Direct link to pageUuid?") > `optional` **pageUuid**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:173](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L173) *** ### parentUuid?[​](#parentuuid "Direct link to parentUuid?") > `optional` **parentUuid**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:175](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L175) *** ### position[​](#position "Direct link to position") > **position**: `number` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:176](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L176) *** ### siteUuid[​](#siteuuid "Direct link to siteUuid") > **siteUuid**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:170](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L170) *** ### target?[​](#target "Direct link to target?") > `optional` **target**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:178](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L178) *** ### url?[​](#url "Direct link to url?") > `optional` **url**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:174](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L174) *** ### uuid[​](#uuid "Direct link to uuid") > **uuid**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:169](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L169) --- # Interface: MenuItemFormData Defined in: [packages/sdk/src/types/site-types.ts:104](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/site-types.ts#L104) ## Properties[​](#properties "Direct link to Properties") ### cssClass?[​](#cssclass "Direct link to cssClass?") > `optional` **cssClass**: `string` | `null` Defined in: [packages/sdk/src/types/site-types.ts:112](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/site-types.ts#L112) *** ### icon?[​](#icon "Direct link to icon?") > `optional` **icon**: `string` | `null` Defined in: [packages/sdk/src/types/site-types.ts:111](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/site-types.ts#L111) *** ### isActive?[​](#isactive "Direct link to isActive?") > `optional` **isActive**: `boolean` Defined in: [packages/sdk/src/types/site-types.ts:114](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/site-types.ts#L114) *** ### itemType[​](#itemtype "Direct link to itemType") > **itemType**: [`MenuItemResponseItemType`](https://docs.gravityrail.com/sdk/type-aliases/MenuItemResponseItemType.md) Defined in: [packages/sdk/src/types/site-types.ts:106](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/site-types.ts#L106) *** ### label[​](#label "Direct link to label") > **label**: `string` Defined in: [packages/sdk/src/types/site-types.ts:105](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/site-types.ts#L105) *** ### pageId?[​](#pageid "Direct link to pageId?") > `optional` **pageId**: `number` | `null` Defined in: [packages/sdk/src/types/site-types.ts:107](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/site-types.ts#L107) *** ### parentId?[​](#parentid "Direct link to parentId?") > `optional` **parentId**: `number` | `null` Defined in: [packages/sdk/src/types/site-types.ts:109](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/site-types.ts#L109) *** ### position?[​](#position "Direct link to position?") > `optional` **position**: `number` Defined in: [packages/sdk/src/types/site-types.ts:110](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/site-types.ts#L110) *** ### target?[​](#target "Direct link to target?") > `optional` **target**: `string` | `null` Defined in: [packages/sdk/src/types/site-types.ts:113](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/site-types.ts#L113) *** ### translations?[​](#translations "Direct link to translations?") > `optional` **translations**: `Record`<`string`, `string`> | `null` Defined in: [packages/sdk/src/types/site-types.ts:115](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/site-types.ts#L115) *** ### url?[​](#url "Direct link to url?") > `optional` **url**: `string` | `null` Defined in: [packages/sdk/src/types/site-types.ts:108](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/site-types.ts#L108) --- # Interface: MenuItemResponse Defined in: [packages/sdk/src/types/generated/site.ts:69](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L69) Response model for a menu item. ## Properties[​](#properties "Direct link to Properties") ### children?[​](#children "Direct link to children?") > `optional` **children**: `MenuItemResponse`\[] Defined in: [packages/sdk/src/types/generated/site.ts:87](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L87) *** ### createdAt[​](#createdat "Direct link to createdAt") > **createdAt**: `string` Defined in: [packages/sdk/src/types/generated/site.ts:85](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L85) *** ### cssClass?[​](#cssclass "Direct link to cssClass?") > `optional` **cssClass**: `string` | `null` Defined in: [packages/sdk/src/types/generated/site.ts:81](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L81) *** ### icon?[​](#icon "Direct link to icon?") > `optional` **icon**: `string` | `null` Defined in: [packages/sdk/src/types/generated/site.ts:80](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L80) *** ### id[​](#id "Direct link to id") > **id**: `number` Defined in: [packages/sdk/src/types/generated/site.ts:70](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L70) *** ### isActive?[​](#isactive "Direct link to isActive?") > `optional` **isActive**: `boolean` Defined in: [packages/sdk/src/types/generated/site.ts:83](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L83) *** ### itemType[​](#itemtype "Direct link to itemType") > **itemType**: [`MenuItemResponseItemType`](https://docs.gravityrail.com/sdk/type-aliases/MenuItemResponseItemType.md) Defined in: [packages/sdk/src/types/generated/site.ts:73](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L73) *** ### label[​](#label "Direct link to label") > **label**: `string` Defined in: [packages/sdk/src/types/generated/site.ts:72](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L72) *** ### pageId?[​](#pageid "Direct link to pageId?") > `optional` **pageId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/site.ts:74](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L74) *** ### pageSlug?[​](#pageslug "Direct link to pageSlug?") > `optional` **pageSlug**: `string` | `null` Defined in: [packages/sdk/src/types/generated/site.ts:75](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L75) *** ### pageTitle?[​](#pagetitle "Direct link to pageTitle?") > `optional` **pageTitle**: `string` | `null` Defined in: [packages/sdk/src/types/generated/site.ts:76](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L76) *** ### parentId?[​](#parentid "Direct link to parentId?") > `optional` **parentId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/site.ts:78](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L78) *** ### position[​](#position "Direct link to position") > **position**: `number` Defined in: [packages/sdk/src/types/generated/site.ts:79](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L79) *** ### siteId[​](#siteid "Direct link to siteId") > **siteId**: `number` Defined in: [packages/sdk/src/types/generated/site.ts:71](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L71) *** ### target?[​](#target "Direct link to target?") > `optional` **target**: `string` | `null` Defined in: [packages/sdk/src/types/generated/site.ts:82](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L82) *** ### translations?[​](#translations "Direct link to translations?") > `optional` **translations**: `MenuItemResponseTranslations` Defined in: [packages/sdk/src/types/generated/site.ts:84](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L84) *** ### updatedAt[​](#updatedat "Direct link to updatedAt") > **updatedAt**: `string` Defined in: [packages/sdk/src/types/generated/site.ts:86](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L86) *** ### url?[​](#url "Direct link to url?") > `optional` **url**: `string` | `null` Defined in: [packages/sdk/src/types/generated/site.ts:77](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L77) --- # Interface: MenuTreeResponse Defined in: [packages/sdk/src/types/generated/site.ts:105](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L105) Response model for the complete menu tree of a site. ## Properties[​](#properties "Direct link to Properties") ### items?[​](#items "Direct link to items?") > `optional` **items**: [`MenuItemResponse`](https://docs.gravityrail.com/sdk/interfaces/MenuItemResponse.md)\[] Defined in: [packages/sdk/src/types/generated/site.ts:107](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L107) *** ### siteId[​](#siteid "Direct link to siteId") > **siteId**: `number` Defined in: [packages/sdk/src/types/generated/site.ts:106](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L106) --- # Interface: MergeMembersRequest Defined in: [packages/sdk/src/types/member-types.ts:394](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L394) ## Properties[​](#properties "Direct link to Properties") ### sourceMemberIds[​](#sourcememberids "Direct link to sourceMemberIds") > **sourceMemberIds**: `number`\[] Defined in: [packages/sdk/src/types/member-types.ts:396](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L396) *** ### targetMemberId[​](#targetmemberid "Direct link to targetMemberId") > **targetMemberId**: `number` Defined in: [packages/sdk/src/types/member-types.ts:395](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L395) --- # Interface: MergeMembersResponse Defined in: [packages/sdk/src/types/generated/member.ts:612](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L612) Response for merge members operation. ## Properties[​](#properties "Direct link to Properties") ### dataRecordsTransferred[​](#datarecordstransferred "Direct link to dataRecordsTransferred") > **dataRecordsTransferred**: `number` Defined in: [packages/sdk/src/types/generated/member.ts:615](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L615) *** ### member[​](#member "Direct link to member") > **member**: [`WorkspaceMemberResponse`](https://docs.gravityrail.com/sdk/interfaces/WorkspaceMemberResponse.md) Defined in: [packages/sdk/src/types/generated/member.ts:613](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L613) *** ### mergedCount[​](#mergedcount "Direct link to mergedCount") > **mergedCount**: `number` Defined in: [packages/sdk/src/types/generated/member.ts:614](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L614) --- # Interface: MessageTimingResponse Defined in: [packages/sdk/src/types/generated/communication.ts:285](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L285) ## Properties[​](#properties "Direct link to Properties") ### anchorTimeIso[​](#anchortimeiso "Direct link to anchorTimeIso") > **anchorTimeIso**: `string` Defined in: [packages/sdk/src/types/generated/communication.ts:286](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L286) *** ### durationMs[​](#durationms "Direct link to durationMs") > **durationMs**: `number` Defined in: [packages/sdk/src/types/generated/communication.ts:287](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L287) *** ### messages[​](#messages "Direct link to messages") > **messages**: `MessageTimingResponseMessages` Defined in: [packages/sdk/src/types/generated/communication.ts:288](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L288) --- # Interface: MessageTokenUsageResponse Defined in: [packages/sdk/src/types/generated/chat.ts:356](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L356) Token usage for a single message. ## Properties[​](#properties "Direct link to Properties") ### cachedTokens?[​](#cachedtokens "Direct link to cachedTokens?") > `optional` **cachedTokens**: `number` Defined in: [packages/sdk/src/types/generated/chat.ts:361](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L361) *** ### completionTokens[​](#completiontokens "Direct link to completionTokens") > **completionTokens**: `number` Defined in: [packages/sdk/src/types/generated/chat.ts:359](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L359) *** ### credits?[​](#credits "Direct link to credits?") > `optional` **credits**: `number` Defined in: [packages/sdk/src/types/generated/chat.ts:362](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L362) *** ### model[​](#model "Direct link to model") > **model**: `string` Defined in: [packages/sdk/src/types/generated/chat.ts:357](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L357) *** ### promptTokens[​](#prompttokens "Direct link to promptTokens") > **promptTokens**: `number` Defined in: [packages/sdk/src/types/generated/chat.ts:358](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L358) *** ### totalTokens[​](#totaltokens "Direct link to totalTokens") > **totalTokens**: `number` Defined in: [packages/sdk/src/types/generated/chat.ts:360](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L360) --- # Interface: MessageValidationActionParams Defined in: [packages/sdk/src/types/event-types.ts:267](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L267) ## Properties[​](#properties "Direct link to Properties") ### condition?[​](#condition "Direct link to condition?") > `optional` **condition**: `string` Defined in: [packages/sdk/src/types/event-types.ts:268](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L268) *** ### reason?[​](#reason "Direct link to reason?") > `optional` **reason**: `string` Defined in: [packages/sdk/src/types/event-types.ts:269](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L269) --- # Interface: MetricDataPoint Defined in: [packages/sdk/src/types/generated/voice\_metrics.ts:25](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/voice_metrics.ts#L25) ## Properties[​](#properties "Direct link to Properties") ### timestamp[​](#timestamp "Direct link to timestamp") > **timestamp**: `string` Defined in: [packages/sdk/src/types/generated/voice\_metrics.ts:26](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/voice_metrics.ts#L26) *** ### value[​](#value "Direct link to value") > **value**: `number` Defined in: [packages/sdk/src/types/generated/voice\_metrics.ts:27](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/voice_metrics.ts#L27) --- # Interface: MetricValue Defined in: [packages/sdk/src/types/stats-types.ts:21](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/stats-types.ts#L21) ## Properties[​](#properties "Direct link to Properties") ### change?[​](#change "Direct link to change?") > `optional` **change**: `number` Defined in: [packages/sdk/src/types/stats-types.ts:24](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/stats-types.ts#L24) *** ### changeType?[​](#changetype "Direct link to changeType?") > `optional` **changeType**: `"increase"` | `"decrease"` | `"neutral"` Defined in: [packages/sdk/src/types/stats-types.ts:25](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/stats-types.ts#L25) *** ### label[​](#label "Direct link to label") > **label**: `string` Defined in: [packages/sdk/src/types/stats-types.ts:23](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/stats-types.ts#L23) *** ### value[​](#value "Direct link to value") > **value**: `number` Defined in: [packages/sdk/src/types/stats-types.ts:22](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/stats-types.ts#L22) --- # Interface: Milestone Defined in: [packages/sdk/src/types/generated/milestone.ts:47](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/milestone.ts#L47) Response model for milestone data. ## Properties[​](#properties "Direct link to Properties") ### createdAt[​](#createdat "Direct link to createdAt") > **createdAt**: `string` Defined in: [packages/sdk/src/types/generated/milestone.ts:53](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/milestone.ts#L53) *** ### description[​](#description "Direct link to description") > **description**: `string` | `null` Defined in: [packages/sdk/src/types/generated/milestone.ts:50](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/milestone.ts#L50) *** ### goals[​](#goals "Direct link to goals") > **goals**: [`GeneratedMilestoneGoalResponse`](https://docs.gravityrail.com/sdk/interfaces/GeneratedMilestoneGoalResponse.md)\[] Defined in: [packages/sdk/src/types/generated/milestone.ts:52](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/milestone.ts#L52) *** ### id[​](#id "Direct link to id") > **id**: `number` Defined in: [packages/sdk/src/types/generated/milestone.ts:48](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/milestone.ts#L48) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/generated/milestone.ts:49](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/milestone.ts#L49) *** ### targetDate[​](#targetdate "Direct link to targetDate") > **targetDate**: `string` Defined in: [packages/sdk/src/types/generated/milestone.ts:51](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/milestone.ts#L51) *** ### updatedAt[​](#updatedat "Direct link to updatedAt") > **updatedAt**: `string` Defined in: [packages/sdk/src/types/generated/milestone.ts:54](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/milestone.ts#L54) --- # Interface: MilestoneAnalytics Defined in: [packages/sdk/src/types/milestone-types.ts:75](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/milestone-types.ts#L75) ## Properties[​](#properties "Direct link to Properties") ### averageCompletionTime[​](#averagecompletiontime "Direct link to averageCompletionTime") > **averageCompletionTime**: `number` Defined in: [packages/sdk/src/types/milestone-types.ts:80](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/milestone-types.ts#L80) *** ### completedMilestones[​](#completedmilestones "Direct link to completedMilestones") > **completedMilestones**: `number` Defined in: [packages/sdk/src/types/milestone-types.ts:77](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/milestone-types.ts#L77) *** ### completionRate[​](#completionrate "Direct link to completionRate") > **completionRate**: `number` Defined in: [packages/sdk/src/types/milestone-types.ts:81](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/milestone-types.ts#L81) *** ### overdueMilestones[​](#overduemilestones "Direct link to overdueMilestones") > **overdueMilestones**: `number` Defined in: [packages/sdk/src/types/milestone-types.ts:78](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/milestone-types.ts#L78) *** ### totalMilestones[​](#totalmilestones "Direct link to totalMilestones") > **totalMilestones**: `number` Defined in: [packages/sdk/src/types/milestone-types.ts:76](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/milestone-types.ts#L76) *** ### upcomingMilestones[​](#upcomingmilestones "Direct link to upcomingMilestones") > **upcomingMilestones**: `number` Defined in: [packages/sdk/src/types/milestone-types.ts:79](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/milestone-types.ts#L79) --- # Interface: MilestoneCreateRequest Defined in: [packages/sdk/src/types/milestone-types.ts:63](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/milestone-types.ts#L63) ## Properties[​](#properties "Direct link to Properties") ### description?[​](#description "Direct link to description?") > `optional` **description**: `string` Defined in: [packages/sdk/src/types/milestone-types.ts:65](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/milestone-types.ts#L65) *** ### goals[​](#goals "Direct link to goals") > **goals**: `object`\[] Defined in: [packages/sdk/src/types/milestone-types.ts:67](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/milestone-types.ts#L67) #### description?[​](#description-1 "Direct link to description?") > `optional` **description**: `string` #### id?[​](#id "Direct link to id?") > `optional` **id**: `number` #### memberFilterId[​](#memberfilterid "Direct link to memberFilterId") > **memberFilterId**: `number` #### name[​](#name "Direct link to name") > **name**: `string` #### value?[​](#value "Direct link to value?") > `optional` **value**: `number` *** ### name[​](#name-1 "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/milestone-types.ts:64](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/milestone-types.ts#L64) *** ### targetDate[​](#targetdate "Direct link to targetDate") > **targetDate**: `string` Defined in: [packages/sdk/src/types/milestone-types.ts:66](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/milestone-types.ts#L66) --- # Interface: MilestoneDeleteResponse Defined in: [packages/sdk/src/types/milestone-types.ts:70](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/milestone-types.ts#L70) ## Properties[​](#properties "Direct link to Properties") ### message?[​](#message "Direct link to message?") > `optional` **message**: `string` Defined in: [packages/sdk/src/types/milestone-types.ts:72](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/milestone-types.ts#L72) *** ### success[​](#success "Direct link to success") > **success**: `boolean` Defined in: [packages/sdk/src/types/milestone-types.ts:71](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/milestone-types.ts#L71) --- # Interface: MilestoneExport Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:245](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L245) ## Properties[​](#properties "Direct link to Properties") ### description?[​](#description "Direct link to description?") > `optional` **description**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:248](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L248) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:247](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L247) *** ### targetDate[​](#targetdate "Direct link to targetDate") > **targetDate**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:249](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L249) *** ### uuid[​](#uuid "Direct link to uuid") > **uuid**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:246](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L246) --- # Interface: MilestoneGoalExport Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:252](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L252) ## Properties[​](#properties "Direct link to Properties") ### milestoneUuid[​](#milestoneuuid "Direct link to milestoneUuid") > **milestoneUuid**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:254](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L254) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:255](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L255) *** ### uuid[​](#uuid "Direct link to uuid") > **uuid**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:253](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L253) *** ### value[​](#value "Direct link to value") > **value**: `number` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:256](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L256) --- # Interface: MilestoneGoalProgress Defined in: [packages/sdk/src/types/milestone-types.ts:36](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/milestone-types.ts#L36) ## Properties[​](#properties "Direct link to Properties") ### completionPercentage[​](#completionpercentage "Direct link to completionPercentage") > **completionPercentage**: `number` Defined in: [packages/sdk/src/types/milestone-types.ts:41](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/milestone-types.ts#L41) *** ### currentValue[​](#currentvalue "Direct link to currentValue") > **currentValue**: `number` Defined in: [packages/sdk/src/types/milestone-types.ts:40](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/milestone-types.ts#L40) *** ### goalId[​](#goalid "Direct link to goalId") > **goalId**: `number` Defined in: [packages/sdk/src/types/milestone-types.ts:37](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/milestone-types.ts#L37) *** ### goalName[​](#goalname "Direct link to goalName") > **goalName**: `string` Defined in: [packages/sdk/src/types/milestone-types.ts:38](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/milestone-types.ts#L38) *** ### memberFilterId[​](#memberfilterid "Direct link to memberFilterId") > **memberFilterId**: `number` Defined in: [packages/sdk/src/types/milestone-types.ts:42](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/milestone-types.ts#L42) *** ### memberFilterName[​](#memberfiltername "Direct link to memberFilterName") > **memberFilterName**: `string` Defined in: [packages/sdk/src/types/milestone-types.ts:43](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/milestone-types.ts#L43) *** ### targetValue?[​](#targetvalue "Direct link to targetValue?") > `optional` **targetValue**: `number` Defined in: [packages/sdk/src/types/milestone-types.ts:39](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/milestone-types.ts#L39) --- # Interface: MilestoneProgress Defined in: [packages/sdk/src/types/milestone-types.ts:46](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/milestone-types.ts#L46) ## Properties[​](#properties "Direct link to Properties") ### daysRemaining[​](#daysremaining "Direct link to daysRemaining") > **daysRemaining**: `number` Defined in: [packages/sdk/src/types/milestone-types.ts:53](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/milestone-types.ts#L53) *** ### goalProgress[​](#goalprogress "Direct link to goalProgress") > **goalProgress**: [`MilestoneGoalProgress`](https://docs.gravityrail.com/sdk/interfaces/MilestoneGoalProgress.md)\[] Defined in: [packages/sdk/src/types/milestone-types.ts:52](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/milestone-types.ts#L52) *** ### isCompleted[​](#iscompleted "Direct link to isCompleted") > **isCompleted**: `boolean` Defined in: [packages/sdk/src/types/milestone-types.ts:51](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/milestone-types.ts#L51) *** ### milestoneId[​](#milestoneid "Direct link to milestoneId") > **milestoneId**: `number` Defined in: [packages/sdk/src/types/milestone-types.ts:47](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/milestone-types.ts#L47) *** ### milestoneName[​](#milestonename "Direct link to milestoneName") > **milestoneName**: `string` Defined in: [packages/sdk/src/types/milestone-types.ts:48](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/milestone-types.ts#L48) *** ### overallProgress[​](#overallprogress "Direct link to overallProgress") > **overallProgress**: `number` Defined in: [packages/sdk/src/types/milestone-types.ts:50](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/milestone-types.ts#L50) *** ### targetDate[​](#targetdate "Direct link to targetDate") > **targetDate**: `string` Defined in: [packages/sdk/src/types/milestone-types.ts:49](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/milestone-types.ts#L49) --- # Interface: MilestonesQueryParams Defined in: [packages/sdk/src/types/milestone-types.ts:28](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/milestone-types.ts#L28) ## Properties[​](#properties "Direct link to Properties") ### page?[​](#page "Direct link to page?") > `optional` **page**: `number` Defined in: [packages/sdk/src/types/milestone-types.ts:29](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/milestone-types.ts#L29) *** ### pageSize?[​](#pagesize "Direct link to pageSize?") > `optional` **pageSize**: `number` Defined in: [packages/sdk/src/types/milestone-types.ts:30](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/milestone-types.ts#L30) *** ### search?[​](#search "Direct link to search?") > `optional` **search**: `string` Defined in: [packages/sdk/src/types/milestone-types.ts:33](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/milestone-types.ts#L33) *** ### sortBy?[​](#sortby "Direct link to sortBy?") > `optional` **sortBy**: [`MilestoneSortField`](https://docs.gravityrail.com/sdk/type-aliases/MilestoneSortField.md) Defined in: [packages/sdk/src/types/milestone-types.ts:31](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/milestone-types.ts#L31) *** ### sortOrder?[​](#sortorder "Direct link to sortOrder?") > `optional` **sortOrder**: [`SortOrder`](https://docs.gravityrail.com/sdk/type-aliases/SortOrder.md) Defined in: [packages/sdk/src/types/milestone-types.ts:32](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/milestone-types.ts#L32) --- # Interface: MilestoneTimeline Defined in: [packages/sdk/src/types/milestone-types.ts:93](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/milestone-types.ts#L93) ## Properties[​](#properties "Direct link to Properties") ### dateRange[​](#daterange "Direct link to dateRange") > **dateRange**: `object` Defined in: [packages/sdk/src/types/milestone-types.ts:95](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/milestone-types.ts#L95) #### end[​](#end "Direct link to end") > **end**: `string` #### start[​](#start "Direct link to start") > **start**: `string` *** ### items[​](#items "Direct link to items") > **items**: [`MilestoneTimelineItem`](https://docs.gravityrail.com/sdk/interfaces/MilestoneTimelineItem.md)\[] Defined in: [packages/sdk/src/types/milestone-types.ts:94](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/milestone-types.ts#L94) --- # Interface: MilestoneTimelineItem Defined in: [packages/sdk/src/types/milestone-types.ts:84](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/milestone-types.ts#L84) ## Properties[​](#properties "Direct link to Properties") ### completionDate?[​](#completiondate "Direct link to completionDate?") > `optional` **completionDate**: `string` Defined in: [packages/sdk/src/types/milestone-types.ts:88](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/milestone-types.ts#L88) *** ### milestoneId[​](#milestoneid "Direct link to milestoneId") > **milestoneId**: `number` Defined in: [packages/sdk/src/types/milestone-types.ts:85](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/milestone-types.ts#L85) *** ### milestoneName[​](#milestonename "Direct link to milestoneName") > **milestoneName**: `string` Defined in: [packages/sdk/src/types/milestone-types.ts:86](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/milestone-types.ts#L86) *** ### progress[​](#progress "Direct link to progress") > **progress**: `number` Defined in: [packages/sdk/src/types/milestone-types.ts:90](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/milestone-types.ts#L90) *** ### status[​](#status "Direct link to status") > **status**: `"pending"` | `"completed"` | `"overdue"` Defined in: [packages/sdk/src/types/milestone-types.ts:89](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/milestone-types.ts#L89) *** ### targetDate[​](#targetdate "Direct link to targetDate") > **targetDate**: `string` Defined in: [packages/sdk/src/types/milestone-types.ts:87](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/milestone-types.ts#L87) --- # Interface: MilestoneUpdateRequest Defined in: [packages/sdk/src/types/milestone-types.ts:56](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/milestone-types.ts#L56) ## Properties[​](#properties "Direct link to Properties") ### description?[​](#description "Direct link to description?") > `optional` **description**: `string` Defined in: [packages/sdk/src/types/milestone-types.ts:58](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/milestone-types.ts#L58) *** ### goals?[​](#goals "Direct link to goals?") > `optional` **goals**: `object`\[] Defined in: [packages/sdk/src/types/milestone-types.ts:60](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/milestone-types.ts#L60) #### description?[​](#description-1 "Direct link to description?") > `optional` **description**: `string` #### id?[​](#id "Direct link to id?") > `optional` **id**: `number` #### memberFilterId[​](#memberfilterid "Direct link to memberFilterId") > **memberFilterId**: `number` #### name[​](#name "Direct link to name") > **name**: `string` #### value?[​](#value "Direct link to value?") > `optional` **value**: `number` *** ### name?[​](#name-1 "Direct link to name?") > `optional` **name**: `string` Defined in: [packages/sdk/src/types/milestone-types.ts:57](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/milestone-types.ts#L57) *** ### targetDate?[​](#targetdate "Direct link to targetDate?") > `optional` **targetDate**: `string` Defined in: [packages/sdk/src/types/milestone-types.ts:59](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/milestone-types.ts#L59) --- # Interface: MissingMembershipItem Defined in: [packages/sdk/src/types/account-types.ts:392](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L392) ## Properties[​](#properties "Direct link to Properties") ### account\_id[​](#account_id "Direct link to account_id") > **account\_id**: `number` Defined in: [packages/sdk/src/types/account-types.ts:395](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L395) *** ### account\_uuid[​](#account_uuid "Direct link to account_uuid") > **account\_uuid**: `string` Defined in: [packages/sdk/src/types/account-types.ts:396](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L396) *** ### member\_id[​](#member_id "Direct link to member_id") > **member\_id**: `number` Defined in: [packages/sdk/src/types/account-types.ts:393](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L393) *** ### member\_name[​](#member_name "Direct link to member_name") > **member\_name**: `string` Defined in: [packages/sdk/src/types/account-types.ts:394](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L394) --- # Interface: ModelMetadataResponse Defined in: [packages/sdk/src/types/generated/ai\_model.ts:72](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/ai_model.ts#L72) Unified response model for any AI model with full metadata. ## Properties[​](#properties "Direct link to Properties") ### available?[​](#available "Direct link to available?") > `optional` **available**: `boolean` Defined in: [packages/sdk/src/types/generated/ai\_model.ts:79](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/ai_model.ts#L79) *** ### cachedMultiplier?[​](#cachedmultiplier "Direct link to cachedMultiplier?") > `optional` **cachedMultiplier**: `number` | `null` Defined in: [packages/sdk/src/types/generated/ai\_model.ts:85](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/ai_model.ts#L85) *** ### description?[​](#description "Direct link to description?") > `optional` **description**: `string` | `null` Defined in: [packages/sdk/src/types/generated/ai\_model.ts:77](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/ai_model.ts#L77) *** ### id[​](#id "Direct link to id") > **id**: `string` Defined in: [packages/sdk/src/types/generated/ai\_model.ts:73](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/ai_model.ts#L73) *** ### inputMultiplier?[​](#inputmultiplier "Direct link to inputMultiplier?") > `optional` **inputMultiplier**: `number` | `null` Defined in: [packages/sdk/src/types/generated/ai\_model.ts:83](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/ai_model.ts#L83) *** ### multiplier?[​](#multiplier "Direct link to multiplier?") > `optional` **multiplier**: `number` Defined in: [packages/sdk/src/types/generated/ai\_model.ts:82](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/ai_model.ts#L82) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/generated/ai\_model.ts:74](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/ai_model.ts#L74) *** ### outputMultiplier?[​](#outputmultiplier "Direct link to outputMultiplier?") > `optional` **outputMultiplier**: `number` | `null` Defined in: [packages/sdk/src/types/generated/ai\_model.ts:84](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/ai_model.ts#L84) *** ### provider[​](#provider "Direct link to provider") > **provider**: [`ModelProvider`](https://docs.gravityrail.com/sdk/type-aliases/ModelProvider.md) Defined in: [packages/sdk/src/types/generated/ai\_model.ts:75](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/ai_model.ts#L75) *** ### recommended?[​](#recommended "Direct link to recommended?") > `optional` **recommended**: `boolean` Defined in: [packages/sdk/src/types/generated/ai\_model.ts:80](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/ai_model.ts#L80) *** ### replacement?[​](#replacement "Direct link to replacement?") > `optional` **replacement**: `string` | `null` Defined in: [packages/sdk/src/types/generated/ai\_model.ts:81](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/ai_model.ts#L81) *** ### state?[​](#state "Direct link to state?") > `optional` **state**: `string` Defined in: [packages/sdk/src/types/generated/ai\_model.ts:78](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/ai_model.ts#L78) *** ### type[​](#type "Direct link to type") > **type**: [`ModelType`](https://docs.gravityrail.com/sdk/type-aliases/ModelType.md) Defined in: [packages/sdk/src/types/generated/ai\_model.ts:76](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/ai_model.ts#L76) --- # Interface: ModelUsageResponse Defined in: [packages/sdk/src/types/generated/chat.ts:368](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L368) Token and credit usage for a specific model. ## Properties[​](#properties "Direct link to Properties") ### audioInputTokens?[​](#audioinputtokens "Direct link to audioInputTokens?") > `optional` **audioInputTokens**: `number` Defined in: [packages/sdk/src/types/generated/chat.ts:379](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L379) *** ### audioOutputTokens?[​](#audiooutputtokens "Direct link to audioOutputTokens?") > `optional` **audioOutputTokens**: `number` Defined in: [packages/sdk/src/types/generated/chat.ts:380](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L380) *** ### cachedMultiplier?[​](#cachedmultiplier "Direct link to cachedMultiplier?") > `optional` **cachedMultiplier**: `number` Defined in: [packages/sdk/src/types/generated/chat.ts:378](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L378) *** ### cachedTokens?[​](#cachedtokens "Direct link to cachedTokens?") > `optional` **cachedTokens**: `number` Defined in: [packages/sdk/src/types/generated/chat.ts:373](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L373) *** ### completionTokens?[​](#completiontokens "Direct link to completionTokens?") > `optional` **completionTokens**: `number` Defined in: [packages/sdk/src/types/generated/chat.ts:371](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L371) *** ### credits[​](#credits "Direct link to credits") > **credits**: `number` Defined in: [packages/sdk/src/types/generated/chat.ts:374](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L374) *** ### inputMultiplier?[​](#inputmultiplier "Direct link to inputMultiplier?") > `optional` **inputMultiplier**: `number` Defined in: [packages/sdk/src/types/generated/chat.ts:376](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L376) *** ### model[​](#model "Direct link to model") > **model**: `string` Defined in: [packages/sdk/src/types/generated/chat.ts:369](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L369) *** ### multiplier[​](#multiplier "Direct link to multiplier") > **multiplier**: `number` Defined in: [packages/sdk/src/types/generated/chat.ts:375](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L375) *** ### outputMultiplier?[​](#outputmultiplier "Direct link to outputMultiplier?") > `optional` **outputMultiplier**: `number` Defined in: [packages/sdk/src/types/generated/chat.ts:377](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L377) *** ### promptTokens?[​](#prompttokens "Direct link to promptTokens?") > `optional` **promptTokens**: `number` Defined in: [packages/sdk/src/types/generated/chat.ts:370](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L370) *** ### totalTokens[​](#totaltokens "Direct link to totalTokens") > **totalTokens**: `number` Defined in: [packages/sdk/src/types/generated/chat.ts:372](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L372) --- # Interface: ModelUsageStats Defined in: [packages/sdk/src/types/generated/reports.ts:63](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/reports.ts#L63) Usage statistics for a specific AI model. Note: model field accepts str instead of ModelId to support legacy model IDs that may exist in the database (e.g., "gpt-4.1" without provider prefix). ## Properties[​](#properties "Direct link to Properties") ### audioInputTokens?[​](#audioinputtokens "Direct link to audioInputTokens?") > `optional` **audioInputTokens**: `number` Defined in: [packages/sdk/src/types/generated/reports.ts:73](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/reports.ts#L73) *** ### audioOutputTokens?[​](#audiooutputtokens "Direct link to audioOutputTokens?") > `optional` **audioOutputTokens**: `number` Defined in: [packages/sdk/src/types/generated/reports.ts:74](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/reports.ts#L74) *** ### averageTokensPerMessage[​](#averagetokenspermessage "Direct link to averageTokensPerMessage") > **averageTokensPerMessage**: `number` Defined in: [packages/sdk/src/types/generated/reports.ts:75](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/reports.ts#L75) *** ### cachedTokens[​](#cachedtokens "Direct link to cachedTokens") > **cachedTokens**: `number` Defined in: [packages/sdk/src/types/generated/reports.ts:72](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/reports.ts#L72) *** ### chatSummaryCount[​](#chatsummarycount "Direct link to chatSummaryCount") > **chatSummaryCount**: `number` Defined in: [packages/sdk/src/types/generated/reports.ts:68](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/reports.ts#L68) *** ### completionTokens[​](#completiontokens "Direct link to completionTokens") > **completionTokens**: `number` Defined in: [packages/sdk/src/types/generated/reports.ts:70](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/reports.ts#L70) *** ### credits[​](#credits "Direct link to credits") > **credits**: `number` Defined in: [packages/sdk/src/types/generated/reports.ts:76](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/reports.ts#L76) *** ### messageCount[​](#messagecount "Direct link to messageCount") > **messageCount**: `number` Defined in: [packages/sdk/src/types/generated/reports.ts:67](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/reports.ts#L67) *** ### model[​](#model "Direct link to model") > **model**: `string` Defined in: [packages/sdk/src/types/generated/reports.ts:64](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/reports.ts#L64) *** ### promptTokens[​](#prompttokens "Direct link to promptTokens") > **promptTokens**: `number` Defined in: [packages/sdk/src/types/generated/reports.ts:69](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/reports.ts#L69) *** ### provider[​](#provider "Direct link to provider") > **provider**: [`ModelProvider`](https://docs.gravityrail.com/sdk/type-aliases/ModelProvider.md) Defined in: [packages/sdk/src/types/generated/reports.ts:65](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/reports.ts#L65) *** ### totalTokens[​](#totaltokens "Direct link to totalTokens") > **totalTokens**: `number` Defined in: [packages/sdk/src/types/generated/reports.ts:71](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/reports.ts#L71) *** ### type[​](#type "Direct link to type") > **type**: [`ModelType`](https://docs.gravityrail.com/sdk/type-aliases/ModelType.md) Defined in: [packages/sdk/src/types/generated/reports.ts:66](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/reports.ts#L66) --- # Interface: MondayBoard Defined in: [packages/sdk/src/api/monday.ts:4](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/monday.ts#L4) ## Properties[​](#properties "Direct link to Properties") ### id[​](#id "Direct link to id") > **id**: `string` Defined in: [packages/sdk/src/api/monday.ts:5](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/monday.ts#L5) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/api/monday.ts:6](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/monday.ts#L6) --- # Interface: MondayColumn Defined in: [packages/sdk/src/api/monday.ts:29](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/monday.ts#L29) ## Properties[​](#properties "Direct link to Properties") ### id[​](#id "Direct link to id") > **id**: `string` Defined in: [packages/sdk/src/api/monday.ts:30](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/monday.ts#L30) *** ### settings?[​](#settings "Direct link to settings?") > `optional` **settings**: [`MondayColumnSettings`](https://docs.gravityrail.com/sdk/interfaces/MondayColumnSettings.md) | `null` Defined in: [packages/sdk/src/api/monday.ts:34](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/monday.ts#L34) Column settings - contains labels for status columns *** ### title[​](#title "Direct link to title") > **title**: `string` Defined in: [packages/sdk/src/api/monday.ts:31](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/monday.ts#L31) *** ### type[​](#type "Direct link to type") > **type**: `string` Defined in: [packages/sdk/src/api/monday.ts:32](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/monday.ts#L32) --- # Interface: MondayColumnMapping Defined in: [packages/sdk/src/types/event-types.ts:396](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L396) Column mapping for Monday.com create item action. Stores the column slug (e.g., 'text\_abc123') and the user-friendly label along with the Jinja template value. ## Properties[​](#properties "Direct link to Properties") ### columnId[​](#columnid "Direct link to columnId") > **columnId**: `string` Defined in: [packages/sdk/src/types/event-types.ts:397](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L397) *** ### columnTitle[​](#columntitle "Direct link to columnTitle") > **columnTitle**: `string` Defined in: [packages/sdk/src/types/event-types.ts:398](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L398) *** ### columnType[​](#columntype "Direct link to columnType") > **columnType**: `string` Defined in: [packages/sdk/src/types/event-types.ts:399](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L399) *** ### template[​](#template "Direct link to template") > **template**: `string` Defined in: [packages/sdk/src/types/event-types.ts:400](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L400) --- # Interface: MondayColumnSettings Defined in: [packages/sdk/src/api/monday.ts:22](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/monday.ts#L22) Column settings - contains labels for status columns ## Properties[​](#properties "Direct link to Properties") ### labels?[​](#labels "Direct link to labels?") > `optional` **labels**: `Record`<`string`, `string` | [`MondayStatusLabel`](https://docs.gravityrail.com/sdk/interfaces/MondayStatusLabel.md)> Defined in: [packages/sdk/src/api/monday.ts:24](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/monday.ts#L24) Labels for status columns, keyed by index *** ### labels\_colors?[​](#labels_colors "Direct link to labels_colors?") > `optional` **labels\_colors**: `Record`<`string`, { `border`: `string`; `color`: `string`; `var_name`: `string`; }> Defined in: [packages/sdk/src/api/monday.ts:26](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/monday.ts#L26) Label colors for status columns --- # Interface: MondayConnectionResponse Defined in: [packages/sdk/src/types/generated/app\_connection.ts:320](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L320) Serialized Monday.com connection for API responses. ## Properties[​](#properties "Direct link to Properties") ### connectionType?[​](#connectiontype "Direct link to connectionType?") > `optional` **connectionType**: `"monday_connection"` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:321](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L321) *** ### createdAt?[​](#createdat "Direct link to createdAt?") > `optional` **createdAt**: `string` | `null` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:330](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L330) *** ### creatorId?[​](#creatorid "Direct link to creatorId?") > `optional` **creatorId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:326](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L326) *** ### enabled[​](#enabled "Direct link to enabled") > **enabled**: `boolean` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:325](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L325) *** ### id[​](#id "Direct link to id") > **id**: `number` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:322](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L322) *** ### lastConnectedAt?[​](#lastconnectedat "Direct link to lastConnectedAt?") > `optional` **lastConnectedAt**: `string` | `null` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:329](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L329) *** ### mondayAccountId?[​](#mondayaccountid "Direct link to mondayAccountId?") > `optional` **mondayAccountId**: `string` | `null` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:327](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L327) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:324](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L324) *** ### state?[​](#state "Direct link to state?") > `optional` **state**: `string` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:328](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L328) *** ### updatedAt?[​](#updatedat "Direct link to updatedAt?") > `optional` **updatedAt**: `string` | `null` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:331](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L331) *** ### uuid[​](#uuid "Direct link to uuid") > **uuid**: `string` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:323](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L323) --- # Interface: MondayCurrentUserInfoResponse Defined in: [packages/sdk/src/api/monday.ts:54](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/monday.ts#L54) ## Properties[​](#properties "Direct link to Properties") ### accountName?[​](#accountname "Direct link to accountName?") > `optional` **accountName**: `string` Defined in: [packages/sdk/src/api/monday.ts:58](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/monday.ts#L58) *** ### connected[​](#connected "Direct link to connected") > **connected**: `boolean` Defined in: [packages/sdk/src/api/monday.ts:55](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/monday.ts#L55) *** ### userEmail?[​](#useremail "Direct link to userEmail?") > `optional` **userEmail**: `string` Defined in: [packages/sdk/src/api/monday.ts:57](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/monday.ts#L57) *** ### userName?[​](#username "Direct link to userName?") > `optional` **userName**: `string` Defined in: [packages/sdk/src/api/monday.ts:56](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/monday.ts#L56) --- # Interface: MondayGroup Defined in: [packages/sdk/src/api/monday.ts:45](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/monday.ts#L45) ## Properties[​](#properties "Direct link to Properties") ### id[​](#id "Direct link to id") > **id**: `string` Defined in: [packages/sdk/src/api/monday.ts:46](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/monday.ts#L46) *** ### title[​](#title "Direct link to title") > **title**: `string` Defined in: [packages/sdk/src/api/monday.ts:47](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/monday.ts#L47) --- # Interface: MondayRefreshActionParams Defined in: [packages/sdk/src/types/event-types.ts:458](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L458) Parameters for refreshing member data from Monday.com. Fetches data from a Monday.com item and updates the local member record. ## Properties[​](#properties "Direct link to Properties") ### apiToken?[​](#apitoken "Direct link to apiToken?") > `optional` **apiToken**: `string` Defined in: [packages/sdk/src/types/event-types.ts:470](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L470) *** ### boardId[​](#boardid "Direct link to boardId") > **boardId**: `string` Defined in: [packages/sdk/src/types/event-types.ts:459](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L459) *** ### dataFieldMappings?[​](#datafieldmappings "Direct link to dataFieldMappings?") > `optional` **dataFieldMappings**: `Record`<`string`, `any`> Defined in: [packages/sdk/src/types/event-types.ts:467](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L467) *** ### itemIdSource?[​](#itemidsource "Direct link to itemIdSource?") > `optional` **itemIdSource**: `string` Defined in: [packages/sdk/src/types/event-types.ts:460](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L460) *** ### memberFieldMappings?[​](#memberfieldmappings "Direct link to memberFieldMappings?") > `optional` **memberFieldMappings**: `Record`<`string`, [`MondayRefreshColumnMapping`](https://docs.gravityrail.com/sdk/interfaces/MondayRefreshColumnMapping.md)> Defined in: [packages/sdk/src/types/event-types.ts:464](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L464) *** ### skipIfNoItemId?[​](#skipifnoitemid "Direct link to skipIfNoItemId?") > `optional` **skipIfNoItemId**: `boolean` Defined in: [packages/sdk/src/types/event-types.ts:461](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L461) --- # Interface: MondayRefreshColumnMapping Defined in: [packages/sdk/src/types/event-types.ts:449](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L449) Column mapping for Monday.com refresh action. Maps Monday.com columns to member or data fields. ## Properties[​](#properties "Direct link to Properties") ### columnId[​](#columnid "Direct link to columnId") > **columnId**: `string` Defined in: [packages/sdk/src/types/event-types.ts:450](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L450) *** ### columnType[​](#columntype "Direct link to columnType") > **columnType**: `string` Defined in: [packages/sdk/src/types/event-types.ts:451](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L451) --- # Interface: MondayStatusLabel Defined in: [packages/sdk/src/api/monday.ts:10](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/monday.ts#L10) Status label from Monday.com column settings ## Properties[​](#properties "Direct link to Properties") ### color?[​](#color "Direct link to color?") > `optional` **color**: `string` Defined in: [packages/sdk/src/api/monday.ts:14](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/monday.ts#L14) The color of the status (CSS color name or hex) *** ### index?[​](#index "Direct link to index?") > `optional` **index**: `number` Defined in: [packages/sdk/src/api/monday.ts:16](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/monday.ts#L16) The index used when creating webhooks for specific status changes *** ### is\_deactivated?[​](#is_deactivated "Direct link to is_deactivated?") > `optional` **is\_deactivated**: `boolean` Defined in: [packages/sdk/src/api/monday.ts:18](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/monday.ts#L18) Whether this status is deactivated *** ### label?[​](#label "Direct link to label?") > `optional` **label**: `string` Defined in: [packages/sdk/src/api/monday.ts:12](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/monday.ts#L12) The display text of the status --- # Interface: MondayUpsertItemActionParams Defined in: [packages/sdk/src/types/event-types.ts:424](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L424) Parameters for upserting (create or update) a Monday.com item. This is the primary action for Monday.com item operations. ## Properties[​](#properties "Direct link to Properties") ### apiToken?[​](#apitoken "Direct link to apiToken?") > `optional` **apiToken**: `string` Defined in: [packages/sdk/src/types/event-types.ts:442](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L442) *** ### boardId[​](#boardid "Direct link to boardId") > **boardId**: `string` Defined in: [packages/sdk/src/types/event-types.ts:425](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L425) *** ### columnMappings?[​](#columnmappings "Direct link to columnMappings?") > `optional` **columnMappings**: [`MondayColumnMapping`](https://docs.gravityrail.com/sdk/interfaces/MondayColumnMapping.md)\[] Defined in: [packages/sdk/src/types/event-types.ts:428](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L428) *** ### groupId?[​](#groupid "Direct link to groupId?") > `optional` **groupId**: `string` Defined in: [packages/sdk/src/types/event-types.ts:426](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L426) *** ### itemNameTemplate?[​](#itemnametemplate "Direct link to itemNameTemplate?") > `optional` **itemNameTemplate**: `string` Defined in: [packages/sdk/src/types/event-types.ts:427](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L427) *** ### lookupColumnId?[​](#lookupcolumnid "Direct link to lookupColumnId?") > `optional` **lookupColumnId**: `string` Defined in: [packages/sdk/src/types/event-types.ts:432](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L432) *** ### lookupType?[​](#lookuptype "Direct link to lookupType?") > `optional` **lookupType**: [`MondayLookupType`](https://docs.gravityrail.com/sdk/type-aliases/MondayLookupType.md) Defined in: [packages/sdk/src/types/event-types.ts:431](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L431) *** ### lookupValueTemplate?[​](#lookupvaluetemplate "Direct link to lookupValueTemplate?") > `optional` **lookupValueTemplate**: `string` Defined in: [packages/sdk/src/types/event-types.ts:433](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L433) *** ### multiMatchBehavior?[​](#multimatchbehavior "Direct link to multiMatchBehavior?") > `optional` **multiMatchBehavior**: [`MultiMatchBehavior`](https://docs.gravityrail.com/sdk/type-aliases/MultiMatchBehavior.md) Defined in: [packages/sdk/src/types/event-types.ts:439](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L439) *** ### upsertMode?[​](#upsertmode "Direct link to upsertMode?") > `optional` **upsertMode**: [`MondayUpsertMode`](https://docs.gravityrail.com/sdk/type-aliases/MondayUpsertMode.md) Defined in: [packages/sdk/src/types/event-types.ts:436](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L436) --- # Interface: NormalizeMemberRequest Defined in: [packages/sdk/src/types/member-types.ts:399](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L399) ## Properties[​](#properties "Direct link to Properties") ### memberId[​](#memberid "Direct link to memberId") > **memberId**: `number` Defined in: [packages/sdk/src/types/member-types.ts:400](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L400) --- # Interface: NormalizeMemberResponse Defined in: [packages/sdk/src/types/member-types.ts:403](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L403) ## Properties[​](#properties "Direct link to Properties") ### changes[​](#changes "Direct link to changes") > **changes**: `Record`<`string`, { `new`: `string`; `old`: `string`; }> Defined in: [packages/sdk/src/types/member-types.ts:405](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L405) *** ### member[​](#member "Direct link to member") > **member**: [`WorkspaceMemberResponse`](https://docs.gravityrail.com/sdk/interfaces/WorkspaceMemberResponse.md) Defined in: [packages/sdk/src/types/member-types.ts:404](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L404) --- # Interface: Notice Defined in: [packages/sdk/src/types/generated/notification.ts:11](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/notification.ts#L11) A notice to display to the user. ## Properties[​](#properties "Direct link to Properties") ### category?[​](#category "Direct link to category?") > `optional` **category**: `string` | `null` Defined in: [packages/sdk/src/types/generated/notification.ts:17](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/notification.ts#L17) *** ### completedSteps?[​](#completedsteps "Direct link to completedSteps?") > `optional` **completedSteps**: `number` | `null` Defined in: [packages/sdk/src/types/generated/notification.ts:19](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/notification.ts#L19) *** ### level[​](#level "Direct link to level") > **level**: `string` Defined in: [packages/sdk/src/types/generated/notification.ts:12](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/notification.ts#L12) *** ### message[​](#message "Direct link to message") > **message**: `string` Defined in: [packages/sdk/src/types/generated/notification.ts:14](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/notification.ts#L14) *** ### progress?[​](#progress "Direct link to progress?") > `optional` **progress**: `number` | `null` Defined in: [packages/sdk/src/types/generated/notification.ts:15](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/notification.ts#L15) *** ### step?[​](#step "Direct link to step?") > `optional` **step**: `string` | `null` Defined in: [packages/sdk/src/types/generated/notification.ts:16](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/notification.ts#L16) *** ### steps?[​](#steps "Direct link to steps?") > `optional` **steps**: [`SetupStep`](https://docs.gravityrail.com/sdk/interfaces/SetupStep.md)\[] | `null` Defined in: [packages/sdk/src/types/generated/notification.ts:20](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/notification.ts#L20) *** ### totalSteps?[​](#totalsteps "Direct link to totalSteps?") > `optional` **totalSteps**: `number` | `null` Defined in: [packages/sdk/src/types/generated/notification.ts:18](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/notification.ts#L18) *** ### type[​](#type "Direct link to type") > **type**: `string` Defined in: [packages/sdk/src/types/generated/notification.ts:13](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/notification.ts#L13) --- # Interface: NoticesResponse Defined in: [packages/sdk/src/types/generated/notification.ts:23](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/notification.ts#L23) ## Properties[​](#properties "Direct link to Properties") ### notices[​](#notices "Direct link to notices") > **notices**: [`Notice`](https://docs.gravityrail.com/sdk/interfaces/Notice.md)\[] Defined in: [packages/sdk/src/types/generated/notification.ts:24](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/notification.ts#L24) --- # Interface: NotificationResponse Defined in: [packages/sdk/src/types/generated/notification.ts:30](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/notification.ts#L30) Response model for notification endpoints. ## Properties[​](#properties "Direct link to Properties") ### acknowledgedAt?[​](#acknowledgedat "Direct link to acknowledgedAt?") > `optional` **acknowledgedAt**: `string` | `null` Defined in: [packages/sdk/src/types/generated/notification.ts:37](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/notification.ts#L37) *** ### actionUri?[​](#actionuri "Direct link to actionUri?") > `optional` **actionUri**: `string` | `null` Defined in: [packages/sdk/src/types/generated/notification.ts:33](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/notification.ts#L33) *** ### assignmentId?[​](#assignmentid "Direct link to assignmentId?") > `optional` **assignmentId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/notification.ts:39](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/notification.ts#L39) *** ### createdAt[​](#createdat "Direct link to createdAt") > **createdAt**: `string` Defined in: [packages/sdk/src/types/generated/notification.ts:34](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/notification.ts#L34) *** ### dataRecordId?[​](#datarecordid "Direct link to dataRecordId?") > `optional` **dataRecordId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/notification.ts:41](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/notification.ts#L41) *** ### dismissedAt?[​](#dismissedat "Direct link to dismissedAt?") > `optional` **dismissedAt**: `string` | `null` Defined in: [packages/sdk/src/types/generated/notification.ts:38](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/notification.ts#L38) *** ### id[​](#id "Direct link to id") > **id**: `number` Defined in: [packages/sdk/src/types/generated/notification.ts:31](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/notification.ts#L31) *** ### memberId[​](#memberid "Direct link to memberId") > **memberId**: `number` Defined in: [packages/sdk/src/types/generated/notification.ts:40](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/notification.ts#L40) *** ### message[​](#message "Direct link to message") > **message**: `string` Defined in: [packages/sdk/src/types/generated/notification.ts:32](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/notification.ts#L32) *** ### readAt?[​](#readat "Direct link to readAt?") > `optional` **readAt**: `string` | `null` Defined in: [packages/sdk/src/types/generated/notification.ts:36](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/notification.ts#L36) *** ### updatedAt[​](#updatedat "Direct link to updatedAt") > **updatedAt**: `string` Defined in: [packages/sdk/src/types/generated/notification.ts:35](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/notification.ts#L35) --- # Interface: NotificationRule Defined in: [packages/sdk/src/api/notification-rules.ts:3](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/notification-rules.ts#L3) ## Properties[​](#properties "Direct link to Properties") ### id?[​](#id "Direct link to id?") > `optional` **id**: `number` Defined in: [packages/sdk/src/api/notification-rules.ts:4](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/notification-rules.ts#L4) *** ### memberId[​](#memberid "Direct link to memberId") > **memberId**: `number` Defined in: [packages/sdk/src/api/notification-rules.ts:6](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/notification-rules.ts#L6) *** ### noticeType[​](#noticetype "Direct link to noticeType") > **noticeType**: `string` Defined in: [packages/sdk/src/api/notification-rules.ts:5](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/notification-rules.ts#L5) *** ### notifyEmail[​](#notifyemail "Direct link to notifyEmail") > **notifyEmail**: `boolean` Defined in: [packages/sdk/src/api/notification-rules.ts:10](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/notification-rules.ts#L10) *** ### notifySms[​](#notifysms "Direct link to notifySms") > **notifySms**: `boolean` Defined in: [packages/sdk/src/api/notification-rules.ts:9](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/notification-rules.ts#L9) *** ### notifyVoice[​](#notifyvoice "Direct link to notifyVoice") > **notifyVoice**: `boolean` Defined in: [packages/sdk/src/api/notification-rules.ts:11](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/notification-rules.ts#L11) *** ### prompt?[​](#prompt "Direct link to prompt?") > `optional` **prompt**: `string` | `null` Defined in: [packages/sdk/src/api/notification-rules.ts:8](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/notification-rules.ts#L8) *** ### workflowId?[​](#workflowid "Direct link to workflowId?") > `optional` **workflowId**: `number` | `null` Defined in: [packages/sdk/src/api/notification-rules.ts:7](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/notification-rules.ts#L7) --- # Interface: NotificationRuleCreate Defined in: [packages/sdk/src/api/notification-rules.ts:14](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/notification-rules.ts#L14) ## Properties[​](#properties "Direct link to Properties") ### memberId[​](#memberid "Direct link to memberId") > **memberId**: `number` Defined in: [packages/sdk/src/api/notification-rules.ts:16](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/notification-rules.ts#L16) *** ### noticeType[​](#noticetype "Direct link to noticeType") > **noticeType**: `string` Defined in: [packages/sdk/src/api/notification-rules.ts:15](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/notification-rules.ts#L15) *** ### notifyEmail[​](#notifyemail "Direct link to notifyEmail") > **notifyEmail**: `boolean` Defined in: [packages/sdk/src/api/notification-rules.ts:20](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/notification-rules.ts#L20) *** ### notifySms[​](#notifysms "Direct link to notifySms") > **notifySms**: `boolean` Defined in: [packages/sdk/src/api/notification-rules.ts:19](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/notification-rules.ts#L19) *** ### notifyVoice[​](#notifyvoice "Direct link to notifyVoice") > **notifyVoice**: `boolean` Defined in: [packages/sdk/src/api/notification-rules.ts:21](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/notification-rules.ts#L21) *** ### prompt?[​](#prompt "Direct link to prompt?") > `optional` **prompt**: `string` | `null` Defined in: [packages/sdk/src/api/notification-rules.ts:18](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/notification-rules.ts#L18) *** ### workflowId?[​](#workflowid "Direct link to workflowId?") > `optional` **workflowId**: `number` | `null` Defined in: [packages/sdk/src/api/notification-rules.ts:17](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/notification-rules.ts#L17) --- # Interface: NotificationRuleResponse Defined in: [packages/sdk/src/types/generated/notification.ts:47](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/notification.ts#L47) Schema for notification rule responses. ## Properties[​](#properties "Direct link to Properties") ### id[​](#id "Direct link to id") > **id**: `number` Defined in: [packages/sdk/src/types/generated/notification.ts:55](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/notification.ts#L55) *** ### memberId[​](#memberid "Direct link to memberId") > **memberId**: `number` Defined in: [packages/sdk/src/types/generated/notification.ts:49](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/notification.ts#L49) *** ### noticeType[​](#noticetype "Direct link to noticeType") > **noticeType**: `string` Defined in: [packages/sdk/src/types/generated/notification.ts:48](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/notification.ts#L48) *** ### notifyEmail?[​](#notifyemail "Direct link to notifyEmail?") > `optional` **notifyEmail**: `boolean` Defined in: [packages/sdk/src/types/generated/notification.ts:53](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/notification.ts#L53) *** ### notifySms?[​](#notifysms "Direct link to notifySms?") > `optional` **notifySms**: `boolean` Defined in: [packages/sdk/src/types/generated/notification.ts:52](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/notification.ts#L52) *** ### notifyVoice?[​](#notifyvoice "Direct link to notifyVoice?") > `optional` **notifyVoice**: `boolean` Defined in: [packages/sdk/src/types/generated/notification.ts:54](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/notification.ts#L54) *** ### prompt?[​](#prompt "Direct link to prompt?") > `optional` **prompt**: `string` | `null` Defined in: [packages/sdk/src/types/generated/notification.ts:51](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/notification.ts#L51) *** ### workflowId?[​](#workflowid "Direct link to workflowId?") > `optional` **workflowId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/notification.ts:50](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/notification.ts#L50) --- # Interface: NotificationRuleUpdate Defined in: [packages/sdk/src/api/notification-rules.ts:24](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/notification-rules.ts#L24) ## Properties[​](#properties "Direct link to Properties") ### memberId?[​](#memberid "Direct link to memberId?") > `optional` **memberId**: `number` Defined in: [packages/sdk/src/api/notification-rules.ts:26](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/notification-rules.ts#L26) *** ### noticeType?[​](#noticetype "Direct link to noticeType?") > `optional` **noticeType**: `string` Defined in: [packages/sdk/src/api/notification-rules.ts:25](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/notification-rules.ts#L25) *** ### notifyEmail?[​](#notifyemail "Direct link to notifyEmail?") > `optional` **notifyEmail**: `boolean` Defined in: [packages/sdk/src/api/notification-rules.ts:30](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/notification-rules.ts#L30) *** ### notifySms?[​](#notifysms "Direct link to notifySms?") > `optional` **notifySms**: `boolean` Defined in: [packages/sdk/src/api/notification-rules.ts:29](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/notification-rules.ts#L29) *** ### notifyVoice?[​](#notifyvoice "Direct link to notifyVoice?") > `optional` **notifyVoice**: `boolean` Defined in: [packages/sdk/src/api/notification-rules.ts:31](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/notification-rules.ts#L31) *** ### prompt?[​](#prompt "Direct link to prompt?") > `optional` **prompt**: `string` | `null` Defined in: [packages/sdk/src/api/notification-rules.ts:28](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/notification-rules.ts#L28) *** ### workflowId?[​](#workflowid "Direct link to workflowId?") > `optional` **workflowId**: `number` | `null` Defined in: [packages/sdk/src/api/notification-rules.ts:27](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/notification-rules.ts#L27) --- # Interface: OAuthAuthorizeResponse Defined in: [packages/sdk/src/api/oauth.ts:22](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/oauth.ts#L22) ## Properties[​](#properties "Direct link to Properties") ### authorization\_url[​](#authorization_url "Direct link to authorization_url") > **authorization\_url**: `string` Defined in: [packages/sdk/src/api/oauth.ts:23](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/oauth.ts#L23) --- # Interface: OAuthConnectionStatus Defined in: [packages/sdk/src/api/oauth.ts:6](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/oauth.ts#L6) ## Properties[​](#properties "Direct link to Properties") ### connected[​](#connected "Direct link to connected") > **connected**: `boolean` Defined in: [packages/sdk/src/api/oauth.ts:7](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/oauth.ts#L7) *** ### email?[​](#email "Direct link to email?") > `optional` **email**: `string` Defined in: [packages/sdk/src/api/oauth.ts:8](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/oauth.ts#L8) --- # Interface: ObjectPermissionFlags Defined in: [packages/sdk/src/types/core-types.ts:43](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/core-types.ts#L43) ## Properties[​](#properties "Direct link to Properties") ### create[​](#create "Direct link to create") > **create**: `boolean` Defined in: [packages/sdk/src/types/core-types.ts:46](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/core-types.ts#L46) *** ### delete[​](#delete "Direct link to delete") > **delete**: `boolean` Defined in: [packages/sdk/src/types/core-types.ts:51](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/core-types.ts#L51) *** ### edit[​](#edit "Direct link to edit") > **edit**: `boolean` Defined in: [packages/sdk/src/types/core-types.ts:45](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/core-types.ts#L45) *** ### geolocate[​](#geolocate "Direct link to geolocate") > **geolocate**: `boolean` Defined in: [packages/sdk/src/types/core-types.ts:49](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/core-types.ts#L49) *** ### list[​](#list "Direct link to list") > **list**: `boolean` Defined in: [packages/sdk/src/types/core-types.ts:47](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/core-types.ts#L47) *** ### listAll[​](#listall "Direct link to listAll") > **listAll**: `boolean` Defined in: [packages/sdk/src/types/core-types.ts:50](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/core-types.ts#L50) *** ### use[​](#use "Direct link to use") > **use**: `boolean` Defined in: [packages/sdk/src/types/core-types.ts:44](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/core-types.ts#L44) *** ### verify[​](#verify "Direct link to verify") > **verify**: `boolean` Defined in: [packages/sdk/src/types/core-types.ts:48](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/core-types.ts#L48) --- # Interface: OIDCAdminConfigView Defined in: [packages/sdk/src/types/generated/organization.ts:443](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L443) OIDC config returned to an admin. Cleartext secret is always None. ## Properties[​](#properties "Direct link to Properties") ### autoProvision?[​](#autoprovision "Direct link to autoProvision?") > `optional` **autoProvision**: `boolean` Defined in: [packages/sdk/src/types/generated/organization.ts:450](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L450) *** ### clientId[​](#clientid "Direct link to clientId") > **clientId**: `string` Defined in: [packages/sdk/src/types/generated/organization.ts:446](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L446) *** ### clientSecret?[​](#clientsecret "Direct link to clientSecret?") > `optional` **clientSecret**: `string` | `null` Defined in: [packages/sdk/src/types/generated/organization.ts:455](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L455) *** ### clientSecretSet?[​](#clientsecretset "Direct link to clientSecretSet?") > `optional` **clientSecretSet**: `boolean` Defined in: [packages/sdk/src/types/generated/organization.ts:456](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L456) *** ### expectedAudience?[​](#expectedaudience "Direct link to expectedAudience?") > `optional` **expectedAudience**: `string` | `null` Defined in: [packages/sdk/src/types/generated/organization.ts:447](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L447) *** ### expectedTenantId?[​](#expectedtenantid "Direct link to expectedTenantId?") > `optional` **expectedTenantId**: `string` | `null` Defined in: [packages/sdk/src/types/generated/organization.ts:448](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L448) *** ### groupsKey?[​](#groupskey "Direct link to groupsKey?") > `optional` **groupsKey**: `string` | `null` Defined in: [packages/sdk/src/types/generated/organization.ts:453](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L453) *** ### issuer[​](#issuer "Direct link to issuer") > **issuer**: `string` Defined in: [packages/sdk/src/types/generated/organization.ts:445](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L445) *** ### multiTenant?[​](#multitenant "Direct link to multiTenant?") > `optional` **multiTenant**: `boolean` Defined in: [packages/sdk/src/types/generated/organization.ts:449](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L449) *** ### postLogoutRedirectUris?[​](#postlogoutredirecturis "Direct link to postLogoutRedirectUris?") > `optional` **postLogoutRedirectUris**: `string`\[] | `null` Defined in: [packages/sdk/src/types/generated/organization.ts:454](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L454) *** ### providerType?[​](#providertype "Direct link to providerType?") > `optional` **providerType**: [`OIDCAdminConfigViewProviderType`](https://docs.gravityrail.com/sdk/type-aliases/OIDCAdminConfigViewProviderType.md) Defined in: [packages/sdk/src/types/generated/organization.ts:444](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L444) *** ### roleMapping?[​](#rolemapping "Direct link to roleMapping?") > `optional` **roleMapping**: `OIDCAdminConfigViewRoleMapping` Defined in: [packages/sdk/src/types/generated/organization.ts:451](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L451) *** ### rolesKey?[​](#roleskey "Direct link to rolesKey?") > `optional` **rolesKey**: `string` | `null` Defined in: [packages/sdk/src/types/generated/organization.ts:452](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L452) --- # Interface: OpenAIChatModelConfig Defined in: [packages/sdk/src/types/model-config-types.ts:159](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/model-config-types.ts#L159) Base configuration for all chat models. Can be extended for provider-specific options. ## Extends[​](#extends "Direct link to Extends") * [`BaseChatModelConfig`](https://docs.gravityrail.com/sdk/interfaces/BaseChatModelConfig.md) ## Properties[​](#properties "Direct link to Properties") ### provider[​](#provider "Direct link to provider") > **provider**: `"openai"` Defined in: [packages/sdk/src/types/model-config-types.ts:160](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/model-config-types.ts#L160) *** ### reasoningEffort?[​](#reasoningeffort "Direct link to reasoningEffort?") > `optional` **reasoningEffort**: [`OpenAIReasoningEffort`](https://docs.gravityrail.com/sdk/type-aliases/OpenAIReasoningEffort.md) | `null` Defined in: [packages/sdk/src/types/model-config-types.ts:161](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/model-config-types.ts#L161) --- # Interface: OpenAIRealtimeModelConfig Defined in: [packages/sdk/src/types/model-config-types.ts:84](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/model-config-types.ts#L84) Native realtime providers always use the model's built-in audio. The backend Pydantic schemas now enforce `ttsModel: "native"` and reject external `sttModel`. Mirroring that contract on the client surface keeps the editor in sync — see `useVoiceConfig.buildSubmitConfig`. ## Extends[​](#extends "Direct link to Extends") * [`BaseRealtimeModelConfig`](https://docs.gravityrail.com/sdk/interfaces/BaseRealtimeModelConfig.md) ## Properties[​](#properties "Direct link to Properties") ### interruptionSound?[​](#interruptionsound "Direct link to interruptionSound?") > `optional` **interruptionSound**: [`InterruptionSound`](https://docs.gravityrail.com/sdk/type-aliases/InterruptionSound.md) | `null` Defined in: [packages/sdk/src/types/model-config-types.ts:69](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/model-config-types.ts#L69) Sound to play when user stops speaking after interrupting the assistant. Provides immediate auditory feedback that input was received. Default: none. #### Inherited from[​](#inherited-from "Direct link to Inherited from") [`BaseRealtimeModelConfig`](https://docs.gravityrail.com/sdk/interfaces/BaseRealtimeModelConfig.md).[`interruptionSound`](https://docs.gravityrail.com/sdk/interfaces/BaseRealtimeModelConfig.md#interruptionsound) *** ### interruptionSoundVolume?[​](#interruptionsoundvolume "Direct link to interruptionSoundVolume?") > `optional` **interruptionSoundVolume**: `number` | `null` Defined in: [packages/sdk/src/types/model-config-types.ts:71](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/model-config-types.ts#L71) Volume level for the interruption sound (0-100). 0 means muted. Missing or null means full volume (100). #### Inherited from[​](#inherited-from-1 "Direct link to Inherited from") [`BaseRealtimeModelConfig`](https://docs.gravityrail.com/sdk/interfaces/BaseRealtimeModelConfig.md).[`interruptionSoundVolume`](https://docs.gravityrail.com/sdk/interfaces/BaseRealtimeModelConfig.md#interruptionsoundvolume) *** ### thinkingSound?[​](#thinkingsound "Direct link to thinkingSound?") > `optional` **thinkingSound**: [`ThinkingSound`](https://docs.gravityrail.com/sdk/type-aliases/ThinkingSound.md) | `null` Defined in: [packages/sdk/src/types/model-config-types.ts:61](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/model-config-types.ts#L61) Sound to play while the agent is processing tool calls. #### Inherited from[​](#inherited-from-2 "Direct link to Inherited from") [`BaseRealtimeModelConfig`](https://docs.gravityrail.com/sdk/interfaces/BaseRealtimeModelConfig.md).[`thinkingSound`](https://docs.gravityrail.com/sdk/interfaces/BaseRealtimeModelConfig.md#thinkingsound) *** ### thinkingSoundInitialDelay?[​](#thinkingsoundinitialdelay "Direct link to thinkingSoundInitialDelay?") > `optional` **thinkingSoundInitialDelay**: `number` | `null` Defined in: [packages/sdk/src/types/model-config-types.ts:65](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/model-config-types.ts#L65) Initial delay in milliseconds before playing thinking sound. Prevents needless interruption on short tool calls. Default: 500ms. #### Inherited from[​](#inherited-from-3 "Direct link to Inherited from") [`BaseRealtimeModelConfig`](https://docs.gravityrail.com/sdk/interfaces/BaseRealtimeModelConfig.md).[`thinkingSoundInitialDelay`](https://docs.gravityrail.com/sdk/interfaces/BaseRealtimeModelConfig.md#thinkingsoundinitialdelay) *** ### thinkingSoundVolume?[​](#thinkingsoundvolume "Direct link to thinkingSoundVolume?") > `optional` **thinkingSoundVolume**: `number` | `null` Defined in: [packages/sdk/src/types/model-config-types.ts:63](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/model-config-types.ts#L63) Volume level for the thinking sound (0-100). 0 means muted. Missing or null means full volume (100). #### Inherited from[​](#inherited-from-4 "Direct link to Inherited from") [`BaseRealtimeModelConfig`](https://docs.gravityrail.com/sdk/interfaces/BaseRealtimeModelConfig.md).[`thinkingSoundVolume`](https://docs.gravityrail.com/sdk/interfaces/BaseRealtimeModelConfig.md#thinkingsoundvolume) *** ### thinkingSpeechPhrases?[​](#thinkingspeechphrases "Direct link to thinkingSpeechPhrases?") > `optional` **thinkingSpeechPhrases**: `string`\[] | `null` Defined in: [packages/sdk/src/types/model-config-types.ts:67](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/model-config-types.ts#L67) When `thinkingSound` is 'speech', one of these phrases is spoken while the agent runs a tool. Phrases rotate round-robin per session. #### Inherited from[​](#inherited-from-5 "Direct link to Inherited from") [`BaseRealtimeModelConfig`](https://docs.gravityrail.com/sdk/interfaces/BaseRealtimeModelConfig.md).[`thinkingSpeechPhrases`](https://docs.gravityrail.com/sdk/interfaces/BaseRealtimeModelConfig.md#thinkingspeechphrases) *** ### ttsModel?[​](#ttsmodel "Direct link to ttsModel?") > `optional` **ttsModel**: `"native"` | `null` Defined in: [packages/sdk/src/types/model-config-types.ts:85](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/model-config-types.ts#L85) TTS model ID in provider:tts:model format (e.g. 'elevenlabs:tts:eleven\_flash\_v2\_5'), or 'native'. #### Overrides[​](#overrides "Direct link to Overrides") [`BaseRealtimeModelConfig`](https://docs.gravityrail.com/sdk/interfaces/BaseRealtimeModelConfig.md).[`ttsModel`](https://docs.gravityrail.com/sdk/interfaces/BaseRealtimeModelConfig.md#ttsmodel) *** ### turnDetection?[​](#turndetection "Direct link to turnDetection?") > `optional` **turnDetection**: [`OpenAITurnDetection`](https://docs.gravityrail.com/sdk/type-aliases/OpenAITurnDetection.md) | `null` Defined in: [packages/sdk/src/types/model-config-types.ts:86](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/model-config-types.ts#L86) *** ### voiceModel?[​](#voicemodel "Direct link to voiceModel?") > `optional` **voiceModel**: `string` | `null` Defined in: [packages/sdk/src/types/model-config-types.ts:75](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/model-config-types.ts#L75) Canonical voice identifier (e.g., elevenlabs:voice:catt) that selects the specific agent voice. #### Inherited from[​](#inherited-from-6 "Direct link to Inherited from") [`BaseRealtimeModelConfig`](https://docs.gravityrail.com/sdk/interfaces/BaseRealtimeModelConfig.md).[`voiceModel`](https://docs.gravityrail.com/sdk/interfaces/BaseRealtimeModelConfig.md#voicemodel) --- # Interface: OpenAISemanticVADTurnDetection Defined in: [packages/sdk/src/types/model-config-types.ts:9](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/model-config-types.ts#L9) ## Properties[​](#properties "Direct link to Properties") ### create\_response?[​](#create_response "Direct link to create_response?") > `optional` **create\_response**: `boolean` Defined in: [packages/sdk/src/types/model-config-types.ts:12](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/model-config-types.ts#L12) *** ### eagerness?[​](#eagerness "Direct link to eagerness?") > `optional` **eagerness**: [`OpenAISemanticVADEagerness`](https://docs.gravityrail.com/sdk/type-aliases/OpenAISemanticVADEagerness.md) Defined in: [packages/sdk/src/types/model-config-types.ts:11](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/model-config-types.ts#L11) *** ### interrupt\_response?[​](#interrupt_response "Direct link to interrupt_response?") > `optional` **interrupt\_response**: `boolean` Defined in: [packages/sdk/src/types/model-config-types.ts:13](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/model-config-types.ts#L13) *** ### type[​](#type "Direct link to type") > **type**: `"semantic_vad"` Defined in: [packages/sdk/src/types/model-config-types.ts:10](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/model-config-types.ts#L10) --- # Interface: OpenAIServerVADTurnDetection Defined in: [packages/sdk/src/types/model-config-types.ts:16](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/model-config-types.ts#L16) ## Properties[​](#properties "Direct link to Properties") ### create\_response?[​](#create_response "Direct link to create_response?") > `optional` **create\_response**: `boolean` Defined in: [packages/sdk/src/types/model-config-types.ts:21](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/model-config-types.ts#L21) *** ### interrupt\_response?[​](#interrupt_response "Direct link to interrupt_response?") > `optional` **interrupt\_response**: `boolean` Defined in: [packages/sdk/src/types/model-config-types.ts:22](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/model-config-types.ts#L22) *** ### prefix\_padding\_ms?[​](#prefix_padding_ms "Direct link to prefix_padding_ms?") > `optional` **prefix\_padding\_ms**: `number` Defined in: [packages/sdk/src/types/model-config-types.ts:19](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/model-config-types.ts#L19) *** ### silence\_duration\_ms?[​](#silence_duration_ms "Direct link to silence_duration_ms?") > `optional` **silence\_duration\_ms**: `number` Defined in: [packages/sdk/src/types/model-config-types.ts:20](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/model-config-types.ts#L20) *** ### threshold?[​](#threshold "Direct link to threshold?") > `optional` **threshold**: `number` Defined in: [packages/sdk/src/types/model-config-types.ts:18](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/model-config-types.ts#L18) *** ### type[​](#type "Direct link to type") > **type**: `"server_vad"` Defined in: [packages/sdk/src/types/model-config-types.ts:17](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/model-config-types.ts#L17) --- # Interface: OperatorChatParticipant Defined in: [packages/sdk/src/types/chat-types.ts:145](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L145) ## Properties[​](#properties "Direct link to Properties") ### memberId[​](#memberid "Direct link to memberId") > **memberId**: `number` Defined in: [packages/sdk/src/types/chat-types.ts:148](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L148) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/chat-types.ts:146](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L146) *** ### role[​](#role "Direct link to role") > **role**: `"operator"` Defined in: [packages/sdk/src/types/chat-types.ts:147](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L147) --- # Interface: OperatorChildTaskDetail Defined in: [packages/sdk/src/types/generated/task.ts:175](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L175) Child task info for the operator assignment view. ## Properties[​](#properties "Direct link to Properties") ### assignmentTaskId[​](#assignmenttaskid "Direct link to assignmentTaskId") > **assignmentTaskId**: `number` Defined in: [packages/sdk/src/types/generated/task.ts:176](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L176) *** ### autoNext?[​](#autonext "Direct link to autoNext?") > `optional` **autoNext**: `boolean` Defined in: [packages/sdk/src/types/generated/task.ts:184](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L184) *** ### celCondition?[​](#celcondition "Direct link to celCondition?") > `optional` **celCondition**: `string` | `null` Defined in: [packages/sdk/src/types/generated/task.ts:183](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L183) *** ### choicePrompt?[​](#choiceprompt "Direct link to choicePrompt?") > `optional` **choicePrompt**: `string` | `null` Defined in: [packages/sdk/src/types/generated/task.ts:182](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L182) *** ### order?[​](#order "Direct link to order?") > `optional` **order**: `number` Defined in: [packages/sdk/src/types/generated/task.ts:186](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L186) *** ### required?[​](#required "Direct link to required?") > `optional` **required**: `boolean` Defined in: [packages/sdk/src/types/generated/task.ts:185](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L185) *** ### shortPrompt?[​](#shortprompt "Direct link to shortPrompt?") > `optional` **shortPrompt**: `string` | `null` Defined in: [packages/sdk/src/types/generated/task.ts:181](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L181) *** ### taskId[​](#taskid "Direct link to taskId") > **taskId**: `number` Defined in: [packages/sdk/src/types/generated/task.ts:177](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L177) *** ### taskName[​](#taskname "Direct link to taskName") > **taskName**: `string` Defined in: [packages/sdk/src/types/generated/task.ts:178](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L178) *** ### taskType[​](#tasktype "Direct link to taskType") > **taskType**: `string` Defined in: [packages/sdk/src/types/generated/task.ts:180](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L180) *** ### taskUuid[​](#taskuuid "Direct link to taskUuid") > **taskUuid**: `string` Defined in: [packages/sdk/src/types/generated/task.ts:179](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L179) *** ### visitedAt?[​](#visitedat "Direct link to visitedAt?") > `optional` **visitedAt**: `string` | `null` Defined in: [packages/sdk/src/types/generated/task.ts:187](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L187) --- # Interface: OperatorGroupMemberInput Defined in: [packages/sdk/src/types/operator-types.ts:175](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/operator-types.ts#L175) ## Properties[​](#properties "Direct link to Properties") ### memberId[​](#memberid "Direct link to memberId") > **memberId**: `number` Defined in: [packages/sdk/src/types/operator-types.ts:176](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/operator-types.ts#L176) *** ### priority?[​](#priority "Direct link to priority?") > `optional` **priority**: `number` Defined in: [packages/sdk/src/types/operator-types.ts:177](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/operator-types.ts#L177) --- # Interface: OperatorGroupMemberResponse Defined in: [packages/sdk/src/types/generated/operator.ts:25](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/operator.ts#L25) Response model for a member within an operator group. ## Properties[​](#properties "Direct link to Properties") ### createdAt[​](#createdat "Direct link to createdAt") > **createdAt**: `string` Defined in: [packages/sdk/src/types/generated/operator.ts:30](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/operator.ts#L30) *** ### id[​](#id "Direct link to id") > **id**: `number` Defined in: [packages/sdk/src/types/generated/operator.ts:26](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/operator.ts#L26) *** ### memberId[​](#memberid "Direct link to memberId") > **memberId**: `number` Defined in: [packages/sdk/src/types/generated/operator.ts:27](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/operator.ts#L27) *** ### memberType?[​](#membertype "Direct link to memberType?") > `optional` **memberType**: `string` | `null` Defined in: [packages/sdk/src/types/generated/operator.ts:28](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/operator.ts#L28) *** ### priority[​](#priority "Direct link to priority") > **priority**: `number` Defined in: [packages/sdk/src/types/generated/operator.ts:29](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/operator.ts#L29) --- # Interface: OperatorTaskDetailResponse Defined in: [packages/sdk/src/types/generated/task.ts:196](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L196) Rich task detail for operator assignment view. Includes prompt, abilities, and child task details with CEL conditions so the operator can see what the AI would see and navigate workflow steps. ## Properties[​](#properties "Direct link to Properties") ### abilities?[​](#abilities "Direct link to abilities?") > `optional` **abilities**: `AbilityResponse`\[] Defined in: [packages/sdk/src/types/generated/task.ts:208](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L208) *** ### assignmentId[​](#assignmentid "Direct link to assignmentId") > **assignmentId**: `number` Defined in: [packages/sdk/src/types/generated/task.ts:197](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L197) *** ### assignmentTaskId[​](#assignmenttaskid "Direct link to assignmentTaskId") > **assignmentTaskId**: `number` Defined in: [packages/sdk/src/types/generated/task.ts:198](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L198) *** ### celGuard?[​](#celguard "Direct link to celGuard?") > `optional` **celGuard**: `string` | `null` Defined in: [packages/sdk/src/types/generated/task.ts:207](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L207) *** ### childTasks?[​](#childtasks "Direct link to childTasks?") > `optional` **childTasks**: [`OperatorChildTaskDetail`](https://docs.gravityrail.com/sdk/interfaces/OperatorChildTaskDetail.md)\[] Defined in: [packages/sdk/src/types/generated/task.ts:210](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L210) *** ### configuration?[​](#configuration "Direct link to configuration?") > `optional` **configuration**: `OperatorTaskDetailResponseConfiguration` Defined in: [packages/sdk/src/types/generated/task.ts:206](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L206) *** ### description?[​](#description "Direct link to description?") > `optional` **description**: `string` | `null` Defined in: [packages/sdk/src/types/generated/task.ts:205](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L205) *** ### inheritedAbilities?[​](#inheritedabilities "Direct link to inheritedAbilities?") > `optional` **inheritedAbilities**: `AbilityResponse`\[] Defined in: [packages/sdk/src/types/generated/task.ts:209](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L209) *** ### parentAssignmentTaskId?[​](#parentassignmenttaskid "Direct link to parentAssignmentTaskId?") > `optional` **parentAssignmentTaskId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/task.ts:211](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L211) *** ### parentShortPrompt?[​](#parentshortprompt "Direct link to parentShortPrompt?") > `optional` **parentShortPrompt**: `string` | `null` Defined in: [packages/sdk/src/types/generated/task.ts:213](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L213) *** ### parentTaskName?[​](#parenttaskname "Direct link to parentTaskName?") > `optional` **parentTaskName**: `string` | `null` Defined in: [packages/sdk/src/types/generated/task.ts:212](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L212) *** ### prompt?[​](#prompt "Direct link to prompt?") > `optional` **prompt**: `string` | `null` Defined in: [packages/sdk/src/types/generated/task.ts:202](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L202) *** ### renderedPrompt?[​](#renderedprompt "Direct link to renderedPrompt?") > `optional` **renderedPrompt**: `string` | `null` Defined in: [packages/sdk/src/types/generated/task.ts:203](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L203) *** ### shortPrompt?[​](#shortprompt "Direct link to shortPrompt?") > `optional` **shortPrompt**: `string` | `null` Defined in: [packages/sdk/src/types/generated/task.ts:204](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L204) *** ### taskId[​](#taskid "Direct link to taskId") > **taskId**: `number` Defined in: [packages/sdk/src/types/generated/task.ts:199](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L199) *** ### taskName[​](#taskname "Direct link to taskName") > **taskName**: `string` Defined in: [packages/sdk/src/types/generated/task.ts:200](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L200) *** ### taskType[​](#tasktype "Direct link to taskType") > **taskType**: `string` Defined in: [packages/sdk/src/types/generated/task.ts:201](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L201) --- # Interface: OrgA2PBrandListResponse Defined in: [packages/sdk/src/types/organization-types.ts:213](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/organization-types.ts#L213) ## Properties[​](#properties "Direct link to Properties") ### brands[​](#brands "Direct link to brands") > **brands**: [`OrgA2PBrandSummary`](https://docs.gravityrail.com/sdk/interfaces/OrgA2PBrandSummary.md)\[] Defined in: [packages/sdk/src/types/organization-types.ts:214](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/organization-types.ts#L214) --- # Interface: OrgA2PBrandSummary Defined in: [packages/sdk/src/types/organization-types.ts:205](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/organization-types.ts#L205) One A2P brand in the org broker view (subset the consent editor reads). ## Properties[​](#properties "Direct link to Properties") ### brandStatus?[​](#brandstatus "Direct link to brandStatus?") > `optional` **brandStatus**: `string` | `null` Defined in: [packages/sdk/src/types/organization-types.ts:208](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/organization-types.ts#L208) *** ### campaignStatus?[​](#campaignstatus "Direct link to campaignStatus?") > `optional` **campaignStatus**: `string` | `null` Defined in: [packages/sdk/src/types/organization-types.ts:209](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/organization-types.ts#L209) *** ### displayName[​](#displayname "Direct link to displayName") > **displayName**: `string` Defined in: [packages/sdk/src/types/organization-types.ts:207](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/organization-types.ts#L207) *** ### evidenceUrl[​](#evidenceurl "Direct link to evidenceUrl") > **evidenceUrl**: `string` Defined in: [packages/sdk/src/types/organization-types.ts:210](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/organization-types.ts#L210) *** ### uuid[​](#uuid "Direct link to uuid") > **uuid**: `string` Defined in: [packages/sdk/src/types/organization-types.ts:206](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/organization-types.ts#L206) --- # Interface: OrgAccessDeniedData Defined in: [packages/sdk/src/types/organization-types.ts:157](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/organization-types.ts#L157) ## Properties[​](#properties "Direct link to Properties") ### canSelfGrant[​](#canselfgrant "Direct link to canSelfGrant") > **canSelfGrant**: `true` Defined in: [packages/sdk/src/types/organization-types.ts:161](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/organization-types.ts#L161) *** ### code[​](#code "Direct link to code") > **code**: `"ORG_MEMBERSHIP_REQUIRED"` Defined in: [packages/sdk/src/types/organization-types.ts:160](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/organization-types.ts#L160) *** ### error[​](#error "Direct link to error") > **error**: `true` Defined in: [packages/sdk/src/types/organization-types.ts:158](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/organization-types.ts#L158) *** ### message[​](#message "Direct link to message") > **message**: `string` Defined in: [packages/sdk/src/types/organization-types.ts:159](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/organization-types.ts#L159) *** ### orgId[​](#orgid "Direct link to orgId") > **orgId**: `number` Defined in: [packages/sdk/src/types/organization-types.ts:162](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/organization-types.ts#L162) *** ### orgName[​](#orgname "Direct link to orgName") > **orgName**: `string` Defined in: [packages/sdk/src/types/organization-types.ts:164](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/organization-types.ts#L164) *** ### orgUuid[​](#orguuid "Direct link to orgUuid") > **orgUuid**: `string` Defined in: [packages/sdk/src/types/organization-types.ts:163](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/organization-types.ts#L163) --- # Interface: Organization Defined in: [packages/sdk/src/types/generated/organization.ts:526](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L526) Base organization response. ## Properties[​](#properties "Direct link to Properties") ### authMode?[​](#authmode "Direct link to authMode?") > `optional` **authMode**: `string` Defined in: [packages/sdk/src/types/generated/organization.ts:535](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L535) *** ### contactEmail?[​](#contactemail "Direct link to contactEmail?") > `optional` **contactEmail**: `string` | `null` Defined in: [packages/sdk/src/types/generated/organization.ts:533](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L533) *** ### contactPhone?[​](#contactphone "Direct link to contactPhone?") > `optional` **contactPhone**: `string` | `null` Defined in: [packages/sdk/src/types/generated/organization.ts:534](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L534) *** ### createdAt[​](#createdat "Direct link to createdAt") > **createdAt**: `string` Defined in: [packages/sdk/src/types/generated/organization.ts:536](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L536) *** ### creatorId?[​](#creatorid "Direct link to creatorId?") > `optional` **creatorId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/organization.ts:537](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L537) *** ### creatorName?[​](#creatorname "Direct link to creatorName?") > `optional` **creatorName**: `string` | `null` Defined in: [packages/sdk/src/types/generated/organization.ts:538](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L538) *** ### id[​](#id "Direct link to id") > **id**: `number` Defined in: [packages/sdk/src/types/generated/organization.ts:527](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L527) *** ### logoUrl?[​](#logourl "Direct link to logoUrl?") > `optional` **logoUrl**: `string` | `null` Defined in: [packages/sdk/src/types/generated/organization.ts:532](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L532) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/generated/organization.ts:529](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L529) *** ### primary[​](#primary "Direct link to primary") > **primary**: `boolean` Defined in: [packages/sdk/src/types/generated/organization.ts:531](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L531) *** ### resellerWorkspaceId?[​](#resellerworkspaceid "Direct link to resellerWorkspaceId?") > `optional` **resellerWorkspaceId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/organization.ts:539](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L539) *** ### resellerWorkspaceUuid?[​](#resellerworkspaceuuid "Direct link to resellerWorkspaceUuid?") > `optional` **resellerWorkspaceUuid**: `string` | `null` Defined in: [packages/sdk/src/types/generated/organization.ts:540](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L540) *** ### slug[​](#slug "Direct link to slug") > **slug**: `string` Defined in: [packages/sdk/src/types/generated/organization.ts:530](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L530) *** ### sso?[​](#sso "Direct link to sso?") > `optional` **sso**: [`SSOConfig`](https://docs.gravityrail.com/sdk/interfaces/SSOConfig.md) | `null` Defined in: [packages/sdk/src/types/generated/organization.ts:541](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L541) *** ### uuid[​](#uuid "Direct link to uuid") > **uuid**: `string` Defined in: [packages/sdk/src/types/generated/organization.ts:528](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L528) --- # Interface: OrganizationInvitationListResponse Defined in: [packages/sdk/src/types/generated/invitation.ts:149](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/invitation.ts#L149) Response model for listing organization invitations. ## Properties[​](#properties "Direct link to Properties") ### items[​](#items "Direct link to items") > **items**: `InvitationResponse`\[] Defined in: [packages/sdk/src/types/generated/invitation.ts:151](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/invitation.ts#L151) List of organization invitations *** ### page[​](#page "Direct link to page") > **page**: `number` Defined in: [packages/sdk/src/types/generated/invitation.ts:155](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/invitation.ts#L155) Current page number *** ### pageSize[​](#pagesize "Direct link to pageSize") > **pageSize**: `number` Defined in: [packages/sdk/src/types/generated/invitation.ts:157](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/invitation.ts#L157) Number of items per page *** ### total[​](#total "Direct link to total") > **total**: `number` Defined in: [packages/sdk/src/types/generated/invitation.ts:153](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/invitation.ts#L153) Total number of invitations --- # Interface: OrgAuthInfo Defined in: [packages/sdk/src/api/base.ts:84](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/base.ts#L84) Info parsed from WWW-Authenticate header for org auth requirement. ## Properties[​](#properties "Direct link to Properties") ### authUrl[​](#authurl "Direct link to authUrl") > **authUrl**: `string` Defined in: [packages/sdk/src/api/base.ts:87](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/base.ts#L87) *** ### cookieName[​](#cookiename "Direct link to cookieName") > **cookieName**: `string` Defined in: [packages/sdk/src/api/base.ts:86](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/base.ts#L86) *** ### orgUuid[​](#orguuid "Direct link to orgUuid") > **orgUuid**: `string` Defined in: [packages/sdk/src/api/base.ts:85](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/base.ts#L85) --- # Interface: OrgMember Defined in: [packages/sdk/src/types/account-types.ts:405](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L405) ## Extended by[​](#extended-by "Direct link to Extended by") * [`CurrentOrgMember`](https://docs.gravityrail.com/sdk/interfaces/CurrentOrgMember.md) ## Properties[​](#properties "Direct link to Properties") ### accountEmail?[​](#accountemail "Direct link to accountEmail?") > `optional` **accountEmail**: `string` | `null` Defined in: [packages/sdk/src/types/account-types.ts:416](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L416) *** ### accountId[​](#accountid "Direct link to accountId") > **accountId**: `number` | `null` Defined in: [packages/sdk/src/types/account-types.ts:407](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L407) *** ### accountName?[​](#accountname "Direct link to accountName?") > `optional` **accountName**: `string` | `null` Defined in: [packages/sdk/src/types/account-types.ts:415](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L415) *** ### accountPhone?[​](#accountphone "Direct link to accountPhone?") > `optional` **accountPhone**: `string` | `null` Defined in: [packages/sdk/src/types/account-types.ts:417](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L417) *** ### accountUuid?[​](#accountuuid "Direct link to accountUuid?") > `optional` **accountUuid**: `string` | `null` Defined in: [packages/sdk/src/types/account-types.ts:418](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L418) *** ### createdAt[​](#createdat "Direct link to createdAt") > **createdAt**: `string` Defined in: [packages/sdk/src/types/account-types.ts:412](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L412) *** ### externalId?[​](#externalid "Direct link to externalId?") > `optional` **externalId**: `string` | `null` Defined in: [packages/sdk/src/types/account-types.ts:411](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L411) *** ### id[​](#id "Direct link to id") > **id**: `number` Defined in: [packages/sdk/src/types/account-types.ts:406](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L406) *** ### name?[​](#name "Direct link to name?") > `optional` **name**: `string` | `null` Defined in: [packages/sdk/src/types/account-types.ts:410](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L410) *** ### organizationId[​](#organizationid "Direct link to organizationId") > **organizationId**: `number` Defined in: [packages/sdk/src/types/account-types.ts:408](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L408) *** ### role[​](#role "Direct link to role") > **role**: [`OrgMemberRole`](https://docs.gravityrail.com/sdk/type-aliases/OrgMemberRole.md) Defined in: [packages/sdk/src/types/account-types.ts:409](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L409) *** ### updatedAt[​](#updatedat "Direct link to updatedAt") > **updatedAt**: `string` Defined in: [packages/sdk/src/types/account-types.ts:413](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L413) --- # Interface: OrgMemberListResponse Defined in: [packages/sdk/src/types/account-types.ts:430](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L430) ## Properties[​](#properties "Direct link to Properties") ### items[​](#items "Direct link to items") > **items**: [`OrgMember`](https://docs.gravityrail.com/sdk/interfaces/OrgMember.md)\[] Defined in: [packages/sdk/src/types/account-types.ts:431](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L431) *** ### page[​](#page "Direct link to page") > **page**: `number` Defined in: [packages/sdk/src/types/account-types.ts:433](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L433) *** ### pageSize[​](#pagesize "Direct link to pageSize") > **pageSize**: `number` Defined in: [packages/sdk/src/types/account-types.ts:434](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L434) *** ### total[​](#total "Direct link to total") > **total**: `number` Defined in: [packages/sdk/src/types/account-types.ts:432](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L432) --- # Interface: OutboundCallRequest Defined in: [packages/sdk/src/types/communication-types.ts:172](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/communication-types.ts#L172) ## Properties[​](#properties "Direct link to Properties") ### chatId[​](#chatid "Direct link to chatId") > **chatId**: `number` Defined in: [packages/sdk/src/types/communication-types.ts:174](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/communication-types.ts#L174) *** ### phoneNumberId[​](#phonenumberid "Direct link to phoneNumberId") > **phoneNumberId**: `number` Defined in: [packages/sdk/src/types/communication-types.ts:173](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/communication-types.ts#L173) --- # Interface: OutboundCallResponse Defined in: [packages/sdk/src/types/communication-types.ts:167](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/communication-types.ts#L167) ## Properties[​](#properties "Direct link to Properties") ### call\_sid[​](#call_sid "Direct link to call_sid") > **call\_sid**: `string` Defined in: [packages/sdk/src/types/communication-types.ts:169](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/communication-types.ts#L169) *** ### status[​](#status "Direct link to status") > **status**: `string` Defined in: [packages/sdk/src/types/communication-types.ts:168](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/communication-types.ts#L168) --- # Interface: OwnershipVerificationResponse Defined in: [packages/sdk/src/types/generated/organization.ts:557](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L557) Result of running an ownership-proof DNS lookup. ## Properties[​](#properties "Direct link to Properties") ### domain[​](#domain "Direct link to domain") > **domain**: [`GeneratedOrgDomainResponse`](https://docs.gravityrail.com/sdk/interfaces/GeneratedOrgDomainResponse.md) Defined in: [packages/sdk/src/types/generated/organization.ts:560](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L560) *** ### message[​](#message "Direct link to message") > **message**: `string` Defined in: [packages/sdk/src/types/generated/organization.ts:559](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L559) *** ### status[​](#status "Direct link to status") > **status**: `string` Defined in: [packages/sdk/src/types/generated/organization.ts:558](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L558) --- # Interface: PageContext Defined in: [packages/sdk/src/app-context.ts:20](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/app-context.ts#L20) Information about a page in the context ## Properties[​](#properties "Direct link to Properties") ### id[​](#id "Direct link to id") > **id**: `number` Defined in: [packages/sdk/src/app-context.ts:21](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/app-context.ts#L21) *** ### name?[​](#name "Direct link to name?") > `optional` **name**: `string` Defined in: [packages/sdk/src/app-context.ts:22](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/app-context.ts#L22) *** ### slug?[​](#slug "Direct link to slug?") > `optional` **slug**: `string` Defined in: [packages/sdk/src/app-context.ts:23](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/app-context.ts#L23) --- # Interface: PageExport Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:156](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L156) ## Properties[​](#properties "Direct link to Properties") ### contentBlocks?[​](#contentblocks "Direct link to contentBlocks?") > `optional` **contentBlocks**: `any` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:163](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L163) *** ### contentHtml?[​](#contenthtml "Direct link to contentHtml?") > `optional` **contentHtml**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:162](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L162) *** ### contentMd?[​](#contentmd "Direct link to contentMd?") > `optional` **contentMd**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:161](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L161) *** ### siteUuid[​](#siteuuid "Direct link to siteUuid") > **siteUuid**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:158](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L158) *** ### slug[​](#slug "Direct link to slug") > **slug**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:159](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L159) *** ### sourceMetadata?[​](#sourcemetadata "Direct link to sourceMetadata?") > `optional` **sourceMetadata**: `Record`<`string`, `any`> Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:165](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L165) *** ### sourceUrl?[​](#sourceurl "Direct link to sourceUrl?") > `optional` **sourceUrl**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:164](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L164) *** ### title[​](#title "Direct link to title") > **title**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:160](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L160) *** ### uuid[​](#uuid "Direct link to uuid") > **uuid**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:157](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L157) --- # Interface: PageFormData Defined in: [packages/sdk/src/types/site-types.ts:82](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/site-types.ts#L82) ## Properties[​](#properties "Direct link to Properties") ### contentAMP?[​](#contentamp "Direct link to contentAMP?") > `optional` **contentAMP**: `string` | `null` Defined in: [packages/sdk/src/types/site-types.ts:87](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/site-types.ts#L87) *** ### contentBlocks?[​](#contentblocks "Direct link to contentBlocks?") > `optional` **contentBlocks**: [`TipTapDocumentOutput`](https://docs.gravityrail.com/sdk/interfaces/TipTapDocumentOutput.md) Defined in: [packages/sdk/src/types/site-types.ts:89](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/site-types.ts#L89) *** ### contentHtml?[​](#contenthtml "Direct link to contentHtml?") > `optional` **contentHtml**: `string` | `null` Defined in: [packages/sdk/src/types/site-types.ts:88](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/site-types.ts#L88) *** ### contentMarkdown?[​](#contentmarkdown "Direct link to contentMarkdown?") > `optional` **contentMarkdown**: `string` Defined in: [packages/sdk/src/types/site-types.ts:86](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/site-types.ts#L86) *** ### slug[​](#slug "Direct link to slug") > **slug**: `string` Defined in: [packages/sdk/src/types/site-types.ts:84](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/site-types.ts#L84) *** ### sourceHtml?[​](#sourcehtml "Direct link to sourceHtml?") > `optional` **sourceHtml**: `string` Defined in: [packages/sdk/src/types/site-types.ts:91](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/site-types.ts#L91) *** ### sourceMarkdown?[​](#sourcemarkdown "Direct link to sourceMarkdown?") > `optional` **sourceMarkdown**: `string` Defined in: [packages/sdk/src/types/site-types.ts:92](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/site-types.ts#L92) *** ### sourceMetadata?[​](#sourcemetadata "Direct link to sourceMetadata?") > `optional` **sourceMetadata**: `Record`<`string`, `any`> Defined in: [packages/sdk/src/types/site-types.ts:93](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/site-types.ts#L93) *** ### sourceUrl?[​](#sourceurl "Direct link to sourceUrl?") > `optional` **sourceUrl**: `string` Defined in: [packages/sdk/src/types/site-types.ts:90](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/site-types.ts#L90) *** ### status?[​](#status "Direct link to status?") > `optional` **status**: `string` Defined in: [packages/sdk/src/types/site-types.ts:85](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/site-types.ts#L85) *** ### title[​](#title "Direct link to title") > **title**: `string` Defined in: [packages/sdk/src/types/site-types.ts:83](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/site-types.ts#L83) --- # Interface: PageResponse Defined in: [packages/sdk/src/types/generated/site.ts:110](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L110) ## Properties[​](#properties "Direct link to Properties") ### contentAMP[​](#contentamp "Direct link to contentAMP") > **contentAMP**: `string` | `null` Defined in: [packages/sdk/src/types/generated/site.ts:119](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L119) *** ### contentBlocks[​](#contentblocks "Direct link to contentBlocks") > **contentBlocks**: [`TipTapDocumentOutput`](https://docs.gravityrail.com/sdk/interfaces/TipTapDocumentOutput.md) | `null` Defined in: [packages/sdk/src/types/generated/site.ts:116](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L116) *** ### contentHtml[​](#contenthtml "Direct link to contentHtml") > **contentHtml**: `string` | `null` Defined in: [packages/sdk/src/types/generated/site.ts:118](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L118) *** ### contentMarkdown[​](#contentmarkdown "Direct link to contentMarkdown") > **contentMarkdown**: `string` | `null` Defined in: [packages/sdk/src/types/generated/site.ts:117](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L117) *** ### crawledAt[​](#crawledat "Direct link to crawledAt") > **crawledAt**: `string` | `null` Defined in: [packages/sdk/src/types/generated/site.ts:126](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L126) *** ### createdAt[​](#createdat "Direct link to createdAt") > **createdAt**: `string` Defined in: [packages/sdk/src/types/generated/site.ts:124](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L124) *** ### id[​](#id "Direct link to id") > **id**: `number` Defined in: [packages/sdk/src/types/generated/site.ts:111](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L111) *** ### isHomePage?[​](#ishomepage "Direct link to isHomePage?") > `optional` **isHomePage**: `boolean` Defined in: [packages/sdk/src/types/generated/site.ts:128](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L128) *** ### siteId[​](#siteid "Direct link to siteId") > **siteId**: `number` Defined in: [packages/sdk/src/types/generated/site.ts:127](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L127) *** ### slug[​](#slug "Direct link to slug") > **slug**: `string` Defined in: [packages/sdk/src/types/generated/site.ts:112](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L112) *** ### sourceHtml[​](#sourcehtml "Direct link to sourceHtml") > **sourceHtml**: `string` | `null` Defined in: [packages/sdk/src/types/generated/site.ts:121](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L121) *** ### sourceMarkdown[​](#sourcemarkdown "Direct link to sourceMarkdown") > **sourceMarkdown**: `string` | `null` Defined in: [packages/sdk/src/types/generated/site.ts:122](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L122) *** ### sourceMetadata[​](#sourcemetadata "Direct link to sourceMetadata") > **sourceMetadata**: `PageResponseSourceMetadata` Defined in: [packages/sdk/src/types/generated/site.ts:120](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L120) *** ### sourceUrl[​](#sourceurl "Direct link to sourceUrl") > **sourceUrl**: `string` | `null` Defined in: [packages/sdk/src/types/generated/site.ts:123](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L123) *** ### status?[​](#status "Direct link to status?") > `optional` **status**: `string` Defined in: [packages/sdk/src/types/generated/site.ts:114](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L114) *** ### title[​](#title "Direct link to title") > **title**: `string` Defined in: [packages/sdk/src/types/generated/site.ts:113](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L113) *** ### updatedAt[​](#updatedat "Direct link to updatedAt") > **updatedAt**: `string` Defined in: [packages/sdk/src/types/generated/site.ts:125](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L125) *** ### url?[​](#url "Direct link to url?") > `optional` **url**: `string` | `null` Defined in: [packages/sdk/src/types/generated/site.ts:115](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L115) --- # Interface: PagesQueryParams Defined in: [packages/sdk/src/types/site-types.ts:96](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/site-types.ts#L96) ## Properties[​](#properties "Direct link to Properties") ### page?[​](#page "Direct link to page?") > `optional` **page**: `number` Defined in: [packages/sdk/src/types/site-types.ts:97](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/site-types.ts#L97) *** ### pageSize?[​](#pagesize "Direct link to pageSize?") > `optional` **pageSize**: `number` Defined in: [packages/sdk/src/types/site-types.ts:98](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/site-types.ts#L98) *** ### search?[​](#search "Direct link to search?") > `optional` **search**: `string` Defined in: [packages/sdk/src/types/site-types.ts:101](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/site-types.ts#L101) *** ### sortBy?[​](#sortby "Direct link to sortBy?") > `optional` **sortBy**: [`PageSortField`](https://docs.gravityrail.com/sdk/type-aliases/PageSortField.md) Defined in: [packages/sdk/src/types/site-types.ts:99](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/site-types.ts#L99) *** ### sortOrder?[​](#sortorder "Direct link to sortOrder?") > `optional` **sortOrder**: [`SortOrder`](https://docs.gravityrail.com/sdk/type-aliases/SortOrder.md) Defined in: [packages/sdk/src/types/site-types.ts:100](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/site-types.ts#L100) --- # Interface: PaginatedResponse\ Defined in: [packages/sdk/src/types/core-types.ts:4](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/core-types.ts#L4) ## Type Parameters[​](#type-parameters "Direct link to Type Parameters") ### T[​](#t "Direct link to T") `T` ## Properties[​](#properties "Direct link to Properties") ### items[​](#items "Direct link to items") > **items**: `T`\[] Defined in: [packages/sdk/src/types/core-types.ts:5](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/core-types.ts#L5) *** ### page[​](#page "Direct link to page") > **page**: `number` Defined in: [packages/sdk/src/types/core-types.ts:7](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/core-types.ts#L7) *** ### pageSize[​](#pagesize "Direct link to pageSize") > **pageSize**: `number` Defined in: [packages/sdk/src/types/core-types.ts:8](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/core-types.ts#L8) *** ### total[​](#total "Direct link to total") > **total**: `number` Defined in: [packages/sdk/src/types/core-types.ts:6](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/core-types.ts#L6) *** ### totalPages[​](#totalpages "Direct link to totalPages") > **totalPages**: `number` Defined in: [packages/sdk/src/types/core-types.ts:9](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/core-types.ts#L9) --- # Interface: PaginatedSubscriptionsResponse Defined in: [packages/sdk/src/types/generated/billing.ts:78](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/billing.ts#L78) Paginated response for subscriptions. ## Properties[​](#properties "Direct link to Properties") ### items[​](#items "Direct link to items") > **items**: `SubscriptionResponse`\[] Defined in: [packages/sdk/src/types/generated/billing.ts:79](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/billing.ts#L79) *** ### page[​](#page "Direct link to page") > **page**: `number` Defined in: [packages/sdk/src/types/generated/billing.ts:81](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/billing.ts#L81) *** ### pageSize[​](#pagesize "Direct link to pageSize") > **pageSize**: `number` Defined in: [packages/sdk/src/types/generated/billing.ts:82](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/billing.ts#L82) *** ### total[​](#total "Direct link to total") > **total**: `number` Defined in: [packages/sdk/src/types/generated/billing.ts:80](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/billing.ts#L80) *** ### totalPages[​](#totalpages "Direct link to totalPages") > **totalPages**: `number` Defined in: [packages/sdk/src/types/generated/billing.ts:83](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/billing.ts#L83) --- # Interface: PatientSyncConnectionStatus Defined in: [packages/sdk/src/api/patientsync-connections.ts:19](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/patientsync-connections.ts#L19) Current PatientSync connection state. Never includes the API key. ## Properties[​](#properties "Direct link to Properties") ### apiBaseUrl[​](#apibaseurl "Direct link to apiBaseUrl") > **apiBaseUrl**: `string` | `null` Defined in: [packages/sdk/src/api/patientsync-connections.ts:23](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/patientsync-connections.ts#L23) *** ### configured[​](#configured "Direct link to configured") > **configured**: `boolean` Defined in: [packages/sdk/src/api/patientsync-connections.ts:20](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/patientsync-connections.ts#L20) *** ### enabled[​](#enabled "Direct link to enabled") > **enabled**: `boolean` Defined in: [packages/sdk/src/api/patientsync-connections.ts:21](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/patientsync-connections.ts#L21) *** ### fallbackDid[​](#fallbackdid "Direct link to fallbackDid") > **fallbackDid**: `string` | `null` Defined in: [packages/sdk/src/api/patientsync-connections.ts:26](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/patientsync-connections.ts#L26) *** ### formSlug[​](#formslug "Direct link to formSlug") > **formSlug**: `string` | `null` Defined in: [packages/sdk/src/api/patientsync-connections.ts:25](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/patientsync-connections.ts#L25) *** ### hasApiKey[​](#hasapikey "Direct link to hasApiKey") > **hasApiKey**: `boolean` Defined in: [packages/sdk/src/api/patientsync-connections.ts:22](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/patientsync-connections.ts#L22) *** ### requestor[​](#requestor "Direct link to requestor") > **requestor**: `string` | `null` Defined in: [packages/sdk/src/api/patientsync-connections.ts:24](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/patientsync-connections.ts#L24) --- # Interface: PendingAnonymousMembersResponse Defined in: [packages/sdk/src/types/generated/member.ts:631](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L631) Response with list of pending anonymous member resolutions. ## Properties[​](#properties "Direct link to Properties") ### items[​](#items "Direct link to items") > **items**: [`AnonymousMemberResolutionResponse`](https://docs.gravityrail.com/sdk/interfaces/AnonymousMemberResolutionResponse.md)\[] Defined in: [packages/sdk/src/types/generated/member.ts:632](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L632) *** ### total[​](#total "Direct link to total") > **total**: `number` Defined in: [packages/sdk/src/types/generated/member.ts:633](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L633) --- # Interface: PendingCredentialChange Defined in: [packages/sdk/src/types/generated/account.ts:309](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L309) Response for a pending credential change request. ## Properties[​](#properties "Direct link to Properties") ### attempts[​](#attempts "Direct link to attempts") > **attempts**: `number` Defined in: [packages/sdk/src/types/generated/account.ts:316](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L316) *** ### createdAt[​](#createdat "Direct link to createdAt") > **createdAt**: `string` Defined in: [packages/sdk/src/types/generated/account.ts:313](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L313) *** ### credentialType[​](#credentialtype "Direct link to credentialType") > **credentialType**: `PendingCredentialChangeResponseCredentialType` Defined in: [packages/sdk/src/types/generated/account.ts:311](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L311) *** ### expiresAt[​](#expiresat "Direct link to expiresAt") > **expiresAt**: `string` Defined in: [packages/sdk/src/types/generated/account.ts:314](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L314) *** ### id[​](#id "Direct link to id") > **id**: `number` Defined in: [packages/sdk/src/types/generated/account.ts:310](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L310) *** ### isExpired[​](#isexpired "Direct link to isExpired") > **isExpired**: `boolean` Defined in: [packages/sdk/src/types/generated/account.ts:315](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L315) *** ### maskedNewValue[​](#maskednewvalue "Direct link to maskedNewValue") > **maskedNewValue**: `string` Defined in: [packages/sdk/src/types/generated/account.ts:312](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L312) --- # Interface: PendingCredentialChangeInvite Defined in: [packages/sdk/src/types/generated/account.ts:286](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L286) Response for a pending credential change invitation. ## Properties[​](#properties "Direct link to Properties") ### createdAt[​](#createdat "Direct link to createdAt") > **createdAt**: `string` Defined in: [packages/sdk/src/types/generated/account.ts:292](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L292) *** ### credentialType[​](#credentialtype "Direct link to credentialType") > **credentialType**: `PendingCredentialChangeInviteResponseCredentialType` Defined in: [packages/sdk/src/types/generated/account.ts:288](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L288) *** ### expiresAt[​](#expiresat "Direct link to expiresAt") > **expiresAt**: `string` Defined in: [packages/sdk/src/types/generated/account.ts:293](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L293) *** ### id[​](#id "Direct link to id") > **id**: `number` Defined in: [packages/sdk/src/types/generated/account.ts:287](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L287) *** ### initiatedByName[​](#initiatedbyname "Direct link to initiatedByName") > **initiatedByName**: `string` | `null` Defined in: [packages/sdk/src/types/generated/account.ts:291](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L291) *** ### isExpired[​](#isexpired "Direct link to isExpired") > **isExpired**: `boolean` Defined in: [packages/sdk/src/types/generated/account.ts:294](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L294) *** ### maskedNewValue[​](#maskednewvalue "Direct link to maskedNewValue") > **maskedNewValue**: `string` Defined in: [packages/sdk/src/types/generated/account.ts:289](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L289) *** ### status[​](#status "Direct link to status") > **status**: `string` Defined in: [packages/sdk/src/types/generated/account.ts:295](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L295) *** ### workspaceName[​](#workspacename "Direct link to workspaceName") > **workspaceName**: `string` Defined in: [packages/sdk/src/types/generated/account.ts:290](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L290) --- # Interface: PerformanceMetrics Defined in: [packages/sdk/src/types/stats-types.ts:85](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/stats-types.ts#L85) ## Properties[​](#properties "Direct link to Properties") ### averageResponseTime[​](#averageresponsetime "Direct link to averageResponseTime") > **averageResponseTime**: `number` Defined in: [packages/sdk/src/types/stats-types.ts:86](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/stats-types.ts#L86) *** ### errorRate[​](#errorrate "Direct link to errorRate") > **errorRate**: `number` Defined in: [packages/sdk/src/types/stats-types.ts:90](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/stats-types.ts#L90) *** ### memberSatisfactionScore[​](#membersatisfactionscore "Direct link to memberSatisfactionScore") > **memberSatisfactionScore**: `number` Defined in: [packages/sdk/src/types/stats-types.ts:88](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/stats-types.ts#L88) *** ### systemUptime[​](#systemuptime "Direct link to systemUptime") > **systemUptime**: `number` Defined in: [packages/sdk/src/types/stats-types.ts:89](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/stats-types.ts#L89) *** ### taskCompletionRate[​](#taskcompletionrate "Direct link to taskCompletionRate") > **taskCompletionRate**: `number` Defined in: [packages/sdk/src/types/stats-types.ts:87](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/stats-types.ts#L87) *** ### throughput[​](#throughput "Direct link to throughput") > **throughput**: `number` Defined in: [packages/sdk/src/types/stats-types.ts:91](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/stats-types.ts#L91) --- # Interface: PhoneAggregatedData Defined in: [packages/sdk/src/api/reports.ts:60](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/reports.ts#L60) Frontend aggregation of SMSUsageRow entries by phone number. ## Properties[​](#properties "Direct link to Properties") ### inbound[​](#inbound "Direct link to inbound") > **inbound**: `number` Defined in: [packages/sdk/src/api/reports.ts:65](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/reports.ts#L65) *** ### outbound[​](#outbound "Direct link to outbound") > **outbound**: `number` Defined in: [packages/sdk/src/api/reports.ts:66](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/reports.ts#L66) *** ### phoneName[​](#phonename "Direct link to phoneName") > **phoneName**: `string` | `null` Defined in: [packages/sdk/src/api/reports.ts:63](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/reports.ts#L63) *** ### phoneNumber[​](#phonenumber "Direct link to phoneNumber") > **phoneNumber**: `string` Defined in: [packages/sdk/src/api/reports.ts:62](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/reports.ts#L62) *** ### phoneNumberId[​](#phonenumberid "Direct link to phoneNumberId") > **phoneNumberId**: `number` Defined in: [packages/sdk/src/api/reports.ts:61](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/reports.ts#L61) *** ### totalChars[​](#totalchars "Direct link to totalChars") > **totalChars**: `number` Defined in: [packages/sdk/src/api/reports.ts:67](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/reports.ts#L67) *** ### totalMessages[​](#totalmessages "Direct link to totalMessages") > **totalMessages**: `number` Defined in: [packages/sdk/src/api/reports.ts:64](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/reports.ts#L64) *** ### totalSegments[​](#totalsegments "Direct link to totalSegments") > **totalSegments**: `number` Defined in: [packages/sdk/src/api/reports.ts:68](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/reports.ts#L68) --- # Interface: PhoneCall Defined in: [packages/sdk/src/types/generated/communication.ts:308](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L308) ## Properties[​](#properties "Direct link to Properties") ### agent?[​](#agent "Direct link to agent?") > `optional` **agent**: `BaseAssistantResponse` | `null` Defined in: [packages/sdk/src/types/generated/communication.ts:318](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L318) *** ### chatId?[​](#chatid "Direct link to chatId?") > `optional` **chatId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/communication.ts:311](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L311) *** ### createdAt[​](#createdat "Direct link to createdAt") > **createdAt**: `string` Defined in: [packages/sdk/src/types/generated/communication.ts:314](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L314) *** ### credits?[​](#credits "Direct link to credits?") > `optional` **credits**: `number` | `null` Defined in: [packages/sdk/src/types/generated/communication.ts:320](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L320) *** ### finishedAt?[​](#finishedat "Direct link to finishedAt?") > `optional` **finishedAt**: `string` | `null` Defined in: [packages/sdk/src/types/generated/communication.ts:316](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L316) *** ### id[​](#id "Direct link to id") > **id**: `number` Defined in: [packages/sdk/src/types/generated/communication.ts:309](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L309) *** ### inbound[​](#inbound "Direct link to inbound") > **inbound**: `boolean` Defined in: [packages/sdk/src/types/generated/communication.ts:319](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L319) *** ### member?[​](#member "Direct link to member?") > `optional` **member**: [`WorkspaceMemberResponse`](https://docs.gravityrail.com/sdk/interfaces/WorkspaceMemberResponse.md) | `null` Defined in: [packages/sdk/src/types/generated/communication.ts:317](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L317) *** ### phoneNumberId[​](#phonenumberid "Direct link to phoneNumberId") > **phoneNumberId**: `number` Defined in: [packages/sdk/src/types/generated/communication.ts:310](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L310) *** ### startedAt?[​](#startedat "Direct link to startedAt?") > `optional` **startedAt**: `string` | `null` Defined in: [packages/sdk/src/types/generated/communication.ts:315](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L315) *** ### status[​](#status "Direct link to status") > **status**: `string` Defined in: [packages/sdk/src/types/generated/communication.ts:313](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L313) *** ### terminationReason?[​](#terminationreason "Direct link to terminationReason?") > `optional` **terminationReason**: `string` | `null` Defined in: [packages/sdk/src/types/generated/communication.ts:322](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L322) How the call ended. One of: `completed` (caller hung up / normal end), `connection_reset` (carrier drop or WebRTC failure — Twilio reported a call ErrorCode), `stream_reset` (media-stream WebSocket reset, e.g. Twilio 31921 — our /media-stream socket dropped mid-call), `hangup` (assistant ended), `forward` (call forwarded), `busy` (line busy), `no-answer` (rang out), `failed` (Twilio rejected — invalid number, carrier error, etc.), `canceled` (canceled before connection), `timeout` (request killed before Twilio responded), `error` (legacy generic failure — new calls use the specific values above), `blocked_outbound_safety` (the dial was suppressed by the outbound safety gate before Twilio was contacted; the row carries `status=BLOCKED` and a synthetic `BLOCKED:{reason}` SID), or `null` for in-progress/unknown calls. *** ### twilioCallId[​](#twiliocallid "Direct link to twilioCallId") > **twilioCallId**: `string` Defined in: [packages/sdk/src/types/generated/communication.ts:312](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L312) *** ### workflowId?[​](#workflowid "Direct link to workflowId?") > `optional` **workflowId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/communication.ts:324](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L324) ID of the workflow associated with this call, resolved via the chat's assignment (PhoneCall.chat\_id -> Chat.assignment\_id -> Assignment.workflow\_id). Null for direct human-to-human calls with no chat, or chats with no assignment. --- # Interface: PhoneCallActionParams Defined in: [packages/sdk/src/types/event-types.ts:367](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L367) ## Properties[​](#properties "Direct link to Properties") ### phoneNumberUUID[​](#phonenumberuuid "Direct link to phoneNumberUUID") > **phoneNumberUUID**: `string` Defined in: [packages/sdk/src/types/event-types.ts:368](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L368) *** ### workflowUUID[​](#workflowuuid "Direct link to workflowUUID") > **workflowUUID**: `string` Defined in: [packages/sdk/src/types/event-types.ts:369](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L369) --- # Interface: PhoneCallAggregatedData Defined in: [packages/sdk/src/api/reports.ts:82](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/reports.ts#L82) Frontend aggregation of PhoneUsageRow entries by phone number. ## Properties[​](#properties "Direct link to Properties") ### inbound[​](#inbound "Direct link to inbound") > **inbound**: `number` Defined in: [packages/sdk/src/api/reports.ts:87](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/reports.ts#L87) *** ### outbound[​](#outbound "Direct link to outbound") > **outbound**: `number` Defined in: [packages/sdk/src/api/reports.ts:88](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/reports.ts#L88) *** ### phoneName[​](#phonename "Direct link to phoneName") > **phoneName**: `string` | `null` Defined in: [packages/sdk/src/api/reports.ts:85](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/reports.ts#L85) *** ### phoneNumber[​](#phonenumber "Direct link to phoneNumber") > **phoneNumber**: `string` Defined in: [packages/sdk/src/api/reports.ts:84](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/reports.ts#L84) *** ### phoneNumberId[​](#phonenumberid "Direct link to phoneNumberId") > **phoneNumberId**: `number` Defined in: [packages/sdk/src/api/reports.ts:83](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/reports.ts#L83) *** ### totalCalls[​](#totalcalls "Direct link to totalCalls") > **totalCalls**: `number` Defined in: [packages/sdk/src/api/reports.ts:86](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/reports.ts#L86) *** ### totalDurationSeconds[​](#totaldurationseconds "Direct link to totalDurationSeconds") > **totalDurationSeconds**: `number` Defined in: [packages/sdk/src/api/reports.ts:89](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/reports.ts#L89) --- # Interface: PhoneCallPhoneNumberUsageResponse Defined in: [packages/sdk/src/types/generated/usage.ts:89](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/usage.ts#L89) Phone call usage details for a phone number. ## Properties[​](#properties "Direct link to Properties") ### inbound[​](#inbound "Direct link to inbound") > **inbound**: `number` Defined in: [packages/sdk/src/types/generated/usage.ts:93](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/usage.ts#L93) *** ### outbound[​](#outbound "Direct link to outbound") > **outbound**: `number` Defined in: [packages/sdk/src/types/generated/usage.ts:94](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/usage.ts#L94) *** ### phoneName[​](#phonename "Direct link to phoneName") > **phoneName**: `string` | `null` Defined in: [packages/sdk/src/types/generated/usage.ts:92](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/usage.ts#L92) *** ### phoneNumber[​](#phonenumber "Direct link to phoneNumber") > **phoneNumber**: `string` Defined in: [packages/sdk/src/types/generated/usage.ts:91](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/usage.ts#L91) *** ### phoneNumberId[​](#phonenumberid "Direct link to phoneNumberId") > **phoneNumberId**: `number` Defined in: [packages/sdk/src/types/generated/usage.ts:90](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/usage.ts#L90) *** ### totalDurationSeconds[​](#totaldurationseconds "Direct link to totalDurationSeconds") > **totalDurationSeconds**: `number` Defined in: [packages/sdk/src/types/generated/usage.ts:95](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/usage.ts#L95) --- # Interface: PhoneCallToolsAbilityConfig Defined in: [packages/sdk/src/types/ability-types.ts:214](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ability-types.ts#L214) Config for phone\_call\_tools ability ## Properties[​](#properties "Direct link to Properties") ### allowFreeformForwarding?[​](#allowfreeformforwarding "Direct link to allowFreeformForwarding?") > `optional` **allowFreeformForwarding**: `boolean` Defined in: [packages/sdk/src/types/ability-types.ts:220](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ability-types.ts#L220) When true, the agent can also forward to any number (not just configured ones) *** ### canForward?[​](#canforward "Direct link to canForward?") > `optional` **canForward**: `boolean` Defined in: [packages/sdk/src/types/ability-types.ts:216](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ability-types.ts#L216) Allow the agent to forward the call to another number (phone-voice and web-voice) *** ### canSendDtmf?[​](#cansenddtmf "Direct link to canSendDtmf?") > `optional` **canSendDtmf**: `boolean` Defined in: [packages/sdk/src/types/ability-types.ts:222](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ability-types.ts#L222) Allow the agent to press keys (DTMF tones) on the active phone call to navigate phone menus. Phone-voice only. *** ### forwardingNumbers?[​](#forwardingnumbers "Direct link to forwardingNumbers?") > `optional` **forwardingNumbers**: [`ForwardingNumberDef`](https://docs.gravityrail.com/sdk/interfaces/ForwardingNumberDef.md)\[] Defined in: [packages/sdk/src/types/ability-types.ts:218](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ability-types.ts#L218) List of specific forwarding destinations the agent can use --- # Interface: PhoneCallUsageResponse Defined in: [packages/sdk/src/types/generated/usage.ts:101](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/usage.ts#L101) Phone call usage response. ## Properties[​](#properties "Direct link to Properties") ### inbound[​](#inbound "Direct link to inbound") > **inbound**: `number` Defined in: [packages/sdk/src/types/generated/usage.ts:103](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/usage.ts#L103) *** ### outbound[​](#outbound "Direct link to outbound") > **outbound**: `number` Defined in: [packages/sdk/src/types/generated/usage.ts:104](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/usage.ts#L104) *** ### totalMinutes[​](#totalminutes "Direct link to totalMinutes") > **totalMinutes**: `number` Defined in: [packages/sdk/src/types/generated/usage.ts:102](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/usage.ts#L102) --- # Interface: PhoneCommunicationDetailsResponse Defined in: [packages/sdk/src/types/generated/usage.ts:110](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/usage.ts#L110) Detailed phone communication data. ## Properties[​](#properties "Direct link to Properties") ### dailyRows[​](#dailyrows "Direct link to dailyRows") > **dailyRows**: [`DailyPhoneRowResponse`](https://docs.gravityrail.com/sdk/interfaces/DailyPhoneRowResponse.md)\[] Defined in: [packages/sdk/src/types/generated/usage.ts:112](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/usage.ts#L112) *** ### phoneNumbers[​](#phonenumbers "Direct link to phoneNumbers") > **phoneNumbers**: [`PhoneCallPhoneNumberUsageResponse`](https://docs.gravityrail.com/sdk/interfaces/PhoneCallPhoneNumberUsageResponse.md)\[] Defined in: [packages/sdk/src/types/generated/usage.ts:111](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/usage.ts#L111) --- # Interface: PhoneNumber Defined in: [packages/sdk/src/types/generated/communication.ts:327](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L327) ## Properties[​](#properties "Direct link to Properties") ### a2pStatus?[​](#a2pstatus "Direct link to a2pStatus?") > `optional` **a2pStatus**: `string` | `null` Defined in: [packages/sdk/src/types/generated/communication.ts:367](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L367) *** ### allowAnonymous[​](#allowanonymous "Direct link to allowAnonymous") > **allowAnonymous**: `boolean` Defined in: [packages/sdk/src/types/generated/communication.ts:338](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L338) *** ### allowSignup[​](#allowsignup "Direct link to allowSignup") > **allowSignup**: `boolean` Defined in: [packages/sdk/src/types/generated/communication.ts:337](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L337) *** ### anonymousMemberRoleId?[​](#anonymousmemberroleid "Direct link to anonymousMemberRoleId?") > `optional` **anonymousMemberRoleId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/communication.ts:340](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L340) *** ### anonymousRejectionMessage?[​](#anonymousrejectionmessage "Direct link to anonymousRejectionMessage?") > `optional` **anonymousRejectionMessage**: `string` | `null` Defined in: [packages/sdk/src/types/generated/communication.ts:358](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L358) *** ### assistantEnabled[​](#assistantenabled "Direct link to assistantEnabled") > **assistantEnabled**: `boolean` Defined in: [packages/sdk/src/types/generated/communication.ts:350](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L350) *** ### brandDescription[​](#branddescription "Direct link to brandDescription") > **brandDescription**: `string` | `null` Defined in: [packages/sdk/src/types/generated/communication.ts:333](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L333) *** ### brandName[​](#brandname "Direct link to brandName") > **brandName**: `string` | `null` Defined in: [packages/sdk/src/types/generated/communication.ts:332](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L332) *** ### brandWebsite[​](#brandwebsite "Direct link to brandWebsite") > **brandWebsite**: `string` | `null` Defined in: [packages/sdk/src/types/generated/communication.ts:334](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L334) *** ### createdAt[​](#createdat "Direct link to createdAt") > **createdAt**: `string` Defined in: [packages/sdk/src/types/generated/communication.ts:335](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L335) *** ### defaultWorkflowId?[​](#defaultworkflowid "Direct link to defaultWorkflowId?") > `optional` **defaultWorkflowId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/communication.ts:341](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L341) *** ### enableSms[​](#enablesms "Direct link to enableSms") > **enableSms**: `boolean` Defined in: [packages/sdk/src/types/generated/communication.ts:344](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L344) *** ### enableVoice[​](#enablevoice "Direct link to enableVoice") > **enableVoice**: `boolean` Defined in: [packages/sdk/src/types/generated/communication.ts:345](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L345) *** ### enableWhatsApp[​](#enablewhatsapp "Direct link to enableWhatsApp") > **enableWhatsApp**: `boolean` Defined in: [packages/sdk/src/types/generated/communication.ts:346](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L346) *** ### id[​](#id "Direct link to id") > **id**: `number` Defined in: [packages/sdk/src/types/generated/communication.ts:328](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L328) *** ### isArchived[​](#isarchived "Direct link to isArchived") > **isArchived**: `boolean` Defined in: [packages/sdk/src/types/generated/communication.ts:360](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L360) *** ### isMapped[​](#ismapped "Direct link to isMapped") > **isMapped**: `boolean` Defined in: [packages/sdk/src/types/generated/communication.ts:361](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L361) *** ### name[​](#name "Direct link to name") > **name**: `string` | `null` Defined in: [packages/sdk/src/types/generated/communication.ts:331](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L331) *** ### number[​](#number "Direct link to number") > **number**: `string` Defined in: [packages/sdk/src/types/generated/communication.ts:330](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L330) *** ### operatorGroupId?[​](#operatorgroupid "Direct link to operatorGroupId?") > `optional` **operatorGroupId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/communication.ts:364](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L364) *** ### operatorRingTimeoutSeconds?[​](#operatorringtimeoutseconds "Direct link to operatorRingTimeoutSeconds?") > `optional` **operatorRingTimeoutSeconds**: `number` | `null` Defined in: [packages/sdk/src/types/generated/communication.ts:365](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L365) *** ### providerPhoneUuid?[​](#providerphoneuuid "Direct link to providerPhoneUuid?") > `optional` **providerPhoneUuid**: `string` | `null` Defined in: [packages/sdk/src/types/generated/communication.ts:363](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L363) *** ### restartDelay?[​](#restartdelay "Direct link to restartDelay?") > `optional` **restartDelay**: `number` | `null` Defined in: [packages/sdk/src/types/generated/communication.ts:343](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L343) *** ### restartPrompt?[​](#restartprompt "Direct link to restartPrompt?") > `optional` **restartPrompt**: `string` | `null` Defined in: [packages/sdk/src/types/generated/communication.ts:342](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L342) *** ### signupMemberRoleId?[​](#signupmemberroleid "Direct link to signupMemberRoleId?") > `optional` **signupMemberRoleId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/communication.ts:339](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L339) *** ### smsForwardNumber?[​](#smsforwardnumber "Direct link to smsForwardNumber?") > `optional` **smsForwardNumber**: `string` | `null` Defined in: [packages/sdk/src/types/generated/communication.ts:353](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L353) *** ### smsOffHoursMessage?[​](#smsoffhoursmessage "Direct link to smsOffHoursMessage?") > `optional` **smsOffHoursMessage**: `string` | `null` Defined in: [packages/sdk/src/types/generated/communication.ts:352](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L352) *** ### smsUnavailableMessage?[​](#smsunavailablemessage "Direct link to smsUnavailableMessage?") > `optional` **smsUnavailableMessage**: `string` | `null` Defined in: [packages/sdk/src/types/generated/communication.ts:354](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L354) *** ### smsWorkMode?[​](#smsworkmode "Direct link to smsWorkMode?") > `optional` **smsWorkMode**: `string` | `null` Defined in: [packages/sdk/src/types/generated/communication.ts:351](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L351) *** ### twilioInboundReady[​](#twilioinboundready "Direct link to twilioInboundReady") > **twilioInboundReady**: `boolean` Defined in: [packages/sdk/src/types/generated/communication.ts:362](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L362) *** ### twilioNumberSid?[​](#twilionumbersid "Direct link to twilioNumberSid?") > `optional` **twilioNumberSid**: `string` | `null` Defined in: [packages/sdk/src/types/generated/communication.ts:366](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L366) *** ### updatedAt[​](#updatedat "Direct link to updatedAt") > **updatedAt**: `string` Defined in: [packages/sdk/src/types/generated/communication.ts:336](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L336) *** ### uuid[​](#uuid "Direct link to uuid") > **uuid**: `string` Defined in: [packages/sdk/src/types/generated/communication.ts:329](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L329) *** ### voiceForwardNumber?[​](#voiceforwardnumber "Direct link to voiceForwardNumber?") > `optional` **voiceForwardNumber**: `string` | `null` Defined in: [packages/sdk/src/types/generated/communication.ts:357](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L357) *** ### voiceGreetingMessage?[​](#voicegreetingmessage "Direct link to voiceGreetingMessage?") > `optional` **voiceGreetingMessage**: `string` | `null` Defined in: [packages/sdk/src/types/generated/communication.ts:348](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L348) *** ### voicemailGreeting?[​](#voicemailgreeting "Direct link to voicemailGreeting?") > `optional` **voicemailGreeting**: `string` | `null` Defined in: [packages/sdk/src/types/generated/communication.ts:359](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L359) *** ### voiceOffHoursMessage?[​](#voiceoffhoursmessage "Direct link to voiceOffHoursMessage?") > `optional` **voiceOffHoursMessage**: `string` | `null` Defined in: [packages/sdk/src/types/generated/communication.ts:356](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L356) *** ### voiceRequireConsent?[​](#voicerequireconsent "Direct link to voiceRequireConsent?") > `optional` **voiceRequireConsent**: `boolean` Defined in: [packages/sdk/src/types/generated/communication.ts:349](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L349) *** ### voiceUnavailableMessage?[​](#voiceunavailablemessage "Direct link to voiceUnavailableMessage?") > `optional` **voiceUnavailableMessage**: `string` | `null` Defined in: [packages/sdk/src/types/generated/communication.ts:347](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L347) *** ### voiceWorkMode?[​](#voiceworkmode "Direct link to voiceWorkMode?") > `optional` **voiceWorkMode**: `string` | `null` Defined in: [packages/sdk/src/types/generated/communication.ts:355](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L355) *** ### webhookWarning?[​](#webhookwarning "Direct link to webhookWarning?") > `optional` **webhookWarning**: `string` | `null` Defined in: [packages/sdk/src/types/generated/communication.ts:368](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L368) --- # Interface: PhoneNumberExport Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:81](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L81) ## Properties[​](#properties "Direct link to Properties") ### allowSignup[​](#allowsignup "Direct link to allowSignup") > **allowSignup**: `boolean` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:85](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L85) *** ### name?[​](#name "Direct link to name?") > `optional` **name**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:84](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L84) *** ### number[​](#number "Direct link to number") > **number**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:83](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L83) *** ### uuid[​](#uuid "Direct link to uuid") > **uuid**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:82](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L82) --- # Interface: PhoneNumberFormData Defined in: [packages/sdk/src/types/communication-types.ts:126](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/communication-types.ts#L126) ## Properties[​](#properties "Direct link to Properties") ### allowAnonymous?[​](#allowanonymous "Direct link to allowAnonymous?") > `optional` **allowAnonymous**: `boolean` Defined in: [packages/sdk/src/types/communication-types.ts:129](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/communication-types.ts#L129) *** ### allowSignup[​](#allowsignup "Direct link to allowSignup") > **allowSignup**: `boolean` Defined in: [packages/sdk/src/types/communication-types.ts:128](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/communication-types.ts#L128) *** ### anonymousMemberRoleId?[​](#anonymousmemberroleid "Direct link to anonymousMemberRoleId?") > `optional` **anonymousMemberRoleId**: `number` | `null` Defined in: [packages/sdk/src/types/communication-types.ts:131](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/communication-types.ts#L131) *** ### anonymousRejectionMessage?[​](#anonymousrejectionmessage "Direct link to anonymousRejectionMessage?") > `optional` **anonymousRejectionMessage**: `string` | `null` Defined in: [packages/sdk/src/types/communication-types.ts:149](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/communication-types.ts#L149) *** ### assistantEnabled?[​](#assistantenabled "Direct link to assistantEnabled?") > `optional` **assistantEnabled**: `boolean` Defined in: [packages/sdk/src/types/communication-types.ts:141](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/communication-types.ts#L141) *** ### defaultWorkflowId?[​](#defaultworkflowid "Direct link to defaultWorkflowId?") > `optional` **defaultWorkflowId**: `number` | `null` Defined in: [packages/sdk/src/types/communication-types.ts:132](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/communication-types.ts#L132) *** ### enableSms?[​](#enablesms "Direct link to enableSms?") > `optional` **enableSms**: `boolean` Defined in: [packages/sdk/src/types/communication-types.ts:135](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/communication-types.ts#L135) *** ### enableVoice?[​](#enablevoice "Direct link to enableVoice?") > `optional` **enableVoice**: `boolean` Defined in: [packages/sdk/src/types/communication-types.ts:136](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/communication-types.ts#L136) *** ### enableWhatsApp?[​](#enablewhatsapp "Direct link to enableWhatsApp?") > `optional` **enableWhatsApp**: `boolean` Defined in: [packages/sdk/src/types/communication-types.ts:137](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/communication-types.ts#L137) *** ### name?[​](#name "Direct link to name?") > `optional` **name**: `string` | `null` Defined in: [packages/sdk/src/types/communication-types.ts:127](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/communication-types.ts#L127) *** ### operatorGroupId?[​](#operatorgroupid "Direct link to operatorGroupId?") > `optional` **operatorGroupId**: `number` | `null` Defined in: [packages/sdk/src/types/communication-types.ts:151](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/communication-types.ts#L151) *** ### operatorRingTimeoutSeconds?[​](#operatorringtimeoutseconds "Direct link to operatorRingTimeoutSeconds?") > `optional` **operatorRingTimeoutSeconds**: `number` | `null` Defined in: [packages/sdk/src/types/communication-types.ts:152](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/communication-types.ts#L152) *** ### providerPhoneUuid?[​](#providerphoneuuid "Direct link to providerPhoneUuid?") > `optional` **providerPhoneUuid**: `string` | `null` Defined in: [packages/sdk/src/types/communication-types.ts:153](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/communication-types.ts#L153) *** ### restartDelay?[​](#restartdelay "Direct link to restartDelay?") > `optional` **restartDelay**: `number` | `null` Defined in: [packages/sdk/src/types/communication-types.ts:134](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/communication-types.ts#L134) *** ### restartPrompt?[​](#restartprompt "Direct link to restartPrompt?") > `optional` **restartPrompt**: `string` | `null` Defined in: [packages/sdk/src/types/communication-types.ts:133](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/communication-types.ts#L133) *** ### signupMemberRoleId?[​](#signupmemberroleid "Direct link to signupMemberRoleId?") > `optional` **signupMemberRoleId**: `number` | `null` Defined in: [packages/sdk/src/types/communication-types.ts:130](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/communication-types.ts#L130) *** ### smsForwardNumber?[​](#smsforwardnumber "Direct link to smsForwardNumber?") > `optional` **smsForwardNumber**: `string` | `null` Defined in: [packages/sdk/src/types/communication-types.ts:144](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/communication-types.ts#L144) *** ### smsOffHoursMessage?[​](#smsoffhoursmessage "Direct link to smsOffHoursMessage?") > `optional` **smsOffHoursMessage**: `string` | `null` Defined in: [packages/sdk/src/types/communication-types.ts:143](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/communication-types.ts#L143) *** ### smsUnavailableMessage?[​](#smsunavailablemessage "Direct link to smsUnavailableMessage?") > `optional` **smsUnavailableMessage**: `string` | `null` Defined in: [packages/sdk/src/types/communication-types.ts:145](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/communication-types.ts#L145) *** ### smsWorkMode?[​](#smsworkmode "Direct link to smsWorkMode?") > `optional` **smsWorkMode**: `string` | `null` Defined in: [packages/sdk/src/types/communication-types.ts:142](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/communication-types.ts#L142) *** ### voiceForwardNumber?[​](#voiceforwardnumber "Direct link to voiceForwardNumber?") > `optional` **voiceForwardNumber**: `string` | `null` Defined in: [packages/sdk/src/types/communication-types.ts:148](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/communication-types.ts#L148) *** ### voiceGreetingMessage?[​](#voicegreetingmessage "Direct link to voiceGreetingMessage?") > `optional` **voiceGreetingMessage**: `string` | `null` Defined in: [packages/sdk/src/types/communication-types.ts:139](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/communication-types.ts#L139) *** ### voicemailGreeting?[​](#voicemailgreeting "Direct link to voicemailGreeting?") > `optional` **voicemailGreeting**: `string` | `null` Defined in: [packages/sdk/src/types/communication-types.ts:150](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/communication-types.ts#L150) *** ### voiceOffHoursMessage?[​](#voiceoffhoursmessage "Direct link to voiceOffHoursMessage?") > `optional` **voiceOffHoursMessage**: `string` | `null` Defined in: [packages/sdk/src/types/communication-types.ts:147](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/communication-types.ts#L147) *** ### voiceRequireConsent?[​](#voicerequireconsent "Direct link to voiceRequireConsent?") > `optional` **voiceRequireConsent**: `boolean` Defined in: [packages/sdk/src/types/communication-types.ts:140](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/communication-types.ts#L140) *** ### voiceUnavailableMessage?[​](#voiceunavailablemessage "Direct link to voiceUnavailableMessage?") > `optional` **voiceUnavailableMessage**: `string` | `null` Defined in: [packages/sdk/src/types/communication-types.ts:138](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/communication-types.ts#L138) *** ### voiceWorkMode?[​](#voiceworkmode "Direct link to voiceWorkMode?") > `optional` **voiceWorkMode**: `string` | `null` Defined in: [packages/sdk/src/types/communication-types.ts:146](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/communication-types.ts#L146) --- # Interface: PhoneNumberUsage Defined in: [packages/sdk/src/types/usage-reporting-types.ts:47](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/usage-reporting-types.ts#L47) ## Properties[​](#properties "Direct link to Properties") ### inbound[​](#inbound "Direct link to inbound") > **inbound**: `number` Defined in: [packages/sdk/src/types/usage-reporting-types.ts:51](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/usage-reporting-types.ts#L51) *** ### outbound[​](#outbound "Direct link to outbound") > **outbound**: `number` Defined in: [packages/sdk/src/types/usage-reporting-types.ts:52](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/usage-reporting-types.ts#L52) *** ### phoneName[​](#phonename "Direct link to phoneName") > **phoneName**: `string` | `null` Defined in: [packages/sdk/src/types/usage-reporting-types.ts:50](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/usage-reporting-types.ts#L50) *** ### phoneNumber[​](#phonenumber "Direct link to phoneNumber") > **phoneNumber**: `string` Defined in: [packages/sdk/src/types/usage-reporting-types.ts:49](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/usage-reporting-types.ts#L49) *** ### phoneNumberId[​](#phonenumberid "Direct link to phoneNumberId") > **phoneNumberId**: `number` Defined in: [packages/sdk/src/types/usage-reporting-types.ts:48](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/usage-reporting-types.ts#L48) --- # Interface: PhoneUsageReport Defined in: [packages/sdk/src/types/generated/reports.ts:82](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/reports.ts#L82) Complete phone usage report for a workspace. ## Properties[​](#properties "Direct link to Properties") ### reportPeriodEnd[​](#reportperiodend "Direct link to reportPeriodEnd") > **reportPeriodEnd**: `string` Defined in: [packages/sdk/src/types/generated/reports.ts:87](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/reports.ts#L87) *** ### reportPeriodStart[​](#reportperiodstart "Direct link to reportPeriodStart") > **reportPeriodStart**: `string` Defined in: [packages/sdk/src/types/generated/reports.ts:86](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/reports.ts#L86) *** ### rows[​](#rows "Direct link to rows") > **rows**: [`PhoneUsageRow`](https://docs.gravityrail.com/sdk/interfaces/PhoneUsageRow.md)\[] Defined in: [packages/sdk/src/types/generated/reports.ts:92](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/reports.ts#L92) *** ### totalCalls[​](#totalcalls "Direct link to totalCalls") > **totalCalls**: `number` Defined in: [packages/sdk/src/types/generated/reports.ts:88](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/reports.ts#L88) *** ### totalDurationSeconds[​](#totaldurationseconds "Direct link to totalDurationSeconds") > **totalDurationSeconds**: `number` Defined in: [packages/sdk/src/types/generated/reports.ts:91](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/reports.ts#L91) *** ### totalInbound[​](#totalinbound "Direct link to totalInbound") > **totalInbound**: `number` Defined in: [packages/sdk/src/types/generated/reports.ts:89](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/reports.ts#L89) *** ### totalOutbound[​](#totaloutbound "Direct link to totalOutbound") > **totalOutbound**: `number` Defined in: [packages/sdk/src/types/generated/reports.ts:90](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/reports.ts#L90) *** ### workspaceId[​](#workspaceid "Direct link to workspaceId") > **workspaceId**: `number` Defined in: [packages/sdk/src/types/generated/reports.ts:83](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/reports.ts#L83) *** ### workspaceName[​](#workspacename "Direct link to workspaceName") > **workspaceName**: `string` Defined in: [packages/sdk/src/types/generated/reports.ts:85](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/reports.ts#L85) *** ### workspaceUuid[​](#workspaceuuid "Direct link to workspaceUuid") > **workspaceUuid**: `string` Defined in: [packages/sdk/src/types/generated/reports.ts:84](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/reports.ts#L84) --- # Interface: PhoneUsageReportParams Defined in: [packages/sdk/src/api/reports.ts:44](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/reports.ts#L44) ## Properties[​](#properties "Direct link to Properties") ### end\_date?[​](#end_date "Direct link to end_date?") > `optional` **end\_date**: `string` Defined in: [packages/sdk/src/api/reports.ts:46](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/reports.ts#L46) *** ### start\_date?[​](#start_date "Direct link to start_date?") > `optional` **start\_date**: `string` Defined in: [packages/sdk/src/api/reports.ts:45](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/reports.ts#L45) --- # Interface: PhoneUsageRow Defined in: [packages/sdk/src/types/generated/reports.ts:98](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/reports.ts#L98) Phone usage data for a specific phone number and date combination. ## Properties[​](#properties "Direct link to Properties") ### date[​](#date "Direct link to date") > **date**: `string` Defined in: [packages/sdk/src/types/generated/reports.ts:99](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/reports.ts#L99) *** ### inbound[​](#inbound "Direct link to inbound") > **inbound**: `number` Defined in: [packages/sdk/src/types/generated/reports.ts:103](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/reports.ts#L103) *** ### outbound[​](#outbound "Direct link to outbound") > **outbound**: `number` Defined in: [packages/sdk/src/types/generated/reports.ts:104](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/reports.ts#L104) *** ### phoneName[​](#phonename "Direct link to phoneName") > **phoneName**: `string` | `null` Defined in: [packages/sdk/src/types/generated/reports.ts:102](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/reports.ts#L102) *** ### phoneNumber[​](#phonenumber "Direct link to phoneNumber") > **phoneNumber**: `string` Defined in: [packages/sdk/src/types/generated/reports.ts:101](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/reports.ts#L101) *** ### phoneNumberId[​](#phonenumberid "Direct link to phoneNumberId") > **phoneNumberId**: `number` Defined in: [packages/sdk/src/types/generated/reports.ts:100](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/reports.ts#L100) *** ### totalDurationSeconds[​](#totaldurationseconds "Direct link to totalDurationSeconds") > **totalDurationSeconds**: `number` Defined in: [packages/sdk/src/types/generated/reports.ts:105](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/reports.ts#L105) --- # Interface: PlanComparisonResult Defined in: [packages/sdk/src/types/generated/billing.ts:89](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/billing.ts#L89) Comparison result for a single product plan ## Properties[​](#properties "Direct link to Properties") ### differences?[​](#differences "Direct link to differences?") > `optional` **differences**: `string`\[] Defined in: [packages/sdk/src/types/generated/billing.ts:93](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/billing.ts#L93) *** ### localPlan[​](#localplan "Direct link to localPlan") > **localPlan**: [`ProductPlan`](https://docs.gravityrail.com/sdk/interfaces/ProductPlan.md) Defined in: [packages/sdk/src/types/generated/billing.ts:90](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/billing.ts#L90) *** ### status[​](#status "Direct link to status") > **status**: `string` Defined in: [packages/sdk/src/types/generated/billing.ts:92](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/billing.ts#L92) *** ### stripePrice[​](#stripeprice "Direct link to stripePrice") > **stripePrice**: [`StripePrice`](https://docs.gravityrail.com/sdk/interfaces/StripePrice.md) | `null` Defined in: [packages/sdk/src/types/generated/billing.ts:91](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/billing.ts#L91) --- # Interface: PlanConfiguration Defined in: [packages/sdk/src/types/generated/billing.ts:99](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/billing.ts#L99) Configuration for a single billing period plan. ## Properties[​](#properties "Direct link to Properties") ### costPerPeriod?[​](#costperperiod "Direct link to costPerPeriod?") > `optional` **costPerPeriod**: `number` | `null` Defined in: [packages/sdk/src/types/generated/billing.ts:101](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/billing.ts#L101) *** ### isTest?[​](#istest "Direct link to isTest?") > `optional` **isTest**: `boolean` Defined in: [packages/sdk/src/types/generated/billing.ts:104](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/billing.ts#L104) *** ### stripePriceId?[​](#stripepriceid "Direct link to stripePriceId?") > `optional` **stripePriceId**: `string` | `null` Defined in: [packages/sdk/src/types/generated/billing.ts:100](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/billing.ts#L100) *** ### upfrontFee?[​](#upfrontfee "Direct link to upfrontFee?") > `optional` **upfrontFee**: `number` | `null` Defined in: [packages/sdk/src/types/generated/billing.ts:102](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/billing.ts#L102) *** ### upfrontFeeStripePriceId?[​](#upfrontfeestripepriceid "Direct link to upfrontFeeStripePriceId?") > `optional` **upfrontFeeStripePriceId**: `string` | `null` Defined in: [packages/sdk/src/types/generated/billing.ts:103](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/billing.ts#L103) --- # Interface: PlatformAppConnectionResponse Defined in: [packages/sdk/src/types/generated/app\_connection.ts:337](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L337) Platform app connection response. ## Properties[​](#properties "Direct link to Properties") ### allowMultipleMemberAccounts?[​](#allowmultiplememberaccounts "Direct link to allowMultipleMemberAccounts?") > `optional` **allowMultipleMemberAccounts**: `boolean` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:352](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L352) *** ### authorizedAt?[​](#authorizedat "Direct link to authorizedAt?") > `optional` **authorizedAt**: `string` | `null` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:351](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L351) *** ### authorizedByMemberId?[​](#authorizedbymemberid "Direct link to authorizedByMemberId?") > `optional` **authorizedByMemberId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:350](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L350) *** ### config?[​](#config "Direct link to config?") > `optional` **config**: `PlatformAppConnectionResponseConfig` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:345](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L345) *** ### connectionType?[​](#connectiontype "Direct link to connectionType?") > `optional` **connectionType**: `"platform_app"` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:338](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L338) *** ### createdAt?[​](#createdat "Direct link to createdAt?") > `optional` **createdAt**: `string` | `null` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:346](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L346) *** ### creatorId?[​](#creatorid "Direct link to creatorId?") > `optional` **creatorId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:343](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L343) *** ### displayLabel?[​](#displaylabel "Direct link to displayLabel?") > `optional` **displayLabel**: `string` | `null` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:349](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L349) *** ### enabled[​](#enabled "Direct link to enabled") > **enabled**: `boolean` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:342](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L342) *** ### externalEmail?[​](#externalemail "Direct link to externalEmail?") > `optional` **externalEmail**: `string` | `null` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:348](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L348) *** ### id[​](#id "Direct link to id") > **id**: `number` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:339](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L339) *** ### myLinkedAccountCount?[​](#mylinkedaccountcount "Direct link to myLinkedAccountCount?") > `optional` **myLinkedAccountCount**: `number` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:353](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L353) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:341](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L341) *** ### slug[​](#slug "Direct link to slug") > **slug**: `string` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:344](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L344) *** ### updatedAt?[​](#updatedat "Direct link to updatedAt?") > `optional` **updatedAt**: `string` | `null` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:347](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L347) *** ### uuid[​](#uuid "Direct link to uuid") > **uuid**: `string` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:340](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L340) --- # Interface: PlatformUsageData Defined in: [packages/sdk/src/types/billing-types.ts:283](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L283) Simplified platform usage data for display components. This is the shared interface used by PlatformUsageCard across all views: * Workspace billing dashboard (/w/$wid/settings/billing) * Admin workspace billing tab (/admin/workspaces/$wid) ## Properties[​](#properties "Direct link to Properties") ### included[​](#included "Direct link to included") > **included**: `Partial`<`Record`<[`Resource`](https://docs.gravityrail.com/sdk/enumerations/Resource.md), `number`>> Defined in: [packages/sdk/src/types/billing-types.ts:287](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L287) *** ### overages[​](#overages "Direct link to overages") > **overages**: `Partial`<`Record`<[`Resource`](https://docs.gravityrail.com/sdk/enumerations/Resource.md), [`ResourceOverage`](https://docs.gravityrail.com/sdk/interfaces/ResourceOverage.md)>> Defined in: [packages/sdk/src/types/billing-types.ts:288](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L288) *** ### periodEnd[​](#periodend "Direct link to periodEnd") > **periodEnd**: `string` Defined in: [packages/sdk/src/types/billing-types.ts:285](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L285) *** ### periodStart[​](#periodstart "Direct link to periodStart") > **periodStart**: `string` Defined in: [packages/sdk/src/types/billing-types.ts:284](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L284) *** ### usage[​](#usage "Direct link to usage") > **usage**: `Partial`<`Record`<[`Resource`](https://docs.gravityrail.com/sdk/enumerations/Resource.md), `number`>> Defined in: [packages/sdk/src/types/billing-types.ts:286](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L286) --- # Interface: PlayAudioActionParams Defined in: [packages/sdk/src/types/event-types.ts:326](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L326) Parameters for the `audio:play` event-rule action. Plays a pre-recorded workspace audio file on the current voice call. Composes with `task:execute` rules + CEL conditions on `call.answered_by` to deliver guaranteed-delivery disclosure recordings without the LLM in the loop. See the backend handler at `lib/rules/actions/builtin/play_audio.py`. ## Properties[​](#properties "Direct link to Properties") ### allowInterrupt?[​](#allowinterrupt "Direct link to allowInterrupt?") > `optional` **allowInterrupt**: `boolean` Defined in: [packages/sdk/src/types/event-types.ts:334](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L334) When false, the clip plays end-to-end ignoring barge-in. Pair with `hangUpOnAudioEnd: true` for compliance recordings that must not be interrupted by speech. Defaults to true. *** ### clipFileUuid[​](#clipfileuuid "Direct link to clipFileUuid") > **clipFileUuid**: `string` Defined in: [packages/sdk/src/types/event-types.ts:328](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L328) UUID of the workspace File row to play. Required. *** ### hangUpOnAudioEnd?[​](#hanguponaudioend "Direct link to hangUpOnAudioEnd?") > `optional` **hangUpOnAudioEnd**: `boolean` Defined in: [packages/sdk/src/types/event-types.ts:339](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L339) When true, the call hangs up immediately after the clip finishes streaming — no further LLM turns. Defaults to false. *** ### volume?[​](#volume "Direct link to volume?") > `optional` **volume**: `number` Defined in: [packages/sdk/src/types/event-types.ts:347](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L347) Playback volume as a percent in \[0, 100]. `80` is the unity baseline — no gain adjustment is applied. Higher values boost, lower values attenuate. Clipped at the int16 ceiling so a 100% setting on already-hot source material won't introduce distortion beyond the source's own. Defaults to 80. --- # Interface: PresenceAcceptInteractionMessage Defined in: [packages/sdk/src/types/operator-types.ts:41](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/operator-types.ts#L41) Client -> Server: Accept an incoming interaction ## Properties[​](#properties "Direct link to Properties") ### channel?[​](#channel "Direct link to channel?") > `optional` **channel**: `string` Defined in: [packages/sdk/src/types/operator-types.ts:45](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/operator-types.ts#L45) *** ### chat\_id?[​](#chat_id "Direct link to chat_id?") > `optional` **chat\_id**: `number` Defined in: [packages/sdk/src/types/operator-types.ts:44](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/operator-types.ts#L44) *** ### interaction\_id[​](#interaction_id "Direct link to interaction_id") > **interaction\_id**: `string` Defined in: [packages/sdk/src/types/operator-types.ts:43](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/operator-types.ts#L43) *** ### type[​](#type "Direct link to type") > **type**: `"accept_interaction"` Defined in: [packages/sdk/src/types/operator-types.ts:42](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/operator-types.ts#L42) *** ### workflow\_id?[​](#workflow_id "Direct link to workflow_id?") > `optional` **workflow\_id**: `number` Defined in: [packages/sdk/src/types/operator-types.ts:46](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/operator-types.ts#L46) --- # Interface: PresenceConfirmation Defined in: [packages/sdk/src/types/operator-types.ts:115](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/operator-types.ts#L115) Server -> Client: Confirmation of live status ## Properties[​](#properties "Direct link to Properties") ### status[​](#status "Direct link to status") > **status**: [`OperatorLiveStatus`](https://docs.gravityrail.com/sdk/type-aliases/OperatorLiveStatus.md) Defined in: [packages/sdk/src/types/operator-types.ts:117](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/operator-types.ts#L117) *** ### type[​](#type "Direct link to type") > **type**: `"presence_confirmed"` Defined in: [packages/sdk/src/types/operator-types.ts:116](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/operator-types.ts#L116) --- # Interface: PresenceEndInteractionMessage Defined in: [packages/sdk/src/types/operator-types.ts:67](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/operator-types.ts#L67) Client -> Server: End the active interaction and release the chat ## Properties[​](#properties "Direct link to Properties") ### chat\_id[​](#chat_id "Direct link to chat_id") > **chat\_id**: `number` Defined in: [packages/sdk/src/types/operator-types.ts:69](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/operator-types.ts#L69) *** ### type[​](#type "Direct link to type") > **type**: `"end_interaction"` Defined in: [packages/sdk/src/types/operator-types.ts:68](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/operator-types.ts#L68) --- # Interface: PresenceError Defined in: [packages/sdk/src/types/operator-types.ts:121](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/operator-types.ts#L121) Server -> Client: Error message ## Properties[​](#properties "Direct link to Properties") ### code?[​](#code "Direct link to code?") > `optional` **code**: `string` Defined in: [packages/sdk/src/types/operator-types.ts:124](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/operator-types.ts#L124) *** ### message[​](#message "Direct link to message") > **message**: `string` Defined in: [packages/sdk/src/types/operator-types.ts:123](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/operator-types.ts#L123) *** ### type[​](#type "Direct link to type") > **type**: `"error"` Defined in: [packages/sdk/src/types/operator-types.ts:122](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/operator-types.ts#L122) --- # Interface: PresenceGoLiveMessage Defined in: [packages/sdk/src/types/operator-types.ts:24](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/operator-types.ts#L24) Client -> Server: Go live ## Properties[​](#properties "Direct link to Properties") ### type[​](#type "Direct link to type") > **type**: `"go_live"` Defined in: [packages/sdk/src/types/operator-types.ts:25](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/operator-types.ts#L25) *** ### workflow\_ids?[​](#workflow_ids "Direct link to workflow_ids?") > `optional` **workflow\_ids**: `number`\[] Defined in: [packages/sdk/src/types/operator-types.ts:27](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/operator-types.ts#L27) Workflow IDs the operator is available for. Empty array means all workflows. --- # Interface: PresenceGoOfflineMessage Defined in: [packages/sdk/src/types/operator-types.ts:31](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/operator-types.ts#L31) Client -> Server: Go offline ## Properties[​](#properties "Direct link to Properties") ### type[​](#type "Direct link to type") > **type**: `"go_offline"` Defined in: [packages/sdk/src/types/operator-types.ts:32](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/operator-types.ts#L32) --- # Interface: PresenceHeartbeatMessage Defined in: [packages/sdk/src/types/operator-types.ts:36](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/operator-types.ts#L36) Client -> Server: Heartbeat to maintain presence ## Properties[​](#properties "Direct link to Properties") ### type[​](#type "Direct link to type") > **type**: `"heartbeat"` Defined in: [packages/sdk/src/types/operator-types.ts:37](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/operator-types.ts#L37) --- # Interface: PresenceLoginAck Defined in: [packages/sdk/src/types/operator-types.ts:133](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/operator-types.ts#L133) Server -> Client: Login acknowledged ## Properties[​](#properties "Direct link to Properties") ### ok[​](#ok "Direct link to ok") > **ok**: `boolean` Defined in: [packages/sdk/src/types/operator-types.ts:135](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/operator-types.ts#L135) *** ### type[​](#type "Direct link to type") > **type**: `"login_ack"` Defined in: [packages/sdk/src/types/operator-types.ts:134](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/operator-types.ts#L134) --- # Interface: PresenceLoginMessage Defined in: [packages/sdk/src/types/operator-types.ts:61](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/operator-types.ts#L61) Client -> Server: Login message sent as the first message after connecting ## Properties[​](#properties "Direct link to Properties") ### token[​](#token "Direct link to token") > **token**: `string` Defined in: [packages/sdk/src/types/operator-types.ts:63](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/operator-types.ts#L63) *** ### type[​](#type "Direct link to type") > **type**: `"login"` Defined in: [packages/sdk/src/types/operator-types.ts:62](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/operator-types.ts#L62) --- # Interface: PresenceRejectInteractionMessage Defined in: [packages/sdk/src/types/operator-types.ts:50](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/operator-types.ts#L50) Client -> Server: Reject an incoming interaction ## Properties[​](#properties "Direct link to Properties") ### interaction\_id[​](#interaction_id "Direct link to interaction_id") > **interaction\_id**: `string` Defined in: [packages/sdk/src/types/operator-types.ts:52](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/operator-types.ts#L52) *** ### type[​](#type "Direct link to type") > **type**: `"reject_interaction"` Defined in: [packages/sdk/src/types/operator-types.ts:51](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/operator-types.ts#L51) --- # Interface: PresenceStatusResponse Defined in: [packages/sdk/src/types/generated/operator.ts:46](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/operator.ts#L46) ## Properties[​](#properties "Direct link to Properties") ### isLive[​](#islive "Direct link to isLive") > **isLive**: `boolean` Defined in: [packages/sdk/src/types/generated/operator.ts:47](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/operator.ts#L47) --- # Interface: PresenceTakenOverAckMessage Defined in: [packages/sdk/src/types/operator-types.ts:56](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/operator-types.ts#L56) Client -> Server: Acknowledge session takeover (so server skips go\_offline) ## Properties[​](#properties "Direct link to Properties") ### type[​](#type "Direct link to type") > **type**: `"taken_over_ack"` Defined in: [packages/sdk/src/types/operator-types.ts:57](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/operator-types.ts#L57) --- # Interface: ProductFeature Defined in: [packages/sdk/src/types/billing-types.ts:133](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L133) ## Properties[​](#properties "Direct link to Properties") ### createdAt[​](#createdat "Direct link to createdAt") > **createdAt**: `string` Defined in: [packages/sdk/src/types/billing-types.ts:137](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L137) *** ### featureKey[​](#featurekey "Direct link to featureKey") > **featureKey**: `string` Defined in: [packages/sdk/src/types/billing-types.ts:136](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L136) *** ### id[​](#id "Direct link to id") > **id**: `number` Defined in: [packages/sdk/src/types/billing-types.ts:134](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L134) *** ### productId[​](#productid "Direct link to productId") > **productId**: `number` Defined in: [packages/sdk/src/types/billing-types.ts:135](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L135) --- # Interface: ProductImage Defined in: [packages/sdk/src/types/generated/billing.ts:130](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/billing.ts#L130) Represents an image in product metadata. ## Properties[​](#properties "Direct link to Properties") ### caption?[​](#caption "Direct link to caption?") > `optional` **caption**: `string` | `null` Defined in: [packages/sdk/src/types/generated/billing.ts:132](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/billing.ts#L132) *** ### url[​](#url "Direct link to url") > **url**: `string` Defined in: [packages/sdk/src/types/generated/billing.ts:131](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/billing.ts#L131) --- # Interface: ProductLink Defined in: [packages/sdk/src/types/generated/billing.ts:138](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/billing.ts#L138) Represents a link in product metadata. ## Properties[​](#properties "Direct link to Properties") ### title[​](#title "Direct link to title") > **title**: `string` Defined in: [packages/sdk/src/types/generated/billing.ts:140](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/billing.ts#L140) *** ### url[​](#url "Direct link to url") > **url**: `string` Defined in: [packages/sdk/src/types/generated/billing.ts:139](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/billing.ts#L139) --- # Interface: ProductMetadata Defined in: [packages/sdk/src/types/generated/billing.ts:146](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/billing.ts#L146) Structured metadata for products. ## Indexable[​](#indexable "Direct link to Indexable") \[`key`: `string`]: `unknown` ## Properties[​](#properties "Direct link to Properties") ### images?[​](#images "Direct link to images?") > `optional` **images**: [`ProductImage`](https://docs.gravityrail.com/sdk/interfaces/ProductImage.md)\[] | `null` Defined in: [packages/sdk/src/types/generated/billing.ts:147](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/billing.ts#L147) *** ### links?[​](#links "Direct link to links?") > `optional` **links**: [`ProductLink`](https://docs.gravityrail.com/sdk/interfaces/ProductLink.md)\[] | `null` Defined in: [packages/sdk/src/types/generated/billing.ts:148](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/billing.ts#L148) --- # Interface: ProductOverageConfig Defined in: [packages/sdk/src/types/generated/usage.ts:118](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/usage.ts#L118) Product overage configuration response. ## Properties[​](#properties "Direct link to Properties") ### id[​](#id "Direct link to id") > **id**: `number` | `null` Defined in: [packages/sdk/src/types/generated/usage.ts:119](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/usage.ts#L119) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/generated/usage.ts:120](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/usage.ts#L120) *** ### unitCost[​](#unitcost "Direct link to unitCost") > **unitCost**: `number` Defined in: [packages/sdk/src/types/generated/usage.ts:122](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/usage.ts#L122) *** ### unitType[​](#unittype "Direct link to unitType") > **unitType**: `string` Defined in: [packages/sdk/src/types/generated/usage.ts:121](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/usage.ts#L121) --- # Interface: ProductPlan Defined in: [packages/sdk/src/types/generated/billing.ts:66](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/billing.ts#L66) Local plan data from product.plans JSONB with period identifier ## Properties[​](#properties "Direct link to Properties") ### costPerPeriod?[​](#costperperiod "Direct link to costPerPeriod?") > `optional` **costPerPeriod**: `number` | `null` Defined in: [packages/sdk/src/types/generated/billing.ts:68](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/billing.ts#L68) *** ### isTest?[​](#istest "Direct link to isTest?") > `optional` **isTest**: `boolean` Defined in: [packages/sdk/src/types/generated/billing.ts:71](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/billing.ts#L71) *** ### period[​](#period "Direct link to period") > **period**: `string` Defined in: [packages/sdk/src/types/generated/billing.ts:72](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/billing.ts#L72) *** ### stripePriceId?[​](#stripepriceid "Direct link to stripePriceId?") > `optional` **stripePriceId**: `string` | `null` Defined in: [packages/sdk/src/types/generated/billing.ts:67](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/billing.ts#L67) *** ### upfrontFee?[​](#upfrontfee "Direct link to upfrontFee?") > `optional` **upfrontFee**: `number` | `null` Defined in: [packages/sdk/src/types/generated/billing.ts:69](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/billing.ts#L69) *** ### upfrontFeeStripePriceId?[​](#upfrontfeestripepriceid "Direct link to upfrontFeeStripePriceId?") > `optional` **upfrontFeeStripePriceId**: `string` | `null` Defined in: [packages/sdk/src/types/generated/billing.ts:70](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/billing.ts#L70) --- # Interface: PronunciationEntryResponse Defined in: [packages/sdk/src/types/generated/pronunciation.ts:44](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/pronunciation.ts#L44) ## Properties[​](#properties "Direct link to Properties") ### accountId?[​](#accountid "Direct link to accountId?") > `optional` **accountId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/pronunciation.ts:47](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/pronunciation.ts#L47) *** ### accountName?[​](#accountname "Direct link to accountName?") > `optional` **accountName**: `string` | `null` Defined in: [packages/sdk/src/types/generated/pronunciation.ts:48](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/pronunciation.ts#L48) *** ### createdAt[​](#createdat "Direct link to createdAt") > **createdAt**: `string` Defined in: [packages/sdk/src/types/generated/pronunciation.ts:52](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/pronunciation.ts#L52) *** ### id[​](#id "Direct link to id") > **id**: `number` Defined in: [packages/sdk/src/types/generated/pronunciation.ts:45](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/pronunciation.ts#L45) *** ### organizationId?[​](#organizationid "Direct link to organizationId?") > `optional` **organizationId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/pronunciation.ts:46](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/pronunciation.ts#L46) *** ### respelling[​](#respelling "Direct link to respelling") > **respelling**: `string` Defined in: [packages/sdk/src/types/generated/pronunciation.ts:51](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/pronunciation.ts#L51) *** ### term[​](#term "Direct link to term") > **term**: `string` Defined in: [packages/sdk/src/types/generated/pronunciation.ts:49](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/pronunciation.ts#L49) *** ### termNormalized[​](#termnormalized "Direct link to termNormalized") > **termNormalized**: `string` Defined in: [packages/sdk/src/types/generated/pronunciation.ts:50](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/pronunciation.ts#L50) *** ### updatedAt[​](#updatedat "Direct link to updatedAt") > **updatedAt**: `string` Defined in: [packages/sdk/src/types/generated/pronunciation.ts:53](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/pronunciation.ts#L53) --- # Interface: PronunciationImportEntry Defined in: [packages/sdk/src/types/generated/pronunciation.ts:56](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/pronunciation.ts#L56) ## Properties[​](#properties "Direct link to Properties") ### respelling[​](#respelling "Direct link to respelling") > **respelling**: `string` Defined in: [packages/sdk/src/types/generated/pronunciation.ts:66](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/pronunciation.ts#L66) #### Max Length[​](#max-length "Direct link to Max Length") 200 #### Pattern[​](#pattern "Direct link to Pattern") ^\[\w\s-.''\u00C0-\u024F]+$ *** ### term[​](#term "Direct link to term") > **term**: `string` Defined in: [packages/sdk/src/types/generated/pronunciation.ts:61](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/pronunciation.ts#L61) #### Max Length[​](#max-length-1 "Direct link to Max Length") 200 #### Pattern[​](#pattern-1 "Direct link to Pattern") ^\[\w\s-.''\u00C0-\u024F]+$ --- # Interface: PronunciationImportResult Defined in: [packages/sdk/src/types/generated/pronunciation.ts:73](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/pronunciation.ts#L73) ## Properties[​](#properties "Direct link to Properties") ### created[​](#created "Direct link to created") > **created**: `number` Defined in: [packages/sdk/src/types/generated/pronunciation.ts:74](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/pronunciation.ts#L74) *** ### total[​](#total "Direct link to total") > **total**: `number` Defined in: [packages/sdk/src/types/generated/pronunciation.ts:76](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/pronunciation.ts#L76) *** ### updated[​](#updated "Direct link to updated") > **updated**: `number` Defined in: [packages/sdk/src/types/generated/pronunciation.ts:75](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/pronunciation.ts#L75) --- # Interface: ProviderPhoneNumber Defined in: [packages/sdk/src/types/generated/communication.ts:374](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L374) Response model for provider phone number (Twilio/etc inventory). ## Properties[​](#properties "Direct link to Properties") ### createdAt[​](#createdat "Direct link to createdAt") > **createdAt**: `string` Defined in: [packages/sdk/src/types/generated/communication.ts:403](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L403) *** ### faxEnabled[​](#faxenabled "Direct link to faxEnabled") > **faxEnabled**: `boolean` Defined in: [packages/sdk/src/types/generated/communication.ts:391](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L391) *** ### friendlyName[​](#friendlyname "Direct link to friendlyName") > **friendlyName**: `string` | `null` Defined in: [packages/sdk/src/types/generated/communication.ts:380](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L380) *** ### id[​](#id "Direct link to id") > **id**: `number` Defined in: [packages/sdk/src/types/generated/communication.ts:375](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L375) *** ### isAssigned[​](#isassigned "Direct link to isAssigned") > **isAssigned**: `boolean` Defined in: [packages/sdk/src/types/generated/communication.ts:392](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L392) *** ### isoCountry[​](#isocountry "Direct link to isoCountry") > **isoCountry**: `string` | `null` Defined in: [packages/sdk/src/types/generated/communication.ts:383](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L383) *** ### lastSyncedAt[​](#lastsyncedat "Direct link to lastSyncedAt") > **lastSyncedAt**: `string` | `null` Defined in: [packages/sdk/src/types/generated/communication.ts:405](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L405) *** ### lata[​](#lata "Direct link to lata") > **lata**: `string` | `null` Defined in: [packages/sdk/src/types/generated/communication.ts:386](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L386) *** ### locality[​](#locality "Direct link to locality") > **locality**: `string` | `null` Defined in: [packages/sdk/src/types/generated/communication.ts:384](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L384) *** ### mmsEnabled[​](#mmsenabled "Direct link to mmsEnabled") > **mmsEnabled**: `boolean` Defined in: [packages/sdk/src/types/generated/communication.ts:390](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L390) *** ### organizationId[​](#organizationid "Direct link to organizationId") > **organizationId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/communication.ts:393](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L393) *** ### organizationName?[​](#organizationname "Direct link to organizationName?") > `optional` **organizationName**: `string` | `null` Defined in: [packages/sdk/src/types/generated/communication.ts:394](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L394) *** ### organizationUuid?[​](#organizationuuid "Direct link to organizationUuid?") > `optional` **organizationUuid**: `string` | `null` Defined in: [packages/sdk/src/types/generated/communication.ts:395](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L395) *** ### phoneNumber[​](#phonenumber "Direct link to phoneNumber") > **phoneNumber**: `string` Defined in: [packages/sdk/src/types/generated/communication.ts:378](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L378) *** ### phoneNumberType[​](#phonenumbertype "Direct link to phoneNumberType") > **phoneNumberType**: `string` | `null` Defined in: [packages/sdk/src/types/generated/communication.ts:381](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L381) *** ### postalCode[​](#postalcode "Direct link to postalCode") > **postalCode**: `string` | `null` Defined in: [packages/sdk/src/types/generated/communication.ts:385](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L385) *** ### provider[​](#provider "Direct link to provider") > **provider**: `string` Defined in: [packages/sdk/src/types/generated/communication.ts:377](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L377) *** ### rateCenter[​](#ratecenter "Direct link to rateCenter") > **rateCenter**: `string` | `null` Defined in: [packages/sdk/src/types/generated/communication.ts:387](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L387) *** ### region[​](#region "Direct link to region") > **region**: `string` | `null` Defined in: [packages/sdk/src/types/generated/communication.ts:382](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L382) *** ### sid[​](#sid "Direct link to sid") > **sid**: `string` Defined in: [packages/sdk/src/types/generated/communication.ts:379](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L379) *** ### smsEnabled[​](#smsenabled "Direct link to smsEnabled") > **smsEnabled**: `boolean` Defined in: [packages/sdk/src/types/generated/communication.ts:389](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L389) *** ### twilioAccountSid?[​](#twilioaccountsid "Direct link to twilioAccountSid?") > `optional` **twilioAccountSid**: `string` | `null` Defined in: [packages/sdk/src/types/generated/communication.ts:402](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L402) *** ### updatedAt[​](#updatedat "Direct link to updatedAt") > **updatedAt**: `string` Defined in: [packages/sdk/src/types/generated/communication.ts:404](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L404) *** ### uuid[​](#uuid "Direct link to uuid") > **uuid**: `string` Defined in: [packages/sdk/src/types/generated/communication.ts:376](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L376) *** ### voiceEnabled[​](#voiceenabled "Direct link to voiceEnabled") > **voiceEnabled**: `boolean` Defined in: [packages/sdk/src/types/generated/communication.ts:388](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L388) *** ### webhookWarning?[​](#webhookwarning "Direct link to webhookWarning?") > `optional` **webhookWarning**: `string` | `null` Defined in: [packages/sdk/src/types/generated/communication.ts:406](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L406) *** ### workspaceId[​](#workspaceid "Direct link to workspaceId") > **workspaceId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/communication.ts:396](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L396) *** ### workspaceName?[​](#workspacename "Direct link to workspaceName?") > `optional` **workspaceName**: `string` | `null` Defined in: [packages/sdk/src/types/generated/communication.ts:397](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L397) *** ### workspacePhoneId?[​](#workspacephoneid "Direct link to workspacePhoneId?") > `optional` **workspacePhoneId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/communication.ts:400](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L400) *** ### workspacePhoneName?[​](#workspacephonename "Direct link to workspacePhoneName?") > `optional` **workspacePhoneName**: `string` | `null` Defined in: [packages/sdk/src/types/generated/communication.ts:401](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L401) *** ### workspacePhoneUuid[​](#workspacephoneuuid "Direct link to workspacePhoneUuid") > **workspacePhoneUuid**: `string` | `null` Defined in: [packages/sdk/src/types/generated/communication.ts:399](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L399) *** ### workspaceUuid?[​](#workspaceuuid "Direct link to workspaceUuid?") > `optional` **workspaceUuid**: `string` | `null` Defined in: [packages/sdk/src/types/generated/communication.ts:398](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L398) --- # Interface: ProviderUsageSummary Defined in: [packages/sdk/src/types/generated/reports.ts:111](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/reports.ts#L111) Summary statistics for a provider. ## Properties[​](#properties "Direct link to Properties") ### models[​](#models "Direct link to models") > **models**: [`ModelUsageStats`](https://docs.gravityrail.com/sdk/interfaces/ModelUsageStats.md)\[] Defined in: [packages/sdk/src/types/generated/reports.ts:119](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/reports.ts#L119) *** ### provider[​](#provider "Direct link to provider") > **provider**: [`ModelProvider`](https://docs.gravityrail.com/sdk/type-aliases/ModelProvider.md) Defined in: [packages/sdk/src/types/generated/reports.ts:112](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/reports.ts#L112) *** ### totalAudioInputTokens?[​](#totalaudioinputtokens "Direct link to totalAudioInputTokens?") > `optional` **totalAudioInputTokens**: `number` Defined in: [packages/sdk/src/types/generated/reports.ts:116](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/reports.ts#L116) *** ### totalAudioOutputTokens?[​](#totalaudiooutputtokens "Direct link to totalAudioOutputTokens?") > `optional` **totalAudioOutputTokens**: `number` Defined in: [packages/sdk/src/types/generated/reports.ts:117](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/reports.ts#L117) *** ### totalCachedTokens[​](#totalcachedtokens "Direct link to totalCachedTokens") > **totalCachedTokens**: `number` Defined in: [packages/sdk/src/types/generated/reports.ts:115](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/reports.ts#L115) *** ### totalCredits[​](#totalcredits "Direct link to totalCredits") > **totalCredits**: `number` Defined in: [packages/sdk/src/types/generated/reports.ts:118](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/reports.ts#L118) *** ### totalMessages[​](#totalmessages "Direct link to totalMessages") > **totalMessages**: `number` Defined in: [packages/sdk/src/types/generated/reports.ts:113](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/reports.ts#L113) *** ### totalTokens[​](#totaltokens "Direct link to totalTokens") > **totalTokens**: `number` Defined in: [packages/sdk/src/types/generated/reports.ts:114](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/reports.ts#L114) --- # Interface: ProvisionA2PEnrollmentSiteRequest Defined in: [packages/sdk/src/types/organization-types.ts:274](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/organization-types.ts#L274) Auto-provision the brand's opt-in Site. `workspaceUuid` is required only when the org has multiple workspaces; with a single workspace it is inferred (omitted). The backend treats a missing value as "infer". ## Properties[​](#properties "Direct link to Properties") ### workspaceUuid?[​](#workspaceuuid "Direct link to workspaceUuid?") > `optional` **workspaceUuid**: `string` Defined in: [packages/sdk/src/types/organization-types.ts:275](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/organization-types.ts#L275) --- # Interface: ProvisionPlanRequest Defined in: [packages/sdk/src/types/workspace-health-types.ts:27](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/workspace-health-types.ts#L27) ## Properties[​](#properties "Direct link to Properties") ### subscriptionId?[​](#subscriptionid "Direct link to subscriptionId?") > `optional` **subscriptionId**: `number` Defined in: [packages/sdk/src/types/workspace-health-types.ts:28](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/workspace-health-types.ts#L28) --- # Interface: ProvisionPlanResponse Defined in: [packages/sdk/src/types/generated/workspace\_health.ts:80](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/workspace_health.ts#L80) Response model for provision-plan endpoint. ## Properties[​](#properties "Direct link to Properties") ### addedFeatures[​](#addedfeatures "Direct link to addedFeatures") > **addedFeatures**: `string`\[] Defined in: [packages/sdk/src/types/generated/workspace\_health.ts:85](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/workspace_health.ts#L85) *** ### message[​](#message "Direct link to message") > **message**: `string` Defined in: [packages/sdk/src/types/generated/workspace\_health.ts:87](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/workspace_health.ts#L87) *** ### newFeatures[​](#newfeatures "Direct link to newFeatures") > **newFeatures**: `string`\[] Defined in: [packages/sdk/src/types/generated/workspace\_health.ts:84](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/workspace_health.ts#L84) *** ### previousFeatures[​](#previousfeatures "Direct link to previousFeatures") > **previousFeatures**: `string`\[] Defined in: [packages/sdk/src/types/generated/workspace\_health.ts:83](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/workspace_health.ts#L83) *** ### removedFeatures[​](#removedfeatures "Direct link to removedFeatures") > **removedFeatures**: `string`\[] Defined in: [packages/sdk/src/types/generated/workspace\_health.ts:86](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/workspace_health.ts#L86) *** ### success[​](#success "Direct link to success") > **success**: `boolean` Defined in: [packages/sdk/src/types/generated/workspace\_health.ts:81](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/workspace_health.ts#L81) *** ### workspaceUuid[​](#workspaceuuid "Direct link to workspaceUuid") > **workspaceUuid**: `string` Defined in: [packages/sdk/src/types/generated/workspace\_health.ts:82](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/workspace_health.ts#L82) --- # Interface: PublicFileMetadata Defined in: [packages/sdk/src/types/file-types.ts:168](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/file-types.ts#L168) ## Properties[​](#properties "Direct link to Properties") ### access[​](#access "Direct link to access") > **access**: [`AccessLevel`](https://docs.gravityrail.com/sdk/enumerations/AccessLevel.md) Defined in: [packages/sdk/src/types/file-types.ts:174](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/file-types.ts#L174) *** ### createdAt?[​](#createdat "Direct link to createdAt?") > `optional` **createdAt**: `string` Defined in: [packages/sdk/src/types/file-types.ts:176](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/file-types.ts#L176) *** ### id[​](#id "Direct link to id") > **id**: `number` Defined in: [packages/sdk/src/types/file-types.ts:169](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/file-types.ts#L169) *** ### mimeType[​](#mimetype "Direct link to mimeType") > **mimeType**: `string` Defined in: [packages/sdk/src/types/file-types.ts:173](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/file-types.ts#L173) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/file-types.ts:170](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/file-types.ts#L170) *** ### shareable[​](#shareable "Direct link to shareable") > **shareable**: `boolean` Defined in: [packages/sdk/src/types/file-types.ts:175](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/file-types.ts#L175) *** ### size[​](#size "Direct link to size") > **size**: `number` Defined in: [packages/sdk/src/types/file-types.ts:172](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/file-types.ts#L172) *** ### title?[​](#title "Direct link to title?") > `optional` **title**: `string` Defined in: [packages/sdk/src/types/file-types.ts:171](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/file-types.ts#L171) --- # Interface: PublicFolderContents Defined in: [packages/sdk/src/types/file-types.ts:179](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/file-types.ts#L179) ## Properties[​](#properties "Direct link to Properties") ### access[​](#access "Direct link to access") > **access**: [`AccessLevel`](https://docs.gravityrail.com/sdk/enumerations/AccessLevel.md) Defined in: [packages/sdk/src/types/file-types.ts:182](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/file-types.ts#L182) *** ### files[​](#files "Direct link to files") > **files**: [`PublicFileMetadata`](https://docs.gravityrail.com/sdk/interfaces/PublicFileMetadata.md)\[] Defined in: [packages/sdk/src/types/file-types.ts:184](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/file-types.ts#L184) *** ### id[​](#id "Direct link to id") > **id**: `number` Defined in: [packages/sdk/src/types/file-types.ts:180](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/file-types.ts#L180) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/file-types.ts:181](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/file-types.ts#L181) *** ### pagination?[​](#pagination "Direct link to pagination?") > `optional` **pagination**: `object` Defined in: [packages/sdk/src/types/file-types.ts:185](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/file-types.ts#L185) #### page[​](#page "Direct link to page") > **page**: `number` #### pageSize[​](#pagesize "Direct link to pageSize") > **pageSize**: `number` #### total[​](#total "Direct link to total") > **total**: `number` *** ### shareable[​](#shareable "Direct link to shareable") > **shareable**: `boolean` Defined in: [packages/sdk/src/types/file-types.ts:183](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/file-types.ts#L183) --- # Interface: PublicOrganizationConfig Defined in: [packages/sdk/src/types/organization-types.ts:147](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/organization-types.ts#L147) ## Properties[​](#properties "Direct link to Properties") ### authMode[​](#authmode "Direct link to authMode") > **authMode**: `"open"` | `"ssoForDomain"` | `"ssoOnly"` Defined in: [packages/sdk/src/types/organization-types.ts:152](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/organization-types.ts#L152) *** ### logoUrl[​](#logourl "Direct link to logoUrl") > **logoUrl**: `string` | `null` Defined in: [packages/sdk/src/types/organization-types.ts:151](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/organization-types.ts#L151) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/organization-types.ts:149](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/organization-types.ts#L149) *** ### slug[​](#slug "Direct link to slug") > **slug**: `string` Defined in: [packages/sdk/src/types/organization-types.ts:150](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/organization-types.ts#L150) *** ### sso[​](#sso "Direct link to sso") > **sso**: [`PublicSSOConfig`](https://docs.gravityrail.com/sdk/interfaces/PublicSSOConfig.md) Defined in: [packages/sdk/src/types/organization-types.ts:153](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/organization-types.ts#L153) *** ### uuid[​](#uuid "Direct link to uuid") > **uuid**: `string` Defined in: [packages/sdk/src/types/organization-types.ts:148](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/organization-types.ts#L148) --- # Interface: PublicSSOConfig Defined in: [packages/sdk/src/types/organization-types.ts:141](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/organization-types.ts#L141) ## Properties[​](#properties "Direct link to Properties") ### enabled[​](#enabled "Direct link to enabled") > **enabled**: `boolean` Defined in: [packages/sdk/src/types/organization-types.ts:142](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/organization-types.ts#L142) *** ### provider[​](#provider "Direct link to provider") > **provider**: `string` | `null` Defined in: [packages/sdk/src/types/organization-types.ts:143](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/organization-types.ts#L143) *** ### providerType[​](#providertype "Direct link to providerType") > **providerType**: `string` | `null` Defined in: [packages/sdk/src/types/organization-types.ts:144](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/organization-types.ts#L144) --- # Interface: PublicWorkspace Defined in: [packages/sdk/src/types/generated/workspace.ts:270](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/workspace.ts#L270) ## Properties[​](#properties "Direct link to Properties") ### allowSignup?[​](#allowsignup "Direct link to allowSignup?") > `optional` **allowSignup**: `boolean` Defined in: [packages/sdk/src/types/generated/workspace.ts:276](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/workspace.ts#L276) *** ### createdAt[​](#createdat "Direct link to createdAt") > **createdAt**: `string` Defined in: [packages/sdk/src/types/generated/workspace.ts:275](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/workspace.ts#L275) *** ### id[​](#id "Direct link to id") > **id**: `number` Defined in: [packages/sdk/src/types/generated/workspace.ts:271](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/workspace.ts#L271) *** ### memberRole?[​](#memberrole "Direct link to memberRole?") > `optional` **memberRole**: `string` | `null` Defined in: [packages/sdk/src/types/generated/workspace.ts:278](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/workspace.ts#L278) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/generated/workspace.ts:274](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/workspace.ts#L274) *** ### resellerId?[​](#resellerid "Direct link to resellerId?") > `optional` **resellerId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/workspace.ts:277](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/workspace.ts#L277) *** ### signupRequestStatus?[​](#signuprequeststatus "Direct link to signupRequestStatus?") > `optional` **signupRequestStatus**: `string` | `null` Defined in: [packages/sdk/src/types/generated/workspace.ts:279](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/workspace.ts#L279) *** ### slug[​](#slug "Direct link to slug") > **slug**: `string` Defined in: [packages/sdk/src/types/generated/workspace.ts:273](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/workspace.ts#L273) *** ### uuid[​](#uuid "Direct link to uuid") > **uuid**: `string` Defined in: [packages/sdk/src/types/generated/workspace.ts:272](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/workspace.ts#L272) --- # Interface: QualificationExport Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:326](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L326) ## Properties[​](#properties "Direct link to Properties") ### scenarios[​](#scenarios "Direct link to scenarios") > **scenarios**: [`ScenarioExport`](https://docs.gravityrail.com/sdk/interfaces/ScenarioExport.md)\[] Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:330](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L330) *** ### templateUuid?[​](#templateuuid "Direct link to templateUuid?") > `optional` **templateUuid**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:328](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L328) *** ### uuid[​](#uuid "Direct link to uuid") > **uuid**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:327](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L327) *** ### workflowUuid?[​](#workflowuuid "Direct link to workflowUuid?") > `optional` **workflowUuid**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:329](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L329) --- # Interface: QualificationResponse Defined in: [packages/sdk/src/types/generated/qualification.ts:133](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/qualification.ts#L133) Response model for a qualification (per-workflow scenario suite). ## Properties[​](#properties "Direct link to Properties") ### createdAt[​](#createdat "Direct link to createdAt") > **createdAt**: `string` Defined in: [packages/sdk/src/types/generated/qualification.ts:138](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/qualification.ts#L138) *** ### id[​](#id "Direct link to id") > **id**: `number` Defined in: [packages/sdk/src/types/generated/qualification.ts:134](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/qualification.ts#L134) *** ### updatedAt[​](#updatedat "Direct link to updatedAt") > **updatedAt**: `string` Defined in: [packages/sdk/src/types/generated/qualification.ts:139](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/qualification.ts#L139) *** ### uuid[​](#uuid "Direct link to uuid") > **uuid**: `string` Defined in: [packages/sdk/src/types/generated/qualification.ts:135](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/qualification.ts#L135) *** ### workflowId[​](#workflowid "Direct link to workflowId") > **workflowId**: `number` Defined in: [packages/sdk/src/types/generated/qualification.ts:136](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/qualification.ts#L136) *** ### workflowName?[​](#workflowname "Direct link to workflowName?") > `optional` **workflowName**: `string` | `null` Defined in: [packages/sdk/src/types/generated/qualification.ts:137](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/qualification.ts#L137) --- # Interface: QueryAggregatePredicate Defined in: [packages/sdk/src/types/query-engine-types.ts:154](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L154) ## Properties[​](#properties "Direct link to Properties") ### emptyPolicy?[​](#emptypolicy "Direct link to emptyPolicy?") > `optional` **emptyPolicy**: `"include"` | `"exclude"` Defined in: [packages/sdk/src/types/query-engine-types.ts:166](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L166) *** ### kind[​](#kind "Direct link to kind") > **kind**: `"aggregate"` Defined in: [packages/sdk/src/types/query-engine-types.ts:155](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L155) *** ### metric?[​](#metric "Direct link to metric?") > `optional` **metric**: `"count"` | `"max"` Defined in: [packages/sdk/src/types/query-engine-types.ts:159](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L159) *** ### op[​](#op "Direct link to op") > **op**: [`QueryAggregateOp`](https://docs.gravityrail.com/sdk/type-aliases/QueryAggregateOp.md) Defined in: [packages/sdk/src/types/query-engine-types.ts:160](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L160) *** ### source[​](#source "Direct link to source") > **source**: `string` Defined in: [packages/sdk/src/types/query-engine-types.ts:156](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L156) *** ### sourceIds?[​](#sourceids "Direct link to sourceIds?") > `optional` **sourceIds**: `number`\[] | `null` Defined in: [packages/sdk/src/types/query-engine-types.ts:158](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L158) Narrows a parameterized source (e.g. workflowEntries → workflow ids). *** ### value[​](#value "Direct link to value") > **value**: `string` | `number` | [`QueryTemporalValue`](https://docs.gravityrail.com/sdk/type-aliases/QueryTemporalValue.md) Defined in: [packages/sdk/src/types/query-engine-types.ts:162](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L162) metric=max also accepts an ISO datetime string. *** ### windowDays?[​](#windowdays "Direct link to windowDays?") > `optional` **windowDays**: `number` | `null` Defined in: [packages/sdk/src/types/query-engine-types.ts:163](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L163) *** ### windowHours?[​](#windowhours "Direct link to windowHours?") > `optional` **windowHours**: `number` | `null` Defined in: [packages/sdk/src/types/query-engine-types.ts:165](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L165) Mutually exclusive with windowDays. --- # Interface: QueryAggregateSpec Defined in: [packages/sdk/src/types/query-engine-types.ts:216](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L216) ## Properties[​](#properties "Direct link to Properties") ### groupBy?[​](#groupby "Direct link to groupBy?") > `optional` **groupBy**: [`QueryGroupBy`](https://docs.gravityrail.com/sdk/interfaces/QueryGroupBy.md)\[] Defined in: [packages/sdk/src/types/query-engine-types.ts:217](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L217) *** ### limit?[​](#limit "Direct link to limit?") > `optional` **limit**: `number` Defined in: [packages/sdk/src/types/query-engine-types.ts:219](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L219) *** ### metrics[​](#metrics "Direct link to metrics") > **metrics**: [`QueryMetric`](https://docs.gravityrail.com/sdk/interfaces/QueryMetric.md)\[] Defined in: [packages/sdk/src/types/query-engine-types.ts:218](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L218) --- # Interface: QueryAnd Defined in: [packages/sdk/src/types/query-engine-types.ts:93](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L93) ## Properties[​](#properties "Direct link to Properties") ### children[​](#children "Direct link to children") > **children**: [`QueryPredicate`](https://docs.gravityrail.com/sdk/type-aliases/QueryPredicate.md)\[] Defined in: [packages/sdk/src/types/query-engine-types.ts:95](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L95) *** ### kind[​](#kind "Direct link to kind") > **kind**: `"and"` Defined in: [packages/sdk/src/types/query-engine-types.ts:94](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L94) --- # Interface: QueryCompare Defined in: [packages/sdk/src/types/query-engine-types.ts:108](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L108) ## Properties[​](#properties "Direct link to Properties") ### field[​](#field "Direct link to field") > **field**: `string` Defined in: [packages/sdk/src/types/query-engine-types.ts:110](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L110) *** ### kind[​](#kind "Direct link to kind") > **kind**: `"compare"` Defined in: [packages/sdk/src/types/query-engine-types.ts:109](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L109) *** ### op[​](#op "Direct link to op") > **op**: [`QueryComparisonOp`](https://docs.gravityrail.com/sdk/type-aliases/QueryComparisonOp.md) Defined in: [packages/sdk/src/types/query-engine-types.ts:111](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L111) *** ### value?[​](#value "Direct link to value?") > `optional` **value**: [`QueryValue`](https://docs.gravityrail.com/sdk/type-aliases/QueryValue.md) | `null` Defined in: [packages/sdk/src/types/query-engine-types.ts:112](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L112) --- # Interface: QueryCostInfo Defined in: [packages/sdk/src/types/query-engine-types.ts:245](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L245) ## Properties[​](#properties "Direct link to Properties") ### budget[​](#budget "Direct link to budget") > **budget**: `number` Defined in: [packages/sdk/src/types/query-engine-types.ts:247](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L247) *** ### score[​](#score "Direct link to score") > **score**: `number` Defined in: [packages/sdk/src/types/query-engine-types.ts:246](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L246) --- # Interface: QueryDataTypeInfo Defined in: [packages/sdk/src/types/query-engine-types.ts:310](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L310) ## Properties[​](#properties "Direct link to Properties") ### id[​](#id "Direct link to id") > **id**: `number` Defined in: [packages/sdk/src/types/query-engine-types.ts:311](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L311) *** ### isCollection[​](#iscollection "Direct link to isCollection") > **isCollection**: `boolean` Defined in: [packages/sdk/src/types/query-engine-types.ts:314](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L314) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/query-engine-types.ts:313](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L313) *** ### recordFields[​](#recordfields "Direct link to recordFields") > **recordFields**: [`QueryRecordFieldInfo`](https://docs.gravityrail.com/sdk/interfaces/QueryRecordFieldInfo.md)\[] Defined in: [packages/sdk/src/types/query-engine-types.ts:315](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L315) *** ### slug[​](#slug "Direct link to slug") > **slug**: `string` Defined in: [packages/sdk/src/types/query-engine-types.ts:312](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L312) --- # Interface: QueryDayBoundaryValue Defined in: [packages/sdk/src/types/query-engine-types.ts:60](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L60) ## Properties[​](#properties "Direct link to Properties") ### day[​](#day "Direct link to day") > **day**: `string` Defined in: [packages/sdk/src/types/query-engine-types.ts:63](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L63) 'today' | 'tomorrow' | 'yesterday' | ISO date (YYYY-MM-DD) *** ### edge?[​](#edge "Direct link to edge?") > `optional` **edge**: `"start"` | `"end"` Defined in: [packages/sdk/src/types/query-engine-types.ts:64](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L64) *** ### offsetDays?[​](#offsetdays "Direct link to offsetDays?") > `optional` **offsetDays**: `number` Defined in: [packages/sdk/src/types/query-engine-types.ts:66](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L66) Whole-day shift relative to `day` (legacy daysAgoEqual: N). *** ### type[​](#type "Direct link to type") > **type**: `"dayBoundary"` Defined in: [packages/sdk/src/types/query-engine-types.ts:61](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L61) *** ### tz?[​](#tz "Direct link to tz?") > `optional` **tz**: `"workspace"` | `"utc"` Defined in: [packages/sdk/src/types/query-engine-types.ts:68](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L68) UTC-pinned day bounds (legacy calendar-event day operators). --- # Interface: QueryDaysAgoValue Defined in: [packages/sdk/src/types/query-engine-types.ts:48](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L48) ## Properties[​](#properties "Direct link to Properties") ### days[​](#days "Direct link to days") > **days**: `number` Defined in: [packages/sdk/src/types/query-engine-types.ts:50](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L50) *** ### hours?[​](#hours "Direct link to hours?") > `optional` **hours**: `number` Defined in: [packages/sdk/src/types/query-engine-types.ts:52](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L52) Optional hour component (legacy "36h" duration windows). *** ### type[​](#type "Direct link to type") > **type**: `"daysAgo"` Defined in: [packages/sdk/src/types/query-engine-types.ts:49](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L49) --- # Interface: QueryDaysFromNowValue Defined in: [packages/sdk/src/types/query-engine-types.ts:55](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L55) ## Properties[​](#properties "Direct link to Properties") ### days[​](#days "Direct link to days") > **days**: `number` Defined in: [packages/sdk/src/types/query-engine-types.ts:57](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L57) *** ### type[​](#type "Direct link to type") > **type**: `"daysFromNow"` Defined in: [packages/sdk/src/types/query-engine-types.ts:56](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L56) --- # Interface: QueryEnumOption Defined in: [packages/sdk/src/types/query-engine-types.ts:272](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L272) A labeled choice for a field whose raw values are ids/codes. ## Properties[​](#properties "Direct link to Properties") ### color?[​](#color "Direct link to color?") > `optional` **color**: `string` | `null` Defined in: [packages/sdk/src/types/query-engine-types.ts:276](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L276) Display color (bare 6-digit hex, as stored on MemberLabel), if any. *** ### label[​](#label "Direct link to label") > **label**: `string` Defined in: [packages/sdk/src/types/query-engine-types.ts:274](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L274) *** ### value[​](#value "Direct link to value") > **value**: `string` | `number` Defined in: [packages/sdk/src/types/query-engine-types.ts:273](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L273) --- # Interface: QueryFieldInfo Defined in: [packages/sdk/src/types/query-engine-types.ts:279](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L279) ## Properties[​](#properties "Direct link to Properties") ### category?[​](#category "Direct link to category?") > `optional` **category**: `string` | `null` Defined in: [packages/sdk/src/types/query-engine-types.ts:299](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L299) Semantic group from the registry (profile/contact/notifications/ communications/workflows/calendar) — drives builder palette grouping. Optional for older API versions; null = uncategorized. *** ### displayName?[​](#displayname "Direct link to displayName?") > `optional` **displayName**: `string` | `null` Defined in: [packages/sdk/src/types/query-engine-types.ts:293](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L293) Human picker label when the path tail is misleading (e.g. "labelId"). *** ### enumOptions?[​](#enumoptions "Direct link to enumOptions?") > `optional` **enumOptions**: [`QueryEnumOption`](https://docs.gravityrail.com/sdk/interfaces/QueryEnumOption.md)\[] | `null` Defined in: [packages/sdk/src/types/query-engine-types.ts:291](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L291) Labeled value options ({value, label}) for fields whose raw values are meaningless to humans (label/role ids). Value stored in the IR is `value`; the UI shows `label`. *** ### enumValues?[​](#enumvalues "Direct link to enumValues?") > `optional` **enumValues**: `unknown`\[] | `null` Defined in: [packages/sdk/src/types/query-engine-types.ts:285](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L285) *** ### operators[​](#operators "Direct link to operators") > **operators**: `string`\[] Defined in: [packages/sdk/src/types/query-engine-types.ts:282](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L282) *** ### path[​](#path "Direct link to path") > **path**: `string` Defined in: [packages/sdk/src/types/query-engine-types.ts:280](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L280) *** ### selectable[​](#selectable "Direct link to selectable") > **selectable**: `boolean` Defined in: [packages/sdk/src/types/query-engine-types.ts:284](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L284) *** ### sortable[​](#sortable "Direct link to sortable") > **sortable**: `boolean` Defined in: [packages/sdk/src/types/query-engine-types.ts:283](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L283) *** ### type[​](#type "Direct link to type") > **type**: `string` Defined in: [packages/sdk/src/types/query-engine-types.ts:281](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L281) --- # Interface: QueryFieldsResponse Defined in: [packages/sdk/src/types/query-engine-types.ts:318](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L318) ## Properties[​](#properties "Direct link to Properties") ### aggregateSourceCategories?[​](#aggregatesourcecategories "Direct link to aggregateSourceCategories?") > `optional` **aggregateSourceCategories**: `Record`<`string`, `Record`<`string`, `string`>> Defined in: [packages/sdk/src/types/query-engine-types.ts:336](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L336) entity → aggregate source → semantic category. Only categorized sources appear; uncategorized sources are internal (legacy-adapter parity) and should not be offered in builder palettes. Optional for older API versions. *** ### aggregateSources[​](#aggregatesources "Direct link to aggregateSources") > **aggregateSources**: `Record`<`string`, `string`\[]> Defined in: [packages/sdk/src/types/query-engine-types.ts:320](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L320) *** ### dataTypes[​](#datatypes "Direct link to dataTypes") > **dataTypes**: [`QueryDataTypeInfo`](https://docs.gravityrail.com/sdk/interfaces/QueryDataTypeInfo.md)\[] Defined in: [packages/sdk/src/types/query-engine-types.ts:321](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L321) *** ### entities[​](#entities "Direct link to entities") > **entities**: `Record`<`string`, [`QueryFieldInfo`](https://docs.gravityrail.com/sdk/interfaces/QueryFieldInfo.md)\[]> Defined in: [packages/sdk/src/types/query-engine-types.ts:319](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L319) *** ### recordSystemFields[​](#recordsystemfields "Direct link to recordSystemFields") > **recordSystemFields**: [`QueryFieldInfo`](https://docs.gravityrail.com/sdk/interfaces/QueryFieldInfo.md)\[] Defined in: [packages/sdk/src/types/query-engine-types.ts:322](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L322) *** ### relations?[​](#relations "Direct link to relations?") > `optional` **relations**: `Record`<`string`, `Record`<`string`, [`QueryFieldInfo`](https://docs.gravityrail.com/sdk/interfaces/QueryFieldInfo.md)\[]>> Defined in: [packages/sdk/src/types/query-engine-types.ts:329](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L329) RelationMatch palette: entity → relation name → the relation's queryable sub-fields (e.g. member.workflowEntries → entry.workflowId, entry.status, entry.enteredAt). Same raw-ID hiding convention as `entities`. Optional for older API versions. --- # Interface: QueryGroupBy Defined in: [packages/sdk/src/types/query-engine-types.ts:204](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L204) ## Properties[​](#properties "Direct link to Properties") ### alias?[​](#alias "Direct link to alias?") > `optional` **alias**: `string` | `null` Defined in: [packages/sdk/src/types/query-engine-types.ts:207](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L207) *** ### bucket?[​](#bucket "Direct link to bucket?") > `optional` **bucket**: `"day"` | `"week"` | `"month"` | `null` Defined in: [packages/sdk/src/types/query-engine-types.ts:206](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L206) *** ### field[​](#field "Direct link to field") > **field**: `string` Defined in: [packages/sdk/src/types/query-engine-types.ts:205](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L205) --- # Interface: QueryIR Defined in: [packages/sdk/src/types/query-engine-types.ts:222](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L222) ## Properties[​](#properties "Direct link to Properties") ### aggregate?[​](#aggregate "Direct link to aggregate?") > `optional` **aggregate**: [`QueryAggregateSpec`](https://docs.gravityrail.com/sdk/interfaces/QueryAggregateSpec.md) | `null` Defined in: [packages/sdk/src/types/query-engine-types.ts:230](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L230) *** ### cursor?[​](#cursor "Direct link to cursor?") > `optional` **cursor**: `string` | `null` Defined in: [packages/sdk/src/types/query-engine-types.ts:229](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L229) *** ### dataType?[​](#datatype "Direct link to dataType?") > `optional` **dataType**: `string` | `number` | `null` Defined in: [packages/sdk/src/types/query-engine-types.ts:224](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L224) *** ### entity[​](#entity "Direct link to entity") > **entity**: [`QueryEntityType`](https://docs.gravityrail.com/sdk/type-aliases/QueryEntityType.md) Defined in: [packages/sdk/src/types/query-engine-types.ts:223](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L223) *** ### includeArchived?[​](#includearchived "Direct link to includeArchived?") > `optional` **includeArchived**: `boolean` Defined in: [packages/sdk/src/types/query-engine-types.ts:231](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L231) *** ### limit[​](#limit "Direct link to limit") > **limit**: `number` Defined in: [packages/sdk/src/types/query-engine-types.ts:228](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L228) *** ### select?[​](#select "Direct link to select?") > `optional` **select**: `string`\[] | `null` Defined in: [packages/sdk/src/types/query-engine-types.ts:226](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L226) *** ### sort?[​](#sort "Direct link to sort?") > `optional` **sort**: [`QuerySortKey`](https://docs.gravityrail.com/sdk/interfaces/QuerySortKey.md)\[] | `null` Defined in: [packages/sdk/src/types/query-engine-types.ts:227](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L227) *** ### where?[​](#where "Direct link to where?") > `optional` **where**: [`QueryPredicate`](https://docs.gravityrail.com/sdk/type-aliases/QueryPredicate.md) | `null` Defined in: [packages/sdk/src/types/query-engine-types.ts:225](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L225) --- # Interface: QueryMetric Defined in: [packages/sdk/src/types/query-engine-types.ts:210](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L210) ## Properties[​](#properties "Direct link to Properties") ### as?[​](#as "Direct link to as?") > `optional` **as**: `string` Defined in: [packages/sdk/src/types/query-engine-types.ts:213](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L213) *** ### fn[​](#fn "Direct link to fn") > **fn**: `"count"` | `"max"` | `"countDistinct"` | `"sum"` | `"avg"` | `"min"` Defined in: [packages/sdk/src/types/query-engine-types.ts:211](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L211) *** ### of?[​](#of "Direct link to of?") > `optional` **of**: `string` | `null` Defined in: [packages/sdk/src/types/query-engine-types.ts:212](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L212) --- # Interface: QueryNot Defined in: [packages/sdk/src/types/query-engine-types.ts:103](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L103) ## Properties[​](#properties "Direct link to Properties") ### child[​](#child "Direct link to child") > **child**: [`QueryPredicate`](https://docs.gravityrail.com/sdk/type-aliases/QueryPredicate.md) Defined in: [packages/sdk/src/types/query-engine-types.ts:105](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L105) *** ### kind[​](#kind "Direct link to kind") > **kind**: `"not"` Defined in: [packages/sdk/src/types/query-engine-types.ts:104](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L104) --- # Interface: QueryNowValue Defined in: [packages/sdk/src/types/query-engine-types.ts:44](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L44) ## Properties[​](#properties "Direct link to Properties") ### type[​](#type "Direct link to type") > **type**: `"now"` Defined in: [packages/sdk/src/types/query-engine-types.ts:45](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L45) --- # Interface: QueryOr Defined in: [packages/sdk/src/types/query-engine-types.ts:98](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L98) ## Properties[​](#properties "Direct link to Properties") ### children[​](#children "Direct link to children") > **children**: [`QueryPredicate`](https://docs.gravityrail.com/sdk/type-aliases/QueryPredicate.md)\[] Defined in: [packages/sdk/src/types/query-engine-types.ts:100](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L100) *** ### kind[​](#kind "Direct link to kind") > **kind**: `"or"` Defined in: [packages/sdk/src/types/query-engine-types.ts:99](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L99) --- # Interface: QueryRangeValue Defined in: [packages/sdk/src/types/query-engine-types.ts:81](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L81) ## Properties[​](#properties "Direct link to Properties") ### max[​](#max "Direct link to max") > **max**: [`QueryRangeBound`](https://docs.gravityrail.com/sdk/type-aliases/QueryRangeBound.md) Defined in: [packages/sdk/src/types/query-engine-types.ts:84](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L84) *** ### min[​](#min "Direct link to min") > **min**: [`QueryRangeBound`](https://docs.gravityrail.com/sdk/type-aliases/QueryRangeBound.md) Defined in: [packages/sdk/src/types/query-engine-types.ts:83](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L83) *** ### type[​](#type "Direct link to type") > **type**: `"range"` Defined in: [packages/sdk/src/types/query-engine-types.ts:82](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L82) --- # Interface: QueryRecordFieldInfo Defined in: [packages/sdk/src/types/query-engine-types.ts:302](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L302) ## Properties[​](#properties "Direct link to Properties") ### enumValues?[​](#enumvalues "Direct link to enumValues?") > `optional` **enumValues**: `unknown`\[] | `null` Defined in: [packages/sdk/src/types/query-engine-types.ts:307](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L307) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/query-engine-types.ts:304](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L304) *** ### operators[​](#operators "Direct link to operators") > **operators**: `string`\[] Defined in: [packages/sdk/src/types/query-engine-types.ts:306](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L306) *** ### slug[​](#slug "Direct link to slug") > **slug**: `string` Defined in: [packages/sdk/src/types/query-engine-types.ts:303](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L303) *** ### type[​](#type "Direct link to type") > **type**: `string` Defined in: [packages/sdk/src/types/query-engine-types.ts:305](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L305) --- # Interface: QueryRecordMatch Defined in: [packages/sdk/src/types/query-engine-types.ts:128](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L128) Correlated record predicate (#16104): all conditions in `where` must match the SAME DataRecord row. * any → EXISTS(match) * none → NOT EXISTS(match), members with no records DO match * noneWithRecord → NOT EXISTS(match) AND has at least one record ## Properties[​](#properties "Direct link to Properties") ### dataType[​](#datatype "Direct link to dataType") > **dataType**: `string` | `number` Defined in: [packages/sdk/src/types/query-engine-types.ts:130](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L130) *** ### kind[​](#kind "Direct link to kind") > **kind**: `"recordMatch"` Defined in: [packages/sdk/src/types/query-engine-types.ts:129](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L129) *** ### mode?[​](#mode "Direct link to mode?") > `optional` **mode**: `"any"` | `"none"` | `"noneWithRecord"` Defined in: [packages/sdk/src/types/query-engine-types.ts:131](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L131) *** ### selection?[​](#selection "Direct link to selection?") > `optional` **selection**: [`QueryRecordSelection`](https://docs.gravityrail.com/sdk/interfaces/QueryRecordSelection.md) | `null` Defined in: [packages/sdk/src/types/query-engine-types.ts:133](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L133) *** ### where?[​](#where "Direct link to where?") > `optional` **where**: [`QueryPredicate`](https://docs.gravityrail.com/sdk/type-aliases/QueryPredicate.md) | `null` Defined in: [packages/sdk/src/types/query-engine-types.ts:132](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L132) --- # Interface: QueryRecordSelection Defined in: [packages/sdk/src/types/query-engine-types.ts:115](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L115) ## Properties[​](#properties "Direct link to Properties") ### criterion[​](#criterion "Direct link to criterion") > **criterion**: `"true"` | `"newest"` | `"oldest"` | `"highest"` | `"lowest"` | `"earliest"` | `"latest"` | `"false"` Defined in: [packages/sdk/src/types/query-engine-types.ts:117](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L117) *** ### field[​](#field "Direct link to field") > **field**: `string` Defined in: [packages/sdk/src/types/query-engine-types.ts:116](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L116) --- # Interface: QueryRelationMatch Defined in: [packages/sdk/src/types/query-engine-types.ts:147](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L147) Correlated EXISTS over a named related-entity relation (the RecordMatch pattern generalized): all conditions in `where` apply to the SAME related row. Relations and their sub-fields come from `QueryFieldsResponse.relations` (e.g. member `workflowEntries` → entry.workflowId / entry.status / entry.enteredAt; `calendarEvents` → event.calendarId / event.typeId / event.startTime). * any → EXISTS(match) * none → NOT EXISTS(match), members with no related rows DO match ## Properties[​](#properties "Direct link to Properties") ### kind[​](#kind "Direct link to kind") > **kind**: `"relationMatch"` Defined in: [packages/sdk/src/types/query-engine-types.ts:148](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L148) *** ### mode?[​](#mode "Direct link to mode?") > `optional` **mode**: `"any"` | `"none"` Defined in: [packages/sdk/src/types/query-engine-types.ts:150](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L150) *** ### relation[​](#relation "Direct link to relation") > **relation**: `string` Defined in: [packages/sdk/src/types/query-engine-types.ts:149](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L149) *** ### where?[​](#where "Direct link to where?") > `optional` **where**: [`QueryPredicate`](https://docs.gravityrail.com/sdk/type-aliases/QueryPredicate.md) | `null` Defined in: [packages/sdk/src/types/query-engine-types.ts:151](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L151) --- # Interface: QuerySavedFilterRef Defined in: [packages/sdk/src/types/query-engine-types.ts:177](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L177) ## Properties[​](#properties "Direct link to Properties") ### combine?[​](#combine "Direct link to combine?") > `optional` **combine**: `"union"` | `"intersect"` Defined in: [packages/sdk/src/types/query-engine-types.ts:181](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L181) *** ### filterIds[​](#filterids "Direct link to filterIds") > **filterIds**: `number`\[] Defined in: [packages/sdk/src/types/query-engine-types.ts:180](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L180) *** ### filterType?[​](#filtertype "Direct link to filterType?") > `optional` **filterType**: `"member"` Defined in: [packages/sdk/src/types/query-engine-types.ts:179](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L179) *** ### kind[​](#kind "Direct link to kind") > **kind**: `"savedFilterRef"` Defined in: [packages/sdk/src/types/query-engine-types.ts:178](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L178) --- # Interface: QuerySortKey Defined in: [packages/sdk/src/types/query-engine-types.ts:199](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L199) ## Properties[​](#properties "Direct link to Properties") ### dir?[​](#dir "Direct link to dir?") > `optional` **dir**: `"asc"` | `"desc"` Defined in: [packages/sdk/src/types/query-engine-types.ts:201](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L201) *** ### field[​](#field "Direct link to field") > **field**: `string` Defined in: [packages/sdk/src/types/query-engine-types.ts:200](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L200) --- # Interface: QuerySubQueryRef Defined in: [packages/sdk/src/types/query-engine-types.ts:169](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L169) ## Properties[​](#properties "Direct link to Properties") ### entity[​](#entity "Direct link to entity") > **entity**: `"member"` Defined in: [packages/sdk/src/types/query-engine-types.ts:171](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L171) *** ### kind[​](#kind "Direct link to kind") > **kind**: `"subquery"` Defined in: [packages/sdk/src/types/query-engine-types.ts:170](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L170) *** ### link[​](#link "Direct link to link") > **link**: `string` Defined in: [packages/sdk/src/types/query-engine-types.ts:172](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L172) *** ### negate?[​](#negate "Direct link to negate?") > `optional` **negate**: `boolean` Defined in: [packages/sdk/src/types/query-engine-types.ts:173](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L173) *** ### where?[​](#where "Direct link to where?") > `optional` **where**: [`QueryPredicate`](https://docs.gravityrail.com/sdk/type-aliases/QueryPredicate.md) | `null` Defined in: [packages/sdk/src/types/query-engine-types.ts:174](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L174) --- # Interface: RealtimeChatError Defined in: [packages/sdk/src/types/communication-types.ts:258](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/communication-types.ts#L258) ## Properties[​](#properties "Direct link to Properties") ### code[​](#code "Direct link to code") > **code**: `string` Defined in: [packages/sdk/src/types/communication-types.ts:260](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/communication-types.ts#L260) *** ### message[​](#message "Direct link to message") > **message**: `string` Defined in: [packages/sdk/src/types/communication-types.ts:261](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/communication-types.ts#L261) *** ### param?[​](#param "Direct link to param?") > `optional` **param**: `string` Defined in: [packages/sdk/src/types/communication-types.ts:262](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/communication-types.ts#L262) *** ### source[​](#source "Direct link to source") > **source**: `string` Defined in: [packages/sdk/src/types/communication-types.ts:259](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/communication-types.ts#L259) *** ### url?[​](#url "Direct link to url?") > `optional` **url**: `string` Defined in: [packages/sdk/src/types/communication-types.ts:263](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/communication-types.ts#L263) --- # Interface: RealtimeModelResponse Defined in: [packages/sdk/src/types/generated/ai\_model.ts:124](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/ai_model.ts#L124) Response model for a realtime model. ## Properties[​](#properties "Direct link to Properties") ### available?[​](#available "Direct link to available?") > `optional` **available**: `boolean` Defined in: [packages/sdk/src/types/generated/ai\_model.ts:131](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/ai_model.ts#L131) *** ### cachedMultiplier?[​](#cachedmultiplier "Direct link to cachedMultiplier?") > `optional` **cachedMultiplier**: `number` | `null` Defined in: [packages/sdk/src/types/generated/ai\_model.ts:140](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/ai_model.ts#L140) *** ### clientVad?[​](#clientvad "Direct link to clientVad?") > `optional` **clientVad**: `boolean` Defined in: [packages/sdk/src/types/generated/ai\_model.ts:136](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/ai_model.ts#L136) *** ### description?[​](#description "Direct link to description?") > `optional` **description**: `string` | `null` Defined in: [packages/sdk/src/types/generated/ai\_model.ts:129](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/ai_model.ts#L129) *** ### id[​](#id "Direct link to id") > **id**: `string` Defined in: [packages/sdk/src/types/generated/ai\_model.ts:125](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/ai_model.ts#L125) *** ### inputMultiplier?[​](#inputmultiplier "Direct link to inputMultiplier?") > `optional` **inputMultiplier**: `number` | `null` Defined in: [packages/sdk/src/types/generated/ai\_model.ts:138](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/ai_model.ts#L138) *** ### multiplier?[​](#multiplier "Direct link to multiplier?") > `optional` **multiplier**: `number` Defined in: [packages/sdk/src/types/generated/ai\_model.ts:137](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/ai_model.ts#L137) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/generated/ai\_model.ts:126](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/ai_model.ts#L126) *** ### outputMultiplier?[​](#outputmultiplier "Direct link to outputMultiplier?") > `optional` **outputMultiplier**: `number` | `null` Defined in: [packages/sdk/src/types/generated/ai\_model.ts:139](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/ai_model.ts#L139) *** ### provider[​](#provider "Direct link to provider") > **provider**: [`ModelProvider`](https://docs.gravityrail.com/sdk/type-aliases/ModelProvider.md) Defined in: [packages/sdk/src/types/generated/ai\_model.ts:127](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/ai_model.ts#L127) *** ### recommended?[​](#recommended "Direct link to recommended?") > `optional` **recommended**: `boolean` Defined in: [packages/sdk/src/types/generated/ai\_model.ts:132](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/ai_model.ts#L132) *** ### replacement?[​](#replacement "Direct link to replacement?") > `optional` **replacement**: `string` | `null` Defined in: [packages/sdk/src/types/generated/ai\_model.ts:133](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/ai_model.ts#L133) *** ### serverVad?[​](#servervad "Direct link to serverVad?") > `optional` **serverVad**: `boolean` Defined in: [packages/sdk/src/types/generated/ai\_model.ts:135](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/ai_model.ts#L135) *** ### state?[​](#state "Direct link to state?") > `optional` **state**: `string` Defined in: [packages/sdk/src/types/generated/ai\_model.ts:130](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/ai_model.ts#L130) *** ### type?[​](#type "Direct link to type?") > `optional` **type**: [`ModelType`](https://docs.gravityrail.com/sdk/type-aliases/ModelType.md) Defined in: [packages/sdk/src/types/generated/ai\_model.ts:128](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/ai_model.ts#L128) *** ### voices?[​](#voices "Direct link to voices?") > `optional` **voices**: `string`\[] Defined in: [packages/sdk/src/types/generated/ai\_model.ts:134](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/ai_model.ts#L134) --- # Interface: RecommendedVoiceResponse Defined in: [packages/sdk/src/types/generated/pronunciation.ts:79](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/pronunciation.ts#L79) ## Properties[​](#properties "Direct link to Properties") ### description?[​](#description "Direct link to description?") > `optional` **description**: `string` | `null` Defined in: [packages/sdk/src/types/generated/pronunciation.ts:83](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/pronunciation.ts#L83) *** ### id[​](#id "Direct link to id") > **id**: `string` Defined in: [packages/sdk/src/types/generated/pronunciation.ts:80](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/pronunciation.ts#L80) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/generated/pronunciation.ts:81](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/pronunciation.ts#L81) *** ### provider[​](#provider "Direct link to provider") > **provider**: `string` Defined in: [packages/sdk/src/types/generated/pronunciation.ts:82](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/pronunciation.ts#L82) --- # Interface: RecoveryCodesResponse Defined in: [packages/sdk/src/types/generated/account.ts:330](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L330) Response model for recovery codes ## Properties[​](#properties "Direct link to Properties") ### codes[​](#codes "Direct link to codes") > **codes**: `string`\[] Defined in: [packages/sdk/src/types/generated/account.ts:332](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L332) List of recovery codes (only shown once) *** ### generatedAt[​](#generatedat "Direct link to generatedAt") > **generatedAt**: `string` Defined in: [packages/sdk/src/types/generated/account.ts:334](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L334) When the codes were generated *** ### warning?[​](#warning "Direct link to warning?") > `optional` **warning**: `string` Defined in: [packages/sdk/src/types/generated/account.ts:335](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L335) --- # Interface: RegistryVariable Defined in: [packages/sdk/src/api/templates.ts:56](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/templates.ts#L56) A variable from the central registry with extended metadata. ## Properties[​](#properties "Direct link to Properties") ### deprecated[​](#deprecated "Direct link to deprecated") > **deprecated**: `boolean` Defined in: [packages/sdk/src/api/templates.ts:62](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/templates.ts#L62) *** ### deprecatedFor?[​](#deprecatedfor "Direct link to deprecatedFor?") > `optional` **deprecatedFor**: `string` | `null` Defined in: [packages/sdk/src/api/templates.ts:63](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/templates.ts#L63) *** ### description[​](#description "Direct link to description") > **description**: `string` Defined in: [packages/sdk/src/api/templates.ts:59](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/templates.ts#L59) *** ### example[​](#example "Direct link to example") > **example**: `any` Defined in: [packages/sdk/src/api/templates.ts:60](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/templates.ts#L60) *** ### namespace[​](#namespace "Direct link to namespace") > **namespace**: `string` Defined in: [packages/sdk/src/api/templates.ts:61](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/templates.ts#L61) *** ### path[​](#path "Direct link to path") > **path**: `string` Defined in: [packages/sdk/src/api/templates.ts:57](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/templates.ts#L57) *** ### permissionScope?[​](#permissionscope "Direct link to permissionScope?") > `optional` **permissionScope**: `string` | `null` Defined in: [packages/sdk/src/api/templates.ts:64](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/templates.ts#L64) *** ### type[​](#type "Direct link to type") > **type**: `string` Defined in: [packages/sdk/src/api/templates.ts:58](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/templates.ts#L58) --- # Interface: RenderedPageResponse Defined in: [packages/sdk/src/types/generated/site.ts:133](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L133) ## Properties[​](#properties "Direct link to Properties") ### availableLocales?[​](#availablelocales "Direct link to availableLocales?") > `optional` **availableLocales**: `string`\[] | `null` Defined in: [packages/sdk/src/types/generated/site.ts:144](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L144) *** ### content[​](#content "Direct link to content") > **content**: `string` Defined in: [packages/sdk/src/types/generated/site.ts:139](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L139) *** ### contentBlocks?[​](#contentblocks "Direct link to contentBlocks?") > `optional` **contentBlocks**: [`TipTapDocumentOutput`](https://docs.gravityrail.com/sdk/interfaces/TipTapDocumentOutput.md) | `null` Defined in: [packages/sdk/src/types/generated/site.ts:140](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L140) *** ### createdAt[​](#createdat "Direct link to createdAt") > **createdAt**: `string` Defined in: [packages/sdk/src/types/generated/site.ts:141](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L141) *** ### id[​](#id "Direct link to id") > **id**: `number` Defined in: [packages/sdk/src/types/generated/site.ts:134](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L134) *** ### locale?[​](#locale "Direct link to locale?") > `optional` **locale**: `string` Defined in: [packages/sdk/src/types/generated/site.ts:143](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L143) *** ### metaDescription?[​](#metadescription "Direct link to metaDescription?") > `optional` **metaDescription**: `string` | `null` Defined in: [packages/sdk/src/types/generated/site.ts:138](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L138) *** ### primaryLocale?[​](#primarylocale "Direct link to primaryLocale?") > `optional` **primaryLocale**: `string` | `null` Defined in: [packages/sdk/src/types/generated/site.ts:145](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L145) *** ### slug[​](#slug "Direct link to slug") > **slug**: `string` Defined in: [packages/sdk/src/types/generated/site.ts:135](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L135) *** ### status?[​](#status "Direct link to status?") > `optional` **status**: `string` Defined in: [packages/sdk/src/types/generated/site.ts:137](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L137) *** ### title[​](#title "Direct link to title") > **title**: `string` Defined in: [packages/sdk/src/types/generated/site.ts:136](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L136) *** ### updatedAt?[​](#updatedat "Direct link to updatedAt?") > `optional` **updatedAt**: `string` | `null` Defined in: [packages/sdk/src/types/generated/site.ts:142](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L142) --- # Interface: ReorderMenuItemsData Defined in: [packages/sdk/src/types/site-types.ts:118](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/site-types.ts#L118) ## Properties[​](#properties "Direct link to Properties") ### itemIds[​](#itemids "Direct link to itemIds") > **itemIds**: `number`\[] Defined in: [packages/sdk/src/types/site-types.ts:119](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/site-types.ts#L119) *** ### parentId?[​](#parentid "Direct link to parentId?") > `optional` **parentId**: `number` | `null` Defined in: [packages/sdk/src/types/site-types.ts:120](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/site-types.ts#L120) --- # Interface: RequestCredentialChangeRequest Defined in: [packages/sdk/src/types/account-types.ts:476](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L476) ## Properties[​](#properties "Direct link to Properties") ### credentialType[​](#credentialtype "Direct link to credentialType") > **credentialType**: [`CredentialType`](https://docs.gravityrail.com/sdk/type-aliases/CredentialType.md) Defined in: [packages/sdk/src/types/account-types.ts:477](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L477) *** ### newValue[​](#newvalue "Direct link to newValue") > **newValue**: `string` Defined in: [packages/sdk/src/types/account-types.ts:478](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L478) --- # Interface: RequestMagicLinkRequest Defined in: [packages/sdk/src/types/account-types.ts:179](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L179) ## Properties[​](#properties "Direct link to Properties") ### email[​](#email "Direct link to email") > **email**: `string` Defined in: [packages/sdk/src/types/account-types.ts:180](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L180) *** ### organizationUuid?[​](#organizationuuid "Direct link to organizationUuid?") > `optional` **organizationUuid**: `string` Defined in: [packages/sdk/src/types/account-types.ts:181](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L181) *** ### redirectUrl?[​](#redirecturl "Direct link to redirectUrl?") > `optional` **redirectUrl**: `string` Defined in: [packages/sdk/src/types/account-types.ts:182](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L182) --- # Interface: RequestMagicLinkResponse Defined in: [packages/sdk/src/types/account-types.ts:185](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L185) ## Properties[​](#properties "Direct link to Properties") ### magicLinkUrl?[​](#magiclinkurl "Direct link to magicLinkUrl?") > `optional` **magicLinkUrl**: `string` Defined in: [packages/sdk/src/types/account-types.ts:189](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L189) *** ### message[​](#message "Direct link to message") > **message**: `string` Defined in: [packages/sdk/src/types/account-types.ts:187](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L187) *** ### success[​](#success "Direct link to success") > **success**: `boolean` Defined in: [packages/sdk/src/types/account-types.ts:186](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L186) *** ### token?[​](#token "Direct link to token?") > `optional` **token**: `string` Defined in: [packages/sdk/src/types/account-types.ts:188](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L188) --- # Interface: ResolveAnonymousMemberRequest Defined in: [packages/sdk/src/types/member-types.ts:485](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L485) ## Properties[​](#properties "Direct link to Properties") ### notes?[​](#notes "Direct link to notes?") > `optional` **notes**: `string` Defined in: [packages/sdk/src/types/member-types.ts:487](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L487) *** ### targetMemberId[​](#targetmemberid "Direct link to targetMemberId") > **targetMemberId**: `number` Defined in: [packages/sdk/src/types/member-types.ts:486](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L486) --- # Interface: ResolvedA2PCampaignConfig Defined in: [packages/sdk/src/types/organization-types.ts:223](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/organization-types.ts#L223) Resolved A2P campaign config for one brand — compliant defaults merged with the brand's stored overrides. `consentCheckboxLabel` + `consentDisclosure` are the canonical opt-in text the patient sees; the MessageFlow quotes them verbatim, so the live preview's three views render from the same data. ## Properties[​](#properties "Direct link to Properties") ### ageGated[​](#agegated "Direct link to ageGated") > **ageGated**: `boolean` Defined in: [packages/sdk/src/types/organization-types.ts:233](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/organization-types.ts#L233) *** ### consentCheckboxLabel[​](#consentcheckboxlabel "Direct link to consentCheckboxLabel") > **consentCheckboxLabel**: `string` Defined in: [packages/sdk/src/types/organization-types.ts:239](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/organization-types.ts#L239) *** ### consentDisclosure[​](#consentdisclosure "Direct link to consentDisclosure") > **consentDisclosure**: `string` Defined in: [packages/sdk/src/types/organization-types.ts:240](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/organization-types.ts#L240) *** ### description[​](#description "Direct link to description") > **description**: `string` Defined in: [packages/sdk/src/types/organization-types.ts:224](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/organization-types.ts#L224) *** ### directLending[​](#directlending "Direct link to directLending") > **directLending**: `boolean` Defined in: [packages/sdk/src/types/organization-types.ts:238](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/organization-types.ts#L238) *** ### evidenceUrl[​](#evidenceurl "Direct link to evidenceUrl") > **evidenceUrl**: `string` Defined in: [packages/sdk/src/types/organization-types.ts:234](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/organization-types.ts#L234) *** ### hasEmbeddedLinks[​](#hasembeddedlinks "Direct link to hasEmbeddedLinks") > **hasEmbeddedLinks**: `boolean` Defined in: [packages/sdk/src/types/organization-types.ts:235](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/organization-types.ts#L235) *** ### hasEmbeddedPhone[​](#hasembeddedphone "Direct link to hasEmbeddedPhone") > **hasEmbeddedPhone**: `boolean` Defined in: [packages/sdk/src/types/organization-types.ts:236](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/organization-types.ts#L236) *** ### helpMessage[​](#helpmessage "Direct link to helpMessage") > **helpMessage**: `string` Defined in: [packages/sdk/src/types/organization-types.ts:230](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/organization-types.ts#L230) *** ### messageFlow[​](#messageflow "Direct link to messageFlow") > **messageFlow**: `string` Defined in: [packages/sdk/src/types/organization-types.ts:225](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/organization-types.ts#L225) *** ### messageSamples[​](#messagesamples "Direct link to messageSamples") > **messageSamples**: `string`\[] Defined in: [packages/sdk/src/types/organization-types.ts:226](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/organization-types.ts#L226) *** ### optInMessage[​](#optinmessage "Direct link to optInMessage") > **optInMessage**: `string` Defined in: [packages/sdk/src/types/organization-types.ts:228](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/organization-types.ts#L228) *** ### optOutMessage[​](#optoutmessage "Direct link to optOutMessage") > **optOutMessage**: `string` Defined in: [packages/sdk/src/types/organization-types.ts:229](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/organization-types.ts#L229) *** ### privacyUrl[​](#privacyurl "Direct link to privacyUrl") > **privacyUrl**: `string` Defined in: [packages/sdk/src/types/organization-types.ts:231](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/organization-types.ts#L231) *** ### programConsentLabel[​](#programconsentlabel "Direct link to programConsentLabel") > **programConsentLabel**: `string` Defined in: [packages/sdk/src/types/organization-types.ts:241](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/organization-types.ts#L241) *** ### subscriberOptIn[​](#subscriberoptin "Direct link to subscriberOptIn") > **subscriberOptIn**: `boolean` Defined in: [packages/sdk/src/types/organization-types.ts:237](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/organization-types.ts#L237) *** ### termsUrl[​](#termsurl "Direct link to termsUrl") > **termsUrl**: `string` Defined in: [packages/sdk/src/types/organization-types.ts:232](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/organization-types.ts#L232) *** ### useCase[​](#usecase "Direct link to useCase") > **useCase**: `string` Defined in: [packages/sdk/src/types/organization-types.ts:227](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/organization-types.ts#L227) --- # Interface: ResolveGrantRequest Defined in: [packages/sdk/src/types/access-grant-types.ts:76](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/access-grant-types.ts#L76) ## Properties[​](#properties "Direct link to Properties") ### approve[​](#approve "Direct link to approve") > **approve**: `boolean` Defined in: [packages/sdk/src/types/access-grant-types.ts:77](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/access-grant-types.ts#L77) *** ### consentMethod?[​](#consentmethod "Direct link to consentMethod?") > `optional` **consentMethod**: [`ConsentMethod`](https://docs.gravityrail.com/sdk/enumerations/ConsentMethod.md) Defined in: [packages/sdk/src/types/access-grant-types.ts:78](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/access-grant-types.ts#L78) *** ### expiresAt?[​](#expiresat "Direct link to expiresAt?") > `optional` **expiresAt**: `string` Defined in: [packages/sdk/src/types/access-grant-types.ts:79](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/access-grant-types.ts#L79) --- # Interface: ResourceMetadata Defined in: [packages/sdk/src/types/resource-metadata.ts:12](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/resource-metadata.ts#L12) ## Properties[​](#properties "Direct link to Properties") ### description[​](#description "Direct link to description") > **description**: `string` Defined in: [packages/sdk/src/types/resource-metadata.ts:16](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/resource-metadata.ts#L16) *** ### label[​](#label "Direct link to label") > **label**: `string` Defined in: [packages/sdk/src/types/resource-metadata.ts:13](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/resource-metadata.ts#L13) *** ### requiresFeature[​](#requiresfeature "Direct link to requiresFeature") > **requiresFeature**: [`WorkspaceFeature`](https://docs.gravityrail.com/sdk/enumerations/WorkspaceFeature.md) | `null` Defined in: [packages/sdk/src/types/resource-metadata.ts:18](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/resource-metadata.ts#L18) Feature required to use this resource (null means always available) *** ### scope[​](#scope "Direct link to scope") > **scope**: [`ResourceScope`](https://docs.gravityrail.com/sdk/type-aliases/ResourceScope.md) Defined in: [packages/sdk/src/types/resource-metadata.ts:20](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/resource-metadata.ts#L20) Where this resource can be configured *** ### unit[​](#unit "Direct link to unit") > **unit**: `string` Defined in: [packages/sdk/src/types/resource-metadata.ts:14](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/resource-metadata.ts#L14) *** ### unitPlural[​](#unitplural "Direct link to unitPlural") > **unitPlural**: `string` Defined in: [packages/sdk/src/types/resource-metadata.ts:15](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/resource-metadata.ts#L15) --- # Interface: ResourceOverage Defined in: [packages/sdk/src/types/billing-types.ts:270](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L270) Overage details for a specific resource. Shows how much was included, used, and the overage cost. ## Properties[​](#properties "Direct link to Properties") ### included[​](#included "Direct link to included") > **included**: `number` Defined in: [packages/sdk/src/types/billing-types.ts:271](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L271) *** ### overageAmount[​](#overageamount "Direct link to overageAmount") > **overageAmount**: `number` Defined in: [packages/sdk/src/types/billing-types.ts:273](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L273) *** ### overageCostCents[​](#overagecostcents "Direct link to overageCostCents") > **overageCostCents**: `number` Defined in: [packages/sdk/src/types/billing-types.ts:274](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L274) *** ### used[​](#used "Direct link to used") > **used**: `number` Defined in: [packages/sdk/src/types/billing-types.ts:272](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L272) --- # Interface: ResourceOverageResponse Defined in: [packages/sdk/src/types/generated/usage.ts:159](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/usage.ts#L159) Resource overage details response. ## Properties[​](#properties "Direct link to Properties") ### included[​](#included "Direct link to included") > **included**: `number` Defined in: [packages/sdk/src/types/generated/usage.ts:160](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/usage.ts#L160) *** ### overageAmount[​](#overageamount "Direct link to overageAmount") > **overageAmount**: `number` Defined in: [packages/sdk/src/types/generated/usage.ts:162](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/usage.ts#L162) *** ### overageCostCents[​](#overagecostcents "Direct link to overageCostCents") > **overageCostCents**: `number` Defined in: [packages/sdk/src/types/generated/usage.ts:163](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/usage.ts#L163) *** ### used[​](#used "Direct link to used") > **used**: `number` Defined in: [packages/sdk/src/types/generated/usage.ts:161](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/usage.ts#L161) --- # Interface: ResourceUsageResponse Defined in: [packages/sdk/src/types/generated/usage.ts:169](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/usage.ts#L169) Resource usage breakdown response. ## Properties[​](#properties "Direct link to Properties") ### credit[​](#credit "Direct link to credit") > **credit**: [`AIUsageDetailsResponse`](https://docs.gravityrail.com/sdk/interfaces/AIUsageDetailsResponse.md) Defined in: [packages/sdk/src/types/generated/usage.ts:170](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/usage.ts#L170) *** ### email[​](#email "Direct link to email") > **email**: [`EmailUsageResponse`](https://docs.gravityrail.com/sdk/interfaces/EmailUsageResponse.md) Defined in: [packages/sdk/src/types/generated/usage.ts:173](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/usage.ts#L173) *** ### inbox[​](#inbox "Direct link to inbox") > **inbox**: `number` Defined in: [packages/sdk/src/types/generated/usage.ts:178](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/usage.ts#L178) *** ### member[​](#member "Direct link to member") > **member**: `number` Defined in: [packages/sdk/src/types/generated/usage.ts:175](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/usage.ts#L175) *** ### phoneCall[​](#phonecall "Direct link to phoneCall") > **phoneCall**: [`PhoneCallUsageResponse`](https://docs.gravityrail.com/sdk/interfaces/PhoneCallUsageResponse.md) Defined in: [packages/sdk/src/types/generated/usage.ts:172](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/usage.ts#L172) *** ### phoneNumber[​](#phonenumber "Direct link to phoneNumber") > **phoneNumber**: `number` Defined in: [packages/sdk/src/types/generated/usage.ts:176](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/usage.ts#L176) *** ### site[​](#site "Direct link to site") > **site**: `number` Defined in: [packages/sdk/src/types/generated/usage.ts:177](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/usage.ts#L177) *** ### sms[​](#sms "Direct link to sms") > **sms**: [`SMSMessageUsageResponse`](https://docs.gravityrail.com/sdk/interfaces/SMSMessageUsageResponse.md) Defined in: [packages/sdk/src/types/generated/usage.ts:171](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/usage.ts#L171) *** ### storageMb[​](#storagemb "Direct link to storageMb") > **storageMb**: `number` Defined in: [packages/sdk/src/types/generated/usage.ts:174](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/usage.ts#L174) --- # Interface: RevokeGrantRequest Defined in: [packages/sdk/src/types/access-grant-types.ts:82](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/access-grant-types.ts#L82) ## Properties[​](#properties "Direct link to Properties") ### reason?[​](#reason "Direct link to reason?") > `optional` **reason**: `string` Defined in: [packages/sdk/src/types/access-grant-types.ts:83](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/access-grant-types.ts#L83) --- # Interface: RoleAssociationEntry Defined in: [packages/sdk/src/types/file-types.ts:147](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/file-types.ts#L147) ## Properties[​](#properties "Direct link to Properties") ### accessMode[​](#accessmode "Direct link to accessMode") > **accessMode**: `number` Defined in: [packages/sdk/src/types/file-types.ts:149](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/file-types.ts#L149) *** ### memberRoleId[​](#memberroleid "Direct link to memberRoleId") > **memberRoleId**: `number` Defined in: [packages/sdk/src/types/file-types.ts:148](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/file-types.ts#L148) --- # Interface: RoutineExport Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:211](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L211) ## Properties[​](#properties "Direct link to Properties") ### cronString?[​](#cronstring "Direct link to cronString?") > `optional` **cronString**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:220](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L220) *** ### description?[​](#description "Direct link to description?") > `optional` **description**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:215](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L215) *** ### intervalSeconds?[​](#intervalseconds "Direct link to intervalSeconds?") > `optional` **intervalSeconds**: `number` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:218](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L218) *** ### limit?[​](#limit "Direct link to limit?") > `optional` **limit**: `number` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:225](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L225) *** ### memberFilterUuid?[​](#memberfilteruuid "Direct link to memberFilterUuid?") > `optional` **memberFilterUuid**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:222](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L222) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:214](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L214) *** ### repeatCount?[​](#repeatcount "Direct link to repeatCount?") > `optional` **repeatCount**: `number` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:219](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L219) *** ### scheduledTime?[​](#scheduledtime "Direct link to scheduledTime?") > `optional` **scheduledTime**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:217](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L217) *** ### scheduleEnabled?[​](#scheduleenabled "Direct link to scheduleEnabled?") > `optional` **scheduleEnabled**: `boolean` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:227](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L227) *** ### scheduleMode[​](#schedulemode "Direct link to scheduleMode") > **scheduleMode**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:216](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L216) *** ### startDate?[​](#startdate "Direct link to startDate?") > `optional` **startDate**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:221](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L221) *** ### targetMemberUuid?[​](#targetmemberuuid "Direct link to targetMemberUuid?") > `optional` **targetMemberUuid**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:223](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L223) *** ### templateUuid?[​](#templateuuid "Direct link to templateUuid?") > `optional` **templateUuid**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:213](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L213) *** ### uuid[​](#uuid "Direct link to uuid") > **uuid**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:212](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L212) *** ### visibility?[​](#visibility "Direct link to visibility?") > `optional` **visibility**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:226](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L226) *** ### webhookEnabled?[​](#webhookenabled "Direct link to webhookEnabled?") > `optional` **webhookEnabled**: `boolean` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:228](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L228) *** ### workflowUuid?[​](#workflowuuid "Direct link to workflowUuid?") > `optional` **workflowUuid**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:224](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L224) --- # Interface: RoutineResponse Defined in: [packages/sdk/src/types/event-types.ts:158](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L158) ## Extends[​](#extends "Direct link to Extends") * `Omit`<`GeneratedRoutineResponse`, `"eventRules"` | `"visibility"` | `"scheduleMode"` | `"webhookEnabled"`> ## Properties[​](#properties "Direct link to Properties") ### createdAt[​](#createdat "Direct link to createdAt") > **createdAt**: `string` Defined in: [packages/sdk/src/types/generated/routine.ts:63](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/routine.ts#L63) #### Inherited from[​](#inherited-from "Direct link to Inherited from") `Omit.createdAt` *** ### cronString?[​](#cronstring "Direct link to cronString?") > `optional` **cronString**: `string` | `null` Defined in: [packages/sdk/src/types/generated/routine.ts:53](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/routine.ts#L53) #### Inherited from[​](#inherited-from-1 "Direct link to Inherited from") `Omit.cronString` *** ### description?[​](#description "Direct link to description?") > `optional` **description**: `string` | `null` Defined in: [packages/sdk/src/types/generated/routine.ts:47](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/routine.ts#L47) #### Inherited from[​](#inherited-from-2 "Direct link to Inherited from") `Omit.description` *** ### eventRules?[​](#eventrules "Direct link to eventRules?") > `optional` **eventRules**: [`EventRuleResponse`](https://docs.gravityrail.com/sdk/type-aliases/EventRuleResponse.md)\[] Defined in: [packages/sdk/src/types/event-types.ts:166](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L166) *** ### id[​](#id "Direct link to id") > **id**: `number` Defined in: [packages/sdk/src/types/generated/routine.ts:44](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/routine.ts#L44) #### Inherited from[​](#inherited-from-3 "Direct link to Inherited from") `Omit.id` *** ### intervalSeconds?[​](#intervalseconds "Direct link to intervalSeconds?") > `optional` **intervalSeconds**: `number` | `null` Defined in: [packages/sdk/src/types/generated/routine.ts:51](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/routine.ts#L51) #### Inherited from[​](#inherited-from-4 "Direct link to Inherited from") `Omit.intervalSeconds` *** ### lastRun?[​](#lastrun "Direct link to lastRun?") > `optional` **lastRun**: [`RoutineRunResponse`](https://docs.gravityrail.com/sdk/interfaces/RoutineRunResponse.md) Defined in: [packages/sdk/src/types/event-types.ts:165](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L165) *** ### limit[​](#limit "Direct link to limit") > **limit**: `number` Defined in: [packages/sdk/src/types/generated/routine.ts:60](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/routine.ts#L60) #### Inherited from[​](#inherited-from-5 "Direct link to Inherited from") `Omit.limit` *** ### memberFilterId?[​](#memberfilterid "Direct link to memberFilterId?") > `optional` **memberFilterId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/routine.ts:56](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/routine.ts#L56) #### Inherited from[​](#inherited-from-6 "Direct link to Inherited from") `Omit.memberFilterId` *** ### memberFilterName?[​](#memberfiltername "Direct link to memberFilterName?") > `optional` **memberFilterName**: `string` | `null` Defined in: [packages/sdk/src/types/generated/routine.ts:57](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/routine.ts#L57) #### Inherited from[​](#inherited-from-7 "Direct link to Inherited from") `Omit.memberFilterName` *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/generated/routine.ts:46](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/routine.ts#L46) #### Inherited from[​](#inherited-from-8 "Direct link to Inherited from") `Omit.name` *** ### nextRun?[​](#nextrun "Direct link to nextRun?") > `optional` **nextRun**: `string` | `null` Defined in: [packages/sdk/src/types/generated/routine.ts:66](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/routine.ts#L66) #### Inherited from[​](#inherited-from-9 "Direct link to Inherited from") `Omit.nextRun` *** ### ownerId[​](#ownerid "Direct link to ownerId") > **ownerId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/routine.ts:62](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/routine.ts#L62) #### Inherited from[​](#inherited-from-10 "Direct link to Inherited from") `Omit.ownerId` *** ### repeatCount?[​](#repeatcount "Direct link to repeatCount?") > `optional` **repeatCount**: `number` | `null` Defined in: [packages/sdk/src/types/generated/routine.ts:52](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/routine.ts#L52) #### Inherited from[​](#inherited-from-11 "Direct link to Inherited from") `Omit.repeatCount` *** ### scheduledTime?[​](#scheduledtime "Direct link to scheduledTime?") > `optional` **scheduledTime**: `string` | `null` Defined in: [packages/sdk/src/types/generated/routine.ts:50](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/routine.ts#L50) #### Inherited from[​](#inherited-from-12 "Direct link to Inherited from") `Omit.scheduledTime` *** ### scheduleEnabled[​](#scheduleenabled "Direct link to scheduleEnabled") > **scheduleEnabled**: `boolean` Defined in: [packages/sdk/src/types/generated/routine.ts:48](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/routine.ts#L48) #### Inherited from[​](#inherited-from-13 "Direct link to Inherited from") `Omit.scheduleEnabled` *** ### scheduleMode[​](#schedulemode "Direct link to scheduleMode") > **scheduleMode**: [`RoutineScheduleMode`](https://docs.gravityrail.com/sdk/type-aliases/RoutineScheduleMode.md) Defined in: [packages/sdk/src/types/event-types.ts:163](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L163) *** ### startDate?[​](#startdate "Direct link to startDate?") > `optional` **startDate**: `string` | `null` Defined in: [packages/sdk/src/types/generated/routine.ts:55](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/routine.ts#L55) #### Inherited from[​](#inherited-from-14 "Direct link to Inherited from") `Omit.startDate` *** ### targetMemberId?[​](#targetmemberid "Direct link to targetMemberId?") > `optional` **targetMemberId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/routine.ts:58](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/routine.ts#L58) #### Inherited from[​](#inherited-from-15 "Direct link to Inherited from") `Omit.targetMemberId` *** ### timezone?[​](#timezone "Direct link to timezone?") > `optional` **timezone**: `string` | `null` Defined in: [packages/sdk/src/types/generated/routine.ts:54](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/routine.ts#L54) #### Inherited from[​](#inherited-from-16 "Direct link to Inherited from") `Omit.timezone` *** ### updatedAt[​](#updatedat "Direct link to updatedAt") > **updatedAt**: `string` Defined in: [packages/sdk/src/types/generated/routine.ts:64](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/routine.ts#L64) #### Inherited from[​](#inherited-from-17 "Direct link to Inherited from") `Omit.updatedAt` *** ### uuid[​](#uuid "Direct link to uuid") > **uuid**: `string` Defined in: [packages/sdk/src/types/generated/routine.ts:45](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/routine.ts#L45) #### Inherited from[​](#inherited-from-18 "Direct link to Inherited from") `Omit.uuid` *** ### visibility[​](#visibility "Direct link to visibility") > **visibility**: [`RoutineVisibility`](https://docs.gravityrail.com/sdk/type-aliases/RoutineVisibility.md) Defined in: [packages/sdk/src/types/event-types.ts:162](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L162) *** ### webhookEnabled[​](#webhookenabled "Direct link to webhookEnabled") > **webhookEnabled**: `boolean` Defined in: [packages/sdk/src/types/event-types.ts:164](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L164) *** ### webhookSecretPlaintext?[​](#webhooksecretplaintext "Direct link to webhookSecretPlaintext?") > `optional` **webhookSecretPlaintext**: `string` | `null` Defined in: [packages/sdk/src/types/generated/routine.ts:68](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/routine.ts#L68) #### Inherited from[​](#inherited-from-19 "Direct link to Inherited from") `Omit.webhookSecretPlaintext` *** ### workflowId?[​](#workflowid "Direct link to workflowId?") > `optional` **workflowId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/routine.ts:59](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/routine.ts#L59) #### Inherited from[​](#inherited-from-20 "Direct link to Inherited from") `Omit.workflowId` --- # Interface: RoutineRunResponse Defined in: [packages/sdk/src/types/generated/routine.ts:74](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/routine.ts#L74) Response model for Routine runs. ## Properties[​](#properties "Direct link to Properties") ### assignmentId?[​](#assignmentid "Direct link to assignmentId?") > `optional` **assignmentId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/routine.ts:86](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/routine.ts#L86) *** ### chatId?[​](#chatid "Direct link to chatId?") > `optional` **chatId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/routine.ts:85](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/routine.ts#L85) *** ### completedAt?[​](#completedat "Direct link to completedAt?") > `optional` **completedAt**: `string` | `null` Defined in: [packages/sdk/src/types/generated/routine.ts:82](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/routine.ts#L82) *** ### createdAt[​](#createdat "Direct link to createdAt") > **createdAt**: `string` Defined in: [packages/sdk/src/types/generated/routine.ts:87](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/routine.ts#L87) *** ### errorMessage?[​](#errormessage "Direct link to errorMessage?") > `optional` **errorMessage**: `string` | `null` Defined in: [packages/sdk/src/types/generated/routine.ts:83](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/routine.ts#L83) *** ### id[​](#id "Direct link to id") > **id**: `number` Defined in: [packages/sdk/src/types/generated/routine.ts:75](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/routine.ts#L75) *** ### jobId?[​](#jobid "Direct link to jobId?") > `optional` **jobId**: `string` | `null` Defined in: [packages/sdk/src/types/generated/routine.ts:84](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/routine.ts#L84) *** ### member?[​](#member "Direct link to member?") > `optional` **member**: [`MemberSummary`](https://docs.gravityrail.com/sdk/interfaces/MemberSummary.md) | `null` Defined in: [packages/sdk/src/types/generated/routine.ts:89](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/routine.ts#L89) *** ### memberId?[​](#memberid "Direct link to memberId?") > `optional` **memberId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/routine.ts:79](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/routine.ts#L79) *** ### parentRunId?[​](#parentrunid "Direct link to parentRunId?") > `optional` **parentRunId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/routine.ts:78](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/routine.ts#L78) *** ### routineId[​](#routineid "Direct link to routineId") > **routineId**: `number` Defined in: [packages/sdk/src/types/generated/routine.ts:77](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/routine.ts#L77) *** ### startedAt?[​](#startedat "Direct link to startedAt?") > `optional` **startedAt**: `string` | `null` Defined in: [packages/sdk/src/types/generated/routine.ts:81](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/routine.ts#L81) *** ### status[​](#status "Direct link to status") > **status**: `string` Defined in: [packages/sdk/src/types/generated/routine.ts:80](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/routine.ts#L80) *** ### updatedAt[​](#updatedat "Direct link to updatedAt") > **updatedAt**: `string` Defined in: [packages/sdk/src/types/generated/routine.ts:88](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/routine.ts#L88) *** ### uuid[​](#uuid "Direct link to uuid") > **uuid**: `string` Defined in: [packages/sdk/src/types/generated/routine.ts:76](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/routine.ts#L76) --- # Interface: RoutineRunsQueryParams Defined in: [packages/sdk/src/types/event-types.ts:631](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L631) ## Properties[​](#properties "Direct link to Properties") ### memberId?[​](#memberid "Direct link to memberId?") > `optional` **memberId**: `number` Defined in: [packages/sdk/src/types/event-types.ts:637](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L637) *** ### page?[​](#page "Direct link to page?") > `optional` **page**: `number` Defined in: [packages/sdk/src/types/event-types.ts:632](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L632) *** ### pageSize?[​](#pagesize "Direct link to pageSize?") > `optional` **pageSize**: `number` Defined in: [packages/sdk/src/types/event-types.ts:633](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L633) *** ### routineId?[​](#routineid "Direct link to routineId?") > `optional` **routineId**: `number` Defined in: [packages/sdk/src/types/event-types.ts:636](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L636) *** ### sortBy?[​](#sortby "Direct link to sortBy?") > `optional` **sortBy**: `"createdAt"` Defined in: [packages/sdk/src/types/event-types.ts:634](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L634) *** ### sortOrder?[​](#sortorder "Direct link to sortOrder?") > `optional` **sortOrder**: [`SortOrder`](https://docs.gravityrail.com/sdk/type-aliases/SortOrder.md) Defined in: [packages/sdk/src/types/event-types.ts:635](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L635) *** ### status?[​](#status "Direct link to status?") > `optional` **status**: [`RoutineRunStatus`](https://docs.gravityrail.com/sdk/type-aliases/RoutineRunStatus.md) Defined in: [packages/sdk/src/types/event-types.ts:638](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L638) --- # Interface: RoutinesQueryParams Defined in: [packages/sdk/src/types/event-types.ts:618](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L618) ## Properties[​](#properties "Direct link to Properties") ### owner?[​](#owner "Direct link to owner?") > `optional` **owner**: `"all"` | `"mine"` | `"shared"` | `"all_including_private"` Defined in: [packages/sdk/src/types/event-types.ts:628](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L628) 'mine' = routines I own, 'shared' = workspace-visible from others, 'all' = both. 'all\_including\_private' = every routine in the workspace; requires AUTOMATIONS\_ADMIN and will 403 otherwise. *** ### page?[​](#page "Direct link to page?") > `optional` **page**: `number` Defined in: [packages/sdk/src/types/event-types.ts:619](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L619) *** ### pageSize?[​](#pagesize "Direct link to pageSize?") > `optional` **pageSize**: `number` Defined in: [packages/sdk/src/types/event-types.ts:620](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L620) *** ### sortBy?[​](#sortby "Direct link to sortBy?") > `optional` **sortBy**: [`RoutineSortField`](https://docs.gravityrail.com/sdk/type-aliases/RoutineSortField.md) Defined in: [packages/sdk/src/types/event-types.ts:621](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L621) *** ### sortOrder?[​](#sortorder "Direct link to sortOrder?") > `optional` **sortOrder**: [`SortOrder`](https://docs.gravityrail.com/sdk/type-aliases/SortOrder.md) Defined in: [packages/sdk/src/types/event-types.ts:622](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L622) --- # Interface: RuleExecutionResponse Defined in: [packages/sdk/src/types/generated/rule\_execution.ts:13](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/rule_execution.ts#L13) Response model for RuleExecutionLog entity. ## Properties[​](#properties "Direct link to Properties") ### actionSlug[​](#actionslug "Direct link to actionSlug") > **actionSlug**: `string` Defined in: [packages/sdk/src/types/generated/rule\_execution.ts:17](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/rule_execution.ts#L17) *** ### completedAt?[​](#completedat "Direct link to completedAt?") > `optional` **completedAt**: `string` | `null` Defined in: [packages/sdk/src/types/generated/rule\_execution.ts:27](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/rule_execution.ts#L27) *** ### createdAt[​](#createdat "Direct link to createdAt") > **createdAt**: `string` Defined in: [packages/sdk/src/types/generated/rule\_execution.ts:26](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/rule_execution.ts#L26) *** ### details?[​](#details "Direct link to details?") > `optional` **details**: `RuleExecutionResponseDetails` Defined in: [packages/sdk/src/types/generated/rule\_execution.ts:25](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/rule_execution.ts#L25) *** ### durationMs?[​](#durationms "Direct link to durationMs?") > `optional` **durationMs**: `number` | `null` Defined in: [packages/sdk/src/types/generated/rule\_execution.ts:28](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/rule_execution.ts#L28) *** ### errorCode?[​](#errorcode "Direct link to errorCode?") > `optional` **errorCode**: `string` | `null` Defined in: [packages/sdk/src/types/generated/rule\_execution.ts:22](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/rule_execution.ts#L22) *** ### errorMessage?[​](#errormessage "Direct link to errorMessage?") > `optional` **errorMessage**: `string` | `null` Defined in: [packages/sdk/src/types/generated/rule\_execution.ts:23](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/rule_execution.ts#L23) *** ### id[​](#id "Direct link to id") > **id**: `number` Defined in: [packages/sdk/src/types/generated/rule\_execution.ts:14](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/rule_execution.ts#L14) *** ### messagesEmitted[​](#messagesemitted "Direct link to messagesEmitted") > **messagesEmitted**: `number` Defined in: [packages/sdk/src/types/generated/rule\_execution.ts:19](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/rule_execution.ts#L19) *** ### rule?[​](#rule "Direct link to rule?") > `optional` **rule**: `EventRuleResponse` | `null` Defined in: [packages/sdk/src/types/generated/rule\_execution.ts:29](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/rule_execution.ts#L29) *** ### ruleId[​](#ruleid "Direct link to ruleId") > **ruleId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/rule\_execution.ts:15](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/rule_execution.ts#L15) *** ### status[​](#status "Direct link to status") > **status**: `string` Defined in: [packages/sdk/src/types/generated/rule\_execution.ts:18](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/rule_execution.ts#L18) *** ### taskSwitched[​](#taskswitched "Direct link to taskSwitched") > **taskSwitched**: `boolean` Defined in: [packages/sdk/src/types/generated/rule\_execution.ts:20](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/rule_execution.ts#L20) *** ### triggerFingerprint?[​](#triggerfingerprint "Direct link to triggerFingerprint?") > `optional` **triggerFingerprint**: `string` | `null` Defined in: [packages/sdk/src/types/generated/rule\_execution.ts:24](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/rule_execution.ts#L24) *** ### triggerType[​](#triggertype "Direct link to triggerType") > **triggerType**: `string` Defined in: [packages/sdk/src/types/generated/rule\_execution.ts:16](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/rule_execution.ts#L16) *** ### validationErrors[​](#validationerrors "Direct link to validationErrors") > **validationErrors**: `string`\[] Defined in: [packages/sdk/src/types/generated/rule\_execution.ts:21](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/rule_execution.ts#L21) --- # Interface: RuleExecutionsQueryParams Defined in: [packages/sdk/src/types/event-types.ts:537](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L537) ## Properties[​](#properties "Direct link to Properties") ### actionSlug?[​](#actionslug "Direct link to actionSlug?") > `optional` **actionSlug**: `string` Defined in: [packages/sdk/src/types/event-types.ts:545](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L545) *** ### actionType?[​](#actiontype "Direct link to actionType?") > `optional` **actionType**: `string` Defined in: [packages/sdk/src/types/event-types.ts:548](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L548) *** ### cursor?[​](#cursor "Direct link to cursor?") > `optional` **cursor**: `string` Defined in: [packages/sdk/src/types/event-types.ts:538](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L538) *** ### eventType?[​](#eventtype "Direct link to eventType?") > `optional` **eventType**: `string` Defined in: [packages/sdk/src/types/event-types.ts:547](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L547) *** ### objectType?[​](#objecttype "Direct link to objectType?") > `optional` **objectType**: `string` Defined in: [packages/sdk/src/types/event-types.ts:546](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L546) *** ### pageSize?[​](#pagesize "Direct link to pageSize?") > `optional` **pageSize**: `number` Defined in: [packages/sdk/src/types/event-types.ts:539](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L539) *** ### ruleId?[​](#ruleid "Direct link to ruleId?") > `optional` **ruleId**: `number` Defined in: [packages/sdk/src/types/event-types.ts:542](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L542) *** ### sortBy?[​](#sortby "Direct link to sortBy?") > `optional` **sortBy**: [`RuleExecutionSortField`](https://docs.gravityrail.com/sdk/type-aliases/RuleExecutionSortField.md) Defined in: [packages/sdk/src/types/event-types.ts:540](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L540) *** ### sortOrder?[​](#sortorder "Direct link to sortOrder?") > `optional` **sortOrder**: [`SortOrder`](https://docs.gravityrail.com/sdk/type-aliases/SortOrder.md) Defined in: [packages/sdk/src/types/event-types.ts:541](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L541) *** ### status?[​](#status "Direct link to status?") > `optional` **status**: `string` Defined in: [packages/sdk/src/types/event-types.ts:543](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L543) *** ### triggerType?[​](#triggertype "Direct link to triggerType?") > `optional` **triggerType**: `string` Defined in: [packages/sdk/src/types/event-types.ts:544](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L544) *** ### workflowId?[​](#workflowid "Direct link to workflowId?") > `optional` **workflowId**: `number` Defined in: [packages/sdk/src/types/event-types.ts:549](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L549) --- # Interface: RunQueryRequest Defined in: [packages/sdk/src/types/query-engine-types.ts:240](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L240) ## Properties[​](#properties "Direct link to Properties") ### mode?[​](#mode "Direct link to mode?") > `optional` **mode**: [`QueryRunMode`](https://docs.gravityrail.com/sdk/type-aliases/QueryRunMode.md) | `null` Defined in: [packages/sdk/src/types/query-engine-types.ts:242](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L242) *** ### query[​](#query "Direct link to query") > **query**: [`QueryIR`](https://docs.gravityrail.com/sdk/interfaces/QueryIR.md) Defined in: [packages/sdk/src/types/query-engine-types.ts:241](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L241) --- # Interface: RunQueryResponse Defined in: [packages/sdk/src/types/query-engine-types.ts:257](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L257) ## Properties[​](#properties "Direct link to Properties") ### cost?[​](#cost "Direct link to cost?") > `optional` **cost**: [`QueryCostInfo`](https://docs.gravityrail.com/sdk/interfaces/QueryCostInfo.md) | `null` Defined in: [packages/sdk/src/types/query-engine-types.ts:264](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L264) *** ### count?[​](#count "Direct link to count?") > `optional` **count**: `number` | `null` Defined in: [packages/sdk/src/types/query-engine-types.ts:261](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L261) *** ### items?[​](#items "Direct link to items?") > `optional` **items**: `Record`<`string`, `unknown`>\[] | `null` Defined in: [packages/sdk/src/types/query-engine-types.ts:259](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L259) *** ### mode[​](#mode "Direct link to mode") > **mode**: `string` Defined in: [packages/sdk/src/types/query-engine-types.ts:258](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L258) *** ### nextCursor?[​](#nextcursor "Direct link to nextCursor?") > `optional` **nextCursor**: `string` | `null` Defined in: [packages/sdk/src/types/query-engine-types.ts:260](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L260) *** ### rows?[​](#rows "Direct link to rows?") > `optional` **rows**: `Record`<`string`, `unknown`>\[] | `null` Defined in: [packages/sdk/src/types/query-engine-types.ts:262](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L262) *** ### warnings[​](#warnings "Direct link to warnings") > **warnings**: `string`\[] Defined in: [packages/sdk/src/types/query-engine-types.ts:263](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L263) --- # Interface: SalesforceConnectionResponse Defined in: [packages/sdk/src/types/generated/app\_connection.ts:361](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L361) Serialized Salesforce connection for API responses. ## Properties[​](#properties "Direct link to Properties") ### apiVersion?[​](#apiversion "Direct link to apiVersion?") > `optional` **apiVersion**: `string` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:369](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L369) *** ### connectionType?[​](#connectiontype "Direct link to connectionType?") > `optional` **connectionType**: `"salesforce_connection"` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:362](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L362) *** ### createdAt?[​](#createdat "Direct link to createdAt?") > `optional` **createdAt**: `string` | `null` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:373](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L373) *** ### creatorId?[​](#creatorid "Direct link to creatorId?") > `optional` **creatorId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:367](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L367) *** ### enabled[​](#enabled "Direct link to enabled") > **enabled**: `boolean` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:366](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L366) *** ### id[​](#id "Direct link to id") > **id**: `number` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:363](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L363) *** ### instanceUrl?[​](#instanceurl "Direct link to instanceUrl?") > `optional` **instanceUrl**: `string` | `null` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:368](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L368) *** ### lastConnectedAt?[​](#lastconnectedat "Direct link to lastConnectedAt?") > `optional` **lastConnectedAt**: `string` | `null` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:372](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L372) *** ### memberObjectType?[​](#memberobjecttype "Direct link to memberObjectType?") > `optional` **memberObjectType**: `string` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:370](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L370) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:365](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L365) *** ### state?[​](#state "Direct link to state?") > `optional` **state**: `string` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:371](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L371) *** ### updatedAt?[​](#updatedat "Direct link to updatedAt?") > `optional` **updatedAt**: `string` | `null` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:374](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L374) *** ### uuid[​](#uuid "Direct link to uuid") > **uuid**: `string` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:364](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L364) --- # Interface: SalesforceDataRecordObjectMapping Defined in: [packages/sdk/src/types/app-connection-types.ts:329](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L329) ## Properties[​](#properties "Direct link to Properties") ### contactLookupField[​](#contactlookupfield "Direct link to contactLookupField") > **contactLookupField**: `string` Defined in: [packages/sdk/src/types/app-connection-types.ts:332](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L332) *** ### dataTypeId[​](#datatypeid "Direct link to dataTypeId") > **dataTypeId**: `number` Defined in: [packages/sdk/src/types/app-connection-types.ts:330](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L330) *** ### fieldRules[​](#fieldrules "Direct link to fieldRules") > **fieldRules**: [`SyncRuleOutbound`](https://docs.gravityrail.com/sdk/interfaces/SyncRuleOutbound.md)\[] Defined in: [packages/sdk/src/types/app-connection-types.ts:333](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L333) *** ### targetSobject[​](#targetsobject "Direct link to targetSobject") > **targetSobject**: `string` Defined in: [packages/sdk/src/types/app-connection-types.ts:331](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L331) --- # Interface: SalesforceSearchRequest Defined in: [packages/sdk/src/types/app-connection-types.ts:368](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L368) ## Properties[​](#properties "Direct link to Properties") ### limit?[​](#limit "Direct link to limit?") > `optional` **limit**: `number` Defined in: [packages/sdk/src/types/app-connection-types.ts:371](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L371) *** ### objectType[​](#objecttype "Direct link to objectType") > **objectType**: [`SalesforceSearchObjectType`](https://docs.gravityrail.com/sdk/type-aliases/SalesforceSearchObjectType.md) Defined in: [packages/sdk/src/types/app-connection-types.ts:370](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L370) *** ### query[​](#query "Direct link to query") > **query**: `string` Defined in: [packages/sdk/src/types/app-connection-types.ts:369](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L369) --- # Interface: SalesforceSearchResponse Defined in: [packages/sdk/src/types/app-connection-types.ts:389](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L389) ## Properties[​](#properties "Direct link to Properties") ### results[​](#results "Direct link to results") > **results**: [`SalesforceSearchResult`](https://docs.gravityrail.com/sdk/interfaces/SalesforceSearchResult.md)\[] Defined in: [packages/sdk/src/types/app-connection-types.ts:390](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L390) *** ### totalSize[​](#totalsize "Direct link to totalSize") > **totalSize**: `number` Defined in: [packages/sdk/src/types/app-connection-types.ts:391](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L391) --- # Interface: SalesforceSearchResult Defined in: [packages/sdk/src/types/app-connection-types.ts:379](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L379) ## Properties[​](#properties "Direct link to Properties") ### company[​](#company "Direct link to company") > **company**: `string` | `null` Defined in: [packages/sdk/src/types/app-connection-types.ts:384](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L384) *** ### email[​](#email "Direct link to email") > **email**: `string` | `null` Defined in: [packages/sdk/src/types/app-connection-types.ts:382](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L382) *** ### existingMember[​](#existingmember "Direct link to existingMember") > **existingMember**: [`SalesforceSearchResultMatch`](https://docs.gravityrail.com/sdk/interfaces/SalesforceSearchResultMatch.md) | `null` Defined in: [packages/sdk/src/types/app-connection-types.ts:386](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L386) *** ### id[​](#id "Direct link to id") > **id**: `string` Defined in: [packages/sdk/src/types/app-connection-types.ts:380](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L380) *** ### name[​](#name "Direct link to name") > **name**: `string` | `null` Defined in: [packages/sdk/src/types/app-connection-types.ts:381](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L381) *** ### objectType[​](#objecttype "Direct link to objectType") > **objectType**: `string` Defined in: [packages/sdk/src/types/app-connection-types.ts:385](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L385) *** ### phone[​](#phone "Direct link to phone") > **phone**: `string` | `null` Defined in: [packages/sdk/src/types/app-connection-types.ts:383](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L383) --- # Interface: SalesforceSearchResultMatch Defined in: [packages/sdk/src/types/app-connection-types.ts:374](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L374) ## Properties[​](#properties "Direct link to Properties") ### matchType[​](#matchtype "Direct link to matchType") > **matchType**: `"email"` | `"phone"` | `"salesforce_id"` Defined in: [packages/sdk/src/types/app-connection-types.ts:376](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L376) *** ### memberId[​](#memberid "Direct link to memberId") > **memberId**: `number` Defined in: [packages/sdk/src/types/app-connection-types.ts:375](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L375) --- # Interface: SalesforceSyncConfigResponse Defined in: [packages/sdk/src/types/app-connection-types.ts:354](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L354) ## Properties[​](#properties "Direct link to Properties") ### salesforceSyncSettings[​](#salesforcesyncsettings "Direct link to salesforceSyncSettings") > **salesforceSyncSettings**: [`SalesforceSyncSettings`](https://docs.gravityrail.com/sdk/interfaces/SalesforceSyncSettings.md) Defined in: [packages/sdk/src/types/app-connection-types.ts:356](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L356) *** ### syncConfig[​](#syncconfig "Direct link to syncConfig") > **syncConfig**: [`ConnectionSyncConfig`](https://docs.gravityrail.com/sdk/interfaces/ConnectionSyncConfig.md) Defined in: [packages/sdk/src/types/app-connection-types.ts:355](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L355) --- # Interface: SalesforceSyncSettings Defined in: [packages/sdk/src/types/app-connection-types.ts:338](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L338) ## Properties[​](#properties "Direct link to Properties") ### dataRecordMappings[​](#datarecordmappings "Direct link to dataRecordMappings") > **dataRecordMappings**: [`SalesforceDataRecordObjectMapping`](https://docs.gravityrail.com/sdk/interfaces/SalesforceDataRecordObjectMapping.md)\[] Defined in: [packages/sdk/src/types/app-connection-types.ts:348](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L348) *** ### inboundPollIntervalMinutes[​](#inboundpollintervalminutes "Direct link to inboundPollIntervalMinutes") > **inboundPollIntervalMinutes**: `number` Defined in: [packages/sdk/src/types/app-connection-types.ts:347](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L347) *** ### labelSyncMode[​](#labelsyncmode "Direct link to labelSyncMode") > **labelSyncMode**: [`SalesforceLabelSyncMode`](https://docs.gravityrail.com/sdk/type-aliases/SalesforceLabelSyncMode.md) Defined in: [packages/sdk/src/types/app-connection-types.ts:344](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L344) *** ### labelTargetField[​](#labeltargetfield "Direct link to labelTargetField") > **labelTargetField**: `string` Defined in: [packages/sdk/src/types/app-connection-types.ts:345](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L345) *** ### noteSobject[​](#notesobject "Direct link to noteSobject") > **noteSobject**: `string` Defined in: [packages/sdk/src/types/app-connection-types.ts:342](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L342) *** ### recordTypeId[​](#recordtypeid "Direct link to recordTypeId") > **recordTypeId**: `string` | `null` Defined in: [packages/sdk/src/types/app-connection-types.ts:340](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L340) *** ### targetSobject[​](#targetsobject "Direct link to targetSobject") > **targetSobject**: `string` Defined in: [packages/sdk/src/types/app-connection-types.ts:341](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L341) *** ### taskSobject[​](#tasksobject "Direct link to taskSobject") > **taskSobject**: `string` Defined in: [packages/sdk/src/types/app-connection-types.ts:343](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L343) *** ### upsertField[​](#upsertfield "Direct link to upsertField") > **upsertField**: `string` Defined in: [packages/sdk/src/types/app-connection-types.ts:339](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L339) *** ### useCompositeApi[​](#usecompositeapi "Direct link to useCompositeApi") > **useCompositeApi**: `boolean` Defined in: [packages/sdk/src/types/app-connection-types.ts:346](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L346) --- # Interface: ScenarioCriterionExport Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:301](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L301) ## Properties[​](#properties "Direct link to Properties") ### celExpression?[​](#celexpression "Direct link to celExpression?") > `optional` **celExpression**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:308](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L308) *** ### criterionType[​](#criteriontype "Direct link to criterionType") > **criterionType**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:306](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L306) *** ### description?[​](#description "Direct link to description?") > `optional` **description**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:305](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L305) *** ### evaluationPrompt?[​](#evaluationprompt "Direct link to evaluationPrompt?") > `optional` **evaluationPrompt**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:309](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L309) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:304](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L304) *** ### order[​](#order "Direct link to order") > **order**: `number` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:303](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L303) *** ### passingThreshold[​](#passingthreshold "Direct link to passingThreshold") > **passingThreshold**: `number` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:310](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L310) *** ### uuid[​](#uuid "Direct link to uuid") > **uuid**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:302](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L302) *** ### weight[​](#weight "Direct link to weight") > **weight**: `number` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:307](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L307) --- # Interface: ScenarioDataRecord Defined in: [packages/sdk/src/types/qualification-types.ts:37](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/qualification-types.ts#L37) ## Properties[​](#properties "Direct link to Properties") ### externalId?[​](#externalid "Direct link to externalId?") > `optional` **externalId**: `string` Defined in: [packages/sdk/src/types/qualification-types.ts:38](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/qualification-types.ts#L38) *** ### fieldValues[​](#fieldvalues "Direct link to fieldValues") > **fieldValues**: `Record`<`string`, `unknown`> Defined in: [packages/sdk/src/types/qualification-types.ts:39](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/qualification-types.ts#L39) --- # Interface: ScenarioExport Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:313](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L313) ## Properties[​](#properties "Direct link to Properties") ### channel?[​](#channel "Direct link to channel?") > `optional` **channel**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:321](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L321) *** ### criteria[​](#criteria "Direct link to criteria") > **criteria**: [`ScenarioCriterionExport`](https://docs.gravityrail.com/sdk/interfaces/ScenarioCriterionExport.md)\[] Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:323](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L323) *** ### dataRecords?[​](#datarecords "Direct link to dataRecords?") > `optional` **dataRecords**: `Record`<`string`, `any`> Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:322](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L322) *** ### description?[​](#description "Direct link to description?") > `optional` **description**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:318](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L318) *** ### goal?[​](#goal "Direct link to goal?") > `optional` **goal**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:320](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L320) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:317](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L317) *** ### order[​](#order "Direct link to order") > **order**: `number` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:315](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L315) *** ### personaUuid?[​](#personauuid "Direct link to personaUuid?") > `optional` **personaUuid**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:319](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L319) *** ### slug[​](#slug "Direct link to slug") > **slug**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:316](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L316) *** ### uuid[​](#uuid "Direct link to uuid") > **uuid**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:314](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L314) --- # Interface: ScheduledCallbackListResponse Defined in: [packages/sdk/src/types/generated/chat.ts:454](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L454) Callbacks for one chat. ## Properties[​](#properties "Direct link to Properties") ### callbacks[​](#callbacks "Direct link to callbacks") > **callbacks**: [`ScheduledCallbackResponse`](https://docs.gravityrail.com/sdk/interfaces/ScheduledCallbackResponse.md)\[] Defined in: [packages/sdk/src/types/generated/chat.ts:455](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L455) --- # Interface: ScheduledCallbackResponse Defined in: [packages/sdk/src/types/generated/chat.ts:461](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L461) One scheduled follow-up on a chat. ## Properties[​](#properties "Direct link to Properties") ### chatId[​](#chatid "Direct link to chatId") > **chatId**: `number` Defined in: [packages/sdk/src/types/generated/chat.ts:464](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L464) *** ### completedAt?[​](#completedat "Direct link to completedAt?") > `optional` **completedAt**: `string` | `null` Defined in: [packages/sdk/src/types/generated/chat.ts:473](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L473) *** ### createdAt[​](#createdat "Direct link to createdAt") > **createdAt**: `string` Defined in: [packages/sdk/src/types/generated/chat.ts:472](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L472) *** ### createdChatId?[​](#createdchatid "Direct link to createdChatId?") > `optional` **createdChatId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/chat.ts:471](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L471) *** ### id[​](#id "Direct link to id") > **id**: `number` Defined in: [packages/sdk/src/types/generated/chat.ts:462](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L462) *** ### memberId[​](#memberid "Direct link to memberId") > **memberId**: `number` Defined in: [packages/sdk/src/types/generated/chat.ts:465](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L465) *** ### reason?[​](#reason "Direct link to reason?") > `optional` **reason**: `string` | `null` Defined in: [packages/sdk/src/types/generated/chat.ts:467](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L467) *** ### scheduledTime[​](#scheduledtime "Direct link to scheduledTime") > **scheduledTime**: `string` Defined in: [packages/sdk/src/types/generated/chat.ts:468](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L468) *** ### status[​](#status "Direct link to status") > **status**: `string` Defined in: [packages/sdk/src/types/generated/chat.ts:469](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L469) *** ### statusDetail?[​](#statusdetail "Direct link to statusDetail?") > `optional` **statusDetail**: `string` | `null` Defined in: [packages/sdk/src/types/generated/chat.ts:470](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L470) *** ### targetChannel?[​](#targetchannel "Direct link to targetChannel?") > `optional` **targetChannel**: `string` | `null` Defined in: [packages/sdk/src/types/generated/chat.ts:466](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L466) *** ### uuid[​](#uuid "Direct link to uuid") > **uuid**: `string` Defined in: [packages/sdk/src/types/generated/chat.ts:463](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L463) --- # Interface: SchedulePreviewRequest Defined in: [packages/sdk/src/types/event-types.ts:641](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L641) ## Properties[​](#properties "Direct link to Properties") ### count?[​](#count "Direct link to count?") > `optional` **count**: `number` Defined in: [packages/sdk/src/types/event-types.ts:643](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L643) *** ### cronString[​](#cronstring "Direct link to cronString") > **cronString**: `string` Defined in: [packages/sdk/src/types/event-types.ts:642](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L642) *** ### timezone?[​](#timezone "Direct link to timezone?") > `optional` **timezone**: `string` Defined in: [packages/sdk/src/types/event-types.ts:646](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L646) IANA timezone the cronString is interpreted in (default UTC) so the previewed run times match what the dispatcher will fire. --- # Interface: SchedulePreviewResponse Defined in: [packages/sdk/src/types/generated/routine.ts:108](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/routine.ts#L108) Response model for cron schedule preview. ## Properties[​](#properties "Direct link to Properties") ### nextRuns[​](#nextruns "Direct link to nextRuns") > **nextRuns**: `string`\[] Defined in: [packages/sdk/src/types/generated/routine.ts:109](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/routine.ts#L109) --- # Interface: SchemaField Defined in: [packages/sdk/src/types/generated/data.ts:157](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/data.ts#L157) Strongly-typed field definition for DataType schemas. ## Properties[​](#properties "Direct link to Properties") ### adminOnly?[​](#adminonly "Direct link to adminOnly?") > `optional` **adminOnly**: `boolean` Defined in: [packages/sdk/src/types/generated/data.ts:177](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/data.ts#L177) Whether only admins can see this field *** ### categories?[​](#categories "Direct link to categories?") > `optional` **categories**: `SchemaFieldCategoriesItem`\[] Defined in: [packages/sdk/src/types/generated/data.ts:187](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/data.ts#L187) Regulatory or content categories for audit and policy *** ### celFunction?[​](#celfunction "Direct link to celFunction?") > `optional` **celFunction**: `string` | `null` Defined in: [packages/sdk/src/types/generated/data.ts:181](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/data.ts#L181) CEL expression that computes this field's value. CONSTRAINT: Can ONLY reference regular fields (TEXT, NUMBER, DATE, etc.). Cannot reference other FUNCTION fields. Syntax: record.data.\. Example: 'record.data.score1 + record.data.score2' *** ### defaultValue?[​](#defaultvalue "Direct link to defaultValue?") > `optional` **defaultValue**: `unknown` Defined in: [packages/sdk/src/types/generated/data.ts:179](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/data.ts#L179) Default value for the field *** ### description?[​](#description "Direct link to description?") > `optional` **description**: `string` | `null` Defined in: [packages/sdk/src/types/generated/data.ts:163](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/data.ts#L163) Optional field description *** ### fieldType?[​](#fieldtype "Direct link to fieldType?") > `optional` **fieldType**: `"number"` | `"boolean"` | `"object"` | `"function"` | `"email"` | `"phone"` | `"date"` | `"array"` | `"enum"` | `"text"` | `"longtext"` | `"integer"` | `"datetime"` | `"time_of_day"` | `"us_zip_code"` Defined in: [packages/sdk/src/types/generated/data.ts:165](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/data.ts#L165) Field type (text, email, enum, etc.) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/generated/data.ts:161](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/data.ts#L161) Display name for the field *** ### options?[​](#options "Direct link to options?") > `optional` **options**: `EnumOption`\[] | `null` Defined in: [packages/sdk/src/types/generated/data.ts:171](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/data.ts#L171) Options for enum fields as {label, value} objects. *** ### order?[​](#order "Direct link to order?") > `optional` **order**: `number` | `null` Defined in: [packages/sdk/src/types/generated/data.ts:169](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/data.ts#L169) Deprecated: Display order is now determined by array position *** ### referencedTypeId?[​](#referencedtypeid "Direct link to referencedTypeId?") > `optional` **referencedTypeId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/data.ts:173](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/data.ts#L173) Referenced DataType ID for reference fields *** ### required?[​](#required "Direct link to required?") > `optional` **required**: `boolean` Defined in: [packages/sdk/src/types/generated/data.ts:167](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/data.ts#L167) Whether field is required *** ### sensitivity?[​](#sensitivity "Direct link to sensitivity?") > `optional` **sensitivity**: `SchemaFieldSensitivity` Defined in: [packages/sdk/src/types/generated/data.ts:185](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/data.ts#L185) Disclosure severity for audit and access policy *** ### shouldIndex?[​](#shouldindex "Direct link to shouldIndex?") > `optional` **shouldIndex**: `boolean` Defined in: [packages/sdk/src/types/generated/data.ts:175](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/data.ts#L175) Whether to index this field *** ### slug[​](#slug "Direct link to slug") > **slug**: `string` Defined in: [packages/sdk/src/types/generated/data.ts:159](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/data.ts#L159) Unique field identifier *** ### validateCel?[​](#validatecel "Direct link to validateCel?") > `optional` **validateCel**: `string` | `null` Defined in: [packages/sdk/src/types/generated/data.ts:183](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/data.ts#L183) CEL expression for cross-field validation. Context: 'value' (current field value), 'record.data.\' (other fields). Returns: true if valid, or a string error message if invalid. CONSTRAINT: Can only reference non-FUNCTION fields. Example: 'value >= record.data.min\_score' or 'value < record.data.min\_score ? "Must be >= " + string(record.data.min\_score) : true' --- # Interface: ScopesListResponse Defined in: [packages/sdk/src/api/oauth.ts:135](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/oauth.ts#L135) ## Properties[​](#properties "Direct link to Properties") ### categories[​](#categories "Direct link to categories") > **categories**: `string`\[] Defined in: [packages/sdk/src/api/oauth.ts:137](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/oauth.ts#L137) *** ### items[​](#items "Direct link to items") > **items**: [`ApiScope`](https://docs.gravityrail.com/sdk/interfaces/ApiScope.md)\[] Defined in: [packages/sdk/src/api/oauth.ts:136](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/oauth.ts#L136) --- # Interface: SendEmailVerificationRequest Defined in: [packages/sdk/src/types/account-types.ts:162](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L162) ## Properties[​](#properties "Direct link to Properties") ### email[​](#email "Direct link to email") > **email**: `string` Defined in: [packages/sdk/src/types/account-types.ts:163](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L163) *** ### organizationUuid?[​](#organizationuuid "Direct link to organizationUuid?") > `optional` **organizationUuid**: `string` Defined in: [packages/sdk/src/types/account-types.ts:164](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L164) --- # Interface: SendSMSAbilityConfig Defined in: [packages/sdk/src/types/ability-types.ts:234](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ability-types.ts#L234) Config for send\_sms ability ## Properties[​](#properties "Direct link to Properties") ### allowFreeformMessage?[​](#allowfreeformmessage "Direct link to allowFreeformMessage?") > `optional` **allowFreeformMessage**: `boolean` Defined in: [packages/sdk/src/types/ability-types.ts:236](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ability-types.ts#L236) If true, the agent can also compose its own messages (default: false) *** ### messages?[​](#messages "Direct link to messages?") > `optional` **messages**: [`SMSMessageDef`](https://docs.gravityrail.com/sdk/interfaces/SMSMessageDef.md)\[] Defined in: [packages/sdk/src/types/ability-types.ts:238](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ability-types.ts#L238) List of named messages the agent can send --- # Interface: SessionExchangeRequest Defined in: [packages/sdk/src/types/account-types.ts:144](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L144) ## Properties[​](#properties "Direct link to Properties") ### audience?[​](#audience "Direct link to audience?") > `optional` **audience**: `"gravityrail:org"` Defined in: [packages/sdk/src/types/account-types.ts:146](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L146) *** ### maxAgeSeconds?[​](#maxageseconds "Direct link to maxAgeSeconds?") > `optional` **maxAgeSeconds**: `number` Defined in: [packages/sdk/src/types/account-types.ts:147](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L147) *** ### organizationUuid[​](#organizationuuid "Direct link to organizationUuid") > **organizationUuid**: `string` Defined in: [packages/sdk/src/types/account-types.ts:145](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L145) --- # Interface: SessionExchangeResponse Defined in: [packages/sdk/src/types/account-types.ts:150](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L150) ## Properties[​](#properties "Direct link to Properties") ### audience[​](#audience "Direct link to audience") > **audience**: `"gravityrail:org"` Defined in: [packages/sdk/src/types/account-types.ts:156](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L156) *** ### expiresAt[​](#expiresat "Direct link to expiresAt") > **expiresAt**: `string` Defined in: [packages/sdk/src/types/account-types.ts:157](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L157) *** ### organizationUuid[​](#organizationuuid "Direct link to organizationUuid") > **organizationUuid**: `string` Defined in: [packages/sdk/src/types/account-types.ts:155](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L155) *** ### policyVersion[​](#policyversion "Direct link to policyVersion") > **policyVersion**: `number` Defined in: [packages/sdk/src/types/account-types.ts:159](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L159) *** ### principalScope[​](#principalscope "Direct link to principalScope") > **principalScope**: `"org"` Defined in: [packages/sdk/src/types/account-types.ts:153](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L153) *** ### principalUuid[​](#principaluuid "Direct link to principalUuid") > **principalUuid**: `string` Defined in: [packages/sdk/src/types/account-types.ts:154](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L154) *** ### sessionAssuranceLevel[​](#sessionassurancelevel "Direct link to sessionAssuranceLevel") > **sessionAssuranceLevel**: `number` Defined in: [packages/sdk/src/types/account-types.ts:158](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L158) *** ### sessionId[​](#sessionid "Direct link to sessionId") > **sessionId**: `string` Defined in: [packages/sdk/src/types/account-types.ts:152](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L152) *** ### token[​](#token "Direct link to token") > **token**: `string` Defined in: [packages/sdk/src/types/account-types.ts:151](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L151) --- # Interface: SessionTakeover Defined in: [packages/sdk/src/types/operator-types.ts:128](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/operator-types.ts#L128) Server -> Client: Another tab has taken over this session ## Properties[​](#properties "Direct link to Properties") ### type[​](#type "Direct link to type") > **type**: `"session_takeover"` Defined in: [packages/sdk/src/types/operator-types.ts:129](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/operator-types.ts#L129) --- # Interface: SetupStep Defined in: [packages/sdk/src/types/generated/notification.ts:61](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/notification.ts#L61) Individual setup step within a setup notice. ## Properties[​](#properties "Direct link to Properties") ### completed[​](#completed "Direct link to completed") > **completed**: `boolean` Defined in: [packages/sdk/src/types/generated/notification.ts:64](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/notification.ts#L64) *** ### id[​](#id "Direct link to id") > **id**: `string` Defined in: [packages/sdk/src/types/generated/notification.ts:62](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/notification.ts#L62) *** ### label[​](#label "Direct link to label") > **label**: `string` Defined in: [packages/sdk/src/types/generated/notification.ts:63](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/notification.ts#L63) --- # Interface: SetupTOTPRequest Defined in: [packages/sdk/src/types/account-types.ts:361](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L361) ## Properties[​](#properties "Direct link to Properties") ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/account-types.ts:362](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L362) --- # Interface: SetupWebAuthnRequest Defined in: [packages/sdk/src/types/account-types.ts:371](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L371) ## Properties[​](#properties "Direct link to Properties") ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/account-types.ts:372](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L372) --- # Interface: SharingGrantEntry Defined in: [packages/sdk/src/types/file-types.ts:156](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/file-types.ts#L156) ## Properties[​](#properties "Direct link to Properties") ### accessMode[​](#accessmode "Direct link to accessMode") > **accessMode**: `number` Defined in: [packages/sdk/src/types/file-types.ts:158](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/file-types.ts#L158) *** ### granteeMemberId[​](#granteememberid "Direct link to granteeMemberId") > **granteeMemberId**: `number` Defined in: [packages/sdk/src/types/file-types.ts:157](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/file-types.ts#L157) --- # Interface: SignupAccountResponse Defined in: [packages/sdk/src/types/generated/member.ts:646](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L646) Response model for account data in signup response. ## Properties[​](#properties "Direct link to Properties") ### createdAt[​](#createdat "Direct link to createdAt") > **createdAt**: `string` Defined in: [packages/sdk/src/types/generated/member.ts:653](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L653) *** ### email?[​](#email "Direct link to email?") > `optional` **email**: `string` | `null` Defined in: [packages/sdk/src/types/generated/member.ts:649](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L649) *** ### id[​](#id "Direct link to id") > **id**: `number` Defined in: [packages/sdk/src/types/generated/member.ts:647](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L647) *** ### locale?[​](#locale "Direct link to locale?") > `optional` **locale**: `string` | `null` Defined in: [packages/sdk/src/types/generated/member.ts:652](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L652) *** ### name?[​](#name "Direct link to name?") > `optional` **name**: `string` | `null` Defined in: [packages/sdk/src/types/generated/member.ts:651](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L651) *** ### phone?[​](#phone "Direct link to phone?") > `optional` **phone**: `string` | `null` Defined in: [packages/sdk/src/types/generated/member.ts:650](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L650) *** ### uuid[​](#uuid "Direct link to uuid") > **uuid**: `string` Defined in: [packages/sdk/src/types/generated/member.ts:648](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L648) --- # Interface: SignupMemberResponse Defined in: [packages/sdk/src/types/generated/member.ts:659](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L659) Response model for member data in signup response. ## Properties[​](#properties "Direct link to Properties") ### createdAt[​](#createdat "Direct link to createdAt") > **createdAt**: `string` Defined in: [packages/sdk/src/types/generated/member.ts:662](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L662) *** ### description?[​](#description "Direct link to description?") > `optional` **description**: `string` | `null` Defined in: [packages/sdk/src/types/generated/member.ts:664](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L664) *** ### email?[​](#email "Direct link to email?") > `optional` **email**: `string` | `null` Defined in: [packages/sdk/src/types/generated/member.ts:666](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L666) *** ### externalId?[​](#externalid "Direct link to externalId?") > `optional` **externalId**: `string` | `null` Defined in: [packages/sdk/src/types/generated/member.ts:667](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L667) *** ### id[​](#id "Direct link to id") > **id**: `number` Defined in: [packages/sdk/src/types/generated/member.ts:660](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L660) *** ### labels?[​](#labels "Direct link to labels?") > `optional` **labels**: `string`\[] Defined in: [packages/sdk/src/types/generated/member.ts:668](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L668) *** ### memberRoleId[​](#memberroleid "Direct link to memberRoleId") > **memberRoleId**: `number` Defined in: [packages/sdk/src/types/generated/member.ts:661](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L661) *** ### name?[​](#name "Direct link to name?") > `optional` **name**: `string` | `null` Defined in: [packages/sdk/src/types/generated/member.ts:663](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L663) *** ### phone?[​](#phone "Direct link to phone?") > `optional` **phone**: `string` | `null` Defined in: [packages/sdk/src/types/generated/member.ts:665](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L665) *** ### tosAccepted[​](#tosaccepted "Direct link to tosAccepted") > **tosAccepted**: `boolean` Defined in: [packages/sdk/src/types/generated/member.ts:669](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L669) --- # Interface: SiteContext Defined in: [packages/sdk/src/app-context.ts:11](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/app-context.ts#L11) Information about a site in the context ## Properties[​](#properties "Direct link to Properties") ### id[​](#id "Direct link to id") > **id**: `number` Defined in: [packages/sdk/src/app-context.ts:12](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/app-context.ts#L12) *** ### name?[​](#name "Direct link to name?") > `optional` **name**: `string` Defined in: [packages/sdk/src/app-context.ts:13](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/app-context.ts#L13) *** ### slug?[​](#slug "Direct link to slug?") > `optional` **slug**: `string` Defined in: [packages/sdk/src/app-context.ts:14](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/app-context.ts#L14) --- # Interface: SiteCountsResponse Defined in: [packages/sdk/src/types/generated/site.ts:169](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L169) ## Properties[​](#properties "Direct link to Properties") ### pages[​](#pages "Direct link to pages") > **pages**: `number` Defined in: [packages/sdk/src/types/generated/site.ts:170](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L170) --- # Interface: SiteDisableImpactResponse Defined in: [packages/sdk/src/types/generated/organization.ts:691](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L691) SiteMapping rows that will be dropped on disable. ## Properties[​](#properties "Direct link to Properties") ### siteCount[​](#sitecount "Direct link to siteCount") > **siteCount**: `number` Defined in: [packages/sdk/src/types/generated/organization.ts:692](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L692) *** ### siteDomains[​](#sitedomains "Direct link to siteDomains") > **siteDomains**: `string`\[] Defined in: [packages/sdk/src/types/generated/organization.ts:693](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L693) --- # Interface: SiteDomainConfigResponse Defined in: [packages/sdk/src/types/generated/organization.ts:734](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L734) Full picture of a SiteDomainConfig — DNS records + statuses. ## Properties[​](#properties "Direct link to Properties") ### createdAt[​](#createdat "Direct link to createdAt") > **createdAt**: `string` Defined in: [packages/sdk/src/types/generated/organization.ts:742](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L742) *** ### dnsRecords[​](#dnsrecords "Direct link to dnsRecords") > **dnsRecords**: `SiteDnsRecord`\[] Defined in: [packages/sdk/src/types/generated/organization.ts:744](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L744) *** ### domain[​](#domain "Direct link to domain") > **domain**: `string` Defined in: [packages/sdk/src/types/generated/organization.ts:737](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L737) *** ### lastCheckedAt?[​](#lastcheckedat "Direct link to lastCheckedAt?") > `optional` **lastCheckedAt**: `string` | `null` Defined in: [packages/sdk/src/types/generated/organization.ts:741](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L741) *** ### orgDomainUuid[​](#orgdomainuuid "Direct link to orgDomainUuid") > **orgDomainUuid**: `string` Defined in: [packages/sdk/src/types/generated/organization.ts:736](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L736) *** ### status[​](#status "Direct link to status") > **status**: `string` Defined in: [packages/sdk/src/types/generated/organization.ts:738](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L738) *** ### targetStatus[​](#targetstatus "Direct link to targetStatus") > **targetStatus**: `string` Defined in: [packages/sdk/src/types/generated/organization.ts:739](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L739) *** ### tlsStatus[​](#tlsstatus "Direct link to tlsStatus") > **tlsStatus**: `string` Defined in: [packages/sdk/src/types/generated/organization.ts:740](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L740) *** ### updatedAt[​](#updatedat "Direct link to updatedAt") > **updatedAt**: `string` Defined in: [packages/sdk/src/types/generated/organization.ts:743](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L743) *** ### uuid[​](#uuid "Direct link to uuid") > **uuid**: `string` Defined in: [packages/sdk/src/types/generated/organization.ts:735](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L735) --- # Interface: SiteExport Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:88](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L88) ## Properties[​](#properties "Direct link to Properties") ### content?[​](#content "Direct link to content?") > `optional` **content**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:94](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L94) *** ### defaultWorkflowUuid?[​](#defaultworkflowuuid "Direct link to defaultWorkflowUuid?") > `optional` **defaultWorkflowUuid**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:97](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L97) *** ### homePageUuid?[​](#homepageuuid "Direct link to homePageUuid?") > `optional` **homePageUuid**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:96](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L96) *** ### isPublic[​](#ispublic "Direct link to isPublic") > **isPublic**: `boolean` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:95](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L95) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:90](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L90) *** ### signupMemberRoleUuid?[​](#signupmemberroleuuid "Direct link to signupMemberRoleUuid?") > `optional` **signupMemberRoleUuid**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:98](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L98) *** ### slug[​](#slug "Direct link to slug") > **slug**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:91](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L91) *** ### tagLine?[​](#tagline "Direct link to tagLine?") > `optional` **tagLine**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:92](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L92) *** ### theme?[​](#theme "Direct link to theme?") > `optional` **theme**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:93](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L93) *** ### uuid[​](#uuid "Direct link to uuid") > **uuid**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:89](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L89) --- # Interface: SiteFormData Defined in: [packages/sdk/src/types/site-types.ts:123](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/site-types.ts#L123) ## Properties[​](#properties "Direct link to Properties") ### allowSignup?[​](#allowsignup "Direct link to allowSignup?") > `optional` **allowSignup**: `boolean` Defined in: [packages/sdk/src/types/site-types.ts:131](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/site-types.ts#L131) *** ### availableLocales?[​](#availablelocales "Direct link to availableLocales?") > `optional` **availableLocales**: `string`\[] Defined in: [packages/sdk/src/types/site-types.ts:145](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/site-types.ts#L145) *** ### content?[​](#content "Direct link to content?") > `optional` **content**: `string` Defined in: [packages/sdk/src/types/site-types.ts:133](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/site-types.ts#L133) *** ### crawl?[​](#crawl "Direct link to crawl?") > `optional` **crawl**: `boolean` Defined in: [packages/sdk/src/types/site-types.ts:138](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/site-types.ts#L138) *** ### crawlExcludedTags?[​](#crawlexcludedtags "Direct link to crawlExcludedTags?") > `optional` **crawlExcludedTags**: `string`\[] Defined in: [packages/sdk/src/types/site-types.ts:141](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/site-types.ts#L141) *** ### crawlLimit?[​](#crawllimit "Direct link to crawlLimit?") > `optional` **crawlLimit**: `number` | `null` Defined in: [packages/sdk/src/types/site-types.ts:140](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/site-types.ts#L140) *** ### crawlUrl?[​](#crawlurl "Direct link to crawlUrl?") > `optional` **crawlUrl**: `string` | `null` Defined in: [packages/sdk/src/types/site-types.ts:139](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/site-types.ts#L139) *** ### customDomain?[​](#customdomain "Direct link to customDomain?") > `optional` **customDomain**: `string` | `null` Defined in: [packages/sdk/src/types/site-types.ts:129](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/site-types.ts#L129) *** ### defaultWorkflowId?[​](#defaultworkflowid "Direct link to defaultWorkflowId?") > `optional` **defaultWorkflowId**: `number` | `null` Defined in: [packages/sdk/src/types/site-types.ts:136](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/site-types.ts#L136) *** ### googleAdwordsId?[​](#googleadwordsid "Direct link to googleAdwordsId?") > `optional` **googleAdwordsId**: `string` | `null` Defined in: [packages/sdk/src/types/site-types.ts:143](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/site-types.ts#L143) *** ### googleAnalyticsId?[​](#googleanalyticsid "Direct link to googleAnalyticsId?") > `optional` **googleAnalyticsId**: `string` | `null` Defined in: [packages/sdk/src/types/site-types.ts:142](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/site-types.ts#L142) *** ### homePageId?[​](#homepageid "Direct link to homePageId?") > `optional` **homePageId**: `number` | `null` Defined in: [packages/sdk/src/types/site-types.ts:137](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/site-types.ts#L137) *** ### isPublic?[​](#ispublic "Direct link to isPublic?") > `optional` **isPublic**: `boolean` Defined in: [packages/sdk/src/types/site-types.ts:135](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/site-types.ts#L135) *** ### isReseller?[​](#isreseller "Direct link to isReseller?") > `optional` **isReseller**: `boolean` Defined in: [packages/sdk/src/types/site-types.ts:134](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/site-types.ts#L134) *** ### metaDescription?[​](#metadescription "Direct link to metaDescription?") > `optional` **metaDescription**: `string` Defined in: [packages/sdk/src/types/site-types.ts:128](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/site-types.ts#L128) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/site-types.ts:124](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/site-types.ts#L124) *** ### primaryLocale?[​](#primarylocale "Direct link to primaryLocale?") > `optional` **primaryLocale**: `string` Defined in: [packages/sdk/src/types/site-types.ts:144](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/site-types.ts#L144) *** ### redirectUrl?[​](#redirecturl "Direct link to redirectUrl?") > `optional` **redirectUrl**: `string` | `null` Defined in: [packages/sdk/src/types/site-types.ts:130](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/site-types.ts#L130) *** ### signupMemberRoleId?[​](#signupmemberroleid "Direct link to signupMemberRoleId?") > `optional` **signupMemberRoleId**: `number` | `null` Defined in: [packages/sdk/src/types/site-types.ts:132](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/site-types.ts#L132) *** ### slug?[​](#slug "Direct link to slug?") > `optional` **slug**: `string` Defined in: [packages/sdk/src/types/site-types.ts:125](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/site-types.ts#L125) *** ### tagLine?[​](#tagline "Direct link to tagLine?") > `optional` **tagLine**: `string` Defined in: [packages/sdk/src/types/site-types.ts:127](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/site-types.ts#L127) *** ### theme?[​](#theme "Direct link to theme?") > `optional` **theme**: [`ThemeName`](https://docs.gravityrail.com/sdk/type-aliases/ThemeName.md) | `null` Defined in: [packages/sdk/src/types/site-types.ts:126](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/site-types.ts#L126) *** ### widgetOrigins?[​](#widgetorigins "Direct link to widgetOrigins?") > `optional` **widgetOrigins**: `string`\[] | `null` Defined in: [packages/sdk/src/types/site-types.ts:146](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/site-types.ts#L146) --- # Interface: SiteMappingFormData Defined in: [packages/sdk/src/types/workspace-types.ts:139](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/workspace-types.ts#L139) ## Properties[​](#properties "Direct link to Properties") ### externalDomain?[​](#externaldomain "Direct link to externalDomain?") > `optional` **externalDomain**: `string` Defined in: [packages/sdk/src/types/workspace-types.ts:142](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/workspace-types.ts#L142) *** ### siteUuid?[​](#siteuuid "Direct link to siteUuid?") > `optional` **siteUuid**: `string` Defined in: [packages/sdk/src/types/workspace-types.ts:140](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/workspace-types.ts#L140) *** ### workspaceId?[​](#workspaceid "Direct link to workspaceId?") > `optional` **workspaceId**: `number` Defined in: [packages/sdk/src/types/workspace-types.ts:141](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/workspace-types.ts#L141) --- # Interface: SiteSharingResponse Defined in: [packages/sdk/src/types/site-types.ts:200](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/site-types.ts#L200) ## Properties[​](#properties "Direct link to Properties") ### access[​](#access "Direct link to access") > **access**: [`AccessLevel`](https://docs.gravityrail.com/sdk/enumerations/AccessLevel.md) Defined in: [packages/sdk/src/types/site-types.ts:203](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/site-types.ts#L203) *** ### grants[​](#grants "Direct link to grants") > **grants**: [`AccessGrant`](https://docs.gravityrail.com/sdk/type-aliases/AccessGrant.md)\[] Defined in: [packages/sdk/src/types/site-types.ts:205](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/site-types.ts#L205) *** ### ownerId[​](#ownerid "Direct link to ownerId") > **ownerId**: `number` Defined in: [packages/sdk/src/types/site-types.ts:201](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/site-types.ts#L201) *** ### ownerName?[​](#ownername "Direct link to ownerName?") > `optional` **ownerName**: `string` | `null` Defined in: [packages/sdk/src/types/site-types.ts:202](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/site-types.ts#L202) *** ### roleAssociations[​](#roleassociations "Direct link to roleAssociations") > **roleAssociations**: [`FileRoleAssociationResponse`](https://docs.gravityrail.com/sdk/interfaces/FileRoleAssociationResponse.md)\[] Defined in: [packages/sdk/src/types/site-types.ts:206](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/site-types.ts#L206) *** ### shareable[​](#shareable "Direct link to shareable") > **shareable**: `boolean` Defined in: [packages/sdk/src/types/site-types.ts:204](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/site-types.ts#L204) --- # Interface: SiteSignupResponse Defined in: [packages/sdk/src/types/generated/site.ts:276](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L276) ## Properties[​](#properties "Direct link to Properties") ### memberId?[​](#memberid "Direct link to memberId?") > `optional` **memberId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/site.ts:279](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L279) *** ### message[​](#message "Direct link to message") > **message**: `string` Defined in: [packages/sdk/src/types/generated/site.ts:278](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L278) *** ### roleName?[​](#rolename "Direct link to roleName?") > `optional` **roleName**: `string` | `null` Defined in: [packages/sdk/src/types/generated/site.ts:280](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L280) *** ### status[​](#status "Direct link to status") > **status**: `SiteSignupResponseStatus` Defined in: [packages/sdk/src/types/generated/site.ts:277](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L277) --- # Interface: SiteSlugAvailability Defined in: [packages/sdk/src/types/site-types.ts:209](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/site-types.ts#L209) ## Properties[​](#properties "Direct link to Properties") ### result[​](#result "Direct link to result") > **result**: `boolean` Defined in: [packages/sdk/src/types/site-types.ts:210](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/site-types.ts#L210) *** ### suggestions?[​](#suggestions "Direct link to suggestions?") > `optional` **suggestions**: `string`\[] Defined in: [packages/sdk/src/types/site-types.ts:211](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/site-types.ts#L211) --- # Interface: SiteSource Defined in: [packages/sdk/src/types/site-types.ts:170](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/site-types.ts#L170) ## Properties[​](#properties "Direct link to Properties") ### hasUnpublishedChanges?[​](#hasunpublishedchanges "Direct link to hasUnpublishedChanges?") > `optional` **hasUnpublishedChanges**: `boolean` Defined in: [packages/sdk/src/types/site-types.ts:177](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/site-types.ts#L177) *** ### latestBuild?[​](#latestbuild "Direct link to latestBuild?") > `optional` **latestBuild**: [`SiteSourceBuild`](https://docs.gravityrail.com/sdk/interfaces/SiteSourceBuild.md) | `null` Defined in: [packages/sdk/src/types/site-types.ts:174](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/site-types.ts#L174) *** ### previewHtml?[​](#previewhtml "Direct link to previewHtml?") > `optional` **previewHtml**: `string` | `null` Defined in: [packages/sdk/src/types/site-types.ts:176](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/site-types.ts#L176) *** ### releases[​](#releases "Direct link to releases") > **releases**: [`SiteSourceRelease`](https://docs.gravityrail.com/sdk/interfaces/SiteSourceRelease.md)\[] Defined in: [packages/sdk/src/types/site-types.ts:175](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/site-types.ts#L175) *** ### siteId[​](#siteid "Direct link to siteId") > **siteId**: `number` Defined in: [packages/sdk/src/types/site-types.ts:171](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/site-types.ts#L171) *** ### sourceFolderId[​](#sourcefolderid "Direct link to sourceFolderId") > **sourceFolderId**: `number` | `null` Defined in: [packages/sdk/src/types/site-types.ts:172](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/site-types.ts#L172) *** ### sourceReleaseId[​](#sourcereleaseid "Direct link to sourceReleaseId") > **sourceReleaseId**: `number` | `null` Defined in: [packages/sdk/src/types/site-types.ts:173](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/site-types.ts#L173) *** ### updatedAt[​](#updatedat "Direct link to updatedAt") > **updatedAt**: `string` Defined in: [packages/sdk/src/types/site-types.ts:178](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/site-types.ts#L178) --- # Interface: SiteSourceBuild Defined in: [packages/sdk/src/types/site-types.ts:149](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/site-types.ts#L149) ## Properties[​](#properties "Direct link to Properties") ### createdAt[​](#createdat "Direct link to createdAt") > **createdAt**: `string` Defined in: [packages/sdk/src/types/site-types.ts:155](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/site-types.ts#L155) *** ### diagnostics[​](#diagnostics "Direct link to diagnostics") > **diagnostics**: `Record`<`string`, `unknown`> Defined in: [packages/sdk/src/types/site-types.ts:154](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/site-types.ts#L154) *** ### id[​](#id "Direct link to id") > **id**: `number` Defined in: [packages/sdk/src/types/site-types.ts:150](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/site-types.ts#L150) *** ### logs[​](#logs "Direct link to logs") > **logs**: `string` Defined in: [packages/sdk/src/types/site-types.ts:153](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/site-types.ts#L153) *** ### status[​](#status "Direct link to status") > **status**: `string` Defined in: [packages/sdk/src/types/site-types.ts:152](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/site-types.ts#L152) *** ### uuid[​](#uuid "Direct link to uuid") > **uuid**: `string` Defined in: [packages/sdk/src/types/site-types.ts:151](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/site-types.ts#L151) --- # Interface: SiteSourcePublishResponse Defined in: [packages/sdk/src/types/site-types.ts:181](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/site-types.ts#L181) ## Properties[​](#properties "Direct link to Properties") ### build[​](#build "Direct link to build") > **build**: [`SiteSourceBuild`](https://docs.gravityrail.com/sdk/interfaces/SiteSourceBuild.md) Defined in: [packages/sdk/src/types/site-types.ts:183](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/site-types.ts#L183) *** ### release?[​](#release "Direct link to release?") > `optional` **release**: [`SiteSourceRelease`](https://docs.gravityrail.com/sdk/interfaces/SiteSourceRelease.md) | `null` Defined in: [packages/sdk/src/types/site-types.ts:184](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/site-types.ts#L184) *** ### source[​](#source "Direct link to source") > **source**: [`SiteSource`](https://docs.gravityrail.com/sdk/interfaces/SiteSource.md) Defined in: [packages/sdk/src/types/site-types.ts:182](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/site-types.ts#L182) --- # Interface: SiteSourceRelease Defined in: [packages/sdk/src/types/site-types.ts:158](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/site-types.ts#L158) ## Properties[​](#properties "Direct link to Properties") ### buildId[​](#buildid "Direct link to buildId") > **buildId**: `number` Defined in: [packages/sdk/src/types/site-types.ts:166](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/site-types.ts#L166) *** ### createdAt[​](#createdat "Direct link to createdAt") > **createdAt**: `string` Defined in: [packages/sdk/src/types/site-types.ts:167](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/site-types.ts#L167) *** ### id[​](#id "Direct link to id") > **id**: `number` Defined in: [packages/sdk/src/types/site-types.ts:159](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/site-types.ts#L159) *** ### name?[​](#name "Direct link to name?") > `optional` **name**: `string` | `null` Defined in: [packages/sdk/src/types/site-types.ts:163](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/site-types.ts#L163) Optional version label; clients fall back to `Version {version}` when null. *** ### note?[​](#note "Direct link to note?") > `optional` **note**: `string` | `null` Defined in: [packages/sdk/src/types/site-types.ts:165](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/site-types.ts#L165) Optional free-text release note. *** ### uuid[​](#uuid "Direct link to uuid") > **uuid**: `string` Defined in: [packages/sdk/src/types/site-types.ts:160](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/site-types.ts#L160) *** ### version[​](#version "Direct link to version") > **version**: `number` Defined in: [packages/sdk/src/types/site-types.ts:161](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/site-types.ts#L161) --- # Interface: SiteSourceTemplateOption Defined in: [packages/sdk/src/types/site-types.ts:187](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/site-types.ts#L187) ## Properties[​](#properties "Direct link to Properties") ### description[​](#description "Direct link to description") > **description**: `string` Defined in: [packages/sdk/src/types/site-types.ts:190](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/site-types.ts#L190) *** ### label[​](#label "Direct link to label") > **label**: `string` Defined in: [packages/sdk/src/types/site-types.ts:189](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/site-types.ts#L189) *** ### value[​](#value "Direct link to value") > **value**: `string` Defined in: [packages/sdk/src/types/site-types.ts:188](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/site-types.ts#L188) --- # Interface: SiteSourceTemplates Defined in: [packages/sdk/src/types/site-types.ts:195](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/site-types.ts#L195) Starter templates the caller may seed; superuser-only templates are filtered out server-side so their names/copy never ship in the client bundle. ## Properties[​](#properties "Direct link to Properties") ### defaultTemplate[​](#defaulttemplate "Direct link to defaultTemplate") > **defaultTemplate**: `string` Defined in: [packages/sdk/src/types/site-types.ts:197](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/site-types.ts#L197) *** ### templates[​](#templates "Direct link to templates") > **templates**: [`SiteSourceTemplateOption`](https://docs.gravityrail.com/sdk/interfaces/SiteSourceTemplateOption.md)\[] Defined in: [packages/sdk/src/types/site-types.ts:196](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/site-types.ts#L196) --- # Interface: SiteVerificationResponse Defined in: [packages/sdk/src/types/generated/organization.ts:750](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L750) Result of running a "Verify DNS" pass. ## Properties[​](#properties "Direct link to Properties") ### config[​](#config "Direct link to config") > **config**: [`SiteDomainConfigResponse`](https://docs.gravityrail.com/sdk/interfaces/SiteDomainConfigResponse.md) Defined in: [packages/sdk/src/types/generated/organization.ts:752](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L752) *** ### status[​](#status "Direct link to status") > **status**: `string` Defined in: [packages/sdk/src/types/generated/organization.ts:751](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L751) --- # Interface: SkillsResponse Defined in: [packages/sdk/src/types/generated/chat.ts:502](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L502) Response model for the agent's loaded skills state. Sent as a state.SkillsResponse custom event to sync loaded skills to the client. Attributes: loadedSkills: Skills that are currently loaded (prompts injected into context) revealedSkills: Skills that are visible but not yet loaded ## Properties[​](#properties "Direct link to Properties") ### loadedSkills?[​](#loadedskills "Direct link to loadedSkills?") > `optional` **loadedSkills**: `string`\[] Defined in: [packages/sdk/src/types/generated/chat.ts:503](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L503) *** ### revealedSkills?[​](#revealedskills "Direct link to revealedSkills?") > `optional` **revealedSkills**: `string`\[] Defined in: [packages/sdk/src/types/generated/chat.ts:504](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L504) --- # Interface: SkillsState Defined in: [packages/sdk/src/types/chat-types.ts:71](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L71) ## Properties[​](#properties "Direct link to Properties") ### loaded\_skills[​](#loaded_skills "Direct link to loaded_skills") > **loaded\_skills**: `string`\[] Defined in: [packages/sdk/src/types/chat-types.ts:72](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L72) *** ### revealed\_skills[​](#revealed_skills "Direct link to revealed_skills") > **revealed\_skills**: `string`\[] Defined in: [packages/sdk/src/types/chat-types.ts:73](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L73) --- # Interface: SkippedWorkspace Defined in: [packages/sdk/src/types/generated/health\_dashboard.ts:71](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/health_dashboard.ts#L71) A workspace that was skipped during metrics collection. ## Properties[​](#properties "Direct link to Properties") ### reason[​](#reason "Direct link to reason") > **reason**: `string` Defined in: [packages/sdk/src/types/generated/health\_dashboard.ts:73](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/health_dashboard.ts#L73) *** ### uuid[​](#uuid "Direct link to uuid") > **uuid**: `string` Defined in: [packages/sdk/src/types/generated/health\_dashboard.ts:72](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/health_dashboard.ts#L72) --- # Interface: SlackAccount Defined in: [packages/sdk/src/types/slack-app-types.ts:60](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/slack-app-types.ts#L60) Slack account link for a specific app. Maps a workspace member to their Slack account. ## Properties[​](#properties "Direct link to Properties") ### connectedAt[​](#connectedat "Direct link to connectedAt") > **connectedAt**: `string` | `null` Defined in: [packages/sdk/src/types/slack-app-types.ts:69](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/slack-app-types.ts#L69) *** ### emailVerified[​](#emailverified "Direct link to emailVerified") > **emailVerified**: `boolean` Defined in: [packages/sdk/src/types/slack-app-types.ts:68](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/slack-app-types.ts#L68) *** ### id[​](#id "Direct link to id") > **id**: `number` Defined in: [packages/sdk/src/types/slack-app-types.ts:61](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/slack-app-types.ts#L61) *** ### lastUsedAt[​](#lastusedat "Direct link to lastUsedAt") > **lastUsedAt**: `string` | `null` Defined in: [packages/sdk/src/types/slack-app-types.ts:70](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/slack-app-types.ts#L70) *** ### memberEmail[​](#memberemail "Direct link to memberEmail") > **memberEmail**: `string` | `null` Defined in: [packages/sdk/src/types/slack-app-types.ts:64](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/slack-app-types.ts#L64) *** ### memberId[​](#memberid "Direct link to memberId") > **memberId**: `number` Defined in: [packages/sdk/src/types/slack-app-types.ts:62](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/slack-app-types.ts#L62) *** ### memberName[​](#membername "Direct link to memberName") > **memberName**: `string` | `null` Defined in: [packages/sdk/src/types/slack-app-types.ts:63](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/slack-app-types.ts#L63) *** ### slackEmail[​](#slackemail "Direct link to slackEmail") > **slackEmail**: `string` | `null` Defined in: [packages/sdk/src/types/slack-app-types.ts:67](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/slack-app-types.ts#L67) *** ### slackUserId[​](#slackuserid "Direct link to slackUserId") > **slackUserId**: `string` Defined in: [packages/sdk/src/types/slack-app-types.ts:65](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/slack-app-types.ts#L65) *** ### slackUsername[​](#slackusername "Direct link to slackUsername") > **slackUsername**: `string` | `null` Defined in: [packages/sdk/src/types/slack-app-types.ts:66](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/slack-app-types.ts#L66) --- # Interface: SlackAppInstallation Defined in: [packages/sdk/src/types/slack-app-types.ts:42](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/slack-app-types.ts#L42) A Slack app installation to a specific Slack workspace. Slack's OAuth returns workspace-specific tokens, so each workspace the app is installed to gets its own installation record with its own token. ## Properties[​](#properties "Direct link to Properties") ### active[​](#active "Direct link to active") > **active**: `boolean` Defined in: [packages/sdk/src/types/slack-app-types.ts:51](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/slack-app-types.ts#L51) Whether this installation is active *** ### createdAt[​](#createdat "Direct link to createdAt") > **createdAt**: `string` Defined in: [packages/sdk/src/types/slack-app-types.ts:52](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/slack-app-types.ts#L52) *** ### id[​](#id "Direct link to id") > **id**: `number` Defined in: [packages/sdk/src/types/slack-app-types.ts:43](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/slack-app-types.ts#L43) *** ### slackBotUserId[​](#slackbotuserid "Direct link to slackBotUserId") > **slackBotUserId**: `string` | `null` Defined in: [packages/sdk/src/types/slack-app-types.ts:49](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/slack-app-types.ts#L49) Bot's Slack user ID in this workspace *** ### slackTeamId[​](#slackteamid "Direct link to slackTeamId") > **slackTeamId**: `string` Defined in: [packages/sdk/src/types/slack-app-types.ts:45](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/slack-app-types.ts#L45) Slack workspace/team ID *** ### slackTeamName[​](#slackteamname "Direct link to slackTeamName") > **slackTeamName**: `string` | `null` Defined in: [packages/sdk/src/types/slack-app-types.ts:47](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/slack-app-types.ts#L47) Slack workspace/team name *** ### updatedAt[​](#updatedat "Direct link to updatedAt") > **updatedAt**: `string` Defined in: [packages/sdk/src/types/slack-app-types.ts:53](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/slack-app-types.ts#L53) --- # Interface: SlackSlashCommandConfigResponse Defined in: [packages/sdk/src/types/generated/app\_connection.ts:402](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L402) Response model for a Slack slash command configuration. ## Properties[​](#properties "Direct link to Properties") ### command[​](#command "Direct link to command") > **command**: `string` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:403](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L403) *** ### description[​](#description "Direct link to description") > **description**: `string` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:404](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L404) *** ### workflowId[​](#workflowid "Direct link to workflowId") > **workflowId**: `number` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:405](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L405) --- # Interface: SlackThread Defined in: [packages/sdk/src/types/slack-app-types.ts:146](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/slack-app-types.ts#L146) Slack thread linked to a Gravity Rail chat. ## Properties[​](#properties "Direct link to Properties") ### chatId[​](#chatid "Direct link to chatId") > **chatId**: `number` Defined in: [packages/sdk/src/types/slack-app-types.ts:148](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/slack-app-types.ts#L148) *** ### chatTitle[​](#chattitle "Direct link to chatTitle") > **chatTitle**: `string` | `null` Defined in: [packages/sdk/src/types/slack-app-types.ts:150](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/slack-app-types.ts#L150) Title of the linked chat *** ### createdAt[​](#createdat "Direct link to createdAt") > **createdAt**: `string` Defined in: [packages/sdk/src/types/slack-app-types.ts:159](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/slack-app-types.ts#L159) *** ### id[​](#id "Direct link to id") > **id**: `number` Defined in: [packages/sdk/src/types/slack-app-types.ts:147](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/slack-app-types.ts#L147) *** ### isDm[​](#isdm "Direct link to isDm") > **isDm**: `boolean` Defined in: [packages/sdk/src/types/slack-app-types.ts:158](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/slack-app-types.ts#L158) *** ### slackAppId[​](#slackappid "Direct link to slackAppId") > **slackAppId**: `number` Defined in: [packages/sdk/src/types/slack-app-types.ts:151](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/slack-app-types.ts#L151) *** ### slackChannelId[​](#slackchannelid "Direct link to slackChannelId") > **slackChannelId**: `string` Defined in: [packages/sdk/src/types/slack-app-types.ts:152](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/slack-app-types.ts#L152) *** ### slackThreadTs[​](#slackthreadts "Direct link to slackThreadTs") > **slackThreadTs**: `string` | `null` Defined in: [packages/sdk/src/types/slack-app-types.ts:153](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/slack-app-types.ts#L153) *** ### slackUserId[​](#slackuserid "Direct link to slackUserId") > **slackUserId**: `string` | `null` Defined in: [packages/sdk/src/types/slack-app-types.ts:154](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/slack-app-types.ts#L154) *** ### workflowId[​](#workflowid "Direct link to workflowId") > **workflowId**: `number` | `null` Defined in: [packages/sdk/src/types/slack-app-types.ts:155](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/slack-app-types.ts#L155) *** ### workflowName[​](#workflowname "Direct link to workflowName") > **workflowName**: `string` | `null` Defined in: [packages/sdk/src/types/slack-app-types.ts:157](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/slack-app-types.ts#L157) Name of the workflow handling this thread --- # Interface: SlashCommandConfigResponse Defined in: [packages/sdk/src/types/generated/app\_connection.ts:411](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L411) Response model for a Discord slash command configuration. ## Properties[​](#properties "Direct link to Properties") ### description[​](#description "Direct link to description") > **description**: `string` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:413](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L413) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:412](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L412) *** ### workflowId[​](#workflowid "Direct link to workflowId") > **workflowId**: `number` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:414](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L414) --- # Interface: SMSCommunicationDetailsResponse Defined in: [packages/sdk/src/types/generated/usage.ts:184](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/usage.ts#L184) Detailed SMS communication data. ## Properties[​](#properties "Direct link to Properties") ### dailyRows[​](#dailyrows "Direct link to dailyRows") > **dailyRows**: [`DailySMSRowResponse`](https://docs.gravityrail.com/sdk/interfaces/DailySMSRowResponse.md)\[] Defined in: [packages/sdk/src/types/generated/usage.ts:188](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/usage.ts#L188) *** ### phoneNumbers[​](#phonenumbers "Direct link to phoneNumbers") > **phoneNumbers**: [`SMSPhoneNumberUsageResponse`](https://docs.gravityrail.com/sdk/interfaces/SMSPhoneNumberUsageResponse.md)\[] Defined in: [packages/sdk/src/types/generated/usage.ts:187](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/usage.ts#L187) *** ### totalCharacters[​](#totalcharacters "Direct link to totalCharacters") > **totalCharacters**: `number` Defined in: [packages/sdk/src/types/generated/usage.ts:185](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/usage.ts#L185) *** ### totalSegments?[​](#totalsegments "Direct link to totalSegments?") > `optional` **totalSegments**: `number` Defined in: [packages/sdk/src/types/generated/usage.ts:186](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/usage.ts#L186) --- # Interface: SMSLoginResponse Defined in: [packages/sdk/src/types/generated/account.ts:338](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L338) ## Properties[​](#properties "Direct link to Properties") ### message?[​](#message "Direct link to message?") > `optional` **message**: `string` | `null` Defined in: [packages/sdk/src/types/generated/account.ts:340](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L340) *** ### success[​](#success "Direct link to success") > **success**: `boolean` Defined in: [packages/sdk/src/types/generated/account.ts:339](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L339) --- # Interface: SMSMessage Defined in: [packages/sdk/src/types/generated/communication.ts:419](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L419) ## Properties[​](#properties "Direct link to Properties") ### channel?[​](#channel "Direct link to channel?") > `optional` **channel**: `string` Defined in: [packages/sdk/src/types/generated/communication.ts:436](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L436) *** ### chatId?[​](#chatid "Direct link to chatId?") > `optional` **chatId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/communication.ts:430](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L430) *** ### content[​](#content "Direct link to content") > **content**: `string` Defined in: [packages/sdk/src/types/generated/communication.ts:427](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L427) *** ### deliveryErrorCode?[​](#deliveryerrorcode "Direct link to deliveryErrorCode?") > `optional` **deliveryErrorCode**: `string` | `null` Defined in: [packages/sdk/src/types/generated/communication.ts:434](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L434) *** ### deliveryStatus?[​](#deliverystatus "Direct link to deliveryStatus?") > `optional` **deliveryStatus**: `string` | `null` Defined in: [packages/sdk/src/types/generated/communication.ts:433](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L433) *** ### deliveryUpdatedAt?[​](#deliveryupdatedat "Direct link to deliveryUpdatedAt?") > `optional` **deliveryUpdatedAt**: `string` | `null` Defined in: [packages/sdk/src/types/generated/communication.ts:435](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L435) *** ### fromCity?[​](#fromcity "Direct link to fromCity?") > `optional` **fromCity**: `string` | `null` Defined in: [packages/sdk/src/types/generated/communication.ts:424](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L424) *** ### fromCountry?[​](#fromcountry "Direct link to fromCountry?") > `optional` **fromCountry**: `string` | `null` Defined in: [packages/sdk/src/types/generated/communication.ts:425](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L425) *** ### fromNumber[​](#fromnumber "Direct link to fromNumber") > **fromNumber**: `string` Defined in: [packages/sdk/src/types/generated/communication.ts:423](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L423) *** ### id[​](#id "Direct link to id") > **id**: `number` Defined in: [packages/sdk/src/types/generated/communication.ts:420](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L420) *** ### inbound[​](#inbound "Direct link to inbound") > **inbound**: `boolean` Defined in: [packages/sdk/src/types/generated/communication.ts:426](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L426) *** ### messageId?[​](#messageid "Direct link to messageId?") > `optional` **messageId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/communication.ts:431](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L431) *** ### messageUuid?[​](#messageuuid "Direct link to messageUuid?") > `optional` **messageUuid**: `string` | `null` Defined in: [packages/sdk/src/types/generated/communication.ts:432](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L432) *** ### phoneNumberId[​](#phonenumberid "Direct link to phoneNumberId") > **phoneNumberId**: `number` Defined in: [packages/sdk/src/types/generated/communication.ts:421](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L421) *** ### raw?[​](#raw "Direct link to raw?") > `optional` **raw**: `string` | `null` Defined in: [packages/sdk/src/types/generated/communication.ts:428](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L428) *** ### receivedAt[​](#receivedat "Direct link to receivedAt") > **receivedAt**: `string` Defined in: [packages/sdk/src/types/generated/communication.ts:429](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L429) *** ### toNumber[​](#tonumber "Direct link to toNumber") > **toNumber**: `string` Defined in: [packages/sdk/src/types/generated/communication.ts:422](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L422) --- # Interface: SMSMessageDef Defined in: [packages/sdk/src/types/ability-types.ts:226](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ability-types.ts#L226) A single named SMS message in the ability config ## Properties[​](#properties "Direct link to Properties") ### messageTemplate[​](#messagetemplate "Direct link to messageTemplate") > **messageTemplate**: `string` Defined in: [packages/sdk/src/types/ability-types.ts:230](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ability-types.ts#L230) Jinja2 template for the message body *** ### title[​](#title "Direct link to title") > **title**: `string` Defined in: [packages/sdk/src/types/ability-types.ts:228](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ability-types.ts#L228) AI-readable title like "Customer Docs Link" --- # Interface: SMSMessageUsageResponse Defined in: [packages/sdk/src/types/generated/usage.ts:194](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/usage.ts#L194) SMS message usage response. ## Properties[​](#properties "Direct link to Properties") ### inbound[​](#inbound "Direct link to inbound") > **inbound**: `number` Defined in: [packages/sdk/src/types/generated/usage.ts:196](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/usage.ts#L196) *** ### outbound[​](#outbound "Direct link to outbound") > **outbound**: `number` Defined in: [packages/sdk/src/types/generated/usage.ts:197](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/usage.ts#L197) *** ### total[​](#total "Direct link to total") > **total**: `number` Defined in: [packages/sdk/src/types/generated/usage.ts:195](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/usage.ts#L195) *** ### totalSegments?[​](#totalsegments "Direct link to totalSegments?") > `optional` **totalSegments**: `number` Defined in: [packages/sdk/src/types/generated/usage.ts:198](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/usage.ts#L198) --- # Interface: SMSPhoneNumberUsageResponse Defined in: [packages/sdk/src/types/generated/usage.ts:204](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/usage.ts#L204) SMS usage details for a phone number. ## Properties[​](#properties "Direct link to Properties") ### inbound[​](#inbound "Direct link to inbound") > **inbound**: `number` Defined in: [packages/sdk/src/types/generated/usage.ts:208](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/usage.ts#L208) *** ### outbound[​](#outbound "Direct link to outbound") > **outbound**: `number` Defined in: [packages/sdk/src/types/generated/usage.ts:209](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/usage.ts#L209) *** ### phoneName[​](#phonename "Direct link to phoneName") > **phoneName**: `string` | `null` Defined in: [packages/sdk/src/types/generated/usage.ts:207](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/usage.ts#L207) *** ### phoneNumber[​](#phonenumber "Direct link to phoneNumber") > **phoneNumber**: `string` Defined in: [packages/sdk/src/types/generated/usage.ts:206](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/usage.ts#L206) *** ### phoneNumberId[​](#phonenumberid "Direct link to phoneNumberId") > **phoneNumberId**: `number` Defined in: [packages/sdk/src/types/generated/usage.ts:205](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/usage.ts#L205) *** ### totalChars[​](#totalchars "Direct link to totalChars") > **totalChars**: `number` Defined in: [packages/sdk/src/types/generated/usage.ts:210](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/usage.ts#L210) *** ### totalSegments?[​](#totalsegments "Direct link to totalSegments?") > `optional` **totalSegments**: `number` Defined in: [packages/sdk/src/types/generated/usage.ts:211](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/usage.ts#L211) --- # Interface: SmsSendActionParams Defined in: [packages/sdk/src/types/event-types.ts:360](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L360) ## Properties[​](#properties "Direct link to Properties") ### initialUserMessage?[​](#initialusermessage "Direct link to initialUserMessage?") > `optional` **initialUserMessage**: `string` Defined in: [packages/sdk/src/types/event-types.ts:364](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L364) *** ### messageTemplate?[​](#messagetemplate "Direct link to messageTemplate?") > `optional` **messageTemplate**: `string` Defined in: [packages/sdk/src/types/event-types.ts:362](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L362) *** ### phoneNumberUUID[​](#phonenumberuuid "Direct link to phoneNumberUUID") > **phoneNumberUUID**: `string` Defined in: [packages/sdk/src/types/event-types.ts:361](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L361) *** ### workflowUUID?[​](#workflowuuid "Direct link to workflowUUID?") > `optional` **workflowUUID**: `string` Defined in: [packages/sdk/src/types/event-types.ts:363](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L363) --- # Interface: SMSUsageReport Defined in: [packages/sdk/src/types/generated/reports.ts:125](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/reports.ts#L125) Complete SMS usage report for a workspace. ## Properties[​](#properties "Direct link to Properties") ### reportPeriodEnd[​](#reportperiodend "Direct link to reportPeriodEnd") > **reportPeriodEnd**: `string` Defined in: [packages/sdk/src/types/generated/reports.ts:130](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/reports.ts#L130) *** ### reportPeriodStart[​](#reportperiodstart "Direct link to reportPeriodStart") > **reportPeriodStart**: `string` Defined in: [packages/sdk/src/types/generated/reports.ts:129](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/reports.ts#L129) *** ### rows[​](#rows "Direct link to rows") > **rows**: [`SMSUsageRow`](https://docs.gravityrail.com/sdk/interfaces/SMSUsageRow.md)\[] Defined in: [packages/sdk/src/types/generated/reports.ts:138](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/reports.ts#L138) *** ### totalCharacters[​](#totalcharacters "Direct link to totalCharacters") > **totalCharacters**: `number` Defined in: [packages/sdk/src/types/generated/reports.ts:134](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/reports.ts#L134) *** ### totalInbound[​](#totalinbound "Direct link to totalInbound") > **totalInbound**: `number` Defined in: [packages/sdk/src/types/generated/reports.ts:132](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/reports.ts#L132) *** ### totalInboundSegments?[​](#totalinboundsegments "Direct link to totalInboundSegments?") > `optional` **totalInboundSegments**: `number` Defined in: [packages/sdk/src/types/generated/reports.ts:136](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/reports.ts#L136) *** ### totalMessages[​](#totalmessages "Direct link to totalMessages") > **totalMessages**: `number` Defined in: [packages/sdk/src/types/generated/reports.ts:131](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/reports.ts#L131) *** ### totalOutbound[​](#totaloutbound "Direct link to totalOutbound") > **totalOutbound**: `number` Defined in: [packages/sdk/src/types/generated/reports.ts:133](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/reports.ts#L133) *** ### totalOutboundSegments?[​](#totaloutboundsegments "Direct link to totalOutboundSegments?") > `optional` **totalOutboundSegments**: `number` Defined in: [packages/sdk/src/types/generated/reports.ts:137](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/reports.ts#L137) *** ### totalSegments?[​](#totalsegments "Direct link to totalSegments?") > `optional` **totalSegments**: `number` Defined in: [packages/sdk/src/types/generated/reports.ts:135](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/reports.ts#L135) *** ### workspaceId[​](#workspaceid "Direct link to workspaceId") > **workspaceId**: `number` Defined in: [packages/sdk/src/types/generated/reports.ts:126](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/reports.ts#L126) *** ### workspaceName[​](#workspacename "Direct link to workspaceName") > **workspaceName**: `string` Defined in: [packages/sdk/src/types/generated/reports.ts:128](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/reports.ts#L128) *** ### workspaceUuid[​](#workspaceuuid "Direct link to workspaceUuid") > **workspaceUuid**: `string` Defined in: [packages/sdk/src/types/generated/reports.ts:127](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/reports.ts#L127) --- # Interface: SMSUsageReportParams Defined in: [packages/sdk/src/api/reports.ts:39](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/reports.ts#L39) ## Properties[​](#properties "Direct link to Properties") ### end\_date?[​](#end_date "Direct link to end_date?") > `optional` **end\_date**: `string` Defined in: [packages/sdk/src/api/reports.ts:41](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/reports.ts#L41) *** ### start\_date?[​](#start_date "Direct link to start_date?") > `optional` **start\_date**: `string` Defined in: [packages/sdk/src/api/reports.ts:40](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/reports.ts#L40) --- # Interface: SMSUsageRow Defined in: [packages/sdk/src/types/generated/reports.ts:144](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/reports.ts#L144) SMS usage data for a specific phone number and date combination. ## Properties[​](#properties "Direct link to Properties") ### date[​](#date "Direct link to date") > **date**: `string` Defined in: [packages/sdk/src/types/generated/reports.ts:145](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/reports.ts#L145) *** ### inbound[​](#inbound "Direct link to inbound") > **inbound**: `number` Defined in: [packages/sdk/src/types/generated/reports.ts:149](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/reports.ts#L149) *** ### outbound[​](#outbound "Direct link to outbound") > **outbound**: `number` Defined in: [packages/sdk/src/types/generated/reports.ts:150](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/reports.ts#L150) *** ### phoneName[​](#phonename "Direct link to phoneName") > **phoneName**: `string` | `null` Defined in: [packages/sdk/src/types/generated/reports.ts:148](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/reports.ts#L148) *** ### phoneNumber[​](#phonenumber "Direct link to phoneNumber") > **phoneNumber**: `string` Defined in: [packages/sdk/src/types/generated/reports.ts:147](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/reports.ts#L147) *** ### phoneNumberId[​](#phonenumberid "Direct link to phoneNumberId") > **phoneNumberId**: `number` Defined in: [packages/sdk/src/types/generated/reports.ts:146](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/reports.ts#L146) *** ### totalChars[​](#totalchars "Direct link to totalChars") > **totalChars**: `number` Defined in: [packages/sdk/src/types/generated/reports.ts:151](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/reports.ts#L151) *** ### totalSegments?[​](#totalsegments "Direct link to totalSegments?") > `optional` **totalSegments**: `number` Defined in: [packages/sdk/src/types/generated/reports.ts:152](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/reports.ts#L152) --- # Interface: SpamScore Defined in: [packages/sdk/src/types/communication-types.ts:182](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/communication-types.ts#L182) ## Properties[​](#properties "Direct link to Properties") ### actionTaken[​](#actiontaken "Direct link to actionTaken") > **actionTaken**: `"accepted"` | `"quarantined"` | `"rejected"` Defined in: [packages/sdk/src/types/communication-types.ts:192](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/communication-types.ts#L192) *** ### attachmentScore[​](#attachmentscore "Direct link to attachmentScore") > **attachmentScore**: `number` Defined in: [packages/sdk/src/types/communication-types.ts:191](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/communication-types.ts#L191) *** ### contentScore[​](#contentscore "Direct link to contentScore") > **contentScore**: `number` Defined in: [packages/sdk/src/types/communication-types.ts:188](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/communication-types.ts#L188) *** ### createdAt[​](#createdat "Direct link to createdAt") > **createdAt**: `string` Defined in: [packages/sdk/src/types/communication-types.ts:197](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/communication-types.ts#L197) *** ### dnsblScore[​](#dnsblscore "Direct link to dnsblScore") > **dnsblScore**: `number` Defined in: [packages/sdk/src/types/communication-types.ts:187](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/communication-types.ts#L187) *** ### emailId[​](#emailid "Direct link to emailId") > **emailId**: `number` Defined in: [packages/sdk/src/types/communication-types.ts:185](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/communication-types.ts#L185) *** ### factorDetails?[​](#factordetails "Direct link to factorDetails?") > `optional` **factorDetails**: `Record`<`string`, `any`> Defined in: [packages/sdk/src/types/communication-types.ts:196](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/communication-types.ts#L196) *** ### id[​](#id "Direct link to id") > **id**: `number` Defined in: [packages/sdk/src/types/communication-types.ts:183](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/communication-types.ts#L183) *** ### phishingScore[​](#phishingscore "Direct link to phishingScore") > **phishingScore**: `number` Defined in: [packages/sdk/src/types/communication-types.ts:190](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/communication-types.ts#L190) *** ### releasedAt?[​](#releasedat "Direct link to releasedAt?") > `optional` **releasedAt**: `string` Defined in: [packages/sdk/src/types/communication-types.ts:194](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/communication-types.ts#L194) *** ### releasedByAccountUuid?[​](#releasedbyaccountuuid "Direct link to releasedByAccountUuid?") > `optional` **releasedByAccountUuid**: `string` Defined in: [packages/sdk/src/types/communication-types.ts:193](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/communication-types.ts#L193) *** ### releaseReason?[​](#releasereason "Direct link to releaseReason?") > `optional` **releaseReason**: `string` Defined in: [packages/sdk/src/types/communication-types.ts:195](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/communication-types.ts#L195) *** ### reputationScore[​](#reputationscore "Direct link to reputationScore") > **reputationScore**: `number` Defined in: [packages/sdk/src/types/communication-types.ts:189](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/communication-types.ts#L189) *** ### totalScore[​](#totalscore "Direct link to totalScore") > **totalScore**: `number` Defined in: [packages/sdk/src/types/communication-types.ts:186](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/communication-types.ts#L186) *** ### uuid[​](#uuid "Direct link to uuid") > **uuid**: `string` Defined in: [packages/sdk/src/types/communication-types.ts:184](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/communication-types.ts#L184) --- # Interface: SSOConfig Defined in: [packages/sdk/src/types/generated/organization.ts:388](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L388) SSO configuration in organization responses (provider-agnostic). ## Properties[​](#properties "Direct link to Properties") ### config?[​](#config "Direct link to config?") > `optional` **config**: [`SSOConfigData`](https://docs.gravityrail.com/sdk/interfaces/SSOConfigData.md) | `null` Defined in: [packages/sdk/src/types/generated/organization.ts:392](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L392) *** ### domain?[​](#domain "Direct link to domain?") > `optional` **domain**: `string` | `null` Defined in: [packages/sdk/src/types/generated/organization.ts:390](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L390) *** ### enabledAt?[​](#enabledat "Direct link to enabledAt?") > `optional` **enabledAt**: `string` | `null` Defined in: [packages/sdk/src/types/generated/organization.ts:391](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L391) *** ### provider?[​](#provider "Direct link to provider?") > `optional` **provider**: `string` | `null` Defined in: [packages/sdk/src/types/generated/organization.ts:389](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L389) --- # Interface: SSOConfigData Defined in: [packages/sdk/src/types/generated/organization.ts:641](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L641) Typed SSO configuration data stored in sso\_config JSONB column. This model defines the structure for provider-specific SSO settings that don't need database indexing. SECURITY NOTE: SSO can NEVER grant superuser status. The maximum role that can be auto-provisioned via SSO is org\_owner. Superuser accounts must be created directly in the database. SECURITY NOTE: This model uses extra="ignore" to ensure any additional fields stored in the JSONB (such as secrets or PII) are never exposed in API responses. OIDC client credentials are stored in environment variables (SYSTEM\_CONFIG), NOT in the database. If per-org OIDC credentials are needed in the future, they must be stored encrypted (like OauthCredential) or in AWS Secrets Manager. ## Properties[​](#properties "Direct link to Properties") ### autoProvision?[​](#autoprovision "Direct link to autoProvision?") > `optional` **autoProvision**: `boolean` Defined in: [packages/sdk/src/types/generated/organization.ts:643](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L643) *** ### providerType?[​](#providertype "Direct link to providerType?") > `optional` **providerType**: `string` | `null` Defined in: [packages/sdk/src/types/generated/organization.ts:642](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L642) *** ### roleMapping?[​](#rolemapping "Direct link to roleMapping?") > `optional` **roleMapping**: `SSOConfigDataRoleMapping` Defined in: [packages/sdk/src/types/generated/organization.ts:644](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L644) --- # Interface: StartTestChatRunRequest Defined in: [packages/sdk/src/types/qualification-types.ts:128](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/qualification-types.ts#L128) Start a test chat run on a workflow. With `scenarioId`: the scenario's persona/goal/channel/data act as defaults (overridable). The run is eligible for grading afterwards. Without `scenarioId`: an ad-hoc run. `personaId` is required; the run has no scenario linkage and cannot be evaluated. ## Properties[​](#properties "Direct link to Properties") ### assistantChatModelConfig?[​](#assistantchatmodelconfig "Direct link to assistantChatModelConfig?") > `optional` **assistantChatModelConfig**: `Record`<`string`, `unknown`> Defined in: [packages/sdk/src/types/qualification-types.ts:138](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/qualification-types.ts#L138) *** ### assistantChatModelId?[​](#assistantchatmodelid "Direct link to assistantChatModelId?") > `optional` **assistantChatModelId**: `string` Defined in: [packages/sdk/src/types/qualification-types.ts:137](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/qualification-types.ts#L137) *** ### assistantRealtimeModelConfig?[​](#assistantrealtimemodelconfig "Direct link to assistantRealtimeModelConfig?") > `optional` **assistantRealtimeModelConfig**: `Record`<`string`, `unknown`> Defined in: [packages/sdk/src/types/qualification-types.ts:140](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/qualification-types.ts#L140) *** ### assistantRealtimeModelId?[​](#assistantrealtimemodelid "Direct link to assistantRealtimeModelId?") > `optional` **assistantRealtimeModelId**: `string` Defined in: [packages/sdk/src/types/qualification-types.ts:139](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/qualification-types.ts#L139) *** ### channel?[​](#channel "Direct link to channel?") > `optional` **channel**: `string` Defined in: [packages/sdk/src/types/qualification-types.ts:134](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/qualification-types.ts#L134) *** ### dataRecords?[​](#datarecords "Direct link to dataRecords?") > `optional` **dataRecords**: `Record`<`string`, [`ScenarioDataRecord`](https://docs.gravityrail.com/sdk/interfaces/ScenarioDataRecord.md)> Defined in: [packages/sdk/src/types/qualification-types.ts:135](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/qualification-types.ts#L135) *** ### driver?[​](#driver "Direct link to driver?") > `optional` **driver**: [`DriverMode`](https://docs.gravityrail.com/sdk/enumerations/DriverMode.md) Defined in: [packages/sdk/src/types/qualification-types.ts:136](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/qualification-types.ts#L136) *** ### goal?[​](#goal "Direct link to goal?") > `optional` **goal**: `string` Defined in: [packages/sdk/src/types/qualification-types.ts:133](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/qualification-types.ts#L133) *** ### personaId?[​](#personaid "Direct link to personaId?") > `optional` **personaId**: `number` Defined in: [packages/sdk/src/types/qualification-types.ts:130](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/qualification-types.ts#L130) *** ### scenarioId?[​](#scenarioid "Direct link to scenarioId?") > `optional` **scenarioId**: `number` Defined in: [packages/sdk/src/types/qualification-types.ts:129](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/qualification-types.ts#L129) *** ### testMemberId?[​](#testmemberid "Direct link to testMemberId?") > `optional` **testMemberId**: `number` Defined in: [packages/sdk/src/types/qualification-types.ts:132](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/qualification-types.ts#L132) Reuse an existing test member instead of minting one from a persona. --- # Interface: StartTestChatRunResponse Defined in: [packages/sdk/src/types/generated/qualification.ts:218](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/qualification.ts#L218) Returned when starting a test chat run. Contains the run plus the chat/test-member handles the UI needs to subscribe and drive. ## Properties[​](#properties "Direct link to Properties") ### driver[​](#driver "Direct link to driver") > **driver**: `string` Defined in: [packages/sdk/src/types/generated/qualification.ts:221](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/qualification.ts#L221) *** ### run[​](#run "Direct link to run") > **run**: [`TestChatRunResponse`](https://docs.gravityrail.com/sdk/interfaces/TestChatRunResponse.md) Defined in: [packages/sdk/src/types/generated/qualification.ts:219](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/qualification.ts#L219) *** ### testMemberId[​](#testmemberid "Direct link to testMemberId") > **testMemberId**: `number` Defined in: [packages/sdk/src/types/generated/qualification.ts:220](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/qualification.ts#L220) --- # Interface: StatisticsSummary Defined in: [packages/sdk/src/types/stats-types.ts:41](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/stats-types.ts#L41) ## Properties[​](#properties "Direct link to Properties") ### active[​](#active "Direct link to active") > **active**: `number` Defined in: [packages/sdk/src/types/stats-types.ts:43](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/stats-types.ts#L43) *** ### growth[​](#growth "Direct link to growth") > **growth**: `number` Defined in: [packages/sdk/src/types/stats-types.ts:45](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/stats-types.ts#L45) *** ### growthPercentage[​](#growthpercentage "Direct link to growthPercentage") > **growthPercentage**: `number` Defined in: [packages/sdk/src/types/stats-types.ts:46](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/stats-types.ts#L46) *** ### inactive[​](#inactive "Direct link to inactive") > **inactive**: `number` Defined in: [packages/sdk/src/types/stats-types.ts:44](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/stats-types.ts#L44) *** ### total[​](#total "Direct link to total") > **total**: `number` Defined in: [packages/sdk/src/types/stats-types.ts:42](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/stats-types.ts#L42) --- # Interface: StripeAddress Defined in: [packages/sdk/src/types/billing-types.ts:454](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L454) ## Properties[​](#properties "Direct link to Properties") ### city?[​](#city "Direct link to city?") > `optional` **city**: `string` Defined in: [packages/sdk/src/types/billing-types.ts:457](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L457) *** ### country?[​](#country "Direct link to country?") > `optional` **country**: `string` Defined in: [packages/sdk/src/types/billing-types.ts:460](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L460) *** ### line1?[​](#line1 "Direct link to line1?") > `optional` **line1**: `string` Defined in: [packages/sdk/src/types/billing-types.ts:455](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L455) *** ### line2?[​](#line2 "Direct link to line2?") > `optional` **line2**: `string` Defined in: [packages/sdk/src/types/billing-types.ts:456](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L456) *** ### postal\_code?[​](#postal_code "Direct link to postal_code?") > `optional` **postal\_code**: `string` Defined in: [packages/sdk/src/types/billing-types.ts:459](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L459) *** ### state?[​](#state "Direct link to state?") > `optional` **state**: `string` Defined in: [packages/sdk/src/types/billing-types.ts:458](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L458) --- # Interface: StripeCardDetails Defined in: [packages/sdk/src/types/billing-types.ts:503](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L503) ## Properties[​](#properties "Direct link to Properties") ### brand[​](#brand "Direct link to brand") > **brand**: `string` Defined in: [packages/sdk/src/types/billing-types.ts:504](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L504) *** ### country?[​](#country "Direct link to country?") > `optional` **country**: `string` Defined in: [packages/sdk/src/types/billing-types.ts:509](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L509) *** ### expMonth[​](#expmonth "Direct link to expMonth") > **expMonth**: `number` Defined in: [packages/sdk/src/types/billing-types.ts:506](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L506) *** ### expYear[​](#expyear "Direct link to expYear") > **expYear**: `number` Defined in: [packages/sdk/src/types/billing-types.ts:507](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L507) *** ### funding?[​](#funding "Direct link to funding?") > `optional` **funding**: `string` Defined in: [packages/sdk/src/types/billing-types.ts:508](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L508) *** ### last4[​](#last4 "Direct link to last4") > **last4**: `string` Defined in: [packages/sdk/src/types/billing-types.ts:505](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L505) --- # Interface: StripeComparisonResult Defined in: [packages/sdk/src/types/generated/billing.ts:212](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/billing.ts#L212) Comparison result for a single product ## Properties[​](#properties "Direct link to Properties") ### differences?[​](#differences "Direct link to differences?") > `optional` **differences**: `string`\[] Defined in: [packages/sdk/src/types/generated/billing.ts:216](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/billing.ts#L216) *** ### localProduct[​](#localproduct "Direct link to localProduct") > **localProduct**: `ProductResponse` Defined in: [packages/sdk/src/types/generated/billing.ts:213](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/billing.ts#L213) *** ### planComparisons?[​](#plancomparisons "Direct link to planComparisons?") > `optional` **planComparisons**: [`PlanComparisonResult`](https://docs.gravityrail.com/sdk/interfaces/PlanComparisonResult.md)\[] Defined in: [packages/sdk/src/types/generated/billing.ts:217](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/billing.ts#L217) *** ### status[​](#status "Direct link to status") > **status**: `string` Defined in: [packages/sdk/src/types/generated/billing.ts:215](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/billing.ts#L215) *** ### stripeProduct[​](#stripeproduct "Direct link to stripeProduct") > **stripeProduct**: [`StripeProduct`](https://docs.gravityrail.com/sdk/interfaces/StripeProduct.md) | `null` Defined in: [packages/sdk/src/types/generated/billing.ts:214](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/billing.ts#L214) --- # Interface: StripeCustomer Defined in: [packages/sdk/src/types/generated/billing.ts:223](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/billing.ts#L223) Response model for Stripe customer data ## Properties[​](#properties "Direct link to Properties") ### address?[​](#address "Direct link to address?") > `optional` **address**: `StripeCustomerResponseAddress` Defined in: [packages/sdk/src/types/generated/billing.ts:231](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/billing.ts#L231) *** ### balance?[​](#balance "Direct link to balance?") > `optional` **balance**: `number` Defined in: [packages/sdk/src/types/generated/billing.ts:233](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/billing.ts#L233) *** ### created[​](#created "Direct link to created") > **created**: `number` Defined in: [packages/sdk/src/types/generated/billing.ts:237](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/billing.ts#L237) *** ### currency?[​](#currency "Direct link to currency?") > `optional` **currency**: `string` | `null` Defined in: [packages/sdk/src/types/generated/billing.ts:234](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/billing.ts#L234) *** ### delinquent?[​](#delinquent "Direct link to delinquent?") > `optional` **delinquent**: `boolean` Defined in: [packages/sdk/src/types/generated/billing.ts:235](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/billing.ts#L235) *** ### description?[​](#description "Direct link to description?") > `optional` **description**: `string` | `null` Defined in: [packages/sdk/src/types/generated/billing.ts:229](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/billing.ts#L229) *** ### email?[​](#email "Direct link to email?") > `optional` **email**: `string` | `null` Defined in: [packages/sdk/src/types/generated/billing.ts:227](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/billing.ts#L227) *** ### id[​](#id "Direct link to id") > **id**: `string` Defined in: [packages/sdk/src/types/generated/billing.ts:224](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/billing.ts#L224) *** ### livemode?[​](#livemode "Direct link to livemode?") > `optional` **livemode**: `boolean` Defined in: [packages/sdk/src/types/generated/billing.ts:238](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/billing.ts#L238) *** ### metadata?[​](#metadata "Direct link to metadata?") > `optional` **metadata**: `StripeCustomerResponseMetadata` Defined in: [packages/sdk/src/types/generated/billing.ts:230](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/billing.ts#L230) *** ### name?[​](#name "Direct link to name?") > `optional` **name**: `string` | `null` Defined in: [packages/sdk/src/types/generated/billing.ts:226](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/billing.ts#L226) *** ### object?[​](#object "Direct link to object?") > `optional` **object**: `string` Defined in: [packages/sdk/src/types/generated/billing.ts:225](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/billing.ts#L225) *** ### phone?[​](#phone "Direct link to phone?") > `optional` **phone**: `string` | `null` Defined in: [packages/sdk/src/types/generated/billing.ts:228](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/billing.ts#L228) *** ### shipping?[​](#shipping "Direct link to shipping?") > `optional` **shipping**: `StripeCustomerResponseShipping` Defined in: [packages/sdk/src/types/generated/billing.ts:232](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/billing.ts#L232) *** ### taxExempt?[​](#taxexempt "Direct link to taxExempt?") > `optional` **taxExempt**: `string` Defined in: [packages/sdk/src/types/generated/billing.ts:236](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/billing.ts#L236) --- # Interface: StripeCustomerCreateRequest Defined in: [packages/sdk/src/types/billing-types.ts:477](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L477) ## Properties[​](#properties "Direct link to Properties") ### address?[​](#address "Direct link to address?") > `optional` **address**: [`StripeAddress`](https://docs.gravityrail.com/sdk/interfaces/StripeAddress.md) Defined in: [packages/sdk/src/types/billing-types.ts:483](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L483) *** ### description?[​](#description "Direct link to description?") > `optional` **description**: `string` Defined in: [packages/sdk/src/types/billing-types.ts:481](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L481) *** ### email?[​](#email "Direct link to email?") > `optional` **email**: `string` Defined in: [packages/sdk/src/types/billing-types.ts:479](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L479) *** ### metadata?[​](#metadata "Direct link to metadata?") > `optional` **metadata**: `Record`<`string`, `string`> Defined in: [packages/sdk/src/types/billing-types.ts:482](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L482) *** ### name?[​](#name "Direct link to name?") > `optional` **name**: `string` Defined in: [packages/sdk/src/types/billing-types.ts:478](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L478) *** ### phone?[​](#phone "Direct link to phone?") > `optional` **phone**: `string` Defined in: [packages/sdk/src/types/billing-types.ts:480](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L480) *** ### shipping?[​](#shipping "Direct link to shipping?") > `optional` **shipping**: [`StripeShipping`](https://docs.gravityrail.com/sdk/interfaces/StripeShipping.md) Defined in: [packages/sdk/src/types/billing-types.ts:484](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L484) *** ### tax?[​](#tax "Direct link to tax?") > `optional` **tax**: [`StripeTax`](https://docs.gravityrail.com/sdk/interfaces/StripeTax.md) Defined in: [packages/sdk/src/types/billing-types.ts:485](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L485) *** ### taxExempt?[​](#taxexempt "Direct link to taxExempt?") > `optional` **taxExempt**: `string` Defined in: [packages/sdk/src/types/billing-types.ts:486](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L486) --- # Interface: StripeCustomerUpdateRequest Defined in: [packages/sdk/src/types/billing-types.ts:489](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L489) ## Properties[​](#properties "Direct link to Properties") ### address?[​](#address "Direct link to address?") > `optional` **address**: [`StripeAddress`](https://docs.gravityrail.com/sdk/interfaces/StripeAddress.md) Defined in: [packages/sdk/src/types/billing-types.ts:495](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L495) *** ### description?[​](#description "Direct link to description?") > `optional` **description**: `string` Defined in: [packages/sdk/src/types/billing-types.ts:493](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L493) *** ### email?[​](#email "Direct link to email?") > `optional` **email**: `string` Defined in: [packages/sdk/src/types/billing-types.ts:491](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L491) *** ### metadata?[​](#metadata "Direct link to metadata?") > `optional` **metadata**: `Record`<`string`, `string`> Defined in: [packages/sdk/src/types/billing-types.ts:494](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L494) *** ### name?[​](#name "Direct link to name?") > `optional` **name**: `string` Defined in: [packages/sdk/src/types/billing-types.ts:490](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L490) *** ### phone?[​](#phone "Direct link to phone?") > `optional` **phone**: `string` Defined in: [packages/sdk/src/types/billing-types.ts:492](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L492) *** ### shipping?[​](#shipping "Direct link to shipping?") > `optional` **shipping**: [`StripeShipping`](https://docs.gravityrail.com/sdk/interfaces/StripeShipping.md) Defined in: [packages/sdk/src/types/billing-types.ts:496](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L496) *** ### tax?[​](#tax "Direct link to tax?") > `optional` **tax**: [`StripeTax`](https://docs.gravityrail.com/sdk/interfaces/StripeTax.md) Defined in: [packages/sdk/src/types/billing-types.ts:497](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L497) *** ### taxExempt?[​](#taxexempt "Direct link to taxExempt?") > `optional` **taxExempt**: `string` Defined in: [packages/sdk/src/types/billing-types.ts:498](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L498) --- # Interface: StripePaymentMethod Defined in: [packages/sdk/src/types/billing-types.ts:519](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L519) ## Properties[​](#properties "Direct link to Properties") ### card?[​](#card "Direct link to card?") > `optional` **card**: [`StripeCardDetails`](https://docs.gravityrail.com/sdk/interfaces/StripeCardDetails.md) Defined in: [packages/sdk/src/types/billing-types.ts:524](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L524) *** ### created[​](#created "Direct link to created") > **created**: `number` Defined in: [packages/sdk/src/types/billing-types.ts:522](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L522) *** ### id[​](#id "Direct link to id") > **id**: `string` Defined in: [packages/sdk/src/types/billing-types.ts:520](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L520) *** ### isDefault?[​](#isdefault "Direct link to isDefault?") > `optional` **isDefault**: `boolean` Defined in: [packages/sdk/src/types/billing-types.ts:523](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L523) *** ### type[​](#type "Direct link to type") > **type**: `string` Defined in: [packages/sdk/src/types/billing-types.ts:521](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L521) *** ### usBankAccount?[​](#usbankaccount "Direct link to usBankAccount?") > `optional` **usBankAccount**: [`StripeUSBankAccountDetails`](https://docs.gravityrail.com/sdk/interfaces/StripeUSBankAccountDetails.md) Defined in: [packages/sdk/src/types/billing-types.ts:525](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L525) --- # Interface: StripePlanDetail Defined in: [packages/sdk/src/types/generated/billing.ts:250](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/billing.ts#L250) Individual plan details from Stripe subscription. ## Properties[​](#properties "Direct link to Properties") ### amount?[​](#amount "Direct link to amount?") > `optional` **amount**: `number` | `null` Defined in: [packages/sdk/src/types/generated/billing.ts:254](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/billing.ts#L254) *** ### currency?[​](#currency "Direct link to currency?") > `optional` **currency**: `string` | `null` Defined in: [packages/sdk/src/types/generated/billing.ts:255](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/billing.ts#L255) *** ### features?[​](#features "Direct link to features?") > `optional` **features**: `string`\[] Defined in: [packages/sdk/src/types/generated/billing.ts:256](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/billing.ts#L256) *** ### interval?[​](#interval "Direct link to interval?") > `optional` **interval**: `string` | `null` Defined in: [packages/sdk/src/types/generated/billing.ts:253](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/billing.ts#L253) *** ### limits?[​](#limits "Direct link to limits?") > `optional` **limits**: `StripePlanDetailLimits` Defined in: [packages/sdk/src/types/generated/billing.ts:257](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/billing.ts#L257) *** ### name?[​](#name "Direct link to name?") > `optional` **name**: `string` | `null` Defined in: [packages/sdk/src/types/generated/billing.ts:251](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/billing.ts#L251) *** ### productName?[​](#productname "Direct link to productName?") > `optional` **productName**: `string` | `null` Defined in: [packages/sdk/src/types/generated/billing.ts:252](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/billing.ts#L252) *** ### quantity?[​](#quantity "Direct link to quantity?") > `optional` **quantity**: `number` | `null` Defined in: [packages/sdk/src/types/generated/billing.ts:258](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/billing.ts#L258) --- # Interface: StripePrice Defined in: [packages/sdk/src/types/generated/billing.ts:266](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/billing.ts#L266) Stripe price data for comparison ## Properties[​](#properties "Direct link to Properties") ### active[​](#active "Direct link to active") > **active**: `boolean` Defined in: [packages/sdk/src/types/generated/billing.ts:274](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/billing.ts#L274) *** ### currency[​](#currency "Direct link to currency") > **currency**: `string` Defined in: [packages/sdk/src/types/generated/billing.ts:269](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/billing.ts#L269) *** ### id[​](#id "Direct link to id") > **id**: `string` Defined in: [packages/sdk/src/types/generated/billing.ts:267](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/billing.ts#L267) *** ### metadata?[​](#metadata "Direct link to metadata?") > `optional` **metadata**: `StripePriceDataMetadata` Defined in: [packages/sdk/src/types/generated/billing.ts:273](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/billing.ts#L273) *** ### nickname[​](#nickname "Direct link to nickname") > **nickname**: `string` | `null` Defined in: [packages/sdk/src/types/generated/billing.ts:271](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/billing.ts#L271) *** ### product[​](#product "Direct link to product") > **product**: `string` Defined in: [packages/sdk/src/types/generated/billing.ts:268](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/billing.ts#L268) *** ### recurring[​](#recurring "Direct link to recurring") > **recurring**: `StripePriceDataRecurring` Defined in: [packages/sdk/src/types/generated/billing.ts:272](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/billing.ts#L272) *** ### unitAmount[​](#unitamount "Direct link to unitAmount") > **unitAmount**: `number` | `null` Defined in: [packages/sdk/src/types/generated/billing.ts:270](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/billing.ts#L270) --- # Interface: StripeProduct Defined in: [packages/sdk/src/types/generated/billing.ts:284](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/billing.ts#L284) Stripe product data for comparison ## Properties[​](#properties "Direct link to Properties") ### created[​](#created "Direct link to created") > **created**: `number` Defined in: [packages/sdk/src/types/generated/billing.ts:290](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/billing.ts#L290) *** ### description[​](#description "Direct link to description") > **description**: `string` Defined in: [packages/sdk/src/types/generated/billing.ts:287](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/billing.ts#L287) *** ### features?[​](#features "Direct link to features?") > `optional` **features**: `string`\[] Defined in: [packages/sdk/src/types/generated/billing.ts:289](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/billing.ts#L289) *** ### id[​](#id "Direct link to id") > **id**: `string` Defined in: [packages/sdk/src/types/generated/billing.ts:285](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/billing.ts#L285) *** ### metadata?[​](#metadata "Direct link to metadata?") > `optional` **metadata**: `StripeProductDataMetadata` Defined in: [packages/sdk/src/types/generated/billing.ts:288](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/billing.ts#L288) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/generated/billing.ts:286](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/billing.ts#L286) *** ### updated[​](#updated "Direct link to updated") > **updated**: `number` Defined in: [packages/sdk/src/types/generated/billing.ts:291](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/billing.ts#L291) --- # Interface: StripeShipping Defined in: [packages/sdk/src/types/billing-types.ts:463](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L463) ## Properties[​](#properties "Direct link to Properties") ### address[​](#address "Direct link to address") > **address**: [`StripeAddress`](https://docs.gravityrail.com/sdk/interfaces/StripeAddress.md) Defined in: [packages/sdk/src/types/billing-types.ts:466](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L466) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/billing-types.ts:464](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L464) *** ### phone?[​](#phone "Direct link to phone?") > `optional` **phone**: `string` Defined in: [packages/sdk/src/types/billing-types.ts:465](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L465) --- # Interface: StripeSubscriptionCreateRequest Defined in: [packages/sdk/src/types/billing-types.ts:530](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L530) ## Properties[​](#properties "Direct link to Properties") ### cancelAtPeriodEnd?[​](#cancelatperiodend "Direct link to cancelAtPeriodEnd?") > `optional` **cancelAtPeriodEnd**: `boolean` Defined in: [packages/sdk/src/types/billing-types.ts:537](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L537) *** ### collectionMethod?[​](#collectionmethod "Direct link to collectionMethod?") > `optional` **collectionMethod**: `string` Defined in: [packages/sdk/src/types/billing-types.ts:538](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L538) *** ### customerWorkspaceId?[​](#customerworkspaceid "Direct link to customerWorkspaceId?") > `optional` **customerWorkspaceId**: `number` Defined in: [packages/sdk/src/types/billing-types.ts:534](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L534) *** ### metadata?[​](#metadata "Direct link to metadata?") > `optional` **metadata**: `Record`<`string`, `string`> Defined in: [packages/sdk/src/types/billing-types.ts:536](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L536) *** ### planPeriod[​](#planperiod "Direct link to planPeriod") > **planPeriod**: `string` Defined in: [packages/sdk/src/types/billing-types.ts:532](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L532) *** ### productId[​](#productid "Direct link to productId") > **productId**: `number` Defined in: [packages/sdk/src/types/billing-types.ts:531](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L531) *** ### trialPeriodDays?[​](#trialperioddays "Direct link to trialPeriodDays?") > `optional` **trialPeriodDays**: `number` Defined in: [packages/sdk/src/types/billing-types.ts:535](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L535) *** ### workspaceId[​](#workspaceid "Direct link to workspaceId") > **workspaceId**: `number` Defined in: [packages/sdk/src/types/billing-types.ts:533](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L533) --- # Interface: StripeSubscriptionUpdateRequest Defined in: [packages/sdk/src/types/billing-types.ts:558](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L558) ## Properties[​](#properties "Direct link to Properties") ### cancelAtPeriodEnd?[​](#cancelatperiodend "Direct link to cancelAtPeriodEnd?") > `optional` **cancelAtPeriodEnd**: `boolean` Defined in: [packages/sdk/src/types/billing-types.ts:560](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L560) *** ### items?[​](#items "Direct link to items?") > `optional` **items**: `Record`<`string`, `any`>\[] Defined in: [packages/sdk/src/types/billing-types.ts:561](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L561) *** ### metadata?[​](#metadata "Direct link to metadata?") > `optional` **metadata**: `Record`<`string`, `string`> Defined in: [packages/sdk/src/types/billing-types.ts:559](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L559) *** ### trialEnd?[​](#trialend "Direct link to trialEnd?") > `optional` **trialEnd**: `string` Defined in: [packages/sdk/src/types/billing-types.ts:562](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L562) --- # Interface: StripeTax Defined in: [packages/sdk/src/types/billing-types.ts:469](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L469) ## Properties[​](#properties "Direct link to Properties") ### automatic\_tax?[​](#automatic_tax "Direct link to automatic_tax?") > `optional` **automatic\_tax**: `string` Defined in: [packages/sdk/src/types/billing-types.ts:470](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L470) *** ### ip\_address?[​](#ip_address "Direct link to ip_address?") > `optional` **ip\_address**: `string` Defined in: [packages/sdk/src/types/billing-types.ts:471](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L471) *** ### location?[​](#location "Direct link to location?") > `optional` **location**: `string` Defined in: [packages/sdk/src/types/billing-types.ts:472](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L472) --- # Interface: StripeUSBankAccountDetails Defined in: [packages/sdk/src/types/billing-types.ts:512](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L512) ## Properties[​](#properties "Direct link to Properties") ### accountHolderType?[​](#accountholdertype "Direct link to accountHolderType?") > `optional` **accountHolderType**: `string` Defined in: [packages/sdk/src/types/billing-types.ts:513](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L513) *** ### bankName?[​](#bankname "Direct link to bankName?") > `optional` **bankName**: `string` Defined in: [packages/sdk/src/types/billing-types.ts:514](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L514) *** ### last4[​](#last4 "Direct link to last4") > **last4**: `string` Defined in: [packages/sdk/src/types/billing-types.ts:515](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L515) *** ### routingNumber?[​](#routingnumber "Direct link to routingNumber?") > `optional` **routingNumber**: `string` Defined in: [packages/sdk/src/types/billing-types.ts:516](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L516) --- # Interface: STTCapabilitiesResponse Defined in: [packages/sdk/src/types/generated/ai\_model.ts:157](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/ai_model.ts#L157) Capability flags for an STT model — the cross-layer source of truth (#14184). The frontend reads these instead of pattern-matching the model id. Serialized as camelCase (the platform-wide API key convention) via the model's alias\_generator; the generated client type uses the same camelCase keys. ## Properties[​](#properties "Direct link to Properties") ### detectThenLockDefault?[​](#detectthenlockdefault "Direct link to detectThenLockDefault?") > `optional` **detectThenLockDefault**: `boolean` Defined in: [packages/sdk/src/types/generated/ai\_model.ts:160](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/ai_model.ts#L160) *** ### supportsDetectThenLock?[​](#supportsdetectthenlock "Direct link to supportsDetectThenLock?") > `optional` **supportsDetectThenLock**: `boolean` Defined in: [packages/sdk/src/types/generated/ai\_model.ts:159](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/ai_model.ts#L159) *** ### supportsLanguageHints?[​](#supportslanguagehints "Direct link to supportsLanguageHints?") > `optional` **supportsLanguageHints**: `boolean` Defined in: [packages/sdk/src/types/generated/ai\_model.ts:158](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/ai_model.ts#L158) --- # Interface: STTModelResponse Defined in: [packages/sdk/src/types/generated/ai\_model.ts:174](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/ai_model.ts#L174) Response model for a speech-to-text model. ## Properties[​](#properties "Direct link to Properties") ### available?[​](#available "Direct link to available?") > `optional` **available**: `boolean` Defined in: [packages/sdk/src/types/generated/ai\_model.ts:181](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/ai_model.ts#L181) *** ### capabilities?[​](#capabilities "Direct link to capabilities?") > `optional` **capabilities**: [`STTCapabilitiesResponse`](https://docs.gravityrail.com/sdk/interfaces/STTCapabilitiesResponse.md) Defined in: [packages/sdk/src/types/generated/ai\_model.ts:186](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/ai_model.ts#L186) *** ### description?[​](#description "Direct link to description?") > `optional` **description**: `string` | `null` Defined in: [packages/sdk/src/types/generated/ai\_model.ts:179](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/ai_model.ts#L179) *** ### id[​](#id "Direct link to id") > **id**: `string` Defined in: [packages/sdk/src/types/generated/ai\_model.ts:175](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/ai_model.ts#L175) *** ### languages?[​](#languages "Direct link to languages?") > `optional` **languages**: `STTLanguageResponse`\[] Defined in: [packages/sdk/src/types/generated/ai\_model.ts:185](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/ai_model.ts#L185) *** ### multiplier?[​](#multiplier "Direct link to multiplier?") > `optional` **multiplier**: `number` Defined in: [packages/sdk/src/types/generated/ai\_model.ts:184](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/ai_model.ts#L184) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/generated/ai\_model.ts:176](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/ai_model.ts#L176) *** ### provider[​](#provider "Direct link to provider") > **provider**: [`ModelProvider`](https://docs.gravityrail.com/sdk/type-aliases/ModelProvider.md) Defined in: [packages/sdk/src/types/generated/ai\_model.ts:177](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/ai_model.ts#L177) *** ### recommended?[​](#recommended "Direct link to recommended?") > `optional` **recommended**: `boolean` Defined in: [packages/sdk/src/types/generated/ai\_model.ts:182](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/ai_model.ts#L182) *** ### replacement?[​](#replacement "Direct link to replacement?") > `optional` **replacement**: `string` | `null` Defined in: [packages/sdk/src/types/generated/ai\_model.ts:183](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/ai_model.ts#L183) *** ### state?[​](#state "Direct link to state?") > `optional` **state**: `string` Defined in: [packages/sdk/src/types/generated/ai\_model.ts:180](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/ai_model.ts#L180) *** ### type?[​](#type "Direct link to type?") > `optional` **type**: [`ModelType`](https://docs.gravityrail.com/sdk/type-aliases/ModelType.md) Defined in: [packages/sdk/src/types/generated/ai\_model.ts:178](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/ai_model.ts#L178) --- # Interface: STTModelsResponse Defined in: [packages/sdk/src/types/generated/ai\_model.ts:192](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/ai_model.ts#L192) Response model for STT models list. ## Properties[​](#properties "Direct link to Properties") ### models[​](#models "Direct link to models") > **models**: [`STTModelResponse`](https://docs.gravityrail.com/sdk/interfaces/STTModelResponse.md)\[] Defined in: [packages/sdk/src/types/generated/ai\_model.ts:193](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/ai_model.ts#L193) --- # Interface: STTProviderSummary Defined in: [packages/sdk/src/types/generated/reports.ts:158](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/reports.ts#L158) Summary statistics for an STT provider. ## Properties[​](#properties "Direct link to Properties") ### model[​](#model "Direct link to model") > **model**: `string` Defined in: [packages/sdk/src/types/generated/reports.ts:160](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/reports.ts#L160) *** ### provider[​](#provider "Direct link to provider") > **provider**: `string` Defined in: [packages/sdk/src/types/generated/reports.ts:159](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/reports.ts#L159) *** ### totalDurationSeconds[​](#totaldurationseconds "Direct link to totalDurationSeconds") > **totalDurationSeconds**: `number` Defined in: [packages/sdk/src/types/generated/reports.ts:161](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/reports.ts#L161) *** ### totalMessages[​](#totalmessages "Direct link to totalMessages") > **totalMessages**: `number` Defined in: [packages/sdk/src/types/generated/reports.ts:162](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/reports.ts#L162) --- # Interface: STTUsageRow Defined in: [packages/sdk/src/types/generated/reports.ts:168](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/reports.ts#L168) STT usage for a specific date and provider/model combination. ## Properties[​](#properties "Direct link to Properties") ### date[​](#date "Direct link to date") > **date**: `string` Defined in: [packages/sdk/src/types/generated/reports.ts:169](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/reports.ts#L169) *** ### messageCount[​](#messagecount "Direct link to messageCount") > **messageCount**: `number` Defined in: [packages/sdk/src/types/generated/reports.ts:172](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/reports.ts#L172) *** ### model[​](#model "Direct link to model") > **model**: `string` Defined in: [packages/sdk/src/types/generated/reports.ts:171](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/reports.ts#L171) *** ### provider[​](#provider "Direct link to provider") > **provider**: `string` Defined in: [packages/sdk/src/types/generated/reports.ts:170](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/reports.ts#L170) *** ### totalDurationSeconds[​](#totaldurationseconds "Direct link to totalDurationSeconds") > **totalDurationSeconds**: `number` Defined in: [packages/sdk/src/types/generated/reports.ts:173](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/reports.ts#L173) --- # Interface: SubscriptionUpdateRequest Defined in: [packages/sdk/src/types/billing-types.ts:550](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L550) ## Properties[​](#properties "Direct link to Properties") ### cancelAtPeriodEnd?[​](#cancelatperiodend "Direct link to cancelAtPeriodEnd?") > `optional` **cancelAtPeriodEnd**: `boolean` Defined in: [packages/sdk/src/types/billing-types.ts:553](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L553) *** ### metadata?[​](#metadata "Direct link to metadata?") > `optional` **metadata**: `Record`<`string`, `string`> Defined in: [packages/sdk/src/types/billing-types.ts:554](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L554) *** ### planPeriod?[​](#planperiod "Direct link to planPeriod?") > `optional` **planPeriod**: `string` Defined in: [packages/sdk/src/types/billing-types.ts:552](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L552) *** ### productId?[​](#productid "Direct link to productId?") > `optional` **productId**: `number` Defined in: [packages/sdk/src/types/billing-types.ts:551](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L551) *** ### trialEnd?[​](#trialend "Direct link to trialEnd?") > `optional` **trialEnd**: `string` Defined in: [packages/sdk/src/types/billing-types.ts:555](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L555) --- # Interface: SupervisorAbilityConfig Defined in: [packages/sdk/src/types/ability-types.ts:128](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ability-types.ts#L128) Config for the oversight:supervisor workflow ability ## Properties[​](#properties "Direct link to Properties") ### customToolId?[​](#customtoolid "Direct link to customToolId?") > `optional` **customToolId**: `number` Defined in: [packages/sdk/src/types/ability-types.ts:132](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ability-types.ts#L132) Legacy integer id of the supervisor CustomTool (kept for backward compat with pre-#10893 configs) *** ### customToolUUID?[​](#customtooluuid "Direct link to customToolUUID?") > `optional` **customToolUUID**: `string` Defined in: [packages/sdk/src/types/ability-types.ts:130](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ability-types.ts#L130) UUID of the supervisor CustomTool (must have tool\_type='supervisor') *** ### includeHistory?[​](#includehistory "Direct link to includeHistory?") > `optional` **includeHistory**: `boolean` Defined in: [packages/sdk/src/types/ability-types.ts:134](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ability-types.ts#L134) Whether to include full conversation history when invoking the supervisor --- # Interface: SupervisorActionsAbilityConfig Defined in: [packages/sdk/src/types/ability-types.ts:138](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ability-types.ts#L138) Config for supervisor\_actions ability - defines what actions a supervisor can take ## Properties[​](#properties "Direct link to Properties") ### overrideResponse?[​](#overrideresponse "Direct link to overrideResponse?") > `optional` **overrideResponse**: `boolean` Defined in: [packages/sdk/src/types/ability-types.ts:142](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ability-types.ts#L142) Allow supervisor to send messages directly to the user *** ### pauseChat?[​](#pausechat "Direct link to pauseChat?") > `optional` **pauseChat**: `boolean` Defined in: [packages/sdk/src/types/ability-types.ts:144](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ability-types.ts#L144) Allow supervisor to pause the conversation *** ### suggestResponse?[​](#suggestresponse "Direct link to suggestResponse?") > `optional` **suggestResponse**: `boolean` Defined in: [packages/sdk/src/types/ability-types.ts:140](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ability-types.ts#L140) Allow supervisor to provide suggestions to the main assistant (not visible to user) --- # Interface: SupervisorFormData Defined in: [packages/sdk/src/api/supervisors.ts:5](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/supervisors.ts#L5) ## Properties[​](#properties "Direct link to Properties") ### abilities?[​](#abilities "Direct link to abilities?") > `optional` **abilities**: `object`\[] Defined in: [packages/sdk/src/api/supervisors.ts:11](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/supervisors.ts#L11) #### abilityType[​](#abilitytype "Direct link to abilityType") > **abilityType**: `string` #### celCondition?[​](#celcondition "Direct link to celCondition?") > `optional` **celCondition**: `string` #### config?[​](#config "Direct link to config?") > `optional` **config**: `Record`<`string`, `any`> #### enabled?[​](#enabled "Direct link to enabled?") > `optional` **enabled**: `boolean` #### uuid[​](#uuid "Direct link to uuid") > **uuid**: `string` *** ### chatModel?[​](#chatmodel "Direct link to chatModel?") > `optional` **chatModel**: `string` Defined in: [packages/sdk/src/api/supervisors.ts:10](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/supervisors.ts#L10) *** ### description?[​](#description "Direct link to description?") > `optional` **description**: `string` Defined in: [packages/sdk/src/api/supervisors.ts:8](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/supervisors.ts#L8) *** ### displayName?[​](#displayname "Direct link to displayName?") > `optional` **displayName**: `string` Defined in: [packages/sdk/src/api/supervisors.ts:7](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/supervisors.ts#L7) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/api/supervisors.ts:6](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/supervisors.ts#L6) *** ### overrideResponse?[​](#overrideresponse "Direct link to overrideResponse?") > `optional` **overrideResponse**: `boolean` Defined in: [packages/sdk/src/api/supervisors.ts:13](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/supervisors.ts#L13) *** ### pauseChat?[​](#pausechat "Direct link to pauseChat?") > `optional` **pauseChat**: `boolean` Defined in: [packages/sdk/src/api/supervisors.ts:14](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/supervisors.ts#L14) *** ### prompt[​](#prompt "Direct link to prompt") > **prompt**: `string` Defined in: [packages/sdk/src/api/supervisors.ts:9](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/supervisors.ts#L9) *** ### suggestResponse?[​](#suggestresponse "Direct link to suggestResponse?") > `optional` **suggestResponse**: `boolean` Defined in: [packages/sdk/src/api/supervisors.ts:12](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/supervisors.ts#L12) *** ### talkToHuman?[​](#talktohuman "Direct link to talkToHuman?") > `optional` **talkToHuman**: `boolean` Defined in: [packages/sdk/src/api/supervisors.ts:15](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/supervisors.ts#L15) --- # Interface: SwitchTaskActionParams Defined in: [packages/sdk/src/types/event-types.ts:228](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L228) ## Properties[​](#properties "Direct link to Properties") ### taskUUID[​](#taskuuid "Direct link to taskUUID") > **taskUUID**: `string` Defined in: [packages/sdk/src/types/event-types.ts:229](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L229) --- # Interface: SyncCalendarResponse Defined in: [packages/sdk/src/types/calendar-types.ts:203](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/calendar-types.ts#L203) ## Properties[​](#properties "Direct link to Properties") ### created[​](#created "Direct link to created") > **created**: `number` Defined in: [packages/sdk/src/types/calendar-types.ts:206](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/calendar-types.ts#L206) *** ### errors[​](#errors "Direct link to errors") > **errors**: `object`\[] Defined in: [packages/sdk/src/types/calendar-types.ts:208](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/calendar-types.ts#L208) #### error[​](#error "Direct link to error") > **error**: `string` #### event\_id[​](#event_id "Direct link to event_id") > **event\_id**: `string` *** ### message[​](#message "Direct link to message") > **message**: `string` Defined in: [packages/sdk/src/types/calendar-types.ts:205](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/calendar-types.ts#L205) *** ### status[​](#status "Direct link to status") > **status**: `string` Defined in: [packages/sdk/src/types/calendar-types.ts:204](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/calendar-types.ts#L204) *** ### updated[​](#updated "Direct link to updated") > **updated**: `number` Defined in: [packages/sdk/src/types/calendar-types.ts:207](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/calendar-types.ts#L207) --- # Interface: SyncCapabilities Defined in: [packages/sdk/src/types/app-connection-types.ts:429](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L429) ## Properties[​](#properties "Direct link to Properties") ### conflictModes[​](#conflictmodes "Direct link to conflictModes") > **conflictModes**: [`ConflictPolicyMode`](https://docs.gravityrail.com/sdk/type-aliases/ConflictPolicyMode.md)\[] Defined in: [packages/sdk/src/types/app-connection-types.ts:431](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L431) *** ### entityDirections[​](#entitydirections "Direct link to entityDirections") > **entityDirections**: `Record`<`string`, (`"inbound"` | `"outbound"`)\[]> Defined in: [packages/sdk/src/types/app-connection-types.ts:437](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L437) Per-entity direction constraints. Missing key = both directions allowed. *** ### inboundTargets[​](#inboundtargets "Direct link to inboundTargets") > **inboundTargets**: `string`\[] Defined in: [packages/sdk/src/types/app-connection-types.ts:433](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L433) *** ### matchStrategies[​](#matchstrategies "Direct link to matchStrategies") > **matchStrategies**: [`MatchStrategyMode`](https://docs.gravityrail.com/sdk/type-aliases/MatchStrategyMode.md)\[] Defined in: [packages/sdk/src/types/app-connection-types.ts:430](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L430) *** ### supportedEntityTypes[​](#supportedentitytypes "Direct link to supportedEntityTypes") > **supportedEntityTypes**: [`SyncEntityType`](https://docs.gravityrail.com/sdk/type-aliases/SyncEntityType.md)\[] Defined in: [packages/sdk/src/types/app-connection-types.ts:432](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L432) *** ### supportsClear[​](#supportsclear "Direct link to supportsClear") > **supportsClear**: `boolean` Defined in: [packages/sdk/src/types/app-connection-types.ts:435](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L435) *** ### supportsNoteTask[​](#supportsnotetask "Direct link to supportsNoteTask") > **supportsNoteTask**: `boolean` Defined in: [packages/sdk/src/types/app-connection-types.ts:434](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L434) --- # Interface: SyncCapabilitiesResponse Defined in: [packages/sdk/src/types/generated/app\_connection.ts:420](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L420) Connector sync capabilities exposed to the frontend. ## Properties[​](#properties "Direct link to Properties") ### conflictModes?[​](#conflictmodes "Direct link to conflictModes?") > `optional` **conflictModes**: `string`\[] Defined in: [packages/sdk/src/types/generated/app\_connection.ts:422](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L422) *** ### entityDirections?[​](#entitydirections "Direct link to entityDirections?") > `optional` **entityDirections**: `SyncCapabilitiesResponseEntityDirections` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:427](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L427) *** ### inboundTargets?[​](#inboundtargets "Direct link to inboundTargets?") > `optional` **inboundTargets**: `string`\[] Defined in: [packages/sdk/src/types/generated/app\_connection.ts:424](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L424) *** ### matchStrategies?[​](#matchstrategies "Direct link to matchStrategies?") > `optional` **matchStrategies**: `string`\[] Defined in: [packages/sdk/src/types/generated/app\_connection.ts:421](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L421) *** ### supportedEntityTypes?[​](#supportedentitytypes "Direct link to supportedEntityTypes?") > `optional` **supportedEntityTypes**: `string`\[] Defined in: [packages/sdk/src/types/generated/app\_connection.ts:423](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L423) *** ### supportsClear?[​](#supportsclear "Direct link to supportsClear?") > `optional` **supportsClear**: `boolean` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:426](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L426) *** ### supportsNoteTask?[​](#supportsnotetask "Direct link to supportsNoteTask?") > `optional` **supportsNoteTask**: `boolean` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:425](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L425) --- # Interface: SyncCheckpoint Defined in: [packages/sdk/src/types/app-connection-types.ts:529](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L529) ## Properties[​](#properties "Direct link to Properties") ### cursor[​](#cursor "Direct link to cursor") > **cursor**: `Record`<`string`, `unknown`> Defined in: [packages/sdk/src/types/app-connection-types.ts:530](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L530) *** ### lastSuccessfulAt[​](#lastsuccessfulat "Direct link to lastSuccessfulAt") > **lastSuccessfulAt**: `string` | `null` Defined in: [packages/sdk/src/types/app-connection-types.ts:531](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L531) --- # Interface: SyncLogEntry Defined in: [packages/sdk/src/types/app-connection-types.ts:313](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L313) ## Properties[​](#properties "Direct link to Properties") ### createdAt[​](#createdat "Direct link to createdAt") > **createdAt**: `string` Defined in: [packages/sdk/src/types/app-connection-types.ts:317](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L317) *** ### errorMessage?[​](#errormessage "Direct link to errorMessage?") > `optional` **errorMessage**: `string` | `null` Defined in: [packages/sdk/src/types/app-connection-types.ts:318](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L318) *** ### id[​](#id "Direct link to id") > **id**: `number` Defined in: [packages/sdk/src/types/app-connection-types.ts:314](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L314) *** ### ruleName[​](#rulename "Direct link to ruleName") > **ruleName**: `string` | `null` Defined in: [packages/sdk/src/types/app-connection-types.ts:316](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L316) *** ### status[​](#status "Direct link to status") > **status**: [`RuleExecutionStatus`](https://docs.gravityrail.com/sdk/type-aliases/RuleExecutionStatus.md) Defined in: [packages/sdk/src/types/app-connection-types.ts:315](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L315) --- # Interface: SyncLogsResponse Defined in: [packages/sdk/src/types/app-connection-types.ts:321](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L321) ## Properties[​](#properties "Direct link to Properties") ### hasMore[​](#hasmore "Direct link to hasMore") > **hasMore**: `boolean` Defined in: [packages/sdk/src/types/app-connection-types.ts:323](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L323) *** ### items[​](#items "Direct link to items") > **items**: [`SyncLogEntry`](https://docs.gravityrail.com/sdk/interfaces/SyncLogEntry.md)\[] Defined in: [packages/sdk/src/types/app-connection-types.ts:322](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L322) *** ### nextCursor?[​](#nextcursor "Direct link to nextCursor?") > `optional` **nextCursor**: `string` Defined in: [packages/sdk/src/types/app-connection-types.ts:324](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L324) --- # Interface: SyncProductToStripeRequest Defined in: [packages/sdk/src/types/billing-types.ts:567](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L567) ## Properties[​](#properties "Direct link to Properties") ### productId[​](#productid "Direct link to productId") > **productId**: `number` Defined in: [packages/sdk/src/types/billing-types.ts:568](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L568) *** ### syncFeatures?[​](#syncfeatures "Direct link to syncFeatures?") > `optional` **syncFeatures**: `boolean` Defined in: [packages/sdk/src/types/billing-types.ts:571](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L571) *** ### syncOverages?[​](#syncoverages "Direct link to syncOverages?") > `optional` **syncOverages**: `boolean` Defined in: [packages/sdk/src/types/billing-types.ts:570](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L570) *** ### syncPlans?[​](#syncplans "Direct link to syncPlans?") > `optional` **syncPlans**: `boolean` Defined in: [packages/sdk/src/types/billing-types.ts:569](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L569) --- # Interface: SyncProductToStripeResponse Defined in: [packages/sdk/src/types/generated/billing.ts:355](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/billing.ts#L355) Response model for syncing a product to Stripe ## Properties[​](#properties "Direct link to Properties") ### errors?[​](#errors "Direct link to errors?") > `optional` **errors**: `string`\[] Defined in: [packages/sdk/src/types/generated/billing.ts:361](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/billing.ts#L361) *** ### productId[​](#productid "Direct link to productId") > **productId**: `number` Defined in: [packages/sdk/src/types/generated/billing.ts:357](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/billing.ts#L357) *** ### stripeProductId[​](#stripeproductid "Direct link to stripeProductId") > **stripeProductId**: `string` Defined in: [packages/sdk/src/types/generated/billing.ts:358](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/billing.ts#L358) *** ### success[​](#success "Direct link to success") > **success**: `boolean` Defined in: [packages/sdk/src/types/generated/billing.ts:356](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/billing.ts#L356) *** ### syncedFeatures?[​](#syncedfeatures "Direct link to syncedFeatures?") > `optional` **syncedFeatures**: `string`\[] Defined in: [packages/sdk/src/types/generated/billing.ts:360](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/billing.ts#L360) *** ### syncedPlans?[​](#syncedplans "Direct link to syncedPlans?") > `optional` **syncedPlans**: `string`\[] Defined in: [packages/sdk/src/types/generated/billing.ts:359](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/billing.ts#L359) *** ### syncTime[​](#synctime "Direct link to syncTime") > **syncTime**: `string` Defined in: [packages/sdk/src/types/generated/billing.ts:362](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/billing.ts#L362) --- # Interface: SyncRule Defined in: [packages/sdk/src/types/app-connection-types.ts:193](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L193) ## Properties[​](#properties "Direct link to Properties") ### enabled[​](#enabled "Direct link to enabled") > **enabled**: `boolean` Defined in: [packages/sdk/src/types/app-connection-types.ts:195](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L195) *** ### inbound[​](#inbound "Direct link to inbound") > **inbound**: [`SyncRuleInbound`](https://docs.gravityrail.com/sdk/interfaces/SyncRuleInbound.md)\[] Defined in: [packages/sdk/src/types/app-connection-types.ts:197](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L197) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/app-connection-types.ts:194](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L194) *** ### outbound[​](#outbound "Direct link to outbound") > **outbound**: [`SyncRuleOutbound`](https://docs.gravityrail.com/sdk/interfaces/SyncRuleOutbound.md)\[] Defined in: [packages/sdk/src/types/app-connection-types.ts:196](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L196) --- # Interface: SyncRuleInbound Defined in: [packages/sdk/src/types/app-connection-types.ts:187](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L187) ## Properties[​](#properties "Direct link to Properties") ### expression[​](#expression "Direct link to expression") > **expression**: `string` Defined in: [packages/sdk/src/types/app-connection-types.ts:190](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L190) *** ### targetKey[​](#targetkey "Direct link to targetKey") > **targetKey**: `string` Defined in: [packages/sdk/src/types/app-connection-types.ts:189](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L189) *** ### targetType[​](#targettype "Direct link to targetType") > **targetType**: [`SyncRuleInboundTargetType`](https://docs.gravityrail.com/sdk/type-aliases/SyncRuleInboundTargetType.md) Defined in: [packages/sdk/src/types/app-connection-types.ts:188](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L188) --- # Interface: SyncRuleOutbound Defined in: [packages/sdk/src/types/app-connection-types.ts:176](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L176) ## Properties[​](#properties "Direct link to Properties") ### expression[​](#expression "Direct link to expression") > **expression**: `string` Defined in: [packages/sdk/src/types/app-connection-types.ts:178](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L178) *** ### targetField[​](#targetfield "Direct link to targetField") > **targetField**: `string` Defined in: [packages/sdk/src/types/app-connection-types.ts:177](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L177) --- # Interface: SyncRunRequest Defined in: [packages/sdk/src/types/app-connection-types.ts:265](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L265) ## Properties[​](#properties "Direct link to Properties") ### boardId?[​](#boardid "Direct link to boardId?") > `optional` **boardId**: `string` Defined in: [packages/sdk/src/types/app-connection-types.ts:280](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L280) When set, the run is further scoped to a single board mapping within the selected entity. Requires `entityType` to be set. Used by the per-mapping sync buttons in the Monday.com UI so a failure on one board does not obscure results on another. *** ### dryRun?[​](#dryrun "Direct link to dryRun?") > `optional` **dryRun**: `boolean` Defined in: [packages/sdk/src/types/app-connection-types.ts:266](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L266) *** ### entityType?[​](#entitytype "Direct link to entityType?") > `optional` **entityType**: [`SyncEntityType`](https://docs.gravityrail.com/sdk/type-aliases/SyncEntityType.md) Defined in: [packages/sdk/src/types/app-connection-types.ts:273](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L273) When set, the run is scoped to a single entity type (members or records). Mode derivation, the "any direction enabled" guard, and checkpoint resets are all limited to the matching entity config. *** ### recordLimit?[​](#recordlimit "Direct link to recordLimit?") > `optional` **recordLimit**: `number` Defined in: [packages/sdk/src/types/app-connection-types.ts:290](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L290) Optional preview-only cap on the number of entities the engine processes. Server enforces `1 <= recordLimit <= 200` and additionally requires `dryRun: true` — capped runs are the "test on a small batch" affordance and never commit writes. The server also withholds inbound checkpoint advancement so a subsequent uncapped sync replays the previewed records. Omit (or pass `undefined`) for the legacy uncapped behavior. *** ### resetCheckpoints?[​](#resetcheckpoints "Direct link to resetCheckpoints?") > `optional` **resetCheckpoints**: `boolean` Defined in: [packages/sdk/src/types/app-connection-types.ts:267](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L267) --- # Interface: SyncRunResponse Defined in: [packages/sdk/src/types/app-connection-types.ts:293](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L293) ## Properties[​](#properties "Direct link to Properties") ### streamKey[​](#streamkey "Direct link to streamKey") > **streamKey**: `string` Defined in: [packages/sdk/src/types/app-connection-types.ts:294](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L294) *** ### workflowId[​](#workflowid "Direct link to workflowId") > **workflowId**: `string` Defined in: [packages/sdk/src/types/app-connection-types.ts:295](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L295) --- # Interface: SystemStatistics Defined in: [packages/sdk/src/types/stats-types.ts:147](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/stats-types.ts#L147) ## Properties[​](#properties "Direct link to Properties") ### activeConnections[​](#activeconnections "Direct link to activeConnections") > **activeConnections**: `number` Defined in: [packages/sdk/src/types/stats-types.ts:152](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/stats-types.ts#L152) *** ### cpu[​](#cpu "Direct link to cpu") > **cpu**: `number` Defined in: [packages/sdk/src/types/stats-types.ts:148](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/stats-types.ts#L148) *** ### healthChecks[​](#healthchecks "Direct link to healthChecks") > **healthChecks**: [`HealthCheckStatistics`](https://docs.gravityrail.com/sdk/interfaces/HealthCheckStatistics.md)\[] Defined in: [packages/sdk/src/types/stats-types.ts:154](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/stats-types.ts#L154) *** ### memory[​](#memory "Direct link to memory") > **memory**: `number` Defined in: [packages/sdk/src/types/stats-types.ts:149](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/stats-types.ts#L149) *** ### network[​](#network "Direct link to network") > **network**: `number` Defined in: [packages/sdk/src/types/stats-types.ts:151](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/stats-types.ts#L151) *** ### queueLength[​](#queuelength "Direct link to queueLength") > **queueLength**: `number` Defined in: [packages/sdk/src/types/stats-types.ts:153](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/stats-types.ts#L153) *** ### storage[​](#storage "Direct link to storage") > **storage**: `number` Defined in: [packages/sdk/src/types/stats-types.ts:150](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/stats-types.ts#L150) --- # Interface: TaskAssignmentStatsResponse Defined in: [packages/sdk/src/types/generated/task.ts:221](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L221) Response model for task assignment statistics. ## Properties[​](#properties "Direct link to Properties") ### current[​](#current "Direct link to current") > **current**: `number` Defined in: [packages/sdk/src/types/generated/task.ts:222](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L222) *** ### parentTotal?[​](#parenttotal "Direct link to parentTotal?") > `optional` **parentTotal**: `number` | `null` Defined in: [packages/sdk/src/types/generated/task.ts:224](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L224) *** ### total[​](#total "Direct link to total") > **total**: `number` Defined in: [packages/sdk/src/types/generated/task.ts:223](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L223) --- # Interface: TaskChatResponse Defined in: [packages/sdk/src/types/generated/task.ts:230](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L230) Response model for a chat on a specific task. ## Properties[​](#properties "Direct link to Properties") ### assignmentId[​](#assignmentid "Direct link to assignmentId") > **assignmentId**: `number` Defined in: [packages/sdk/src/types/generated/task.ts:235](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L235) *** ### chatId[​](#chatid "Direct link to chatId") > **chatId**: `number` Defined in: [packages/sdk/src/types/generated/task.ts:231](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L231) *** ### chatUuid[​](#chatuuid "Direct link to chatUuid") > **chatUuid**: `string` Defined in: [packages/sdk/src/types/generated/task.ts:232](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L232) *** ### currentTaskName[​](#currenttaskname "Direct link to currentTaskName") > **currentTaskName**: `string` Defined in: [packages/sdk/src/types/generated/task.ts:238](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L238) *** ### lastMessageAt?[​](#lastmessageat "Direct link to lastMessageAt?") > `optional` **lastMessageAt**: `string` | `null` Defined in: [packages/sdk/src/types/generated/task.ts:240](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L240) *** ### memberId[​](#memberid "Direct link to memberId") > **memberId**: `number` Defined in: [packages/sdk/src/types/generated/task.ts:237](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L237) *** ### memberName[​](#membername "Direct link to memberName") > **memberName**: `string` Defined in: [packages/sdk/src/types/generated/task.ts:236](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L236) *** ### messageCount?[​](#messagecount "Direct link to messageCount?") > `optional` **messageCount**: `number` Defined in: [packages/sdk/src/types/generated/task.ts:241](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L241) *** ### summary?[​](#summary "Direct link to summary?") > `optional` **summary**: `string` | `null` Defined in: [packages/sdk/src/types/generated/task.ts:234](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L234) *** ### title?[​](#title "Direct link to title?") > `optional` **title**: `string` | `null` Defined in: [packages/sdk/src/types/generated/task.ts:233](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L233) *** ### workflowName[​](#workflowname "Direct link to workflowName") > **workflowName**: `string` Defined in: [packages/sdk/src/types/generated/task.ts:239](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L239) --- # Interface: TaskChatsListResponse Defined in: [packages/sdk/src/types/generated/task.ts:247](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L247) Response model for paginated list of task chats. ## Properties[​](#properties "Direct link to Properties") ### items[​](#items "Direct link to items") > **items**: [`TaskChatResponse`](https://docs.gravityrail.com/sdk/interfaces/TaskChatResponse.md)\[] Defined in: [packages/sdk/src/types/generated/task.ts:248](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L248) *** ### limit[​](#limit "Direct link to limit") > **limit**: `number` Defined in: [packages/sdk/src/types/generated/task.ts:250](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L250) *** ### offset[​](#offset "Direct link to offset") > **offset**: `number` Defined in: [packages/sdk/src/types/generated/task.ts:251](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L251) *** ### total[​](#total "Direct link to total") > **total**: `number` Defined in: [packages/sdk/src/types/generated/task.ts:249](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L249) --- # Interface: TaskChildRelation Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:113](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L113) ## Properties[​](#properties "Direct link to Properties") ### autoNext[​](#autonext "Direct link to autoNext") > **autoNext**: `boolean` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:117](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L117) *** ### childUuid[​](#childuuid "Direct link to childUuid") > **childUuid**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:115](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L115) *** ### choicePrompt?[​](#choiceprompt "Direct link to choicePrompt?") > `optional` **choicePrompt**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:118](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L118) *** ### order[​](#order "Direct link to order") > **order**: `number` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:119](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L119) *** ### parentUuid[​](#parentuuid "Direct link to parentUuid") > **parentUuid**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:114](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L114) *** ### required[​](#required "Direct link to required") > **required**: `boolean` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:116](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L116) --- # Interface: TaskContext Defined in: [packages/sdk/src/app-context.ts:38](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/app-context.ts#L38) Information about a task in the context ## Properties[​](#properties "Direct link to Properties") ### id[​](#id "Direct link to id") > **id**: `number` Defined in: [packages/sdk/src/app-context.ts:39](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/app-context.ts#L39) *** ### name?[​](#name "Direct link to name?") > `optional` **name**: `string` Defined in: [packages/sdk/src/app-context.ts:40](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/app-context.ts#L40) --- # Interface: TaskCountResponse Defined in: [packages/sdk/src/types/stats-types.ts:6](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/stats-types.ts#L6) ## Properties[​](#properties "Direct link to Properties") ### taskCount[​](#taskcount "Direct link to taskCount") > **taskCount**: `number` Defined in: [packages/sdk/src/types/stats-types.ts:7](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/stats-types.ts#L7) --- # Interface: TaskDataTypeRelation Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:101](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L101) ## Properties[​](#properties "Direct link to Properties") ### accessMode[​](#accessmode "Direct link to accessMode") > **accessMode**: `number` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:104](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L104) *** ### dataTypeUuid[​](#datatypeuuid "Direct link to dataTypeUuid") > **dataTypeUuid**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:103](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L103) *** ### taskUuid[​](#taskuuid "Direct link to taskUuid") > **taskUuid**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:102](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L102) --- # Interface: TaskEventRuleRelation Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:122](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L122) ## Properties[​](#properties "Direct link to Properties") ### eventRuleUuid[​](#eventruleuuid "Direct link to eventRuleUuid") > **eventRuleUuid**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:124](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L124) *** ### ruleType[​](#ruletype "Direct link to ruleType") > **ruleType**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:125](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L125) *** ### taskUuid[​](#taskuuid "Direct link to taskUuid") > **taskUuid**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:123](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L123) --- # Interface: TaskExport Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:18](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L18) ## Properties[​](#properties "Direct link to Properties") ### description?[​](#description "Direct link to description?") > `optional` **description**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:23](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L23) *** ### isAdmin?[​](#isadmin "Direct link to isAdmin?") > `optional` **isAdmin**: `boolean` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:26](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L26) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:20](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L20) *** ### posX?[​](#posx "Direct link to posX?") > `optional` **posX**: `number` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:28](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L28) *** ### posY?[​](#posy "Direct link to posY?") > `optional` **posY**: `number` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:29](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L29) *** ### prompt?[​](#prompt "Direct link to prompt?") > `optional` **prompt**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:25](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L25) *** ### shortPrompt?[​](#shortprompt "Direct link to shortPrompt?") > `optional` **shortPrompt**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:24](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L24) *** ### slug[​](#slug "Direct link to slug") > **slug**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:21](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L21) *** ### uuid[​](#uuid "Direct link to uuid") > **uuid**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:19](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L19) *** ### workflowUuid[​](#workflowuuid "Direct link to workflowUuid") > **workflowUuid**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:22](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L22) --- # Interface: TaskExportChildRelation Defined in: [packages/sdk/src/types/task-types.ts:203](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/task-types.ts#L203) ## Properties[​](#properties "Direct link to Properties") ### autoNext[​](#autonext "Direct link to autoNext") > **autoNext**: `boolean` Defined in: [packages/sdk/src/types/task-types.ts:207](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/task-types.ts#L207) *** ### childUuid[​](#childuuid "Direct link to childUuid") > **childUuid**: `string` Defined in: [packages/sdk/src/types/task-types.ts:205](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/task-types.ts#L205) *** ### choicePrompt[​](#choiceprompt "Direct link to choicePrompt") > **choicePrompt**: `string` | `null` Defined in: [packages/sdk/src/types/task-types.ts:208](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/task-types.ts#L208) *** ### order[​](#order "Direct link to order") > **order**: `number` Defined in: [packages/sdk/src/types/task-types.ts:209](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/task-types.ts#L209) *** ### parentUuid[​](#parentuuid "Direct link to parentUuid") > **parentUuid**: `string` Defined in: [packages/sdk/src/types/task-types.ts:204](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/task-types.ts#L204) *** ### required[​](#required "Direct link to required") > **required**: `boolean` Defined in: [packages/sdk/src/types/task-types.ts:206](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/task-types.ts#L206) --- # Interface: TaskExportDataTypeRelation Defined in: [packages/sdk/src/types/data-types.ts:214](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L214) ## Properties[​](#properties "Direct link to Properties") ### accessMode[​](#accessmode "Direct link to accessMode") > **accessMode**: `number` Defined in: [packages/sdk/src/types/data-types.ts:217](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L217) *** ### dataTypeId[​](#datatypeid "Direct link to dataTypeId") > **dataTypeId**: `number` Defined in: [packages/sdk/src/types/data-types.ts:215](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L215) *** ### dataTypeSlug[​](#datatypeslug "Direct link to dataTypeSlug") > **dataTypeSlug**: `string` Defined in: [packages/sdk/src/types/data-types.ts:216](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/data-types.ts#L216) --- # Interface: TaskExportEventRuleRelation Defined in: [packages/sdk/src/types/event-types.ts:649](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L649) ## Properties[​](#properties "Direct link to Properties") ### eventRuleUuid[​](#eventruleuuid "Direct link to eventRuleUuid") > **eventRuleUuid**: `string` Defined in: [packages/sdk/src/types/event-types.ts:651](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L651) *** ### ruleType[​](#ruletype "Direct link to ruleType") > **ruleType**: `string` Defined in: [packages/sdk/src/types/event-types.ts:652](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L652) *** ### taskUuid[​](#taskuuid "Direct link to taskUuid") > **taskUuid**: `string` Defined in: [packages/sdk/src/types/event-types.ts:650](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L650) --- # Interface: TaskExportFileRelation Defined in: [packages/sdk/src/types/file-types.ts:122](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/file-types.ts#L122) ## Properties[​](#properties "Direct link to Properties") ### accessMode[​](#accessmode "Direct link to accessMode") > **accessMode**: `number` Defined in: [packages/sdk/src/types/file-types.ts:125](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/file-types.ts#L125) *** ### fileUuid[​](#fileuuid "Direct link to fileUuid") > **fileUuid**: `string` Defined in: [packages/sdk/src/types/file-types.ts:124](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/file-types.ts#L124) *** ### taskUuid[​](#taskuuid "Direct link to taskUuid") > **taskUuid**: `string` Defined in: [packages/sdk/src/types/file-types.ts:123](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/file-types.ts#L123) --- # Interface: TaskFileRelation Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:107](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L107) ## Properties[​](#properties "Direct link to Properties") ### accessMode[​](#accessmode "Direct link to accessMode") > **accessMode**: `number` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:110](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L110) *** ### fileUuid[​](#fileuuid "Direct link to fileUuid") > **fileUuid**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:109](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L109) *** ### taskUuid[​](#taskuuid "Direct link to taskUuid") > **taskUuid**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:108](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L108) --- # Interface: TaskFormData Defined in: [packages/sdk/src/types/task-types.ts:89](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/task-types.ts#L89) ## Properties[​](#properties "Direct link to Properties") ### abilities?[​](#abilities "Direct link to abilities?") > `optional` **abilities**: [`AbilityResponse`](https://docs.gravityrail.com/sdk/type-aliases/AbilityResponse.md)\[] Defined in: [packages/sdk/src/types/task-types.ts:103](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/task-types.ts#L103) *** ### celGuard?[​](#celguard "Direct link to celGuard?") > `optional` **celGuard**: `string` | `null` Defined in: [packages/sdk/src/types/task-types.ts:100](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/task-types.ts#L100) *** ### childTasks?[​](#childtasks "Direct link to childTasks?") > `optional` **childTasks**: [`ChildTaskFormData`](https://docs.gravityrail.com/sdk/interfaces/ChildTaskFormData.md)\[] Defined in: [packages/sdk/src/types/task-types.ts:97](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/task-types.ts#L97) *** ### configuration?[​](#configuration "Direct link to configuration?") > `optional` **configuration**: `any` Defined in: [packages/sdk/src/types/task-types.ts:92](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/task-types.ts#L92) *** ### description?[​](#description "Direct link to description?") > `optional` **description**: `string` Defined in: [packages/sdk/src/types/task-types.ts:93](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/task-types.ts#L93) *** ### eventRules?[​](#eventrules "Direct link to eventRules?") > `optional` **eventRules**: [`EventRuleInput`](https://docs.gravityrail.com/sdk/interfaces/EventRuleInput.md)\[] Defined in: [packages/sdk/src/types/task-types.ts:104](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/task-types.ts#L104) *** ### isAdmin?[​](#isadmin "Direct link to isAdmin?") > `optional` **isAdmin**: `boolean` Defined in: [packages/sdk/src/types/task-types.ts:96](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/task-types.ts#L96) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/task-types.ts:90](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/task-types.ts#L90) *** ### ownerId?[​](#ownerid "Direct link to ownerId?") > `optional` **ownerId**: `number` | `null` Defined in: [packages/sdk/src/types/task-types.ts:98](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/task-types.ts#L98) *** ### posX?[​](#posx "Direct link to posX?") > `optional` **posX**: `number` | `null` Defined in: [packages/sdk/src/types/task-types.ts:101](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/task-types.ts#L101) *** ### posY?[​](#posy "Direct link to posY?") > `optional` **posY**: `number` | `null` Defined in: [packages/sdk/src/types/task-types.ts:102](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/task-types.ts#L102) *** ### prompt?[​](#prompt "Direct link to prompt?") > `optional` **prompt**: `string` Defined in: [packages/sdk/src/types/task-types.ts:95](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/task-types.ts#L95) *** ### shortPrompt?[​](#shortprompt "Direct link to shortPrompt?") > `optional` **shortPrompt**: `string` | `null` Defined in: [packages/sdk/src/types/task-types.ts:94](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/task-types.ts#L94) *** ### taskType?[​](#tasktype "Direct link to taskType?") > `optional` **taskType**: `string` Defined in: [packages/sdk/src/types/task-types.ts:91](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/task-types.ts#L91) *** ### workflowId?[​](#workflowid "Direct link to workflowId?") > `optional` **workflowId**: `number` Defined in: [packages/sdk/src/types/task-types.ts:99](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/task-types.ts#L99) --- # Interface: TasksQueryParams Defined in: [packages/sdk/src/types/task-types.ts:107](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/task-types.ts#L107) ## Properties[​](#properties "Direct link to Properties") ### include\_archived?[​](#include_archived "Direct link to include_archived?") > `optional` **include\_archived**: `boolean` Defined in: [packages/sdk/src/types/task-types.ts:108](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/task-types.ts#L108) --- # Interface: TeamsAccountResponse Defined in: [packages/sdk/src/types/generated/app\_connection.ts:443](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L443) Response model for a workspace member's linked Teams (Entra) account. PII surface — `memberEmail` and `teamsEmail` are surfaced to readers with `Scope.APPS_READ`. This intentionally matches `SlackAccountResponse` (`memberEmail` + `slackEmail`) so the account-link admin UI has identical scope semantics across integrations. A tighter PII gate on this surface (e.g. requiring `APPS_ADMIN`) is tracked as a cross-integration follow-up — see Urðarbrunnr review on #11653 (LOW) — and should be applied to Slack at the same time. ## Properties[​](#properties "Direct link to Properties") ### aadObjectId[​](#aadobjectid "Direct link to aadObjectId") > **aadObjectId**: `string` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:448](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L448) *** ### connectedAt?[​](#connectedat "Direct link to connectedAt?") > `optional` **connectedAt**: `string` | `null` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:454](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L454) *** ### displayName?[​](#displayname "Direct link to displayName?") > `optional` **displayName**: `string` | `null` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:450](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L450) *** ### emailVerified[​](#emailverified "Direct link to emailVerified") > **emailVerified**: `boolean` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:453](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L453) *** ### id[​](#id "Direct link to id") > **id**: `number` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:444](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L444) *** ### lastUsedAt?[​](#lastusedat "Direct link to lastUsedAt?") > `optional` **lastUsedAt**: `string` | `null` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:455](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L455) *** ### memberEmail?[​](#memberemail "Direct link to memberEmail?") > `optional` **memberEmail**: `string` | `null` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:447](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L447) *** ### memberId[​](#memberid "Direct link to memberId") > **memberId**: `number` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:445](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L445) *** ### memberName?[​](#membername "Direct link to memberName?") > `optional` **memberName**: `string` | `null` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:446](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L446) *** ### teamsEmail?[​](#teamsemail "Direct link to teamsEmail?") > `optional` **teamsEmail**: `string` | `null` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:452](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L452) *** ### tenantId?[​](#tenantid "Direct link to tenantId?") > `optional` **tenantId**: `string` | `null` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:449](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L449) *** ### userPrincipalName?[​](#userprincipalname "Direct link to userPrincipalName?") > `optional` **userPrincipalName**: `string` | `null` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:451](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L451) --- # Interface: TeamsAppInstallationResponse Defined in: [packages/sdk/src/types/generated/app\_connection.ts:461](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L461) Response model for a Teams per-tenant installation. ## Properties[​](#properties "Direct link to Properties") ### active[​](#active "Direct link to active") > **active**: `boolean` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:468](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L468) *** ### botUserId?[​](#botuserid "Direct link to botUserId?") > `optional` **botUserId**: `string` | `null` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:466](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L466) *** ### createdAt[​](#createdat "Direct link to createdAt") > **createdAt**: `string` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:470](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L470) *** ### id[​](#id "Direct link to id") > **id**: `number` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:462](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L462) *** ### installedAt[​](#installedat "Direct link to installedAt") > **installedAt**: `string` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:469](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L469) *** ### installedByAadOid?[​](#installedbyaadoid "Direct link to installedByAadOid?") > `optional` **installedByAadOid**: `string` | `null` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:467](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L467) *** ### serviceUrl?[​](#serviceurl "Direct link to serviceUrl?") > `optional` **serviceUrl**: `string` | `null` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:465](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L465) *** ### tenantDisplayName?[​](#tenantdisplayname "Direct link to tenantDisplayName?") > `optional` **tenantDisplayName**: `string` | `null` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:464](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L464) *** ### tenantId[​](#tenantid "Direct link to tenantId") > **tenantId**: `string` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:463](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L463) *** ### updatedAt[​](#updatedat "Direct link to updatedAt") > **updatedAt**: `string` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:471](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L471) --- # Interface: TeamsAppResponse Defined in: [packages/sdk/src/types/generated/app\_connection.ts:477](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L477) Response model for Teams app. ## Properties[​](#properties "Direct link to Properties") ### allowDm[​](#allowdm "Direct link to allowDm") > **allowDm**: `boolean` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:491](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L491) *** ### allowedChannelIds?[​](#allowedchannelids "Direct link to allowedChannelIds?") > `optional` **allowedChannelIds**: `string`\[] | `null` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:493](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L493) *** ### commands?[​](#commands "Direct link to commands?") > `optional` **commands**: [`TeamsCommandConfigResponse`](https://docs.gravityrail.com/sdk/interfaces/TeamsCommandConfigResponse.md)\[] | `null` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:488](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L488) *** ### connectionType?[​](#connectiontype "Direct link to connectionType?") > `optional` **connectionType**: `"teams_app"` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:478](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L478) *** ### createdAt[​](#createdat "Direct link to createdAt") > **createdAt**: `string` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:494](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L494) *** ### creatorId?[​](#creatorid "Direct link to creatorId?") > `optional` **creatorId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:483](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L483) *** ### defaultWorkflowId[​](#defaultworkflowid "Direct link to defaultWorkflowId") > **defaultWorkflowId**: `number` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:484](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L484) *** ### enabled[​](#enabled "Direct link to enabled") > **enabled**: `boolean` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:482](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L482) *** ### id[​](#id "Direct link to id") > **id**: `number` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:479](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L479) *** ### microsoftAppId?[​](#microsoftappid "Direct link to microsoftAppId?") > `optional` **microsoftAppId**: `string` | `null` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:485](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L485) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:481](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L481) *** ### replyInThread[​](#replyinthread "Direct link to replyInThread") > **replyInThread**: `boolean` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:492](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L492) *** ### respondMode[​](#respondmode "Direct link to respondMode") > **respondMode**: `string` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:489](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L489) *** ### respondWhen?[​](#respondwhen "Direct link to respondWhen?") > `optional` **respondWhen**: `string` | `null` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:490](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L490) *** ### ssoClientId?[​](#ssoclientid "Direct link to ssoClientId?") > `optional` **ssoClientId**: `string` | `null` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:487](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L487) *** ### teamsManifestAppId?[​](#teamsmanifestappid "Direct link to teamsManifestAppId?") > `optional` **teamsManifestAppId**: `string` | `null` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:486](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L486) *** ### updatedAt[​](#updatedat "Direct link to updatedAt") > **updatedAt**: `string` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:495](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L495) *** ### uuid[​](#uuid "Direct link to uuid") > **uuid**: `string` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:480](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L480) --- # Interface: TeamsCommandConfigResponse Defined in: [packages/sdk/src/types/generated/app\_connection.ts:501](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L501) Response model for a Teams bot command configuration. ## Properties[​](#properties "Direct link to Properties") ### command[​](#command "Direct link to command") > **command**: `string` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:502](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L502) *** ### description[​](#description "Direct link to description") > **description**: `string` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:503](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L503) *** ### workflowId[​](#workflowid "Direct link to workflowId") > **workflowId**: `number` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:504](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L504) --- # Interface: TemplateContextRequest Defined in: [packages/sdk/src/api/templates.ts:16](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/templates.ts#L16) Parameters for requesting template context. ## Properties[​](#properties "Direct link to Properties") ### dataTypeId?[​](#datatypeid "Direct link to dataTypeId?") > `optional` **dataTypeId**: `number` Defined in: [packages/sdk/src/api/templates.ts:19](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/templates.ts#L19) *** ### eventType?[​](#eventtype "Direct link to eventType?") > `optional` **eventType**: `string` Defined in: [packages/sdk/src/api/templates.ts:20](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/templates.ts#L20) *** ### objectType?[​](#objecttype "Direct link to objectType?") > `optional` **objectType**: `string` Defined in: [packages/sdk/src/api/templates.ts:21](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/templates.ts#L21) *** ### taskId?[​](#taskid "Direct link to taskId?") > `optional` **taskId**: `number` Defined in: [packages/sdk/src/api/templates.ts:18](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/templates.ts#L18) *** ### workflowId?[​](#workflowid "Direct link to workflowId?") > `optional` **workflowId**: `number` Defined in: [packages/sdk/src/api/templates.ts:17](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/templates.ts#L17) --- # Interface: TemplateContextResponse Defined in: [packages/sdk/src/api/templates.ts:27](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/templates.ts#L27) Response containing available template variables and namespaces. ## Properties[​](#properties "Direct link to Properties") ### namespaces[​](#namespaces "Direct link to namespaces") > **namespaces**: `string`\[] Defined in: [packages/sdk/src/api/templates.ts:29](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/templates.ts#L29) *** ### sampleContext[​](#samplecontext "Direct link to sampleContext") > **sampleContext**: `Record`<`string`, `any`> Defined in: [packages/sdk/src/api/templates.ts:30](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/templates.ts#L30) *** ### variables[​](#variables "Direct link to variables") > **variables**: [`TemplateVariable`](https://docs.gravityrail.com/sdk/interfaces/TemplateVariable.md)\[] Defined in: [packages/sdk/src/api/templates.ts:28](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/templates.ts#L28) --- # Interface: TemplatePreviewRequest Defined in: [packages/sdk/src/api/templates.ts:36](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/templates.ts#L36) Parameters for requesting a template preview. ## Properties[​](#properties "Direct link to Properties") ### dataTypeId?[​](#datatypeid "Direct link to dataTypeId?") > `optional` **dataTypeId**: `number` Defined in: [packages/sdk/src/api/templates.ts:40](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/templates.ts#L40) *** ### eventType?[​](#eventtype "Direct link to eventType?") > `optional` **eventType**: `string` Defined in: [packages/sdk/src/api/templates.ts:41](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/templates.ts#L41) *** ### objectType?[​](#objecttype "Direct link to objectType?") > `optional` **objectType**: `string` Defined in: [packages/sdk/src/api/templates.ts:42](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/templates.ts#L42) *** ### taskId?[​](#taskid "Direct link to taskId?") > `optional` **taskId**: `number` Defined in: [packages/sdk/src/api/templates.ts:39](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/templates.ts#L39) *** ### template[​](#template "Direct link to template") > **template**: `string` Defined in: [packages/sdk/src/api/templates.ts:37](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/templates.ts#L37) *** ### workflowId?[​](#workflowid "Direct link to workflowId?") > `optional` **workflowId**: `number` Defined in: [packages/sdk/src/api/templates.ts:38](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/templates.ts#L38) --- # Interface: TemplatePreviewResponse Defined in: [packages/sdk/src/api/templates.ts:48](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/templates.ts#L48) Response containing rendered template and any errors. ## Properties[​](#properties "Direct link to Properties") ### errors[​](#errors "Direct link to errors") > **errors**: `string`\[] Defined in: [packages/sdk/src/api/templates.ts:50](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/templates.ts#L50) *** ### rendered[​](#rendered "Direct link to rendered") > **rendered**: `string` Defined in: [packages/sdk/src/api/templates.ts:49](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/templates.ts#L49) --- # Interface: TemplateVariable Defined in: [packages/sdk/src/api/templates.ts:6](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/templates.ts#L6) A template variable available for autocomplete. ## Properties[​](#properties "Direct link to Properties") ### description[​](#description "Direct link to description") > **description**: `string` Defined in: [packages/sdk/src/api/templates.ts:9](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/templates.ts#L9) *** ### path[​](#path "Direct link to path") > **path**: `string` Defined in: [packages/sdk/src/api/templates.ts:7](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/templates.ts#L7) *** ### sampleValue[​](#samplevalue "Direct link to sampleValue") > **sampleValue**: `any` Defined in: [packages/sdk/src/api/templates.ts:10](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/templates.ts#L10) *** ### type[​](#type "Direct link to type") > **type**: `string` Defined in: [packages/sdk/src/api/templates.ts:8](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/templates.ts#L8) --- # Interface: TestChatRunResponse Defined in: [packages/sdk/src/types/generated/qualification.ts:230](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/qualification.ts#L230) Response model for a test chat run with nested criterion results. `scenarioId` is optional — NULL means ad-hoc (no scenario linkage, no grading). ## Properties[​](#properties "Direct link to Properties") ### assignmentId?[​](#assignmentid "Direct link to assignmentId?") > `optional` **assignmentId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/qualification.ts:238](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/qualification.ts#L238) *** ### assistantChatModelId?[​](#assistantchatmodelid "Direct link to assistantChatModelId?") > `optional` **assistantChatModelId**: `string` | `null` Defined in: [packages/sdk/src/types/generated/qualification.ts:248](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/qualification.ts#L248) *** ### assistantRealtimeModelId?[​](#assistantrealtimemodelid "Direct link to assistantRealtimeModelId?") > `optional` **assistantRealtimeModelId**: `string` | `null` Defined in: [packages/sdk/src/types/generated/qualification.ts:249](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/qualification.ts#L249) *** ### chatId?[​](#chatid "Direct link to chatId?") > `optional` **chatId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/qualification.ts:237](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/qualification.ts#L237) *** ### completedAt?[​](#completedat "Direct link to completedAt?") > `optional` **completedAt**: `string` | `null` Defined in: [packages/sdk/src/types/generated/qualification.ts:242](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/qualification.ts#L242) *** ### createdAt[​](#createdat "Direct link to createdAt") > **createdAt**: `string` Defined in: [packages/sdk/src/types/generated/qualification.ts:252](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/qualification.ts#L252) *** ### criterionResults?[​](#criterionresults "Direct link to criterionResults?") > `optional` **criterionResults**: [`CriterionResultResponse`](https://docs.gravityrail.com/sdk/interfaces/CriterionResultResponse.md)\[] Defined in: [packages/sdk/src/types/generated/qualification.ts:251](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/qualification.ts#L251) *** ### driverMemberId?[​](#drivermemberid "Direct link to driverMemberId?") > `optional` **driverMemberId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/qualification.ts:239](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/qualification.ts#L239) *** ### driverMemberName?[​](#drivermembername "Direct link to driverMemberName?") > `optional` **driverMemberName**: `string` | `null` Defined in: [packages/sdk/src/types/generated/qualification.ts:240](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/qualification.ts#L240) *** ### evaluatedAt?[​](#evaluatedat "Direct link to evaluatedAt?") > `optional` **evaluatedAt**: `string` | `null` Defined in: [packages/sdk/src/types/generated/qualification.ts:247](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/qualification.ts#L247) *** ### failedAt?[​](#failedat "Direct link to failedAt?") > `optional` **failedAt**: `string` | `null` Defined in: [packages/sdk/src/types/generated/qualification.ts:243](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/qualification.ts#L243) *** ### failureReason?[​](#failurereason "Direct link to failureReason?") > `optional` **failureReason**: `string` | `null` Defined in: [packages/sdk/src/types/generated/qualification.ts:244](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/qualification.ts#L244) *** ### id[​](#id "Direct link to id") > **id**: `number` Defined in: [packages/sdk/src/types/generated/qualification.ts:231](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/qualification.ts#L231) *** ### overallScore?[​](#overallscore "Direct link to overallScore?") > `optional` **overallScore**: `number` | `null` Defined in: [packages/sdk/src/types/generated/qualification.ts:245](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/qualification.ts#L245) *** ### passed?[​](#passed "Direct link to passed?") > `optional` **passed**: `boolean` | `null` Defined in: [packages/sdk/src/types/generated/qualification.ts:246](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/qualification.ts#L246) *** ### scenarioId?[​](#scenarioid "Direct link to scenarioId?") > `optional` **scenarioId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/qualification.ts:234](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/qualification.ts#L234) *** ### scenarioName?[​](#scenarioname "Direct link to scenarioName?") > `optional` **scenarioName**: `string` | `null` Defined in: [packages/sdk/src/types/generated/qualification.ts:236](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/qualification.ts#L236) *** ### scenarioSlug?[​](#scenarioslug "Direct link to scenarioSlug?") > `optional` **scenarioSlug**: `string` | `null` Defined in: [packages/sdk/src/types/generated/qualification.ts:235](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/qualification.ts#L235) *** ### startedAt[​](#startedat "Direct link to startedAt") > **startedAt**: `string` Defined in: [packages/sdk/src/types/generated/qualification.ts:241](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/qualification.ts#L241) *** ### timingSummary?[​](#timingsummary "Direct link to timingSummary?") > `optional` **timingSummary**: `TestChatRunResponseTimingSummary` Defined in: [packages/sdk/src/types/generated/qualification.ts:250](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/qualification.ts#L250) *** ### updatedAt[​](#updatedat "Direct link to updatedAt") > **updatedAt**: `string` Defined in: [packages/sdk/src/types/generated/qualification.ts:253](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/qualification.ts#L253) *** ### uuid[​](#uuid "Direct link to uuid") > **uuid**: `string` Defined in: [packages/sdk/src/types/generated/qualification.ts:232](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/qualification.ts#L232) *** ### workflowId[​](#workflowid "Direct link to workflowId") > **workflowId**: `number` Defined in: [packages/sdk/src/types/generated/qualification.ts:233](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/qualification.ts#L233) --- # Interface: TestConnectionResponse Defined in: [packages/sdk/src/types/generated/app\_connection.ts:530](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L530) Response model for connection test. ## Properties[​](#properties "Direct link to Properties") ### message[​](#message "Direct link to message") > **message**: `string` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:532](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L532) *** ### success[​](#success "Direct link to success") > **success**: `boolean` Defined in: [packages/sdk/src/types/generated/app\_connection.ts:531](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L531) --- # Interface: TestWebhookRequest Defined in: [packages/sdk/src/types/event-types.ts:214](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L214) ## Properties[​](#properties "Direct link to Properties") ### payload[​](#payload "Direct link to payload") > **payload**: `Record`<`string`, `unknown`> Defined in: [packages/sdk/src/types/event-types.ts:216](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L216) *** ### signingSecret?[​](#signingsecret "Direct link to signingSecret?") > `optional` **signingSecret**: `string` Defined in: [packages/sdk/src/types/event-types.ts:217](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L217) *** ### webhookUrl[​](#webhookurl "Direct link to webhookUrl") > **webhookUrl**: `string` Defined in: [packages/sdk/src/types/event-types.ts:215](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L215) --- # Interface: TestWebhookResponse Defined in: [packages/sdk/src/types/event-types.ts:220](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L220) ## Properties[​](#properties "Direct link to Properties") ### durationMs[​](#durationms "Direct link to durationMs") > **durationMs**: `number` Defined in: [packages/sdk/src/types/event-types.ts:225](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L225) *** ### errorMessage?[​](#errormessage "Direct link to errorMessage?") > `optional` **errorMessage**: `string` | `null` Defined in: [packages/sdk/src/types/event-types.ts:224](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L224) *** ### responseBody?[​](#responsebody "Direct link to responseBody?") > `optional` **responseBody**: `string` | `null` Defined in: [packages/sdk/src/types/event-types.ts:223](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L223) *** ### statusCode?[​](#statuscode "Direct link to statusCode?") > `optional` **statusCode**: `number` | `null` Defined in: [packages/sdk/src/types/event-types.ts:222](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L222) *** ### success[​](#success "Direct link to success") > **success**: `boolean` Defined in: [packages/sdk/src/types/event-types.ts:221](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L221) --- # Interface: TextContent Defined in: [packages/sdk/src/types/chat-types.ts:190](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L190) ## Properties[​](#properties "Direct link to Properties") ### text[​](#text "Direct link to text") > **text**: `string` Defined in: [packages/sdk/src/types/chat-types.ts:192](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L192) *** ### type[​](#type "Direct link to type") > **type**: `"text"` Defined in: [packages/sdk/src/types/chat-types.ts:191](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L191) --- # Interface: ThemeFeatures Defined in: [packages/sdk/src/types/generated/theme.ts:17](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/theme.ts#L17) Capabilities a theme supports. Lets the builder adapt its UI to the active theme — e.g. hide the Pages tab for a theme that doesn't render CMS pages, or the locale picker for one without i18n. Declared statically per theme in `lib/themes.py` for hard-coded themes, and in the `gravityrail.config.json` manifest for source-site themes (resolved per site). ## Properties[​](#properties "Direct link to Properties") ### admin?[​](#admin "Direct link to admin?") > `optional` **admin**: `boolean` Defined in: [packages/sdk/src/types/generated/theme.ts:33](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/theme.ts#L33) Operator/admin-facing surface rather than a public/member site *** ### apiAccess?[​](#apiaccess "Direct link to apiAccess?") > `optional` **apiAccess**: `boolean` Defined in: [packages/sdk/src/types/generated/theme.ts:27](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/theme.ts#L27) Exposes a runtime API to the rendered site (e.g. grFetch) *** ### auth?[​](#auth "Direct link to auth?") > `optional` **auth**: `boolean` Defined in: [packages/sdk/src/types/generated/theme.ts:29](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/theme.ts#L29) Supports authenticated (logged-in) members at all *** ### darkMode?[​](#darkmode "Direct link to darkMode?") > `optional` **darkMode**: [`ThemeFeaturesDarkMode`](https://docs.gravityrail.com/sdk/type-aliases/ThemeFeaturesDarkMode.md) Defined in: [packages/sdk/src/types/generated/theme.ts:25](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/theme.ts#L25) Color-scheme support *** ### dynamicPages?[​](#dynamicpages "Direct link to dynamicPages?") > `optional` **dynamicPages**: `boolean` Defined in: [packages/sdk/src/types/generated/theme.ts:19](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/theme.ts#L19) Renders CMS-style pages (the Pages tab) *** ### i18n?[​](#i18n "Direct link to i18n?") > `optional` **i18n**: `boolean` Defined in: [packages/sdk/src/types/generated/theme.ts:21](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/theme.ts#L21) Renders localized content for multiple locales *** ### locales?[​](#locales "Direct link to locales?") > `optional` **locales**: `string`\[] | `null` Defined in: [packages/sdk/src/types/generated/theme.ts:23](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/theme.ts#L23) Locales the theme constrains itself to; null means it follows the site's configured locales. *** ### scopes?[​](#scopes "Direct link to scopes?") > `optional` **scopes**: `string`\[] Defined in: [packages/sdk/src/types/generated/theme.ts:35](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/theme.ts#L35) Permission scopes the theme relies on to function *** ### signup?[​](#signup "Direct link to signup?") > `optional` **signup**: `boolean` Defined in: [packages/sdk/src/types/generated/theme.ts:31](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/theme.ts#L31) Supports public self-service signup (implies auth) --- # Interface: ThemeResponse Defined in: [packages/sdk/src/types/generated/theme.ts:53](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/theme.ts#L53) Response model for theme information. ## Properties[​](#properties "Direct link to Properties") ### description[​](#description "Direct link to description") > **description**: `string` Defined in: [packages/sdk/src/types/generated/theme.ts:56](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/theme.ts#L56) *** ### features?[​](#features "Direct link to features?") > `optional` **features**: [`ThemeFeatures`](https://docs.gravityrail.com/sdk/interfaces/ThemeFeatures.md) Defined in: [packages/sdk/src/types/generated/theme.ts:57](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/theme.ts#L57) *** ### globalAccess?[​](#globalaccess "Direct link to globalAccess?") > `optional` **globalAccess**: `boolean` | `null` Defined in: [packages/sdk/src/types/generated/theme.ts:59](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/theme.ts#L59) Present on admin theme catalog; omitted for workspace-scoped lists. *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/generated/theme.ts:55](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/theme.ts#L55) *** ### slug[​](#slug "Direct link to slug") > **slug**: `string` Defined in: [packages/sdk/src/types/generated/theme.ts:54](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/theme.ts#L54) --- # Interface: ThemeSettingField Defined in: [packages/sdk/src/types/generated/site.ts:294](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L294) One configurable value a theme declares. ## Properties[​](#properties "Direct link to Properties") ### createDefaults?[​](#createdefaults "Direct link to createDefaults?") > `optional` **createDefaults**: `ThemeSettingFieldCreateDefaults` Defined in: [packages/sdk/src/types/generated/site.ts:312](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L312) For reference fields (e.g. data\_type): a payload matching the entity's create API (DataTypeFormData), used by the field's Create button to scaffold a new entity pre-populated with the theme's defaults. *** ### default?[​](#default "Direct link to default?") > `optional` **default**: `unknown` Defined in: [packages/sdk/src/types/generated/site.ts:306](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L306) Default value used when none is saved *** ### description?[​](#description "Direct link to description?") > `optional` **description**: `string` | `null` Defined in: [packages/sdk/src/types/generated/site.ts:302](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L302) Help text shown under the field *** ### group?[​](#group "Direct link to group?") > `optional` **group**: `string` | `null` Defined in: [packages/sdk/src/types/generated/site.ts:310](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L310) Optional section header to group fields under *** ### key[​](#key "Direct link to key") > **key**: `string` Defined in: [packages/sdk/src/types/generated/site.ts:296](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L296) Machine name; the key under Site.theme\_settings *** ### label[​](#label "Direct link to label") > **label**: `string` Defined in: [packages/sdk/src/types/generated/site.ts:298](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L298) Display label shown in the Theme Settings form *** ### options?[​](#options "Direct link to options?") > `optional` **options**: `EnumOption`\[] | `null` Defined in: [packages/sdk/src/types/generated/site.ts:308](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L308) Choices for a 'select' field *** ### required?[​](#required "Direct link to required?") > `optional` **required**: `boolean` Defined in: [packages/sdk/src/types/generated/site.ts:304](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L304) Whether a value must be set *** ### type[​](#type "Direct link to type") > **type**: [`ThemeSettingFieldType`](https://docs.gravityrail.com/sdk/type-aliases/ThemeSettingFieldType.md) Defined in: [packages/sdk/src/types/generated/site.ts:300](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L300) Field/value type --- # Interface: ThemeSettingsResponse Defined in: [packages/sdk/src/types/generated/site.ts:349](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L349) The active theme's configurable settings, their saved values, and the theme's capabilities — everything the Theme Settings tab needs in one call. `fields` is the declared schema (source-site manifest or hard-coded registry); `values` are the raw saved values keyed by field key (reference fields hold entity ids); `features` are the theme's capabilities. ## Properties[​](#properties "Direct link to Properties") ### features[​](#features "Direct link to features") > **features**: [`ThemeFeatures`](https://docs.gravityrail.com/sdk/interfaces/ThemeFeatures.md) Defined in: [packages/sdk/src/types/generated/site.ts:352](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L352) *** ### fields[​](#fields "Direct link to fields") > **fields**: [`ThemeSettingField`](https://docs.gravityrail.com/sdk/interfaces/ThemeSettingField.md)\[] Defined in: [packages/sdk/src/types/generated/site.ts:350](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L350) *** ### values[​](#values "Direct link to values") > **values**: `ThemeSettingsResponseValues` Defined in: [packages/sdk/src/types/generated/site.ts:351](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L351) --- # Interface: ThemesListResponse Defined in: [packages/sdk/src/types/generated/theme.ts:65](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/theme.ts#L65) Response model for a list of themes. ## Properties[​](#properties "Direct link to Properties") ### items[​](#items "Direct link to items") > **items**: [`ThemeResponse`](https://docs.gravityrail.com/sdk/interfaces/ThemeResponse.md)\[] Defined in: [packages/sdk/src/types/generated/theme.ts:66](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/theme.ts#L66) --- # Interface: ThinkingSoundPreviewRequest Defined in: [packages/sdk/src/api/voice.ts:8](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/voice.ts#L8) ## Properties[​](#properties "Direct link to Properties") ### sound[​](#sound "Direct link to sound") > **sound**: `string` Defined in: [packages/sdk/src/api/voice.ts:9](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/voice.ts#L9) *** ### volume?[​](#volume "Direct link to volume?") > `optional` **volume**: `number` | `null` Defined in: [packages/sdk/src/api/voice.ts:10](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/voice.ts#L10) --- # Interface: TimeSeriesData Defined in: [packages/sdk/src/types/stats-types.ts:34](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/stats-types.ts#L34) ## Properties[​](#properties "Direct link to Properties") ### data[​](#data "Direct link to data") > **data**: [`TimeSeriesDataPoint`](https://docs.gravityrail.com/sdk/interfaces/TimeSeriesDataPoint.md)\[] Defined in: [packages/sdk/src/types/stats-types.ts:35](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/stats-types.ts#L35) *** ### endDate[​](#enddate "Direct link to endDate") > **endDate**: `string` Defined in: [packages/sdk/src/types/stats-types.ts:38](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/stats-types.ts#L38) *** ### period[​](#period "Direct link to period") > **period**: `"day"` | `"week"` | `"month"` | `"year"` | `"hour"` Defined in: [packages/sdk/src/types/stats-types.ts:36](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/stats-types.ts#L36) *** ### startDate[​](#startdate "Direct link to startDate") > **startDate**: `string` Defined in: [packages/sdk/src/types/stats-types.ts:37](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/stats-types.ts#L37) --- # Interface: TimeSeriesDataPoint Defined in: [packages/sdk/src/types/stats-types.ts:28](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/stats-types.ts#L28) ## Properties[​](#properties "Direct link to Properties") ### label?[​](#label "Direct link to label?") > `optional` **label**: `string` Defined in: [packages/sdk/src/types/stats-types.ts:31](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/stats-types.ts#L31) *** ### timestamp[​](#timestamp "Direct link to timestamp") > **timestamp**: `string` Defined in: [packages/sdk/src/types/stats-types.ts:29](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/stats-types.ts#L29) *** ### value[​](#value "Direct link to value") > **value**: `number` Defined in: [packages/sdk/src/types/stats-types.ts:30](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/stats-types.ts#L30) --- # Interface: TimeSlot Defined in: [packages/sdk/src/types/generated/calendar.ts:317](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/calendar.ts#L317) A single time slot range with start and end times. ## Properties[​](#properties "Direct link to Properties") ### endTime[​](#endtime "Direct link to endTime") > **endTime**: `string` Defined in: [packages/sdk/src/types/generated/calendar.ts:319](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/calendar.ts#L319) *** ### startTime[​](#starttime "Direct link to startTime") > **startTime**: `string` Defined in: [packages/sdk/src/types/generated/calendar.ts:318](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/calendar.ts#L318) --- # Interface: TipTapDocumentOutput Defined in: [packages/sdk/src/types/generated/site.ts:372](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L372) TipTap native document structure. Matches the TypeScript interface: { type: 'doc'; content?: Array<{ type: string; attrs?: Record\; content?: any\[]; marks?: Array<{ type: string; attrs?: Record\ }>; text?: string; }>; } ## Indexable[​](#indexable "Direct link to Indexable") \[`key`: `string`]: `unknown` ## Properties[​](#properties "Direct link to Properties") ### content?[​](#content "Direct link to content?") > `optional` **content**: `TipTapNodeOutput`\[] | `null` Defined in: [packages/sdk/src/types/generated/site.ts:374](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L374) *** ### translations?[​](#translations "Direct link to translations?") > `optional` **translations**: `TipTapDocumentOutputTranslations` Defined in: [packages/sdk/src/types/generated/site.ts:375](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L375) *** ### type?[​](#type "Direct link to type?") > `optional` **type**: `"doc"` Defined in: [packages/sdk/src/types/generated/site.ts:373](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L373) --- # Interface: TodoItemResponse Defined in: [packages/sdk/src/types/generated/chat.ts:510](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L510) Response model for a single todo item. ## Properties[​](#properties "Direct link to Properties") ### content[​](#content "Direct link to content") > **content**: `string` Defined in: [packages/sdk/src/types/generated/chat.ts:512](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L512) *** ### id[​](#id "Direct link to id") > **id**: `string` Defined in: [packages/sdk/src/types/generated/chat.ts:511](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L511) *** ### notes?[​](#notes "Direct link to notes?") > `optional` **notes**: `string` | `null` Defined in: [packages/sdk/src/types/generated/chat.ts:514](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L514) *** ### status[​](#status "Direct link to status") > **status**: `string` Defined in: [packages/sdk/src/types/generated/chat.ts:513](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L513) --- # Interface: TodosResponse Defined in: [packages/sdk/src/types/generated/chat.ts:522](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L522) Response model for the agent's todo list state. Sent as a state.TodosResponse custom event to sync todos to the client. ## Properties[​](#properties "Direct link to Properties") ### todos?[​](#todos "Direct link to todos?") > `optional` **todos**: [`TodoItemResponse`](https://docs.gravityrail.com/sdk/interfaces/TodoItemResponse.md)\[] Defined in: [packages/sdk/src/types/generated/chat.ts:523](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L523) --- # Interface: Tool Defined in: [packages/sdk/src/types/generated/toolkit.ts:11](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/toolkit.ts#L11) Tool definition matching MCP format. ## Properties[​](#properties "Direct link to Properties") ### autoEnabled?[​](#autoenabled "Direct link to autoEnabled?") > `optional` **autoEnabled**: `boolean` | `null` Defined in: [packages/sdk/src/types/generated/toolkit.ts:15](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/toolkit.ts#L15) *** ### description?[​](#description "Direct link to description?") > `optional` **description**: `string` | `null` Defined in: [packages/sdk/src/types/generated/toolkit.ts:14](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/toolkit.ts#L14) *** ### displayName[​](#displayname "Direct link to displayName") > **displayName**: `string` Defined in: [packages/sdk/src/types/generated/toolkit.ts:13](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/toolkit.ts#L13) *** ### inputSchema[​](#inputschema "Direct link to inputSchema") > **inputSchema**: [`ToolInputSchema`](https://docs.gravityrail.com/sdk/interfaces/ToolInputSchema.md) Defined in: [packages/sdk/src/types/generated/toolkit.ts:16](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/toolkit.ts#L16) *** ### llmName?[​](#llmname "Direct link to llmName?") > `optional` **llmName**: `string` | `null` Defined in: [packages/sdk/src/types/generated/toolkit.ts:18](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/toolkit.ts#L18) *** ### loaded?[​](#loaded "Direct link to loaded?") > `optional` **loaded**: `boolean` Defined in: [packages/sdk/src/types/generated/toolkit.ts:22](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/toolkit.ts#L22) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/generated/toolkit.ts:12](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/toolkit.ts#L12) *** ### requiresChat?[​](#requireschat "Direct link to requiresChat?") > `optional` **requiresChat**: `boolean` | `null` Defined in: [packages/sdk/src/types/generated/toolkit.ts:19](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/toolkit.ts#L19) *** ### toolMeta?[​](#toolmeta "Direct link to toolMeta?") > `optional` **toolMeta**: `ToolToolMeta` Defined in: [packages/sdk/src/types/generated/toolkit.ts:21](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/toolkit.ts#L21) *** ### toolType?[​](#tooltype "Direct link to toolType?") > `optional` **toolType**: `string` | `null` Defined in: [packages/sdk/src/types/generated/toolkit.ts:20](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/toolkit.ts#L20) *** ### uri?[​](#uri "Direct link to uri?") > `optional` **uri**: `string` | `null` Defined in: [packages/sdk/src/types/generated/toolkit.ts:17](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/toolkit.ts#L17) --- # Interface: ToolCall Defined in: [packages/sdk/src/types/chat-types.ts:173](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L173) ## Properties[​](#properties "Direct link to Properties") ### function[​](#function "Direct link to function") > **function**: [`ToolCallFunction`](https://docs.gravityrail.com/sdk/interfaces/ToolCallFunction.md) Defined in: [packages/sdk/src/types/chat-types.ts:176](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L176) *** ### id[​](#id "Direct link to id") > **id**: `string` Defined in: [packages/sdk/src/types/chat-types.ts:174](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L174) *** ### type[​](#type "Direct link to type") > **type**: `"function"` Defined in: [packages/sdk/src/types/chat-types.ts:175](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L175) --- # Interface: ToolCallFunction Defined in: [packages/sdk/src/types/chat-types.ts:168](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L168) ## Properties[​](#properties "Direct link to Properties") ### arguments[​](#arguments "Direct link to arguments") > **arguments**: `string` Defined in: [packages/sdk/src/types/chat-types.ts:170](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L170) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/chat-types.ts:169](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L169) --- # Interface: ToolInputSchema Defined in: [packages/sdk/src/types/generated/toolkit.ts:28](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/toolkit.ts#L28) Tool input schema matching MCP format. ## Properties[​](#properties "Direct link to Properties") ### additionalProperties?[​](#additionalproperties "Direct link to additionalProperties?") > `optional` **additionalProperties**: `boolean` | `null` Defined in: [packages/sdk/src/types/generated/toolkit.ts:32](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/toolkit.ts#L32) *** ### properties[​](#properties-1 "Direct link to properties") > **properties**: `ToolInputSchemaProperties` Defined in: [packages/sdk/src/types/generated/toolkit.ts:30](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/toolkit.ts#L30) *** ### required[​](#required "Direct link to required") > **required**: `string`\[] Defined in: [packages/sdk/src/types/generated/toolkit.ts:31](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/toolkit.ts#L31) *** ### type?[​](#type "Direct link to type?") > `optional` **type**: `string` Defined in: [packages/sdk/src/types/generated/toolkit.ts:29](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/toolkit.ts#L29) --- # Interface: Toolkit Defined in: [packages/sdk/src/types/generated/toolkit.ts:56](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/toolkit.ts#L56) Toolkit definition containing a group of related tools. ## Properties[​](#properties "Direct link to Properties") ### description?[​](#description "Direct link to description?") > `optional` **description**: `string` | `null` Defined in: [packages/sdk/src/types/generated/toolkit.ts:59](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/toolkit.ts#L59) *** ### displayName[​](#displayname "Direct link to displayName") > **displayName**: `string` Defined in: [packages/sdk/src/types/generated/toolkit.ts:58](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/toolkit.ts#L58) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/generated/toolkit.ts:57](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/toolkit.ts#L57) *** ### state[​](#state "Direct link to state") > **state**: `string` Defined in: [packages/sdk/src/types/generated/toolkit.ts:61](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/toolkit.ts#L61) *** ### tools[​](#tools "Direct link to tools") > **tools**: [`Tool`](https://docs.gravityrail.com/sdk/interfaces/Tool.md)\[] Defined in: [packages/sdk/src/types/generated/toolkit.ts:62](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/toolkit.ts#L62) *** ### type[​](#type "Direct link to type") > **type**: `string` Defined in: [packages/sdk/src/types/generated/toolkit.ts:60](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/toolkit.ts#L60) --- # Interface: ToolkitContext Defined in: [packages/sdk/src/app-context.ts:55](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/app-context.ts#L55) Information about a toolkit in the context ## Properties[​](#properties "Direct link to Properties") ### id[​](#id "Direct link to id") > **id**: `string` Defined in: [packages/sdk/src/app-context.ts:56](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/app-context.ts#L56) *** ### name?[​](#name "Direct link to name?") > `optional` **name**: `string` Defined in: [packages/sdk/src/app-context.ts:57](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/app-context.ts#L57) --- # Interface: ToolkitsAbilityConfig Defined in: [packages/sdk/src/types/ability-types.ts:148](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ability-types.ts#L148) Config for toolkits ability ## Properties[​](#properties "Direct link to Properties") ### tools[​](#tools "Direct link to tools") > **tools**: `string`\[] Defined in: [packages/sdk/src/types/ability-types.ts:150](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ability-types.ts#L150) List of tool names to add to the agent --- # Interface: ToolkitsResponse Defined in: [packages/sdk/src/types/generated/toolkit.ts:68](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/toolkit.ts#L68) Response containing available toolkits for workspace. ## Properties[​](#properties "Direct link to Properties") ### toolkits[​](#toolkits "Direct link to toolkits") > **toolkits**: [`Toolkit`](https://docs.gravityrail.com/sdk/interfaces/Toolkit.md)\[] Defined in: [packages/sdk/src/types/generated/toolkit.ts:69](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/toolkit.ts#L69) --- # Interface: ToolParameter Defined in: [packages/sdk/src/types/toolkit-types.ts:28](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/toolkit-types.ts#L28) ## Properties[​](#properties "Direct link to Properties") ### default?[​](#default "Direct link to default?") > `optional` **default**: `any` Defined in: [packages/sdk/src/types/toolkit-types.ts:34](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/toolkit-types.ts#L34) *** ### description[​](#description "Direct link to description") > **description**: `string` Defined in: [packages/sdk/src/types/toolkit-types.ts:31](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/toolkit-types.ts#L31) *** ### enum?[​](#enum "Direct link to enum?") > `optional` **enum**: `string`\[] Defined in: [packages/sdk/src/types/toolkit-types.ts:33](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/toolkit-types.ts#L33) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/toolkit-types.ts:29](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/toolkit-types.ts#L29) *** ### required?[​](#required "Direct link to required?") > `optional` **required**: `boolean` Defined in: [packages/sdk/src/types/toolkit-types.ts:32](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/toolkit-types.ts#L32) *** ### type[​](#type "Direct link to type") > **type**: `string` Defined in: [packages/sdk/src/types/toolkit-types.ts:30](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/toolkit-types.ts#L30) --- # Interface: ToolResponse Defined in: [packages/sdk/src/types/generated/toolkit.ts:40](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/toolkit.ts#L40) Response containing details for a single tool lookup. ## Properties[​](#properties "Direct link to Properties") ### description?[​](#description "Direct link to description?") > `optional` **description**: `string` | `null` Defined in: [packages/sdk/src/types/generated/toolkit.ts:43](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/toolkit.ts#L43) *** ### displayName[​](#displayname "Direct link to displayName") > **displayName**: `string` Defined in: [packages/sdk/src/types/generated/toolkit.ts:42](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/toolkit.ts#L42) *** ### llmName?[​](#llmname "Direct link to llmName?") > `optional` **llmName**: `string` | `null` Defined in: [packages/sdk/src/types/generated/toolkit.ts:48](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/toolkit.ts#L48) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/generated/toolkit.ts:41](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/toolkit.ts#L41) *** ### toolkit[​](#toolkit "Direct link to toolkit") > **toolkit**: `string` Defined in: [packages/sdk/src/types/generated/toolkit.ts:44](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/toolkit.ts#L44) *** ### toolkitDisplayName[​](#toolkitdisplayname "Direct link to toolkitDisplayName") > **toolkitDisplayName**: `string` Defined in: [packages/sdk/src/types/generated/toolkit.ts:45](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/toolkit.ts#L45) *** ### toolType?[​](#tooltype "Direct link to toolType?") > `optional` **toolType**: `string` | `null` Defined in: [packages/sdk/src/types/generated/toolkit.ts:46](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/toolkit.ts#L46) *** ### uri?[​](#uri "Direct link to uri?") > `optional` **uri**: `string` | `null` Defined in: [packages/sdk/src/types/generated/toolkit.ts:47](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/toolkit.ts#L47) --- # Interface: ToolResult Defined in: [packages/sdk/src/types/chat-types.ts:179](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L179) ## Properties[​](#properties "Direct link to Properties") ### output[​](#output "Direct link to output") > **output**: `string` | { `data`: `unknown`; `type`: `string`; } Defined in: [packages/sdk/src/types/chat-types.ts:181](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L181) *** ### tool\_call\_id[​](#tool_call_id "Direct link to tool_call_id") > **tool\_call\_id**: `string` Defined in: [packages/sdk/src/types/chat-types.ts:180](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L180) --- # Interface: ToolsResponse Defined in: [packages/sdk/src/types/generated/toolkit.ts:75](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/toolkit.ts#L75) Response containing available tools for a chat. ## Properties[​](#properties "Direct link to Properties") ### tools[​](#tools "Direct link to tools") > **tools**: [`Tool`](https://docs.gravityrail.com/sdk/interfaces/Tool.md)\[] Defined in: [packages/sdk/src/types/generated/toolkit.ts:76](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/toolkit.ts#L76) --- # Interface: TopOffender Defined in: [packages/sdk/src/types/health-dashboard-types.ts:31](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/health-dashboard-types.ts#L31) ## Properties[​](#properties "Direct link to Properties") ### failureCount[​](#failurecount "Direct link to failureCount") > **failureCount**: `number` Defined in: [packages/sdk/src/types/health-dashboard-types.ts:35](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/health-dashboard-types.ts#L35) *** ### id[​](#id "Direct link to id") > **id**: `number` Defined in: [packages/sdk/src/types/health-dashboard-types.ts:32](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/health-dashboard-types.ts#L32) *** ### identifier[​](#identifier "Direct link to identifier") > **identifier**: `string` | `null` Defined in: [packages/sdk/src/types/health-dashboard-types.ts:34](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/health-dashboard-types.ts#L34) *** ### name[​](#name "Direct link to name") > **name**: `string` | `null` Defined in: [packages/sdk/src/types/health-dashboard-types.ts:33](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/health-dashboard-types.ts#L33) --- # Interface: TopResourceOverageResponse Defined in: [packages/sdk/src/types/generated/usage.ts:217](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/usage.ts#L217) Top resource overage summary. ## Properties[​](#properties "Direct link to Properties") ### overageCostCents[​](#overagecostcents "Direct link to overageCostCents") > **overageCostCents**: `number` Defined in: [packages/sdk/src/types/generated/usage.ts:219](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/usage.ts#L219) *** ### resource[​](#resource "Direct link to resource") > **resource**: `string` Defined in: [packages/sdk/src/types/generated/usage.ts:218](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/usage.ts#L218) --- # Interface: TOTPSetupResponse Defined in: [packages/sdk/src/types/generated/account.ts:346](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L346) Response for TOTP setup initiation ## Properties[​](#properties "Direct link to Properties") ### issuer[​](#issuer "Direct link to issuer") > **issuer**: `string` Defined in: [packages/sdk/src/types/generated/account.ts:356](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L356) Issuer name for TOTP *** ### manualEntryKey[​](#manualentrykey "Direct link to manualEntryKey") > **manualEntryKey**: `string` Defined in: [packages/sdk/src/types/generated/account.ts:354](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L354) Manual entry key for authenticator apps *** ### qrCodeUrl[​](#qrcodeurl "Direct link to qrCodeUrl") > **qrCodeUrl**: `string` Defined in: [packages/sdk/src/types/generated/account.ts:352](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L352) QR code URL for easy setup *** ### secret[​](#secret "Direct link to secret") > **secret**: `string` Defined in: [packages/sdk/src/types/generated/account.ts:350](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L350) Base32 encoded TOTP secret *** ### setupId[​](#setupid "Direct link to setupId") > **setupId**: `string` Defined in: [packages/sdk/src/types/generated/account.ts:348](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L348) Session ID for completing setup --- # Interface: TransformPreset Defined in: [packages/sdk/src/types/app-connection-types.ts:167](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L167) ## Properties[​](#properties "Direct link to Properties") ### description[​](#description "Direct link to description") > **description**: `string` Defined in: [packages/sdk/src/types/app-connection-types.ts:170](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L170) *** ### expression[​](#expression "Direct link to expression") > **expression**: `string` Defined in: [packages/sdk/src/types/app-connection-types.ts:171](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L171) *** ### label[​](#label "Direct link to label") > **label**: `string` Defined in: [packages/sdk/src/types/app-connection-types.ts:169](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L169) *** ### slug[​](#slug "Direct link to slug") > **slug**: `string` Defined in: [packages/sdk/src/types/app-connection-types.ts:168](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L168) --- # Interface: TriggerConnectionBackfillRequest Defined in: [packages/sdk/src/types/fhir-connection-types.ts:349](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L349) Request to run a manual connection-wide backfill across linked patients. ## Properties[​](#properties "Direct link to Properties") ### lookbackDays?[​](#lookbackdays "Direct link to lookbackDays?") > `optional` **lookbackDays**: `number` Defined in: [packages/sdk/src/types/fhir-connection-types.ts:350](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L350) --- # Interface: TriggerPatientRefreshRequest Defined in: [packages/sdk/src/types/fhir-connection-types.ts:338](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L338) Request to refresh a single linked patient's encounter cache on demand. ## Properties[​](#properties "Direct link to Properties") ### force?[​](#force "Direct link to force?") > `optional` **force**: `boolean` Defined in: [packages/sdk/src/types/fhir-connection-types.ts:343](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L343) When true, bypass the freshness TTL (operator-initiated repair). *** ### lookbackDays?[​](#lookbackdays "Direct link to lookbackDays?") > `optional` **lookbackDays**: `number` Defined in: [packages/sdk/src/types/fhir-connection-types.ts:341](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L341) *** ### memberId[​](#memberid "Direct link to memberId") > **memberId**: `number` Defined in: [packages/sdk/src/types/fhir-connection-types.ts:339](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L339) *** ### patientId[​](#patientid "Direct link to patientId") > **patientId**: `string` Defined in: [packages/sdk/src/types/fhir-connection-types.ts:340](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L340) --- # Interface: TTSModelResponse Defined in: [packages/sdk/src/types/generated/ai\_model.ts:199](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/ai_model.ts#L199) Response model for a text-to-speech model. ## Properties[​](#properties "Direct link to Properties") ### available?[​](#available "Direct link to available?") > `optional` **available**: `boolean` Defined in: [packages/sdk/src/types/generated/ai\_model.ts:206](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/ai_model.ts#L206) *** ### description?[​](#description "Direct link to description?") > `optional` **description**: `string` | `null` Defined in: [packages/sdk/src/types/generated/ai\_model.ts:204](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/ai_model.ts#L204) *** ### id[​](#id "Direct link to id") > **id**: `string` Defined in: [packages/sdk/src/types/generated/ai\_model.ts:200](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/ai_model.ts#L200) *** ### multiplier?[​](#multiplier "Direct link to multiplier?") > `optional` **multiplier**: `number` Defined in: [packages/sdk/src/types/generated/ai\_model.ts:209](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/ai_model.ts#L209) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/generated/ai\_model.ts:201](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/ai_model.ts#L201) *** ### provider[​](#provider "Direct link to provider") > **provider**: [`ModelProvider`](https://docs.gravityrail.com/sdk/type-aliases/ModelProvider.md) Defined in: [packages/sdk/src/types/generated/ai\_model.ts:202](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/ai_model.ts#L202) *** ### recommended?[​](#recommended "Direct link to recommended?") > `optional` **recommended**: `boolean` Defined in: [packages/sdk/src/types/generated/ai\_model.ts:207](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/ai_model.ts#L207) *** ### replacement?[​](#replacement "Direct link to replacement?") > `optional` **replacement**: `string` | `null` Defined in: [packages/sdk/src/types/generated/ai\_model.ts:208](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/ai_model.ts#L208) *** ### state?[​](#state "Direct link to state?") > `optional` **state**: `string` Defined in: [packages/sdk/src/types/generated/ai\_model.ts:205](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/ai_model.ts#L205) *** ### type?[​](#type "Direct link to type?") > `optional` **type**: [`ModelType`](https://docs.gravityrail.com/sdk/type-aliases/ModelType.md) Defined in: [packages/sdk/src/types/generated/ai\_model.ts:203](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/ai_model.ts#L203) --- # Interface: TTSPreviewRequest Defined in: [packages/sdk/src/api/voice.ts:3](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/voice.ts#L3) ## Properties[​](#properties "Direct link to Properties") ### phrase?[​](#phrase "Direct link to phrase?") > `optional` **phrase**: `string` Defined in: [packages/sdk/src/api/voice.ts:5](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/voice.ts#L5) *** ### voiceModel[​](#voicemodel "Direct link to voiceModel") > **voiceModel**: `string` Defined in: [packages/sdk/src/api/voice.ts:4](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/voice.ts#L4) --- # Interface: TTSProviderSummary Defined in: [packages/sdk/src/types/generated/reports.ts:179](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/reports.ts#L179) Summary statistics for a TTS provider. ## Properties[​](#properties "Direct link to Properties") ### model[​](#model "Direct link to model") > **model**: `string` Defined in: [packages/sdk/src/types/generated/reports.ts:181](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/reports.ts#L181) *** ### provider[​](#provider "Direct link to provider") > **provider**: `string` Defined in: [packages/sdk/src/types/generated/reports.ts:180](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/reports.ts#L180) *** ### totalCharacters[​](#totalcharacters "Direct link to totalCharacters") > **totalCharacters**: `number` Defined in: [packages/sdk/src/types/generated/reports.ts:182](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/reports.ts#L182) *** ### totalMessages[​](#totalmessages "Direct link to totalMessages") > **totalMessages**: `number` Defined in: [packages/sdk/src/types/generated/reports.ts:183](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/reports.ts#L183) --- # Interface: TTSUsageRow Defined in: [packages/sdk/src/types/generated/reports.ts:189](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/reports.ts#L189) TTS usage for a specific date and provider/model combination. ## Properties[​](#properties "Direct link to Properties") ### date[​](#date "Direct link to date") > **date**: `string` Defined in: [packages/sdk/src/types/generated/reports.ts:190](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/reports.ts#L190) *** ### messageCount[​](#messagecount "Direct link to messageCount") > **messageCount**: `number` Defined in: [packages/sdk/src/types/generated/reports.ts:193](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/reports.ts#L193) *** ### model[​](#model "Direct link to model") > **model**: `string` Defined in: [packages/sdk/src/types/generated/reports.ts:192](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/reports.ts#L192) *** ### provider[​](#provider "Direct link to provider") > **provider**: `string` Defined in: [packages/sdk/src/types/generated/reports.ts:191](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/reports.ts#L191) *** ### totalCharacters[​](#totalcharacters "Direct link to totalCharacters") > **totalCharacters**: `number` Defined in: [packages/sdk/src/types/generated/reports.ts:194](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/reports.ts#L194) --- # Interface: TwoFactorOperationResponse Defined in: [packages/sdk/src/types/generated/account.ts:374](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L374) Generic response for 2FA operations ## Properties[​](#properties "Direct link to Properties") ### message[​](#message "Direct link to message") > **message**: `string` Defined in: [packages/sdk/src/types/generated/account.ts:378](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L378) Human-readable message *** ### methodId?[​](#methodid "Direct link to methodId?") > `optional` **methodId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/account.ts:380](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L380) ID of the affected 2FA method *** ### success[​](#success "Direct link to success") > **success**: `boolean` Defined in: [packages/sdk/src/types/generated/account.ts:376](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/account.ts#L376) Whether the operation was successful --- # Interface: UIChoiceDecision Defined in: [packages/sdk/src/types/chat-types.ts:350](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L350) ## Properties[​](#properties "Direct link to Properties") ### chosenValue[​](#chosenvalue "Direct link to chosenValue") > **chosenValue**: `string` Defined in: [packages/sdk/src/types/chat-types.ts:351](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L351) *** ### interruptId?[​](#interruptid "Direct link to interruptId?") > `optional` **interruptId**: `string` Defined in: [packages/sdk/src/types/chat-types.ts:352](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L352) --- # Interface: UnauthorizedSiteResponse Defined in: [packages/sdk/src/types/generated/site.ts:406](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L406) ## Properties[​](#properties "Direct link to Properties") ### allowSignup?[​](#allowsignup "Direct link to allowSignup?") > `optional` **allowSignup**: `boolean` Defined in: [packages/sdk/src/types/generated/site.ts:423](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L423) *** ### assetsFolderId?[​](#assetsfolderid "Direct link to assetsFolderId?") > `optional` **assetsFolderId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/site.ts:411](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L411) *** ### authorized[​](#authorized "Direct link to authorized") > **authorized**: `boolean` Defined in: [packages/sdk/src/types/generated/site.ts:418](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L418) *** ### availableLocales?[​](#availablelocales "Direct link to availableLocales?") > `optional` **availableLocales**: `string`\[] Defined in: [packages/sdk/src/types/generated/site.ts:455](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L455) *** ### content[​](#content "Direct link to content") > **content**: `string` Defined in: [packages/sdk/src/types/generated/site.ts:417](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L417) *** ### crawl?[​](#crawl "Direct link to crawl?") > `optional` **crawl**: `boolean` Defined in: [packages/sdk/src/types/generated/site.ts:438](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L438) *** ### crawlCompleted?[​](#crawlcompleted "Direct link to crawlCompleted?") > `optional` **crawlCompleted**: `number` | `null` Defined in: [packages/sdk/src/types/generated/site.ts:442](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L442) *** ### crawlCompletedAt?[​](#crawlcompletedat "Direct link to crawlCompletedAt?") > `optional` **crawlCompletedAt**: `string` | `null` Defined in: [packages/sdk/src/types/generated/site.ts:441](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L441) *** ### crawlError?[​](#crawlerror "Direct link to crawlError?") > `optional` **crawlError**: `string` | `null` Defined in: [packages/sdk/src/types/generated/site.ts:444](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L444) *** ### crawlExcludedTags?[​](#crawlexcludedtags "Direct link to crawlExcludedTags?") > `optional` **crawlExcludedTags**: `string`\[] Defined in: [packages/sdk/src/types/generated/site.ts:445](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L445) *** ### crawlFailedAt?[​](#crawlfailedat "Direct link to crawlFailedAt?") > `optional` **crawlFailedAt**: `string` | `null` Defined in: [packages/sdk/src/types/generated/site.ts:443](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L443) *** ### crawlJobId?[​](#crawljobid "Direct link to crawlJobId?") > `optional` **crawlJobId**: `string` | `null` Defined in: [packages/sdk/src/types/generated/site.ts:446](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L446) *** ### crawlLimit?[​](#crawllimit "Direct link to crawlLimit?") > `optional` **crawlLimit**: `number` | `null` Defined in: [packages/sdk/src/types/generated/site.ts:448](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L448) *** ### crawlPrevious?[​](#crawlprevious "Direct link to crawlPrevious?") > `optional` **crawlPrevious**: `number` | `null` Defined in: [packages/sdk/src/types/generated/site.ts:447](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L447) *** ### crawlStartedAt?[​](#crawlstartedat "Direct link to crawlStartedAt?") > `optional` **crawlStartedAt**: `string` | `null` Defined in: [packages/sdk/src/types/generated/site.ts:440](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L440) *** ### crawlUrl?[​](#crawlurl "Direct link to crawlUrl?") > `optional` **crawlUrl**: `string` | `null` Defined in: [packages/sdk/src/types/generated/site.ts:439](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L439) *** ### createdAt[​](#createdat "Direct link to createdAt") > **createdAt**: `string` Defined in: [packages/sdk/src/types/generated/site.ts:428](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L428) *** ### customDomain?[​](#customdomain "Direct link to customDomain?") > `optional` **customDomain**: `string` | `null` Defined in: [packages/sdk/src/types/generated/site.ts:421](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L421) *** ### defaultUrl?[​](#defaulturl "Direct link to defaultUrl?") > `optional` **defaultUrl**: `string` | `null` Defined in: [packages/sdk/src/types/generated/site.ts:437](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L437) *** ### defaultWorkflowId?[​](#defaultworkflowid "Direct link to defaultWorkflowId?") > `optional` **defaultWorkflowId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/site.ts:434](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L434) *** ### googleAdwordsId?[​](#googleadwordsid "Direct link to googleAdwordsId?") > `optional` **googleAdwordsId**: `string` | `null` Defined in: [packages/sdk/src/types/generated/site.ts:450](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L450) *** ### googleAnalyticsId?[​](#googleanalyticsid "Direct link to googleAnalyticsId?") > `optional` **googleAnalyticsId**: `string` | `null` Defined in: [packages/sdk/src/types/generated/site.ts:449](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L449) *** ### homePageId?[​](#homepageid "Direct link to homePageId?") > `optional` **homePageId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/site.ts:435](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L435) *** ### id[​](#id "Direct link to id") > **id**: `number` Defined in: [packages/sdk/src/types/generated/site.ts:407](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L407) *** ### isMapped?[​](#ismapped "Direct link to isMapped?") > `optional` **isMapped**: `boolean` Defined in: [packages/sdk/src/types/generated/site.ts:426](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L426) *** ### isPublic[​](#ispublic "Direct link to isPublic") > **isPublic**: `boolean` Defined in: [packages/sdk/src/types/generated/site.ts:427](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L427) *** ### isReseller[​](#isreseller "Direct link to isReseller") > **isReseller**: `boolean` Defined in: [packages/sdk/src/types/generated/site.ts:430](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L430) *** ### metaDescription[​](#metadescription "Direct link to metaDescription") > **metaDescription**: `string` | `null` Defined in: [packages/sdk/src/types/generated/site.ts:420](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L420) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/generated/site.ts:408](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L408) *** ### organizationLogoUrl?[​](#organizationlogourl "Direct link to organizationLogoUrl?") > `optional` **organizationLogoUrl**: `string` | `null` Defined in: [packages/sdk/src/types/generated/site.ts:453](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L453) *** ### ownerId?[​](#ownerid "Direct link to ownerId?") > `optional` **ownerId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/site.ts:433](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L433) *** ### pageCount?[​](#pagecount "Direct link to pageCount?") > `optional` **pageCount**: `number` | `null` Defined in: [packages/sdk/src/types/generated/site.ts:456](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L456) *** ### permissions?[​](#permissions "Direct link to permissions?") > `optional` **permissions**: `number` Defined in: [packages/sdk/src/types/generated/site.ts:451](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L451) *** ### primaryLocale?[​](#primarylocale "Direct link to primaryLocale?") > `optional` **primaryLocale**: `string` Defined in: [packages/sdk/src/types/generated/site.ts:454](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L454) *** ### redirectUrl[​](#redirecturl "Direct link to redirectUrl") > **redirectUrl**: `string` | `null` Defined in: [packages/sdk/src/types/generated/site.ts:422](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L422) *** ### resolvedThemeSettings?[​](#resolvedthemesettings "Direct link to resolvedThemeSettings?") > `optional` **resolvedThemeSettings**: `UnauthorizedSiteResponseResolvedThemeSettings` Defined in: [packages/sdk/src/types/generated/site.ts:416](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L416) *** ### signupMemberRoleId?[​](#signupmemberroleid "Direct link to signupMemberRoleId?") > `optional` **signupMemberRoleId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/site.ts:424](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L424) *** ### signupMemberRoleName?[​](#signupmemberrolename "Direct link to signupMemberRoleName?") > `optional` **signupMemberRoleName**: `string` | `null` Defined in: [packages/sdk/src/types/generated/site.ts:425](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L425) *** ### slug[​](#slug "Direct link to slug") > **slug**: `string` Defined in: [packages/sdk/src/types/generated/site.ts:410](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L410) *** ### sourceFolderId?[​](#sourcefolderid "Direct link to sourceFolderId?") > `optional` **sourceFolderId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/site.ts:412](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L412) *** ### sourceReleaseId?[​](#sourcereleaseid "Direct link to sourceReleaseId?") > `optional` **sourceReleaseId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/site.ts:413](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L413) *** ### tagLine[​](#tagline "Direct link to tagLine") > **tagLine**: `string` | `null` Defined in: [packages/sdk/src/types/generated/site.ts:419](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L419) *** ### theme[​](#theme "Direct link to theme") > **theme**: `UnauthorizedSiteResponseTheme` Defined in: [packages/sdk/src/types/generated/site.ts:414](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L414) *** ### themeSettings?[​](#themesettings "Direct link to themeSettings?") > `optional` **themeSettings**: `UnauthorizedSiteResponseThemeSettings` Defined in: [packages/sdk/src/types/generated/site.ts:415](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L415) *** ### updatedAt[​](#updatedat "Direct link to updatedAt") > **updatedAt**: `string` Defined in: [packages/sdk/src/types/generated/site.ts:429](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L429) *** ### url?[​](#url "Direct link to url?") > `optional` **url**: `string` | `null` Defined in: [packages/sdk/src/types/generated/site.ts:436](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L436) *** ### uuid[​](#uuid "Direct link to uuid") > **uuid**: `string` Defined in: [packages/sdk/src/types/generated/site.ts:409](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L409) *** ### widgetOrigins?[​](#widgetorigins "Direct link to widgetOrigins?") > `optional` **widgetOrigins**: `string`\[] | `null` Defined in: [packages/sdk/src/types/generated/site.ts:452](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L452) *** ### workspaceName?[​](#workspacename "Direct link to workspaceName?") > `optional` **workspaceName**: `string` Defined in: [packages/sdk/src/types/generated/site.ts:431](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L431) *** ### workspaceUuid?[​](#workspaceuuid "Direct link to workspaceUuid?") > `optional` **workspaceUuid**: `string` | `null` Defined in: [packages/sdk/src/types/generated/site.ts:432](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L432) --- # Interface: UnlinkCalendarResponse Defined in: [packages/sdk/src/types/calendar-types.ts:198](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/calendar-types.ts#L198) ## Properties[​](#properties "Direct link to Properties") ### message[​](#message "Direct link to message") > **message**: `string` Defined in: [packages/sdk/src/types/calendar-types.ts:200](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/calendar-types.ts#L200) *** ### status[​](#status "Direct link to status") > **status**: `string` Defined in: [packages/sdk/src/types/calendar-types.ts:199](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/calendar-types.ts#L199) --- # Interface: UnmappedPhoneNumber Defined in: [packages/sdk/src/types/communication-types.ts:98](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/communication-types.ts#L98) ## Properties[​](#properties "Direct link to Properties") ### brandDescription?[​](#branddescription "Direct link to brandDescription?") > `optional` **brandDescription**: `string` | `null` Defined in: [packages/sdk/src/types/communication-types.ts:104](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/communication-types.ts#L104) *** ### brandName?[​](#brandname "Direct link to brandName?") > `optional` **brandName**: `string` | `null` Defined in: [packages/sdk/src/types/communication-types.ts:103](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/communication-types.ts#L103) *** ### brandWebsite?[​](#brandwebsite "Direct link to brandWebsite?") > `optional` **brandWebsite**: `string` | `null` Defined in: [packages/sdk/src/types/communication-types.ts:105](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/communication-types.ts#L105) *** ### createdAt[​](#createdat "Direct link to createdAt") > **createdAt**: `string` Defined in: [packages/sdk/src/types/communication-types.ts:106](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/communication-types.ts#L106) *** ### enableSms[​](#enablesms "Direct link to enableSms") > **enableSms**: `boolean` Defined in: [packages/sdk/src/types/communication-types.ts:110](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/communication-types.ts#L110) *** ### enableVoice[​](#enablevoice "Direct link to enableVoice") > **enableVoice**: `boolean` Defined in: [packages/sdk/src/types/communication-types.ts:111](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/communication-types.ts#L111) *** ### enableWhatsApp[​](#enablewhatsapp "Direct link to enableWhatsApp") > **enableWhatsApp**: `boolean` Defined in: [packages/sdk/src/types/communication-types.ts:112](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/communication-types.ts#L112) *** ### id[​](#id "Direct link to id") > **id**: `number` Defined in: [packages/sdk/src/types/communication-types.ts:99](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/communication-types.ts#L99) *** ### isMapped[​](#ismapped "Direct link to isMapped") > **isMapped**: `boolean` Defined in: [packages/sdk/src/types/communication-types.ts:113](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/communication-types.ts#L113) *** ### name[​](#name "Direct link to name") > **name**: `string` | `null` Defined in: [packages/sdk/src/types/communication-types.ts:102](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/communication-types.ts#L102) *** ### number[​](#number "Direct link to number") > **number**: `string` Defined in: [packages/sdk/src/types/communication-types.ts:101](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/communication-types.ts#L101) *** ### updatedAt[​](#updatedat "Direct link to updatedAt") > **updatedAt**: `string` Defined in: [packages/sdk/src/types/communication-types.ts:107](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/communication-types.ts#L107) *** ### uuid[​](#uuid "Direct link to uuid") > **uuid**: `string` Defined in: [packages/sdk/src/types/communication-types.ts:100](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/communication-types.ts#L100) *** ### workspaceName[​](#workspacename "Direct link to workspaceName") > **workspaceName**: `string` Defined in: [packages/sdk/src/types/communication-types.ts:109](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/communication-types.ts#L109) *** ### workspaceUuid[​](#workspaceuuid "Direct link to workspaceUuid") > **workspaceUuid**: `string` Defined in: [packages/sdk/src/types/communication-types.ts:108](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/communication-types.ts#L108) --- # Interface: UnthreadedEmailResponse Defined in: [packages/sdk/src/types/generated/communication.ts:463](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L463) A single email not associated with any chat thread. ## Properties[​](#properties "Direct link to Properties") ### createdAt?[​](#createdat "Direct link to createdAt?") > `optional` **createdAt**: `string` | `null` Defined in: [packages/sdk/src/types/generated/communication.ts:467](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L467) *** ### id[​](#id "Direct link to id") > **id**: `number` Defined in: [packages/sdk/src/types/generated/communication.ts:464](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L464) *** ### readAt?[​](#readat "Direct link to readAt?") > `optional` **readAt**: `string` | `null` Defined in: [packages/sdk/src/types/generated/communication.ts:468](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L468) *** ### sender[​](#sender "Direct link to sender") > **sender**: `string` Defined in: [packages/sdk/src/types/generated/communication.ts:466](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L466) *** ### subject[​](#subject "Direct link to subject") > **subject**: `string` Defined in: [packages/sdk/src/types/generated/communication.ts:465](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L465) --- # Interface: UpdateA2PCampaignConfigRequest Defined in: [packages/sdk/src/types/organization-types.ts:284](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/organization-types.ts#L284) Partial update of a brand's campaign config; omitted fields are unchanged. ## Properties[​](#properties "Direct link to Properties") ### ageGated?[​](#agegated "Direct link to ageGated?") > `optional` **ageGated**: `boolean` Defined in: [packages/sdk/src/types/organization-types.ts:294](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/organization-types.ts#L294) *** ### consentCheckboxLabel?[​](#consentcheckboxlabel "Direct link to consentCheckboxLabel?") > `optional` **consentCheckboxLabel**: `string` Defined in: [packages/sdk/src/types/organization-types.ts:295](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/organization-types.ts#L295) *** ### consentDisclosure?[​](#consentdisclosure "Direct link to consentDisclosure?") > `optional` **consentDisclosure**: `string` Defined in: [packages/sdk/src/types/organization-types.ts:296](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/organization-types.ts#L296) *** ### description?[​](#description "Direct link to description?") > `optional` **description**: `string` Defined in: [packages/sdk/src/types/organization-types.ts:285](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/organization-types.ts#L285) *** ### helpMessage?[​](#helpmessage "Direct link to helpMessage?") > `optional` **helpMessage**: `string` Defined in: [packages/sdk/src/types/organization-types.ts:291](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/organization-types.ts#L291) *** ### messageFlow?[​](#messageflow "Direct link to messageFlow?") > `optional` **messageFlow**: `string` Defined in: [packages/sdk/src/types/organization-types.ts:286](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/organization-types.ts#L286) *** ### messageSamples?[​](#messagesamples "Direct link to messageSamples?") > `optional` **messageSamples**: `string`\[] Defined in: [packages/sdk/src/types/organization-types.ts:288](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/organization-types.ts#L288) *** ### optInMessage?[​](#optinmessage "Direct link to optInMessage?") > `optional` **optInMessage**: `string` Defined in: [packages/sdk/src/types/organization-types.ts:289](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/organization-types.ts#L289) *** ### optOutMessage?[​](#optoutmessage "Direct link to optOutMessage?") > `optional` **optOutMessage**: `string` Defined in: [packages/sdk/src/types/organization-types.ts:290](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/organization-types.ts#L290) *** ### privacyUrl?[​](#privacyurl "Direct link to privacyUrl?") > `optional` **privacyUrl**: `string` Defined in: [packages/sdk/src/types/organization-types.ts:292](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/organization-types.ts#L292) *** ### termsUrl?[​](#termsurl "Direct link to termsUrl?") > `optional` **termsUrl**: `string` Defined in: [packages/sdk/src/types/organization-types.ts:293](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/organization-types.ts#L293) *** ### useCase?[​](#usecase "Direct link to useCase?") > `optional` **useCase**: `string` Defined in: [packages/sdk/src/types/organization-types.ts:287](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/organization-types.ts#L287) --- # Interface: UpdateAgentRequest Defined in: [packages/sdk/src/types/member-types.ts:462](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L462) ## Properties[​](#properties "Direct link to Properties") ### archived?[​](#archived "Direct link to archived?") > `optional` **archived**: `boolean` Defined in: [packages/sdk/src/types/member-types.ts:470](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L470) *** ### chatModelConfig?[​](#chatmodelconfig "Direct link to chatModelConfig?") > `optional` **chatModelConfig**: `Record`<`string`, `unknown`> Defined in: [packages/sdk/src/types/member-types.ts:472](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L472) *** ### chatModelId?[​](#chatmodelid "Direct link to chatModelId?") > `optional` **chatModelId**: `string` Defined in: [packages/sdk/src/types/member-types.ts:471](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L471) *** ### codeInterpreterEnabled?[​](#codeinterpreterenabled "Direct link to codeInterpreterEnabled?") > `optional` **codeInterpreterEnabled**: `boolean` Defined in: [packages/sdk/src/types/member-types.ts:478](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L478) *** ### description?[​](#description "Direct link to description?") > `optional` **description**: `string` Defined in: [packages/sdk/src/types/member-types.ts:464](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L464) *** ### email?[​](#email "Direct link to email?") > `optional` **email**: `string` Defined in: [packages/sdk/src/types/member-types.ts:465](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L465) *** ### externalId?[​](#externalid "Direct link to externalId?") > `optional` **externalId**: `string` Defined in: [packages/sdk/src/types/member-types.ts:467](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L467) *** ### labelIds?[​](#labelids "Direct link to labelIds?") > `optional` **labelIds**: `number`\[] Defined in: [packages/sdk/src/types/member-types.ts:469](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L469) *** ### maxDailyActions?[​](#maxdailyactions "Direct link to maxDailyActions?") > `optional` **maxDailyActions**: `number` Defined in: [packages/sdk/src/types/member-types.ts:476](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L476) *** ### memberRoleId?[​](#memberroleid "Direct link to memberRoleId?") > `optional` **memberRoleId**: `number` Defined in: [packages/sdk/src/types/member-types.ts:468](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L468) *** ### memoryConfig?[​](#memoryconfig "Direct link to memoryConfig?") > `optional` **memoryConfig**: [`AgentMemoryConfig`](https://docs.gravityrail.com/sdk/interfaces/AgentMemoryConfig.md) Defined in: [packages/sdk/src/types/member-types.ts:479](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L479) *** ### name?[​](#name "Direct link to name?") > `optional` **name**: `string` Defined in: [packages/sdk/src/types/member-types.ts:463](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L463) *** ### phone?[​](#phone "Direct link to phone?") > `optional` **phone**: `string` Defined in: [packages/sdk/src/types/member-types.ts:466](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L466) *** ### realtimeModelConfig?[​](#realtimemodelconfig "Direct link to realtimeModelConfig?") > `optional` **realtimeModelConfig**: `Record`<`string`, `unknown`> Defined in: [packages/sdk/src/types/member-types.ts:474](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L474) *** ### realtimeModelId?[​](#realtimemodelid "Direct link to realtimeModelId?") > `optional` **realtimeModelId**: `string` Defined in: [packages/sdk/src/types/member-types.ts:473](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L473) *** ### systemPrompt?[​](#systemprompt "Direct link to systemPrompt?") > `optional` **systemPrompt**: `string` Defined in: [packages/sdk/src/types/member-types.ts:475](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L475) *** ### tools?[​](#tools "Direct link to tools?") > `optional` **tools**: `string`\[] Defined in: [packages/sdk/src/types/member-types.ts:477](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L477) --- # Interface: UpdateAppConnectionRequest Defined in: [packages/sdk/src/types/app-connection-types.ts:628](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L628) Request body for updating a platform app connection. ## Properties[​](#properties "Direct link to Properties") ### config?[​](#config "Direct link to config?") > `optional` **config**: `Record`<`string`, `unknown`> Defined in: [packages/sdk/src/types/app-connection-types.ts:629](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L629) *** ### enabled?[​](#enabled "Direct link to enabled?") > `optional` **enabled**: `boolean` Defined in: [packages/sdk/src/types/app-connection-types.ts:630](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L630) *** ### name?[​](#name "Direct link to name?") > `optional` **name**: `string` Defined in: [packages/sdk/src/types/app-connection-types.ts:631](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L631) --- # Interface: UpdateAppRequest Defined in: [packages/sdk/src/types/app-types.ts:53](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-types.ts#L53) ## Properties[​](#properties "Direct link to Properties") ### allowedWorkspaces?[​](#allowedworkspaces "Direct link to allowedWorkspaces?") > `optional` **allowedWorkspaces**: `number`\[] Defined in: [packages/sdk/src/types/app-types.ts:65](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-types.ts#L65) *** ### authorizationServerUrl?[​](#authorizationserverurl "Direct link to authorizationServerUrl?") > `optional` **authorizationServerUrl**: `string` Defined in: [packages/sdk/src/types/app-types.ts:60](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-types.ts#L60) *** ### builderId?[​](#builderid "Direct link to builderId?") > `optional` **builderId**: `number` Defined in: [packages/sdk/src/types/app-types.ts:55](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-types.ts#L55) *** ### description?[​](#description "Direct link to description?") > `optional` **description**: `string` Defined in: [packages/sdk/src/types/app-types.ts:56](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-types.ts#L56) *** ### grantTypes?[​](#granttypes "Direct link to grantTypes?") > `optional` **grantTypes**: `string`\[] Defined in: [packages/sdk/src/types/app-types.ts:62](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-types.ts#L62) *** ### isActive?[​](#isactive "Direct link to isActive?") > `optional` **isActive**: `boolean` Defined in: [packages/sdk/src/types/app-types.ts:63](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-types.ts#L63) *** ### isPublic?[​](#ispublic "Direct link to isPublic?") > `optional` **isPublic**: `boolean` Defined in: [packages/sdk/src/types/app-types.ts:64](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-types.ts#L64) *** ### mcpUrl?[​](#mcpurl "Direct link to mcpUrl?") > `optional` **mcpUrl**: `string` Defined in: [packages/sdk/src/types/app-types.ts:58](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-types.ts#L58) *** ### name?[​](#name "Direct link to name?") > `optional` **name**: `string` Defined in: [packages/sdk/src/types/app-types.ts:54](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-types.ts#L54) *** ### redirectUris?[​](#redirecturis "Direct link to redirectUris?") > `optional` **redirectUris**: `string`\[] Defined in: [packages/sdk/src/types/app-types.ts:59](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-types.ts#L59) *** ### responseTypes?[​](#responsetypes "Direct link to responseTypes?") > `optional` **responseTypes**: `string`\[] Defined in: [packages/sdk/src/types/app-types.ts:61](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-types.ts#L61) *** ### scopes?[​](#scopes "Direct link to scopes?") > `optional` **scopes**: `string`\[] Defined in: [packages/sdk/src/types/app-types.ts:57](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-types.ts#L57) --- # Interface: UpdateAssignmentFormData Defined in: [packages/sdk/src/types/task-types.ts:138](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/task-types.ts#L138) ## Properties[​](#properties "Direct link to Properties") ### dataRecords?[​](#datarecords "Direct link to dataRecords?") > `optional` **dataRecords**: [`DataRecordAssociationFormData`](https://docs.gravityrail.com/sdk/interfaces/DataRecordAssociationFormData.md)\[] Defined in: [packages/sdk/src/types/task-types.ts:139](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/task-types.ts#L139) *** ### files?[​](#files "Direct link to files?") > `optional` **files**: [`FileAssociationFormData`](https://docs.gravityrail.com/sdk/interfaces/FileAssociationFormData.md)\[] Defined in: [packages/sdk/src/types/task-types.ts:140](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/task-types.ts#L140) --- # Interface: UpdateAttendeeRequest Defined in: [packages/sdk/src/types/calendar-types.ts:159](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/calendar-types.ts#L159) ## Properties[​](#properties "Direct link to Properties") ### note?[​](#note "Direct link to note?") > `optional` **note**: `string` | `null` Defined in: [packages/sdk/src/types/calendar-types.ts:161](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/calendar-types.ts#L161) *** ### responseStatus[​](#responsestatus "Direct link to responseStatus") > **responseStatus**: [`AttendeeResponseStatus`](https://docs.gravityrail.com/sdk/enumerations/AttendeeResponseStatus.md) Defined in: [packages/sdk/src/types/calendar-types.ts:160](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/calendar-types.ts#L160) --- # Interface: UpdateBuilderRequest Defined in: [packages/sdk/src/types/builder-types.ts:28](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/builder-types.ts#L28) ## Properties[​](#properties "Direct link to Properties") ### avatarImage?[​](#avatarimage "Direct link to avatarImage?") > `optional` **avatarImage**: `string` Defined in: [packages/sdk/src/types/builder-types.ts:32](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/builder-types.ts#L32) *** ### avatarImageMimeType?[​](#avatarimagemimetype "Direct link to avatarImageMimeType?") > `optional` **avatarImageMimeType**: `string` Defined in: [packages/sdk/src/types/builder-types.ts:33](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/builder-types.ts#L33) *** ### description?[​](#description "Direct link to description?") > `optional` **description**: `string` Defined in: [packages/sdk/src/types/builder-types.ts:30](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/builder-types.ts#L30) *** ### isActive?[​](#isactive "Direct link to isActive?") > `optional` **isActive**: `boolean` Defined in: [packages/sdk/src/types/builder-types.ts:34](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/builder-types.ts#L34) *** ### isVerified?[​](#isverified "Direct link to isVerified?") > `optional` **isVerified**: `boolean` Defined in: [packages/sdk/src/types/builder-types.ts:35](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/builder-types.ts#L35) *** ### name?[​](#name "Direct link to name?") > `optional` **name**: `string` Defined in: [packages/sdk/src/types/builder-types.ts:29](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/builder-types.ts#L29) *** ### siteUrl?[​](#siteurl "Direct link to siteUrl?") > `optional` **siteUrl**: `string` Defined in: [packages/sdk/src/types/builder-types.ts:31](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/builder-types.ts#L31) --- # Interface: UpdateBusinessProfileRequest Defined in: [packages/sdk/src/types/organization-types.ts:184](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/organization-types.ts#L184) ## Properties[​](#properties "Direct link to Properties") ### address[​](#address "Direct link to address") > **address**: [`Address`](https://docs.gravityrail.com/sdk/interfaces/Address.md) Defined in: [packages/sdk/src/types/organization-types.ts:188](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/organization-types.ts#L188) *** ### authorizedReps[​](#authorizedreps "Direct link to authorizedReps") > **authorizedReps**: \[[`AuthorizedRep`](https://docs.gravityrail.com/sdk/interfaces/AuthorizedRep.md), [`AuthorizedRep`](https://docs.gravityrail.com/sdk/interfaces/AuthorizedRep.md)] Defined in: [packages/sdk/src/types/organization-types.ts:187](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/organization-types.ts#L187) Twilio Secondary CP policy requires exactly two authorized reps. *** ### businessInfo[​](#businessinfo "Direct link to businessInfo") > **businessInfo**: [`BusinessInfo`](https://docs.gravityrail.com/sdk/interfaces/BusinessInfo.md) Defined in: [packages/sdk/src/types/organization-types.ts:185](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/organization-types.ts#L185) --- # Interface: UpdateDiscordBotRequest Defined in: [packages/sdk/src/types/discord-bot-types.ts:66](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/discord-bot-types.ts#L66) Form data for updating a Discord bot. ## Properties[​](#properties "Direct link to Properties") ### allowDm?[​](#allowdm "Direct link to allowDm?") > `optional` **allowDm**: `boolean` Defined in: [packages/sdk/src/types/discord-bot-types.ts:78](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/discord-bot-types.ts#L78) *** ### allowedChannelIds?[​](#allowedchannelids "Direct link to allowedChannelIds?") > `optional` **allowedChannelIds**: `string`\[] | `null` Defined in: [packages/sdk/src/types/discord-bot-types.ts:86](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/discord-bot-types.ts#L86) *** ### allowedGuildIds?[​](#allowedguildids "Direct link to allowedGuildIds?") > `optional` **allowedGuildIds**: `string`\[] | `null` Defined in: [packages/sdk/src/types/discord-bot-types.ts:85](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/discord-bot-types.ts#L85) *** ### botToken?[​](#bottoken "Direct link to botToken?") > `optional` **botToken**: `string` Defined in: [packages/sdk/src/types/discord-bot-types.ts:68](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/discord-bot-types.ts#L68) *** ### clientSecret?[​](#clientsecret "Direct link to clientSecret?") > `optional` **clientSecret**: `string` Defined in: [packages/sdk/src/types/discord-bot-types.ts:70](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/discord-bot-types.ts#L70) *** ### defaultWorkflowId?[​](#defaultworkflowid "Direct link to defaultWorkflowId?") > `optional` **defaultWorkflowId**: `number` | `null` Defined in: [packages/sdk/src/types/discord-bot-types.ts:82](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/discord-bot-types.ts#L82) Default workflow ID for #### Mention[​](#mention "Direct link to Mention") responses (null = manager mode) *** ### enabled?[​](#enabled "Direct link to enabled?") > `optional` **enabled**: `boolean` Defined in: [packages/sdk/src/types/discord-bot-types.ts:87](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/discord-bot-types.ts#L87) *** ### enableGateway?[​](#enablegateway "Direct link to enableGateway?") > `optional` **enableGateway**: `boolean` Defined in: [packages/sdk/src/types/discord-bot-types.ts:80](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/discord-bot-types.ts#L80) Enable Discord Gateway for #### Mention[​](#mention-1 "Direct link to Mention") responses (requires MESSAGE\_CONTENT intent) *** ### memberId?[​](#memberid "Direct link to memberId?") > `optional` **memberId**: `number` | `null` Defined in: [packages/sdk/src/types/discord-bot-types.ts:84](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/discord-bot-types.ts#L84) Agent member ID who handles all bot interactions (mutually exclusive with defaultWorkflowId) *** ### name?[​](#name "Direct link to name?") > `optional` **name**: `string` Defined in: [packages/sdk/src/types/discord-bot-types.ts:67](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/discord-bot-types.ts#L67) *** ### publicKey?[​](#publickey "Direct link to publicKey?") > `optional` **publicKey**: `string` Defined in: [packages/sdk/src/types/discord-bot-types.ts:69](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/discord-bot-types.ts#L69) *** ### replyInThread?[​](#replyinthread "Direct link to replyInThread?") > `optional` **replyInThread**: `boolean` Defined in: [packages/sdk/src/types/discord-bot-types.ts:73](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/discord-bot-types.ts#L73) *** ### respondMode?[​](#respondmode "Direct link to respondMode?") > `optional` **respondMode**: [`DiscordRespondMode`](https://docs.gravityrail.com/sdk/type-aliases/DiscordRespondMode.md) Defined in: [packages/sdk/src/types/discord-bot-types.ts:75](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/discord-bot-types.ts#L75) How bot responds: 'mentions' (only @mentions), 'auto' (AI decides), 'off' (slash commands only) *** ### respondWhen?[​](#respondwhen "Direct link to respondWhen?") > `optional` **respondWhen**: `string` | `null` Defined in: [packages/sdk/src/types/discord-bot-types.ts:77](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/discord-bot-types.ts#L77) Custom prompt for AI to decide when to respond (only used when respondMode is 'auto', null to clear) *** ### slashCommands?[​](#slashcommands "Direct link to slashCommands?") > `optional` **slashCommands**: [`SlashCommandConfigResponse`](https://docs.gravityrail.com/sdk/interfaces/SlashCommandConfigResponse.md)\[] | `null` Defined in: [packages/sdk/src/types/discord-bot-types.ts:72](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/discord-bot-types.ts#L72) Custom slash commands (empty array clears, undefined leaves unchanged) --- # Interface: UpdateEncounterSyncRequest Defined in: [packages/sdk/src/types/fhir-connection-types.ts:292](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L292) Request to enable/disable encounter sync and configure freshness knobs. All fields optional — server falls back to documented defaults. ## Properties[​](#properties "Direct link to Properties") ### cadenceHours?[​](#cadencehours "Direct link to cadenceHours?") > `optional` **cadenceHours**: `number` Defined in: [packages/sdk/src/types/fhir-connection-types.ts:332](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L332) Minimum hours between scheduled runs; daily dispatcher gates via \_is\_due (default 20 — sub-24 to tolerate run-completion time). *** ### ccdaBinaryEnabled?[​](#ccdabinaryenabled "Direct link to ccdaBinaryEnabled?") > `optional` **ccdaBinaryEnabled**: `boolean` Defined in: [packages/sdk/src/types/fhir-connection-types.ts:315](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L315) C-CDA Binary fetch + parse path (defaults False). *** ### documentReferenceEnabled?[​](#documentreferenceenabled "Direct link to documentReferenceEnabled?") > `optional` **documentReferenceEnabled**: `boolean` Defined in: [packages/sdk/src/types/fhir-connection-types.ts:309](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L309) Inline-note `DocumentReference` ingestion (LOINC 11488-4 / 34117-2 / 11506-3). *** ### enabled[​](#enabled "Direct link to enabled") > **enabled**: `boolean` Defined in: [packages/sdk/src/types/fhir-connection-types.ts:293](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L293) *** ### initialLookbackDays?[​](#initiallookbackdays "Direct link to initialLookbackDays?") > `optional` **initialLookbackDays**: `number` Defined in: [packages/sdk/src/types/fhir-connection-types.ts:326](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L326) First scheduled-run window for a never-synced connection (feeds compute\_poll\_since; default 180). *** ### manualBackfillLookbackDays?[​](#manualbackfilllookbackdays "Direct link to manualBackfillLookbackDays?") > `optional` **manualBackfillLookbackDays**: `number` Defined in: [packages/sdk/src/types/fhir-connection-types.ts:303](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L303) *** ### medicationRequestsEnabled?[​](#medicationrequestsenabled "Direct link to medicationRequestsEnabled?") > `optional` **medicationRequestsEnabled**: `boolean` Defined in: [packages/sdk/src/types/fhir-connection-types.ts:313](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L313) `MedicationRequest` ingestion. *** ### observationSyncEnabled?[​](#observationsyncenabled "Direct link to observationSyncEnabled?") > `optional` **observationSyncEnabled**: `boolean` Defined in: [packages/sdk/src/types/fhir-connection-types.ts:324](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L324) Per-patient Observation sync (labs, vitals, social history). Connection-level — disables scheduled, manual, and refresh-coordinator observation fetches alike. Omit to preserve the stored value (defaults True). *** ### overlapDays?[​](#overlapdays "Direct link to overlapDays?") > `optional` **overlapDays**: `number` Defined in: [packages/sdk/src/types/fhir-connection-types.ts:330](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L330) Re-fetch window (by clinical date) from the last successful run to catch late charting (default 14). *** ### postCreateVerificationDelayMinutes?[​](#postcreateverificationdelayminutes "Direct link to postCreateVerificationDelayMinutes?") > `optional` **postCreateVerificationDelayMinutes**: `number` Defined in: [packages/sdk/src/types/fhir-connection-types.ts:306](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L306) *** ### postCreateVerificationEnabled?[​](#postcreateverificationenabled "Direct link to postCreateVerificationEnabled?") > `optional` **postCreateVerificationEnabled**: `boolean` Defined in: [packages/sdk/src/types/fhir-connection-types.ts:305](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L305) *** ### postCreateWriteThroughEnabled?[​](#postcreatewritethroughenabled "Direct link to postCreateWriteThroughEnabled?") > `optional` **postCreateWriteThroughEnabled**: `boolean` Defined in: [packages/sdk/src/types/fhir-connection-types.ts:304](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L304) *** ### readerLookbackDays?[​](#readerlookbackdays "Direct link to readerLookbackDays?") > `optional` **readerLookbackDays**: `number` Defined in: [packages/sdk/src/types/fhir-connection-types.ts:302](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L302) *** ### refreshLookbackDays?[​](#refreshlookbackdays "Direct link to refreshLookbackDays?") > `optional` **refreshLookbackDays**: `number` Defined in: [packages/sdk/src/types/fhir-connection-types.ts:301](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L301) *** ### refreshTtlMinutes?[​](#refreshttlminutes "Direct link to refreshTtlMinutes?") > `optional` **refreshTtlMinutes**: `number` Defined in: [packages/sdk/src/types/fhir-connection-types.ts:300](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L300) *** ### rollingLookbackDays?[​](#rollinglookbackdays "Direct link to rollingLookbackDays?") > `optional` **rollingLookbackDays**: `number` Defined in: [packages/sdk/src/types/fhir-connection-types.ts:328](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L328) Max age of encounters re-fetched on each scheduled run (feeds compute\_poll\_since; default 30). *** ### scheduledSyncPaused?[​](#scheduledsyncpaused "Direct link to scheduledSyncPaused?") > `optional` **scheduledSyncPaused**: `boolean` Defined in: [packages/sdk/src/types/fhir-connection-types.ts:299](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L299) Opt this connection out of the daily scheduled encounter-sync dispatcher. Demand/manual refresh keep working. Distinct from `enabled`. Omit to preserve the stored value (defaults False). *** ### serviceRequestReferralsEnabled?[​](#servicerequestreferralsenabled "Direct link to serviceRequestReferralsEnabled?") > `optional` **serviceRequestReferralsEnabled**: `boolean` Defined in: [packages/sdk/src/types/fhir-connection-types.ts:311](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L311) `ServiceRequest` referral (SNOMED 3457005) ingestion. *** ### storeRawCcdaXml?[​](#storerawccdaxml "Direct link to storeRawCcdaXml?") > `optional` **storeRawCcdaXml**: `boolean` Defined in: [packages/sdk/src/types/fhir-connection-types.ts:317](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L317) Persist raw C-CDA XML on section rows (defaults False). *** ### workflowStartAutomation?[​](#workflowstartautomation "Direct link to workflowStartAutomation?") > `optional` **workflowStartAutomation**: [`WorkflowStartAutomationResponse`](https://docs.gravityrail.com/sdk/interfaces/WorkflowStartAutomationResponse.md) Defined in: [packages/sdk/src/types/fhir-connection-types.ts:307](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L307) --- # Interface: UpdateEventRuleFormData Defined in: [packages/sdk/src/types/event-types.ts:497](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L497) ## Properties[​](#properties "Direct link to Properties") ### actionParams?[​](#actionparams "Direct link to actionParams?") > `optional` **actionParams**: `Record`<`string`, `any`> Defined in: [packages/sdk/src/types/event-types.ts:501](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L501) *** ### active?[​](#active "Direct link to active?") > `optional` **active**: `boolean` Defined in: [packages/sdk/src/types/event-types.ts:503](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L503) *** ### conditions?[​](#conditions "Direct link to conditions?") > `optional` **conditions**: `string` | `null` Defined in: [packages/sdk/src/types/event-types.ts:500](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L500) *** ### delay?[​](#delay "Direct link to delay?") > `optional` **delay**: `number` Defined in: [packages/sdk/src/types/event-types.ts:504](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L504) *** ### name?[​](#name "Direct link to name?") > `optional` **name**: `string` | `null` Defined in: [packages/sdk/src/types/event-types.ts:499](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L499) *** ### order?[​](#order "Direct link to order?") > `optional` **order**: `number` Defined in: [packages/sdk/src/types/event-types.ts:505](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L505) *** ### triggerParams?[​](#triggerparams "Direct link to triggerParams?") > `optional` **triggerParams**: `Record`<`string`, `any`> Defined in: [packages/sdk/src/types/event-types.ts:502](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L502) --- # Interface: UpdateFhirConnectionRequest Defined in: [packages/sdk/src/types/fhir-connection-types.ts:87](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L87) Form data for updating a FHIR connection. ## Properties[​](#properties "Direct link to Properties") ### clientId?[​](#clientid "Direct link to clientId?") > `optional` **clientId**: `string` Defined in: [packages/sdk/src/types/fhir-connection-types.ts:91](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L91) *** ### clientSecret?[​](#clientsecret "Direct link to clientSecret?") > `optional` **clientSecret**: `string` Defined in: [packages/sdk/src/types/fhir-connection-types.ts:92](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L92) *** ### enabled?[​](#enabled "Direct link to enabled?") > `optional` **enabled**: `boolean` Defined in: [packages/sdk/src/types/fhir-connection-types.ts:95](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L95) *** ### fhirBaseUrl?[​](#fhirbaseurl "Direct link to fhirBaseUrl?") > `optional` **fhirBaseUrl**: `string` Defined in: [packages/sdk/src/types/fhir-connection-types.ts:89](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L89) *** ### name?[​](#name "Direct link to name?") > `optional` **name**: `string` Defined in: [packages/sdk/src/types/fhir-connection-types.ts:88](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L88) *** ### practiceId?[​](#practiceid "Direct link to practiceId?") > `optional` **practiceId**: `string` Defined in: [packages/sdk/src/types/fhir-connection-types.ts:90](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L90) *** ### rateLimitPerMinute?[​](#ratelimitperminute "Direct link to rateLimitPerMinute?") > `optional` **rateLimitPerMinute**: `number` Defined in: [packages/sdk/src/types/fhir-connection-types.ts:96](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L96) *** ### state?[​](#state "Direct link to state?") > `optional` **state**: [`FhirConnectionState`](https://docs.gravityrail.com/sdk/enumerations/FhirConnectionState.md) Defined in: [packages/sdk/src/types/fhir-connection-types.ts:94](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L94) *** ### tokenEndpoint?[​](#tokenendpoint "Direct link to tokenEndpoint?") > `optional` **tokenEndpoint**: `string` Defined in: [packages/sdk/src/types/fhir-connection-types.ts:93](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L93) *** ### vendorConfig?[​](#vendorconfig "Direct link to vendorConfig?") > `optional` **vendorConfig**: `Record`<`string`, `unknown`> Defined in: [packages/sdk/src/types/fhir-connection-types.ts:97](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L97) --- # Interface: UpdateFhirCsvImportSettingsRequest Defined in: [packages/sdk/src/types/fhir-connection-types.ts:227](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L227) Request to update CSV import settings. Field-presence semantics for trust fields: * Omitted: leave the existing override unchanged. * `true` / `false`: persist explicit override. * `null`: clear the override so the connector inherits from `EntitySyncConfig.trustEmail` / `trustPhone`. ## Properties[​](#properties "Direct link to Properties") ### allowCreateUnmatched?[​](#allowcreateunmatched "Direct link to allowCreateUnmatched?") > `optional` **allowCreateUnmatched**: `boolean` Defined in: [packages/sdk/src/types/fhir-connection-types.ts:228](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L228) *** ### defaultImportedMemberRoleId?[​](#defaultimportedmemberroleid "Direct link to defaultImportedMemberRoleId?") > `optional` **defaultImportedMemberRoleId**: `number` | `null` Defined in: [packages/sdk/src/types/fhir-connection-types.ts:229](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L229) *** ### trustEmail?[​](#trustemail "Direct link to trustEmail?") > `optional` **trustEmail**: `boolean` | `null` Defined in: [packages/sdk/src/types/fhir-connection-types.ts:230](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L230) *** ### trustPhone?[​](#trustphone "Direct link to trustPhone?") > `optional` **trustPhone**: `boolean` | `null` Defined in: [packages/sdk/src/types/fhir-connection-types.ts:231](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L231) --- # Interface: UpdateFileRoleAssociationsRequest Defined in: [packages/sdk/src/types/file-types.ts:152](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/file-types.ts#L152) ## Properties[​](#properties "Direct link to Properties") ### associations[​](#associations "Direct link to associations") > **associations**: [`RoleAssociationEntry`](https://docs.gravityrail.com/sdk/interfaces/RoleAssociationEntry.md)\[] Defined in: [packages/sdk/src/types/file-types.ts:153](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/file-types.ts#L153) --- # Interface: UpdateFileSharingRequest Defined in: [packages/sdk/src/types/file-types.ts:161](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/file-types.ts#L161) ## Properties[​](#properties "Direct link to Properties") ### access[​](#access "Direct link to access") > **access**: [`AccessLevel`](https://docs.gravityrail.com/sdk/enumerations/AccessLevel.md) Defined in: [packages/sdk/src/types/file-types.ts:162](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/file-types.ts#L162) *** ### grants[​](#grants "Direct link to grants") > **grants**: [`SharingGrantEntry`](https://docs.gravityrail.com/sdk/interfaces/SharingGrantEntry.md)\[] Defined in: [packages/sdk/src/types/file-types.ts:164](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/file-types.ts#L164) *** ### roleAssociations[​](#roleassociations "Direct link to roleAssociations") > **roleAssociations**: [`RoleAssociationEntry`](https://docs.gravityrail.com/sdk/interfaces/RoleAssociationEntry.md)\[] Defined in: [packages/sdk/src/types/file-types.ts:165](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/file-types.ts#L165) *** ### shareable?[​](#shareable "Direct link to shareable?") > `optional` **shareable**: `boolean` Defined in: [packages/sdk/src/types/file-types.ts:163](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/file-types.ts#L163) --- # Interface: UpdateInvitationFormData Defined in: [packages/sdk/src/types/invitation-types.ts:57](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/invitation-types.ts#L57) ## Properties[​](#properties "Direct link to Properties") ### role?[​](#role "Direct link to role?") > `optional` **role**: [`OrgMemberRole`](https://docs.gravityrail.com/sdk/type-aliases/OrgMemberRole.md) Defined in: [packages/sdk/src/types/invitation-types.ts:59](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/invitation-types.ts#L59) *** ### status?[​](#status "Direct link to status?") > `optional` **status**: [`InvitationStatus`](https://docs.gravityrail.com/sdk/enumerations/InvitationStatus.md) Defined in: [packages/sdk/src/types/invitation-types.ts:58](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/invitation-types.ts#L58) --- # Interface: UpdateMemberFieldRequest Defined in: [packages/sdk/src/types/member-field-types.ts:21](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-field-types.ts#L21) ## Properties[​](#properties "Direct link to Properties") ### value[​](#value "Direct link to value") > **value**: `string` Defined in: [packages/sdk/src/types/member-field-types.ts:22](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-field-types.ts#L22) --- # Interface: UpdateOperatorGroupRequest Defined in: [packages/sdk/src/types/operator-types.ts:186](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/operator-types.ts#L186) ## Properties[​](#properties "Direct link to Properties") ### members?[​](#members "Direct link to members?") > `optional` **members**: [`OperatorGroupMemberInput`](https://docs.gravityrail.com/sdk/interfaces/OperatorGroupMemberInput.md)\[] Defined in: [packages/sdk/src/types/operator-types.ts:189](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/operator-types.ts#L189) *** ### name?[​](#name "Direct link to name?") > `optional` **name**: `string` Defined in: [packages/sdk/src/types/operator-types.ts:187](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/operator-types.ts#L187) *** ### routingStrategy?[​](#routingstrategy "Direct link to routingStrategy?") > `optional` **routingStrategy**: [`RoutingStrategy`](https://docs.gravityrail.com/sdk/type-aliases/RoutingStrategy.md) Defined in: [packages/sdk/src/types/operator-types.ts:188](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/operator-types.ts#L188) --- # Interface: UpdateOrganizationRequest Defined in: [packages/sdk/src/types/account-types.ts:283](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L283) ## Properties[​](#properties "Direct link to Properties") ### authMode?[​](#authmode "Direct link to authMode?") > `optional` **authMode**: `"open"` | `"ssoForDomain"` | `"ssoOnly"` Defined in: [packages/sdk/src/types/account-types.ts:295](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L295) *** ### contactEmail?[​](#contactemail "Direct link to contactEmail?") > `optional` **contactEmail**: `string` Defined in: [packages/sdk/src/types/account-types.ts:288](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L288) *** ### contactPhone?[​](#contactphone "Direct link to contactPhone?") > `optional` **contactPhone**: `string` Defined in: [packages/sdk/src/types/account-types.ts:289](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L289) *** ### enforceCreditLimit?[​](#enforcecreditlimit "Direct link to enforceCreditLimit?") > `optional` **enforceCreditLimit**: `boolean` Defined in: [packages/sdk/src/types/account-types.ts:309](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L309) *** ### logo?[​](#logo "Direct link to logo?") > `optional` **logo**: `string` Defined in: [packages/sdk/src/types/account-types.ts:290](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L290) *** ### logoMimeType?[​](#logomimetype "Direct link to logoMimeType?") > `optional` **logoMimeType**: `string` Defined in: [packages/sdk/src/types/account-types.ts:291](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L291) *** ### logoUrl?[​](#logourl "Direct link to logoUrl?") > `optional` **logoUrl**: `string` Defined in: [packages/sdk/src/types/account-types.ts:287](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L287) *** ### name?[​](#name "Direct link to name?") > `optional` **name**: `string` Defined in: [packages/sdk/src/types/account-types.ts:284](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L284) *** ### primary?[​](#primary "Direct link to primary?") > `optional` **primary**: `boolean` Defined in: [packages/sdk/src/types/account-types.ts:286](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L286) *** ### slug?[​](#slug "Direct link to slug?") > `optional` **slug**: `string` Defined in: [packages/sdk/src/types/account-types.ts:285](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L285) *** ### ssoAutoProvision?[​](#ssoautoprovision "Direct link to ssoAutoProvision?") > `optional` **ssoAutoProvision**: `boolean` Defined in: [packages/sdk/src/types/account-types.ts:296](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L296) *** ### ssoDomain?[​](#ssodomain "Direct link to ssoDomain?") > `optional` **ssoDomain**: `string` | `null` Defined in: [packages/sdk/src/types/account-types.ts:294](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L294) *** ### ssoOidc?[​](#ssooidc "Direct link to ssoOidc?") > `optional` **ssoOidc**: `OIDCAdminConfigInput` | `null` Defined in: [packages/sdk/src/types/account-types.ts:303](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L303) External OIDC config — encrypted server-side and persisted into `organization.sso_config["oidc"]`. Set to `null` to clear an existing OIDC config. The cleartext `clientSecret` only lives for the duration of the request; the response surfaces a redacted view. *** ### ssoProvider?[​](#ssoprovider "Direct link to ssoProvider?") > `optional` **ssoProvider**: `string` | `null` Defined in: [packages/sdk/src/types/account-types.ts:293](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L293) *** ### twilioSubAccountSid?[​](#twiliosubaccountsid "Direct link to twilioSubAccountSid?") > `optional` **twilioSubAccountSid**: `string` | `null` Defined in: [packages/sdk/src/types/account-types.ts:306](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L306) --- # Interface: UpdateOrgMemberRequest Defined in: [packages/sdk/src/types/account-types.ts:437](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L437) ## Properties[​](#properties "Direct link to Properties") ### role[​](#role "Direct link to role") > **role**: [`OrgMemberRole`](https://docs.gravityrail.com/sdk/type-aliases/OrgMemberRole.md) Defined in: [packages/sdk/src/types/account-types.ts:438](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L438) --- # Interface: UpdatePersonaRequest Defined in: [packages/sdk/src/types/qualification-types.ts:108](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/qualification-types.ts#L108) ## Properties[​](#properties "Direct link to Properties") ### age?[​](#age "Direct link to age?") > `optional` **age**: `number` Defined in: [packages/sdk/src/types/qualification-types.ts:111](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/qualification-types.ts#L111) *** ### dataRecords?[​](#datarecords "Direct link to dataRecords?") > `optional` **dataRecords**: `Record`<`string`, [`ScenarioDataRecord`](https://docs.gravityrail.com/sdk/interfaces/ScenarioDataRecord.md)> Defined in: [packages/sdk/src/types/qualification-types.ts:116](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/qualification-types.ts#L116) *** ### description?[​](#description "Direct link to description?") > `optional` **description**: `string` Defined in: [packages/sdk/src/types/qualification-types.ts:110](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/qualification-types.ts#L110) *** ### hasEmail?[​](#hasemail "Direct link to hasEmail?") > `optional` **hasEmail**: `boolean` Defined in: [packages/sdk/src/types/qualification-types.ts:113](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/qualification-types.ts#L113) *** ### hasPhone?[​](#hasphone "Direct link to hasPhone?") > `optional` **hasPhone**: `boolean` Defined in: [packages/sdk/src/types/qualification-types.ts:112](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/qualification-types.ts#L112) *** ### identity?[​](#identity "Direct link to identity?") > `optional` **identity**: `string` Defined in: [packages/sdk/src/types/qualification-types.ts:115](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/qualification-types.ts#L115) *** ### memberRoleUuid?[​](#memberroleuuid "Direct link to memberRoleUuid?") > `optional` **memberRoleUuid**: `string` | `null` Defined in: [packages/sdk/src/types/qualification-types.ts:114](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/qualification-types.ts#L114) *** ### name?[​](#name "Direct link to name?") > `optional` **name**: `string` Defined in: [packages/sdk/src/types/qualification-types.ts:109](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/qualification-types.ts#L109) --- # Interface: UpdatePronunciationEntryFormData Defined in: [packages/sdk/src/types/pronunciation-types.ts:22](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/pronunciation-types.ts#L22) ## Properties[​](#properties "Direct link to Properties") ### respelling?[​](#respelling "Direct link to respelling?") > `optional` **respelling**: `string` Defined in: [packages/sdk/src/types/pronunciation-types.ts:23](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/pronunciation-types.ts#L23) --- # Interface: UpdateRoutineRequest Defined in: [packages/sdk/src/types/event-types.ts:589](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L589) ## Properties[​](#properties "Direct link to Properties") ### cronString?[​](#cronstring "Direct link to cronString?") > `optional` **cronString**: `string` Defined in: [packages/sdk/src/types/event-types.ts:597](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L597) *** ### description?[​](#description "Direct link to description?") > `optional` **description**: `string` Defined in: [packages/sdk/src/types/event-types.ts:591](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L591) *** ### eventRules?[​](#eventrules "Direct link to eventRules?") > `optional` **eventRules**: [`EventRuleInput`](https://docs.gravityrail.com/sdk/interfaces/EventRuleInput.md)\[] Defined in: [packages/sdk/src/types/event-types.ts:611](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L611) Ordered event rules to attach. Server syncs by UUID: same-UUID rows update, new UUIDs create, UUIDs missing from the list are deleted. Omit the field to leave existing rules untouched. *** ### intervalSeconds?[​](#intervalseconds "Direct link to intervalSeconds?") > `optional` **intervalSeconds**: `number` Defined in: [packages/sdk/src/types/event-types.ts:595](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L595) *** ### limit?[​](#limit "Direct link to limit?") > `optional` **limit**: `number` Defined in: [packages/sdk/src/types/event-types.ts:606](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L606) *** ### memberFilterId?[​](#memberfilterid "Direct link to memberFilterId?") > `optional` **memberFilterId**: `number` | `null` Defined in: [packages/sdk/src/types/event-types.ts:603](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L603) *** ### name?[​](#name "Direct link to name?") > `optional` **name**: `string` Defined in: [packages/sdk/src/types/event-types.ts:590](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L590) *** ### repeatCount?[​](#repeatcount "Direct link to repeatCount?") > `optional` **repeatCount**: `number` Defined in: [packages/sdk/src/types/event-types.ts:596](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L596) *** ### rotateWebhookSecret?[​](#rotatewebhooksecret "Direct link to rotateWebhookSecret?") > `optional` **rotateWebhookSecret**: `boolean` Defined in: [packages/sdk/src/types/event-types.ts:615](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L615) Rotate the stored secret without toggling enabled. Ignored when webhookEnabled=false. *** ### scheduledTime?[​](#scheduledtime "Direct link to scheduledTime?") > `optional` **scheduledTime**: `string` Defined in: [packages/sdk/src/types/event-types.ts:594](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L594) *** ### scheduleEnabled?[​](#scheduleenabled "Direct link to scheduleEnabled?") > `optional` **scheduleEnabled**: `boolean` Defined in: [packages/sdk/src/types/event-types.ts:592](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L592) *** ### scheduleMode?[​](#schedulemode "Direct link to scheduleMode?") > `optional` **scheduleMode**: `"ONCE"` | `"CRON"` | `"INTERVAL"` Defined in: [packages/sdk/src/types/event-types.ts:593](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L593) *** ### startDate?[​](#startdate "Direct link to startDate?") > `optional` **startDate**: `string` Defined in: [packages/sdk/src/types/event-types.ts:602](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L602) ISO 8601 datetime string for deferred start. Pass empty string "" to clear the start date. *** ### targetMemberId?[​](#targetmemberid "Direct link to targetMemberId?") > `optional` **targetMemberId**: `number` | `null` Defined in: [packages/sdk/src/types/event-types.ts:604](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L604) *** ### timezone?[​](#timezone "Direct link to timezone?") > `optional` **timezone**: `string` Defined in: [packages/sdk/src/types/event-types.ts:600](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L600) IANA timezone the cronString is interpreted in. Pass empty string "" to clear the override (revert to UTC). Omit to leave unchanged. *** ### visibility?[​](#visibility "Direct link to visibility?") > `optional` **visibility**: `"private"` | `"workspace"` Defined in: [packages/sdk/src/types/event-types.ts:607](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L607) *** ### webhookEnabled?[​](#webhookenabled "Direct link to webhookEnabled?") > `optional` **webhookEnabled**: `boolean` Defined in: [packages/sdk/src/types/event-types.ts:613](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L613) Toggle inbound webhook. Enabling without a stored secret generates one and surfaces plaintext in the response exactly once. *** ### workflowId?[​](#workflowid "Direct link to workflowId?") > `optional` **workflowId**: `number` | `null` Defined in: [packages/sdk/src/types/event-types.ts:605](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L605) --- # Interface: UpdateSalesforceSyncConfigRequest Defined in: [packages/sdk/src/types/app-connection-types.ts:359](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L359) ## Properties[​](#properties "Direct link to Properties") ### salesforceSyncSettings[​](#salesforcesyncsettings "Direct link to salesforceSyncSettings") > **salesforceSyncSettings**: [`SalesforceSyncSettings`](https://docs.gravityrail.com/sdk/interfaces/SalesforceSyncSettings.md) Defined in: [packages/sdk/src/types/app-connection-types.ts:361](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L361) *** ### syncConfig[​](#syncconfig "Direct link to syncConfig") > **syncConfig**: [`ConnectionSyncConfig`](https://docs.gravityrail.com/sdk/interfaces/ConnectionSyncConfig.md) Defined in: [packages/sdk/src/types/app-connection-types.ts:360](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L360) --- # Interface: UpdateScenarioRequest Defined in: [packages/sdk/src/types/qualification-types.ts:83](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/qualification-types.ts#L83) ## Properties[​](#properties "Direct link to Properties") ### archived?[​](#archived "Direct link to archived?") > `optional` **archived**: `boolean` Defined in: [packages/sdk/src/types/qualification-types.ts:92](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/qualification-types.ts#L92) *** ### channel?[​](#channel "Direct link to channel?") > `optional` **channel**: `string` Defined in: [packages/sdk/src/types/qualification-types.ts:89](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/qualification-types.ts#L89) *** ### criteria?[​](#criteria "Direct link to criteria?") > `optional` **criteria**: [`CriterionInput`](https://docs.gravityrail.com/sdk/interfaces/CriterionInput.md)\[] Defined in: [packages/sdk/src/types/qualification-types.ts:93](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/qualification-types.ts#L93) *** ### dataRecords?[​](#datarecords "Direct link to dataRecords?") > `optional` **dataRecords**: `Record`<`string`, [`ScenarioDataRecord`](https://docs.gravityrail.com/sdk/interfaces/ScenarioDataRecord.md)> Defined in: [packages/sdk/src/types/qualification-types.ts:90](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/qualification-types.ts#L90) *** ### description?[​](#description "Direct link to description?") > `optional` **description**: `string` Defined in: [packages/sdk/src/types/qualification-types.ts:86](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/qualification-types.ts#L86) *** ### goal?[​](#goal "Direct link to goal?") > `optional` **goal**: `string` Defined in: [packages/sdk/src/types/qualification-types.ts:88](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/qualification-types.ts#L88) *** ### name?[​](#name "Direct link to name?") > `optional` **name**: `string` Defined in: [packages/sdk/src/types/qualification-types.ts:85](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/qualification-types.ts#L85) *** ### order?[​](#order "Direct link to order?") > `optional` **order**: `number` Defined in: [packages/sdk/src/types/qualification-types.ts:91](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/qualification-types.ts#L91) *** ### personaId?[​](#personaid "Direct link to personaId?") > `optional` **personaId**: `number` Defined in: [packages/sdk/src/types/qualification-types.ts:87](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/qualification-types.ts#L87) *** ### simulatedDatetime?[​](#simulateddatetime "Direct link to simulatedDatetime?") > `optional` **simulatedDatetime**: `string` | `null` Defined in: [packages/sdk/src/types/qualification-types.ts:94](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/qualification-types.ts#L94) *** ### slug?[​](#slug "Direct link to slug?") > `optional` **slug**: `string` Defined in: [packages/sdk/src/types/qualification-types.ts:84](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/qualification-types.ts#L84) --- # Interface: UpdateSlackAppRequest Defined in: [packages/sdk/src/types/slack-app-types.ts:111](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/slack-app-types.ts#L111) Form data for updating a Slack app. ## Properties[​](#properties "Direct link to Properties") ### allowDm?[​](#allowdm "Direct link to allowDm?") > `optional` **allowDm**: `boolean` Defined in: [packages/sdk/src/types/slack-app-types.ts:137](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/slack-app-types.ts#L137) *** ### allowedChannelIds?[​](#allowedchannelids "Direct link to allowedChannelIds?") > `optional` **allowedChannelIds**: `string`\[] | `null` Defined in: [packages/sdk/src/types/slack-app-types.ts:139](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/slack-app-types.ts#L139) *** ### appLevelToken?[​](#appleveltoken "Direct link to appLevelToken?") > `optional` **appLevelToken**: `string` Defined in: [packages/sdk/src/types/slack-app-types.ts:122](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/slack-app-types.ts#L122) App-level token (xapp-...) - only required if socketModeEnabled is true *** ### clientSecret?[​](#clientsecret "Direct link to clientSecret?") > `optional` **clientSecret**: `string` Defined in: [packages/sdk/src/types/slack-app-types.ts:114](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/slack-app-types.ts#L114) *** ### defaultWorkflowId?[​](#defaultworkflowid "Direct link to defaultWorkflowId?") > `optional` **defaultWorkflowId**: `number` Defined in: [packages/sdk/src/types/slack-app-types.ts:113](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/slack-app-types.ts#L113) *** ### enabled?[​](#enabled "Direct link to enabled?") > `optional` **enabled**: `boolean` Defined in: [packages/sdk/src/types/slack-app-types.ts:140](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/slack-app-types.ts#L140) *** ### name?[​](#name "Direct link to name?") > `optional` **name**: `string` Defined in: [packages/sdk/src/types/slack-app-types.ts:112](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/slack-app-types.ts#L112) *** ### replyInThread?[​](#replyinthread "Direct link to replyInThread?") > `optional` **replyInThread**: `boolean` Defined in: [packages/sdk/src/types/slack-app-types.ts:138](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/slack-app-types.ts#L138) *** ### respondMode?[​](#respondmode "Direct link to respondMode?") > `optional` **respondMode**: [`SlackRespondMode`](https://docs.gravityrail.com/sdk/type-aliases/SlackRespondMode.md) Defined in: [packages/sdk/src/types/slack-app-types.ts:131](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/slack-app-types.ts#L131) How the bot responds to messages: * 'mentions': Only respond when explicitly #### Mentioned[​](#mentioned "Direct link to Mentioned") * 'auto': Use AI to decide whether to respond * 'off': Don't auto-respond (only slash commands work) *** ### respondWhen?[​](#respondwhen "Direct link to respondWhen?") > `optional` **respondWhen**: `string` | `null` Defined in: [packages/sdk/src/types/slack-app-types.ts:136](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/slack-app-types.ts#L136) Custom prompt for AI to decide when to respond. Only used when respondMode is 'auto'. Set to null to clear. *** ### signingSecret?[​](#signingsecret "Direct link to signingSecret?") > `optional` **signingSecret**: `string` Defined in: [packages/sdk/src/types/slack-app-types.ts:115](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/slack-app-types.ts#L115) *** ### slashCommands?[​](#slashcommands "Direct link to slashCommands?") > `optional` **slashCommands**: [`SlackSlashCommandConfigResponse`](https://docs.gravityrail.com/sdk/interfaces/SlackSlashCommandConfigResponse.md)\[] | `null` Defined in: [packages/sdk/src/types/slack-app-types.ts:124](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/slack-app-types.ts#L124) Slash commands (empty array clears, undefined leaves unchanged) *** ### socketModeEnabled?[​](#socketmodeenabled "Direct link to socketModeEnabled?") > `optional` **socketModeEnabled**: `boolean` Defined in: [packages/sdk/src/types/slack-app-types.ts:120](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/slack-app-types.ts#L120) Enable Socket Mode (optional). Only needed for firewalls or local dev. Events API is recommended for production. --- # Interface: UpdateTeamsAppRequest Defined in: [packages/sdk/src/types/teams-app-types.ts:86](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/teams-app-types.ts#L86) Form data for updating a Teams app. ## Properties[​](#properties "Direct link to Properties") ### allowDm?[​](#allowdm "Direct link to allowDm?") > `optional` **allowDm**: `boolean` Defined in: [packages/sdk/src/types/teams-app-types.ts:98](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/teams-app-types.ts#L98) *** ### allowedChannelIds?[​](#allowedchannelids "Direct link to allowedChannelIds?") > `optional` **allowedChannelIds**: `string`\[] | `null` Defined in: [packages/sdk/src/types/teams-app-types.ts:100](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/teams-app-types.ts#L100) *** ### commands?[​](#commands "Direct link to commands?") > `optional` **commands**: [`TeamsCommandConfigResponse`](https://docs.gravityrail.com/sdk/interfaces/TeamsCommandConfigResponse.md)\[] | `null` Defined in: [packages/sdk/src/types/teams-app-types.ts:95](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/teams-app-types.ts#L95) Commands (empty array clears, undefined leaves unchanged) *** ### defaultWorkflowId?[​](#defaultworkflowid "Direct link to defaultWorkflowId?") > `optional` **defaultWorkflowId**: `number` Defined in: [packages/sdk/src/types/teams-app-types.ts:88](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/teams-app-types.ts#L88) *** ### enabled?[​](#enabled "Direct link to enabled?") > `optional` **enabled**: `boolean` Defined in: [packages/sdk/src/types/teams-app-types.ts:101](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/teams-app-types.ts#L101) *** ### microsoftAppId?[​](#microsoftappid "Direct link to microsoftAppId?") > `optional` **microsoftAppId**: `string` Defined in: [packages/sdk/src/types/teams-app-types.ts:89](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/teams-app-types.ts#L89) *** ### microsoftAppPassword?[​](#microsoftapppassword "Direct link to microsoftAppPassword?") > `optional` **microsoftAppPassword**: `string` Defined in: [packages/sdk/src/types/teams-app-types.ts:90](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/teams-app-types.ts#L90) *** ### name?[​](#name "Direct link to name?") > `optional` **name**: `string` Defined in: [packages/sdk/src/types/teams-app-types.ts:87](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/teams-app-types.ts#L87) *** ### replyInThread?[​](#replyinthread "Direct link to replyInThread?") > `optional` **replyInThread**: `boolean` Defined in: [packages/sdk/src/types/teams-app-types.ts:99](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/teams-app-types.ts#L99) *** ### respondMode?[​](#respondmode "Direct link to respondMode?") > `optional` **respondMode**: [`TeamsRespondMode`](https://docs.gravityrail.com/sdk/type-aliases/TeamsRespondMode.md) Defined in: [packages/sdk/src/types/teams-app-types.ts:96](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/teams-app-types.ts#L96) *** ### respondWhen?[​](#respondwhen "Direct link to respondWhen?") > `optional` **respondWhen**: `string` | `null` Defined in: [packages/sdk/src/types/teams-app-types.ts:97](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/teams-app-types.ts#L97) *** ### ssoClientId?[​](#ssoclientid "Direct link to ssoClientId?") > `optional` **ssoClientId**: `string` Defined in: [packages/sdk/src/types/teams-app-types.ts:91](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/teams-app-types.ts#L91) *** ### ssoClientSecret?[​](#ssoclientsecret "Direct link to ssoClientSecret?") > `optional` **ssoClientSecret**: `string` Defined in: [packages/sdk/src/types/teams-app-types.ts:92](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/teams-app-types.ts#L92) *** ### teamsManifestAppId?[​](#teamsmanifestappid "Direct link to teamsManifestAppId?") > `optional` **teamsManifestAppId**: `string` Defined in: [packages/sdk/src/types/teams-app-types.ts:93](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/teams-app-types.ts#L93) --- # Interface: UpdateThemeSettingsRequest Defined in: [packages/sdk/src/types/generated/site.ts:551](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L551) Save values for the active theme's declared settings. Values are validated/coerced against the resolved schema in the handler (undeclared keys dropped, references checked); see lib/services/theme\_settings.py. ## Properties[​](#properties "Direct link to Properties") ### values?[​](#values "Direct link to values?") > `optional` **values**: `UpdateThemeSettingsRequestValues` Defined in: [packages/sdk/src/types/generated/site.ts:552](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L552) --- # Interface: UpdateTwoFactorMethodRequest Defined in: [packages/sdk/src/types/account-types.ts:385](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L385) ## Properties[​](#properties "Direct link to Properties") ### methodId[​](#methodid "Direct link to methodId") > **methodId**: `number` Defined in: [packages/sdk/src/types/account-types.ts:386](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L386) *** ### name?[​](#name "Direct link to name?") > `optional` **name**: `string` Defined in: [packages/sdk/src/types/account-types.ts:387](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L387) --- # Interface: UpdateWorkflowContributorRequest Defined in: [packages/sdk/src/types/task-types.ts:164](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/task-types.ts#L164) ## Properties[​](#properties "Direct link to Properties") ### channels?[​](#channels "Direct link to channels?") > `optional` **channels**: `string`\[] Defined in: [packages/sdk/src/types/task-types.ts:167](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/task-types.ts#L167) *** ### hint?[​](#hint "Direct link to hint?") > `optional` **hint**: `string` Defined in: [packages/sdk/src/types/task-types.ts:168](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/task-types.ts#L168) *** ### memberId?[​](#memberid "Direct link to memberId?") > `optional` **memberId**: `number` Defined in: [packages/sdk/src/types/task-types.ts:165](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/task-types.ts#L165) *** ### title?[​](#title "Direct link to title?") > `optional` **title**: `string` Defined in: [packages/sdk/src/types/task-types.ts:166](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/task-types.ts#L166) --- # Interface: UpdateWorkspaceMemberRequest Defined in: [packages/sdk/src/types/member-types.ts:369](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L369) ## Properties[​](#properties "Direct link to Properties") ### accountEnabled?[​](#accountenabled "Direct link to accountEnabled?") > `optional` **accountEnabled**: `boolean` Defined in: [packages/sdk/src/types/member-types.ts:387](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L387) *** ### accountTosAccepted?[​](#accounttosaccepted "Direct link to accountTosAccepted?") > `optional` **accountTosAccepted**: `boolean` Defined in: [packages/sdk/src/types/member-types.ts:390](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L390) *** ### dateOfBirth?[​](#dateofbirth "Direct link to dateOfBirth?") > `optional` **dateOfBirth**: `string` | `null` Defined in: [packages/sdk/src/types/member-types.ts:375](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L375) *** ### description?[​](#description "Direct link to description?") > `optional` **description**: `string` | `null` Defined in: [packages/sdk/src/types/member-types.ts:371](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L371) *** ### email?[​](#email "Direct link to email?") > `optional` **email**: `string` | `null` Defined in: [packages/sdk/src/types/member-types.ts:373](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L373) *** ### emailTrusted?[​](#emailtrusted "Direct link to emailTrusted?") > `optional` **emailTrusted**: `boolean` | `null` Defined in: [packages/sdk/src/types/member-types.ts:376](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L376) *** ### externalId?[​](#externalid "Direct link to externalId?") > `optional` **externalId**: `string` | `null` Defined in: [packages/sdk/src/types/member-types.ts:374](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L374) *** ### isOrgOwner?[​](#isorgowner "Direct link to isOrgOwner?") > `optional` **isOrgOwner**: `boolean` Defined in: [packages/sdk/src/types/member-types.ts:388](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L388) *** ### isSuperuser?[​](#issuperuser "Direct link to isSuperuser?") > `optional` **isSuperuser**: `boolean` Defined in: [packages/sdk/src/types/member-types.ts:389](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L389) *** ### labelIds?[​](#labelids "Direct link to labelIds?") > `optional` **labelIds**: `number`\[] Defined in: [packages/sdk/src/types/member-types.ts:379](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L379) *** ### locale?[​](#locale "Direct link to locale?") > `optional` **locale**: `string` | `null` Defined in: [packages/sdk/src/types/member-types.ts:384](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L384) *** ### memberRoleId?[​](#memberroleid "Direct link to memberRoleId?") > `optional` **memberRoleId**: `number` Defined in: [packages/sdk/src/types/member-types.ts:378](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L378) *** ### memberType?[​](#membertype "Direct link to memberType?") > `optional` **memberType**: [`MemberType`](https://docs.gravityrail.com/sdk/enumerations/MemberType.md) Defined in: [packages/sdk/src/types/member-types.ts:391](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L391) *** ### name?[​](#name "Direct link to name?") > `optional` **name**: `string` | `null` Defined in: [packages/sdk/src/types/member-types.ts:370](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L370) *** ### notifyEmail?[​](#notifyemail "Direct link to notifyEmail?") > `optional` **notifyEmail**: `boolean` Defined in: [packages/sdk/src/types/member-types.ts:381](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L381) *** ### notifySms?[​](#notifysms "Direct link to notifySms?") > `optional` **notifySms**: `boolean` Defined in: [packages/sdk/src/types/member-types.ts:380](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L380) *** ### notifyVoice?[​](#notifyvoice "Direct link to notifyVoice?") > `optional` **notifyVoice**: `boolean` Defined in: [packages/sdk/src/types/member-types.ts:382](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L382) *** ### notifyWhatsapp?[​](#notifywhatsapp "Direct link to notifyWhatsapp?") > `optional` **notifyWhatsapp**: `boolean` Defined in: [packages/sdk/src/types/member-types.ts:383](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L383) *** ### phone?[​](#phone "Direct link to phone?") > `optional` **phone**: `string` | `null` Defined in: [packages/sdk/src/types/member-types.ts:372](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L372) *** ### phoneTrusted?[​](#phonetrusted "Direct link to phoneTrusted?") > `optional` **phoneTrusted**: `boolean` | `null` Defined in: [packages/sdk/src/types/member-types.ts:377](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L377) *** ### timezone?[​](#timezone "Direct link to timezone?") > `optional` **timezone**: `string` | `null` Defined in: [packages/sdk/src/types/member-types.ts:385](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L385) *** ### tosAccepted?[​](#tosaccepted "Direct link to tosAccepted?") > `optional` **tosAccepted**: `boolean` Defined in: [packages/sdk/src/types/member-types.ts:386](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L386) --- # Interface: UploadFileRequest Defined in: [packages/sdk/src/types/file-types.ts:79](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/file-types.ts#L79) ## Properties[​](#properties "Direct link to Properties") ### access?[​](#access "Direct link to access?") > `optional` **access**: [`AccessLevel`](https://docs.gravityrail.com/sdk/enumerations/AccessLevel.md) Defined in: [packages/sdk/src/types/file-types.ts:89](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/file-types.ts#L89) *** ### data[​](#data "Direct link to data") > **data**: [`UploadFileData`](https://docs.gravityrail.com/sdk/type-aliases/UploadFileData.md) Defined in: [packages/sdk/src/types/file-types.ts:81](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/file-types.ts#L81) *** ### description?[​](#description "Direct link to description?") > `optional` **description**: `string` Defined in: [packages/sdk/src/types/file-types.ts:84](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/file-types.ts#L84) *** ### externalId?[​](#externalid "Direct link to externalId?") > `optional` **externalId**: `string` Defined in: [packages/sdk/src/types/file-types.ts:87](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/file-types.ts#L87) *** ### filename[​](#filename "Direct link to filename") > **filename**: `string` Defined in: [packages/sdk/src/types/file-types.ts:80](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/file-types.ts#L80) *** ### folderId?[​](#folderid "Direct link to folderId?") > `optional` **folderId**: `number` Defined in: [packages/sdk/src/types/file-types.ts:85](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/file-types.ts#L85) *** ### labelIds?[​](#labelids "Direct link to labelIds?") > `optional` **labelIds**: `number`\[] Defined in: [packages/sdk/src/types/file-types.ts:90](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/file-types.ts#L90) *** ### mimeType?[​](#mimetype "Direct link to mimeType?") > `optional` **mimeType**: `string` Defined in: [packages/sdk/src/types/file-types.ts:82](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/file-types.ts#L82) *** ### oauthCredentialUuid?[​](#oauthcredentialuuid "Direct link to oauthCredentialUuid?") > `optional` **oauthCredentialUuid**: `string` Defined in: [packages/sdk/src/types/file-types.ts:88](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/file-types.ts#L88) *** ### overwrite?[​](#overwrite "Direct link to overwrite?") > `optional` **overwrite**: `boolean` Defined in: [packages/sdk/src/types/file-types.ts:91](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/file-types.ts#L91) *** ### siteId?[​](#siteid "Direct link to siteId?") > `optional` **siteId**: `number` Defined in: [packages/sdk/src/types/file-types.ts:86](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/file-types.ts#L86) *** ### title?[​](#title "Direct link to title?") > `optional` **title**: `string` Defined in: [packages/sdk/src/types/file-types.ts:83](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/file-types.ts#L83) --- # Interface: UsageDiscrepancy Defined in: [packages/sdk/src/types/generated/billing.ts:380](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/billing.ts#L380) Discrepancy between platform and Stripe usage. ## Properties[​](#properties "Direct link to Properties") ### difference?[​](#difference "Direct link to difference?") > `optional` **difference**: `number` Defined in: [packages/sdk/src/types/generated/billing.ts:383](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/billing.ts#L383) *** ### platform?[​](#platform "Direct link to platform?") > `optional` **platform**: `number` Defined in: [packages/sdk/src/types/generated/billing.ts:381](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/billing.ts#L381) *** ### stripe?[​](#stripe "Direct link to stripe?") > `optional` **stripe**: `number` Defined in: [packages/sdk/src/types/generated/billing.ts:382](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/billing.ts#L382) --- # Interface: UsageProductSummaryResponse Defined in: [packages/sdk/src/types/generated/usage.ts:225](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/usage.ts#L225) Product summary for usage reporting. ## Properties[​](#properties "Direct link to Properties") ### id[​](#id "Direct link to id") > **id**: `number` Defined in: [packages/sdk/src/types/generated/usage.ts:226](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/usage.ts#L226) *** ### inclusions[​](#inclusions "Direct link to inclusions") > **inclusions**: `UsageProductSummaryResponseInclusions` Defined in: [packages/sdk/src/types/generated/usage.ts:228](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/usage.ts#L228) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/generated/usage.ts:227](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/usage.ts#L227) *** ### overages[​](#overages "Direct link to overages") > **overages**: `UsageProductSummaryResponseOverages` Defined in: [packages/sdk/src/types/generated/usage.ts:229](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/usage.ts#L229) --- # Interface: UsageReportRequest Defined in: [packages/sdk/src/types/usage-reporting-types.ts:58](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/usage-reporting-types.ts#L58) ## Properties[​](#properties "Direct link to Properties") ### endDate[​](#enddate "Direct link to endDate") > **endDate**: `string` Defined in: [packages/sdk/src/types/usage-reporting-types.ts:61](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/usage-reporting-types.ts#L61) *** ### startDate[​](#startdate "Direct link to startDate") > **startDate**: `string` Defined in: [packages/sdk/src/types/usage-reporting-types.ts:60](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/usage-reporting-types.ts#L60) *** ### workspaceUuids[​](#workspaceuuids "Direct link to workspaceUuids") > **workspaceUuids**: `string`\[] Defined in: [packages/sdk/src/types/usage-reporting-types.ts:59](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/usage-reporting-types.ts#L59) --- # Interface: UsageReportResponse Defined in: [packages/sdk/src/types/generated/usage.ts:239](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/usage.ts#L239) Usage report response. ## Properties[​](#properties "Direct link to Properties") ### summary[​](#summary "Direct link to summary") > **summary**: `UsageReportSummaryResponse` Defined in: [packages/sdk/src/types/generated/usage.ts:241](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/usage.ts#L241) *** ### workspaces[​](#workspaces "Direct link to workspaces") > **workspaces**: [`WorkspaceUsageReportResponse`](https://docs.gravityrail.com/sdk/interfaces/WorkspaceUsageReportResponse.md)\[] Defined in: [packages/sdk/src/types/generated/usage.ts:240](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/usage.ts#L240) --- # Interface: UsageStatistics Defined in: [packages/sdk/src/types/stats-types.ts:116](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/stats-types.ts#L116) ## Properties[​](#properties "Direct link to Properties") ### activeUsers[​](#activeusers "Direct link to activeUsers") > **activeUsers**: `number` Defined in: [packages/sdk/src/types/stats-types.ts:120](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/stats-types.ts#L120) *** ### apiCalls[​](#apicalls "Direct link to apiCalls") > **apiCalls**: `number` Defined in: [packages/sdk/src/types/stats-types.ts:117](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/stats-types.ts#L117) *** ### averageSessionDuration[​](#averagesessionduration "Direct link to averageSessionDuration") > **averageSessionDuration**: `number` Defined in: [packages/sdk/src/types/stats-types.ts:122](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/stats-types.ts#L122) *** ### bandwidthUsed[​](#bandwidthused "Direct link to bandwidthUsed") > **bandwidthUsed**: `number` Defined in: [packages/sdk/src/types/stats-types.ts:119](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/stats-types.ts#L119) *** ### peakConcurrentUsers[​](#peakconcurrentusers "Direct link to peakConcurrentUsers") > **peakConcurrentUsers**: `number` Defined in: [packages/sdk/src/types/stats-types.ts:121](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/stats-types.ts#L121) *** ### storageUsed[​](#storageused "Direct link to storageUsed") > **storageUsed**: `number` Defined in: [packages/sdk/src/types/stats-types.ts:118](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/stats-types.ts#L118) --- # Interface: ValidateMagicLinkRequest Defined in: [packages/sdk/src/types/account-types.ts:192](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L192) ## Properties[​](#properties "Direct link to Properties") ### token[​](#token "Direct link to token") > **token**: `string` Defined in: [packages/sdk/src/types/account-types.ts:193](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L193) --- # Interface: ValidateMagicLinkResponse Defined in: [packages/sdk/src/types/account-types.ts:196](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L196) ## Extends[​](#extends "Direct link to Extends") * [`VerifyCodeResponse`](https://docs.gravityrail.com/sdk/interfaces/VerifyCodeResponse.md) ## Properties[​](#properties "Direct link to Properties") ### accountId[​](#accountid "Direct link to accountId") > **accountId**: `number` Defined in: [packages/sdk/src/types/account-types.ts:137](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L137) #### Inherited from[​](#inherited-from "Direct link to Inherited from") [`VerifyCodeResponse`](https://docs.gravityrail.com/sdk/interfaces/VerifyCodeResponse.md).[`accountId`](https://docs.gravityrail.com/sdk/interfaces/VerifyCodeResponse.md#accountid) *** ### accountName?[​](#accountname "Direct link to accountName?") > `optional` **accountName**: `string` | `null` Defined in: [packages/sdk/src/types/account-types.ts:138](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L138) #### Inherited from[​](#inherited-from-1 "Direct link to Inherited from") [`VerifyCodeResponse`](https://docs.gravityrail.com/sdk/interfaces/VerifyCodeResponse.md).[`accountName`](https://docs.gravityrail.com/sdk/interfaces/VerifyCodeResponse.md#accountname) *** ### accountUuid?[​](#accountuuid "Direct link to accountUuid?") > `optional` **accountUuid**: `string` | `null` Defined in: [packages/sdk/src/types/account-types.ts:139](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L139) #### Inherited from[​](#inherited-from-2 "Direct link to Inherited from") [`VerifyCodeResponse`](https://docs.gravityrail.com/sdk/interfaces/VerifyCodeResponse.md).[`accountUuid`](https://docs.gravityrail.com/sdk/interfaces/VerifyCodeResponse.md#accountuuid) *** ### availableTwoFactorMethods?[​](#availabletwofactormethods "Direct link to availableTwoFactorMethods?") > `optional` **availableTwoFactorMethods**: `any`\[] Defined in: [packages/sdk/src/types/account-types.ts:141](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L141) #### Inherited from[​](#inherited-from-3 "Direct link to Inherited from") [`VerifyCodeResponse`](https://docs.gravityrail.com/sdk/interfaces/VerifyCodeResponse.md).[`availableTwoFactorMethods`](https://docs.gravityrail.com/sdk/interfaces/VerifyCodeResponse.md#availabletwofactormethods) *** ### redirectUrl?[​](#redirecturl "Direct link to redirectUrl?") > `optional` **redirectUrl**: `string` Defined in: [packages/sdk/src/types/account-types.ts:204](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L204) *** ### requiresTwoFactor?[​](#requirestwofactor "Direct link to requiresTwoFactor?") > `optional` **requiresTwoFactor**: `boolean` Defined in: [packages/sdk/src/types/account-types.ts:140](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L140) #### Inherited from[​](#inherited-from-4 "Direct link to Inherited from") [`VerifyCodeResponse`](https://docs.gravityrail.com/sdk/interfaces/VerifyCodeResponse.md).[`requiresTwoFactor`](https://docs.gravityrail.com/sdk/interfaces/VerifyCodeResponse.md#requirestwofactor) *** ### success[​](#success "Direct link to success") > **success**: `boolean` Defined in: [packages/sdk/src/types/account-types.ts:201](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L201) *** ### token[​](#token "Direct link to token") > **token**: `string` Defined in: [packages/sdk/src/types/account-types.ts:136](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L136) #### Inherited from[​](#inherited-from-5 "Direct link to Inherited from") [`VerifyCodeResponse`](https://docs.gravityrail.com/sdk/interfaces/VerifyCodeResponse.md).[`token`](https://docs.gravityrail.com/sdk/interfaces/VerifyCodeResponse.md#token) --- # Interface: ValidateQueryResponse Defined in: [packages/sdk/src/types/query-engine-types.ts:250](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L250) ## Properties[​](#properties "Direct link to Properties") ### cost[​](#cost "Direct link to cost") > **cost**: [`QueryCostInfo`](https://docs.gravityrail.com/sdk/interfaces/QueryCostInfo.md) Defined in: [packages/sdk/src/types/query-engine-types.ts:252](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L252) *** ### errors[​](#errors "Direct link to errors") > **errors**: `string`\[] Defined in: [packages/sdk/src/types/query-engine-types.ts:254](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L254) *** ### valid[​](#valid "Direct link to valid") > **valid**: `boolean` Defined in: [packages/sdk/src/types/query-engine-types.ts:251](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L251) *** ### warnings[​](#warnings "Direct link to warnings") > **warnings**: `string`\[] Defined in: [packages/sdk/src/types/query-engine-types.ts:253](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L253) --- # Interface: VariableRegistryRequest Defined in: [packages/sdk/src/api/templates.ts:70](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/templates.ts#L70) Parameters for requesting variables from the registry. ## Properties[​](#properties "Direct link to Properties") ### eventType?[​](#eventtype "Direct link to eventType?") > `optional` **eventType**: `string` Defined in: [packages/sdk/src/api/templates.ts:71](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/templates.ts#L71) *** ### includeDeprecated?[​](#includedeprecated "Direct link to includeDeprecated?") > `optional` **includeDeprecated**: `boolean` Defined in: [packages/sdk/src/api/templates.ts:72](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/templates.ts#L72) --- # Interface: VariableRegistryResponse Defined in: [packages/sdk/src/api/templates.ts:78](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/templates.ts#L78) Response containing variables from the central registry. ## Properties[​](#properties "Direct link to Properties") ### namespaces[​](#namespaces "Direct link to namespaces") > **namespaces**: `string`\[] Defined in: [packages/sdk/src/api/templates.ts:80](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/templates.ts#L80) *** ### sampleContext[​](#samplecontext "Direct link to sampleContext") > **sampleContext**: `Record`<`string`, `any`> Defined in: [packages/sdk/src/api/templates.ts:81](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/templates.ts#L81) *** ### variables[​](#variables "Direct link to variables") > **variables**: [`RegistryVariable`](https://docs.gravityrail.com/sdk/interfaces/RegistryVariable.md)\[] Defined in: [packages/sdk/src/api/templates.ts:79](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/templates.ts#L79) --- # Interface: VerifyCodeRequest Defined in: [packages/sdk/src/types/account-types.ts:129](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L129) ## Properties[​](#properties "Direct link to Properties") ### code[​](#code "Direct link to code") > **code**: `string` Defined in: [packages/sdk/src/types/account-types.ts:131](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L131) *** ### organizationUuid?[​](#organizationuuid "Direct link to organizationUuid?") > `optional` **organizationUuid**: `string` Defined in: [packages/sdk/src/types/account-types.ts:132](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L132) *** ### phoneNumber[​](#phonenumber "Direct link to phoneNumber") > **phoneNumber**: `string` Defined in: [packages/sdk/src/types/account-types.ts:130](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L130) --- # Interface: VerifyCodeResponse Defined in: [packages/sdk/src/types/account-types.ts:135](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L135) ## Extended by[​](#extended-by "Direct link to Extended by") * [`ValidateMagicLinkResponse`](https://docs.gravityrail.com/sdk/interfaces/ValidateMagicLinkResponse.md) ## Properties[​](#properties "Direct link to Properties") ### accountId[​](#accountid "Direct link to accountId") > **accountId**: `number` Defined in: [packages/sdk/src/types/account-types.ts:137](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L137) *** ### accountName?[​](#accountname "Direct link to accountName?") > `optional` **accountName**: `string` | `null` Defined in: [packages/sdk/src/types/account-types.ts:138](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L138) *** ### accountUuid?[​](#accountuuid "Direct link to accountUuid?") > `optional` **accountUuid**: `string` | `null` Defined in: [packages/sdk/src/types/account-types.ts:139](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L139) *** ### availableTwoFactorMethods?[​](#availabletwofactormethods "Direct link to availableTwoFactorMethods?") > `optional` **availableTwoFactorMethods**: `any`\[] Defined in: [packages/sdk/src/types/account-types.ts:141](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L141) *** ### requiresTwoFactor?[​](#requirestwofactor "Direct link to requiresTwoFactor?") > `optional` **requiresTwoFactor**: `boolean` Defined in: [packages/sdk/src/types/account-types.ts:140](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L140) *** ### token[​](#token "Direct link to token") > **token**: `string` Defined in: [packages/sdk/src/types/account-types.ts:136](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L136) --- # Interface: VerifyCredentialChangeRequest Defined in: [packages/sdk/src/types/account-types.ts:481](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L481) ## Properties[​](#properties "Direct link to Properties") ### otpCode[​](#otpcode "Direct link to otpCode") > **otpCode**: `string` Defined in: [packages/sdk/src/types/account-types.ts:483](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L483) *** ### requestId[​](#requestid "Direct link to requestId") > **requestId**: `number` Defined in: [packages/sdk/src/types/account-types.ts:482](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L482) --- # Interface: VerifyEmailRequest Defined in: [packages/sdk/src/types/account-types.ts:167](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L167) ## Properties[​](#properties "Direct link to Properties") ### code[​](#code "Direct link to code") > **code**: `string` Defined in: [packages/sdk/src/types/account-types.ts:169](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L169) *** ### email[​](#email "Direct link to email") > **email**: `string` Defined in: [packages/sdk/src/types/account-types.ts:168](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L168) *** ### organizationUuid?[​](#organizationuuid "Direct link to organizationUuid?") > `optional` **organizationUuid**: `string` Defined in: [packages/sdk/src/types/account-types.ts:170](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L170) --- # Interface: VerifyTOTPSetupRequest Defined in: [packages/sdk/src/types/account-types.ts:365](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L365) ## Properties[​](#properties "Direct link to Properties") ### code[​](#code "Direct link to code") > **code**: `string` Defined in: [packages/sdk/src/types/account-types.ts:367](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L367) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/account-types.ts:368](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L368) *** ### setupId[​](#setupid "Direct link to setupId") > **setupId**: `string` Defined in: [packages/sdk/src/types/account-types.ts:366](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L366) --- # Interface: VerifyWebAuthnSetupRequest Defined in: [packages/sdk/src/types/account-types.ts:375](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L375) ## Properties[​](#properties "Direct link to Properties") ### credentialResponse[​](#credentialresponse "Direct link to credentialResponse") > **credentialResponse**: `any` Defined in: [packages/sdk/src/types/account-types.ts:377](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L377) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/account-types.ts:378](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L378) *** ### setupId[​](#setupid "Direct link to setupId") > **setupId**: `string` Defined in: [packages/sdk/src/types/account-types.ts:376](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L376) --- # Interface: VoiceMetricsTimeRange Defined in: [packages/sdk/src/types/generated/voice\_metrics.ts:87](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/voice_metrics.ts#L87) ## Properties[​](#properties "Direct link to Properties") ### end[​](#end "Direct link to end") > **end**: `string` Defined in: [packages/sdk/src/types/generated/voice\_metrics.ts:89](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/voice_metrics.ts#L89) *** ### hours[​](#hours "Direct link to hours") > **hours**: `number` Defined in: [packages/sdk/src/types/generated/voice\_metrics.ts:90](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/voice_metrics.ts#L90) *** ### periodSeconds[​](#periodseconds "Direct link to periodSeconds") > **periodSeconds**: `number` Defined in: [packages/sdk/src/types/generated/voice\_metrics.ts:91](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/voice_metrics.ts#L91) *** ### start[​](#start "Direct link to start") > **start**: `string` Defined in: [packages/sdk/src/types/generated/voice\_metrics.ts:88](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/voice_metrics.ts#L88) --- # Interface: VoiceTokenResponse Defined in: [packages/sdk/src/types/generated/communication.ts:471](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L471) ## Properties[​](#properties "Direct link to Properties") ### identity[​](#identity "Direct link to identity") > **identity**: `string` Defined in: [packages/sdk/src/types/generated/communication.ts:473](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L473) *** ### token[​](#token "Direct link to token") > **token**: `string` Defined in: [packages/sdk/src/types/generated/communication.ts:472](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/communication.ts#L472) --- # Interface: VoiceUsageReport Defined in: [packages/sdk/src/types/generated/reports.ts:200](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/reports.ts#L200) Complete voice usage report for a workspace. ## Properties[​](#properties "Direct link to Properties") ### reportPeriodEnd[​](#reportperiodend "Direct link to reportPeriodEnd") > **reportPeriodEnd**: `string` Defined in: [packages/sdk/src/types/generated/reports.ts:205](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/reports.ts#L205) *** ### reportPeriodStart[​](#reportperiodstart "Direct link to reportPeriodStart") > **reportPeriodStart**: `string` Defined in: [packages/sdk/src/types/generated/reports.ts:204](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/reports.ts#L204) *** ### sttByProvider[​](#sttbyprovider "Direct link to sttByProvider") > **sttByProvider**: [`STTProviderSummary`](https://docs.gravityrail.com/sdk/interfaces/STTProviderSummary.md)\[] Defined in: [packages/sdk/src/types/generated/reports.ts:210](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/reports.ts#L210) *** ### sttRows[​](#sttrows "Direct link to sttRows") > **sttRows**: [`STTUsageRow`](https://docs.gravityrail.com/sdk/interfaces/STTUsageRow.md)\[] Defined in: [packages/sdk/src/types/generated/reports.ts:212](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/reports.ts#L212) *** ### totalSttDurationSeconds[​](#totalsttdurationseconds "Direct link to totalSttDurationSeconds") > **totalSttDurationSeconds**: `number` Defined in: [packages/sdk/src/types/generated/reports.ts:206](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/reports.ts#L206) *** ### totalSttMessages[​](#totalsttmessages "Direct link to totalSttMessages") > **totalSttMessages**: `number` Defined in: [packages/sdk/src/types/generated/reports.ts:207](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/reports.ts#L207) *** ### totalTtsCharacters[​](#totalttscharacters "Direct link to totalTtsCharacters") > **totalTtsCharacters**: `number` Defined in: [packages/sdk/src/types/generated/reports.ts:208](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/reports.ts#L208) *** ### totalTtsMessages[​](#totalttsmessages "Direct link to totalTtsMessages") > **totalTtsMessages**: `number` Defined in: [packages/sdk/src/types/generated/reports.ts:209](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/reports.ts#L209) *** ### ttsByProvider[​](#ttsbyprovider "Direct link to ttsByProvider") > **ttsByProvider**: [`TTSProviderSummary`](https://docs.gravityrail.com/sdk/interfaces/TTSProviderSummary.md)\[] Defined in: [packages/sdk/src/types/generated/reports.ts:211](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/reports.ts#L211) *** ### ttsRows[​](#ttsrows "Direct link to ttsRows") > **ttsRows**: [`TTSUsageRow`](https://docs.gravityrail.com/sdk/interfaces/TTSUsageRow.md)\[] Defined in: [packages/sdk/src/types/generated/reports.ts:213](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/reports.ts#L213) *** ### workspaceId[​](#workspaceid "Direct link to workspaceId") > **workspaceId**: `string` Defined in: [packages/sdk/src/types/generated/reports.ts:201](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/reports.ts#L201) *** ### workspaceName[​](#workspacename "Direct link to workspaceName") > **workspaceName**: `string` Defined in: [packages/sdk/src/types/generated/reports.ts:203](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/reports.ts#L203) *** ### workspaceUuid[​](#workspaceuuid "Direct link to workspaceUuid") > **workspaceUuid**: `string` Defined in: [packages/sdk/src/types/generated/reports.ts:202](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/reports.ts#L202) --- # Interface: VoiceUsageReportParams Defined in: [packages/sdk/src/api/reports.ts:54](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/reports.ts#L54) ## Properties[​](#properties "Direct link to Properties") ### end\_date?[​](#end_date "Direct link to end_date?") > `optional` **end\_date**: `string` Defined in: [packages/sdk/src/api/reports.ts:56](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/reports.ts#L56) *** ### start\_date?[​](#start_date "Direct link to start_date?") > `optional` **start\_date**: `string` Defined in: [packages/sdk/src/api/reports.ts:55](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/reports.ts#L55) --- # Interface: VoiceUsageResponse Defined in: [packages/sdk/src/types/generated/chat.ts:567](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L567) STT or TTS usage for a specific model. ## Properties[​](#properties "Direct link to Properties") ### characterCount?[​](#charactercount "Direct link to characterCount?") > `optional` **characterCount**: `number` | `null` Defined in: [packages/sdk/src/types/generated/chat.ts:572](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L572) *** ### credits[​](#credits "Direct link to credits") > **credits**: `number` Defined in: [packages/sdk/src/types/generated/chat.ts:569](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L569) *** ### durationSeconds?[​](#durationseconds "Direct link to durationSeconds?") > `optional` **durationSeconds**: `number` | `null` Defined in: [packages/sdk/src/types/generated/chat.ts:571](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L571) *** ### model[​](#model "Direct link to model") > **model**: `string` Defined in: [packages/sdk/src/types/generated/chat.ts:568](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L568) *** ### multiplier[​](#multiplier "Direct link to multiplier") > **multiplier**: `number` Defined in: [packages/sdk/src/types/generated/chat.ts:570](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/chat.ts#L570) --- # Interface: WebhookActionParams Defined in: [packages/sdk/src/types/event-types.ts:209](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L209) ## Properties[​](#properties "Direct link to Properties") ### signingSecret?[​](#signingsecret "Direct link to signingSecret?") > `optional` **signingSecret**: `string` Defined in: [packages/sdk/src/types/event-types.ts:211](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L211) *** ### webhookUrl[​](#webhookurl "Direct link to webhookUrl") > **webhookUrl**: `string` Defined in: [packages/sdk/src/types/event-types.ts:210](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L210) --- # Interface: WebhookLogResponse Defined in: [packages/sdk/src/types/generated/rule\_execution.ts:37](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/rule_execution.ts#L37) Response model for WebhookLog entity ## Properties[​](#properties "Direct link to Properties") ### createdAt[​](#createdat "Direct link to createdAt") > **createdAt**: `string` Defined in: [packages/sdk/src/types/generated/rule\_execution.ts:47](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/rule_execution.ts#L47) *** ### errorMessage?[​](#errormessage "Direct link to errorMessage?") > `optional` **errorMessage**: `string` | `null` Defined in: [packages/sdk/src/types/generated/rule\_execution.ts:46](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/rule_execution.ts#L46) *** ### eventType[​](#eventtype "Direct link to eventType") > **eventType**: `string` Defined in: [packages/sdk/src/types/generated/rule\_execution.ts:43](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/rule_execution.ts#L43) *** ### id[​](#id "Direct link to id") > **id**: `number` Defined in: [packages/sdk/src/types/generated/rule\_execution.ts:38](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/rule_execution.ts#L38) *** ### memberId?[​](#memberid "Direct link to memberId?") > `optional` **memberId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/rule\_execution.ts:41](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/rule_execution.ts#L41) *** ### record?[​](#record "Direct link to record?") > `optional` **record**: [`DataRecordResponse`](https://docs.gravityrail.com/sdk/interfaces/DataRecordResponse.md) | `null` Defined in: [packages/sdk/src/types/generated/rule\_execution.ts:49](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/rule_execution.ts#L49) *** ### recordId?[​](#recordid "Direct link to recordId?") > `optional` **recordId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/rule\_execution.ts:40](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/rule_execution.ts#L40) *** ### rule?[​](#rule "Direct link to rule?") > `optional` **rule**: `EventRuleResponse` | `null` Defined in: [packages/sdk/src/types/generated/rule\_execution.ts:48](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/rule_execution.ts#L48) *** ### ruleId?[​](#ruleid "Direct link to ruleId?") > `optional` **ruleId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/rule\_execution.ts:39](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/rule_execution.ts#L39) *** ### statusCode?[​](#statuscode "Direct link to statusCode?") > `optional` **statusCode**: `number` | `null` Defined in: [packages/sdk/src/types/generated/rule\_execution.ts:44](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/rule_execution.ts#L44) *** ### success[​](#success "Direct link to success") > **success**: `boolean` Defined in: [packages/sdk/src/types/generated/rule\_execution.ts:45](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/rule_execution.ts#L45) *** ### url[​](#url "Direct link to url") > **url**: `string` Defined in: [packages/sdk/src/types/generated/rule\_execution.ts:42](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/rule_execution.ts#L42) --- # Interface: WebhookLogsQueryParams Defined in: [packages/sdk/src/types/event-types.ts:528](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L528) ## Properties[​](#properties "Direct link to Properties") ### eventType?[​](#eventtype "Direct link to eventType?") > `optional` **eventType**: [`EventRuleEventType`](https://docs.gravityrail.com/sdk/enumerations/EventRuleEventType.md) Defined in: [packages/sdk/src/types/event-types.ts:533](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L533) *** ### page?[​](#page "Direct link to page?") > `optional` **page**: `number` Defined in: [packages/sdk/src/types/event-types.ts:529](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L529) *** ### pageSize?[​](#pagesize "Direct link to pageSize?") > `optional` **pageSize**: `number` Defined in: [packages/sdk/src/types/event-types.ts:530](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L530) *** ### sortBy?[​](#sortby "Direct link to sortBy?") > `optional` **sortBy**: `"createdAt"` Defined in: [packages/sdk/src/types/event-types.ts:531](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L531) *** ### sortOrder?[​](#sortorder "Direct link to sortOrder?") > `optional` **sortOrder**: [`SortOrder`](https://docs.gravityrail.com/sdk/type-aliases/SortOrder.md) Defined in: [packages/sdk/src/types/event-types.ts:532](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L532) *** ### success?[​](#success "Direct link to success?") > `optional` **success**: `boolean` Defined in: [packages/sdk/src/types/event-types.ts:534](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L534) --- # Interface: WebhookMetrics Defined in: [packages/sdk/src/types/generated/health\_dashboard.ts:79](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/health_dashboard.ts#L79) Webhook delivery failure and volume counts. ## Properties[​](#properties "Direct link to Properties") ### failures?[​](#failures "Direct link to failures?") > `optional` **failures**: `number` Defined in: [packages/sdk/src/types/generated/health\_dashboard.ts:80](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/health_dashboard.ts#L80) *** ### total?[​](#total "Direct link to total?") > `optional` **total**: `number` Defined in: [packages/sdk/src/types/generated/health\_dashboard.ts:81](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/health_dashboard.ts#L81) --- # Interface: WebSearchAbilityConfig Defined in: [packages/sdk/src/types/ability-types.ts:258](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ability-types.ts#L258) Config for web\_search ability ## Properties[​](#properties "Direct link to Properties") ### local?[​](#local "Direct link to local?") > `optional` **local**: `boolean` Defined in: [packages/sdk/src/types/ability-types.ts:262](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ability-types.ts#L262) Enable local search for businesses, restaurants, and POIs (default: false) *** ### web?[​](#web "Direct link to web?") > `optional` **web**: `boolean` Defined in: [packages/sdk/src/types/ability-types.ts:260](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ability-types.ts#L260) Enable web search capability (default: true) --- # Interface: WorkflowAccessGapSummary Defined in: [packages/sdk/src/types/generated/task.ts:313](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L313) Summary of access gaps for a single workflow in bulk validation. ## Properties[​](#properties "Direct link to Properties") ### warnings[​](#warnings "Direct link to warnings") > **warnings**: [`WorkflowAccessWarning`](https://docs.gravityrail.com/sdk/interfaces/WorkflowAccessWarning.md)\[] Defined in: [packages/sdk/src/types/generated/task.ts:316](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L316) *** ### workflowId[​](#workflowid "Direct link to workflowId") > **workflowId**: `number` Defined in: [packages/sdk/src/types/generated/task.ts:314](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L314) *** ### workflowName[​](#workflowname "Direct link to workflowName") > **workflowName**: `string` Defined in: [packages/sdk/src/types/generated/task.ts:315](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L315) --- # Interface: WorkflowAccessValidationResponse Defined in: [packages/sdk/src/types/generated/task.ts:322](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L322) Response model for workflow access validation warnings. ## Properties[​](#properties "Direct link to Properties") ### warnings[​](#warnings "Direct link to warnings") > **warnings**: [`WorkflowAccessWarning`](https://docs.gravityrail.com/sdk/interfaces/WorkflowAccessWarning.md)\[] Defined in: [packages/sdk/src/types/generated/task.ts:323](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L323) --- # Interface: WorkflowAccessWarning Defined in: [packages/sdk/src/types/generated/task.ts:329](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L329) Warning about a role that has workflow access but lacks access to a dependency. ## Properties[​](#properties "Direct link to Properties") ### abilityType[​](#abilitytype "Direct link to abilityType") > **abilityType**: `string` Defined in: [packages/sdk/src/types/generated/task.ts:334](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L334) *** ### neededAccess[​](#neededaccess "Direct link to neededAccess") > **neededAccess**: `string` Defined in: [packages/sdk/src/types/generated/task.ts:338](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L338) *** ### neededAccessMask[​](#neededaccessmask "Direct link to neededAccessMask") > **neededAccessMask**: `number` Defined in: [packages/sdk/src/types/generated/task.ts:339](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L339) *** ### resourceId[​](#resourceid "Direct link to resourceId") > **resourceId**: `number` Defined in: [packages/sdk/src/types/generated/task.ts:336](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L336) *** ### resourceName[​](#resourcename "Direct link to resourceName") > **resourceName**: `string` Defined in: [packages/sdk/src/types/generated/task.ts:337](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L337) *** ### resourceType[​](#resourcetype "Direct link to resourceType") > **resourceType**: [`WorkflowAccessWarningResourceType`](https://docs.gravityrail.com/sdk/type-aliases/WorkflowAccessWarningResourceType.md) Defined in: [packages/sdk/src/types/generated/task.ts:335](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L335) *** ### roleId[​](#roleid "Direct link to roleId") > **roleId**: `number` Defined in: [packages/sdk/src/types/generated/task.ts:330](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L330) *** ### roleName[​](#rolename "Direct link to roleName") > **roleName**: `string` Defined in: [packages/sdk/src/types/generated/task.ts:331](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L331) *** ### taskId[​](#taskid "Direct link to taskId") > **taskId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/task.ts:332](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L332) *** ### taskName[​](#taskname "Direct link to taskName") > **taskName**: `string` | `null` Defined in: [packages/sdk/src/types/generated/task.ts:333](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L333) --- # Interface: WorkflowActivity Defined in: [packages/sdk/src/types/task-types.ts:171](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/task-types.ts#L171) ## Properties[​](#properties "Direct link to Properties") ### chatCount[​](#chatcount "Direct link to chatCount") > **chatCount**: `number` Defined in: [packages/sdk/src/types/task-types.ts:172](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/task-types.ts#L172) *** ### sparklineData[​](#sparklinedata "Direct link to sparklineData") > **sparklineData**: `number`\[] Defined in: [packages/sdk/src/types/task-types.ts:173](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/task-types.ts#L173) --- # Interface: WorkflowConfigValidationResponse Defined in: [packages/sdk/src/types/generated/task.ts:359](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L359) Response model for workflow config-validation (drift) diagnostics. Separate from :class:`WorkflowAccessValidationResponse` because access gaps are role-centric and have a specific remediation path, while config issues describe drift in an ability's own references. ## Properties[​](#properties "Direct link to Properties") ### issues[​](#issues "Direct link to issues") > **issues**: [`AbilityConfigIssue`](https://docs.gravityrail.com/sdk/interfaces/AbilityConfigIssue.md)\[] Defined in: [packages/sdk/src/types/generated/task.ts:360](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L360) --- # Interface: WorkflowContext Defined in: [packages/sdk/src/app-context.ts:29](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/app-context.ts#L29) Information about a workflow in the context ## Properties[​](#properties "Direct link to Properties") ### id[​](#id "Direct link to id") > **id**: `number` Defined in: [packages/sdk/src/app-context.ts:30](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/app-context.ts#L30) *** ### name?[​](#name "Direct link to name?") > `optional` **name**: `string` Defined in: [packages/sdk/src/app-context.ts:31](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/app-context.ts#L31) *** ### selectedTask?[​](#selectedtask "Direct link to selectedTask?") > `optional` **selectedTask**: [`TaskContext`](https://docs.gravityrail.com/sdk/interfaces/TaskContext.md) Defined in: [packages/sdk/src/app-context.ts:32](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/app-context.ts#L32) --- # Interface: WorkflowContributorResponse Defined in: [packages/sdk/src/types/generated/task.ts:366](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L366) Response model for workflow contributor. ## Properties[​](#properties "Direct link to Properties") ### channels[​](#channels "Direct link to channels") > **channels**: `string`\[] Defined in: [packages/sdk/src/types/generated/task.ts:371](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L371) *** ### createdAt[​](#createdat "Direct link to createdAt") > **createdAt**: `string` Defined in: [packages/sdk/src/types/generated/task.ts:373](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L373) *** ### hint?[​](#hint "Direct link to hint?") > `optional` **hint**: `string` | `null` Defined in: [packages/sdk/src/types/generated/task.ts:372](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L372) *** ### id[​](#id "Direct link to id") > **id**: `number` Defined in: [packages/sdk/src/types/generated/task.ts:367](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L367) *** ### memberId[​](#memberid "Direct link to memberId") > **memberId**: `number` Defined in: [packages/sdk/src/types/generated/task.ts:369](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L369) *** ### title[​](#title "Direct link to title") > **title**: `string` Defined in: [packages/sdk/src/types/generated/task.ts:370](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L370) *** ### updatedAt[​](#updatedat "Direct link to updatedAt") > **updatedAt**: `string` Defined in: [packages/sdk/src/types/generated/task.ts:374](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L374) *** ### workflowId[​](#workflowid "Direct link to workflowId") > **workflowId**: `number` Defined in: [packages/sdk/src/types/generated/task.ts:368](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L368) --- # Interface: WorkflowExport Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:9](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L9) ## Properties[​](#properties "Direct link to Properties") ### assistantUuid?[​](#assistantuuid "Direct link to assistantUuid?") > `optional` **assistantUuid**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:15](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L15) *** ### defaultTaskUuid?[​](#defaulttaskuuid "Direct link to defaultTaskUuid?") > `optional` **defaultTaskUuid**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:14](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L14) *** ### description?[​](#description "Direct link to description?") > `optional` **description**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:13](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L13) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:11](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L11) *** ### slug[​](#slug "Direct link to slug") > **slug**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:12](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L12) *** ### uuid[​](#uuid "Direct link to uuid") > **uuid**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:10](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L10) --- # Interface: WorkflowFormData Defined in: [packages/sdk/src/types/task-types.ts:176](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/task-types.ts#L176) ## Properties[​](#properties "Direct link to Properties") ### abilities?[​](#abilities "Direct link to abilities?") > `optional` **abilities**: [`AbilityResponse`](https://docs.gravityrail.com/sdk/type-aliases/AbilityResponse.md)\[] Defined in: [packages/sdk/src/types/task-types.ts:198](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/task-types.ts#L198) *** ### agentId?[​](#agentid "Direct link to agentId?") > `optional` **agentId**: `number` | `null` Defined in: [packages/sdk/src/types/task-types.ts:183](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/task-types.ts#L183) *** ### chatModelConfig?[​](#chatmodelconfig "Direct link to chatModelConfig?") > `optional` **chatModelConfig**: `Record`<`string`, `unknown`> | `null` Defined in: [packages/sdk/src/types/task-types.ts:186](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/task-types.ts#L186) *** ### chatModelId?[​](#chatmodelid "Direct link to chatModelId?") > `optional` **chatModelId**: `string` | `null` Defined in: [packages/sdk/src/types/task-types.ts:185](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/task-types.ts#L185) *** ### contributorIds?[​](#contributorids "Direct link to contributorIds?") > `optional` **contributorIds**: `number`\[] Defined in: [packages/sdk/src/types/task-types.ts:194](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/task-types.ts#L194) *** ### createMode?[​](#createmode "Direct link to createMode?") > `optional` **createMode**: `"task"` | `"taskless"` Defined in: [packages/sdk/src/types/task-types.ts:189](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/task-types.ts#L189) *** ### defaultInboxId?[​](#defaultinboxid "Direct link to defaultInboxId?") > `optional` **defaultInboxId**: `number` | `null` Defined in: [packages/sdk/src/types/task-types.ts:191](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/task-types.ts#L191) *** ### defaultPhoneNumberId?[​](#defaultphonenumberid "Direct link to defaultPhoneNumberId?") > `optional` **defaultPhoneNumberId**: `number` | `null` Defined in: [packages/sdk/src/types/task-types.ts:190](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/task-types.ts#L190) *** ### defaultTaskDescription?[​](#defaulttaskdescription "Direct link to defaultTaskDescription?") > `optional` **defaultTaskDescription**: `string` Defined in: [packages/sdk/src/types/task-types.ts:196](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/task-types.ts#L196) *** ### defaultTaskName?[​](#defaulttaskname "Direct link to defaultTaskName?") > `optional` **defaultTaskName**: `string` Defined in: [packages/sdk/src/types/task-types.ts:195](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/task-types.ts#L195) *** ### defaultTaskPrompt?[​](#defaulttaskprompt "Direct link to defaultTaskPrompt?") > `optional` **defaultTaskPrompt**: `string` Defined in: [packages/sdk/src/types/task-types.ts:197](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/task-types.ts#L197) *** ### description?[​](#description "Direct link to description?") > `optional` **description**: `string` Defined in: [packages/sdk/src/types/task-types.ts:179](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/task-types.ts#L179) *** ### eventRules?[​](#eventrules "Direct link to eventRules?") > `optional` **eventRules**: [`EventRuleInput`](https://docs.gravityrail.com/sdk/interfaces/EventRuleInput.md)\[] Defined in: [packages/sdk/src/types/task-types.ts:199](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/task-types.ts#L199) *** ### memberRoleAccess?[​](#memberroleaccess "Direct link to memberRoleAccess?") > `optional` **memberRoleAccess**: [`WorkflowMemberRoleAccessInput`](https://docs.gravityrail.com/sdk/interfaces/WorkflowMemberRoleAccessInput.md)\[] Defined in: [packages/sdk/src/types/task-types.ts:200](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/task-types.ts#L200) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/task-types.ts:177](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/task-types.ts#L177) *** ### ownerId?[​](#ownerid "Direct link to ownerId?") > `optional` **ownerId**: `number` Defined in: [packages/sdk/src/types/task-types.ts:181](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/task-types.ts#L181) *** ### posX?[​](#posx "Direct link to posX?") > `optional` **posX**: `number` | `null` Defined in: [packages/sdk/src/types/task-types.ts:192](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/task-types.ts#L192) *** ### posY?[​](#posy "Direct link to posY?") > `optional` **posY**: `number` | `null` Defined in: [packages/sdk/src/types/task-types.ts:193](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/task-types.ts#L193) *** ### prompt?[​](#prompt "Direct link to prompt?") > `optional` **prompt**: `string` Defined in: [packages/sdk/src/types/task-types.ts:180](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/task-types.ts#L180) *** ### realtimeModelConfig?[​](#realtimemodelconfig "Direct link to realtimeModelConfig?") > `optional` **realtimeModelConfig**: `Record`<`string`, `unknown`> | `null` Defined in: [packages/sdk/src/types/task-types.ts:188](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/task-types.ts#L188) *** ### realtimeModelId?[​](#realtimemodelid "Direct link to realtimeModelId?") > `optional` **realtimeModelId**: `string` | `null` Defined in: [packages/sdk/src/types/task-types.ts:187](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/task-types.ts#L187) *** ### slug?[​](#slug "Direct link to slug?") > `optional` **slug**: `string` Defined in: [packages/sdk/src/types/task-types.ts:178](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/task-types.ts#L178) *** ### startTaskId?[​](#starttaskid "Direct link to startTaskId?") > `optional` **startTaskId**: `number` | `null` Defined in: [packages/sdk/src/types/task-types.ts:182](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/task-types.ts#L182) --- # Interface: WorkflowMemberRoleAccessInput Defined in: [packages/sdk/src/types/task-types.ts:143](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/task-types.ts#L143) ## Properties[​](#properties "Direct link to Properties") ### accessMode[​](#accessmode "Direct link to accessMode") > **accessMode**: `number` Defined in: [packages/sdk/src/types/task-types.ts:146](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/task-types.ts#L146) *** ### memberRoleId[​](#memberroleid "Direct link to memberRoleId") > **memberRoleId**: `number` Defined in: [packages/sdk/src/types/task-types.ts:144](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/task-types.ts#L144) *** ### memberRoleName?[​](#memberrolename "Direct link to memberRoleName?") > `optional` **memberRoleName**: `string` Defined in: [packages/sdk/src/types/task-types.ts:145](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/task-types.ts#L145) --- # Interface: WorkflowNoteExport Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:290](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L290) ## Properties[​](#properties "Direct link to Properties") ### contents[​](#contents "Direct link to contents") > **contents**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:297](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L297) *** ### height[​](#height "Direct link to height") > **height**: `number` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:296](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L296) *** ### posX[​](#posx "Direct link to posX") > **posX**: `number` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:293](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L293) *** ### posY[​](#posy "Direct link to posY") > **posY**: `number` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:294](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L294) *** ### uuid[​](#uuid "Direct link to uuid") > **uuid**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:291](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L291) *** ### width[​](#width "Direct link to width") > **width**: `number` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:295](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L295) *** ### workflowUuid[​](#workflowuuid "Direct link to workflowUuid") > **workflowUuid**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:292](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L292) --- # Interface: WorkflowNoteFormData Defined in: [packages/sdk/src/types/task-types.ts:149](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/task-types.ts#L149) ## Properties[​](#properties "Direct link to Properties") ### contents?[​](#contents "Direct link to contents?") > `optional` **contents**: `string` Defined in: [packages/sdk/src/types/task-types.ts:154](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/task-types.ts#L154) *** ### height?[​](#height "Direct link to height?") > `optional` **height**: `number` Defined in: [packages/sdk/src/types/task-types.ts:153](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/task-types.ts#L153) *** ### posX[​](#posx "Direct link to posX") > **posX**: `number` Defined in: [packages/sdk/src/types/task-types.ts:150](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/task-types.ts#L150) *** ### posY[​](#posy "Direct link to posY") > **posY**: `number` Defined in: [packages/sdk/src/types/task-types.ts:151](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/task-types.ts#L151) *** ### width?[​](#width "Direct link to width?") > `optional` **width**: `number` Defined in: [packages/sdk/src/types/task-types.ts:152](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/task-types.ts#L152) --- # Interface: WorkflowNoteResponse Defined in: [packages/sdk/src/types/generated/task.ts:389](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L389) Response model for workflow note. ## Properties[​](#properties "Direct link to Properties") ### contents[​](#contents "Direct link to contents") > **contents**: `string` Defined in: [packages/sdk/src/types/generated/task.ts:397](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L397) *** ### createdAt[​](#createdat "Direct link to createdAt") > **createdAt**: `string` Defined in: [packages/sdk/src/types/generated/task.ts:398](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L398) *** ### height[​](#height "Direct link to height") > **height**: `number` Defined in: [packages/sdk/src/types/generated/task.ts:396](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L396) *** ### id[​](#id "Direct link to id") > **id**: `number` Defined in: [packages/sdk/src/types/generated/task.ts:390](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L390) *** ### posX[​](#posx "Direct link to posX") > **posX**: `number` Defined in: [packages/sdk/src/types/generated/task.ts:393](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L393) *** ### posY[​](#posy "Direct link to posY") > **posY**: `number` Defined in: [packages/sdk/src/types/generated/task.ts:394](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L394) *** ### updatedAt[​](#updatedat "Direct link to updatedAt") > **updatedAt**: `string` Defined in: [packages/sdk/src/types/generated/task.ts:399](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L399) *** ### uuid[​](#uuid "Direct link to uuid") > **uuid**: `string` Defined in: [packages/sdk/src/types/generated/task.ts:391](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L391) *** ### width[​](#width "Direct link to width") > **width**: `number` Defined in: [packages/sdk/src/types/generated/task.ts:395](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L395) *** ### workflowId[​](#workflowid "Direct link to workflowId") > **workflowId**: `number` Defined in: [packages/sdk/src/types/generated/task.ts:392](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L392) --- # Interface: WorkflowRouteDryRunCandidate Defined in: [packages/sdk/src/types/task-types.ts:229](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/task-types.ts#L229) One candidate child Task surfaced by a dry-run routing trace. PHI policy: identifiers and `order` only. CEL text, evaluation inputs, Form values, Member values, and exception strings are intentionally omitted. ## Properties[​](#properties "Direct link to Properties") ### automatic[​](#automatic "Direct link to automatic") > **automatic**: `boolean` Defined in: [packages/sdk/src/types/task-types.ts:233](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/task-types.ts#L233) *** ### childTaskId[​](#childtaskid "Direct link to childTaskId") > **childTaskId**: `number` Defined in: [packages/sdk/src/types/task-types.ts:231](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/task-types.ts#L231) *** ### order[​](#order "Direct link to order") > **order**: `number` | `null` Defined in: [packages/sdk/src/types/task-types.ts:232](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/task-types.ts#L232) *** ### parentTaskId[​](#parenttaskid "Direct link to parentTaskId") > **parentTaskId**: `number` Defined in: [packages/sdk/src/types/task-types.ts:230](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/task-types.ts#L230) --- # Interface: WorkflowRouteDryRunResponse Defined in: [packages/sdk/src/types/generated/task.ts:475](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L475) PHI-safe response shape for the route dry-run endpoint. Fields: assignmentId / chatId — context the dry-run was executed under. sourceTaskId / sourceAssignmentTaskId — current Task/AssignmentTask resolved from the supplied chat context (after applying any `current_task_id` / `current_assignment_task_id` overrides). status — one of the :class:`lib.services.cel_edge_evaluator.EdgeEvaluationStatus` labels (e.g. `"no_edges"`, `"no_match"`, `"would_transition"`, `"matched_current_task"`, `"missing_assignment_task"`, `"transition_blocked"`, `"error"`). edgeCount — number of automatic-routing-candidate edges the evaluator considered. candidateChildTaskIds — Task IDs of every candidate edge the evaluator examined. winningChildTaskId — Task ID of the matched child Task, populated when `status == "would_transition"` or `"matched_current_task"` or `"missing_assignment_task"` or `"transition_blocked"`. errorType — exception class name only when `status == "error"`; never the raw `str(exc)` message. issues — optional list of related `AbilityConfigIssue` entries (e.g. from the Workflow Health collectors) the caller may surface alongside the trace. The route may leave this empty in Phase 4; the field exists to keep the contract stable. PHI guard (enforced by tests): raw CEL, Form values, Member values, Chat content, and `str(exc)` MUST NOT appear on this response. ## Properties[​](#properties "Direct link to Properties") ### assignmentId[​](#assignmentid "Direct link to assignmentId") > **assignmentId**: `number` Defined in: [packages/sdk/src/types/generated/task.ts:476](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L476) *** ### candidateChildTaskIds?[​](#candidatechildtaskids "Direct link to candidateChildTaskIds?") > `optional` **candidateChildTaskIds**: `number`\[] Defined in: [packages/sdk/src/types/generated/task.ts:482](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L482) *** ### chatId[​](#chatid "Direct link to chatId") > **chatId**: `number` Defined in: [packages/sdk/src/types/generated/task.ts:477](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L477) *** ### edgeCount[​](#edgecount "Direct link to edgeCount") > **edgeCount**: `number` Defined in: [packages/sdk/src/types/generated/task.ts:481](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L481) *** ### errorType?[​](#errortype "Direct link to errorType?") > `optional` **errorType**: `string` | `null` Defined in: [packages/sdk/src/types/generated/task.ts:484](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L484) *** ### issues?[​](#issues "Direct link to issues?") > `optional` **issues**: [`AbilityConfigIssue`](https://docs.gravityrail.com/sdk/interfaces/AbilityConfigIssue.md)\[] Defined in: [packages/sdk/src/types/generated/task.ts:485](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L485) *** ### sourceAssignmentTaskId?[​](#sourceassignmenttaskid "Direct link to sourceAssignmentTaskId?") > `optional` **sourceAssignmentTaskId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/task.ts:479](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L479) *** ### sourceTaskId?[​](#sourcetaskid "Direct link to sourceTaskId?") > `optional` **sourceTaskId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/task.ts:478](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L478) *** ### status[​](#status "Direct link to status") > **status**: `string` Defined in: [packages/sdk/src/types/generated/task.ts:480](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L480) *** ### winningChildTaskId?[​](#winningchildtaskid "Direct link to winningChildTaskId?") > `optional` **winningChildTaskId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/task.ts:483](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L483) --- # Interface: WorkflowRunAbilityConfig Defined in: [packages/sdk/src/types/ability-types.ts:403](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ability-types.ts#L403) Config for workflow\_run ability ## Properties[​](#properties "Direct link to Properties") ### allowedModes?[​](#allowedmodes "Direct link to allowedModes?") > `optional` **allowedModes**: (`"current_chat"` | `"background"`)\[] Defined in: [packages/sdk/src/types/ability-types.ts:407](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ability-types.ts#L407) Enabled run modes (default: \['current\_chat']) *** ### allowedWorkflowUuids?[​](#allowedworkflowuuids "Direct link to allowedWorkflowUuids?") > `optional` **allowedWorkflowUuids**: `string`\[] Defined in: [packages/sdk/src/types/ability-types.ts:405](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ability-types.ts#L405) Workflow UUID allowlist. Empty means any authorized Workflow. *** ### defaultBackgroundTimeoutSeconds?[​](#defaultbackgroundtimeoutseconds "Direct link to defaultBackgroundTimeoutSeconds?") > `optional` **defaultBackgroundTimeoutSeconds**: `number` Defined in: [packages/sdk/src/types/ability-types.ts:409](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ability-types.ts#L409) Background run timeout in seconds (default: 600) --- # Interface: WorkflowStartAutomationResponse Defined in: [packages/sdk/src/types/generated/app\_connection.ts:546](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L546) Surfaces the operator-selected workflows for workflow-start refresh. ## Properties[​](#properties "Direct link to Properties") ### unsupportedWorkflowIds?[​](#unsupportedworkflowids "Direct link to unsupportedWorkflowIds?") > `optional` **unsupportedWorkflowIds**: `number`\[] Defined in: [packages/sdk/src/types/generated/app\_connection.ts:548](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L548) *** ### workflowIds?[​](#workflowids "Direct link to workflowIds?") > `optional` **workflowIds**: `number`\[] Defined in: [packages/sdk/src/types/generated/app\_connection.ts:547](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/app_connection.ts#L547) --- # Interface: WorkflowTemplateResponse Defined in: [packages/sdk/src/types/generated/task.ts:491](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L491) Response model for a workflow template. ## Properties[​](#properties "Direct link to Properties") ### available[​](#available "Direct link to available") > **available**: `boolean` Defined in: [packages/sdk/src/types/generated/task.ts:501](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L501) *** ### defaultWorkflowName[​](#defaultworkflowname "Direct link to defaultWorkflowName") > **defaultWorkflowName**: `string` Defined in: [packages/sdk/src/types/generated/task.ts:497](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L497) *** ### exampleConversation[​](#exampleconversation "Direct link to exampleConversation") > **exampleConversation**: `string` Defined in: [packages/sdk/src/types/generated/task.ts:498](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L498) *** ### icon[​](#icon "Direct link to icon") > **icon**: `string` Defined in: [packages/sdk/src/types/generated/task.ts:494](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L494) *** ### longDescription[​](#longdescription "Direct link to longDescription") > **longDescription**: `string` Defined in: [packages/sdk/src/types/generated/task.ts:496](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L496) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/generated/task.ts:493](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L493) *** ### requiredFeatures[​](#requiredfeatures "Direct link to requiredFeatures") > **requiredFeatures**: `string`\[] Defined in: [packages/sdk/src/types/generated/task.ts:499](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L499) *** ### shortDescription[​](#shortdescription "Direct link to shortDescription") > **shortDescription**: `string` Defined in: [packages/sdk/src/types/generated/task.ts:495](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L495) *** ### tags?[​](#tags "Direct link to tags?") > `optional` **tags**: `string`\[] Defined in: [packages/sdk/src/types/generated/task.ts:500](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L500) *** ### uuid[​](#uuid "Direct link to uuid") > **uuid**: `string` Defined in: [packages/sdk/src/types/generated/task.ts:492](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L492) --- # Interface: Workspace Defined in: [packages/sdk/src/types/generated/workspace.ts:480](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/workspace.ts#L480) ## Properties[​](#properties "Direct link to Properties") ### allowSignup?[​](#allowsignup "Direct link to allowSignup?") > `optional` **allowSignup**: `boolean` Defined in: [packages/sdk/src/types/generated/workspace.ts:493](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/workspace.ts#L493) *** ### createdAt[​](#createdat "Direct link to createdAt") > **createdAt**: `string` Defined in: [packages/sdk/src/types/generated/workspace.ts:490](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/workspace.ts#L490) *** ### features?[​](#features "Direct link to features?") > `optional` **features**: `string`\[] | `null` Defined in: [packages/sdk/src/types/generated/workspace.ts:496](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/workspace.ts#L496) *** ### featureStatus?[​](#featurestatus "Direct link to featureStatus?") > `optional` **featureStatus**: `WorkspaceResponseFeatureStatus` Defined in: [packages/sdk/src/types/generated/workspace.ts:497](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/workspace.ts#L497) *** ### id[​](#id "Direct link to id") > **id**: `number` Defined in: [packages/sdk/src/types/generated/workspace.ts:481](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/workspace.ts#L481) *** ### isPublic?[​](#ispublic "Direct link to isPublic?") > `optional` **isPublic**: `boolean` Defined in: [packages/sdk/src/types/generated/workspace.ts:492](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/workspace.ts#L492) *** ### locale?[​](#locale "Direct link to locale?") > `optional` **locale**: `string` | `null` Defined in: [packages/sdk/src/types/generated/workspace.ts:500](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/workspace.ts#L500) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/generated/workspace.ts:484](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/workspace.ts#L484) *** ### organizationId[​](#organizationid "Direct link to organizationId") > **organizationId**: `number` Defined in: [packages/sdk/src/types/generated/workspace.ts:485](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/workspace.ts#L485) *** ### organizationLogoUrl?[​](#organizationlogourl "Direct link to organizationLogoUrl?") > `optional` **organizationLogoUrl**: `string` | `null` Defined in: [packages/sdk/src/types/generated/workspace.ts:488](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/workspace.ts#L488) *** ### organizationName?[​](#organizationname "Direct link to organizationName?") > `optional` **organizationName**: `string` | `null` Defined in: [packages/sdk/src/types/generated/workspace.ts:487](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/workspace.ts#L487) *** ### organizationUuid?[​](#organizationuuid "Direct link to organizationUuid?") > `optional` **organizationUuid**: `string` | `null` Defined in: [packages/sdk/src/types/generated/workspace.ts:486](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/workspace.ts#L486) *** ### pendingSetupSpecIds?[​](#pendingsetupspecids "Direct link to pendingSetupSpecIds?") > `optional` **pendingSetupSpecIds**: `number`\[] Defined in: [packages/sdk/src/types/generated/workspace.ts:502](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/workspace.ts#L502) *** ### resellerId?[​](#resellerid "Direct link to resellerId?") > `optional` **resellerId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/workspace.ts:494](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/workspace.ts#L494) *** ### signupCode?[​](#signupcode "Direct link to signupCode?") > `optional` **signupCode**: `string` | `null` Defined in: [packages/sdk/src/types/generated/workspace.ts:489](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/workspace.ts#L489) *** ### signupRequestStatus?[​](#signuprequeststatus "Direct link to signupRequestStatus?") > `optional` **signupRequestStatus**: `string` | `null` Defined in: [packages/sdk/src/types/generated/workspace.ts:498](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/workspace.ts#L498) *** ### slug[​](#slug "Direct link to slug") > **slug**: `string` Defined in: [packages/sdk/src/types/generated/workspace.ts:483](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/workspace.ts#L483) *** ### status?[​](#status "Direct link to status?") > `optional` **status**: `number` | `null` Defined in: [packages/sdk/src/types/generated/workspace.ts:499](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/workspace.ts#L499) *** ### themes?[​](#themes "Direct link to themes?") > `optional` **themes**: `string`\[] Defined in: [packages/sdk/src/types/generated/workspace.ts:495](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/workspace.ts#L495) *** ### timezone?[​](#timezone "Direct link to timezone?") > `optional` **timezone**: `string` | `null` Defined in: [packages/sdk/src/types/generated/workspace.ts:501](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/workspace.ts#L501) *** ### userRole[​](#userrole "Direct link to userRole") > **userRole**: `string` | `null` Defined in: [packages/sdk/src/types/generated/workspace.ts:491](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/workspace.ts#L491) *** ### uuid[​](#uuid "Direct link to uuid") > **uuid**: `string` Defined in: [packages/sdk/src/types/generated/workspace.ts:482](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/workspace.ts#L482) --- # Interface: WorkspaceAccessDeniedData Defined in: [packages/sdk/src/types/workspace-types.ts:155](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/workspace-types.ts#L155) ## Properties[​](#properties "Direct link to Properties") ### availableRoles[​](#availableroles "Direct link to availableRoles") > **availableRoles**: [`AvailableMemberRole`](https://docs.gravityrail.com/sdk/interfaces/AvailableMemberRole.md)\[] Defined in: [packages/sdk/src/types/workspace-types.ts:165](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/workspace-types.ts#L165) *** ### canSelfGrant[​](#canselfgrant "Direct link to canSelfGrant") > **canSelfGrant**: `true` Defined in: [packages/sdk/src/types/workspace-types.ts:159](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/workspace-types.ts#L159) *** ### code[​](#code "Direct link to code") > **code**: `"WORKSPACE_MEMBERSHIP_REQUIRED"` Defined in: [packages/sdk/src/types/workspace-types.ts:158](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/workspace-types.ts#L158) *** ### error[​](#error "Direct link to error") > **error**: `true` Defined in: [packages/sdk/src/types/workspace-types.ts:156](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/workspace-types.ts#L156) *** ### grantReason[​](#grantreason "Direct link to grantReason") > **grantReason**: [`WorkspaceGrantReason`](https://docs.gravityrail.com/sdk/type-aliases/WorkspaceGrantReason.md) Defined in: [packages/sdk/src/types/workspace-types.ts:160](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/workspace-types.ts#L160) *** ### message[​](#message "Direct link to message") > **message**: `string` Defined in: [packages/sdk/src/types/workspace-types.ts:157](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/workspace-types.ts#L157) *** ### organizationName[​](#organizationname "Direct link to organizationName") > **organizationName**: `string` | `null` Defined in: [packages/sdk/src/types/workspace-types.ts:164](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/workspace-types.ts#L164) *** ### organizationUuid[​](#organizationuuid "Direct link to organizationUuid") > **organizationUuid**: `string` | `null` Defined in: [packages/sdk/src/types/workspace-types.ts:163](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/workspace-types.ts#L163) *** ### workspaceName[​](#workspacename "Direct link to workspaceName") > **workspaceName**: `string` Defined in: [packages/sdk/src/types/workspace-types.ts:162](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/workspace-types.ts#L162) *** ### workspaceUuid[​](#workspaceuuid "Direct link to workspaceUuid") > **workspaceUuid**: `string` Defined in: [packages/sdk/src/types/workspace-types.ts:161](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/workspace-types.ts#L161) --- # Interface: WorkspaceAutoMapEntities Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:456](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L456) UUIDs of entities to auto-map by template\_uuid or name matching. These will be automatically matched to existing entities if found. ## Properties[​](#properties "Direct link to Properties") ### agents[​](#agents "Direct link to agents") > **agents**: `string`\[] Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:460](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L460) *** ### customToolkits[​](#customtoolkits "Direct link to customToolkits") > **customToolkits**: `string`\[] Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:473](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L473) *** ### customTools[​](#customtools "Direct link to customTools") > **customTools**: `string`\[] Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:474](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L474) *** ### dataTypes[​](#datatypes "Direct link to dataTypes") > **dataTypes**: `string`\[] Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:459](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L459) *** ### eventRules[​](#eventrules "Direct link to eventRules") > **eventRules**: `string`\[] Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:463](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L463) *** ### fileFolders[​](#filefolders "Direct link to fileFolders") > **fileFolders**: `string`\[] Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:478](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L478) *** ### fileLabels[​](#filelabels "Direct link to fileLabels") > **fileLabels**: `string`\[] Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:479](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L479) *** ### files[​](#files "Direct link to files") > **files**: `string`\[] Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:462](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L462) *** ### inboxes[​](#inboxes "Direct link to inboxes") > **inboxes**: `string`\[] Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:467](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L467) *** ### mcpServers[​](#mcpservers "Direct link to mcpServers") > **mcpServers**: `string`\[] Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:477](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L477) *** ### memberFilterRules[​](#memberfilterrules "Direct link to memberFilterRules") > **memberFilterRules**: `string`\[] Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:470](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L470) *** ### memberFilters[​](#memberfilters "Direct link to memberFilters") > **memberFilters**: `string`\[] Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:469](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L469) *** ### memberLabels[​](#memberlabels "Direct link to memberLabels") > **memberLabels**: `string`\[] Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:461](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L461) *** ### memberRoles[​](#memberroles "Direct link to memberRoles") > **memberRoles**: `string`\[] Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:464](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L464) *** ### menuItems[​](#menuitems "Direct link to menuItems") > **menuItems**: `string`\[] Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:476](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L476) *** ### milestoneGoals[​](#milestonegoals "Direct link to milestoneGoals") > **milestoneGoals**: `string`\[] Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:472](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L472) *** ### milestones[​](#milestones "Direct link to milestones") > **milestones**: `string`\[] Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:471](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L471) *** ### pages[​](#pages "Direct link to pages") > **pages**: `string`\[] Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:475](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L475) *** ### phoneNumbers[​](#phonenumbers "Direct link to phoneNumbers") > **phoneNumbers**: `string`\[] Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:465](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L465) *** ### qualifications[​](#qualifications "Direct link to qualifications") > **qualifications**: `string`\[] Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:481](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L481) *** ### routines[​](#routines "Direct link to routines") > **routines**: `string`\[] Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:468](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L468) *** ### sites[​](#sites "Direct link to sites") > **sites**: `string`\[] Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:466](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L466) *** ### tasks[​](#tasks "Direct link to tasks") > **tasks**: `string`\[] Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:458](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L458) *** ### workflowNotes[​](#workflownotes "Direct link to workflowNotes") > **workflowNotes**: `string`\[] Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:480](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L480) *** ### workflows[​](#workflows "Direct link to workflows") > **workflows**: `string`\[] Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:457](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L457) --- # Interface: WorkspaceAvailableDomain Defined in: [packages/sdk/src/types/generated/workspace.ts:430](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/workspace.ts#L430) Slim view of an OrgDomain for selection in workspace forms. Intentionally smaller than `OrgDomainResponse` — workspace members don't need ownership tokens, DNS records, last-checked timestamps, etc. Just enough to populate a dropdown, pass the uuid back as a foreign reference (e.g. `orgDomainUuid` on inbox creation), and let the UI mark non-verified entries as disabled with a reason. ## Properties[​](#properties "Direct link to Properties") ### domain[​](#domain "Direct link to domain") > **domain**: `string` Defined in: [packages/sdk/src/types/generated/workspace.ts:432](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/workspace.ts#L432) *** ### emailStatus?[​](#emailstatus "Direct link to emailStatus?") > `optional` **emailStatus**: `string` | `null` Defined in: [packages/sdk/src/types/generated/workspace.ts:434](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/workspace.ts#L434) *** ### ownershipStatus[​](#ownershipstatus "Direct link to ownershipStatus") > **ownershipStatus**: `string` Defined in: [packages/sdk/src/types/generated/workspace.ts:433](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/workspace.ts#L433) *** ### siteStatus?[​](#sitestatus "Direct link to siteStatus?") > `optional` **siteStatus**: `string` | `null` Defined in: [packages/sdk/src/types/generated/workspace.ts:435](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/workspace.ts#L435) *** ### uuid[​](#uuid "Direct link to uuid") > **uuid**: `string` Defined in: [packages/sdk/src/types/generated/workspace.ts:431](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/workspace.ts#L431) --- # Interface: WorkspaceAvailableDomainsResponse Defined in: [packages/sdk/src/types/generated/workspace.ts:438](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/workspace.ts#L438) ## Properties[​](#properties "Direct link to Properties") ### items[​](#items "Direct link to items") > **items**: [`WorkspaceAvailableDomain`](https://docs.gravityrail.com/sdk/interfaces/WorkspaceAvailableDomain.md)\[] Defined in: [packages/sdk/src/types/generated/workspace.ts:439](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/workspace.ts#L439) *** ### total[​](#total "Direct link to total") > **total**: `number` Defined in: [packages/sdk/src/types/generated/workspace.ts:440](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/workspace.ts#L440) --- # Interface: WorkspaceBuilderExportData Defined in: [packages/sdk/src/types/workspace-builder-types.ts:40](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/workspace-builder-types.ts#L40) ## Properties[​](#properties "Direct link to Properties") ### calendars?[​](#calendars "Direct link to calendars?") > `optional` **calendars**: `unknown`\[] Defined in: [packages/sdk/src/types/workspace-builder-types.ts:49](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/workspace-builder-types.ts#L49) *** ### dataTypes?[​](#datatypes "Direct link to dataTypes?") > `optional` **dataTypes**: `unknown`\[] Defined in: [packages/sdk/src/types/workspace-builder-types.ts:46](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/workspace-builder-types.ts#L46) *** ### eventRules?[​](#eventrules "Direct link to eventRules?") > `optional` **eventRules**: `unknown`\[] Defined in: [packages/sdk/src/types/workspace-builder-types.ts:48](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/workspace-builder-types.ts#L48) *** ### exportedAt[​](#exportedat "Direct link to exportedAt") > **exportedAt**: `string` Defined in: [packages/sdk/src/types/workspace-builder-types.ts:42](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/workspace-builder-types.ts#L42) *** ### files?[​](#files "Direct link to files?") > `optional` **files**: `unknown`\[] Defined in: [packages/sdk/src/types/workspace-builder-types.ts:47](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/workspace-builder-types.ts#L47) *** ### sites?[​](#sites "Direct link to sites?") > `optional` **sites**: `unknown`\[] Defined in: [packages/sdk/src/types/workspace-builder-types.ts:50](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/workspace-builder-types.ts#L50) *** ### taskChildRelations[​](#taskchildrelations "Direct link to taskChildRelations") > **taskChildRelations**: [`TaskExportChildRelation`](https://docs.gravityrail.com/sdk/interfaces/TaskExportChildRelation.md)\[] Defined in: [packages/sdk/src/types/workspace-builder-types.ts:45](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/workspace-builder-types.ts#L45) *** ### tasks[​](#tasks "Direct link to tasks") > **tasks**: [`WorkspaceBuilderTaskExport`](https://docs.gravityrail.com/sdk/interfaces/WorkspaceBuilderTaskExport.md)\[] Defined in: [packages/sdk/src/types/workspace-builder-types.ts:44](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/workspace-builder-types.ts#L44) *** ### version[​](#version "Direct link to version") > **version**: `string` Defined in: [packages/sdk/src/types/workspace-builder-types.ts:41](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/workspace-builder-types.ts#L41) *** ### workflows[​](#workflows "Direct link to workflows") > **workflows**: [`WorkspaceBuilderWorkflowExport`](https://docs.gravityrail.com/sdk/interfaces/WorkspaceBuilderWorkflowExport.md)\[] Defined in: [packages/sdk/src/types/workspace-builder-types.ts:43](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/workspace-builder-types.ts#L43) --- # Interface: WorkspaceBuilderInfo Defined in: [packages/sdk/src/types/workspace-builder-types.ts:53](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/workspace-builder-types.ts#L53) ## Properties[​](#properties "Direct link to Properties") ### builderId[​](#builderid "Direct link to builderId") > **builderId**: `string` Defined in: [packages/sdk/src/types/workspace-builder-types.ts:54](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/workspace-builder-types.ts#L54) *** ### description[​](#description "Direct link to description") > **description**: `string` Defined in: [packages/sdk/src/types/workspace-builder-types.ts:56](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/workspace-builder-types.ts#L56) *** ### displayName[​](#displayname "Direct link to displayName") > **displayName**: `string` Defined in: [packages/sdk/src/types/workspace-builder-types.ts:55](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/workspace-builder-types.ts#L55) *** ### icon[​](#icon "Direct link to icon") > **icon**: `string` Defined in: [packages/sdk/src/types/workspace-builder-types.ts:57](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/workspace-builder-types.ts#L57) *** ### paramsSchema[​](#paramsschema "Direct link to paramsSchema") > **paramsSchema**: `Record`<`string`, `unknown`> Defined in: [packages/sdk/src/types/workspace-builder-types.ts:58](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/workspace-builder-types.ts#L58) --- # Interface: WorkspaceBuilderListResponse Defined in: [packages/sdk/src/types/workspace-builder-types.ts:61](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/workspace-builder-types.ts#L61) ## Properties[​](#properties "Direct link to Properties") ### items[​](#items "Direct link to items") > **items**: [`WorkspaceBuilderInfo`](https://docs.gravityrail.com/sdk/interfaces/WorkspaceBuilderInfo.md)\[] Defined in: [packages/sdk/src/types/workspace-builder-types.ts:62](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/workspace-builder-types.ts#L62) --- # Interface: WorkspaceBuilderTaskExport Defined in: [packages/sdk/src/types/workspace-builder-types.ts:27](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/workspace-builder-types.ts#L27) ## Properties[​](#properties "Direct link to Properties") ### description[​](#description "Direct link to description") > **description**: `string` | `null` Defined in: [packages/sdk/src/types/workspace-builder-types.ts:31](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/workspace-builder-types.ts#L31) *** ### isAdmin[​](#isadmin "Direct link to isAdmin") > **isAdmin**: `boolean` Defined in: [packages/sdk/src/types/workspace-builder-types.ts:35](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/workspace-builder-types.ts#L35) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/workspace-builder-types.ts:29](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/workspace-builder-types.ts#L29) *** ### posX[​](#posx "Direct link to posX") > **posX**: `number` | `null` Defined in: [packages/sdk/src/types/workspace-builder-types.ts:36](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/workspace-builder-types.ts#L36) *** ### posY[​](#posy "Direct link to posY") > **posY**: `number` | `null` Defined in: [packages/sdk/src/types/workspace-builder-types.ts:37](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/workspace-builder-types.ts#L37) *** ### prompt[​](#prompt "Direct link to prompt") > **prompt**: `string` | `null` Defined in: [packages/sdk/src/types/workspace-builder-types.ts:33](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/workspace-builder-types.ts#L33) *** ### shortPrompt[​](#shortprompt "Direct link to shortPrompt") > **shortPrompt**: `string` | `null` Defined in: [packages/sdk/src/types/workspace-builder-types.ts:32](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/workspace-builder-types.ts#L32) *** ### taskType[​](#tasktype "Direct link to taskType") > **taskType**: `string` Defined in: [packages/sdk/src/types/workspace-builder-types.ts:34](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/workspace-builder-types.ts#L34) *** ### uuid[​](#uuid "Direct link to uuid") > **uuid**: `string` Defined in: [packages/sdk/src/types/workspace-builder-types.ts:28](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/workspace-builder-types.ts#L28) *** ### workflowUuid[​](#workflowuuid "Direct link to workflowUuid") > **workflowUuid**: `string` Defined in: [packages/sdk/src/types/workspace-builder-types.ts:30](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/workspace-builder-types.ts#L30) --- # Interface: WorkspaceBuilderWorkflowExport Defined in: [packages/sdk/src/types/workspace-builder-types.ts:19](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/workspace-builder-types.ts#L19) ## Properties[​](#properties "Direct link to Properties") ### agentUuid[​](#agentuuid "Direct link to agentUuid") > **agentUuid**: `string` | `null` Defined in: [packages/sdk/src/types/workspace-builder-types.ts:24](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/workspace-builder-types.ts#L24) *** ### defaultTaskUuid[​](#defaulttaskuuid "Direct link to defaultTaskUuid") > **defaultTaskUuid**: `string` | `null` Defined in: [packages/sdk/src/types/workspace-builder-types.ts:23](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/workspace-builder-types.ts#L23) *** ### description[​](#description "Direct link to description") > **description**: `string` | `null` Defined in: [packages/sdk/src/types/workspace-builder-types.ts:22](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/workspace-builder-types.ts#L22) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/workspace-builder-types.ts:21](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/workspace-builder-types.ts#L21) *** ### uuid[​](#uuid "Direct link to uuid") > **uuid**: `string` Defined in: [packages/sdk/src/types/workspace-builder-types.ts:20](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/workspace-builder-types.ts#L20) --- # Interface: WorkspaceBuildPreview Defined in: [packages/sdk/src/types/workspace-builder-types.ts:70](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/workspace-builder-types.ts#L70) ## Properties[​](#properties "Direct link to Properties") ### summary[​](#summary "Direct link to summary") > **summary**: `string`\[] Defined in: [packages/sdk/src/types/workspace-builder-types.ts:71](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/workspace-builder-types.ts#L71) *** ### tasks[​](#tasks "Direct link to tasks") > **tasks**: `object`\[] Defined in: [packages/sdk/src/types/workspace-builder-types.ts:77](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/workspace-builder-types.ts#L77) #### description[​](#description "Direct link to description") > **description**: `string` | `null` #### name[​](#name "Direct link to name") > **name**: `string` #### taskType[​](#tasktype "Direct link to taskType") > **taskType**: `string` #### uuid[​](#uuid "Direct link to uuid") > **uuid**: `string` *** ### workflows[​](#workflows "Direct link to workflows") > **workflows**: `object`\[] Defined in: [packages/sdk/src/types/workspace-builder-types.ts:72](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/workspace-builder-types.ts#L72) #### description[​](#description-1 "Direct link to description") > **description**: `string` | `null` #### name[​](#name-1 "Direct link to name") > **name**: `string` #### uuid[​](#uuid-1 "Direct link to uuid") > **uuid**: `string` --- # Interface: WorkspaceCounts Defined in: [packages/sdk/src/types/generated/workspace.ts:446](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/workspace.ts#L446) Response model for workspace counts. ## Properties[​](#properties "Direct link to Properties") ### agents[​](#agents "Direct link to agents") > **agents**: `number` Defined in: [packages/sdk/src/types/generated/workspace.ts:448](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/workspace.ts#L448) *** ### chats[​](#chats "Direct link to chats") > **chats**: `number` Defined in: [packages/sdk/src/types/generated/workspace.ts:453](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/workspace.ts#L453) *** ### files[​](#files "Direct link to files") > **files**: `number` Defined in: [packages/sdk/src/types/generated/workspace.ts:454](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/workspace.ts#L454) *** ### forms[​](#forms "Direct link to forms") > **forms**: `number` Defined in: [packages/sdk/src/types/generated/workspace.ts:456](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/workspace.ts#L456) *** ### humans[​](#humans "Direct link to humans") > **humans**: `number` Defined in: [packages/sdk/src/types/generated/workspace.ts:447](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/workspace.ts#L447) *** ### inboxes[​](#inboxes "Direct link to inboxes") > **inboxes**: `number` Defined in: [packages/sdk/src/types/generated/workspace.ts:451](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/workspace.ts#L451) *** ### phoneNumbers[​](#phonenumbers "Direct link to phoneNumbers") > **phoneNumbers**: `number` Defined in: [packages/sdk/src/types/generated/workspace.ts:452](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/workspace.ts#L452) *** ### sites[​](#sites "Direct link to sites") > **sites**: `number` Defined in: [packages/sdk/src/types/generated/workspace.ts:455](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/workspace.ts#L455) *** ### tasks[​](#tasks "Direct link to tasks") > **tasks**: `number` Defined in: [packages/sdk/src/types/generated/workspace.ts:449](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/workspace.ts#L449) *** ### workflows[​](#workflows "Direct link to workflows") > **workflows**: `number` Defined in: [packages/sdk/src/types/generated/workspace.ts:450](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/workspace.ts#L450) --- # Interface: WorkspaceCreateNewEntities Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:424](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L424) ## Properties[​](#properties "Direct link to Properties") ### agents[​](#agents "Direct link to agents") > **agents**: `string`\[] Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:428](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L428) *** ### customToolkits[​](#customtoolkits "Direct link to customToolkits") > **customToolkits**: `string`\[] Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:441](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L441) *** ### customTools[​](#customtools "Direct link to customTools") > **customTools**: `string`\[] Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:442](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L442) *** ### dataTypes[​](#datatypes "Direct link to dataTypes") > **dataTypes**: `string`\[] Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:427](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L427) *** ### eventRules[​](#eventrules "Direct link to eventRules") > **eventRules**: `string`\[] Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:431](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L431) *** ### fileFolders[​](#filefolders "Direct link to fileFolders") > **fileFolders**: `string`\[] Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:446](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L446) *** ### fileLabels[​](#filelabels "Direct link to fileLabels") > **fileLabels**: `string`\[] Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:447](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L447) *** ### files[​](#files "Direct link to files") > **files**: `string`\[] Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:430](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L430) *** ### inboxes[​](#inboxes "Direct link to inboxes") > **inboxes**: `string`\[] Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:435](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L435) *** ### mcpServers[​](#mcpservers "Direct link to mcpServers") > **mcpServers**: `string`\[] Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:445](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L445) *** ### memberFilterRules[​](#memberfilterrules "Direct link to memberFilterRules") > **memberFilterRules**: `string`\[] Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:438](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L438) *** ### memberFilters[​](#memberfilters "Direct link to memberFilters") > **memberFilters**: `string`\[] Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:437](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L437) *** ### memberLabels[​](#memberlabels "Direct link to memberLabels") > **memberLabels**: `string`\[] Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:429](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L429) *** ### memberRoles[​](#memberroles "Direct link to memberRoles") > **memberRoles**: `string`\[] Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:432](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L432) *** ### menuItems[​](#menuitems "Direct link to menuItems") > **menuItems**: `string`\[] Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:444](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L444) *** ### milestoneGoals[​](#milestonegoals "Direct link to milestoneGoals") > **milestoneGoals**: `string`\[] Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:440](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L440) *** ### milestones[​](#milestones "Direct link to milestones") > **milestones**: `string`\[] Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:439](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L439) *** ### pages[​](#pages "Direct link to pages") > **pages**: `string`\[] Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:443](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L443) *** ### phoneNumbers[​](#phonenumbers "Direct link to phoneNumbers") > **phoneNumbers**: `string`\[] Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:433](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L433) *** ### qualifications[​](#qualifications "Direct link to qualifications") > **qualifications**: `string`\[] Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:449](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L449) *** ### routines[​](#routines "Direct link to routines") > **routines**: `string`\[] Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:436](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L436) *** ### sites[​](#sites "Direct link to sites") > **sites**: `string`\[] Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:434](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L434) *** ### tasks[​](#tasks "Direct link to tasks") > **tasks**: `string`\[] Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:426](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L426) *** ### workflowNotes[​](#workflownotes "Direct link to workflowNotes") > **workflowNotes**: `string`\[] Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:448](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L448) *** ### workflows[​](#workflows "Direct link to workflows") > **workflows**: `string`\[] Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:425](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L425) --- # Interface: WorkspaceDefaults Defined in: [packages/sdk/src/types/generated/workspace.ts:526](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/workspace.ts#L526) ## Properties[​](#properties "Direct link to Properties") ### defaultAgentId[​](#defaultagentid "Direct link to defaultAgentId") > **defaultAgentId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/workspace.ts:530](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/workspace.ts#L530) *** ### defaultChatModel[​](#defaultchatmodel "Direct link to defaultChatModel") > **defaultChatModel**: `string` Defined in: [packages/sdk/src/types/generated/workspace.ts:543](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/workspace.ts#L543) *** ### defaultInferenceModel[​](#defaultinferencemodel "Direct link to defaultInferenceModel") > **defaultInferenceModel**: `string` Defined in: [packages/sdk/src/types/generated/workspace.ts:545](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/workspace.ts#L545) *** ### defaultPhoneNumberId[​](#defaultphonenumberid "Direct link to defaultPhoneNumberId") > **defaultPhoneNumberId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/workspace.ts:529](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/workspace.ts#L529) *** ### defaultRealtimeModel[​](#defaultrealtimemodel "Direct link to defaultRealtimeModel") > **defaultRealtimeModel**: `string` Defined in: [packages/sdk/src/types/generated/workspace.ts:544](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/workspace.ts#L544) *** ### defaultVoiceModel[​](#defaultvoicemodel "Direct link to defaultVoiceModel") > **defaultVoiceModel**: `string` Defined in: [packages/sdk/src/types/generated/workspace.ts:546](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/workspace.ts#L546) *** ### emailFooter[​](#emailfooter "Direct link to emailFooter") > **emailFooter**: `string` | `null` Defined in: [packages/sdk/src/types/generated/workspace.ts:537](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/workspace.ts#L537) *** ### enableAudioRecording[​](#enableaudiorecording "Direct link to enableAudioRecording") > **enableAudioRecording**: `boolean` Defined in: [packages/sdk/src/types/generated/workspace.ts:540](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/workspace.ts#L540) *** ### enableVoicemailDetection[​](#enablevoicemaildetection "Direct link to enableVoicemailDetection") > **enableVoicemailDetection**: `boolean` Defined in: [packages/sdk/src/types/generated/workspace.ts:541](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/workspace.ts#L541) *** ### escalationBusinessHours[​](#escalationbusinesshours "Direct link to escalationBusinessHours") > **escalationBusinessHours**: `string` | `null` Defined in: [packages/sdk/src/types/generated/workspace.ts:532](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/workspace.ts#L532) *** ### escalationNotifiedMessageTemplate[​](#escalationnotifiedmessagetemplate "Direct link to escalationNotifiedMessageTemplate") > **escalationNotifiedMessageTemplate**: `string` | `null` Defined in: [packages/sdk/src/types/generated/workspace.ts:535](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/workspace.ts#L535) *** ### escalationOfflineMessageTemplate[​](#escalationofflinemessagetemplate "Direct link to escalationOfflineMessageTemplate") > **escalationOfflineMessageTemplate**: `string` | `null` Defined in: [packages/sdk/src/types/generated/workspace.ts:534](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/workspace.ts#L534) *** ### escalationOnlineMessageTemplate[​](#escalationonlinemessagetemplate "Direct link to escalationOnlineMessageTemplate") > **escalationOnlineMessageTemplate**: `string` | `null` Defined in: [packages/sdk/src/types/generated/workspace.ts:533](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/workspace.ts#L533) *** ### escalationPausedMessageTemplate[​](#escalationpausedmessagetemplate "Direct link to escalationPausedMessageTemplate") > **escalationPausedMessageTemplate**: `string` | `null` Defined in: [packages/sdk/src/types/generated/workspace.ts:536](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/workspace.ts#L536) *** ### firstRunMode?[​](#firstrunmode "Direct link to firstRunMode?") > `optional` **firstRunMode**: `string` | `null` Defined in: [packages/sdk/src/types/generated/workspace.ts:547](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/workspace.ts#L547) *** ### id[​](#id "Direct link to id") > **id**: `number` Defined in: [packages/sdk/src/types/generated/workspace.ts:527](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/workspace.ts#L527) *** ### pauseOnEscalate[​](#pauseonescalate "Direct link to pauseOnEscalate") > **pauseOnEscalate**: `boolean` Defined in: [packages/sdk/src/types/generated/workspace.ts:538](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/workspace.ts#L538) *** ### sesDomain[​](#sesdomain "Direct link to sesDomain") > **sesDomain**: `string` Defined in: [packages/sdk/src/types/generated/workspace.ts:539](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/workspace.ts#L539) *** ### slug[​](#slug "Direct link to slug") > **slug**: `string` Defined in: [packages/sdk/src/types/generated/workspace.ts:528](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/workspace.ts#L528) *** ### transcriptionModel?[​](#transcriptionmodel "Direct link to transcriptionModel?") > `optional` **transcriptionModel**: `string` | `null` Defined in: [packages/sdk/src/types/generated/workspace.ts:542](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/workspace.ts#L542) *** ### workspaceFolderId?[​](#workspacefolderid "Direct link to workspaceFolderId?") > `optional` **workspaceFolderId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/workspace.ts:531](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/workspace.ts#L531) --- # Interface: WorkspaceDefaultsFormData Defined in: [packages/sdk/src/types/workspace-types.ts:124](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/workspace-types.ts#L124) ## Properties[​](#properties "Direct link to Properties") ### defaultAgentId?[​](#defaultagentid "Direct link to defaultAgentId?") > `optional` **defaultAgentId**: `number` | `null` Defined in: [packages/sdk/src/types/workspace-types.ts:126](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/workspace-types.ts#L126) *** ### defaultPhoneNumberId?[​](#defaultphonenumberid "Direct link to defaultPhoneNumberId?") > `optional` **defaultPhoneNumberId**: `number` | `null` Defined in: [packages/sdk/src/types/workspace-types.ts:125](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/workspace-types.ts#L125) *** ### emailFooter?[​](#emailfooter "Direct link to emailFooter?") > `optional` **emailFooter**: `string` | `null` Defined in: [packages/sdk/src/types/workspace-types.ts:132](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/workspace-types.ts#L132) *** ### enableAudioRecording?[​](#enableaudiorecording "Direct link to enableAudioRecording?") > `optional` **enableAudioRecording**: `boolean` Defined in: [packages/sdk/src/types/workspace-types.ts:134](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/workspace-types.ts#L134) *** ### enableVoicemailDetection?[​](#enablevoicemaildetection "Direct link to enableVoicemailDetection?") > `optional` **enableVoicemailDetection**: `boolean` Defined in: [packages/sdk/src/types/workspace-types.ts:135](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/workspace-types.ts#L135) *** ### escalationBusinessHours?[​](#escalationbusinesshours "Direct link to escalationBusinessHours?") > `optional` **escalationBusinessHours**: `string` | `null` Defined in: [packages/sdk/src/types/workspace-types.ts:127](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/workspace-types.ts#L127) *** ### escalationNotifiedMessageTemplate?[​](#escalationnotifiedmessagetemplate "Direct link to escalationNotifiedMessageTemplate?") > `optional` **escalationNotifiedMessageTemplate**: `string` | `null` Defined in: [packages/sdk/src/types/workspace-types.ts:130](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/workspace-types.ts#L130) *** ### escalationOfflineMessageTemplate?[​](#escalationofflinemessagetemplate "Direct link to escalationOfflineMessageTemplate?") > `optional` **escalationOfflineMessageTemplate**: `string` | `null` Defined in: [packages/sdk/src/types/workspace-types.ts:129](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/workspace-types.ts#L129) *** ### escalationOnlineMessageTemplate?[​](#escalationonlinemessagetemplate "Direct link to escalationOnlineMessageTemplate?") > `optional` **escalationOnlineMessageTemplate**: `string` | `null` Defined in: [packages/sdk/src/types/workspace-types.ts:128](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/workspace-types.ts#L128) *** ### escalationPausedMessageTemplate?[​](#escalationpausedmessagetemplate "Direct link to escalationPausedMessageTemplate?") > `optional` **escalationPausedMessageTemplate**: `string` | `null` Defined in: [packages/sdk/src/types/workspace-types.ts:131](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/workspace-types.ts#L131) *** ### pauseOnEscalate?[​](#pauseonescalate "Direct link to pauseOnEscalate?") > `optional` **pauseOnEscalate**: `boolean` Defined in: [packages/sdk/src/types/workspace-types.ts:133](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/workspace-types.ts#L133) *** ### transcriptionModel?[​](#transcriptionmodel "Direct link to transcriptionModel?") > `optional` **transcriptionModel**: `string` | `null` Defined in: [packages/sdk/src/types/workspace-types.ts:136](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/workspace-types.ts#L136) --- # Interface: WorkspaceExportData Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:350](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L350) ## Properties[​](#properties "Direct link to Properties") ### agents[​](#agents "Direct link to agents") > **agents**: [`AgentExport`](https://docs.gravityrail.com/sdk/interfaces/AgentExport.md)\[] Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:356](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L356) *** ### customToolkits[​](#customtoolkits "Direct link to customToolkits") > **customToolkits**: [`CustomToolkitExport`](https://docs.gravityrail.com/sdk/interfaces/CustomToolkitExport.md)\[] Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:369](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L369) *** ### customTools[​](#customtools "Direct link to customTools") > **customTools**: [`CustomToolExport`](https://docs.gravityrail.com/sdk/interfaces/CustomToolExport.md)\[] Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:370](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L370) *** ### dataTypes[​](#datatypes "Direct link to dataTypes") > **dataTypes**: [`DataTypeExport`](https://docs.gravityrail.com/sdk/interfaces/DataTypeExport.md)\[] Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:355](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L355) *** ### eventRules[​](#eventrules "Direct link to eventRules") > **eventRules**: [`EventRuleExport`](https://docs.gravityrail.com/sdk/interfaces/EventRuleExport.md)\[] Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:359](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L359) *** ### exportedAt[​](#exportedat "Direct link to exportedAt") > **exportedAt**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:352](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L352) *** ### fileFolderRelations[​](#filefolderrelations "Direct link to fileFolderRelations") > **fileFolderRelations**: [`FileFolderRelation`](https://docs.gravityrail.com/sdk/interfaces/FileFolderRelation.md)\[] Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:390](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L390) *** ### fileFolders[​](#filefolders "Direct link to fileFolders") > **fileFolders**: [`FileFolderExport`](https://docs.gravityrail.com/sdk/interfaces/FileFolderExport.md)\[] Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:375](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L375) *** ### fileLabelRelations[​](#filelabelrelations "Direct link to fileLabelRelations") > **fileLabelRelations**: [`FileLabelRelation`](https://docs.gravityrail.com/sdk/interfaces/FileLabelRelation.md)\[] Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:391](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L391) *** ### fileLabels[​](#filelabels "Direct link to fileLabels") > **fileLabels**: [`FileLabelExport`](https://docs.gravityrail.com/sdk/interfaces/FileLabelExport.md)\[] Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:376](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L376) *** ### files[​](#files "Direct link to files") > **files**: [`FileExport`](https://docs.gravityrail.com/sdk/interfaces/FileExport.md)\[] Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:358](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L358) *** ### folderMemberRoleRelations[​](#foldermemberrolerelations "Direct link to folderMemberRoleRelations") > **folderMemberRoleRelations**: [`FolderMemberRoleRelation`](https://docs.gravityrail.com/sdk/interfaces/FolderMemberRoleRelation.md)\[] Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:392](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L392) *** ### inboxes[​](#inboxes "Direct link to inboxes") > **inboxes**: [`InboxExport`](https://docs.gravityrail.com/sdk/interfaces/InboxExport.md)\[] Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:363](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L363) *** ### mcpServers[​](#mcpservers "Direct link to mcpServers") > **mcpServers**: [`McpServerExport`](https://docs.gravityrail.com/sdk/interfaces/McpServerExport.md)\[] Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:373](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L373) *** ### memberFilterRules[​](#memberfilterrules "Direct link to memberFilterRules") > **memberFilterRules**: [`MemberFilterRuleExport`](https://docs.gravityrail.com/sdk/interfaces/MemberFilterRuleExport.md)\[] Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:366](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L366) *** ### memberFilters[​](#memberfilters "Direct link to memberFilters") > **memberFilters**: [`MemberFilterExport`](https://docs.gravityrail.com/sdk/interfaces/MemberFilterExport.md)\[] Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:365](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L365) *** ### memberLabels[​](#memberlabels "Direct link to memberLabels") > **memberLabels**: [`MemberLabelExport`](https://docs.gravityrail.com/sdk/interfaces/MemberLabelExport.md)\[] Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:357](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L357) *** ### memberRoleDataTypeRelations[​](#memberroledatatyperelations "Direct link to memberRoleDataTypeRelations") > **memberRoleDataTypeRelations**: [`MemberRoleDataTypeRelation`](https://docs.gravityrail.com/sdk/interfaces/MemberRoleDataTypeRelation.md)\[] Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:386](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L386) *** ### memberRoleInboxRelations[​](#memberroleinboxrelations "Direct link to memberRoleInboxRelations") > **memberRoleInboxRelations**: [`MemberRoleInboxRelation`](https://docs.gravityrail.com/sdk/interfaces/MemberRoleInboxRelation.md)\[] Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:388](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L388) *** ### memberRoles[​](#memberroles "Direct link to memberRoles") > **memberRoles**: [`MemberRoleExport`](https://docs.gravityrail.com/sdk/interfaces/MemberRoleExport.md)\[] Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:360](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L360) *** ### memberRoleSiteRelations[​](#memberrolesiterelations "Direct link to memberRoleSiteRelations") > **memberRoleSiteRelations**: [`MemberRoleSiteRelation`](https://docs.gravityrail.com/sdk/interfaces/MemberRoleSiteRelation.md)\[] Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:387](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L387) *** ### memberRoleTaskRelations[​](#memberroletaskrelations "Direct link to memberRoleTaskRelations") > **memberRoleTaskRelations**: [`MemberRoleTaskRelation`](https://docs.gravityrail.com/sdk/interfaces/MemberRoleTaskRelation.md)\[] Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:385](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L385) *** ### menuItems[​](#menuitems "Direct link to menuItems") > **menuItems**: [`MenuItemExport`](https://docs.gravityrail.com/sdk/interfaces/MenuItemExport.md)\[] Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:372](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L372) *** ### milestoneGoals[​](#milestonegoals "Direct link to milestoneGoals") > **milestoneGoals**: [`MilestoneGoalExport`](https://docs.gravityrail.com/sdk/interfaces/MilestoneGoalExport.md)\[] Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:368](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L368) *** ### milestones[​](#milestones "Direct link to milestones") > **milestones**: [`MilestoneExport`](https://docs.gravityrail.com/sdk/interfaces/MilestoneExport.md)\[] Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:367](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L367) *** ### pages[​](#pages "Direct link to pages") > **pages**: [`PageExport`](https://docs.gravityrail.com/sdk/interfaces/PageExport.md)\[] Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:371](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L371) *** ### phoneNumbers[​](#phonenumbers "Direct link to phoneNumbers") > **phoneNumbers**: [`PhoneNumberExport`](https://docs.gravityrail.com/sdk/interfaces/PhoneNumberExport.md)\[] Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:361](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L361) *** ### qualifications[​](#qualifications "Direct link to qualifications") > **qualifications**: [`QualificationExport`](https://docs.gravityrail.com/sdk/interfaces/QualificationExport.md)\[] Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:379](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L379) *** ### routines[​](#routines "Direct link to routines") > **routines**: [`RoutineExport`](https://docs.gravityrail.com/sdk/interfaces/RoutineExport.md)\[] Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:364](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L364) *** ### sites[​](#sites "Direct link to sites") > **sites**: [`SiteExport`](https://docs.gravityrail.com/sdk/interfaces/SiteExport.md)\[] Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:362](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L362) *** ### taskChildRelations[​](#taskchildrelations "Direct link to taskChildRelations") > **taskChildRelations**: [`TaskChildRelation`](https://docs.gravityrail.com/sdk/interfaces/TaskChildRelation.md)\[] Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:383](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L383) *** ### taskDataTypeRelations[​](#taskdatatyperelations "Direct link to taskDataTypeRelations") > **taskDataTypeRelations**: [`TaskDataTypeRelation`](https://docs.gravityrail.com/sdk/interfaces/TaskDataTypeRelation.md)\[] Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:381](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L381) *** ### taskEventRuleRelations[​](#taskeventrulerelations "Direct link to taskEventRuleRelations") > **taskEventRuleRelations**: [`TaskEventRuleRelation`](https://docs.gravityrail.com/sdk/interfaces/TaskEventRuleRelation.md)\[] Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:384](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L384) *** ### taskFileRelations[​](#taskfilerelations "Direct link to taskFileRelations") > **taskFileRelations**: [`TaskFileRelation`](https://docs.gravityrail.com/sdk/interfaces/TaskFileRelation.md)\[] Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:382](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L382) *** ### tasks[​](#tasks "Direct link to tasks") > **tasks**: [`TaskExport`](https://docs.gravityrail.com/sdk/interfaces/TaskExport.md)\[] Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:354](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L354) *** ### version[​](#version "Direct link to version") > **version**: `string` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:351](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L351) *** ### workflowNotes[​](#workflownotes "Direct link to workflowNotes") > **workflowNotes**: [`WorkflowNoteExport`](https://docs.gravityrail.com/sdk/interfaces/WorkflowNoteExport.md)\[] Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:377](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L377) *** ### workflows[​](#workflows "Direct link to workflows") > **workflows**: [`WorkflowExport`](https://docs.gravityrail.com/sdk/interfaces/WorkflowExport.md)\[] Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:353](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L353) --- # Interface: WorkspaceFeatureInfo Defined in: [packages/sdk/src/types/workspace-types.ts:50](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/workspace-types.ts#L50) ## Properties[​](#properties "Direct link to Properties") ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/workspace-types.ts:51](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/workspace-types.ts#L51) *** ### slug[​](#slug "Direct link to slug") > **slug**: [`WorkspaceFeature`](https://docs.gravityrail.com/sdk/enumerations/WorkspaceFeature.md) Defined in: [packages/sdk/src/types/workspace-types.ts:52](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/workspace-types.ts#L52) --- # Interface: WorkspaceFormData Defined in: [packages/sdk/src/types/workspace-types.ts:76](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/workspace-types.ts#L76) ## Properties[​](#properties "Direct link to Properties") ### allowSignup?[​](#allowsignup "Direct link to allowSignup?") > `optional` **allowSignup**: `boolean` Defined in: [packages/sdk/src/types/workspace-types.ts:81](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/workspace-types.ts#L81) *** ### isPublic?[​](#ispublic "Direct link to isPublic?") > `optional` **isPublic**: `boolean` Defined in: [packages/sdk/src/types/workspace-types.ts:80](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/workspace-types.ts#L80) *** ### locale?[​](#locale "Direct link to locale?") > `optional` **locale**: `string` Defined in: [packages/sdk/src/types/workspace-types.ts:82](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/workspace-types.ts#L82) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/workspace-types.ts:77](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/workspace-types.ts#L77) *** ### signupCode?[​](#signupcode "Direct link to signupCode?") > `optional` **signupCode**: `string` Defined in: [packages/sdk/src/types/workspace-types.ts:79](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/workspace-types.ts#L79) *** ### slug?[​](#slug "Direct link to slug?") > `optional` **slug**: `string` Defined in: [packages/sdk/src/types/workspace-types.ts:78](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/workspace-types.ts#L78) *** ### timezone?[​](#timezone "Direct link to timezone?") > `optional` **timezone**: `string` Defined in: [packages/sdk/src/types/workspace-types.ts:83](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/workspace-types.ts#L83) --- # Interface: WorkspaceHealthDetail Defined in: [packages/sdk/src/types/health-dashboard-types.ts:43](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/health-dashboard-types.ts#L43) ## Properties[​](#properties "Direct link to Properties") ### eventRules[​](#eventrules "Direct link to eventRules") > **eventRules**: [`ChannelErrorBreakdown`](https://docs.gravityrail.com/sdk/interfaces/ChannelErrorBreakdown.md) | `null` Defined in: [packages/sdk/src/types/health-dashboard-types.ts:49](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/health-dashboard-types.ts#L49) *** ### hours[​](#hours "Direct link to hours") > **hours**: `number` Defined in: [packages/sdk/src/types/health-dashboard-types.ts:45](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/health-dashboard-types.ts#L45) *** ### sms[​](#sms "Direct link to sms") > **sms**: [`ChannelErrorBreakdown`](https://docs.gravityrail.com/sdk/interfaces/ChannelErrorBreakdown.md) | `null` Defined in: [packages/sdk/src/types/health-dashboard-types.ts:46](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/health-dashboard-types.ts#L46) *** ### voice[​](#voice "Direct link to voice") > **voice**: [`ChannelErrorBreakdown`](https://docs.gravityrail.com/sdk/interfaces/ChannelErrorBreakdown.md) | `null` Defined in: [packages/sdk/src/types/health-dashboard-types.ts:47](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/health-dashboard-types.ts#L47) *** ### webhooks[​](#webhooks "Direct link to webhooks") > **webhooks**: [`ChannelErrorBreakdown`](https://docs.gravityrail.com/sdk/interfaces/ChannelErrorBreakdown.md) | `null` Defined in: [packages/sdk/src/types/health-dashboard-types.ts:48](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/health-dashboard-types.ts#L48) *** ### workspaceUuid[​](#workspaceuuid "Direct link to workspaceUuid") > **workspaceUuid**: `string` Defined in: [packages/sdk/src/types/health-dashboard-types.ts:44](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/health-dashboard-types.ts#L44) --- # Interface: WorkspaceHealthRow Defined in: [packages/sdk/src/types/generated/health\_dashboard.ts:87](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/health_dashboard.ts#L87) Health metrics for a single workspace. ## Properties[​](#properties "Direct link to Properties") ### accessGapWarnings?[​](#accessgapwarnings "Direct link to accessGapWarnings?") > `optional` **accessGapWarnings**: `number` Defined in: [packages/sdk/src/types/generated/health\_dashboard.ts:100](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/health_dashboard.ts#L100) *** ### channelFailures[​](#channelfailures "Direct link to channelFailures") > **channelFailures**: [`ChannelFailures`](https://docs.gravityrail.com/sdk/interfaces/ChannelFailures.md) Defined in: [packages/sdk/src/types/generated/health\_dashboard.ts:95](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/health_dashboard.ts#L95) *** ### eventRules[​](#eventrules "Direct link to eventRules") > **eventRules**: [`EventRuleMetrics`](https://docs.gravityrail.com/sdk/interfaces/EventRuleMetrics.md) Defined in: [packages/sdk/src/types/generated/health\_dashboard.ts:96](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/health_dashboard.ts#L96) *** ### healthStatus[​](#healthstatus "Direct link to healthStatus") > **healthStatus**: `string` Defined in: [packages/sdk/src/types/generated/health\_dashboard.ts:94](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/health_dashboard.ts#L94) *** ### memberChats?[​](#memberchats "Direct link to memberChats?") > `optional` **memberChats**: `number` Defined in: [packages/sdk/src/types/generated/health\_dashboard.ts:98](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/health_dashboard.ts#L98) *** ### needsResponse?[​](#needsresponse "Direct link to needsResponse?") > `optional` **needsResponse**: `number` Defined in: [packages/sdk/src/types/generated/health\_dashboard.ts:99](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/health_dashboard.ts#L99) *** ### organizationId[​](#organizationid "Direct link to organizationId") > **organizationId**: `number` Defined in: [packages/sdk/src/types/generated/health\_dashboard.ts:90](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/health_dashboard.ts#L90) *** ### organizationName?[​](#organizationname "Direct link to organizationName?") > `optional` **organizationName**: `string` | `null` Defined in: [packages/sdk/src/types/generated/health\_dashboard.ts:91](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/health_dashboard.ts#L91) *** ### statusCode[​](#statuscode "Direct link to statusCode") > **statusCode**: `number` Defined in: [packages/sdk/src/types/generated/health\_dashboard.ts:92](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/health_dashboard.ts#L92) *** ### statusLabel[​](#statuslabel "Direct link to statusLabel") > **statusLabel**: `string` Defined in: [packages/sdk/src/types/generated/health\_dashboard.ts:93](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/health_dashboard.ts#L93) *** ### webhooks[​](#webhooks "Direct link to webhooks") > **webhooks**: [`WebhookMetrics`](https://docs.gravityrail.com/sdk/interfaces/WebhookMetrics.md) Defined in: [packages/sdk/src/types/generated/health\_dashboard.ts:97](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/health_dashboard.ts#L97) *** ### workspaceName[​](#workspacename "Direct link to workspaceName") > **workspaceName**: `string` Defined in: [packages/sdk/src/types/generated/health\_dashboard.ts:89](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/health_dashboard.ts#L89) *** ### workspaceUuid[​](#workspaceuuid "Direct link to workspaceUuid") > **workspaceUuid**: `string` Defined in: [packages/sdk/src/types/generated/health\_dashboard.ts:88](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/health_dashboard.ts#L88) --- # Interface: WorkspaceImportMapping Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:396](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L396) ## Properties[​](#properties "Direct link to Properties") ### agents[​](#agents "Direct link to agents") > **agents**: `Record`<`string`, `string`> Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:400](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L400) *** ### customToolkits[​](#customtoolkits "Direct link to customToolkits") > **customToolkits**: `Record`<`string`, `string`> Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:413](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L413) *** ### customTools[​](#customtools "Direct link to customTools") > **customTools**: `Record`<`string`, `string`> Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:414](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L414) *** ### dataTypes[​](#datatypes "Direct link to dataTypes") > **dataTypes**: `Record`<`string`, `string`> Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:399](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L399) *** ### eventRules[​](#eventrules "Direct link to eventRules") > **eventRules**: `Record`<`string`, `string`> Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:403](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L403) *** ### fileFolders[​](#filefolders "Direct link to fileFolders") > **fileFolders**: `Record`<`string`, `string`> Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:418](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L418) *** ### fileLabels[​](#filelabels "Direct link to fileLabels") > **fileLabels**: `Record`<`string`, `string`> Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:419](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L419) *** ### files[​](#files "Direct link to files") > **files**: `Record`<`string`, `string`> Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:402](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L402) *** ### inboxes[​](#inboxes "Direct link to inboxes") > **inboxes**: `Record`<`string`, `string`> Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:407](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L407) *** ### mcpServers[​](#mcpservers "Direct link to mcpServers") > **mcpServers**: `Record`<`string`, `string`> Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:417](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L417) *** ### memberFilterRules[​](#memberfilterrules "Direct link to memberFilterRules") > **memberFilterRules**: `Record`<`string`, `string`> Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:410](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L410) *** ### memberFilters[​](#memberfilters "Direct link to memberFilters") > **memberFilters**: `Record`<`string`, `string`> Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:409](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L409) *** ### memberLabels[​](#memberlabels "Direct link to memberLabels") > **memberLabels**: `Record`<`string`, `string`> Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:401](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L401) *** ### memberRoles[​](#memberroles "Direct link to memberRoles") > **memberRoles**: `Record`<`string`, `string`> Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:404](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L404) *** ### menuItems[​](#menuitems "Direct link to menuItems") > **menuItems**: `Record`<`string`, `string`> Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:416](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L416) *** ### milestoneGoals[​](#milestonegoals "Direct link to milestoneGoals") > **milestoneGoals**: `Record`<`string`, `string`> Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:412](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L412) *** ### milestones[​](#milestones "Direct link to milestones") > **milestones**: `Record`<`string`, `string`> Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:411](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L411) *** ### pages[​](#pages "Direct link to pages") > **pages**: `Record`<`string`, `string`> Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:415](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L415) *** ### phoneNumbers[​](#phonenumbers "Direct link to phoneNumbers") > **phoneNumbers**: `Record`<`string`, `string`> Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:405](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L405) *** ### qualifications[​](#qualifications "Direct link to qualifications") > **qualifications**: `Record`<`string`, `string`> Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:421](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L421) *** ### routines[​](#routines "Direct link to routines") > **routines**: `Record`<`string`, `string`> Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:408](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L408) *** ### sites[​](#sites "Direct link to sites") > **sites**: `Record`<`string`, `string`> Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:406](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L406) *** ### tasks[​](#tasks "Direct link to tasks") > **tasks**: `Record`<`string`, `string`> Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:398](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L398) *** ### workflowNotes[​](#workflownotes "Direct link to workflowNotes") > **workflowNotes**: `Record`<`string`, `string`> Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:420](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L420) *** ### workflows[​](#workflows "Direct link to workflows") > **workflows**: `Record`<`string`, `string`> Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:397](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L397) --- # Interface: WorkspaceImportPreviewResponse Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:510](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L510) ## Properties[​](#properties "Direct link to Properties") ### agents[​](#agents "Direct link to agents") > **agents**: [`ImportPreviewItem`](https://docs.gravityrail.com/sdk/interfaces/ImportPreviewItem.md)\[] Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:514](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L514) *** ### dataTypes[​](#datatypes "Direct link to dataTypes") > **dataTypes**: [`ImportPreviewItem`](https://docs.gravityrail.com/sdk/interfaces/ImportPreviewItem.md)\[] Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:513](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L513) *** ### discoveredMappings?[​](#discoveredmappings "Direct link to discoveredMappings?") > `optional` **discoveredMappings**: [`WorkspaceImportMapping`](https://docs.gravityrail.com/sdk/interfaces/WorkspaceImportMapping.md) Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:524](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L524) *** ### eventRules[​](#eventrules "Direct link to eventRules") > **eventRules**: [`ImportPreviewItem`](https://docs.gravityrail.com/sdk/interfaces/ImportPreviewItem.md)\[] Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:516](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L516) *** ### files[​](#files "Direct link to files") > **files**: [`ImportPreviewItem`](https://docs.gravityrail.com/sdk/interfaces/ImportPreviewItem.md)\[] Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:515](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L515) *** ### memberRoles[​](#memberroles "Direct link to memberRoles") > **memberRoles**: [`ImportPreviewItem`](https://docs.gravityrail.com/sdk/interfaces/ImportPreviewItem.md)\[] Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:517](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L517) *** ### phoneNumbers[​](#phonenumbers "Direct link to phoneNumbers") > **phoneNumbers**: [`ImportPreviewItem`](https://docs.gravityrail.com/sdk/interfaces/ImportPreviewItem.md)\[] Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:518](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L518) *** ### relationships[​](#relationships "Direct link to relationships") > **relationships**: [`ImportPreviewItem`](https://docs.gravityrail.com/sdk/interfaces/ImportPreviewItem.md)\[] Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:520](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L520) *** ### sites[​](#sites "Direct link to sites") > **sites**: [`ImportPreviewItem`](https://docs.gravityrail.com/sdk/interfaces/ImportPreviewItem.md)\[] Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:519](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L519) *** ### tasks[​](#tasks "Direct link to tasks") > **tasks**: [`ImportPreviewItem`](https://docs.gravityrail.com/sdk/interfaces/ImportPreviewItem.md)\[] Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:512](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L512) *** ### validationResult[​](#validationresult "Direct link to validationResult") > **validationResult**: [`WorkspaceImportValidation`](https://docs.gravityrail.com/sdk/interfaces/WorkspaceImportValidation.md) Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:521](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L521) *** ### workflows[​](#workflows "Direct link to workflows") > **workflows**: [`ImportPreviewItem`](https://docs.gravityrail.com/sdk/interfaces/ImportPreviewItem.md)\[] Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:511](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L511) --- # Interface: WorkspaceImportRequest Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:484](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L484) ## Properties[​](#properties "Direct link to Properties") ### autoMap?[​](#automap "Direct link to autoMap?") > `optional` **autoMap**: [`WorkspaceAutoMapEntities`](https://docs.gravityrail.com/sdk/interfaces/WorkspaceAutoMapEntities.md) Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:488](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L488) *** ### createNew[​](#createnew "Direct link to createNew") > **createNew**: [`WorkspaceCreateNewEntities`](https://docs.gravityrail.com/sdk/interfaces/WorkspaceCreateNewEntities.md) Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:487](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L487) *** ### exportData[​](#exportdata "Direct link to exportData") > **exportData**: [`WorkspaceExportData`](https://docs.gravityrail.com/sdk/interfaces/WorkspaceExportData.md) Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:485](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L485) *** ### importMappings[​](#importmappings "Direct link to importMappings") > **importMappings**: [`WorkspaceImportMapping`](https://docs.gravityrail.com/sdk/interfaces/WorkspaceImportMapping.md) Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:486](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L486) --- # Interface: WorkspaceImportValidation Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:493](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L493) ## Properties[​](#properties "Direct link to Properties") ### unmappedAgents[​](#unmappedagents "Direct link to unmappedAgents") > **unmappedAgents**: [`AgentExport`](https://docs.gravityrail.com/sdk/interfaces/AgentExport.md)\[] Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:497](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L497) *** ### unmappedDatatypes[​](#unmappeddatatypes "Direct link to unmappedDatatypes") > **unmappedDatatypes**: [`DataTypeExport`](https://docs.gravityrail.com/sdk/interfaces/DataTypeExport.md)\[] Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:498](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L498) *** ### unmappedEventrules[​](#unmappedeventrules "Direct link to unmappedEventrules") > **unmappedEventrules**: [`EventRuleExport`](https://docs.gravityrail.com/sdk/interfaces/EventRuleExport.md)\[] Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:500](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L500) *** ### unmappedFiles[​](#unmappedfiles "Direct link to unmappedFiles") > **unmappedFiles**: [`FileExport`](https://docs.gravityrail.com/sdk/interfaces/FileExport.md)\[] Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:499](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L499) *** ### unmappedInboxes[​](#unmappedinboxes "Direct link to unmappedInboxes") > **unmappedInboxes**: [`InboxExport`](https://docs.gravityrail.com/sdk/interfaces/InboxExport.md)\[] Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:504](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L504) *** ### unmappedMemberRoles[​](#unmappedmemberroles "Direct link to unmappedMemberRoles") > **unmappedMemberRoles**: [`MemberRoleExport`](https://docs.gravityrail.com/sdk/interfaces/MemberRoleExport.md)\[] Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:501](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L501) *** ### unmappedPhonenumbers[​](#unmappedphonenumbers "Direct link to unmappedPhonenumbers") > **unmappedPhonenumbers**: [`PhoneNumberExport`](https://docs.gravityrail.com/sdk/interfaces/PhoneNumberExport.md)\[] Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:502](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L502) *** ### unmappedQualifications[​](#unmappedqualifications "Direct link to unmappedQualifications") > **unmappedQualifications**: [`QualificationExport`](https://docs.gravityrail.com/sdk/interfaces/QualificationExport.md)\[] Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:506](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L506) *** ### unmappedSites[​](#unmappedsites "Direct link to unmappedSites") > **unmappedSites**: [`SiteExport`](https://docs.gravityrail.com/sdk/interfaces/SiteExport.md)\[] Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:503](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L503) *** ### unmappedTasks[​](#unmappedtasks "Direct link to unmappedTasks") > **unmappedTasks**: [`TaskExport`](https://docs.gravityrail.com/sdk/interfaces/TaskExport.md)\[] Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:505](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L505) *** ### unmappedWorkflows[​](#unmappedworkflows "Direct link to unmappedWorkflows") > **unmappedWorkflows**: [`WorkflowExport`](https://docs.gravityrail.com/sdk/interfaces/WorkflowExport.md)\[] Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:496](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L496) *** ### valid[​](#valid "Direct link to valid") > **valid**: `boolean` Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:494](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L494) *** ### validationErrors[​](#validationerrors "Direct link to validationErrors") > **validationErrors**: `string`\[] Defined in: [packages/sdk/src/types\_workspace\_transfer.ts:495](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types_workspace_transfer.ts#L495) --- # Interface: WorkspaceJoinRequest Defined in: [packages/sdk/src/types/workspace-types.ts:168](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/workspace-types.ts#L168) ## Properties[​](#properties "Direct link to Properties") ### memberRoleId[​](#memberroleid "Direct link to memberRoleId") > **memberRoleId**: `number` Defined in: [packages/sdk/src/types/workspace-types.ts:169](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/workspace-types.ts#L169) --- # Interface: WorkspaceJoinResponse Defined in: [packages/sdk/src/types/generated/workspace.ts:470](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/workspace.ts#L470) Response model for joining a workspace. ## Properties[​](#properties "Direct link to Properties") ### memberId[​](#memberid "Direct link to memberId") > **memberId**: `number` Defined in: [packages/sdk/src/types/generated/workspace.ts:473](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/workspace.ts#L473) *** ### memberRoleName[​](#memberrolename "Direct link to memberRoleName") > **memberRoleName**: `string` Defined in: [packages/sdk/src/types/generated/workspace.ts:476](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/workspace.ts#L476) *** ### memberUuid[​](#memberuuid "Direct link to memberUuid") > **memberUuid**: `string` Defined in: [packages/sdk/src/types/generated/workspace.ts:472](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/workspace.ts#L472) *** ### message[​](#message "Direct link to message") > **message**: `string` Defined in: [packages/sdk/src/types/generated/workspace.ts:477](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/workspace.ts#L477) *** ### success[​](#success "Direct link to success") > **success**: `boolean` Defined in: [packages/sdk/src/types/generated/workspace.ts:471](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/workspace.ts#L471) *** ### workspaceName[​](#workspacename "Direct link to workspaceName") > **workspaceName**: `string` Defined in: [packages/sdk/src/types/generated/workspace.ts:475](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/workspace.ts#L475) *** ### workspaceUuid[​](#workspaceuuid "Direct link to workspaceUuid") > **workspaceUuid**: `string` Defined in: [packages/sdk/src/types/generated/workspace.ts:474](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/workspace.ts#L474) --- # Interface: WorkspaceMemberResponse Defined in: [packages/sdk/src/types/generated/member.ts:730](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L730) ## Properties[​](#properties "Direct link to Properties") ### accountEnabled?[​](#accountenabled "Direct link to accountEnabled?") > `optional` **accountEnabled**: `boolean` | `null` Defined in: [packages/sdk/src/types/generated/member.ts:757](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L757) *** ### accountTosAccepted[​](#accounttosaccepted "Direct link to accountTosAccepted") > **accountTosAccepted**: `boolean` | `null` Defined in: [packages/sdk/src/types/generated/member.ts:735](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L735) *** ### accountUuid[​](#accountuuid "Direct link to accountUuid") > **accountUuid**: `string` | `null` Defined in: [packages/sdk/src/types/generated/member.ts:736](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L736) *** ### canLogin?[​](#canlogin "Direct link to canLogin?") > `optional` **canLogin**: `boolean` Defined in: [packages/sdk/src/types/generated/member.ts:766](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L766) *** ### createdAt[​](#createdat "Direct link to createdAt") > **createdAt**: `string` Defined in: [packages/sdk/src/types/generated/member.ts:737](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L737) *** ### dateOfBirth?[​](#dateofbirth "Direct link to dateOfBirth?") > `optional` **dateOfBirth**: `string` | `null` Defined in: [packages/sdk/src/types/generated/member.ts:745](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L745) *** ### description[​](#description "Direct link to description") > **description**: `string` | `null` Defined in: [packages/sdk/src/types/generated/member.ts:740](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L740) *** ### email[​](#email "Direct link to email") > **email**: `string` | `null` Defined in: [packages/sdk/src/types/generated/member.ts:743](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L743) *** ### emailTrusted?[​](#emailtrusted "Direct link to emailTrusted?") > `optional` **emailTrusted**: `boolean` Defined in: [packages/sdk/src/types/generated/member.ts:746](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L746) *** ### experimentGroup?[​](#experimentgroup "Direct link to experimentGroup?") > `optional` **experimentGroup**: `MemberExperimentGroupSummary` | `null` Defined in: [packages/sdk/src/types/generated/member.ts:767](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L767) *** ### externalId[​](#externalid "Direct link to externalId") > **externalId**: `string` | `null` Defined in: [packages/sdk/src/types/generated/member.ts:744](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L744) *** ### homeFolderId?[​](#homefolderid "Direct link to homeFolderId?") > `optional` **homeFolderId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/member.ts:755](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L755) *** ### id[​](#id "Direct link to id") > **id**: `number` Defined in: [packages/sdk/src/types/generated/member.ts:731](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L731) *** ### isArchived?[​](#isarchived "Direct link to isArchived?") > `optional` **isArchived**: `boolean` Defined in: [packages/sdk/src/types/generated/member.ts:763](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L763) *** ### isOrgOwner?[​](#isorgowner "Direct link to isOrgOwner?") > `optional` **isOrgOwner**: `boolean` | `null` Defined in: [packages/sdk/src/types/generated/member.ts:758](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L758) *** ### isSuperuser?[​](#issuperuser "Direct link to isSuperuser?") > `optional` **isSuperuser**: `boolean` | `null` Defined in: [packages/sdk/src/types/generated/member.ts:759](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L759) *** ### labels?[​](#labels "Direct link to labels?") > `optional` **labels**: [`MemberLabelResponse`](https://docs.gravityrail.com/sdk/interfaces/MemberLabelResponse.md)\[] Defined in: [packages/sdk/src/types/generated/member.ts:756](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L756) *** ### locale[​](#locale "Direct link to locale") > **locale**: `string` | `null` Defined in: [packages/sdk/src/types/generated/member.ts:752](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L752) *** ### memberRoleId[​](#memberroleid "Direct link to memberRoleId") > **memberRoleId**: `number` Defined in: [packages/sdk/src/types/generated/member.ts:753](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L753) *** ### memberRoleName[​](#memberrolename "Direct link to memberRoleName") > **memberRoleName**: `string` Defined in: [packages/sdk/src/types/generated/member.ts:754](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L754) *** ### memberType?[​](#membertype "Direct link to memberType?") > `optional` **memberType**: `string` Defined in: [packages/sdk/src/types/generated/member.ts:762](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L762) *** ### name[​](#name "Direct link to name") > **name**: `string` | `null` Defined in: [packages/sdk/src/types/generated/member.ts:739](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L739) *** ### notifyEmail[​](#notifyemail "Direct link to notifyEmail") > **notifyEmail**: `boolean` Defined in: [packages/sdk/src/types/generated/member.ts:749](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L749) *** ### notifySms[​](#notifysms "Direct link to notifySms") > **notifySms**: `boolean` Defined in: [packages/sdk/src/types/generated/member.ts:748](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L748) *** ### notifyVoice[​](#notifyvoice "Direct link to notifyVoice") > **notifyVoice**: `boolean` Defined in: [packages/sdk/src/types/generated/member.ts:750](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L750) *** ### notifyWhatsapp?[​](#notifywhatsapp "Direct link to notifyWhatsapp?") > `optional` **notifyWhatsapp**: `boolean` Defined in: [packages/sdk/src/types/generated/member.ts:751](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L751) *** ### orgRole?[​](#orgrole "Direct link to orgRole?") > `optional` **orgRole**: `string` | `null` Defined in: [packages/sdk/src/types/generated/member.ts:760](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L760) *** ### ownerId?[​](#ownerid "Direct link to ownerId?") > `optional` **ownerId**: `number` | `null` Defined in: [packages/sdk/src/types/generated/member.ts:764](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L764) *** ### ownerName?[​](#ownername "Direct link to ownerName?") > `optional` **ownerName**: `string` | `null` Defined in: [packages/sdk/src/types/generated/member.ts:765](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L765) *** ### phone[​](#phone "Direct link to phone") > **phone**: `string` | `null` Defined in: [packages/sdk/src/types/generated/member.ts:741](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L741) *** ### phoneTrusted?[​](#phonetrusted "Direct link to phoneTrusted?") > `optional` **phoneTrusted**: `boolean` Defined in: [packages/sdk/src/types/generated/member.ts:747](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L747) *** ### phoneType[​](#phonetype "Direct link to phoneType") > **phoneType**: `string` | `null` Defined in: [packages/sdk/src/types/generated/member.ts:742](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L742) *** ### role[​](#role "Direct link to role") > **role**: `string` Defined in: [packages/sdk/src/types/generated/member.ts:733](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L733) *** ### timezone?[​](#timezone "Direct link to timezone?") > `optional` **timezone**: `string` | `null` Defined in: [packages/sdk/src/types/generated/member.ts:761](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L761) *** ### tosAccepted[​](#tosaccepted "Direct link to tosAccepted") > **tosAccepted**: `boolean` Defined in: [packages/sdk/src/types/generated/member.ts:734](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L734) *** ### updatedAt[​](#updatedat "Direct link to updatedAt") > **updatedAt**: `string` Defined in: [packages/sdk/src/types/generated/member.ts:738](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L738) *** ### uuid[​](#uuid "Direct link to uuid") > **uuid**: `string` Defined in: [packages/sdk/src/types/generated/member.ts:732](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L732) --- # Interface: WorkspaceScope Defined in: [packages/sdk/src/api/workspaces.ts:32](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/workspaces.ts#L32) Workspace-grantable scope metadata. These are scopes that can be assigned to member roles. ## Properties[​](#properties "Direct link to Properties") ### category[​](#category "Direct link to category") > **category**: `string` Defined in: [packages/sdk/src/api/workspaces.ts:34](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/workspaces.ts#L34) *** ### dangerous[​](#dangerous "Direct link to dangerous") > **dangerous**: `boolean` Defined in: [packages/sdk/src/api/workspaces.ts:37](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/workspaces.ts#L37) *** ### description[​](#description "Direct link to description") > **description**: `string` Defined in: [packages/sdk/src/api/workspaces.ts:35](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/workspaces.ts#L35) *** ### implies[​](#implies "Direct link to implies") > **implies**: `string`\[] Defined in: [packages/sdk/src/api/workspaces.ts:36](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/workspaces.ts#L36) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/api/workspaces.ts:33](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/workspaces.ts#L33) --- # Interface: WorkspaceScopesResponse Defined in: [packages/sdk/src/api/workspaces.ts:43](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/workspaces.ts#L43) Response containing all workspace-grantable scopes. ## Properties[​](#properties "Direct link to Properties") ### categories[​](#categories "Direct link to categories") > **categories**: `string`\[] Defined in: [packages/sdk/src/api/workspaces.ts:45](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/workspaces.ts#L45) *** ### items[​](#items "Direct link to items") > **items**: [`WorkspaceScope`](https://docs.gravityrail.com/sdk/interfaces/WorkspaceScope.md)\[] Defined in: [packages/sdk/src/api/workspaces.ts:44](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/workspaces.ts#L44) --- # Interface: WorkspaceStatsResponse Defined in: [packages/sdk/src/types/workspace-types.ts:112](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/workspace-types.ts#L112) ## Properties[​](#properties "Direct link to Properties") ### pages[​](#pages "Direct link to pages") > **pages**: `number` Defined in: [packages/sdk/src/types/workspace-types.ts:114](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/workspace-types.ts#L114) *** ### sites[​](#sites "Direct link to sites") > **sites**: `number` Defined in: [packages/sdk/src/types/workspace-types.ts:113](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/workspace-types.ts#L113) --- # Interface: WorkspaceUsageReportResponse Defined in: [packages/sdk/src/types/generated/usage.ts:268](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/usage.ts#L268) Workspace usage report response. ## Properties[​](#properties "Direct link to Properties") ### communicationDetails[​](#communicationdetails "Direct link to communicationDetails") > **communicationDetails**: [`CommunicationDetailsResponse`](https://docs.gravityrail.com/sdk/interfaces/CommunicationDetailsResponse.md) Defined in: [packages/sdk/src/types/generated/usage.ts:276](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/usage.ts#L276) *** ### name[​](#name "Direct link to name") > **name**: `string` Defined in: [packages/sdk/src/types/generated/usage.ts:270](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/usage.ts#L270) *** ### overages[​](#overages "Direct link to overages") > **overages**: `Partial`<`Record`<`Resource`, [`ResourceOverageResponse`](https://docs.gravityrail.com/sdk/interfaces/ResourceOverageResponse.md)>> Defined in: [packages/sdk/src/types/generated/usage.ts:274](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/usage.ts#L274) *** ### product[​](#product "Direct link to product") > **product**: [`UsageProductSummaryResponse`](https://docs.gravityrail.com/sdk/interfaces/UsageProductSummaryResponse.md) Defined in: [packages/sdk/src/types/generated/usage.ts:272](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/usage.ts#L272) *** ### slug[​](#slug "Direct link to slug") > **slug**: `string` Defined in: [packages/sdk/src/types/generated/usage.ts:271](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/usage.ts#L271) *** ### totalOverageCostCents[​](#totaloveragecostcents "Direct link to totalOverageCostCents") > **totalOverageCostCents**: `number` Defined in: [packages/sdk/src/types/generated/usage.ts:275](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/usage.ts#L275) *** ### usage[​](#usage "Direct link to usage") > **usage**: [`ResourceUsageResponse`](https://docs.gravityrail.com/sdk/interfaces/ResourceUsageResponse.md) Defined in: [packages/sdk/src/types/generated/usage.ts:273](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/usage.ts#L273) *** ### uuid[​](#uuid "Direct link to uuid") > **uuid**: `string` Defined in: [packages/sdk/src/types/generated/usage.ts:269](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/usage.ts#L269) --- # Interface: XAIChatModelConfig Defined in: [packages/sdk/src/types/model-config-types.ts:164](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/model-config-types.ts#L164) Base configuration for all chat models. Can be extended for provider-specific options. ## Extends[​](#extends "Direct link to Extends") * [`BaseChatModelConfig`](https://docs.gravityrail.com/sdk/interfaces/BaseChatModelConfig.md) ## Properties[​](#properties "Direct link to Properties") ### provider[​](#provider "Direct link to provider") > **provider**: `"xai"` Defined in: [packages/sdk/src/types/model-config-types.ts:165](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/model-config-types.ts#L165) *** ### reasoningEffort?[​](#reasoningeffort "Direct link to reasoningEffort?") > `optional` **reasoningEffort**: [`XAIReasoningEffort`](https://docs.gravityrail.com/sdk/type-aliases/XAIReasoningEffort.md) | `null` Defined in: [packages/sdk/src/types/model-config-types.ts:166](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/model-config-types.ts#L166) --- # Interface: XAIRealtimeModelConfig Defined in: [packages/sdk/src/types/model-config-types.ts:110](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/model-config-types.ts#L110) xAI Voice Agent realtime config. Only `server_vad` is supported, so the server-side schema rejects `semantic_vad`. Mirrors `lib/constants.py:XAIRealtimeModelConfig`. ## Extends[​](#extends "Direct link to Extends") * [`BaseRealtimeModelConfig`](https://docs.gravityrail.com/sdk/interfaces/BaseRealtimeModelConfig.md) ## Properties[​](#properties "Direct link to Properties") ### interruptionSound?[​](#interruptionsound "Direct link to interruptionSound?") > `optional` **interruptionSound**: [`InterruptionSound`](https://docs.gravityrail.com/sdk/type-aliases/InterruptionSound.md) | `null` Defined in: [packages/sdk/src/types/model-config-types.ts:69](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/model-config-types.ts#L69) Sound to play when user stops speaking after interrupting the assistant. Provides immediate auditory feedback that input was received. Default: none. #### Inherited from[​](#inherited-from "Direct link to Inherited from") [`BaseRealtimeModelConfig`](https://docs.gravityrail.com/sdk/interfaces/BaseRealtimeModelConfig.md).[`interruptionSound`](https://docs.gravityrail.com/sdk/interfaces/BaseRealtimeModelConfig.md#interruptionsound) *** ### interruptionSoundVolume?[​](#interruptionsoundvolume "Direct link to interruptionSoundVolume?") > `optional` **interruptionSoundVolume**: `number` | `null` Defined in: [packages/sdk/src/types/model-config-types.ts:71](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/model-config-types.ts#L71) Volume level for the interruption sound (0-100). 0 means muted. Missing or null means full volume (100). #### Inherited from[​](#inherited-from-1 "Direct link to Inherited from") [`BaseRealtimeModelConfig`](https://docs.gravityrail.com/sdk/interfaces/BaseRealtimeModelConfig.md).[`interruptionSoundVolume`](https://docs.gravityrail.com/sdk/interfaces/BaseRealtimeModelConfig.md#interruptionsoundvolume) *** ### thinkingSound?[​](#thinkingsound "Direct link to thinkingSound?") > `optional` **thinkingSound**: [`ThinkingSound`](https://docs.gravityrail.com/sdk/type-aliases/ThinkingSound.md) | `null` Defined in: [packages/sdk/src/types/model-config-types.ts:61](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/model-config-types.ts#L61) Sound to play while the agent is processing tool calls. #### Inherited from[​](#inherited-from-2 "Direct link to Inherited from") [`BaseRealtimeModelConfig`](https://docs.gravityrail.com/sdk/interfaces/BaseRealtimeModelConfig.md).[`thinkingSound`](https://docs.gravityrail.com/sdk/interfaces/BaseRealtimeModelConfig.md#thinkingsound) *** ### thinkingSoundInitialDelay?[​](#thinkingsoundinitialdelay "Direct link to thinkingSoundInitialDelay?") > `optional` **thinkingSoundInitialDelay**: `number` | `null` Defined in: [packages/sdk/src/types/model-config-types.ts:65](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/model-config-types.ts#L65) Initial delay in milliseconds before playing thinking sound. Prevents needless interruption on short tool calls. Default: 500ms. #### Inherited from[​](#inherited-from-3 "Direct link to Inherited from") [`BaseRealtimeModelConfig`](https://docs.gravityrail.com/sdk/interfaces/BaseRealtimeModelConfig.md).[`thinkingSoundInitialDelay`](https://docs.gravityrail.com/sdk/interfaces/BaseRealtimeModelConfig.md#thinkingsoundinitialdelay) *** ### thinkingSoundVolume?[​](#thinkingsoundvolume "Direct link to thinkingSoundVolume?") > `optional` **thinkingSoundVolume**: `number` | `null` Defined in: [packages/sdk/src/types/model-config-types.ts:63](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/model-config-types.ts#L63) Volume level for the thinking sound (0-100). 0 means muted. Missing or null means full volume (100). #### Inherited from[​](#inherited-from-4 "Direct link to Inherited from") [`BaseRealtimeModelConfig`](https://docs.gravityrail.com/sdk/interfaces/BaseRealtimeModelConfig.md).[`thinkingSoundVolume`](https://docs.gravityrail.com/sdk/interfaces/BaseRealtimeModelConfig.md#thinkingsoundvolume) *** ### thinkingSpeechPhrases?[​](#thinkingspeechphrases "Direct link to thinkingSpeechPhrases?") > `optional` **thinkingSpeechPhrases**: `string`\[] | `null` Defined in: [packages/sdk/src/types/model-config-types.ts:67](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/model-config-types.ts#L67) When `thinkingSound` is 'speech', one of these phrases is spoken while the agent runs a tool. Phrases rotate round-robin per session. #### Inherited from[​](#inherited-from-5 "Direct link to Inherited from") [`BaseRealtimeModelConfig`](https://docs.gravityrail.com/sdk/interfaces/BaseRealtimeModelConfig.md).[`thinkingSpeechPhrases`](https://docs.gravityrail.com/sdk/interfaces/BaseRealtimeModelConfig.md#thinkingspeechphrases) *** ### ttsModel?[​](#ttsmodel "Direct link to ttsModel?") > `optional` **ttsModel**: `"native"` | `null` Defined in: [packages/sdk/src/types/model-config-types.ts:111](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/model-config-types.ts#L111) TTS model ID in provider:tts:model format (e.g. 'elevenlabs:tts:eleven\_flash\_v2\_5'), or 'native'. #### Overrides[​](#overrides "Direct link to Overrides") [`BaseRealtimeModelConfig`](https://docs.gravityrail.com/sdk/interfaces/BaseRealtimeModelConfig.md).[`ttsModel`](https://docs.gravityrail.com/sdk/interfaces/BaseRealtimeModelConfig.md#ttsmodel) *** ### turnDetection?[​](#turndetection "Direct link to turnDetection?") > `optional` **turnDetection**: [`OpenAIServerVADTurnDetection`](https://docs.gravityrail.com/sdk/interfaces/OpenAIServerVADTurnDetection.md) | `null` Defined in: [packages/sdk/src/types/model-config-types.ts:112](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/model-config-types.ts#L112) *** ### voiceModel?[​](#voicemodel "Direct link to voiceModel?") > `optional` **voiceModel**: `string` | `null` Defined in: [packages/sdk/src/types/model-config-types.ts:75](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/model-config-types.ts#L75) Canonical voice identifier (e.g., elevenlabs:voice:catt) that selects the specific agent voice. #### Inherited from[​](#inherited-from-6 "Direct link to Inherited from") [`BaseRealtimeModelConfig`](https://docs.gravityrail.com/sdk/interfaces/BaseRealtimeModelConfig.md).[`voiceModel`](https://docs.gravityrail.com/sdk/interfaces/BaseRealtimeModelConfig.md#voicemodel) --- # Type Alias: Ability > **Ability** = [`AbilityResponse`](https://docs.gravityrail.com/sdk/type-aliases/AbilityResponse.md) Defined in: [packages/sdk/src/types/ability-types.ts:461](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ability-types.ts#L461) --- # Type Alias: AbilityConfig > **AbilityConfig** = [`CalendarBookingAbilityConfig`](https://docs.gravityrail.com/sdk/interfaces/CalendarBookingAbilityConfig.md) | [`FileAccessAbilityConfig`](https://docs.gravityrail.com/sdk/interfaces/FileAccessAbilityConfig.md) | [`SupervisorAbilityConfig`](https://docs.gravityrail.com/sdk/interfaces/SupervisorAbilityConfig.md) | [`SupervisorActionsAbilityConfig`](https://docs.gravityrail.com/sdk/interfaces/SupervisorActionsAbilityConfig.md) | [`ToolkitsAbilityConfig`](https://docs.gravityrail.com/sdk/interfaces/ToolkitsAbilityConfig.md) | [`DataAccessAbilityConfig`](https://docs.gravityrail.com/sdk/interfaces/DataAccessAbilityConfig.md) | [`PhoneCallToolsAbilityConfig`](https://docs.gravityrail.com/sdk/interfaces/PhoneCallToolsAbilityConfig.md) | [`SendSMSAbilityConfig`](https://docs.gravityrail.com/sdk/interfaces/SendSMSAbilityConfig.md) | [`EscalationAbilityConfig`](https://docs.gravityrail.com/sdk/interfaces/EscalationAbilityConfig.md) | [`WebSearchAbilityConfig`](https://docs.gravityrail.com/sdk/interfaces/WebSearchAbilityConfig.md) | [`ConversationHistoryAbilityConfig`](https://docs.gravityrail.com/sdk/interfaces/ConversationHistoryAbilityConfig.md) | [`GmailAbilityConfig`](https://docs.gravityrail.com/sdk/type-aliases/GmailAbilityConfig.md) | [`GoogleCalendarAbilityConfig`](https://docs.gravityrail.com/sdk/type-aliases/GoogleCalendarAbilityConfig.md) | [`GoogleDriveAbilityConfig`](https://docs.gravityrail.com/sdk/type-aliases/GoogleDriveAbilityConfig.md) | [`AudioPlaybackAbilityConfig`](https://docs.gravityrail.com/sdk/interfaces/AudioPlaybackAbilityConfig.md) | [`CharlestonPmdAbilityConfig`](https://docs.gravityrail.com/sdk/interfaces/CharlestonPmdAbilityConfig.md) | [`ConversationControlAbilityConfig`](https://docs.gravityrail.com/sdk/interfaces/ConversationControlAbilityConfig.md) | [`WorkflowRunAbilityConfig`](https://docs.gravityrail.com/sdk/interfaces/WorkflowRunAbilityConfig.md) | [`MemberFieldVerificationAbilityConfig`](https://docs.gravityrail.com/sdk/interfaces/MemberFieldVerificationAbilityConfig.md) | [`ImageGenerationAbilityConfig`](https://docs.gravityrail.com/sdk/interfaces/ImageGenerationAbilityConfig.md) | [`EmptyAbilityConfig`](https://docs.gravityrail.com/sdk/type-aliases/EmptyAbilityConfig.md) | `Record`<`string`, `unknown`> Defined in: [packages/sdk/src/types/ability-types.ts:431](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ability-types.ts#L431) Union type of all ability configs --- # Type Alias: AbilityConfigIssueCode > **AbilityConfigIssueCode** = *typeof* [`AbilityConfigIssueCode`](https://docs.gravityrail.com/sdk/variables/AbilityConfigIssueCode.md)\[keyof *typeof* [`AbilityConfigIssueCode`](https://docs.gravityrail.com/sdk/variables/AbilityConfigIssueCode.md)] Defined in: [packages/sdk/src/types/generated/task.ts:37](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L37) --- # Type Alias: AbilityConfigIssueSeverity > **AbilityConfigIssueSeverity** = *typeof* [`AbilityConfigIssueSeverity`](https://docs.gravityrail.com/sdk/variables/AbilityConfigIssueSeverity.md)\[keyof *typeof* [`AbilityConfigIssueSeverity`](https://docs.gravityrail.com/sdk/variables/AbilityConfigIssueSeverity.md)] Defined in: [packages/sdk/src/types/generated/task.ts:47](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L47) --- # Type Alias: AbilityResponse > **AbilityResponse** = `Omit`<`GeneratedAbilityResponse`, `"config"` | `"id"`> & `object` Defined in: [packages/sdk/src/types/ability-types.ts:456](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ability-types.ts#L456) Re-bind config to typed client union (OpenAPI emits `{ [key: string]: unknown }`). ## Type Declaration[​](#type-declaration "Direct link to Type Declaration") ### config[​](#config "Direct link to config") > **config**: [`AbilityConfig`](https://docs.gravityrail.com/sdk/type-aliases/AbilityConfig.md) ### id?[​](#id "Direct link to id?") > `optional` **id**: `number` --- # Type Alias: AbilityTypeSlug > **AbilityTypeSlug** = *typeof* [`AbilityTypeSlugs`](https://docs.gravityrail.com/sdk/variables/AbilityTypeSlugs.md)\[keyof *typeof* [`AbilityTypeSlugs`](https://docs.gravityrail.com/sdk/variables/AbilityTypeSlugs.md)] Defined in: [packages/sdk/src/types/ability-types.ts:77](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ability-types.ts#L77) Type for ability type slug values --- # Type Alias: AccessGrant > **AccessGrant** = `Omit`<[`GeneratedAccessGrantResponse`](https://docs.gravityrail.com/sdk/interfaces/GeneratedAccessGrantResponse.md), `"status"`> & `object` Defined in: [packages/sdk/src/types/access-grant-types.ts:8](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/access-grant-types.ts#L8) ## Type Declaration[​](#type-declaration "Direct link to Type Declaration") ### status[​](#status "Direct link to status") > **status**: [`AccessGrantStatus`](https://docs.gravityrail.com/sdk/enumerations/AccessGrantStatus.md) --- # Type Alias: AccessGrantInterrupt > **AccessGrantInterrupt** = [`AppConnectionAccessInterrupt`](https://docs.gravityrail.com/sdk/interfaces/AppConnectionAccessInterrupt.md) | [`DataAccessGrantInterrupt`](https://docs.gravityrail.com/sdk/interfaces/DataAccessGrantInterrupt.md) Defined in: [packages/sdk/src/types/chat-types.ts:387](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L387) --- # Type Alias: AccessGrantResponse > **AccessGrantResponse** = [`AccessGrant`](https://docs.gravityrail.com/sdk/type-aliases/AccessGrant.md) Defined in: [packages/sdk/src/types/access-grant-types.ts:12](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/access-grant-types.ts#L12) --- # Type Alias: AccountSortField > **AccountSortField** = `"createdAt"` | `"updatedAt"` | `"name"` | `"email"` Defined in: [packages/sdk/src/types/sort-types.ts:41](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/sort-types.ts#L41) --- # Type Alias: AdminWorkspaceSortField > **AdminWorkspaceSortField** = `"name"` | `"slug"` | `"createdAt"` Defined in: [packages/sdk/src/types/sort-types.ts:47](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/sort-types.ts#L47) --- # Type Alias: AgentSortField > **AgentSortField** = `"createdAt"` | `"updatedAt"` | `"name"` Defined in: [packages/sdk/src/types/sort-types.ts:54](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/sort-types.ts#L54) --- # Type Alias: AnonymousMemberResolutionStatus > **AnonymousMemberResolutionStatus** = `"pending"` | `"resolved"` | `"expired"` Defined in: [packages/sdk/src/types/member-types.ts:483](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L483) --- # Type Alias: App > **App** = `Omit`<`GeneratedAppResponse`, `"builder"`> & `object` Defined in: [packages/sdk/src/types/app-types.ts:27](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-types.ts#L27) ## Type Declaration[​](#type-declaration "Direct link to Type Declaration") ### builder?[​](#builder "Direct link to builder?") > `optional` **builder**: [`AppBuilder`](https://docs.gravityrail.com/sdk/interfaces/AppBuilder.md) | `null` --- # Type Alias: AppConnectionItem > **AppConnectionItem** = [`PlatformAppConnectionResponse`](https://docs.gravityrail.com/sdk/interfaces/PlatformAppConnectionResponse.md) | [`McpServerResponse`](https://docs.gravityrail.com/sdk/interfaces/McpServerResponse.md) | [`DiscordBotResponse`](https://docs.gravityrail.com/sdk/type-aliases/DiscordBotResponse.md) | [`SlackAppResponse`](https://docs.gravityrail.com/sdk/type-aliases/SlackAppResponse.md) | [`TeamsAppResponse`](https://docs.gravityrail.com/sdk/interfaces/TeamsAppResponse.md) | [`FhirConnectionResponse`](https://docs.gravityrail.com/sdk/type-aliases/FhirConnectionResponse.md) | [`SalesforceConnectionResponse`](https://docs.gravityrail.com/sdk/interfaces/SalesforceConnectionResponse.md) | [`HubspotConnectionResponse`](https://docs.gravityrail.com/sdk/interfaces/HubspotConnectionResponse.md) | [`MondayConnectionResponse`](https://docs.gravityrail.com/sdk/interfaces/MondayConnectionResponse.md) | [`ConfluenceConnectionResponse`](https://docs.gravityrail.com/sdk/interfaces/ConfluenceConnectionResponse.md) | [`HealthieConnectionResponse`](https://docs.gravityrail.com/sdk/interfaces/HealthieConnectionResponse.md) Defined in: [packages/sdk/src/types/app-connection-types.ts:77](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L77) Union of all connection types returned by GET /app-connections. Discriminated on `connectionType`. --- # Type Alias: AppConnectionType > **AppConnectionType** = `"platform_app"` | `"mcp_server"` | `"discord_bot"` | `"slack_app"` | `"teams_app"` | `"fhir_connection"` | `"salesforce_connection"` | `"hubspot_connection"` | `"monday_connection"` | `"confluence_connection"` | `"healthie_connection"` Defined in: [packages/sdk/src/types/app-connection-types.ts:55](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L55) Connection type discriminator values — mirrors AppConnectionType in lib/app\_connections/registry.py. --- # Type Alias: AppListResponse > **AppListResponse** = `Omit`<[`GeneratedAppListResponse`](https://docs.gravityrail.com/sdk/interfaces/GeneratedAppListResponse.md), `"items"`> & `object` Defined in: [packages/sdk/src/types/app-types.ts:33](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-types.ts#L33) ## Type Declaration[​](#type-declaration "Direct link to Type Declaration") ### items[​](#items "Direct link to items") > **items**: [`App`](https://docs.gravityrail.com/sdk/type-aliases/App.md)\[] --- # Type Alias: AppResponse > **AppResponse** = [`App`](https://docs.gravityrail.com/sdk/type-aliases/App.md) Defined in: [packages/sdk/src/types/app-types.ts:31](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-types.ts#L31) --- # Type Alias: AssignmentSortField > **AssignmentSortField** = `"createdAt"` | `"updatedAt"` Defined in: [packages/sdk/src/types/sort-types.ts:10](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/sort-types.ts#L10) --- # Type Alias: AssignmentStatusType > **AssignmentStatusType** = `"active"` | `"completed"` | `"canceled"` Defined in: [packages/sdk/src/types/task-types.ts:111](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/task-types.ts#L111) --- # Type Alias: BillingPlanInfo > **BillingPlanInfo** = `PlanInfo` Defined in: [packages/sdk/src/types/billing-types.ts:66](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L66) --- # Type Alias: BotSortField > **BotSortField** = `"createdAt"` | `"updatedAt"` | `"name"` Defined in: [packages/sdk/src/types/sort-types.ts:51](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/sort-types.ts#L51) --- # Type Alias: BulkMemberResultStatus > **BulkMemberResultStatus** = *typeof* [`BulkMemberResultStatus`](https://docs.gravityrail.com/sdk/variables/BulkMemberResultStatus.md)\[keyof *typeof* [`BulkMemberResultStatus`](https://docs.gravityrail.com/sdk/variables/BulkMemberResultStatus.md)] Defined in: [packages/sdk/src/types/generated/member.ts:145](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L145) --- # Type Alias: BusinessIndustry > **BusinessIndustry** = *typeof* [`BusinessIndustry`](https://docs.gravityrail.com/sdk/variables/BusinessIndustry.md)\[keyof *typeof* [`BusinessIndustry`](https://docs.gravityrail.com/sdk/variables/BusinessIndustry.md)] Defined in: [packages/sdk/src/types/generated/organization.ts:115](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L115) Twilio's accepted business industries — SHOUTING\_SNAKE\_CASE. Source: `api-create-secondary-customer-profile.md`. --- # Type Alias: BusinessProfile > **BusinessProfile** = `Omit`<[`GeneratedBusinessProfileResponse`](https://docs.gravityrail.com/sdk/interfaces/GeneratedBusinessProfileResponse.md), `"status"`> & `object` Defined in: [packages/sdk/src/types/organization-types.ts:92](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/organization-types.ts#L92) ## Type Declaration[​](#type-declaration "Direct link to Type Declaration") ### status?[​](#status "Direct link to status?") > `optional` **status**: [`BusinessProfileStatus`](https://docs.gravityrail.com/sdk/type-aliases/BusinessProfileStatus.md) | `null` --- # Type Alias: BusinessProfileEvaluationStatus > **BusinessProfileEvaluationStatus** = `"compliant"` | `"noncompliant"` Defined in: [packages/sdk/src/types/organization-types.ts:182](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/organization-types.ts#L182) Compliance evaluation status (`customer_profile_evaluation_enum_status`). --- # Type Alias: BusinessProfileResponse > **BusinessProfileResponse** = [`BusinessProfile`](https://docs.gravityrail.com/sdk/type-aliases/BusinessProfile.md) Defined in: [packages/sdk/src/types/organization-types.ts:96](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/organization-types.ts#L96) --- # Type Alias: BusinessProfileStatus > **BusinessProfileStatus** = `"draft"` | `"pending-review"` | `"in-review"` | `"twilio-approved"` | `"twilio-rejected"` Defined in: [packages/sdk/src/types/organization-types.ts:172](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/organization-types.ts#L172) Twilio Customer Profile lifecycle status (`customer_profile_enum_status`). --- # Type Alias: BusinessType > **BusinessType** = *typeof* [`BusinessType`](https://docs.gravityrail.com/sdk/variables/BusinessType.md)\[keyof *typeof* [`BusinessType`](https://docs.gravityrail.com/sdk/variables/BusinessType.md)] Defined in: [packages/sdk/src/types/generated/organization.ts:243](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L243) Twilio's accepted business types — Title Case with spaces. Source: `api-create-secondary-customer-profile.md`. Values are inconsistently cased (Title Case here, SHOUTING\_SNAKE for industry, lowercase\_snake for identity) — that's how Twilio defines them. --- # Type Alias: Calendar > **Calendar** = `Omit`<[`GeneratedCalendarResponse`](https://docs.gravityrail.com/sdk/interfaces/GeneratedCalendarResponse.md), `never`> & `object` Defined in: [packages/sdk/src/types/calendar-types.ts:34](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/calendar-types.ts#L34) ## Type Declaration[​](#type-declaration "Direct link to Type Declaration") ### eventTypeIds?[​](#eventtypeids "Direct link to eventTypeIds?") > `optional` **eventTypeIds**: `number`\[] Present on detail responses; omitted from some list payloads. --- # Type Alias: CalendarEventSortField > **CalendarEventSortField** = `"startTime"` | `"createdAt"` Defined in: [packages/sdk/src/types/sort-types.ts:72](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/sort-types.ts#L72) --- # Type Alias: CalendarResponse > **CalendarResponse** = [`Calendar`](https://docs.gravityrail.com/sdk/type-aliases/Calendar.md) Defined in: [packages/sdk/src/types/calendar-types.ts:38](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/calendar-types.ts#L38) --- # Type Alias: CalendarSchedule > **CalendarSchedule** = `Omit`<[`GeneratedCalendarScheduleResponse`](https://docs.gravityrail.com/sdk/interfaces/GeneratedCalendarScheduleResponse.md), `"availabilityType"` | `"recurrenceType"`> & `object` Defined in: [packages/sdk/src/types/calendar-types.ts:40](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/calendar-types.ts#L40) ## Type Declaration[​](#type-declaration "Direct link to Type Declaration") ### availabilityType[​](#availabilitytype "Direct link to availabilityType") > **availabilityType**: [`CalendarScheduleAvailabilityType`](https://docs.gravityrail.com/sdk/enumerations/CalendarScheduleAvailabilityType.md) | `string` ### recurrenceType[​](#recurrencetype "Direct link to recurrenceType") > **recurrenceType**: [`CalendarScheduleRecurrence`](https://docs.gravityrail.com/sdk/enumerations/CalendarScheduleRecurrence.md) | `string` --- # Type Alias: CalendarScheduleResponse > **CalendarScheduleResponse** = [`CalendarSchedule`](https://docs.gravityrail.com/sdk/type-aliases/CalendarSchedule.md) Defined in: [packages/sdk/src/types/calendar-types.ts:47](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/calendar-types.ts#L47) --- # Type Alias: CallEndSection > **CallEndSection** = `Omit`<`GeneratedCallEndSection`, `"statuses"` | `"totalCalls"`> & `object` Defined in: [packages/sdk/src/types/voice-metrics-types.ts:41](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/voice-metrics-types.ts#L41) ## Type Declaration[​](#type-declaration "Direct link to Type Declaration") ### statuses[​](#statuses "Direct link to statuses") > **statuses**: [`CallEndStatusEntry`](https://docs.gravityrail.com/sdk/type-aliases/CallEndStatusEntry.md)\[] ### totalCalls[​](#totalcalls "Direct link to totalCalls") > **totalCalls**: `number` --- # Type Alias: CallEndStatusEntry > **CallEndStatusEntry** = `Omit`<`GeneratedCallEndStatusEntry`, `"total"` | `"timeSeries"`> & `object` Defined in: [packages/sdk/src/types/voice-metrics-types.ts:36](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/voice-metrics-types.ts#L36) ## Type Declaration[​](#type-declaration "Direct link to Type Declaration") ### timeSeries[​](#timeseries "Direct link to timeSeries") > **timeSeries**: [`MetricDataPoint`](https://docs.gravityrail.com/sdk/interfaces/MetricDataPoint.md)\[] ### total[​](#total "Direct link to total") > **total**: `number` --- # Type Alias: Channel > **Channel** = `"cli"` | `"frame"` | `"phone-sms"` | `"phone-voice"` | `"phone-whatsapp"` | `"email"` | `"background"` | `"web-chat"` | `"web-voice"` | `"discord"` | `"slack"` | `"teams"` | `"direct-message"` | `"a2a"` | `"routine"` Defined in: [packages/sdk/src/types/communication-types.ts:222](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/communication-types.ts#L222) --- # Type Alias: CharlestonPmdSimulationOutcome > **CharlestonPmdSimulationOutcome** = `"read"` | `"reply"` | `"send_failed"` | `"no_response_escalate"` | `"daytime_followup_unread"` Defined in: [packages/sdk/src/types/ability-types.ts:368](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ability-types.ts#L368) Allowed values for the Charleston PMD simulation switch (v1). --- # Type Alias: ChatAIModel > **ChatAIModel** = [`ChatModelResponse`](https://docs.gravityrail.com/sdk/interfaces/ChatModelResponse.md) & `object` Defined in: [packages/sdk/src/types/ai-model-types.ts:47](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ai-model-types.ts#L47) ## Type Declaration[​](#type-declaration "Direct link to Type Declaration") ### type[​](#type "Direct link to type") > **type**: `"chat"` --- # Type Alias: ChatFilterFilterType > **ChatFilterFilterType** = `"any"` | `"all"` | `"none"` | `"partial"` | `"exact"` | `"equals"` | `"notEquals"` | `"onlyMine"` | `"active"` | `"greaterThan"` | `"lessThan"` | `"greaterThanOrEqual"` | `"lessThanOrEqual"` | `"before"` | `"after"` | `"between"` Defined in: [packages/sdk/src/types/chat-types.ts:420](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L420) --- # Type Alias: ChatFilterObjectType > **ChatFilterObjectType** = `"title"` | `"participant"` | `"mode"` | `"channel"` | `"owner"` | `"needsResponse"` | `"paused"` | `"label"` | `"memberFilter"` | `"messageCount"` | `"workflow"` | `"phoneNumber"` | `"inbox"` | `"site"` | `"toolCall"` | `"createdAt"` | `"updatedAt"` Defined in: [packages/sdk/src/types/chat-types.ts:401](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L401) --- # Type Alias: ChatModelConfig > **ChatModelConfig** = [`GeminiChatModelConfig`](https://docs.gravityrail.com/sdk/interfaces/GeminiChatModelConfig.md) | [`ClaudeChatModelConfig`](https://docs.gravityrail.com/sdk/interfaces/ClaudeChatModelConfig.md) | [`OpenAIChatModelConfig`](https://docs.gravityrail.com/sdk/interfaces/OpenAIChatModelConfig.md) | [`XAIChatModelConfig`](https://docs.gravityrail.com/sdk/interfaces/XAIChatModelConfig.md) Defined in: [packages/sdk/src/types/model-config-types.ts:169](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/model-config-types.ts#L169) --- # Type Alias: ChatSortField > **ChatSortField** = `"createdAt"` | `"updatedAt"` | `"title"` | `"mostRecentMessage"` Defined in: [packages/sdk/src/types/sort-types.ts:7](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/sort-types.ts#L7) --- # Type Alias: ChatType > **ChatType** = *typeof* [`CHAT_TYPES`](https://docs.gravityrail.com/sdk/variables/CHAT_TYPES.md)\[keyof *typeof* [`CHAT_TYPES`](https://docs.gravityrail.com/sdk/variables/CHAT_TYPES.md)] Defined in: [packages/sdk/src/constants/chat-types.ts:21](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/constants/chat-types.ts#L21) Type for valid chat type values. --- # Type Alias: ConflictPolicyMode > **ConflictPolicyMode** = `"local_wins"` | `"remote_wins"` | `"skip"` Defined in: [packages/sdk/src/types/app-connection-types.ts:481](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L481) --- # Type Alias: ConnectionMultiplicity > **ConnectionMultiplicity** = `"singleton"` | `"multiple"` Defined in: [packages/sdk/src/types/app-connection-types.ts:50](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L50) --- # Type Alias: ContributorAbilityConfig > **ContributorAbilityConfig** = [`EmptyAbilityConfig`](https://docs.gravityrail.com/sdk/type-aliases/EmptyAbilityConfig.md) Defined in: [packages/sdk/src/types/ability-types.ts:400](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ability-types.ts#L400) Config for contributor ability — no user-configurable options --- # Type Alias: CreateInquiryRequest > **CreateInquiryRequest** = `z.infer`<*typeof* `CreateInquirySchema`> Defined in: [packages/sdk/src/types/inquiry-types.ts:27](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/inquiry-types.ts#L27) --- # Type Alias: CredentialProvider > **CredentialProvider** = `"platform_app"` | `"mcp_server"` | `"discord_bot"` | `"slack_app"` | `"teams_app"` | `"fhir_connection"` | `"salesforce_connection"` Defined in: [packages/sdk/src/types/app-connection-types.ts:95](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L95) Provider types match AppConnectionType values from backend --- # Type Alias: CredentialType > **CredentialType** = `"email"` | `"phone"` Defined in: [packages/sdk/src/types/account-types.ts:474](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L474) --- # Type Alias: CustomTool > **CustomTool** = `Omit`<[`GeneratedCustomToolResponse`](https://docs.gravityrail.com/sdk/interfaces/GeneratedCustomToolResponse.md), `"inputSchema"` | `"outputSchema"` | `"toolType"`> & `object` Defined in: [packages/sdk/src/types/custom-tool-types.ts:36](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/custom-tool-types.ts#L36) ## Type Declaration[​](#type-declaration "Direct link to Type Declaration") ### inputSchema?[​](#inputschema "Direct link to inputSchema?") > `optional` **inputSchema**: [`JsonSchema`](https://docs.gravityrail.com/sdk/interfaces/JsonSchema.md) | `null` ### outputSchema?[​](#outputschema "Direct link to outputSchema?") > `optional` **outputSchema**: [`JsonSchema`](https://docs.gravityrail.com/sdk/interfaces/JsonSchema.md) | `null` ### talkToHuman?[​](#talktohuman "Direct link to talkToHuman?") > `optional` **talkToHuman**: `boolean` ### toolType?[​](#tooltype "Direct link to toolType?") > `optional` **toolType**: [`ToolType`](https://docs.gravityrail.com/sdk/type-aliases/ToolType.md) | `null` --- # Type Alias: CustomToolkit > **CustomToolkit** = `Omit`<[`GeneratedCustomToolkitResponse`](https://docs.gravityrail.com/sdk/interfaces/GeneratedCustomToolkitResponse.md), `"customTools"` | `"abilities"`> & `object` Defined in: [packages/sdk/src/types/custom-tool-types.ts:48](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/custom-tool-types.ts#L48) ## Type Declaration[​](#type-declaration "Direct link to Type Declaration") ### abilities?[​](#abilities "Direct link to abilities?") > `optional` **abilities**: [`AbilityResponse`](https://docs.gravityrail.com/sdk/type-aliases/AbilityResponse.md)\[] ### customTools?[​](#customtools "Direct link to customTools?") > `optional` **customTools**: [`CustomTool`](https://docs.gravityrail.com/sdk/type-aliases/CustomTool.md)\[] --- # Type Alias: CustomToolkitResponse > **CustomToolkitResponse** = [`CustomToolkit`](https://docs.gravityrail.com/sdk/type-aliases/CustomToolkit.md) Defined in: [packages/sdk/src/types/custom-tool-types.ts:53](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/custom-tool-types.ts#L53) --- # Type Alias: CustomToolResponse > **CustomToolResponse** = [`CustomTool`](https://docs.gravityrail.com/sdk/type-aliases/CustomTool.md) Defined in: [packages/sdk/src/types/custom-tool-types.ts:46](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/custom-tool-types.ts#L46) --- # Type Alias: DataRecordRetirementResponseReason > **DataRecordRetirementResponseReason** = *typeof* [`DataRecordRetirementResponseReason`](https://docs.gravityrail.com/sdk/variables/DataRecordRetirementResponseReason.md)\[keyof *typeof* [`DataRecordRetirementResponseReason`](https://docs.gravityrail.com/sdk/variables/DataRecordRetirementResponseReason.md)] Defined in: [packages/sdk/src/types/generated/data.ts:94](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/data.ts#L94) --- # Type Alias: DataTypeSortField > **DataTypeSortField** = `"name"` | `"createdAt"` Defined in: [packages/sdk/src/types/sort-types.ts:69](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/sort-types.ts#L69) --- # Type Alias: DiscordBot > **DiscordBot** = `Omit`<[`GeneratedDiscordBotResponse`](https://docs.gravityrail.com/sdk/interfaces/GeneratedDiscordBotResponse.md), `"respondMode"`> & `object` Defined in: [packages/sdk/src/types/discord-bot-types.ts:21](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/discord-bot-types.ts#L21) ## Type Declaration[​](#type-declaration "Direct link to Type Declaration") ### respondMode[​](#respondmode "Direct link to respondMode") > **respondMode**: [`DiscordRespondMode`](https://docs.gravityrail.com/sdk/type-aliases/DiscordRespondMode.md) --- # Type Alias: DiscordBotResponse > **DiscordBotResponse** = [`DiscordBot`](https://docs.gravityrail.com/sdk/type-aliases/DiscordBot.md) Defined in: [packages/sdk/src/types/discord-bot-types.ts:24](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/discord-bot-types.ts#L24) --- # Type Alias: DiscordBotSortField > **DiscordBotSortField** = `"createdAt"` | `"updatedAt"` | `"name"` Defined in: [packages/sdk/src/types/discord-bot-types.ts:118](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/discord-bot-types.ts#L118) Sort fields for Discord bots. --- # Type Alias: DiscordRespondMode > **DiscordRespondMode** = `"mentions"` | `"auto"` | `"off"` Defined in: [packages/sdk/src/types/discord-bot-types.ts:34](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/discord-bot-types.ts#L34) How the Discord bot decides whether to respond to messages. * 'mentions': Only respond when explicitly ## Mentioned[​](#mentioned "Direct link to Mentioned") * 'auto': Use AI to decide whether to respond based on context * 'off': Don't auto-respond (only slash commands work) --- # Type Alias: EmailDisableResponse > **EmailDisableResponse** = { `impact?`: `never`; `ok`: `true`; } | { `impact`: [`EmailDisableImpactResponse`](https://docs.gravityrail.com/sdk/interfaces/EmailDisableImpactResponse.md); `ok`: `false`; } Defined in: [packages/sdk/src/types/organization-types.ts:191](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/organization-types.ts#L191) --- # Type Alias: EmailDnsRecord > **EmailDnsRecord** = `Omit`<`GeneratedEmailDnsRecord`, `"status"`> & `object` Defined in: [packages/sdk/src/types/organization-types.ts:80](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/organization-types.ts#L80) ## Type Declaration[​](#type-declaration "Direct link to Type Declaration") ### status[​](#status "Direct link to status") > **status**: [`OrgDomainDnsRecordStatus`](https://docs.gravityrail.com/sdk/type-aliases/OrgDomainDnsRecordStatus.md) --- # Type Alias: EmailDnsRecordType > **EmailDnsRecordType** = *typeof* [`EmailDnsRecordType`](https://docs.gravityrail.com/sdk/variables/EmailDnsRecordType.md)\[keyof *typeof* [`EmailDnsRecordType`](https://docs.gravityrail.com/sdk/variables/EmailDnsRecordType.md)] Defined in: [packages/sdk/src/types/generated/organization.ts:315](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L315) --- # Type Alias: EmailDomainConfig > **EmailDomainConfig** = `Omit`<[`EmailDomainConfigResponse`](https://docs.gravityrail.com/sdk/interfaces/EmailDomainConfigResponse.md), `"status"` | `"spfStatus"` | `"dkimStatus"` | `"dmarcStatus"` | `"mxStatus"` | `"returnPathStatus"` | `"dnsRecords"`> & `object` Defined in: [packages/sdk/src/types/organization-types.ts:98](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/organization-types.ts#L98) ## Type Declaration[​](#type-declaration "Direct link to Type Declaration") ### dkimStatus[​](#dkimstatus "Direct link to dkimStatus") > **dkimStatus**: [`OrgDomainDnsRecordStatus`](https://docs.gravityrail.com/sdk/type-aliases/OrgDomainDnsRecordStatus.md) ### dmarcStatus[​](#dmarcstatus "Direct link to dmarcStatus") > **dmarcStatus**: [`OrgDomainDnsRecordStatus`](https://docs.gravityrail.com/sdk/type-aliases/OrgDomainDnsRecordStatus.md) ### dnsRecords[​](#dnsrecords "Direct link to dnsRecords") > **dnsRecords**: [`EmailDnsRecord`](https://docs.gravityrail.com/sdk/type-aliases/EmailDnsRecord.md)\[] ### mxStatus[​](#mxstatus "Direct link to mxStatus") > **mxStatus**: [`OrgDomainDnsRecordStatus`](https://docs.gravityrail.com/sdk/type-aliases/OrgDomainDnsRecordStatus.md) ### returnPathStatus[​](#returnpathstatus "Direct link to returnPathStatus") > **returnPathStatus**: [`OrgDomainDnsRecordStatus`](https://docs.gravityrail.com/sdk/type-aliases/OrgDomainDnsRecordStatus.md) ### spfStatus[​](#spfstatus "Direct link to spfStatus") > **spfStatus**: [`OrgDomainDnsRecordStatus`](https://docs.gravityrail.com/sdk/type-aliases/OrgDomainDnsRecordStatus.md) ### status[​](#status "Direct link to status") > **status**: [`OrgDomainCapabilityStatus`](https://docs.gravityrail.com/sdk/type-aliases/OrgDomainCapabilityStatus.md) --- # Type Alias: EmailDomainConfigGetResponse > **EmailDomainConfigGetResponse** = `Omit`<`GeneratedEmailDomainConfigGetResponse`, `"config"`> & `object` Defined in: [packages/sdk/src/types/organization-types.ts:131](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/organization-types.ts#L131) ## Type Declaration[​](#type-declaration "Direct link to Type Declaration") ### config?[​](#config "Direct link to config?") > `optional` **config**: [`EmailDomainConfig`](https://docs.gravityrail.com/sdk/type-aliases/EmailDomainConfig.md) | `null` --- # Type Alias: EmptyAbilityConfig > **EmptyAbilityConfig** = `Record`<`string`, `never`> Defined in: [packages/sdk/src/types/ability-types.ts:428](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ability-types.ts#L428) Config for abilities with no configuration --- # Type Alias: EnhancedAuthHandler() > **EnhancedAuthHandler** = () => `Promise`<`string`> Defined in: [packages/sdk/src/api/base.ts:79](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/base.ts#L79) Handler for enhanced authentication requirement (RFC 9470 Step-Up Authentication). Called when a 401 response includes WWW-Authenticate header with error="insufficient\_user\_authentication". Should return a promise that resolves with the new auth token after re-auth. ## Returns[​](#returns "Direct link to Returns") `Promise`<`string`> --- # Type Alias: EventRule > **EventRule** = [`EventRuleResponse`](https://docs.gravityrail.com/sdk/type-aliases/EventRuleResponse.md) Defined in: [packages/sdk/src/types/event-types.ts:140](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L140) --- # Type Alias: EventRuleResponse > **EventRuleResponse** = `Omit`<`GeneratedEventRuleResponse`, `"objectType"` | `"eventType"` | `"actionType"` | `"actionParams"` | `"triggerParams"`> & `object` Defined in: [packages/sdk/src/types/event-types.ts:129](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L129) Re-bind enum fields to client enums (generated OpenAPI uses string-literal unions). ## Type Declaration[​](#type-declaration "Direct link to Type Declaration") ### actionParams[​](#actionparams "Direct link to actionParams") > **actionParams**: `Record`<`string`, `unknown`> | `null` ### actionType[​](#actiontype "Direct link to actionType") > **actionType**: [`EventRuleActionType`](https://docs.gravityrail.com/sdk/enumerations/EventRuleActionType.md) ### eventType[​](#eventtype "Direct link to eventType") > **eventType**: [`EventRuleEventType`](https://docs.gravityrail.com/sdk/enumerations/EventRuleEventType.md) ### objectType[​](#objecttype "Direct link to objectType") > **objectType**: [`EventRuleObjectType`](https://docs.gravityrail.com/sdk/enumerations/EventRuleObjectType.md) ### triggerParams[​](#triggerparams "Direct link to triggerParams") > **triggerParams**: `Record`<`string`, `unknown`> | `null` --- # Type Alias: EventRunSortField > **EventRunSortField** = `"createdAt"` Defined in: [packages/sdk/src/types/sort-types.ts:34](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/sort-types.ts#L34) --- # Type Alias: FeatureStatusValue > **FeatureStatusValue** = `"enabled"` | `"hidden"` | `"upgrade"` | `"contact"` Defined in: [packages/sdk/src/types/workspace-types.ts:48](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/workspace-types.ts#L48) --- # Type Alias: FhirConnection > **FhirConnection** = `Omit`<[`GeneratedFhirConnectionResponse`](https://docs.gravityrail.com/sdk/interfaces/GeneratedFhirConnectionResponse.md), `"vendor"` | `"clientType"` | `"state"`> & `object` Defined in: [packages/sdk/src/types/fhir-connection-types.ts:26](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L26) ## Type Declaration[​](#type-declaration "Direct link to Type Declaration") ### clientType[​](#clienttype "Direct link to clientType") > **clientType**: [`FhirClientType`](https://docs.gravityrail.com/sdk/enumerations/FhirClientType.md) ### state[​](#state "Direct link to state") > **state**: [`FhirConnectionState`](https://docs.gravityrail.com/sdk/enumerations/FhirConnectionState.md) ### vendor[​](#vendor "Direct link to vendor") > **vendor**: [`FhirVendor`](https://docs.gravityrail.com/sdk/enumerations/FhirVendor.md) --- # Type Alias: FhirConnectionResponse > **FhirConnectionResponse** = [`FhirConnection`](https://docs.gravityrail.com/sdk/type-aliases/FhirConnection.md) Defined in: [packages/sdk/src/types/fhir-connection-types.ts:35](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L35) --- # Type Alias: FhirConnectionSortField > **FhirConnectionSortField** = `"createdAt"` | `"updatedAt"` | `"name"` | `"vendor"` | `"state"` Defined in: [packages/sdk/src/types/fhir-connection-types.ts:103](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L103) Sort fields for FHIR connections. --- # Type Alias: FhirCsvIdentifierKind > **FhirCsvIdentifierKind** = `"encrypted_patient_id"` | `"human_identifier"` Defined in: [packages/sdk/src/types/fhir-connection-types.ts:170](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L170) Identifier classification kind returned by the inspect endpoint. --- # Type Alias: FhirCsvImportRowStatus > **FhirCsvImportRowStatus** = `"linked"` | `"already_linked"` | `"created"` | `"skipped"` | `"ambiguous"` | `"conflict"` | `"not_found"` | `"failed"` Defined in: [packages/sdk/src/types/fhir-connection-types.ts:237](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L237) Status for a single import row. --- # Type Alias: FhirCsvImportRunStatus > **FhirCsvImportRunStatus** = `"queued"` | `"in_progress"` | `"completed"` | `"completed_with_errors"` | `"failed"` Defined in: [packages/sdk/src/types/fhir-connection-types.ts:250](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/fhir-connection-types.ts#L250) Import run summary (PHI-minimal, from DynamoDB). --- # Type Alias: File > **File** = [`GeneratedFileResponse`](https://docs.gravityrail.com/sdk/interfaces/GeneratedFileResponse.md) & `object` Defined in: [packages/sdk/src/types/file-types.ts:34](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/file-types.ts#L34) Sharing endpoints include shareable; list responses may omit it. ## Type Declaration[​](#type-declaration "Direct link to Type Declaration") ### shareable?[​](#shareable "Direct link to shareable?") > `optional` **shareable**: `boolean` --- # Type Alias: FileResponse > **FileResponse** = [`File`](https://docs.gravityrail.com/sdk/type-aliases/File.md) Defined in: [packages/sdk/src/types/file-types.ts:37](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/file-types.ts#L37) --- # Type Alias: FileSharingResponse > **FileSharingResponse** = `Omit`<[`GeneratedFileSharingResponse`](https://docs.gravityrail.com/sdk/interfaces/GeneratedFileSharingResponse.md), `"access"` | `"grants"`> & `object` Defined in: [packages/sdk/src/types/file-types.ts:39](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/file-types.ts#L39) ## Type Declaration[​](#type-declaration "Direct link to Type Declaration") ### access[​](#access "Direct link to access") > **access**: [`AccessLevel`](https://docs.gravityrail.com/sdk/enumerations/AccessLevel.md) ### grants[​](#grants "Direct link to grants") > **grants**: [`AccessGrant`](https://docs.gravityrail.com/sdk/type-aliases/AccessGrant.md)\[] --- # Type Alias: FileSortField > **FileSortField** = `"createdAt"` | `"updatedAt"` | `"name"` Defined in: [packages/sdk/src/types/sort-types.ts:19](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/sort-types.ts#L19) --- # Type Alias: FileWithAccessMode > **FileWithAccessMode** = [`FileResponse`](https://docs.gravityrail.com/sdk/type-aliases/FileResponse.md) & `object` Defined in: [packages/sdk/src/types/file-types.ts:102](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/file-types.ts#L102) ## Type Declaration[​](#type-declaration "Direct link to Type Declaration") ### accessMode[​](#accessmode "Direct link to accessMode") > **accessMode**: `number` ### choicePrompt?[​](#choiceprompt "Direct link to choicePrompt?") > `optional` **choicePrompt**: `string` | `null` --- # Type Alias: FirstRunMode > **FirstRunMode** = `"unset"` | `"concierge"` | `"explorer"` | `"expert"` Defined in: [packages/sdk/src/types/workspace-types.ts:55](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/workspace-types.ts#L55) --- # Type Alias: FolderSharingResponse > **FolderSharingResponse** = `Omit`<[`GeneratedFolderSharingResponse`](https://docs.gravityrail.com/sdk/interfaces/GeneratedFolderSharingResponse.md), `"access"` | `"grants"`> & `object` Defined in: [packages/sdk/src/types/file-types.ts:44](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/file-types.ts#L44) ## Type Declaration[​](#type-declaration "Direct link to Type Declaration") ### access[​](#access "Direct link to access") > **access**: [`AccessLevel`](https://docs.gravityrail.com/sdk/enumerations/AccessLevel.md) ### grants[​](#grants "Direct link to grants") > **grants**: [`AccessGrant`](https://docs.gravityrail.com/sdk/type-aliases/AccessGrant.md)\[] --- # Type Alias: GeminiThinkingLevel > **GeminiThinkingLevel** = `"minimal"` | `"low"` | `"medium"` | `"high"` Defined in: [packages/sdk/src/types/model-config-types.ts:124](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/model-config-types.ts#L124) --- # Type Alias: GmailAbilityConfig > **GmailAbilityConfig** = [`GoogleWorkspaceIntegrationAbilityConfig`](https://docs.gravityrail.com/sdk/interfaces/GoogleWorkspaceIntegrationAbilityConfig.md) Defined in: [packages/sdk/src/types/ability-types.ts:302](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ability-types.ts#L302) Config for integration:gmail --- # Type Alias: GoogleCalendarAbilityConfig > **GoogleCalendarAbilityConfig** = [`GoogleWorkspaceIntegrationAbilityConfig`](https://docs.gravityrail.com/sdk/interfaces/GoogleWorkspaceIntegrationAbilityConfig.md) Defined in: [packages/sdk/src/types/ability-types.ts:305](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ability-types.ts#L305) Config for integration:google\_calendar --- # Type Alias: GoogleDriveAbilityConfig > **GoogleDriveAbilityConfig** = [`GoogleWorkspaceIntegrationAbilityConfig`](https://docs.gravityrail.com/sdk/interfaces/GoogleWorkspaceIntegrationAbilityConfig.md) Defined in: [packages/sdk/src/types/ability-types.ts:308](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ability-types.ts#L308) Config for integration:google\_drive --- # Type Alias: GoogleWorkspaceAccessMode > **GoogleWorkspaceAccessMode** = `"read_only"` | `"read_write"` Defined in: [packages/sdk/src/types/ability-types.ts:290](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ability-types.ts#L290) Read-only vs read-write for member-linked Google integrations --- # Type Alias: GravityRailWorkspaceClient > **GravityRailWorkspaceClient** = `object` & `{ [K in WorkspaceMethodKey]: WorkspaceBoundMethod }` Defined in: [packages/sdk/src/client/workspace-client.ts:721](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/client/workspace-client.ts#L721) ## Type Declaration[​](#type-declaration "Direct link to Type Declaration") ### root[​](#root "Direct link to root") > `readonly` **root**: [`GravityRailClient`](https://docs.gravityrail.com/sdk/classes/GravityRailClient.md) ### workspaceUuid[​](#workspaceuuid "Direct link to workspaceUuid") > `readonly` **workspaceUuid**: `string` --- # Type Alias: HubSpotTaskPriority > **HubSpotTaskPriority** = `"NONE"` | `"LOW"` | `"MEDIUM"` | `"HIGH"` Defined in: [packages/sdk/src/types/app-connection-types.ts:207](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L207) --- # Type Alias: HubSpotTaskStatus > **HubSpotTaskStatus** = `"NOT_STARTED"` | `"IN_PROGRESS"` | `"COMPLETED"` Defined in: [packages/sdk/src/types/app-connection-types.ts:208](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L208) --- # Type Alias: IdentityConflictPolicy > **IdentityConflictPolicy** = `"skip"` | `"overwrite_identity_fields"` Defined in: [packages/sdk/src/types/member-types.ts:129](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L129) How the streaming commit import treats a row that matches an existing member ONLY by phone but carries different identity fields. 'skip' (safe default) writes nothing for the row; 'overwrite\_identity\_fields' overwrites + audits and is intended to be sent only after a preview. --- # Type Alias: Inbox > **Inbox** = `Omit`<`GeneratedInboxResponse`, `"rules"`> & `object` Defined in: [packages/sdk/src/types/communication-types.ts:64](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/communication-types.ts#L64) ## Type Declaration[​](#type-declaration "Direct link to Type Declaration") ### rules?[​](#rules "Direct link to rules?") > `optional` **rules**: `InboxRules` | `null` --- # Type Alias: InquiryStatus > **InquiryStatus** = `"new"` | `"in_progress"` | `"done"` Defined in: [packages/sdk/src/types/inquiry-types.ts:25](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/inquiry-types.ts#L25) --- # Type Alias: InquiryType > **InquiryType** = `"customer"` | `"builder"` | `"partner"` | `"other"` | `"demo_request"` | `"waitlist"` Defined in: [packages/sdk/src/types/inquiry-types.ts:18](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/inquiry-types.ts#L18) --- # Type Alias: InterruptionSound > **InterruptionSound** = `"none"` | `"clav"` | `"bells"` | `"organ"` | `"guzheng"` Defined in: [packages/sdk/src/types/model-config-types.ts:28](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/model-config-types.ts#L28) --- # Type Alias: Invitation > **Invitation** = [`InvitationResponse`](https://docs.gravityrail.com/sdk/type-aliases/InvitationResponse.md) Defined in: [packages/sdk/src/types/invitation-types.ts:33](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/invitation-types.ts#L33) --- # Type Alias: InvitationListResponse > **InvitationListResponse** = `Omit`<[`GeneratedInvitationListResponse`](https://docs.gravityrail.com/sdk/interfaces/GeneratedInvitationListResponse.md), `"items"`> & `object` Defined in: [packages/sdk/src/types/invitation-types.ts:35](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/invitation-types.ts#L35) ## Type Declaration[​](#type-declaration "Direct link to Type Declaration") ### items[​](#items "Direct link to items") > **items**: [`InvitationResponse`](https://docs.gravityrail.com/sdk/type-aliases/InvitationResponse.md)\[] --- # Type Alias: InvitationResponse > **InvitationResponse** = `Omit`<`GeneratedInvitationResponse`, `"status"`> & `object` Defined in: [packages/sdk/src/types/invitation-types.ts:29](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/invitation-types.ts#L29) ## Type Declaration[​](#type-declaration "Direct link to Type Declaration") ### status[​](#status "Direct link to status") > **status**: [`InvitationStatus`](https://docs.gravityrail.com/sdk/enumerations/InvitationStatus.md) --- # Type Alias: JobPosition > **JobPosition** = *typeof* [`JobPosition`](https://docs.gravityrail.com/sdk/variables/JobPosition.md)\[keyof *typeof* [`JobPosition`](https://docs.gravityrail.com/sdk/variables/JobPosition.md)] Defined in: [packages/sdk/src/types/generated/organization.ts:372](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L372) Twilio's accepted authorized-rep job positions. Source: `api-create-secondary-customer-profile.md`. --- # Type Alias: JourneySortField > **JourneySortField** = `"name"` | `"createdAt"` Defined in: [packages/sdk/src/types/sort-types.ts:63](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/sort-types.ts#L63) --- # Type Alias: ManagedAutomationPriority > **ManagedAutomationPriority** = `"NONE"` | `"LOW"` | `"MEDIUM"` | `"HIGH"` Defined in: [packages/sdk/src/types/app-connection-types.ts:487](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L487) --- # Type Alias: ManagedAutomationStatus > **ManagedAutomationStatus** = `"NOT_STARTED"` | `"IN_PROGRESS"` | `"COMPLETED"` | `"DEFERRED"` Defined in: [packages/sdk/src/types/app-connection-types.ts:488](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L488) --- # Type Alias: MatchStrategyMode > **MatchStrategyMode** = `"linked_id"` | `"email"` | `"external_id"` | `"phone"` | `"custom"` Defined in: [packages/sdk/src/types/app-connection-types.ts:442](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L442) --- # Type Alias: McpServerSortField > **McpServerSortField** = `"name"` | `"createdAt"` | `"state"` Defined in: [packages/sdk/src/types/sort-types.ts:66](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/sort-types.ts#L66) --- # Type Alias: MemberFilterFilterType > **MemberFilterFilterType** = `"any"` | `"all"` | `"none"` | `"partial"` | `"notPartial"` | `"exact"` | `"equals"` | `"notEquals"` | `"notContains"` | `"atLeast"` | `"atMost"` | `"field"` | `"dateFilter"` | `"greaterThan"` | `"greaterThanOrEqual"` | `"lessThan"` | `"lessThanOrEqual"` | `"within"` | `"olderThan"` | `"never"` | `"isEmpty"` | `"notEmpty"` | `"before"` | `"after"` | `"between"` | `"daysAgo"` | `"lessThanDaysAgo"` | `"daysUntil"` | `"hasKey"` | `"hasKeyValue"` | `"smsDeliveryStatusNeedsAttention"` | `"callForwardedAny"` | `"inGroup"` Defined in: [packages/sdk/src/types/member-types.ts:248](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L248) --- # Type Alias: MemberFilterObjectType > **MemberFilterObjectType** = `"label"` | `"dataType"` | `"member"` | `"memberRole"` | `"name"` | `"email"` | `"phone"` | `"phoneType"` | `"age"` | `"dateOfBirth"` | `"workflow"` | `"tosAccepted"` | `"notifySms"` | `"notifyEmail"` | `"notifyVoice"` | `"smsDeliveryStatus"` | `"callForwarded"` | `"calendarEvent"` | `"chatEngagement"` | `"lastMessageActivity"` | `"memberCreated"` | `"isDefault"` | `"memberType"` | `"memberField"` | `"journey"` | `"experiment"` Defined in: [packages/sdk/src/types/member-types.ts:220](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L220) --- # Type Alias: MemberFilterWithQuery > **MemberFilterWithQuery** = [`MemberFilterResponse`](https://docs.gravityrail.com/sdk/interfaces/MemberFilterResponse.md) & `object` Defined in: [packages/sdk/src/types/member-types.ts:294](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L294) MemberFilter response with the query-engine predicate column narrowed. The generated type exposes `query` as a loose `{ [key: string]: unknown } | null` (OpenAPI free-form object); this intersection narrows it to the typed client-side `QueryPredicate` IR. ## Type Declaration[​](#type-declaration "Direct link to Type Declaration") ### query?[​](#query "Direct link to query?") > `optional` **query**: [`QueryPredicate`](https://docs.gravityrail.com/sdk/type-aliases/QueryPredicate.md) | `null` --- # Type Alias: MemberImportMatchInfoMatchType > **MemberImportMatchInfoMatchType** = *typeof* [`MemberImportMatchInfoMatchType`](https://docs.gravityrail.com/sdk/variables/MemberImportMatchInfoMatchType.md)\[keyof *typeof* [`MemberImportMatchInfoMatchType`](https://docs.gravityrail.com/sdk/variables/MemberImportMatchInfoMatchType.md)] Defined in: [packages/sdk/src/types/generated/member.ts:448](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L448) --- # Type Alias: MemberImportPreviewRowAction > **MemberImportPreviewRowAction** = *typeof* [`MemberImportPreviewRowAction`](https://docs.gravityrail.com/sdk/variables/MemberImportPreviewRowAction.md)\[keyof *typeof* [`MemberImportPreviewRowAction`](https://docs.gravityrail.com/sdk/variables/MemberImportPreviewRowAction.md)] Defined in: [packages/sdk/src/types/generated/member.ts:482](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L482) --- # Type Alias: MemberMemoriesResponse > **MemberMemoriesResponse** = `Omit`<[`GeneratedMemoryListResponse`](https://docs.gravityrail.com/sdk/interfaces/GeneratedMemoryListResponse.md), `"items"`> & `object` Defined in: [packages/sdk/src/types/member-types.ts:85](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L85) ## Type Declaration[​](#type-declaration "Direct link to Type Declaration") ### items[​](#items "Direct link to items") > **items**: [`MemoryItem`](https://docs.gravityrail.com/sdk/type-aliases/MemoryItem.md)\[] --- # Type Alias: MemberSortField > **MemberSortField** = `"createdAt"` | `"updatedAt"` | `"name"` | `"email"` Defined in: [packages/sdk/src/types/sort-types.ts:13](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/sort-types.ts#L13) --- # Type Alias: MemberUpsertBehavior > **MemberUpsertBehavior** = `"upsert"` | `"create_only"` | `"update_only"` Defined in: [packages/sdk/src/types/event-types.ts:198](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L198) --- # Type Alias: MemoryItem > **MemoryItem** = [`GeneratedMemoryResponse`](https://docs.gravityrail.com/sdk/interfaces/GeneratedMemoryResponse.md) Defined in: [packages/sdk/src/types/member-types.ts:82](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L82) --- # Type Alias: MemoryResponse > **MemoryResponse** = [`MemoryItem`](https://docs.gravityrail.com/sdk/type-aliases/MemoryItem.md) Defined in: [packages/sdk/src/types/member-types.ts:83](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L83) --- # Type Alias: MemoryType > **MemoryType** = `"basic"` | `"preferences"` | `"semantic"` | `"summaries"` | `"episodic"` Defined in: [packages/sdk/src/types/member-types.ts:100](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/member-types.ts#L100) --- # Type Alias: MenuItemResponseItemType > **MenuItemResponseItemType** = *typeof* [`MenuItemResponseItemType`](https://docs.gravityrail.com/sdk/variables/MenuItemResponseItemType.md)\[keyof *typeof* [`MenuItemResponseItemType`](https://docs.gravityrail.com/sdk/variables/MenuItemResponseItemType.md)] Defined in: [packages/sdk/src/types/generated/site.ts:90](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L90) --- # Type Alias: MessageContentPart > **MessageContentPart** = [`TextContent`](https://docs.gravityrail.com/sdk/interfaces/TextContent.md) | [`ImageUrlContent`](https://docs.gravityrail.com/sdk/interfaces/ImageUrlContent.md) Defined in: [packages/sdk/src/types/chat-types.ts:203](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L203) --- # Type Alias: MessageRole > **MessageRole** = `"user"` | `"assistant"` | `"system"` | `"tool"` | `"function"` | `"operator"` | `"error"` Defined in: [packages/sdk/src/types/chat-types.ts:205](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L205) --- # Type Alias: MetricSection > **MetricSection** = `Omit`<`GeneratedMetricSection`, `"summary"` | `"timeSeries"`> & `object` Defined in: [packages/sdk/src/types/voice-metrics-types.ts:31](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/voice-metrics-types.ts#L31) ## Type Declaration[​](#type-declaration "Direct link to Type Declaration") ### summary[​](#summary "Direct link to summary") > **summary**: [`MetricSummary`](https://docs.gravityrail.com/sdk/type-aliases/MetricSummary.md) ### timeSeries[​](#timeseries "Direct link to timeSeries") > **timeSeries**: [`MetricDataPoint`](https://docs.gravityrail.com/sdk/interfaces/MetricDataPoint.md)\[] --- # Type Alias: MetricSummary > **MetricSummary** = `Required`<`Pick`<[`GeneratedMetricSummary`](https://docs.gravityrail.com/sdk/interfaces/GeneratedMetricSummary.md), `"avg"` | `"min"` | `"max"` | `"count"` | `"p50"` | `"p90"` | `"p99"`>> & `Omit`<[`GeneratedMetricSummary`](https://docs.gravityrail.com/sdk/interfaces/GeneratedMetricSummary.md), `"avg"` | `"min"` | `"max"` | `"count"` | `"p50"` | `"p90"` | `"p99"`> Defined in: [packages/sdk/src/types/voice-metrics-types.ts:26](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/voice-metrics-types.ts#L26) Admin dashboards treat absent aggregates as zero. --- # Type Alias: MilestoneFormData > **MilestoneFormData** = `z.infer`<*typeof* `MilestoneFormDataSchema`> Defined in: [packages/sdk/src/types/milestone-types.ts:20](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/milestone-types.ts#L20) --- # Type Alias: MilestoneGoal > **MilestoneGoal** = `Omit`<[`GeneratedMilestoneGoalResponse`](https://docs.gravityrail.com/sdk/interfaces/GeneratedMilestoneGoalResponse.md), `"description"` | `"value"`> & `object` Defined in: [packages/sdk/src/types/milestone-types.ts:22](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/milestone-types.ts#L22) ## Type Declaration[​](#type-declaration "Direct link to Type Declaration") ### description?[​](#description "Direct link to description?") > `optional` **description**: `string` | `null` ### value?[​](#value "Direct link to value?") > `optional` **value**: `number` | `null` --- # Type Alias: MilestoneGoalFormData > **MilestoneGoalFormData** = `z.infer`<*typeof* `MilestoneGoalFormDataSchema`> Defined in: [packages/sdk/src/types/milestone-types.ts:19](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/milestone-types.ts#L19) --- # Type Alias: MilestoneGoalResponse > **MilestoneGoalResponse** = [`MilestoneGoal`](https://docs.gravityrail.com/sdk/type-aliases/MilestoneGoal.md) Defined in: [packages/sdk/src/types/milestone-types.ts:26](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/milestone-types.ts#L26) --- # Type Alias: MilestoneSortField > **MilestoneSortField** = `"name"` | `"createdAt"` | `"updatedAt"` | `"targetDate"` Defined in: [packages/sdk/src/types/sort-types.ts:37](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/sort-types.ts#L37) --- # Type Alias: ModelProvider > **ModelProvider** = *typeof* [`ModelProvider`](https://docs.gravityrail.com/sdk/variables/ModelProvider.md)\[keyof *typeof* [`ModelProvider`](https://docs.gravityrail.com/sdk/variables/ModelProvider.md)] Defined in: [packages/sdk/src/types/generated/ai\_model.ts:91](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/ai_model.ts#L91) AI model providers. --- # Type Alias: ModelState > **ModelState** = `"enabled"` | `"disabled"` | `"deprecated"` Defined in: [packages/sdk/src/types/ai-model-types.ts:44](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ai-model-types.ts#L44) --- # Type Alias: ModelType > **ModelType** = *typeof* [`ModelType`](https://docs.gravityrail.com/sdk/variables/ModelType.md)\[keyof *typeof* [`ModelType`](https://docs.gravityrail.com/sdk/variables/ModelType.md)] Defined in: [packages/sdk/src/types/generated/ai\_model.ts:109](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/ai_model.ts#L109) AI model types. --- # Type Alias: MondayLookupType > **MondayLookupType** = `"column_value"` | `"item_id"` Defined in: [packages/sdk/src/types/event-types.ts:413](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L413) Lookup type for Monday.com item action. Controls how to find existing items to update. --- # Type Alias: MondayUpsertMode > **MondayUpsertMode** = `"create_only"` | `"update_only"` | `"upsert"` Defined in: [packages/sdk/src/types/event-types.ts:407](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L407) Upsert mode for Monday.com item action. Controls whether to create new items, update existing items, or both. --- # Type Alias: MultiMatchBehavior > **MultiMatchBehavior** = `"fail"` | `"update_first"` | `"update_all"` Defined in: [packages/sdk/src/types/event-types.ts:418](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L418) Behavior when multiple items match the lookup criteria. --- # Type Alias: OAuthProviderSlug > **OAuthProviderSlug** = `"google_calendar"` | `"gmail"` | `"google"` | `"gdrive"` Defined in: [packages/sdk/src/api/oauth.ts:4](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/oauth.ts#L4) --- # Type Alias: ObjectPermission > **ObjectPermission** = `"use"` | `"edit"` | `"create"` | `"list"` | `"verify"` | `"geolocate"` | `"listAll"` | `"delete"` Defined in: [packages/sdk/src/types/core-types.ts:82](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/core-types.ts#L82) --- # Type Alias: OIDCAdminConfigViewProviderType > **OIDCAdminConfigViewProviderType** = *typeof* [`OIDCAdminConfigViewProviderType`](https://docs.gravityrail.com/sdk/variables/OIDCAdminConfigViewProviderType.md)\[keyof *typeof* [`OIDCAdminConfigViewProviderType`](https://docs.gravityrail.com/sdk/variables/OIDCAdminConfigViewProviderType.md)] Defined in: [packages/sdk/src/types/generated/organization.ts:459](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L459) --- # Type Alias: OpenAIReasoningEffort > **OpenAIReasoningEffort** = `"none"` | `"minimal"` | `"low"` | `"medium"` | `"high"` | `"xhigh"` Defined in: [packages/sdk/src/types/model-config-types.ts:134](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/model-config-types.ts#L134) OpenAI GPT-5 reasoning effort. The ACCEPTED SUBSET IS MODEL-DEPENDENT — sending an out-of-set value is a hard 400 at the API. Mirror of the per-family vocab in lib/ai/chat\_model\_config.py (see getOpenAIReasoningEfforts): gpt-5 (5.0): minimal / low / medium / high gpt-5.1: none / low / medium / high gpt-5.4: none / low / medium / high / xhigh This union is the superset; the UI filters it down per selected model. --- # Type Alias: OpenAISemanticVADEagerness > **OpenAISemanticVADEagerness** = `"low"` | `"medium"` | `"high"` | `"auto"` Defined in: [packages/sdk/src/types/model-config-types.ts:7](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/model-config-types.ts#L7) --- # Type Alias: OpenAITurnDetection > **OpenAITurnDetection** = [`OpenAISemanticVADTurnDetection`](https://docs.gravityrail.com/sdk/interfaces/OpenAISemanticVADTurnDetection.md) | [`OpenAIServerVADTurnDetection`](https://docs.gravityrail.com/sdk/interfaces/OpenAIServerVADTurnDetection.md) Defined in: [packages/sdk/src/types/model-config-types.ts:25](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/model-config-types.ts#L25) --- # Type Alias: OpenAITurnDetectionType > **OpenAITurnDetectionType** = `"semantic_vad"` | `"server_vad"` Defined in: [packages/sdk/src/types/model-config-types.ts:6](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/model-config-types.ts#L6) --- # Type Alias: OperatorGroup > **OperatorGroup** = `Omit`<`GeneratedOperatorGroupResponse`, `"routingStrategy"`> & `object` Defined in: [packages/sdk/src/types/operator-types.ts:168](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/operator-types.ts#L168) ## Type Declaration[​](#type-declaration "Direct link to Type Declaration") ### routingStrategy[​](#routingstrategy "Direct link to routingStrategy") > **routingStrategy**: [`RoutingStrategy`](https://docs.gravityrail.com/sdk/type-aliases/RoutingStrategy.md) | `string` --- # Type Alias: OperatorGroupResponse > **OperatorGroupResponse** = [`OperatorGroup`](https://docs.gravityrail.com/sdk/type-aliases/OperatorGroup.md) Defined in: [packages/sdk/src/types/operator-types.ts:173](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/operator-types.ts#L173) --- # Type Alias: OperatorLiveStatus > **OperatorLiveStatus** = `"live"` | `"offline"` Defined in: [packages/sdk/src/types/operator-types.ts:21](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/operator-types.ts#L21) Status of an operator's live availability --- # Type Alias: OrgAuthHandler() > **OrgAuthHandler** = (`info`) => `Promise`<`void`> Defined in: [packages/sdk/src/api/base.ts:96](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/api/base.ts#L96) Handler for organization authentication requirement. Called when a 401 response includes WWW-Authenticate header with realm="org". The handler should redirect the user to the auth URL for consent/SSO. Returns a promise that resolves when the user should retry (after page reload with cookie). ## Parameters[​](#parameters "Direct link to Parameters") ### info[​](#info "Direct link to info") [`OrgAuthInfo`](https://docs.gravityrail.com/sdk/interfaces/OrgAuthInfo.md) ## Returns[​](#returns "Direct link to Returns") `Promise`<`void`> --- # Type Alias: OrgDomain > **OrgDomain** = `Omit`<[`GeneratedOrgDomainResponse`](https://docs.gravityrail.com/sdk/interfaces/GeneratedOrgDomainResponse.md), `"ownershipStatus"` | `"emailStatus"` | `"siteStatus"`> & `object` Defined in: [packages/sdk/src/types/organization-types.ts:69](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/organization-types.ts#L69) Re-bind status fields OpenAPI emits as plain strings. ## Type Declaration[​](#type-declaration "Direct link to Type Declaration") ### emailStatus?[​](#emailstatus "Direct link to emailStatus?") > `optional` **emailStatus**: [`OrgDomainCapabilityStatus`](https://docs.gravityrail.com/sdk/type-aliases/OrgDomainCapabilityStatus.md) | `null` ### ownershipStatus[​](#ownershipstatus "Direct link to ownershipStatus") > **ownershipStatus**: [`OrgDomainOwnershipStatus`](https://docs.gravityrail.com/sdk/type-aliases/OrgDomainOwnershipStatus.md) ### siteStatus?[​](#sitestatus "Direct link to siteStatus?") > `optional` **siteStatus**: [`OrgDomainCapabilityStatus`](https://docs.gravityrail.com/sdk/type-aliases/OrgDomainCapabilityStatus.md) | `null` --- # Type Alias: OrgDomainCapabilityStatus > **OrgDomainCapabilityStatus** = `"unconfigured"` | `"pending"` | `"verified"` | `"failed"` Defined in: [packages/sdk/src/types/organization-types.ts:168](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/organization-types.ts#L168) --- # Type Alias: OrgDomainDnsRecordStatus > **OrgDomainDnsRecordStatus** = `"pending"` | `"verified"` | `"failed"` Defined in: [packages/sdk/src/types/organization-types.ts:169](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/organization-types.ts#L169) --- # Type Alias: OrgDomainListResponse > **OrgDomainListResponse** = `Omit`<`GeneratedOrgDomainListResponse`, `"items"`> & `object` Defined in: [packages/sdk/src/types/organization-types.ts:127](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/organization-types.ts#L127) ## Type Declaration[​](#type-declaration "Direct link to Type Declaration") ### items[​](#items "Direct link to items") > **items**: [`OrgDomain`](https://docs.gravityrail.com/sdk/type-aliases/OrgDomain.md)\[] --- # Type Alias: OrgDomainOwnershipStatus > **OrgDomainOwnershipStatus** = `"pending"` | `"verified"` | `"failed"` Defined in: [packages/sdk/src/types/organization-types.ts:167](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/organization-types.ts#L167) --- # Type Alias: OrgDomainResponse > **OrgDomainResponse** = [`OrgDomain`](https://docs.gravityrail.com/sdk/type-aliases/OrgDomain.md) Defined in: [packages/sdk/src/types/organization-types.ts:78](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/organization-types.ts#L78) --- # Type Alias: OrgMemberRole > **OrgMemberRole** = `"member"` | `"admin"` | `"owner"` | `"platform_support"` Defined in: [packages/sdk/src/types/account-types.ts:401](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L401) --- # Type Alias: OwnershipDnsRecord > **OwnershipDnsRecord** = `Omit`<[`GeneratedOwnershipDnsRecord`](https://docs.gravityrail.com/sdk/interfaces/GeneratedOwnershipDnsRecord.md), `"status"`> & `object` Defined in: [packages/sdk/src/types/organization-types.ts:88](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/organization-types.ts#L88) ## Type Declaration[​](#type-declaration "Direct link to Type Declaration") ### status[​](#status "Direct link to status") > **status**: [`OrgDomainDnsRecordStatus`](https://docs.gravityrail.com/sdk/type-aliases/OrgDomainDnsRecordStatus.md) --- # Type Alias: PageSortField > **PageSortField** = `"createdAt"` | `"updatedAt"` | `"title"` Defined in: [packages/sdk/src/types/sort-types.ts:22](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/sort-types.ts#L22) --- # Type Alias: Persona > **Persona** = `Omit`<`GeneratedPersonaResponse`, `"dataRecords"`> & `object` Defined in: [packages/sdk/src/types/qualification-types.ts:52](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/qualification-types.ts#L52) ## Type Declaration[​](#type-declaration "Direct link to Type Declaration") ### dataRecords?[​](#datarecords "Direct link to dataRecords?") > `optional` **dataRecords**: `Record`<`string`, [`ScenarioDataRecord`](https://docs.gravityrail.com/sdk/interfaces/ScenarioDataRecord.md)> | `null` --- # Type Alias: PersonaResponse > **PersonaResponse** = [`Persona`](https://docs.gravityrail.com/sdk/type-aliases/Persona.md) Defined in: [packages/sdk/src/types/qualification-types.ts:55](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/qualification-types.ts#L55) --- # Type Alias: PidsDisposition > **PidsDisposition** = *typeof* [`PIDS_DISPOSITIONS`](https://docs.gravityrail.com/sdk/variables/PIDS_DISPOSITIONS.md)\[`number`] Defined in: [packages/sdk/src/types/pids-types.ts:45](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/pids-types.ts#L45) --- # Type Alias: PidsSource > **PidsSource** = *typeof* [`PIDS_SOURCES`](https://docs.gravityrail.com/sdk/variables/PIDS_SOURCES.md)\[`number`] Defined in: [packages/sdk/src/types/pids-types.ts:49](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/pids-types.ts#L49) --- # Type Alias: PresenceClientMessage > **PresenceClientMessage** = [`PresenceLoginMessage`](https://docs.gravityrail.com/sdk/interfaces/PresenceLoginMessage.md) | [`PresenceGoLiveMessage`](https://docs.gravityrail.com/sdk/interfaces/PresenceGoLiveMessage.md) | [`PresenceGoOfflineMessage`](https://docs.gravityrail.com/sdk/interfaces/PresenceGoOfflineMessage.md) | [`PresenceHeartbeatMessage`](https://docs.gravityrail.com/sdk/interfaces/PresenceHeartbeatMessage.md) | [`PresenceAcceptInteractionMessage`](https://docs.gravityrail.com/sdk/interfaces/PresenceAcceptInteractionMessage.md) | [`PresenceRejectInteractionMessage`](https://docs.gravityrail.com/sdk/interfaces/PresenceRejectInteractionMessage.md) | [`PresenceTakenOverAckMessage`](https://docs.gravityrail.com/sdk/interfaces/PresenceTakenOverAckMessage.md) | [`PresenceEndInteractionMessage`](https://docs.gravityrail.com/sdk/interfaces/PresenceEndInteractionMessage.md) Defined in: [packages/sdk/src/types/operator-types.ts:73](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/operator-types.ts#L73) All client -> server message types --- # Type Alias: PresenceServerMessage > **PresenceServerMessage** = [`PresenceLoginAck`](https://docs.gravityrail.com/sdk/interfaces/PresenceLoginAck.md) | [`IncomingInteraction`](https://docs.gravityrail.com/sdk/interfaces/IncomingInteraction.md) | [`InteractionAccepted`](https://docs.gravityrail.com/sdk/interfaces/InteractionAccepted.md) | [`InteractionTimedOut`](https://docs.gravityrail.com/sdk/interfaces/InteractionTimedOut.md) | [`PresenceConfirmation`](https://docs.gravityrail.com/sdk/interfaces/PresenceConfirmation.md) | [`PresenceError`](https://docs.gravityrail.com/sdk/interfaces/PresenceError.md) | [`SessionTakeover`](https://docs.gravityrail.com/sdk/interfaces/SessionTakeover.md) | [`ChatActivityEvent`](https://docs.gravityrail.com/sdk/interfaces/ChatActivityEvent.md) Defined in: [packages/sdk/src/types/operator-types.ts:151](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/operator-types.ts#L151) All server -> client message types --- # Type Alias: Product > **Product** = `Omit`<`GeneratedProductResponse`, `"productType"` | `"plans"` | `"tagline"` | `"audience"` | `"stripeProductId"` | `"icon"` | `"color"` | `"publicUrl"` | `"subscriberUrl"` | `"templateWorkspaceUuid"` | `"metadata"` | `"limits"`> & `object` Defined in: [packages/sdk/src/types/billing-types.ts:339](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L339) Re-bind nullable/string fields the admin UI passes through to request bodies. ## Type Declaration[​](#type-declaration "Direct link to Type Declaration") ### audience?[​](#audience "Direct link to audience?") > `optional` **audience**: `string` | `null` ### color?[​](#color "Direct link to color?") > `optional` **color**: `string` | `null` ### icon?[​](#icon "Direct link to icon?") > `optional` **icon**: `string` | `null` ### limits?[​](#limits "Direct link to limits?") > `optional` **limits**: [`ProductLimits`](https://docs.gravityrail.com/sdk/type-aliases/ProductLimits.md) | `null` ### metadata?[​](#metadata "Direct link to metadata?") > `optional` **metadata**: [`ProductMetadata`](https://docs.gravityrail.com/sdk/interfaces/ProductMetadata.md) | `null` ### plans[​](#plans "Direct link to plans") > **plans**: [`ProductPlans`](https://docs.gravityrail.com/sdk/type-aliases/ProductPlans.md) | `null` ### productType[​](#producttype "Direct link to productType") > **productType**: [`ProductType`](https://docs.gravityrail.com/sdk/enumerations/ProductType.md) | `string` ### publicUrl?[​](#publicurl "Direct link to publicUrl?") > `optional` **publicUrl**: `string` | `null` ### stripeProductId?[​](#stripeproductid "Direct link to stripeProductId?") > `optional` **stripeProductId**: `string` | `null` ### subscriberUrl?[​](#subscriberurl "Direct link to subscriberUrl?") > `optional` **subscriberUrl**: `string` | `null` ### tagline?[​](#tagline "Direct link to tagline?") > `optional` **tagline**: `string` | `null` ### templateWorkspaceUuid?[​](#templateworkspaceuuid "Direct link to templateWorkspaceUuid?") > `optional` **templateWorkspaceUuid**: `string` | `null` --- # Type Alias: ProductFeatureKey > **ProductFeatureKey** = [`WorkspaceFeature`](https://docs.gravityrail.com/sdk/enumerations/WorkspaceFeature.md) | [`MemberFeature`](https://docs.gravityrail.com/sdk/enumerations/MemberFeature.md) | [`OrgFeature`](https://docs.gravityrail.com/sdk/enumerations/OrgFeature.md) Defined in: [packages/sdk/src/types/billing-types.ts:234](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L234) ProductFeatureKey is the union of all possible product features. It combines WorkspaceFeature, MemberFeature, and OrgFeature. Matches the Python ProductFeatureKey type in lib/constants.py --- # Type Alias: ProductLimits > **ProductLimits** = { \[key in Resource]?: number | null } Defined in: [packages/sdk/src/types/billing-types.ts:326](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L326) --- # Type Alias: ProductPlans > **ProductPlans** = `Partial`<`Record`<`"month"` | `"year"` | `"quarter"`, [`PlanConfiguration`](https://docs.gravityrail.com/sdk/interfaces/PlanConfiguration.md)>> Defined in: [packages/sdk/src/types/billing-types.ts:336](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L336) Map of billing periods to their plan configurations. Used for defining product pricing across different billing cycles. --- # Type Alias: QualificationSortField > **QualificationSortField** = `"name"` | `"createdAt"` Defined in: [packages/sdk/src/types/sort-types.ts:61](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/sort-types.ts#L61) --- # Type Alias: QueryAggregateOp > **QueryAggregateOp** = `"eq"` | `"neq"` | `"gt"` | `"gte"` | `"lt"` | `"lte"` Defined in: [packages/sdk/src/types/query-engine-types.ts:31](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L31) --- # Type Alias: QueryComparisonOp > **QueryComparisonOp** = `"eq"` | `"neq"` | `"contains"` | `"notContains"` | `"startsWith"` | `"in"` | `"notIn"` | `"gt"` | `"gte"` | `"lt"` | `"lte"` | `"between"` | `"notBetween"` | `"isEmpty"` | `"notEmpty"` | `"exists"` | `"onDay"` | `"notOnDay"` Defined in: [packages/sdk/src/types/query-engine-types.ts:11](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L11) --- # Type Alias: QueryEntityType > **QueryEntityType** = `"member"` | `"chat"` | `"data_record"` Defined in: [packages/sdk/src/types/query-engine-types.ts:9](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L9) Unified Query Engine types — hand-written mirror of `lib/query/ir.py` and the `/w/{wid}/queries/*` route models. The JSON IR is the wire format AND the UI's source of truth: the query-builder renders from and edits exactly this tree. --- # Type Alias: QueryPredicate > **QueryPredicate** = [`QueryAnd`](https://docs.gravityrail.com/sdk/interfaces/QueryAnd.md) | [`QueryOr`](https://docs.gravityrail.com/sdk/interfaces/QueryOr.md) | [`QueryNot`](https://docs.gravityrail.com/sdk/interfaces/QueryNot.md) | [`QueryCompare`](https://docs.gravityrail.com/sdk/interfaces/QueryCompare.md) | [`QueryRecordMatch`](https://docs.gravityrail.com/sdk/interfaces/QueryRecordMatch.md) | [`QueryRelationMatch`](https://docs.gravityrail.com/sdk/interfaces/QueryRelationMatch.md) | [`QueryAggregatePredicate`](https://docs.gravityrail.com/sdk/interfaces/QueryAggregatePredicate.md) | [`QuerySubQueryRef`](https://docs.gravityrail.com/sdk/interfaces/QuerySubQueryRef.md) | [`QuerySavedFilterRef`](https://docs.gravityrail.com/sdk/interfaces/QuerySavedFilterRef.md) Defined in: [packages/sdk/src/types/query-engine-types.ts:184](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L184) --- # Type Alias: QueryRangeBound > **QueryRangeBound** = [`QueryScalar`](https://docs.gravityrail.com/sdk/type-aliases/QueryScalar.md) | [`QueryTemporalValue`](https://docs.gravityrail.com/sdk/type-aliases/QueryTemporalValue.md) Defined in: [packages/sdk/src/types/query-engine-types.ts:79](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L79) --- # Type Alias: QueryRunMode > **QueryRunMode** = `"rows"` | `"count"` | `"aggregate"` Defined in: [packages/sdk/src/types/query-engine-types.ts:234](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L234) --- # Type Alias: QueryScalar > **QueryScalar** = `boolean` | `number` | `string` Defined in: [packages/sdk/src/types/query-engine-types.ts:77](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L77) --- # Type Alias: QueryTemporalValue > **QueryTemporalValue** = [`QueryNowValue`](https://docs.gravityrail.com/sdk/interfaces/QueryNowValue.md) | [`QueryDaysAgoValue`](https://docs.gravityrail.com/sdk/interfaces/QueryDaysAgoValue.md) | [`QueryDaysFromNowValue`](https://docs.gravityrail.com/sdk/interfaces/QueryDaysFromNowValue.md) | [`QueryDayBoundaryValue`](https://docs.gravityrail.com/sdk/interfaces/QueryDayBoundaryValue.md) Defined in: [packages/sdk/src/types/query-engine-types.ts:71](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L71) --- # Type Alias: QueryValue > **QueryValue** = [`QueryScalar`](https://docs.gravityrail.com/sdk/type-aliases/QueryScalar.md) | [`QueryTemporalValue`](https://docs.gravityrail.com/sdk/type-aliases/QueryTemporalValue.md) | [`QueryRangeValue`](https://docs.gravityrail.com/sdk/interfaces/QueryRangeValue.md) | [`QueryScalar`](https://docs.gravityrail.com/sdk/type-aliases/QueryScalar.md)\[] Defined in: [packages/sdk/src/types/query-engine-types.ts:87](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L87) --- # Type Alias: RealtimeAIModel > **RealtimeAIModel** = `Omit`<[`RealtimeModelResponse`](https://docs.gravityrail.com/sdk/interfaces/RealtimeModelResponse.md), `"serverVad"` | `"clientVad"`> & `object` Defined in: [packages/sdk/src/types/ai-model-types.ts:48](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ai-model-types.ts#L48) ## Type Declaration[​](#type-declaration "Direct link to Type Declaration") ### clientVad[​](#clientvad "Direct link to clientVad") > **clientVad**: `boolean` ### serverVad[​](#servervad "Direct link to serverVad") > **serverVad**: `boolean` ### type[​](#type "Direct link to type") > **type**: `"realtime"` --- # Type Alias: RealtimeModelConfig > **RealtimeModelConfig** = [`OpenAIRealtimeModelConfig`](https://docs.gravityrail.com/sdk/interfaces/OpenAIRealtimeModelConfig.md) | [`GeminiRealtimeModelConfig`](https://docs.gravityrail.com/sdk/interfaces/GeminiRealtimeModelConfig.md) | [`CustomRealtimeModelConfig`](https://docs.gravityrail.com/sdk/interfaces/CustomRealtimeModelConfig.md) | [`AWSRealtimeModelConfig`](https://docs.gravityrail.com/sdk/interfaces/AWSRealtimeModelConfig.md) | [`XAIRealtimeModelConfig`](https://docs.gravityrail.com/sdk/interfaces/XAIRealtimeModelConfig.md) Defined in: [packages/sdk/src/types/model-config-types.ts:115](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/model-config-types.ts#L115) --- # Type Alias: Region > **Region** = *typeof* [`Region`](https://docs.gravityrail.com/sdk/variables/Region.md)\[keyof *typeof* [`Region`](https://docs.gravityrail.com/sdk/variables/Region.md)] Defined in: [packages/sdk/src/types/generated/organization.ts:589](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L589) Twilio's region buckets — NOT ISO 3166. The plan said "ISO" but Twilio actually uses these continental buckets, with `USA_AND_CANADA` as a single value. Source: `api-create-secondary-customer-profile.md`. --- # Type Alias: RegistrationIdentifier > **RegistrationIdentifier** = *typeof* [`RegistrationIdentifier`](https://docs.gravityrail.com/sdk/variables/RegistrationIdentifier.md)\[keyof *typeof* [`RegistrationIdentifier`](https://docs.gravityrail.com/sdk/variables/RegistrationIdentifier.md)] Defined in: [packages/sdk/src/types/generated/organization.ts:609](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L609) Twilio's accepted registration identifier types. Source: `docs/external/twilio-api/prose/trust-hub/trusthub-rest-api/ api-create-secondary-customer-profile.md` (the table of accepted values, augmented with `DUNS` from the EndUser create example — the table omits `DUNS` but Twilio accepts it). --- # Type Alias: RequestsSection > **RequestsSection** = `Omit`<`GeneratedRequestsSection`, `"statuses"` | `"totalRequests"`> & `object` Defined in: [packages/sdk/src/types/voice-metrics-types.ts:51](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/voice-metrics-types.ts#L51) ## Type Declaration[​](#type-declaration "Direct link to Type Declaration") ### statuses[​](#statuses "Direct link to statuses") > **statuses**: [`RequestsStatusEntry`](https://docs.gravityrail.com/sdk/type-aliases/RequestsStatusEntry.md)\[] ### totalRequests[​](#totalrequests "Direct link to totalRequests") > **totalRequests**: `number` --- # Type Alias: RequestsStatusEntry > **RequestsStatusEntry** = `Omit`<`GeneratedRequestsStatusEntry`, `"total"` | `"timeSeries"`> & `object` Defined in: [packages/sdk/src/types/voice-metrics-types.ts:46](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/voice-metrics-types.ts#L46) ## Type Declaration[​](#type-declaration "Direct link to Type Declaration") ### timeSeries[​](#timeseries "Direct link to timeSeries") > **timeSeries**: [`MetricDataPoint`](https://docs.gravityrail.com/sdk/interfaces/MetricDataPoint.md)\[] ### total[​](#total "Direct link to total") > **total**: `number` --- # Type Alias: ResellerAbilityConfig > **ResellerAbilityConfig** = [`EmptyAbilityConfig`](https://docs.gravityrail.com/sdk/type-aliases/EmptyAbilityConfig.md) Defined in: [packages/sdk/src/types/ability-types.ts:413](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ability-types.ts#L413) Config for reseller ability — no user-configurable options --- # Type Alias: ResourceScope > **ResourceScope** = `"workspace"` | `"org"` | `"any"` Defined in: [packages/sdk/src/types/resource-metadata.ts:10](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/resource-metadata.ts#L10) Scope defines where a resource can be configured --- # Type Alias: Routine > **Routine** = [`RoutineResponse`](https://docs.gravityrail.com/sdk/interfaces/RoutineResponse.md) Defined in: [packages/sdk/src/types/event-types.ts:169](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L169) --- # Type Alias: RoutineRunStatus > **RoutineRunStatus** = `"PENDING"` | `"IN_PROGRESS"` | `"COMPLETED"` | `"FAILED"` | `"CANCELLED"` | `"SKIPPED"` Defined in: [packages/sdk/src/types/event-types.ts:554](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L554) --- # Type Alias: RoutineScheduleMode > **RoutineScheduleMode** = `"ONCE"` | `"CRON"` | `"INTERVAL"` Defined in: [packages/sdk/src/types/event-types.ts:156](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L156) --- # Type Alias: RoutineSortField > **RoutineSortField** = `"createdAt"` | `"updatedAt"` | `"name"` | `"scheduledTime"` Defined in: [packages/sdk/src/types/sort-types.ts:31](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/sort-types.ts#L31) --- # Type Alias: RoutineVisibility > **RoutineVisibility** = `"private"` | `"workspace"` Defined in: [packages/sdk/src/types/event-types.ts:155](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L155) OpenAPI omits nested last run; list/detail endpoints include it when available. --- # Type Alias: RoutingStrategy > **RoutingStrategy** = `"broadcast"` | `"round_robin"` Defined in: [packages/sdk/src/types/operator-types.ts:164](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/operator-types.ts#L164) --- # Type Alias: RuleExecutionSortField > **RuleExecutionSortField** = `"createdAt"` | `"completedAt"` | `"durationMs"` | `"status"` Defined in: [packages/sdk/src/types/sort-types.ts:28](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/sort-types.ts#L28) --- # Type Alias: RuleExecutionStatus > **RuleExecutionStatus** = `"running"` | `"success"` | `"failed"` | `"skipped"` Defined in: [packages/sdk/src/types/app-connection-types.ts:311](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L311) --- # Type Alias: SalesforceLabelSyncMode > **SalesforceLabelSyncMode** = `"multi_select"` | `"text"` Defined in: [packages/sdk/src/types/app-connection-types.ts:336](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L336) --- # Type Alias: SalesforceSearchObjectType > **SalesforceSearchObjectType** = `"Contact"` | `"Account"` | `"Lead"` Defined in: [packages/sdk/src/types/app-connection-types.ts:366](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L366) --- # Type Alias: SalesforceSyncConfig > **SalesforceSyncConfig** = [`ConnectionSyncConfig`](https://docs.gravityrail.com/sdk/interfaces/ConnectionSyncConfig.md) Defined in: [packages/sdk/src/types/app-connection-types.ts:352](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L352) Salesforce sync uses the same ConnectionSyncConfig as all connectors. --- # Type Alias: Scenario > **Scenario** = `Omit`<`GeneratedScenarioResponse`, `"dataRecords"`> & `object` Defined in: [packages/sdk/src/types/qualification-types.ts:47](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/qualification-types.ts#L47) ## Type Declaration[​](#type-declaration "Direct link to Type Declaration") ### dataRecords?[​](#datarecords "Direct link to dataRecords?") > `optional` **dataRecords**: `Record`<`string`, [`ScenarioDataRecord`](https://docs.gravityrail.com/sdk/interfaces/ScenarioDataRecord.md)> | `null` --- # Type Alias: ScenarioCriterion > **ScenarioCriterion** = `Omit`<`GeneratedScenarioCriterionResponse`, `"criterionType"`> & `object` Defined in: [packages/sdk/src/types/qualification-types.ts:42](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/qualification-types.ts#L42) ## Type Declaration[​](#type-declaration "Direct link to Type Declaration") ### criterionType[​](#criteriontype "Direct link to criterionType") > **criterionType**: [`CriterionType`](https://docs.gravityrail.com/sdk/enumerations/CriterionType.md) | `string` --- # Type Alias: ScenarioCriterionResponse > **ScenarioCriterionResponse** = [`ScenarioCriterion`](https://docs.gravityrail.com/sdk/type-aliases/ScenarioCriterion.md) Defined in: [packages/sdk/src/types/qualification-types.ts:45](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/qualification-types.ts#L45) --- # Type Alias: ScenarioResponse > **ScenarioResponse** = [`Scenario`](https://docs.gravityrail.com/sdk/type-aliases/Scenario.md) Defined in: [packages/sdk/src/types/qualification-types.ts:50](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/qualification-types.ts#L50) --- # Type Alias: ScopeName > **ScopeName** = keyof *typeof* [`SCOPES`](https://docs.gravityrail.com/sdk/variables/SCOPES.md) Defined in: [packages/sdk/src/scopes.ts:596](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/scopes.ts#L596) Type-safe scope name. Use this instead of raw strings for scope checks. --- # Type Alias: SendWhatsAppAbilityConfig > **SendWhatsAppAbilityConfig** = [`EmptyAbilityConfig`](https://docs.gravityrail.com/sdk/type-aliases/EmptyAbilityConfig.md) Defined in: [packages/sdk/src/types/ability-types.ts:397](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ability-types.ts#L397) Config for send\_whatsapp ability — no user-configurable options --- # Type Alias: Site > **Site** = `Omit`<[`GeneratedSiteResponse`](https://docs.gravityrail.com/sdk/interfaces/GeneratedSiteResponse.md), `"theme"` | `"availableLocales"` | `"primaryLocale"` | `"url"`> & `object` Defined in: [packages/sdk/src/types/site-types.ts:39](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/site-types.ts#L39) OpenAPI theme union can drift ahead of the client catalog — keep in sync with generated/site. ## Type Declaration[​](#type-declaration "Direct link to Type Declaration") ### availableLocales[​](#availablelocales "Direct link to availableLocales") > **availableLocales**: `string`\[] ### primaryLocale[​](#primarylocale "Direct link to primaryLocale") > **primaryLocale**: `string` ### theme[​](#theme "Direct link to theme") > **theme**: [`ThemeName`](https://docs.gravityrail.com/sdk/type-aliases/ThemeName.md) | `null` ### url?[​](#url "Direct link to url?") > `optional` **url**: `string` | `null` --- # Type Alias: SiteDisableResponse > **SiteDisableResponse** = { `impact?`: `never`; `ok`: `true`; } | { `impact`: [`SiteDisableImpactResponse`](https://docs.gravityrail.com/sdk/interfaces/SiteDisableImpactResponse.md); `ok`: `false`; } Defined in: [packages/sdk/src/types/organization-types.ts:195](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/organization-types.ts#L195) --- # Type Alias: SiteDnsRecord > **SiteDnsRecord** = `Omit`<`GeneratedSiteDnsRecord`, `"status"`> & `object` Defined in: [packages/sdk/src/types/organization-types.ts:84](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/organization-types.ts#L84) ## Type Declaration[​](#type-declaration "Direct link to Type Declaration") ### status[​](#status "Direct link to status") > **status**: [`OrgDomainDnsRecordStatus`](https://docs.gravityrail.com/sdk/type-aliases/OrgDomainDnsRecordStatus.md) --- # Type Alias: SiteDnsRecordType > **SiteDnsRecordType** = *typeof* [`SiteDnsRecordType`](https://docs.gravityrail.com/sdk/variables/SiteDnsRecordType.md)\[keyof *typeof* [`SiteDnsRecordType`](https://docs.gravityrail.com/sdk/variables/SiteDnsRecordType.md)] Defined in: [packages/sdk/src/types/generated/organization.ts:711](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L711) --- # Type Alias: SiteDomainConfig > **SiteDomainConfig** = `Omit`<[`SiteDomainConfigResponse`](https://docs.gravityrail.com/sdk/interfaces/SiteDomainConfigResponse.md), `"status"` | `"targetStatus"` | `"tlsStatus"` | `"dnsRecords"`> & `object` Defined in: [packages/sdk/src/types/organization-types.ts:117](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/organization-types.ts#L117) ## Type Declaration[​](#type-declaration "Direct link to Type Declaration") ### dnsRecords[​](#dnsrecords "Direct link to dnsRecords") > **dnsRecords**: [`SiteDnsRecord`](https://docs.gravityrail.com/sdk/type-aliases/SiteDnsRecord.md)\[] ### status[​](#status "Direct link to status") > **status**: [`OrgDomainCapabilityStatus`](https://docs.gravityrail.com/sdk/type-aliases/OrgDomainCapabilityStatus.md) ### targetStatus[​](#targetstatus "Direct link to targetStatus") > **targetStatus**: [`OrgDomainDnsRecordStatus`](https://docs.gravityrail.com/sdk/type-aliases/OrgDomainDnsRecordStatus.md) ### tlsStatus[​](#tlsstatus "Direct link to tlsStatus") > **tlsStatus**: [`OrgDomainDnsRecordStatus`](https://docs.gravityrail.com/sdk/type-aliases/OrgDomainDnsRecordStatus.md) --- # Type Alias: SiteDomainConfigGetResponse > **SiteDomainConfigGetResponse** = `Omit`<`GeneratedSiteDomainConfigGetResponse`, `"config"`> & `object` Defined in: [packages/sdk/src/types/organization-types.ts:135](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/organization-types.ts#L135) ## Type Declaration[​](#type-declaration "Direct link to Type Declaration") ### config?[​](#config "Direct link to config?") > `optional` **config**: [`SiteDomainConfig`](https://docs.gravityrail.com/sdk/type-aliases/SiteDomainConfig.md) | `null` --- # Type Alias: SiteMapping > **SiteMapping** = `Omit`<`GeneratedAdminSiteMappingResponse`, `"externalDomain"`> & `object` Defined in: [packages/sdk/src/types/workspace-types.ts:35](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/workspace-types.ts#L35) ## Type Declaration[​](#type-declaration "Direct link to Type Declaration") ### externalDomain[​](#externaldomain "Direct link to externalDomain") > **externalDomain**: `string` | `null` --- # Type Alias: SiteResponse > **SiteResponse** = [`Site`](https://docs.gravityrail.com/sdk/type-aliases/Site.md) Defined in: [packages/sdk/src/types/site-types.ts:48](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/site-types.ts#L48) --- # Type Alias: SiteSortField > **SiteSortField** = `"createdAt"` | `"updatedAt"` | `"name"` Defined in: [packages/sdk/src/types/sort-types.ts:16](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/sort-types.ts#L16) --- # Type Alias: SlackApp > **SlackApp** = `Omit`<[`GeneratedSlackAppResponse`](https://docs.gravityrail.com/sdk/interfaces/GeneratedSlackAppResponse.md), `"respondMode"`> & `object` Defined in: [packages/sdk/src/types/slack-app-types.ts:24](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/slack-app-types.ts#L24) ## Type Declaration[​](#type-declaration "Direct link to Type Declaration") ### respondMode[​](#respondmode "Direct link to respondMode") > **respondMode**: [`SlackRespondMode`](https://docs.gravityrail.com/sdk/type-aliases/SlackRespondMode.md) --- # Type Alias: SlackAppResponse > **SlackAppResponse** = [`SlackApp`](https://docs.gravityrail.com/sdk/type-aliases/SlackApp.md) Defined in: [packages/sdk/src/types/slack-app-types.ts:27](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/slack-app-types.ts#L27) --- # Type Alias: SlackAppSortField > **SlackAppSortField** = `"createdAt"` | `"updatedAt"` | `"name"` Defined in: [packages/sdk/src/types/slack-app-types.ts:165](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/slack-app-types.ts#L165) Sort fields for Slack apps. --- # Type Alias: SlackRespondMode > **SlackRespondMode** = `"mentions"` | `"auto"` | `"off"` Defined in: [packages/sdk/src/types/slack-app-types.ts:34](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/slack-app-types.ts#L34) How the Slack bot decides whether to respond to messages. --- # Type Alias: SMSDeliveryFailureStatus > **SMSDeliveryFailureStatus** = `Extract`<[`SMSDeliveryStatus`](https://docs.gravityrail.com/sdk/type-aliases/SMSDeliveryStatus.md), `"failed"` | `"undelivered"`> Defined in: [packages/sdk/src/types/chat-types.ts:228](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L228) --- # Type Alias: SMSDeliveryStatus > **SMSDeliveryStatus** = `"queued"` | `"sending"` | `"sent"` | `"delivered"` | `"undelivered"` | `"failed"` Defined in: [packages/sdk/src/types/chat-types.ts:220](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L220) --- # Type Alias: SortOrder > **SortOrder** = `"asc"` | `"desc"` Defined in: [packages/sdk/src/types/core-types.ts:21](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/core-types.ts#L21) --- # Type Alias: STTAIModel > **STTAIModel** = [`STTModelResponse`](https://docs.gravityrail.com/sdk/interfaces/STTModelResponse.md) & `object` Defined in: [packages/sdk/src/types/ai-model-types.ts:53](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ai-model-types.ts#L53) ## Type Declaration[​](#type-declaration "Direct link to Type Declaration") ### type[​](#type "Direct link to type") > **type**: `"stt"` --- # Type Alias: Subscription > **Subscription** = `GeneratedSubscriptionResponse` Defined in: [packages/sdk/src/types/billing-types.ts:57](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L57) Subscription list/detail shape. OpenAPI marks several denormalized display fields optional (creditPriceCents, cancelAtPeriodEnd, isDirect, …) because the Pydantic model uses Optional — list endpoints still populate them in normal responses. --- # Type Alias: SyncEntityType > **SyncEntityType** = `"member"` | `"record"` | `"calendar_event"` | `"file"` Defined in: [packages/sdk/src/types/app-connection-types.ts:499](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L499) --- # Type Alias: SyncRuleInboundTargetType > **SyncRuleInboundTargetType** = `"member_property"` | `"managed_field"` | `"label"` | `"form_field"` Defined in: [packages/sdk/src/types/app-connection-types.ts:181](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L181) --- # Type Alias: SyncRunMode > **SyncRunMode** = `"outbound"` | `"inbound"` | `"both"` Defined in: [packages/sdk/src/types/app-connection-types.ts:259](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/app-connection-types.ts#L259) --- # Type Alias: Task > **Task** = `Omit`<[`GeneratedTaskResponse`](https://docs.gravityrail.com/sdk/interfaces/GeneratedTaskResponse.md), `"enterRules"` | `"leaveRules"` | `"eventRules"` | `"abilities"` | `"inheritedAbilities"`> & `object` Defined in: [packages/sdk/src/types/task-types.ts:61](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/task-types.ts#L61) ## Type Declaration[​](#type-declaration "Direct link to Type Declaration") ### abilities?[​](#abilities "Direct link to abilities?") > `optional` **abilities**: [`AbilityResponse`](https://docs.gravityrail.com/sdk/type-aliases/AbilityResponse.md)\[] ### enterRules[​](#enterrules "Direct link to enterRules") > **enterRules**: [`EventRuleResponse`](https://docs.gravityrail.com/sdk/type-aliases/EventRuleResponse.md)\[] ### eventRules?[​](#eventrules "Direct link to eventRules?") > `optional` **eventRules**: [`EventRuleResponse`](https://docs.gravityrail.com/sdk/type-aliases/EventRuleResponse.md)\[] ### inheritedAbilities?[​](#inheritedabilities "Direct link to inheritedAbilities?") > `optional` **inheritedAbilities**: [`AbilityResponse`](https://docs.gravityrail.com/sdk/type-aliases/AbilityResponse.md)\[] ### leaveRules[​](#leaverules "Direct link to leaveRules") > **leaveRules**: [`EventRuleResponse`](https://docs.gravityrail.com/sdk/type-aliases/EventRuleResponse.md)\[] --- # Type Alias: TaskResponse > **TaskResponse** = [`Task`](https://docs.gravityrail.com/sdk/type-aliases/Task.md) Defined in: [packages/sdk/src/types/task-types.ts:72](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/task-types.ts#L72) --- # Type Alias: TaskSortField > **TaskSortField** = `"name"` | `"createdAt"` | `"workflowId"` Defined in: [packages/sdk/src/types/sort-types.ts:59](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/sort-types.ts#L59) --- # Type Alias: TeamsAppSortField > **TeamsAppSortField** = `"createdAt"` | `"updatedAt"` | `"name"` Defined in: [packages/sdk/src/types/teams-app-types.ts:107](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/teams-app-types.ts#L107) Sort fields for Teams apps. --- # Type Alias: TeamsConversation > **TeamsConversation** = `Omit`<`GeneratedTeamsConversationResponse`, `"chatTitle"` | `"teamId"` | `"channelId"` | `"workflowId"` | `"workflowName"`> & `object` Defined in: [packages/sdk/src/types/teams-app-types.ts:34](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/teams-app-types.ts#L34) ## Type Declaration[​](#type-declaration "Direct link to Type Declaration") ### channelId[​](#channelid "Direct link to channelId") > **channelId**: `string` | `null` ### chatTitle?[​](#chattitle "Direct link to chatTitle?") > `optional` **chatTitle**: `string` | `null` ### teamId[​](#teamid "Direct link to teamId") > **teamId**: `string` | `null` ### workflowId[​](#workflowid "Direct link to workflowId") > **workflowId**: `number` | `null` ### workflowName[​](#workflowname "Direct link to workflowName") > **workflowName**: `string` | `null` --- # Type Alias: TeamsConversationResponse > **TeamsConversationResponse** = [`TeamsConversation`](https://docs.gravityrail.com/sdk/type-aliases/TeamsConversation.md) Defined in: [packages/sdk/src/types/teams-app-types.ts:44](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/teams-app-types.ts#L44) --- # Type Alias: TeamsConversationType > **TeamsConversationType** = `"personal"` | `"groupChat"` | `"channel"` Defined in: [packages/sdk/src/types/teams-app-types.ts:56](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/teams-app-types.ts#L56) Teams conversation surface. --- # Type Alias: TeamsRespondMode > **TeamsRespondMode** = `"mentions"` | `"auto"` | `"off"` Defined in: [packages/sdk/src/types/teams-app-types.ts:51](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/teams-app-types.ts#L51) How the Teams bot decides whether to respond to messages. --- # Type Alias: ThemeFeaturesDarkMode > **ThemeFeaturesDarkMode** = `object` Defined in: [packages/sdk/src/types/generated/theme.ts:41](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/theme.ts#L41) Color-scheme support ## Properties[​](#properties "Direct link to Properties") ### both[​](#both "Direct link to both") > `readonly` **both**: `"both"` = `'both'` Defined in: [packages/sdk/src/types/generated/theme.ts:47](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/theme.ts#L47) *** ### dark[​](#dark "Direct link to dark") > `readonly` **dark**: `"dark"` = `'dark'` Defined in: [packages/sdk/src/types/generated/theme.ts:46](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/theme.ts#L46) *** ### light[​](#light "Direct link to light") > `readonly` **light**: `"light"` = `'light'` Defined in: [packages/sdk/src/types/generated/theme.ts:45](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/theme.ts#L45) --- # Type Alias: ThemeFeaturesDarkMode > **ThemeFeaturesDarkMode** = *typeof* [`ThemeFeaturesDarkMode`](https://docs.gravityrail.com/sdk/type-aliases/ThemeFeaturesDarkMode.md)\[keyof *typeof* [`ThemeFeaturesDarkMode`](https://docs.gravityrail.com/sdk/type-aliases/ThemeFeaturesDarkMode.md)] Defined in: [packages/sdk/src/types/generated/theme.ts:41](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/theme.ts#L41) Color-scheme support --- # Type Alias: ThemeName > **ThemeName** = `"default"` | `"gravityrail-home"` | `"gravityrail-home-2"` | `"gravityrail-start"` | `"gravityrail-pitch"` | `"leapcure-home"` | `"leapcure-home-no-chat"` | `"leapcure-home-pre-launch"` | `"dml-home"` | `"rc360-demo"` | `"patient-engagement-demo"` | `"admin-clinical-trial"` | `"customer-basic"` | `"operator-product"` | `"gravity-health"` | `"gravity-health-enrollment"` | `"gravity-developer"` | `"gravityrail-launch"` | `"gravity-rail-feb-2026"` | `"cosan-enrollment"` | `"gravity-health-enrollment"` | `"source-site"` Defined in: [packages/sdk/src/types/site-types.ts:58](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/site-types.ts#L58) --- # Type Alias: ThemeSettingFieldType > **ThemeSettingFieldType** = `object` Defined in: [packages/sdk/src/types/generated/site.ts:323](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L323) Field/value type ## Properties[​](#properties "Direct link to Properties") ### boolean[​](#boolean "Direct link to boolean") > `readonly` **boolean**: `"boolean"` = `'boolean'` Defined in: [packages/sdk/src/types/generated/site.ts:330](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L330) *** ### color[​](#color "Direct link to color") > `readonly` **color**: `"color"` = `'color'` Defined in: [packages/sdk/src/types/generated/site.ts:332](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L332) *** ### data\_type[​](#data_type "Direct link to data_type") > `readonly` **data\_type**: `"data_type"` = `'data_type'` Defined in: [packages/sdk/src/types/generated/site.ts:335](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L335) *** ### image[​](#image "Direct link to image") > `readonly` **image**: `"image"` = `'image'` Defined in: [packages/sdk/src/types/generated/site.ts:334](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L334) *** ### member\_role[​](#member_role "Direct link to member_role") > `readonly` **member\_role**: `"member_role"` = `'member_role'` Defined in: [packages/sdk/src/types/generated/site.ts:338](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L338) *** ### number[​](#number "Direct link to number") > `readonly` **number**: `"number"` = `'number'` Defined in: [packages/sdk/src/types/generated/site.ts:329](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L329) *** ### page[​](#page "Direct link to page") > `readonly` **page**: `"page"` = `'page'` Defined in: [packages/sdk/src/types/generated/site.ts:337](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L337) *** ### select[​](#select "Direct link to select") > `readonly` **select**: `"select"` = `'select'` Defined in: [packages/sdk/src/types/generated/site.ts:331](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L331) *** ### text[​](#text "Direct link to text") > `readonly` **text**: `"text"` = `'text'` Defined in: [packages/sdk/src/types/generated/site.ts:327](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L327) *** ### textarea[​](#textarea "Direct link to textarea") > `readonly` **textarea**: `"textarea"` = `'textarea'` Defined in: [packages/sdk/src/types/generated/site.ts:328](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L328) *** ### url[​](#url "Direct link to url") > `readonly` **url**: `"url"` = `'url'` Defined in: [packages/sdk/src/types/generated/site.ts:333](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L333) *** ### workflow[​](#workflow "Direct link to workflow") > `readonly` **workflow**: `"workflow"` = `'workflow'` Defined in: [packages/sdk/src/types/generated/site.ts:336](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L336) --- # Type Alias: ThemeSettingFieldType > **ThemeSettingFieldType** = *typeof* [`ThemeSettingFieldType`](https://docs.gravityrail.com/sdk/type-aliases/ThemeSettingFieldType.md)\[keyof *typeof* [`ThemeSettingFieldType`](https://docs.gravityrail.com/sdk/type-aliases/ThemeSettingFieldType.md)] Defined in: [packages/sdk/src/types/generated/site.ts:323](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L323) Field/value type --- # Type Alias: ThinkingSound > **ThinkingSound** = `"none"` | `"typing"` | `"strumming"` | `"speech"` Defined in: [packages/sdk/src/types/model-config-types.ts:27](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/model-config-types.ts#L27) --- # Type Alias: TodoStatus > **TodoStatus** = `"pending"` | `"in_progress"` | `"completed"` | `"blocked"` Defined in: [packages/sdk/src/types/chat-types.ts:65](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L65) --- # Type Alias: ToolType > **ToolType** = `"custom"` | `"supervisor"` Defined in: [packages/sdk/src/types/custom-tool-types.ts:34](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/custom-tool-types.ts#L34) --- # Type Alias: TruncationReason > **TruncationReason** = `"barge_in"` | `"client_interrupt"` | `"user_cancel"` | `"error"` Defined in: [packages/sdk/src/types/chat-types.ts:214](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L214) --- # Type Alias: TTSAIModel > **TTSAIModel** = [`TTSModelResponse`](https://docs.gravityrail.com/sdk/interfaces/TTSModelResponse.md) & `object` Defined in: [packages/sdk/src/types/ai-model-types.ts:54](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ai-model-types.ts#L54) ## Type Declaration[​](#type-declaration "Direct link to Type Declaration") ### type[​](#type "Direct link to type") > **type**: `"tts"` --- # Type Alias: TTSModel > **TTSModel** = `"native"` | `"elevenlabs:tts:eleven_turbo_v2"` | `"elevenlabs:tts:eleven_turbo_v2_5"` | `"elevenlabs:tts:eleven_multilingual_v2"` | `"elevenlabs:tts:eleven_flash_v2_5"` | `"openai:tts:tts-1"` | `"openai:tts:tts-1-hd"` | `"openai:tts:gpt-4o-mini-tts"` | `"aws:tts:polly-generative"` | `"aws:tts:polly-neural"` | `"google:tts:chirp"` Defined in: [packages/sdk/src/types/model-config-types.ts:36](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/model-config-types.ts#L36) --- # Type Alias: TTSPreviewProvider > **TTSPreviewProvider** = *typeof* [`TTS_PREVIEW_PROVIDERS`](https://docs.gravityrail.com/sdk/variables/TTS_PREVIEW_PROVIDERS.md)\[`number`] Defined in: [packages/sdk/src/types/model-config-types.ts:189](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/model-config-types.ts#L189) --- # Type Alias: TtsReconnectOutcomeEntry > **TtsReconnectOutcomeEntry** = `Omit`<`GeneratedTtsReconnectOutcomeEntry`, `"total"` | `"timeSeries"`> & `object` Defined in: [packages/sdk/src/types/voice-metrics-types.ts:56](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/voice-metrics-types.ts#L56) ## Type Declaration[​](#type-declaration "Direct link to Type Declaration") ### timeSeries[​](#timeseries "Direct link to timeSeries") > **timeSeries**: [`MetricDataPoint`](https://docs.gravityrail.com/sdk/interfaces/MetricDataPoint.md)\[] ### total[​](#total "Direct link to total") > **total**: `number` --- # Type Alias: TtsReconnectSection > **TtsReconnectSection** = `Omit`<`GeneratedTtsReconnectSection`, `"outcomes"` | `"totalReconnects"` | `"duration"`> & `object` Defined in: [packages/sdk/src/types/voice-metrics-types.ts:64](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/voice-metrics-types.ts#L64) ## Type Declaration[​](#type-declaration "Direct link to Type Declaration") ### duration?[​](#duration "Direct link to duration?") > `optional` **duration**: [`MetricSection`](https://docs.gravityrail.com/sdk/type-aliases/MetricSection.md) | `null` ### outcomes[​](#outcomes "Direct link to outcomes") > **outcomes**: [`TtsReconnectOutcomeEntry`](https://docs.gravityrail.com/sdk/type-aliases/TtsReconnectOutcomeEntry.md)\[] ### totalReconnects[​](#totalreconnects "Direct link to totalReconnects") > **totalReconnects**: `number` --- # Type Alias: TwoFactorMethod > **TwoFactorMethod** = `Omit`<`GeneratedTwoFactorMethodResponse`, `"methodType"`> & `object` Defined in: [packages/sdk/src/types/account-types.ts:53](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L53) ## Type Declaration[​](#type-declaration "Direct link to Type Declaration") ### methodType[​](#methodtype "Direct link to methodType") > **methodType**: `TwoFactorMethodType` --- # Type Alias: TwoFactorStatus > **TwoFactorStatus** = `Omit`<`GeneratedTwoFactorStatusResponse`, `"methods"`> & `object` Defined in: [packages/sdk/src/types/account-types.ts:58](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/account-types.ts#L58) ## Type Declaration[​](#type-declaration "Direct link to Type Declaration") ### methods[​](#methods "Direct link to methods") > **methods**: [`TwoFactorMethod`](https://docs.gravityrail.com/sdk/type-aliases/TwoFactorMethod.md)\[] --- # Type Alias: UpdateInquiryRequest > **UpdateInquiryRequest** = `z.infer`<*typeof* `UpdateInquiryRequestSchema`> Defined in: [packages/sdk/src/types/inquiry-types.ts:37](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/inquiry-types.ts#L37) --- # Type Alias: UploadFileData > **UploadFileData** = `string` | `Uint8Array` | `ArrayBuffer` | `ArrayBufferView` | `Blob` Defined in: [packages/sdk/src/types/file-types.ts:77](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/file-types.ts#L77) --- # Type Alias: UsageDashboardResponse > **UsageDashboardResponse** = `Omit`<`GeneratedUsageDashboardResponse`, `"plan"`> & `object` Defined in: [packages/sdk/src/types/billing-types.ts:68](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L68) ## Type Declaration[​](#type-declaration "Direct link to Type Declaration") ### plan[​](#plan "Direct link to plan") > **plan**: `PlanInfo` --- # Type Alias: VoiceMetricsResponse > **VoiceMetricsResponse** = `Omit`<[`GeneratedVoiceMetricsResponse`](https://docs.gravityrail.com/sdk/interfaces/GeneratedVoiceMetricsResponse.md), `"voice"` | `"chat"` | `"callEnd"` | `"requests"` | `"ttsReconnect"`> & `object` Defined in: [packages/sdk/src/types/voice-metrics-types.ts:73](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/voice-metrics-types.ts#L73) ## Type Declaration[​](#type-declaration "Direct link to Type Declaration") ### callEnd[​](#callend "Direct link to callEnd") > **callEnd**: [`CallEndSection`](https://docs.gravityrail.com/sdk/type-aliases/CallEndSection.md) ### chat[​](#chat "Direct link to chat") > **chat**: [`MetricSection`](https://docs.gravityrail.com/sdk/type-aliases/MetricSection.md)\[] ### requests[​](#requests "Direct link to requests") > **requests**: [`RequestsSection`](https://docs.gravityrail.com/sdk/type-aliases/RequestsSection.md) ### ttsReconnect[​](#ttsreconnect "Direct link to ttsReconnect") > **ttsReconnect**: [`TtsReconnectSection`](https://docs.gravityrail.com/sdk/type-aliases/TtsReconnectSection.md) ### voice[​](#voice "Direct link to voice") > **voice**: [`MetricSection`](https://docs.gravityrail.com/sdk/type-aliases/MetricSection.md)\[] --- # Type Alias: VoiceModel > **VoiceModel** = `Omit`<[`GeneratedVoiceModelResponse`](https://docs.gravityrail.com/sdk/interfaces/GeneratedVoiceModelResponse.md), `"description"`> & `object` Defined in: [packages/sdk/src/types/ai-model-types.ts:33](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ai-model-types.ts#L33) ## Type Declaration[​](#type-declaration "Direct link to Type Declaration") ### description?[​](#description "Direct link to description?") > `optional` **description**: `string` | `null` --- # Type Alias: VoiceModelResponse > **VoiceModelResponse** = [`VoiceModel`](https://docs.gravityrail.com/sdk/type-aliases/VoiceModel.md) Defined in: [packages/sdk/src/types/ai-model-types.ts:36](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ai-model-types.ts#L36) --- # Type Alias: VoiceModelsResponse > **VoiceModelsResponse** = `Omit`<`GeneratedVoiceModelsResponse`, `"items"`> & `object` Defined in: [packages/sdk/src/types/ai-model-types.ts:38](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ai-model-types.ts#L38) ## Type Declaration[​](#type-declaration "Direct link to Type Declaration") ### items[​](#items "Direct link to items") > **items**: [`VoiceModelResponse`](https://docs.gravityrail.com/sdk/type-aliases/VoiceModelResponse.md)\[] --- # Type Alias: WebhookLogSortField > **WebhookLogSortField** = `"createdAt"` Defined in: [packages/sdk/src/types/sort-types.ts:25](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/sort-types.ts#L25) --- # Type Alias: Workflow > **Workflow** = `Omit`<[`GeneratedWorkflowResponse`](https://docs.gravityrail.com/sdk/interfaces/GeneratedWorkflowResponse.md), `"abilities"` | `"eventRules"`> & `object` Defined in: [packages/sdk/src/types/task-types.ts:74](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/task-types.ts#L74) ## Type Declaration[​](#type-declaration "Direct link to Type Declaration") ### abilities?[​](#abilities "Direct link to abilities?") > `optional` **abilities**: [`AbilityResponse`](https://docs.gravityrail.com/sdk/type-aliases/AbilityResponse.md)\[] ### eventRules?[​](#eventrules "Direct link to eventRules?") > `optional` **eventRules**: [`EventRuleResponse`](https://docs.gravityrail.com/sdk/type-aliases/EventRuleResponse.md)\[] --- # Type Alias: WorkflowAccessWarningResourceType > **WorkflowAccessWarningResourceType** = *typeof* [`WorkflowAccessWarningResourceType`](https://docs.gravityrail.com/sdk/variables/WorkflowAccessWarningResourceType.md)\[keyof *typeof* [`WorkflowAccessWarningResourceType`](https://docs.gravityrail.com/sdk/variables/WorkflowAccessWarningResourceType.md)] Defined in: [packages/sdk/src/types/generated/task.ts:342](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L342) --- # Type Alias: WorkflowResponse > **WorkflowResponse** = [`Workflow`](https://docs.gravityrail.com/sdk/type-aliases/Workflow.md) Defined in: [packages/sdk/src/types/task-types.ts:79](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/task-types.ts#L79) --- # Type Alias: WorkflowSortField > **WorkflowSortField** = `"name"` | `"updatedAt"` | `"createdAt"` Defined in: [packages/sdk/src/types/sort-types.ts:57](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/sort-types.ts#L57) --- # Type Alias: WorkspaceGrantReason > **WorkspaceGrantReason** = `"superuser"` | `"org_owner"` | `"org_admin"` Defined in: [packages/sdk/src/types/workspace-types.ts:153](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/workspace-types.ts#L153) --- # Type Alias: WorkspaceHealthResponse > **WorkspaceHealthResponse** = `Omit`<[`GeneratedWorkspaceHealthResponse`](https://docs.gravityrail.com/sdk/interfaces/GeneratedWorkspaceHealthResponse.md), `"attachedAddons"`> & `object` Defined in: [packages/sdk/src/types/workspace-health-types.ts:21](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/workspace-health-types.ts#L21) ## Type Declaration[​](#type-declaration "Direct link to Type Declaration") ### attachedAddons[​](#attachedaddons "Direct link to attachedAddons") > **attachedAddons**: [`AttachedAddonInfo`](https://docs.gravityrail.com/sdk/interfaces/AttachedAddonInfo.md)\[] --- # Type Alias: WorkspaceSortField > **WorkspaceSortField** = `"createdAt"` | `"updatedAt"` | `"name"` Defined in: [packages/sdk/src/types/sort-types.ts:44](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/sort-types.ts#L44) --- # Type Alias: XAIReasoningEffort > **XAIReasoningEffort** = `"none"` | `"low"` | `"medium"` | `"high"` Defined in: [packages/sdk/src/types/model-config-types.ts:141](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/model-config-types.ts#L141) xAI (Grok) reasoning levels. Note "none" disables reasoning entirely (used by Grok 4.3 to switch into non-reasoning mode); xAI does NOT accept OpenAI's "minimal". --- # Variable: AbilityConfigIssueCode > **AbilityConfigIssueCode**: `object` Defined in: [packages/sdk/src/types/generated/task.ts:37](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L37) ## Type Declaration[​](#type-declaration "Direct link to Type Declaration") ### external\_drift[​](#external_drift "Direct link to external_drift") > `readonly` **external\_drift**: `"external_drift"` = `'external_drift'` ### feature\_disabled[​](#feature_disabled "Direct link to feature_disabled") > `readonly` **feature\_disabled**: `"feature_disabled"` = `'feature_disabled'` ### invalid\_state[​](#invalid_state "Direct link to invalid_state") > `readonly` **invalid\_state**: `"invalid_state"` = `'invalid_state'` ### missing\_resource[​](#missing_resource "Direct link to missing_resource") > `readonly` **missing\_resource**: `"missing_resource"` = `'missing_resource'` --- # Variable: AbilityConfigIssueSeverity > **AbilityConfigIssueSeverity**: `object` Defined in: [packages/sdk/src/types/generated/task.ts:47](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L47) ## Type Declaration[​](#type-declaration "Direct link to Type Declaration") ### error[​](#error "Direct link to error") > `readonly` **error**: `"error"` = `'error'` ### warning[​](#warning "Direct link to warning") > `readonly` **warning**: `"warning"` = `'warning'` --- # Variable: AbilityTypeSlugs > `const` **AbilityTypeSlugs**: `object` Defined in: [packages/sdk/src/types/ability-types.ts:29](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ability-types.ts#L29) Known ability type slugs ## Type Declaration[​](#type-declaration "Direct link to Type Declaration") ### ASSISTANT\_MESSAGE\_RULES[​](#assistant_message_rules "Direct link to ASSISTANT_MESSAGE_RULES") > `readonly` **ASSISTANT\_MESSAGE\_RULES**: `"chat:assistant_message_rules"` = `'chat:assistant_message_rules'` ### AUDIO\_PLAYBACK[​](#audio_playback "Direct link to AUDIO_PLAYBACK") > `readonly` **AUDIO\_PLAYBACK**: `"communication:audio_playback"` = `'communication:audio_playback'` ### CALENDAR\_BOOKING[​](#calendar_booking "Direct link to CALENDAR_BOOKING") > `readonly` **CALENDAR\_BOOKING**: `"integration:calendar_booking"` = `'integration:calendar_booking'` ### CEL\_ROUTING[​](#cel_routing "Direct link to CEL_ROUTING") > `readonly` **CEL\_ROUTING**: `"system:cel_routing"` = `'system:cel_routing'` ### CHARLESTON\_PMD\_PAGING[​](#charleston_pmd_paging "Direct link to CHARLESTON_PMD_PAGING") > `readonly` **CHARLESTON\_PMD\_PAGING**: `"integration:charleston_pmd_paging"` = `'integration:charleston_pmd_paging'` ### CONTRIBUTOR[​](#contributor "Direct link to CONTRIBUTOR") > `readonly` **CONTRIBUTOR**: `"delegation:contributor"` = `'delegation:contributor'` ### CONVERSATION\_CONTROL[​](#conversation_control "Direct link to CONVERSATION_CONTROL") > `readonly` **CONVERSATION\_CONTROL**: `"tools:conversation_control"` = `'tools:conversation_control'` ### CONVERSATION\_HISTORY[​](#conversation_history "Direct link to CONVERSATION_HISTORY") > `readonly` **CONVERSATION\_HISTORY**: `"tools:conversation_history"` = `'tools:conversation_history'` ### DATA\_ACCESS[​](#data_access "Direct link to DATA_ACCESS") > `readonly` **DATA\_ACCESS**: `"integration:data_access"` = `'integration:data_access'` ### ESCALATION[​](#escalation "Direct link to ESCALATION") > `readonly` **ESCALATION**: `"oversight:escalation"` = `'oversight:escalation'` ### FILE\_ACCESS[​](#file_access "Direct link to FILE_ACCESS") > `readonly` **FILE\_ACCESS**: `"integration:file_access"` = `'integration:file_access'` ### GMAIL[​](#gmail "Direct link to GMAIL") > `readonly` **GMAIL**: `"integration:gmail"` = `'integration:gmail'` ### GOOGLE\_CALENDAR[​](#google_calendar "Direct link to GOOGLE_CALENDAR") > `readonly` **GOOGLE\_CALENDAR**: `"integration:google_calendar"` = `'integration:google_calendar'` ### GOOGLE\_DRIVE[​](#google_drive "Direct link to GOOGLE_DRIVE") > `readonly` **GOOGLE\_DRIVE**: `"integration:google_drive"` = `'integration:google_drive'` ### IMAGE\_GENERATION[​](#image_generation "Direct link to IMAGE_GENERATION") > `readonly` **IMAGE\_GENERATION**: `"tools:image_generation"` = `'tools:image_generation'` ### MEMBER\_ACCESS[​](#member_access "Direct link to MEMBER_ACCESS") > `readonly` **MEMBER\_ACCESS**: `"communication:member_access"` = `'communication:member_access'` ### MEMBER\_FIELD\_VERIFICATION[​](#member_field_verification "Direct link to MEMBER_FIELD_VERIFICATION") > `readonly` **MEMBER\_FIELD\_VERIFICATION**: `"identity:member_field_verification"` = `'identity:member_field_verification'` ### PHONE\_CALL\_TOOLS[​](#phone_call_tools "Direct link to PHONE_CALL_TOOLS") > `readonly` **PHONE\_CALL\_TOOLS**: `"communication:phone_call_tools"` = `'communication:phone_call_tools'` ### RESELLER[​](#reseller "Direct link to RESELLER") > `readonly` **RESELLER**: `"commerce:reseller"` = `'commerce:reseller'` ### SEND\_SMS[​](#send_sms "Direct link to SEND_SMS") > `readonly` **SEND\_SMS**: `"communication:send_sms"` = `'communication:send_sms'` ### SEND\_WHATSAPP[​](#send_whatsapp "Direct link to SEND_WHATSAPP") > `readonly` **SEND\_WHATSAPP**: `"communication:send_whatsapp"` = `'communication:send_whatsapp'` ### SUPERVISOR[​](#supervisor "Direct link to SUPERVISOR") > `readonly` **SUPERVISOR**: `"oversight:supervisor"` = `'oversight:supervisor'` ### SUPERVISOR\_ACTIONS[​](#supervisor_actions "Direct link to SUPERVISOR_ACTIONS") > `readonly` **SUPERVISOR\_ACTIONS**: `"oversight:supervisor_actions"` = `'oversight:supervisor_actions'` ### TOOLKITS[​](#toolkits "Direct link to TOOLKITS") > `readonly` **TOOLKITS**: `"tools:toolkits"` = `'tools:toolkits'` ### USER\_MESSAGE\_RULES[​](#user_message_rules "Direct link to USER_MESSAGE_RULES") > `readonly` **USER\_MESSAGE\_RULES**: `"system:user_message_rules"` = `'system:user_message_rules'` ### WEB\_SEARCH[​](#web_search "Direct link to WEB_SEARCH") > `readonly` **WEB\_SEARCH**: `"tools:web_search"` = `'tools:web_search'` ### WORKFLOW\_RUN[​](#workflow_run "Direct link to WORKFLOW_RUN") > `readonly` **WORKFLOW\_RUN**: `"workflow:run"` = `'workflow:run'` --- # Variable: BUILTIN\_ASSISTANT\_CHAT\_TYPES > `const` **BUILTIN\_ASSISTANT\_CHAT\_TYPES**: `Set`<[`ChatType`](https://docs.gravityrail.com/sdk/type-aliases/ChatType.md)> Defined in: [packages/sdk/src/constants/chat-types.ts:26](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/constants/chat-types.ts#L26) Chat types that use builtin (virtual) assistants instead of DB assistants. --- # Variable: BulkMemberResultStatus > **BulkMemberResultStatus**: `object` Defined in: [packages/sdk/src/types/generated/member.ts:145](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L145) ## Type Declaration[​](#type-declaration "Direct link to Type Declaration") ### created[​](#created "Direct link to created") > `readonly` **created**: `"created"` = `'created'` ### failed[​](#failed "Direct link to failed") > `readonly` **failed**: `"failed"` = `'failed'` ### updated[​](#updated "Direct link to updated") > `readonly` **updated**: `"updated"` = `'updated'` --- # Variable: BusinessIndustry > **BusinessIndustry**: `object` Defined in: [packages/sdk/src/types/generated/organization.ts:115](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L115) ## Type Declaration[​](#type-declaration "Direct link to Type Declaration") ### AGRICULTURE[​](#agriculture "Direct link to AGRICULTURE") > `readonly` **AGRICULTURE**: `"AGRICULTURE"` = `'AGRICULTURE'` ### AUTOMOTIVE[​](#automotive "Direct link to AUTOMOTIVE") > `readonly` **AUTOMOTIVE**: `"AUTOMOTIVE"` = `'AUTOMOTIVE'` ### BANKING[​](#banking "Direct link to BANKING") > `readonly` **BANKING**: `"BANKING"` = `'BANKING'` ### CONSUMER[​](#consumer "Direct link to CONSUMER") > `readonly` **CONSUMER**: `"CONSUMER"` = `'CONSUMER'` ### EDUCATION[​](#education "Direct link to EDUCATION") > `readonly` **EDUCATION**: `"EDUCATION"` = `'EDUCATION'` ### ELECTRONICS[​](#electronics "Direct link to ELECTRONICS") > `readonly` **ELECTRONICS**: `"ELECTRONICS"` = `'ELECTRONICS'` ### ENERGY[​](#energy "Direct link to ENERGY") > `readonly` **ENERGY**: `"ENERGY"` = `'ENERGY'` ### ENGINEERING[​](#engineering "Direct link to ENGINEERING") > `readonly` **ENGINEERING**: `"ENGINEERING"` = `'ENGINEERING'` ### FAST\_MOVING\_CONSUMER\_GOODS[​](#fast_moving_consumer_goods "Direct link to FAST_MOVING_CONSUMER_GOODS") > `readonly` **FAST\_MOVING\_CONSUMER\_GOODS**: `"FAST_MOVING_CONSUMER_GOODS"` = `'FAST_MOVING_CONSUMER_GOODS'` ### FINANCIAL[​](#financial "Direct link to FINANCIAL") > `readonly` **FINANCIAL**: `"FINANCIAL"` = `'FINANCIAL'` ### FINTECH[​](#fintech "Direct link to FINTECH") > `readonly` **FINTECH**: `"FINTECH"` = `'FINTECH'` ### FOOD\_AND\_BEVERAGE[​](#food_and_beverage "Direct link to FOOD_AND_BEVERAGE") > `readonly` **FOOD\_AND\_BEVERAGE**: `"FOOD_AND_BEVERAGE"` = `'FOOD_AND_BEVERAGE'` ### GOVERNMENT[​](#government "Direct link to GOVERNMENT") > `readonly` **GOVERNMENT**: `"GOVERNMENT"` = `'GOVERNMENT'` ### HEALTHCARE[​](#healthcare "Direct link to HEALTHCARE") > `readonly` **HEALTHCARE**: `"HEALTHCARE"` = `'HEALTHCARE'` ### HOSPITALITY[​](#hospitality "Direct link to HOSPITALITY") > `readonly` **HOSPITALITY**: `"HOSPITALITY"` = `'HOSPITALITY'` ### INSURANCE[​](#insurance "Direct link to INSURANCE") > `readonly` **INSURANCE**: `"INSURANCE"` = `'INSURANCE'` ### JEWELRY[​](#jewelry "Direct link to JEWELRY") > `readonly` **JEWELRY**: `"JEWELRY"` = `'JEWELRY'` ### LEGAL[​](#legal "Direct link to LEGAL") > `readonly` **LEGAL**: `"LEGAL"` = `'LEGAL'` ### MANUFACTURING[​](#manufacturing "Direct link to MANUFACTURING") > `readonly` **MANUFACTURING**: `"MANUFACTURING"` = `'MANUFACTURING'` ### MEDIA[​](#media "Direct link to MEDIA") > `readonly` **MEDIA**: `"MEDIA"` = `'MEDIA'` ### NOT\_FOR\_PROFIT[​](#not_for_profit "Direct link to NOT_FOR_PROFIT") > `readonly` **NOT\_FOR\_PROFIT**: `"NOT_FOR_PROFIT"` = `'NOT_FOR_PROFIT'` ### OIL\_AND\_GAS[​](#oil_and_gas "Direct link to OIL_AND_GAS") > `readonly` **OIL\_AND\_GAS**: `"OIL_AND_GAS"` = `'OIL_AND_GAS'` ### ONLINE[​](#online "Direct link to ONLINE") > `readonly` **ONLINE**: `"ONLINE"` = `'ONLINE'` ### RAW\_MATERIALS[​](#raw_materials "Direct link to RAW_MATERIALS") > `readonly` **RAW\_MATERIALS**: `"RAW_MATERIALS"` = `'RAW_MATERIALS'` ### REAL\_ESTATE[​](#real_estate "Direct link to REAL_ESTATE") > `readonly` **REAL\_ESTATE**: `"REAL_ESTATE"` = `'REAL_ESTATE'` ### RELIGION[​](#religion "Direct link to RELIGION") > `readonly` **RELIGION**: `"RELIGION"` = `'RELIGION'` ### RETAIL[​](#retail "Direct link to RETAIL") > `readonly` **RETAIL**: `"RETAIL"` = `'RETAIL'` ### TECHNOLOGY[​](#technology "Direct link to TECHNOLOGY") > `readonly` **TECHNOLOGY**: `"TECHNOLOGY"` = `'TECHNOLOGY'` ### TELECOMMUNICATIONS[​](#telecommunications "Direct link to TELECOMMUNICATIONS") > `readonly` **TELECOMMUNICATIONS**: `"TELECOMMUNICATIONS"` = `'TELECOMMUNICATIONS'` ### TRANSPORTATION[​](#transportation "Direct link to TRANSPORTATION") > `readonly` **TRANSPORTATION**: `"TRANSPORTATION"` = `'TRANSPORTATION'` ### TRAVEL[​](#travel "Direct link to TRAVEL") > `readonly` **TRAVEL**: `"TRAVEL"` = `'TRAVEL'` --- # Variable: BusinessType > **BusinessType**: `object` Defined in: [packages/sdk/src/types/generated/organization.ts:243](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L243) ## Type Declaration[​](#type-declaration "Direct link to Type Declaration") ### Co-operative[​](#co-operative "Direct link to Co-operative") > `readonly` **Co-operative**: `"Co-operative"` = `'Co-operative'` ### Corporation[​](#corporation "Direct link to Corporation") > `readonly` **Corporation**: `"Corporation"` = `'Corporation'` ### Limited\_Liability\_Corporation[​](#limited_liability_corporation "Direct link to Limited_Liability_Corporation") > `readonly` **Limited\_Liability\_Corporation**: `"Limited Liability Corporation"` = `'Limited Liability Corporation'` ### Non-profit\_Corporation[​](#non-profit_corporation "Direct link to Non-profit_Corporation") > `readonly` **Non-profit\_Corporation**: `"Non-profit Corporation"` = `'Non-profit Corporation'` ### Partnership[​](#partnership "Direct link to Partnership") > `readonly` **Partnership**: `"Partnership"` = `'Partnership'` ### Sole\_Proprietorship[​](#sole_proprietorship "Direct link to Sole_Proprietorship") > `readonly` **Sole\_Proprietorship**: `"Sole Proprietorship"` = `'Sole Proprietorship'` --- # Variable: CHAT\_TYPES > `const` **CHAT\_TYPES**: `object` Defined in: [packages/sdk/src/constants/chat-types.ts:11](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/constants/chat-types.ts#L11) Available chat types in the system. ## Type Declaration[​](#type-declaration "Direct link to Type Declaration") ### ASSIGNMENT[​](#assignment "Direct link to ASSIGNMENT") > `readonly` **ASSIGNMENT**: `"assignment"` = `'assignment'` ### CONTRIBUTOR[​](#contributor "Direct link to CONTRIBUTOR") > `readonly` **CONTRIBUTOR**: `"contributor"` = `'contributor'` ### DM[​](#dm "Direct link to DM") > `readonly` **DM**: `"dm"` = `'dm'` ### MANAGER[​](#manager "Direct link to MANAGER") > `readonly` **MANAGER**: `"manager"` = `'manager'` --- # Variable: DataRecordRetirementResponseReason > **DataRecordRetirementResponseReason**: `object` Defined in: [packages/sdk/src/types/generated/data.ts:94](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/data.ts#L94) ## Type Declaration[​](#type-declaration "Direct link to Type Declaration") ### monday\_item\_archived[​](#monday_item_archived "Direct link to monday_item_archived") > `readonly` **monday\_item\_archived**: `"monday_item_archived"` = `'monday_item_archived'` ### monday\_item\_deleted[​](#monday_item_deleted "Direct link to monday_item_deleted") > `readonly` **monday\_item\_deleted**: `"monday_item_deleted"` = `'monday_item_deleted'` --- # Variable: DEFAULT\_CHAT\_MODEL > `const` **DEFAULT\_CHAT\_MODEL**: `"aws:bedrock:claude-4-5-haiku"` = `'aws:bedrock:claude-4-5-haiku'` Defined in: [packages/sdk/src/constants/models.ts:9](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/constants/models.ts#L9) Default chat/inference model for new agents and assistants. --- # Variable: DEFAULT\_CUSTOM\_VOICE\_MODEL > `const` **DEFAULT\_CUSTOM\_VOICE\_MODEL**: `"elevenlabs:voice:river"` = `'elevenlabs:voice:river'` Defined in: [packages/sdk/src/constants/models.ts:15](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/constants/models.ts#L15) Default voice model for custom realtime configurations. --- # Variable: DEFAULT\_THINKING\_SPEECH\_PHRASES > `const` **DEFAULT\_THINKING\_SPEECH\_PHRASES**: readonly `string`\[] Defined in: [packages/sdk/src/types/model-config-types.ts:31](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/model-config-types.ts#L31) Default filler phrases suggested when the user first enables "speech" mode. --- # Variable: DEFAULT\_VOICE\_INFERENCE\_MODEL > `const` **DEFAULT\_VOICE\_INFERENCE\_MODEL**: `"google:vertex:gemini-3-flash"` = `'google:vertex:gemini-3-flash'` Defined in: [packages/sdk/src/constants/models.ts:12](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/constants/models.ts#L12) Default inference model for custom voice stack. --- # Variable: EmailDnsRecordType > **EmailDnsRecordType**: `object` Defined in: [packages/sdk/src/types/generated/organization.ts:315](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L315) ## Type Declaration[​](#type-declaration "Direct link to Type Declaration") ### CNAME[​](#cname "Direct link to CNAME") > `readonly` **CNAME**: `"CNAME"` = `'CNAME'` ### MX[​](#mx "Direct link to MX") > `readonly` **MX**: `"MX"` = `'MX'` ### TXT[​](#txt "Direct link to TXT") > `readonly` **TXT**: `"TXT"` = `'TXT'` --- # Variable: JobPosition > **JobPosition**: `object` Defined in: [packages/sdk/src/types/generated/organization.ts:372](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L372) ## Type Declaration[​](#type-declaration "Direct link to Type Declaration") ### CEO[​](#ceo "Direct link to CEO") > `readonly` **CEO**: `"CEO"` = `'CEO'` ### CFO[​](#cfo "Direct link to CFO") > `readonly` **CFO**: `"CFO"` = `'CFO'` ### Director[​](#director "Direct link to Director") > `readonly` **Director**: `"Director"` = `'Director'` ### General\_Counsel[​](#general_counsel "Direct link to General_Counsel") > `readonly` **General\_Counsel**: `"General Counsel"` = `'General Counsel'` ### GM[​](#gm "Direct link to GM") > `readonly` **GM**: `"GM"` = `'GM'` ### Other[​](#other "Direct link to Other") > `readonly` **Other**: `"Other"` = `'Other'` ### VP[​](#vp "Direct link to VP") > `readonly` **VP**: `"VP"` = `'VP'` --- # Variable: MASKED\_SECRET\_SENTINEL > `const` **MASKED\_SECRET\_SENTINEL**: `"__SECRET_SET__"` = `'__SECRET_SET__'` Defined in: [packages/sdk/src/types/event-types.ts:186](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/event-types.ts#L186) Sentinel value returned by the API when a secret field (like apiToken) is set. The client should detect this value and show a "secret is set" state instead of the actual value. When sending updates, if the user hasn't changed the secret, either omit the field or don't include it in the request. --- # Variable: MemberImportMatchInfoMatchType > **MemberImportMatchInfoMatchType**: `object` Defined in: [packages/sdk/src/types/generated/member.ts:448](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L448) ## Type Declaration[​](#type-declaration "Direct link to Type Declaration") ### account\_email[​](#account_email "Direct link to account_email") > `readonly` **account\_email**: `"account_email"` = `'account_email'` ### account\_phone[​](#account_phone "Direct link to account_phone") > `readonly` **account\_phone**: `"account_phone"` = `'account_phone'` ### email[​](#email "Direct link to email") > `readonly` **email**: `"email"` = `'email'` ### external\_id[​](#external_id "Direct link to external_id") > `readonly` **external\_id**: `"external_id"` = `'external_id'` ### phone[​](#phone "Direct link to phone") > `readonly` **phone**: `"phone"` = `'phone'` --- # Variable: MemberImportPreviewRowAction > **MemberImportPreviewRowAction**: `object` Defined in: [packages/sdk/src/types/generated/member.ts:482](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/member.ts#L482) ## Type Declaration[​](#type-declaration "Direct link to Type Declaration") ### conflict[​](#conflict "Direct link to conflict") > `readonly` **conflict**: `"conflict"` = `'conflict'` ### create[​](#create "Direct link to create") > `readonly` **create**: `"create"` = `'create'` ### error[​](#error "Direct link to error") > `readonly` **error**: `"error"` = `'error'` ### unchanged[​](#unchanged "Direct link to unchanged") > `readonly` **unchanged**: `"unchanged"` = `'unchanged'` ### update[​](#update "Direct link to update") > `readonly` **update**: `"update"` = `'update'` --- # Variable: MenuItemResponseItemType > **MenuItemResponseItemType**: `object` Defined in: [packages/sdk/src/types/generated/site.ts:90](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/site.ts#L90) ## Type Declaration[​](#type-declaration "Direct link to Type Declaration") ### none[​](#none "Direct link to none") > `readonly` **none**: `"none"` = `'none'` ### page[​](#page "Direct link to page") > `readonly` **page**: `"page"` = `'page'` ### products[​](#products "Direct link to products") > `readonly` **products**: `"products"` = `'products'` ### url[​](#url "Direct link to url") > `readonly` **url**: `"url"` = `'url'` --- # Variable: ModelProvider > **ModelProvider**: `object` Defined in: [packages/sdk/src/types/generated/ai\_model.ts:91](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/ai_model.ts#L91) ## Type Declaration[​](#type-declaration "Direct link to Type Declaration") ### anthropic[​](#anthropic "Direct link to anthropic") > `readonly` **anthropic**: `"anthropic"` = `'anthropic'` ### aws[​](#aws "Direct link to aws") > `readonly` **aws**: `"aws"` = `'aws'` ### custom[​](#custom "Direct link to custom") > `readonly` **custom**: `"custom"` = `'custom'` ### deepgram[​](#deepgram "Direct link to deepgram") > `readonly` **deepgram**: `"deepgram"` = `'deepgram'` ### elevenlabs[​](#elevenlabs "Direct link to elevenlabs") > `readonly` **elevenlabs**: `"elevenlabs"` = `'elevenlabs'` ### google[​](#google "Direct link to google") > `readonly` **google**: `"google"` = `'google'` ### openai[​](#openai "Direct link to openai") > `readonly` **openai**: `"openai"` = `'openai'` ### unknown[​](#unknown "Direct link to unknown") > `readonly` **unknown**: `"unknown"` = `'unknown'` ### xai[​](#xai "Direct link to xai") > `readonly` **xai**: `"xai"` = `'xai'` --- # Variable: ModelType > **ModelType**: `object` Defined in: [packages/sdk/src/types/generated/ai\_model.ts:109](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/ai_model.ts#L109) ## Type Declaration[​](#type-declaration "Direct link to Type Declaration") ### chat[​](#chat "Direct link to chat") > `readonly` **chat**: `"chat"` = `'chat'` ### image[​](#image "Direct link to image") > `readonly` **image**: `"image"` = `'image'` ### realtime[​](#realtime "Direct link to realtime") > `readonly` **realtime**: `"realtime"` = `'realtime'` ### stt[​](#stt "Direct link to stt") > `readonly` **stt**: `"stt"` = `'stt'` ### tts[​](#tts "Direct link to tts") > `readonly` **tts**: `"tts"` = `'tts'` ### video[​](#video "Direct link to video") > `readonly` **video**: `"video"` = `'video'` --- # Variable: NO\_ASSISTANT\_PARTICIPANT\_CHAT\_TYPES > `const` **NO\_ASSISTANT\_PARTICIPANT\_CHAT\_TYPES**: `Set`<[`ChatType`](https://docs.gravityrail.com/sdk/type-aliases/ChatType.md)> Defined in: [packages/sdk/src/constants/chat-types.ts:37](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/constants/chat-types.ts#L37) Chat types that don't require assistant participant records. --- # Variable: OIDCAdminConfigViewProviderType > **OIDCAdminConfigViewProviderType**: `object` Defined in: [packages/sdk/src/types/generated/organization.ts:459](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L459) ## Type Declaration[​](#type-declaration "Direct link to Type Declaration") ### auth0[​](#auth0 "Direct link to auth0") > `readonly` **auth0**: `"auth0"` = `'auth0'` ### azure\_ad[​](#azure_ad "Direct link to azure_ad") > `readonly` **azure\_ad**: `"azure_ad"` = `'azure_ad'` ### generic[​](#generic "Direct link to generic") > `readonly` **generic**: `"generic"` = `'generic'` ### okta[​](#okta "Direct link to okta") > `readonly` **okta**: `"okta"` = `'okta'` --- # Variable: ORG\_ONLY\_RESOURCES > `const` **ORG\_ONLY\_RESOURCES**: `Set`<[`Resource`](https://docs.gravityrail.com/sdk/enumerations/Resource.md)> Defined in: [packages/sdk/src/types/billing-types.ts:302](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/billing-types.ts#L302) Resources that are only valid for ORG-level products. Matches the Python ORG\_ONLY\_RESOURCES in lib/constants.py --- # Variable: PERMISSION\_ADMIN > `const` **PERMISSION\_ADMIN**: `16` = `16` Defined in: [packages/sdk/src/types/core-types.ts:36](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/core-types.ts#L36) --- # Variable: PERMISSION\_CREATE > `const` **PERMISSION\_CREATE**: `4` = `4` Defined in: [packages/sdk/src/types/core-types.ts:34](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/core-types.ts#L34) --- # Variable: PERMISSION\_DELETE > `const` **PERMISSION\_DELETE**: `512` = `512` Defined in: [packages/sdk/src/types/core-types.ts:40](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/core-types.ts#L40) --- # Variable: PERMISSION\_EDIT > `const` **PERMISSION\_EDIT**: `2` = `2` Defined in: [packages/sdk/src/types/core-types.ts:33](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/core-types.ts#L33) --- # Variable: PERMISSION\_GEOLOCATE > `const` **PERMISSION\_GEOLOCATE**: `128` = `128` Defined in: [packages/sdk/src/types/core-types.ts:38](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/core-types.ts#L38) --- # Variable: PERMISSION\_LIST > `const` **PERMISSION\_LIST**: `8` = `8` Defined in: [packages/sdk/src/types/core-types.ts:35](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/core-types.ts#L35) --- # Variable: PERMISSION\_LIST\_ALL > `const` **PERMISSION\_LIST\_ALL**: `256` = `256` Defined in: [packages/sdk/src/types/core-types.ts:39](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/core-types.ts#L39) --- # Variable: PERMISSION\_NONE > `const` **PERMISSION\_NONE**: `0` = `0` Defined in: [packages/sdk/src/types/core-types.ts:31](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/core-types.ts#L31) --- # Variable: PERMISSION\_USE > `const` **PERMISSION\_USE**: `1` = `1` Defined in: [packages/sdk/src/types/core-types.ts:32](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/core-types.ts#L32) --- # Variable: PERMISSION\_VERIFY > `const` **PERMISSION\_VERIFY**: `32` = `32` Defined in: [packages/sdk/src/types/core-types.ts:37](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/core-types.ts#L37) --- # Variable: PIDS\_DISPOSITIONS > `const` **PIDS\_DISPOSITIONS**: readonly \[`"true_positive"`, `"false_positive"`, `"needs_more_context"`] Defined in: [packages/sdk/src/types/pids-types.ts:44](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/pids-types.ts#L44) Reviewer disposition values (matches the backend `ReviewerDisposition`). --- # Variable: PIDS\_SOURCES > `const` **PIDS\_SOURCES**: readonly \[`"scheduled"`, `"backfill"`, `"pre_llm"`] Defined in: [packages/sdk/src/types/pids-types.ts:48](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/pids-types.ts#L48) Finding source values (matches the backend `FindingSource`). --- # Variable: QUERY\_VALUELESS\_OPS > `const` **QUERY\_VALUELESS\_OPS**: `ReadonlySet`<[`QueryComparisonOp`](https://docs.gravityrail.com/sdk/type-aliases/QueryComparisonOp.md)> Defined in: [packages/sdk/src/types/query-engine-types.ts:34](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/query-engine-types.ts#L34) Operators that take no value. --- # Variable: REALTIME\_MODEL\_CUSTOM > `const` **REALTIME\_MODEL\_CUSTOM**: `"custom:realtime:composable"` = `'custom:realtime:composable'` Defined in: [packages/sdk/src/types/ai-model-types.ts:63](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ai-model-types.ts#L63) --- # Variable: REALTIME\_MODEL\_GEMINI > `const` **REALTIME\_MODEL\_GEMINI**: `"google:aistudio:gemini-3.1-flash-live"` = `'google:aistudio:gemini-3.1-flash-live'` Defined in: [packages/sdk/src/types/ai-model-types.ts:60](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ai-model-types.ts#L60) --- # Variable: REALTIME\_MODEL\_GEMINI\_VERTEX > `const` **REALTIME\_MODEL\_GEMINI\_VERTEX**: `"google:vertex:gemini-3.1-flash-live"` = `'google:vertex:gemini-3.1-flash-live'` Defined in: [packages/sdk/src/types/ai-model-types.ts:61](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ai-model-types.ts#L61) --- # Variable: REALTIME\_MODEL\_NOVA\_SONIC > `const` **REALTIME\_MODEL\_NOVA\_SONIC**: `"aws:bedrock:nova-sonic-1"` = `'aws:bedrock:nova-sonic-1'` Defined in: [packages/sdk/src/types/ai-model-types.ts:62](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ai-model-types.ts#L62) --- # Variable: REALTIME\_MODEL\_OPENAI > `const` **REALTIME\_MODEL\_OPENAI**: `"openai:realtime:gpt-realtime"` = `'openai:realtime:gpt-realtime'` Defined in: [packages/sdk/src/types/ai-model-types.ts:57](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ai-model-types.ts#L57) --- # Variable: REALTIME\_MODEL\_OPENAI\_2 > `const` **REALTIME\_MODEL\_OPENAI\_2**: `"openai:realtime:gpt-realtime-2"` = `'openai:realtime:gpt-realtime-2'` Defined in: [packages/sdk/src/types/ai-model-types.ts:59](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ai-model-types.ts#L59) --- # Variable: REALTIME\_MODEL\_OPENAI\_MINI > `const` **REALTIME\_MODEL\_OPENAI\_MINI**: `"openai:realtime:gpt-realtime-mini"` = `'openai:realtime:gpt-realtime-mini'` Defined in: [packages/sdk/src/types/ai-model-types.ts:58](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ai-model-types.ts#L58) --- # Variable: Region > **Region**: `object` Defined in: [packages/sdk/src/types/generated/organization.ts:589](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L589) ## Type Declaration[​](#type-declaration "Direct link to Type Declaration") ### AFRICA[​](#africa "Direct link to AFRICA") > `readonly` **AFRICA**: `"AFRICA"` = `'AFRICA'` ### ASIA[​](#asia "Direct link to ASIA") > `readonly` **ASIA**: `"ASIA"` = `'ASIA'` ### AUSTRALIA[​](#australia "Direct link to AUSTRALIA") > `readonly` **AUSTRALIA**: `"AUSTRALIA"` = `'AUSTRALIA'` ### EUROPE[​](#europe "Direct link to EUROPE") > `readonly` **EUROPE**: `"EUROPE"` = `'EUROPE'` ### LATIN\_AMERICA[​](#latin_america "Direct link to LATIN_AMERICA") > `readonly` **LATIN\_AMERICA**: `"LATIN_AMERICA"` = `'LATIN_AMERICA'` ### USA\_AND\_CANADA[​](#usa_and_canada "Direct link to USA_AND_CANADA") > `readonly` **USA\_AND\_CANADA**: `"USA_AND_CANADA"` = `'USA_AND_CANADA'` --- # Variable: RegistrationIdentifier > **RegistrationIdentifier**: `object` Defined in: [packages/sdk/src/types/generated/organization.ts:609](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L609) ## Type Declaration[​](#type-declaration "Direct link to Type Declaration") ### ACN[​](#acn "Direct link to ACN") > `readonly` **ACN**: `"ACN"` = `'ACN'` ### CBN[​](#cbn "Direct link to CBN") > `readonly` **CBN**: `"CBN"` = `'CBN'` ### CIN[​](#cin "Direct link to CIN") > `readonly` **CIN**: `"CIN"` = `'CIN'` ### CN[​](#cn "Direct link to CN") > `readonly` **CN**: `"CN"` = `'CN'` ### DUNS[​](#duns "Direct link to DUNS") > `readonly` **DUNS**: `"DUNS"` = `'DUNS'` ### EIN[​](#ein "Direct link to EIN") > `readonly` **EIN**: `"EIN"` = `'EIN'` ### Other[​](#other "Direct link to Other") > `readonly` **Other**: `"Other"` = `'Other'` ### RN[​](#rn "Direct link to RN") > `readonly` **RN**: `"RN"` = `'RN'` ### VAT[​](#vat "Direct link to VAT") > `readonly` **VAT**: `"VAT"` = `'VAT'` ### VATRN[​](#vatrn "Direct link to VATRN") > `readonly` **VATRN**: `"VATRN"` = `'VATRN'` --- # Variable: SCOPE\_PRESETS > `const` **SCOPE\_PRESETS**: `object` Defined in: [packages/sdk/src/scopes.ts:743](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/scopes.ts#L743) Common scope combinations for convenience ## Type Declaration[​](#type-declaration "Direct link to Type Declaration") ### ALL[​](#all "Direct link to ALL") > **ALL**: (`"workspace:read"` | `"workspace:write"` | `"workspace:admin"` | `"members:read"` | `"members:write"` | `"members:admin"` | `"member_roles:read"` | `"member_roles:write"` | `"member_roles:admin"` | `"chats:read"` | `"chats:write"` | `"chats:admin"` | `"dm:read"` | `"dm:write"` | `"dm:admin"` | `"journeys:read"` | `"journeys:write"` | `"journeys:admin"` | `"experiments:read"` | `"experiments:write"` | `"experiments:admin"` | `"workflows:read"` | `"workflows:write"` | `"workflows:admin"` | `"assignments:read"` | `"assignments:write"` | `"assignments:admin"` | `"automations:read"` | `"automations:write"` | `"automations:admin"` | `"datatypes:read"` | `"datatypes:write"` | `"datatypes:admin"` | `"records:read"` | `"records:write"` | `"records:admin"` | `"files:read"` | `"files:write"` | `"files:admin"` | `"sites:read"` | `"sites:write"` | `"sites:admin"` | `"agents:read"` | `"agents:write"` | `"agents:admin"` | `"calendars:read"` | `"calendars:write"` | `"calendars:admin"` | `"inboxes:read"` | `"inboxes:write"` | `"inboxes:admin"` | `"phones:read"` | `"phones:write"` | `"phones:admin"` | `"webhooks:read"` | `"webhooks:write"` | `"webhooks:admin"` | `"webhooks:raw"` | `"apps:read"` | `"apps:write"` | `"apps:admin"` | `"labels:read"` | `"labels:write"` | `"analytics:read"` | `"operator:read"` | `"operator:write"` | `"export:read"` | `"export:write"` | `"export:admin"` | `"org:info"` | `"org:read"` | `"org:write"` | `"org:admin"` | `"org:manage_admins"` | `"org:delete"`)\[] Full access - all available scopes ### CHATS[​](#chats "Direct link to CHATS") > **CHATS**: (`"workspace:read"` | `"workspace:write"` | `"workspace:admin"` | `"members:read"` | `"members:write"` | `"members:admin"` | `"member_roles:read"` | `"member_roles:write"` | `"member_roles:admin"` | `"chats:read"` | `"chats:write"` | `"chats:admin"` | `"dm:read"` | `"dm:write"` | `"dm:admin"` | `"journeys:read"` | `"journeys:write"` | `"journeys:admin"` | `"experiments:read"` | `"experiments:write"` | `"experiments:admin"` | `"workflows:read"` | `"workflows:write"` | `"workflows:admin"` | `"assignments:read"` | `"assignments:write"` | `"assignments:admin"` | `"automations:read"` | `"automations:write"` | `"automations:admin"` | `"datatypes:read"` | `"datatypes:write"` | `"datatypes:admin"` | `"records:read"` | `"records:write"` | `"records:admin"` | `"files:read"` | `"files:write"` | `"files:admin"` | `"sites:read"` | `"sites:write"` | `"sites:admin"` | `"agents:read"` | `"agents:write"` | `"agents:admin"` | `"calendars:read"` | `"calendars:write"` | `"calendars:admin"` | `"inboxes:read"` | `"inboxes:write"` | `"inboxes:admin"` | `"phones:read"` | `"phones:write"` | `"phones:admin"` | `"webhooks:read"` | `"webhooks:write"` | `"webhooks:admin"` | `"webhooks:raw"` | `"apps:read"` | `"apps:write"` | `"apps:admin"` | `"labels:read"` | `"labels:write"` | `"analytics:read"` | `"operator:read"` | `"operator:write"` | `"export:read"` | `"export:write"` | `"export:admin"` | `"org:info"` | `"org:read"` | `"org:write"` | `"org:admin"` | `"org:manage_admins"` | `"org:delete"`)\[] Chat access - members and chat management ### DATA[​](#data "Direct link to DATA") > **DATA**: (`"workspace:read"` | `"workspace:write"` | `"workspace:admin"` | `"members:read"` | `"members:write"` | `"members:admin"` | `"member_roles:read"` | `"member_roles:write"` | `"member_roles:admin"` | `"chats:read"` | `"chats:write"` | `"chats:admin"` | `"dm:read"` | `"dm:write"` | `"dm:admin"` | `"journeys:read"` | `"journeys:write"` | `"journeys:admin"` | `"experiments:read"` | `"experiments:write"` | `"experiments:admin"` | `"workflows:read"` | `"workflows:write"` | `"workflows:admin"` | `"assignments:read"` | `"assignments:write"` | `"assignments:admin"` | `"automations:read"` | `"automations:write"` | `"automations:admin"` | `"datatypes:read"` | `"datatypes:write"` | `"datatypes:admin"` | `"records:read"` | `"records:write"` | `"records:admin"` | `"files:read"` | `"files:write"` | `"files:admin"` | `"sites:read"` | `"sites:write"` | `"sites:admin"` | `"agents:read"` | `"agents:write"` | `"agents:admin"` | `"calendars:read"` | `"calendars:write"` | `"calendars:admin"` | `"inboxes:read"` | `"inboxes:write"` | `"inboxes:admin"` | `"phones:read"` | `"phones:write"` | `"phones:admin"` | `"webhooks:read"` | `"webhooks:write"` | `"webhooks:admin"` | `"webhooks:raw"` | `"apps:read"` | `"apps:write"` | `"apps:admin"` | `"labels:read"` | `"labels:write"` | `"analytics:read"` | `"operator:read"` | `"operator:write"` | `"export:read"` | `"export:write"` | `"export:admin"` | `"org:info"` | `"org:read"` | `"org:write"` | `"org:admin"` | `"org:manage_admins"` | `"org:delete"`)\[] Data access - members and records management --- # Variable: SCOPES > `const` **SCOPES**: `object` Defined in: [packages/sdk/src/scopes.ts:63](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/scopes.ts#L63) All available OAuth scopes Must match Python Scope enum in lib/context/scopes.py ## Type Declaration[​](#type-declaration "Direct link to Type Declaration") ### agents:admin[​](#agents "Direct link to agents:admin") > `readonly` **agents:admin**: `object` #### agents:admin.category[​](#agentscategory "Direct link to agents:admin.category") > `readonly` **category**: [`AGENTS`](https://docs.gravityrail.com/sdk/enumerations/ScopeCategory.md#agents) = `ScopeCategory.AGENTS` #### agents:admin.description[​](#agentsdescription "Direct link to agents:admin.description") > `readonly` **description**: `"Delete agents"` = `'Delete agents'` #### agents:admin.implies[​](#agentsimplies "Direct link to agents:admin.implies") > `readonly` **implies**: readonly \[`"agents:write"`] #### agents:admin.name[​](#agentsname "Direct link to agents:admin.name") > `readonly` **name**: `"agents:admin"` = `'agents:admin'` ### agents:read[​](#agents-1 "Direct link to agents:read") > `readonly` **agents:read**: `object` #### agents:read.category[​](#agentscategory-1 "Direct link to agents:read.category") > `readonly` **category**: [`AGENTS`](https://docs.gravityrail.com/sdk/enumerations/ScopeCategory.md#agents) = `ScopeCategory.AGENTS` #### agents:read.description[​](#agentsdescription-1 "Direct link to agents:read.description") > `readonly` **description**: `"View agent members"` = `'View agent members'` #### agents:read.name[​](#agentsname-1 "Direct link to agents:read.name") > `readonly` **name**: `"agents:read"` = `'agents:read'` ### agents:write[​](#agents-2 "Direct link to agents:write") > `readonly` **agents:write**: `object` #### agents:write.category[​](#agentscategory-2 "Direct link to agents:write.category") > `readonly` **category**: [`AGENTS`](https://docs.gravityrail.com/sdk/enumerations/ScopeCategory.md#agents) = `ScopeCategory.AGENTS` #### agents:write.description[​](#agentsdescription-2 "Direct link to agents:write.description") > `readonly` **description**: `"Create and configure agents"` = `'Create and configure agents'` #### agents:write.implies[​](#agentsimplies-1 "Direct link to agents:write.implies") > `readonly` **implies**: readonly \[`"agents:read"`] #### agents:write.name[​](#agentsname-2 "Direct link to agents:write.name") > `readonly` **name**: `"agents:write"` = `'agents:write'` ### analytics:read[​](#analytics "Direct link to analytics:read") > `readonly` **analytics:read**: `object` #### analytics:read.category[​](#analyticscategory "Direct link to analytics:read.category") > `readonly` **category**: [`ANALYTICS`](https://docs.gravityrail.com/sdk/enumerations/ScopeCategory.md#analytics) = `ScopeCategory.ANALYTICS` #### analytics:read.description[​](#analyticsdescription "Direct link to analytics:read.description") > `readonly` **description**: `"View analytics and reports"` = `'View analytics and reports'` #### analytics:read.name[​](#analyticsname "Direct link to analytics:read.name") > `readonly` **name**: `"analytics:read"` = `'analytics:read'` ### apps:admin[​](#apps "Direct link to apps:admin") > `readonly` **apps:admin**: `object` #### apps:admin.category[​](#appscategory "Direct link to apps:admin.category") > `readonly` **category**: [`APPS`](https://docs.gravityrail.com/sdk/enumerations/ScopeCategory.md#apps) = `ScopeCategory.APPS` #### apps:admin.description[​](#appsdescription "Direct link to apps:admin.description") > `readonly` **description**: `"Delete app integrations"` = `'Delete app integrations'` #### apps:admin.implies[​](#appsimplies "Direct link to apps:admin.implies") > `readonly` **implies**: readonly \[`"apps:write"`] #### apps:admin.name[​](#appsname "Direct link to apps:admin.name") > `readonly` **name**: `"apps:admin"` = `'apps:admin'` ### apps:read[​](#apps-1 "Direct link to apps:read") > `readonly` **apps:read**: `object` #### apps:read.category[​](#appscategory-1 "Direct link to apps:read.category") > `readonly` **category**: [`APPS`](https://docs.gravityrail.com/sdk/enumerations/ScopeCategory.md#apps) = `ScopeCategory.APPS` #### apps:read.description[​](#appsdescription-1 "Direct link to apps:read.description") > `readonly` **description**: `"View app integrations"` = `'View app integrations'` #### apps:read.name[​](#appsname-1 "Direct link to apps:read.name") > `readonly` **name**: `"apps:read"` = `'apps:read'` ### apps:write[​](#apps-2 "Direct link to apps:write") > `readonly` **apps:write**: `object` #### apps:write.category[​](#appscategory-2 "Direct link to apps:write.category") > `readonly` **category**: [`APPS`](https://docs.gravityrail.com/sdk/enumerations/ScopeCategory.md#apps) = `ScopeCategory.APPS` #### apps:write.description[​](#appsdescription-2 "Direct link to apps:write.description") > `readonly` **description**: `"Configure app integrations"` = `'Configure app integrations'` #### apps:write.implies[​](#appsimplies-1 "Direct link to apps:write.implies") > `readonly` **implies**: readonly \[`"apps:read"`] #### apps:write.name[​](#appsname-2 "Direct link to apps:write.name") > `readonly` **name**: `"apps:write"` = `'apps:write'` ### assignments:admin[​](#assignments "Direct link to assignments:admin") > `readonly` **assignments:admin**: `object` #### assignments:admin.category[​](#assignmentscategory "Direct link to assignments:admin.category") > `readonly` **category**: [`ASSIGNMENTS`](https://docs.gravityrail.com/sdk/enumerations/ScopeCategory.md#assignments) = `ScopeCategory.ASSIGNMENTS` #### assignments:admin.description[​](#assignmentsdescription "Direct link to assignments:admin.description") > `readonly` **description**: `"Delete assignments"` = `'Delete assignments'` #### assignments:admin.implies[​](#assignmentsimplies "Direct link to assignments:admin.implies") > `readonly` **implies**: readonly \[`"assignments:write"`] #### assignments:admin.name[​](#assignmentsname "Direct link to assignments:admin.name") > `readonly` **name**: `"assignments:admin"` = `'assignments:admin'` ### assignments:read[​](#assignments-1 "Direct link to assignments:read") > `readonly` **assignments:read**: `object` #### assignments:read.category[​](#assignmentscategory-1 "Direct link to assignments:read.category") > `readonly` **category**: [`ASSIGNMENTS`](https://docs.gravityrail.com/sdk/enumerations/ScopeCategory.md#assignments) = `ScopeCategory.ASSIGNMENTS` #### assignments:read.description[​](#assignmentsdescription-1 "Direct link to assignments:read.description") > `readonly` **description**: `"View all assignments"` = `'View all assignments'` #### assignments:read.name[​](#assignmentsname-1 "Direct link to assignments:read.name") > `readonly` **name**: `"assignments:read"` = `'assignments:read'` ### assignments:write[​](#assignments-2 "Direct link to assignments:write") > `readonly` **assignments:write**: `object` #### assignments:write.category[​](#assignmentscategory-2 "Direct link to assignments:write.category") > `readonly` **category**: [`ASSIGNMENTS`](https://docs.gravityrail.com/sdk/enumerations/ScopeCategory.md#assignments) = `ScopeCategory.ASSIGNMENTS` #### assignments:write.description[​](#assignmentsdescription-2 "Direct link to assignments:write.description") > `readonly` **description**: `"Create and modify assignments"` = `'Create and modify assignments'` #### assignments:write.implies[​](#assignmentsimplies-1 "Direct link to assignments:write.implies") > `readonly` **implies**: readonly \[`"assignments:read"`] #### assignments:write.name[​](#assignmentsname-2 "Direct link to assignments:write.name") > `readonly` **name**: `"assignments:write"` = `'assignments:write'` ### automations:admin[​](#automations "Direct link to automations:admin") > `readonly` **automations:admin**: `object` #### automations:admin.category[​](#automationscategory "Direct link to automations:admin.category") > `readonly` **category**: [`AUTOMATIONS`](https://docs.gravityrail.com/sdk/enumerations/ScopeCategory.md#automations) = `ScopeCategory.AUTOMATIONS` #### automations:admin.description[​](#automationsdescription "Direct link to automations:admin.description") > `readonly` **description**: `"Delete automations"` = `'Delete automations'` #### automations:admin.implies[​](#automationsimplies "Direct link to automations:admin.implies") > `readonly` **implies**: readonly \[`"automations:write"`] #### automations:admin.name[​](#automationsname "Direct link to automations:admin.name") > `readonly` **name**: `"automations:admin"` = `'automations:admin'` ### automations:read[​](#automations-1 "Direct link to automations:read") > `readonly` **automations:read**: `object` #### automations:read.category[​](#automationscategory-1 "Direct link to automations:read.category") > `readonly` **category**: [`AUTOMATIONS`](https://docs.gravityrail.com/sdk/enumerations/ScopeCategory.md#automations) = `ScopeCategory.AUTOMATIONS` #### automations:read.description[​](#automationsdescription-1 "Direct link to automations:read.description") > `readonly` **description**: `"View scheduled tasks and rules"` = `'View scheduled tasks and rules'` #### automations:read.name[​](#automationsname-1 "Direct link to automations:read.name") > `readonly` **name**: `"automations:read"` = `'automations:read'` ### automations:write[​](#automations-2 "Direct link to automations:write") > `readonly` **automations:write**: `object` #### automations:write.category[​](#automationscategory-2 "Direct link to automations:write.category") > `readonly` **category**: [`AUTOMATIONS`](https://docs.gravityrail.com/sdk/enumerations/ScopeCategory.md#automations) = `ScopeCategory.AUTOMATIONS` #### automations:write.description[​](#automationsdescription-2 "Direct link to automations:write.description") > `readonly` **description**: `"Create and edit automations"` = `'Create and edit automations'` #### automations:write.implies[​](#automationsimplies-1 "Direct link to automations:write.implies") > `readonly` **implies**: readonly \[`"automations:read"`] #### automations:write.name[​](#automationsname-2 "Direct link to automations:write.name") > `readonly` **name**: `"automations:write"` = `'automations:write'` ### calendars:admin[​](#calendars "Direct link to calendars:admin") > `readonly` **calendars:admin**: `object` #### calendars:admin.category[​](#calendarscategory "Direct link to calendars:admin.category") > `readonly` **category**: [`CALENDARS`](https://docs.gravityrail.com/sdk/enumerations/ScopeCategory.md#calendars) = `ScopeCategory.CALENDARS` #### calendars:admin.description[​](#calendarsdescription "Direct link to calendars:admin.description") > `readonly` **description**: `"Delete calendars"` = `'Delete calendars'` #### calendars:admin.implies[​](#calendarsimplies "Direct link to calendars:admin.implies") > `readonly` **implies**: readonly \[`"calendars:write"`] #### calendars:admin.name[​](#calendarsname "Direct link to calendars:admin.name") > `readonly` **name**: `"calendars:admin"` = `'calendars:admin'` ### calendars:read[​](#calendars-1 "Direct link to calendars:read") > `readonly` **calendars:read**: `object` #### calendars:read.category[​](#calendarscategory-1 "Direct link to calendars:read.category") > `readonly` **category**: [`CALENDARS`](https://docs.gravityrail.com/sdk/enumerations/ScopeCategory.md#calendars) = `ScopeCategory.CALENDARS` #### calendars:read.description[​](#calendarsdescription-1 "Direct link to calendars:read.description") > `readonly` **description**: `"View calendars"` = `'View calendars'` #### calendars:read.name[​](#calendarsname-1 "Direct link to calendars:read.name") > `readonly` **name**: `"calendars:read"` = `'calendars:read'` ### calendars:write[​](#calendars-2 "Direct link to calendars:write") > `readonly` **calendars:write**: `object` #### calendars:write.category[​](#calendarscategory-2 "Direct link to calendars:write.category") > `readonly` **category**: [`CALENDARS`](https://docs.gravityrail.com/sdk/enumerations/ScopeCategory.md#calendars) = `ScopeCategory.CALENDARS` #### calendars:write.description[​](#calendarsdescription-2 "Direct link to calendars:write.description") > `readonly` **description**: `"Create and edit calendar events"` = `'Create and edit calendar events'` #### calendars:write.implies[​](#calendarsimplies-1 "Direct link to calendars:write.implies") > `readonly` **implies**: readonly \[`"calendars:read"`] #### calendars:write.name[​](#calendarsname-2 "Direct link to calendars:write.name") > `readonly` **name**: `"calendars:write"` = `'calendars:write'` ### chats:admin[​](#chats "Direct link to chats:admin") > `readonly` **chats:admin**: `object` #### chats:admin.category[​](#chatscategory "Direct link to chats:admin.category") > `readonly` **category**: [`CHATS`](https://docs.gravityrail.com/sdk/enumerations/ScopeCategory.md#chats) = `ScopeCategory.CHATS` #### chats:admin.description[​](#chatsdescription "Direct link to chats:admin.description") > `readonly` **description**: `"Delete conversations"` = `'Delete conversations'` #### chats:admin.implies[​](#chatsimplies "Direct link to chats:admin.implies") > `readonly` **implies**: readonly \[`"chats:write"`] #### chats:admin.name[​](#chatsname "Direct link to chats:admin.name") > `readonly` **name**: `"chats:admin"` = `'chats:admin'` ### chats:read[​](#chats-1 "Direct link to chats:read") > `readonly` **chats:read**: `object` #### chats:read.category[​](#chatscategory-1 "Direct link to chats:read.category") > `readonly` **category**: [`CHATS`](https://docs.gravityrail.com/sdk/enumerations/ScopeCategory.md#chats) = `ScopeCategory.CHATS` #### chats:read.description[​](#chatsdescription-1 "Direct link to chats:read.description") > `readonly` **description**: `"View all conversations"` = `'View all conversations'` #### chats:read.name[​](#chatsname-1 "Direct link to chats:read.name") > `readonly` **name**: `"chats:read"` = `'chats:read'` ### chats:write[​](#chats-2 "Direct link to chats:write") > `readonly` **chats:write**: `object` #### chats:write.category[​](#chatscategory-2 "Direct link to chats:write.category") > `readonly` **category**: [`CHATS`](https://docs.gravityrail.com/sdk/enumerations/ScopeCategory.md#chats) = `ScopeCategory.CHATS` #### chats:write.description[​](#chatsdescription-2 "Direct link to chats:write.description") > `readonly` **description**: `"Send messages in conversations"` = `'Send messages in conversations'` #### chats:write.implies[​](#chatsimplies-1 "Direct link to chats:write.implies") > `readonly` **implies**: readonly \[`"chats:read"`] #### chats:write.name[​](#chatsname-2 "Direct link to chats:write.name") > `readonly` **name**: `"chats:write"` = `'chats:write'` ### datatypes:admin[​](#datatypes "Direct link to datatypes:admin") > `readonly` **datatypes:admin**: `object` #### datatypes:admin.category[​](#datatypescategory "Direct link to datatypes:admin.category") > `readonly` **category**: [`DATATYPES`](https://docs.gravityrail.com/sdk/enumerations/ScopeCategory.md#datatypes) = `ScopeCategory.DATATYPES` #### datatypes:admin.description[​](#datatypesdescription "Direct link to datatypes:admin.description") > `readonly` **description**: `"Delete data types"` = `'Delete data types'` #### datatypes:admin.implies[​](#datatypesimplies "Direct link to datatypes:admin.implies") > `readonly` **implies**: readonly \[`"datatypes:write"`] #### datatypes:admin.name[​](#datatypesname "Direct link to datatypes:admin.name") > `readonly` **name**: `"datatypes:admin"` = `'datatypes:admin'` ### datatypes:read[​](#datatypes-1 "Direct link to datatypes:read") > `readonly` **datatypes:read**: `object` #### datatypes:read.category[​](#datatypescategory-1 "Direct link to datatypes:read.category") > `readonly` **category**: [`DATATYPES`](https://docs.gravityrail.com/sdk/enumerations/ScopeCategory.md#datatypes) = `ScopeCategory.DATATYPES` #### datatypes:read.description[​](#datatypesdescription-1 "Direct link to datatypes:read.description") > `readonly` **description**: `"View data type schemas"` = `'View data type schemas'` #### datatypes:read.name[​](#datatypesname-1 "Direct link to datatypes:read.name") > `readonly` **name**: `"datatypes:read"` = `'datatypes:read'` ### datatypes:write[​](#datatypes-2 "Direct link to datatypes:write") > `readonly` **datatypes:write**: `object` #### datatypes:write.category[​](#datatypescategory-2 "Direct link to datatypes:write.category") > `readonly` **category**: [`DATATYPES`](https://docs.gravityrail.com/sdk/enumerations/ScopeCategory.md#datatypes) = `ScopeCategory.DATATYPES` #### datatypes:write.description[​](#datatypesdescription-2 "Direct link to datatypes:write.description") > `readonly` **description**: `"Create and edit data types"` = `'Create and edit data types'` #### datatypes:write.implies[​](#datatypesimplies-1 "Direct link to datatypes:write.implies") > `readonly` **implies**: readonly \[`"datatypes:read"`] #### datatypes:write.name[​](#datatypesname-2 "Direct link to datatypes:write.name") > `readonly` **name**: `"datatypes:write"` = `'datatypes:write'` ### dm:admin[​](#dm "Direct link to dm:admin") > `readonly` **dm:admin**: `object` #### dm:admin.category[​](#dmcategory "Direct link to dm:admin.category") > `readonly` **category**: [`DM`](https://docs.gravityrail.com/sdk/enumerations/ScopeCategory.md#dm) = `ScopeCategory.DM` #### dm:admin.description[​](#dmdescription "Direct link to dm:admin.description") > `readonly` **description**: `"Delete direct messages"` = `'Delete direct messages'` #### dm:admin.implies[​](#dmimplies "Direct link to dm:admin.implies") > `readonly` **implies**: readonly \[`"dm:write"`] #### dm:admin.name[​](#dmname "Direct link to dm:admin.name") > `readonly` **name**: `"dm:admin"` = `'dm:admin'` ### dm:read[​](#dm-1 "Direct link to dm:read") > `readonly` **dm:read**: `object` #### dm:read.category[​](#dmcategory-1 "Direct link to dm:read.category") > `readonly` **category**: [`DM`](https://docs.gravityrail.com/sdk/enumerations/ScopeCategory.md#dm) = `ScopeCategory.DM` #### dm:read.description[​](#dmdescription-1 "Direct link to dm:read.description") > `readonly` **description**: `"View direct messages"` = `'View direct messages'` #### dm:read.name[​](#dmname-1 "Direct link to dm:read.name") > `readonly` **name**: `"dm:read"` = `'dm:read'` ### dm:write[​](#dm-2 "Direct link to dm:write") > `readonly` **dm:write**: `object` #### dm:write.category[​](#dmcategory-2 "Direct link to dm:write.category") > `readonly` **category**: [`DM`](https://docs.gravityrail.com/sdk/enumerations/ScopeCategory.md#dm) = `ScopeCategory.DM` #### dm:write.description[​](#dmdescription-2 "Direct link to dm:write.description") > `readonly` **description**: `"Send direct messages"` = `'Send direct messages'` #### dm:write.implies[​](#dmimplies-1 "Direct link to dm:write.implies") > `readonly` **implies**: readonly \[`"dm:read"`] #### dm:write.name[​](#dmname-2 "Direct link to dm:write.name") > `readonly` **name**: `"dm:write"` = `'dm:write'` ### experiments:admin[​](#experiments "Direct link to experiments:admin") > `readonly` **experiments:admin**: `object` #### experiments:admin.category[​](#experimentscategory "Direct link to experiments:admin.category") > `readonly` **category**: [`EXPERIMENTS`](https://docs.gravityrail.com/sdk/enumerations/ScopeCategory.md#experiments) = `ScopeCategory.EXPERIMENTS` #### experiments:admin.description[​](#experimentsdescription "Direct link to experiments:admin.description") > `readonly` **description**: `"Delete draft experiments and archive experiments"` = `'Delete draft experiments and archive experiments'` #### experiments:admin.implies[​](#experimentsimplies "Direct link to experiments:admin.implies") > `readonly` **implies**: readonly \[`"experiments:write"`] #### experiments:admin.name[​](#experimentsname "Direct link to experiments:admin.name") > `readonly` **name**: `"experiments:admin"` = `'experiments:admin'` ### experiments:read[​](#experiments-1 "Direct link to experiments:read") > `readonly` **experiments:read**: `object` #### experiments:read.category[​](#experimentscategory-1 "Direct link to experiments:read.category") > `readonly` **category**: [`EXPERIMENTS`](https://docs.gravityrail.com/sdk/enumerations/ScopeCategory.md#experiments) = `ScopeCategory.EXPERIMENTS` #### experiments:read.description[​](#experimentsdescription-1 "Direct link to experiments:read.description") > `readonly` **description**: `"View experiments and assignments"` = `'View experiments and assignments'` #### experiments:read.name[​](#experimentsname-1 "Direct link to experiments:read.name") > `readonly` **name**: `"experiments:read"` = `'experiments:read'` ### experiments:write[​](#experiments-2 "Direct link to experiments:write") > `readonly` **experiments:write**: `object` #### experiments:write.category[​](#experimentscategory-2 "Direct link to experiments:write.category") > `readonly` **category**: [`EXPERIMENTS`](https://docs.gravityrail.com/sdk/enumerations/ScopeCategory.md#experiments) = `ScopeCategory.EXPERIMENTS` #### experiments:write.description[​](#experimentsdescription-2 "Direct link to experiments:write.description") > `readonly` **description**: `"Create and edit experiments"` = `'Create and edit experiments'` #### experiments:write.implies[​](#experimentsimplies-1 "Direct link to experiments:write.implies") > `readonly` **implies**: readonly \[`"experiments:read"`] #### experiments:write.name[​](#experimentsname-2 "Direct link to experiments:write.name") > `readonly` **name**: `"experiments:write"` = `'experiments:write'` ### export:admin[​](#export "Direct link to export:admin") > `readonly` **export:admin**: `object` #### export:admin.category[​](#exportcategory "Direct link to export:admin.category") > `readonly` **category**: [`EXPORT`](https://docs.gravityrail.com/sdk/enumerations/ScopeCategory.md#export) = `ScopeCategory.EXPORT` #### export:admin.dangerous[​](#exportdangerous "Direct link to export:admin.dangerous") > `readonly` **dangerous**: `true` = `true` #### export:admin.description[​](#exportdescription "Direct link to export:admin.description") > `readonly` **description**: `"Export all data including sensitive information"` = `'Export all data including sensitive information'` #### export:admin.implies[​](#exportimplies "Direct link to export:admin.implies") > `readonly` **implies**: readonly \[`"export:write"`] #### export:admin.name[​](#exportname "Direct link to export:admin.name") > `readonly` **name**: `"export:admin"` = `'export:admin'` ### export:read[​](#export-1 "Direct link to export:read") > `readonly` **export:read**: `object` #### export:read.category[​](#exportcategory-1 "Direct link to export:read.category") > `readonly` **category**: [`EXPORT`](https://docs.gravityrail.com/sdk/enumerations/ScopeCategory.md#export) = `ScopeCategory.EXPORT` #### export:read.description[​](#exportdescription-1 "Direct link to export:read.description") > `readonly` **description**: `"Export workspace data"` = `'Export workspace data'` #### export:read.name[​](#exportname-1 "Direct link to export:read.name") > `readonly` **name**: `"export:read"` = `'export:read'` ### export:write[​](#export-2 "Direct link to export:write") > `readonly` **export:write**: `object` #### export:write.category[​](#exportcategory-2 "Direct link to export:write.category") > `readonly` **category**: [`EXPORT`](https://docs.gravityrail.com/sdk/enumerations/ScopeCategory.md#export) = `ScopeCategory.EXPORT` #### export:write.description[​](#exportdescription-2 "Direct link to export:write.description") > `readonly` **description**: `"Export workspace data"` = `'Export workspace data'` #### export:write.implies[​](#exportimplies-1 "Direct link to export:write.implies") > `readonly` **implies**: readonly \[`"export:read"`] #### export:write.name[​](#exportname-2 "Direct link to export:write.name") > `readonly` **name**: `"export:write"` = `'export:write'` ### files:admin[​](#files "Direct link to files:admin") > `readonly` **files:admin**: `object` #### files:admin.category[​](#filescategory "Direct link to files:admin.category") > `readonly` **category**: [`FILES`](https://docs.gravityrail.com/sdk/enumerations/ScopeCategory.md#files) = `ScopeCategory.FILES` #### files:admin.description[​](#filesdescription "Direct link to files:admin.description") > `readonly` **description**: `"Delete files"` = `'Delete files'` #### files:admin.implies[​](#filesimplies "Direct link to files:admin.implies") > `readonly` **implies**: readonly \[`"files:write"`] #### files:admin.name[​](#filesname "Direct link to files:admin.name") > `readonly` **name**: `"files:admin"` = `'files:admin'` ### files:read[​](#files-1 "Direct link to files:read") > `readonly` **files:read**: `object` #### files:read.category[​](#filescategory-1 "Direct link to files:read.category") > `readonly` **category**: [`FILES`](https://docs.gravityrail.com/sdk/enumerations/ScopeCategory.md#files) = `ScopeCategory.FILES` #### files:read.description[​](#filesdescription-1 "Direct link to files:read.description") > `readonly` **description**: `"View all files"` = `'View all files'` #### files:read.name[​](#filesname-1 "Direct link to files:read.name") > `readonly` **name**: `"files:read"` = `'files:read'` ### files:write[​](#files-2 "Direct link to files:write") > `readonly` **files:write**: `object` #### files:write.category[​](#filescategory-2 "Direct link to files:write.category") > `readonly` **category**: [`FILES`](https://docs.gravityrail.com/sdk/enumerations/ScopeCategory.md#files) = `ScopeCategory.FILES` #### files:write.description[​](#filesdescription-2 "Direct link to files:write.description") > `readonly` **description**: `"Upload and modify files"` = `'Upload and modify files'` #### files:write.implies[​](#filesimplies-1 "Direct link to files:write.implies") > `readonly` **implies**: readonly \[`"files:read"`] #### files:write.name[​](#filesname-2 "Direct link to files:write.name") > `readonly` **name**: `"files:write"` = `'files:write'` ### inboxes:admin[​](#inboxes "Direct link to inboxes:admin") > `readonly` **inboxes:admin**: `object` #### inboxes:admin.category[​](#inboxescategory "Direct link to inboxes:admin.category") > `readonly` **category**: [`INBOXES`](https://docs.gravityrail.com/sdk/enumerations/ScopeCategory.md#inboxes) = `ScopeCategory.INBOXES` #### inboxes:admin.description[​](#inboxesdescription "Direct link to inboxes:admin.description") > `readonly` **description**: `"Delete inboxes"` = `'Delete inboxes'` #### inboxes:admin.implies[​](#inboxesimplies "Direct link to inboxes:admin.implies") > `readonly` **implies**: readonly \[`"inboxes:write"`] #### inboxes:admin.name[​](#inboxesname "Direct link to inboxes:admin.name") > `readonly` **name**: `"inboxes:admin"` = `'inboxes:admin'` ### inboxes:read[​](#inboxes-1 "Direct link to inboxes:read") > `readonly` **inboxes:read**: `object` #### inboxes:read.category[​](#inboxescategory-1 "Direct link to inboxes:read.category") > `readonly` **category**: [`INBOXES`](https://docs.gravityrail.com/sdk/enumerations/ScopeCategory.md#inboxes) = `ScopeCategory.INBOXES` #### inboxes:read.description[​](#inboxesdescription-1 "Direct link to inboxes:read.description") > `readonly` **description**: `"View inbox configurations"` = `'View inbox configurations'` #### inboxes:read.name[​](#inboxesname-1 "Direct link to inboxes:read.name") > `readonly` **name**: `"inboxes:read"` = `'inboxes:read'` ### inboxes:write[​](#inboxes-2 "Direct link to inboxes:write") > `readonly` **inboxes:write**: `object` #### inboxes:write.category[​](#inboxescategory-2 "Direct link to inboxes:write.category") > `readonly` **category**: [`INBOXES`](https://docs.gravityrail.com/sdk/enumerations/ScopeCategory.md#inboxes) = `ScopeCategory.INBOXES` #### inboxes:write.description[​](#inboxesdescription-2 "Direct link to inboxes:write.description") > `readonly` **description**: `"Configure inboxes"` = `'Configure inboxes'` #### inboxes:write.implies[​](#inboxesimplies-1 "Direct link to inboxes:write.implies") > `readonly` **implies**: readonly \[`"inboxes:read"`] #### inboxes:write.name[​](#inboxesname-2 "Direct link to inboxes:write.name") > `readonly` **name**: `"inboxes:write"` = `'inboxes:write'` ### journeys:admin[​](#journeys "Direct link to journeys:admin") > `readonly` **journeys:admin**: `object` #### journeys:admin.category[​](#journeyscategory "Direct link to journeys:admin.category") > `readonly` **category**: [`JOURNEYS`](https://docs.gravityrail.com/sdk/enumerations/ScopeCategory.md#journeys) = `ScopeCategory.JOURNEYS` #### journeys:admin.description[​](#journeysdescription "Direct link to journeys:admin.description") > `readonly` **description**: `"Delete journeys"` = `'Delete journeys'` #### journeys:admin.implies[​](#journeysimplies "Direct link to journeys:admin.implies") > `readonly` **implies**: readonly \[`"journeys:write"`] #### journeys:admin.name[​](#journeysname "Direct link to journeys:admin.name") > `readonly` **name**: `"journeys:admin"` = `'journeys:admin'` ### journeys:read[​](#journeys-1 "Direct link to journeys:read") > `readonly` **journeys:read**: `object` #### journeys:read.category[​](#journeyscategory-1 "Direct link to journeys:read.category") > `readonly` **category**: [`JOURNEYS`](https://docs.gravityrail.com/sdk/enumerations/ScopeCategory.md#journeys) = `ScopeCategory.JOURNEYS` #### journeys:read.description[​](#journeysdescription-1 "Direct link to journeys:read.description") > `readonly` **description**: `"View journey definitions"` = `'View journey definitions'` #### journeys:read.name[​](#journeysname-1 "Direct link to journeys:read.name") > `readonly` **name**: `"journeys:read"` = `'journeys:read'` ### journeys:write[​](#journeys-2 "Direct link to journeys:write") > `readonly` **journeys:write**: `object` #### journeys:write.category[​](#journeyscategory-2 "Direct link to journeys:write.category") > `readonly` **category**: [`JOURNEYS`](https://docs.gravityrail.com/sdk/enumerations/ScopeCategory.md#journeys) = `ScopeCategory.JOURNEYS` #### journeys:write.description[​](#journeysdescription-2 "Direct link to journeys:write.description") > `readonly` **description**: `"Create and edit journeys"` = `'Create and edit journeys'` #### journeys:write.implies[​](#journeysimplies-1 "Direct link to journeys:write.implies") > `readonly` **implies**: readonly \[`"journeys:read"`] #### journeys:write.name[​](#journeysname-2 "Direct link to journeys:write.name") > `readonly` **name**: `"journeys:write"` = `'journeys:write'` ### labels:read[​](#labels "Direct link to labels:read") > `readonly` **labels:read**: `object` #### labels:read.category[​](#labelscategory "Direct link to labels:read.category") > `readonly` **category**: [`LABELS`](https://docs.gravityrail.com/sdk/enumerations/ScopeCategory.md#labels) = `ScopeCategory.LABELS` #### labels:read.description[​](#labelsdescription "Direct link to labels:read.description") > `readonly` **description**: `"View labels"` = `'View labels'` #### labels:read.name[​](#labelsname "Direct link to labels:read.name") > `readonly` **name**: `"labels:read"` = `'labels:read'` ### labels:write[​](#labels-1 "Direct link to labels:write") > `readonly` **labels:write**: `object` #### labels:write.category[​](#labelscategory-1 "Direct link to labels:write.category") > `readonly` **category**: [`LABELS`](https://docs.gravityrail.com/sdk/enumerations/ScopeCategory.md#labels) = `ScopeCategory.LABELS` #### labels:write.description[​](#labelsdescription-1 "Direct link to labels:write.description") > `readonly` **description**: `"Deprecated — label mutations now require the parent resource write scope (members:write, chats:write, files:write)"` = `'Deprecated — label mutations now require the parent resource write scope (members:write, chats:write, files:write)'` #### labels:write.implies[​](#labelsimplies "Direct link to labels:write.implies") > `readonly` **implies**: readonly \[`"labels:read"`] #### labels:write.name[​](#labelsname-1 "Direct link to labels:write.name") > `readonly` **name**: `"labels:write"` = `'labels:write'` ### member\_roles:admin[​](#member_roles "Direct link to member_roles:admin") > `readonly` **member\_roles:admin**: `object` #### member\_roles:admin.category[​](#member_rolescategory "Direct link to member_roles:admin.category") > `readonly` **category**: [`MEMBER_ROLES`](https://docs.gravityrail.com/sdk/enumerations/ScopeCategory.md#member_roles) = `ScopeCategory.MEMBER_ROLES` #### member\_roles:admin.dangerous[​](#member_rolesdangerous "Direct link to member_roles:admin.dangerous") > `readonly` **dangerous**: `true` = `true` #### member\_roles:admin.description[​](#member_rolesdescription "Direct link to member_roles:admin.description") > `readonly` **description**: `"Delete roles"` = `'Delete roles'` #### member\_roles:admin.implies[​](#member_rolesimplies "Direct link to member_roles:admin.implies") > `readonly` **implies**: readonly \[`"member_roles:write"`] #### member\_roles:admin.name[​](#member_rolesname "Direct link to member_roles:admin.name") > `readonly` **name**: `"member_roles:admin"` = `'member_roles:admin'` ### member\_roles:read[​](#member_roles-1 "Direct link to member_roles:read") > `readonly` **member\_roles:read**: `object` #### member\_roles:read.category[​](#member_rolescategory-1 "Direct link to member_roles:read.category") > `readonly` **category**: [`MEMBER_ROLES`](https://docs.gravityrail.com/sdk/enumerations/ScopeCategory.md#member_roles) = `ScopeCategory.MEMBER_ROLES` #### member\_roles:read.description[​](#member_rolesdescription-1 "Direct link to member_roles:read.description") > `readonly` **description**: `"View role definitions"` = `'View role definitions'` #### member\_roles:read.name[​](#member_rolesname-1 "Direct link to member_roles:read.name") > `readonly` **name**: `"member_roles:read"` = `'member_roles:read'` ### member\_roles:write[​](#member_roles-2 "Direct link to member_roles:write") > `readonly` **member\_roles:write**: `object` #### member\_roles:write.category[​](#member_rolescategory-2 "Direct link to member_roles:write.category") > `readonly` **category**: [`MEMBER_ROLES`](https://docs.gravityrail.com/sdk/enumerations/ScopeCategory.md#member_roles) = `ScopeCategory.MEMBER_ROLES` #### member\_roles:write.description[​](#member_rolesdescription-2 "Direct link to member_roles:write.description") > `readonly` **description**: `"Create and edit roles"` = `'Create and edit roles'` #### member\_roles:write.implies[​](#member_rolesimplies-1 "Direct link to member_roles:write.implies") > `readonly` **implies**: readonly \[`"member_roles:read"`] #### member\_roles:write.name[​](#member_rolesname-2 "Direct link to member_roles:write.name") > `readonly` **name**: `"member_roles:write"` = `'member_roles:write'` ### members:admin[​](#members "Direct link to members:admin") > `readonly` **members:admin**: `object` #### members:admin.category[​](#memberscategory "Direct link to members:admin.category") > `readonly` **category**: [`MEMBERS`](https://docs.gravityrail.com/sdk/enumerations/ScopeCategory.md#members) = `ScopeCategory.MEMBERS` #### members:admin.dangerous[​](#membersdangerous "Direct link to members:admin.dangerous") > `readonly` **dangerous**: `true` = `true` #### members:admin.description[​](#membersdescription "Direct link to members:admin.description") > `readonly` **description**: `"Delete members, manage permissions"` = `'Delete members, manage permissions'` #### members:admin.implies[​](#membersimplies "Direct link to members:admin.implies") > `readonly` **implies**: readonly \[`"members:write"`] #### members:admin.name[​](#membersname "Direct link to members:admin.name") > `readonly` **name**: `"members:admin"` = `'members:admin'` ### members:read[​](#members-1 "Direct link to members:read") > `readonly` **members:read**: `object` #### members:read.category[​](#memberscategory-1 "Direct link to members:read.category") > `readonly` **category**: [`MEMBERS`](https://docs.gravityrail.com/sdk/enumerations/ScopeCategory.md#members) = `ScopeCategory.MEMBERS` #### members:read.description[​](#membersdescription-1 "Direct link to members:read.description") > `readonly` **description**: `"View all members"` = `'View all members'` #### members:read.name[​](#membersname-1 "Direct link to members:read.name") > `readonly` **name**: `"members:read"` = `'members:read'` ### members:write[​](#members-2 "Direct link to members:write") > `readonly` **members:write**: `object` #### members:write.category[​](#memberscategory-2 "Direct link to members:write.category") > `readonly` **category**: [`MEMBERS`](https://docs.gravityrail.com/sdk/enumerations/ScopeCategory.md#members) = `ScopeCategory.MEMBERS` #### members:write.description[​](#membersdescription-2 "Direct link to members:write.description") > `readonly` **description**: `"Create and update members"` = `'Create and update members'` #### members:write.implies[​](#membersimplies-1 "Direct link to members:write.implies") > `readonly` **implies**: readonly \[`"members:read"`] #### members:write.name[​](#membersname-2 "Direct link to members:write.name") > `readonly` **name**: `"members:write"` = `'members:write'` ### operator:read[​](#operator "Direct link to operator:read") > `readonly` **operator:read**: `object` #### operator:read.category[​](#operatorcategory "Direct link to operator:read.category") > `readonly` **category**: [`OPERATOR`](https://docs.gravityrail.com/sdk/enumerations/ScopeCategory.md#operator) = `ScopeCategory.OPERATOR` #### operator:read.description[​](#operatordescription "Direct link to operator:read.description") > `readonly` **description**: `"View operator dashboard and listen in"` = `'View operator dashboard and listen in'` #### operator:read.name[​](#operatorname "Direct link to operator:read.name") > `readonly` **name**: `"operator:read"` = `'operator:read'` ### operator:write[​](#operator-1 "Direct link to operator:write") > `readonly` **operator:write**: `object` #### operator:write.category[​](#operatorcategory-1 "Direct link to operator:write.category") > `readonly` **category**: [`OPERATOR`](https://docs.gravityrail.com/sdk/enumerations/ScopeCategory.md#operator) = `ScopeCategory.OPERATOR` #### operator:write.description[​](#operatordescription-1 "Direct link to operator:write.description") > `readonly` **description**: `"Go Live and handle interactions as an operator"` = `'Go Live and handle interactions as an operator'` #### operator:write.implies[​](#operatorimplies "Direct link to operator:write.implies") > `readonly` **implies**: readonly \[`"operator:read"`] #### operator:write.name[​](#operatorname-1 "Direct link to operator:write.name") > `readonly` **name**: `"operator:write"` = `'operator:write'` ### org:admin[​](#org "Direct link to org:admin") > `readonly` **org:admin**: `object` #### org:admin.category[​](#orgcategory "Direct link to org:admin.category") > `readonly` **category**: [`ORG`](https://docs.gravityrail.com/sdk/enumerations/ScopeCategory.md#org) = `ScopeCategory.ORG` #### org:admin.dangerous[​](#orgdangerous "Direct link to org:admin.dangerous") > `readonly` **dangerous**: `true` = `true` #### org:admin.description[​](#orgdescription "Direct link to org:admin.description") > `readonly` **description**: `"Full org management"` = `'Full org management'` #### org:admin.implies[​](#orgimplies "Direct link to org:admin.implies") > `readonly` **implies**: readonly \[`"org:write"`] #### org:admin.name[​](#orgname "Direct link to org:admin.name") > `readonly` **name**: `"org:admin"` = `'org:admin'` ### org:delete[​](#org-1 "Direct link to org:delete") > `readonly` **org:delete**: `object` #### org:delete.category[​](#orgcategory-1 "Direct link to org:delete.category") > `readonly` **category**: [`ORG`](https://docs.gravityrail.com/sdk/enumerations/ScopeCategory.md#org) = `ScopeCategory.ORG` #### org:delete.dangerous[​](#orgdangerous-1 "Direct link to org:delete.dangerous") > `readonly` **dangerous**: `true` = `true` #### org:delete.description[​](#orgdescription-1 "Direct link to org:delete.description") > `readonly` **description**: `"Delete organization (owner only)"` = `'Delete organization (owner only)'` #### org:delete.implies[​](#orgimplies-1 "Direct link to org:delete.implies") > `readonly` **implies**: readonly \[`"org:admin"`] #### org:delete.name[​](#orgname-1 "Direct link to org:delete.name") > `readonly` **name**: `"org:delete"` = `'org:delete'` ### org:info[​](#org-2 "Direct link to org:info") > `readonly` **org:info**: `object` #### org:info.category[​](#orgcategory-2 "Direct link to org:info.category") > `readonly` **category**: [`ORG`](https://docs.gravityrail.com/sdk/enumerations/ScopeCategory.md#org) = `ScopeCategory.ORG` #### org:info.description[​](#orgdescription-2 "Direct link to org:info.description") > `readonly` **description**: `"View basic org info and own workspaces"` = `'View basic org info and own workspaces'` #### org:info.name[​](#orgname-2 "Direct link to org:info.name") > `readonly` **name**: `"org:info"` = `'org:info'` ### org:manage\_admins[​](#org_admins "Direct link to org:manage_admins") > `readonly` **org:manage\_admins**: `object` #### org:manage\_admins.category[​](#org_adminscategory "Direct link to org:manage_admins.category") > `readonly` **category**: [`ORG`](https://docs.gravityrail.com/sdk/enumerations/ScopeCategory.md#org) = `ScopeCategory.ORG` #### org:manage\_admins.dangerous[​](#org_adminsdangerous "Direct link to org:manage_admins.dangerous") > `readonly` **dangerous**: `true` = `true` #### org:manage\_admins.description[​](#org_adminsdescription "Direct link to org:manage_admins.description") > `readonly` **description**: `"Assign admin and owner roles (owner only)"` = `'Assign admin and owner roles (owner only)'` #### org:manage\_admins.implies[​](#org_adminsimplies "Direct link to org:manage_admins.implies") > `readonly` **implies**: readonly \[`"org:admin"`] #### org:manage\_admins.name[​](#org_adminsname "Direct link to org:manage_admins.name") > `readonly` **name**: `"org:manage_admins"` = `'org:manage_admins'` ### org:read[​](#org-3 "Direct link to org:read") > `readonly` **org:read**: `object` #### org:read.category[​](#orgcategory-3 "Direct link to org:read.category") > `readonly` **category**: [`ORG`](https://docs.gravityrail.com/sdk/enumerations/ScopeCategory.md#org) = `ScopeCategory.ORG` #### org:read.description[​](#orgdescription-3 "Direct link to org:read.description") > `readonly` **description**: `"View org info"` = `'View org info'` #### org:read.implies[​](#orgimplies-2 "Direct link to org:read.implies") > `readonly` **implies**: readonly \[`"org:info"`] #### org:read.name[​](#orgname-3 "Direct link to org:read.name") > `readonly` **name**: `"org:read"` = `'org:read'` ### org:write[​](#org-4 "Direct link to org:write") > `readonly` **org:write**: `object` #### org:write.category[​](#orgcategory-4 "Direct link to org:write.category") > `readonly` **category**: [`ORG`](https://docs.gravityrail.com/sdk/enumerations/ScopeCategory.md#org) = `ScopeCategory.ORG` #### org:write.description[​](#orgdescription-4 "Direct link to org:write.description") > `readonly` **description**: `"Update org settings"` = `'Update org settings'` #### org:write.implies[​](#orgimplies-3 "Direct link to org:write.implies") > `readonly` **implies**: readonly \[`"org:read"`] #### org:write.name[​](#orgname-4 "Direct link to org:write.name") > `readonly` **name**: `"org:write"` = `'org:write'` ### phones:admin[​](#phones "Direct link to phones:admin") > `readonly` **phones:admin**: `object` #### phones:admin.category[​](#phonescategory "Direct link to phones:admin.category") > `readonly` **category**: [`PHONES`](https://docs.gravityrail.com/sdk/enumerations/ScopeCategory.md#phones) = `ScopeCategory.PHONES` #### phones:admin.description[​](#phonesdescription "Direct link to phones:admin.description") > `readonly` **description**: `"Delete phone numbers"` = `'Delete phone numbers'` #### phones:admin.implies[​](#phonesimplies "Direct link to phones:admin.implies") > `readonly` **implies**: readonly \[`"phones:write"`] #### phones:admin.name[​](#phonesname "Direct link to phones:admin.name") > `readonly` **name**: `"phones:admin"` = `'phones:admin'` ### phones:read[​](#phones-1 "Direct link to phones:read") > `readonly` **phones:read**: `object` #### phones:read.category[​](#phonescategory-1 "Direct link to phones:read.category") > `readonly` **category**: [`PHONES`](https://docs.gravityrail.com/sdk/enumerations/ScopeCategory.md#phones) = `ScopeCategory.PHONES` #### phones:read.description[​](#phonesdescription-1 "Direct link to phones:read.description") > `readonly` **description**: `"View phone numbers"` = `'View phone numbers'` #### phones:read.name[​](#phonesname-1 "Direct link to phones:read.name") > `readonly` **name**: `"phones:read"` = `'phones:read'` ### phones:write[​](#phones-2 "Direct link to phones:write") > `readonly` **phones:write**: `object` #### phones:write.category[​](#phonescategory-2 "Direct link to phones:write.category") > `readonly` **category**: [`PHONES`](https://docs.gravityrail.com/sdk/enumerations/ScopeCategory.md#phones) = `ScopeCategory.PHONES` #### phones:write.description[​](#phonesdescription-2 "Direct link to phones:write.description") > `readonly` **description**: `"Configure phone numbers"` = `'Configure phone numbers'` #### phones:write.implies[​](#phonesimplies-1 "Direct link to phones:write.implies") > `readonly` **implies**: readonly \[`"phones:read"`] #### phones:write.name[​](#phonesname-2 "Direct link to phones:write.name") > `readonly` **name**: `"phones:write"` = `'phones:write'` ### records:admin[​](#records "Direct link to records:admin") > `readonly` **records:admin**: `object` #### records:admin.category[​](#recordscategory "Direct link to records:admin.category") > `readonly` **category**: [`RECORDS`](https://docs.gravityrail.com/sdk/enumerations/ScopeCategory.md#records) = `ScopeCategory.RECORDS` #### records:admin.description[​](#recordsdescription "Direct link to records:admin.description") > `readonly` **description**: `"Delete records"` = `'Delete records'` #### records:admin.implies[​](#recordsimplies "Direct link to records:admin.implies") > `readonly` **implies**: readonly \[`"records:write"`] #### records:admin.name[​](#recordsname "Direct link to records:admin.name") > `readonly` **name**: `"records:admin"` = `'records:admin'` ### records:read[​](#records-1 "Direct link to records:read") > `readonly` **records:read**: `object` #### records:read.category[​](#recordscategory-1 "Direct link to records:read.category") > `readonly` **category**: [`RECORDS`](https://docs.gravityrail.com/sdk/enumerations/ScopeCategory.md#records) = `ScopeCategory.RECORDS` #### records:read.description[​](#recordsdescription-1 "Direct link to records:read.description") > `readonly` **description**: `"View all data records"` = `'View all data records'` #### records:read.name[​](#recordsname-1 "Direct link to records:read.name") > `readonly` **name**: `"records:read"` = `'records:read'` ### records:write[​](#records-2 "Direct link to records:write") > `readonly` **records:write**: `object` #### records:write.category[​](#recordscategory-2 "Direct link to records:write.category") > `readonly` **category**: [`RECORDS`](https://docs.gravityrail.com/sdk/enumerations/ScopeCategory.md#records) = `ScopeCategory.RECORDS` #### records:write.description[​](#recordsdescription-2 "Direct link to records:write.description") > `readonly` **description**: `"Create and modify records"` = `'Create and modify records'` #### records:write.implies[​](#recordsimplies-1 "Direct link to records:write.implies") > `readonly` **implies**: readonly \[`"records:read"`] #### records:write.name[​](#recordsname-2 "Direct link to records:write.name") > `readonly` **name**: `"records:write"` = `'records:write'` ### sites:admin[​](#sites "Direct link to sites:admin") > `readonly` **sites:admin**: `object` #### sites:admin.category[​](#sitescategory "Direct link to sites:admin.category") > `readonly` **category**: [`SITES`](https://docs.gravityrail.com/sdk/enumerations/ScopeCategory.md#sites) = `ScopeCategory.SITES` #### sites:admin.description[​](#sitesdescription "Direct link to sites:admin.description") > `readonly` **description**: `"Delete sites"` = `'Delete sites'` #### sites:admin.implies[​](#sitesimplies "Direct link to sites:admin.implies") > `readonly` **implies**: readonly \[`"sites:write"`] #### sites:admin.name[​](#sitesname "Direct link to sites:admin.name") > `readonly` **name**: `"sites:admin"` = `'sites:admin'` ### sites:read[​](#sites-1 "Direct link to sites:read") > `readonly` **sites:read**: `object` #### sites:read.category[​](#sitescategory-1 "Direct link to sites:read.category") > `readonly` **category**: [`SITES`](https://docs.gravityrail.com/sdk/enumerations/ScopeCategory.md#sites) = `ScopeCategory.SITES` #### sites:read.description[​](#sitesdescription-1 "Direct link to sites:read.description") > `readonly` **description**: `"View site configurations"` = `'View site configurations'` #### sites:read.name[​](#sitesname-1 "Direct link to sites:read.name") > `readonly` **name**: `"sites:read"` = `'sites:read'` ### sites:write[​](#sites-2 "Direct link to sites:write") > `readonly` **sites:write**: `object` #### sites:write.category[​](#sitescategory-2 "Direct link to sites:write.category") > `readonly` **category**: [`SITES`](https://docs.gravityrail.com/sdk/enumerations/ScopeCategory.md#sites) = `ScopeCategory.SITES` #### sites:write.description[​](#sitesdescription-2 "Direct link to sites:write.description") > `readonly` **description**: `"Create and edit sites"` = `'Create and edit sites'` #### sites:write.implies[​](#sitesimplies-1 "Direct link to sites:write.implies") > `readonly` **implies**: readonly \[`"sites:read"`] #### sites:write.name[​](#sitesname-2 "Direct link to sites:write.name") > `readonly` **name**: `"sites:write"` = `'sites:write'` ### webhooks:admin[​](#webhooks "Direct link to webhooks:admin") > `readonly` **webhooks:admin**: `object` #### webhooks:admin.category[​](#webhookscategory "Direct link to webhooks:admin.category") > `readonly` **category**: [`WEBHOOKS`](https://docs.gravityrail.com/sdk/enumerations/ScopeCategory.md#webhooks) = `ScopeCategory.WEBHOOKS` #### webhooks:admin.description[​](#webhooksdescription "Direct link to webhooks:admin.description") > `readonly` **description**: `"Delete webhooks"` = `'Delete webhooks'` #### webhooks:admin.implies[​](#webhooksimplies "Direct link to webhooks:admin.implies") > `readonly` **implies**: readonly \[`"webhooks:write"`] #### webhooks:admin.name[​](#webhooksname "Direct link to webhooks:admin.name") > `readonly` **name**: `"webhooks:admin"` = `'webhooks:admin'` ### webhooks:raw[​](#webhooks-1 "Direct link to webhooks:raw") > `readonly` **webhooks:raw**: `object` #### webhooks:raw\.category[​](#webhookscategory-1 "Direct link to webhooks:raw.category") > `readonly` **category**: [`WEBHOOKS`](https://docs.gravityrail.com/sdk/enumerations/ScopeCategory.md#webhooks) = `ScopeCategory.WEBHOOKS` #### webhooks:raw\.description[​](#webhooksdescription-1 "Direct link to webhooks:raw.description") > `readonly` **description**: `"Access raw webhook payloads"` = `'Access raw webhook payloads'` #### webhooks:raw\.name[​](#webhooksname-1 "Direct link to webhooks:raw.name") > `readonly` **name**: `"webhooks:raw"` = `'webhooks:raw'` ### webhooks:read[​](#webhooks-2 "Direct link to webhooks:read") > `readonly` **webhooks:read**: `object` #### webhooks:read.category[​](#webhookscategory-2 "Direct link to webhooks:read.category") > `readonly` **category**: [`WEBHOOKS`](https://docs.gravityrail.com/sdk/enumerations/ScopeCategory.md#webhooks) = `ScopeCategory.WEBHOOKS` #### webhooks:read.description[​](#webhooksdescription-2 "Direct link to webhooks:read.description") > `readonly` **description**: `"View webhook logs"` = `'View webhook logs'` #### webhooks:read.name[​](#webhooksname-2 "Direct link to webhooks:read.name") > `readonly` **name**: `"webhooks:read"` = `'webhooks:read'` ### webhooks:write[​](#webhooks-3 "Direct link to webhooks:write") > `readonly` **webhooks:write**: `object` #### webhooks:write.category[​](#webhookscategory-3 "Direct link to webhooks:write.category") > `readonly` **category**: [`WEBHOOKS`](https://docs.gravityrail.com/sdk/enumerations/ScopeCategory.md#webhooks) = `ScopeCategory.WEBHOOKS` #### webhooks:write.description[​](#webhooksdescription-3 "Direct link to webhooks:write.description") > `readonly` **description**: `"Configure webhooks"` = `'Configure webhooks'` #### webhooks:write.implies[​](#webhooksimplies-1 "Direct link to webhooks:write.implies") > `readonly` **implies**: readonly \[`"webhooks:read"`] #### webhooks:write.name[​](#webhooksname-3 "Direct link to webhooks:write.name") > `readonly` **name**: `"webhooks:write"` = `'webhooks:write'` ### workflows:admin[​](#workflows "Direct link to workflows:admin") > `readonly` **workflows:admin**: `object` #### workflows:admin.category[​](#workflowscategory "Direct link to workflows:admin.category") > `readonly` **category**: [`WORKFLOWS`](https://docs.gravityrail.com/sdk/enumerations/ScopeCategory.md#workflows) = `ScopeCategory.WORKFLOWS` #### workflows:admin.description[​](#workflowsdescription "Direct link to workflows:admin.description") > `readonly` **description**: `"Delete workflows"` = `'Delete workflows'` #### workflows:admin.implies[​](#workflowsimplies "Direct link to workflows:admin.implies") > `readonly` **implies**: readonly \[`"workflows:write"`] #### workflows:admin.name[​](#workflowsname "Direct link to workflows:admin.name") > `readonly` **name**: `"workflows:admin"` = `'workflows:admin'` ### workflows:read[​](#workflows-1 "Direct link to workflows:read") > `readonly` **workflows:read**: `object` #### workflows:read.category[​](#workflowscategory-1 "Direct link to workflows:read.category") > `readonly` **category**: [`WORKFLOWS`](https://docs.gravityrail.com/sdk/enumerations/ScopeCategory.md#workflows) = `ScopeCategory.WORKFLOWS` #### workflows:read.description[​](#workflowsdescription-1 "Direct link to workflows:read.description") > `readonly` **description**: `"View workflow definitions"` = `'View workflow definitions'` #### workflows:read.name[​](#workflowsname-1 "Direct link to workflows:read.name") > `readonly` **name**: `"workflows:read"` = `'workflows:read'` ### workflows:write[​](#workflows-2 "Direct link to workflows:write") > `readonly` **workflows:write**: `object` #### workflows:write.category[​](#workflowscategory-2 "Direct link to workflows:write.category") > `readonly` **category**: [`WORKFLOWS`](https://docs.gravityrail.com/sdk/enumerations/ScopeCategory.md#workflows) = `ScopeCategory.WORKFLOWS` #### workflows:write.description[​](#workflowsdescription-2 "Direct link to workflows:write.description") > `readonly` **description**: `"Create and edit workflows"` = `'Create and edit workflows'` #### workflows:write.implies[​](#workflowsimplies-1 "Direct link to workflows:write.implies") > `readonly` **implies**: readonly \[`"workflows:read"`] #### workflows:write.name[​](#workflowsname-2 "Direct link to workflows:write.name") > `readonly` **name**: `"workflows:write"` = `'workflows:write'` ### workspace:admin[​](#workspace "Direct link to workspace:admin") > `readonly` **workspace:admin**: `object` #### workspace:admin.category[​](#workspacecategory "Direct link to workspace:admin.category") > `readonly` **category**: [`WORKSPACE`](https://docs.gravityrail.com/sdk/enumerations/ScopeCategory.md#workspace) = `ScopeCategory.WORKSPACE` #### workspace:admin.dangerous[​](#workspacedangerous "Direct link to workspace:admin.dangerous") > `readonly` **dangerous**: `true` = `true` #### workspace:admin.description[​](#workspacedescription "Direct link to workspace:admin.description") > `readonly` **description**: `"Full workspace control"` = `'Full workspace control'` #### workspace:admin.implies[​](#workspaceimplies "Direct link to workspace:admin.implies") > `readonly` **implies**: readonly \[`"workspace:write"`] #### workspace:admin.name[​](#workspacename "Direct link to workspace:admin.name") > `readonly` **name**: `"workspace:admin"` = `'workspace:admin'` ### workspace:read[​](#workspace-1 "Direct link to workspace:read") > `readonly` **workspace:read**: `object` #### workspace:read.category[​](#workspacecategory-1 "Direct link to workspace:read.category") > `readonly` **category**: [`WORKSPACE`](https://docs.gravityrail.com/sdk/enumerations/ScopeCategory.md#workspace) = `ScopeCategory.WORKSPACE` #### workspace:read.description[​](#workspacedescription-1 "Direct link to workspace:read.description") > `readonly` **description**: `"View workspace settings"` = `'View workspace settings'` #### workspace:read.name[​](#workspacename-1 "Direct link to workspace:read.name") > `readonly` **name**: `"workspace:read"` = `'workspace:read'` ### workspace:write[​](#workspace-2 "Direct link to workspace:write") > `readonly` **workspace:write**: `object` #### workspace:write.category[​](#workspacecategory-2 "Direct link to workspace:write.category") > `readonly` **category**: [`WORKSPACE`](https://docs.gravityrail.com/sdk/enumerations/ScopeCategory.md#workspace) = `ScopeCategory.WORKSPACE` #### workspace:write.description[​](#workspacedescription-2 "Direct link to workspace:write.description") > `readonly` **description**: `"Modify workspace settings"` = `'Modify workspace settings'` #### workspace:write.implies[​](#workspaceimplies-1 "Direct link to workspace:write.implies") > `readonly` **implies**: readonly \[`"workspace:read"`] #### workspace:write.name[​](#workspacename-2 "Direct link to workspace:write.name") > `readonly` **name**: `"workspace:write"` = `'workspace:write'` --- # Variable: SiteDnsRecordType > **SiteDnsRecordType**: `object` Defined in: [packages/sdk/src/types/generated/organization.ts:711](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/organization.ts#L711) ## Type Declaration[​](#type-declaration "Direct link to Type Declaration") ### A[​](#a "Direct link to A") > `readonly` **A**: `"A"` = `'A'` ### CNAME[​](#cname "Direct link to CNAME") > `readonly` **CNAME**: `"CNAME"` = `'CNAME'` ### TXT[​](#txt "Direct link to TXT") > `readonly` **TXT**: `"TXT"` = `'TXT'` --- # Variable: SMS\_DELIVERY\_FAILURE\_STATUSES > `const` **SMS\_DELIVERY\_FAILURE\_STATUSES**: `ReadonlySet`<[`SMSDeliveryFailureStatus`](https://docs.gravityrail.com/sdk/type-aliases/SMSDeliveryFailureStatus.md)> Defined in: [packages/sdk/src/types/chat-types.ts:230](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/chat-types.ts#L230) --- # Variable: STT\_MODEL\_DEEPGRAM\_FLUX > `const` **STT\_MODEL\_DEEPGRAM\_FLUX**: `"deepgram:stt:flux-general-en"` = `'deepgram:stt:flux-general-en'` Defined in: [packages/sdk/src/types/ai-model-types.ts:66](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ai-model-types.ts#L66) --- # Variable: STT\_MODEL\_DEEPGRAM\_FLUX\_MULTI > `const` **STT\_MODEL\_DEEPGRAM\_FLUX\_MULTI**: `"deepgram:stt:flux-general-multi"` = `'deepgram:stt:flux-general-multi'` Defined in: [packages/sdk/src/types/ai-model-types.ts:67](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ai-model-types.ts#L67) --- # Variable: STT\_MODEL\_ELEVENLABS\_SCRIBE > `const` **STT\_MODEL\_ELEVENLABS\_SCRIBE**: `"elevenlabs:stt:scribe_v2_realtime"` = `'elevenlabs:stt:scribe_v2_realtime'` Defined in: [packages/sdk/src/types/ai-model-types.ts:68](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ai-model-types.ts#L68) --- # Variable: TTS\_MODEL\_AWS\_POLLY\_GENERATIVE > `const` **TTS\_MODEL\_AWS\_POLLY\_GENERATIVE**: `"aws:tts:polly-generative"` = `'aws:tts:polly-generative'` Defined in: [packages/sdk/src/types/ai-model-types.ts:75](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ai-model-types.ts#L75) --- # Variable: TTS\_MODEL\_AWS\_POLLY\_NEURAL > `const` **TTS\_MODEL\_AWS\_POLLY\_NEURAL**: `"aws:tts:polly-neural"` = `'aws:tts:polly-neural'` Defined in: [packages/sdk/src/types/ai-model-types.ts:76](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ai-model-types.ts#L76) --- # Variable: TTS\_MODEL\_DEEPGRAM\_AURA\_2 > `const` **TTS\_MODEL\_DEEPGRAM\_AURA\_2**: `"deepgram:tts:aura-2"` = `'deepgram:tts:aura-2'` Defined in: [packages/sdk/src/types/ai-model-types.ts:74](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ai-model-types.ts#L74) --- # Variable: TTS\_MODEL\_ELEVENLABS\_FLASH > `const` **TTS\_MODEL\_ELEVENLABS\_FLASH**: `"elevenlabs:tts:eleven_flash_v2_5"` = `'elevenlabs:tts:eleven_flash_v2_5'` Defined in: [packages/sdk/src/types/ai-model-types.ts:71](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ai-model-types.ts#L71) --- # Variable: TTS\_MODEL\_ELEVENLABS\_MULTILINGUAL > `const` **TTS\_MODEL\_ELEVENLABS\_MULTILINGUAL**: `"elevenlabs:tts:eleven_multilingual_v2"` = `'elevenlabs:tts:eleven_multilingual_v2'` Defined in: [packages/sdk/src/types/ai-model-types.ts:73](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ai-model-types.ts#L73) --- # Variable: TTS\_MODEL\_ELEVENLABS\_TURBO > `const` **TTS\_MODEL\_ELEVENLABS\_TURBO**: `"elevenlabs:tts:eleven_turbo_v2_5"` = `'elevenlabs:tts:eleven_turbo_v2_5'` Defined in: [packages/sdk/src/types/ai-model-types.ts:72](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/ai-model-types.ts#L72) --- # Variable: TTS\_PREVIEW\_PROVIDERS > `const` **TTS\_PREVIEW\_PROVIDERS**: readonly \[`"openai"`, `"elevenlabs"`, `"google"`, `"aws"`, `"deepgram"`, `"xai"`] Defined in: [packages/sdk/src/types/model-config-types.ts:181](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/model-config-types.ts#L181) Supported TTS preview providers. These are the voice providers that support TTS preview in the UI. --- # Variable: WorkflowAccessWarningResourceType > **WorkflowAccessWarningResourceType**: `object` Defined in: [packages/sdk/src/types/generated/task.ts:342](https://github.com/Gravity-Rail/gravity-team/blob/c96b2a2f48ec8c20a5b17c397816cec56b37e18b/packages/sdk/src/types/generated/task.ts#L342) ## Type Declaration[​](#type-declaration "Direct link to Type Declaration") ### calendar[​](#calendar "Direct link to calendar") > `readonly` **calendar**: `"calendar"` = `'calendar'` ### file[​](#file "Direct link to file") > `readonly` **file**: `"file"` = `'file'` ### folder[​](#folder "Direct link to folder") > `readonly` **folder**: `"folder"` = `'folder'` ### form[​](#form "Direct link to form") > `readonly` **form**: `"form"` = `'form'` --- # Use Cases Real-world use cases and implementation patterns. --- # Patient Engagement Streamline patient onboarding, re-engagement, and data collection with AI-powered conversations across phone, SMS, and web chat. ## Overview[​](#overview "Direct link to Overview") The Patient Engagement use case demonstrates how healthcare organizations can automate patient communication workflows while maintaining a personalized, empathetic touch. Using Gravity Rail's AI assistants, phone numbers, and workflow automation, you can: * **Onboard new patients** through conversational screening and eligibility checks * **Re-engage inactive patients** with multi-touch confirmation sequences * **Collect structured data** about patient concerns, preferences, and feedback * **Route to appropriate care** based on geographic location and availability ## Key Features[​](#key-features "Direct link to Key Features") This use case leverages the following Gravity Rail features: ### Phone Numbers & Voice[​](#phone-numbers--voice "Direct link to Phone Numbers & Voice") * Dedicated phone numbers for patient communication * Voice and SMS support for accessibility * Work mode settings for business hours management * Call forwarding and auto-response configuration ### AI-Powered Workflows[​](#ai-powered-workflows "Direct link to AI-Powered Workflows") * Multi-step conversational workflows guide patients through processes * Conditional branching based on patient responses * Priority routing for high-value patients * Automated task progression ### Chats & Messaging[​](#chats--messaging "Direct link to Chats & Messaging") * Unified conversation history across SMS, voice, and web chat * AI assistants handle routine conversations * Escalation to human staff when needed * Multi-channel consistency ### Labels & Segmentation[​](#labels--segmentation "Direct link to Labels & Segmentation") * Dynamic patient segmentation based on status * Automated label application via event rules * Filter-based workflow triggering * Progress tracking throughout patient journey ## Use Case Scenarios[​](#use-case-scenarios "Direct link to Use Case Scenarios") ### 1. New Patient Screening[​](#1-new-patient-screening "Direct link to 1. New Patient Screening") A prospective patient texts your clinic's number or visits your website. An AI assistant: 1. Warmly introduces the service 2. Screens for eligibility (medical conditions, medications, etc.) 3. Matches patient to nearby clinic locations 4. Confirms site selection and sets expectations **Time saved:** 10-15 minutes per patient vs. manual screening ### 2. Interest Confirmation (Round 1)[​](#2-interest-confirmation-round-1 "Direct link to 2. Interest Confirmation (Round 1)") After initial screening, patients need confirmation they're still interested: 1. Automated SMS sent 24-48 hours after screening 2. Simple yes/no response triggers appropriate workflow 3. "Yes" responses → expedited to coordinator 4. No response → enters re-engagement sequence **Time saved:** 5-10 minutes per patient vs. manual confirmation calls ### 3. Non-Responder Re-engagement[​](#3-non-responder-re-engagement "Direct link to 3. Non-Responder Re-engagement") Patients who don't respond to initial outreach receive: 1. **Round 1 Follow-up** (48 hours later): Different messaging, creates urgency 2. **Speed-to-Lead Recovery** (for high-priority patients): Same-day coordinator connection 3. **Round 2 Confirmation** (5-7 days later): "We still have a spot for you" 4. **Final Attempt** (72 hours after Round 2): Last automated touch before manual review **Recovery rate:** 10-20% of initial non-responders convert ### 4. Site Handoff & Follow-up[​](#4-site-handoff--follow-up "Direct link to 4. Site Handoff & Follow-up") After confirmation, patients are matched to clinical sites: 1. Patient information sent to site 2. System monitors for site contact 3. If no contact within 3-5 days → patient prompted to call site directly 4. Alternative: patient routed back to main coordinator **Experience improvement:** Patients never feel "lost in the system" ## Implementation Guide[​](#implementation-guide "Direct link to Implementation Guide") ### Prerequisites[​](#prerequisites "Direct link to Prerequisites") * Gravity Rail workspace with appropriate product tier * Twilio phone number(s) configured * AI assistant(s) created and configured * Business hours and work modes set up ### Setup Steps[​](#setup-steps "Direct link to Setup Steps") 1. **Import Template Workspace** (if using template) * Navigate to workspace settings * Select "Import from Template" * Choose "Patient Engagement" template * Customize branding and settings 2. **Configure Phone Numbers** * Add phone number(s) for patient communication * Set work modes (business hours, forwarding, auto-response) * Configure signup settings if allowing self-registration 3. **Customize Workflows** * Review and customize screening questions * Adjust eligibility criteria for your organization * Configure site matching logic (if applicable) * Set up confirmation timing and messaging 4. **Create Member Segments** * Import provided filters or create custom ones * Set up labels for tracking patient status * Configure filter-based workflow triggers 5. **Set Up Event Rules** * Review and activate automated actions * Configure webhook integrations (if needed) * Set up routines for timed outreach 6. **Configure Data Types** * Review patient data collection forms * Customize fields for your organization * Set up webhooks for external system integration ### Best Practices[​](#best-practices "Direct link to Best Practices") **Messaging Tone** * Keep initial messages warm and conversational * Increase urgency in follow-ups ("We still have a spot") * Always provide human escalation path **Timing** * Initial confirmation: 24-48 hours after screening * Follow-up 1: 48-72 hours after no response * Follow-up 2: 5-7 days after initial attempt * Business hours optimization: 3 PM - 9 PM weekdays **Segmentation** * Prioritize high-value patients (gold/silver tiers) * Fast-track engaged respondents to coordinators * Flag persistent non-responders for manual review **Data Collection** * Capture both quantitative (yes/no) and qualitative (concerns/notes) data * Log patient questions for process improvement * Track conversion at each funnel stage ## Results & Impact[​](#results--impact "Direct link to Results & Impact") Organizations using this pattern report: * **55-80 minutes saved** per patient (vs. manual process) * **10-20% recovery** of initial non-responders * **Consistent experience** for all patients * **Scalable operations** handling 100s of concurrent conversations ## Related Resources[​](#related-resources "Direct link to Related Resources") * [Phone Numbers Feature Documentation](https://docs.gravityrail.com/features/phone) * [Voice Communication Guide](https://docs.gravityrail.com/features/voice) * [Workflows Documentation](https://docs.gravityrail.com/features/workflows/.md) * [Labels & Segmentation](https://docs.gravityrail.com/features/labels) ## Get Started[​](#get-started "Direct link to Get Started") Ready to implement patient engagement automation? 1. **Try the Demo**: Visit the [live demo workspace](https://demo.gravityrail.com/patient-engagement) 2. **Use the Template**: Clone this workspace configuration to your own account 3. **Contact Sales**: Schedule a consultation to discuss your specific needs *** **Questions?** Contact or visit our [community forum](https://community.gravityrail.com). --- # User Guide Getting started, tutorials, and how-to guides. --- # Abilities Abilities are modular capabilities you attach to workflows or tasks. They extend what your AI agent can do during conversations — from searching the web to booking appointments to using custom tools you've built. Without abilities, your agent can converse, collect form data, and follow workflow prompts. With abilities, it becomes a fully capable agent. ## How Abilities Work[​](#how-abilities-work "Direct link to How Abilities Work") 1. Add an ability to a workflow or task 2. The AI gains that capability during conversations in that context 3. The AI decides when to use the ability based on the conversation Abilities can also have **conditions** (CEL expressions) that control when they activate — like only during business hours or only for VIP members. ## Adding Abilities[​](#adding-abilities "Direct link to Adding Abilities") ### Workflow-Level Abilities[​](#workflow-level-abilities "Direct link to Workflow-Level Abilities") Apply to all tasks in the workflow: 1. Open your workflow 2. Go to the **Abilities** tab 3. Click **Add Ability** 4. Configure and save ### Task-Level Abilities[​](#task-level-abilities "Direct link to Task-Level Abilities") Apply only to a specific task: 1. Open the task in the workflow editor 2. Go to the **Abilities** tab 3. Click **Add Ability** Task abilities override workflow abilities of the same type. Use this when a specific step needs different tool access than the rest of the workflow. ### Attaching abilities from the CLI[​](#attaching-abilities-from-the-cli "Direct link to Attaching abilities from the CLI") The `gr` CLI can attach an ability to a task without touching the abilities the task already has: ``` # Discover the ability type slug and its config schema gr abilities list -w $WID gr abilities get --name integration:data_access -w $WID # Attach it to a task (generates the ability's uuid for you) gr abilities attach --task 9 --type integration:data_access \ --config '{"dataTypeId":2}' -w $WID --allow-write # See what's attached, then detach by uuid gr abilities attached --task 9 -w $WID gr abilities detach --task 9 --uuid -w $WID --allow-write ``` Notes: * The ability type is set with `--type` (the slug, e.g. `oversight:escalation`), **not** `slug`/`name` — those are for the read-only `get` command. * `gr abilities attach` reads the task, appends the new ability, and re-saves, so existing task abilities are preserved. Editing the raw `abilities` array via `gr tasks update` instead is a full replace — any ability you omit is deleted. * `--config` takes the ability's JSON config; see `gr abilities get` for each type's schema. Add `--cel ''` for conditional activation and `--disabled` to attach without enabling. ## Built-in Abilities[​](#built-in-abilities "Direct link to Built-in Abilities") ### [Web Search](https://docs.gravityrail.com/user-guide/abilities/web-search.md)[​](#web-search "Direct link to web-search") Let your AI search the internet for current information. No configuration needed — just enable it and the AI decides when to search. Great for: looking up business hours, verifying facts, checking recent events, answering questions outside your knowledge base. ### [Calendar Booking](https://docs.gravityrail.com/user-guide/abilities/calendar-booking.md)[​](#calendar-booking "Direct link to calendar-booking") Give your AI access to check availability and book appointments on connected calendars. * Select which calendar and event type to use * Optionally allow editing existing bookings * Requires a connected Google Calendar or native Gravity Rail calendar ### [File Access](https://docs.gravityrail.com/user-guide/abilities/file-access.md)[​](#file-access "Direct link to file-access") Let your AI read, write, and search files and folders in your workspace. * Choose specific files or folders to grant access to * Fine-grained permissions: read, write, search, and create * Works with folder indexing for semantic search ### [Data Access](https://docs.gravityrail.com/user-guide/abilities/data-access.md)[​](#data-access "Direct link to data-access") Give your AI access to read or create form records beyond the current conversation. * Select which form (data type) to access * Configure read, create, and update permissions independently * Add multiple Data Access abilities for different forms ### [Custom Toolkits](https://docs.gravityrail.com/user-guide/abilities/custom-toolkits.md)[​](#custom-toolkits "Direct link to custom-toolkits") Attach tools you've built (or MCP server integrations) to give your AI entirely new capabilities. * Select which toolkits to include * Extend AI with your own integrations and business logic * See the [Toolkits](https://docs.gravityrail.com/user-guide/developer/toolkits.md) developer guide for building tools ### [Phone Call Tools](https://docs.gravityrail.com/user-guide/abilities/phone-call-tools.md)[​](#phone-call-tools "Direct link to phone-call-tools") Give AI control over voice calls. * **Hang Up**: End calls gracefully (enabled by default) * **Forward**: Transfer calls to other numbers or agents * Pair with conditions for business-hours-only forwarding ### [Supervisor](https://docs.gravityrail.com/user-guide/abilities/supervisor.md)[​](#supervisor "Direct link to supervisor") Route complex requests to a supervisor AI for review. Creates a two-tier system where the primary AI escalates uncertain or sensitive requests. * Optionally include conversation history for full context * Useful for quality assurance, compliance review, and complex decision-making ### Escalation (oversight:escalation)[​](#escalation-oversight "Direct link to Escalation (oversight:escalation)") Gives the agent a `talk_to_human` tool and configures how a conversation hands off to a person (pause behavior, custom messages, priority routing). The agent calls it on explicit human requests and on safety/medical/emergency situations. * **A human is only notified if notification routing is set up.** Attaching the escalation ability alone does not page anyone — configure a notification rule and/or a supervisor / operator group so an escalation reaches a real person. * `pauseOnEscalate: true` pauses the chat on escalation; pair with a clear `pausedMessage`. * Escalation fires only when the agent calls the tool. For workflows where a human **must** be alerted on a specific trigger regardless of the model's judgment, a rule-based escalation is the more reliable path (see the conditional-abilities and event-rule docs). ### Member Field Verification[​](#member-field-verification "Direct link to Member Field Verification") Let the agent confirm a caller's identity by matching configured identity fields against the values on file — without ever seeing the stored values. Admins choose which fields to verify through the ability config. * Single tool, `verify_member`, accepts any subset of the configured fields in one call * Configurable fields: `verifyName` (default: true), `verifyEmail` (default: false), `verifyPhone` (default: false), `verifyDateOfBirth` (default: true) * Default configuration verifies name and date of birth only * Returns one ✓ or ✗ line per provided field; stored values are never revealed * A ✗ result is indistinguishable between "wrong value" and "no value on file" — the agent cannot probe which fields are populated * The prompt component recognizes "verify the patient", "verify the caller", and "verify the member" instructions * Independent of SMS-based phone verification (which lives under Member Access) — enable this on chat-only or email-only agents that should verify identity without telephony ## Conditional Abilities[​](#conditional-abilities "Direct link to Conditional Abilities") Make abilities activate only in certain situations using CEL expressions: ``` # Only during business hours is_business_hours # Only for VIP members "vip" in member.labels # Only on voice calls chat.channel == "phone-voice" ``` Add conditions in the ability's **Conditions** field. The ability is only available to the AI when the condition evaluates to true. ## Ability Order[​](#ability-order "Direct link to Ability Order") When multiple abilities are attached, they execute in order. Drag to reorder in the abilities list. ## Tips[​](#tips "Direct link to Tips") * **Start minimal** — Add only the abilities your workflow actually needs. More abilities means more choices for the AI to make. * **Use conditions** — Limit powerful abilities to appropriate contexts. Don't give every workflow access to everything. * **Test thoroughly** — After adding abilities, run test conversations to make sure the AI uses them correctly and doesn't over-rely on them. * **Combine workflow and task levels** — Add common abilities (like web search) at the workflow level, and specialized ones (like a specific calendar) at the task level. ## Related[​](#related "Direct link to Related") * **[Workflows](https://docs.gravityrail.com/user-guide/automation/workflows.md)** — Build the conversation flows that abilities extend * **[CEL Expressions](https://docs.gravityrail.com/user-guide/automation/cel-expressions.md)** — Write conditions to control when abilities activate * **[Custom Toolkits](https://docs.gravityrail.com/user-guide/abilities/custom-toolkits.md)** — Build your own tools for AI to use --- # Calendar Booking The Calendar Booking ability gives your AI access to book, view, and manage appointments on connected calendars. The agent can check availability, create bookings, and optionally modify existing events through natural conversation. ## Settings[​](#settings "Direct link to Settings") | Setting | Description | | -------------- | --------------------------------------- | | **Calendar** | Which calendar to use | | **Event Type** | What kind of appointment | | **Can Edit** | Whether AI can modify existing bookings | ## Prerequisites[​](#prerequisites "Direct link to Prerequisites") Calendar Booking requires a connected calendar. Make sure your workspace has a calendar set up under **Calendars** before adding this ability. See [Calendars](https://docs.gravityrail.com/user-guide/calendars.md) for setup instructions. ## How It Works[​](#how-it-works "Direct link to How It Works") When a user wants to schedule an appointment, the AI will: 1. Check the connected calendar for available time slots 2. Present options to the user 3. Book the selected slot and create the calendar event 4. Optionally send confirmation details If **Can Edit** is enabled, the AI can also reschedule or cancel existing bookings. ## Adding Calendar Booking[​](#adding-calendar-booking "Direct link to Adding Calendar Booking") Calendar Booking can be added at either the workflow or task level: 1. Open your workflow or task 2. Go to the **Abilities** tab 3. Click **Add Ability** and select **Calendar Booking** 4. Select the calendar and event type 5. Configure whether the AI can edit existing bookings 6. Save Task-level abilities override workflow-level abilities of the same type. ## Conditional Activation[​](#conditional-activation "Direct link to Conditional Activation") You can restrict when Calendar Booking is available using CEL expressions in the ability's **Conditions** field. For example, you might only allow booking during business hours. See [Abilities](https://docs.gravityrail.com/user-guide/abilities/.md) for more on conditional abilities. --- # Custom Toolkits The Custom Toolkits ability lets you attach custom tools you've built to your AI workflows. This extends the AI's capabilities beyond the built-in abilities with your own integrations, API calls, and business logic. ## Settings[​](#settings "Direct link to Settings") | Setting | Description | | ------------ | ------------------------- | | **Toolkits** | Which toolkits to include | ## How It Works[​](#how-it-works "Direct link to How It Works") Custom Toolkits connect your AI to external services and custom logic that you define. When this ability is enabled, the AI can invoke the tools in the selected toolkits during conversations. Toolkits are collections of one or more tools. Each tool defines: * A name and description (so the AI knows when to use it) * Input parameters * The action to perform (API call, webhook, etc.) For full details on creating and managing toolkits, see the [Toolkits](https://docs.gravityrail.com/user-guide/developer/toolkits.md) developer guide. ## Adding Custom Toolkits[​](#adding-custom-toolkits "Direct link to Adding Custom Toolkits") Custom Toolkits can be added at either the workflow or task level: 1. Open your workflow or task 2. Go to the **Abilities** tab 3. Click **Add Ability** and select **Custom Toolkits** 4. Select the toolkits to include 5. Save Task-level abilities override workflow-level abilities of the same type. ## Tips[​](#tips "Direct link to Tips") * **Write clear tool descriptions** so the AI knows when each tool is appropriate to use. * **Test tools independently** before attaching them to production workflows. * **Start with one toolkit** and add more as needed to keep behavior predictable. * **Healthcare workflows**: For EHR integration, scheduling, lab results, and clinical decision support examples, see [Healthcare MCP Integration Examples](https://docs.gravityrail.com/user-guide/developer/healthcare-mcp-examples.md). ## Conditional Activation[​](#conditional-activation "Direct link to Conditional Activation") You can restrict when Custom Toolkits are available using CEL expressions in the ability's **Conditions** field. For example, you might only enable certain toolkits for specific member labels. See [Abilities](https://docs.gravityrail.com/user-guide/abilities/.md) for more on conditional abilities. ## Related[​](#related "Direct link to Related") * **[Abilities](https://docs.gravityrail.com/user-guide/abilities/.md)** — Overview of all AI abilities * **[Toolkits](https://docs.gravityrail.com/user-guide/developer/toolkits.md)** — Build custom tools and MCP integrations * **[Workflows](https://docs.gravityrail.com/user-guide/automation/workflows.md)** — Attach toolkits to workflow tasks --- # Data Access The Data Access ability gives your AI access to read, create, and update form records in your workspace. This lets the agent look up existing data and create new entries through natural conversation. ## Settings[​](#settings "Direct link to Settings") | Setting | Description | | ----------------- | ----------------------------------------------------------------------------- | | **Data Type** | Which form to access | | **Can Read** | AI can view records | | **Can Create** | AI can create records | | **Can Update** | AI can modify records | | **Auto Create** | Automatically create a record for each assignment (useful for state tracking) | | **Read Fields** | Limit which fields the AI can see when reading records (optional) | | **Write Fields** | Limit which fields the AI can modify when updating records (optional) | | **Create Fields** | Limit which fields the AI can set when creating records (optional) | ## How It Works[​](#how-it-works "Direct link to How It Works") When Data Access is enabled, the AI can interact with the specified form's records based on the permissions you configure: * **Can Read** allows the AI to look up and display existing records. Useful for answering questions like "What's the status of order #1234?" * **Can Create** allows the AI to create new records by collecting field values through conversation * **Can Update** allows the AI to modify existing records, such as updating a status field or correcting information You can grant any combination of these permissions depending on your use case. ## Adding Data Access[​](#adding-data-access "Direct link to Adding Data Access") Data Access can be added at either the workflow or task level: 1. Open your workflow or task 2. Go to the **Abilities** tab 3. Click **Add Ability** and select **Data Access** 4. Select the form (data type) to grant access to 5. Configure the permission checkboxes (Can Read, Can Create, Can Update) 6. Save Task-level abilities override workflow-level abilities of the same type. ## Auto Create[​](#auto-create "Direct link to Auto Create") When **Auto Create** is enabled, the system automatically creates a record of this data type for each new assignment. This is useful when the data type serves as state storage for a workflow — the AI can immediately start updating fields without needing to create a record first. For example, a "Game State" data type with `autoCreate` enabled gives each assignment its own state record from the start. ## Field Filters[​](#field-filters "Direct link to Field Filters") Field filters let you control exactly which fields the AI can access. When no filters are set, the AI has access to all fields defined on the data type. When filters are set, only the specified fields are available. | Filter | Controls | Example Use | | ----------------- | -------------------------------------------------- | ---------------------------------------- | | **Read Fields** | Which fields appear when the AI reads records | Hide internal notes from the AI | | **Write Fields** | Which fields the AI can modify on existing records | Prevent the AI from changing an ID field | | **Create Fields** | Which fields the AI can set on new records | Only allow the AI to set name and email | Each filter is independent — you can allow reading all fields but restrict writes to a subset, for example. **When to use field filters:** * **Privacy**: Hide sensitive fields (SSN, internal notes) from the AI while still allowing access to other fields * **Safety**: Prevent the AI from overwriting system-managed fields * **Focus**: Reduce noise by only exposing relevant fields for the current task **Note:** Field filters restrict the AI's tools only. Record metadata (ID, timestamps) is always visible. If a required field is excluded from create filters, the AI won't be able to create valid records — ensure required fields are included. ## Tips[​](#tips "Direct link to Tips") * **Pair with form design** to ensure the AI has clear field names and descriptions to work with. See [Forms](https://docs.gravityrail.com/user-guide/knowledge/forms.md). * **Use read-only access** when the AI only needs to look up information, not modify it. * **Add multiple Data Access abilities** if the AI needs to work with more than one form. * **Use Auto Create with edge routing** to give each assignment its own state record, then use tool-invocation edge conditions to route based on what the AI writes. ## Conditional Activation[​](#conditional-activation "Direct link to Conditional Activation") You can restrict when Data Access is available using CEL expressions in the ability's **Conditions** field. For example, you might only allow record creation for authenticated members. See [Abilities](https://docs.gravityrail.com/user-guide/abilities/.md) for more on conditional abilities. ## Related[​](#related "Direct link to Related") * **[Abilities](https://docs.gravityrail.com/user-guide/abilities/.md)** — Overview of all AI abilities * **[Forms](https://docs.gravityrail.com/user-guide/knowledge/forms.md)** — Define the data types that Data Access works with * **[CEL Expressions](https://docs.gravityrail.com/user-guide/automation/cel-expressions.md)** — Write conditions for conditional activation --- # File Access The File Access ability lets your AI read from, write to, search, and create files and folders in your workspace. You control exactly which items the AI can access and what operations it can perform. ## Settings[​](#settings "Direct link to Settings") | Setting | Description | | ----------------- | ----------------------------- | | **Files/Folders** | Which items to give access to | | **Read** | AI can read contents | | **Write** | AI can modify contents | | **Search** | AI can search within files | | **Create** | AI can create new files | ## How It Works[​](#how-it-works "Direct link to How It Works") When File Access is enabled, the AI can interact with specified files and folders based on the permissions you configure: * **Read** allows the AI to view file contents and use them as context in conversations * **Write** allows the AI to update or replace file contents * **Search** allows the AI to perform semantic or keyword search across the selected files and folders * **Create** allows the AI to create new files in the specified folders You can grant any combination of these permissions. For example, you might allow read and search but not write access. ## Adding File Access[​](#adding-file-access "Direct link to Adding File Access") File Access can be added at either the workflow or task level: 1. Open your workflow or task 2. Go to the **Abilities** tab 3. Click **Add Ability** and select **File Access** 4. Select the files or folders to grant access to 5. Configure the permission checkboxes (Read, Write, Search, Create) 6. Save Task-level abilities override workflow-level abilities of the same type. ## Tips[​](#tips "Direct link to Tips") * **Be specific** with which files and folders you grant access to. Avoid giving blanket access to everything. * **Use folder-level access** when the AI needs to work with a collection of related documents. * **Enable Search** for large document sets so the AI can find relevant information without reading every file. ## Conditional Activation[​](#conditional-activation "Direct link to Conditional Activation") You can restrict when File Access is available using CEL expressions in the ability's **Conditions** field. For example, you might only enable write access for certain member roles. See [Abilities](https://docs.gravityrail.com/user-guide/abilities/.md) for more on conditional abilities. ## Related[​](#related "Direct link to Related") * **[Abilities](https://docs.gravityrail.com/user-guide/abilities/.md)** — Overview of all AI abilities * **[Files](https://docs.gravityrail.com/user-guide/knowledge/files.md)** — Upload and manage files and folders * **[Sites](https://docs.gravityrail.com/user-guide/channels/sites.md)** — Build knowledge base sites with AI-powered file search --- # Phone Call Tools The Phone Call Tools ability gives your AI control over voice calls. When enabled, the agent can end calls and transfer them to other numbers or agents. ## Settings[​](#settings "Direct link to Settings") | Setting | Description | | ----------- | -------------------------------------------------- | | **Hang Up** | AI can always end phone calls (enabled by default) | | **Forward** | AI can transfer the call | ## How It Works[​](#how-it-works "Direct link to How It Works") Phone Call Tools provide the AI with call-control capabilities during voice conversations: * **Hang Up** allows the AI to end the phone call when the conversation is complete. This is enabled by default so the AI can gracefully close calls. * **Forward** allows the AI to transfer the call to another phone number or agent. This is useful for escalation flows where the AI determines it needs to hand off to a human. ## Adding Phone Call Tools[​](#adding-phone-call-tools "Direct link to Adding Phone Call Tools") Phone Call Tools can be added at either the workflow or task level: 1. Open your workflow or task 2. Go to the **Abilities** tab 3. Click **Add Ability** and select **Phone Call Tools** 4. Configure whether the AI can hang up and/or forward calls 5. Save Task-level abilities override workflow-level abilities of the same type. ## Tips[​](#tips "Direct link to Tips") * **Keep Hang Up enabled** so the AI can end calls naturally rather than leaving callers in silence. * **Configure forwarding targets** carefully to ensure calls go to the right person or team. * **Combine with conditions** to only allow forwarding during business hours or to specific teams. ## Conditional Activation[​](#conditional-activation "Direct link to Conditional Activation") You can restrict when Phone Call Tools are available using CEL expressions in the ability's **Conditions** field. For example, you might only enable call forwarding during business hours or on specific channels: ``` chat.channel == "phone-voice" ``` See [Abilities](https://docs.gravityrail.com/user-guide/abilities/.md) for more on conditional abilities. ## Related[​](#related "Direct link to Related") * **[Abilities](https://docs.gravityrail.com/user-guide/abilities/.md)** — Overview of all AI abilities * **[Phone & Voice](https://docs.gravityrail.com/user-guide/channels/phone-and-voice.md)** — Set up phone numbers and voice channels * **[Workspace Settings](https://docs.gravityrail.com/user-guide/workspace-settings/.md)** — Configure business hours for call routing --- # Supervisor The Supervisor ability routes complex or sensitive requests to a supervisor AI for review. This creates a two-tier system where a primary AI handles routine conversations and escalates to a more capable or specialized AI when needed. ## Settings[​](#settings "Direct link to Settings") | Setting | Description | | ------------------- | --------------------------------------- | | **Include History** | Send conversation history to supervisor | ## How It Works[​](#how-it-works "Direct link to How It Works") When the Supervisor ability is enabled, the AI can escalate requests it's uncertain about or that require higher-level judgment. The supervisor AI receives the request (and optionally the conversation history) and provides guidance or a direct response. This is useful for: * Complex decision-making that benefits from a second opinion * Sensitive topics that need careful handling * Requests that fall outside the primary AI's expertise * Quality assurance on important responses If **Include History** is enabled, the supervisor receives the full conversation context. Otherwise, it only receives the specific request being escalated. ## Adding Supervisor[​](#adding-supervisor "Direct link to Adding Supervisor") Supervisor can be added at either the workflow or task level: 1. Open your workflow or task 2. Go to the **Abilities** tab 3. Click **Add Ability** and select **Supervisor** 4. Configure whether to include conversation history 5. Save Task-level abilities override workflow-level abilities of the same type. ## Tips[​](#tips "Direct link to Tips") * **Enable Include History** for better context when the supervisor needs to understand the full conversation. * **Use sparingly** to avoid unnecessary latency from double-processing every request. * **Combine with conditions** to only trigger supervision for specific scenarios. ## Conditional Activation[​](#conditional-activation "Direct link to Conditional Activation") You can restrict when the Supervisor is available using CEL expressions in the ability's **Conditions** field. For example, you might only enable supervision for VIP members: ``` "vip" in member.labels ``` See [Abilities](https://docs.gravityrail.com/user-guide/abilities/.md) for more on conditional abilities. ## Related[​](#related "Direct link to Related") * **[Abilities](https://docs.gravityrail.com/user-guide/abilities/.md)** — Overview of all AI abilities * **[Workflows](https://docs.gravityrail.com/user-guide/automation/workflows.md)** — Build multi-step flows with escalation paths * **[Agents](https://docs.gravityrail.com/user-guide/members/agents.md)** — Configure the AI agents that act as supervisors --- # Web Search The Web Search ability lets your AI search the internet for up-to-date information during conversations. When enabled, the agent can look up current facts, check websites, and bring real-time data into the conversation. ## Settings[​](#settings "Direct link to Settings") | Setting | Description | | ------- | ---------------------------------------- | | (none) | Just enable it — no configuration needed | Web Search requires no configuration. Once added, the AI will automatically decide when to search the internet based on the conversation context. ## How It Works[​](#how-it-works "Direct link to How It Works") When a user asks a question the AI can't confidently answer from its training data or your workspace knowledge, it will perform a web search. Results are summarized and incorporated into the response. Common use cases: * Looking up current business hours or contact details * Checking recent news or events * Verifying facts that may have changed since the AI's training * Researching topics not covered by your workspace knowledge base ## Adding Web Search[​](#adding-web-search "Direct link to Adding Web Search") Web Search can be added at either the workflow or task level: 1. Open your workflow or task 2. Go to the **Abilities** tab 3. Click **Add Ability** and select **Web Search** 4. Save Task-level abilities override workflow-level abilities of the same type. ## Conditional Activation[​](#conditional-activation "Direct link to Conditional Activation") You can restrict when Web Search is available using CEL expressions in the ability's **Conditions** field. For example, you might only enable it during business hours or for certain member labels. See [Abilities](https://docs.gravityrail.com/user-guide/abilities/.md) for more on conditional abilities. --- # Access Grants An **access grant** is your consent for another person or AI agent to access one of your resources — a data record, file, calendar, inbox, or similar — for a limited time. Grants expire automatically, can be revoked at any time, and every decision is logged for compliance. ## How access grants work[​](#how-access-grants-work "Direct link to How access grants work") When a workflow, AI agent, or operator needs temporary access to your data, it creates a **pending** grant request and waits for your approval. You decide whether to allow or deny. If you approve, the grant becomes **active** and the requester can access the resource until the grant expires or you revoke it. | Status | Meaning | | ----------- | ----------------------------------------------------------- | | **Pending** | Request received — waiting for your decision | | **Active** | You approved — access is live | | **Denied** | You declined — no access was given | | **Expired** | The grant's time window passed — access ended automatically | | **Revoked** | You ended the grant early before it expired | ## Receiving a grant request[​](#receiving-a-grant-request "Direct link to Receiving a grant request") You may receive a grant request in several ways: * **Chat message** — the AI agent or a care coordinator asks for your consent directly in a conversation * **DTMF prompt** — during a phone call, you are asked to press a key to confirm * **SMS confirmation** — you receive a text and reply to approve * **Workspace UI** — a notification appears in your member profile under the **Access Grants** tab Each request shows: * Who or what is requesting access * Which resource is being requested (e.g. "your care plan record") * How long the access would last (e.g. "for 60 minutes") ## Approving or denying a request[​](#approving-or-denying-a-request "Direct link to Approving or denying a request") ### In a chat or phone call[​](#in-a-chat-or-phone-call "Direct link to In a chat or phone call") Respond as prompted — say yes or press the indicated key. The grant is recorded with your consent method automatically. ### In the workspace UI[​](#in-the-workspace-ui "Direct link to In the workspace UI") 1. Open your profile (top-right menu → **My Profile**) and select the **Access Grants** tab, or navigate to your member page. 2. Find the pending request in the list. 3. Click **Approve** or **Deny**. 4. The grant moves to **Active** or **Denied** immediately. Denying a request does not affect your other data or access to the workspace — it only prevents this specific access. ## Viewing your grants[​](#viewing-your-grants "Direct link to Viewing your grants") You can see all grants associated with you: ### Grants received (others can access your resources)[​](#grants-received-others-can-access-your-resources "Direct link to Grants received (others can access your resources)") These are grants where you are the data owner who consented. Find them under: * Your member profile → **Access Grants** → **Received** Each entry shows the requester, resource, consent method, status, and expiry time. ### Grants given (you can access others' resources)[​](#grants-given-you-can-access-others-resources "Direct link to Grants given (you can access others' resources)") These are grants where you are the party who was granted access. Find them under: * Your member profile → **Access Grants** → **Given** ## Revoking an active grant[​](#revoking-an-active-grant "Direct link to Revoking an active grant") If you change your mind after approving: 1. Open your member profile → **Access Grants** → **Received**. 2. Find the active grant you want to end. 3. Click **Revoke**. 4. Access ends immediately — the grant status changes to **Revoked**. Revocation takes effect instantly. The requester loses access to your resource as soon as you revoke. ## Expiry behavior[​](#expiry-behavior "Direct link to Expiry behavior") Most grants include an expiry time set by the requester (for example, "access for the next 2 hours"). You will always be shown this duration before approving. * The system checks for expired grants every 5 minutes and marks them **Expired** automatically. * Expired grants cannot be reactivated — a new request must be made. * If no expiry time was set, the grant remains active until you revoke it or an admin ends it. ## Compliance and audit trail[​](#compliance-and-audit-trail "Direct link to Compliance and audit trail") All grant decisions — approvals, denials, revocations, and expiries — are recorded as consent events in the compliance audit log. This is required for HIPAA and SOC 2 compliance. You cannot delete grant history; records are retained per your workspace's data-retention policy. If you have questions about a specific grant or notice unexpected access requests, contact your workspace administrator. --- # Account & Security Manage your personal account, login methods, and security settings. ## Your Account[​](#your-account "Direct link to Your Account") Access your account settings from the user menu (top-right) → **Account Settings**. ### Profile Information[​](#profile-information "Direct link to Profile Information") | Field | Description | | --------- | ------------------------------------------------ | | **Name** | Your display name across all workspaces | | **Email** | Primary login credential, used for notifications | | **Phone** | Optional, enables SMS login and notifications | ## Login Methods[​](#login-methods "Direct link to Login Methods") ### Email & Password[​](#email--password "Direct link to Email & Password") Traditional login with email and password. Set or change your password in Account Settings → **Security**. **Password requirements:** 12–72 characters. Any characters are accepted — no mandatory uppercase, lowercase, digit, or special-character rules. Passwords are checked against a database of passwords exposed in known data breaches; you will be asked to choose a different one if yours appears there. ### Magic Links[​](#magic-links "Direct link to Magic Links") Passwordless login via email: 1. Enter your email on the login page 2. Click **Send Magic Link** 3. Check your email and click the link 4. You're logged in (no password needed) Magic links expire after 15 minutes and can only be used once. If your link expires before you click it, return to the login page and request a new one. ### Phone Login[​](#phone-login "Direct link to Phone Login") If your account has a phone number: 1. Enter your phone number on the login page 2. Receive a 6-digit code via SMS 3. Enter the code to log in ## Two-Factor Authentication (2FA)[​](#two-factor-authentication-2fa "Direct link to Two-Factor Authentication (2FA)") Add a second layer of security to your account. When enabled, you'll need both your password (or magic link) and a second factor to log in. ### Setting Up 2FA[​](#setting-up-2fa "Direct link to Setting Up 2FA") 1. Go to **Account Settings** → **Security** 2. Click **Enable Two-Factor Authentication** 3. Choose your method: | Method | How It Works | | --------------------- | ----------------------------------------------------------------------------- | | **Authenticator App** | Use Google Authenticator, Authy, or similar apps to generate time-based codes | | **Hardware Key** | Use a YubiKey or other WebAuthn-compatible security key | ### Authenticator App Setup[​](#authenticator-app-setup "Direct link to Authenticator App Setup") 1. Select **Authenticator App** 2. Scan the QR code with your authenticator app 3. Enter the 6-digit code from the app to verify 4. Save your recovery codes (see below) ### Recovery Codes[​](#recovery-codes "Direct link to Recovery Codes") When you enable 2FA, you receive 8 single-use recovery codes. Use these if you lose access to your authenticator: * Store codes securely (password manager, printed copy in a safe) * Each code works only once * Regenerate codes anytime from Security settings (invalidates old codes) ### Logging In with 2FA[​](#logging-in-with-2fa "Direct link to Logging In with 2FA") 1. Enter your email/password or use a magic link 2. When prompted, enter your 6-digit authenticator code 3. Alternatively, click **Use Recovery Code** if you don't have your authenticator ## Changing Your Email or Phone[​](#changing-your-email-or-phone "Direct link to Changing Your Email or Phone") ### Self-Service Change[​](#self-service-change "Direct link to Self-Service Change") Update your own credentials: 1. Go to **Account Settings** → **Profile** 2. Click **Change** next to Email or Phone 3. Enter your new email/phone 4. Enter the verification code sent to your **new** contact method 5. Change is applied immediately The verification code expires in 10 minutes. You can have only one pending change at a time. ### Admin-Initiated Change[​](#admin-initiated-change "Direct link to Admin-Initiated Change") Workspace admins can initiate credential changes for members (useful when a member loses access to their email/phone): 1. Admin sends an invitation to update credentials 2. Invitation is sent to the member's **current** contact method 3. Member clicks the link and confirms the change 4. Credential is updated See [Members](https://docs.gravityrail.com/user-guide/people) for admin instructions. ## Session Management[​](#session-management "Direct link to Session Management") Your login sessions last 7 days. Sessions are workspace-independent—logging into one workspace logs you into all workspaces you have access to. To log out: * Click your user menu → **Log Out** * This ends your session on the current device ## Security Best Practices[​](#security-best-practices "Direct link to Security Best Practices") * **Enable 2FA** for accounts with admin access * **Use unique passwords** or rely on magic links * **Keep recovery codes** in a secure location separate from your authenticator * **Review account activity** if you suspect unauthorized access --- # Analytics & Usage Reports Usage reports let organization owners and admins see where their workspace spends time, money, and messages. You can pull AI token consumption, SMS volume, phone minutes, voice (speech-to-text and text-to-speech) usage, and per-member totals, scoped to any date range you pick. Reports are available in two ways: through the live **Detailed Reports** tab in **Settings → Billing** (`/w/{wid}/settings/billing`), and via the REST API for scripted exports, BI tools, or cost-allocation pipelines. ## Who Can Access Reports[​](#who-can-access-reports "Direct link to Who Can Access Reports") Usage reports return financial and operational data, so access is gated by scope: | Report | Required scope | | ------------------------------------ | ---------------- | | AI usage (`/reports/ai-usage`) | `analytics:read` | | SMS usage (`/reports/sms-usage`) | `analytics:read` | | Phone usage (`/reports/phone-usage`) | `analytics:read` | | Voice usage (`/reports/voice-usage`) | `analytics:read` | | Member usage — your own | `members:read` | | Member usage — anyone else's | `analytics:read` | The `analytics:read` scope is what the product calls "View analytics and reports." It's included in the default workspace manager and admin roles, and it's grantable to any custom role. See [Roles & Permissions](https://docs.gravityrail.com/user-guide/members/roles.md) for how to assign scopes to a role. Members can always see their own member-usage report. Only members with `analytics:read` can look at someone else's. ## Getting an API Key[​](#getting-an-api-key "Direct link to Getting an API Key") Reports are served by `https://api.gravityrail.com`. To call the endpoints you need a scoped API key: 1. Go to **Apps** → **API Keys** 2. Click **Create API Key** 3. Give it a clear name (e.g., "Monthly Billing Export") 4. Pick an expiration (1–365 days) 5. Grant the `analytics:read` scope — and `members:read` if you want to pull other members' usage 6. Click **Create** and copy the key immediately (it won't be shown again) Every request below uses the header `Authorization: Bearer `. See [Apps & API Keys](https://docs.gravityrail.com/user-guide/developer/apps.md) for more detail. You'll also need your **workspace UUID**. It's the long identifier in your workspace URL (e.g., `app.gravityrail.com/w//chats`). ## The AI Usage Report[​](#the-ai-usage-report "Direct link to The AI Usage Report") The AI usage report summarizes everything your assistants generated: every chat message, every chat summary, every realtime voice turn. Use it to see which models are driving spend and which providers you lean on most. ### Request[​](#request "Direct link to Request") ``` curl "https://api.gravityrail.com/api/v2/w/{workspace_uuid}/reports/ai-usage?start_date=2026-04-01&end_date=2026-04-30" \ -H "Authorization: Bearer YOUR_API_KEY" ``` | Query parameter | Default | Notes | | --------------- | ----------- | ------------ | | `start_date` | 30 days ago | `YYYY-MM-DD` | | `end_date` | today | `YYYY-MM-DD` | ### What the response contains[​](#what-the-response-contains "Direct link to What the response contains") | Field | What it means | | -------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | | `total_messages` | Every message recorded in the workspace for the period — human and assistant, across all channels | | `total_tokens` | Sum of prompt + completion tokens used by your assistants | | `total_cached_tokens` | Portion of input tokens served from the provider's prompt cache. Higher is cheaper | | `total_audio_input_tokens` / `total_audio_output_tokens` | Realtime voice audio tokens, tracked separately from text | | `total_credits` | The Gravity Rail unit of AI spend for the period (see [Understanding Credits and Costs](#understanding-credits-and-costs)) | | `by_provider` | Totals broken out by provider (OpenAI, Anthropic, Google, AWS) | | `by_type` | Totals split between `chat` and `realtime` models | | `top_models` | The 10 models with the highest credit spend | ### What to look for[​](#what-to-look-for "Direct link to What to look for") * **Providers drifting in the wrong direction.** If one provider is creeping toward 80% of spend and you expected it to be 30%, a workflow is probably routing to the wrong model. * **A model in `top_models` that surprises you.** A development-grade model appearing in the top ten usually means a test workflow is running against real traffic. * **Low `total_cached_tokens` vs. `total_tokens`.** Prompt caching cuts cost substantially. A low ratio often means system prompts are being regenerated on every turn — worth investigating. ## The SMS Usage Report[​](#the-sms-usage-report "Direct link to The SMS Usage Report") Every text your workspace sends or receives is tracked. The SMS report gives you a day-by-day, phone-number-by-phone-number picture of what went out and came in. ### Request[​](#request-1 "Direct link to Request") ``` curl "https://api.gravityrail.com/api/v2/w/{workspace_uuid}/reports/sms-usage?start_date=2026-04-01&end_date=2026-04-30" \ -H "Authorization: Bearer YOUR_API_KEY" ``` | Query parameter | Default | Notes | | --------------- | -------------------------- | ------------ | | `start_date` | Start of current UTC month | `YYYY-MM-DD` | | `end_date` | End of current UTC month | `YYYY-MM-DD` | ### What the response contains[​](#what-the-response-contains-1 "Direct link to What the response contains") | Field | What it means | | ------------------------------------------------ | -------------------------------------------------------------------------------------- | | `totalMessages` | All SMS in the period | | `totalInbound` / `totalOutbound` | Direction split | | `totalCharacters` | Sum of characters sent + received | | `totalSegments` | Total carrier-billable segments (160 GSM chars / 70 Unicode chars per segment) | | `totalInboundSegments` / `totalOutboundSegments` | Segments by direction — useful when only outbound is metered | | `rows[]` | One row per date + phone number combination, each with its own inbound/outbound counts | ### What to look for[​](#what-to-look-for-1 "Direct link to What to look for") * **Segments, not characters.** Carriers bill per segment, and a single long or emoji-laden message can be several segments. Use `totalSegments` for cost estimates. * **Spikes on a single phone number.** Drill into `rows` to see if one number is carrying the whole workspace — that's often a routing issue or a runaway campaign. * **Inbound volume that dwarfs outbound.** Healthy automated workflows usually send more than they receive. The reverse can point to members stuck in an unresolved loop. ## The Phone Usage Report[​](#the-phone-usage-report "Direct link to The Phone Usage Report") The phone report covers voice calls in and out of your workspace numbers — the ones humans or AI answered. It only counts calls that reached a finished state with real start and end timestamps; missed and in-progress calls aren't included. ### Request[​](#request-2 "Direct link to Request") ``` curl "https://api.gravityrail.com/api/v2/w/{workspace_uuid}/reports/phone-usage?start_date=2026-04-01&end_date=2026-04-30" \ -H "Authorization: Bearer YOUR_API_KEY" ``` | Query parameter | Default | Notes | | --------------- | -------------------------- | ------------ | | `start_date` | Start of current UTC month | `YYYY-MM-DD` | | `end_date` | End of current UTC month | `YYYY-MM-DD` | ### What the response contains[​](#what-the-response-contains-2 "Direct link to What the response contains") | Field | What it means | | -------------------------------- | ------------------------------------------------------------------------------------- | | `totalCalls` | All finished calls in the period | | `totalInbound` / `totalOutbound` | Direction split | | `totalDurationSeconds` | Combined talk time — divide by 60 for minutes | | `rows[]` | One row per date + phone number combination with inbound/outbound counts and duration | ### What to look for[​](#what-to-look-for-2 "Direct link to What to look for") * **Average call duration by number.** Divide the row's `totalDurationSeconds` by `(inbound + outbound)` per day. A big jump usually means a workflow isn't hanging up when it should. * **Outbound volume on a number meant for inbound.** It's easy for a campaign to target the wrong line. The phone report surfaces that quickly. * **Days with unusual volume.** The daily breakdown makes it obvious when a single day drove a monthly spike. ## The Voice Usage Report[​](#the-voice-usage-report "Direct link to The Voice Usage Report") Voice calls use two AI services under the hood: speech-to-text (STT) to transcribe what the caller says, and text-to-speech (TTS) to generate the assistant's reply. Voice usage is billed via credits at the org level, so this report shows **usage volume only** — durations, characters, and message counts. ### Request[​](#request-3 "Direct link to Request") ``` curl "https://api.gravityrail.com/api/v2/w/{workspace_uuid}/reports/voice-usage?start_date=2026-04-01&end_date=2026-04-30" \ -H "Authorization: Bearer YOUR_API_KEY" ``` | Query parameter | Default | Notes | | --------------- | -------------------------- | ------------ | | `start_date` | Start of current UTC month | `YYYY-MM-DD` | | `end_date` | End of current UTC month | `YYYY-MM-DD` | ### What the response contains[​](#what-the-response-contains-3 "Direct link to What the response contains") | Field | What it means | | ------------------------------------- | ----------------------------------------------------------- | | `totalSttDurationSeconds` | Total seconds of audio transcribed across all STT providers | | `totalSttMessages` | Number of STT calls (one per transcribed message) | | `totalTtsCharacters` | Total characters converted to speech | | `totalTtsMessages` | Number of TTS calls | | `sttByProvider[]` / `ttsByProvider[]` | Totals broken out by provider and voice model | | `sttRows[]` / `ttsRows[]` | Daily breakdowns per provider + model | ### What to look for[​](#what-to-look-for-3 "Direct link to What to look for") * **Which voice provider is dominating.** If you set up a premium voice for one agent and a cheaper one for everything else, the provider breakdown tells you whether the split is working. * **TTS character growth.** Long assistant replies burn through TTS faster than brief ones — this is often the single biggest voice-cost lever. * **Models you don't recognize.** A fallback model showing up unexpectedly usually means the primary model failed to load somewhere. ## Member-Level Usage[​](#member-level-usage "Direct link to Member-Level Usage") The member usage report covers a single member's activity: chats they own, messages they sent, and AI usage incurred on their behalf. Org admins use it to allocate cost, and members can use it to check their own consumption. ### Request[​](#request-4 "Direct link to Request") ``` curl "https://api.gravityrail.com/api/v2/w/{workspace_uuid}/reports/member-usage/{member_id}?start_date=2026-04-01&end_date=2026-04-30" \ -H "Authorization: Bearer YOUR_API_KEY" ``` | Query parameter | Default | Notes | | --------------- | -------------------------- | ------------ | | `start_date` | Start of current UTC month | `YYYY-MM-DD` | | `end_date` | today (UTC) | `YYYY-MM-DD` | ### What the response contains[​](#what-the-response-contains-4 "Direct link to What the response contains") | Field | What it means | | --------------- | ------------------------------------------------------------------------ | | `memberId` | The member you queried | | `totalChats` | Chats created by this member in the period | | `totalMessages` | Messages sent by this member (any role) | | `totalCredits` | Total tokens consumed across the member's chats and their chat summaries | Find member IDs from the Members page or by listing members via `GET /api/v2/w/{workspace_uuid}/members`. ### What to look for[​](#what-to-look-for-4 "Direct link to What to look for") * **Cost per seat, not just total cost.** Comparing `totalCredits` across members normalizes spend by user, which is what billing and capacity conversations usually need. * **Members with high message counts but low credits.** That's a sign they're having short conversations — usually good. The reverse (few messages, many credits) often points to one long, expensive chat. * **Discrepancies against the workspace-level AI report.** Member usage attributes only what's anchored to a member's chats. System or agent-only work (e.g., scheduled routines) appears in the workspace total but not in any one member's report. That's by design. ## Understanding Credits and Costs[​](#understanding-credits-and-costs "Direct link to Understanding Credits and Costs") Gravity Rail measures AI spend in two related ways: * **Tokens** are the raw unit your AI provider counts — roughly one token per four characters of English text. * **Credits** are Gravity Rail's normalized unit of AI spend. Each model has a multiplier that converts its tokens into credits, so a premium model and a lightweight model consume different numbers of credits per token. Credits are what you'll see on your bill and what org-level quotas are enforced against. Both are pre-calculated at the moment usage is recorded. That means: * **Historical reports are locked to the prices that applied at the time.** If a provider lowers their prices next month, old reports won't retroactively get cheaper. * **You don't need to re-derive credits from tokens yourself.** The number in the report is the authoritative one; credit multipliers can change over time and per-model, so recomputing downstream will drift. For SMS and phone, the report gives you the raw usage primitives — messages, characters, segments, duration. Your carrier pricing converts those to dollars. Voice STT/TTS is billed via org-level credits, and the credit totals appear on your org billing, not in the voice-usage payload. ## Date Ranges and the UTC Caveat[​](#date-ranges-and-the-utc-caveat "Direct link to Date Ranges and the UTC Caveat") Every report accepts optional `start_date` and `end_date` parameters as `YYYY-MM-DD`. Both are **inclusive** — `2026-04-01` to `2026-04-30` covers the whole of April. **All daily breakdowns are bucketed in UTC.** That is important: * A call that starts at 10:00 PM Pacific on April 30 ends up on **May 1** in the report, because that's 5:00 AM UTC May 1. * If you're in the eastern U.S., daily totals roll over at 8:00 PM local (standard time) or 7:00 PM (daylight time) — not midnight. * Month totals align to UTC month boundaries. If your billing cycle ends on the last calendar day in your local time zone, ask for an extra day on either side and filter the rows yourself. Defaults follow the same rule: the SMS, phone, and voice reports default to the start-of-month and end-of-month **in UTC**, and member usage defaults to "start of the current UTC month." If month alignment matters, pass the dates explicitly. ## Tips[​](#tips "Direct link to Tips") * **Export once a month, reconcile once a quarter.** Pulling the AI, SMS, phone, and voice reports on the first of each month and parking them in a spreadsheet is the simplest path to trend analysis. * **Rotate API keys that you use for exports.** A 90-day expiration on the key you feed into a BI tool is a healthy default — see [Apps & API Keys](https://docs.gravityrail.com/user-guide/developer/apps.md). * **Scope sub-minute conversations carefully.** Phone reports round to the second, but very short calls (a dial and immediate hangup) are included and can inflate call counts. Filter the rows if you want only "real" conversations. * **Use the smallest date range that answers your question.** A 90-day AI report aggregates millions of rows in large workspaces. Narrow the range when you're iterating. * **Watch the realtime/chat split.** In `by_type`, realtime models are usually much more expensive per minute than chat models. If realtime credits climb without a corresponding increase in phone calls, that's worth a look. ## Troubleshooting[​](#troubleshooting "Direct link to Troubleshooting") ### "403 Forbidden" when requesting a usage report[​](#403-forbidden-when-requesting-a-usage-report "Direct link to \"403 Forbidden\" when requesting a usage report") Your API key doesn't include `analytics:read`. Create a new key with that scope, or update the role on the member whose API key you're using. Member-level usage for *your own* member ID only requires `members:read`; any other member requires `analytics:read`. ### Numbers don't match my provider invoice[​](#numbers-dont-match-my-provider-invoice "Direct link to Numbers don't match my provider invoice") A few common causes: * **Time zone.** The report is UTC; your invoice is almost certainly in a local time zone. * **Pending calls or messages.** In-progress or not-yet-finished calls don't appear in the phone report. * **Cached tokens.** AI providers typically discount cached prompt tokens. `total_cached_tokens` shows how much of your input was cached — this is usually the source of the discrepancy between raw token counts and billed amounts. ### A member's usage looks lower than expected[​](#a-members-usage-looks-lower-than-expected "Direct link to A member's usage looks lower than expected") Member usage attributes activity to the member who **owns** the chat. Agent-only work, scheduled routines, and system-initiated chats aren't attributed to any member and won't appear in their report. Cross-check against the workspace-level AI usage report for the full picture. ### The report is slow[​](#the-report-is-slow "Direct link to The report is slow") Large date ranges across large workspaces aggregate millions of rows. Narrow the date range, or split a yearly pull into monthly requests and combine the results client-side. ## Related[​](#related "Direct link to Related") * **[Apps & API Keys](https://docs.gravityrail.com/user-guide/developer/apps.md)** — Create and manage the API keys that authenticate report requests * **[Roles & Permissions](https://docs.gravityrail.com/user-guide/members/roles.md)** — Grant `analytics:read` to custom roles * **[Phone & Voice](https://docs.gravityrail.com/user-guide/channels/phone-and-voice.md)** — Configure the phone numbers whose usage these reports cover * **[Organizations](https://docs.gravityrail.com/user-guide/organizations.md)** — Manage org-level credits and billing * **[Workspace Settings](https://docs.gravityrail.com/user-guide/workspace-settings/.md)** — Configure time zone and workspace defaults --- # API Keys API keys enable secure programmatic access to your workspace for EHR integrations, CRM syncs, data pipelines, and custom automations. ## Access the Settings[​](#access-the-settings "Direct link to Access the Settings") Navigate to **Settings > API Keys** in your workspace. ## Create a Key[​](#create-a-key "Direct link to Create a Key") 1. Click **Create API Key**. 2. Enter a descriptive name. 3. Choose scopes (permissions) based on your use case: * Read-only: `members:read`, `chats:read`, `analytics:read` * EHR/CRM sync: `members:write`, `chats:write`, `records:write` 4. (Optional) Set an expiration date. 5. Click create. **Copy the full key immediately** — it is shown only once. ## Store Securely[​](#store-securely "Direct link to Store Securely") * Use environment variables or a secrets manager (e.g., AWS Secrets Manager). * Never commit keys to source control or share them in plain text. ## Revoke or Delete[​](#revoke-or-delete "Direct link to Revoke or Delete") In the API Keys list, select and revoke any key that is expired, unused, or no longer required. This immediately invalidates the key. --- # App Connections An **app connection** links your Gravity Rail workspace to an external service — a CRM (HubSpot, Salesforce), a project management tool (Monday.com), an EHR (eClinicalWorks, Epic, Cerner, Athena, Healthie), a chat platform (Slack, Discord), or a custom tool server (MCP). Once connected, you can sync members and records, trigger automations from external events, and give your AI agents access to data and actions in those systems. App Connections is the **integration hub** for your workspace. Every external service you wire up — whether it's a one-click OAuth integration like Gmail or a complex multi-board sync like Monday.com — appears here. The page consolidates platform integrations, MCP servers, Discord bots, Slack apps, FHIR connections, and CRM sync connections into a single browse-and-manage experience. ## Browsing Available Integrations[​](#browsing-available-integrations "Direct link to Browsing Available Integrations") Go to **App Connections** to open the integration hub. The page has two tabs: * **Active** — every connection currently configured in your workspace, grouped by type. * **Directory** — every integration you can add, with an **Install** button for each. ### Filtering and Searching the Directory[​](#filtering-and-searching-the-directory "Direct link to Filtering and Searching the Directory") The Directory tab supports both search and category filters so you can quickly find an integration: * **Search** — type a name (e.g., "Monday", "Linear", "FHIR") in the search box. * **Category filters** — narrow by **Messaging**, **Google**, **Healthcare**, **Project Management**, **Vehicle & IoT**, or **Tools**. * **View toggle** — switch between **Grid** (card view, default) and **List** (compact rows). Each directory tile shows the integration name, a short description, an icon, and a badge if you already have one or more connections of that type configured. ## Connecting an Integration[​](#connecting-an-integration "Direct link to Connecting an Integration") Most integrations use **OAuth** — you'll be redirected to the external service to authorize Gravity Rail, then sent back to your workspace once the grant is complete. ### General OAuth Flow[​](#general-oauth-flow "Direct link to General OAuth Flow") 1. On the **Directory** tab, find the integration you want 2. Click **Install** 3. Follow the setup wizard: * For OAuth integrations: click **Connect** to launch the provider's authorization page, sign in with the account you want to use, and approve the requested scopes * For API key integrations (e.g., Healthie): paste the API key and submit * For URL-based integrations (e.g., custom MCP servers): paste the server URL and configure auth as prompted 4. After the provider redirects you back, the new connection appears on the **Active** tab > **Use a service account where possible.** OAuth grants are tied to the user who authorized them. If that user leaves your organization or revokes Gravity Rail's access, the connection breaks. For production CRM, calendar, and EHR integrations, authorize with a dedicated service account rather than a personal one. ### Integration-Specific Setup[​](#integration-specific-setup "Direct link to Integration-Specific Setup") Some integrations have additional setup steps documented in their own guides: * **Monday.com** — see **[Monday.com Setup](https://docs.gravityrail.com/user-guide/app-connections/monday-setup.md)** for app creation and OAuth, then **[Monday.com Sync](https://docs.gravityrail.com/user-guide/app-connections/monday-sync.md)** for board mappings and sync rules * **HubSpot** — see **[HubSpot Sync](https://docs.gravityrail.com/user-guide/app-connections/hubspot-sync.md)** for sync rules, CEL expressions, and field filters * **Salesforce** — see **[Salesforce](https://docs.gravityrail.com/user-guide/channels/salesforce.md)** for CRM sync configuration * **Healthie** — see **[Healthie](https://docs.gravityrail.com/user-guide/channels/healthie.md)** for appointment and patient sync * **Slack** — see **[Slack Bots](https://docs.gravityrail.com/user-guide/channels/slack.md)** for app creation and bot setup * **Discord** — see **[Discord Bots](https://docs.gravityrail.com/user-guide/channels/discord-bots.md)** for bot setup * **Confluence** — see **[Confluence Sync](https://docs.gravityrail.com/user-guide/app-connections/confluence-sync.md)** for space mapping and sync configuration ## Viewing Connected Apps and Their Status[​](#viewing-connected-apps-and-their-status "Direct link to Viewing Connected Apps and Their Status") The **Active** tab is where you check on connections that are already wired up. Connections are grouped by type: * **Platform Integrations** — OAuth-based platform apps (Gmail, Google Calendar, Confluence, etc.) * **CRM Connections** — HubSpot, Salesforce, Monday.com * **Healthcare Connections** — FHIR (eClinicalWorks, Epic, Cerner, Athena), Healthie * **MCP Servers** — Linear, Sentry, Notion, DeepWiki, PayPal, NetSuite, custom URLs * **Discord Bots** — configured Discord bot integrations * **Slack Apps** — configured Slack app integrations Each row shows: * **Name** — the connection's display name (you can rename it in settings) * **Status badge** — **Connected**, **Disabled**, **Reauthorize Required**, or **Error** * **Action menu** — **View**, **Edit**, **Settings**, **Sync now**, **Disable**, or **Delete** Click a row to expand it and see additional details: the OAuth account in use, available tools, last sync time, and any error messages from the provider. ## Configuring an Active Connection[​](#configuring-an-active-connection "Direct link to Configuring an Active Connection") After a connection is installed, click **Settings** (or open the connection's detail page) to configure it. ### Renaming a Connection[​](#renaming-a-connection "Direct link to Renaming a Connection") Several integrations support multiple connections of the same type (for example, two HubSpot portals or several Monday.com workspaces). Give each one a descriptive name so AI agents and automations pick the right one: 1. Open the connection's settings 2. Edit the **Name** field 3. Click **Save** ### Configuring Sync[​](#configuring-sync "Direct link to Configuring Sync") Sync-capable connections (HubSpot, Salesforce, Monday.com, FHIR/eClinicalWorks) support **bidirectional data sync** — keeping members and records in step between Gravity Rail and the external system. Sync is configured per **entity type** (member, record, calendar event, file). For each entity type you want to sync: 1. Open the connection's **Sync** tab 2. Add or edit the entity sync config: * **Outbound** — push Gravity Rail data to the external system * **Inbound** — pull external data into Gravity Rail * **Match Strategy** — how to find existing records (typically by email, external ID, or phone) * **Conflict Policy** — what to do when both sides have changed (skip, prefer-source, prefer-target) * **Filter** — an optional CEL expression that limits which entities sync (e.g., `source.email != '' && source.age >= 18`) * **Rules** — named groups of field mappings, each with its own CEL transforms 3. Click **Save** 4. Click **Sync now** to run an initial pass, or wait for the schedule to pick it up For a complete walkthrough of sync rules, CEL expressions, and field transforms, see **[HubSpot Sync](https://docs.gravityrail.com/user-guide/app-connections/hubspot-sync.md)** — the same concepts apply to all sync-capable connectors. ### Trust and Scope Settings[​](#trust-and-scope-settings "Direct link to Trust and Scope Settings") Some integrations expose tools that AI agents can call (for example, "create a HubSpot note", "upsert a Monday.com item", or "look up a FHIR patient"). To control which agents can use them: 1. Open the connection's **Settings** tab 2. Review the **Tools** section — each tool lists the action it performs 3. Toggle individual tools on or off 4. For **agent permissions**, attach the connection's tools to a workflow's task or to an agent's abilities — see **[Custom Toolkits](https://docs.gravityrail.com/user-guide/abilities/custom-toolkits.md)** for the full ability-attachment flow > **Principle of least privilege.** Only grant the scopes and tools you actually need. If a workflow only needs to read Salesforce contacts, don't grant write access. Re-authorize the connection with a narrower scope set if your provider supports it. ## Disconnecting and Revoking Access[​](#disconnecting-and-revoking-access "Direct link to Disconnecting and Revoking Access") There are two ways to remove a connection: ### Disable[​](#disable "Direct link to Disable") **Disable** keeps the configuration in place but stops the connection from being used: 1. On the **Active** tab, click the action menu next to the connection 2. Choose **Disable** 3. Confirm A disabled connection can be re-enabled at any time without re-running OAuth. Use **Disable** when you want to pause a sync or temporarily stop AI agents from using a tool. ### Delete[​](#delete "Direct link to Delete") **Delete** removes the connection entirely, including stored OAuth tokens and configuration: 1. On the **Active** tab, click the action menu next to the connection 2. Choose **Delete** 3. Confirm — this is destructive Sync rules, board mappings, and any custom configuration are deleted. To reconnect, install the integration again from the **Directory** tab and re-run setup. > **Also revoke from the provider side.** Deleting a connection in Gravity Rail removes our copy of the OAuth token, but most providers also keep their own record of the grant. To fully revoke access, sign in to the provider (e.g., HubSpot, Salesforce, Google) and remove the Gravity Rail integration from their connected-apps list. ## Currently Supported Integrations[​](#currently-supported-integrations "Direct link to Currently Supported Integrations") | Integration | Category | Capabilities | | ------------------------- | ------------------ | ----------------------------------------------------------------------------------- | | **Gmail** | Productivity | Read and send email from a connected Google account | | **Google Calendar** | Productivity | Sync events with a Google Calendar | | **HubSpot** | CRM | Bidirectional member sync, notes, tasks, AI tools | | **Salesforce** | CRM | Bidirectional member/record sync, notes, tasks, AI tools | | **Monday.com** | Project Management | Bidirectional member/item sync, multi-board mappings, automations, webhook triggers | | **eClinicalWorks** (FHIR) | Healthcare | Patient data, encounters, observations, care plan items | | **Epic** (FHIR) | Healthcare | Patient data via FHIR R4 | | **Cerner** (FHIR) | Healthcare | Patient data via FHIR R4 | | **Athena** (FHIR) | Healthcare | Patient data via FHIR R4 | | **Generic FHIR** | Healthcare | Connect to any FHIR R4-compatible EHR | | **Healthie** | Healthcare | Appointment sync, patient reconciliation | | **Slack** | Communication | Bot messaging, channel monitoring, slash commands | | **Discord** | Communication | Bot commands, DMs, gateway events | | **Confluence** | Knowledge | Sync Confluence pages and spaces to your knowledge base | | **MCP Servers** | Developer | Linear, Sentry, Notion, DeepWiki, PayPal, NetSuite, or any custom MCP URL | This list grows over time. The **Directory** tab in your workspace always reflects the current set of available integrations, including any that are gated behind feature flags for your plan or organization. ## Tips[​](#tips "Direct link to Tips") * **Authorize with a service account** — OAuth grants are tied to a user. Personal accounts cause connections to break when people leave or revoke access. * **Name connections descriptively** — "HubSpot — Production Portal" beats "HubSpot 2" when an agent has to pick between two. * **Test sync on a small filter first** — Add an `outbound_filter` like `source.labels.exists(l, l == 'sync-test')` to limit your first sync to a handful of test members before opening the floodgates. * **Check the Active tab after every redeploy** — `Reauthorize Required` badges show up here when a token expires or a provider rotates secrets. * **Disable, don't delete, when troubleshooting** — Disabling preserves config so you can re-enable and inspect the same setup once the issue is resolved. ## Troubleshooting[​](#troubleshooting "Direct link to Troubleshooting") ### "Reauthorize Required" badge[​](#reauthorize-required-badge "Direct link to \"Reauthorize Required\" badge") The provider's access token has expired, been revoked, or had its scopes changed. Open the connection and click **Reauthorize** to re-run the OAuth flow with the same account. If the original authorizing user no longer has access, set up a new connection with a service account instead. ### "Insufficient scopes" or "permission denied" errors[​](#insufficient-scopes-or-permission-denied-errors "Direct link to \"Insufficient scopes\" or \"permission denied\" errors") The OAuth grant didn't include the scopes the integration needs. Common causes: * The user authorizing did not approve all requested scopes — re-run authorization and approve everything * The provider account lacks admin privileges for the requested resources (e.g., a Salesforce user without API access) * The integration was authorized before a new feature was added — disconnect and reconnect to pick up the new scope set ### Sync isn't picking up changes[​](#sync-isnt-picking-up-changes "Direct link to Sync isn't picking up changes") * Verify the entity has both **Outbound** (or **Inbound**) **Enabled** in the connection's **Sync** tab * Check the **filter** CEL expression — if it returns false for your entity, sync skips it * Open the connection's detail page and look at **Last Sync** — repeated failures show their error messages there * For inbound sync, verify the provider's webhook or change-feed is reaching Gravity Rail — see **[Webhooks](https://docs.gravityrail.com/user-guide/developer/webhooks.md)** for diagnosis ### "Tool not found" or AI agent says it can't reach the integration[​](#tool-not-found-or-ai-agent-says-it-cant-reach-the-integration "Direct link to \"Tool not found\" or AI agent says it can't reach the integration") * Confirm the connection is on the **Active** tab and not **Disabled** * Verify the tool is enabled in the connection's **Settings → Tools** section * Check that the workflow task or agent ability has the integration's tools attached — see **[Custom Toolkits](https://docs.gravityrail.com/user-guide/abilities/custom-toolkits.md)** ### Duplicate records appearing after sync[​](#duplicate-records-appearing-after-sync "Direct link to Duplicate records appearing after sync") The **Match Strategy** isn't finding existing records, so sync creates new ones. Common causes: * Match by email, but external records have empty or differently-cased emails * Match by external ID, but the IDs aren't populated yet on the Gravity Rail side * A new entity type was added without a match strategy Switch to a different match key (e.g., email + phone fallback), populate the missing field, or run a one-time reconciliation from the connection's detail page. ### Can't disable or delete a connection[​](#cant-disable-or-delete-a-connection "Direct link to Can't disable or delete a connection") If a connection is referenced by an active workflow ability or sync rule, the UI prevents deletion. Detach the connection from those references first, then retry. Workspace admins (the `apps:admin` scope) are the only roles allowed to delete connections — if the option is missing, ask a workspace admin to perform the action. ## Related[​](#related "Direct link to Related") * **[HubSpot Sync](https://docs.gravityrail.com/user-guide/app-connections/hubspot-sync.md)** — Detailed sync rule configuration with CEL expressions * **[Monday.com Setup](https://docs.gravityrail.com/user-guide/app-connections/monday-setup.md)** — Create a Monday.com app and connect it * **[Monday.com Sync](https://docs.gravityrail.com/user-guide/app-connections/monday-sync.md)** — Board mappings, sync rules, and automations * **[Salesforce](https://docs.gravityrail.com/user-guide/channels/salesforce.md)** — Connect to Salesforce CRM * **[Healthie](https://docs.gravityrail.com/user-guide/channels/healthie.md)** — Sync appointments and patients with Healthie EHR * **[Slack Bots](https://docs.gravityrail.com/user-guide/channels/slack.md)** — Deploy AI bots in Slack * **[Discord Bots](https://docs.gravityrail.com/user-guide/channels/discord-bots.md)** — Deploy AI bots in Discord * **[Custom Toolkits](https://docs.gravityrail.com/user-guide/abilities/custom-toolkits.md)** — Attach connection tools to AI agents * **[Webhooks](https://docs.gravityrail.com/user-guide/developer/webhooks.md)** — Receive events from external systems * **[Apps & API Keys](https://docs.gravityrail.com/user-guide/developer/apps.md)** — OAuth grants and API keys for the Gravity Rail API --- # Confluence Sync Connect Atlassian Confluence Cloud to your workspace and sync selected spaces into folders as Markdown files. Once configured, every page in the mapped spaces appears in the workspace virtual file system — where agents retrieve it for RAG and where members can search or browse it like any other folder. Confluence sync is currently **inbound only** (Confluence to Gravity Rail) and **read-only**: pages are pulled on a schedule or on demand, but Gravity Rail never writes back to Confluence. ## Before You Start[​](#before-you-start "Direct link to Before You Start") You'll need: 1. **An Atlassian Cloud site** with Confluence enabled. Data Center and Server are not supported. 2. **Admin access** to the Confluence site so you can approve the OAuth scopes during the connection flow. 3. **The Confluence feature enabled** on your workspace. If you don't see Confluence in the App Connections directory, ask your Gravity Rail administrator to turn on the `confluence` feature flag. 4. **A destination folder** in the workspace file system for each Confluence space you plan to sync. You can create folders under **Files** before or after starting the connection — whichever is easier. ## Connecting Confluence[​](#connecting-confluence "Direct link to Connecting Confluence") 1. Go to **App Connections** and open the **Directory** tab. 2. Find **Confluence** (Knowledge category) and click **Install**. 3. Click **Connect** — you'll be redirected to `auth.atlassian.com` to sign in. 4. Choose the Atlassian site whose Confluence spaces you want to sync. 5. Approve the requested scopes. Gravity Rail requests read-only access to spaces and page content plus `offline_access` so the sync can keep running without re-prompting. 6. You'll be redirected back to your workspace. The new connection appears on the **Active** tab. Only one Confluence connection is supported per workspace (singleton). If you need to switch sites, delete the existing connection first. > **Use a service account where possible.** OAuth grants are tied to the user who authorized them. If that user leaves your organization or revokes the integration's access, sync stops working. For production knowledge-base sync, authorize with a dedicated Atlassian service account. ## Mapping Spaces to Folders[​](#mapping-spaces-to-folders "Direct link to Mapping Spaces to Folders") After connecting, open the Confluence connection's **Sync** tab to configure which Confluence spaces sync into which workspace folders. 1. Click **Add Space**. 2. In the **Confluence Space** dropdown, pick one of the spaces the connected account can see. 3. In the **Destination Folder** selector, pick the workspace folder where pages should land. Start typing to filter the folder list. 4. Add more mappings if you need multiple spaces. Each space can only map to one destination folder, and a space can't be mapped twice. 5. Click **Save Sync Settings**. The mappings you save are stored on the connection and used for every subsequent sync — manual or scheduled. ### How Pages Land in the Destination Folder[​](#how-pages-land-in-the-destination-folder "Direct link to How Pages Land in the Destination Folder") * Each Confluence **space** becomes a top-level subfolder under its destination folder. * Each **parent page** in Confluence becomes a nested subfolder. * Each **page** is created as a Markdown file inside that folder hierarchy. The file's title matches the Confluence page title. * Page content is converted from Confluence's XHTML "storage format" to Markdown so agents and members can read it as plain text. * The source Confluence page URL is preserved on the file so agents can cite it. ### Removing a Mapping[​](#removing-a-mapping "Direct link to Removing a Mapping") To stop syncing a space, click the trash icon next to its row in the Sync tab and click **Save Sync Settings**. Files previously created by that mapping remain in the destination folder unless you delete them manually. ## Running a Sync[​](#running-a-sync "Direct link to Running a Sync") ### Manual Sync[​](#manual-sync "Direct link to Manual Sync") From the connection's **Logs** tab, click **Sync Now** to run a full sync immediately. Progress streams live to your browser — you'll see each page as it's fetched and converted. ### Scheduled Sync[​](#scheduled-sync "Direct link to Scheduled Sync") Once sync is configured, Gravity Rail runs a background sync on a regular cadence and only fetches pages that have changed since the last successful run (incremental sync using Confluence's CQL `lastModified` filter). You don't need to schedule anything by hand. ## Viewing Sync Logs[​](#viewing-sync-logs "Direct link to Viewing Sync Logs") The **Logs** tab shows recent sync runs: when they started, how many pages were processed, and any errors. Click a run to expand it and see per-page detail. Failed pages appear highlighted with the provider's error message attached. ## Troubleshooting[​](#troubleshooting "Direct link to Troubleshooting") ### "Reauthorize Required" badge[​](#reauthorize-required-badge "Direct link to \"Reauthorize Required\" badge") The Atlassian access token has expired or been revoked. Open the connection and click **Reauthorize** to re-run the OAuth flow. If the authorizing user no longer has access, delete the connection and reconnect with a service account. ### A space I expect doesn't appear in the dropdown[​](#a-space-i-expect-doesnt-appear-in-the-dropdown "Direct link to A space I expect doesn't appear in the dropdown") The OAuth grant is scoped to whichever Atlassian site you picked during **Connect**. Spaces on a different site are not visible. If the account you authorized doesn't have access to the space, ask a Confluence admin to grant access and then click **Reauthorize**. ### Pages are missing or out of date[​](#pages-are-missing-or-out-of-date "Direct link to Pages are missing or out of date") * Check that the space is mapped in the **Sync** tab and that you saved after adding the mapping. * Run **Sync Now** once to confirm the space fetches correctly — scheduled syncs pick up changes on an interval. * Check the **Logs** tab for the most recent run. Per-page errors (rate limit, permission denied, content too large) are shown there. ### Sync completes but content looks wrong[​](#sync-completes-but-content-looks-wrong "Direct link to Sync completes but content looks wrong") The content converter turns Confluence's XHTML storage format into Markdown. Complex macros and embedded attachments may render as plain text or be skipped. File a bug with an example page link if a specific construct isn't converting cleanly. ### Rate-limit or timeout errors[​](#rate-limit-or-timeout-errors "Direct link to Rate-limit or timeout errors") Confluence throttles API requests per site. Large initial syncs may retry automatically. If retries don't resolve it, stagger mappings (save one space, let it sync, then add the next). ## Disconnecting[​](#disconnecting "Direct link to Disconnecting") To remove the Confluence integration: 1. Go to the **Active** tab on the App Connections page. 2. Open the connection's action menu and choose **Disable** (pause sync, keep config) or **Delete** (remove entirely). Files already synced into workspace folders remain in place after disable or delete. Remove them manually if you want them gone. > **Also revoke from Atlassian.** Deleting the connection in Gravity Rail removes our copy of the OAuth token, but Atlassian keeps its own record of the grant. To fully revoke access, sign in to [id.atlassian.com](https://id.atlassian.com) and remove Gravity Rail from **Connected Apps**. ## Related[​](#related "Direct link to Related") * **[App Connections](https://docs.gravityrail.com/user-guide/app-connections/.md)** — Overview of the integration hub * **[Files](https://docs.gravityrail.com/user-guide/knowledge/files.md)** — Managing the workspace file system where synced pages live * **[HubSpot Sync](https://docs.gravityrail.com/user-guide/app-connections/hubspot-sync.md)** — Companion guide for member sync (different concepts, similar flow) --- # HubSpot Sync Sync data between Gravity Rail and HubSpot so your CRM stays current without manual work. Push member updates to HubSpot contacts, pull contact changes back into Gravity Rail, or run both directions at once. You control exactly which fields sync and how they're transformed along the way. ## Before You Start[​](#before-you-start "Direct link to Before You Start") You'll need two things in place before configuring sync: 1. **A connected HubSpot account** -- Your workspace must have an active HubSpot integration with OAuth connected. If you haven't set this up yet, go to **Developer > Apps** and connect HubSpot first. 2. **The HubSpot feature enabled** -- Your workspace needs the HubSpot feature flag. Contact your Gravity Rail administrator if you don't see the HubSpot option under Developer. ## Enabling Sync[​](#enabling-sync "Direct link to Enabling Sync") 1. Go to **Developer > HubSpot** and select the **Sync** tab. 2. You'll see a sync configuration for each entity type (e.g., members). Each entity type has its own toggles: * **Enable outbound sync** -- Pushes data from Gravity Rail to HubSpot. * **Enable inbound sync** -- Pulls HubSpot data into Gravity Rail. 3. Turn on one or both directions for each entity type you want to sync. 4. Click **Save Sync Settings** at the bottom of the page. You can enable one direction and add the other later. If you're setting this up for the first time, starting with outbound only is a good approach -- it lets you verify your field mappings before pulling data back. ### Entity Types[​](#entity-types "Direct link to Entity Types") The sync framework supports multiple entity types. Each connector supports a subset of these, and the available types are shown in the Sync tab: | Entity Type | Description | HubSpot Support | | ------------------- | ----------------------------------------------------- | -------------------- | | **member** | Sync workspace members with external contacts/records | Yes | | **record** | Sync data records (form submissions) | No (Monday.com only) | | **calendar\_event** | Sync calendar events | No | | **file** | Sync files | No | HubSpot currently supports the **member** entity type, syncing workspace members with HubSpot contacts. ## Understanding Sync Rules[​](#understanding-sync-rules "Direct link to Understanding Sync Rules") A **sync rule** is a named group of field mappings that defines how a specific piece of data moves between Gravity Rail and HubSpot. Each rule has a name (like "Name" or "Email") and contains one or more operations in each direction. Think of a rule as a container for related data. The "Name" rule, for example, handles splitting a member's full name into first and last name for HubSpot (outbound), and joining first and last name back into a full name for Gravity Rail (inbound). Keeping these operations grouped under one rule makes them easier to find and manage. ### Default Rules[​](#default-rules "Direct link to Default Rules") When you first enable sync, three rules are created automatically: | Rule | Outbound (GR to HubSpot) | Inbound (HubSpot to GR) | | --------- | --------------------------------------------------------- | --------------------------------------------------------- | | **Name** | Splits the member's name into `firstname` and `lastname` | Joins `firstname` and `lastname` into the member's name | | **Email** | Copies the member's email to the HubSpot `email` property | Copies the HubSpot `email` property to the member's email | | **Phone** | Copies the member's phone to the HubSpot `phone` property | Copies the HubSpot `phone` property to the member's phone | These defaults cover the most common fields. You can edit them, disable individual rules with their toggle switch, or delete them entirely if they don't fit your setup. ### Creating a New Rule[​](#creating-a-new-rule "Direct link to Creating a New Rule") 1. In the **Sync Rules** card, click **Add Sync Rule**. 2. A new rule appears with the name "New Rule." Click the name to rename it to something descriptive (e.g., "Company" or "Insurance Status"). 3. Click the chevron to expand the rule and see its outbound and inbound operations. 4. Add operations in either or both directions (see sections below). 5. Click **Save Sync Settings** when you're done. ### Editing a Rule[​](#editing-a-rule "Direct link to Editing a Rule") Each rule card shows a summary of how many outbound and inbound operations it contains (e.g., "2 out, 1 in"). Click the chevron to expand it and see the full details. You can: * **Rename** the rule by editing the text field in the header. * **Enable or disable** the rule with the toggle switch. Disabled rules are saved but skipped during sync. * **Delete** the rule with the trash icon. This removes it permanently. ## Outbound Operations (Gravity Rail to HubSpot)[​](#outbound-operations-gravity-rail-to-hubspot "Direct link to Outbound Operations (Gravity Rail to HubSpot)") An outbound operation takes data from a Gravity Rail member and writes it to a HubSpot contact property. Each operation has two parts: * **Source** (left side) -- What data to read from the member. Select from the dropdown or write a custom expression. * **HubSpot property** (right side) -- Which HubSpot contact property to write the value to. The dropdown shows all properties available on your HubSpot contacts. To add an outbound operation, expand a rule and click **Add outbound**. ### Source Options[​](#source-options "Direct link to Source Options") The source dropdown includes several categories of member data: | Category | Examples | Description | | --------------------- | ----------------------------------------- | ------------------------------------------------------------------- | | **Core properties** | Name, Email, Phone | Standard member fields | | **Managed fields** | Any custom fields defined on your members | Fields created by integrations or custom configuration | | **Form fields** | Intake: Status, Assessment: Score | Values from form records attached to the member | | **Labels** | VIP, Active, At Risk | Whether the member has a specific label applied | | **Custom Expression** | Any CEL expression | Full control over the value (see [Expressions](#expressions) below) | ### Example: Syncing a Form Field to HubSpot[​](#example-syncing-a-form-field-to-hubspot "Direct link to Example: Syncing a Form Field to HubSpot") Suppose you have a form called "Intake" with a field called "Insurance Provider," and you want that value to appear on the HubSpot contact as a custom property: 1. Expand your rule (or create a new one called "Insurance"). 2. Click **Add outbound**. 3. On the left, open the source dropdown and select **Intake: Insurance Provider** from the list. 4. On the right, search for your HubSpot custom property (e.g., `insurance_provider`). 5. Save. Now, every time a sync runs, each member's insurance provider value will be written to HubSpot. ## Inbound Operations (HubSpot to Gravity Rail)[​](#inbound-operations-hubspot-to-gravity-rail "Direct link to Inbound Operations (HubSpot to Gravity Rail)") An inbound operation takes data from a HubSpot contact and writes it to a Gravity Rail member. Each operation has two parts: * **HubSpot source** (left side) -- Which HubSpot property to read. Select from the dropdown, which shows all contact properties from your HubSpot account, or write a custom expression. * **GR field** (right side) -- Where to store the value in Gravity Rail. The dropdown organizes targets into groups. To add an inbound operation, expand a rule and click **Add inbound**. ### Target Types[​](#target-types "Direct link to Target Types") When selecting where to store inbound data, the GR field dropdown offers four categories: | Target | When to use it | Examples | | ------------------- | ----------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | | **Core Properties** | Update standard member fields | Name, Email, Phone | | **Managed Fields** | Store data as a custom field on the member, managed by the HubSpot connection | Company name, job title, or any HubSpot property you want visible on the member profile | | **Labels** | Apply or remove a member label based on a HubSpot value | *Coming soon* -- shown in the UI but not yet functional for HubSpot | | **Form Fields** | Write to a field on a form record | *Coming soon* -- shown in the UI but not yet functional for HubSpot | You can also create new managed fields directly from the dropdown if the one you need doesn't exist yet. > **Note:** For HubSpot, **Core Properties** and **Managed Fields** are the currently supported inbound targets. Labels and Form Fields appear in the dropdown but are not yet wired in the HubSpot sync adapter -- selecting them will have no effect. This will be addressed in a future update. ### Example: Pulling Company Name into Gravity Rail[​](#example-pulling-company-name-into-gravity-rail "Direct link to Example: Pulling Company Name into Gravity Rail") To bring each contact's company name from HubSpot into Gravity Rail as a managed field: 1. Create a new rule called "Company." 2. Click **Add inbound**. 3. On the left, select `company` from the HubSpot properties dropdown. 4. On the right, select an existing managed field or choose **New Managed Field** and name it (e.g., `hubspot:company`). 5. Save. The company name will now appear on each member's profile after the next inbound sync. ## Expressions[​](#expressions "Direct link to Expressions") Every source value in a sync operation is an expression written in CEL (Common Expression Language). Most of the time, you'll use the preset dropdowns and never need to think about this. But when you need more control -- splitting names, formatting values, or applying conditional logic -- you can select **Custom Expression** from the dropdown and write your own. ### How Expressions Work[​](#how-expressions-work "Direct link to How Expressions Work") In an outbound expression, the variable `source` refers to the Gravity Rail member. In an inbound expression, `source` refers to the HubSpot contact. You access properties with dot notation: | Expression | What it returns | | -------------------------------- | --------------------------------------------------------------- | | `source.name` | The member's full name (outbound) or contact property (inbound) | | `source.email` | The member's email address | | `source.phone` | The member's phone number | | `source.form_data.intake.status` | The "status" field from the member's "Intake" form record | ### Available Functions[​](#available-functions "Direct link to Available Functions") CEL includes several built-in functions for transforming text: | Function | What it does | Example | | ----------------------- | --------------------------------------- | --------------------------------------------------- | | `split(str, delimiter)` | Splits a string into a list | `split(source.name, ' ')[0]` returns the first word | | `trim(str)` | Removes leading and trailing whitespace | `trim(source.name)` | | `lowerAscii(str)` | Converts to lowercase | `lowerAscii(source.email)` | | `upperAscii(str)` | Converts to uppercase | `upperAscii(source.name)` | | `size(list)` | Counts items in a list | `size(split(source.name, ' '))` | | `contains(str)` | Checks if a string contains a substring | `source.email.contains('@gmail.com')` | ### Transform Presets[​](#transform-presets "Direct link to Transform Presets") The expression editor offers labeled presets for common transforms, so you don't need to write CEL for routine operations: | Preset | What it does | Expression it generates | | ------------------- | ----------------------------------------- | ------------------------------------- | | **No Transform** | Passes the value through unchanged | `value` | | **First Name** | Extracts the first word from a name | `split(value, ' ')[0]` | | **Last Name** | Extracts the last word from a name | Last word of a space-separated string | | **Trim Whitespace** | Removes extra spaces | `trim(value)` | | **Lowercase** | Converts to lowercase | `lowerAscii(value)` | | **Uppercase** | Converts to uppercase | `upperAscii(value)` | | **Email Domain** | Extracts the domain from an email address | Domain portion after the `@` | Select **Custom Expression** from the dropdown when none of the presets fit your needs. ### Conditional Logic[​](#conditional-logic "Direct link to Conditional Logic") CEL supports ternary expressions for conditional transforms. For example, to set a HubSpot property based on whether a member has a particular label: ``` source.has_label("vip") ? "VIP" : "Standard" ``` Or to handle missing data gracefully: ``` source.email.contains("@") ? split(source.email, "@")[1] : "" ``` ## Sync Filters[​](#sync-filters "Direct link to Sync Filters") Each entity type can have optional **outbound filter** and **inbound filter** expressions. These are CEL expressions evaluated per entity before sync runs. If the expression returns a falsy value, that entity is skipped entirely -- no sync operations are performed for it. Filters are useful for limiting sync to a subset of your data. For example, you might only want to sync members who have an email address, or only sync members with a specific label. ### Example Filters[​](#example-filters "Direct link to Example Filters") | Filter | What it does | | ----------------------------------------------- | ------------------------------------------------ | | `source.email != ''` | Only sync members that have an email address | | `source.has_label("vip")` | Only sync members with the "VIP" label | | `source.form_data.intake.status == 'completed'` | Only sync members whose intake form is completed | The filter context is the same as the sync rule expression context -- you have access to `source.name`, `source.email`, `source.phone`, `source.form_data`, `source.has_label()`, managed fields, and labels. ## Default Lifecycle Stage[​](#default-lifecycle-stage "Direct link to Default Lifecycle Stage") When outbound sync creates a new contact in HubSpot (rather than updating an existing one), you can automatically assign a lifecycle stage. This is useful for ensuring new contacts enter your HubSpot pipeline at the right stage. To configure this: 1. Scroll to the **Default Lifecycle Stage** section below the sync rules. 2. Select a stage from the dropdown: Subscriber, Lead, Marketing Qualified Lead, Sales Qualified Lead, Opportunity, Customer, Evangelist, or Other. 3. Select **None (do not set)** if you don't want to assign a stage automatically. This setting only applies to new contacts. If a contact already has a lifecycle stage set in HubSpot, it won't be overwritten. ## Running a Sync[​](#running-a-sync "Direct link to Running a Sync") ### Manual Sync[​](#manual-sync "Direct link to Manual Sync") To run a sync manually: 1. Go to the **Logs** tab (next to the Sync tab on the HubSpot page). 2. Depending on which sync directions you've enabled, you'll see up to three buttons: * **Sync Outbound** -- Pushes all member data to HubSpot. * **Sync Inbound** -- Pulls all HubSpot contact data into Gravity Rail. * **Sync All** -- Runs both directions. Only available when both outbound and inbound are enabled. 3. Click the appropriate button to start. The sync processes all members in your workspace. Progress streams live to your browser -- you can watch each member's status as it's processed. You can also start a sync from the Sync tab by clicking the **Sync Now** button in the top-right corner, which takes you to the Logs tab. ### Automatic Sync[​](#automatic-sync "Direct link to Automatic Sync") When sync is enabled, changes are also synced automatically. If a member's data is updated in Gravity Rail, the system triggers an outbound sync for that specific member. You don't need to configure this -- it's managed for you behind the scenes. ## Viewing Sync Logs[​](#viewing-sync-logs "Direct link to Viewing Sync Logs") The **Logs** tab shows you what happened during each sync run. ### Live Progress[​](#live-progress "Direct link to Live Progress") While a sync is running, you'll see: * A **progress summary bar** showing total members processed, along with counts for synced, failed, and skipped. * A **live event log** with one row per member, showing whether it synced successfully, failed, or was skipped. * A spinning sync icon on the **Sync All** button while the operation is in progress. ### Error Details[​](#error-details "Direct link to Error Details") If a member fails to sync, its row appears highlighted in red. Click on it to expand and see the specific error message. This is the fastest way to diagnose mapping issues. ### Sync History[​](#sync-history "Direct link to Sync History") Below the live event log, you'll find **Recent Sync History** -- a list of past sync executions showing the status (success or failure), the rule name, and the timestamp. ## Managed Fields[​](#managed-fields "Direct link to Managed Fields") When an inbound sync rule writes to a **managed field** target, that field appears on the member's profile alongside standard fields. Managed fields are owned by the HubSpot connection -- they're created automatically when you configure an inbound rule that targets one, and they stay in sync as long as inbound sync is enabled. For example, if you create an inbound rule mapping HubSpot's `company` property to a managed field called `hubspot:company`, every member matched to a HubSpot contact will show a "Company" field on their profile with the value pulled from HubSpot. ## Notes and Tasks[​](#notes-and-tasks "Direct link to Notes and Tasks") Beyond field sync, you can configure automatic HubSpot note or task creation when forms are submitted. This uses templates with form field variables (e.g., `{{ record.data.status }}`) to build the note or task content dynamically. This is useful for creating an audit trail in HubSpot when specific actions happen in Gravity Rail -- for example, creating a HubSpot note every time an intake form is completed. ## How Members Are Matched to Contacts[​](#how-members-are-matched-to-contacts "Direct link to How Members Are Matched to Contacts") When running a sync, the system needs to determine which HubSpot contact corresponds to which Gravity Rail member. It matches by email address or phone number. If a member has an email that matches a HubSpot contact, they're linked. If no match is found during an outbound sync, a new contact is created in HubSpot. ## Troubleshooting[​](#troubleshooting "Direct link to Troubleshooting") ### Member Email Address Is Not Valid[​](#member-email-address-is-not-valid "Direct link to Member Email Address Is Not Valid") HubSpot validates email formats strictly. If a member's email uses a non-standard format or domain (like `.test` or `.example`), HubSpot will reject it. Update the member's email to a valid address and re-run the sync. ### A Mapped HubSpot Property Does Not Exist[​](#a-mapped-hubspot-property-does-not-exist "Direct link to A Mapped HubSpot Property Does Not Exist") One of your outbound rules references a HubSpot contact property that doesn't exist. Open the Sync tab, expand the rule flagged in the error, and check the HubSpot property dropdown on each outbound operation. The property may have been deleted or renamed in HubSpot. ### HubSpot API Rate Limit Reached[​](#hubspot-api-rate-limit-reached "Direct link to HubSpot API Rate Limit Reached") HubSpot limits how many API calls can be made in a short period. If you hit this limit during a large sync, the system will retry automatically. For very large workspaces, the sync processes members in batches to stay within limits. ### HubSpot Authentication Failed[​](#hubspot-authentication-failed "Direct link to HubSpot Authentication Failed") Your OAuth tokens may have expired or been revoked. Go to **Developer > HubSpot** and reconnect the integration. You'll need to re-authorize with your HubSpot account. ### Expression Returns Empty for Some Members[​](#expression-returns-empty-for-some-members "Direct link to Expression Returns Empty for Some Members") If a CEL expression references form data (like `source.form_data.intake.status`) but a member doesn't have a record for that form, the expression returns an empty string. This is expected -- the field is simply not synced for that member. It's not an error. ### Sync Button Is Disabled[​](#sync-button-is-disabled "Direct link to Sync Button Is Disabled") The sync buttons on the Logs tab are only active when at least one sync direction is enabled. Go to the Sync tab and enable outbound or inbound sync, save your settings, then return to the Logs tab. ## Tips[​](#tips "Direct link to Tips") * **Start with outbound only.** Verify your field mappings work before enabling inbound. Check the Logs tab after your first sync to catch mapping issues early. * **Use presets for common transforms.** Custom expressions are powerful but easy to get wrong. The presets handle the most common cases (name splitting, case conversion, whitespace trimming) reliably. * **Use labels as inbound targets.** Map HubSpot properties to labels for automatic categorization. For example, pull the lifecycle stage from HubSpot and apply a "Customer" or "Lead" label based on the value. * **Name your rules clearly.** When you have more than a handful of rules, descriptive names ("Insurance Info," "Enrollment Status") make it much easier to find what you're looking for later. * **Check managed fields on the member profile.** After running an inbound sync, open a member's profile to verify the managed fields are showing the values you expect. ## Related[​](#related "Direct link to Related") * **[Channels](https://docs.gravityrail.com/user-guide/channels/.md)** -- Overview of all communication channels and integrations * **[Members](https://docs.gravityrail.com/user-guide/members/managing-members.md)** -- Managing member profiles and data * **[Forms](https://docs.gravityrail.com/user-guide/knowledge/forms.md)** -- Structured data collection used in sync rules * **[Labels](https://docs.gravityrail.com/user-guide/knowledge/labels.md)** -- Tagging and categorization for members --- # Monday.com Setup Monday.com is a common system of record for care coordination teams — tracking enrollments, referrals, outreach status, and patient demographics. The Monday.com App Connection lets you sync that data with Gravity Rail so your AI workflows, forms, and member profiles stay current without manual updates. This guide covers creating a Monday.com app and connecting it to Gravity Rail. Once connected, see [Monday.com Sync](https://docs.gravityrail.com/user-guide/app-connections/monday-sync.md) to configure board mappings and sync rules. ## How It Works[​](#how-it-works "Direct link to How It Works") The Monday.com connection uses OAuth to link your Monday account to your Gravity Rail workspace. You create a Monday.com app in your account's Developer Center, enter its credentials in Gravity Rail, and authorize the connection. Once authorized, Gravity Rail can read your boards and items, create and update items, and subscribe to board change events via webhooks. Each Gravity Rail workspace needs its own Monday.com app — even if multiple workspaces connect to the same Monday.com account. This ensures each workspace has its own permissions and callback URL. ## Before You Start[​](#before-you-start "Direct link to Before You Start") You'll need: 1. **A Monday.com account** with admin access to the boards you want to sync. 2. **Workspace admin permissions** in Gravity Rail. ## Step 1: Create a Monday.com App[​](#step-1-create-a-mondaycom-app "Direct link to Step 1: Create a Monday.com App") 1. Open your Monday.com account and click your **profile picture** in the top right corner. 2. Select **Developers**. The Developer Center opens in a new tab. ![Click your profile picture, then select Developers to open the Developer Center](/assets/images/monday-open-developers-9871ee1aba4648f3c3a45dc050b8fdd3.png) 3. Click **Create your first app** (or **Create app** if you already have apps). ![The Developer Center landing page with the Create your first app button](/assets/images/monday-create-app-first-933a51564de3f4a97ee9fe9d8c3a841a.png) ![The Developer Center with existing apps and the Create app button](/assets/images/monday-create-app-nth-55038a716a46d13bcb3f8c4c6b642f94.png) 4. Enter an **App name** (e.g., "Gravity Rail Sync") and an **App slug** (e.g., "gravityrail-sync"). The app slug is permanent and cannot be changed later — choose a stable, descriptive identifier. Click **Create app**. ![The Create new app dialog with app name and slug fields](/assets/images/monday-new-app-name-5979826465c74745663a4b0668236162.png) 5. In the left menu, go to **General Settings**. Under **App Credentials**, copy the **Client ID**, **Client Secret**, and **Signing Secret** — you'll need these in the next step. ![General Settings showing App Credentials with Client ID, Client Secret, and Signing Secret](/assets/images/monday-app-credentials-c3cb7dfe7e3699063eb12be4186b85c5.png) For more details on the Developer Center, see [Monday's documentation](https://developer.monday.com/apps/docs/the-developer-center). ## Step 2: Enter Credentials in Gravity Rail[​](#step-2-enter-credentials-in-gravity-rail "Direct link to Step 2: Enter Credentials in Gravity Rail") 1. In your Gravity Rail workspace, go to **Developer > App Connections**. 2. Find **Monday.com** in the list of available connections and click **Install**. 3. Enter the **Client ID**, **Client Secret**, and **Signing Secret** from your Monday.com app. ![The Configure Monday.com dialog with fields for Client ID, Client Secret, and Signing Secret](/assets/images/monday-configure-dialog-0a767768178669396d5e4e6cdf1d9d63.png) 4. Click **Create**. The Monday.com connection page opens with an "Awaiting OAuth" status. 5. On the **Overview** tab, expand **Setup Details** and copy the **OAuth Callback URL** — you'll need to add it to your Monday.com app. ![The Overview tab showing Setup Details with OAuth Callback URL, required scopes, and Connect button](/assets/images/monday-oauth-callback-url-and-scopes-badcd7696a2f5f2898b8d28545df7baf.png) ## Step 3: Configure OAuth in Monday.com[​](#step-3-configure-oauth-in-mondaycom "Direct link to Step 3: Configure OAuth in Monday.com") 1. Back in the Monday.com Developer Center, go to **Build > OAuth & Permissions**. 2. Select the **Redirect URLs** tab and paste the OAuth Callback URL from Gravity Rail. ![The OAuth \& Permissions page showing the Redirect URLs tab with the callback URL added](/assets/images/monday-app-redirect-urls-1fcd49e3860befa7fcdc8c2744549fed.png) 3. Select the **Scopes** tab and enable the following scopes: * `boards:read` * `boards:write` * `me:read` * `updates:write` * `webhooks:read` * `webhooks:write` ![The Scopes tab with the required scopes enabled](/assets/images/monday-app-scopes-a738e2215efcc832f76cba766869374b.png) 4. Click **Save changes**. ## Step 4: Connect[​](#step-4-connect "Direct link to Step 4: Connect") 1. Back in Gravity Rail, go to the **Overview** tab on the Monday.com connection page. 2. Click **Connect with Monday.com**. ![The Overview tab showing the Connect with Monday.com button](/assets/images/monday-connection-oauth-64398816094ad3714f384762ce521593.png) 3. You'll be redirected to Monday.com to authorize the app. Review the permissions and click **Authorize**. ![The Monday.com authorization screen showing the requested permissions and the Authorize button](/assets/images/monday-app-oauth-authorization-1bfe0b7bedcb3617f65d4d83edcf6422.png) 4. You'll be redirected back to Gravity Rail. Once connected, you'll see a green "Connected" badge under **Developer > App Connections > Active**. ![The App Connections page showing Monday.com with a green Connected badge](/assets/images/monday-overview-connected-d031ec51ddb29d3cd847bc75fc4c554b.png) ## The Monday.com Connection Page[​](#the-mondaycom-connection-page "Direct link to The Monday.com Connection Page") After connecting, you'll see six tabs: | Tab | Purpose | | ------------ | ------------------------------------------------------------------------------------------------------------------ | | **Overview** | Connection status, account info, authorization attribution, test/disconnect buttons, and collapsible setup details | | **Members** | View and manage links between Gravity Rail members and Monday items | | **Forms** | View form records linked to Monday items | | **Sync** | Configure board mappings and sync rules | | **Logs** | View sync activity, progress, and errors | ![The Monday.com connection page showing Overview, Members, Forms, Sync, and Logs tabs](/assets/images/monday-connection-tabs-3fec1b3d3abf3c7f11bc922e0cb25247.png) ### What Permissions Does Gravity Rail Request?[​](#what-permissions-does-gravity-rail-request "Direct link to What Permissions Does Gravity Rail Request?") | Scope | What it allows | | ---------------- | --------------------------------------------------- | | `me:read` | Read your user profile information | | `boards:read` | Read board data and items | | `boards:write` | Create and update items | | `account:read` | Read account info | | `webhooks:write` | Subscribe to board change events (for inbound sync) | Monday.com access tokens do not expire. Once connected, the integration stays active until you disconnect it. ## Troubleshooting[​](#troubleshooting "Direct link to Troubleshooting") ### "Connect with Monday.com" Button Does Nothing[​](#connect-with-mondaycom-button-does-nothing "Direct link to \"Connect with Monday.com\" Button Does Nothing") Make sure you've entered the Client ID and Client Secret in the configuration dialog first. Click the **Edit** button in the header to update credentials. ### OAuth Redirect Fails[​](#oauth-redirect-fails "Direct link to OAuth Redirect Fails") Check that the OAuth Callback URL in your Monday.com app's **Build > OAuth & Permissions > Redirect URLs** exactly matches the URL shown in the **Setup Details** section on the Gravity Rail Overview page. Even a trailing slash difference will cause the redirect to fail. ### "Awaiting OAuth" Status Won't Change[​](#awaiting-oauth-status-wont-change "Direct link to \"Awaiting OAuth\" Status Won't Change") After clicking **Authorize** in Monday.com, you should be redirected back to Gravity Rail and the status should change to "Connected." If it stays on "Awaiting OAuth," verify that all five scopes are enabled in your Monday.com app and that the redirect URL is correct. ### Connection Shows Error State[​](#connection-shows-error-state "Direct link to Connection Shows Error State") Click **Test Connection** on the Overview tab to diagnose. If the token is invalid, click **Disconnect** and repeat the OAuth flow from Step 4. You won't need to re-enter credentials or reconfigure the Monday.com app. ## Tips[​](#tips "Direct link to Tips") * **Copy credentials carefully.** Use the copy buttons in the Monday.com Developer Center rather than selecting text manually. A missing character in the Client Secret will cause a cryptic OAuth error. * **Test the connection immediately.** After completing Step 4, click **Test Connection** on the Overview tab before moving on to sync configuration. * **Bookmark your Developer Center app.** You'll return to it if you need to update scopes or check the signing secret. ## Next Steps[​](#next-steps "Direct link to Next Steps") Now that your Monday.com account is connected, see [Monday.com Sync](https://docs.gravityrail.com/user-guide/app-connections/monday-sync.md) to configure board mappings, sync rules, and automations. ## Related[​](#related "Direct link to Related") * **[Monday.com Sync](https://docs.gravityrail.com/user-guide/app-connections/monday-sync.md)** — Configure board mappings, sync rules, and automations * **[App Connections](https://docs.gravityrail.com/user-guide/app-connections/.md)** — Overview of all available connections * **[HubSpot Sync](https://docs.gravityrail.com/user-guide/app-connections/hubspot-sync.md)** — Sync rules, CEL expressions, and filters (same concepts apply to Monday.com) --- # Monday.com Sync Once your Monday.com account is [connected to Gravity Rail](https://docs.gravityrail.com/user-guide/app-connections/monday-setup.md), you can configure how data flows between your Monday boards and your workspace. This guide covers board mappings, sync rules, automations, member linking, and monitoring. ## How It Works[​](#how-it-works "Direct link to How It Works") Sync is built on three layers: 1. **Board mappings** define which Monday boards connect to which Gravity Rail data — either workspace members or form records. 2. **Sync rules** within each mapping control which columns map to which fields and how values are transformed. 3. **Automations** trigger actions in Gravity Rail (notifications, new conversations) when data arrives from Monday. Sync runs in one or both directions: * **Outbound** (Gravity Rail to Monday) pushes member or form data to Monday items. Useful for writing back data collected by AI agents — call notes, outreach status, screening results — so your Monday board stays current. * **Inbound** (Monday to Gravity Rail) pulls Monday item data into member profiles or form records. Useful for keeping Gravity Rail in sync with enrollment data, referral information, or status changes made by your operations team in Monday. You can start with one direction and add the other later. ## Setting Up Board Mappings[​](#setting-up-board-mappings "Direct link to Setting Up Board Mappings") Board mappings tell Gravity Rail which Monday boards to sync and how. Each mapping connects one Monday board to either your workspace members or a specific form. ### Choosing a Target Type[​](#choosing-a-target-type "Direct link to Choosing a Target Type") The target type determines what kind of Gravity Rail data syncs with the Monday board: | Target | When to use it | Example | | ------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | | **Members** | The Monday board tracks people who should exist as workspace members — patients, enrollees, referrals. Each Monday item maps to one member. | An enrollment board where each row is a patient with name, phone, email, and status columns | | **Form / DataType** | The Monday board tracks records that should be stored as form data on existing members — assessments, outreach logs, intake forms. Each Monday item maps to one form record. | A voicemail queue board where each row is a call record linked to a patient | Most teams start with a member-target mapping for their primary enrollment or patient board. Add form-target mappings later for boards that represent activities or records tied to those members. ### Adding a Board Mapping[​](#adding-a-board-mapping "Direct link to Adding a Board Mapping") 1. Go to the **Sync** tab. 2. Click **Add Board Mapping**. 3. Select a **Board** from the dropdown. This shows all boards accessible to your connected Monday account. 4. Choose a **Target** — Members or Form / DataType. 5. Set the **Sync Direction**: * **Bidirectional** — Data flows both ways. Best when both teams actively update the same records. * **Outbound only** — Data flows from Gravity Rail to Monday. Best when Gravity Rail collects data (via AI conversations, forms, or workflows) that your operations team needs to see in Monday. * **Inbound only** — Data flows from Monday to Gravity Rail. Best when your operations team manages data in Monday and Gravity Rail needs to stay current. 6. Click **Save Sync Settings**. ![The Sync tab showing a board mapping with board selector, target type, sync direction, inbound filter, and create unmatched toggle](/assets/images/monday-board-mapping-b7a4a13fcb346b701c6c4dab12c811d5.png) You can add multiple board mappings to sync different boards or to sync the same board to different targets. ### Board Mapping Options[​](#board-mapping-options "Direct link to Board Mapping Options") Depending on your target type and sync direction, additional options appear: * **Create new members for unmatched items** (member targets only) — When enabled, inbound sync creates new workspace members for Monday items that don't match any existing member. Enable this if your Monday board is the authoritative source of new enrollees. Disable it if members should only be created through other channels (voice, SMS, web). * **Inbound Filter** — A CEL expression that limits which Monday items are synced inbound. For example, `source.status == "Active"` would only sync items with an Active status, ignoring archived or pre-screening records. * **Acting Member for Form Writes** (required for inbound sync with form targets) — Select a workspace admin whose permissions authorize writing to form records during inbound sync. ## Configuring Sync Rules[​](#configuring-sync-rules "Direct link to Configuring Sync Rules") Sync rules define how individual fields map between Monday columns and Gravity Rail. Each rule has a name and contains one or more operations in each direction. ### Default Rules[​](#default-rules "Direct link to Default Rules") When you add a board mapping targeting members, three default rules are created: | Rule | Outbound (GR to Monday) | Inbound (Monday to GR) | | --------- | ----------------------------------- | ---------------------------- | | **Name** | Member name to Monday "Name" column | Monday "Name" to member name | | **Email** | Member email to Monday email column | Monday email to member email | | **Phone** | Member phone to Monday phone column | Monday phone to member phone | For form targets, default rules are generated based on the form's fields. ### Adding a Sync Rule[​](#adding-a-sync-rule "Direct link to Adding a Sync Rule") 1. In a board mapping card, find the **Sync Rules** section. 2. Click **Add Sync Rule**. 3. Name the rule descriptively (e.g., "Referral Date" or "Enrollment Status"). 4. Add outbound operations, inbound operations, or both. ### Outbound Operations (Gravity Rail to Monday)[​](#outbound-operations-gravity-rail-to-monday "Direct link to Outbound Operations (Gravity Rail to Monday)") An outbound operation writes data from a Gravity Rail member or form record to a Monday column. * **Source** (left side) — Select from member properties, form fields, labels, managed fields, or write a custom CEL expression. * **Monday column** (right side) — Search and select the target column. The picker shows each column's name, type, and ID. For example, a care coordination team might create an outbound rule that writes the member's profile URL to a "Gravity Rail Profile" link column in Monday, giving the operations team one-click access to conversation history and form data. ![An expanded sync rule showing outbound and inbound field mappings between Gravity Rail and Monday columns](/assets/images/monday-sync-rule-expanded-1995a24941f8b60e4d886cfd0fa39f85.png) #### Status and Dropdown Columns: Label Matching[​](#status-and-dropdown-columns-label-matching "Direct link to Status and Dropdown Columns: Label Matching") When an outbound rule writes to a Monday **status** or **dropdown** column whose source is a Gravity Rail enum field, Gravity Rail sends the field's display label (e.g. `Scheduled`) — not the stored value (e.g. `scheduled`). For Monday to accept the write, the label set on the Gravity Rail option must exactly match the label set on the Monday column. * **Saving a board mapping** rejects with an actionable error if any Gravity Rail enum option label is missing from the Monday column's labels. Rename the option in the form editor or the label on the Monday column so they match exactly, then save again. * **Saved mappings** that drift later (label renamed in Monday after save) surface as a yellow warning at the top of the Sync tab and fail closed locally on the next sync run with a `MISSING_REMOTE_LABEL` error in the Logs tab — Gravity Rail does not call Monday with a value Monday would reject. * Comparison is **exact**: `Scheduled` and `scheduled` are different labels; trailing whitespace counts. There is no fuzzy match. ### Inbound Operations (Monday to Gravity Rail)[​](#inbound-operations-monday-to-gravity-rail "Direct link to Inbound Operations (Monday to Gravity Rail)") An inbound operation writes data from a Monday column to Gravity Rail. * **Monday source** (left side) — Select a column or write a custom expression. * **GR field** (right side) — Choose where to store the value: * **Core Properties** — Name, email, phone, external ID. * **Managed Fields** — Custom fields owned by the Monday connection, visible on the member profile. * **Form Fields** — Write to a specific field on a form record (requires an acting member to be set). For example, an enrollment team tracking referral dates and referring organizations in Monday can map those columns to form fields in Gravity Rail, so AI agents have that context when engaging with the member. > **Record identifiers belong in real Form fields.** If your Form represents a clinical record keyed by an MRN or other upstream identifier, model that identifier as a dedicated Form field (e.g. a `medical_record_number` DataField) — not as `DataRecord.external_id`. The Form's `external_id` column exists to idempotently bind one Monday item to one record; using it for MRNs silently collapses to "one record per Form per MRN" and reuses a non-PHI integration column for PHI. ### Expressions[​](#expressions "Direct link to Expressions") Sync rule sources use CEL (Common Expression Language). Most of the time, you'll use the dropdowns and never write CEL directly. But for custom transforms — splitting names, formatting values, conditional logic — select **Custom Expression** and write your own. The expression context is the same as described in the [HubSpot Sync guide](https://docs.gravityrail.com/user-guide/app-connections/hubspot-sync.md#expressions): `source.name`, `source.email`, `source.phone`, `source.form_data`, `source.has_label()`, and all available transform presets. ## Importing from a Board[​](#importing-from-a-board "Direct link to Importing from a Board") If you want to do a one-time import of Monday items into Gravity Rail (rather than ongoing sync), use the import feature. This is useful for initial setup — importing your existing Monday roster as workspace members before enabling ongoing sync. 1. On the **Sync** tab, click **Import from Board**. 2. Select the **Board** to import from. 3. Choose **Import As**: Members or Form. 4. Optionally add a **Filter Expression** to limit which items are imported. 5. Check **Dry run** to preview what would be imported without making changes. 6. Click **Preview Import** (dry run) or **Start Import**. Check the **Logs** tab for progress and results. Always run a dry run first on large boards. ## Post-Sync Automations[​](#post-sync-automations "Direct link to Post-Sync Automations") Board mappings support automations that trigger after an inbound sync completes. These bridge the gap between data arriving from Monday and action happening in Gravity Rail. To add an automation: 1. Expand a board mapping on the **Sync** tab. 2. Find the **Automations** section and click **Add automation**. 3. Choose an action: * **Notify Staff** — Send a notification when an item syncs. Configure the message template, recipient (target member, acting member, or a specific person), and optional delay. Useful for alerting a care coordinator when a new referral arrives from Monday. * **Create Chat** — Start a conversation in a workflow when an item syncs. Select the workflow, channel (SMS, Phone Call, or Web Chat), and optional initial message. Useful for automatically kicking off an enrollment outreach when a new patient appears in Monday. 4. Optionally add a **Condition** (CEL expression) to limit when the automation fires. ![A Notify Staff automation card with message template, recipient selector, delay, and condition fields](/assets/images/monday-automation-card-d15dad8c5a80d49dfcc075bddf54d703.png) ## Linking Members to Monday Items[​](#linking-members-to-monday-items "Direct link to Linking Members to Monday Items") The **Members** tab shows which workspace members are linked to Monday items. Links are created automatically during sync, but you can also manage them manually. ![The Members tab showing linked members count and the Find Matching Records button](/assets/images/monday-members-ae8fdc2af9168ca52ad36c629659756e.png) ### Finding Matches[​](#finding-matches "Direct link to Finding Matches") If you have existing members in Gravity Rail and existing items in Monday that represent the same people, use the matching tool to link them: 1. Go to the **Members** tab. 2. Click **Find Matching Records**. 3. Gravity Rail searches your Monday boards for items that match existing members by email, phone, or name. 4. Review the matches and click **Link** on individual matches, or **Link All** to link them all at once. This is especially useful when connecting Monday to a workspace that already has members from other channels (SMS, voice, web). ![The Find Matching Monday.com Items dialog with a button to search for matches](/assets/images/monday-find-matches-b0c98f6130719b30191cbacc1bcbe5f2.png) ### Unlinking[​](#unlinking "Direct link to Unlinking") To remove a link between a member and a Monday item, click **Unlink** next to the member on the Members tab. This doesn't delete the member or the Monday item — it just removes the association so they won't sync. ## Viewing Sync Logs[​](#viewing-sync-logs "Direct link to Viewing Sync Logs") The **Logs** tab shows sync activity. You'll see: * **Live progress** during an active sync, with counts for synced, failed, and skipped items. * **Per-item status** showing which members or records succeeded or failed. * **Error details** — click a failed item to see the specific error message. * **Sync history** — a list of past sync runs with timestamps and status. ### Test on Small Batch[​](#test-on-small-batch "Direct link to Test on Small Batch") When configuring a new board or changing rules, full syncs can take a long time and touch thousands of records. The **Test on small batch** button next to each entity-type's sync controls runs a capped dry-run preview: * **Default sample size**: 20 records. Adjust with the number input next to the button (1–200). * **Always a dry run**: writes are not persisted, regardless of whether **Full resync** is checked. * **Doesn't move the checkpoint**: the sync's resume position is unchanged, so the next real sync still picks up where it left off. Use it to validate field mappings, filters, or a new match strategy on a small slice before committing to a full sync. The Logs tab shows the same per-item status as a normal run, so you can spot mapping or compatibility issues without waiting for thousands of records to process. ## Troubleshooting[​](#troubleshooting "Direct link to Troubleshooting") ### Inbound Sync Not Receiving Updates[​](#inbound-sync-not-receiving-updates "Direct link to Inbound Sync Not Receiving Updates") Inbound sync requires a Signing Secret to verify webhooks from Monday.com. Go to the **Setup** tab or click **Edit** to add the signing secret. ### Items Not Matching Existing Members[​](#items-not-matching-existing-members "Direct link to Items Not Matching Existing Members") By default, inbound sync matches Monday items to existing members by email. If your Monday board doesn't have email data, items won't match and will be skipped (or created as new members if "Create new members for unmatched items" is enabled). Check that your sync rules include an inbound email mapping. If you need to match on a stable identifier that isn't email, open the board mapping's **Member Match Strategy** dropdown and choose **Match by custom field**. Two pickers appear: * **Match On (Local field)** — A grouped combobox with two sections: * **Properties** — A Member built-in column: `Name`, `Email`, `Phone`, or `Description`. * **Custom fields** — A connection-managed `MemberField` key. These are keys this Monday connection has already written to members (e.g. via a `managed_field` inbound rule on another board). You can also choose **Add custom field key…** and type a new key string — the matcher will resolve members whose `MemberField(service_id=, key=, value=)` row matches. * **Match Column (Monday)** — Which Monday column carries the remote value. Select any real column on the board. The intended flow for multi-board workflows is: 1. **Board A** writes a stable identifier (for example an MRN) to a service-managed Member field — add an inbound rule with target type **Managed Field**, key `medical_record_number` (or your chosen key), source the MRN column. 2. **Board B** matches on that same key — pick **Match by custom field**, select `medical_record_number` from the Custom fields group (or add it if it isn't there yet), and pick the Monday column that carries the same value. Every board scoped to this Monday connection can match on the same key without overloading Gravity Rail's `Member.external_id` column. If multiple Members share the same key+value pair the inbound item is skipped with **"Multiple members matched the selected custom field key"** in the run-item detail — the raw value is never logged. Resolve by archiving the duplicate Member or by narrowing the key. ### Form Field Writes Failing[​](#form-field-writes-failing "Direct link to Form Field Writes Failing") Inbound rules targeting form fields require an **Acting Member** to be set on the board mapping. This must be a workspace admin. Check the board mapping configuration on the Sync tab. ### Monday Column Types[​](#monday-column-types "Direct link to Monday Column Types") Not all Monday column types are supported for sync. The column picker shows which columns are available. If a column doesn't appear, its type may not yet be compatible with the sync framework. ### Outbound Sync Not Updating Monday[​](#outbound-sync-not-updating-monday "Direct link to Outbound Sync Not Updating Monday") Check the **Logs** tab for errors. Common causes include expired OAuth tokens (reconnect via the Overview tab), column type mismatches (e.g., writing text to a date column), or missing board permissions on the Monday.com app. ### Save Rejected: "form option label(s) ... are not present on the Monday status column"[​](#save-rejected-form-option-labels--are-not-present-on-the-monday-status-column "Direct link to Save Rejected: \"form option label(s) ... are not present on the Monday status column\"") The save-time validator enforces that every Gravity Rail enum option label exists exactly on the Monday status or dropdown column it maps to. If the labels diverge (e.g. the form has `In Progress` but the Monday column only has `In progress`), saving the mapping returns an HTTP 400 with the offending labels listed. To fix: open the form editor for the Gravity Rail field, rename the option's label to match the Monday column exactly, save the form, then save the sync mapping again. Alternatively, rename the Monday column label to match Gravity Rail. Stored values (option `value`s) are unaffected — only display labels need to match. ### "Sync configuration warnings" Banner[​](#sync-configuration-warnings-banner "Direct link to \"Sync configuration warnings\" Banner") A yellow banner at the top of the Sync tab listing label mismatches means a saved mapping has drifted: the Gravity Rail form labels and the Monday column labels no longer agree. The next outbound sync for those rows will fail closed with `MISSING_REMOTE_LABEL` (visible in the Logs tab) until the labels are realigned. ### Save Warning: "N formula columns are referenced by inbound rules"[​](#save-warning-n-formula-columns-are-referenced-by-inbound-rules "Direct link to Save Warning: \"N formula columns are referenced by inbound rules\"") If one board mapping's inbound rules reference more than five distinct formula columns, the save returns a non-blocking warning (the save still succeeds) noting the count and the limit. Monday's `FormulaValue.display_value` API caps reads at five formula columns per request, so a mapping that references six or more will see some formula values return empty at sync time without an error from Monday. To resolve: split the mapping across multiple boards if possible, drop formula references you don't actually consume downstream, or precompute the formula in Monday into a non-formula column (text/number) and reference that column instead. The warning is informational — Gravity Rail will not block the save, but you should expect partial values on items where all six+ formula columns are touched together. ### Archived or Deleted Monday Items[​](#archived-or-deleted-monday-items "Direct link to Archived or Deleted Monday Items") When a Monday item is archived or deleted, Gravity Rail retires the linked DataRecord. A retired DataRecord is hidden from automation evaluation — it will not trigger EventRules, pass CEL gates, or appear in workflow queues. **The underlying data is not deleted.** All field values are preserved in Gravity Rail. If the item is later restored in Monday (un-archived or recovered), re-running sync will reactivate the DataRecord and it will resume participating in automations normally. You can also manually relink the record from the **Members** tab. Members linked to archived Monday items are not affected unless the board mapping has **Archive member on remote archive** enabled. When that option is off (the default), the member remains active in Gravity Rail regardless of the Monday item's state. When it is on, archiving the Monday item archives the member — they will no longer receive messages or participate in workflows until manually unarchived. ## Tips[​](#tips "Direct link to Tips") * **Start with one board and one direction.** Get a single board mapping working before adding more. If you're migrating from an existing integration, start with inbound to verify field mappings before enabling outbound. * **Use the dry run import** to preview before committing. This is especially useful for large boards or when you're unsure about column type compatibility. * **Check the Logs tab after your first sync** to catch mapping issues early. Most errors come from column type mismatches or missing fields. * **Name your rules after the data they carry.** With many columns on a Monday board, descriptive rule names ("Referral Date," "Enrollment Status," "Caregiver Phone") make configuration much easier to review and maintain. * **Use filters to limit scope.** If your Monday board has test rows, archived items, or records in early stages that shouldn't sync yet, add an inbound or outbound filter to keep your workspace clean. ## Related[​](#related "Direct link to Related") * **[Monday.com Setup](https://docs.gravityrail.com/user-guide/app-connections/monday-setup.md)** — Create a Monday.com app and connect it to Gravity Rail * **[App Connections](https://docs.gravityrail.com/user-guide/app-connections/.md)** — Overview of all available connections * **[HubSpot Sync](https://docs.gravityrail.com/user-guide/app-connections/hubspot-sync.md)** — Detailed guide on sync rules, CEL expressions, and filters (same concepts apply to Monday.com) * **[Members](https://docs.gravityrail.com/user-guide/members/managing-members.md)** — Managing member profiles and data * **[Forms](https://docs.gravityrail.com/user-guide/knowledge/forms.md)** — Structured data collection used in sync rules --- # Automation Automation is where you build the logic that drives your workspace. It has three layers: **Workflows** define how conversations flow, **Actions** respond to events in real time, and **Routines** run tasks on a recurring basis. Together, they let you design systems where the AI handles conversations, data flows between systems automatically, and humans get pulled in only when they're needed. ## [Workflows](https://docs.gravityrail.com/user-guide/automation/workflows.md)[​](#workflows "Direct link to workflows") The backbone of every AI conversation. Workflows define multi-step processes that guide your agent through conversations. * Visual workflow builder with connected tasks * Each task has its own prompt, goal, data collection, and abilities * Branching logic for conditional conversation paths * Clone and iterate without starting from scratch **Example**: A patient intake workflow with tasks for greeting, screening questions, data collection, and appointment scheduling — each step with its own AI instructions and form. ## [Actions](https://docs.gravityrail.com/user-guide/automation/actions.md)[​](#actions "Direct link to actions") Event-triggered automations that fire when things happen in your workspace. * Trigger on task events, form submissions, member changes, or chat messages * Filter with [CEL expressions](https://docs.gravityrail.com/user-guide/automation/cel-expressions.md) for precise targeting (e.g., `"vip" in member.labels`) * Actions can send messages, notify team, switch tasks, update labels, fire webhooks, or modify data * Delayed execution for follow-ups and time-based escalation **Example**: When a form is submitted with `priority == "high"`, immediately notify the support team and switch the chat to the priority support task. ## [Routines](https://docs.gravityrail.com/user-guide/automation/routines.md)[​](#routines "Direct link to routines") Time-based automation for recurring work that doesn't depend on a specific event. * CRON-style scheduling: daily, weekly, monthly, or custom intervals * Target all members, filtered groups, or specific individuals * Chain multiple actions to a single routine * Manual trigger option for testing or one-off runs **Example**: Every weekday at 9 AM, send a check-in message to all members labeled "active-patient" who haven't responded in 48 hours. ## [Experiments (A/B Testing)](https://docs.gravityrail.com/user-guide/automation/experiments.md)[​](#experiments-ab-testing "Direct link to experiments-ab-testing") Member-level A/B tests with weighted Groups, lazy CEL assignment, and journey goal reporting. * Create control and variant Groups with allocation weights * Branch in Actions and task edges with `member.experiments["slug"]` * Filter who gets assigned with optional eligibility CEL * Compare Journey Goal outcomes by Group (exposed Members only) * List filtering for archived experiments; small-number suppression in stats **Example**: Test two opening-message variants in a onboarding journey, then compare goal completion rates by Group on the journey Goals tab. ## How They Work Together[​](#how-they-work-together "Direct link to How They Work Together") The real power comes from combining all three: 1. A **Workflow** guides a patient through intake, collecting their information 2. An **Action** fires when the intake form is submitted, adding a "new-patient" label and sending a webhook to your EHR 3. A **Routine** runs daily, checking on patients who haven't completed intake and sending a reminder This combination lets you build fully automated engagement systems that handle thousands of conversations while keeping humans in the loop where it matters. --- # Actions Actions automate your workspace. When something happens - a form submission, a task completion, a message - actions can automatically respond with notifications, task switches, webhooks, and more. ## The Building Blocks[​](#the-building-blocks "Direct link to The Building Blocks") Every action has three parts: 1. **Trigger** - What event fires this action? 2. **Conditions** - Should it run this time? (optional [CEL expressions](https://docs.gravityrail.com/user-guide/automation/cel-expressions.md)) 3. **Action** - What should happen? ## Creating an Action[​](#creating-an-action "Direct link to Creating an Action") 1. Go to **Actions** 2. Click **New Action** 3. Configure your trigger, conditions, and action ### Triggers[​](#triggers "Direct link to Triggers") Pick what event fires your action: | Category | Events | | --------------- | ----------------------------------- | | **Task** | Entered, Exited | | **Data Record** | Created, Updated | | **Member** | Joined, Left, Updated | | **Chat** | Message sent (by user or assistant) | ### Action Types[​](#action-types "Direct link to Action Types") | Action | What It Does | | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Assistant Message** | AI sends a message. *Voice note: Continue immediately is supported for text chats and voice agents that use local/composable TTS. For native realtime model audio, Gravity Rail treats the message as Wait for reply until native audio playback can be safely ordered with the follow-up response.* | | **[Member Notify](https://docs.gravityrail.com/user-guide/automation/send-notification-action.md)** | Send notification to team | | **Switch Task** | Move to a different workflow step | | **Member Label** | Add or remove labels | | **Send Webhook** | POST to an external URL | | **Form Field Update** | Modify form data. String values support Jinja template syntax (e.g. `{{ current_date }}`, `{{ member.name }}`). Supports targeting specific collection records via `updateType`. | | **[Send Email](https://docs.gravityrail.com/user-guide/automation/send-email-action.md)** | Send a templated email to the member | | **[Send SMS](https://docs.gravityrail.com/user-guide/automation/send-sms-action.md)** | Send a templated SMS message, optionally starting a conversation | | **[Send WhatsApp](https://docs.gravityrail.com/user-guide/automation/send-whatsapp-action.md)** | Send a templated WhatsApp message to a member (workspace must have WhatsApp enabled) | | **[Phone Call](https://docs.gravityrail.com/user-guide/automation/phone-call-action.md)** | Initiate an AI-powered phone call using a workflow | | **[Play Audio](https://docs.gravityrail.com/user-guide/automation/play-audio-action.md)** | Play a pre-recorded audio file on a phone call (disclosures, voicemail drops) | | **[Upsert Member](https://docs.gravityrail.com/user-guide/automation/upsert-member-action.md)** | Create or update a member from incoming webhook data. Configure `behavior` (`upsert`, `create_only`, `update_only`) and skip flags (`skipIfExists`, `skipIfNotFound`) | | **Validate Message** | Check an AI-generated message against a [CEL](https://docs.gravityrail.com/user-guide/automation/cel-expressions.md) condition before it is sent. Set `condition` (CEL expression that flags a policy violation) and `reason` (message shown when the condition is met). Fires in `response_validation` mode — the message is blocked if the condition evaluates to `true`. | | **Conclude Assignment** | End the current assignment with a specified outcome | | **Enroll in Journey** | Enroll the member in a journey program | | **[Create Chat](https://docs.gravityrail.com/user-guide/automation/actions.md#create-chat)** | Open a new chat for a member on a specified channel and workflow. *Deprecated — only configurable via API or app-connections integrations, not the rule builder UI. Prefer **Send SMS**, **Phone Call**, or **Send Email** for new rules.* | | **Continue Chat** | *Legacy action — no longer available for new rules.* Handled automatically by the [Scheduled Callbacks](https://docs.gravityrail.com/user-guide/chats/callbacks.md) feature. | | **[Pause Chat](https://docs.gravityrail.com/user-guide/automation/actions.md#pause-chat)** | Pause an active chat so a human agent can respond | | **[Summarize Chat](https://docs.gravityrail.com/user-guide/automation/actions.md#summarize-chat)** | Generate an AI summary of a chat conversation | ## Conditions with CEL[​](#conditions-with-cel "Direct link to Conditions with CEL") Use [CEL (Common Expression Language)](https://docs.gravityrail.com/user-guide/automation/cel-expressions.md) to control when actions fire. ### Quick Reference[​](#quick-reference "Direct link to Quick Reference") ``` # Check labels "vip" in member.labels # Check form data (single-record forms) member.data.profile.age >= 18 # Check collection data member.collections.patient_visits.count > 0 member.collections.patient_visits.latest.data.diagnosis == "Allergies" # Search recent collection records member.collections.lab_results.recent.exists(r, r.data.status == "critical") # Check time datetime.hour >= 9 && datetime.hour < 17 # Check channel chat.channel == "phone-sms" # Combine conditions "premium" in member.labels && is_business_hours ``` ### Available Variables[​](#available-variables "Direct link to Available Variables") | Variable | What It Contains | | -------------------- | ----------------------------------------------------------------------------------- | | `member` | Name, email, phone, date of birth, age, labels, form data | | `member.collections` | Collection form data: count, latest record, recent records | | `task` | Current task info | | `chat` | Channel, paused state, test flag | | `phone_number` | Workspace phone number a voice/SMS chat arrived on (`number`, `name`, `brand_name`) | | `message` | The message content (for message events) | | `datetime` | Current time in workspace timezone | | `is_business_hours` | Whether it's within business hours | ### Common Patterns[​](#common-patterns "Direct link to Common Patterns") **VIP customers only:** ``` "vip" in member.labels ``` **During business hours:** ``` is_business_hours ``` **Specific channel:** ``` chat.channel == "phone-voice" ``` **Form field check:** ``` member.data.contact.preferred_language == "spanish" ``` ## Delayed Actions[​](#delayed-actions "Direct link to Delayed Actions") Schedule actions for later: 1. Enable the delay option 2. Set hours, minutes, or seconds 3. Action runs after the delay Great for: * Follow-up messages after 24 hours * Escalation if no response in 2 hours * Scheduled reminders ## Webhooks[​](#webhooks "Direct link to Webhooks") Send data to external systems when events happen. ### Setup[​](#setup "Direct link to Setup") 1. Create an action with **Send Webhook** type 2. Enter your HTTPS endpoint URL 3. Choose which events trigger it ### Payload Format[​](#payload-format "Direct link to Payload Format") Every payload includes `event`, `eventId`, `eventRule`, and `workspace` at the top level, plus a slim `member` block when a member is in context: ``` { "event": "call:completed", "eventId": "9d3f1c88-6b0a-45e2-9f41-c7a2b5d80e63", "eventRule": { "id": 88, "uuid": "a1b2…", "name": "Export call to data warehouse" }, "workspace": { "uuid": "9e8d…", "name": "Acme Health" }, "member": { "id": 123, "accountUuid": "c4d5…", "email": "jane@example.com" } } ``` `eventId` is a unique UUID generated when the event fires. Retries of the same delivery carry the **same** `eventId` — use it as your idempotency/dedup key. The exact fields vary by event family (data record events carry a full `member` block and a `dataRecord` block; member events carry the full member profile). See [Webhooks](https://docs.gravityrail.com/user-guide/developer/webhooks.md) for all three payload shapes. Payloads are signed with **HMAC-SHA256** via the `X-Webhook-Signature` header when a signing secret is configured on the rule. See [Webhooks — Security](https://docs.gravityrail.com/user-guide/developer/webhooks.md) for verification examples. ## Common Automations[​](#common-automations "Direct link to Common Automations") **Route VIPs to priority queue:** * Trigger: Task Entered * Condition: `"vip" in member.labels` * Action: Switch Task to "Priority Support" **Notify team on escalation:** * Trigger: Task Entered (Escalation task) * Action: Member Notify to support team **Update CRM on signup:** * Trigger: Member Joined * Action: Send Webhook to CRM API **Follow up after call:** * Trigger: Task Exited (Call task) * Action: Switch Task to "Follow Up" (24h delay) ## Tips[​](#tips "Direct link to Tips") * **Start simple** - One trigger, one action. Add complexity later. * **Test with conditions** - Use `chat.is_test` to run test conversations. * **Order matters** - Drag actions to control execution order. * **Check logs** - Failed actions show error details. ## Chat Actions[​](#chat-actions "Direct link to Chat Actions") ### Create Chat[​](#create-chat "Direct link to Create Chat") > **Deprecated.** This action is not available in the rule builder UI and can only be configured via the API or app-connections integrations. For new rules, use **[Send SMS](https://docs.gravityrail.com/user-guide/automation/send-sms-action.md)**, **[Phone Call](https://docs.gravityrail.com/user-guide/automation/phone-call-action.md)**, or **[Send Email](https://docs.gravityrail.com/user-guide/automation/send-email-action.md)** instead — they cover the most common outbound-initiation use cases and are fully supported in the UI. Opens a new chat for a member on a specified channel and workflow. Use this to proactively start a conversation — for example, sending an outbound SMS after a form submission or initiating a voice callback. **Configuration options:** * **Channel** — `sms`, `email`, `phone-voice`, `web`, etc. * **Workflow** — The workflow the new chat will follow * **Initial message** — Optional opening message sent when the chat is created ### Pause Chat[​](#pause-chat "Direct link to Pause Chat") Pauses an active chat so a human agent can take over. The chat is marked as paused in the inbox and will not receive automated replies until a human responds or the pause is cleared. **Configuration options:** * **Message** — Optional message sent to the member when the chat is paused (e.g., "A team member will be with you shortly") ### Summarize Chat[​](#summarize-chat "Direct link to Summarize Chat") Generates an AI summary of the chat conversation and stores it on the chat record. Useful for hand-off notes, post-call documentation, or building context before a follow-up workflow step. **Configuration options:** * **Summarization prompt** — Custom instructions for what to focus on in the summary * **Chat model** — Override the default AI model used for summarization ## Form Field Update[​](#form-field-update "Direct link to Form Field Update") Updates a field on a member's form record. You can set a static value or use Jinja template syntax to write a dynamic value — for example, the current date or a piece of the member's profile. ### Template variables[​](#template-variables "Direct link to Template variables") String values are rendered through the same template engine used by the Send Email and Send SMS actions. Common variables include: | Variable | Example output | | -------------------- | ------------------ | | `{{ current_date }}` | `2026-06-13` | | `{{ member.name }}` | `Jane Smith` | | `{{ member.email }}` | `jane@example.com` | | `{{ member.phone }}` | `+15551234567` | Non-string values (numbers, booleans) and plain strings without `{{` or `{%` are written verbatim and unchanged. ### Example: stamp a date field on status change[​](#example-stamp-a-date-field-on-status-change "Direct link to Example: stamp a date field on status change") A common use-case is recording when a status field last changed by writing the current date to a companion `status_changed_at` date field. **Setup:** | Setting | Value | | --------- | --------------------- | | Trigger | Data Record Updated | | Condition | `has(changes.status)` | | Action | Form Field Update | | Field | `status_changed_at` | | Value | `{{ current_date }}` | Every time the `status` field changes, the action stamps `status_changed_at` with today's date. ### Collection record selection[​](#collection-record-selection "Direct link to Collection record selection") When the target field belongs to a **collection** data type (a form that can have multiple records per member), you must specify which record to update using the `updateType` parameter. | `updateType` | Behaviour | | ------------ | ------------------------------------------------------------------------------------------------------------------------ | | `newest` | Update the most recently created record. Creates a new record if none exist. | | `oldest` | Update the least recently created record. Creates a new record if none exist. | | `create` | Always insert a new record regardless of existing records. | | `trigger` | Update the exact record that fired the rule. Only valid on **Data Record Created** and **Data Record Updated** triggers. | | `matchField` | Update the record whose `matchField` field equals the template-rendered `matchValue`. See details below. | | `selector` | Evaluate a CEL expression (the candidate record is bound as `record`) and update the first match. See details below. | #### `matchField` mode[​](#matchfield-mode "Direct link to matchfield-mode") Use this mode to look up a record by a specific field value — for example, updating a lab result record that has a matching accession number. | Option | Description | | ----------------- | ----------------------------------------------------------------------------------------------------------- | | `matchField` | The field name on the collection record to match against | | `matchValue` | The value to match (supports Jinja template syntax) | | `tiebreaker` | `newest` (default) or `oldest` — which record wins when multiple records match | | `createIfMissing` | `true` to insert a new record when no match is found; `false` (default) to fail with an audit event instead | A `matchValue` that renders to an empty string fails with a `empty_match_value` audit rather than matching records with an unset field. #### `selector` mode[​](#selector-mode "Direct link to selector-mode") Use this mode for complex match logic. The action evaluates your CEL expression against each of the member's records and updates the first one that matches. | Option | Description | | ----------------- | -------------------------------------------------------------------------------- | | `selector` | CEL expression evaluated per record; the candidate record is bound as `record` | | `tiebreaker` | `newest` (default) or `oldest` — scan order and which record wins on first match | | `createIfMissing` | Same semantics as `matchField` mode | **Example:** update the most recent open appointment record: ``` record.data.status == "open" ``` ### Breaking change note[​](#breaking-change-note "Direct link to Breaking change note") Before this template support was added (prior to 2026-06-12), a field value containing `{{` or `{%` was written to the form verbatim. Those values are now rendered as templates. If an existing rule stored a literal string that happened to contain double braces, that string will now be interpreted as a template expression. Review any Form Field Update rules that use such values and update them if needed. ## Related[​](#related "Direct link to Related") * **[CEL Expressions](https://docs.gravityrail.com/user-guide/automation/cel-expressions.md)** — Write conditions to control when actions fire * **[Webhooks](https://docs.gravityrail.com/user-guide/developer/webhooks.md)** — Send encrypted data to external systems * **[Workflows](https://docs.gravityrail.com/user-guide/automation/workflows.md)** — Build the conversation flows that actions automate --- # CEL Expressions Write dynamic conditions for Gravity Rail workflows using CEL (Common Expression Language). Use it to control access to tasks, route conversations, and trigger automations. ## Quick Start[​](#quick-start "Direct link to Quick Start") CEL expressions evaluate to `true` or `false`. Here are common patterns: ``` # Check if member has a label "vip" in member.labels # Check form data member.data.profile.age >= 18 # Check time datetime.hour >= 9 && datetime.hour < 17 # Check chat channel chat.channel == "phone-sms" ``` ## Operators[​](#operators "Direct link to Operators") | Type | Operators | Example | | ----------- | -------------------------------- | --------------------------------------------- | | Comparison | `==` `!=` `<` `>` `<=` `>=` | `member.data.score >= 80` | | Logic | `&&` (AND) `\|\|` (OR) `!` (NOT) | `"vip" in member.labels && is_business_hours` | | Containment | `in` | `"premium" in member.labels` | | Math | `+` `-` `*` `/` | `member.data.quantity * 10` | ## Available Variables[​](#available-variables "Direct link to Available Variables") ### member[​](#member "Direct link to member") Information about the current member. > **Available in:** All contexts where a member is associated — event rules, ability conditions, router tasks, and **edge routing conditions**. All fields in the table below are available on every surface. | Field | Type | Description | | ----------------------------------------------- | --------------- | --------------------------------------------------------------------------- | | `member.id` | number | Member's internal numeric ID | | `member.name` | string | Member's name | | `member.first_name` | string | Member's first name (falls back to first token of `name` when unset) | | `member.last_name` | string | Member's last name (empty string when unset) | | `member.email` | string | Member's email | | `member.phone` | string | Member's phone number | | `member.account_uuid` | string | UUID of the Member's owning account | | `member.external_id` | string | External system identifier (empty string when unset) | | `member.date_of_birth` | string | Member's date of birth (`YYYY-MM-DD`) | | `member.age` | number | Member's age in whole years (`-1` when date of birth is not set) | | `member.labels` | list of strings | Label slugs assigned to member (e.g., `["vip", "verified"]`) | | `member.label_uuids` | list | UUIDs of labels assigned to member | | `member.data.{type}.{field}` | varies | Data from Data Types (singular and collection) | | `member.collections.{type}.count` | number | Total records for a collection Data Type | | `member.collections.{type}.latest.data.{field}` | varies | Latest record from collection Data Types (by creation time) | | `member.collections.{type}.latest.created_at` | string | Timestamp of latest record | | `member.collections.{type}.latest.external_id` | string | External ID of latest record | | `member.collections.{type}.recent` | list | Up to 50 records, newest first (supports `exists`, `filter`, `map`, `size`) | **Examples:** ``` # Check for a label "verified" in member.labels # Check multiple labels "vip" in member.labels || "enterprise" in member.labels # Element equality with a comprehension is also valid member.labels.exists(l, l == "vip") # DON'T: member.labels.exists(l, l.slug == "vip") # Each element is already the slug string — accessing .slug on it # raises a runtime error and the rule is silently skipped. The save-time # validator now rejects this pattern with a clear error. # Check age or date of birth member.age >= 18 member.date_of_birth < "2008-01-01" # Check singular form data member.data.patient_info.age >= 18 member.data.contact.preferred_language == "spanish" # Collection: count and latest member.collections.patient_visits.count > 0 member.collections.patient_visits.latest.data.diagnosis == "Allergies" # Collection: search recent records (up to 50) member.collections.lab_results.recent.exists(r, r.data.status == "critical") # Collection: filter returns matching records as a list (size() to count) member.collections.appointment_tracking.recent.filter(e, e.data.appointment_type_id == 376657 && e.data.status == "Scheduled").size() > 0 # Same pattern scoped to the current Assignment only assignment.collections.call_log.recent.filter(e, e.data.call_category == "patient_care_management").size() > 0 ``` ### `member.experiments` (A/B testing)[​](#memberexperiments-ab-testing "Direct link to memberexperiments-ab-testing") Map of Experiment slug → assigned **Group** slug. Populated on **runtime** surfaces (Actions, automatic task edges) when a CEL expression reads a slug and lazy assignment runs. > **Available in:** Event rule conditions, automatic task edge CEL, and other assignment-capable runtime surfaces. **Not** available for side-effect-free assignment on filters or journey goal definition CEL. | Access pattern | Type | Description | | --------------------------------------- | ------ | ------------------------------------ | | `member.experiments["my-experiment"]` | string | Assigned Group slug | | `member.experiments.my_experiment` | string | Dot syntax (hyphens → underscores) | | `"my-experiment" in member.experiments` | bool | Whether the Member has an assignment | **Lazy assignment:** First read of a slug on a runtime surface may assign the Member (Experiment must be `running`, eligibility CEL must pass), record exposure, then evaluate the branch. **Unassigned Members:** Missing key → equality checks evaluate `false`. Use `"slug" in member.experiments` when you need to detect assignment explicitly. ``` member.experiments["opening-message-test"] == "friendly" member.experiments["opening-message-test"] == "control" "opening-message-test" in member.experiments ``` See [Experiments (A/B Testing)](https://docs.gravityrail.com/user-guide/automation/experiments.md) for eligibility filtering and reporting. ### chat[​](#chat "Direct link to chat") Information about the current conversation. > **Available in:** Message event rules, router tasks, ability conditions. | Field | Type | Description | | --------------------- | ------ | ---------------------------------------------------------- | | `chat.id` | number | Chat ID | | `chat.uuid` | string | Chat UUID | | `chat.channel` | string | Channel (see values below) | | `chat.chat_type` | string | `"assignment"`, `"manager"`, `"developer"`, `"supervisor"` | | `chat.paused` | bool | Whether the chat is paused | | `chat.needs_response` | bool | Whether the chat needs a response | | `chat.is_test` | bool | Whether this is a test chat | | `chat.title` | string | Chat title (if set) | **Channel values:** `"phone-sms"`, `"phone-voice"`, `"email"`, `"web-chat"`, `"web-voice"`, `"cli"`, `"frame"`, `"discord"`, `"slack"`, `"direct-message"` **Examples:** ``` # Different behavior for SMS vs web chat.channel == "phone-sms" # Voice channels chat.channel == "phone-voice" || chat.channel == "web-voice" # Skip test chats !chat.is_test # Only respond when needs response chat.needs_response ``` ### phone\_number[​](#phone_number "Direct link to phone_number") The workspace phone number the current chat arrived on. Only populated for chats with a linked workspace phone number — typically `phone-voice` and `phone-sms` channels. Absent for `web-chat` and other channels. > **Available in:** Message event rules, router tasks, and ability conditions on chats that came in via a workspace phone number. | Field | Type | Description | | ------------------------- | ------ | --------------------------------------------------------------------------------------- | | `phone_number.number` | string | E.164 phone number (e.g. `"+15551234567"`) | | `phone_number.name` | string | Human-readable name configured on the workspace phone number | | `phone_number.brand_name` | string | Brand name configured on the workspace phone number (used for compliance and caller ID) | **Examples:** ``` # Route based on which workspace number was dialed phone_number.number == "+15551234567" # Brand-specific behavior when a workspace has multiple lines phone_number.brand_name == "Acme Health" ``` ### task[​](#task "Direct link to task") Information about the current task. > **Available in:** Ability conditions, router task edges. | Field | Type | Description | | ----------- | ------ | ----------- | | `task.id` | number | Task ID | | `task.uuid` | string | Task UUID | | `task.name` | string | Task name | ### assignment[​](#assignment "Direct link to assignment") Information about the current assignment (a member's progress through a workflow). > **Available in:** Ability conditions, task guards, edge conditions, and event rules on assignment / task events. | Field | Type | Description | | --------------------------------------------------- | ------ | ---------------------------------------------------------------------------------------------- | | `assignment.id` | number | Assignment ID | | `assignment.uuid` | string | Assignment UUID | | `assignment.collections.{type}.count` | number | Records of this collection Form linked to **this Assignment only** | | `assignment.collections.{type}.latest.data.{field}` | varies | Latest current-Assignment record field | | `assignment.collections.{type}.latest.created_at` | string | Timestamp of latest current-Assignment record | | `assignment.collections.{type}.latest.external_id` | string | External ID of latest current-Assignment record | | `assignment.collections.{type}.recent` | list | Up to 50 current-Assignment records (newest first; supports `exists`, `filter`, `map`, `size`) | #### `assignment.collections.*` vs `member.collections.*`[​](#assignmentcollections-vs-membercollections "Direct link to assignmentcollections-vs-membercollections") These two namespaces have the same shape but different scope: * **`assignment.collections.
.*`** sees only records linked to the **current Assignment** through the agent's data-access action. Use this for per-encounter checks like *"did the agent collect a reason on **this** call?"*. * **`member.collections..*`** sees the Member's **lifetime** records — every record ever created for that Form, across all Assignments and all time. Use this for historical checks like *"has the Member **ever** completed intake?"*. **Pick deliberately.** A common bug is writing `member.collections.call_log.latest.data.reason` for a current-call check, then having the rule fire on a leftover record from a previous call. | Intent | CEL | | ---------------------------------------------------------- | ---------------------------------------------------------------------------------------- | | Block until the agent collects PMD reason on **this** call | `has(assignment.collections.call_log.latest.data.pmd_reason)` | | Skip if the Member has **ever** completed intake | `member.collections.intake.count > 0` | | Only fire if **today's** call was patient-care management | `assignment.collections.call_log.latest.data.call_category == "patient_care_management"` | | Has this patient **ever** been hospitalized? | `member.collections.hospitalizations.count > 0` | `assignment.form_data.*` and `assignment.data.*` are **not** valid paths. Use `member.form_data..` for singular Member-scoped data, or `assignment.collections..*` for current-Assignment collection records. ### workspace[​](#workspace "Direct link to workspace") Workspace-scoped configuration data, keyed by DataType slug. > **Available in:** All contexts (event rules, ability conditions, router task conditions, edge conditions). Access pattern: `workspace..`, where `` is the sanitized slug of a workspace-scoped DataType (one configured with `record_scope="workspace"`). The value reflects the field values of the latest workspace-scoped record for that DataType. Fields that have no record yet return their default values. | Pattern | Type | Description | | -------------------------- | ------ | --------------------------------------------------- | | `workspace..` | varies | Field value from the latest workspace-scoped record | The record's `created_at` and `external_id` scalars are **not** exposed on this namespace today — only the field values from the record's `data` are surfaced. Use member- or assignment-scoped collection paths (e.g. `member.collections..latest.created_at`) if you need record metadata. **Examples:** ``` # Check a workspace configuration value workspace.config.max_retries > 3 # Route based on a workspace setting workspace.routing.default_queue == "tier1" # Guard on a feature flag stored in a workspace DataType workspace.feature_flags.beta_features_enabled == true # Combine with member context workspace.config.strict_mode == true && "admin" in member.labels ``` **Setup:** Workspace-scoped DataTypes are created in the workspace's Data Types settings with *Record Scope* set to `"workspace"`. Each workspace-scoped DataType is always a collection; the CEL namespace reflects the latest record. ### record[​](#record "Direct link to record") Information about the data record that triggered the event. > **Available in:** Data record event rules only (`data_record:created`, `data_record:updated`, `data_record:deleted`). | Field | Type | Description | | --------------------- | ------ | ------------------------------ | | `record.id` | number | Record ID | | `record.external_id` | string | External ID (if set) | | `record.data.{field}` | varies | Field values from the record | | `record.created_at` | string | ISO 8601 creation timestamp | | `record.updated_at` | string | ISO 8601 last-update timestamp | **Examples:** ``` # Check a record field value record.data.status == "active" # Check record has an external ID record.external_id != "" # Combine with member context record.data.priority == "high" && "on-call" in member.labels ``` ### changes[​](#changes "Direct link to changes") Field-level change tracking for record updates. > **Available in:** `data_record:updated` event rules only. | Field | Type | Description | | --------------------- | ------ | --------------------------- | | `changes.{field}.old` | varies | Previous value of the field | | `changes.{field}.new` | varies | New value of the field | **Examples:** ``` # Trigger when status changes to a specific value changes.status.new == "Outreach" # Trigger only when a field actually changed changes.status.old != changes.status.new # Transition-specific logic changes.status.new == "Outreach" && changes.status.old != "Outreach" ``` ### datetime[​](#datetime "Direct link to datetime") Current time in your workspace's timezone. > **Available in:** All contexts. | Field | Type | Description | | ----------------------- | ------ | ------------------------------- | | `datetime.hour` | number | Hour (0-23) | | `datetime.minute` | number | Minute (0-59) | | `datetime.second` | number | Second (0-59) | | `datetime.day_of_week` | number | Day (0=Monday, 6=Sunday) | | `datetime.day_of_month` | number | Day of month (1-31) | | `datetime.month` | number | Month (1-12) | | `datetime.year` | number | Year | | `datetime.timestamp` | string | ISO 8601 timestamp | | `current_date` | string | Date as "YYYY-MM-DD" | | `current_time` | string | Time as "HH:MM" | | `is_business_hours` | bool | Within workspace business hours | **Examples:** ``` # Business hours only is_business_hours # Weekdays 9 AM - 5 PM datetime.hour >= 9 && datetime.hour < 17 && datetime.day_of_week <= 4 # Specific date check current_date == "2025-01-15" ``` ### tool\_invocations[​](#tool_invocations "Direct link to tool_invocations") List of tools the AI called this turn. Each entry has `name` (string) and `args` (map of argument values). > **Available in:** Edge conditions on task transitions only. Evaluated after each agent turn. | Field | Type | Description | | ------------------------- | ------ | --------------------------------------------------------- | | `tool_invocations` | list | List of tool calls made this turn | | `tool_invocations[].name` | string | Tool function name (e.g., `"update_patient_info_record"`) | | `tool_invocations[].args` | map | Arguments passed to the tool | **Examples:** ``` # Check if a specific tool was called tool_invocations.exists(t, t.name == "update_patient_info_record") # Check tool was called with a specific argument tool_invocations.exists(t, t.name == "update_record" && has(t.args.status)) # Check argument value tool_invocations.exists(t, t.name == "update_record" && t.args.status == "complete") # Check if any tools were called tool_invocations.size() > 0 ``` **Note:** Tool names for Data Access abilities follow the pattern `update_{data_type_slug}_record`, `create_{data_type_slug}_record`, etc. Use `has(t.args.field)` to check field presence before comparing values. ### Edge Routing: CEL condition fires but transition is blocked[​](#edge-routing-cel-condition-fires-but-transition-is-blocked "Direct link to Edge Routing: CEL condition fires but transition is blocked") A CEL condition evaluating to `true` does not guarantee the assignment will move to the target task. The transition can be **blocked** if the target task has its own entry guard — for example, an EventRule condition that rejects the entry request. When this happens: * The `transition_blocked` outcome is returned internally. * The assignment **silently stays on the current task** — no error message is shown to the member or the agent. * A warning is logged server-side (visible in platform logs), but nothing is surfaced to the workflow author. **What to check when a CEL edge seems to fire but nothing happens:** 1. Confirm the CEL condition itself evaluates to `true` for the current turn (test it using the CEL editor's real-time validation). 2. Check the **target task's entry conditions**. In the workflow editor, open the target task and review its EventRules triggered on `task:entered` — any one of those whose condition evaluates to `false` will refuse entry and block the transition. 3. The block is recorded as a server-side `WARNING` log line keyed `cel_edge_evaluator.transition_blocked` (including the assignment, source, and target task IDs plus the rejecting status code). This is not visible in the workspace UI — ask your workspace admin or Gravity Rail support to look it up by assignment ID. > **Only client-side (4xx) refusals are silent.** If the target task's entry instead fails with a server error (5xx), that error is re-raised rather than swallowed — so a transition that disappears with no error almost always points at an entry condition, not a platform fault. See the [Edge Routing feature doc](https://docs.gravityrail.com/features/platform/edge-routing/README#evaluation-outcomes) for the full list of evaluation outcomes and the [Debugging `transition_blocked`](https://docs.gravityrail.com/features/platform/edge-routing/README#debugging-transition_blocked) section for the exact log format. ### message[​](#message "Direct link to message") The content of the current message. > **Available in:** Router tasks and message event rules only. ``` # Check message content matches(message, "^[0-9]{5}$") # Valid zip code contains(message, "urgent") ``` ## Built-in Functions & Macros[​](#built-in-functions--macros "Direct link to Built-in Functions & Macros") Standard CEL functions available in all contexts: | Function | Description | Example | | -------------------- | ---------------------------------- | --------------------------------------- | | `has(field)` | Check if a field exists and is set | `has(member.phone)` | | `size(value)` | Length of a string, list, or map | `size(member.labels) > 0` | | `exists(x, cond)` | True if any list element matches | `member.labels.exists(l, l == "vip")` | | `all(x, cond)` | True if all list elements match | `member.labels.all(l, l != "blocked")` | | `filter(x, cond)` | Return matching list elements | `member.labels.filter(l, l != "test")` | | `map(x, expr)` | Transform each list element | `member.labels.map(l, l + "_tag")` | | `startsWith(prefix)` | String starts with prefix | `member.phone.startsWith("+1")` | | `endsWith(suffix)` | String ends with suffix | `member.email.endsWith("@example.com")` | | `int(value)` | Convert to integer | `int("42") == 42` | | `string(value)` | Convert to string | `string(member.id)` | | `type(value)` | Return the type of a value | `type(member.name) == string` | **Examples:** ``` # Check if member has a phone number before using it has(member.phone) && member.phone != "" # Check label list length size(member.labels) >= 2 # Search within tool invocations (edge conditions) tool_invocations.exists(t, t.name == "update_record" && has(t.args.status)) ``` ## Custom Functions[​](#custom-functions "Direct link to Custom Functions") | Function | Description | Example | | ------------------------------------- | ----------------------------------- | ------------------------------------------------ | | `contains(text, substring)` | Case-insensitive substring check | `contains(member.email, "@gmail.com")` | | `notcontains(text, substring)` | Inverse of contains | `notcontains(message, "cancel")` | | `matches(text, pattern)` | Regex pattern match | `matches(message, "^[0-9]{5}$")` | | `containsEntryInFile(text, fileUuid)` | Check against uploaded file entries | `containsEntryInFile(message, "blocklist-uuid")` | ## Common Patterns[​](#common-patterns "Direct link to Common Patterns") ### VIP Handling[​](#vip-handling "Direct link to VIP Handling") ``` "vip" in member.labels ``` ### Business Hours[​](#business-hours "Direct link to Business Hours") ``` is_business_hours ``` ### Form Completion Check[​](#form-completion-check "Direct link to Form Completion Check") ``` member.data.onboarding.status == "complete" ``` ### Channel-Specific Logic[​](#channel-specific-logic "Direct link to Channel-Specific Logic") ``` chat.channel == "phone-sms" chat.channel == "phone-voice" || chat.channel == "web-voice" ``` ### Combined Conditions[​](#combined-conditions "Direct link to Combined Conditions") ``` "premium" in member.labels && is_business_hours && !chat.is_test ``` ### Content Filtering[​](#content-filtering "Direct link to Content Filtering") ``` containsEntryInFile(message, "blocked-words-uuid") == false ``` ### Record Status Change[​](#record-status-change "Direct link to Record Status Change") ``` changes.status.new == "complete" && changes.status.old != "complete" ``` ### Tool Invocation Routing (Edge Conditions)[​](#tool-invocation-routing-edge-conditions "Direct link to Tool Invocation Routing (Edge Conditions)") ``` # Advance when a field is set tool_invocations.exists(t, t.name == "update_intake_record" && has(t.args.profession)) # Route based on value tool_invocations.exists(t, t.name == "update_intake_record" && has(t.args.location_type) && t.args.location_type == "fort") # Boolean flag trigger tool_invocations.exists(t, t.name == "update_intake_record" && has(t.args.done) && t.args.done == true) ``` ## Data Type Validation[​](#data-type-validation "Direct link to Data Type Validation") CEL expressions can be used within Data Types to control field behavior and validate input. ### Conditional Field Options[​](#conditional-field-options "Direct link to Conditional Field Options") Use `visibleWhen` on enum options to show or hide choices based on other field values. The expression evaluates in the form editing context, where field names are available directly. **Example:** Show California-specific options only when the state is California. ``` state == "CA" ``` This would be set on enum options that should only appear for California residents. When the user selects "CA" in the state field, these options become visible. ### Field Validation[​](#field-validation "Direct link to Field Validation") Use `validateCel` on fields to add custom validation rules. The expression should return: * `true` if the value is valid * An error message string if the value is invalid Access field values using `record.data.`. **Example:** Require age to be 18 or older. ``` record.data.age >= 18 ? true : "Must be 18 or older" ``` **Example:** Require email for non-SMS contacts. ``` record.data.contact_method != "sms" && record.data.email == "" ? "Email is required for non-SMS contacts" : true ``` **Example:** Validate date is in the future. ``` record.data.appointment_date > current_date ? true : "Appointment must be scheduled for a future date" ``` ## Tips[​](#tips "Direct link to Tips") 1. **Use labels for permissions** — Labels like `"vip"`, `"verified"`, `"admin"` are the cleanest way to control access. 2. **Handle missing data** — Use `has(field)` to check if a field exists before accessing it. For example, `has(member.phone) && member.phone != ""` safely checks for a phone number. If a field doesn't exist and you access it directly, the expression evaluates to `false` rather than erroring. 3. **Test your expressions** — The CEL editor validates syntax in real-time. Invalid expressions show a red error indicator and cannot be saved. 4. **Keep it readable** — Break complex logic into multiple rules when possible. 5. **All available functions appear in the editor** — Click the "Functions" dropdown in the CEL editor toolbar to see all built-in and custom functions with signatures and examples. ## Error Recovery[​](#error-recovery "Direct link to Error Recovery") ### Circuit Breaker: Automatic Rule Disabling[​](#circuit-breaker-automatic-rule-disabling "Direct link to Circuit Breaker: Automatic Rule Disabling") If a CEL expression throws a runtime error on **5 or more consecutive evaluations**, Gravity Rail automatically disables the event rule to prevent it from causing repeated failures. When this happens: * The rule's `celBlockedAt` timestamp is set to the time of the fifth failure. * The rule stops firing — it will not evaluate or trigger any actions until it is re-enabled. * Other rules in the workspace are not affected. **Common causes:** * Accessing a field that doesn't exist on all members (use `has(field)` to guard) * Calling `.slug` on a label string (labels are plain strings, not objects — use `l == "vip"` not `l.slug == "vip"`) * A type mismatch between the expression and the actual field value **How to recover:** 1. Open the event rule in the workspace editor and review the CEL expression. 2. Fix the expression — refer to the [Available Variables](#available-variables) section and use `has()` to guard optional fields. 3. Save the corrected expression. Saving clears `celBlockedAt` and re-enables the rule immediately. > **Tip:** The CEL editor validates syntax in real-time, but runtime errors (e.g., a field that exists for some members but not others) only appear during actual evaluation. After fixing an expression, monitor the rule for a few minutes to confirm it is evaluating without errors. ## Related[​](#related "Direct link to Related") * **[Actions](https://docs.gravityrail.com/user-guide/automation/actions.md)** — Use CEL conditions to control when automations fire * **[Abilities](https://docs.gravityrail.com/user-guide/abilities/.md)** — Add CEL conditions to control when abilities activate * **[Qualifications](https://docs.gravityrail.com/user-guide/members/qualifications.md)** — Use CEL in formula criteria for evaluation --- # Experiments (A/B Testing) Experiments let you compare **Groups** — usually a control and one or more variants — for the same Member-facing experience. Gravity Rail assigns each Member to exactly one Group per Experiment, keeps that assignment sticky, and exposes the Group in [CEL expressions](https://docs.gravityrail.com/user-guide/automation/cel-expressions.md) so workflows, Actions, and task edges can branch without a separate enrollment step. Use experiments when you need weighted randomization and outcome comparison, not when a simple label or workspace-wide feature toggle is enough. ## Where to find it[​](#where-to-find-it "Direct link to Where to find it") Open **Automations → Experiments** in your workspace sidebar. Member assignments appear on each Member profile under the **Experiments** tab. Requires the workspace **Experiments** feature and role scopes `experiments:read` / `experiments:write` (typically granted with automation permissions). ## Key concepts[​](#key-concepts "Direct link to Key concepts") | Term | What it means | | -------------- | ------------------------------------------------------------------------------------------- | | **Experiment** | The test itself — name, slug, lifecycle, optional eligibility filter | | **Group** | One arm of the test (`control`, `friendly-opening`, …) with an allocation weight | | **Assignment** | Which Group a Member belongs to for this Experiment | | **Exposure** | Proof the Member actually reached the tested experience (used as the reporting denominator) | ## Creating an experiment[​](#creating-an-experiment "Direct link to Creating an experiment") 1. Go to **Automations → Experiments** → **New experiment** 2. Set a **slug** (lowercase, hyphens — used in CEL) and **name** 3. Add at least **two Groups** with allocation weights that sum to **100** 4. Mark one Group as **control** 5. Optionally set **Eligibility CEL** (see [Filtering who gets assigned](#filtering-who-gets-assigned)) 6. Start the Experiment when ready (**status → running**) While an Experiment is in **draft**, you can edit slugs and Groups freely. After it has **run**, slugs are locked because CEL expressions and reports depend on them. ## How assignment works (lazy)[​](#how-assignment-works-lazy "Direct link to How assignment works (lazy)") Gravity Rail does **not** pre-assign every Member when an Experiment starts. Instead: 1. You write a branch that reads the Member's experiment Group in CEL, for example: ``` member.experiments["opening-message-test"] == "friendly" ``` 2. The first time that expression is evaluated for a Member on a **runtime** surface (Event Rules including **journey step execute**, automatic task edges, journey step connection conditions, and similar), Gravity Rail: * Checks the Experiment is **running** * Applies **eligibility** if configured * Assigns the Member to a Group using deterministic weighted hashing * Records an **exposure** * Populates `member.experiments["opening-message-test"]` with the Group slug 3. Later reads return the same Group — assignment is sticky. If the Experiment is paused, completed, or archived, new assignments are not created. Existing assignments remain readable in CEL and on the Member profile. ## Branching in workflows and actions[​](#branching-in-workflows-and-actions "Direct link to Branching in workflows and actions") Use experiment checks anywhere CEL runs on runtime assignment surfaces: **Event rule on a journey step (`journey_step:execute`)** — typical pattern for comparing outbound SMS or email variants when a Member reaches a step: ``` member.experiments["opening-message-test"] == "control" ``` **Event rule on task execute or other assignment events:** ``` member.experiments["opening-message-test"] == "control" ``` **Journey step connection (branching between steps):** ``` member.experiments["routing-test"] == "variant-a" ``` **Automatic task edge:** ``` member.experiments["routing-test"] == "variant-a" ``` **Check membership without comparing to a Group:** ``` "opening-message-test" in member.experiments ``` Alternative slug syntax (hyphens → underscores): `member.experiments.opening_message_test == "control"`. If a Member is not assigned (ineligible, Experiment not running, or slug never read), the key is **absent** and equality checks evaluate **false**. Author a fallback path when you need behavior for unassigned Members. ## Filtering who gets assigned[​](#filtering-who-gets-assigned "Direct link to Filtering who gets assigned") **Eligibility CEL** on the Experiment settings page limits **who can be assigned** when they first hit an experiment branch. Example — only assign Members 18 or older: ``` member.age >= 18 ``` Example — only Members with a specific label: ``` "eligible-for-test" in member.labels ``` Members who fail eligibility: * Are **not** assigned to any Group * Do **not** appear in experiment stats denominators * Have no entry in `member.experiments[slug]` — branch conditions that assume assignment evaluate false Eligibility is evaluated once at assignment time, not on every subsequent read. ## Filtering what you see in lists[​](#filtering-what-you-see-in-lists "Direct link to Filtering what you see in lists") ### Archived experiments[​](#archived-experiments "Direct link to Archived experiments") The Experiments list hides **archived** experiments by default. Turn on **Include archived** in the UI (or pass `includeArchived=true` on the API / `yarn gr experiments list --include-archived true`) to show them. Archived experiments remain available for historical reporting but do not accept new assignments. ## Reporting[​](#reporting "Direct link to Reporting") ### Experiment stats[​](#experiment-stats "Direct link to Experiment stats") Open an Experiment → **Stats** to see per-Group **assigned** and **exposed** counts. ### Journey goal breakdown[​](#journey-goal-breakdown "Direct link to Journey goal breakdown") When analyzing a Journey, you can break goal achievement down by Experiment Group: 1. Open the Journey 2. Select an Experiment from the goal reporting control (when enabled) 3. Each goal shows per-Group **exposed**, **achieved**, and **conversion rate** **Who counts in the breakdown:** * Only Members **enrolled in this Journey** who have an **exposure** row for the selected Experiment * Assigned Members who were never exposed are excluded from denominators * Journey enrollments without experiment exposure are excluded This keeps journey comparisons aligned with Members who actually saw the treatment, not everyone who might eventually be assigned elsewhere. ### Small-number suppression (privacy)[​](#small-number-suppression-privacy "Direct link to Small-number suppression (privacy)") To reduce re-identification risk in small cohorts, Gravity Rail suppresses thin counts in experiment reporting: | Raw count | What you see | | --------- | ---------------------------------- | | 0–4 | `"<5"` instead of the exact number | | 5+ | Exact count | When the **exposed** count for a Group is suppressed, **conversion rate** is hidden (`null` / not shown) even if achievement count is known. This applies to Experiment stats and Journey goal experiment breakdowns. It is a display-layer rule for aggregate API responses, not a filter on who is assigned. ## Member profile[​](#member-profile "Direct link to Member profile") The **Experiments** tab on a Member shows current assignments: Experiment name, Group, assignment time, and source (`lazy` for first-encounter assignment). ## CLI quick reference[​](#cli-quick-reference "Direct link to CLI quick reference") ``` yarn gr experiments list -w $UUID yarn gr experiments list -w $UUID --include-archived true yarn gr experiments get -w $UUID --id 1 yarn gr experiments stats -w $UUID --id 1 yarn gr experiments members list -w $UUID --member-id 42 ``` Create and update accept JSON via `--data`. See the developer API reference for full request shapes. ## Filtering members by assignment[​](#filtering-members-by-assignment "Direct link to Filtering members by assignment") On the **Members** page, add a filter rule of type **Experiments**: | Filter type | Meaning | | ------------------- | --------------------------------------------------------------- | | **Assigned to any** | Member has an assignment to any selected Experiment (any Group) | | **Not assigned to** | Member has no assignment to any selected Experiment | | **In group** | Member is assigned to any selected Experiment Group | Saved member filters and routines can use the same rule shape in the `filters` JSON array (`objectType: "experiment"`). ### API query parameters[​](#api-query-parameters "Direct link to API query parameters") `GET /members` also accepts direct query params (alternative to filter rules): | Param | Description | | --------------------------- | ---------------------------------------------------------------- | | `experimentId` | Members assigned to this Experiment (any Group) | | `experimentGroupId` | Members assigned to this Group | | `experimentUnassigned=true` | With `experimentId`, Members **not** assigned to that Experiment | Example API call: ``` GET /api/v2/w/{workspace_uuid}/members?experimentId=3 ``` Filter rules use `objectType: "experiment"`, `filterType: "any" | "none" | "inGroup"`, and `objectIds` (experiment IDs or group IDs). ## Related guides[​](#related-guides "Direct link to Related guides") * [CEL Expressions](https://docs.gravityrail.com/user-guide/automation/cel-expressions.md) — `member.experiments` namespace * [Actions](https://docs.gravityrail.com/user-guide/automation/actions.md) — trigger experiment branches from EventRules * [Workflows](https://docs.gravityrail.com/user-guide/automation/workflows.md) — task edges and prompts * [Journeys](https://docs.gravityrail.com/user-guide/journeys.md) — programs and goal tracking * [Members](https://docs.gravityrail.com/user-guide/members/managing-members.md) — profile and assignments --- # Creating a Phone Call Action on a Workflow Task A **Phone Call** action initiates an AI-powered phone call to a member as part of an automated workflow. When the action fires, a voice conversation is created using the selected workflow — the AI agent calls the member and follows the workflow's conversation logic. > **How it fits together:** "Phone Call" is an **Action** type in Gravity Rail. Attach it to a workflow task as an entry action — when a member enters the task, the phone call is initiated automatically. The call uses the workflow you select to guide the AI agent through the conversation. ## Prerequisites[​](#prerequisites "Direct link to Prerequisites") * A **workflow** with at least one task designed for voice conversations (see [Workflows](https://docs.gravityrail.com/user-guide/automation/workflows.md)) * A **phone number** configured in your workspace (see [Phone & Voice](https://docs.gravityrail.com/user-guide/channels/phone-and-voice.md)) — this is the number the call is placed from * Your workspace must have **Twilio** configured for voice calls ## Steps[​](#steps "Direct link to Steps") ### 1. Open your workflow[​](#1-open-your-workflow "Direct link to 1. Open your workflow") Navigate to **Workflows** and open the workflow you will use for the phone call. If you don't have one yet, create a new workflow with tasks designed for voice interaction. ### 2. Navigate to the Actions page[​](#2-navigate-to-the-actions-page "Direct link to 2. Navigate to the Actions page") Go to **Actions** in your workspace. ### 3. Create a new action[​](#3-create-a-new-action "Direct link to 3. Create a new action") Click **New Action**. ### 4. Configure the trigger[​](#4-configure-the-trigger "Direct link to 4. Configure the trigger") Set the trigger to **Task Entered** and select the task from your workflow. The phone call is initiated when a member enters this task. ### 5. Select "Phone Call" as the action type[​](#5-select-phone-call-as-the-action-type "Direct link to 5. Select \"Phone Call\" as the action type") In the action type dropdown, select **Phone Call**. The phone call configuration form will appear. ### 6. Select the phone number[​](#6-select-the-phone-number "Direct link to 6. Select the phone number") Choose the phone number that will place the call from the **Phone Number** dropdown. This determines the caller ID that the member sees. If no phone numbers are listed, you need to configure one first in your workspace's phone settings. ### 7. Select the workflow[​](#7-select-the-workflow "Direct link to 7. Select the workflow") Choose the **Workflow** that will handle the phone call conversation. This workflow controls what the AI agent says during the call — its tasks, prompts, data collection, and branching logic all apply. The workflow should be designed for voice interactions. The AI agent will follow the workflow's conversation flow during the call. ### 8. Save the action[​](#8-save-the-action "Direct link to 8. Save the action") Click **Save**. The action is now linked to your workflow task and will initiate a phone call whenever a member enters that task. ## Phone Call Tips[​](#phone-call-tips "Direct link to Phone Call Tips") * **Design workflows for voice** — Voice conversations are different from text. Keep prompts concise and conversational. Avoid long lists or complex instructions that work in text but are hard to follow by ear. * **Test with your own number** — Create a test member with your own phone number and trigger the action to verify the call flow before using it with real members. * **Consider timing** — Phone calls are more intrusive than SMS or email. Combine with [CEL conditions](https://docs.gravityrail.com/user-guide/automation/cel-expressions.md) like `is_business_hours` to avoid calling at inappropriate times. * **Pair with a routine** — Use a [Routine](https://docs.gravityrail.com/user-guide/automation/routines.md) to call groups of members on a recurring schedule, such as daily appointment reminders. --- # Creating a Play Audio Action A **Play Audio** action plays a pre-recorded audio file from your workspace files during an automated voice flow — for example a regulatory disclosure that has to be delivered verbatim, a hold-message, or a voicemail recording dropped on an answering machine. > **How it fits together:** "Play Audio" is an **Action** type. You attach it to a workflow task (or a call event) so that when the trigger fires, the assistant plays the audio file instead of speaking text. Pair it with **Allow interrupt = off** for required disclosures that must be heard end-to-end. ## Prerequisites[​](#prerequisites "Direct link to Prerequisites") * A pre-recorded audio file uploaded to your workspace **Files**. Supported formats: WAV, MP3, M4A. * A **workflow** with the task that should play the audio (see [Workflows](https://docs.gravityrail.com/user-guide/automation/workflows.md)), or a phone-call trigger you want to attach the action to. * A voice-enabled assistant configured for the workflow. ## Steps[​](#steps "Direct link to Steps") ### 1. Upload the audio file[​](#1-upload-the-audio-file "Direct link to 1. Upload the audio file") Go to **Files** in your workspace and upload the audio file the action will play. WAV at 24 kHz mono produces the highest fidelity on a call leg; MP3 / M4A also work. ### 2. Open the Actions page[​](#2-open-the-actions-page "Direct link to 2. Open the Actions page") Go to **Actions** in your workspace and click **New Action**. ### 3. Configure the trigger[​](#3-configure-the-trigger "Direct link to 3. Configure the trigger") Choose the trigger that should play the clip — typically: * **Task Entered** for a clip that plays when the call reaches a specific workflow task (e.g. an opening disclosure on the first task). * **Call Started** for a clip that plays the moment a call connects (e.g. a voicemail-drop recording). ### 4. Select "Play Audio" as the action type[​](#4-select-play-audio-as-the-action-type "Direct link to 4. Select \"Play Audio\" as the action type") Pick **Play Audio** from the action-type dropdown. The Play Audio form appears. ### 5. Pick the audio clip[​](#5-pick-the-audio-clip "Direct link to 5. Pick the audio clip") Use the file picker to select the audio file you uploaded. The picker lists files whose mime type begins with `audio/` (plus `.m4a` voice-memos). Click the **Preview** button next to the picker to listen to the clip in the browser before saving. ### 6. Set the volume[​](#6-set-the-volume "Direct link to 6. Set the volume") The **Volume** slider controls server-side gain that's applied as the clip is streamed to the call leg. * **80% is the unity default** — no adjustment, the call hears the file as-recorded. * Higher values boost the level; lower values attenuate. * The browser preview tracks the slider for attenuation but caps at unity (it can't boost above the source's natural level). Above-unity gain only takes effect on the live call. If your recordings are already mastered loud, leave the slider at 80%. If a recording was captured at a low level, raise the slider until the in-browser preview is comfortably audible (it will be slightly louder again on the live call). ### 7. Allow interrupt[​](#7-allow-interrupt "Direct link to 7. Allow interrupt") The **Allow interrupt** switch controls whether the caller can interrupt the clip by speaking. * **On** (default) — speaking interrupts the clip and hands the turn back to the assistant. Right for greetings, hold-music, and most narrative content. * **Off** — the clip plays end-to-end. Server VAD ignores barge-in, and any final transcript that arrives mid-clip is **deferred** until playback completes (so something the caller said before the clip began doesn't interrupt the disclosure). Right for regulatory disclosures, recorded notices that must be delivered verbatim, and any clip that has to be heard in full. ### 8. Hang up after[​](#8-hang-up-after "Direct link to 8. Hang up after") The **Hang up after** switch ends the call immediately when the clip finishes — no further AI turns, no follow-up questions. Pair this with **Allow interrupt = off** for **voicemail drops**: the assistant calls, leaves the recorded message even if the answering machine starts beeping, and then disconnects without the AI improvising. ### 9. Save the action[​](#9-save-the-action "Direct link to 9. Save the action") Click **Save**. The action is now linked to its trigger and fires whenever the trigger event happens. ## Recipes[​](#recipes "Direct link to Recipes") ### Mandatory regulatory disclosure on call connect[​](#mandatory-regulatory-disclosure-on-call-connect "Direct link to Mandatory regulatory disclosure on call connect") | Setting | Value | | --------------- | -------------------------------------- | | Trigger | **Call Started** | | Audio clip | `disclosure-2026.wav` (your recording) | | Volume | 80% | | Allow interrupt | **Off** | | Hang up after | Off | Plays the disclosure verbatim the moment the call connects. The caller cannot talk over it; mid-clip transcripts are queued and delivered to the assistant once the disclosure finishes. ### Voicemail drop with hang-up[​](#voicemail-drop-with-hang-up "Direct link to Voicemail drop with hang-up") | Setting | Value | | --------------- | -------------------------------------------------------------------------- | | Trigger | **Task Entered** (a "leave voicemail" task) | | Audio clip | `voicemail-promo.mp3` | | Volume | 80–95% (recordings tend to need a slight boost over voicemail compression) | | Allow interrupt | **Off** | | Hang up after | **On** | Plays the recorded message and disconnects. The AI never improvises — what the answering machine captures is exactly what was uploaded. ### Hold music while a tool runs[​](#hold-music-while-a-tool-runs "Direct link to Hold music while a tool runs") | Setting | Value | | --------------- | ------------------------------------------ | | Trigger | **Task Entered** (a "lookup pending" task) | | Audio clip | `short-hold.mp3` | | Volume | 70% (slightly attenuated below speech) | | Allow interrupt | **On** | | Hang up after | Off | Lets the caller barge in to ask a follow-up question. The assistant resumes the conversation as soon as the lookup completes. ## Notes & limitations[​](#notes--limitations "Direct link to Notes & limitations") * **Audio clips are workspace files**, not member-specific recordings. If you need a per-member dynamic message (e.g. "Hi {{member.first\_name}}…"), use **Assistant Message** with text instead — the assistant will TTS the message on the fly. * **The clip's persisted message** appears in the chat transcript as an audio bubble with a play button, so reviewers can hear exactly what was delivered. The bubble shows `plays end-to-end` / `then hangs up` annotations when those switches were set. * **Replay in the web voice console** plays the persisted clip (not a fresh TTS), so what you hear during replay is what the caller heard. --- # Routines Routines run actions on a schedule - daily reports, weekly cleanups, follow-up reminders. Set it and forget it. ## Creating a Routine[​](#creating-a-routine "Direct link to Creating a Routine") 1. Go to **Routines** 2. Click **New Routine** 3. Configure when it runs and who it targets ## Schedule Types[​](#schedule-types "Direct link to Schedule Types") | Type | When It Runs | | --------------- | --------------------------- | | **Manual Only** | Only when you click "Run" | | **Once** | At a specific date and time | | **CRON** | Recurring schedule | | **Interval** | Every X seconds | ### CRON Examples[​](#cron-examples "Direct link to CRON Examples") ``` 0 9 * * 1-5 Every weekday at 9 AM 0 17 * * 5 Every Friday at 5 PM 0 0 1 * * First day of each month 0 8 * * * Daily at 8 AM ``` ## Targeting Members[​](#targeting-members "Direct link to Targeting Members") Routines run for specific members: * **All Members** - Everyone in workspace * **Member Filter** - Target by labels, roles, or data * **Specific Member** - One person only ## Attaching Actions[​](#attaching-actions "Direct link to Attaching Actions") Link your routine to actions: 1. Create an Action first 2. In the routine, select which actions to run 3. Actions execute in order for each targeted member ## Running Routines[​](#running-routines "Direct link to Running Routines") **Automatic:** Routines run on schedule when active. **Manual:** Click **Run** to trigger immediately. **Paused:** Disable temporarily without deleting. ## Tracking Execution[​](#tracking-execution "Direct link to Tracking Execution") Each run creates a record: * **Status**: Completed, Failed, In Progress * **Member Count**: How many were processed * **Errors**: What went wrong (if anything) ## Common Patterns[​](#common-patterns "Direct link to Common Patterns") **Daily check-in:** * Schedule: `0 9 * * 1-5` (weekdays 9 AM) * Target: Members without recent activity * Action: Send reminder notification **Weekly summary:** * Schedule: `0 17 * * 5` (Friday 5 PM) * Target: All team members * Action: Send week's metrics via webhook **Monthly billing:** * Schedule: `0 0 1 * *` (first of month) * Target: Active customers * Action: Trigger invoice generation **Follow-up loop:** * Schedule: Interval every 3600 seconds * Target: Members with pending tasks * Action: Send reminder ## Journey Events[​](#journey-events "Direct link to Journey Events") If your workspace uses [Journeys](https://docs.gravityrail.com/user-guide/journeys.md), you can attach actions to journey lifecycle events. These events fire automatically as members progress through a journey. | Event | When It Fires | | -------------------------- | --------------------------------------------------- | | **Journey Enrolled** | A member is enrolled in a journey | | **Journey Completed** | A member completes all goal steps in a journey | | **Journey Step Due** | A step's trigger time arrives (time-based triggers) | | **Journey Step Entered** | A member's step transitions to in progress | | **Journey Step Completed** | A member's step transitions to completed | ### Common Patterns[​](#common-patterns-1 "Direct link to Common Patterns") **Notify staff when a member enrolls:** * Event: Journey Enrolled * Action: Member Notify to care team **Send a congratulations message when a journey completes:** * Event: Journey Completed * Action: Assistant Message with a personalized completion message **Escalate when a step becomes due:** * Event: Journey Step Due * Action: Send Webhook to external care management system **Log step completion for reporting:** * Event: Journey Step Completed * Action: Send Webhook to analytics platform --- # Creating a Send Email Action on a Workflow Task A **Send Email** action lets you send templated emails to members as part of an automated workflow. For email campaigns, you attach this action as the **entry item** on the first task of a workflow — when a member enters the task, the email fires automatically. > **How it fits together:** "Send Email" is an **Action** type in Gravity Rail. In a campaign workflow, you assign it as the entry action on your first task. When a routine triggers the workflow for each targeted member, the member enters the first task, which fires the Send Email action and delivers the email. ## Prerequisites[​](#prerequisites "Direct link to Prerequisites") * A **workflow** with at least one task (see [Workflows](https://docs.gravityrail.com/user-guide/automation/workflows.md)) * An **inbox** configured in your workspace (see [Email & Inboxes](https://docs.gravityrail.com/user-guide/channels/email-inboxes.md)) — this determines the "from" address for the email * Your email content ready (subject line and body, optionally in HTML) ## Steps[​](#steps "Direct link to Steps") ### 1. Open your campaign workflow[​](#1-open-your-campaign-workflow "Direct link to 1. Open your campaign workflow") Navigate to **Workflows** and open the workflow you'll use for the campaign. If you don't have one yet, create a new workflow and add at least one task (this will be the task that sends the email). ### 2. Navigate to the Actions page[​](#2-navigate-to-the-actions-page "Direct link to 2. Navigate to the Actions page") Go to **Actions** in your workspace. ### 3. Create a new action[​](#3-create-a-new-action "Direct link to 3. Create a new action") Click **New Action**. ### 4. Configure the trigger[​](#4-configure-the-trigger "Direct link to 4. Configure the trigger") Set the trigger to **Task Entered** and select the first task of your campaign workflow. This ensures the email fires when a member enters the task — which happens automatically when the routine starts the workflow for each member. ### 5. Select "Send Email" as the action type[​](#5-select-send-email-as-the-action-type "Direct link to 5. Select \"Send Email\" as the action type") In the action type dropdown, select **Send Email**. The email configuration form will appear. ### 6. Select the inbox[​](#6-select-the-inbox "Direct link to 6. Select the inbox") Choose the inbox that will send the email from the **Inbox** dropdown. This determines the "from" address and reply-to behavior. Replies to this email will be received by this inbox (and can trigger a reply-handling workflow — see the main tutorial). ### 7. Enter the subject line[​](#7-enter-the-subject-line "Direct link to 7. Enter the subject line") In the **Subject** field, enter your email subject. You can use template variables for personalization: ``` {{member.first_name}}, your enrollment update is ready ``` ### 8. Enter the email body[​](#8-enter-the-email-body "Direct link to 8. Enter the email body") In the **Body** field, enter your email content. You have two options: * **Plain text**: Write your message as plain text. * **HTML**: Paste or write HTML markup for rich formatting, images, and styling. Use the **Content Type** dropdown to switch between `text` and `html`. Template variables work in the body as well: ```

Hello {{member.first_name}},

We're reaching out about your enrollment in the program.

If you have any questions, simply reply to this email and our team will assist you.

``` ### 9. Set the content type[​](#9-set-the-content-type "Direct link to 9. Set the content type") Select the content type from the dropdown: * **text** — Plain text email (default) * **html** — HTML-formatted email with support for styling, images, and layout ### 10. Set an email override (optional)[​](#10-set-an-email-override-optional "Direct link to 10. Set an email override (optional)") If you want the email to go to a specific address instead of the member's email on file, enter it in the **To Email** field. Leave this blank for campaigns — the email will be sent to each targeted member's email address automatically. ### 11. Save the action[​](#11-save-the-action "Direct link to 11. Save the action") Click **Save** to create the action. The action is now linked to your workflow task and will fire whenever a member enters that task. ## Template Variables[​](#template-variables "Direct link to Template Variables") You can personalize both the subject and body with template variables using `{{variable}}` syntax. Commonly used variables for email campaigns: | Variable | Example Value | | ---------------------------- | --------------------- | | `{{member.first_name}}` | "Jane" | | `{{member.name}}` | "Jane Smith" | | `{{member.email}}` | "" | | `{{member.phone}}` | "+1 555 123-4567" | | `{{member.date_of_birth}}` | "1980-06-15" | | `{{member.age}}` | 45 | | `{{member.data.SLUG.FIELD}}` | Custom form data | | `{{assistant.name}}` | "Support Bot" | | `{{task.name}}` | "Customer Onboarding" | For conditional content, use Jinja2-style blocks: ``` {% if member.data.profile.company %} Company: {{member.data.profile.company}} {% endif %} ``` For the full list of available variables, see [Template Variables](https://docs.gravityrail.com/user-guide/developer/template-variables.md). ## HTML Email Tips[​](#html-email-tips "Direct link to HTML Email Tips") * **Use inline CSS** — Most email clients strip `