@openfilz-sdk/typescript 1.2.27 → 1.2.29

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

@@ -0,0 +1,282 @@
+/**
+ * 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 { ApplySignatureRequest } from '../models';
+import type { DeclineSignatureRequest } from '../models';
+import type { PublicSignatureView } from '../models';
+import type { VerifyOtpRequest } from '../models';
+/**
+ * ESignPublicApi - axios parameter creator
+ */
+export declare const ESignPublicApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     *
+     * @summary Decline to sign (voids the envelope)
+     * @param {string} token
+     * @param {DeclineSignatureRequest} [declineSignatureRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    decline: (token: string, declineSignatureRequest?: DeclineSignatureRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Stream the source PDF for signing
+     * @param {string} token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    document: (token: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Record that the recipient opened the document
+     * @param {string} token
+     * @param {string} [userAgent]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    markViewed: (token: string, userAgent?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Send a one-time access code to the recipient (EMAIL_OTP / SMS_OTP)
+     * @param {string} token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    requestOtp: (token: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Submit the recipient\'s fields and sign
+     * @param {string} token
+     * @param {ApplySignatureRequest} applySignatureRequest
+     * @param {string} [userAgent]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    sign: (token: string, applySignatureRequest: ApplySignatureRequest, userAgent?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Verify the one-time access code
+     * @param {string} token
+     * @param {VerifyOtpRequest} verifyOtpRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    verifyOtp: (token: string, verifyOtpRequest: VerifyOtpRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Resolve a signing token to its envelope view
+     * @param {string} token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    view: (token: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * ESignPublicApi - functional programming interface
+ */
+export declare const ESignPublicApiFp: (configuration?: Configuration) => {
+    /**
+     *
+     * @summary Decline to sign (voids the envelope)
+     * @param {string} token
+     * @param {DeclineSignatureRequest} [declineSignatureRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    decline(token: string, declineSignatureRequest?: DeclineSignatureRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PublicSignatureView>>;
+    /**
+     *
+     * @summary Stream the source PDF for signing
+     * @param {string} token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    document(token: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
+    /**
+     *
+     * @summary Record that the recipient opened the document
+     * @param {string} token
+     * @param {string} [userAgent]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    markViewed(token: string, userAgent?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PublicSignatureView>>;
+    /**
+     *
+     * @summary Send a one-time access code to the recipient (EMAIL_OTP / SMS_OTP)
+     * @param {string} token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    requestOtp(token: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     *
+     * @summary Submit the recipient\'s fields and sign
+     * @param {string} token
+     * @param {ApplySignatureRequest} applySignatureRequest
+     * @param {string} [userAgent]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    sign(token: string, applySignatureRequest: ApplySignatureRequest, userAgent?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PublicSignatureView>>;
+    /**
+     *
+     * @summary Verify the one-time access code
+     * @param {string} token
+     * @param {VerifyOtpRequest} verifyOtpRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    verifyOtp(token: string, verifyOtpRequest: VerifyOtpRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PublicSignatureView>>;
+    /**
+     *
+     * @summary Resolve a signing token to its envelope view
+     * @param {string} token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    view(token: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PublicSignatureView>>;
+};
+/**
+ * ESignPublicApi - factory interface
+ */
+export declare const ESignPublicApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     *
+     * @summary Decline to sign (voids the envelope)
+     * @param {string} token
+     * @param {DeclineSignatureRequest} [declineSignatureRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    decline(token: string, declineSignatureRequest?: DeclineSignatureRequest, options?: RawAxiosRequestConfig): AxiosPromise<PublicSignatureView>;
+    /**
+     *
+     * @summary Stream the source PDF for signing
+     * @param {string} token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    document(token: string, options?: RawAxiosRequestConfig): AxiosPromise<File>;
+    /**
+     *
+     * @summary Record that the recipient opened the document
+     * @param {string} token
+     * @param {string} [userAgent]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    markViewed(token: string, userAgent?: string, options?: RawAxiosRequestConfig): AxiosPromise<PublicSignatureView>;
+    /**
+     *
+     * @summary Send a one-time access code to the recipient (EMAIL_OTP / SMS_OTP)
+     * @param {string} token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    requestOtp(token: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     *
+     * @summary Submit the recipient\'s fields and sign
+     * @param {string} token
+     * @param {ApplySignatureRequest} applySignatureRequest
+     * @param {string} [userAgent]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    sign(token: string, applySignatureRequest: ApplySignatureRequest, userAgent?: string, options?: RawAxiosRequestConfig): AxiosPromise<PublicSignatureView>;
+    /**
+     *
+     * @summary Verify the one-time access code
+     * @param {string} token
+     * @param {VerifyOtpRequest} verifyOtpRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    verifyOtp(token: string, verifyOtpRequest: VerifyOtpRequest, options?: RawAxiosRequestConfig): AxiosPromise<PublicSignatureView>;
+    /**
+     *
+     * @summary Resolve a signing token to its envelope view
+     * @param {string} token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    view(token: string, options?: RawAxiosRequestConfig): AxiosPromise<PublicSignatureView>;
+};
+/**
+ * ESignPublicApi - object-oriented interface
+ */
+export declare class ESignPublicApi extends BaseAPI {
+    /**
+     *
+     * @summary Decline to sign (voids the envelope)
+     * @param {string} token
+     * @param {DeclineSignatureRequest} [declineSignatureRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    decline(token: string, declineSignatureRequest?: DeclineSignatureRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PublicSignatureView, any, {}>>;
+    /**
+     *
+     * @summary Stream the source PDF for signing
+     * @param {string} token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    document(token: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any, {}>>;
+    /**
+     *
+     * @summary Record that the recipient opened the document
+     * @param {string} token
+     * @param {string} [userAgent]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    markViewed(token: string, userAgent?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PublicSignatureView, any, {}>>;
+    /**
+     *
+     * @summary Send a one-time access code to the recipient (EMAIL_OTP / SMS_OTP)
+     * @param {string} token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    requestOtp(token: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
+    /**
+     *
+     * @summary Submit the recipient\'s fields and sign
+     * @param {string} token
+     * @param {ApplySignatureRequest} applySignatureRequest
+     * @param {string} [userAgent]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    sign(token: string, applySignatureRequest: ApplySignatureRequest, userAgent?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PublicSignatureView, any, {}>>;
+    /**
+     *
+     * @summary Verify the one-time access code
+     * @param {string} token
+     * @param {VerifyOtpRequest} verifyOtpRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    verifyOtp(token: string, verifyOtpRequest: VerifyOtpRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PublicSignatureView, any, {}>>;
+    /**
+     *
+     * @summary Resolve a signing token to its envelope view
+     * @param {string} token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    view(token: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PublicSignatureView, any, {}>>;
+}