@verdocs/js-sdk 3.10.30 → 4.0.1

package/Templates/Roles.d.ts

@@ -1,16 +0,0 @@
-/**
- * A "role" is an individual participant in a signing flow, such as a signer or CC contact. Roles are identified by
- * their names, which must be unique (e.g. 'Recipient 1'). Template fields are assigned to roles for signing operations,
- * so you may have 'Recipient 1 Signature 1' and so forth.
- *
- * @module
- */
-import { ITemplateField, IRole } from './Types';
-import { VerdocsEndpoint } from '../VerdocsEndpoint';
-export declare const createRole: (endpoint: VerdocsEndpoint, templateId: string, params: IRole) => Promise<IRole>;
-export declare const getRoles: (endpoint: VerdocsEndpoint, templateId: string) => Promise<IRole[]>;
-export declare const getRole: (endpoint: VerdocsEndpoint, templateId: string, roleName: string) => Promise<IRole>;
-export declare const updateRole: (endpoint: VerdocsEndpoint, templateId: string, roleName: string, params: Partial<IRole>) => Promise<IRole>;
-export declare const deleteRole: (endpoint: VerdocsEndpoint, templateId: string, roleName: string) => Promise<any>;
-export declare const getRoleFields: (endpoint: VerdocsEndpoint, templateId: string, roleName: string) => Promise<ITemplateField[]>;
-export declare const deleteSequence: (endpoint: VerdocsEndpoint, templateId: string) => Promise<IRole[]>;

package/Templates/Roles.js

@@ -1,42 +0,0 @@
-/**
- * A "role" is an individual participant in a signing flow, such as a signer or CC contact. Roles are identified by
- * their names, which must be unique (e.g. 'Recipient 1'). Template fields are assigned to roles for signing operations,
- * so you may have 'Recipient 1 Signature 1' and so forth.
- *
- * @module
- */
-export var createRole = function (endpoint, templateId, params) {
-    return endpoint.api //
-        .post("/templates/".concat(templateId, "/roles"), params)
-        .then(function (r) { return r.data; });
-};
-export var getRoles = function (endpoint, templateId) {
-    return endpoint.api //
-        .get("/templates/".concat(templateId, "/roles"))
-        .then(function (r) { return r.data; });
-};
-export var getRole = function (endpoint, templateId, roleName) {
-    return endpoint.api //
-        .get("/templates/".concat(templateId, "/roles/").concat(roleName))
-        .then(function (r) { return r.data; });
-};
-export var updateRole = function (endpoint, templateId, roleName, params) {
-    return endpoint.api //
-        .put("/templates/".concat(templateId, "/roles/").concat(roleName), params)
-        .then(function (r) { return r.data; });
-};
-export var deleteRole = function (endpoint, templateId, roleName) {
-    return endpoint.api //
-        .delete("/templates/".concat(templateId, "/roles/").concat(roleName))
-        .then(function (r) { return r.data; });
-};
-export var getRoleFields = function (endpoint, templateId, roleName) {
-    return endpoint.api //
-        .get("/templates/".concat(templateId, "/roles/").concat(roleName, "/fields"))
-        .then(function (r) { return r.data; });
-};
-export var deleteSequence = function (endpoint, templateId) {
-    return endpoint.api //
-        .delete("/templates/".concat(templateId, "/roles"))
-        .then(function (r) { return r.data; });
-};

package/Templates/Stars.d.ts

@@ -1,10 +0,0 @@
-import { IStar, ITemplateSummary } from './Types';
-import { VerdocsEndpoint } from '../VerdocsEndpoint';
-/**
- * Get the template stars for a template.
- */
-export declare const getStars: (endpoint: VerdocsEndpoint, templateId: string) => Promise<IStar[]>;
-/**
- * Toggle the template star for a template.
- */
-export declare const toggleStar: (endpoint: VerdocsEndpoint, templateId: string) => Promise<ITemplateSummary>;

package/Templates/Stars.js

