@veltdev/sdk
Version:
Velt is an SDK to add collaborative features to your product within minutes. Example: Comments like Figma, Frame.io, Google docs or sheets, Recording like Loom, Huddles like Slack and much more.
57 lines (56 loc) • 1.49 kB
TypeScript
import { DocumentMetadata } from "./document-metadata.model";
export interface Document {
id: string;
metadata?: DocumentMetadata;
}
export interface SetDocumentsRequestOptions {
organizationId?: string;
folderId?: string;
allDocuments?: boolean;
locationId?: string;
rootDocumentId?: string;
}
export interface UpdateDocumentsRequest<T = unknown> {
organizationId?: string;
folderId?: string;
documents?: UpdateDocumentMetadata<T>[];
}
export interface UpdateDocumentMetadata<T = unknown> {
documentId: string;
[key: string]: T | string;
}
export interface UpdateLocationsRequest<T = unknown> {
organizationId?: string;
documentIds?: string[];
locations?: UpdateLocationMetadata<T>[];
}
export interface UpdateLocationMetadata<T = unknown> {
id: string;
[key: string]: T | string;
}
export interface FetchDocumentsRequest {
organizationId?: string;
documentIds?: string[];
folderId?: string;
allDocuments?: boolean;
}
export interface FetchLocationsRequest {
organizationId?: string;
documentIds?: string[];
folderId?: string;
allDocuments?: boolean;
}
export interface FetchFoldersRequest {
organizationId?: string;
folderId?: string;
}
export interface FolderConfig {
folderId?: string;
allDocuments?: boolean;
locationId?: string;
veltFolderId?: string;
}
export interface OrganizationConfig {
organizationId: string;
clientOrganizationId: string;
}