NuramaClient | Nurama Developers

Classes

default

Client interface for interacting with the Nurama REST API.

Parameter	Type	Description
`baseURL`	`string`	The base URL for the Nurama API.
`options`	`NuramaClientOptions`	Configuration options.

Properties

Property	Modifier	Type	Default value	Description
`ai`	`public`	{ `composeWithNu`: `Promise`<`ComposeWithNuResponse`>; `createRevisionSourceUpload`: `Promise`<`CreateRevisionSourceUploadResponse`>; `generateRevision`: `Promise`<`GenerateImageRevisionResponse`>; `generateTasks`: `Promise`<`GenerateTasksResponse`>; `listTones`: `Promise`<`ListTonesResponse`>; `polish`: `Promise`<`PolishResponse`>; `submitFeedback`: `Promise`<{ `id`: `string`; }>; }	`undefined`	-
`ai.composeWithNu`	`public`	`Promise`<`ComposeWithNuResponse`>	`undefined`	-
`ai.createRevisionSourceUpload`	`public`	`Promise`<`CreateRevisionSourceUploadResponse`>	`undefined`	-
`ai.generateRevision`	`public`	`Promise`<`GenerateImageRevisionResponse`>	`undefined`	-
`ai.generateTasks`	`public`	`Promise`<`GenerateTasksResponse`>	`undefined`	-
`ai.listTones`	`public`	`Promise`<`ListTonesResponse`>	`undefined`	-
`ai.polish`	`public`	`Promise`<`PolishResponse`>	`undefined`	-
`ai.submitFeedback`	`public`	`Promise`<{ `id`: `string`; }>	`undefined`	-
`aiChat`	`public`	{ `createTopic`: `Promise`<`AiChatCreateTopicResponse`>; `deleteTopic`: `Promise`<`AiChatGetTopicResponse`>; `getTopic`: `Promise`<`AiChatGetTopicResponse`>; `listTopics`: `Promise`<`AiChatListTopicsResponse`>; `updateTopic`: `Promise`<`AiChatGetTopicResponse`>; }	`undefined`	-
`aiChat.createTopic`	`public`	`Promise`<`AiChatCreateTopicResponse`>	`undefined`	-
`aiChat.deleteTopic`	`public`	`Promise`<`AiChatGetTopicResponse`>	`undefined`	-
`aiChat.getTopic`	`public`	`Promise`<`AiChatGetTopicResponse`>	`undefined`	-
`aiChat.listTopics`	`public`	`Promise`<`AiChatListTopicsResponse`>	`undefined`	-
`aiChat.updateTopic`	`public`	`Promise`<`AiChatGetTopicResponse`>	`undefined`	-
`asset`	`readonly`	`AssetMethods`	`undefined`	-
`auth`	`readonly`	`AuthMethods`	`undefined`	-
`baseURL`	`readonly`	`string`	`undefined`	-
`blogPosts`	`public`	{ `listBlogPosts`: `Promise`<`BlogPostListResponse`>; }	`undefined`	-
`blogPosts.listBlogPosts`	`public`	`Promise`<`BlogPostListResponse`>	`undefined`	-
`board`	`public`	{ `addColumn`: `Promise`<`BoardColumn`>; `addExistingTaskToBoard`: `Promise`<`Task`>; `createBoard`: `Promise`<`Board`>; `createBoardTask`: `Promise`<`Task`>; `deleteBoard`: `Promise`<{ `deletedTaskIds`: `string`[]; `disposition`: `string`; `message`: `string`; `reassignedTaskIds`: `string`[]; }>; `deleteColumn`: `Promise`<`void`>; `followBoard`: `Promise`<`Board`>; `getBoard`: `Promise`<`BoardWithTasks`>; `getBoardTasks`: `Promise`<`Task`[]>; `getProjectBoards`: `Promise`<`Board`[]>; `getProjectTasks`: `Promise`<`any`>; `moveTask`: `Promise`<`Task`>; `removeTaskFromBoard`: `Promise`<`Task`>; `reorderColumns`: `Promise`<`BoardColumn`[]>; `tagBoard`: `Promise`<`Board`>; `unfollowBoard`: `Promise`<`Board`>; `untagBoard`: `Promise`<`Board`>; `updateBoard`: `Promise`<`Board`>; `updateColumn`: `Promise`<`BoardColumn`>; }	`undefined`	-
`board.addColumn`	`public`	`Promise`<`BoardColumn`>	`undefined`	-
`board.addExistingTaskToBoard`	`public`	`Promise`<`Task`>	`undefined`	-
`board.createBoard`	`public`	`Promise`<`Board`>	`undefined`	-
`board.createBoardTask`	`public`	`Promise`<`Task`>	`undefined`	-
`board.deleteBoard`	`public`	`Promise`<{ `deletedTaskIds`: `string`[]; `disposition`: `string`; `message`: `string`; `reassignedTaskIds`: `string`[]; }>	`undefined`	-
`board.deleteColumn`	`public`	`Promise`<`void`>	`undefined`	-
`board.followBoard`	`public`	`Promise`<`Board`>	`undefined`	-
`board.getBoard`	`public`	`Promise`<`BoardWithTasks`>	`undefined`	-
`board.getBoardTasks`	`public`	`Promise`<`Task`[]>	`undefined`	-
`board.getProjectBoards`	`public`	`Promise`<`Board`[]>	`undefined`	-
`board.getProjectTasks`	`public`	`Promise`<`any`>	`undefined`	-
`board.moveTask`	`public`	`Promise`<`Task`>	`undefined`	-
`board.removeTaskFromBoard`	`public`	`Promise`<`Task`>	`undefined`	-
`board.reorderColumns`	`public`	`Promise`<`BoardColumn`[]>	`undefined`	-
`board.tagBoard`	`public`	`Promise`<`Board`>	`undefined`	-
`board.unfollowBoard`	`public`	`Promise`<`Board`>	`undefined`	-
`board.untagBoard`	`public`	`Promise`<`Board`>	`undefined`	-
`board.updateBoard`	`public`	`Promise`<`Board`>	`undefined`	-
`board.updateColumn`	`public`	`Promise`<`BoardColumn`>	`undefined`	-
`bot`	`public`	{ `createBot`: `Promise`<`CreateBotResponse`>; `deleteBot`: `Promise`<`void`>; `getBot`: `Promise`<`Bot`>; `listBots`: `Promise`<`Bot`[]>; `listProjectMemberships`: `Promise`<`BotProjectMembership`[]>; `removeProjectMembership`: `Promise`<`void`>; `rotateBotKey`: `Promise`<`RotateBotKeyResponse`>; `setProjectMembership`: `Promise`<`BotProjectMembership`>; `updateBot`: `Promise`<`Bot`>; `updateBotAvatar`: `Promise`<`UpdateBotAvatarResponse`>; }	`undefined`	-
`bot.createBot`	`public`	`Promise`<`CreateBotResponse`>	`undefined`	-
`bot.deleteBot`	`public`	`Promise`<`void`>	`undefined`	-
`bot.getBot`	`public`	`Promise`<`Bot`>	`undefined`	-
`bot.listBots`	`public`	`Promise`<`Bot`[]>	`undefined`	-
`bot.listProjectMemberships`	`public`	`Promise`<`BotProjectMembership`[]>	`undefined`	-
`bot.removeProjectMembership`	`public`	`Promise`<`void`>	`undefined`	-
`bot.rotateBotKey`	`public`	`Promise`<`RotateBotKeyResponse`>	`undefined`	-
`bot.setProjectMembership`	`public`	`Promise`<`BotProjectMembership`>	`undefined`	-
`bot.updateBot`	`public`	`Promise`<`Bot`>	`undefined`	-
`bot.updateBotAvatar`	`public`	`Promise`<`UpdateBotAvatarResponse`>	`undefined`	-
`browserMode`	`readonly`	`boolean`	`false`	-
`cacheDurationSeconds`	`readonly`	`number`	`undefined`	-
`chat`	`public`	{ `addAttachments`: `Promise`<`AttachmentUploadRecord`[]>; `addMembers`: `Promise`<`ChatMember`>; `archiveMemberChat`: `Promise`<`ChatMember`>; `createAssetChatAndMessage`: `Promise`<`any`>; `createMemberChat`: `Promise`<`ChatMember`>; `createMessage`: `Promise`<`ChatMessage`>; `createMessageShortLink`: `Promise`<{ `code`: `string`; `shortUrl`: `string`; }>; `createReaction`: `Promise`<`ChatMessage`>; `createTopicChat`: `Promise`<`Chat`>; `deleteChat`: `Promise`<`void`>; `deleteMemberChat`: `Promise`<`void`>; `deleteMessage`: `Promise`<`ChatMessage`>; `fetchLinkPreviews`: `Promise`<`LinkPreviewResponse`>; `followChat`: `Promise`<`void`>; `getAddableMembers`: `Promise`< \| `AddableMembersByScope` \| `Membership`[]>; `getChat`: `Promise`<`Chat`>; `getChatByTopicId`: `Promise`<`Chat`>; `getMemberChat`: `Promise`<`ChatMember`>; `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`>; `removeAttachment`: `Promise`<`ChatMessage`>; `removeMembers`: `Promise`<`ChatMember`>; `removeReaction`: `Promise`<`ChatMessage`>; `reviseMessage`: `Promise`<`ChatMessage`>; `unarchiveMemberChat`: `Promise`<`ChatMember`>; `unfollowChat`: `Promise`<`void`>; `unhighlightMessage`: `Promise`<`ChatMessage`>; `updateChatSubject`: `Promise`<`Chat`>; `updateMemberChat`: `Promise`<`ChatMember`>; `updateMemberChatIcon`: `Promise`<{ `chat`: `ChatMember`; } & `AttachmentUploadRecord`>; }	`undefined`	-
`chat.addAttachments`	`public`	`Promise`<`AttachmentUploadRecord`[]>	`undefined`	-
`chat.addMembers`	`public`	`Promise`<`ChatMember`>	`undefined`	-
`chat.archiveMemberChat`	`public`	`Promise`<`ChatMember`>	`undefined`	-
`chat.createAssetChatAndMessage`	`public`	`Promise`<`any`>	`undefined`	-
`chat.createMemberChat`	`public`	`Promise`<`ChatMember`>	`undefined`	-
`chat.createMessage`	`public`	`Promise`<`ChatMessage`>	`undefined`	-
`chat.createMessageShortLink`	`public`	`Promise`<{ `code`: `string`; `shortUrl`: `string`; }>	`undefined`	-
`chat.createReaction`	`public`	`Promise`<`ChatMessage`>	`undefined`	-
`chat.createTopicChat`	`public`	`Promise`<`Chat`>	`undefined`	-
`chat.deleteChat`	`public`	`Promise`<`void`>	`undefined`	-
`chat.deleteMemberChat`	`public`	`Promise`<`void`>	`undefined`	-
`chat.deleteMessage`	`public`	`Promise`<`ChatMessage`>	`undefined`	-
`chat.fetchLinkPreviews`	`public`	`Promise`<`LinkPreviewResponse`>	`undefined`	-
`chat.followChat`	`public`	`Promise`<`void`>	`undefined`	-
`chat.getAddableMembers`	`public`	`Promise`< \| `AddableMembersByScope` \| `Membership`[]>	`undefined`	-
`chat.getChat`	`public`	`Promise`<`Chat`>	`undefined`	-
`chat.getChatByTopicId`	`public`	`Promise`<`Chat`>	`undefined`	-
`chat.getMemberChat`	`public`	`Promise`<`ChatMember`>	`undefined`	-
`chat.getMentionableAssets`	`public`	`Promise`<`PaginatedResponse`<`Asset`>>	`undefined`	-
`chat.getMentionableFolders`	`public`	`Promise`<`PaginatedResponse`<`Folder`>>	`undefined`	-
`chat.getMentionablePublics`	`public`	`Promise`<`PaginatedResponse`<`MentionablePublic`>>	`undefined`	-
`chat.getMentionableSubmissions`	`public`	`Promise`<`PaginatedResponse`<`MentionableSubmission`>>	`undefined`	-
`chat.getMentionableTasks`	`public`	`Promise`<`PaginatedResponse`<`any`>>	`undefined`	-
`chat.getMentions`	`public`	`Promise`<`PaginatedResponse`<`ChatMessage`>>	`undefined`	-
`chat.getMessage`	`public`	`Promise`<`ChatMessage`>	`undefined`	-
`chat.getMessages`	`public`	`Promise`<`PaginatedResponse`<`ChatMessage`>>	`undefined`	-
`chat.getReplies`	`public`	`Promise`<`PaginatedResponse`<`ChatMessage`>>	`undefined`	-
`chat.getScopeAddableMembers`	`public`	`Promise`< \| `AddableMembersByScope` \| `Membership`[]>	`undefined`	-
`chat.getUsersMemberChats`	`public`	`Promise`<`PaginatedResponse`<`ChatMember`>>	`undefined`	-
`chat.getWorkspaceProjectChats`	`public`	`Promise`<`any`[]>	`undefined`	-
`chat.highlightMessage`	`public`	`Promise`<`ChatMessage`>	`undefined`	-
`chat.removeAttachment`	`public`	`Promise`<`ChatMessage`>	`undefined`	-
`chat.removeMembers`	`public`	`Promise`<`ChatMember`>	`undefined`	-
`chat.removeReaction`	`public`	`Promise`<`ChatMessage`>	`undefined`	-
`chat.reviseMessage`	`public`	`Promise`<`ChatMessage`>	`undefined`	-
`chat.unarchiveMemberChat`	`public`	`Promise`<`ChatMember`>	`undefined`	-
`chat.unfollowChat`	`public`	`Promise`<`void`>	`undefined`	-
`chat.unhighlightMessage`	`public`	`Promise`<`ChatMessage`>	`undefined`	-
`chat.updateChatSubject`	`public`	`Promise`<`Chat`>	`undefined`	-
`chat.updateMemberChat`	`public`	`Promise`<`ChatMember`>	`undefined`	-
`chat.updateMemberChatIcon`	`public`	`Promise`<{ `chat`: `ChatMember`; } & `AttachmentUploadRecord`>	`undefined`	-
`config`	`readonly`	`ConfigMethods`	`undefined`	-
`convo`	`public`	{ `completeConvo`: `Promise`<`CompleteConvoResponse`>; `deleteConvo`: `Promise`<`void`>; `getChatConvos`: `Promise`<`Convo`[]>; `getConvo`: `Promise`<`GetConvoResponse`>; `getProjectConvos`: `Promise`<`Convo`[]>; `getScopeConvos`: `Promise`<`GetScopeConvosResponse`>; `joinConvo`: `Promise`<`JoinConvoResponse`>; `leaveConvo`: `Promise`<`LeaveConvoResponse`>; `rejoinConvo`: `Promise`<`JoinConvoResponse`>; `startConvo`: `Promise`<`StartConvoResponse`>; `updateConvo`: `Promise`<`UpdateConvoResponse`>; }	`undefined`	-
`convo.completeConvo`	`public`	`Promise`<`CompleteConvoResponse`>	`undefined`	-
`convo.deleteConvo`	`public`	`Promise`<`void`>	`undefined`	-
`convo.getChatConvos`	`public`	`Promise`<`Convo`[]>	`undefined`	-
`convo.getConvo`	`public`	`Promise`<`GetConvoResponse`>	`undefined`	-
`convo.getProjectConvos`	`public`	`Promise`<`Convo`[]>	`undefined`	-
`convo.getScopeConvos`	`public`	`Promise`<`GetScopeConvosResponse`>	`undefined`	-
`convo.joinConvo`	`public`	`Promise`<`JoinConvoResponse`>	`undefined`	-
`convo.leaveConvo`	`public`	`Promise`<`LeaveConvoResponse`>	`undefined`	-
`convo.rejoinConvo`	`public`	`Promise`<`JoinConvoResponse`>	`undefined`	-
`convo.startConvo`	`public`	`Promise`<`StartConvoResponse`>	`undefined`	-
`convo.updateConvo`	`public`	`Promise`<`UpdateConvoResponse`>	`undefined`	-
`credits`	`public`	{ `getBalance`: `Promise`<`GetBalanceResponse`>; `getUsageReport`: `Promise`<`UsageReportResponse`>; }	`undefined`	-
`credits.getBalance`	`public`	`Promise`<`GetBalanceResponse`>	`undefined`	-
`credits.getUsageReport`	`public`	`Promise`<`UsageReportResponse`>	`undefined`	-
`debug`	`readonly`	`boolean`	`undefined`	-
`device`	`public`	{ `deleteDevice`: `Promise`<`void`>; `getDevice`: `Promise`<`Device`>; `getUserDevices`: `Promise`<`Device`[]>; `registerDevice`: `Promise`<`Device`>; `updateDevice`: `Promise`<`Device`>; }	`undefined`	-
`device.deleteDevice`	`public`	`Promise`<`void`>	`undefined`	-
`device.getDevice`	`public`	`Promise`<`Device`>	`undefined`	-
`device.getUserDevices`	`public`	`Promise`<`Device`[]>	`undefined`	-
`device.registerDevice`	`public`	`Promise`<`Device`>	`undefined`	-
`device.updateDevice`	`public`	`Promise`<`Device`>	`undefined`	-
`enableCache`	`readonly`	`boolean`	`undefined`	-
`fetch`	`readonly`	(`input`, `init?`) => `Promise`<`Response`>	`undefined`	-
`folder`	`public`	{ `getFolder`: `Promise`<`Folder`>; `getFoldersAssets`: `Promise`<`PaginatedResponse`<`Asset`>>; `tagFolder`: `Promise`<`Folder`>; `untagFolder`: `Promise`<`Folder`>; `updateFolder`: `Promise`<`Folder`>; `updateFolderIcon`: `Promise`<`any`>; }	`undefined`	-
`folder.getFolder`	`public`	`Promise`<`Folder`>	`undefined`	-
`folder.getFoldersAssets`	`public`	`Promise`<`PaginatedResponse`<`Asset`>>	`undefined`	-
`folder.tagFolder`	`public`	`Promise`<`Folder`>	`undefined`	-
`folder.untagFolder`	`public`	`Promise`<`Folder`>	`undefined`	-
`folder.updateFolder`	`public`	`Promise`<`Folder`>	`undefined`	-
`folder.updateFolderIcon`	`public`	`Promise`<`any`>	`undefined`	-
`invalidateCacheOnMutation`	`readonly`	`boolean`	`undefined`	-
`invite`	`public`	{ `acceptInvite`: `Promise`<`AcceptInviteResponse`>; `cancelInvite`: `Promise`<`Invite`>; `getInviteById`: `Promise`<`Invite`>; `getInvites`: `Promise`<`PaginatedInvitesResponse`>; `getInvitesForResource`: `Promise`<`Invite`[]>; `inviteUser`: `Promise`<`Invite`>; `resendInvite`: `Promise`<`Invite`>; }	`undefined`	-
`invite.acceptInvite`	`public`	`Promise`<`AcceptInviteResponse`>	`undefined`	-
`invite.cancelInvite`	`public`	`Promise`<`Invite`>	`undefined`	-
`invite.getInviteById`	`public`	`Promise`<`Invite`>	`undefined`	-
`invite.getInvites`	`public`	`Promise`<`PaginatedInvitesResponse`>	`undefined`	-
`invite.getInvitesForResource`	`public`	`Promise`<`Invite`[]>	`undefined`	-
`invite.inviteUser`	`public`	`Promise`<`Invite`>	`undefined`	-
`invite.resendInvite`	`public`	`Promise`<`Invite`>	`undefined`	-
`membership`	`public`	{ `addRole`: `Promise`<`Membership`>; `deleteMembership`: `Promise`<`void`>; `getMyMemberships`: `Promise`<`Membership`[]>; `getProjectLastSeen`: `Promise`<`GetLastSeenResponse`>; `getProjectMemberships`: `Promise`<`MembershipReport`>; `getProjectMentionableUsers`: `Promise`<`Mentionable`[]>; `getWorkspaceLastSeen`: `Promise`<`GetLastSeenResponse`>; `getWorkspaceMemberships`: `Promise`<`MembershipReport`>; `leaveResource`: `Promise`<`void`>; `removeRole`: `Promise`<`Membership`>; }	`undefined`	-
`membership.addRole`	`public`	`Promise`<`Membership`>	`undefined`	-
`membership.deleteMembership`	`public`	`Promise`<`void`>	`undefined`	-
`membership.getMyMemberships`	`public`	`Promise`<`Membership`[]>	`undefined`	-
`membership.getProjectLastSeen`	`public`	`Promise`<`GetLastSeenResponse`>	`undefined`	-
`membership.getProjectMemberships`	`public`	`Promise`<`MembershipReport`>	`undefined`	-
`membership.getProjectMentionableUsers`	`public`	`Promise`<`Mentionable`[]>	`undefined`	-
`membership.getWorkspaceLastSeen`	`public`	`Promise`<`GetLastSeenResponse`>	`undefined`	-
`membership.getWorkspaceMemberships`	`public`	`Promise`<`MembershipReport`>	`undefined`	-
`membership.leaveResource`	`public`	`Promise`<`void`>	`undefined`	-
`membership.removeRole`	`public`	`Promise`<`Membership`>	`undefined`	-
`notification`	`public`	{ `getNewNotificationCount`: `Promise`<`NotificationCountResponse`>; `getNewNotificationCountBulk`: `Promise`<`NotificationCountBulkResponse`>; `getNewNotifications`: `Promise`<`PaginatedNotificationResponse`>; `getNotifications`: `Promise`<`PaginatedNotificationResponse`>; `getUsersLastNotificationsSeen`: `Promise`<`LastSeenResponse`>; `updateUsersLastSeen`: `Promise`<`LastSeenResponse`>; }	`undefined`	-
`notification.getNewNotificationCount`	`public`	`Promise`<`NotificationCountResponse`>	`undefined`	-
`notification.getNewNotificationCountBulk`	`public`	`Promise`<`NotificationCountBulkResponse`>	`undefined`	-
`notification.getNewNotifications`	`public`	`Promise`<`PaginatedNotificationResponse`>	`undefined`	-
`notification.getNotifications`	`public`	`Promise`<`PaginatedNotificationResponse`>	`undefined`	-
`notification.getUsersLastNotificationsSeen`	`public`	`Promise`<`LastSeenResponse`>	`undefined`	-
`notification.updateUsersLastSeen`	`public`	`Promise`<`LastSeenResponse`>	`undefined`	-
`payment`	`public`	{ `createManualCheckout`: `Promise`<`any`>; `createStripeCheckout`: `Promise`<`StripeCheckoutResponse`>; `createStripeCustomer`: `Promise`<`StripeCustomerResponse`>; `getStripePortalUrl`: `Promise`<`StripePortalResponse`>; }	`undefined`	-
`payment.createManualCheckout`	`public`	`Promise`<`any`>	`undefined`	-
`payment.createStripeCheckout`	`public`	`Promise`<`StripeCheckoutResponse`>	`undefined`	-
`payment.createStripeCustomer`	`public`	`Promise`<`StripeCustomerResponse`>	`undefined`	-
`payment.getStripePortalUrl`	`public`	`Promise`<`StripePortalResponse`>	`undefined`	-
`product`	`public`	{ `getSuggestedCurrency`: `Promise`<{ `country`: `string` \| `null`; `currency`: `SupportedCurrency`; `locked?`: `boolean`; `supported`: `SupportedCurrency`[]; }>; `getWorkspaceProducts`: `Promise`<`Product`[]>; `listPlans`: `Promise`<`Product`[]>; }	`undefined`	-
`product.getSuggestedCurrency`	`public`	`Promise`<{ `country`: `string` \| `null`; `currency`: `SupportedCurrency`; `locked?`: `boolean`; `supported`: `SupportedCurrency`[]; }>	`undefined`	-
`product.getWorkspaceProducts`	`public`	`Promise`<`Product`[]>	`undefined`	-
`product.listPlans`	`public`	`Promise`<`Product`[]>	`undefined`	-
`project`	`readonly`	`ProjectMethods`	`undefined`	-
`public`	`public`	{ `createPublicAssetChatMessage`: `Promise`<`CreatePublicAssetChatMessageResponse`>; `createPublicChatMessage`: `Promise`<`ChatMessage`>; `createPublicTopicChatMessage`: `Promise`<`CreatePublicAssetChatMessageResponse`>; `downloadAssets`: `Promise`<`DownloadSignedUrlData`[]>; `getPublicAsset`: `Promise`<`PublicAssetResponse`>; `getPublicChat`: `Promise`<`Chat` \| `null`>; `getPublicChatMessages`: `Promise`<`PublicChatMessagesResponse`>; `getPublicDownloadUrl`: `Promise`<`PublicDownloadUrlResponse`>; `getPublicEmbedFiles`: `Promise`<`PublicEmbedFilesResponse`>; `getPublicFileSystem`: `Promise`<`PublicFileSystemDetailsResponse`>; `getPublicItems`: `Promise`<`PublicFileSystemResponse`>; `getPublicItemsAtPath`: `Promise`<`PublicFileSystemResponse`>; `recordAccessActivity`: `Promise`<`void`>; `resolvePublicDownload`: `Promise`<`ResolvePublicDownloadResponse`>; }	`undefined`	-
`public.createPublicAssetChatMessage`	`public`	`Promise`<`CreatePublicAssetChatMessageResponse`>	`undefined`	-
`public.createPublicChatMessage`	`public`	`Promise`<`ChatMessage`>	`undefined`	-
`public.createPublicTopicChatMessage`	`public`	`Promise`<`CreatePublicAssetChatMessageResponse`>	`undefined`	-
`public.downloadAssets`	`public`	`Promise`<`DownloadSignedUrlData`[]>	`undefined`	-
`public.getPublicAsset`	`public`	`Promise`<`PublicAssetResponse`>	`undefined`	-
`public.getPublicChat`	`public`	`Promise`<`Chat` \| `null`>	`undefined`	-
`public.getPublicChatMessages`	`public`	`Promise`<`PublicChatMessagesResponse`>	`undefined`	-
`public.getPublicDownloadUrl`	`public`	`Promise`<`PublicDownloadUrlResponse`>	`undefined`	-
`public.getPublicEmbedFiles`	`public`	`Promise`<`PublicEmbedFilesResponse`>	`undefined`	-
`public.getPublicFileSystem`	`public`	`Promise`<`PublicFileSystemDetailsResponse`>	`undefined`	-
`public.getPublicItems`	`public`	`Promise`<`PublicFileSystemResponse`>	`undefined`	-
`public.getPublicItemsAtPath`	`public`	`Promise`<`PublicFileSystemResponse`>	`undefined`	-
`public.recordAccessActivity`	`public`	`Promise`<`void`>	`undefined`	-
`public.resolvePublicDownload`	`public`	`Promise`<`ResolvePublicDownloadResponse`>	`undefined`	-
`refreshLockTimeoutMs`	`readonly`	`number`	`undefined`	-
`refreshTokenStorageKey`	`readonly`	`string`	`undefined`	-
`scratch`	`public`	{ `completeUpload`: `Promise`<`CompleteUploadResponse`>; `promote`: `Promise`<`PromoteResponse`>; }	`undefined`	-
`scratch.completeUpload`	`public`	`Promise`<`CompleteUploadResponse`>	`undefined`	-
`scratch.promote`	`public`	`Promise`<`PromoteResponse`>	`undefined`	-
`settings`	`public`	{ `cleanupOrphanedSettings`: `Promise`<{ `message`: `string`; `removedCount`: `number`; }>; `getAllResourceSettings`: `Promise`<{ `resourceSettings`: `ResourceSettings`[]; }>; `getEffectiveSettings`: `Promise`<`EffectiveSettings`>; `getResourceSettings`: `Promise`< \| `ResourceSettings` \| { `message`: `string`; }>; `resetResourceSettings`: `Promise`<{ `message`: `string`; }>; `updateResourceSettings`: `Promise`<{ `message`: `string`; `settings`: `ResourceSettings`; }>; }	`undefined`	-
`settings.cleanupOrphanedSettings`	`public`	`Promise`<{ `message`: `string`; `removedCount`: `number`; }>	`undefined`	-
`settings.getAllResourceSettings`	`public`	`Promise`<{ `resourceSettings`: `ResourceSettings`[]; }>	`undefined`	-
`settings.getEffectiveSettings`	`public`	`Promise`<`EffectiveSettings`>	`undefined`	-
`settings.getResourceSettings`	`public`	`Promise`< \| `ResourceSettings` \| { `message`: `string`; }>	`undefined`	-
`settings.resetResourceSettings`	`public`	`Promise`<{ `message`: `string`; }>	`undefined`	-
`settings.updateResourceSettings`	`public`	`Promise`<{ `message`: `string`; `settings`: `ResourceSettings`; }>	`undefined`	-
`shortlink`	`public`	{ `resolveShortLink`: `Promise`<`ResolveShortLinkResponse`>; }	`undefined`	-
`shortlink.resolveShortLink`	`public`	`Promise`<`ResolveShortLinkResponse`>	`undefined`	-
`socket`	`public`	{ `connect`: (`channel`, `options`) => `Promise`<`SocketChannel`>; `connectPublic`: (`publicToken`, `options`) => `Promise`<`SocketChannel`>; `disconnect`: (`channel`) => `Promise`<`void`>; `disconnectAll`: () => `Promise`<`void`>; `emit`: (`channel`, `event`, `data?`) => `void`; `emitWithAck`: (`channel`, `event`, `data`, `timeoutMs`) => `Promise`<`boolean`>; `isConnected`: (`channel`) => `boolean`; `onReconnect`: (`channel`, `callback`) => `void`; `onReconnectFailed`: (`channel`, `callback`) => `void`; `subscribe`: <`T`>(`channel`, `event`, `callback`) => `Promise`<`void`>; `subscribePublic`: <`T`>(`publicToken`, `event`, `callback`) => `Promise`<`void`>; `unsubscribe`: (`channel`, `event`, `callback?`) => `void`; }	`undefined`	-
`socket.connect`	`public`	(`channel`, `options`) => `Promise`<`SocketChannel`>	`undefined`	Connect to a socket channel
`socket.connectPublic`	`public`	(`publicToken`, `options`) => `Promise`<`SocketChannel`>	`undefined`	Connect to a public socket channel without authentication
`socket.disconnect`	`public`	(`channel`) => `Promise`<`void`>	`undefined`	Disconnect from a socket channel
`socket.disconnectAll`	`public`	() => `Promise`<`void`>	`undefined`	Disconnect from all channels
`socket.emit`	`public`	(`channel`, `event`, `data?`) => `void`	`undefined`	Emit an event to a connected channel
`socket.emitWithAck`	`public`	(`channel`, `event`, `data`, `timeoutMs`) => `Promise`<`boolean`>	`undefined`	Emit an event with a timeout-bounded server acknowledgement. Resolves `true` if the server acks within `timeoutMs`, `false` on timeout or transport error. Use it 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 server acknowledges the event via its trailing callback; if no ack arrives within `timeoutMs` the callback receives an Error.
`socket.isConnected`	`public`	(`channel`) => `boolean`	`undefined`	Check if connected to a channel
`socket.onReconnect`	`public`	(`channel`, `callback`) => `void`	`undefined`	Register a callback for when the channel reconnects — a socket.io transport-level reconnect, or the token-refresh reconnect. Use it to recover any gap of server->client messages missed while the connection was down; socket.io does not replay those. Dispatched from the 'reconnect' handler in connect() and from the token-refresh path.
`socket.onReconnectFailed`	`public`	(`channel`, `callback`) => `void`	`undefined`	Register a callback for when Socket.IO exhausts all reconnection attempts
`socket.subscribe`	`public`	<`T`>(`channel`, `event`, `callback`) => `Promise`<`void`>	`undefined`	Subscribe to an event on a channel
`socket.subscribePublic`	`public`	<`T`>(`publicToken`, `event`, `callback`) => `Promise`<`void`>	`undefined`	Subscribe to an event on a public channel Automatically connects to the public channel if not already connected
`socket.unsubscribe`	`public`	(`channel`, `event`, `callback?`) => `void`	`undefined`	Stop listening for an event on a channel. If `callback` is provided, only that specific listener is removed; otherwise every listener for that event is cleared.
`storage`	`public`	{ `getStorageChart`: `Promise`<`ChartDataResponse`>; `getStorageRecord`: `Promise`<`StorageRecord`>; }	`undefined`	-
`storage.getStorageChart`	`public`	`Promise`<`ChartDataResponse`>	`undefined`	-
`storage.getStorageRecord`	`public`	`Promise`<`StorageRecord`>	`undefined`	-
`subscription`	`readonly`	`SubscriptionMethods`	`undefined`	-
`supportChat`	`public`	{ `createAttachment`: `Promise`<`SupportChatCreateAttachmentResponse`>; `getTopic`: `Promise`<`SupportChatGetTopicResponse`>; }	`undefined`	-
`supportChat.createAttachment`	`public`	`Promise`<`SupportChatCreateAttachmentResponse`>	`undefined`	-
`supportChat.getTopic`	`public`	`Promise`<`SupportChatGetTopicResponse`>	`undefined`	-
`supportTicket`	`public`	{ `createSupportTicket`: `Promise`<`SupportTicket`>; `getSupportTicket`: `Promise`<`SupportTicket`>; `getSupportTicketScopeOptions`: `Promise`<`SupportTicketScopeOptions`>; `listSupportTickets`: `Promise`<`SupportTicketListResponse`>; }	`undefined`	-
`supportTicket.createSupportTicket`	`public`	`Promise`<`SupportTicket`>	`undefined`	-
`supportTicket.getSupportTicket`	`public`	`Promise`<`SupportTicket`>	`undefined`	-
`supportTicket.getSupportTicketScopeOptions`	`public`	`Promise`<`SupportTicketScopeOptions`>	`undefined`	-
`supportTicket.listSupportTickets`	`public`	`Promise`<`SupportTicketListResponse`>	`undefined`	-
`tag`	`public`	{ `createTag`: `Promise`<`Tag`>; `deleteTag`: `Promise`<`Tag`>; `getTags`: `Promise`<`Tags`>; `updateTag`: `Promise`<`Tag`>; }	`undefined`	-
`tag.createTag`	`public`	`Promise`<`Tag`>	`undefined`	-
`tag.deleteTag`	`public`	`Promise`<`Tag`>	`undefined`	-
`tag.getTags`	`public`	`Promise`<`Tags`>	`undefined`	-
`tag.updateTag`	`public`	`Promise`<`Tag`>	`undefined`	-
`task`	`public`	{ `acknowledgeAllTasks`: `Promise`<`AcknowledgeAllTasksResponse`>; `acknowledgeTask`: `Promise`<`Task`>; `bulkCreate`: `Promise`<`BulkCreateTasksResponse`>; `deleteTask`: `Promise`<`void`>; `followTask`: `Promise`<`Task`>; `getMyTasks`: `Promise`<`GetTasksResponse`>; `getTaskEvents`: `Promise`<`GetTaskEventsResponse`>; `getTaskLinks`: `Promise`<`TaskLink`[]>; `getUnacknowledgedTaskCount`: `Promise`<`UnacknowledgedTaskCountResponse`>; `linkTask`: `Promise`<`TaskLink`>; `tagTask`: `Promise`<`Task`>; `unfollowTask`: `Promise`<`Task`>; `unlinkTask`: `Promise`<`void`>; `untagTask`: `Promise`<`Task`>; `updateTaskDetails`: `Promise`<`Task`>; `updateTaskStatus`: `Promise`<`Task`>; }	`undefined`	-
`task.acknowledgeAllTasks`	`public`	`Promise`<`AcknowledgeAllTasksResponse`>	`undefined`	-
`task.acknowledgeTask`	`public`	`Promise`<`Task`>	`undefined`	-
`task.bulkCreate`	`public`	`Promise`<`BulkCreateTasksResponse`>	`undefined`	-
`task.deleteTask`	`public`	`Promise`<`void`>	`undefined`	-
`task.followTask`	`public`	`Promise`<`Task`>	`undefined`	-
`task.getMyTasks`	`public`	`Promise`<`GetTasksResponse`>	`undefined`	-
`task.getTaskEvents`	`public`	`Promise`<`GetTaskEventsResponse`>	`undefined`	-
`task.getTaskLinks`	`public`	`Promise`<`TaskLink`[]>	`undefined`	-
`task.getUnacknowledgedTaskCount`	`public`	`Promise`<`UnacknowledgedTaskCountResponse`>	`undefined`	-
`task.linkTask`	`public`	`Promise`<`TaskLink`>	`undefined`	-
`task.tagTask`	`public`	`Promise`<`Task`>	`undefined`	-
`task.unfollowTask`	`public`	`Promise`<`Task`>	`undefined`	-
`task.unlinkTask`	`public`	`Promise`<`void`>	`undefined`	-
`task.untagTask`	`public`	`Promise`<`Task`>	`undefined`	-
`task.updateTaskDetails`	`public`	`Promise`<`Task`>	`undefined`	-
`task.updateTaskStatus`	`public`	`Promise`<`Task`>	`undefined`	-
`taskRelation`	`public`	{ `createTaskRelation`: `Promise`<`TaskRelation`>; `deleteTaskRelation`: `Promise`<`void`>; `getRelationsForChat`: `Promise`<`PaginatedTaskRelations`>; `getRelationsForMessage`: `Promise`<`PaginatedTaskRelations`>; `getTaskRelations`: `Promise`<`PaginatedTaskRelations`>; }	`undefined`	-
`taskRelation.createTaskRelation`	`public`	`Promise`<`TaskRelation`>	`undefined`	-
`taskRelation.deleteTaskRelation`	`public`	`Promise`<`void`>	`undefined`	-
`taskRelation.getRelationsForChat`	`public`	`Promise`<`PaginatedTaskRelations`>	`undefined`	-
`taskRelation.getRelationsForMessage`	`public`	`Promise`<`PaginatedTaskRelations`>	`undefined`	-
`taskRelation.getTaskRelations`	`public`	`Promise`<`PaginatedTaskRelations`>	`undefined`	-
`token`	`public`	{ `createToken`: `Promise`<`CreateTokenResponse`>; `deleteToken`: `Promise`<`void`>; `listTokens`: `Promise`<`TokenSummary`[]>; }	`undefined`	-
`token.createToken`	`public`	`Promise`<`CreateTokenResponse`>	`undefined`	-
`token.deleteToken`	`public`	`Promise`<`void`>	`undefined`	-
`token.listTokens`	`public`	`Promise`<`TokenSummary`[]>	`undefined`	-
`tokenExpiryBufferSeconds`	`readonly`	`number`	`undefined`	-
`tokenRefreshMaxWaitMs`	`readonly`	`number`	`undefined`	-
`tokenRefreshRetryDelayMs`	`readonly`	`number`	`undefined`	-
`tokenStorageKey`	`readonly`	`string`	`undefined`	-
`user`	`readonly`	`UserMethods`	`undefined`	-
`version`	`public`	{ `getCommitHash`: `Promise`<`CommitResponse`>; `getHealth`: `Promise`<`HealthStatus`>; }	`undefined`	-
`version.getCommitHash`	`public`	`Promise`<`CommitResponse`>	`undefined`	-
`version.getHealth`	`public`	`Promise`<`HealthStatus`>	`undefined`	-
`webhook`	`public`	{ `createWebhook`: `Promise`<`CreateWebhookResponse`>; `deleteWebhook`: `Promise`<`void`>; `getWebhook`: `Promise`<`WebhookSubscription`>; `listWebhookDeliveries`: `Promise`<`ListDeliveriesResponse`>; `listWebhooks`: `Promise`<`WebhookSubscription`[]>; `replayWebhookDelivery`: `Promise`<{ `attempt`: `WebhookAttempt`; }>; `rotateWebhookSecret`: `Promise`<`RotateWebhookSecretResponse`>; `testWebhook`: `Promise`<`TestWebhookResponse`>; `updateWebhook`: `Promise`<`WebhookSubscription`>; }	`undefined`	-
`webhook.createWebhook`	`public`	`Promise`<`CreateWebhookResponse`>	`undefined`	-
`webhook.deleteWebhook`	`public`	`Promise`<`void`>	`undefined`	-
`webhook.getWebhook`	`public`	`Promise`<`WebhookSubscription`>	`undefined`	-
`webhook.listWebhookDeliveries`	`public`	`Promise`<`ListDeliveriesResponse`>	`undefined`	-
`webhook.listWebhooks`	`public`	`Promise`<`WebhookSubscription`[]>	`undefined`	-
`webhook.replayWebhookDelivery`	`public`	`Promise`<{ `attempt`: `WebhookAttempt`; }>	`undefined`	-
`webhook.rotateWebhookSecret`	`public`	`Promise`<`RotateWebhookSecretResponse`>	`undefined`	-
`webhook.testWebhook`	`public`	`Promise`<`TestWebhookResponse`>	`undefined`	-
`webhook.updateWebhook`	`public`	`Promise`<`WebhookSubscription`>	`undefined`	-
`websocketURL?`	`readonly`	`string`	`undefined`	-
`workspace`	`readonly`	`WorkspaceMethods`	`undefined`	-