@@ -1,16 +0,0 @@
-/**
- * Get the template stars for a template.
- */
-export var getStars = function (endpoint, templateId) {
-    return endpoint.api //
-        .get("/templates/".concat(templateId, "/stars"))
-        .then(function (r) { return r.data; });
-};
-/**
- * Toggle the template star for a template.
- */
-export var toggleStar = function (endpoint, templateId) {
-    return endpoint.api //
-        .post("/templates/".concat(templateId, "/stars/toggle"))
-        .then(function (r) { return r.data; });
-};

package/Templates/Tags.d.ts

@@ -1,33 +0,0 @@
-/**
- * A Tag is a user-specified label applied to a template. Tags help users organize and find Templates.
- * recipients. Every Organization has a set of tags "owned" by that Organization and only visible inside it.
- * Verdocs also provides a set of system-wide "featured" tags available to all Organizations.
- *
- * @module
- */
-import { ITemplateTag, ITag } from './Types';
-import { VerdocsEndpoint } from '../VerdocsEndpoint';
-/**
- * Apply a tag to a template.
- */
-export declare const addTemplateTag: (endpoint: VerdocsEndpoint, templateId: string, params: ITag) => Promise<ITemplateTag>;
-/**
- * Get all tags for a template.
- */
-export declare const getTemplateTags: (endpoint: VerdocsEndpoint, templateId: string) => Promise<ITemplateTag[]>;
-/**
- * Remove a tag from a template.
- */
-export declare const deleteTemplateTag: (endpoint: VerdocsEndpoint, templateId: string, tagName: string) => Promise<any>;
-/**
- * Create an Organization-wide tag.
- */
-export declare const createTag: (endpoint: VerdocsEndpoint, name: string) => Promise<ITag>;
-/**
- * Get an Organization-wide tag.
- */
-export declare const getTag: (endpoint: VerdocsEndpoint, name: string) => Promise<ITag>;
-/**
- * Get all tags available for use by an Organization.
- */
-export declare const getAllTags: (endpoint: VerdocsEndpoint) => Promise<ITag[]>;

package/Templates/Tags.js

@@ -1,55 +0,0 @@
-/**
- * A Tag is a user-specified label applied to a template. Tags help users organize and find Templates.
- * recipients. Every Organization has a set of tags "owned" by that Organization and only visible inside it.
- * Verdocs also provides a set of system-wide "featured" tags available to all Organizations.
- *
- * @module
- */
-/**
- * Apply a tag to a template.
- */
-export var addTemplateTag = function (endpoint, templateId, params) {
-    return endpoint.api //
-        .post("/templates/".concat(templateId, "/tags/"), params)
-        .then(function (r) { return r.data; });
-};
-/**
- * Get all tags for a template.
- */
-export var getTemplateTags = function (endpoint, templateId) {
-    return endpoint.api //
-        .get("/templates/".concat(templateId, "/tags/"))
-        .then(function (r) { return r.data; });
-};
-/**
- * Remove a tag from a template.
- */
-export var deleteTemplateTag = function (endpoint, templateId, tagName) {
-    return endpoint.api //
-        .post("/templates/".concat(templateId, "/tags/").concat(tagName))
-        .then(function (r) { return r.data; });
-};
-/**
- * Create an Organization-wide tag.
- */
-export var createTag = function (endpoint, name) {
-    return endpoint.api //
-        .post('/tags', { tag_name: name })
-        .then(function (r) { return r.data; });
-};
-/**
- * Get an Organization-wide tag.
- */
-export var getTag = function (endpoint, name) {
-    return endpoint.api //
-        .get("/tags/".concat(name))
-        .then(function (r) { return r.data; });
-};
-/**
- * Get all tags available for use by an Organization.
- */
-export var getAllTags = function (endpoint) {
-    return endpoint.api //
-        .get('/tags')
-        .then(function (r) { return r.data; });
-};

package/Templates/TemplateDocuments.d.ts

