NuramaClient
NuramaClient class reference.
Classes
default
Client interface for interacting with the Nurama REST API.
Constructors
Constructor
new default(baseURL, options?): default;Creates an instance of NuramaClient.
Parameters
| Parameter | Type | Description |
|---|---|---|
baseURL | string | The base URL for the Nurama API. |
options | NuramaClientOptions | Configuration options. |
Returns
Properties
| Property | Modifier | Type | Default value | Description |
|---|---|---|---|---|
ai | public | { composeWithNu: Promise<ComposeWithNuResponse>; createRevisionSourceUpload: Promise<CreateRevisionSourceUploadResponse>; generateRevision: Promise<GenerateImageRevisionResponse>; generateTasks: Promise<GenerateTasksResponse>; listTones: Promise<ListTonesResponse>; polish: Promise<PolishResponse>; submitFeedback: Promise<{ id: string; }>; } | undefined | - |
ai.composeWithNu | public | Promise<ComposeWithNuResponse> | undefined | - |
ai.createRevisionSourceUpload | public | Promise<CreateRevisionSourceUploadResponse> | undefined | - |
ai.generateRevision | public | Promise<GenerateImageRevisionResponse> | undefined | - |
ai.generateTasks | public | Promise<GenerateTasksResponse> | undefined | - |
ai.listTones | public | Promise<ListTonesResponse> | undefined | - |
ai.polish | public | Promise<PolishResponse> | undefined | - |
ai.submitFeedback | public | Promise<{ id: string; }> | undefined | - |
aiChat | public | { createTopic: Promise<AiChatCreateTopicResponse>; deleteTopic: Promise<AiChatGetTopicResponse>; getTopic: Promise<AiChatGetTopicResponse>; listTopics: Promise<AiChatListTopicsResponse>; updateTopic: Promise<AiChatGetTopicResponse>; } | undefined | - |
aiChat.createTopic | public | Promise<AiChatCreateTopicResponse> | undefined | - |
aiChat.deleteTopic | public | Promise<AiChatGetTopicResponse> | undefined | - |
aiChat.getTopic | public | Promise<AiChatGetTopicResponse> | undefined | - |
aiChat.listTopics | public | Promise<AiChatListTopicsResponse> | undefined | - |
aiChat.updateTopic | public | Promise<AiChatGetTopicResponse> | undefined | - |
asset | readonly | AssetMethods | undefined | - |
auth | readonly | AuthMethods | undefined | - |
baseURL | readonly | string | undefined | - |
blogPosts | public | { listBlogPosts: Promise<BlogPostListResponse>; } | undefined | - |
blogPosts.listBlogPosts | public | Promise<BlogPostListResponse> | undefined | - |
board | public | { addColumn: Promise<BoardColumn>; addExistingTaskToBoard: Promise<Task>; createBoard: Promise<Board>; createBoardTask: Promise<Task>; deleteBoard: Promise<{ deletedTaskIds: string[]; disposition: string; message: string; reassignedTaskIds: string[]; }>; deleteColumn: Promise<void>; followBoard: Promise<Board>; getBoard: Promise<BoardWithTasks>; getBoardTasks: Promise<Task[]>; getProjectBoards: Promise<Board[]>; getProjectTasks: Promise<any>; moveTask: Promise<Task>; removeTaskFromBoard: Promise<Task>; reorderColumns: Promise<BoardColumn[]>; tagBoard: Promise<Board>; unfollowBoard: Promise<Board>; untagBoard: Promise<Board>; updateBoard: Promise<Board>; updateColumn: Promise<BoardColumn>; } | undefined | - |
board.addColumn | public | Promise<BoardColumn> | undefined | - |
board.addExistingTaskToBoard | public | Promise<Task> | undefined | - |
board.createBoard | public | Promise<Board> | undefined | - |
board.createBoardTask | public | Promise<Task> | undefined | - |
board.deleteBoard | public | Promise<{ deletedTaskIds: string[]; disposition: string; message: string; reassignedTaskIds: string[]; }> | undefined | - |
board.deleteColumn | public | Promise<void> | undefined | - |
board.followBoard | public | Promise<Board> | undefined | - |
board.getBoard | public | Promise<BoardWithTasks> | undefined | - |
board.getBoardTasks | public | Promise<Task[]> | undefined | - |
board.getProjectBoards | public | Promise<Board[]> | undefined | - |
board.getProjectTasks | public | Promise<any> | undefined | - |
board.moveTask | public | Promise<Task> | undefined | - |
board.removeTaskFromBoard | public | Promise<Task> | undefined | - |
board.reorderColumns | public | Promise<BoardColumn[]> | undefined | - |
board.tagBoard | public | Promise<Board> | undefined | - |
board.unfollowBoard | public | Promise<Board> | undefined | - |
board.untagBoard | public | Promise<Board> | undefined | - |
board.updateBoard | public | Promise<Board> | undefined | - |
board.updateColumn | public | Promise<BoardColumn> | undefined | - |
bot | public | { createBot: Promise<CreateBotResponse>; createBotKey: Promise<CreateBotKeyResponse>; deleteBot: Promise<void>; getBot: Promise<Bot>; listBots: Promise<Bot[]>; listProjectMemberships: Promise<BotProjectMembership[]>; removeProjectMembership: Promise<void>; revokeBotKey: Promise<void>; rotateBotKey: Promise<RotateBotKeyResponse>; setProjectMembership: Promise<BotProjectMembership>; updateBot: Promise<Bot>; updateBotAvatar: Promise<UpdateBotAvatarResponse>; updateBotKeyScopes: Promise<BotApiKeySummary>; } | undefined | - |
bot.createBot | public | Promise<CreateBotResponse> | undefined | - |
bot.createBotKey | public | Promise<CreateBotKeyResponse> | undefined | - |
bot.deleteBot | public | Promise<void> | undefined | - |
bot.getBot | public | Promise<Bot> | undefined | - |
bot.listBots | public | Promise<Bot[]> | undefined | - |
bot.listProjectMemberships | public | Promise<BotProjectMembership[]> | undefined | - |
bot.removeProjectMembership | public | Promise<void> | undefined | - |
bot.revokeBotKey | public | Promise<void> | undefined | - |
bot.rotateBotKey | public | Promise<RotateBotKeyResponse> | undefined | - |
bot.setProjectMembership | public | Promise<BotProjectMembership> | undefined | - |
bot.updateBot | public | Promise<Bot> | undefined | - |
bot.updateBotAvatar | public | Promise<UpdateBotAvatarResponse> | undefined | - |
bot.updateBotKeyScopes | public | Promise<BotApiKeySummary> | undefined | - |
browserMode | readonly | boolean | false | - |
cacheDurationSeconds | readonly | number | undefined | - |
chat | public | { addAttachments: Promise<AttachmentUploadRecord[]>; addMembers: Promise<ChatMember>; archiveMemberChat: Promise<ChatMember>; createAssetChatAndMessage: Promise<any>; createMemberChat: Promise<ChatMember>; createMessage: Promise<ChatMessage>; createMessageShortLink: Promise<{ code: string; shortUrl: string; }>; createReaction: Promise<ChatMessage>; createTopicChat: Promise<Chat>; deleteChat: Promise<void>; deleteMemberChat: Promise<void>; deleteMessage: Promise<ChatMessage>; fetchLinkPreviews: Promise<LinkPreviewResponse>; followChat: Promise<void>; getAddableMembers: Promise< | AddableMembersByScope | Membership[]>; getChat: Promise<Chat>; getChatByTopicId: Promise<Chat>; getMemberChat: Promise<ChatMember>; getMemberChatReadState: Promise<ReadState>; getMemberChatReadStates: Promise<{ results: MemberChatReadState[]; }>; getMentionableAssets: Promise<PaginatedResponse<Asset>>; getMentionableFolders: Promise<PaginatedResponse<Folder>>; getMentionablePublics: Promise<PaginatedResponse<MentionablePublic>>; getMentionableSubmissions: Promise<PaginatedResponse<MentionableSubmission>>; getMentionableTasks: Promise<PaginatedResponse<any>>; getMentions: Promise<PaginatedResponse<ChatMessage>>; getMessage: Promise<ChatMessage>; getMessages: Promise<PaginatedResponse<ChatMessage>>; getReplies: Promise<PaginatedResponse<ChatMessage>>; getScopeAddableMembers: Promise< | AddableMembersByScope | Membership[]>; getUsersMemberChats: Promise<PaginatedResponse<ChatMember>>; getWorkspaceProjectChats: Promise<any[]>; highlightMessage: Promise<ChatMessage>; markMemberChatCaughtUp: Promise<ReadState>; removeAttachment: Promise<ChatMessage>; removeMembers: Promise<ChatMember>; removeReaction: Promise<ChatMessage>; reviseMessage: Promise<ChatMessage>; unarchiveMemberChat: Promise<ChatMember>; unfollowChat: Promise<void>; unhighlightMessage: Promise<ChatMessage>; updateChatSubject: Promise<Chat>; updateMemberChat: Promise<ChatMember>; updateMemberChatIcon: Promise<{ chat: ChatMember; } & AttachmentUploadRecord>; } | undefined | - |
chat.addAttachments | public | Promise<AttachmentUploadRecord[]> | undefined | - |
chat.addMembers | public | Promise<ChatMember> | undefined | - |
chat.archiveMemberChat | public | Promise<ChatMember> | undefined | - |
chat.createAssetChatAndMessage | public | Promise<any> | undefined | - |
chat.createMemberChat | public | Promise<ChatMember> | undefined | - |
chat.createMessage | public | Promise<ChatMessage> | undefined | - |
chat.createMessageShortLink | public | Promise<{ code: string; shortUrl: string; }> | undefined | - |
chat.createReaction | public | Promise<ChatMessage> | undefined | - |
chat.createTopicChat | public | Promise<Chat> | undefined | - |
chat.deleteChat | public | Promise<void> | undefined | - |
chat.deleteMemberChat | public | Promise<void> | undefined | - |
chat.deleteMessage | public | Promise<ChatMessage> | undefined | - |
chat.fetchLinkPreviews | public | Promise<LinkPreviewResponse> | undefined | - |
chat.followChat | public | Promise<void> | undefined | - |
chat.getAddableMembers | public | Promise< | AddableMembersByScope | Membership[]> | undefined | - |
chat.getChat | public | Promise<Chat> | undefined | - |
chat.getChatByTopicId | public | Promise<Chat> | undefined | - |
chat.getMemberChat | public | Promise<ChatMember> | undefined | - |
chat.getMemberChatReadState | public | Promise<ReadState> | undefined | - |
chat.getMemberChatReadStates | public | Promise<{ results: MemberChatReadState[]; }> | undefined | - |
chat.getMentionableAssets | public | Promise<PaginatedResponse<Asset>> | undefined | - |
chat.getMentionableFolders | public | Promise<PaginatedResponse<Folder>> | undefined | - |
chat.getMentionablePublics | public | Promise<PaginatedResponse<MentionablePublic>> | undefined | - |
chat.getMentionableSubmissions | public | Promise<PaginatedResponse<MentionableSubmission>> | undefined | - |
chat.getMentionableTasks | public | Promise<PaginatedResponse<any>> | undefined | - |
chat.getMentions | public | Promise<PaginatedResponse<ChatMessage>> | undefined | - |
chat.getMessage | public | Promise<ChatMessage> | undefined | - |
chat.getMessages | public | Promise<PaginatedResponse<ChatMessage>> | undefined | - |
chat.getReplies | public | Promise<PaginatedResponse<ChatMessage>> | undefined | - |
chat.getScopeAddableMembers | public | Promise< | AddableMembersByScope | Membership[]> | undefined | - |
chat.getUsersMemberChats | public | Promise<PaginatedResponse<ChatMember>> | undefined | - |
chat.getWorkspaceProjectChats | public | Promise<any[]> | undefined | - |
chat.highlightMessage | public | Promise<ChatMessage> | undefined | - |
chat.markMemberChatCaughtUp | public | Promise<ReadState> | undefined | - |
chat.removeAttachment | public | Promise<ChatMessage> | undefined | - |
chat.removeMembers | public | Promise<ChatMember> | undefined | - |
chat.removeReaction | public | Promise<ChatMessage> | undefined | - |
chat.reviseMessage | public | Promise<ChatMessage> | undefined | - |
chat.unarchiveMemberChat | public | Promise<ChatMember> | undefined | - |
chat.unfollowChat | public | Promise<void> | undefined | - |
chat.unhighlightMessage | public | Promise<ChatMessage> | undefined | - |
chat.updateChatSubject | public | Promise<Chat> | undefined | - |
chat.updateMemberChat | public | Promise<ChatMember> | undefined | - |
chat.updateMemberChatIcon | public | Promise<{ chat: ChatMember; } & AttachmentUploadRecord> | undefined | - |
config | readonly | ConfigMethods | undefined | - |
convo | public | { completeConvo: Promise<CompleteConvoResponse>; deleteConvo: Promise<void>; getChatConvos: Promise<Convo[]>; getConvo: Promise<GetConvoResponse>; getProjectConvos: Promise<Convo[]>; getScopeConvos: Promise<GetScopeConvosResponse>; joinConvo: Promise<JoinConvoResponse>; leaveConvo: Promise<LeaveConvoResponse>; promoteConvoArtifact: Promise<PromoteConvoArtifactResponse>; rejoinConvo: Promise<JoinConvoResponse>; startConvo: Promise<StartConvoResponse>; updateConvo: Promise<UpdateConvoResponse>; } | undefined | - |
convo.completeConvo | public | Promise<CompleteConvoResponse> | undefined | - |
convo.deleteConvo | public | Promise<void> | undefined | - |
convo.getChatConvos | public | Promise<Convo[]> | undefined | - |
convo.getConvo | public | Promise<GetConvoResponse> | undefined | - |
convo.getProjectConvos | public | Promise<Convo[]> | undefined | - |
convo.getScopeConvos | public | Promise<GetScopeConvosResponse> | undefined | - |
convo.joinConvo | public | Promise<JoinConvoResponse> | undefined | - |
convo.leaveConvo | public | Promise<LeaveConvoResponse> | undefined | - |
convo.promoteConvoArtifact | public | Promise<PromoteConvoArtifactResponse> | undefined | - |
convo.rejoinConvo | public | Promise<JoinConvoResponse> | undefined | - |
convo.startConvo | public | Promise<StartConvoResponse> | undefined | - |
convo.updateConvo | public | Promise<UpdateConvoResponse> | undefined | - |
credits | public | { getBalance: Promise<GetBalanceResponse>; getUsageReport: Promise<UsageReportResponse>; } | undefined | - |
credits.getBalance | public | Promise<GetBalanceResponse> | undefined | - |
credits.getUsageReport | public | Promise<UsageReportResponse> | undefined | - |
debug | readonly | boolean | undefined | - |
device | public | { deleteDevice: Promise<void>; endLiveActivity: Promise<void>; getDevice: Promise<Device>; getUserDevices: Promise<Device[]>; registerDevice: Promise<Device>; registerLiveActivity: Promise<LiveActivityRegistration>; updateDevice: Promise<Device>; } | undefined | - |
device.deleteDevice | public | Promise<void> | undefined | - |
device.endLiveActivity | public | Promise<void> | undefined | - |
device.getDevice | public | Promise<Device> | undefined | - |
device.getUserDevices | public | Promise<Device[]> | undefined | - |
device.registerDevice | public | Promise<Device> | undefined | - |
device.registerLiveActivity | public | Promise<LiveActivityRegistration> | undefined | - |
device.updateDevice | public | Promise<Device> | undefined | - |
enableCache | readonly | boolean | undefined | - |
fetch | readonly | (input, init?) => Promise<Response> | undefined | - |
folder | public | { getFolder: Promise<Folder>; getFoldersAssets: Promise<PaginatedResponse<Asset>>; tagFolder: Promise<Folder>; untagFolder: Promise<Folder>; updateFolder: Promise<Folder>; updateFolderIcon: Promise<any>; } | undefined | - |
folder.getFolder | public | Promise<Folder> | undefined | - |
folder.getFoldersAssets | public | Promise<PaginatedResponse<Asset>> | undefined | - |
folder.tagFolder | public | Promise<Folder> | undefined | - |
folder.untagFolder | public | Promise<Folder> | undefined | - |
folder.updateFolder | public | Promise<Folder> | undefined | - |
folder.updateFolderIcon | public | Promise<any> | undefined | - |
invalidateCacheOnMutation | readonly | boolean | undefined | - |
invite | public | { acceptInvite: Promise<AcceptInviteResponse>; cancelInvite: Promise<Invite>; getInviteById: Promise<Invite>; getInvites: Promise<PaginatedInvitesResponse>; getInvitesForResource: Promise<Invite[]>; inviteUser: Promise<Invite>; resendInvite: Promise<Invite>; } | undefined | - |
invite.acceptInvite | public | Promise<AcceptInviteResponse> | undefined | - |
invite.cancelInvite | public | Promise<Invite> | undefined | - |
invite.getInviteById | public | Promise<Invite> | undefined | - |
invite.getInvites | public | Promise<PaginatedInvitesResponse> | undefined | - |
invite.getInvitesForResource | public | Promise<Invite[]> | undefined | - |
invite.inviteUser | public | Promise<Invite> | undefined | - |
invite.resendInvite | public | Promise<Invite> | undefined | - |
joinLink | public | { approveJoinRequest: Promise<ApproveJoinRequestResponse>; createJoinLink: Promise<JoinLink>; createResourceBan: Promise<ResourceBan>; getJoinByToken: Promise<JoinLinkPreview>; getJoinLinks: Promise<JoinLinksListResponse>; getJoinRequests: Promise<ListJoinRequestsResponse>; getMyJoinRequests: Promise<ListMyJoinRequestsResponse>; getResourceBans: Promise<ListBansResponse>; joinByToken: Promise<RedeemJoinLinkResult>; liftResourceBan: Promise<ResourceBan>; rejectJoinRequest: Promise<RejectJoinRequestResponse>; rollJoinLink: Promise<JoinLink>; updateJoinLink: Promise<JoinLink>; updateJoinRequestCooldown: Promise<ProjectJoinRequest>; } | undefined | - |
joinLink.approveJoinRequest | public | Promise<ApproveJoinRequestResponse> | undefined | - |
joinLink.createJoinLink | public | Promise<JoinLink> | undefined | - |
joinLink.createResourceBan | public | Promise<ResourceBan> | undefined | - |
joinLink.getJoinByToken | public | Promise<JoinLinkPreview> | undefined | - |
joinLink.getJoinLinks | public | Promise<JoinLinksListResponse> | undefined | - |
joinLink.getJoinRequests | public | Promise<ListJoinRequestsResponse> | undefined | - |
joinLink.getMyJoinRequests | public | Promise<ListMyJoinRequestsResponse> | undefined | - |
joinLink.getResourceBans | public | Promise<ListBansResponse> | undefined | - |
joinLink.joinByToken | public | Promise<RedeemJoinLinkResult> | undefined | - |
joinLink.liftResourceBan | public | Promise<ResourceBan> | undefined | - |
joinLink.rejectJoinRequest | public | Promise<RejectJoinRequestResponse> | undefined | - |
joinLink.rollJoinLink | public | Promise<JoinLink> | undefined | - |
joinLink.updateJoinLink | public | Promise<JoinLink> | undefined | - |
joinLink.updateJoinRequestCooldown | public | Promise<ProjectJoinRequest> | undefined | - |
membership | public | { addRole: Promise<Membership>; deleteMembership: Promise<void>; getMyMemberships: Promise<Membership[]>; getProjectLastSeen: Promise<GetLastSeenResponse>; getProjectMemberships: Promise<MembershipReport>; getProjectMentionableUsers: Promise<Mentionable[]>; getWorkspaceLastSeen: Promise<GetLastSeenResponse>; getWorkspaceMemberships: Promise<MembershipReport>; leaveResource: Promise<void>; removeRole: Promise<Membership>; } | undefined | - |
membership.addRole | public | Promise<Membership> | undefined | - |
membership.deleteMembership | public | Promise<void> | undefined | - |
membership.getMyMemberships | public | Promise<Membership[]> | undefined | - |
membership.getProjectLastSeen | public | Promise<GetLastSeenResponse> | undefined | - |
membership.getProjectMemberships | public | Promise<MembershipReport> | undefined | - |
membership.getProjectMentionableUsers | public | Promise<Mentionable[]> | undefined | - |
membership.getWorkspaceLastSeen | public | Promise<GetLastSeenResponse> | undefined | - |
membership.getWorkspaceMemberships | public | Promise<MembershipReport> | undefined | - |
membership.leaveResource | public | Promise<void> | undefined | - |
membership.removeRole | public | Promise<Membership> | undefined | - |
notification | public | { getNewNotificationCount: Promise<NotificationCountResponse>; getNewNotificationCountBulk: Promise<NotificationCountBulkResponse>; getNewNotifications: Promise<PaginatedNotificationResponse>; getNotifications: Promise<PaginatedNotificationResponse>; getUsersLastNotificationsSeen: Promise<LastSeenResponse>; updateUsersLastSeen: Promise<LastSeenResponse>; } | undefined | - |
notification.getNewNotificationCount | public | Promise<NotificationCountResponse> | undefined | - |
notification.getNewNotificationCountBulk | public | Promise<NotificationCountBulkResponse> | undefined | - |
notification.getNewNotifications | public | Promise<PaginatedNotificationResponse> | undefined | - |
notification.getNotifications | public | Promise<PaginatedNotificationResponse> | undefined | - |
notification.getUsersLastNotificationsSeen | public | Promise<LastSeenResponse> | undefined | - |
notification.updateUsersLastSeen | public | Promise<LastSeenResponse> | undefined | - |
oauthGrant | public | { listGrants: Promise<OAuthGrantSummary[]>; revokeGrant: Promise<void>; } | undefined | Connected applications: what the user has authorised over OAuth. |
oauthGrant.listGrants | public | Promise<OAuthGrantSummary[]> | undefined | - |
oauthGrant.revokeGrant | public | Promise<void> | undefined | - |
payment | public | { createManualCheckout: Promise<any>; createStripeCheckout: Promise<StripeCheckoutResponse>; createStripeCustomer: Promise<StripeCustomerResponse>; getStripePortalUrl: Promise<StripePortalResponse>; } | undefined | - |
payment.createManualCheckout | public | Promise<any> | undefined | - |
payment.createStripeCheckout | public | Promise<StripeCheckoutResponse> | undefined | - |
payment.createStripeCustomer | public | Promise<StripeCustomerResponse> | undefined | - |
payment.getStripePortalUrl | public | Promise<StripePortalResponse> | undefined | - |
product | public | { getSuggestedCurrency: Promise<{ country: string | null; currency: SupportedCurrency; locked?: boolean; supported: SupportedCurrency[]; }>; getWorkspaceProducts: Promise<Product[]>; listPlans: Promise<Product[]>; } | undefined | - |
product.getSuggestedCurrency | public | Promise<{ country: string | null; currency: SupportedCurrency; locked?: boolean; supported: SupportedCurrency[]; }> | undefined | - |
product.getWorkspaceProducts | public | Promise<Product[]> | undefined | - |
product.listPlans | public | Promise<Product[]> | undefined | - |
project | readonly | ProjectMethods | undefined | - |
public | public | { createPublicAssetChatMessage: Promise<CreatePublicAssetChatMessageResponse>; createPublicChatMessage: Promise<ChatMessage>; createPublicTopicChatMessage: Promise<CreatePublicAssetChatMessageResponse>; downloadAssets: Promise<DownloadSignedUrlData[]>; getPublicAsset: Promise<PublicAssetResponse>; getPublicChat: Promise<Chat | null>; getPublicChatMessages: Promise<PublicChatMessagesResponse>; getPublicDocumentViewUrl: Promise<DocumentViewUrlResponse>; getPublicDownloadUrl: Promise<PublicDownloadUrlResponse>; getPublicEmbedFiles: Promise<PublicEmbedFilesResponse>; getPublicFileSystem: Promise<PublicFileSystemDetailsResponse>; getPublicItems: Promise<PublicFileSystemResponse>; getPublicItemsAtPath: Promise<PublicFileSystemResponse>; recordAccessActivity: Promise<void>; resolvePublicDownload: Promise<ResolvePublicDownloadResponse>; } | undefined | - |
public.createPublicAssetChatMessage | public | Promise<CreatePublicAssetChatMessageResponse> | undefined | - |
public.createPublicChatMessage | public | Promise<ChatMessage> | undefined | - |
public.createPublicTopicChatMessage | public | Promise<CreatePublicAssetChatMessageResponse> | undefined | - |
public.downloadAssets | public | Promise<DownloadSignedUrlData[]> | undefined | - |
public.getPublicAsset | public | Promise<PublicAssetResponse> | undefined | - |
public.getPublicChat | public | Promise<Chat | null> | undefined | - |
public.getPublicChatMessages | public | Promise<PublicChatMessagesResponse> | undefined | - |
public.getPublicDocumentViewUrl | public | Promise<DocumentViewUrlResponse> | undefined | - |
public.getPublicDownloadUrl | public | Promise<PublicDownloadUrlResponse> | undefined | - |
public.getPublicEmbedFiles | public | Promise<PublicEmbedFilesResponse> | undefined | - |
public.getPublicFileSystem | public | Promise<PublicFileSystemDetailsResponse> | undefined | - |
public.getPublicItems | public | Promise<PublicFileSystemResponse> | undefined | - |
public.getPublicItemsAtPath | public | Promise<PublicFileSystemResponse> | undefined | - |
public.recordAccessActivity | public | Promise<void> | undefined | - |
public.resolvePublicDownload | public | Promise<ResolvePublicDownloadResponse> | undefined | - |
refreshLockTimeoutMs | readonly | number | undefined | - |
refreshTokenStorageKey | readonly | string | undefined | - |
scratch | public | { completeUpload: Promise<CompleteUploadResponse>; promote: Promise<PromoteResponse>; } | undefined | - |
scratch.completeUpload | public | Promise<CompleteUploadResponse> | undefined | - |
scratch.promote | public | Promise<PromoteResponse> | undefined | - |
settings | public | { cleanupOrphanedSettings: Promise<{ message: string; removedCount: number; }>; getAllResourceSettings: Promise<{ resourceSettings: ResourceSettings[]; }>; getEffectiveSettings: Promise<EffectiveSettings>; getResourceSettings: Promise< | ResourceSettings | { message: string; }>; resetResourceSettings: Promise<{ message: string; }>; updateResourceSettings: Promise<{ message: string; settings: ResourceSettings; }>; } | undefined | - |
settings.cleanupOrphanedSettings | public | Promise<{ message: string; removedCount: number; }> | undefined | - |
settings.getAllResourceSettings | public | Promise<{ resourceSettings: ResourceSettings[]; }> | undefined | - |
settings.getEffectiveSettings | public | Promise<EffectiveSettings> | undefined | - |
settings.getResourceSettings | public | Promise< | ResourceSettings | { message: string; }> | undefined | - |
settings.resetResourceSettings | public | Promise<{ message: string; }> | undefined | - |
settings.updateResourceSettings | public | Promise<{ message: string; settings: ResourceSettings; }> | undefined | - |
shortlink | public | { resolveShortLink: Promise<ResolveShortLinkResponse>; } | undefined | - |
shortlink.resolveShortLink | public | Promise<ResolveShortLinkResponse> | undefined | - |
socket | public | { connect: (channel, options) => Promise<SocketChannel>; connectPublic: (publicToken, options) => Promise<SocketChannel>; disconnect: (channel) => Promise<void>; disconnectAll: () => Promise<void>; emit: (channel, event, data?) => void; emitWithAck: (channel, event, data, timeoutMs) => Promise<boolean>; isConnected: (channel) => boolean; onReconnect: (channel, callback) => void; onReconnectFailed: (channel, callback) => void; subscribe: <T>(channel, event, callback) => Promise<void>; subscribePublic: <T>(publicToken, event, callback) => Promise<void>; unsubscribe: (channel, event, callback?) => void; } | undefined | - |
socket.connect | public | (channel, options) => Promise<SocketChannel> | undefined | Connect to a socket channel |
socket.connectPublic | public | (publicToken, options) => Promise<SocketChannel> | undefined | Connect to a public socket channel without authentication |
socket.disconnect | public | (channel) => Promise<void> | undefined | Disconnect from a socket channel |
socket.disconnectAll | public | () => Promise<void> | undefined | Disconnect from all channels |
socket.emit | public | (channel, event, data?) => void | undefined | Emit an event to a connected channel |
socket.emitWithAck | public | (channel, event, data, timeoutMs) => Promise<boolean> | undefined | Emit an event with a timeout-bounded server acknowledgement. Resolves true if the server acks within timeoutMs, false on timeout or transport error. Used by the FE WS layer (WebSocketManager.probeChannel) to actively verify a channel's liveness when socket.connected may be stale — most notably after a backgrounded tab returns to focus, where the flag can remain true for up to socket.io's own heartbeat window (~25–45s) even after the underlying TCP transport has died. Relies on socket.io v4's socket.timeout(ms).emit(ev, data, cb) pattern: the BE handler invokes ack() (its trailing callback arg); if no ack arrives within timeoutMs the cb is invoked with an Error. |
socket.isConnected | public | (channel) => boolean | undefined | Check if connected to a channel |
socket.onReconnect | public | (channel, callback) => void | undefined | Register a callback for when the channel reconnects — a socket.io transport-level reconnect, or the token-refresh reconnect. Use it to recover any gap of server->client messages missed while the connection was down; socket.io does not replay those. Dispatched from the 'reconnect' handler in connect() and from the token-refresh path. |
socket.onReconnectFailed | public | (channel, callback) => void | undefined | Register a callback for when Socket.IO exhausts all reconnection attempts |
socket.subscribe | public | <T>(channel, event, callback) => Promise<void> | undefined | Subscribe to an event on a channel |
socket.subscribePublic | public | <T>(publicToken, event, callback) => Promise<void> | undefined | Subscribe to an event on a public channel Automatically connects to the public channel if not already connected |
socket.unsubscribe | public | (channel, event, callback?) => void | undefined | Stop listening for an event on a channel. If callback is provided, only that specific listener is removed; otherwise every listener for that event is cleared. |
storage | public | { getStorageChart: Promise<ChartDataResponse>; getStorageRecord: Promise<StorageRecord>; } | undefined | - |
storage.getStorageChart | public | Promise<ChartDataResponse> | undefined | - |
storage.getStorageRecord | public | Promise<StorageRecord> | undefined | - |
subscription | readonly | SubscriptionMethods | undefined | - |
supportChat | public | { createAttachment: Promise<SupportChatCreateAttachmentResponse>; getTopic: Promise<SupportChatGetTopicResponse>; } | undefined | - |
supportChat.createAttachment | public | Promise<SupportChatCreateAttachmentResponse> | undefined | - |
supportChat.getTopic | public | Promise<SupportChatGetTopicResponse> | undefined | - |
supportTicket | public | { createSupportTicket: Promise<SupportTicket>; getSupportTicket: Promise<SupportTicket>; getSupportTicketScopeOptions: Promise<SupportTicketScopeOptions>; listSupportTickets: Promise<SupportTicketListResponse>; } | undefined | - |
supportTicket.createSupportTicket | public | Promise<SupportTicket> | undefined | - |
supportTicket.getSupportTicket | public | Promise<SupportTicket> | undefined | - |
supportTicket.getSupportTicketScopeOptions | public | Promise<SupportTicketScopeOptions> | undefined | - |
supportTicket.listSupportTickets | public | Promise<SupportTicketListResponse> | undefined | - |
tag | public | { createTag: Promise<Tag>; deleteTag: Promise<Tag>; getTags: Promise<Tags>; updateTag: Promise<Tag>; } | undefined | - |
tag.createTag | public | Promise<Tag> | undefined | - |
tag.deleteTag | public | Promise<Tag> | undefined | - |
tag.getTags | public | Promise<Tags> | undefined | - |
tag.updateTag | public | Promise<Tag> | undefined | - |
task | public | { acknowledgeAllTasks: Promise<AcknowledgeAllTasksResponse>; acknowledgeTask: Promise<Task>; bulkCreate: Promise<BulkCreateTasksResponse>; deleteTask: Promise<void>; followTask: Promise<Task>; getMyTasks: Promise<GetTasksResponse>; getTaskEvents: Promise<GetTaskEventsResponse>; getTaskLinks: Promise<TaskLink[]>; getUnacknowledgedTaskCount: Promise<UnacknowledgedTaskCountResponse>; linkTask: Promise<TaskLink>; tagTask: Promise<Task>; unfollowTask: Promise<Task>; unlinkTask: Promise<void>; untagTask: Promise<Task>; updateTaskDetails: Promise<Task>; updateTaskStatus: Promise<Task>; } | undefined | - |
task.acknowledgeAllTasks | public | Promise<AcknowledgeAllTasksResponse> | undefined | - |
task.acknowledgeTask | public | Promise<Task> | undefined | - |
task.bulkCreate | public | Promise<BulkCreateTasksResponse> | undefined | - |
task.deleteTask | public | Promise<void> | undefined | - |
task.followTask | public | Promise<Task> | undefined | - |
task.getMyTasks | public | Promise<GetTasksResponse> | undefined | - |
task.getTaskEvents | public | Promise<GetTaskEventsResponse> | undefined | - |
task.getTaskLinks | public | Promise<TaskLink[]> | undefined | - |
task.getUnacknowledgedTaskCount | public | Promise<UnacknowledgedTaskCountResponse> | undefined | - |
task.linkTask | public | Promise<TaskLink> | undefined | - |
task.tagTask | public | Promise<Task> | undefined | - |
task.unfollowTask | public | Promise<Task> | undefined | - |
task.unlinkTask | public | Promise<void> | undefined | - |
task.untagTask | public | Promise<Task> | undefined | - |
task.updateTaskDetails | public | Promise<Task> | undefined | - |
task.updateTaskStatus | public | Promise<Task> | undefined | - |
taskRelation | public | { createTaskRelation: Promise<TaskRelation>; deleteTaskRelation: Promise<void>; getRelationsForChat: Promise<PaginatedTaskRelations>; getRelationsForMessage: Promise<PaginatedTaskRelations>; getTaskRelations: Promise<PaginatedTaskRelations>; } | undefined | - |
taskRelation.createTaskRelation | public | Promise<TaskRelation> | undefined | - |
taskRelation.deleteTaskRelation | public | Promise<void> | undefined | - |
taskRelation.getRelationsForChat | public | Promise<PaginatedTaskRelations> | undefined | - |
taskRelation.getRelationsForMessage | public | Promise<PaginatedTaskRelations> | undefined | - |
taskRelation.getTaskRelations | public | Promise<PaginatedTaskRelations> | undefined | - |
token | public | { createToken: Promise<CreateTokenResponse>; deleteToken: Promise<void>; listTokens: Promise<TokenSummary[]>; updateTokenScopes: Promise<TokenSummary>; } | undefined | - |
token.createToken | public | Promise<CreateTokenResponse> | undefined | - |
token.deleteToken | public | Promise<void> | undefined | - |
token.listTokens | public | Promise<TokenSummary[]> | undefined | - |
token.updateTokenScopes | public | Promise<TokenSummary> | undefined | - |
tokenExpiryBufferSeconds | readonly | number | undefined | - |
tokenRefreshMaxWaitMs | readonly | number | undefined | - |
tokenRefreshRetryDelayMs | readonly | number | undefined | - |
tokenStorageKey | readonly | string | undefined | - |
user | readonly | UserMethods | undefined | - |
userFeed | public | { dismissAll: Promise<{ dismissed: number; }>; getFeed: Promise<CursorPaginatedUserFeed>; getReadState: Promise<ReadState>; getSummary: Promise<UserFeedSummary>; markCaughtUp: Promise<ReadState>; setEntryState: Promise<UserFeedEntry>; } | undefined | - |
userFeed.dismissAll | public | Promise<{ dismissed: number; }> | undefined | - |
userFeed.getFeed | public | Promise<CursorPaginatedUserFeed> | undefined | - |
userFeed.getReadState | public | Promise<ReadState> | undefined | - |
userFeed.getSummary | public | Promise<UserFeedSummary> | undefined | - |
userFeed.markCaughtUp | public | Promise<ReadState> | undefined | - |
userFeed.setEntryState | public | Promise<UserFeedEntry> | undefined | - |
version | public | { getCommitHash: Promise<CommitResponse>; getHealth: Promise<HealthStatus>; } | undefined | - |
version.getCommitHash | public | Promise<CommitResponse> | undefined | - |
version.getHealth | public | Promise<HealthStatus> | undefined | - |
webhook | public | { createWebhook: Promise<CreateWebhookResponse>; deleteWebhook: Promise<void>; getWebhook: Promise<WebhookSubscription>; listWebhookDeliveries: Promise<ListDeliveriesResponse>; listWebhooks: Promise<WebhookSubscription[]>; replayWebhookDelivery: Promise<{ attempt: WebhookAttempt; }>; rotateWebhookSecret: Promise<RotateWebhookSecretResponse>; testWebhook: Promise<TestWebhookResponse>; updateWebhook: Promise<WebhookSubscription>; } | undefined | - |
webhook.createWebhook | public | Promise<CreateWebhookResponse> | undefined | - |
webhook.deleteWebhook | public | Promise<void> | undefined | - |
webhook.getWebhook | public | Promise<WebhookSubscription> | undefined | - |
webhook.listWebhookDeliveries | public | Promise<ListDeliveriesResponse> | undefined | - |
webhook.listWebhooks | public | Promise<WebhookSubscription[]> | undefined | - |
webhook.replayWebhookDelivery | public | Promise<{ attempt: WebhookAttempt; }> | undefined | - |
webhook.rotateWebhookSecret | public | Promise<RotateWebhookSecretResponse> | undefined | - |
webhook.testWebhook | public | Promise<TestWebhookResponse> | undefined | - |
webhook.updateWebhook | public | Promise<WebhookSubscription> | undefined | - |
websocketURL? | readonly | string | undefined | - |
workspace | readonly | WorkspaceMethods | undefined | - |
Methods
_log()
_log(...args): void;Internal helper for conditional logging. Underscore-prefixed to flag "internal contract" — accessible from sibling route modules but not part of the documented public API.
Parameters
| Parameter | Type | Description |
|---|---|---|
...args | any[] | Arguments to pass to console.log. |
Returns
void
clearCache()
clearCache(): void;Clears the response cache.
Returns
void
getCacheStats()
getCacheStats(): {
entries: {
hasData: boolean;
hasPendingPromise: boolean;
key: string;
timestamp: number;
}[];
size: number;
};Gets cache statistics for debugging.
Returns
{
entries: {
hasData: boolean;
hasPendingPromise: boolean;
key: string;
timestamp: number;
}[];
size: number;
}Object containing cache statistics.
| Name | Type |
|---|---|
entries | { hasData: boolean; hasPendingPromise: boolean; key: string; timestamp: number; }[] |
size | number |
getSession()
getSession(): NuramaSession | null;Returns the current session (tokens and expiries), or null when signed out.
Returns
NuramaSession | null
getTokenExpiry()
getTokenExpiry(): {
access: string | null;
refresh: string | null;
};Gets the token expiration timestamps.
Returns
{
access: string | null;
refresh: string | null;
}Object containing access and refresh token expiry ISO timestamps.
| Name | Type |
|---|---|
access | string | null |
refresh | string | null |
getUserId()
getUserId(): string | null;Gets the current user's ID from the JWT token.
Returns
string | null
The user ID if available, null otherwise.
getVersion()
getVersion(): SDKVersionInfo;Gets the SDK version information including build timestamp and hash. Useful for debugging and verifying which SDK version is in use.
Returns
SDK version, build timestamp, build hash, and git commit
restoreSession()
restoreSession(session): void;Restores a session previously captured through onTokensChanged /
getSession() — for hosts that persist tokens outside localStorage.
Does not fire onTokensChanged. A missing or expired access token is
refreshed on the next authenticated request.
Parameters
| Parameter | Type |
|---|---|
session | NuramaSession | null |
Returns
void
tokenValid()
tokenValid(): boolean;Checks if the current JWT token exists and is valid.
Returns
boolean
True if the token exists and is valid, false otherwise.
Interfaces
ApiError
Error thrown by _request when the API responds with a non-2xx status.
status is the HTTP status and data the parsed error body
({ type, code, message, errorData? }). Use isApiError to narrow.
Extends
Error
Properties
| Property | Type | Inherited from |
|---|---|---|
data? | any | - |
message | string | Error.message |
name | string | Error.name |
stack? | string | Error.stack |
status? | number | - |
AssetMethods
Extends
ReturnType<typeofdefault>
Methods
cancelPruneOriginal()
cancelPruneOriginal(assetId): Promise<Asset>;Cancels a requested prune before it runs. Needs canPruneAsset.
Parameters
| Parameter | Type | Description |
|---|---|---|
assetId | string | The ID of the asset. |
Returns
Promise<Asset>
The asset, with its original back to stored.
Inherited from
ReturnType.cancelPruneOriginalcancelReattachOriginal()
cancelReattachOriginal(assetId): Promise<Asset>;Cancels a re-attach whose upload has not completed; the original is pruned again.
Parameters
| Parameter | Type | Description |
|---|---|---|
assetId | string | The ID of the asset. |
Returns
Promise<Asset>
The asset.
Inherited from
ReturnType.cancelReattachOriginalcleanupUploadSessions()
cleanupUploadSessions(projectId, olderThanMs?): void;Clean up old upload sessions for a project
Parameters
| Parameter | Type | Description |
|---|---|---|
projectId | string | The project ID |
olderThanMs? | number | Remove sessions older than this (default: 24 hours) |
Returns
void
Inherited from
ReturnType.cleanupUploadSessionscompleteCustomThumbnailUpload()
completeCustomThumbnailUpload(assetId, data): Promise<{
key: string;
status: string;
}>;Finalize the multipart S3 upload for a custom thumbnail. Triggers the post-processing Lambda by committing the S3 object.
Parameters
| Parameter | Type |
|---|---|
assetId | string |
data | { key: string; parts: { ETag: string; PartNumber: number; }[]; uploadId: string; } |
data.key | string |
data.parts | { ETag: string; PartNumber: number; }[] |
data.uploadId | string |
Returns
Promise<{
key: string;
status: string;
}>
Inherited from
ReturnType.completeCustomThumbnailUploadcompleteReattachOriginal()
completeReattachOriginal(assetId, data): Promise<Asset>;Completes a re-attach upload. The file is verified against the
original's SHA-256 in the background: the asset comes back still
restoring, and the outcome arrives as an assetOriginalStateUpdate
(stored when it matched, pruned when it did not).
Parameters
| Parameter | Type | Description |
|---|---|---|
assetId | string | The ID of the asset. |
data | { key: string; parts: { ETag: string; PartNumber: number; }[]; uploadId: string; } | The completed upload. |
data.key | string | - |
data.parts | { ETag: string; PartNumber: number; }[] | - |
data.uploadId | string | - |
Returns
Promise<Asset>
The asset, restoring while the file is verified.
Inherited from
ReturnType.completeReattachOriginalcompleteUpload()
completeUpload(uploadData): Promise<any>;Complete a multipart upload initiated by createAssets.
Matches the route (POST /v1/assets/complete-upload) and mirrors
nuramaClient.scratch.completeUpload, so moving between the asset
and scratch namespaces uses the same verb.
Parameters
| Parameter | Type | Description |
|---|---|---|
uploadData | CompleteMultipartUploadData | Data including key, uploadId, parts, and assetId. |
Returns
Promise<any>
S3 completion response.
Inherited from
ReturnType.completeUploadcompleteUploadSession()
completeUploadSession(projectId, sessionId): void;Mark an upload session as completed
Parameters
| Parameter | Type | Description |
|---|---|---|
projectId | string | The project ID |
sessionId | string | The session ID |
Returns
void
Inherited from
ReturnType.completeUploadSessioncreatePublicLink()
createPublicLink(assetId, data): Promise<PublicAssetLink>;Create a public download link for an asset.
Parameters
| Parameter | Type | Description |
|---|---|---|
assetId | string | The asset ID. |
data | { mode?: PublicAssetLinkMode; projectId: string; validity?: number; } | Link creation data. |
data.mode? | PublicAssetLinkMode | - |
data.projectId | string | The project ID. |
data.validity? | number | Link validity in milliseconds. |
Returns
Promise<PublicAssetLink>
The created public link.
Inherited from
ReturnType.createPublicLinkcreateShortLink()
createShortLink(assetId, data?): Promise<CreateAssetShortLinkResponse>;Creates a short link for an asset. If a short link already exists for the asset with the same visibility, returns the existing one.
Parameters
| Parameter | Type | Description |
|---|---|---|
assetId | string | The ID of the asset to create a short link for. |
data? | CreateAssetShortLinkData | Optional data including visibility context. |
Returns
Promise<CreateAssetShortLinkResponse>
The short link object and short URL.
Inherited from
ReturnType.createShortLinkdeleteAsset()
deleteAsset(assetId): Promise<AssetWithChats>;Deletes an asset (marks for deletion).
Parameters
| Parameter | Type | Description |
|---|---|---|
assetId | string | The ID of the asset to delete. |
Returns
Promise<AssetWithChats>
Inherited from
ReturnType.deleteAssetdisablePublicLink()
disablePublicLink(assetId, linkId): Promise<PublicAssetLink>;Disable a public download link.
Parameters
| Parameter | Type | Description |
|---|---|---|
assetId | string | The asset ID. |
linkId | string | The link ID. |
Returns
Promise<PublicAssetLink>
The disabled public link.
Inherited from
ReturnType.disablePublicLinkdownloadAssets()
downloadAssets(assetIds): Promise<DownloadAssetsResponse>;Generates signed download URLs for the original files of specified assets.
Parameters
| Parameter | Type | Description |
|---|---|---|
assetIds | string[] | An array of asset IDs. |
Returns
Promise<DownloadAssetsResponse>
Array of download URL results.
Inherited from
ReturnType.downloadAssetsgetAsset()
getAsset(assetId, params?): Promise<AssetWithChats>;Retrieves a specific asset by its ID with optional chat data.
Parameters
| Parameter | Type | Description |
|---|---|---|
assetId | string | The ID of the asset. |
params? | GetAssetParams | Optional parameters for chat data inclusion. |
Returns
Promise<AssetWithChats>
The asset object with optional chat data.
Inherited from
ReturnType.getAssetgetAssetAccessActivity()
getAssetAccessActivity(assetId, params?): Promise<{
breakdown: {
count: number;
label: string;
value: string;
}[];
eventType: string | null;
from: string;
groupBy: string;
range: string;
series: {
count: number;
date: string;
eventType: string;
}[];
to: string;
totals: {
count: number;
eventType: string;
}[];
}>;Get aggregated access-activity for a single asset. Returns totals per eventType, a breakdown for the requested dimension, and a zero-filled daily series.
Parameters
| Parameter | Type |
|---|---|
assetId | string |
params? | { eventType?: "play_started" | "play_completed" | "download" | "embed_resolved"; groupBy?: "visibility" | "referrerHost" | "country" | "userAgentClass" | "day"; limit?: number; range?: "7d" | "30d" | "90d"; } |
params.eventType? | "play_started" | "play_completed" | "download" | "embed_resolved" |
params.groupBy? | "visibility" | "referrerHost" | "country" | "userAgentClass" | "day" |
params.limit? | number |
params.range? | "7d" | "30d" | "90d" |
Returns
Promise<{
breakdown: {
count: number;
label: string;
value: string;
}[];
eventType: string | null;
from: string;
groupBy: string;
range: string;
series: {
count: number;
date: string;
eventType: string;
}[];
to: string;
totals: {
count: number;
eventType: string;
}[];
}>
Inherited from
ReturnType.getAssetAccessActivitygetAssetPage()
getAssetPage(assetId, params?): Promise<AssetPageResponse>;Gets the page number an asset appears on based on specified filters and sorting.
Parameters
| Parameter | Type | Description |
|---|---|---|
assetId | string | The ID of the asset to find the page for. |
params? | GetAssetPageParams | Query parameters for sorting, filtering, and pagination limit. |
Returns
Promise<AssetPageResponse>
Object containing the page number.
Inherited from
ReturnType.getAssetPagegetAssetReferences()
getAssetReferences(assetId): Promise<AssetReferences>;Lists every location an asset is referenced — its primary file system and each secondary reference (reviewer, submission, public), grouped and counted.
Renaming an asset retitles it at every one of these locations, and deleting its last primary reference removes them all — so this is what the rename and delete confirmations show the user before either happens.
Parameters
| Parameter | Type | Description |
|---|---|---|
assetId | string | The ID of the asset. |
Returns
Promise<AssetReferences>
The asset's references.
Inherited from
ReturnType.getAssetReferencesgetCustomThumbnailUploadUrl()
getCustomThumbnailUploadUrl(assetId, data): Promise<{
assetId: string;
expires: number;
fileName: string;
key: string;
mimeType: string;
status: string;
uploadId: string;
urls: string[];
}>;Mint a signed multipart upload URL for a user-supplied custom thumbnail image. The upload lands in the originals bucket tagged so the post-processing Lambda generates the customThumbnail outputs and registers them on the asset via the file-update callback.
Caller flow:
- multipartUpload(file, response.urls, response.key, response.uploadId)
- completeCustomThumbnailUpload({ assetId, key, uploadId, parts })
- wait for the assetFileUpdate websocket event
Parameters
| Parameter | Type |
|---|---|
assetId | string |
data | { fileName: string; mimeType: string; sizeInMB: number; } |
data.fileName | string |
data.mimeType | string |
data.sizeInMB | number |
Returns
Promise<{
assetId: string;
expires: number;
fileName: string;
key: string;
mimeType: string;
status: string;
uploadId: string;
urls: string[];
}>
Inherited from
ReturnType.getCustomThumbnailUploadUrlgetDocumentViewUrl()
getDocumentViewUrl(assetId): Promise<DocumentViewUrlResponse>;Mints a short-lived signed URL for rendering a document inline.
Documents keep their media PDF in the private bucket, so unlike images
and video it cannot be addressed by keyPath through the file CDN. Fetch
this per document open; do not cache it past expires.
Parameters
| Parameter | Type | Description |
|---|---|---|
assetId | string | The document asset's ID. |
Returns
Promise<DocumentViewUrlResponse>
Signed URL, expiry and page count.
Inherited from
ReturnType.getDocumentViewUrlgetFile()
getFile(assetId, fileId): Promise<File>;Retrieves a specific file from an asset.
Parameters
| Parameter | Type | Description |
|---|---|---|
assetId | string | The ID of the asset. |
fileId | string | The ID of the file. |
Returns
Promise<File>
The file object.
Inherited from
ReturnType.getFilegetFilesByFunctionType()
getFilesByFunctionType(assetId, functionType): Promise<File[]>;Retrieves files of a specific function type from an asset.
Parameters
| Parameter | Type | Description |
|---|---|---|
assetId | string | The ID of the asset. |
functionType | string | The function type of the files (e.g., 'thumbnail', 'original'). |
Returns
Promise<File[]>
An array of file objects.
Inherited from
ReturnType.getFilesByFunctionTypegetOriginal()
getOriginal(assetId): Promise<AssetOriginalStatus>;Where an asset's original is, what the project's pruning policy will do
with it, and whether it can be pruned by hand now. Needs canGetAssetOriginal.
Parameters
| Parameter | Type | Description |
|---|---|---|
assetId | string | The ID of the asset. |
Returns
Promise<AssetOriginalStatus>
The original's state.
Inherited from
ReturnType.getOriginalgetOriginalHistory()
getOriginalHistory(assetId): Promise<{
results: AssetOriginalHistoryEntry[];
}>;The history of an asset's original, newest first. Needs canGetAssetOriginal.
Parameters
| Parameter | Type | Description |
|---|---|---|
assetId | string | The ID of the asset. |
Returns
Promise<{
results: AssetOriginalHistoryEntry[];
}>
The history.
Inherited from
ReturnType.getOriginalHistorygetPublicLinks()
getPublicLinks(assetId, options?): Promise<{
results: PublicAssetLink[];
}>;Get all public download links for an asset.
Parameters
| Parameter | Type | Description |
|---|---|---|
assetId | string | The asset ID. |
options? | { bypassCache?: boolean; } | - |
options.bypassCache? | boolean | - |
Returns
Promise<{
results: PublicAssetLink[];
}>
The public links.
Inherited from
ReturnType.getPublicLinksgetUploadSession()
getUploadSession(projectId, sessionId): UploadSessionData | null;Get a specific upload session
Parameters
| Parameter | Type | Description |
|---|---|---|
projectId | string | The project ID |
sessionId | string | The session ID |
Returns
UploadSessionData | null
Upload session data or null if not found
Inherited from
ReturnType.getUploadSessiongetUploadSessions()
getUploadSessions(projectId): UploadSessionData[];Get all active upload sessions for a project
Parameters
| Parameter | Type | Description |
|---|---|---|
projectId | string | The project ID to get sessions for |
Returns
UploadSessionData[]
Array of upload session data
Inherited from
ReturnType.getUploadSessionshasActiveUploads()
hasActiveUploads(staleMs?): boolean;True when any upload is genuinely in flight anywhere in the app (across all projects and tabs). Intended for app-level guards — e.g. suppressing an automatic version-update page refresh while bytes are still uploading. Stale (crashed-tab) sessions are ignored via the freshness window.
Parameters
| Parameter | Type | Description |
|---|---|---|
staleMs? | number | Max age of the last progress update that still counts as active (default: 2 minutes) |
Returns
boolean
Inherited from
ReturnType.hasActiveUploadsmultipartUpload()
multipartUpload(
file,
signedUrls,
key,
uploadId,
options?
): Promise<MultipartUploadResult>;Uploads a file using multipart upload with the provided signed URLs
Parameters
| Parameter | Type | Description |
|---|---|---|
file | string | File | Blob | Buffer<ArrayBufferLike> | The file to upload (File/Blob in browser, Buffer/string path in Node.js) |
signedUrls | string[] | Array of signed URLs for each part |
key | string | The S3 key for the upload |
uploadId | string | The S3 uploadId for the multipart upload |
options | MultipartUploadOptions | Upload options |
Returns
Promise<MultipartUploadResult>
The completed upload data
Inherited from
ReturnType.multipartUploadoffUploadSessionMessage()
offUploadSessionMessage(listenerId): void;Unregister a cross-tab upload session message listener
Parameters
| Parameter | Type | Description |
|---|---|---|
listenerId | string | Unique listener ID |
Returns
void
Inherited from
ReturnType.offUploadSessionMessageonUploadSessionMessage()
onUploadSessionMessage(listenerId, callback): void;Register a listener for cross-tab upload session messages
Parameters
| Parameter | Type | Description |
|---|---|---|
listenerId | string | Unique listener ID |
callback | (message) => void | Callback function to handle messages |
Returns
void
Inherited from
ReturnType.onUploadSessionMessagepromoteAttachmentToProject()
promoteAttachmentToProject(assetId, payload): Promise<{
asset: Asset;
deduped: boolean;
}>;Promote a chat-message attachment into a project as a fresh, independent project asset. The source attachment is left untouched; the new project asset has its own lifecycle, post-processing pipeline, and storage footprint.
Idempotent: a second promote of the same source into the same
project returns the existing promoted asset with deduped: true.
Requires canCreateAsset on the destination project — reviewers
are blocked. The server additionally rejects when the source
attachment's workspace doesn't match the destination project's.
Parameters
| Parameter | Type |
|---|---|
assetId | string |
payload | { fileName?: string; projectId: string; } |
payload.fileName? | string |
payload.projectId | string |
Returns
Promise<{
asset: Asset;
deduped: boolean;
}>
Inherited from
ReturnType.promoteAttachmentToProjectpruneOriginal()
pruneOriginal(assetId): Promise<Asset>;Requests that an asset's original be pruned once the undo window has
passed (pruneAfter). Needs canPruneAsset.
Parameters
| Parameter | Type | Description |
|---|---|---|
assetId | string | The ID of the asset. |
Returns
Promise<Asset>
The asset, now waiting to be pruned.
Inherited from
ReturnType.pruneOriginalreactivatePublicLink()
reactivatePublicLink(
assetId,
linkId,
data?
): Promise<PublicAssetLink>;Reactivate a disabled/expired public download link.
Parameters
| Parameter | Type | Description |
|---|---|---|
assetId | string | The asset ID. |
linkId | string | The link ID. |
data? | { validity?: number; } | Reactivation data. |
data.validity? | number | New validity in milliseconds. |
Returns
Promise<PublicAssetLink>
The reactivated public link.
Inherited from
ReturnType.reactivatePublicLinkreattachOriginal()
reattachOriginal(
assetId,
file,
options
): Promise<Asset>;Re-attaches a pruned original from a file: starts the re-attach, uploads
the file and completes it. Aborting (abortSignal) or a failed upload
cancels the re-attach. Resolves once the upload is committed; the
verification outcome arrives as an assetOriginalStateUpdate.
Parameters
| Parameter | Type | Description |
|---|---|---|
assetId | string | The ID of the asset. |
file | string | File | Blob | Buffer<ArrayBufferLike> | The file. |
options | { abortSignal?: AbortSignal; checksum?: string; fileName: string; onProgress?: (progress) => void; sizeInBytes: number; } | - |
options.abortSignal? | AbortSignal | - |
options.checksum? | string | Its upload fingerprint, to refuse a wrong file before sending it. |
options.fileName | string | The file's name. |
options.onProgress? | (progress) => void | - |
options.sizeInBytes | number | Its size. |
Returns
Promise<Asset>
The asset, restoring while the file is verified.
Inherited from
ReturnType.reattachOriginalrecordAccessActivity()
recordAccessActivity(assetId, body): Promise<void>;Record an authenticated play event from the in-app player. Fire-and-forget; server returns 204. Throw-on-failure is fine because the caller already de-dupes per session.
Parameters
| Parameter | Type |
|---|---|
assetId | string |
body | { eventType: "play_started" | "play_completed"; visibility: "creator" | "reviewer"; } |
body.eventType | "play_started" | "play_completed" |
body.visibility | "creator" | "reviewer" |
Returns
Promise<void>
Inherited from
ReturnType.recordAccessActivityremoveCustomThumbnail()
removeCustomThumbnail(assetId): Promise<Asset>;Remove the custom thumbnail from an asset. Soft-deletes all custom thumb files; the asset falls back to the auto-generated thumbnail.
Parameters
| Parameter | Type |
|---|---|
assetId | string |
Returns
Promise<Asset>
Inherited from
ReturnType.removeCustomThumbnailremoveUploadSession()
removeUploadSession(projectId, sessionId): void;Remove an upload session
Parameters
| Parameter | Type | Description |
|---|---|---|
projectId | string | The project ID |
sessionId | string | The session ID |
Returns
void
Inherited from
ReturnType.removeUploadSessionrepairAssets()
repairAssets(assetIds): Promise<RepairAssetsResponse>;Attempts to repair assets (e.g., regenerate signed URLs for pending uploads).
Parameters
| Parameter | Type | Description |
|---|---|---|
assetIds | string[] | An array of asset IDs to repair. |
Returns
Promise<RepairAssetsResponse>
Array of repair results.
Inherited from
ReturnType.repairAssetssetKeepOriginal()
setKeepOriginal(assetId, keepOriginal): Promise<Asset>;Exempts an asset from pruning, or lifts the exemption. Needs canPruneAsset.
Parameters
| Parameter | Type | Description |
|---|---|---|
assetId | string | The ID of the asset. |
keepOriginal | boolean | True to exempt the asset. |
Returns
Promise<Asset>
The asset.
Inherited from
ReturnType.setKeepOriginalstartReattachOriginal()
startReattachOriginal(assetId, data): Promise<AssetOriginalReattachStart>;Starts re-attaching a pruned original. The size and the upload
fingerprint (checksum) are checked against the original's first, so a
wrong file is refused before it is sent (assetOriginalMismatch, 422).
Needs canReattachAssetOriginal, or canReattachOwnAssetOriginal on an
asset you created. Upload the parts with multipartUpload, then call
completeReattachOriginal — or use reattachOriginal, which does all three.
Parameters
| Parameter | Type | Description |
|---|---|---|
assetId | string | The ID of the asset. |
data | { checksum?: string; fileName: string; sizeInBytes: number; } | The file. |
data.checksum? | string | - |
data.fileName | string | - |
data.sizeInBytes | number | - |
Returns
Promise<AssetOriginalReattachStart>
The asset, now restoring, and the upload's links.
Inherited from
ReturnType.startReattachOriginaltagAsset()
tagAsset(assetId, tagData): Promise<AssetWithChats>;Tags an asset with a specific tag.
Parameters
| Parameter | Type | Description |
|---|---|---|
assetId | string | The ID of the asset to tag. |
tagData | TagAssetData | Data containing the tag ID. |
Returns
Promise<AssetWithChats>
The updated asset object.
Inherited from
ReturnType.tagAssetuntagAsset()
untagAsset(assetId, untagData): Promise<AssetWithChats>;Untags an asset by removing a specific tag.
Parameters
| Parameter | Type | Description |
|---|---|---|
assetId | string | The ID of the asset to untag. |
untagData | UntagAssetData | Data containing the tag ID to remove. |
Returns
Promise<AssetWithChats>
The updated asset object.
Inherited from
ReturnType.untagAssetupdateAsset()
updateAsset(assetId, updateData): Promise<AssetWithChats>;Updates an asset.
Parameters
| Parameter | Type | Description |
|---|---|---|
assetId | string | The ID of the asset to update. |
updateData | UpdateAssetData | Data to update (e.g., name, meta, tags, folderId). |
Returns
Promise<AssetWithChats>
The updated asset object.
Inherited from
ReturnType.updateAssetupdatePublicLink()
updatePublicLink(
assetId,
linkId,
data
): Promise<PublicAssetLink>;Update a public download link (extend expiration or change status).
Parameters
| Parameter | Type | Description |
|---|---|---|
assetId | string | The asset ID. |
linkId | string | The link ID. |
data | { mode?: PublicAssetLinkMode; status?: string; validity?: number; } | Update data. |
data.mode? | PublicAssetLinkMode | - |
data.status? | string | - |
data.validity? | number | - |
Returns
Promise<PublicAssetLink>
The updated public link.
Inherited from
ReturnType.updatePublicLinkAuthMethods
Extends
ReturnType<typeofdefault>
Methods
changePassword()
changePassword(
currentPassword,
newPassword,
mfaToken?
): Promise<void>;Changes the authenticated user's password. Requires current password verification and MFA token if MFA is enabled. All refresh tokens will be invalidated after password change.
Parameters
| Parameter | Type | Description |
|---|---|---|
currentPassword | string | The current password for verification. |
newPassword | string | The new password. |
mfaToken? | string | MFA token (required if MFA is enabled). |
Returns
Promise<void>
Promise resolving when complete.
Inherited from
ReturnType.changePassworddeletePasskey()
deletePasskey(passkeyId): Promise<void>;Removes one of the authenticated user's passkeys.
Parameters
| Parameter | Type | Description |
|---|---|---|
passkeyId | string | The passkey's id. |
Returns
Promise<void>
Promise resolving when complete.
Inherited from
ReturnType.deletePasskeydisableMfa()
disableMfa(mfaToken): Promise<void>;Disables multi-factor authentication for the authenticated user. Requires a current valid MFA token for confirmation.
Parameters
| Parameter | Type | Description |
|---|---|---|
mfaToken | string | The current MFA token code. |
Returns
Promise<void>
Promise resolving when complete.
Inherited from
ReturnType.disableMfaenableMfa()
enableMfa(): Promise<MFAEnableResponse>;Enables multi-factor authentication for the authenticated user.
Returns
Promise<MFAEnableResponse>
Promise resolving to MFA setup details (secret, OTP URL, backup codes).
Inherited from
ReturnType.enableMfaexchangeOAuthCode()
exchangeOAuthCode(code, __namedParameters?): Promise<OAuthExchangeResponse>;Exchanges a one-time sign-in code for tokens and stores them.
Parameters
| Parameter | Type | Description |
|---|---|---|
code | string | The code from the sign-in redirect. |
__namedParameters | { codeVerifier?: string; } | - |
__namedParameters.codeVerifier? | string | - |
Returns
Promise<OAuthExchangeResponse>
Promise resolving to the user and tokens, or a two-factor challenge.
Inherited from
ReturnType.exchangeOAuthCodeforgotPassword()
forgotPassword(email): Promise<void>;Forgets a user's password.
Parameters
| Parameter | Type | Description |
|---|---|---|
email | string | The user's email address. |
Returns
Promise<void>
Inherited from
ReturnType.forgotPasswordgetLinkedOAuthProviders()
getLinkedOAuthProviders(): Promise<LinkedAuthProvider[]>;Gets all OAuth providers linked to the authenticated user's account.
Returns
Promise<LinkedAuthProvider[]>
Promise resolving to array of linked OAuth providers.
Inherited from
ReturnType.getLinkedOAuthProvidersgetPasskeyLoginOptions()
getPasskeyLoginOptions(origin?): Promise<PasskeyCredentialOptions>;Gets the options for the browser's passkey sign-in prompt. Pass them to the WebAuthn library
(startAuthentication in @simplewebauthn/browser), then send its result to loginWithPasskey.
Parameters
| Parameter | Type | Description |
|---|---|---|
origin? | string | The web origin to sign in for, from a native app (which has no browser Origin); pass the same one to loginWithPasskey. Browsers send their own and ignore this. |
Returns
Promise<PasskeyCredentialOptions>
Promise resolving to WebAuthn request options.
Inherited from
ReturnType.getPasskeyLoginOptionsgetPasskeyRegistrationOptions()
getPasskeyRegistrationOptions(proof?): Promise<PasskeyCredentialOptions>;Gets the options for the browser's "create a passkey" prompt, after confirming who is asking.
Parameters
| Parameter | Type | Description |
|---|---|---|
proof | PasskeyRegistrationProof | The password when the account has one, and a two-factor code when two-factor is on. |
Returns
Promise<PasskeyCredentialOptions>
Promise resolving to WebAuthn creation options.
Inherited from
ReturnType.getPasskeyRegistrationOptionslinkOAuthProvider()
linkOAuthProvider(provider): Promise<LoginRegisterResponse>;Links an OAuth provider to the authenticated user's account. This allows users to sign in with multiple OAuth providers.
Parameters
| Parameter | Type | Description |
|---|---|---|
provider | OAuthProvider | The OAuth provider to link (google, apple, microsoft, adobe). |
Returns
Promise<LoginRegisterResponse>
Promise resolving to user data with updated linked providers.
Inherited from
ReturnType.linkOAuthProviderlistPasskeys()
listPasskeys(): Promise<Passkey[]>;Lists the authenticated user's passkeys, oldest first.
Returns
Promise<Passkey[]>
Promise resolving to the user's passkeys.
Inherited from
ReturnType.listPasskeyslockAccount()
lockAccount(token): Promise<void>;Locks a user account using a lock account token. This is used when a user receives a password changed notification for a change they did not initiate, allowing them to immediately secure their account.
Parameters
| Parameter | Type | Description |
|---|---|---|
token | string | The lock account token from the password changed email. |
Returns
Promise<void>
Promise resolving when the account is locked.
Inherited from
ReturnType.lockAccountlogin()
login(credentials): Promise<LoginRegisterResponse>;Logs in a user.
Parameters
| Parameter | Type | Description |
|---|---|---|
credentials | LoginCredentials | Login credentials. |
Returns
Promise<LoginRegisterResponse>
Object containing user info and tokens (or MFA challenge token).
Inherited from
ReturnType.loginloginDesktopWithPasskey()
loginDesktopWithPasskey(credential, handoff): Promise<PasskeyDesktopLoginResponse>;Signs the desktop app in with a passkey, from the browser. Stores nothing: the tokens wait behind the
returned one-time code, which the desktop app redeems with exchangeOAuthCode(code, { codeVerifier }).
Parameters
| Parameter | Type | Description |
|---|---|---|
credential | PasskeyCredentialResponse | The WebAuthn library's AuthenticationResponseJSON. |
handoff | Omit<PasskeyDesktopLoginRequest, "credential"> | The state and PKCE codeChallenge the desktop app made. |
Returns
Promise<PasskeyDesktopLoginResponse>
Promise resolving to the one-time code.
Inherited from
ReturnType.loginDesktopWithPasskeyloginWithPasskey()
loginWithPasskey(credential, origin?): Promise<LoginRegisterResponse>;Signs in with the browser's response to the passkey prompt and stores the tokens. A passkey stands in for two-factor, so this never returns an MFA challenge.
Parameters
| Parameter | Type | Description |
|---|---|---|
credential | PasskeyCredentialResponse | The WebAuthn library's AuthenticationResponseJSON. |
origin? | string | From a native app: the origin passed to getPasskeyLoginOptions. |
Returns
Promise<LoginRegisterResponse>
Promise resolving to the user and tokens.
Inherited from
ReturnType.loginWithPasskeylogout()
logout(refreshToken): Promise<void>;Logs out a user.
Parameters
| Parameter | Type | Description |
|---|---|---|
refreshToken | string | The refresh token to invalidate. |
Returns
Promise<void>
Inherited from
ReturnType.logoutrefreshTokens()
refreshTokens(refreshToken?): Promise<RefreshResponse>;Refreshes user tokens.
Parameters
| Parameter | Type | Description |
|---|---|---|
refreshToken? | string | The refresh token. |
Returns
Promise<RefreshResponse>
Object containing new access and refresh tokens.
Inherited from
ReturnType.refreshTokensregister()
register(userData): Promise<LoginRegisterResponse>;Registers a new user.
Parameters
| Parameter | Type | Description |
|---|---|---|
userData | RegisterUserData | User registration data. |
Returns
Promise<LoginRegisterResponse>
Object containing user info and tokens.
Inherited from
ReturnType.registerregisterGuest()
registerGuest(data): Promise<void>;Registers a guest account for public chat participation. Always returns void (204) regardless of outcome for anti-enumeration.
Parameters
| Parameter | Type | Description |
|---|---|---|
data | { color?: string; displayName: string; email: string; publicToken: string; } | Guest registration data (email, displayName, optional approved color, publicToken). |
data.color? | string | - |
data.displayName | string | - |
data.email | string | - |
data.publicToken | string | - |
Returns
Promise<void>
Inherited from
ReturnType.registerGuestregisterPasskey()
registerPasskey(credential, name?): Promise<Passkey>;Saves the passkey the browser created.
Parameters
| Parameter | Type | Description |
|---|---|---|
credential | PasskeyCredentialResponse | The WebAuthn library's RegistrationResponseJSON. |
name? | string | Optional name to tell it apart, e.g. "MacBook". |
Returns
Promise<Passkey>
Promise resolving to the saved passkey.
Inherited from
ReturnType.registerPasskeyrenamePasskey()
renamePasskey(passkeyId, name): Promise<Passkey>;Renames one of the authenticated user's passkeys.
Parameters
| Parameter | Type | Description |
|---|---|---|
passkeyId | string | The passkey's id. |
name | string | The new name. |
Returns
Promise<Passkey>
Promise resolving to the renamed passkey.
Inherited from
ReturnType.renamePasskeyresendVerification()
resendVerification(email): Promise<void>;Public, unauthenticated resend of the verification email keyed by address. For users past the verification grace window who can't log in or call the authed sendVerificationEmail. Always resolves (the server returns 204 regardless of whether the email exists).
Parameters
| Parameter | Type | Description |
|---|---|---|
email | string | The email address to resend the verification link to. |
Returns
Promise<void>
Inherited from
ReturnType.resendVerificationresetPassword()
resetPassword(params): Promise<void>;Resets a user's password.
Parameters
| Parameter | Type | Description |
|---|---|---|
params | ResetPasswordData | Input parameters. |
Returns
Promise<void>
Promise resolving when complete.
Inherited from
ReturnType.resetPasswordsendVerificationEmail()
sendVerificationEmail(): Promise<void>;Sends a verification email to the authenticated user.
Returns
Promise<void>
Promise resolving when complete.
Inherited from
ReturnType.sendVerificationEmailsetPassword()
setPassword(password, mfaToken?): Promise<void>;Sets a password for an OAuth-only user account. This allows OAuth users to add local authentication as a backup.
Parameters
| Parameter | Type | Description |
|---|---|---|
password | string | The password to set. |
mfaToken? | string | MFA token (required if MFA is enabled). |
Returns
Promise<void>
Promise resolving when complete.
Inherited from
ReturnType.setPasswordunlinkOAuthProvider()
unlinkOAuthProvider(provider): Promise<void>;Unlinks an OAuth provider from the authenticated user's account. User must have at least one authentication method remaining (password or another OAuth provider).
Parameters
| Parameter | Type | Description |
|---|---|---|
provider | OAuthProvider | The OAuth provider to unlink (google, apple, microsoft, adobe). |
Returns
Promise<void>
Promise resolving when complete.
Inherited from
ReturnType.unlinkOAuthProviderupgradeGuest()
upgradeGuest(data): Promise<{
user: User;
}>;Upgrades a guest account to a standard account with a password. Requires the user to be authenticated as a guest.
Parameters
| Parameter | Type | Description |
|---|---|---|
data | { company?: string; firstName?: string; lastName?: string; password: string; userName?: string; } | Upgrade data (password, optional firstName, lastName, company, userName). |
data.company? | string | - |
data.firstName? | string | - |
data.lastName? | string | - |
data.password | string | - |
data.userName? | string | - |
Returns
Promise<{
user: User;
}>
Promise resolving to the upgraded user data.
Inherited from
ReturnType.upgradeGuestverifyBackupCode()
verifyBackupCode(backupCode): Promise<MFAVerifyResponse>;Verifies an MFA backup code. This is used during login when a user has lost access to their authenticator app.
Parameters
| Parameter | Type | Description |
|---|---|---|
backupCode | string | The backup code (8-character hex string). |
Returns
Promise<MFAVerifyResponse>
Promise resolving to user/token data upon successful verification.
Inherited from
ReturnType.verifyBackupCodeverifyEmail()
verifyEmail(token): Promise<void>;Verifies a user's email using the provided token.
Parameters
| Parameter | Type | Description |
|---|---|---|
token | string | The email verification token. |
Returns
Promise<void>
Promise resolving when complete.
Inherited from
ReturnType.verifyEmailverifyGuest()
verifyGuest(token): Promise<LoginRegisterResponse>;Verifies a guest account using the token from the verification email. Stores auth tokens on success and returns user data.
Parameters
| Parameter | Type | Description |
|---|---|---|
token | string | The guest verification token. |
Returns
Promise<LoginRegisterResponse>
Promise resolving to user data and auth tokens.
Inherited from
ReturnType.verifyGuestverifyMfa()
verifyMfa(mfaToken): Promise<MFAVerifyResponse>;Verifies an MFA token (e.g., TOTP code). This is used both during initial MFA setup and during login challenges.
Parameters
| Parameter | Type | Description |
|---|---|---|
mfaToken | string | The MFA token code. |
Returns
Promise<MFAVerifyResponse>
Promise resolving to user/token data upon successful verification.
Inherited from
ReturnType.verifyMfaNuramaClientOptions
Properties
NuramaSession
A persisted session: the token pair plus their ISO expiry timestamps.
Properties
| Property | Type |
|---|---|
accessToken | string | null |
accessTokenExpiry | string | null |
refreshToken | string | null |
refreshTokenExpiry | string | null |
ProjectMethods
Extends
ReturnType<typeofdefault>
Methods
addItemsToPublicFileSystem()
addItemsToPublicFileSystem(
projectId,
publicId,
addItemsData
): Promise<PublicFileSystemResponse>;Adds additional items to an existing public file system.
Parameters
| Parameter | Type | Description |
|---|---|---|
projectId | string | The ID of the project. |
publicId | string | The ID of the public file system. |
addItemsData | AddItemsToPublicFileSystemData | Data for adding items. |
Returns
Promise<PublicFileSystemResponse>
The updated public file system object.
Inherited from
ReturnType.addItemsToPublicFileSystemaddItemsToSubmission()
addItemsToSubmission(
projectId,
submissionId,
addItemsData
): Promise<ChatSubmission>;Adds items to an existing submission.
Parameters
| Parameter | Type | Description |
|---|---|---|
projectId | string | The ID of the project. |
submissionId | string | The ID of the submission. |
addItemsData | AddItemsToSubmissionData | Data for adding items to the submission. |
Returns
Promise<ChatSubmission>
The updated submission object.
Inherited from
ReturnType.addItemsToSubmissioncancelPruneOriginals()
cancelPruneOriginals(projectId, selection): Promise<AssetPruneCancelResult>;Cancels every waiting prune in the selection. Needs canPruneAsset on the project.
Parameters
| Parameter | Type | Description |
|---|---|---|
projectId | string | The project ID. |
selection | AssetPruneSelection | Asset ids, creator-tree paths, or both. |
Returns
Promise<AssetPruneCancelResult>
The cancelled assets, and those with nothing waiting.
Inherited from
ReturnType.cancelPruneOriginalscopyItemsToPath()
copyItemsToPath(
projectId,
visibility,
copyData
): Promise<{
count: number;
}>;Copies items to a specific path within a project.
Parameters
| Parameter | Type | Description |
|---|---|---|
projectId | string | The ID of the project. |
visibility | "creator" | "reviewer" | The visibility context ('creator' or 'reviewer'). |
copyData | CopyItemsData | Data for copying items. |
Returns
Promise<{
count: number;
}>
Object containing the count of copied items.
Inherited from
ReturnType.copyItemsToPathcopyPublicItemsAtPath()
copyPublicItemsAtPath(
projectId,
token,
copyData
): Promise<{
count: number;
}>;Copies items within a public file system (authenticated management).
Parameters
| Parameter | Type | Description |
|---|---|---|
projectId | string | The ID of the project. |
token | string | The public access token. |
copyData | CopyPublicItemsData | Data for copying items. |
Returns
Promise<{
count: number;
}>
Object containing the count of copied items.
Inherited from
ReturnType.copyPublicItemsAtPathcopySubmissionItems()
copySubmissionItems(
projectId,
submissionId,
copyData
): Promise<{
count: number;
}>;Copies items within a submission.
Parameters
| Parameter | Type | Description |
|---|---|---|
projectId | string | The ID of the project. |
submissionId | string | The ID of the submission. |
copyData | CopySubmissionItemsData | Data for copying items. |
Returns
Promise<{
count: number;
}>
Object containing the count of copied items.
Inherited from
ReturnType.copySubmissionItemscreateAssets()
createAssets(projectId, fileUploadBody): Promise<any[]>;Create assets within a project and return their signed links for upload.
Parameters
| Parameter | Type | Description |
|---|---|---|
projectId | string | The ID of the project. |
fileUploadBody | ProjectFileUploadBody | List of files to upload with optional destination path. |
Returns
Promise<any[]>
Array of results, each containing asset info and signed URL data.
Inherited from
ReturnType.createAssetscreateFolder()
createFolder(
projectId,
visibility,
folderData
): Promise<Folder>;Creates a folder within a project with file system integration.
Parameters
| Parameter | Type | Description |
|---|---|---|
projectId | string | The ID of the project. |
visibility | "creator" | "reviewer" | The visibility context ('creator' or 'reviewer'). |
folderData | CreateFolderData | Data for creating the folder. |
Returns
Promise<Folder>
The created folder object.
Inherited from
ReturnType.createFoldercreateLogo()
createLogo(projectId, logoData): Promise<any>;Creates a new logo asset for a project.
Parameters
| Parameter | Type | Description |
|---|---|---|
projectId | string | The ID of the project. |
logoData | LogoUploadData | File metadata for the logo. |
Returns
Promise<any>
Object containing signed URL data and updated project info.
Inherited from
ReturnType.createLogocreateProject()
createProject(projectData): Promise<Project>;Creates a new project.
Parameters
| Parameter | Type | Description |
|---|---|---|
projectData | CreateProjectData | Data for the new project. |
Returns
Promise<Project>
The created project object.
Inherited from
ReturnType.createProjectcreateProjectPublicAssetChatMessage()
createProjectPublicAssetChatMessage(
projectId,
token,
assetId,
data
): Promise<CreatePublicAssetChatMessageResponse>;Creates a message on an asset's public chat from an authenticated project context. Creates the chat lazily if it doesn't exist yet. Unlike the public endpoint, this does NOT check token expiration.
Parameters
| Parameter | Type | Description |
|---|---|---|
projectId | string | The ID of the project. |
token | string | The public access token. |
assetId | string | The ID of the asset. |
data | CreatePublicChatMessageRequest | Message data. |
Returns
Promise<CreatePublicAssetChatMessageResponse>
The chat and created message.
Inherited from
ReturnType.createProjectPublicAssetChatMessagecreateProjectPublicChatMessage()
createProjectPublicChatMessage(
projectId,
token,
chatId,
data
): Promise<ChatMessage>;Creates a message in an existing public chat from an authenticated project context. Unlike the public endpoint, this does NOT check token expiration.
Parameters
| Parameter | Type | Description |
|---|---|---|
projectId | string | The ID of the project. |
token | string | The public access token. |
chatId | string | The ID of the chat. |
data | CreatePublicChatMessageRequest | Message data. |
Returns
Promise<ChatMessage>
The created message.
Inherited from
ReturnType.createProjectPublicChatMessagecreateProjectPublicTopicChatMessage()
createProjectPublicTopicChatMessage(
projectId,
token,
data
): Promise<CreatePublicAssetChatMessageResponse>;Creates a message on the main public topic chat from an authenticated project context. Creates the chat lazily if it doesn't exist yet. Unlike the public endpoint, this does NOT check token expiration.
Parameters
| Parameter | Type | Description |
|---|---|---|
projectId | string | The ID of the project. |
token | string | The public access token. |
data | CreatePublicChatMessageRequest | Message data. |
Returns
Promise<CreatePublicAssetChatMessageResponse>
The chat and created message.
Inherited from
ReturnType.createProjectPublicTopicChatMessagecreatePublicFileSystem()
createPublicFileSystem(projectId, publicFileSystemData): Promise<PublicFileSystemResponse>;Creates a public file system with a secure token for sharing project assets publicly.
Parameters
| Parameter | Type | Description |
|---|---|---|
projectId | string | The ID of the project. |
publicFileSystemData | CreatePublicFileSystemData | Data for creating the public file system. |
Returns
Promise<PublicFileSystemResponse>
The created public file system object.
Inherited from
ReturnType.createPublicFileSystemcreatePublicFolder()
createPublicFolder(
projectId,
token,
folderData
): Promise<Folder>;Creates a folder inside a public file system (authenticated management).
Parameters
| Parameter | Type | Description |
|---|---|---|
projectId | string | The ID of the project. |
token | string | The public access token. |
folderData | CreateFolderData | Data for creating the folder (name, color, basePath). |
Returns
Promise<Folder>
The created folder object.
Inherited from
ReturnType.createPublicFoldercreateSubmission()
createSubmission(projectId, submissionData): Promise<ChatSubmission>;Creates a new submission for a project.
Parameters
| Parameter | Type | Description |
|---|---|---|
projectId | string | The ID of the project. |
submissionData | CreateSubmissionData | Data for the submission. |
Returns
Promise<ChatSubmission>
The created submission object.
Inherited from
ReturnType.createSubmissioncreateSubmissionFolder()
createSubmissionFolder(
projectId,
submissionId,
folderData
): Promise<Folder>;Creates a folder within a submission.
Parameters
| Parameter | Type | Description |
|---|---|---|
projectId | string | The ID of the project. |
submissionId | string | The ID of the submission. |
folderData | CreateSubmissionFolderData | Data for creating the folder. |
Returns
Promise<Folder>
The created folder object.
Inherited from
ReturnType.createSubmissionFolderdeleteItemsAtPath()
deleteItemsAtPath(
projectId,
visibility,
deleteData
): Promise<{
count: number;
}>;Deletes items at a specific path within a project.
Parameters
| Parameter | Type | Description |
|---|---|---|
projectId | string | The ID of the project. |
visibility | "creator" | "reviewer" | The visibility context ('creator' or 'reviewer'). |
deleteData | DeleteItemsData | Data for deleting items. |
Returns
Promise<{
count: number;
}>
Object containing the count of deleted items.
Inherited from
ReturnType.deleteItemsAtPathdeleteProject()
deleteProject(projectId): Promise<void>;Deletes a project (marks for deletion).
Parameters
| Parameter | Type | Description |
|---|---|---|
projectId | string | The ID of the project to delete. |
Returns
Promise<void>
The deleted public release record.
Inherited from
ReturnType.deleteProjectdeletePublicFileSystem()
deletePublicFileSystem(projectId, publicId): Promise<PublicFileSystemResponse>;Deletes a public file system and invalidates its access token.
Parameters
| Parameter | Type | Description |
|---|---|---|
projectId | string | The ID of the project. |
publicId | string | The ID of the public file system. |
Returns
Promise<PublicFileSystemResponse>
The deleted public release record.
Inherited from
ReturnType.deletePublicFileSystemdeletePublicItemsAtPath()
deletePublicItemsAtPath(
projectId,
token,
deleteData
): Promise<{
count: number;
}>;Deletes items from a public file system (authenticated management).
Parameters
| Parameter | Type | Description |
|---|---|---|
projectId | string | The ID of the project. |
token | string | The public access token. |
deleteData | DeletePublicItemsData | Data for deleting items. |
Returns
Promise<{
count: number;
}>
Object containing the count of deleted items.
Inherited from
ReturnType.deletePublicItemsAtPathdeleteSubmissionItems()
deleteSubmissionItems(
projectId,
submissionId,
deleteData
): Promise<{
count: number;
}>;Deletes items within a submission.
Parameters
| Parameter | Type | Description |
|---|---|---|
projectId | string | The ID of the project. |
submissionId | string | The ID of the submission. |
deleteData | DeleteSubmissionItemsData | Data for deleting items. |
Returns
Promise<{
count: number;
}>
Object containing the count of deleted items.
Inherited from
ReturnType.deleteSubmissionItemsgetAssets()
getAssets(
projectId,
visibility,
params?
): Promise<PaginatedResponse<Asset>>;Lists a project's assets for one visibility tier.
creator requires canGetCreatorAssets; reviewer requires canGetReviewerAssets.
Parameters
| Parameter | Type | Description |
|---|---|---|
projectId | string | The project ID. |
visibility | "creator" | "reviewer" | Which tier's assets to list. |
params? | ListAssetsParams | Filters and pagination. See ListAssetsParams. |
Returns
Promise<PaginatedResponse<Asset>>
Paginated assets.
Throws
'projectId is required.' or 'visibility is required.'.
Inherited from
ReturnType.getAssetsgetFeedEvents()
getFeedEvents(
projectId,
visibility,
params?
): Promise<CursorPaginatedFeedEvents>;Gets one page of the project's event feed (uploads, asset discussions, publishes, submissions and public releases), most recent activity first. The creator and reviewer feeds never share events.
Parameters
| Parameter | Type | Description |
|---|---|---|
projectId | string | The ID of the project. |
visibility | FeedVisibility | Which feed to read. |
params? | ListFeedEventsParams | Filters and cursor. |
Returns
Promise<CursorPaginatedFeedEvents>
One page of feed events.
Inherited from
ReturnType.getFeedEventsgetFeedReadState()
getFeedReadState(projectId, visibility): Promise<ReadState>;Gets where you had read up to in a project feed, and how many cards have
moved since. lastReadAt is null if you have never recorded a position,
and unreadCount is 0 then. Cards you are the actor on never count.
Parameters
| Parameter | Type | Description |
|---|---|---|
projectId | string | The ID of the project. |
visibility | FeedVisibility | Which feed to read. |
Returns
Promise<ReadState>
Your reading position in that feed.
Inherited from
ReturnType.getFeedReadStategetFolders()
getFolders(
projectId,
visibility,
params?
): Promise<PaginatedResponse<Folder>>;Gets folders within a project with specified visibility.
Parameters
| Parameter | Type | Description |
|---|---|---|
projectId | string | The ID of the project. |
visibility | "creator" | "reviewer" | The visibility context ('creator' or 'reviewer'). |
params? | ListFoldersParams | Query parameters for filtering and pagination. |
Returns
Promise<PaginatedResponse<Folder>>
Paginated list of folders.
Inherited from
ReturnType.getFoldersgetHighlightedMessages()
getHighlightedMessages(
projectId,
visibility,
params?
): Promise<PaginatedResponse<ChatMessage>>;Lists highlighted chat messages across a project for one visibility tier (cursor pagination only).
creator requires canGetCreatorHighlights; reviewer requires canGetReviewerHighlights.
Parameters
| Parameter | Type | Description |
|---|---|---|
projectId | string | The project ID. |
visibility | "creator" | "reviewer" | Which tier's highlights to list. |
params? | GetHighlightedMessagesParams | Cursor pagination. See GetHighlightedMessagesParams. |
Returns
Promise<PaginatedResponse<ChatMessage>>
Paginated highlighted messages.
Throws
'projectId is required.' or 'visibility is required.'.
Inherited from
ReturnType.getHighlightedMessagesgetHighlightsReadState()
getHighlightsReadState(projectId, visibility): Promise<ReadState>;Gets your reading position in a project's highlights: when you last caught up, and how many messages others have highlighted since. If you have never caught up, it counts from when read tracking began.
Parameters
| Parameter | Type | Description |
|---|---|---|
projectId | string | The project ID. |
visibility | "creator" | "reviewer" | Which highlights. |
Returns
Promise<ReadState>
Your reading position.
Inherited from
ReturnType.getHighlightsReadStategetHomeFeed()
getHomeFeed(
projectId,
visibility,
params?
): Promise<PaginatedResponse<Asset>>;Gets the home feed for a project with a specified visibility.
Parameters
| Parameter | Type | Description |
|---|---|---|
projectId | string | The ID of the project. |
visibility | "creator" | "reviewer" | The visibility context ('creator' or 'reviewer'). |
params? | ListFeedParams | Query parameters for filtering and pagination. |
Returns
Promise<PaginatedResponse<Asset>>
Paginated feed items.
Inherited from
ReturnType.getHomeFeedgetItemsAtPath()
getItemsAtPath(
projectId,
visibility,
path?,
params?,
usePost?
): Promise<PaginatedResponse<any>>;Gets items at a specific path within a project.
Parameters
| Parameter | Type | Default value | Description |
|---|---|---|---|
projectId | string | undefined | The ID of the project. |
visibility | "creator" | "reviewer" | undefined | The visibility context ('creator' or 'reviewer'). |
path? | string | undefined | The path to get items from (optional, defaults to root). |
params? | GetItemsAtPathParams | undefined | Query parameters for filtering and pagination. |
usePost? | boolean | false | Whether to use POST method (useful for large resourceIds arrays). |
Returns
Promise<PaginatedResponse<any>>
Paginated list of items at the path.
Inherited from
ReturnType.getItemsAtPathgetOriginalPruningSummary()
getOriginalPruningSummary(projectId): Promise<ProjectPruningSummary>;The project's pruning policy and what it has done. Needs canManageProjectSettings.
Parameters
| Parameter | Type | Description |
|---|---|---|
projectId | string | The project ID. |
Returns
Promise<ProjectPruningSummary>
The summary.
Inherited from
ReturnType.getOriginalPruningSummarygetProject()
getProject(projectId): Promise<Project>;Retrieves a specific project by its ID.
Parameters
| Parameter | Type | Description |
|---|---|---|
projectId | string | The ID of the project. |
Returns
Promise<Project>
The project object.
Inherited from
ReturnType.getProjectgetProjectChat()
getProjectChat(
projectId,
visibility,
params?
): Promise<Chat>;Gets the project chat with the specified visibility.
Parameters
| Parameter | Type | Description |
|---|---|---|
projectId | string | The ID of the project. |
visibility | "creator" | "reviewer" | The visibility context ('creator' or 'reviewer'). |
params? | GetChatParams | Query parameters for message/reply limits. |
Returns
Promise<Chat>
The chat object.
Inherited from
ReturnType.getProjectChatgetProjectPublicAsset()
getProjectPublicAsset(
projectId,
token,
assetId
): Promise<PublicAssetResponse>;Gets a public asset with its public chat from an authenticated project context. Unlike the public endpoint, this does NOT check token expiration. Use this for internal management of public file systems.
Parameters
| Parameter | Type | Description |
|---|---|---|
projectId | string | The ID of the project. |
token | string | The public access token. |
assetId | string | The ID of the asset to retrieve. |
Returns
Promise<PublicAssetResponse>
The asset with its public chat.
Inherited from
ReturnType.getProjectPublicAssetgetProjectPublicChat()
getProjectPublicChat(projectId, token): Promise<any>;Gets a public chat from an authenticated project context. Unlike the public endpoint, this does NOT check token expiration. Use this for internal management of public file systems.
Parameters
| Parameter | Type | Description |
|---|---|---|
projectId | string | The ID of the project. |
token | string | The public access token. |
Returns
Promise<any>
The public chat or null if none exists.
Inherited from
ReturnType.getProjectPublicChatgetProjectPublicChatMessages()
getProjectPublicChatMessages(
projectId,
token,
chatId,
params?
): Promise<PublicChatMessagesResponse>;Gets messages from a public chat from an authenticated project context. Unlike the public endpoint, this does NOT check token expiration. Use this for internal management of public file systems.
Parameters
| Parameter | Type | Description |
|---|---|---|
projectId | string | The ID of the project. |
token | string | The public access token. |
chatId | string | The ID of the chat. |
params? | GetPublicChatMessagesParams | Query parameters for pagination. |
Returns
Promise<PublicChatMessagesResponse>
Paginated list of chat messages.
Inherited from
ReturnType.getProjectPublicChatMessagesgetProjects()
getProjects(): Promise<Project[]>;Retrieves projects accessible by the user.
NOTE: API endpoint /v1/projects does not currently support pagination.
Returns
Promise<Project[]>
List of project objects.
Inherited from
ReturnType.getProjectsgetPublicAudit()
getPublicAudit(projectId, params?): Promise<PaginatedResponse<PublicAuditAssetResponse>>;Get the public audit for a project — assets that are or have been publicly exposed.
Parameters
| Parameter | Type | Description |
|---|---|---|
projectId | string | - |
params? | { currentlyPublic?: boolean; limit?: number; page?: number; } | - |
params.currentlyPublic? | boolean | When true, only assets currently public. |
params.limit? | number | - |
params.page? | number | - |
Returns
Promise<PaginatedResponse<PublicAuditAssetResponse>>
Requires
projectAdmin or projectOwner on the project (or workspace-tier admin via inheritance).
Inherited from
ReturnType.getPublicAuditgetPublicFileSystem()
getPublicFileSystem(projectId, publicId): Promise<PublicFileSystemResponse>;Retrieves a specific public file system by its ID.
Parameters
| Parameter | Type | Description |
|---|---|---|
projectId | string | The ID of the project. |
publicId | string | The ID of the public file system. |
Returns
Promise<PublicFileSystemResponse>
The public file system object.
Inherited from
ReturnType.getPublicFileSystemgetPublicFileSystems()
getPublicFileSystems(projectId, params?): Promise<PaginatedResponse<PublicFileSystemResponse>>;Gets all public file systems for a project.
Parameters
| Parameter | Type | Description |
|---|---|---|
projectId | string | The ID of the project. |
params? | ListPublicFileSystemsParams | Query parameters (pagination, sort, search, status, creatorId). |
Returns
Promise<PaginatedResponse<PublicFileSystemResponse>>
Paginated list of public file systems.
Inherited from
ReturnType.getPublicFileSystemsgetPublicItemsAtPath()
getPublicItemsAtPath(
projectId,
token,
path?,
params?
): Promise<PaginatedResponse<any>>;Gets items from a public file system at a specific path (authenticated management).
Parameters
| Parameter | Type | Description |
|---|---|---|
projectId | string | The ID of the project. |
token | string | The public access token. |
path? | string | The path to get items from (optional, defaults to root). |
params? | GetItemsAtPathParams | Query parameters for filtering and pagination. |
Returns
Promise<PaginatedResponse<any>>
Paginated list of public file system items.
Inherited from
ReturnType.getPublicItemsAtPathgetSubmission()
getSubmission(
projectId,
submissionId,
params?
): Promise<ChatSubmission>;Retrieves a specific submission by its ID.
Parameters
| Parameter | Type | Description |
|---|---|---|
projectId | string | The ID of the project. |
submissionId | string | The ID of the submission. |
params? | GetSubmissionParams | Query parameters for chat message/reply options. |
Returns
Promise<ChatSubmission>
The submission object.
Inherited from
ReturnType.getSubmissiongetSubmissionItems()
getSubmissionItems(
projectId,
submissionId,
path?,
params?
): Promise<PaginatedResponse<any>>;Gets files for a specific submission.
Parameters
| Parameter | Type | Description |
|---|---|---|
projectId | string | The ID of the project. |
submissionId | string | The ID of the submission. |
path? | string | The path to get items from (optional, defaults to root). |
params? | GetItemsAtPathParams | Query parameters for filtering and pagination. |
Returns
Promise<PaginatedResponse<any>>
Paginated list of files.
Inherited from
ReturnType.getSubmissionItemsgetSubmissions()
getSubmissions(projectId, params?): Promise<PaginatedResponse<ChatSubmission>>;Retrieves submissions for a project.
Parameters
| Parameter | Type | Description |
|---|---|---|
projectId | string | The ID of the project. |
params? | ListSubmissionsParams | Query parameters for filtering and pagination. |
Returns
Promise<PaginatedResponse<ChatSubmission>>
Paginated list of submissions.
Inherited from
ReturnType.getSubmissionsgetTopAccessActivity()
getTopAccessActivity(projectId, params?): Promise<ProjectTopAccessActivityResponse>;Top-N assets in a project by access-activity event type (plays, downloads, embeds). Requires project read access. Returns asset IDs and counts only; hydrate names and thumbnails through the normal asset fetch path.
Parameters
| Parameter | Type | Description |
|---|---|---|
projectId | string | The project ID. |
params? | { eventType?: "play_started" | "play_completed" | "download" | "embed_resolved"; limit?: number; range?: "7d" | "30d" | "90d"; } | range ('7d' |
params.eventType? | "play_started" | "play_completed" | "download" | "embed_resolved" | - |
params.limit? | number | - |
params.range? | "7d" | "30d" | "90d" | - |
Returns
Promise<ProjectTopAccessActivityResponse>
Ranked asset IDs with counts.
Throws
'projectId is required.' when projectId is falsy.
Inherited from
ReturnType.getTopAccessActivitymarkFeedCaughtUp()
markFeedCaughtUp(
projectId,
visibility,
lastReadAt?
): Promise<ReadState>;Marks a project feed as caught up. Pass lastReadAt (epoch ms) to catch
up to the newest card you had loaded; omit it to catch up to now. The
marker only moves forward and never past the present, so a stale value is
a no-op rather than an error.
Parameters
| Parameter | Type |
|---|---|
projectId | string |
visibility | FeedVisibility |
lastReadAt? | number |
Returns
Promise<ReadState>
Your updated reading position.
Inherited from
ReturnType.markFeedCaughtUpmarkHighlightsCaughtUp()
markHighlightsCaughtUp(
projectId,
visibility,
lastReadAt?
): Promise<ReadState>;Marks a project's highlights as read. Pass lastReadAt (epoch ms) — the
highlightedAt of the newest highlight you had loaded; omit it to catch
up to now. The marker only moves forward and never past the present.
Parameters
| Parameter | Type |
|---|---|
projectId | string |
visibility | "creator" | "reviewer" |
lastReadAt? | number |
Returns
Promise<ReadState>
Your updated reading position.
Inherited from
ReturnType.markHighlightsCaughtUpmoveItemsToPath()
moveItemsToPath(
projectId,
visibility,
moveData
): Promise<MoveItemsResult>;Moves items to a specific path within a project.
Parameters
| Parameter | Type | Description |
|---|---|---|
projectId | string | The ID of the project. |
visibility | "creator" | "reviewer" | The visibility context ('creator' or 'reviewer'). |
moveData | MoveItemsData | Data for moving items. |
Returns
Promise<MoveItemsResult>
Object containing the count of moved items.
Inherited from
ReturnType.moveItemsToPathmovePublicItemsAtPath()
movePublicItemsAtPath(
projectId,
token,
moveData
): Promise<{
count: number;
}>;Moves items within a public file system (authenticated management).
Parameters
| Parameter | Type | Description |
|---|---|---|
projectId | string | The ID of the project. |
token | string | The public access token. |
moveData | MovePublicItemsData | Data for moving items. |
Returns
Promise<{
count: number;
}>
Object containing the count of moved items.
Inherited from
ReturnType.movePublicItemsAtPathmoveSubmissionItems()
moveSubmissionItems(
projectId,
submissionId,
moveData
): Promise<{
count: number;
}>;Moves items within a submission.
Parameters
| Parameter | Type | Description |
|---|---|---|
projectId | string | The ID of the project. |
submissionId | string | The ID of the submission. |
moveData | MoveSubmissionItemsData | Data for moving items. |
Returns
Promise<{
count: number;
}>
Object containing the count of moved items.
Inherited from
ReturnType.moveSubmissionItemspreviewDeleteItemsAtPath()
previewDeleteItemsAtPath(
projectId,
visibility,
deleteData
): Promise<DeleteImpact>;Asks what deleting these paths would reach, without deleting anything.
Computed from the same cascade the delete runs, so the answer is what will happen rather than an estimate of it. Only SECONDARY references come back — the reviewer, submission and public-release copies that would go with the selection.
Parameters
| Parameter | Type | Description |
|---|---|---|
projectId | string | - |
visibility | "creator" | "reviewer" | - |
deleteData | DeleteItemsData | The same body the delete takes. |
Returns
Promise<DeleteImpact>
Inherited from
ReturnType.previewDeleteItemsAtPathpreviewPruneOriginals()
previewPruneOriginals(projectId, selection): Promise<AssetPrunePreview>;What pruning the originals of a selection of the project's assets would
do, without doing it. Needs canPruneAsset on the project.
Parameters
| Parameter | Type | Description |
|---|---|---|
projectId | string | The project ID. |
selection | AssetPruneSelection | Asset ids, creator-tree paths, or both. |
Returns
Promise<AssetPrunePreview>
Each asset's eligibility, and the totals.
Inherited from
ReturnType.previewPruneOriginalspruneOriginals()
pruneOriginals(projectId, selection): Promise<AssetPruneRequestResult>;Requests prunes for every asset in the selection that can be pruned.
Needs canPruneAsset on the project.
Parameters
| Parameter | Type | Description |
|---|---|---|
projectId | string | The project ID. |
selection | AssetPruneSelection | Asset ids, creator-tree paths, or both. |
Returns
Promise<AssetPruneRequestResult>
The requested and skipped assets.
Inherited from
ReturnType.pruneOriginalspublishItems()
publishItems(projectId, publishData): Promise<any>;Publishes a list of items (assets, folders) within a project.
Parameters
| Parameter | Type | Description |
|---|---|---|
projectId | string | The ID of the project. |
publishData | PublishItemsData | Data for publishing items. |
Returns
Promise<any>
Object containing lists of published items and results.
Inherited from
ReturnType.publishItemsreleasePublicFileSystem()
releasePublicFileSystem(projectId, publicId): Promise<PublicFileSystemResponse>;Releases a staged (unreleased) public file system, making it externally accessible via its public token.
Parameters
| Parameter | Type | Description |
|---|---|---|
projectId | string | The ID of the project. |
publicId | string | The ID of the public file system. |
Returns
Promise<PublicFileSystemResponse>
The released public file system object.
Inherited from
ReturnType.releasePublicFileSystemreleaseSubmission()
releaseSubmission(projectId, submissionId): Promise<ChatSubmission>;Releases a staged (unreleased) submission, making it visible to reviewers and firing the deferred "new submission" side effects (emails, notifications, system messages).
Parameters
| Parameter | Type | Description |
|---|---|---|
projectId | string | The ID of the project. |
submissionId | string | The ID of the submission. |
Returns
Promise<ChatSubmission>
The released submission object.
Inherited from
ReturnType.releaseSubmissionreleaseSubmissionUpdate()
releaseSubmissionUpdate(projectId, submissionId): Promise<ChatSubmission>;Re-releases an already-released submission's side effects (the "Release
Update" action) — re-notifies reviewers with the submission-update email
template + submissionUpdate notification. Does not change status.
Parameters
| Parameter | Type | Description |
|---|---|---|
projectId | string | The ID of the project. |
submissionId | string | The ID of the submission. |
Returns
Promise<ChatSubmission>
The submission object.
Inherited from
ReturnType.releaseSubmissionUpdateremoveFeedEventReaction()
removeFeedEventReaction(
projectId,
visibility,
eventId
): Promise<FeedEvent>;Removes your reaction from a feed event.
Parameters
| Parameter | Type |
|---|---|
projectId | string |
visibility | FeedVisibility |
eventId | string |
Returns
Promise<FeedEvent>
The updated event.
Inherited from
ReturnType.removeFeedEventReactionsearchProject()
searchProject(projectId, params): Promise<SearchResponse>;Full-text search across assets, chat messages, and tasks within a project. Results are populated per the content type's native list view (asset → creator/publisher/tags; chatMessage → author/mentions/attachments; task → creator/assignee/project/origin).
Parameters
| Parameter | Type | Description |
|---|---|---|
projectId | string | - |
params | SearchProjectParams | At minimum q. Optional filters: contentTypes, dateFrom, dateTo, creatorId, sortBy, page, limit. |
Returns
Promise<SearchResponse>
Paginated search results.
Inherited from
ReturnType.searchProjectsetFeedEventReaction()
setFeedEventReaction(
projectId,
visibility,
eventId,
emoji
): Promise<FeedEvent>;Sets your reaction on a feed event. One per person — a new emoji replaces your previous one.
Parameters
| Parameter | Type |
|---|---|
projectId | string |
visibility | FeedVisibility |
eventId | string |
emoji | string |
Returns
Promise<FeedEvent>
The updated event.
Inherited from
ReturnType.setFeedEventReactiontagSubmission()
tagSubmission(
projectId,
submissionId,
tagData
): Promise<ChatSubmission>;Adds a tag to a submission.
Parameters
| Parameter | Type | Description |
|---|---|---|
projectId | string | The ID of the project. |
submissionId | string | The ID of the submission. |
tagData | TagSubmissionData | Data for tagging the submission. |
Returns
Promise<ChatSubmission>
The updated submission object.
Inherited from
ReturnType.tagSubmissionunpublishItems()
unpublishItems(projectId, unpublishData): Promise<any>;Unpublishes a list of items (assets, folders) within a project.
Parameters
| Parameter | Type | Description |
|---|---|---|
projectId | string | The ID of the project. |
unpublishData | UnpublishItemsData | Data for unpublishing items. |
Returns
Promise<any>
Object containing lists of unpublished items and results.
Inherited from
ReturnType.unpublishItemsuntagSubmission()
untagSubmission(
projectId,
submissionId,
tagData
): Promise<ChatSubmission>;Removes a tag from a submission.
Parameters
| Parameter | Type | Description |
|---|---|---|
projectId | string | The ID of the project. |
submissionId | string | The ID of the submission. |
tagData | TagSubmissionData | Data for untagging the submission. |
Returns
Promise<ChatSubmission>
The updated submission object.
Inherited from
ReturnType.untagSubmissionupdateLogo()
updateLogo(projectId, logoData): Promise<any>;Updates the logo asset for a project.
Parameters
| Parameter | Type | Description |
|---|---|---|
projectId | string | The ID of the project. |
logoData | LogoUploadData | File metadata for the new logo. |
Returns
Promise<any>
Object containing signed URL data and updated project info.
Inherited from
ReturnType.updateLogoupdateProject()
updateProject(projectId, updateData): Promise<Project>;Updates a project.
Parameters
| Parameter | Type | Description |
|---|---|---|
projectId | string | The ID of the project to update. |
updateData | UpdateProjectData | Data to update. |
Returns
Promise<Project>
The updated project object.
Inherited from
ReturnType.updateProjectupdatePublicFileSystem()
updatePublicFileSystem(
projectId,
publicId,
updateData
): Promise<PublicFileSystemResponse>;Updates an existing public file system's title and description.
Parameters
| Parameter | Type | Description |
|---|---|---|
projectId | string | The ID of the project. |
publicId | string | The ID of the public file system. |
updateData | UpdatePublicFileSystemData | Data to update. |
Returns
Promise<PublicFileSystemResponse>
The updated public file system object.
Inherited from
ReturnType.updatePublicFileSystemupdateSetting()
updateSetting(
projectId,
name,
value
): Promise<Project>;Updates a single project setting (e.g. aiPolishEnabled,
aiCustomPreprompt). Pass null to inherit the workspace's value;
pass a typed value to override. The valid setting names are validated
server-side against projectService.validProjectSettings.
Parameters
| Parameter | Type | Description |
|---|---|---|
projectId | string | - |
name | string | Setting key (e.g. 'aiPolishEnabled'). |
value | unknown | null (inherit) |
Returns
Promise<Project>
Inherited from
ReturnType.updateSettingupdateSubmission()
updateSubmission(
projectId,
submissionId,
updateData
): Promise<ChatSubmission>;Updates a submission.
Parameters
| Parameter | Type | Description |
|---|---|---|
projectId | string | The ID of the project. |
submissionId | string | The ID of the submission. |
updateData | UpdateSubmissionData | Data to update. |
Returns
Promise<ChatSubmission>
The updated submission object.
Inherited from
ReturnType.updateSubmissionSDKVersionInfo
SDK Version Information AUTO-GENERATED by scripts/generate-version-info.cjs - DO NOT EDIT MANUALLY
Properties
SubscriptionMethods
Extends
ReturnType<typeofdefault>
Methods
cancelWorkspaceSubscription()
cancelWorkspaceSubscription(workspaceId): Promise<any>;Cancels the subscription for a specific workspace. Requires authentication and permission.
Parameters
| Parameter | Type | Description |
|---|---|---|
workspaceId | string | The ID of the workspace. |
Returns
Promise<any>
The cancellation response.
Inherited from
ReturnType.cancelWorkspaceSubscriptioncreateWorkspaceOrder()
createWorkspaceOrder(workspaceId, orderData): Promise<any>;Creates a subscription order for a specific workspace. Requires authentication and permission.
Parameters
| Parameter | Type | Description |
|---|---|---|
workspaceId | string | The ID of the workspace. |
orderData | CreateWorkspaceOrderParams | The order data. |
Returns
Promise<any>
The created order response.
Inherited from
ReturnType.createWorkspaceOrdergetResourceLimits()
getResourceLimits(resourceId): Promise<ResourceLimits>;Retrieves the resource limits (e.g., storage, seats) for a specific resource (typically workspace). Requires authentication.
Parameters
| Parameter | Type | Description |
|---|---|---|
resourceId | string | The ID of the resource (e.g., workspaceId). |
Returns
Promise<ResourceLimits>
An object containing the resource limits.
Inherited from
ReturnType.getResourceLimitsgetRoleUsage()
getRoleUsage(resourceId): Promise<RoleUsage>;Retrieves per-role (creator / reviewer) seat usage and caps for a
workspace. limit is null when the plan is unlimited for that
seat type. Requires authentication.
Parameters
| Parameter | Type | Description |
|---|---|---|
resourceId | string | The workspace ID. |
Returns
Promise<RoleUsage>
Creator- and reviewer-side seat usage.
Inherited from
ReturnType.getRoleUsagegetSeatUsage()
getSeatUsage(resourceId): Promise<SeatUsage>;Retrieves the seat usage for a specific resource (typically workspace). Requires authentication.
Parameters
| Parameter | Type | Description |
|---|---|---|
resourceId | string | The ID of the resource (e.g., workspaceId). |
Returns
Promise<SeatUsage>
An object containing seat usage details.
Inherited from
ReturnType.getSeatUsagegetStorageUsage()
getStorageUsage(resourceId): Promise<StorageUsage>;Retrieves the storage usage for a specific resource (typically workspace). Requires authentication.
Parameters
| Parameter | Type | Description |
|---|---|---|
resourceId | string | The ID of the resource (e.g., workspaceId). |
Returns
Promise<StorageUsage>
An object containing storage usage details.
Inherited from
ReturnType.getStorageUsagegetUserSubscriptions()
getUserSubscriptions(params?): Promise<Subscription[]>;Retrieves all subscriptions owned by the currently authenticated user. Requires authentication.
Parameters
| Parameter | Type | Description |
|---|---|---|
params? | GetSubscriptionsParams | Optional query parameters for status and sorting. |
Returns
Promise<Subscription[]>
An array of subscription objects.
Inherited from
ReturnType.getUserSubscriptionsgetWorkspaceOrders()
getWorkspaceOrders(workspaceId, params?): Promise<any[]>;Retrieves subscription orders for a specific workspace. Requires authentication and permission.
Parameters
| Parameter | Type | Description |
|---|---|---|
workspaceId | string | The ID of the workspace. |
params? | GetSubscriptionOrdersParams | Optional query parameters. |
Returns
Promise<any[]>
An array of subscription order objects.
Inherited from
ReturnType.getWorkspaceOrdersgetWorkspaceSubscription()
getWorkspaceSubscription(workspaceId): Promise<Subscription>;Retrieves the active subscription for a specific workspace. Requires authentication and permission.
Parameters
| Parameter | Type | Description |
|---|---|---|
workspaceId | string | The ID of the workspace. |
Returns
Promise<Subscription>
The workspace subscription object.
Inherited from
ReturnType.getWorkspaceSubscriptiongetWorkspaceUsageSummary()
getWorkspaceUsageSummary(workspaceId): Promise<{
billableSeatCount: number;
storageUsedInBytes: number;
}>;Retrieves the workspace usage summary (billable seats and storage used). Requires authentication and subscription management permission.
Parameters
| Parameter | Type | Description |
|---|---|---|
workspaceId | string | The ID of the workspace. |
Returns
Promise<{
billableSeatCount: number;
storageUsedInBytes: number;
}>
Usage summary.
Inherited from
ReturnType.getWorkspaceUsageSummaryresumeWorkspaceSubscription()
resumeWorkspaceSubscription(workspaceId): Promise<any>;Reverse a scheduled (period-end) cancellation, keeping the workspace's subscription on its normal renewal cycle. Only valid while the subscription is still active with a pending cancellation; a fully lapsed subscription can't be resumed (the owner must re-subscribe). Requires authentication and permission.
Parameters
| Parameter | Type | Description |
|---|---|---|
workspaceId | string | The ID of the workspace. |
Returns
Promise<any>
The resume response.
Inherited from
ReturnType.resumeWorkspaceSubscriptionswapWorkspacePlan()
swapWorkspacePlan(workspaceId, params): Promise<{
subscription: Subscription | null;
warnings: PlanChangeWarning[];
}>;Swap the workspace's active basePlan line for a different basePlan product.
Same code path both upgrades and downgrades; the API's pre-flight
capacity check is what distinguishes a permitted change from a refused
one. Pass dryRun: true to get the pre-flight verdict without mutating.
On over-allocation the API returns 400 planCapacityInsufficient with
errorData.violations: [{ resource, current, newLimit }], surfaced via
the SDK's normal error path.
On success, returns the updated subscription plus a warnings[] array
of feature-gate capabilities the destination plan does NOT include (the
FE renders these as a confirmation notice).
Parameters
| Parameter | Type |
|---|---|
workspaceId | string |
params | { billingPeriod: "month" | "year"; currency: string; dryRun?: boolean; newProductId: string; } |
params.billingPeriod | "month" | "year" |
params.currency | string |
params.dryRun? | boolean |
params.newProductId | string |
Returns
Promise<{
subscription: Subscription | null;
warnings: PlanChangeWarning[];
}>
Inherited from
ReturnType.swapWorkspacePlanUserMethods
Extends
ReturnType<typeofdefault>
Methods
createAvatar()
createAvatar(fileData): Promise<any>;Creates a new avatar for the user.
Parameters
| Parameter | Type | Description |
|---|---|---|
fileData | FileData | File metadata (e.g., { name, checksum, sizeInMB }). |
Returns
Promise<any>
Object containing signed URL data and updated user info.
Inherited from
ReturnType.createAvatardeleteCurrentUser()
deleteCurrentUser(): Promise<void>;Deletes the current user. Requires authentication.
Returns
Promise<void>
Inherited from
ReturnType.deleteCurrentUsergetSelf()
getSelf(): Promise<PublicUser>;Retrieves the current user's profile. Requires authentication.
Returns
Promise<PublicUser>
The current user's profile.
Throws
If no user ID is found in the token.
Inherited from
ReturnType.getSelfgetTodos()
getTodos(): Promise<{
todos: UserTodo[];
}>;Get the current user's active site-level Todos for the onboarding drawer. Returns only todos whose completion condition isn't met and (for dismissibles) that the user hasn't opted out of. Server computes from live state — no caching on the server side, so a fresh call always reflects ground truth.
Returns
Promise<{
todos: UserTodo[];
}>
Inherited from
ReturnType.getTodosgetUser()
getUser(userId): Promise<PublicUser>;Retrieves the public profile of a specific user. Requires authentication.
Parameters
| Parameter | Type | Description |
|---|---|---|
userId | string | The ID of the user to retrieve. |
Returns
Promise<PublicUser>
Public user object.
Inherited from
ReturnType.getUsermarkSeen()
markSeen(element): Promise<User>;Record that the current user has seen a one-time UI element (welcome video, tutorial coachmark). Idempotent. Returns the updated user.
Parameters
| Parameter | Type | Description |
|---|---|---|
element | string | one-time element key (see backend oneTimeElements). |
Returns
Promise<User>
Inherited from
ReturnType.markSeenunmarkSeen()
unmarkSeen(elements?): Promise<User>;Remove one-time UI elements from the current user's hasSeen so they
display again. Pass specific element keys, or omit to clear ALL.
Returns the updated user.
Parameters
| Parameter | Type | Description |
|---|---|---|
elements? | string[] | elements to remove; omit to clear all. |
Returns
Promise<User>
Inherited from
ReturnType.unmarkSeenupdateAvatar()
updateAvatar(fileData): Promise<any>;Updates the user's avatar.
Parameters
| Parameter | Type | Description |
|---|---|---|
fileData | FileData | File metadata (e.g., { name, checksum, sizeInMB }). |
Returns
Promise<any>
Object containing signed URL data and updated user info.
Inherited from
ReturnType.updateAvatarupdatePreferences()
updatePreferences(preferenceData): Promise<User>;Updates the user's preferences.
Parameters
| Parameter | Type | Description |
|---|---|---|
preferenceData | PreferencesData | Preference data to update (e.g., { hide: ['feedHint'] }). |
Returns
Promise<User>
Updated user object.
Inherited from
ReturnType.updatePreferencesupdateSelf()
updateSelf(updateData): Promise<User>;Updates the logged-in user's profile. Requires authentication. At least one field must be provided.
Parameters
| Parameter | Type | Description |
|---|---|---|
updateData | UpdateUserData | The user data fields to update. |
Returns
Promise<User>
The updated user object.
Inherited from
ReturnType.updateSelfWorkspaceMethods
Extends
ReturnType<typeofdefault>
Methods
createIcon()
createIcon(workspaceId, fileData): Promise<any>;Request signed URL data to upload a workspace icon (the small square shown in sidebars and tabs — distinct from the logo).
Parameters
| Parameter | Type |
|---|---|
workspaceId | string |
fileData | FileData |
Returns
Promise<any>
Response containing signed URL data and workspace info.
Inherited from
ReturnType.createIconcreateLogo()
createLogo(workspaceId, fileData): Promise<any>;Request signed URL data to upload a workspace logo.
Caller then multipart-uploads the file using the returned signedUrlData
and calls client.asset.completeUpload(...) to finalize.
Parameters
| Parameter | Type |
|---|---|
workspaceId | string |
fileData | FileData |
Returns
Promise<any>
Response containing signed URL data and workspace info.
Inherited from
ReturnType.createLogocreateWorkspace()
createWorkspace(data): Promise<any>;Creates a new workspace. Requires authentication.
Parameters
| Parameter | Type | Description |
|---|---|---|
data | CreateWorkspaceData | Workspace data. |
Returns
Promise<any>
The created workspace object.
Inherited from
ReturnType.createWorkspacedeleteWorkspace()
deleteWorkspace(workspaceId): Promise<any>;Soft-delete a workspace. All nested resources (projects, chats, assets) become inaccessible; bytes are reclaimed by the cleanup cron.
Parameters
| Parameter | Type | Description |
|---|---|---|
workspaceId | string | The ID of the workspace to delete. |
Returns
Promise<any>
Object confirming the status change.
Inherited from
ReturnType.deleteWorkspacegetWorkspace()
getWorkspace(workspaceId): Promise<any>;Retrieves a specific workspace by its ID. Requires authentication.
Parameters
| Parameter | Type | Description |
|---|---|---|
workspaceId | string | The ID of the workspace to retrieve. |
Returns
Promise<any>
The workspace object.
Inherited from
ReturnType.getWorkspacelistProjects()
listProjects(workspaceId): Promise<any[]>;List the projects inside a workspace that the calling user has access to.
Parameters
| Parameter | Type | Description |
|---|---|---|
workspaceId | string | The ID of the workspace. |
Returns
Promise<any[]>
An array of project objects.
Inherited from
ReturnType.listProjectslistWorkspaces()
listWorkspaces(sortParams?): Promise<any[]>;Lists all workspaces the authenticated user has access to. Requires authentication.
Parameters
| Parameter | Type | Description |
|---|---|---|
sortParams? | SortParams | Optional sorting. Keys are field names (id, name, createdAt, updatedAt); values are 1 for ascending or -1 for descending. Sent as ?sort[name]=1&sort[createdAt]=-1. |
Returns
Promise<any[]>
Workspaces with the caller's roles and the workspace capabilities.
Inherited from
ReturnType.listWorkspacesupdateIcon()
updateIcon(workspaceId, fileData): Promise<any>;Request signed URL data to replace the workspace icon. Same upload
shape as createIcon.
Parameters
| Parameter | Type |
|---|---|
workspaceId | string |
fileData | FileData |
Returns
Promise<any>
Response containing signed URL data and workspace info.
Inherited from
ReturnType.updateIconupdateLogo()
updateLogo(workspaceId, fileData): Promise<any>;Request signed URL data to replace the workspace logo. Same upload
shape as createLogo; existing logo is replaced once completeUpload
lands.
Parameters
| Parameter | Type |
|---|---|
workspaceId | string |
fileData | FileData |
Returns
Promise<any>
Response containing signed URL data and workspace info.
Inherited from
ReturnType.updateLogoupdateSetting()
updateSetting(
workspaceId,
settingName,
value
): Promise<any>;Toggle a single workspace boolean setting (e.g. an enableX feature
flag).
Parameters
| Parameter | Type | Description |
|---|---|---|
workspaceId | string | The ID of the workspace. |
settingName | string | The name of the setting. |
value | boolean | The new value for the setting. |
Returns
Promise<any>
The updated workspace object with new settings.
Inherited from
ReturnType.updateSettingupdateWorkspace()
updateWorkspace(workspaceId, updateData): Promise<any>;Update workspace metadata (name, description, etc.).
Parameters
| Parameter | Type |
|---|---|
workspaceId | string |
updateData | UpdateWorkspaceData |
Returns
Promise<any>
The updated workspace object.
Inherited from
ReturnType.updateWorkspaceFunctions
isApiError()
function isApiError(error): error is ApiError;Narrow an unknown thrown value to an API error carrying an HTTP status.
Parameters
| Parameter | Type |
|---|---|
error | unknown |
Returns
error is ApiError
References
Bot
Re-exports Bot
BotApiKeySummary
Re-exports BotApiKeySummary
BotProjectMembership
Re-exports BotProjectMembership
BotProjectRole
Re-exports BotProjectRole
CreateBotData
Re-exports CreateBotData
CreateBotResponse
Re-exports CreateBotResponse
CreateSupportTicketRequest
Re-exports CreateSupportTicketRequest
CreateTokenData
Re-exports CreateTokenData
CreateTokenResponse
Re-exports CreateTokenResponse
CreateWebhookData
Re-exports CreateWebhookData
CreateWebhookResponse
Re-exports CreateWebhookResponse
HealthStatus
Re-exports HealthStatus
ListDeliveriesParams
Re-exports ListDeliveriesParams
ListDeliveriesResponse
Re-exports ListDeliveriesResponse
RotateBotKeyResponse
Re-exports RotateBotKeyResponse
RotateWebhookSecretResponse
Re-exports RotateWebhookSecretResponse
SupportTicket
Re-exports SupportTicket
SupportTicketListParams
Re-exports SupportTicketListParams
SupportTicketListResponse
Re-exports SupportTicketListResponse
SupportTicketScope
Re-exports SupportTicketScope
SupportTicketScopeOptions
Re-exports SupportTicketScopeOptions
SupportTicketStatus
Re-exports SupportTicketStatus
TestWebhookResponse
Re-exports TestWebhookResponse
TokenKind
Re-exports TokenKind
TokenScope
Re-exports TokenScope
TokenSummary
Re-exports TokenSummary
UpdateBotAvatarFileData
Re-exports UpdateBotAvatarFileData
UpdateBotAvatarResponse
Re-exports UpdateBotAvatarResponse
UpdateBotData
Re-exports UpdateBotData
UpdateWebhookData
Re-exports UpdateWebhookData
UserTodo
Re-exports UserTodo
WebhookAttempt
Re-exports WebhookAttempt
WebhookAttemptStatus
Re-exports WebhookAttemptStatus
WebhookEvent
Re-exports WebhookEvent
WebhookSubscription
Re-exports WebhookSubscription
WebhookSubscriptionStatus
Re-exports WebhookSubscriptionStatus