Nurama Developers

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
ParameterTypeDescription
baseURLstringThe base URL for the Nurama API.
optionsNuramaClientOptionsConfiguration options.
Returns

default

Properties

PropertyModifierTypeDefault valueDescription
aipublic{ composeWithNu: Promise<ComposeWithNuResponse>; createRevisionSourceUpload: Promise<CreateRevisionSourceUploadResponse>; generateRevision: Promise<GenerateImageRevisionResponse>; generateTasks: Promise<GenerateTasksResponse>; listTones: Promise<ListTonesResponse>; polish: Promise<PolishResponse>; submitFeedback: Promise<{ id: string; }>; }undefined-
ai.composeWithNupublicPromise<ComposeWithNuResponse>undefined-
ai.createRevisionSourceUploadpublicPromise<CreateRevisionSourceUploadResponse>undefined-
ai.generateRevisionpublicPromise<GenerateImageRevisionResponse>undefined-
ai.generateTaskspublicPromise<GenerateTasksResponse>undefined-
ai.listTonespublicPromise<ListTonesResponse>undefined-
ai.polishpublicPromise<PolishResponse>undefined-
ai.submitFeedbackpublicPromise<{ id: string; }>undefined-
aiChatpublic{ createTopic: Promise<AiChatCreateTopicResponse>; deleteTopic: Promise<AiChatGetTopicResponse>; getTopic: Promise<AiChatGetTopicResponse>; listTopics: Promise<AiChatListTopicsResponse>; updateTopic: Promise<AiChatGetTopicResponse>; }undefined-
aiChat.createTopicpublicPromise<AiChatCreateTopicResponse>undefined-
aiChat.deleteTopicpublicPromise<AiChatGetTopicResponse>undefined-
aiChat.getTopicpublicPromise<AiChatGetTopicResponse>undefined-
aiChat.listTopicspublicPromise<AiChatListTopicsResponse>undefined-
aiChat.updateTopicpublicPromise<AiChatGetTopicResponse>undefined-
assetreadonlyAssetMethodsundefined-
authreadonlyAuthMethodsundefined-
baseURLreadonlystringundefined-
blogPostspublic{ listBlogPosts: Promise<BlogPostListResponse>; }undefined-
blogPosts.listBlogPostspublicPromise<BlogPostListResponse>undefined-
boardpublic{ 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.addColumnpublicPromise<BoardColumn>undefined-
board.addExistingTaskToBoardpublicPromise<Task>undefined-
board.createBoardpublicPromise<Board>undefined-
board.createBoardTaskpublicPromise<Task>undefined-
board.deleteBoardpublicPromise<{ deletedTaskIds: string[]; disposition: string; message: string; reassignedTaskIds: string[]; }>undefined-
board.deleteColumnpublicPromise<void>undefined-
board.followBoardpublicPromise<Board>undefined-
board.getBoardpublicPromise<BoardWithTasks>undefined-
board.getBoardTaskspublicPromise<Task[]>undefined-
board.getProjectBoardspublicPromise<Board[]>undefined-
board.getProjectTaskspublicPromise<any>undefined-
board.moveTaskpublicPromise<Task>undefined-
board.removeTaskFromBoardpublicPromise<Task>undefined-
board.reorderColumnspublicPromise<BoardColumn[]>undefined-
board.tagBoardpublicPromise<Board>undefined-
board.unfollowBoardpublicPromise<Board>undefined-
board.untagBoardpublicPromise<Board>undefined-
board.updateBoardpublicPromise<Board>undefined-
board.updateColumnpublicPromise<BoardColumn>undefined-
botpublic{ 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.createBotpublicPromise<CreateBotResponse>undefined-
bot.createBotKeypublicPromise<CreateBotKeyResponse>undefined-
bot.deleteBotpublicPromise<void>undefined-
bot.getBotpublicPromise<Bot>undefined-
bot.listBotspublicPromise<Bot[]>undefined-
bot.listProjectMembershipspublicPromise<BotProjectMembership[]>undefined-
bot.removeProjectMembershippublicPromise<void>undefined-
bot.revokeBotKeypublicPromise<void>undefined-
bot.rotateBotKeypublicPromise<RotateBotKeyResponse>undefined-
bot.setProjectMembershippublicPromise<BotProjectMembership>undefined-
bot.updateBotpublicPromise<Bot>undefined-
bot.updateBotAvatarpublicPromise<UpdateBotAvatarResponse>undefined-
bot.updateBotKeyScopespublicPromise<BotApiKeySummary>undefined-
browserModereadonlybooleanfalse-
cacheDurationSecondsreadonlynumberundefined-
chatpublic{ 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.addAttachmentspublicPromise<AttachmentUploadRecord[]>undefined-
chat.addMemberspublicPromise<ChatMember>undefined-
chat.archiveMemberChatpublicPromise<ChatMember>undefined-
chat.createAssetChatAndMessagepublicPromise<any>undefined-
chat.createMemberChatpublicPromise<ChatMember>undefined-
chat.createMessagepublicPromise<ChatMessage>undefined-
chat.createMessageShortLinkpublicPromise<{ code: string; shortUrl: string; }>undefined-
chat.createReactionpublicPromise<ChatMessage>undefined-
chat.createTopicChatpublicPromise<Chat>undefined-
chat.deleteChatpublicPromise<void>undefined-
chat.deleteMemberChatpublicPromise<void>undefined-
chat.deleteMessagepublicPromise<ChatMessage>undefined-
chat.fetchLinkPreviewspublicPromise<LinkPreviewResponse>undefined-
chat.followChatpublicPromise<void>undefined-
chat.getAddableMemberspublicPromise< | AddableMembersByScope | Membership[]>undefined-
chat.getChatpublicPromise<Chat>undefined-
chat.getChatByTopicIdpublicPromise<Chat>undefined-
chat.getMemberChatpublicPromise<ChatMember>undefined-
chat.getMemberChatReadStatepublicPromise<ReadState>undefined-
chat.getMemberChatReadStatespublicPromise<{ results: MemberChatReadState[]; }>undefined-
chat.getMentionableAssetspublicPromise<PaginatedResponse<Asset>>undefined-
chat.getMentionableFolderspublicPromise<PaginatedResponse<Folder>>undefined-
chat.getMentionablePublicspublicPromise<PaginatedResponse<MentionablePublic>>undefined-
chat.getMentionableSubmissionspublicPromise<PaginatedResponse<MentionableSubmission>>undefined-
chat.getMentionableTaskspublicPromise<PaginatedResponse<any>>undefined-
chat.getMentionspublicPromise<PaginatedResponse<ChatMessage>>undefined-
chat.getMessagepublicPromise<ChatMessage>undefined-
chat.getMessagespublicPromise<PaginatedResponse<ChatMessage>>undefined-
chat.getRepliespublicPromise<PaginatedResponse<ChatMessage>>undefined-
chat.getScopeAddableMemberspublicPromise< | AddableMembersByScope | Membership[]>undefined-
chat.getUsersMemberChatspublicPromise<PaginatedResponse<ChatMember>>undefined-
chat.getWorkspaceProjectChatspublicPromise<any[]>undefined-
chat.highlightMessagepublicPromise<ChatMessage>undefined-
chat.markMemberChatCaughtUppublicPromise<ReadState>undefined-
chat.removeAttachmentpublicPromise<ChatMessage>undefined-
chat.removeMemberspublicPromise<ChatMember>undefined-
chat.removeReactionpublicPromise<ChatMessage>undefined-
chat.reviseMessagepublicPromise<ChatMessage>undefined-
chat.unarchiveMemberChatpublicPromise<ChatMember>undefined-
chat.unfollowChatpublicPromise<void>undefined-
chat.unhighlightMessagepublicPromise<ChatMessage>undefined-
chat.updateChatSubjectpublicPromise<Chat>undefined-
chat.updateMemberChatpublicPromise<ChatMember>undefined-
chat.updateMemberChatIconpublicPromise<{ chat: ChatMember; } & AttachmentUploadRecord>undefined-
configreadonlyConfigMethodsundefined-
convopublic{ 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.completeConvopublicPromise<CompleteConvoResponse>undefined-
convo.deleteConvopublicPromise<void>undefined-
convo.getChatConvospublicPromise<Convo[]>undefined-
convo.getConvopublicPromise<GetConvoResponse>undefined-
convo.getProjectConvospublicPromise<Convo[]>undefined-
convo.getScopeConvospublicPromise<GetScopeConvosResponse>undefined-
convo.joinConvopublicPromise<JoinConvoResponse>undefined-
convo.leaveConvopublicPromise<LeaveConvoResponse>undefined-
convo.promoteConvoArtifactpublicPromise<PromoteConvoArtifactResponse>undefined-
convo.rejoinConvopublicPromise<JoinConvoResponse>undefined-
convo.startConvopublicPromise<StartConvoResponse>undefined-
convo.updateConvopublicPromise<UpdateConvoResponse>undefined-
creditspublic{ getBalance: Promise<GetBalanceResponse>; getUsageReport: Promise<UsageReportResponse>; }undefined-
credits.getBalancepublicPromise<GetBalanceResponse>undefined-
credits.getUsageReportpublicPromise<UsageReportResponse>undefined-
debugreadonlybooleanundefined-
devicepublic{ deleteDevice: Promise<void>; endLiveActivity: Promise<void>; getDevice: Promise<Device>; getUserDevices: Promise<Device[]>; registerDevice: Promise<Device>; registerLiveActivity: Promise<LiveActivityRegistration>; updateDevice: Promise<Device>; }undefined-
device.deleteDevicepublicPromise<void>undefined-
device.endLiveActivitypublicPromise<void>undefined-
device.getDevicepublicPromise<Device>undefined-
device.getUserDevicespublicPromise<Device[]>undefined-
device.registerDevicepublicPromise<Device>undefined-
device.registerLiveActivitypublicPromise<LiveActivityRegistration>undefined-
device.updateDevicepublicPromise<Device>undefined-
enableCachereadonlybooleanundefined-
fetchreadonly(input, init?) => Promise<Response>undefined-
folderpublic{ getFolder: Promise<Folder>; getFoldersAssets: Promise<PaginatedResponse<Asset>>; tagFolder: Promise<Folder>; untagFolder: Promise<Folder>; updateFolder: Promise<Folder>; updateFolderIcon: Promise<any>; }undefined-
folder.getFolderpublicPromise<Folder>undefined-
folder.getFoldersAssetspublicPromise<PaginatedResponse<Asset>>undefined-
folder.tagFolderpublicPromise<Folder>undefined-
folder.untagFolderpublicPromise<Folder>undefined-
folder.updateFolderpublicPromise<Folder>undefined-
folder.updateFolderIconpublicPromise<any>undefined-
invalidateCacheOnMutationreadonlybooleanundefined-
invitepublic{ acceptInvite: Promise<AcceptInviteResponse>; cancelInvite: Promise<Invite>; getInviteById: Promise<Invite>; getInvites: Promise<PaginatedInvitesResponse>; getInvitesForResource: Promise<Invite[]>; inviteUser: Promise<Invite>; resendInvite: Promise<Invite>; }undefined-
invite.acceptInvitepublicPromise<AcceptInviteResponse>undefined-
invite.cancelInvitepublicPromise<Invite>undefined-
invite.getInviteByIdpublicPromise<Invite>undefined-
invite.getInvitespublicPromise<PaginatedInvitesResponse>undefined-
invite.getInvitesForResourcepublicPromise<Invite[]>undefined-
invite.inviteUserpublicPromise<Invite>undefined-
invite.resendInvitepublicPromise<Invite>undefined-
joinLinkpublic{ 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.approveJoinRequestpublicPromise<ApproveJoinRequestResponse>undefined-
joinLink.createJoinLinkpublicPromise<JoinLink>undefined-
joinLink.createResourceBanpublicPromise<ResourceBan>undefined-
joinLink.getJoinByTokenpublicPromise<JoinLinkPreview>undefined-
joinLink.getJoinLinkspublicPromise<JoinLinksListResponse>undefined-
joinLink.getJoinRequestspublicPromise<ListJoinRequestsResponse>undefined-
joinLink.getMyJoinRequestspublicPromise<ListMyJoinRequestsResponse>undefined-
joinLink.getResourceBanspublicPromise<ListBansResponse>undefined-
joinLink.joinByTokenpublicPromise<RedeemJoinLinkResult>undefined-
joinLink.liftResourceBanpublicPromise<ResourceBan>undefined-
joinLink.rejectJoinRequestpublicPromise<RejectJoinRequestResponse>undefined-
joinLink.rollJoinLinkpublicPromise<JoinLink>undefined-
joinLink.updateJoinLinkpublicPromise<JoinLink>undefined-
joinLink.updateJoinRequestCooldownpublicPromise<ProjectJoinRequest>undefined-
membershippublic{ 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.addRolepublicPromise<Membership>undefined-
membership.deleteMembershippublicPromise<void>undefined-
membership.getMyMembershipspublicPromise<Membership[]>undefined-
membership.getProjectLastSeenpublicPromise<GetLastSeenResponse>undefined-
membership.getProjectMembershipspublicPromise<MembershipReport>undefined-
membership.getProjectMentionableUserspublicPromise<Mentionable[]>undefined-
membership.getWorkspaceLastSeenpublicPromise<GetLastSeenResponse>undefined-
membership.getWorkspaceMembershipspublicPromise<MembershipReport>undefined-
membership.leaveResourcepublicPromise<void>undefined-
membership.removeRolepublicPromise<Membership>undefined-
notificationpublic{ getNewNotificationCount: Promise<NotificationCountResponse>; getNewNotificationCountBulk: Promise<NotificationCountBulkResponse>; getNewNotifications: Promise<PaginatedNotificationResponse>; getNotifications: Promise<PaginatedNotificationResponse>; getUsersLastNotificationsSeen: Promise<LastSeenResponse>; updateUsersLastSeen: Promise<LastSeenResponse>; }undefined-
notification.getNewNotificationCountpublicPromise<NotificationCountResponse>undefined-
notification.getNewNotificationCountBulkpublicPromise<NotificationCountBulkResponse>undefined-
notification.getNewNotificationspublicPromise<PaginatedNotificationResponse>undefined-
notification.getNotificationspublicPromise<PaginatedNotificationResponse>undefined-
notification.getUsersLastNotificationsSeenpublicPromise<LastSeenResponse>undefined-
notification.updateUsersLastSeenpublicPromise<LastSeenResponse>undefined-
oauthGrantpublic{ listGrants: Promise<OAuthGrantSummary[]>; revokeGrant: Promise<void>; }undefinedConnected applications: what the user has authorised over OAuth.
oauthGrant.listGrantspublicPromise<OAuthGrantSummary[]>undefined-
oauthGrant.revokeGrantpublicPromise<void>undefined-
paymentpublic{ createManualCheckout: Promise<any>; createStripeCheckout: Promise<StripeCheckoutResponse>; createStripeCustomer: Promise<StripeCustomerResponse>; getStripePortalUrl: Promise<StripePortalResponse>; }undefined-
payment.createManualCheckoutpublicPromise<any>undefined-
payment.createStripeCheckoutpublicPromise<StripeCheckoutResponse>undefined-
payment.createStripeCustomerpublicPromise<StripeCustomerResponse>undefined-
payment.getStripePortalUrlpublicPromise<StripePortalResponse>undefined-
productpublic{ getSuggestedCurrency: Promise<{ country: string | null; currency: SupportedCurrency; locked?: boolean; supported: SupportedCurrency[]; }>; getWorkspaceProducts: Promise<Product[]>; listPlans: Promise<Product[]>; }undefined-
product.getSuggestedCurrencypublicPromise<{ country: string | null; currency: SupportedCurrency; locked?: boolean; supported: SupportedCurrency[]; }>undefined-
product.getWorkspaceProductspublicPromise<Product[]>undefined-
product.listPlanspublicPromise<Product[]>undefined-
projectreadonlyProjectMethodsundefined-
publicpublic{ 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.createPublicAssetChatMessagepublicPromise<CreatePublicAssetChatMessageResponse>undefined-
public.createPublicChatMessagepublicPromise<ChatMessage>undefined-
public.createPublicTopicChatMessagepublicPromise<CreatePublicAssetChatMessageResponse>undefined-
public.downloadAssetspublicPromise<DownloadSignedUrlData[]>undefined-
public.getPublicAssetpublicPromise<PublicAssetResponse>undefined-
public.getPublicChatpublicPromise<Chat | null>undefined-
public.getPublicChatMessagespublicPromise<PublicChatMessagesResponse>undefined-
public.getPublicDocumentViewUrlpublicPromise<DocumentViewUrlResponse>undefined-
public.getPublicDownloadUrlpublicPromise<PublicDownloadUrlResponse>undefined-
public.getPublicEmbedFilespublicPromise<PublicEmbedFilesResponse>undefined-
public.getPublicFileSystempublicPromise<PublicFileSystemDetailsResponse>undefined-
public.getPublicItemspublicPromise<PublicFileSystemResponse>undefined-
public.getPublicItemsAtPathpublicPromise<PublicFileSystemResponse>undefined-
public.recordAccessActivitypublicPromise<void>undefined-
public.resolvePublicDownloadpublicPromise<ResolvePublicDownloadResponse>undefined-
refreshLockTimeoutMsreadonlynumberundefined-
refreshTokenStorageKeyreadonlystringundefined-
scratchpublic{ completeUpload: Promise<CompleteUploadResponse>; promote: Promise<PromoteResponse>; }undefined-
scratch.completeUploadpublicPromise<CompleteUploadResponse>undefined-
scratch.promotepublicPromise<PromoteResponse>undefined-
settingspublic{ 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.cleanupOrphanedSettingspublicPromise<{ message: string; removedCount: number; }>undefined-
settings.getAllResourceSettingspublicPromise<{ resourceSettings: ResourceSettings[]; }>undefined-
settings.getEffectiveSettingspublicPromise<EffectiveSettings>undefined-
settings.getResourceSettingspublicPromise< | ResourceSettings | { message: string; }>undefined-
settings.resetResourceSettingspublicPromise<{ message: string; }>undefined-
settings.updateResourceSettingspublicPromise<{ message: string; settings: ResourceSettings; }>undefined-
shortlinkpublic{ resolveShortLink: Promise<ResolveShortLinkResponse>; }undefined-
shortlink.resolveShortLinkpublicPromise<ResolveShortLinkResponse>undefined-
socketpublic{ 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.connectpublic(channel, options) => Promise<SocketChannel>undefinedConnect to a socket channel
socket.connectPublicpublic(publicToken, options) => Promise<SocketChannel>undefinedConnect to a public socket channel without authentication
socket.disconnectpublic(channel) => Promise<void>undefinedDisconnect from a socket channel
socket.disconnectAllpublic() => Promise<void>undefinedDisconnect from all channels
socket.emitpublic(channel, event, data?) => voidundefinedEmit an event to a connected channel
socket.emitWithAckpublic(channel, event, data, timeoutMs) => Promise<boolean>undefinedEmit 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.isConnectedpublic(channel) => booleanundefinedCheck if connected to a channel
socket.onReconnectpublic(channel, callback) => voidundefinedRegister 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.onReconnectFailedpublic(channel, callback) => voidundefinedRegister a callback for when Socket.IO exhausts all reconnection attempts
socket.subscribepublic<T>(channel, event, callback) => Promise<void>undefinedSubscribe to an event on a channel
socket.subscribePublicpublic<T>(publicToken, event, callback) => Promise<void>undefinedSubscribe to an event on a public channel Automatically connects to the public channel if not already connected
socket.unsubscribepublic(channel, event, callback?) => voidundefinedStop 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.
storagepublic{ getStorageChart: Promise<ChartDataResponse>; getStorageRecord: Promise<StorageRecord>; }undefined-
storage.getStorageChartpublicPromise<ChartDataResponse>undefined-
storage.getStorageRecordpublicPromise<StorageRecord>undefined-
subscriptionreadonlySubscriptionMethodsundefined-
supportChatpublic{ createAttachment: Promise<SupportChatCreateAttachmentResponse>; getTopic: Promise<SupportChatGetTopicResponse>; }undefined-
supportChat.createAttachmentpublicPromise<SupportChatCreateAttachmentResponse>undefined-
supportChat.getTopicpublicPromise<SupportChatGetTopicResponse>undefined-
supportTicketpublic{ createSupportTicket: Promise<SupportTicket>; getSupportTicket: Promise<SupportTicket>; getSupportTicketScopeOptions: Promise<SupportTicketScopeOptions>; listSupportTickets: Promise<SupportTicketListResponse>; }undefined-
supportTicket.createSupportTicketpublicPromise<SupportTicket>undefined-
supportTicket.getSupportTicketpublicPromise<SupportTicket>undefined-
supportTicket.getSupportTicketScopeOptionspublicPromise<SupportTicketScopeOptions>undefined-
supportTicket.listSupportTicketspublicPromise<SupportTicketListResponse>undefined-
tagpublic{ createTag: Promise<Tag>; deleteTag: Promise<Tag>; getTags: Promise<Tags>; updateTag: Promise<Tag>; }undefined-
tag.createTagpublicPromise<Tag>undefined-
tag.deleteTagpublicPromise<Tag>undefined-
tag.getTagspublicPromise<Tags>undefined-
tag.updateTagpublicPromise<Tag>undefined-
taskpublic{ 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.acknowledgeAllTaskspublicPromise<AcknowledgeAllTasksResponse>undefined-
task.acknowledgeTaskpublicPromise<Task>undefined-
task.bulkCreatepublicPromise<BulkCreateTasksResponse>undefined-
task.deleteTaskpublicPromise<void>undefined-
task.followTaskpublicPromise<Task>undefined-
task.getMyTaskspublicPromise<GetTasksResponse>undefined-
task.getTaskEventspublicPromise<GetTaskEventsResponse>undefined-
task.getTaskLinkspublicPromise<TaskLink[]>undefined-
task.getUnacknowledgedTaskCountpublicPromise<UnacknowledgedTaskCountResponse>undefined-
task.linkTaskpublicPromise<TaskLink>undefined-
task.tagTaskpublicPromise<Task>undefined-
task.unfollowTaskpublicPromise<Task>undefined-
task.unlinkTaskpublicPromise<void>undefined-
task.untagTaskpublicPromise<Task>undefined-
task.updateTaskDetailspublicPromise<Task>undefined-
task.updateTaskStatuspublicPromise<Task>undefined-
taskRelationpublic{ createTaskRelation: Promise<TaskRelation>; deleteTaskRelation: Promise<void>; getRelationsForChat: Promise<PaginatedTaskRelations>; getRelationsForMessage: Promise<PaginatedTaskRelations>; getTaskRelations: Promise<PaginatedTaskRelations>; }undefined-
taskRelation.createTaskRelationpublicPromise<TaskRelation>undefined-
taskRelation.deleteTaskRelationpublicPromise<void>undefined-
taskRelation.getRelationsForChatpublicPromise<PaginatedTaskRelations>undefined-
taskRelation.getRelationsForMessagepublicPromise<PaginatedTaskRelations>undefined-
taskRelation.getTaskRelationspublicPromise<PaginatedTaskRelations>undefined-
tokenpublic{ createToken: Promise<CreateTokenResponse>; deleteToken: Promise<void>; listTokens: Promise<TokenSummary[]>; updateTokenScopes: Promise<TokenSummary>; }undefined-
token.createTokenpublicPromise<CreateTokenResponse>undefined-
token.deleteTokenpublicPromise<void>undefined-
token.listTokenspublicPromise<TokenSummary[]>undefined-
token.updateTokenScopespublicPromise<TokenSummary>undefined-
tokenExpiryBufferSecondsreadonlynumberundefined-
tokenRefreshMaxWaitMsreadonlynumberundefined-
tokenRefreshRetryDelayMsreadonlynumberundefined-
tokenStorageKeyreadonlystringundefined-
userreadonlyUserMethodsundefined-
userFeedpublic{ dismissAll: Promise<{ dismissed: number; }>; getFeed: Promise<CursorPaginatedUserFeed>; getReadState: Promise<ReadState>; getSummary: Promise<UserFeedSummary>; markCaughtUp: Promise<ReadState>; setEntryState: Promise<UserFeedEntry>; }undefined-
userFeed.dismissAllpublicPromise<{ dismissed: number; }>undefined-
userFeed.getFeedpublicPromise<CursorPaginatedUserFeed>undefined-
userFeed.getReadStatepublicPromise<ReadState>undefined-
userFeed.getSummarypublicPromise<UserFeedSummary>undefined-
userFeed.markCaughtUppublicPromise<ReadState>undefined-
userFeed.setEntryStatepublicPromise<UserFeedEntry>undefined-
versionpublic{ getCommitHash: Promise<CommitResponse>; getHealth: Promise<HealthStatus>; }undefined-
version.getCommitHashpublicPromise<CommitResponse>undefined-
version.getHealthpublicPromise<HealthStatus>undefined-
webhookpublic{ 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.createWebhookpublicPromise<CreateWebhookResponse>undefined-
webhook.deleteWebhookpublicPromise<void>undefined-
webhook.getWebhookpublicPromise<WebhookSubscription>undefined-
webhook.listWebhookDeliveriespublicPromise<ListDeliveriesResponse>undefined-
webhook.listWebhookspublicPromise<WebhookSubscription[]>undefined-
webhook.replayWebhookDeliverypublicPromise<{ attempt: WebhookAttempt; }>undefined-
webhook.rotateWebhookSecretpublicPromise<RotateWebhookSecretResponse>undefined-
webhook.testWebhookpublicPromise<TestWebhookResponse>undefined-
webhook.updateWebhookpublicPromise<WebhookSubscription>undefined-
websocketURL?readonlystringundefined-
workspacereadonlyWorkspaceMethodsundefined-

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
ParameterTypeDescription
...argsany[]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.

NameType
entries{ hasData: boolean; hasPendingPromise: boolean; key: string; timestamp: number; }[]
sizenumber
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.

NameType
accessstring | null
refreshstring | 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

SDKVersionInfo

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
ParameterType
sessionNuramaSession | 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

PropertyTypeInherited from
data?any-
messagestringError.message
namestringError.name
stack?stringError.stack
status?number-

AssetMethods

Extends

Methods

cancelPruneOriginal()
cancelPruneOriginal(assetId): Promise<Asset>;

Cancels a requested prune before it runs. Needs canPruneAsset.

Parameters
ParameterTypeDescription
assetIdstringThe ID of the asset.
Returns

Promise<Asset>

The asset, with its original back to stored.

Inherited from
ReturnType.cancelPruneOriginal
cancelReattachOriginal()
cancelReattachOriginal(assetId): Promise<Asset>;

Cancels a re-attach whose upload has not completed; the original is pruned again.

Parameters
ParameterTypeDescription
assetIdstringThe ID of the asset.
Returns

Promise<Asset>

The asset.

Inherited from
ReturnType.cancelReattachOriginal
cleanupUploadSessions()
cleanupUploadSessions(projectId, olderThanMs?): void;

Clean up old upload sessions for a project

Parameters
ParameterTypeDescription
projectIdstringThe project ID
olderThanMs?numberRemove sessions older than this (default: 24 hours)
Returns

void

Inherited from
ReturnType.cleanupUploadSessions
completeCustomThumbnailUpload()
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
ParameterType
assetIdstring
data{ key: string; parts: { ETag: string; PartNumber: number; }[]; uploadId: string; }
data.keystring
data.parts{ ETag: string; PartNumber: number; }[]
data.uploadIdstring
Returns

Promise<{ key: string; status: string; }>

Inherited from
ReturnType.completeCustomThumbnailUpload
completeReattachOriginal()
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
ParameterTypeDescription
assetIdstringThe ID of the asset.
data{ key: string; parts: { ETag: string; PartNumber: number; }[]; uploadId: string; }The completed upload.
data.keystring-
data.parts{ ETag: string; PartNumber: number; }[]-
data.uploadIdstring-
Returns

Promise<Asset>

The asset, restoring while the file is verified.

Inherited from
ReturnType.completeReattachOriginal
completeUpload()
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
ParameterTypeDescription
uploadDataCompleteMultipartUploadDataData including key, uploadId, parts, and assetId.
Returns

Promise<any>

S3 completion response.

Inherited from
ReturnType.completeUpload
completeUploadSession()
completeUploadSession(projectId, sessionId): void;

Mark an upload session as completed

Parameters
ParameterTypeDescription
projectIdstringThe project ID
sessionIdstringThe session ID
Returns

void

Inherited from
ReturnType.completeUploadSession
createPublicLink(assetId, data): Promise<PublicAssetLink>;

Create a public download link for an asset.

Parameters
ParameterTypeDescription
assetIdstringThe asset ID.
data{ mode?: PublicAssetLinkMode; projectId: string; validity?: number; }Link creation data.
data.mode?PublicAssetLinkMode-
data.projectIdstringThe project ID.
data.validity?numberLink validity in milliseconds.
Returns

Promise<PublicAssetLink>

The created public link.

Inherited from
ReturnType.createPublicLink
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
ParameterTypeDescription
assetIdstringThe ID of the asset to create a short link for.
data?CreateAssetShortLinkDataOptional data including visibility context.
Returns

Promise<CreateAssetShortLinkResponse>

The short link object and short URL.

Inherited from
ReturnType.createShortLink
deleteAsset()
deleteAsset(assetId): Promise<AssetWithChats>;

Deletes an asset (marks for deletion).

Parameters
ParameterTypeDescription
assetIdstringThe ID of the asset to delete.
Returns

Promise<AssetWithChats>

Inherited from
ReturnType.deleteAsset
disablePublicLink(assetId, linkId): Promise<PublicAssetLink>;

Disable a public download link.

Parameters
ParameterTypeDescription
assetIdstringThe asset ID.
linkIdstringThe link ID.
Returns

Promise<PublicAssetLink>

The disabled public link.

Inherited from
ReturnType.disablePublicLink
downloadAssets()
downloadAssets(assetIds): Promise<DownloadAssetsResponse>;

Generates signed download URLs for the original files of specified assets.

Parameters
ParameterTypeDescription
assetIdsstring[]An array of asset IDs.
Returns

Promise<DownloadAssetsResponse>

Array of download URL results.

Inherited from
ReturnType.downloadAssets
getAsset()
getAsset(assetId, params?): Promise<AssetWithChats>;

Retrieves a specific asset by its ID with optional chat data.

Parameters
ParameterTypeDescription
assetIdstringThe ID of the asset.
params?GetAssetParamsOptional parameters for chat data inclusion.
Returns

Promise<AssetWithChats>

The asset object with optional chat data.

Inherited from
ReturnType.getAsset
getAssetAccessActivity()
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
ParameterType
assetIdstring
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.getAssetAccessActivity
getAssetPage()
getAssetPage(assetId, params?): Promise<AssetPageResponse>;

Gets the page number an asset appears on based on specified filters and sorting.

Parameters
ParameterTypeDescription
assetIdstringThe ID of the asset to find the page for.
params?GetAssetPageParamsQuery parameters for sorting, filtering, and pagination limit.
Returns

Promise<AssetPageResponse>

Object containing the page number.

Inherited from
ReturnType.getAssetPage
getAssetReferences()
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
ParameterTypeDescription
assetIdstringThe ID of the asset.
Returns

Promise<AssetReferences>

The asset's references.

Inherited from
ReturnType.getAssetReferences
getCustomThumbnailUploadUrl()
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:

  1. multipartUpload(file, response.urls, response.key, response.uploadId)
  2. completeCustomThumbnailUpload({ assetId, key, uploadId, parts })
  3. wait for the assetFileUpdate websocket event
Parameters
ParameterType
assetIdstring
data{ fileName: string; mimeType: string; sizeInMB: number; }
data.fileNamestring
data.mimeTypestring
data.sizeInMBnumber
Returns

Promise<{ assetId: string; expires: number; fileName: string; key: string; mimeType: string; status: string; uploadId: string; urls: string[]; }>

Inherited from
ReturnType.getCustomThumbnailUploadUrl
getDocumentViewUrl()
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
ParameterTypeDescription
assetIdstringThe document asset's ID.
Returns

Promise<DocumentViewUrlResponse>

Signed URL, expiry and page count.

Inherited from
ReturnType.getDocumentViewUrl
getFile()
getFile(assetId, fileId): Promise<File>;

Retrieves a specific file from an asset.

Parameters
ParameterTypeDescription
assetIdstringThe ID of the asset.
fileIdstringThe ID of the file.
Returns

Promise<File>

The file object.

Inherited from
ReturnType.getFile
getFilesByFunctionType()
getFilesByFunctionType(assetId, functionType): Promise<File[]>;

Retrieves files of a specific function type from an asset.

Parameters
ParameterTypeDescription
assetIdstringThe ID of the asset.
functionTypestringThe function type of the files (e.g., 'thumbnail', 'original').
Returns

Promise<File[]>

An array of file objects.

Inherited from
ReturnType.getFilesByFunctionType
getOriginal()
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
ParameterTypeDescription
assetIdstringThe ID of the asset.
Returns

Promise<AssetOriginalStatus>

The original's state.

Inherited from
ReturnType.getOriginal
getOriginalHistory()
getOriginalHistory(assetId): Promise<{
  results: AssetOriginalHistoryEntry[];
}>;

The history of an asset's original, newest first. Needs canGetAssetOriginal.

Parameters
ParameterTypeDescription
assetIdstringThe ID of the asset.
Returns

Promise<{ results: AssetOriginalHistoryEntry[]; }>

The history.

Inherited from
ReturnType.getOriginalHistory
getPublicLinks(assetId, options?): Promise<{
  results: PublicAssetLink[];
}>;

Get all public download links for an asset.

Parameters
ParameterTypeDescription
assetIdstringThe asset ID.
options?{ bypassCache?: boolean; }-
options.bypassCache?boolean-
Returns

Promise<{ results: PublicAssetLink[]; }>

The public links.

Inherited from
ReturnType.getPublicLinks
getUploadSession()
getUploadSession(projectId, sessionId): UploadSessionData | null;

Get a specific upload session

Parameters
ParameterTypeDescription
projectIdstringThe project ID
sessionIdstringThe session ID
Returns

UploadSessionData | null

Upload session data or null if not found

Inherited from
ReturnType.getUploadSession
getUploadSessions()
getUploadSessions(projectId): UploadSessionData[];

Get all active upload sessions for a project

Parameters
ParameterTypeDescription
projectIdstringThe project ID to get sessions for
Returns

UploadSessionData[]

Array of upload session data

Inherited from
ReturnType.getUploadSessions
hasActiveUploads()
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
ParameterTypeDescription
staleMs?numberMax age of the last progress update that still counts as active (default: 2 minutes)
Returns

boolean

Inherited from
ReturnType.hasActiveUploads
multipartUpload()
multipartUpload(
   file, 
   signedUrls, 
   key, 
   uploadId, 
   options?
): Promise<MultipartUploadResult>;

Uploads a file using multipart upload with the provided signed URLs

Parameters
ParameterTypeDescription
filestring | File | Blob | Buffer<ArrayBufferLike>The file to upload (File/Blob in browser, Buffer/string path in Node.js)
signedUrlsstring[]Array of signed URLs for each part
keystringThe S3 key for the upload
uploadIdstringThe S3 uploadId for the multipart upload
optionsMultipartUploadOptionsUpload options
Returns

Promise<MultipartUploadResult>

The completed upload data

Inherited from
ReturnType.multipartUpload
offUploadSessionMessage()
offUploadSessionMessage(listenerId): void;

Unregister a cross-tab upload session message listener

Parameters
ParameterTypeDescription
listenerIdstringUnique listener ID
Returns

void

Inherited from
ReturnType.offUploadSessionMessage
onUploadSessionMessage()
onUploadSessionMessage(listenerId, callback): void;

Register a listener for cross-tab upload session messages

Parameters
ParameterTypeDescription
listenerIdstringUnique listener ID
callback(message) => voidCallback function to handle messages
Returns

void

Inherited from
ReturnType.onUploadSessionMessage
promoteAttachmentToProject()
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
ParameterType
assetIdstring
payload{ fileName?: string; projectId: string; }
payload.fileName?string
payload.projectIdstring
Returns

Promise<{ asset: Asset; deduped: boolean; }>

Inherited from
ReturnType.promoteAttachmentToProject
pruneOriginal()
pruneOriginal(assetId): Promise<Asset>;

Requests that an asset's original be pruned once the undo window has passed (pruneAfter). Needs canPruneAsset.

Parameters
ParameterTypeDescription
assetIdstringThe ID of the asset.
Returns

Promise<Asset>

The asset, now waiting to be pruned.

Inherited from
ReturnType.pruneOriginal
reactivatePublicLink(
   assetId, 
   linkId, 
   data?
): Promise<PublicAssetLink>;

Reactivate a disabled/expired public download link.

Parameters
ParameterTypeDescription
assetIdstringThe asset ID.
linkIdstringThe link ID.
data?{ validity?: number; }Reactivation data.
data.validity?numberNew validity in milliseconds.
Returns

Promise<PublicAssetLink>

The reactivated public link.

Inherited from
ReturnType.reactivatePublicLink
reattachOriginal()
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
ParameterTypeDescription
assetIdstringThe ID of the asset.
filestring | File | Blob | Buffer<ArrayBufferLike>The file.
options{ abortSignal?: AbortSignal; checksum?: string; fileName: string; onProgress?: (progress) => void; sizeInBytes: number; }-
options.abortSignal?AbortSignal-
options.checksum?stringIts upload fingerprint, to refuse a wrong file before sending it.
options.fileNamestringThe file's name.
options.onProgress?(progress) => void-
options.sizeInBytesnumberIts size.
Returns

Promise<Asset>

The asset, restoring while the file is verified.

Inherited from
ReturnType.reattachOriginal
recordAccessActivity()
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
ParameterType
assetIdstring
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.recordAccessActivity
removeCustomThumbnail()
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
ParameterType
assetIdstring
Returns

Promise<Asset>

Inherited from
ReturnType.removeCustomThumbnail
removeUploadSession()
removeUploadSession(projectId, sessionId): void;

Remove an upload session

Parameters
ParameterTypeDescription
projectIdstringThe project ID
sessionIdstringThe session ID
Returns

void

Inherited from
ReturnType.removeUploadSession
repairAssets()
repairAssets(assetIds): Promise<RepairAssetsResponse>;

Attempts to repair assets (e.g., regenerate signed URLs for pending uploads).

Parameters
ParameterTypeDescription
assetIdsstring[]An array of asset IDs to repair.
Returns

Promise<RepairAssetsResponse>

Array of repair results.

Inherited from
ReturnType.repairAssets
setKeepOriginal()
setKeepOriginal(assetId, keepOriginal): Promise<Asset>;

Exempts an asset from pruning, or lifts the exemption. Needs canPruneAsset.

Parameters
ParameterTypeDescription
assetIdstringThe ID of the asset.
keepOriginalbooleanTrue to exempt the asset.
Returns

Promise<Asset>

The asset.

Inherited from
ReturnType.setKeepOriginal
startReattachOriginal()
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
ParameterTypeDescription
assetIdstringThe ID of the asset.
data{ checksum?: string; fileName: string; sizeInBytes: number; }The file.
data.checksum?string-
data.fileNamestring-
data.sizeInBytesnumber-
Returns

Promise<AssetOriginalReattachStart>

The asset, now restoring, and the upload's links.

Inherited from
ReturnType.startReattachOriginal
tagAsset()
tagAsset(assetId, tagData): Promise<AssetWithChats>;

Tags an asset with a specific tag.

Parameters
ParameterTypeDescription
assetIdstringThe ID of the asset to tag.
tagDataTagAssetDataData containing the tag ID.
Returns

Promise<AssetWithChats>

The updated asset object.

Inherited from
ReturnType.tagAsset
untagAsset()
untagAsset(assetId, untagData): Promise<AssetWithChats>;

Untags an asset by removing a specific tag.

Parameters
ParameterTypeDescription
assetIdstringThe ID of the asset to untag.
untagDataUntagAssetDataData containing the tag ID to remove.
Returns

Promise<AssetWithChats>

The updated asset object.

Inherited from
ReturnType.untagAsset
updateAsset()
updateAsset(assetId, updateData): Promise<AssetWithChats>;

Updates an asset.

Parameters
ParameterTypeDescription
assetIdstringThe ID of the asset to update.
updateDataUpdateAssetDataData to update (e.g., name, meta, tags, folderId).
Returns

Promise<AssetWithChats>

The updated asset object.

Inherited from
ReturnType.updateAsset
updatePublicLink(
   assetId, 
   linkId, 
   data
): Promise<PublicAssetLink>;

Update a public download link (extend expiration or change status).

Parameters
ParameterTypeDescription
assetIdstringThe asset ID.
linkIdstringThe 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.updatePublicLink

AuthMethods

Extends

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
ParameterTypeDescription
currentPasswordstringThe current password for verification.
newPasswordstringThe new password.
mfaToken?stringMFA token (required if MFA is enabled).
Returns

Promise<void>

Promise resolving when complete.

Inherited from
ReturnType.changePassword
deletePasskey()
deletePasskey(passkeyId): Promise<void>;

Removes one of the authenticated user's passkeys.

Parameters
ParameterTypeDescription
passkeyIdstringThe passkey's id.
Returns

Promise<void>

Promise resolving when complete.

Inherited from
ReturnType.deletePasskey
disableMfa()
disableMfa(mfaToken): Promise<void>;

Disables multi-factor authentication for the authenticated user. Requires a current valid MFA token for confirmation.

Parameters
ParameterTypeDescription
mfaTokenstringThe current MFA token code.
Returns

Promise<void>

Promise resolving when complete.

Inherited from
ReturnType.disableMfa
enableMfa()
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.enableMfa
exchangeOAuthCode()
exchangeOAuthCode(code, __namedParameters?): Promise<OAuthExchangeResponse>;

Exchanges a one-time sign-in code for tokens and stores them.

Parameters
ParameterTypeDescription
codestringThe 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.exchangeOAuthCode
forgotPassword()
forgotPassword(email): Promise<void>;

Forgets a user's password.

Parameters
ParameterTypeDescription
emailstringThe user's email address.
Returns

Promise<void>

Inherited from
ReturnType.forgotPassword
getLinkedOAuthProviders()
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.getLinkedOAuthProviders
getPasskeyLoginOptions()
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
ParameterTypeDescription
origin?stringThe 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.getPasskeyLoginOptions
getPasskeyRegistrationOptions()
getPasskeyRegistrationOptions(proof?): Promise<PasskeyCredentialOptions>;

Gets the options for the browser's "create a passkey" prompt, after confirming who is asking.

Parameters
ParameterTypeDescription
proofPasskeyRegistrationProofThe 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.getPasskeyRegistrationOptions
linkOAuthProvider()
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
ParameterTypeDescription
providerOAuthProviderThe OAuth provider to link (google, apple, microsoft, adobe).
Returns

Promise<LoginRegisterResponse>

Promise resolving to user data with updated linked providers.

Inherited from
ReturnType.linkOAuthProvider
listPasskeys()
listPasskeys(): Promise<Passkey[]>;

Lists the authenticated user's passkeys, oldest first.

Returns

Promise<Passkey[]>

Promise resolving to the user's passkeys.

Inherited from
ReturnType.listPasskeys
lockAccount()
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
ParameterTypeDescription
tokenstringThe lock account token from the password changed email.
Returns

Promise<void>

Promise resolving when the account is locked.

Inherited from
ReturnType.lockAccount
login()
login(credentials): Promise<LoginRegisterResponse>;

Logs in a user.

Parameters
ParameterTypeDescription
credentialsLoginCredentialsLogin credentials.
Returns

Promise<LoginRegisterResponse>

Object containing user info and tokens (or MFA challenge token).

Inherited from
ReturnType.login
loginDesktopWithPasskey()
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
ParameterTypeDescription
credentialPasskeyCredentialResponseThe WebAuthn library's AuthenticationResponseJSON.
handoffOmit<PasskeyDesktopLoginRequest, "credential">The state and PKCE codeChallenge the desktop app made.
Returns

Promise<PasskeyDesktopLoginResponse>

Promise resolving to the one-time code.

Inherited from
ReturnType.loginDesktopWithPasskey
loginWithPasskey()
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
ParameterTypeDescription
credentialPasskeyCredentialResponseThe WebAuthn library's AuthenticationResponseJSON.
origin?stringFrom a native app: the origin passed to getPasskeyLoginOptions.
Returns

Promise<LoginRegisterResponse>

Promise resolving to the user and tokens.

Inherited from
ReturnType.loginWithPasskey
logout()
logout(refreshToken): Promise<void>;

Logs out a user.

Parameters
ParameterTypeDescription
refreshTokenstringThe refresh token to invalidate.
Returns

Promise<void>

Inherited from
ReturnType.logout
refreshTokens()
refreshTokens(refreshToken?): Promise<RefreshResponse>;

Refreshes user tokens.

Parameters
ParameterTypeDescription
refreshToken?stringThe refresh token.
Returns

Promise<RefreshResponse>

Object containing new access and refresh tokens.

Inherited from
ReturnType.refreshTokens
register()
register(userData): Promise<LoginRegisterResponse>;

Registers a new user.

Parameters
ParameterTypeDescription
userDataRegisterUserDataUser registration data.
Returns

Promise<LoginRegisterResponse>

Object containing user info and tokens.

Inherited from
ReturnType.register
registerGuest()
registerGuest(data): Promise<void>;

Registers a guest account for public chat participation. Always returns void (204) regardless of outcome for anti-enumeration.

Parameters
ParameterTypeDescription
data{ color?: string; displayName: string; email: string; publicToken: string; }Guest registration data (email, displayName, optional approved color, publicToken).
data.color?string-
data.displayNamestring-
data.emailstring-
data.publicTokenstring-
Returns

Promise<void>

Inherited from
ReturnType.registerGuest
registerPasskey()
registerPasskey(credential, name?): Promise<Passkey>;

Saves the passkey the browser created.

Parameters
ParameterTypeDescription
credentialPasskeyCredentialResponseThe WebAuthn library's RegistrationResponseJSON.
name?stringOptional name to tell it apart, e.g. "MacBook".
Returns

Promise<Passkey>

Promise resolving to the saved passkey.

Inherited from
ReturnType.registerPasskey
renamePasskey()
renamePasskey(passkeyId, name): Promise<Passkey>;

Renames one of the authenticated user's passkeys.

Parameters
ParameterTypeDescription
passkeyIdstringThe passkey's id.
namestringThe new name.
Returns

Promise<Passkey>

Promise resolving to the renamed passkey.

Inherited from
ReturnType.renamePasskey
resendVerification()
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
ParameterTypeDescription
emailstringThe email address to resend the verification link to.
Returns

Promise<void>

Inherited from
ReturnType.resendVerification
resetPassword()
resetPassword(params): Promise<void>;

Resets a user's password.

Parameters
ParameterTypeDescription
paramsResetPasswordDataInput parameters.
Returns

Promise<void>

Promise resolving when complete.

Inherited from
ReturnType.resetPassword
sendVerificationEmail()
sendVerificationEmail(): Promise<void>;

Sends a verification email to the authenticated user.

Returns

Promise<void>

Promise resolving when complete.

Inherited from
ReturnType.sendVerificationEmail
setPassword()
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
ParameterTypeDescription
passwordstringThe password to set.
mfaToken?stringMFA token (required if MFA is enabled).
Returns

Promise<void>

Promise resolving when complete.

Inherited from
ReturnType.setPassword
unlinkOAuthProvider()
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
ParameterTypeDescription
providerOAuthProviderThe OAuth provider to unlink (google, apple, microsoft, adobe).
Returns

Promise<void>

Promise resolving when complete.

Inherited from
ReturnType.unlinkOAuthProvider
upgradeGuest()
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
ParameterTypeDescription
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.passwordstring-
data.userName?string-
Returns

Promise<{ user: User; }>

Promise resolving to the upgraded user data.

Inherited from
ReturnType.upgradeGuest
verifyBackupCode()
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
ParameterTypeDescription
backupCodestringThe backup code (8-character hex string).
Returns

Promise<MFAVerifyResponse>

Promise resolving to user/token data upon successful verification.

Inherited from
ReturnType.verifyBackupCode
verifyEmail()
verifyEmail(token): Promise<void>;

Verifies a user's email using the provided token.

Parameters
ParameterTypeDescription
tokenstringThe email verification token.
Returns

Promise<void>

Promise resolving when complete.

Inherited from
ReturnType.verifyEmail
verifyGuest()
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
ParameterTypeDescription
tokenstringThe guest verification token.
Returns

Promise<LoginRegisterResponse>

Promise resolving to user data and auth tokens.

Inherited from
ReturnType.verifyGuest
verifyMfa()
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
ParameterTypeDescription
mfaTokenstringThe MFA token code.
Returns

Promise<MFAVerifyResponse>

Promise resolving to user/token data upon successful verification.

Inherited from
ReturnType.verifyMfa

NuramaClientOptions

Properties

PropertyTypeDescription
apiKey?stringLong-lived API key to use for every request (e.g., a bot API key starting with nrm_bot_). When set, the client skips JWT refresh logic and uses the key as the bearer token.
browserMode?booleanWhether to run in browser mode (uses localStorage for token storage). Default: false
cacheDurationSeconds?numberCache duration in seconds. Default: 5
debug?booleanEnable debug logging. Default: false
enableCache?booleanEnable response caching. Default: true
fetch?(input, init?) => Promise<Response>Custom fetch implementation. If not provided, will use global fetch
invalidateCacheOnMutation?booleanAfter a successful write (POST/PUT/PATCH/DELETE) to a resource, evict cached GET responses for that resource so the next read returns fresh data (read-after-write consistency). Default: true.
onMaintenance?() => voidInvoked when the API returns a { error: 'maintenance' } body on a 418 or 503 — i.e. the site is in a maintenance window (the edge rule returns this to non-allowlisted clients; a Cloudflare WAF block can only be a 4xx, so 418 — a guaranteed-unused sentinel — is used there, while a Worker/origin can return 503). Lets an already-loaded (cached) SPA surface a maintenance message instead of failing silently.
onTokensChanged?(session) => voidInvoked whenever the client's tokens change (login, MFA completion, refresh, logout, or a failed refresh clearing the session). Lets non-browser hosts (e.g. React Native) persist the session in their own secure storage; pair with restoreSession() on startup. Not called by restoreSession() itself.
onUnauthorized?(reason?) => voidCallback invoked when authentication fails and re-login is required (e.g., refresh token expired/missing). reason.type carries the backend error type when available — notably emailVerificationRequired when the refresh was rejected because the user's email-verification grace period has expired, so callers can prompt verification instead of a plain logout.
refreshLockTimeoutMs?numberTimeout in ms for the refresh lock to prevent multiple simultaneous refreshes. Default: 5000
refreshTokenStorageKey?stringKey used to store the refresh token in storage. Default: 'nurama_refresh_token'
tokenExpiryBufferSeconds?numberNumber of seconds before token expiry to trigger refresh. Default: 300 (5 minutes)
tokenRefreshMaxWaitMs?numberMaximum time in ms to wait for token refresh. Default: 10000
tokenRefreshRetryDelayMs?numberDelay in ms between token refresh retries. Default: 1000
tokenStorageKey?stringKey used to store the access token in storage. Default: 'nurama_token'
websocketURL?stringWebSocket server URL. If not provided, will use the baseURL

NuramaSession

A persisted session: the token pair plus their ISO expiry timestamps.

Properties

PropertyType
accessTokenstring | null
accessTokenExpirystring | null
refreshTokenstring | null
refreshTokenExpirystring | null

ProjectMethods

Extends

Methods

addItemsToPublicFileSystem()
addItemsToPublicFileSystem(
   projectId, 
   publicId, 
   addItemsData
): Promise<PublicFileSystemResponse>;

Adds additional items to an existing public file system.

Parameters
ParameterTypeDescription
projectIdstringThe ID of the project.
publicIdstringThe ID of the public file system.
addItemsDataAddItemsToPublicFileSystemDataData for adding items.
Returns

Promise<PublicFileSystemResponse>

The updated public file system object.

Inherited from
ReturnType.addItemsToPublicFileSystem
addItemsToSubmission()
addItemsToSubmission(
   projectId, 
   submissionId, 
   addItemsData
): Promise<ChatSubmission>;

Adds items to an existing submission.

Parameters
ParameterTypeDescription
projectIdstringThe ID of the project.
submissionIdstringThe ID of the submission.
addItemsDataAddItemsToSubmissionDataData for adding items to the submission.
Returns

Promise<ChatSubmission>

The updated submission object.

Inherited from
ReturnType.addItemsToSubmission
cancelPruneOriginals()
cancelPruneOriginals(projectId, selection): Promise<AssetPruneCancelResult>;

Cancels every waiting prune in the selection. Needs canPruneAsset on the project.

Parameters
ParameterTypeDescription
projectIdstringThe project ID.
selectionAssetPruneSelectionAsset ids, creator-tree paths, or both.
Returns

Promise<AssetPruneCancelResult>

The cancelled assets, and those with nothing waiting.

Inherited from
ReturnType.cancelPruneOriginals
copyItemsToPath()
copyItemsToPath(
   projectId, 
   visibility, 
   copyData
): Promise<{
  count: number;
}>;

Copies items to a specific path within a project.

Parameters
ParameterTypeDescription
projectIdstringThe ID of the project.
visibility"creator" | "reviewer"The visibility context ('creator' or 'reviewer').
copyDataCopyItemsDataData for copying items.
Returns

Promise<{ count: number; }>

Object containing the count of copied items.

Inherited from
ReturnType.copyItemsToPath
copyPublicItemsAtPath()
copyPublicItemsAtPath(
   projectId, 
   token, 
   copyData
): Promise<{
  count: number;
}>;

Copies items within a public file system (authenticated management).

Parameters
ParameterTypeDescription
projectIdstringThe ID of the project.
tokenstringThe public access token.
copyDataCopyPublicItemsDataData for copying items.
Returns

Promise<{ count: number; }>

Object containing the count of copied items.

Inherited from
ReturnType.copyPublicItemsAtPath
copySubmissionItems()
copySubmissionItems(
   projectId, 
   submissionId, 
   copyData
): Promise<{
  count: number;
}>;

Copies items within a submission.

Parameters
ParameterTypeDescription
projectIdstringThe ID of the project.
submissionIdstringThe ID of the submission.
copyDataCopySubmissionItemsDataData for copying items.
Returns

Promise<{ count: number; }>

Object containing the count of copied items.

Inherited from
ReturnType.copySubmissionItems
createAssets()
createAssets(projectId, fileUploadBody): Promise<any[]>;

Create assets within a project and return their signed links for upload.

Parameters
ParameterTypeDescription
projectIdstringThe ID of the project.
fileUploadBodyProjectFileUploadBodyList 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.createAssets
createFolder()
createFolder(
   projectId, 
   visibility, 
   folderData
): Promise<Folder>;

Creates a folder within a project with file system integration.

Parameters
ParameterTypeDescription
projectIdstringThe ID of the project.
visibility"creator" | "reviewer"The visibility context ('creator' or 'reviewer').
folderDataCreateFolderDataData for creating the folder.
Returns

Promise<Folder>

The created folder object.

Inherited from
ReturnType.createFolder
createLogo(projectId, logoData): Promise<any>;

Creates a new logo asset for a project.

Parameters
ParameterTypeDescription
projectIdstringThe ID of the project.
logoDataLogoUploadDataFile metadata for the logo.
Returns

Promise<any>

Object containing signed URL data and updated project info.

Inherited from
ReturnType.createLogo
createProject()
createProject(projectData): Promise<Project>;

Creates a new project.

Parameters
ParameterTypeDescription
projectDataCreateProjectDataData for the new project.
Returns

Promise<Project>

The created project object.

Inherited from
ReturnType.createProject
createProjectPublicAssetChatMessage()
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
ParameterTypeDescription
projectIdstringThe ID of the project.
tokenstringThe public access token.
assetIdstringThe ID of the asset.
dataCreatePublicChatMessageRequestMessage data.
Returns

Promise<CreatePublicAssetChatMessageResponse>

The chat and created message.

Inherited from
ReturnType.createProjectPublicAssetChatMessage
createProjectPublicChatMessage()
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
ParameterTypeDescription
projectIdstringThe ID of the project.
tokenstringThe public access token.
chatIdstringThe ID of the chat.
dataCreatePublicChatMessageRequestMessage data.
Returns

Promise<ChatMessage>

The created message.

Inherited from
ReturnType.createProjectPublicChatMessage
createProjectPublicTopicChatMessage()
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
ParameterTypeDescription
projectIdstringThe ID of the project.
tokenstringThe public access token.
dataCreatePublicChatMessageRequestMessage data.
Returns

Promise<CreatePublicAssetChatMessageResponse>

The chat and created message.

Inherited from
ReturnType.createProjectPublicTopicChatMessage
createPublicFileSystem()
createPublicFileSystem(projectId, publicFileSystemData): Promise<PublicFileSystemResponse>;

Creates a public file system with a secure token for sharing project assets publicly.

Parameters
ParameterTypeDescription
projectIdstringThe ID of the project.
publicFileSystemDataCreatePublicFileSystemDataData for creating the public file system.
Returns

Promise<PublicFileSystemResponse>

The created public file system object.

Inherited from
ReturnType.createPublicFileSystem
createPublicFolder()
createPublicFolder(
   projectId, 
   token, 
   folderData
): Promise<Folder>;

Creates a folder inside a public file system (authenticated management).

Parameters
ParameterTypeDescription
projectIdstringThe ID of the project.
tokenstringThe public access token.
folderDataCreateFolderDataData for creating the folder (name, color, basePath).
Returns

Promise<Folder>

The created folder object.

Inherited from
ReturnType.createPublicFolder
createSubmission()
createSubmission(projectId, submissionData): Promise<ChatSubmission>;

Creates a new submission for a project.

Parameters
ParameterTypeDescription
projectIdstringThe ID of the project.
submissionDataCreateSubmissionDataData for the submission.
Returns

Promise<ChatSubmission>

The created submission object.

Inherited from
ReturnType.createSubmission
createSubmissionFolder()
createSubmissionFolder(
   projectId, 
   submissionId, 
   folderData
): Promise<Folder>;

Creates a folder within a submission.

Parameters
ParameterTypeDescription
projectIdstringThe ID of the project.
submissionIdstringThe ID of the submission.
folderDataCreateSubmissionFolderDataData for creating the folder.
Returns

Promise<Folder>

The created folder object.

Inherited from
ReturnType.createSubmissionFolder
deleteItemsAtPath()
deleteItemsAtPath(
   projectId, 
   visibility, 
   deleteData
): Promise<{
  count: number;
}>;

Deletes items at a specific path within a project.

Parameters
ParameterTypeDescription
projectIdstringThe ID of the project.
visibility"creator" | "reviewer"The visibility context ('creator' or 'reviewer').
deleteDataDeleteItemsDataData for deleting items.
Returns

Promise<{ count: number; }>

Object containing the count of deleted items.

Inherited from
ReturnType.deleteItemsAtPath
deleteProject()
deleteProject(projectId): Promise<void>;

Deletes a project (marks for deletion).

Parameters
ParameterTypeDescription
projectIdstringThe ID of the project to delete.
Returns

Promise<void>

The deleted public release record.

Inherited from
ReturnType.deleteProject
deletePublicFileSystem()
deletePublicFileSystem(projectId, publicId): Promise<PublicFileSystemResponse>;

Deletes a public file system and invalidates its access token.

Parameters
ParameterTypeDescription
projectIdstringThe ID of the project.
publicIdstringThe ID of the public file system.
Returns

Promise<PublicFileSystemResponse>

The deleted public release record.

Inherited from
ReturnType.deletePublicFileSystem
deletePublicItemsAtPath()
deletePublicItemsAtPath(
   projectId, 
   token, 
   deleteData
): Promise<{
  count: number;
}>;

Deletes items from a public file system (authenticated management).

Parameters
ParameterTypeDescription
projectIdstringThe ID of the project.
tokenstringThe public access token.
deleteDataDeletePublicItemsDataData for deleting items.
Returns

Promise<{ count: number; }>

Object containing the count of deleted items.

Inherited from
ReturnType.deletePublicItemsAtPath
deleteSubmissionItems()
deleteSubmissionItems(
   projectId, 
   submissionId, 
   deleteData
): Promise<{
  count: number;
}>;

Deletes items within a submission.

Parameters
ParameterTypeDescription
projectIdstringThe ID of the project.
submissionIdstringThe ID of the submission.
deleteDataDeleteSubmissionItemsDataData for deleting items.
Returns

Promise<{ count: number; }>

Object containing the count of deleted items.

Inherited from
ReturnType.deleteSubmissionItems
getAssets()
getAssets(
   projectId, 
   visibility, 
   params?
): Promise<PaginatedResponse<Asset>>;

Lists a project's assets for one visibility tier. creator requires canGetCreatorAssets; reviewer requires canGetReviewerAssets.

Parameters
ParameterTypeDescription
projectIdstringThe project ID.
visibility"creator" | "reviewer"Which tier's assets to list.
params?ListAssetsParamsFilters and pagination. See ListAssetsParams.
Returns

Promise<PaginatedResponse<Asset>>

Paginated assets.

Throws

'projectId is required.' or 'visibility is required.'.

Inherited from
ReturnType.getAssets
getFeedEvents()
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
ParameterTypeDescription
projectIdstringThe ID of the project.
visibilityFeedVisibilityWhich feed to read.
params?ListFeedEventsParamsFilters and cursor.
Returns

Promise<CursorPaginatedFeedEvents>

One page of feed events.

Inherited from
ReturnType.getFeedEvents
getFeedReadState()
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
ParameterTypeDescription
projectIdstringThe ID of the project.
visibilityFeedVisibilityWhich feed to read.
Returns

Promise<ReadState>

Your reading position in that feed.

Inherited from
ReturnType.getFeedReadState
getFolders()
getFolders(
   projectId, 
   visibility, 
   params?
): Promise<PaginatedResponse<Folder>>;

Gets folders within a project with specified visibility.

Parameters
ParameterTypeDescription
projectIdstringThe ID of the project.
visibility"creator" | "reviewer"The visibility context ('creator' or 'reviewer').
params?ListFoldersParamsQuery parameters for filtering and pagination.
Returns

Promise<PaginatedResponse<Folder>>

Paginated list of folders.

Inherited from
ReturnType.getFolders
getHighlightedMessages()
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
ParameterTypeDescription
projectIdstringThe project ID.
visibility"creator" | "reviewer"Which tier's highlights to list.
params?GetHighlightedMessagesParamsCursor pagination. See GetHighlightedMessagesParams.
Returns

Promise<PaginatedResponse<ChatMessage>>

Paginated highlighted messages.

Throws

'projectId is required.' or 'visibility is required.'.

Inherited from
ReturnType.getHighlightedMessages
getHighlightsReadState()
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
ParameterTypeDescription
projectIdstringThe project ID.
visibility"creator" | "reviewer"Which highlights.
Returns

Promise<ReadState>

Your reading position.

Inherited from
ReturnType.getHighlightsReadState
getHomeFeed()
getHomeFeed(
   projectId, 
   visibility, 
   params?
): Promise<PaginatedResponse<Asset>>;

Gets the home feed for a project with a specified visibility.

Parameters
ParameterTypeDescription
projectIdstringThe ID of the project.
visibility"creator" | "reviewer"The visibility context ('creator' or 'reviewer').
params?ListFeedParamsQuery parameters for filtering and pagination.
Returns

Promise<PaginatedResponse<Asset>>

Paginated feed items.

Inherited from
ReturnType.getHomeFeed
getItemsAtPath()
getItemsAtPath(
   projectId, 
   visibility, 
   path?, 
   params?, 
   usePost?
): Promise<PaginatedResponse<any>>;

Gets items at a specific path within a project.

Parameters
ParameterTypeDefault valueDescription
projectIdstringundefinedThe ID of the project.
visibility"creator" | "reviewer"undefinedThe visibility context ('creator' or 'reviewer').
path?stringundefinedThe path to get items from (optional, defaults to root).
params?GetItemsAtPathParamsundefinedQuery parameters for filtering and pagination.
usePost?booleanfalseWhether to use POST method (useful for large resourceIds arrays).
Returns

Promise<PaginatedResponse<any>>

Paginated list of items at the path.

Inherited from
ReturnType.getItemsAtPath
getOriginalPruningSummary()
getOriginalPruningSummary(projectId): Promise<ProjectPruningSummary>;

The project's pruning policy and what it has done. Needs canManageProjectSettings.

Parameters
ParameterTypeDescription
projectIdstringThe project ID.
Returns

Promise<ProjectPruningSummary>

The summary.

Inherited from
ReturnType.getOriginalPruningSummary
getProject()
getProject(projectId): Promise<Project>;

Retrieves a specific project by its ID.

Parameters
ParameterTypeDescription
projectIdstringThe ID of the project.
Returns

Promise<Project>

The project object.

Inherited from
ReturnType.getProject
getProjectChat()
getProjectChat(
   projectId, 
   visibility, 
   params?
): Promise<Chat>;

Gets the project chat with the specified visibility.

Parameters
ParameterTypeDescription
projectIdstringThe ID of the project.
visibility"creator" | "reviewer"The visibility context ('creator' or 'reviewer').
params?GetChatParamsQuery parameters for message/reply limits.
Returns

Promise<Chat>

The chat object.

Inherited from
ReturnType.getProjectChat
getProjectPublicAsset()
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
ParameterTypeDescription
projectIdstringThe ID of the project.
tokenstringThe public access token.
assetIdstringThe ID of the asset to retrieve.
Returns

Promise<PublicAssetResponse>

The asset with its public chat.

Inherited from
ReturnType.getProjectPublicAsset
getProjectPublicChat()
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
ParameterTypeDescription
projectIdstringThe ID of the project.
tokenstringThe public access token.
Returns

Promise<any>

The public chat or null if none exists.

Inherited from
ReturnType.getProjectPublicChat
getProjectPublicChatMessages()
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
ParameterTypeDescription
projectIdstringThe ID of the project.
tokenstringThe public access token.
chatIdstringThe ID of the chat.
params?GetPublicChatMessagesParamsQuery parameters for pagination.
Returns

Promise<PublicChatMessagesResponse>

Paginated list of chat messages.

Inherited from
ReturnType.getProjectPublicChatMessages
getProjects()
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.getProjects
getPublicAudit()
getPublicAudit(projectId, params?): Promise<PaginatedResponse<PublicAuditAssetResponse>>;

Get the public audit for a project — assets that are or have been publicly exposed.

Parameters
ParameterTypeDescription
projectIdstring-
params?{ currentlyPublic?: boolean; limit?: number; page?: number; }-
params.currentlyPublic?booleanWhen 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.getPublicAudit
getPublicFileSystem()
getPublicFileSystem(projectId, publicId): Promise<PublicFileSystemResponse>;

Retrieves a specific public file system by its ID.

Parameters
ParameterTypeDescription
projectIdstringThe ID of the project.
publicIdstringThe ID of the public file system.
Returns

Promise<PublicFileSystemResponse>

The public file system object.

Inherited from
ReturnType.getPublicFileSystem
getPublicFileSystems()
getPublicFileSystems(projectId, params?): Promise<PaginatedResponse<PublicFileSystemResponse>>;

Gets all public file systems for a project.

Parameters
ParameterTypeDescription
projectIdstringThe ID of the project.
params?ListPublicFileSystemsParamsQuery parameters (pagination, sort, search, status, creatorId).
Returns

Promise<PaginatedResponse<PublicFileSystemResponse>>

Paginated list of public file systems.

Inherited from
ReturnType.getPublicFileSystems
getPublicItemsAtPath()
getPublicItemsAtPath(
   projectId, 
   token, 
   path?, 
   params?
): Promise<PaginatedResponse<any>>;

Gets items from a public file system at a specific path (authenticated management).

Parameters
ParameterTypeDescription
projectIdstringThe ID of the project.
tokenstringThe public access token.
path?stringThe path to get items from (optional, defaults to root).
params?GetItemsAtPathParamsQuery parameters for filtering and pagination.
Returns

Promise<PaginatedResponse<any>>

Paginated list of public file system items.

Inherited from
ReturnType.getPublicItemsAtPath
getSubmission()
getSubmission(
   projectId, 
   submissionId, 
   params?
): Promise<ChatSubmission>;

Retrieves a specific submission by its ID.

Parameters
ParameterTypeDescription
projectIdstringThe ID of the project.
submissionIdstringThe ID of the submission.
params?GetSubmissionParamsQuery parameters for chat message/reply options.
Returns

Promise<ChatSubmission>

The submission object.

Inherited from
ReturnType.getSubmission
getSubmissionItems()
getSubmissionItems(
   projectId, 
   submissionId, 
   path?, 
   params?
): Promise<PaginatedResponse<any>>;

Gets files for a specific submission.

Parameters
ParameterTypeDescription
projectIdstringThe ID of the project.
submissionIdstringThe ID of the submission.
path?stringThe path to get items from (optional, defaults to root).
params?GetItemsAtPathParamsQuery parameters for filtering and pagination.
Returns

Promise<PaginatedResponse<any>>

Paginated list of files.

Inherited from
ReturnType.getSubmissionItems
getSubmissions()
getSubmissions(projectId, params?): Promise<PaginatedResponse<ChatSubmission>>;

Retrieves submissions for a project.

Parameters
ParameterTypeDescription
projectIdstringThe ID of the project.
params?ListSubmissionsParamsQuery parameters for filtering and pagination.
Returns

Promise<PaginatedResponse<ChatSubmission>>

Paginated list of submissions.

Inherited from
ReturnType.getSubmissions
getTopAccessActivity()
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
ParameterTypeDescription
projectIdstringThe 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.getTopAccessActivity
markFeedCaughtUp()
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
ParameterType
projectIdstring
visibilityFeedVisibility
lastReadAt?number
Returns

Promise<ReadState>

Your updated reading position.

Inherited from
ReturnType.markFeedCaughtUp
markHighlightsCaughtUp()
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
ParameterType
projectIdstring
visibility"creator" | "reviewer"
lastReadAt?number
Returns

Promise<ReadState>

Your updated reading position.

Inherited from
ReturnType.markHighlightsCaughtUp
moveItemsToPath()
moveItemsToPath(
   projectId, 
   visibility, 
   moveData
): Promise<MoveItemsResult>;

Moves items to a specific path within a project.

Parameters
ParameterTypeDescription
projectIdstringThe ID of the project.
visibility"creator" | "reviewer"The visibility context ('creator' or 'reviewer').
moveDataMoveItemsDataData for moving items.
Returns

Promise<MoveItemsResult>

Object containing the count of moved items.

Inherited from
ReturnType.moveItemsToPath
movePublicItemsAtPath()
movePublicItemsAtPath(
   projectId, 
   token, 
   moveData
): Promise<{
  count: number;
}>;

Moves items within a public file system (authenticated management).

Parameters
ParameterTypeDescription
projectIdstringThe ID of the project.
tokenstringThe public access token.
moveDataMovePublicItemsDataData for moving items.
Returns

Promise<{ count: number; }>

Object containing the count of moved items.

Inherited from
ReturnType.movePublicItemsAtPath
moveSubmissionItems()
moveSubmissionItems(
   projectId, 
   submissionId, 
   moveData
): Promise<{
  count: number;
}>;

Moves items within a submission.

Parameters
ParameterTypeDescription
projectIdstringThe ID of the project.
submissionIdstringThe ID of the submission.
moveDataMoveSubmissionItemsDataData for moving items.
Returns

Promise<{ count: number; }>

Object containing the count of moved items.

Inherited from
ReturnType.moveSubmissionItems
previewDeleteItemsAtPath()
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
ParameterTypeDescription
projectIdstring-
visibility"creator" | "reviewer"-
deleteDataDeleteItemsDataThe same body the delete takes.
Returns

Promise<DeleteImpact>

Inherited from
ReturnType.previewDeleteItemsAtPath
previewPruneOriginals()
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
ParameterTypeDescription
projectIdstringThe project ID.
selectionAssetPruneSelectionAsset ids, creator-tree paths, or both.
Returns

Promise<AssetPrunePreview>

Each asset's eligibility, and the totals.

Inherited from
ReturnType.previewPruneOriginals
pruneOriginals()
pruneOriginals(projectId, selection): Promise<AssetPruneRequestResult>;

Requests prunes for every asset in the selection that can be pruned. Needs canPruneAsset on the project.

Parameters
ParameterTypeDescription
projectIdstringThe project ID.
selectionAssetPruneSelectionAsset ids, creator-tree paths, or both.
Returns

Promise<AssetPruneRequestResult>

The requested and skipped assets.

Inherited from
ReturnType.pruneOriginals
publishItems()
publishItems(projectId, publishData): Promise<any>;

Publishes a list of items (assets, folders) within a project.

Parameters
ParameterTypeDescription
projectIdstringThe ID of the project.
publishDataPublishItemsDataData for publishing items.
Returns

Promise<any>

Object containing lists of published items and results.

Inherited from
ReturnType.publishItems
releasePublicFileSystem()
releasePublicFileSystem(projectId, publicId): Promise<PublicFileSystemResponse>;

Releases a staged (unreleased) public file system, making it externally accessible via its public token.

Parameters
ParameterTypeDescription
projectIdstringThe ID of the project.
publicIdstringThe ID of the public file system.
Returns

Promise<PublicFileSystemResponse>

The released public file system object.

Inherited from
ReturnType.releasePublicFileSystem
releaseSubmission()
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
ParameterTypeDescription
projectIdstringThe ID of the project.
submissionIdstringThe ID of the submission.
Returns

Promise<ChatSubmission>

The released submission object.

Inherited from
ReturnType.releaseSubmission
releaseSubmissionUpdate()
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
ParameterTypeDescription
projectIdstringThe ID of the project.
submissionIdstringThe ID of the submission.
Returns

Promise<ChatSubmission>

The submission object.

Inherited from
ReturnType.releaseSubmissionUpdate
removeFeedEventReaction()
removeFeedEventReaction(
   projectId, 
   visibility, 
   eventId
): Promise<FeedEvent>;

Removes your reaction from a feed event.

Parameters
ParameterType
projectIdstring
visibilityFeedVisibility
eventIdstring
Returns

Promise<FeedEvent>

The updated event.

Inherited from
ReturnType.removeFeedEventReaction
searchProject()
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
ParameterTypeDescription
projectIdstring-
paramsSearchProjectParamsAt minimum q. Optional filters: contentTypes, dateFrom, dateTo, creatorId, sortBy, page, limit.
Returns

Promise<SearchResponse>

Paginated search results.

Inherited from
ReturnType.searchProject
setFeedEventReaction()
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
ParameterType
projectIdstring
visibilityFeedVisibility
eventIdstring
emojistring
Returns

Promise<FeedEvent>

The updated event.

Inherited from
ReturnType.setFeedEventReaction
tagSubmission()
tagSubmission(
   projectId, 
   submissionId, 
   tagData
): Promise<ChatSubmission>;

Adds a tag to a submission.

Parameters
ParameterTypeDescription
projectIdstringThe ID of the project.
submissionIdstringThe ID of the submission.
tagDataTagSubmissionDataData for tagging the submission.
Returns

Promise<ChatSubmission>

The updated submission object.

Inherited from
ReturnType.tagSubmission
unpublishItems()
unpublishItems(projectId, unpublishData): Promise<any>;

Unpublishes a list of items (assets, folders) within a project.

Parameters
ParameterTypeDescription
projectIdstringThe ID of the project.
unpublishDataUnpublishItemsDataData for unpublishing items.
Returns

Promise<any>

Object containing lists of unpublished items and results.

Inherited from
ReturnType.unpublishItems
untagSubmission()
untagSubmission(
   projectId, 
   submissionId, 
   tagData
): Promise<ChatSubmission>;

Removes a tag from a submission.

Parameters
ParameterTypeDescription
projectIdstringThe ID of the project.
submissionIdstringThe ID of the submission.
tagDataTagSubmissionDataData for untagging the submission.
Returns

Promise<ChatSubmission>

The updated submission object.

Inherited from
ReturnType.untagSubmission
updateLogo(projectId, logoData): Promise<any>;

Updates the logo asset for a project.

Parameters
ParameterTypeDescription
projectIdstringThe ID of the project.
logoDataLogoUploadDataFile metadata for the new logo.
Returns

Promise<any>

Object containing signed URL data and updated project info.

Inherited from
ReturnType.updateLogo
updateProject()
updateProject(projectId, updateData): Promise<Project>;

Updates a project.

Parameters
ParameterTypeDescription
projectIdstringThe ID of the project to update.
updateDataUpdateProjectDataData to update.
Returns

Promise<Project>

The updated project object.

Inherited from
ReturnType.updateProject
updatePublicFileSystem()
updatePublicFileSystem(
   projectId, 
   publicId, 
   updateData
): Promise<PublicFileSystemResponse>;

Updates an existing public file system's title and description.

Parameters
ParameterTypeDescription
projectIdstringThe ID of the project.
publicIdstringThe ID of the public file system.
updateDataUpdatePublicFileSystemDataData to update.
Returns

Promise<PublicFileSystemResponse>

The updated public file system object.

Inherited from
ReturnType.updatePublicFileSystem
updateSetting()
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
ParameterTypeDescription
projectIdstring-
namestringSetting key (e.g. 'aiPolishEnabled').
valueunknownnull (inherit)
Returns

Promise<Project>

Inherited from
ReturnType.updateSetting
updateSubmission()
updateSubmission(
   projectId, 
   submissionId, 
   updateData
): Promise<ChatSubmission>;

Updates a submission.

Parameters
ParameterTypeDescription
projectIdstringThe ID of the project.
submissionIdstringThe ID of the submission.
updateDataUpdateSubmissionDataData to update.
Returns

Promise<ChatSubmission>

The updated submission object.

Inherited from
ReturnType.updateSubmission

SDKVersionInfo

SDK Version Information AUTO-GENERATED by scripts/generate-version-info.cjs - DO NOT EDIT MANUALLY

Properties

PropertyTypeDescription
buildHashstring-
buildTimestampstring-
dirtybooleanThe build included uncommitted SDK changes.
gitCommitstring-
versionstringThe release number for a published build; <package.json version>+<source hash> for any other build.

SubscriptionMethods

Extends

Methods

cancelWorkspaceSubscription()
cancelWorkspaceSubscription(workspaceId): Promise<any>;

Cancels the subscription for a specific workspace. Requires authentication and permission.

Parameters
ParameterTypeDescription
workspaceIdstringThe ID of the workspace.
Returns

Promise<any>

The cancellation response.

Inherited from
ReturnType.cancelWorkspaceSubscription
createWorkspaceOrder()
createWorkspaceOrder(workspaceId, orderData): Promise<any>;

Creates a subscription order for a specific workspace. Requires authentication and permission.

Parameters
ParameterTypeDescription
workspaceIdstringThe ID of the workspace.
orderDataCreateWorkspaceOrderParamsThe order data.
Returns

Promise<any>

The created order response.

Inherited from
ReturnType.createWorkspaceOrder
getResourceLimits()
getResourceLimits(resourceId): Promise<ResourceLimits>;

Retrieves the resource limits (e.g., storage, seats) for a specific resource (typically workspace). Requires authentication.

Parameters
ParameterTypeDescription
resourceIdstringThe ID of the resource (e.g., workspaceId).
Returns

Promise<ResourceLimits>

An object containing the resource limits.

Inherited from
ReturnType.getResourceLimits
getRoleUsage()
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
ParameterTypeDescription
resourceIdstringThe workspace ID.
Returns

Promise<RoleUsage>

Creator- and reviewer-side seat usage.

Inherited from
ReturnType.getRoleUsage
getSeatUsage()
getSeatUsage(resourceId): Promise<SeatUsage>;

Retrieves the seat usage for a specific resource (typically workspace). Requires authentication.

Parameters
ParameterTypeDescription
resourceIdstringThe ID of the resource (e.g., workspaceId).
Returns

Promise<SeatUsage>

An object containing seat usage details.

Inherited from
ReturnType.getSeatUsage
getStorageUsage()
getStorageUsage(resourceId): Promise<StorageUsage>;

Retrieves the storage usage for a specific resource (typically workspace). Requires authentication.

Parameters
ParameterTypeDescription
resourceIdstringThe ID of the resource (e.g., workspaceId).
Returns

Promise<StorageUsage>

An object containing storage usage details.

Inherited from
ReturnType.getStorageUsage
getUserSubscriptions()
getUserSubscriptions(params?): Promise<Subscription[]>;

Retrieves all subscriptions owned by the currently authenticated user. Requires authentication.

Parameters
ParameterTypeDescription
params?GetSubscriptionsParamsOptional query parameters for status and sorting.
Returns

Promise<Subscription[]>

An array of subscription objects.

Inherited from
ReturnType.getUserSubscriptions
getWorkspaceOrders()
getWorkspaceOrders(workspaceId, params?): Promise<any[]>;

Retrieves subscription orders for a specific workspace. Requires authentication and permission.

Parameters
ParameterTypeDescription
workspaceIdstringThe ID of the workspace.
params?GetSubscriptionOrdersParamsOptional query parameters.
Returns

Promise<any[]>

An array of subscription order objects.

Inherited from
ReturnType.getWorkspaceOrders
getWorkspaceSubscription()
getWorkspaceSubscription(workspaceId): Promise<Subscription>;

Retrieves the active subscription for a specific workspace. Requires authentication and permission.

Parameters
ParameterTypeDescription
workspaceIdstringThe ID of the workspace.
Returns

Promise<Subscription>

The workspace subscription object.

Inherited from
ReturnType.getWorkspaceSubscription
getWorkspaceUsageSummary()
getWorkspaceUsageSummary(workspaceId): Promise<{
  billableSeatCount: number;
  storageUsedInBytes: number;
}>;

Retrieves the workspace usage summary (billable seats and storage used). Requires authentication and subscription management permission.

Parameters
ParameterTypeDescription
workspaceIdstringThe ID of the workspace.
Returns

Promise<{ billableSeatCount: number; storageUsedInBytes: number; }>

Usage summary.

Inherited from
ReturnType.getWorkspaceUsageSummary
resumeWorkspaceSubscription()
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
ParameterTypeDescription
workspaceIdstringThe ID of the workspace.
Returns

Promise<any>

The resume response.

Inherited from
ReturnType.resumeWorkspaceSubscription
swapWorkspacePlan()
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
ParameterType
workspaceIdstring
params{ billingPeriod: "month" | "year"; currency: string; dryRun?: boolean; newProductId: string; }
params.billingPeriod"month" | "year"
params.currencystring
params.dryRun?boolean
params.newProductIdstring
Returns

Promise<{ subscription: Subscription | null; warnings: PlanChangeWarning[]; }>

Inherited from
ReturnType.swapWorkspacePlan

UserMethods

Extends

Methods

createAvatar()
createAvatar(fileData): Promise<any>;

Creates a new avatar for the user.

Parameters
ParameterTypeDescription
fileDataFileDataFile metadata (e.g., { name, checksum, sizeInMB }).
Returns

Promise<any>

Object containing signed URL data and updated user info.

Inherited from
ReturnType.createAvatar
deleteCurrentUser()
deleteCurrentUser(): Promise<void>;

Deletes the current user. Requires authentication.

Returns

Promise<void>

Inherited from
ReturnType.deleteCurrentUser
getSelf()
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.getSelf
getTodos()
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.getTodos
getUser()
getUser(userId): Promise<PublicUser>;

Retrieves the public profile of a specific user. Requires authentication.

Parameters
ParameterTypeDescription
userIdstringThe ID of the user to retrieve.
Returns

Promise<PublicUser>

Public user object.

Inherited from
ReturnType.getUser
markSeen()
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
ParameterTypeDescription
elementstringone-time element key (see backend oneTimeElements).
Returns

Promise<User>

Inherited from
ReturnType.markSeen
unmarkSeen()
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
ParameterTypeDescription
elements?string[]elements to remove; omit to clear all.
Returns

Promise<User>

Inherited from
ReturnType.unmarkSeen
updateAvatar()
updateAvatar(fileData): Promise<any>;

Updates the user's avatar.

Parameters
ParameterTypeDescription
fileDataFileDataFile metadata (e.g., { name, checksum, sizeInMB }).
Returns

Promise<any>

Object containing signed URL data and updated user info.

Inherited from
ReturnType.updateAvatar
updatePreferences()
updatePreferences(preferenceData): Promise<User>;

Updates the user's preferences.

Parameters
ParameterTypeDescription
preferenceDataPreferencesDataPreference data to update (e.g., { hide: ['feedHint'] }).
Returns

Promise<User>

Updated user object.

Inherited from
ReturnType.updatePreferences
updateSelf()
updateSelf(updateData): Promise<User>;

Updates the logged-in user's profile. Requires authentication. At least one field must be provided.

Parameters
ParameterTypeDescription
updateDataUpdateUserDataThe user data fields to update.
Returns

Promise<User>

The updated user object.

Inherited from
ReturnType.updateSelf

WorkspaceMethods

Extends

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
ParameterType
workspaceIdstring
fileDataFileData
Returns

Promise<any>

Response containing signed URL data and workspace info.

Inherited from
ReturnType.createIcon
createLogo()
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
ParameterType
workspaceIdstring
fileDataFileData
Returns

Promise<any>

Response containing signed URL data and workspace info.

Inherited from
ReturnType.createLogo
createWorkspace()
createWorkspace(data): Promise<any>;

Creates a new workspace. Requires authentication.

Parameters
ParameterTypeDescription
dataCreateWorkspaceDataWorkspace data.
Returns

Promise<any>

The created workspace object.

Inherited from
ReturnType.createWorkspace
deleteWorkspace()
deleteWorkspace(workspaceId): Promise<any>;

Soft-delete a workspace. All nested resources (projects, chats, assets) become inaccessible; bytes are reclaimed by the cleanup cron.

Parameters
ParameterTypeDescription
workspaceIdstringThe ID of the workspace to delete.
Returns

Promise<any>

Object confirming the status change.

Inherited from
ReturnType.deleteWorkspace
getWorkspace()
getWorkspace(workspaceId): Promise<any>;

Retrieves a specific workspace by its ID. Requires authentication.

Parameters
ParameterTypeDescription
workspaceIdstringThe ID of the workspace to retrieve.
Returns

Promise<any>

The workspace object.

Inherited from
ReturnType.getWorkspace
listProjects()
listProjects(workspaceId): Promise<any[]>;

List the projects inside a workspace that the calling user has access to.

Parameters
ParameterTypeDescription
workspaceIdstringThe ID of the workspace.
Returns

Promise<any[]>

An array of project objects.

Inherited from
ReturnType.listProjects
listWorkspaces()
listWorkspaces(sortParams?): Promise<any[]>;

Lists all workspaces the authenticated user has access to. Requires authentication.

Parameters
ParameterTypeDescription
sortParams?SortParamsOptional 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.listWorkspaces
updateIcon()
updateIcon(workspaceId, fileData): Promise<any>;

Request signed URL data to replace the workspace icon. Same upload shape as createIcon.

Parameters
ParameterType
workspaceIdstring
fileDataFileData
Returns

Promise<any>

Response containing signed URL data and workspace info.

Inherited from
ReturnType.updateIcon
updateLogo()
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
ParameterType
workspaceIdstring
fileDataFileData
Returns

Promise<any>

Response containing signed URL data and workspace info.

Inherited from
ReturnType.updateLogo
updateSetting()
updateSetting(
   workspaceId, 
   settingName, 
   value
): Promise<any>;

Toggle a single workspace boolean setting (e.g. an enableX feature flag).

Parameters
ParameterTypeDescription
workspaceIdstringThe ID of the workspace.
settingNamestringThe name of the setting.
valuebooleanThe new value for the setting.
Returns

Promise<any>

The updated workspace object with new settings.

Inherited from
ReturnType.updateSetting
updateWorkspace()
updateWorkspace(workspaceId, updateData): Promise<any>;

Update workspace metadata (name, description, etc.).

Parameters
ParameterType
workspaceIdstring
updateDataUpdateWorkspaceData
Returns

Promise<any>

The updated workspace object.

Inherited from
ReturnType.updateWorkspace

Functions

isApiError()

function isApiError(error): error is ApiError;

Narrow an unknown thrown value to an API error carrying an HTTP status.

Parameters

ParameterType
errorunknown

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

On this page

ClassesdefaultConstructorsConstructorParametersReturnsPropertiesMethods_log()ParametersReturnsclearCache()ReturnsgetCacheStats()ReturnsgetSession()ReturnsgetTokenExpiry()ReturnsgetUserId()ReturnsgetVersion()ReturnsrestoreSession()ParametersReturnstokenValid()ReturnsInterfacesApiErrorExtendsPropertiesAssetMethodsExtendsMethodscancelPruneOriginal()ParametersReturnsInherited fromcancelReattachOriginal()ParametersReturnsInherited fromcleanupUploadSessions()ParametersReturnsInherited fromcompleteCustomThumbnailUpload()ParametersReturnsInherited fromcompleteReattachOriginal()ParametersReturnsInherited fromcompleteUpload()ParametersReturnsInherited fromcompleteUploadSession()ParametersReturnsInherited fromcreatePublicLink()ParametersReturnsInherited fromcreateShortLink()ParametersReturnsInherited fromdeleteAsset()ParametersReturnsInherited fromdisablePublicLink()ParametersReturnsInherited fromdownloadAssets()ParametersReturnsInherited fromgetAsset()ParametersReturnsInherited fromgetAssetAccessActivity()ParametersReturnsInherited fromgetAssetPage()ParametersReturnsInherited fromgetAssetReferences()ParametersReturnsInherited fromgetCustomThumbnailUploadUrl()ParametersReturnsInherited fromgetDocumentViewUrl()ParametersReturnsInherited fromgetFile()ParametersReturnsInherited fromgetFilesByFunctionType()ParametersReturnsInherited fromgetOriginal()ParametersReturnsInherited fromgetOriginalHistory()ParametersReturnsInherited fromgetPublicLinks()ParametersReturnsInherited fromgetUploadSession()ParametersReturnsInherited fromgetUploadSessions()ParametersReturnsInherited fromhasActiveUploads()ParametersReturnsInherited frommultipartUpload()ParametersReturnsInherited fromoffUploadSessionMessage()ParametersReturnsInherited fromonUploadSessionMessage()ParametersReturnsInherited frompromoteAttachmentToProject()ParametersReturnsInherited frompruneOriginal()ParametersReturnsInherited fromreactivatePublicLink()ParametersReturnsInherited fromreattachOriginal()ParametersReturnsInherited fromrecordAccessActivity()ParametersReturnsInherited fromremoveCustomThumbnail()ParametersReturnsInherited fromremoveUploadSession()ParametersReturnsInherited fromrepairAssets()ParametersReturnsInherited fromsetKeepOriginal()ParametersReturnsInherited fromstartReattachOriginal()ParametersReturnsInherited fromtagAsset()ParametersReturnsInherited fromuntagAsset()ParametersReturnsInherited fromupdateAsset()ParametersReturnsInherited fromupdatePublicLink()ParametersReturnsInherited fromAuthMethodsExtendsMethodschangePassword()ParametersReturnsInherited fromdeletePasskey()ParametersReturnsInherited fromdisableMfa()ParametersReturnsInherited fromenableMfa()ReturnsInherited fromexchangeOAuthCode()ParametersReturnsInherited fromforgotPassword()ParametersReturnsInherited fromgetLinkedOAuthProviders()ReturnsInherited fromgetPasskeyLoginOptions()ParametersReturnsInherited fromgetPasskeyRegistrationOptions()ParametersReturnsInherited fromlinkOAuthProvider()ParametersReturnsInherited fromlistPasskeys()ReturnsInherited fromlockAccount()ParametersReturnsInherited fromlogin()ParametersReturnsInherited fromloginDesktopWithPasskey()ParametersReturnsInherited fromloginWithPasskey()ParametersReturnsInherited fromlogout()ParametersReturnsInherited fromrefreshTokens()ParametersReturnsInherited fromregister()ParametersReturnsInherited fromregisterGuest()ParametersReturnsInherited fromregisterPasskey()ParametersReturnsInherited fromrenamePasskey()ParametersReturnsInherited fromresendVerification()ParametersReturnsInherited fromresetPassword()ParametersReturnsInherited fromsendVerificationEmail()ReturnsInherited fromsetPassword()ParametersReturnsInherited fromunlinkOAuthProvider()ParametersReturnsInherited fromupgradeGuest()ParametersReturnsInherited fromverifyBackupCode()ParametersReturnsInherited fromverifyEmail()ParametersReturnsInherited fromverifyGuest()ParametersReturnsInherited fromverifyMfa()ParametersReturnsInherited fromNuramaClientOptionsPropertiesNuramaSessionPropertiesProjectMethodsExtendsMethodsaddItemsToPublicFileSystem()ParametersReturnsInherited fromaddItemsToSubmission()ParametersReturnsInherited fromcancelPruneOriginals()ParametersReturnsInherited fromcopyItemsToPath()ParametersReturnsInherited fromcopyPublicItemsAtPath()ParametersReturnsInherited fromcopySubmissionItems()ParametersReturnsInherited fromcreateAssets()ParametersReturnsInherited fromcreateFolder()ParametersReturnsInherited fromcreateLogo()ParametersReturnsInherited fromcreateProject()ParametersReturnsInherited fromcreateProjectPublicAssetChatMessage()ParametersReturnsInherited fromcreateProjectPublicChatMessage()ParametersReturnsInherited fromcreateProjectPublicTopicChatMessage()ParametersReturnsInherited fromcreatePublicFileSystem()ParametersReturnsInherited fromcreatePublicFolder()ParametersReturnsInherited fromcreateSubmission()ParametersReturnsInherited fromcreateSubmissionFolder()ParametersReturnsInherited fromdeleteItemsAtPath()ParametersReturnsInherited fromdeleteProject()ParametersReturnsInherited fromdeletePublicFileSystem()ParametersReturnsInherited fromdeletePublicItemsAtPath()ParametersReturnsInherited fromdeleteSubmissionItems()ParametersReturnsInherited fromgetAssets()ParametersReturnsThrowsInherited fromgetFeedEvents()ParametersReturnsInherited fromgetFeedReadState()ParametersReturnsInherited fromgetFolders()ParametersReturnsInherited fromgetHighlightedMessages()ParametersReturnsThrowsInherited fromgetHighlightsReadState()ParametersReturnsInherited fromgetHomeFeed()ParametersReturnsInherited fromgetItemsAtPath()ParametersReturnsInherited fromgetOriginalPruningSummary()ParametersReturnsInherited fromgetProject()ParametersReturnsInherited fromgetProjectChat()ParametersReturnsInherited fromgetProjectPublicAsset()ParametersReturnsInherited fromgetProjectPublicChat()ParametersReturnsInherited fromgetProjectPublicChatMessages()ParametersReturnsInherited fromgetProjects()ReturnsInherited fromgetPublicAudit()ParametersReturnsRequiresInherited fromgetPublicFileSystem()ParametersReturnsInherited fromgetPublicFileSystems()ParametersReturnsInherited fromgetPublicItemsAtPath()ParametersReturnsInherited fromgetSubmission()ParametersReturnsInherited fromgetSubmissionItems()ParametersReturnsInherited fromgetSubmissions()ParametersReturnsInherited fromgetTopAccessActivity()ParametersReturnsThrowsInherited frommarkFeedCaughtUp()ParametersReturnsInherited frommarkHighlightsCaughtUp()ParametersReturnsInherited frommoveItemsToPath()ParametersReturnsInherited frommovePublicItemsAtPath()ParametersReturnsInherited frommoveSubmissionItems()ParametersReturnsInherited frompreviewDeleteItemsAtPath()ParametersReturnsInherited frompreviewPruneOriginals()ParametersReturnsInherited frompruneOriginals()ParametersReturnsInherited frompublishItems()ParametersReturnsInherited fromreleasePublicFileSystem()ParametersReturnsInherited fromreleaseSubmission()ParametersReturnsInherited fromreleaseSubmissionUpdate()ParametersReturnsInherited fromremoveFeedEventReaction()ParametersReturnsInherited fromsearchProject()ParametersReturnsInherited fromsetFeedEventReaction()ParametersReturnsInherited fromtagSubmission()ParametersReturnsInherited fromunpublishItems()ParametersReturnsInherited fromuntagSubmission()ParametersReturnsInherited fromupdateLogo()ParametersReturnsInherited fromupdateProject()ParametersReturnsInherited fromupdatePublicFileSystem()ParametersReturnsInherited fromupdateSetting()ParametersReturnsInherited fromupdateSubmission()ParametersReturnsInherited fromSDKVersionInfoPropertiesSubscriptionMethodsExtendsMethodscancelWorkspaceSubscription()ParametersReturnsInherited fromcreateWorkspaceOrder()ParametersReturnsInherited fromgetResourceLimits()ParametersReturnsInherited fromgetRoleUsage()ParametersReturnsInherited fromgetSeatUsage()ParametersReturnsInherited fromgetStorageUsage()ParametersReturnsInherited fromgetUserSubscriptions()ParametersReturnsInherited fromgetWorkspaceOrders()ParametersReturnsInherited fromgetWorkspaceSubscription()ParametersReturnsInherited fromgetWorkspaceUsageSummary()ParametersReturnsInherited fromresumeWorkspaceSubscription()ParametersReturnsInherited fromswapWorkspacePlan()ParametersReturnsInherited fromUserMethodsExtendsMethodscreateAvatar()ParametersReturnsInherited fromdeleteCurrentUser()ReturnsInherited fromgetSelf()ReturnsThrowsInherited fromgetTodos()ReturnsInherited fromgetUser()ParametersReturnsInherited frommarkSeen()ParametersReturnsInherited fromunmarkSeen()ParametersReturnsInherited fromupdateAvatar()ParametersReturnsInherited fromupdatePreferences()ParametersReturnsInherited fromupdateSelf()ParametersReturnsInherited fromWorkspaceMethodsExtendsMethodscreateIcon()ParametersReturnsInherited fromcreateLogo()ParametersReturnsInherited fromcreateWorkspace()ParametersReturnsInherited fromdeleteWorkspace()ParametersReturnsInherited fromgetWorkspace()ParametersReturnsInherited fromlistProjects()ParametersReturnsInherited fromlistWorkspaces()ParametersReturnsInherited fromupdateIcon()ParametersReturnsInherited fromupdateLogo()ParametersReturnsInherited fromupdateSetting()ParametersReturnsInherited fromupdateWorkspace()ParametersReturnsInherited fromFunctionsisApiError()ParametersReturnsReferencesBotBotApiKeySummaryBotProjectMembershipBotProjectRoleCreateBotDataCreateBotResponseCreateSupportTicketRequestCreateTokenDataCreateTokenResponseCreateWebhookDataCreateWebhookResponseHealthStatusListDeliveriesParamsListDeliveriesResponseRotateBotKeyResponseRotateWebhookSecretResponseSupportTicketSupportTicketListParamsSupportTicketListResponseSupportTicketScopeSupportTicketScopeOptionsSupportTicketStatusTestWebhookResponseTokenKindTokenScopeTokenSummaryUpdateBotAvatarFileDataUpdateBotAvatarResponseUpdateBotDataUpdateWebhookDataUserTodoWebhookAttemptWebhookAttemptStatusWebhookEventWebhookSubscriptionWebhookSubscriptionStatus