import { ListPage } from '../models/ListPage'; import { Document } from '../models/Document'; import { RequiredDeep } from '../models/RequiredDeep'; import { ListArgs } from '../models/ListArgs'; export default class Documents { private impersonating; /** * @ignore * not part of public api, don't include in generated docs */ constructor(); /** * @param schemaID ID of the schema. * @param options.search Word or phrase to search for. * @param options.searchOn Comma-delimited list of fields to search on. * @param options.sortBy Comma-delimited list of fields to sort by. * @param options.page Page of results to return. Default: 1 * @param options.pageSize Number of results to return per page. Default: 20, max: 100. * @param options.filters An object whose keys match the model, and the values are the values to filter by * @param accessToken Provide an alternative token to the one stored in the sdk instance (useful for impersonation). */ List(schemaID: string, options?: ListArgs, accessToken?: string): Promise>>; /** * @param schemaID ID of the schema. * @param documentID ID of the document. * @param accessToken Provide an alternative token to the one stored in the sdk instance (useful for impersonation). */ Get(schemaID: string, documentID: string, accessToken?: string): Promise>; /** * @param schemaID ID of the schema. * @param documentID ID of the document. * @param document * @param accessToken Provide an alternative token to the one stored in the sdk instance (useful for impersonation). */ Update(schemaID: string, documentID: string, document: Document, accessToken?: string): Promise>; /** * @param schemaID ID of the schema. * @param documentID ID of the document. * @param accessToken Provide an alternative token to the one stored in the sdk instance (useful for impersonation). */ Delete(schemaID: string, documentID: string, accessToken?: string): Promise; /** * @description * enables impersonation by calling the subsequent method with the stored impersonation token * * @example * Documents.As().List() // lists Documents using the impersonated users' token */ As(): this; }