@openfilz-sdk/typescript-ee 1.8.1 → 1.8.2

package/dist/api/esign-api.d.ts

@@ -0,0 +1,334 @@
+/**
+ * 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 { 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}
+     */
+    cancel: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @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<RequestArgs>;
+    /**
+     *
+     * @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<RequestArgs>;
+    /**
+     *
+     * @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<RequestArgs>;
+    /**
+     *
+     * @summary List envelopes I sent for signature
+     * @param {ListSentStatusEnum} [status]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listSent: (status?: ListSentStatusEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary List envelopes waiting for my signature
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listToSign: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @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<RequestArgs>;
+    /**
+     *
+     * @summary Send a DRAFT envelope
+     * @param {string} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    send: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @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<RequestArgs>;
+};
+/**
+ * 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}
+     */
+    cancel(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SignatureEnvelopeDTO>>;
+    /**
+     *
+     * @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<SignatureEnvelopeDTO>>;
+    /**
+     *
+     * @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<Array<SignatureEventDTO>>>;
+    /**
+     *
+     * @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<SignatureEnvelopeDTO>>;
+    /**
+     *
+     * @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<Array<SignatureEnvelopeDTO>>>;
+    /**
+     *
+     * @summary List envelopes waiting for my signature
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listToSign(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<SignatureEnvelopeDTO>>>;
+    /**
+     *
+     * @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<SignatureEnvelopeDTO>>;
+    /**
+     *
+     * @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<SignatureEnvelopeDTO>>;
+    /**
+     *
+     * @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<File>>;
+};
+/**
+ * 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}
+     */
+    cancel(id: string, options?: RawAxiosRequestConfig): AxiosPromise<SignatureEnvelopeDTO>;
+    /**
+     *
+     * @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<SignatureEnvelopeDTO>;
+    /**
+     *
+     * @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<Array<SignatureEventDTO>>;
+    /**
+     *
+     * @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<SignatureEnvelopeDTO>;
+    /**
+     *
+     * @summary List envelopes I sent for signature
+     * @param {ListSentStatusEnum} [status]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listSent(status?: ListSentStatusEnum, options?: RawAxiosRequestConfig): AxiosPromise<Array<SignatureEnvelopeDTO>>;
+    /**
+     *
+     * @summary List envelopes waiting for my signature
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listToSign(options?: RawAxiosRequestConfig): AxiosPromise<Array<SignatureEnvelopeDTO>>;
+    /**
+     *
+     * @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<SignatureEnvelopeDTO>;
+    /**
+     *
+     * @summary Send a DRAFT envelope
+     * @param {string} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    send(id: string, options?: RawAxiosRequestConfig): AxiosPromise<SignatureEnvelopeDTO>;
+    /**
+     *
+     * @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<File>;
+};
+/**
+ * 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}
+     */
+    cancel(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SignatureEnvelopeDTO, any, {}, any>>;
+    /**
+     *
+     * @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<import("axios").AxiosResponse<SignatureEnvelopeDTO, any, {}, any>>;
+    /**
+     *
+     * @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<import("axios").AxiosResponse<SignatureEventDTO[], any, {}, any>>;
+    /**
+     *
+     * @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<import("axios").AxiosResponse<SignatureEnvelopeDTO, any, {}, any>>;
+    /**
+     *
+     * @summary List envelopes I sent for signature
+     * @param {ListSentStatusEnum} [status]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listSent(status?: ListSentStatusEnum, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SignatureEnvelopeDTO[], any, {}, any>>;
+    /**
+     *
+     * @summary List envelopes waiting for my signature
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listToSign(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SignatureEnvelopeDTO[], any, {}, any>>;
+    /**
+     *
+     * @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<import("axios").AxiosResponse<SignatureEnvelopeDTO, any, {}, any>>;
+    /**
+     *
+     * @summary Send a DRAFT envelope
+     * @param {string} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    send(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SignatureEnvelopeDTO, any, {}, any>>;
+    /**
+     *
+     * @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<import("axios").AxiosResponse<File, any, {}, any>>;
+}
+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];