@@ -1,66 +0,0 @@
-/**
- * A TemplateDocument represents a PDF or other attachment in a Template.
- *
- * @module
- */
-import { VerdocsEndpoint } from '../VerdocsEndpoint';
-import { ITemplateDocument } from './Types';
-/**
- * Get all the Template Documents associated to a particular Template.
- *
- * ```typescript
- * import {TemplateDocument} from '@verdocs/js-sdk/Templates';
- *
- * await TemplateDocument.geTemplateDocuments((VerdocsEndpoint.getDefault(), templateId);
- * ```
- */
-export declare const getTemplateDocuments: (endpoint: VerdocsEndpoint, templateId: string) => Promise<ITemplateDocument[]>;
-/**
- * Get a specific Document.
- *
- * ```typescript
- * import {TemplateDocument} from '@verdocs/js-sdk/Templates';
- *
- * await TemplateDocument.geTemplateDocument((VerdocsEndpoint.getDefault(), templateId,documentId);
- * ```
- */
-export declare const getTemplateDocument: (endpoint: VerdocsEndpoint, templateId: string, documentId: string) => Promise<ITemplateDocument>;
-/**
- * Create a Document for a particular Template.
- *
- * ```typescript
- * import {TemplateDocument} from '@verdocs/js-sdk/Templates';
- *
- * await TemplateDocument.createDocument((VerdocsEndpoint.getDefault(), templateID, params);
- * ```
- */
-export declare const createTemplateDocument: (endpoint: VerdocsEndpoint, templateId: string, file: File, onUploadProgress?: ((percent: number, loadedBytes: number, totalBytes: number) => void) | undefined) => Promise<ITemplateDocument>;
-/**
- * Delete a specific Document.
- *
- * ```typescript
- * import {TemplateDocument} from '@verdocs/js-sdk/Templates';
- *
- * await TemplateDocument.deleteDocument((VerdocsEndpoint.getDefault(), templateID, documentID);
- * ```
- */
-export declare const deleteTemplateDocument: (endpoint: VerdocsEndpoint, templateId: string, documentId: string) => Promise<any>;
-/**
- * Get (binary download) a file attached to a Template. It is important to use this method
- * rather than a direct A HREF or similar link to set the authorization headers for the
- * request.
- */
-export declare const getTemplateDocumentFile: (endpoint: VerdocsEndpoint, templateId: string, documentId: string) => Promise<any>;
-/**
- * Get (binary download) a file attached to a Template. It is important to use this method
- * rather than a direct A HREF or similar link to set the authorization headers for the
- * request.
- */
-export declare const getTemplateDocumentThumbnail: (endpoint: VerdocsEndpoint, templateId: string, documentId: string) => Promise<any>;
-/**
- * Get a display URI for a given page in a file attached to a template document. These pages are rendered server-side
- * into PNG resources suitable for display in IMG tags although they may be used elsewhere. Note that these are intended
- * for DISPLAY ONLY, are not legally binding documents, and do not contain any encoded metadata from participants. The
- * original asset may be obtained by calling `getTemplateDocumentFile()` or similar.
- */
-export declare const getTemplateDocumentPageDisplayUri: (endpoint: VerdocsEndpoint, templateId: string, documentId: string, page: number) => Promise<string>;

package/Templates/TemplateDocuments.js