Methods

Parameter	Type	Description
...`args`	`any`[]	Arguments to pass to console.log.

getCacheStats()

getCacheStats(): {
  entries: {
     hasData: boolean;
     hasPendingPromise: boolean;
     key: string;
     timestamp: number;
  }[];
  size: number;
};

Gets cache statistics for debugging.

Returns

{
  entries: {
     hasData: boolean;
     hasPendingPromise: boolean;
     key: string;
     timestamp: number;
  }[];
  size: number;
}

Object containing cache statistics.

Name	Type
`entries`	{ `hasData`: `boolean`; `hasPendingPromise`: `boolean`; `key`: `string`; `timestamp`: `number`; }[]
`size`	`number`

getTokenExpiry()

getTokenExpiry(): {
  access: string | null;
  refresh: string | null;
};

Gets the token expiration timestamps.

Returns

{
  access: string | null;
  refresh: string | null;
}

Object containing access and refresh token expiry ISO timestamps.

Name	Type
`access`	`string` \| `null`
`refresh`	`string` \| `null`

getUserId()

getUserId(): string | null;

Gets the current user's ID from the JWT token.

Returns

string | null

The user ID if available, null otherwise.

getVersion()

getVersion(): SDKVersionInfo;

Gets the SDK version information including build timestamp and hash. Useful for debugging and verifying which SDK version is in use.

