/* tslint:disable */ /* eslint-disable */ /** * 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 globalAxios from 'axios'; // Some imports not used depending on template conditions // @ts-ignore import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction, replaceWithSerializableTypeIfNeeded } from '../common'; // @ts-ignore import { BASE_PATH, COLLECTION_FORMATS, type RequestArgs, BaseAPI, RequiredError, operationServerMap } from '../base'; // @ts-ignore import type { CloudSignatureSubscription } from '../models'; // @ts-ignore import type { CreateSignatureEnvelopeRequest } from '../models'; // @ts-ignore import type { SignatureEnvelopeDTO } from '../models'; // @ts-ignore import type { SignatureEventDTO } from '../models'; /** * ESignApi - axios parameter creator */ export const ESignApiAxiosParamCreator = function (configuration?: Configuration) { return { /** * * @summary Cancel a non-terminal envelope * @param {string} id * @param {*} [options] Override http request option. * @throws {RequiredError} */ cancel1: async (id: string, options: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'id' is not null or undefined assertParamExists('cancel1', 'id', id) const localVarPath = `/api/v1/signatures/{id}/cancel` .replace('{id}', encodeURIComponent(String(id))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; // authentication keycloak_auth required // http bearer authentication required await setBearerAuthToObject(localVarHeaderParameter, configuration) localVarHeaderParameter['Accept'] = 'application/json'; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; return { url: toPathString(localVarUrlObj), options: localVarRequestOptions, }; }, /** * * @summary Cloud Signing subscription and month-to-date usage (openfilz-cloud seal provider only) * @param {*} [options] Override http request option. * @throws {RequiredError} */ cloudSubscription: async (options: RawAxiosRequestConfig = {}): Promise => { const localVarPath = `/api/v1/signatures/cloud-subscription`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; // authentication keycloak_auth required // http bearer authentication required await setBearerAuthToObject(localVarHeaderParameter, configuration) localVarHeaderParameter['Accept'] = 'application/json'; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; return { url: toPathString(localVarUrlObj), options: localVarRequestOptions, }; }, /** * * @summary Create an envelope (sent immediately unless send=false) * @param {CreateSignatureEnvelopeRequest} createSignatureEnvelopeRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ create: async (createSignatureEnvelopeRequest: CreateSignatureEnvelopeRequest, options: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'createSignatureEnvelopeRequest' is not null or undefined assertParamExists('create', 'createSignatureEnvelopeRequest', createSignatureEnvelopeRequest) const localVarPath = `/api/v1/signatures`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; // authentication keycloak_auth required // http bearer authentication required await setBearerAuthToObject(localVarHeaderParameter, configuration) localVarHeaderParameter['Content-Type'] = 'application/json'; localVarHeaderParameter['Accept'] = 'application/json'; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; localVarRequestOptions.data = serializeDataIfNeeded(createSignatureEnvelopeRequest, localVarRequestOptions, configuration) return { url: toPathString(localVarUrlObj), options: localVarRequestOptions, }; }, /** * * @summary Audit trail of one of my envelopes * @param {string} id * @param {*} [options] Override http request option. * @throws {RequiredError} */ events: async (id: string, options: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'id' is not null or undefined assertParamExists('events', 'id', id) const localVarPath = `/api/v1/signatures/{id}/events` .replace('{id}', encodeURIComponent(String(id))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; // authentication keycloak_auth required // http bearer authentication required await setBearerAuthToObject(localVarHeaderParameter, configuration) localVarHeaderParameter['Accept'] = 'application/json'; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; return { url: toPathString(localVarUrlObj), options: localVarRequestOptions, }; }, /** * * @summary Get one of my envelopes (recipients + fields) * @param {string} id * @param {*} [options] Override http request option. * @throws {RequiredError} */ get2: async (id: string, options: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'id' is not null or undefined assertParamExists('get2', 'id', id) const localVarPath = `/api/v1/signatures/{id}` .replace('{id}', encodeURIComponent(String(id))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; // authentication keycloak_auth required // http bearer authentication required await setBearerAuthToObject(localVarHeaderParameter, configuration) localVarHeaderParameter['Accept'] = 'application/json'; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; return { url: toPathString(localVarUrlObj), options: localVarRequestOptions, }; }, /** * * @summary List envelopes I sent for signature * @param {ListSentStatusEnum} [status] * @param {*} [options] Override http request option. * @throws {RequiredError} */ listSent: async (status?: ListSentStatusEnum, options: RawAxiosRequestConfig = {}): Promise => { const localVarPath = `/api/v1/signatures`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; // authentication keycloak_auth required // http bearer authentication required await setBearerAuthToObject(localVarHeaderParameter, configuration) if (status !== undefined) { localVarQueryParameter['status'] = status; } localVarHeaderParameter['Accept'] = 'application/json'; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; return { url: toPathString(localVarUrlObj), options: localVarRequestOptions, }; }, /** * * @summary List envelopes waiting for my signature * @param {*} [options] Override http request option. * @throws {RequiredError} */ listToSign: async (options: RawAxiosRequestConfig = {}): Promise => { const localVarPath = `/api/v1/signatures/to-sign`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; // authentication keycloak_auth required // http bearer authentication required await setBearerAuthToObject(localVarHeaderParameter, configuration) localVarHeaderParameter['Accept'] = 'application/json'; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; return { url: toPathString(localVarUrlObj), options: localVarRequestOptions, }; }, /** * * @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: async (id: string, recipientId: string, options: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'id' is not null or undefined assertParamExists('resend', 'id', id) // verify required parameter 'recipientId' is not null or undefined assertParamExists('resend', 'recipientId', recipientId) const localVarPath = `/api/v1/signatures/{id}/recipients/{recipientId}/resend` .replace('{id}', encodeURIComponent(String(id))) .replace('{recipientId}', encodeURIComponent(String(recipientId))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; // authentication keycloak_auth required // http bearer authentication required await setBearerAuthToObject(localVarHeaderParameter, configuration) localVarHeaderParameter['Accept'] = 'application/json'; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; return { url: toPathString(localVarUrlObj), options: localVarRequestOptions, }; }, /** * * @summary Send a DRAFT envelope * @param {string} id * @param {*} [options] Override http request option. * @throws {RequiredError} */ send: async (id: string, options: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'id' is not null or undefined assertParamExists('send', 'id', id) const localVarPath = `/api/v1/signatures/{id}/send` .replace('{id}', encodeURIComponent(String(id))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; // authentication keycloak_auth required // http bearer authentication required await setBearerAuthToObject(localVarHeaderParameter, configuration) localVarHeaderParameter['Accept'] = 'application/json'; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; return { url: toPathString(localVarUrlObj), options: localVarRequestOptions, }; }, /** * * @summary Download the sealed PDF of a completed envelope * @param {string} id * @param {*} [options] Override http request option. * @throws {RequiredError} */ signedDocument: async (id: string, options: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'id' is not null or undefined assertParamExists('signedDocument', 'id', id) const localVarPath = `/api/v1/signatures/{id}/signed-document` .replace('{id}', encodeURIComponent(String(id))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; // authentication keycloak_auth required // http bearer authentication required await setBearerAuthToObject(localVarHeaderParameter, configuration) localVarHeaderParameter['Accept'] = 'application/pdf'; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; return { url: toPathString(localVarUrlObj), options: localVarRequestOptions, }; }, } }; /** * ESignApi - functional programming interface */ export const ESignApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = ESignApiAxiosParamCreator(configuration) return { /** * * @summary Cancel a non-terminal envelope * @param {string} id * @param {*} [options] Override http request option. * @throws {RequiredError} */ async cancel1(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.cancel1(id, options); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['ESignApi.cancel1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * * @summary Cloud Signing subscription and month-to-date usage (openfilz-cloud seal provider only) * @param {*} [options] Override http request option. * @throws {RequiredError} */ async cloudSubscription(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.cloudSubscription(options); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['ESignApi.cloudSubscription']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * * @summary Create an envelope (sent immediately unless send=false) * @param {CreateSignatureEnvelopeRequest} createSignatureEnvelopeRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ async create(createSignatureEnvelopeRequest: CreateSignatureEnvelopeRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.create(createSignatureEnvelopeRequest, options); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['ESignApi.create']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * * @summary Audit trail of one of my envelopes * @param {string} id * @param {*} [options] Override http request option. * @throws {RequiredError} */ async events(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { const localVarAxiosArgs = await localVarAxiosParamCreator.events(id, options); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['ESignApi.events']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * * @summary Get one of my envelopes (recipients + fields) * @param {string} id * @param {*} [options] Override http request option. * @throws {RequiredError} */ async get2(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.get2(id, options); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['ESignApi.get2']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * * @summary List envelopes I sent for signature * @param {ListSentStatusEnum} [status] * @param {*} [options] Override http request option. * @throws {RequiredError} */ async listSent(status?: ListSentStatusEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { const localVarAxiosArgs = await localVarAxiosParamCreator.listSent(status, options); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['ESignApi.listSent']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * * @summary List envelopes waiting for my signature * @param {*} [options] Override http request option. * @throws {RequiredError} */ async listToSign(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { const localVarAxiosArgs = await localVarAxiosParamCreator.listToSign(options); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['ESignApi.listToSign']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * * @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} */ async resend(id: string, recipientId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.resend(id, recipientId, options); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['ESignApi.resend']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * * @summary Send a DRAFT envelope * @param {string} id * @param {*} [options] Override http request option. * @throws {RequiredError} */ async send(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.send(id, options); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['ESignApi.send']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * * @summary Download the sealed PDF of a completed envelope * @param {string} id * @param {*} [options] Override http request option. * @throws {RequiredError} */ async signedDocument(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.signedDocument(id, options); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['ESignApi.signedDocument']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, } }; /** * ESignApi - factory interface */ export const ESignApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { const localVarFp = ESignApiFp(configuration) return { /** * * @summary Cancel a non-terminal envelope * @param {string} id * @param {*} [options] Override http request option. * @throws {RequiredError} */ cancel1(id: string, options?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.cancel1(id, options).then((request) => request(axios, basePath)); }, /** * * @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 { return localVarFp.cloudSubscription(options).then((request) => request(axios, basePath)); }, /** * * @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 { return localVarFp.create(createSignatureEnvelopeRequest, options).then((request) => request(axios, basePath)); }, /** * * @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> { return localVarFp.events(id, options).then((request) => request(axios, basePath)); }, /** * * @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 { return localVarFp.get2(id, options).then((request) => request(axios, basePath)); }, /** * * @summary List envelopes I sent for signature * @param {ListSentStatusEnum} [status] * @param {*} [options] Override http request option. * @throws {RequiredError} */ listSent(status?: ListSentStatusEnum, options?: RawAxiosRequestConfig): AxiosPromise> { return localVarFp.listSent(status, options).then((request) => request(axios, basePath)); }, /** * * @summary List envelopes waiting for my signature * @param {*} [options] Override http request option. * @throws {RequiredError} */ listToSign(options?: RawAxiosRequestConfig): AxiosPromise> { return localVarFp.listToSign(options).then((request) => request(axios, basePath)); }, /** * * @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 { return localVarFp.resend(id, recipientId, options).then((request) => request(axios, basePath)); }, /** * * @summary Send a DRAFT envelope * @param {string} id * @param {*} [options] Override http request option. * @throws {RequiredError} */ send(id: string, options?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.send(id, options).then((request) => request(axios, basePath)); }, /** * * @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 { return localVarFp.signedDocument(id, options).then((request) => request(axios, basePath)); }, }; }; /** * ESignApi - object-oriented interface */ export class ESignApi extends BaseAPI { /** * * @summary Cancel a non-terminal envelope * @param {string} id * @param {*} [options] Override http request option. * @throws {RequiredError} */ public cancel1(id: string, options?: RawAxiosRequestConfig) { return ESignApiFp(this.configuration).cancel1(id, options).then((request) => request(this.axios, this.basePath)); } /** * * @summary Cloud Signing subscription and month-to-date usage (openfilz-cloud seal provider only) * @param {*} [options] Override http request option. * @throws {RequiredError} */ public cloudSubscription(options?: RawAxiosRequestConfig) { return ESignApiFp(this.configuration).cloudSubscription(options).then((request) => request(this.axios, this.basePath)); } /** * * @summary Create an envelope (sent immediately unless send=false) * @param {CreateSignatureEnvelopeRequest} createSignatureEnvelopeRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ public create(createSignatureEnvelopeRequest: CreateSignatureEnvelopeRequest, options?: RawAxiosRequestConfig) { return ESignApiFp(this.configuration).create(createSignatureEnvelopeRequest, options).then((request) => request(this.axios, this.basePath)); } /** * * @summary Audit trail of one of my envelopes * @param {string} id * @param {*} [options] Override http request option. * @throws {RequiredError} */ public events(id: string, options?: RawAxiosRequestConfig) { return ESignApiFp(this.configuration).events(id, options).then((request) => request(this.axios, this.basePath)); } /** * * @summary Get one of my envelopes (recipients + fields) * @param {string} id * @param {*} [options] Override http request option. * @throws {RequiredError} */ public get2(id: string, options?: RawAxiosRequestConfig) { return ESignApiFp(this.configuration).get2(id, options).then((request) => request(this.axios, this.basePath)); } /** * * @summary List envelopes I sent for signature * @param {ListSentStatusEnum} [status] * @param {*} [options] Override http request option. * @throws {RequiredError} */ public listSent(status?: ListSentStatusEnum, options?: RawAxiosRequestConfig) { return ESignApiFp(this.configuration).listSent(status, options).then((request) => request(this.axios, this.basePath)); } /** * * @summary List envelopes waiting for my signature * @param {*} [options] Override http request option. * @throws {RequiredError} */ public listToSign(options?: RawAxiosRequestConfig) { return ESignApiFp(this.configuration).listToSign(options).then((request) => request(this.axios, this.basePath)); } /** * * @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} */ public resend(id: string, recipientId: string, options?: RawAxiosRequestConfig) { return ESignApiFp(this.configuration).resend(id, recipientId, options).then((request) => request(this.axios, this.basePath)); } /** * * @summary Send a DRAFT envelope * @param {string} id * @param {*} [options] Override http request option. * @throws {RequiredError} */ public send(id: string, options?: RawAxiosRequestConfig) { return ESignApiFp(this.configuration).send(id, options).then((request) => request(this.axios, this.basePath)); } /** * * @summary Download the sealed PDF of a completed envelope * @param {string} id * @param {*} [options] Override http request option. * @throws {RequiredError} */ public signedDocument(id: string, options?: RawAxiosRequestConfig) { return ESignApiFp(this.configuration).signedDocument(id, options).then((request) => request(this.axios, this.basePath)); } } export const ListSentStatusEnum = { Draft: 'DRAFT', Sent: 'SENT', Completed: 'COMPLETED', Declined: 'DECLINED', Cancelled: 'CANCELLED', Expired: 'EXPIRED', } as const; export type ListSentStatusEnum = typeof ListSentStatusEnum[keyof typeof ListSentStatusEnum];