@openfilz-sdk/typescript 1.2.26 → 1.2.28

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

@@ -0,0 +1,234 @@
+/**
+ * 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 { InstantiateTemplateRequest } from '../models';
+import type { SignatureEnvelopeDTO } from '../models';
+import type { SignatureTemplateDTO } from '../models';
+import type { SignatureTemplateRequest } from '../models';
+/**
+ * ESignTemplatesApi - axios parameter creator
+ */
+export declare const ESignTemplatesApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     *
+     * @summary Delete a template
+     * @param {string} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    _delete: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Create a template
+     * @param {SignatureTemplateRequest} signatureTemplateRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    create1: (signatureTemplateRequest: SignatureTemplateRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Get a template
+     * @param {string} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    get: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Create (and send) an envelope from a template
+     * @param {string} id
+     * @param {InstantiateTemplateRequest} instantiateTemplateRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    instantiate: (id: string, instantiateTemplateRequest: InstantiateTemplateRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary List my templates
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    list: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Update a template
+     * @param {string} id
+     * @param {SignatureTemplateRequest} signatureTemplateRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    update: (id: string, signatureTemplateRequest: SignatureTemplateRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * ESignTemplatesApi - functional programming interface
+ */
+export declare const ESignTemplatesApiFp: (configuration?: Configuration) => {
+    /**
+     *
+     * @summary Delete a template
+     * @param {string} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    _delete(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     *
+     * @summary Create a template
+     * @param {SignatureTemplateRequest} signatureTemplateRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    create1(signatureTemplateRequest: SignatureTemplateRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SignatureTemplateDTO>>;
+    /**
+     *
+     * @summary Get a template
+     * @param {string} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    get(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SignatureTemplateDTO>>;
+    /**
+     *
+     * @summary Create (and send) an envelope from a template
+     * @param {string} id
+     * @param {InstantiateTemplateRequest} instantiateTemplateRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    instantiate(id: string, instantiateTemplateRequest: InstantiateTemplateRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SignatureEnvelopeDTO>>;
+    /**
+     *
+     * @summary List my templates
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    list(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<SignatureTemplateDTO>>>;
+    /**
+     *
+     * @summary Update a template
+     * @param {string} id
+     * @param {SignatureTemplateRequest} signatureTemplateRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    update(id: string, signatureTemplateRequest: SignatureTemplateRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SignatureTemplateDTO>>;
+};
+/**
+ * ESignTemplatesApi - factory interface
+ */
+export declare const ESignTemplatesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     *
+     * @summary Delete a template
+     * @param {string} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    _delete(id: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     *
+     * @summary Create a template
+     * @param {SignatureTemplateRequest} signatureTemplateRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    create1(signatureTemplateRequest: SignatureTemplateRequest, options?: RawAxiosRequestConfig): AxiosPromise<SignatureTemplateDTO>;
+    /**
+     *
+     * @summary Get a template
+     * @param {string} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    get(id: string, options?: RawAxiosRequestConfig): AxiosPromise<SignatureTemplateDTO>;
+    /**
+     *
+     * @summary Create (and send) an envelope from a template
+     * @param {string} id
+     * @param {InstantiateTemplateRequest} instantiateTemplateRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    instantiate(id: string, instantiateTemplateRequest: InstantiateTemplateRequest, options?: RawAxiosRequestConfig): AxiosPromise<SignatureEnvelopeDTO>;
+    /**
+     *
+     * @summary List my templates
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    list(options?: RawAxiosRequestConfig): AxiosPromise<Array<SignatureTemplateDTO>>;
+    /**
+     *
+     * @summary Update a template
+     * @param {string} id
+     * @param {SignatureTemplateRequest} signatureTemplateRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    update(id: string, signatureTemplateRequest: SignatureTemplateRequest, options?: RawAxiosRequestConfig): AxiosPromise<SignatureTemplateDTO>;
+};
+/**
+ * ESignTemplatesApi - object-oriented interface
+ */
+export declare class ESignTemplatesApi extends BaseAPI {
+    /**
+     *
+     * @summary Delete a template
+     * @param {string} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    _delete(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
+    /**
+     *
+     * @summary Create a template
+     * @param {SignatureTemplateRequest} signatureTemplateRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    create1(signatureTemplateRequest: SignatureTemplateRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SignatureTemplateDTO, any, {}>>;
+    /**
+     *
+     * @summary Get a template
+     * @param {string} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    get(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SignatureTemplateDTO, any, {}>>;
+    /**
+     *
+     * @summary Create (and send) an envelope from a template
+     * @param {string} id
+     * @param {InstantiateTemplateRequest} instantiateTemplateRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    instantiate(id: string, instantiateTemplateRequest: InstantiateTemplateRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SignatureEnvelopeDTO, any, {}>>;
+    /**
+     *
+     * @summary List my templates
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    list(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SignatureTemplateDTO[], any, {}>>;
+    /**
+     *
+     * @summary Update a template
+     * @param {string} id
+     * @param {SignatureTemplateRequest} signatureTemplateRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    update(id: string, signatureTemplateRequest: SignatureTemplateRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SignatureTemplateDTO, any, {}>>;
+}