Returns

SDKVersionInfo

SDK version, build timestamp, build hash, and git commit

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.

Error thrown by _request when the API responds with a non-2xx status. status is the HTTP status and data the parsed error body ({ type, code, message, errorData? }). Use isApiError to narrow.

Extends

Error

Properties

Property	Type	Inherited from
`data?`	`any`	-
`message`	`string`	`Error.message`
`name`	`string`	`Error.name`
`stack?`	`string`	`Error.stack`
`status?`	`number`	-

AssetMethods

Extends

ReturnType<typeof default>

Methods

cleanupUploadSessions()

cleanupUploadSessions(projectId, olderThanMs?): void;

Clean up old upload sessions for a project

Parameters

Parameter	Type	Description
`projectId`	`string`	The project ID
`olderThanMs?`	`number`	Remove sessions older than this (default: 24 hours)

Returns

void

Inherited from

ReturnType.cleanupUploadSessions

completeCustomThumbnailUpload()

completeCustomThumbnailUpload(assetId, data): Promise<{
  key: string;
  status: string;
}>;

Finalize the multipart upload for a custom thumbnail. Committing the upload starts the background processing that generates the thumbnail outputs.

Parameters

Parameter	Type
`assetId`	`string`
`data`	{ `key`: `string`; `parts`: { `ETag`: `string`; `PartNumber`: `number`; }[]; `uploadId`: `string`; }
`data.key`	`string`
`data.parts`	{ `ETag`: `string`; `PartNumber`: `number`; }[]
`data.uploadId`	`string`

