/** * openfilz-api * API for Document Management System * * The version of the OpenAPI document: 1.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import type { Configuration } from '../configuration'; import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; import { type RequestArgs, BaseAPI } from '../base'; import type { CloudSignatureSubscription } from '../models'; import type { CreateSignatureEnvelopeRequest } from '../models'; import type { SignatureEnvelopeDTO } from '../models'; import type { SignatureEventDTO } from '../models'; /** * ESignApi - axios parameter creator */ export declare const ESignApiAxiosParamCreator: (configuration?: Configuration) => { /** * * @summary Cancel a non-terminal envelope * @param {string} id * @param {*} [options] Override http request option. * @throws {RequiredError} */ cancel1: (id: string, options?: RawAxiosRequestConfig) => Promise; /** * * @summary Cloud Signing subscription and month-to-date usage (openfilz-cloud seal provider only) * @param {*} [options] Override http request option. * @throws {RequiredError} */ cloudSubscription: (options?: RawAxiosRequestConfig) => Promise; /** * * @summary Create an envelope (sent immediately unless send=false) * @param {CreateSignatureEnvelopeRequest} createSignatureEnvelopeRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ create: (createSignatureEnvelopeRequest: CreateSignatureEnvelopeRequest, options?: RawAxiosRequestConfig) => Promise; /** * * @summary Audit trail of one of my envelopes * @param {string} id * @param {*} [options] Override http request option. * @throws {RequiredError} */ events: (id: string, options?: RawAxiosRequestConfig) => Promise; /** * * @summary Get one of my envelopes (recipients + fields) * @param {string} id * @param {*} [options] Override http request option. * @throws {RequiredError} */ get2: (id: string, options?: RawAxiosRequestConfig) => Promise; /** * * @summary List envelopes I sent for signature * @param {ListSentStatusEnum} [status] * @param {*} [options] Override http request option. * @throws {RequiredError} */ listSent: (status?: ListSentStatusEnum, options?: RawAxiosRequestConfig) => Promise; /** * * @summary List envelopes waiting for my signature * @param {*} [options] Override http request option. * @throws {RequiredError} */ listToSign: (options?: RawAxiosRequestConfig) => Promise; /** * * @summary Resend the signing link to a recipient (new token, previous one revoked) * @param {string} id * @param {string} recipientId * @param {*} [options] Override http request option. * @throws {RequiredError} */ resend: (id: string, recipientId: string, options?: RawAxiosRequestConfig) => Promise; /** * * @summary Send a DRAFT envelope * @param {string} id * @param {*} [options] Override http request option. * @throws {RequiredError} */ send: (id: string, options?: RawAxiosRequestConfig) => Promise; /** * * @summary Download the sealed PDF of a completed envelope * @param {string} id * @param {*} [options] Override http request option. * @throws {RequiredError} */ signedDocument: (id: string, options?: RawAxiosRequestConfig) => Promise; }; /** * ESignApi - functional programming interface */ export declare const ESignApiFp: (configuration?: Configuration) => { /** * * @summary Cancel a non-terminal envelope * @param {string} id * @param {*} [options] Override http request option. * @throws {RequiredError} */ cancel1(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Cloud Signing subscription and month-to-date usage (openfilz-cloud seal provider only) * @param {*} [options] Override http request option. * @throws {RequiredError} */ cloudSubscription(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Create an envelope (sent immediately unless send=false) * @param {CreateSignatureEnvelopeRequest} createSignatureEnvelopeRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ create(createSignatureEnvelopeRequest: CreateSignatureEnvelopeRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Audit trail of one of my envelopes * @param {string} id * @param {*} [options] Override http request option. * @throws {RequiredError} */ events(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * * @summary Get one of my envelopes (recipients + fields) * @param {string} id * @param {*} [options] Override http request option. * @throws {RequiredError} */ get2(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary List envelopes I sent for signature * @param {ListSentStatusEnum} [status] * @param {*} [options] Override http request option. * @throws {RequiredError} */ listSent(status?: ListSentStatusEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * * @summary List envelopes waiting for my signature * @param {*} [options] Override http request option. * @throws {RequiredError} */ listToSign(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * * @summary Resend the signing link to a recipient (new token, previous one revoked) * @param {string} id * @param {string} recipientId * @param {*} [options] Override http request option. * @throws {RequiredError} */ resend(id: string, recipientId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Send a DRAFT envelope * @param {string} id * @param {*} [options] Override http request option. * @throws {RequiredError} */ send(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Download the sealed PDF of a completed envelope * @param {string} id * @param {*} [options] Override http request option. * @throws {RequiredError} */ signedDocument(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * ESignApi - factory interface */ export declare const ESignApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * * @summary Cancel a non-terminal envelope * @param {string} id * @param {*} [options] Override http request option. * @throws {RequiredError} */ cancel1(id: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * * @summary Cloud Signing subscription and month-to-date usage (openfilz-cloud seal provider only) * @param {*} [options] Override http request option. * @throws {RequiredError} */ cloudSubscription(options?: RawAxiosRequestConfig): AxiosPromise; /** * * @summary Create an envelope (sent immediately unless send=false) * @param {CreateSignatureEnvelopeRequest} createSignatureEnvelopeRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ create(createSignatureEnvelopeRequest: CreateSignatureEnvelopeRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * * @summary Audit trail of one of my envelopes * @param {string} id * @param {*} [options] Override http request option. * @throws {RequiredError} */ events(id: string, options?: RawAxiosRequestConfig): AxiosPromise>; /** * * @summary Get one of my envelopes (recipients + fields) * @param {string} id * @param {*} [options] Override http request option. * @throws {RequiredError} */ get2(id: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * * @summary List envelopes I sent for signature * @param {ListSentStatusEnum} [status] * @param {*} [options] Override http request option. * @throws {RequiredError} */ listSent(status?: ListSentStatusEnum, options?: RawAxiosRequestConfig): AxiosPromise>; /** * * @summary List envelopes waiting for my signature * @param {*} [options] Override http request option. * @throws {RequiredError} */ listToSign(options?: RawAxiosRequestConfig): AxiosPromise>; /** * * @summary Resend the signing link to a recipient (new token, previous one revoked) * @param {string} id * @param {string} recipientId * @param {*} [options] Override http request option. * @throws {RequiredError} */ resend(id: string, recipientId: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * * @summary Send a DRAFT envelope * @param {string} id * @param {*} [options] Override http request option. * @throws {RequiredError} */ send(id: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * * @summary Download the sealed PDF of a completed envelope * @param {string} id * @param {*} [options] Override http request option. * @throws {RequiredError} */ signedDocument(id: string, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * ESignApi - object-oriented interface */ export declare class ESignApi extends BaseAPI { /** * * @summary Cancel a non-terminal envelope * @param {string} id * @param {*} [options] Override http request option. * @throws {RequiredError} */ cancel1(id: string, options?: RawAxiosRequestConfig): Promise>; /** * * @summary Cloud Signing subscription and month-to-date usage (openfilz-cloud seal provider only) * @param {*} [options] Override http request option. * @throws {RequiredError} */ cloudSubscription(options?: RawAxiosRequestConfig): Promise>; /** * * @summary Create an envelope (sent immediately unless send=false) * @param {CreateSignatureEnvelopeRequest} createSignatureEnvelopeRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ create(createSignatureEnvelopeRequest: CreateSignatureEnvelopeRequest, options?: RawAxiosRequestConfig): Promise>; /** * * @summary Audit trail of one of my envelopes * @param {string} id * @param {*} [options] Override http request option. * @throws {RequiredError} */ events(id: string, options?: RawAxiosRequestConfig): Promise>; /** * * @summary Get one of my envelopes (recipients + fields) * @param {string} id * @param {*} [options] Override http request option. * @throws {RequiredError} */ get2(id: string, options?: RawAxiosRequestConfig): Promise>; /** * * @summary List envelopes I sent for signature * @param {ListSentStatusEnum} [status] * @param {*} [options] Override http request option. * @throws {RequiredError} */ listSent(status?: ListSentStatusEnum, options?: RawAxiosRequestConfig): Promise>; /** * * @summary List envelopes waiting for my signature * @param {*} [options] Override http request option. * @throws {RequiredError} */ listToSign(options?: RawAxiosRequestConfig): Promise>; /** * * @summary Resend the signing link to a recipient (new token, previous one revoked) * @param {string} id * @param {string} recipientId * @param {*} [options] Override http request option. * @throws {RequiredError} */ resend(id: string, recipientId: string, options?: RawAxiosRequestConfig): Promise>; /** * * @summary Send a DRAFT envelope * @param {string} id * @param {*} [options] Override http request option. * @throws {RequiredError} */ send(id: string, options?: RawAxiosRequestConfig): Promise>; /** * * @summary Download the sealed PDF of a completed envelope * @param {string} id * @param {*} [options] Override http request option. * @throws {RequiredError} */ signedDocument(id: string, options?: RawAxiosRequestConfig): Promise>; } export declare const ListSentStatusEnum: { readonly Draft: "DRAFT"; readonly Sent: "SENT"; readonly Completed: "COMPLETED"; readonly Declined: "DECLINED"; readonly Cancelled: "CANCELLED"; readonly Expired: "EXPIRED"; }; export type ListSentStatusEnum = typeof ListSentStatusEnum[keyof typeof ListSentStatusEnum];