import { SignRequest } from '../schemas/signRequest.generated.js'; import { SignRequests } from '../schemas/signRequests.generated.js'; import { SignRequestCreateRequest } from '../schemas/signRequestCreateRequest.generated.js'; import { Authentication } from '../networking/auth.generated.js'; import { NetworkSession } from '../networking/network.generated.js'; import { CancellationToken } from '../internal/utils.js'; export declare class CancelSignRequestOptionals { readonly headers: CancelSignRequestHeaders; readonly cancellationToken?: CancellationToken; constructor(fields: Omit & Partial>); } export interface CancelSignRequestOptionalsInput { readonly headers?: CancelSignRequestHeaders; readonly cancellationToken?: undefined | CancellationToken; } export declare class ResendSignRequestOptionals { readonly headers: ResendSignRequestHeaders; readonly cancellationToken?: CancellationToken; constructor(fields: Omit & Partial>); } export interface ResendSignRequestOptionalsInput { readonly headers?: ResendSignRequestHeaders; readonly cancellationToken?: undefined | CancellationToken; } export declare class GetSignRequestByIdOptionals { readonly headers: GetSignRequestByIdHeaders; readonly cancellationToken?: CancellationToken; constructor(fields: Omit & Partial>); } export interface GetSignRequestByIdOptionalsInput { readonly headers?: GetSignRequestByIdHeaders; readonly cancellationToken?: undefined | CancellationToken; } export declare class CreateSignRequestOptionals { readonly headers: CreateSignRequestHeaders; readonly cancellationToken?: CancellationToken; constructor(fields: Omit & Partial>); } export interface CreateSignRequestOptionalsInput { readonly headers?: CreateSignRequestHeaders; readonly cancellationToken?: undefined | CancellationToken; } export declare class CancelSignRequestHeaders { /** * Extra headers that will be included in the HTTP request. */ readonly extraHeaders?: { readonly [key: string]: undefined | string; }; constructor(fields: Omit & Partial>); } export interface CancelSignRequestHeadersInput { /** * Extra headers that will be included in the HTTP request. */ readonly extraHeaders?: undefined | { readonly [key: string]: undefined | string; }; } export declare class ResendSignRequestHeaders { /** * Extra headers that will be included in the HTTP request. */ readonly extraHeaders?: { readonly [key: string]: undefined | string; }; constructor(fields: Omit & Partial>); } export interface ResendSignRequestHeadersInput { /** * Extra headers that will be included in the HTTP request. */ readonly extraHeaders?: undefined | { readonly [key: string]: undefined | string; }; } export declare class GetSignRequestByIdHeaders { /** * Extra headers that will be included in the HTTP request. */ readonly extraHeaders?: { readonly [key: string]: undefined | string; }; constructor(fields: Omit & Partial>); } export interface GetSignRequestByIdHeadersInput { /** * Extra headers that will be included in the HTTP request. */ readonly extraHeaders?: undefined | { readonly [key: string]: undefined | string; }; } export interface GetSignRequestsQueryParams { /** * Defines the position marker at which to begin returning results. This is * used when paginating using marker-based pagination. * * This requires `usemarker` to be set to `true`. */ readonly marker?: string; /** * The maximum number of items to return per page. */ readonly limit?: number; /** * A list of sender emails to filter the signature requests by sender. * If provided, `shared_requests` must be set to `true`. */ readonly senders?: readonly string[]; /** * If set to `true`, only includes requests that user is not an owner, * but user is a collaborator. Collaborator access is determined by the * user access level of the sign files of the request. * Default is `false`. Must be set to `true` if `senders` are provided. */ readonly sharedRequests?: boolean; } export declare class GetSignRequestsHeaders { /** * Extra headers that will be included in the HTTP request. */ readonly extraHeaders?: { readonly [key: string]: undefined | string; }; constructor(fields: Omit & Partial>); } export interface GetSignRequestsHeadersInput { /** * Extra headers that will be included in the HTTP request. */ readonly extraHeaders?: undefined | { readonly [key: string]: undefined | string; }; } export declare class CreateSignRequestHeaders { /** * Extra headers that will be included in the HTTP request. */ readonly extraHeaders?: { readonly [key: string]: undefined | string; }; constructor(fields: Omit & Partial>); } export interface CreateSignRequestHeadersInput { /** * Extra headers that will be included in the HTTP request. */ readonly extraHeaders?: undefined | { readonly [key: string]: undefined | string; }; } export declare class SignRequestsManager { readonly auth?: Authentication; readonly networkSession: NetworkSession; constructor(fields: Omit & Partial>); /** * Cancels a sign request. * @param {string} signRequestId The ID of the signature request. Example: "33243242" * @param {CancelSignRequestOptionalsInput} optionalsInput * @returns {Promise} */ cancelSignRequest(signRequestId: string, optionalsInput?: CancelSignRequestOptionalsInput): Promise; /** * Resends a signature request email to all outstanding signers. * @param {string} signRequestId The ID of the signature request. Example: "33243242" * @param {ResendSignRequestOptionalsInput} optionalsInput * @returns {Promise} */ resendSignRequest(signRequestId: string, optionalsInput?: ResendSignRequestOptionalsInput): Promise; /** * Gets a sign request by ID. * @param {string} signRequestId The ID of the signature request. Example: "33243242" * @param {GetSignRequestByIdOptionalsInput} optionalsInput * @returns {Promise} */ getSignRequestById(signRequestId: string, optionalsInput?: GetSignRequestByIdOptionalsInput): Promise; /** * Gets signature requests created by a user. If the `sign_files` and/or * `parent_folder` are deleted, the signature request will not return in the list. * @param {GetSignRequestsQueryParams} queryParams Query parameters of getSignRequests method * @param {GetSignRequestsHeadersInput} headersInput Headers of getSignRequests method * @param {CancellationToken} cancellationToken Token used for request cancellation. * @returns {Promise} */ getSignRequests(queryParams?: GetSignRequestsQueryParams, headersInput?: GetSignRequestsHeadersInput, cancellationToken?: CancellationToken): Promise; /** * Creates a signature request. This involves preparing a document for signing and * sending the signature request to signers. * @param {SignRequestCreateRequest} requestBody Request body of createSignRequest method * @param {CreateSignRequestOptionalsInput} optionalsInput * @returns {Promise} */ createSignRequest(requestBody: SignRequestCreateRequest, optionalsInput?: CreateSignRequestOptionalsInput): Promise; } export interface SignRequestsManagerInput { readonly auth?: Authentication; readonly networkSession?: NetworkSession; } //# sourceMappingURL=signRequests.generated.d.ts.map