Returns

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

Inherited from

ReturnType.completeCustomThumbnailUpload

completeUpload()

completeUpload(uploadData): Promise<any>;

Complete a multipart upload initiated by createAssets.

Takes the same { uploadId, parts } shape as nuramaClient.scratch.completeUpload, plus the key and assetId.

Parameters

Parameter	Type	Description
`uploadData`	`CompleteMultipartUploadData`	Data including key, uploadId, parts, and assetId.

Returns

Promise<any>

Upload completion response from the server.

Inherited from

ReturnType.completeUpload

completeUploadSession()

completeUploadSession(projectId, sessionId): void;

Mark an upload session as completed

Parameters

Parameter	Type	Description
`projectId`	`string`	The project ID
`sessionId`	`string`	The session ID

Returns

void

Inherited from

ReturnType.completeUploadSession

createPublicLink()

createPublicLink(assetId, data): Promise<PublicAssetLink>;

Create a public download link for an asset.

Parameters

Parameter	Type	Description
`assetId`	`string`	The asset ID.
`data`	{ `mode?`: `PublicAssetLinkMode`; `projectId`: `string`; `validity?`: `number`; }	Link creation data.
`data.mode?`	`PublicAssetLinkMode`	-
`data.projectId`	`string`	The project ID.
`data.validity?`	`number`	Link validity in milliseconds.

Returns

Promise<PublicAssetLink>

The created public link.

Inherited from

ReturnType.createPublicLink

createShortLink()

createShortLink(assetId, data?): Promise<CreateAssetShortLinkResponse>;

Creates a short link for an asset. If a short link already exists for the asset with the same visibility, returns the existing one.

Parameters

Parameter	Type	Description
`assetId`	`string`	The ID of the asset to create a short link for.
`data?`	`CreateAssetShortLinkData`	Optional data including visibility context.

Returns

Promise<CreateAssetShortLinkResponse>

The short link object and short URL.

Inherited from

ReturnType.createShortLink

deleteAsset()

deleteAsset(assetId): Promise<AssetWithChats>;

Deletes an asset (marks for deletion).

Parameters

Parameter	Type	Description
`assetId`	`string`	The ID of the asset to delete.

Returns

Promise<AssetWithChats>

Inherited from

ReturnType.deleteAsset

disablePublicLink()

disablePublicLink(assetId, linkId): Promise<PublicAssetLink>;

Disable a public download link.

Parameters

Parameter	Type	Description
`assetId`	`string`	The asset ID.
`linkId`	`string`	The link ID.

Returns

Promise<PublicAssetLink>

The disabled public link.

Inherited from

ReturnType.disablePublicLink

downloadAssets()

downloadAssets(assetIds): Promise<DownloadAssetsResponse>;

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

Parameters

Parameter	Type	Description
`assetIds`	`string`[]	An array of asset IDs.

Returns

Promise<DownloadAssetsResponse>

Array of download URL results.

Inherited from

ReturnType.downloadAssets

getAsset()

getAsset(assetId, params?): Promise<AssetWithChats>;

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

Parameters

Parameter	Type	Description
`assetId`	`string`	The ID of the asset.
`params?`	`GetAssetParams`	Optional parameters for chat data inclusion.

Returns

Promise<AssetWithChats>

