@docuseal/api/types/api.d.ts

JavaScript / TypeScript library for the DocuSeal API

import { GetTemplatesResponse, GetTemplateResponse, GetTemplatesQuery, CreateTemplateFromDocxResponse, CreateTemplateFromDocxData, CreateTemplateFromHtmlData, CreateTemplateFromHtmlResponse, CreateTemplateFromPdfData, CreateTemplateFromPdfResponse, MergeTemplateData, MergeTemplateResponse, CloneTemplateData, CloneTemplateResponse, UpdateTemplateData, UpdateTemplateResponse, UpdateTemplateDocumentsData, UpdateTemplateDocumentsResponse, ArchiveTemplateResponse, GetSubmissionsQuery, GetSubmissionsResponse, GetSubmissionResponse, UpdateSubmissionData, UpdateSubmissionResponse, CreateSubmissionData, CreateSubmissionResponse as CreateSubmissionLegacyResponse, CreateSubmissionsFromEmailsData, CreateSubmissionsFromEmailsResponse, CreateSubmissionFromPdfData, CreateSubmissionFromPdfResponse, CreateSubmissionFromHtmlData, CreateSubmissionFromHtmlResponse, CreateSubmissionFromDocxData, CreateSubmissionFromDocxResponse, ArchiveSubmissionResponse, GetSubmitterResponse, UpdateSubmitterData, UpdateSubmitterResponse, GetSubmittersQuery, GetSubmittersResponse, GetSubmissionDocumentsQuery, GetSubmissionDocumentsResponse } from "./types.js";
export type { GetTemplatesResponse, GetTemplateResponse, GetTemplatesQuery, CreateTemplateFromDocxResponse, CreateTemplateFromDocxData, CreateTemplateFromHtmlData, CreateTemplateFromHtmlResponse, CreateTemplateFromPdfData, CreateTemplateFromPdfResponse, MergeTemplateData, MergeTemplateResponse, CloneTemplateData, CloneTemplateResponse, UpdateTemplateData, UpdateTemplateResponse, UpdateTemplateDocumentsData, UpdateTemplateDocumentsData as AddDocumentToTemplateData, UpdateTemplateDocumentsResponse, UpdateTemplateDocumentsResponse as AddDocumentToTemplateResponse, ArchiveTemplateResponse, GetSubmissionsQuery, GetSubmissionsResponse, GetSubmissionResponse, UpdateSubmissionData, UpdateSubmissionResponse, CreateSubmissionData, CreateSubmissionsFromEmailsData, CreateSubmissionsFromEmailsResponse, CreateSubmissionFromPdfData, CreateSubmissionFromPdfResponse, CreateSubmissionFromHtmlData, CreateSubmissionFromHtmlResponse, CreateSubmissionFromDocxData, CreateSubmissionFromDocxResponse, ArchiveSubmissionResponse, GetSubmitterResponse, UpdateSubmitterData, UpdateSubmitterResponse, GetSubmittersQuery, GetSubmittersResponse, GetSubmissionDocumentsQuery, GetSubmissionDocumentsResponse };
export type DocusealConfig = {
    key?: string;
    url?: string;
    openTimeout?: number;
    userAgent?: string;
};
export type CreateSubmissionResponse = {
    id: number;
    submitters: CreateSubmissionLegacyResponse;
    expire_at: string | null;
    created_at: string;
};
type IncludeQuery = {
    include?: string;
};
export type GetTemplateQuery = IncludeQuery;
export type GetSubmissionQuery = IncludeQuery;
export type GetSubmitterQuery = IncludeQuery;
export declare class DocusealApi {
    private http;
    key: string;
    url: string;
    openTimeout: number;
    userAgent?: string;
    constructor(config?: DocusealConfig);
    configure(config?: DocusealConfig): void;
    listTemplates(query?: GetTemplatesQuery): Promise<GetTemplatesResponse>;
    getTemplate(id: number, query?: GetTemplateQuery): Promise<GetTemplateResponse>;
    createTemplateFromDocx(data: CreateTemplateFromDocxData): Promise<CreateTemplateFromDocxResponse>;
    createTemplateFromHtml(data: CreateTemplateFromHtmlData): Promise<CreateTemplateFromHtmlResponse>;
    createTemplateFromPdf(data: CreateTemplateFromPdfData): Promise<CreateTemplateFromPdfResponse>;
    mergeTemplates(data: MergeTemplateData): Promise<MergeTemplateResponse>;
    cloneTemplate(id: number, data: CloneTemplateData): Promise<CloneTemplateResponse>;
    updateTemplate(id: number, data: UpdateTemplateData): Promise<UpdateTemplateResponse>;
    updateTemplateDocuments(id: number, data: UpdateTemplateDocumentsData): Promise<UpdateTemplateDocumentsResponse>;
    archiveTemplate(id: number): Promise<ArchiveTemplateResponse>;
    permanentlyDeleteTemplate(id: number): Promise<ArchiveTemplateResponse>;
    listSubmissions(query?: GetSubmissionsQuery): Promise<GetSubmissionsResponse>;
    getSubmission(id: number, query?: GetSubmissionQuery): Promise<GetSubmissionResponse>;
    getSubmissionDocuments(id: number, query?: GetSubmissionDocumentsQuery): Promise<GetSubmissionDocumentsResponse>;
    createSubmission(data: CreateSubmissionData): Promise<CreateSubmissionResponse>;
    createSubmissionFromEmails(data: CreateSubmissionsFromEmailsData): Promise<CreateSubmissionsFromEmailsResponse>;
    createSubmissionFromPdf(data: CreateSubmissionFromPdfData): Promise<CreateSubmissionFromPdfResponse>;
    createSubmissionFromHtml(data: CreateSubmissionFromHtmlData): Promise<CreateSubmissionFromHtmlResponse>;
    createSubmissionFromDocx(data: CreateSubmissionFromDocxData): Promise<CreateSubmissionFromDocxResponse>;
    updateSubmission(id: number, data: UpdateSubmissionData): Promise<UpdateSubmissionResponse>;
    archiveSubmission(id: number): Promise<ArchiveSubmissionResponse>;
    permanentlyDeleteSubmission(id: number): Promise<ArchiveSubmissionResponse>;
    listSubmitters(query?: GetSubmittersQuery): Promise<GetSubmittersResponse>;
    getSubmitter(id: number, query?: GetSubmitterQuery): Promise<GetSubmitterResponse>;
    updateSubmitter(id: number, data: UpdateSubmitterData): Promise<UpdateSubmitterResponse>;
}