@@ -1,139 +0,0 @@
-/**
- * A TemplateDocument represents a PDF or other attachment in a Template.
- *
- * @module
- */
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-var __generator = (this && this.__generator) || function (thisArg, body) {
-    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
-    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
-    function verb(n) { return function (v) { return step([n, v]); }; }
-    function step(op) {
-        if (f) throw new TypeError("Generator is already executing.");
-        while (g && (g = 0, op[0] && (_ = 0)), _) try {
-            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
-            if (y = 0, t) op = [op[0] & 2, t.value];
-            switch (op[0]) {
-                case 0: case 1: t = op; break;
-                case 4: _.label++; return { value: op[1], done: false };
-                case 5: _.label++; y = op[1]; op = [0]; continue;
-                case 7: op = _.ops.pop(); _.trys.pop(); continue;
-                default:
-                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
-                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
-                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
-                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
-                    if (t[2]) _.ops.pop();
-                    _.trys.pop(); continue;
-            }
-            op = body.call(thisArg, _);
-        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
-        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
-    }
-};
-/**
- * Get all the Template Documents associated to a particular Template.
- *
- * ```typescript
- * import {TemplateDocument} from '@verdocs/js-sdk/Templates';
- *
- * await TemplateDocument.geTemplateDocuments((VerdocsEndpoint.getDefault(), templateId);
- * ```
- */
-export var getTemplateDocuments = function (endpoint, templateId) {
-    return endpoint.api //
-        .get("/templates/".concat(templateId, "/documents/"))
-        .then(function (r) { return r.data; });
-};
-/**
- * Get a specific Document.
- *
- * ```typescript
- * import {TemplateDocument} from '@verdocs/js-sdk/Templates';
- *
- * await TemplateDocument.geTemplateDocument((VerdocsEndpoint.getDefault(), templateId,documentId);
- * ```
- */
-export var getTemplateDocument = function (endpoint, templateId, documentId) {
-    return endpoint.api //
-        .get("/templates/".concat(templateId, "/documents/").concat(documentId))
-        .then(function (r) { return r.data; });
-};
-/**
- * Create a Document for a particular Template.
- *
- * ```typescript
- * import {TemplateDocument} from '@verdocs/js-sdk/Templates';
- *
- * await TemplateDocument.createDocument((VerdocsEndpoint.getDefault(), templateID, params);
- * ```
- */
-export var createTemplateDocument = function (endpoint, templateId, file, onUploadProgress) {
-    var formData = new FormData();
-    formData.append('document', file, file.name);
-    return endpoint.api //
-        .post("/templates/".concat(templateId, "/documents"), formData, {
-        timeout: 120000,
-        onUploadProgress: function (event) {
-            var total = event.total || 1;
-            var loaded = event.loaded || 0;
-            onUploadProgress === null || onUploadProgress === void 0 ? void 0 : onUploadProgress(Math.floor((loaded * 100) / (total || 1)), loaded, total || 1);
-        },
-    })
-        .then(function (r) { return r.data; });
-};
-/**
- * Delete a specific Document.
- *
- * ```typescript
- * import {TemplateDocument} from '@verdocs/js-sdk/Templates';
- *
- * await TemplateDocument.deleteDocument((VerdocsEndpoint.getDefault(), templateID, documentID);
- * ```
- */
-export var deleteTemplateDocument = function (endpoint, templateId, documentId) {
-    return endpoint.api //
-        .delete("/templates/".concat(templateId, "/documents/").concat(documentId))
-        .then(function (r) { return r.data; });
-};
-/**
- * Get (binary download) a file attached to a Template. It is important to use this method
- * rather than a direct A HREF or similar link to set the authorization headers for the
- * request.
- */
-export var getTemplateDocumentFile = function (endpoint, templateId, documentId) { return __awaiter(void 0, void 0, void 0, function () {
-    return __generator(this, function (_a) {
-        return [2 /*return*/, endpoint.api //
-                .get("/templates/".concat(templateId, "/documents/").concat(documentId, "?file=true"), { responseType: 'blob' })
-                .then(function (r) { return r.data; })];
-    });
-}); };
-/**
- * Get (binary download) a file attached to a Template. It is important to use this method
- * rather than a direct A HREF or similar link to set the authorization headers for the
- * request.
- */
-export var getTemplateDocumentThumbnail = function (endpoint, templateId, documentId) { return __awaiter(void 0, void 0, void 0, function () {
-    return __generator(this, function (_a) {
-        return [2 /*return*/, endpoint.api //
-                .get("/templates/".concat(templateId, "/documents/").concat(documentId, "?thumbnail=true"), { responseType: 'blob' })
-                .then(function (r) { return r.data; })];
-    });
-}); };
-/**
- * Get a display URI for a given page in a file attached to a template document. These pages are rendered server-side
- * into PNG resources suitable for display in IMG tags although they may be used elsewhere. Note that these are intended
- * for DISPLAY ONLY, are not legally binding documents, and do not contain any encoded metadata from participants. The
- * original asset may be obtained by calling `getTemplateDocumentFile()` or similar.
- */
-export var getTemplateDocumentPageDisplayUri = function (endpoint, templateId, documentId, page) { return __awaiter(void 0, void 0, void 0, function () { return __generator(this, function (_a) {
-    return [2 /*return*/, endpoint.api.get("/templates/".concat(templateId, "/documents/").concat(documentId, "/pages/").concat(page, "/image")).then(function (r) { return r.data; })];
-}); }); };

package/Templates/Templates.d.ts

@@ -1,284 +0,0 @@
-/**
- * A Template defines how a Verdocs signing flow will be performed, including attachments, signing fields, and
- * recipients.
- *
- * @module
- */
-import { IRole, ITemplate, ITemplateField, ITemplateOwnerInfo, ITemplateSummary, TTemplateSender } from './Types';
-import { VerdocsEndpoint } from '../VerdocsEndpoint';
-export interface IGetTemplatesParams {
-    is_starred?: boolean;
-    is_creator?: boolean;
-    is_organization?: boolean;
-}
-/**
- * Get all templates accessible by the caller, with optional filters.
- *
- * ```typescript
- * import {Templates} from '@verdocs/js-sdk/Templates';
- *
- * await Templates.getTemplates((VerdocsEndpoint.getDefault());
- * await Templates.getTemplates((VerdocsEndpoint.getDefault(), { is_starred: true });
- * await Templates.getTemplates((VerdocsEndpoint.getDefault(), { is_creator: true });
- * await Templates.getTemplates((VerdocsEndpoint.getDefault(), { is_organization: true });
- * ```
- */
-export declare const getTemplates: (endpoint: VerdocsEndpoint, params?: IGetTemplatesParams) => Promise<ITemplate[]>;
-/**
- * Lists all templates accessible by the caller, with optional filters.
- *
- * ```typescript
- * import {Templates} from '@verdocs/js-sdk/Templates';
- *
- * await Templates.listTemplates((VerdocsEndpoint.getDefault(), { sharing: 'personal', sort: 'last_used_at' });
- * ```
- */
-/**
- * Get one template by its ID.
- *
- * ```typescript
- * import {Templates} from '@verdocs/js-sdk/Templates';
- *
- * const template = await Templates.getTemplate((VerdocsEndpoint.getDefault(), '83da3d70-7857-4392-b876-c4592a304bc9');
- * ```
- */
-export declare const getTemplate: (endpoint: VerdocsEndpoint, templateId: string) => Promise<ITemplate>;
-/**
- * Get owner information for a template.
- *
- * ```typescript
- * import {Templates} from '@verdocs/js-sdk/Templates';
- *
- * const template = await Templates.getTemplateOwnerInfo((VerdocsEndpoint.getDefault(), '83da3d70-7857-4392-b876-c4592a304bc9');
- * ```
- */
-export declare const getTemplateOwnerInfo: (endpoint: VerdocsEndpoint, templateId: string) => Promise<ITemplateOwnerInfo>;
-/**
- * Represents a document to be attached to a template via an externally-accessible URI. A copy of the document will be
- * downloaded from the specified URI. Note that the URI will be accessed without headers or other authorization methods
- * set, so the URI itself must encode any security tokens or keys required to access the file.
- */
-export interface IDocumentFromUri {
-    /** The URI to retrieve the file from. */
-    uri: string;
-    /** A name for the attachment. */
-    name: string;
-}
-/**
- * Represents a document to be attached to a template via a Base64-encoded string attachment. This is the best option
- * for maximum security but there is a 10MB size limit for the entire creation request. Requests attaching larger files
- * should use `IDocumentFromUri` or add attachments via `createTemplateDocument` after creating the template.
- */
-export interface IDocumentFromData {
-    /** Base64-encoded file data. */
-    data: string;
-    /** A name for the attachment. */
-    name: string;
-}
-export interface ITemplateCreateParams {
-    /** Name for the template to create. */
-    name: string;
-    /**
-     * Optional (defaults to true). Personal templates are only visible to the owner. Non-personal templates are shared
-     * within the user's organization.
-     */
-    is_personal?: boolean;
-    /**
-     * Optional (defaults to false). Public templates may be found (via search) and viewed by anyone.
-     */
-    is_public?: boolean;
-    /** Optional (defaults to EVERYONE_AS_CREATOR). Who may create and send envelopes using this template. */
-    sender?: TTemplateSender;
-    /** Optional description for the template to help identify it. */
-    description?: string;
-    /**
-     * Optional list of roles to create. Documents are required if roles or fields will also be specified. Files may
-     * be attached via a number of methods (browser File object, remote URI reference, or Base64-encoded string) but
-     * all entries must of of the same type. If browser File objects are provided, the request will use a FORM POST
-     * call, otherwise it will use traditional XHR.
-     */
-    documents?: File[] | IDocumentFromUri[] | IDocumentFromData[];
-    /**
-     * Optional list of roles to create. Note that if roles are not included in the request, fields will be ignored.
-     */
-    roles?: IRole[];
-    /**
-     * Optional list of fields to create.
-     */
-    fields?: ITemplateField[];
-}
-/**
- * Create a template.
- *
- * ```typescript
- * import {Templates} from '@verdocs/js-sdk/Templates';
- *
- * const newTemplate = await Templates.createTemplate((VerdocsEndpoint.getDefault(), {...});
- * ```
- */
-export declare const createTemplate: (endpoint: VerdocsEndpoint, params: ITemplateCreateParams, onUploadProgress?: ((percent: number, loadedBytes: number, totalBytes: number) => void) | undefined) => Promise<ITemplate>;
-/**
- * Create a template.
- *
- * ```typescript
- * import {Templates} from '@verdocs/js-sdk/Templates';
- *
- * const newTemplate = await Templates.createTemplatev2((VerdocsEndpoint.getDefault(), {...});
- * ```
- */
-export declare const createTemplatev2: (endpoint: VerdocsEndpoint, params: ITemplateCreateParams, onUploadProgress?: ((percent: number, loadedBytes: number, totalBytes: number) => void) | undefined) => Promise<ITemplate>;
-export interface ITemplateCreateFromSharepointParams {
-    /** Name for the template to create. */
-    name: string;
-    /** The site ID the source file is in. */
-    siteId: string;
-    /** The item ID of the source file. */
-    itemId: string;
-    /**
-     * On-Behalf-Of access token generated for the request. This must have an audience of "https://graph.microsoft.com"
-     * with Read access to the source file. This token is used ephemerally and discarded after the request, but it is
-     * still recommended that you generate it with the minimal permissions possible.
-     */
-    oboToken: string;
-}
-/**
- * Create a template from a Sharepoint asset.
- *
- * ```typescript
- * import {Templates} from '@verdocs/js-sdk/Templates';
- *
- * const newTemplate = await Templates.createTemplateFromSharepoint((VerdocsEndpoint.getDefault(), {...});
- * ```
- */
-export declare const createTemplateFromSharepoint: (endpoint: VerdocsEndpoint, params: ITemplateCreateFromSharepointParams) => Promise<ITemplate>;
-/**
- * Update a template.
- *
- * ```typescript
- * import {Templates} from '@verdocs/js-sdk/Templates';
- *
- * const updatedTemplate = await Templates.updateTemplate((VerdocsEndpoint.getDefault(), '83da3d70-7857-4392-b876-c4592a304bc9', { name: 'New Name' });
- * ```
- */
-export declare const updateTemplate: (endpoint: VerdocsEndpoint, templateId: string, params: Partial<ITemplateCreateParams>) => Promise<ITemplate>;
-/**
- * Delete a template.
- *
- * ```typescript
- * import {Templates} from '@verdocs/js-sdk/Templates';
- *
- * await Templates.deleteTemplate((VerdocsEndpoint.getDefault(), '83da3d70-7857-4392-b876-c4592a304bc9');
- * ```
- */
-export declare const deleteTemplate: (endpoint: VerdocsEndpoint, templateId: string) => Promise<any>;
-export interface ITimePeriod {
-    start_time: string;
-    end_time: string;
-}
-export declare enum SortOptions {
-    CREATED_AT = "created_at",
-    UPDATED_AT = "updated_at",
-    NAME = "name",
-    LAST_USED_AT = "last_used_at",
-    COUNTER = "counter",
-    STAR_COUNTER = "star_counter"
-}
-export interface ITemplateSearchParams {
-    id?: string;
-    name?: string;
-    sender?: string;
-    description?: string;
-    profile_id?: string;
-    organization_id?: string;
-    updated_at?: ITimePeriod;
-    created_at?: ITimePeriod;
-    last_used_at?: ITimePeriod;
-    is_personal?: boolean;
-    is_public?: boolean;
-    tags?: string[];
-    document_name?: string;
-    sort_by?: SortOptions;
-    ascending?: boolean;
-    row?: number;
-    page?: number;
-}
-export interface ITemplateSearchResult {
-    page: number;
-    row: number;
-    total: number;
-    result: ITemplate[];
-}
-/**
- * Search for templates matching various criteria.
- *
- * ```typescript
- * import {Templates} from '@verdocs/js-sdk/Templates';
- *
- * const {result, page, total} = await Templates.search((VerdocsEndpoint.getDefault(), { ... });
- * ```
- */
-export declare const searchTemplates: (endpoint: VerdocsEndpoint, params: ITemplateSearchParams) => Promise<ITemplateSearchResult>;
-export interface ISearchTimeRange {
-    start_time: string;
-    end_time: string;
-}
-export type IGetTemplateSummarySortBy = 'created_at' | 'updated_at' | 'name' | 'last_used_at' | 'counter' | 'star_counter';
-export interface IGetTemplateSummaryParams {
-    id?: string;
-    name?: string;
-    sender?: string;
-    profile_id?: string;
-    organization_id?: string;
-    description?: string;
-    created_at?: ISearchTimeRange;
-    updated_at?: ISearchTimeRange;
-    last_used_at?: ISearchTimeRange;
-    is_personal?: boolean;
-    is_public?: boolean;
-    is_starred?: boolean;
-    sort_by?: IGetTemplateSummarySortBy;
-    ascending?: boolean;
-    row?: number;
-    page?: number;
-}
-/**
- * Get a summary of template data, typically used to populate admin panel dashboard pages.
- *
- * ```typescript
- * import {Templates} from '@verdocs/js-sdk/Templates';
- *
- * const summary = await Templates.getSummary((VerdocsEndpoint.getDefault(), 0);
- * ```
- */
-export declare const getSummary: (endpoint: VerdocsEndpoint, params?: IGetTemplateSummaryParams) => Promise<ITemplateSummary>;
-/**
- * Wrapper for `getTemplate()` that limits queries to one every 2 seconds per template ID.
- * This is intended for use in component hierarchies that all rely on the same template
- * to avoid unnecessary repeat server calls.
- */
-export declare const throttledGetTemplate: (endpoint: VerdocsEndpoint, templateId: string) => ITemplate | Promise<ITemplate>;
-export interface ITemplateListParams {
-    status?: string[];
-    q?: string;
-    created_at?: ITimePeriod;
-    is_personal?: boolean;
-    is_public?: boolean;
-    sort_by?: SortOptions;
-    ascending?: boolean;
-    rows?: number;
-    page?: number;
-}
-/**
- * List templates.
- *
- * ```typescript
- * import {Templates} from '@verdocs/js-sdk/Templates';
- *
- * const {totals, templates} = await Templates.listTemplates((VerdocsEndpoint.getDefault(), { q: 'test', sort: 'created_at' }); * ```
- */
-export declare const listTemplates: (endpoint: VerdocsEndpoint, params?: ITemplateListParams) => Promise<{
-    total: number;
-    rows: number;
-    page: number;
-    templates: ITemplate[];
-}>;