The asset object with optional chat data.

Inherited from

ReturnType.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

Parameter	Type
`assetId`	`string`
`params?`	{ `eventType?`: `"play_started"` \| `"play_completed"` \| `"download"` \| `"embed_resolved"`; `groupBy?`: `"visibility"` \| `"referrerHost"` \| `"country"` \| `"userAgentClass"` \| `"day"`; `limit?`: `number`; `range?`: `"7d"` \| `"30d"` \| `"90d"`; }
`params.eventType?`	`"play_started"` \| `"play_completed"` \| `"download"` \| `"embed_resolved"`
`params.groupBy?`	`"visibility"` \| `"referrerHost"` \| `"country"` \| `"userAgentClass"` \| `"day"`
`params.limit?`	`number`
`params.range?`	`"7d"` \| `"30d"` \| `"90d"`

Returns

Promise<{ breakdown: { count: number; label: string; value: string; }[]; eventType: string | null; from: string; groupBy: string; range: string; series: { count: number; date: string; eventType: string; }[]; to: string; totals: { count: number; eventType: string; }[]; }>

Inherited from

ReturnType.getAssetAccessActivity

getAssetPage()

getAssetPage(assetId, params?): Promise<AssetPageResponse>;

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

Parameters

Parameter	Type	Description
`assetId`	`string`	The ID of the asset to find the page for.
`params?`	`GetAssetPageParams`	Query parameters for sorting, filtering, and pagination limit.

Returns

Promise<AssetPageResponse>

Object containing the page number.

Inherited from

ReturnType.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

Parameter	Type	Description
`assetId`	`string`	The 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 signed multipart upload URLs for a user-supplied custom thumbnail image. Once the upload is completed, background processing generates the custom-thumbnail outputs and attaches them to the asset; the assetFileUpdate websocket event fires when they are ready.

Caller flow:

multipartUpload(file, response.urls, response.key, response.uploadId)
completeCustomThumbnailUpload({ assetId, key, uploadId, parts })
wait for the assetFileUpdate websocket event

Parameters

Parameter	Type
`assetId`	`string`
`data`	{ `fileName`: `string`; `mimeType`: `string`; `sizeInMB`: `number`; }
`data.fileName`	`string`
`data.mimeType`	`string`
`data.sizeInMB`	`number`

Returns

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

Inherited from

ReturnType.getCustomThumbnailUploadUrl

getDocumentViewUrl()

getDocumentViewUrl(assetId): Promise<DocumentViewUrlResponse>;

Mints a short-lived signed URL for rendering a document inline.

A document's media PDF is kept in private storage, so unlike images and video it cannot be addressed by keyPath through the public file URL. Fetch this each time a document is opened; do not cache it past expires.

Parameters

Parameter	Type	Description
`assetId`	`string`	The document asset's ID.

Returns

Promise<DocumentViewUrlResponse>

Signed URL, expiry and page count.

Inherited from

ReturnType.getDocumentViewUrl

getFile()

getFile(assetId, fileId): Promise<File>;

Retrieves a specific file from an asset.

Parameters

Parameter	Type	Description
`assetId`	`string`	The ID of the asset.
`fileId`	`string`	The ID of the file.

Returns

Promise<File>

The file object.

Inherited from

ReturnType.getFile

getFilesByFunctionType()

getFilesByFunctionType(assetId, functionType): Promise<File[]>;

Retrieves files of a specific function type from an asset.

Parameters

Parameter	Type	Description
`assetId`	`string`	The ID of the asset.
`functionType`	`string`	The function type of the files (e.g., 'thumbnail', 'original').

Returns

Promise<File[]>

An array of file objects.

Inherited from

ReturnType.getFilesByFunctionType

getPublicLinks()

getPublicLinks(assetId, options?): Promise<{
  results: PublicAssetLink[];
}>;

Get all public download links for an asset.

Parameters

Parameter	Type	Description
`assetId`	`string`	The asset ID.
`options?`	{ `bypassCache?`: `boolean`; }	-
`options.bypassCache?`	`boolean`	-

Returns

Promise<{ results: PublicAssetLink[]; }>

The public links.

Inherited from

ReturnType.getPublicLinks

getUploadSession()

getUploadSession(projectId, sessionId): UploadSessionData | null;

Get a specific upload session

Parameters

Parameter	Type	Description
`projectId`	`string`	The project ID
`sessionId`	`string`	The session ID

Returns

UploadSessionData | null

Upload session data or null if not found

Inherited from

ReturnType.getUploadSession

getUploadSessions()

getUploadSessions(projectId): UploadSessionData[];

Get all active upload sessions for a project

Parameters

Parameter	Type	Description
`projectId`	`string`	The project ID to get sessions for

Returns

UploadSessionData[]

Array of upload session data

Inherited from

ReturnType.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

Parameter	Type	Description
`staleMs?`	`number`	Max age of the last progress update that still counts as active (default: 2 minutes)

Returns

boolean

Inherited from

ReturnType.hasActiveUploads

multipartUpload()

multipartUpload(
   file, 
   signedUrls, 
   key, 
   uploadId, 
   options?
): Promise<MultipartUploadResult>;

Uploads a file using multipart upload with the provided signed URLs

Parameters

Parameter	Type	Description
`file`	`string` \| `File` \| `Blob` \| `Buffer`<`ArrayBufferLike`>	The file to upload (File/Blob in browser, Buffer/string path in Node.js)
`signedUrls`	`string`[]	Array of signed URLs for each part
`key`	`string`	The storage key returned alongside the signed URLs
`uploadId`	`string`	The multipart upload id returned alongside the signed URLs
`options`	`MultipartUploadOptions`	Upload 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

Parameter	Type	Description
`listenerId`	`string`	Unique listener ID

Returns

void

Inherited from

ReturnType.offUploadSessionMessage

onUploadSessionMessage()

onUploadSessionMessage(listenerId, callback): void;

Parameters

Parameter	Type	Description
`listenerId`	`string`	Unique listener ID
`callback`	(`message`) => `void`	Callback 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

Parameter	Type
`assetId`	`string`
`payload`	{ `fileName?`: `string`; `projectId`: `string`; }
`payload.fileName?`	`string`
`payload.projectId`	`string`

Returns

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

Inherited from

ReturnType.promoteAttachmentToProject

reactivatePublicLink()

reactivatePublicLink(
   assetId, 
   linkId, 
   data?
): Promise<PublicAssetLink>;

Reactivate a disabled/expired public download link.

Parameters

Parameter	Type	Description
`assetId`	`string`	The asset ID.
`linkId`	`string`	The link ID.
`data?`	{ `validity?`: `number`; }	Reactivation data.
`data.validity?`	`number`	New validity in milliseconds.

Returns

Promise<PublicAssetLink>

The reactivated public link.

Inherited from

ReturnType.reactivatePublicLink

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

Parameter	Type
`assetId`	`string`
`body`	{ `eventType`: `"play_started"` \| `"play_completed"`; `visibility`: `"creator"` \| `"reviewer"`; }
`body.eventType`	`"play_started"` \| `"play_completed"`
`body.visibility`	`"creator"` \| `"reviewer"`

Returns

Promise<void>

Inherited from

ReturnType.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

Parameter	Type
`assetId`	`string`

Returns

Promise<Asset>

Inherited from

ReturnType.removeCustomThumbnail

removeUploadSession()

removeUploadSession(projectId, sessionId): void;

Remove an upload session

Parameters

Parameter	Type	Description
`projectId`	`string`	The project ID
`sessionId`	`string`	The session ID

Returns

void

Inherited from

ReturnType.removeUploadSession

repairAssets()

repairAssets(assetIds): Promise<RepairAssetsResponse>;

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

Parameters

Parameter	Type	Description
`assetIds`	`string`[]	An array of asset IDs to repair.

Returns

Promise<RepairAssetsResponse>

Array of repair results.

Inherited from

ReturnType.repairAssets

tagAsset()

tagAsset(assetId, tagData): Promise<AssetWithChats>;

Tags an asset with a specific tag.

Parameters

Parameter	Type	Description
`assetId`	`string`	The ID of the asset to tag.
`tagData`	`TagAssetData`	Data containing the tag ID.

Returns

Promise<AssetWithChats>

The updated asset object.

Inherited from

ReturnType.tagAsset

untagAsset()

untagAsset(assetId, untagData): Promise<AssetWithChats>;

Untags an asset by removing a specific tag.

Parameters

Parameter	Type	Description
`assetId`	`string`	The ID of the asset to untag.
`untagData`	`UntagAssetData`	Data containing the tag ID to remove.

Returns

Promise<AssetWithChats>

The updated asset object.

Inherited from

ReturnType.untagAsset

updateAsset()

updateAsset(assetId, updateData): Promise<AssetWithChats>;

Updates an asset.

Parameters

Parameter	Type	Description
`assetId`	`string`	The ID of the asset to update.
`updateData`	`UpdateAssetData`	Data to update (e.g., name, meta, tags, folderId).

Returns

Promise<AssetWithChats>

The updated asset object.

Inherited from

ReturnType.updateAsset

updatePublicLink()

updatePublicLink(
   assetId, 
   linkId, 
   data
): Promise<PublicAssetLink>;

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

Parameters

Parameter	Type	Description
`assetId`	`string`	The asset ID.
`linkId`	`string`	The link ID.
`data`	{ `mode?`: `PublicAssetLinkMode`; `status?`: `string`; `validity?`: `number`; }	Update data.
`data.mode?`	`PublicAssetLinkMode`	-
`data.status?`	`string`	-
`data.validity?`	`number`	-

Returns

Promise<PublicAssetLink>

The updated public link.

Inherited from

ReturnType.updatePublicLink

AuthMethods

Extends

ReturnType<typeof default>

Methods

changePassword()

changePassword(
   currentPassword, 
   newPassword, 
   mfaToken?
): Promise<void>;

Changes the authenticated user's password. Requires current password verification and MFA token if MFA is enabled. All refresh tokens will be invalidated after password change.

Parameters

Parameter	Type	Description
`currentPassword`	`string`	The current password for verification.
`newPassword`	`string`	The new password.
`mfaToken?`	`string`	MFA token (required if MFA is enabled).

Returns

Promise<void>

Promise resolving when complete.

Inherited from

ReturnType.changePassword

disableMfa()

disableMfa(mfaToken): Promise<void>;

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

Parameters

Parameter	Type	Description
`mfaToken`	`string`	The current MFA token code.

Returns

Promise<void>

Promise resolving when complete.

Inherited from

ReturnType.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): Promise<OAuthExchangeResponse>;

Parameters

Parameter	Type
`code`	`string`

Returns

Promise<OAuthExchangeResponse>

Inherited from

ReturnType.exchangeOAuthCode

forgotPassword()

forgotPassword(email): Promise<void>;

Forgets a user's password.

Parameters

Parameter	Type	Description
`email`	`string`	The user's email address.

Returns

Promise<void>

Inherited from

ReturnType.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

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

Parameter	Type	Description
`provider`	`OAuthProvider`	The OAuth provider to link (google, apple, microsoft, adobe).

Returns

Promise<LoginRegisterResponse>

Promise resolving to user data with updated linked providers.

Inherited from

ReturnType.linkOAuthProvider

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

Parameter	Type	Description
`token`	`string`	The lock account token from the password changed email.

Returns

Promise<void>

Promise resolving when the account is locked.

Inherited from

ReturnType.lockAccount

login(credentials): Promise<LoginRegisterResponse>;

Logs in a user.

Parameters

Parameter	Type	Description
`credentials`	`LoginCredentials`	Login credentials.

Returns

Promise<LoginRegisterResponse>

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

Inherited from

ReturnType.login

logout()

logout(refreshToken): Promise<void>;

Logs out a user.

Parameters

Parameter	Type	Description
`refreshToken`	`string`	The refresh token to invalidate.

Returns

Promise<void>

Inherited from

ReturnType.logout

refreshTokens()

refreshTokens(refreshToken?): Promise<RefreshResponse>;

Refreshes user tokens.

Parameters

Parameter	Type	Description
`refreshToken?`	`string`	The refresh token.

Returns

Promise<RefreshResponse>

Object containing new access and refresh tokens.

Inherited from

ReturnType.refreshTokens

register()

register(userData): Promise<LoginRegisterResponse>;

Registers a new user.

Parameters

Parameter	Type	Description
`userData`	`RegisterUserData`	User registration data.

Returns

Promise<LoginRegisterResponse>

Object containing user info and tokens.

Inherited from

ReturnType.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

Parameter	Type	Description
`data`	{ `color?`: `string`; `displayName`: `string`; `email`: `string`; `publicToken`: `string`; }	Guest registration data (email, displayName, optional approved color, publicToken).
`data.color?`	`string`	-
`data.displayName`	`string`	-
`data.email`	`string`	-
`data.publicToken`	`string`	-

Returns

Promise<void>

Inherited from

ReturnType.registerGuest

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

Parameter	Type	Description
`email`	`string`	The 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

Parameter	Type	Description
`params`	`ResetPasswordData`	Input 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

Parameter	Type	Description
`password`	`string`	The password to set.
`mfaToken?`	`string`	MFA token (required if MFA is enabled).

Returns

Promise<void>

Promise resolving when complete.

Inherited from

ReturnType.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

Parameter	Type	Description
`provider`	`OAuthProvider`	The 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

Parameter	Type	Description
`data`	{ `company?`: `string`; `firstName?`: `string`; `lastName?`: `string`; `password`: `string`; `userName?`: `string`; }	Upgrade data (password, optional firstName, lastName, company, userName).
`data.company?`	`string`	-
`data.firstName?`	`string`	-
`data.lastName?`	`string`	-
`data.password`	`string`	-
`data.userName?`	`string`	-

Returns

Promise<{ user: User; }>

Promise resolving to the upgraded user data.

Inherited from

ReturnType.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

Parameter	Type	Description
`backupCode`	`string`	The backup code (8-character hex string).

Returns

Promise<MFAVerifyResponse>

Promise resolving to user/token data upon successful verification.

Inherited from

ReturnType.verifyBackupCode

verifyEmail()

verifyEmail(token): Promise<void>;

Verifies a user's email using the provided token.

Parameters

Parameter	Type	Description
`token`	`string`	The email verification token.

Returns

Promise<void>

Promise resolving when complete.

Inherited from

ReturnType.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

Parameter	Type	Description
`token`	`string`	The 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

Parameter	Type	Description
`mfaToken`	`string`	The MFA token code.

Returns

Promise<MFAVerifyResponse>

Promise resolving to user/token data upon successful verification.

Inherited from

ReturnType.verifyMfa

NuramaClientOptions

Properties

Property	Type	Description
`apiKey?`	`string`	Long-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?`	`boolean`	Whether to run in browser mode (uses localStorage for token storage). Default: false
`cacheDurationSeconds?`	`number`	Cache duration in seconds. Default: 5
`debug?`	`boolean`	Enable debug logging. Default: false
`enableCache?`	`boolean`	Enable response caching. Default: true
`fetch?`	(`input`, `init?`) => `Promise`<`Response`>	Custom fetch implementation. If not provided, will use global fetch
`invalidateCacheOnMutation?`	`boolean`	After 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?`	() => `void`	Invoked when the API returns a `{ error: 'maintenance' }` body with a 418 or 503 status — i.e. the site is in a maintenance window. Lets an already-loaded (cached) app surface a maintenance message instead of failing silently.
`onUnauthorized?`	(`reason?`) => `void`	Callback invoked when authentication fails and re-login is required (e.g., refresh token expired/missing). `reason.type` carries the API's 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?`	`number`	Timeout in ms for the refresh lock to prevent multiple simultaneous refreshes. Default: 5000
`refreshTokenStorageKey?`	`string`	Key used to store the refresh token in storage. Default: 'nurama_refresh_token'
`tokenExpiryBufferSeconds?`	`number`	Number of seconds before token expiry to trigger refresh. Default: 300 (5 minutes)
`tokenRefreshMaxWaitMs?`	`number`	Maximum time in ms to wait for token refresh. Default: 10000
`tokenRefreshRetryDelayMs?`	`number`	Delay in ms between token refresh retries. Default: 1000
`tokenStorageKey?`	`string`	Key used to store the access token in storage. Default: 'nurama_token'
`websocketURL?`	`string`	WebSocket server URL. If not provided, will use the baseURL

ProjectMethods

Extends

ReturnType<typeof default>

Methods

addItemsToPublicFileSystem()

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

Adds additional items to an existing public file system.

Parameters

Parameter	Type	Description
`projectId`	`string`	The ID of the project.
`publicId`	`string`	The ID of the public file system.
`addItemsData`	`AddItemsToPublicFileSystemData`	Data for adding items.

Returns

Promise<PublicFileSystemResponse>

The updated public file system object.

Inherited from

ReturnType.addItemsToPublicFileSystem

addItemsToSubmission()

addItemsToSubmission(
   projectId, 
   submissionId, 
   addItemsData
): Promise<ChatSubmission>;

Adds items to an existing submission.

Parameters

Parameter	Type	Description
`projectId`	`string`	The ID of the project.
`submissionId`	`string`	The ID of the submission.
`addItemsData`	`AddItemsToSubmissionData`	Data for adding items to the submission.

Returns

Promise<ChatSubmission>

The updated submission object.

Inherited from

ReturnType.addItemsToSubmission

copyItemsToPath()

copyItemsToPath(
   projectId, 
   visibility, 
   copyData
): Promise<{
  count: number;
}>;

Copies items to a specific path within a project.

Parameters

Parameter	Type	Description
`projectId`	`string`	The ID of the project.
`visibility`	`"creator"` \| `"reviewer"`	The visibility context ('creator' or 'reviewer').
`copyData`	`CopyItemsData`	Data for copying items.

Returns

Promise<{ count: number; }>

Object containing the count of copied items.

Inherited from

ReturnType.copyItemsToPath

copyPublicItemsAtPath()

copyPublicItemsAtPath(
   projectId, 
   token, 
   copyData
): Promise<{
  count: number;
}>;

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

Parameters

Parameter	Type	Description
`projectId`	`string`	The ID of the project.
`token`	`string`	The public access token.
`copyData`	`CopyPublicItemsData`	Data for copying items.

Returns

Promise<{ count: number; }>

Object containing the count of copied items.

Inherited from

ReturnType.copyPublicItemsAtPath

copySubmissionItems()

copySubmissionItems(
   projectId, 
   submissionId, 
   copyData
): Promise<{
  count: number;
}>;

Copies items within a submission.

Parameters

Parameter	Type	Description
`projectId`	`string`	The ID of the project.
`submissionId`	`string`	The ID of the submission.
`copyData`	`CopySubmissionItemsData`	Data for copying items.

Returns

Promise<{ count: number; }>

Object containing the count of copied items.

Inherited from

ReturnType.copySubmissionItems

createAssets()

createAssets(projectId, fileUploadBody): Promise<any[]>;

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

Parameters

Parameter	Type	Description
`projectId`	`string`	The ID of the project.
`fileUploadBody`	`ProjectFileUploadBody`	List of files to upload with optional destination path.

Returns

Promise<any[]>

Array of results, each containing asset info and signed URL data.

Inherited from

ReturnType.createAssets

createFolder()

createFolder(
   projectId, 
   visibility, 
   folderData
): Promise<Folder>;

Creates a folder within a project with file system integration.

Parameters

Parameter	Type	Description
`projectId`	`string`	The ID of the project.
`visibility`	`"creator"` \| `"reviewer"`	The visibility context ('creator' or 'reviewer').
`folderData`	`CreateFolderData`	Data for creating the folder.

Returns

Promise<Folder>

The created folder object.

Inherited from

ReturnType.createFolder

createLogo()

createLogo(projectId, logoData): Promise<any>;

Creates a new logo asset for a project.

Parameters

Parameter	Type	Description
`projectId`	`string`	The ID of the project.
`logoData`	`LogoUploadData`	File metadata for the logo.

Returns

Promise<any>

Object containing signed URL data and updated project info.

Inherited from

ReturnType.createLogo

createProject()

createProject(projectData): Promise<Project>;

Creates a new project.

Parameters

Parameter	Type	Description
`projectData`	`CreateProjectData`	Data for the new project.

Returns

Promise<Project>

The created project object.

Inherited from

ReturnType.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

Parameter	Type	Description
`projectId`	`string`	The ID of the project.
`token`	`string`	The public access token.
`assetId`	`string`	The ID of the asset.
`data`	`CreatePublicChatMessageRequest`	Message data.

Returns

Promise<CreatePublicAssetChatMessageResponse>

The chat and created message.

Inherited from

ReturnType.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

Parameter	Type	Description
`projectId`	`string`	The ID of the project.
`token`	`string`	The public access token.
`chatId`	`string`	The ID of the chat.
`data`	`CreatePublicChatMessageRequest`	Message data.

Returns

Promise<ChatMessage>

The created message.

Inherited from

ReturnType.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

Parameter	Type	Description
`projectId`	`string`	The ID of the project.
`token`	`string`	The public access token.
`data`	`CreatePublicChatMessageRequest`	Message data.

Returns

Promise<CreatePublicAssetChatMessageResponse>

The chat and created message.

Inherited from

ReturnType.createProjectPublicTopicChatMessage

createPublicFileSystem()

createPublicFileSystem(projectId, publicFileSystemData): Promise<PublicFileSystemResponse>;

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

Parameters

Parameter	Type	Description
`projectId`	`string`	The ID of the project.
`publicFileSystemData`	`CreatePublicFileSystemData`	Data for creating the public file system.

Returns

Promise<PublicFileSystemResponse>

The created public file system object.

Inherited from

ReturnType.createPublicFileSystem

createPublicFolder()

createPublicFolder(
   projectId, 
   token, 
   folderData
): Promise<Folder>;

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

Parameters

Parameter	Type	Description
`projectId`	`string`	The ID of the project.
`token`	`string`	The public access token.
`folderData`	`CreateFolderData`	Data for creating the folder (name, color, basePath).

Returns

Promise<Folder>

The created folder object.

Inherited from

ReturnType.createPublicFolder

createSubmission()

createSubmission(projectId, submissionData): Promise<ChatSubmission>;

Creates a new submission for a project.

Parameters

Parameter	Type	Description
`projectId`	`string`	The ID of the project.
`submissionData`	`CreateSubmissionData`	Data for the submission.

Returns

Promise<ChatSubmission>

The created submission object.

Inherited from

ReturnType.createSubmission

createSubmissionFolder()

createSubmissionFolder(
   projectId, 
   submissionId, 
   folderData
): Promise<Folder>;

Creates a folder within a submission.

Parameters

Parameter	Type	Description
`projectId`	`string`	The ID of the project.
`submissionId`	`string`	The ID of the submission.
`folderData`	`CreateSubmissionFolderData`	Data for creating the folder.

Returns

Promise<Folder>

The created folder object.

Inherited from

ReturnType.createSubmissionFolder

deleteItemsAtPath()

deleteItemsAtPath(
   projectId, 
   visibility, 
   deleteData
): Promise<{
  count: number;
}>;

Deletes items at a specific path within a project.

Parameters

Parameter	Type	Description
`projectId`	`string`	The ID of the project.
`visibility`	`"creator"` \| `"reviewer"`	The visibility context ('creator' or 'reviewer').
`deleteData`	`DeleteItemsData`	Data for deleting items.

Returns

Promise<{ count: number; }>

Object containing the count of deleted items.

Inherited from

ReturnType.deleteItemsAtPath

deleteProject()

deleteProject(projectId): Promise<void>;

Deletes a project (marks for deletion).

Parameters

Parameter	Type	Description
`projectId`	`string`	The ID of the project to delete.

Returns

Promise<void>

The deleted public release record.

Inherited from

ReturnType.deleteProject

deletePublicFileSystem()

deletePublicFileSystem(projectId, publicId): Promise<PublicFileSystemResponse>;

Deletes a public file system and invalidates its access token.

Parameters

Parameter	Type	Description
`projectId`	`string`	The ID of the project.
`publicId`	`string`	The ID of the public file system.

Returns

Promise<PublicFileSystemResponse>

The deleted public release record.

Inherited from

ReturnType.deletePublicFileSystem

deletePublicItemsAtPath()

deletePublicItemsAtPath(
   projectId, 
   token, 
   deleteData
): Promise<{
  count: number;
}>;

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

Parameters

Parameter	Type	Description
`projectId`	`string`	The ID of the project.
`token`	`string`	The public access token.
`deleteData`	`DeletePublicItemsData`	Data for deleting items.

Returns

Promise<{ count: number; }>

Object containing the count of deleted items.

Inherited from

ReturnType.deletePublicItemsAtPath

deleteSubmissionItems()

deleteSubmissionItems(
   projectId, 
   submissionId, 
   deleteData
): Promise<{
  count: number;
}>;

Deletes items within a submission.

Parameters

Parameter	Type	Description
`projectId`	`string`	The ID of the project.
`submissionId`	`string`	The ID of the submission.
`deleteData`	`DeleteSubmissionItemsData`	Data for deleting items.

Returns

Promise<{ count: number; }>

Object containing the count of deleted items.

Inherited from

ReturnType.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

Parameter	Type	Description
`projectId`	`string`	The project ID.
`visibility`	`"creator"` \| `"reviewer"`	Which tier's assets to list.
`params?`	`ListAssetsParams`	Filters and pagination. See ListAssetsParams.

Returns

Promise<PaginatedResponse<Asset>>

Paginated assets.

Throws

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

Inherited from

ReturnType.getAssets

getFolders()

getFolders(
   projectId, 
   visibility, 
   params?
): Promise<PaginatedResponse<Folder>>;

Gets folders within a project with specified visibility.

Parameters

Parameter	Type	Description
`projectId`	`string`	The ID of the project.
`visibility`	`"creator"` \| `"reviewer"`	The visibility context ('creator' or 'reviewer').
`params?`	`ListFoldersParams`	Query parameters for filtering and pagination.

Returns

Promise<PaginatedResponse<Folder>>

Paginated list of folders.

Inherited from

ReturnType.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

Parameter	Type	Description
`projectId`	`string`	The project ID.
`visibility`	`"creator"` \| `"reviewer"`	Which tier's highlights to list.
`params?`	`GetHighlightedMessagesParams`	Cursor pagination. See GetHighlightedMessagesParams.

Returns

Promise<PaginatedResponse<ChatMessage>>

Paginated highlighted messages.

Throws

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

Inherited from

ReturnType.getHighlightedMessages

getHomeFeed()

getHomeFeed(
   projectId, 
   visibility, 
   params?
): Promise<PaginatedResponse<Asset>>;

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

Parameters

Parameter	Type	Description
`projectId`	`string`	The ID of the project.
`visibility`	`"creator"` \| `"reviewer"`	The visibility context ('creator' or 'reviewer').
`params?`	`ListFeedParams`	Query parameters for filtering and pagination.

Returns

Promise<PaginatedResponse<Asset>>

Paginated feed items.

Inherited from

ReturnType.getHomeFeed

getItemsAtPath()

getItemsAtPath(
   projectId, 
   visibility, 
   path?, 
   params?, 
   usePost?
): Promise<PaginatedResponse<any>>;

Gets items at a specific path within a project.

Parameters

Parameter	Type	Default value	Description
`projectId`	`string`	`undefined`	The ID of the project.
`visibility`	`"creator"` \| `"reviewer"`	`undefined`	The visibility context ('creator' or 'reviewer').
`path?`	`string`	`undefined`	The path to get items from (optional, defaults to root).
`params?`	`GetItemsAtPathParams`	`undefined`	Query parameters for filtering and pagination.
`usePost?`	`boolean`	`false`	Whether to use POST method (useful for large resourceIds arrays).

Returns

Promise<PaginatedResponse<any>>

Paginated list of items at the path.

Inherited from

ReturnType.getItemsAtPath

getProject()

getProject(projectId): Promise<Project>;

Retrieves a specific project by its ID.

Parameters

Parameter	Type	Description
`projectId`	`string`	The ID of the project.

Returns

Promise<Project>

The project object.

Inherited from

ReturnType.getProject

getProjectChat()

getProjectChat(
   projectId, 
   visibility, 
   params?
): Promise<Chat>;

Gets the project chat with the specified visibility.

Parameters

Parameter	Type	Description
`projectId`	`string`	The ID of the project.
`visibility`	`"creator"` \| `"reviewer"`	The visibility context ('creator' or 'reviewer').
`params?`	`GetChatParams`	Query parameters for message/reply limits.

Returns

Promise<Chat>

The chat object.

Inherited from

ReturnType.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

Parameter	Type	Description
`projectId`	`string`	The ID of the project.
`token`	`string`	The public access token.
`assetId`	`string`	The ID of the asset to retrieve.

Returns

Promise<PublicAssetResponse>

The asset with its public chat.

Inherited from

ReturnType.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

Parameter	Type	Description
`projectId`	`string`	The ID of the project.
`token`	`string`	The public access token.

Returns

Promise<any>

The public chat or null if none exists.

Inherited from

ReturnType.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

Parameter	Type	Description
`projectId`	`string`	The ID of the project.
`token`	`string`	The public access token.
`chatId`	`string`	The ID of the chat.
`params?`	`GetPublicChatMessagesParams`	Query parameters for pagination.

Returns

Promise<PublicChatMessagesResponse>

Paginated list of chat messages.

Inherited from

ReturnType.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

Parameter	Type	Description
`projectId`	`string`	-
`params?`	{ `currentlyPublic?`: `boolean`; `limit?`: `number`; `page?`: `number`; }	-
`params.currentlyPublic?`	`boolean`	When true, only assets currently public.
`params.limit?`	`number`	-
`params.page?`	`number`	-

Returns

Promise<PaginatedResponse<PublicAuditAssetResponse>>

Requires

projectAdmin or projectOwner on the project (or workspace-tier admin via inheritance).

Inherited from

ReturnType.getPublicAudit

getPublicFileSystem()

getPublicFileSystem(projectId, publicId): Promise<PublicFileSystemResponse>;

Retrieves a specific public file system by its ID.

Parameters

Parameter	Type	Description
`projectId`	`string`	The ID of the project.
`publicId`	`string`	The ID of the public file system.

Returns

Promise<PublicFileSystemResponse>

The public file system object.

Inherited from

ReturnType.getPublicFileSystem

getPublicFileSystems()

getPublicFileSystems(projectId, params?): Promise<PaginatedResponse<PublicFileSystemResponse>>;

Gets all public file systems for a project.

Parameters

Parameter	Type	Description
`projectId`	`string`	The ID of the project.
`params?`	`ListPublicFileSystemsParams`	Query parameters (pagination, sort, search, status, creatorId).

Returns

Promise<PaginatedResponse<PublicFileSystemResponse>>

Paginated list of public file systems.

Inherited from

ReturnType.getPublicFileSystems

getPublicItemsAtPath()

getPublicItemsAtPath(
   projectId, 
   token, 
   path?, 
   params?
): Promise<PaginatedResponse<any>>;

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

Parameters

Parameter	Type	Description
`projectId`	`string`	The ID of the project.
`token`	`string`	The public access token.
`path?`	`string`	The path to get items from (optional, defaults to root).
`params?`	`GetItemsAtPathParams`	Query parameters for filtering and pagination.

Returns

Promise<PaginatedResponse<any>>

Paginated list of public file system items.

Inherited from

ReturnType.getPublicItemsAtPath

getSubmission()

getSubmission(
   projectId, 
   submissionId, 
   params?
): Promise<ChatSubmission>;

Retrieves a specific submission by its ID.

Parameters

Parameter	Type	Description
`projectId`	`string`	The ID of the project.
`submissionId`	`string`	The ID of the submission.
`params?`	`GetSubmissionParams`	Query parameters for chat message/reply options.

Returns

Promise<ChatSubmission>

The submission object.

Inherited from

ReturnType.getSubmission

getSubmissionItems()

getSubmissionItems(
   projectId, 
   submissionId, 
   path?, 
   params?
): Promise<PaginatedResponse<any>>;

Gets files for a specific submission.

Parameters

Parameter	Type	Description
`projectId`	`string`	The ID of the project.
`submissionId`	`string`	The ID of the submission.
`path?`	`string`	The path to get items from (optional, defaults to root).
`params?`	`GetItemsAtPathParams`	Query parameters for filtering and pagination.

Returns

Promise<PaginatedResponse<any>>

Paginated list of files.

Inherited from

ReturnType.getSubmissionItems

getSubmissions()

getSubmissions(projectId, params?): Promise<PaginatedResponse<ChatSubmission>>;

Retrieves submissions for a project.

Parameters

Parameter	Type	Description
`projectId`	`string`	The ID of the project.
`params?`	`ListSubmissionsParams`	Query parameters for filtering and pagination.

Returns

Promise<PaginatedResponse<ChatSubmission>>

Paginated list of submissions.

Inherited from

ReturnType.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

Parameter	Type	Description
`projectId`	`string`	The project ID.
`params?`	{ `eventType?`: `"play_started"` \| `"play_completed"` \| `"download"` \| `"embed_resolved"`; `limit?`: `number`; `range?`: `"7d"` \| `"30d"` \| `"90d"`; }	`range` ('7d'
`params.eventType?`	`"play_started"` \| `"play_completed"` \| `"download"` \| `"embed_resolved"`	-
`params.limit?`	`number`	-
`params.range?`	`"7d"` \| `"30d"` \| `"90d"`	-

Returns

Promise<ProjectTopAccessActivityResponse>

Ranked asset IDs with counts.

Throws

'projectId is required.' when projectId is falsy.

Inherited from

ReturnType.getTopAccessActivity

moveItemsToPath()

moveItemsToPath(
   projectId, 
   visibility, 
   moveData
): Promise<MoveItemsResult>;

Moves items to a specific path within a project.

Parameters

Parameter	Type	Description
`projectId`	`string`	The ID of the project.
`visibility`	`"creator"` \| `"reviewer"`	The visibility context ('creator' or 'reviewer').
`moveData`	`MoveItemsData`	Data for moving items.

Returns

Promise<MoveItemsResult>

Object containing the count of moved items.

Inherited from

ReturnType.moveItemsToPath

movePublicItemsAtPath()

movePublicItemsAtPath(
   projectId, 
   token, 
   moveData
): Promise<{
  count: number;
}>;

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

Parameters

Parameter	Type	Description
`projectId`	`string`	The ID of the project.
`token`	`string`	The public access token.
`moveData`	`MovePublicItemsData`	Data for moving items.

Returns

Promise<{ count: number; }>

Object containing the count of moved items.

Inherited from

ReturnType.movePublicItemsAtPath

moveSubmissionItems()

moveSubmissionItems(
   projectId, 
   submissionId, 
   moveData
): Promise<{
  count: number;
}>;

Moves items within a submission.

Parameters

Parameter	Type	Description
`projectId`	`string`	The ID of the project.
`submissionId`	`string`	The ID of the submission.
`moveData`	`MoveSubmissionItemsData`	Data for moving items.

Returns

Promise<{ count: number; }>

Object containing the count of moved items.

Inherited from

ReturnType.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

Parameter	Type	Description
`projectId`	`string`	-
`visibility`	`"creator"` \| `"reviewer"`	-
`deleteData`	`DeleteItemsData`	The same body the delete takes.

Returns

Promise<DeleteImpact>

Inherited from

ReturnType.previewDeleteItemsAtPath

publishItems()

publishItems(projectId, publishData): Promise<any>;

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

Parameters

Parameter	Type	Description
`projectId`	`string`	The ID of the project.
`publishData`	`PublishItemsData`	Data for publishing items.

Returns

Promise<any>

Object containing lists of published items and results.

Inherited from

ReturnType.publishItems

releasePublicFileSystem()

releasePublicFileSystem(projectId, publicId): Promise<PublicFileSystemResponse>;

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

Parameters

Parameter	Type	Description
`projectId`	`string`	The ID of the project.
`publicId`	`string`	The ID of the public file system.

Returns

Promise<PublicFileSystemResponse>

The released public file system object.

Inherited from

ReturnType.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

Parameter	Type	Description
`projectId`	`string`	The ID of the project.
`submissionId`	`string`	The ID of the submission.

Returns

Promise<ChatSubmission>

The released submission object.

Inherited from

ReturnType.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

Parameter	Type	Description
`projectId`	`string`	The ID of the project.
`submissionId`	`string`	The ID of the submission.

Returns

Promise<ChatSubmission>

The submission object.

Inherited from

ReturnType.releaseSubmissionUpdate

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

Parameter	Type	Description
`projectId`	`string`	-
`params`	`SearchProjectParams`	At minimum `q`. Optional filters: `contentTypes`, `dateFrom`, `dateTo`, `creatorId`, `sortBy`, `page`, `limit`.

Returns

Promise<SearchResponse>

Paginated search results.

Inherited from

ReturnType.searchProject

tagSubmission()

tagSubmission(
   projectId, 
   submissionId, 
   tagData
): Promise<ChatSubmission>;

Adds a tag to a submission.

Parameters

Parameter	Type	Description
`projectId`	`string`	The ID of the project.
`submissionId`	`string`	The ID of the submission.
`tagData`	`TagSubmissionData`	Data for tagging the submission.

Returns

Promise<ChatSubmission>

The updated submission object.

Inherited from

ReturnType.tagSubmission

unpublishItems()

unpublishItems(projectId, unpublishData): Promise<any>;

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

Parameters

Parameter	Type	Description
`projectId`	`string`	The ID of the project.
`unpublishData`	`UnpublishItemsData`	Data for unpublishing items.

Returns

Promise<any>

Object containing lists of unpublished items and results.

Inherited from

ReturnType.unpublishItems

untagSubmission()

untagSubmission(
   projectId, 
   submissionId, 
   tagData
): Promise<ChatSubmission>;

Removes a tag from a submission.

Parameters

Parameter	Type	Description
`projectId`	`string`	The ID of the project.
`submissionId`	`string`	The ID of the submission.
`tagData`	`TagSubmissionData`	Data for untagging the submission.

Returns

Promise<ChatSubmission>

The updated submission object.

Inherited from

ReturnType.untagSubmission

updateLogo()

updateLogo(projectId, logoData): Promise<any>;

Updates the logo asset for a project.

Parameters

Parameter	Type	Description
`projectId`	`string`	The ID of the project.
`logoData`	`LogoUploadData`	File metadata for the new logo.

Returns

Promise<any>

Object containing signed URL data and updated project info.

Inherited from

ReturnType.updateLogo

updateProject()

updateProject(projectId, updateData): Promise<Project>;

Updates a project.

Parameters

Parameter	Type	Description
`projectId`	`string`	The ID of the project to update.
`updateData`	`UpdateProjectData`	Data to update.

Returns

Promise<Project>

The updated project object.

Inherited from

ReturnType.updateProject

updatePublicFileSystem()

updatePublicFileSystem(
   projectId, 
   publicId, 
   updateData
): Promise<PublicFileSystemResponse>;

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

Parameters

Parameter	Type	Description
`projectId`	`string`	The ID of the project.
`publicId`	`string`	The ID of the public file system.
`updateData`	`UpdatePublicFileSystemData`	Data to update.

Returns

Promise<PublicFileSystemResponse>

The updated public file system object.

Inherited from

ReturnType.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

Parameter	Type	Description
`projectId`	`string`	-
`name`	`string`	Setting key (e.g. 'aiPolishEnabled').
`value`	`unknown`	null (inherit)

Returns

Promise<Project>

Inherited from

ReturnType.updateSetting

updateSubmission()

updateSubmission(
   projectId, 
   submissionId, 
   updateData
): Promise<ChatSubmission>;

Updates a submission.

Parameters

Parameter	Type	Description
`projectId`	`string`	The ID of the project.
`submissionId`	`string`	The ID of the submission.
`updateData`	`UpdateSubmissionData`	Data to update.

Returns

Promise<ChatSubmission>

The updated submission object.

Inherited from

ReturnType.updateSubmission

SDKVersionInfo

SDK Version Information AUTO-GENERATED - DO NOT EDIT MANUALLY Generated at: 2026-09-22T16:09:58.836Z

Properties

Property	Type
`buildHash`	`string`
`buildTimestamp`	`string`
`gitCommit`	`string`
`version`	`string`

SubscriptionMethods

Extends

ReturnType<typeof default>

Methods

cancelWorkspaceSubscription()

cancelWorkspaceSubscription(workspaceId): Promise<any>;

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

Parameters

Parameter	Type	Description
`workspaceId`	`string`	The ID of the workspace.

Returns

Promise<any>

The cancellation response.

Inherited from

ReturnType.cancelWorkspaceSubscription

createWorkspaceOrder()

createWorkspaceOrder(workspaceId, orderData): Promise<any>;

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

Parameters

Parameter	Type	Description
`workspaceId`	`string`	The ID of the workspace.
`orderData`	`CreateWorkspaceOrderParams`	The order data.

Returns

Promise<any>

The created order response.

Inherited from

ReturnType.createWorkspaceOrder

getResourceLimits()

getResourceLimits(resourceId): Promise<ResourceLimits>;

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

Parameters

Parameter	Type	Description
`resourceId`	`string`	The ID of the resource (e.g., workspaceId).

Returns

Promise<ResourceLimits>

An object containing the resource limits.

Inherited from

ReturnType.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

Parameter	Type	Description
`resourceId`	`string`	The 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

Parameter	Type	Description
`resourceId`	`string`	The ID of the resource (e.g., workspaceId).

Returns

Promise<SeatUsage>

An object containing seat usage details.

Inherited from

ReturnType.getSeatUsage

getStorageUsage()

getStorageUsage(resourceId): Promise<StorageUsage>;

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

Parameters

Parameter	Type	Description
`resourceId`	`string`	The ID of the resource (e.g., workspaceId).

Returns

Promise<StorageUsage>

An object containing storage usage details.

Inherited from

ReturnType.getStorageUsage

getUserSubscriptions()

getUserSubscriptions(params?): Promise<Subscription[]>;

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

Parameters

Parameter	Type	Description
`params?`	`GetSubscriptionsParams`	Optional query parameters for status and sorting.

Returns

Promise<Subscription[]>

An array of subscription objects.

Inherited from

ReturnType.getUserSubscriptions

getWorkspaceOrders()

getWorkspaceOrders(workspaceId, params?): Promise<any[]>;

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

Parameters

Parameter	Type	Description
`workspaceId`	`string`	The ID of the workspace.
`params?`	`GetSubscriptionOrdersParams`	Optional query parameters.

Returns

Promise<any[]>

An array of subscription order objects.

Inherited from

ReturnType.getWorkspaceOrders

getWorkspaceSubscription()

getWorkspaceSubscription(workspaceId): Promise<Subscription>;

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

Parameters

Parameter	Type	Description
`workspaceId`	`string`	The ID of the workspace.

Returns

Promise<Subscription>

The workspace subscription object.

Inherited from

ReturnType.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

Parameter	Type	Description
`workspaceId`	`string`	The 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

Parameter	Type	Description
`workspaceId`	`string`	The 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 (suitable for showing as a confirmation notice).

Parameters

Parameter	Type
`workspaceId`	`string`
`params`	{ `billingPeriod`: `"month"` \| `"year"`; `currency`: `string`; `dryRun?`: `boolean`; `newProductId`: `string`; }
`params.billingPeriod`	`"month"` \| `"year"`
`params.currency`	`string`
`params.dryRun?`	`boolean`
`params.newProductId`	`string`

Returns

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

Inherited from

ReturnType.swapWorkspacePlan

UserMethods

Extends

ReturnType<typeof default>

Methods

createAvatar()

createAvatar(fileData): Promise<any>;

Creates a new avatar for the user.

Parameters

Parameter	Type	Description
`fileData`	`FileData`	File metadata (e.g., { name, checksum, sizeInMB }).

Returns

Promise<any>

Object containing signed URL data and updated user info.

Inherited from

ReturnType.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

Parameter	Type	Description
`userId`	`string`	The 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

Parameter	Type	Description
`element`	`string`	one-time element key (must be one of the element keys the server recognises).

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

Parameter	Type	Description
`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

Parameter	Type	Description
`fileData`	`FileData`	File metadata (e.g., { name, checksum, sizeInMB }).

Returns

Promise<any>

Object containing signed URL data and updated user info.

Inherited from

ReturnType.updateAvatar

updatePreferences()

updatePreferences(preferenceData): Promise<User>;

Updates the user's preferences.

Parameters

Parameter	Type	Description
`preferenceData`	`PreferencesData`	Preference data to update (e.g., { hide: ['feedHint'] }).

Returns

Promise<User>

Updated user object.

Inherited from

ReturnType.updatePreferences

updateSelf()

updateSelf(updateData): Promise<User>;

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

Parameters

Parameter	Type	Description
`updateData`	`UpdateUserData`	The user data fields to update.

Returns

Promise<User>

The updated user object.

Inherited from

ReturnType.updateSelf

WorkspaceMethods

Extends

ReturnType<typeof default>

Methods

createIcon()

createIcon(workspaceId, fileData): Promise<any>;

Request signed URL data to upload a workspace icon (the small square shown in sidebars and tabs — distinct from the logo).

Parameters

Parameter	Type
`workspaceId`	`string`
`fileData`	`FileData`

Returns

Promise<any>

Response containing signed URL data and workspace info.

Inherited from

ReturnType.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

Parameter	Type
`workspaceId`	`string`
`fileData`	`FileData`

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

Parameter	Type	Description
`data`	`CreateWorkspaceData`	Workspace 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

Parameter	Type	Description
`workspaceId`	`string`	The 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

Parameter	Type	Description
`workspaceId`	`string`	The 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

Parameter	Type	Description
`workspaceId`	`string`	The 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

Parameter	Type	Description
`sortParams?`	`SortParams`	Optional sorting. Keys are field names (`id`, `name`, `createdAt`, `updatedAt`); values are 1 for ascending or -1 for descending. Sent as `?sort[name]=1&sort[createdAt]=-1`.

Returns

Promise<any[]>

Workspaces with the caller's roles and the workspace capabilities.

Inherited from

ReturnType.listWorkspaces

updateIcon()

updateIcon(workspaceId, fileData): Promise<any>;

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

Parameters

Parameter	Type
`workspaceId`	`string`
`fileData`	`FileData`

Returns

Promise<any>

Response containing signed URL data and workspace info.

Inherited from

ReturnType.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

Parameter	Type
`workspaceId`	`string`
`fileData`	`FileData`

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

Parameter	Type	Description
`workspaceId`	`string`	The ID of the workspace.
`settingName`	`string`	The name of the setting.
`value`	`boolean`	The new value for the setting.

Returns

Promise<any>

The updated workspace object with new settings.

Inherited from

ReturnType.updateSetting

updateWorkspace()

updateWorkspace(workspaceId, updateData): Promise<any>;

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

Parameters

Parameter	Type
`workspaceId`	`string`
`updateData`	`UpdateWorkspaceData`

Returns

Promise<any>

The updated workspace object.

Inherited from

ReturnType.updateWorkspace

Functions

isApiError()

function isApiError(error): error is ApiError;

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

Parameters

Parameter	Type
`error`	`unknown`