/**
* Dropsigner
* Authentication
In order to call this APIs, you will need an API key. Set the API key in the header X-Api-Key:
X-Api-Key: your-app|xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
HTTP Codes
The APIs will return the following HTTP codes:
| Code | Description |
| 200 (OK) | Request processed successfully. The response is different for each API, please refer to the operation\'s documentation |
| 400 (Bad Request) | Syntax error. For instance, when a required field was not provided |
| 401 (Unauthorized) | API key not provided or invalid |
| 403 (Forbidden) | API key is valid, but the application has insufficient permissions to complete the requested operation |
| 422 (Unprocessable Entity) | API error. The response is as defined in ErrorModel |
Error Codes
Some of the error codes returned in a 422 response are provided bellow*:
- CertificateNotFound
- DocumentNotFound
- FolderNotFound
- CpfMismatch
- CpfNotExpected
- InvalidFlowAction
- DocumentInvalidKey
*The codes shown above are the main error codes. Nonetheless, this list is not comprehensive. New codes may be added anytime without previous warning.
Webhooks
It is recomended to subscribe to Webhook events instead of polling APIs. To do so, enable webhooks and register an URL that will receive a POST request whenever one of the events bellow occur.
All requests have the format described in Webhooks.WebhookModel. The data field varies according to the webhook event type:
To register your application URL and enable Webhooks, access the integrations section in your organization\'s details page.
*
* The version of the OpenAPI document: 2.6.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 { Configuration } from './configuration';
import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
import { RequestArgs, BaseAPI } from './base';
/**
*
* @export
* @enum {string}
*/
export declare const ActionStatus: {
readonly Created: "Created";
readonly Pending: "Pending";
readonly Completed: "Completed";
readonly Refused: "Refused";
};
export type ActionStatus = typeof ActionStatus[keyof typeof ActionStatus];
/**
*
* @export
* @enum {string}
*/
export declare const AgentTypes: {
readonly User: "User";
readonly Application: "Application";
};
export type AgentTypes = typeof AgentTypes[keyof typeof AgentTypes];
/**
*
* @export
* @interface AgentsAgentModel
*/
export interface AgentsAgentModel {
/**
*
* @type {string}
* @memberof AgentsAgentModel
*/
'id'?: string;
/**
*
* @type {AgentTypes}
* @memberof AgentsAgentModel
*/
'type'?: AgentTypes;
/**
*
* @type {string}
* @memberof AgentsAgentModel
*/
'name'?: string | null;
}
/**
*
* @export
* @interface ApplicationsApplicationDisplayModel
*/
export interface ApplicationsApplicationDisplayModel {
/**
*
* @type {string}
* @memberof ApplicationsApplicationDisplayModel
*/
'id'?: string;
/**
*
* @type {string}
* @memberof ApplicationsApplicationDisplayModel
*/
'name'?: string | null;
/**
*
* @type {string}
* @memberof ApplicationsApplicationDisplayModel
*/
'organizationName'?: string | null;
}
/**
*
* @export
* @interface AttachmentsAttachmentModel
*/
export interface AttachmentsAttachmentModel {
/**
*
* @type {string}
* @memberof AttachmentsAttachmentModel
*/
'id'?: string;
/**
*
* @type {string}
* @memberof AttachmentsAttachmentModel
*/
'name'?: string | null;
/**
* The attachment\'s file name.
* @type {string}
* @memberof AttachmentsAttachmentModel
*/
'filename'?: string | null;
/**
* The attachment\'s file size in bytes.
* @type {number}
* @memberof AttachmentsAttachmentModel
*/
'fileSize'?: number;
/**
* The attachment\'s file mime type.
* @type {string}
* @memberof AttachmentsAttachmentModel
*/
'mimeType'?: string | null;
/**
* The date the attachment was created.
* @type {string}
* @memberof AttachmentsAttachmentModel
*/
'creationDate'?: string;
/**
* The date of the last update to the attachment.
* @type {string}
* @memberof AttachmentsAttachmentModel
*/
'updateDate'?: string;
/**
*
* @type {DocumentsCreatorModel}
* @memberof AttachmentsAttachmentModel
*/
'createdBy'?: DocumentsCreatorModel;
/**
*
* @type {boolean}
* @memberof AttachmentsAttachmentModel
*/
'isPrivate'?: boolean;
}
/**
*
* @export
* @interface AttachmentsAttachmentUploadModel
*/
export interface AttachmentsAttachmentUploadModel {
/**
* This is the name the document will display in the application.
* @type {string}
* @memberof AttachmentsAttachmentUploadModel
*/
'displayName': string;
/**
* The upload Id as returned by the Upload API
* @type {string}
* @memberof AttachmentsAttachmentUploadModel
*/
'id': string;
/**
* The file\'s original name.
* @type {string}
* @memberof AttachmentsAttachmentUploadModel
*/
'name': string;
/**
* The file\'s mime type. Unless overridden, PDF mime types will be signed as PAdES and all other types as CAdES.
* @type {string}
* @memberof AttachmentsAttachmentUploadModel
*/
'contentType': string;
/**
*
* @type {boolean}
* @memberof AttachmentsAttachmentUploadModel
*/
'isPrivate'?: boolean;
}
/**
*
* @export
* @interface AttachmentsCreateAttachmentResult
*/
export interface AttachmentsCreateAttachmentResult {
/**
* The Id of the uploaded attachment, from the request Lacuna.Signer.Api.UploadModel.Id.
* @type {string}
* @memberof AttachmentsCreateAttachmentResult
*/
'uploadId'?: string | null;
/**
* The Id of the newly created attachment.
* @type {string}
* @memberof AttachmentsCreateAttachmentResult
*/
'attachmentId'?: string;
}
/**
* This enum is used as flags, the order and values matter!
* @export
* @enum {string}
*/
export declare const AuthenticationTypes: {
readonly Sms: "SMS";
readonly AuthenticatorApp: "AuthenticatorApp";
readonly Email: "Email";
readonly Login: "Login";
readonly Application: "Application";
readonly Selfie: "Selfie";
readonly Datavalid: "Datavalid";
readonly Pix: "Pix";
readonly AccessCode: "AccessCode";
readonly Whatsapp: "Whatsapp";
readonly Liveness: "Liveness";
readonly IdScan: "IdScan";
};
export type AuthenticationTypes = typeof AuthenticationTypes[keyof typeof AuthenticationTypes];
/**
*
* @export
* @interface BatchItemResultModel
*/
export interface BatchItemResultModel {
/**
*
* @type {string}
* @memberof BatchItemResultModel
*/
'id'?: string;
/**
*
* @type {boolean}
* @memberof BatchItemResultModel
*/
'success'?: boolean;
/**
*
* @type {string}
* @memberof BatchItemResultModel
*/
'errorMessage'?: string | null;
}
/**
*
* @export
* @interface BillingBillingInformationModel
*/
export interface BillingBillingInformationModel {
/**
*
* @type {string}
* @memberof BillingBillingInformationModel
*/
'email': string;
/**
*
* @type {string}
* @memberof BillingBillingInformationModel
*/
'phone': string;
/**
*
* @type {string}
* @memberof BillingBillingInformationModel
*/
'zipCode': string;
/**
*
* @type {string}
* @memberof BillingBillingInformationModel
*/
'city': string;
/**
*
* @type {string}
* @memberof BillingBillingInformationModel
*/
'state': string;
/**
*
* @type {string}
* @memberof BillingBillingInformationModel
*/
'contactName'?: string | null;
/**
*
* @type {BillingInformationTypes}
* @memberof BillingBillingInformationModel
*/
'type'?: BillingInformationTypes;
/**
*
* @type {BillingIndividualBillingInformationModel}
* @memberof BillingBillingInformationModel
*/
'individual'?: BillingIndividualBillingInformationModel;
/**
*
* @type {BillingCompanyBillingInformationModel}
* @memberof BillingBillingInformationModel
*/
'company'?: BillingCompanyBillingInformationModel;
/**
*
* @type {string}
* @memberof BillingBillingInformationModel
*/
'streetAddress'?: string | null;
/**
*
* @type {string}
* @memberof BillingBillingInformationModel
*/
'addressNumber'?: string | null;
/**
*
* @type {string}
* @memberof BillingBillingInformationModel
*/
'additionalAddressInfo'?: string | null;
/**
*
* @type {string}
* @memberof BillingBillingInformationModel
*/
'neighborhood'?: string | null;
/**
* International address line 1. Currently not used
* @type {string}
* @memberof BillingBillingInformationModel
*/
'address'?: string | null;
/**
* International address line 2. Currently not used
* @type {string}
* @memberof BillingBillingInformationModel
*/
'address2'?: string | null;
/**
* IBGE Code
* @type {string}
* @memberof BillingBillingInformationModel
*/
'cityCode'?: string | null;
}
/**
*
* @export
* @interface BillingCompanyBillingInformationModel
*/
export interface BillingCompanyBillingInformationModel {
/**
*
* @type {string}
* @memberof BillingCompanyBillingInformationModel
*/
'name'?: string | null;
/**
*
* @type {string}
* @memberof BillingCompanyBillingInformationModel
*/
'identifier'?: string | null;
/**
*
* @type {string}
* @memberof BillingCompanyBillingInformationModel
*/
'stateRegistration'?: string | null;
/**
*
* @type {boolean}
* @memberof BillingCompanyBillingInformationModel
*/
'stateRegistrationExempt'?: boolean;
/**
*
* @type {string}
* @memberof BillingCompanyBillingInformationModel
*/
'municipalRegistration'?: string | null;
/**
*
* @type {boolean}
* @memberof BillingCompanyBillingInformationModel
*/
'municipalRegistrationExempt'?: boolean;
}
/**
*
* @export
* @interface BillingIndividualBillingInformationModel
*/
export interface BillingIndividualBillingInformationModel {
/**
*
* @type {string}
* @memberof BillingIndividualBillingInformationModel
*/
'name'?: string | null;
/**
*
* @type {string}
* @memberof BillingIndividualBillingInformationModel
*/
'identifier'?: string | null;
}
/**
*
* @export
* @enum {string}
*/
export declare const BillingInformationTypes: {
readonly Individual: "Individual";
readonly Company: "Company";
};
export type BillingInformationTypes = typeof BillingInformationTypes[keyof typeof BillingInformationTypes];
/**
*
* @export
* @enum {string}
*/
export declare const CertificateHolderTypes: {
readonly Individual: "Individual";
readonly Company: "Company";
};
export type CertificateHolderTypes = typeof CertificateHolderTypes[keyof typeof CertificateHolderTypes];
/**
*
* @export
* @enum {string}
*/
export declare const CertificateTypes: {
readonly A1: "A1";
readonly A2: "A2";
readonly A3: "A3";
readonly A4: "A4";
readonly S1: "S1";
readonly S2: "S2";
readonly S3: "S3";
readonly S4: "S4";
readonly T3: "T3";
readonly T4: "T4";
};
export type CertificateTypes = typeof CertificateTypes[keyof typeof CertificateTypes];
/**
*
* @export
* @interface CertificatesAttributeCertificateInfoModel
*/
export interface CertificatesAttributeCertificateInfoModel {
/**
*
* @type {string}
* @memberof CertificatesAttributeCertificateInfoModel
*/
'details'?: string | null;
/**
*
* @type {string}
* @memberof CertificatesAttributeCertificateInfoModel
*/
'issuer'?: string | null;
}
/**
*
* @export
* @enum {string}
*/
export declare const DeleteAction: {
readonly MoveContent: "MoveContent";
readonly DeleteContent: "DeleteContent";
};
export type DeleteAction = typeof DeleteAction[keyof typeof DeleteAction];
/**
*
* @export
* @enum {string}
*/
export declare const DocumentDownloadTypes: {
readonly Original: "Original";
readonly PrinterFriendlyVersion: "PrinterFriendlyVersion";
readonly Signatures: "Signatures";
readonly OriginalWithMarks: "OriginalWithMarks";
readonly SigningTags: "SigningTags";
readonly SignatureMarks: "SignatureMarks";
readonly SignaturesManifest: "SignaturesManifest";
};
export type DocumentDownloadTypes = typeof DocumentDownloadTypes[keyof typeof DocumentDownloadTypes];
/**
*
* @export
* @enum {string}
*/
export declare const DocumentFilterStatus: {
readonly PendingOrRefused: "PendingOrRefused";
readonly Concluded: "Concluded";
readonly CanceledOrExpired: "CanceledOrExpired";
readonly Pending: "Pending";
readonly Refused: "Refused";
readonly Canceled: "Canceled";
readonly Expired: "Expired";
};
export type DocumentFilterStatus = typeof DocumentFilterStatus[keyof typeof DocumentFilterStatus];
/**
*
* @export
* @interface DocumentFlowsDocumentFlowCreateRequest
*/
export interface DocumentFlowsDocumentFlowCreateRequest {
/**
*
* @type {string}
* @memberof DocumentFlowsDocumentFlowCreateRequest
*/
'name': string;
/**
*
* @type {Array}
* @memberof DocumentFlowsDocumentFlowCreateRequest
*/
'flowActions': Array;
/**
*
* @type {boolean}
* @memberof DocumentFlowsDocumentFlowCreateRequest
*/
'areActionsOrdered'?: boolean;
/**
*
* @type {Array}
* @memberof DocumentFlowsDocumentFlowCreateRequest
*/
'observers'?: Array | null;
}
/**
*
* @export
* @interface DocumentFlowsDocumentFlowData
*/
export interface DocumentFlowsDocumentFlowData {
/**
*
* @type {string}
* @memberof DocumentFlowsDocumentFlowData
*/
'name': string;
/**
*
* @type {Array}
* @memberof DocumentFlowsDocumentFlowData
*/
'flowActions': Array;
/**
*
* @type {boolean}
* @memberof DocumentFlowsDocumentFlowData
*/
'areActionsOrdered'?: boolean;
/**
*
* @type {Array}
* @memberof DocumentFlowsDocumentFlowData
*/
'observers'?: Array | null;
}
/**
*
* @export
* @interface DocumentFlowsDocumentFlowDetailsModel
*/
export interface DocumentFlowsDocumentFlowDetailsModel {
/**
*
* @type {boolean}
* @memberof DocumentFlowsDocumentFlowDetailsModel
*/
'areActionsOrdered'?: boolean;
/**
* The list of actions (signers and approvers) that will be in the document.
* @type {Array}
* @memberof DocumentFlowsDocumentFlowDetailsModel
*/
'flowActions'?: Array | null;
/**
*
* @type {Array}
* @memberof DocumentFlowsDocumentFlowDetailsModel
*/
'observers'?: Array | null;
/**
*
* @type {string}
* @memberof DocumentFlowsDocumentFlowDetailsModel
*/
'id'?: string;
/**
*
* @type {string}
* @memberof DocumentFlowsDocumentFlowDetailsModel
*/
'name'?: string | null;
/**
* The date the flow was created.
* @type {string}
* @memberof DocumentFlowsDocumentFlowDetailsModel
*/
'creationDate'?: string;
/**
* The date of the last update to the flow.
* @type {string}
* @memberof DocumentFlowsDocumentFlowDetailsModel
*/
'updateDate'?: string;
/**
*
* @type {DocumentsCreatorModel}
* @memberof DocumentFlowsDocumentFlowDetailsModel
*/
'createdBy'?: DocumentsCreatorModel;
}
/**
*
* @export
* @interface DocumentFlowsDocumentFlowModel
*/
export interface DocumentFlowsDocumentFlowModel {
/**
*
* @type {string}
* @memberof DocumentFlowsDocumentFlowModel
*/
'id'?: string;
/**
*
* @type {string}
* @memberof DocumentFlowsDocumentFlowModel
*/
'name'?: string | null;
/**
* The date the flow was created.
* @type {string}
* @memberof DocumentFlowsDocumentFlowModel
*/
'creationDate'?: string;
/**
* The date of the last update to the flow.
* @type {string}
* @memberof DocumentFlowsDocumentFlowModel
*/
'updateDate'?: string;
/**
*
* @type {DocumentsCreatorModel}
* @memberof DocumentFlowsDocumentFlowModel
*/
'createdBy'?: DocumentsCreatorModel;
}
/**
*
* @export
* @interface DocumentMarkDocumentMarkPositionModel
*/
export interface DocumentMarkDocumentMarkPositionModel {
/**
* X position of the top left point of the mark (in PDF points).
* @type {number}
* @memberof DocumentMarkDocumentMarkPositionModel
*/
'topLeftX'?: number;
/**
* Y position of the top left point of the mark (in PDF points).
* @type {number}
* @memberof DocumentMarkDocumentMarkPositionModel
*/
'topLeftY'?: number;
/**
* Width of the mark (in PDF points).
* @type {number}
* @memberof DocumentMarkDocumentMarkPositionModel
*/
'width'?: number;
/**
* Height of the mark (in PDF points).
* @type {number}
* @memberof DocumentMarkDocumentMarkPositionModel
*/
'height'?: number;
/**
* The page number of the mark.
* @type {number}
* @memberof DocumentMarkDocumentMarkPositionModel
*/
'pageNumber'?: number | null;
/**
*
* @type {DocumentMarkType}
* @memberof DocumentMarkDocumentMarkPositionModel
*/
'type'?: DocumentMarkType;
/**
* The font size of the mark. The font size adapts dynamically to fit within the dimensions of the mark rectangle.
* @type {number}
* @memberof DocumentMarkDocumentMarkPositionModel
*/
'fontSize'?: number | null;
}
/**
*
* @export
* @interface DocumentMarkFlowActionPositionModel
*/
export interface DocumentMarkFlowActionPositionModel {
/**
*
* @type {string}
* @memberof DocumentMarkFlowActionPositionModel
*/
'id'?: string | null;
/**
*
* @type {FlowActionType}
* @memberof DocumentMarkFlowActionPositionModel
*/
'type'?: FlowActionType;
/**
*
* @type {UsersParticipantUserModel}
* @memberof DocumentMarkFlowActionPositionModel
*/
'user'?: UsersParticipantUserModel;
/**
*
* @type {SignatureInitialsModes}
* @memberof DocumentMarkFlowActionPositionModel
*/
'signatureInitialsMode'?: SignatureInitialsModes;
/**
*
* @type {string}
* @memberof DocumentMarkFlowActionPositionModel
*/
'ruleName'?: string | null;
/**
*
* @type {number}
* @memberof DocumentMarkFlowActionPositionModel
* @deprecated
*/
'numberRequiredSignatures'?: number | null;
/**
*
* @type {number}
* @memberof DocumentMarkFlowActionPositionModel
*/
'numberRequiredActions'?: number | null;
/**
*
* @type {Array}
* @memberof DocumentMarkFlowActionPositionModel
*/
'prePositionedMarks'?: Array | null;
}
/**
*
* @export
* @interface DocumentMarkMarksSessionCreateRequest
*/
export interface DocumentMarkMarksSessionCreateRequest {
/**
*
* @type {Array}
* @memberof DocumentMarkMarksSessionCreateRequest
*/
'files': Array;
/**
*
* @type {Array}
* @memberof DocumentMarkMarksSessionCreateRequest
*/
'flowActions': Array;
/**
* If true, groups all files into a single document (the envelope). All files must be in PDF format.
* @type {boolean}
* @memberof DocumentMarkMarksSessionCreateRequest
*/
'isEnvelope'?: boolean;
/**
*
* @type {SignatureTypes}
* @memberof DocumentMarkMarksSessionCreateRequest
*/
'signatureType'?: SignatureTypes;
}
/**
*
* @export
* @interface DocumentMarkMarksSessionCreateResponse
*/
export interface DocumentMarkMarksSessionCreateResponse {
/**
*
* @type {string}
* @memberof DocumentMarkMarksSessionCreateResponse
*/
'id'?: string;
/**
* The URL to embed the session in a iframe to use in your own application.
* @type {string}
* @memberof DocumentMarkMarksSessionCreateResponse
*/
'embedUrl'?: string | null;
}
/**
*
* @export
* @interface DocumentMarkMarksSessionModel
*/
export interface DocumentMarkMarksSessionModel {
/**
*
* @type {string}
* @memberof DocumentMarkMarksSessionModel
*/
'id'?: string;
/**
*
* @type {Array}
* @memberof DocumentMarkMarksSessionModel
*/
'files'?: Array | null;
/**
*
* @type {any}
* @memberof DocumentMarkMarksSessionModel
*/
'data'?: any | null;
}
/**
* Model used to set the position of a document mark before it\'s associated flow action is completed.
* @export
* @interface DocumentMarkPrePositionedDocumentMarkModel
*/
export interface DocumentMarkPrePositionedDocumentMarkModel {
/**
*
* @type {DocumentMarkType}
* @memberof DocumentMarkPrePositionedDocumentMarkModel
*/
'type'?: DocumentMarkType;
/**
* The file to which this mark should be applied. If null it will be applied to all sent files.
* @type {string}
* @memberof DocumentMarkPrePositionedDocumentMarkModel
*/
'uploadId'?: string | null;
/**
* X position of the top left point of the mark (in PDF points).
* @type {number}
* @memberof DocumentMarkPrePositionedDocumentMarkModel
*/
'topLeftX'?: number;
/**
* Y position of the top left point of the mark (in PDF points).
* @type {number}
* @memberof DocumentMarkPrePositionedDocumentMarkModel
*/
'topLeftY'?: number;
/**
* Width of the mark (in PDF points).
* @type {number}
* @memberof DocumentMarkPrePositionedDocumentMarkModel
*/
'width'?: number;
/**
* Height of the mark (in PDF points).
* @type {number}
* @memberof DocumentMarkPrePositionedDocumentMarkModel
*/
'height'?: number;
/**
* The page number of the mark.
* @type {number}
* @memberof DocumentMarkPrePositionedDocumentMarkModel
*/
'pageNumber'?: number | null;
/**
* The font size of the mark. The font size adapts dynamically to fit within the dimensions of the mark rectangle.
* @type {number}
* @memberof DocumentMarkPrePositionedDocumentMarkModel
*/
'fontSize'?: number | null;
}
/**
*
* @export
* @enum {string}
*/
export declare const DocumentMarkType: {
readonly SignatureVisualRepresentation: "SignatureVisualRepresentation";
readonly SignatureInitials: "SignatureInitials";
readonly AuthenticationStamp: "AuthenticationStamp";
};
export type DocumentMarkType = typeof DocumentMarkType[keyof typeof DocumentMarkType];
/**
*
* @export
* @interface DocumentMarkUploadTicketModel
*/
export interface DocumentMarkUploadTicketModel {
/**
*
* @type {string}
* @memberof DocumentMarkUploadTicketModel
*/
'id'?: string | null;
/**
*
* @type {string}
* @memberof DocumentMarkUploadTicketModel
*/
'location'?: string | null;
}
/**
*
* @export
* @enum {string}
*/
export declare const DocumentQueryTypes: {
readonly Name: "Name";
readonly Key: "Key";
readonly Id: "Id";
readonly CreatorName: "CreatorName";
readonly Tag: "Tag";
};
export type DocumentQueryTypes = typeof DocumentQueryTypes[keyof typeof DocumentQueryTypes];
/**
*
* @export
* @enum {string}
*/
export declare const DocumentStatus: {
readonly Pending: "Pending";
readonly Refused: "Refused";
readonly FlowConcluded: "FlowConcluded";
readonly Concluded: "Concluded";
readonly Canceled: "Canceled";
readonly Expired: "Expired";
};
export type DocumentStatus = typeof DocumentStatus[keyof typeof DocumentStatus];
/**
*
* @export
* @enum {string}
*/
export declare const DocumentTicketType: {
readonly Original: "Original";
readonly PrinterFriendlyVersion: "PrinterFriendlyVersion";
readonly Signatures: "Signatures";
readonly OriginalWithMarks: "OriginalWithMarks";
readonly SigningTags: "SigningTags";
readonly SignatureMarks: "SignatureMarks";
readonly SignaturesManifest: "SignaturesManifest";
};
export type DocumentTicketType = typeof DocumentTicketType[keyof typeof DocumentTicketType];
/**
*
* @export
* @enum {string}
*/
export declare const DocumentTypes: {
readonly Deed: "Deed";
readonly PowerOfAttorney: "PowerOfAttorney";
readonly Prescription: "Prescription";
readonly MedicalCertificate: "MedicalCertificate";
readonly ExamRequest: "ExamRequest";
readonly LabReport: "LabReport";
readonly DischargeSummary: "DischargeSummary";
readonly ClinicalRecord: "ClinicalRecord";
readonly DrugDispensing: "DrugDispensing";
readonly Vaccination: "Vaccination";
readonly MedicalReport: "MedicalReport";
};
export type DocumentTypes = typeof DocumentTypes[keyof typeof DocumentTypes];
/**
*
* @export
* @interface DocumentsActionUrlRequest
*/
export interface DocumentsActionUrlRequest {
/**
* The identifier (CPF in Brazil or Cédula de Identidad in Ecuador/Paraguay) of the participant to whom you want to get the ticket.
* @type {string}
* @memberof DocumentsActionUrlRequest
*/
'identifier'?: string | null;
/**
* The email of the participant to whom you want to get the ticket.
* @type {string}
* @memberof DocumentsActionUrlRequest
*/
'emailAddress'?: string | null;
/**
* If action is an electronic signature and this parameter is set to true, requires e-mail authentication with code in order to complete the signature.
* @type {boolean}
* @memberof DocumentsActionUrlRequest
*/
'requireEmailAuthentication'?: boolean;
/**
* The ID of the flow action for which the ticket will be generated. It should only be provided if there are more than one pending action for the participant.
* @type {string}
* @memberof DocumentsActionUrlRequest
*/
'flowActionId'?: string | null;
}
/**
*
* @export
* @interface DocumentsActionUrlResponse
*/
export interface DocumentsActionUrlResponse {
/**
* The URL to redirect the user to the first pending action found.
* @type {string}
* @memberof DocumentsActionUrlResponse
*/
'url'?: string | null;
/**
* The URL to embed the action in a iframe to use in your own application.
* @type {string}
* @memberof DocumentsActionUrlResponse
*/
'embedUrl'?: string | null;
}
/**
*
* @export
* @interface DocumentsCancelDocumentRequest
*/
export interface DocumentsCancelDocumentRequest {
/**
*
* @type {string}
* @memberof DocumentsCancelDocumentRequest
*/
'reason': string;
}
/**
*
* @export
* @interface DocumentsCreateDocumentRequest
*/
export interface DocumentsCreateDocumentRequest {
/**
* The files to submit. Each file will create a document.
* @type {Array}
* @memberof DocumentsCreateDocumentRequest
*/
'files': Array;
/**
* The list of actions (signers and approvers) that will be in the document.
* @type {Array}
* @memberof DocumentsCreateDocumentRequest
*/
'flowActions': Array;
/**
* The attachments to submit. Each document will have the same attachments.
* @type {Array}
* @memberof DocumentsCreateDocumentRequest
*/
'attachments'?: Array | null;
/**
* Optional parameter for XML documents. This namespace will be used by all files in Lacuna.Signer.Api.Documents.CreateDocumentRequest.Files.
* @type {Array}
* @memberof DocumentsCreateDocumentRequest
*/
'xmlNamespaces'?: Array | null;
/**
* If true, groups all files into a single document (the envelope). All files must be in PDF format.
* @type {boolean}
* @memberof DocumentsCreateDocumentRequest
*/
'isEnvelope'?: boolean;
/**
* The name of the document if the envelope option is enabled (see \"IsEnvelope\" property).
* @type {string}
* @memberof DocumentsCreateDocumentRequest
*/
'envelopeName'?: string | null;
/**
*
* @type {UploadModel}
* @memberof DocumentsCreateDocumentRequest
*/
'participantsDataFile'?: UploadModel;
/**
*
* @type {{ [key: string]: string; }}
* @memberof DocumentsCreateDocumentRequest
*/
'templateFieldValues'?: {
[key: string]: string;
} | null;
/**
* The id of the folder in which the document should be placed or null if it should not be placed in any specific folder.
* @type {string}
* @memberof DocumentsCreateDocumentRequest
*/
'folderId'?: string | null;
/**
* A description to be added to the document(s). This will be presented to all participants in the document details screen and in pending action notifications.
* @type {string}
* @memberof DocumentsCreateDocumentRequest
*/
'description'?: string | null;
/**
*
* @type {Array}
* @memberof DocumentsCreateDocumentRequest
*/
'observers'?: Array | null;
/**
* If true the notifications of pending actions won\'t be sent to the participants of the first step.
* @type {boolean}
* @memberof DocumentsCreateDocumentRequest
*/
'disablePendingActionNotifications'?: boolean;
/**
* If true, no notifications will be sent to participants of this document.
* @type {boolean}
* @memberof DocumentsCreateDocumentRequest
*/
'disableNotifications'?: boolean;
/**
* The name of a new folder to be created and associated to the document. If you do not wish to create a new folder you may set this as null.
* @type {string}
* @memberof DocumentsCreateDocumentRequest
*/
'newFolderName'?: string | null;
/**
* If this property is set to true, then the document will be signed using the CAdES format.
* @type {boolean}
* @memberof DocumentsCreateDocumentRequest
*/
'forceCadesSignature'?: boolean;
/**
* The emails to notify when the document is concluded.
* @type {Array}
* @memberof DocumentsCreateDocumentRequest
*/
'notifiedEmails'?: Array | null;
/**
*
* @type {DocumentsDocumentAdditionalInfoData}
* @memberof DocumentsCreateDocumentRequest
*/
'additionalInfo'?: DocumentsDocumentAdditionalInfoData;
/**
*
* @type {Array}
* @memberof DocumentsCreateDocumentRequest
*/
'tags'?: Array | null;
/**
*
* @type {SignatureTypes}
* @memberof DocumentsCreateDocumentRequest
*/
'signatureType'?: SignatureTypes;
/**
*
* @type {string}
* @memberof DocumentsCreateDocumentRequest
*/
'securityContextId'?: string | null;
/**
*
* @type {string}
* @memberof DocumentsCreateDocumentRequest
*/
'templateId'?: string | null;
/**
* The expiration date of the document. Any time information will be discarded, as the expiration will be set to the last time available for the chosen date in the default timezone.
* @type {string}
* @memberof DocumentsCreateDocumentRequest
*/
'expirationDate'?: string | null;
}
/**
*
* @export
* @interface DocumentsCreateDocumentResult
*/
export interface DocumentsCreateDocumentResult {
/**
* The Id of the uploaded file, from the request Lacuna.Signer.Api.UploadModel.Id.
* @type {string}
* @memberof DocumentsCreateDocumentResult
*/
'uploadId'?: string | null;
/**
* The Id of the newly created document.
* @type {string}
* @memberof DocumentsCreateDocumentResult
*/
'documentId'?: string;
/**
* Result of creating attachments
* @type {Array}
* @memberof DocumentsCreateDocumentResult
*/
'attachments'?: Array | null;
}
/**
*
* @export
* @interface DocumentsCreatorModel
*/
export interface DocumentsCreatorModel {
/**
*
* @type {string}
* @memberof DocumentsCreatorModel
*/
'id'?: string;
/**
*
* @type {string}
* @memberof DocumentsCreatorModel
*/
'name'?: string | null;
}
/**
*
* @export
* @interface DocumentsDocumentAddVersionRequest
*/
export interface DocumentsDocumentAddVersionRequest {
/**
*
* @type {FileUploadModel}
* @memberof DocumentsDocumentAddVersionRequest
*/
'file'?: FileUploadModel;
/**
* If true the notifications of pending actions won\'t be sent to the participants of the first step.
* @type {boolean}
* @memberof DocumentsDocumentAddVersionRequest
*/
'disablePendingActionNotifications'?: boolean;
/**
*
* @type {DocumentsDocumentAdditionalInfoData}
* @memberof DocumentsDocumentAddVersionRequest
*/
'additionalInfo'?: DocumentsDocumentAdditionalInfoData;
/**
*
* @type {Array}
* @memberof DocumentsDocumentAddVersionRequest
*/
'prePositionedMarks'?: Array | null;
}
/**
*
* @export
* @interface DocumentsDocumentAdditionalInfoData
*/
export interface DocumentsDocumentAdditionalInfoData {
/**
*
* @type {HealthDocumentsHealthDocumentData}
* @memberof DocumentsDocumentAdditionalInfoData
*/
'healthData'?: HealthDocumentsHealthDocumentData;
/**
* Form fields to fill when creating the document.
* @type {{ [key: string]: string; }}
* @memberof DocumentsDocumentAdditionalInfoData
*/
'fields'?: {
[key: string]: string;
} | null;
/**
* PDF custom metadata to add when creating the document
* @type {{ [key: string]: string; }}
* @memberof DocumentsDocumentAdditionalInfoData
*/
'metadata'?: {
[key: string]: string;
} | null;
}
/**
*
* @export
* @interface DocumentsDocumentContentModel
*/
export interface DocumentsDocumentContentModel {
/**
*
* @type {string}
* @memberof DocumentsDocumentContentModel
*/
'bytes'?: string | null;
/**
*
* @type {string}
* @memberof DocumentsDocumentContentModel
*/
'name'?: string | null;
/**
*
* @type {string}
* @memberof DocumentsDocumentContentModel
*/
'contentType'?: string | null;
}
/**
*
* @export
* @interface DocumentsDocumentFileModel
*/
export interface DocumentsDocumentFileModel {
/**
*
* @type {string}
* @memberof DocumentsDocumentFileModel
*/
'id'?: string;
/**
*
* @type {string}
* @memberof DocumentsDocumentFileModel
*/
'name'?: string | null;
/**
*
* @type {boolean}
* @memberof DocumentsDocumentFileModel
*/
'isSigned'?: boolean;
/**
*
* @type {boolean}
* @memberof DocumentsDocumentFileModel
*/
'isEnvelopePart'?: boolean;
/**
*
* @type {number}
* @memberof DocumentsDocumentFileModel
*/
'envelopeStartPage'?: number | null;
/**
*
* @type {number}
* @memberof DocumentsDocumentFileModel
*/
'numberPages'?: number | null;
/**
*
* @type {string}
* @memberof DocumentsDocumentFileModel
*/
'mimeType'?: string | null;
/**
*
* @type {string}
* @memberof DocumentsDocumentFileModel
*/
'filename'?: string | null;
/**
*
* @type {string}
* @memberof DocumentsDocumentFileModel
*/
'creationDate'?: string;
}
/**
*
* @export
* @interface DocumentsDocumentFlowEditRequest
*/
export interface DocumentsDocumentFlowEditRequest {
/**
* The actions to be added to the flow. The FlowActionCreateModel.Step must be greater or equal to the current pending step.
* @type {Array}
* @memberof DocumentsDocumentFlowEditRequest
*/
'addedFlowActions'?: Array | null;
/**
* The existing actions to be modified. Flow actions that have already been completed or are partially completed cannot be edited.
* @type {Array}
* @memberof DocumentsDocumentFlowEditRequest
*/
'editedFlowActions'?: Array | null;
/**
* The Ids of flow actions to be deleted. Flow actions that have already been completed or are partially completed cannot be deleted.
* @type {Array}
* @memberof DocumentsDocumentFlowEditRequest
*/
'deletedFlowActionIds'?: Array | null;
/**
* The observers to be added to the document.
* @type {Array}
* @memberof DocumentsDocumentFlowEditRequest
*/
'addedObservers'?: Array | null;
/**
* The existing observers to be modified.
* @type {Array}
* @memberof DocumentsDocumentFlowEditRequest
*/
'editedObservers'?: Array | null;
/**
* The Ids of observers to be deleted.
* @type {Array}
* @memberof DocumentsDocumentFlowEditRequest
*/
'deletedObserverIds'?: Array | null;
}
/**
*
* @export
* @interface DocumentsDocumentListModel
*/
export interface DocumentsDocumentListModel {
/**
*
* @type {string}
* @memberof DocumentsDocumentListModel
*/
'id'?: string;
/**
*
* @type {string}
* @memberof DocumentsDocumentListModel
*/
'name'?: string | null;
/**
*
* @type {string}
* @memberof DocumentsDocumentListModel
*/
'creationDate'?: string;
/**
*
* @type {string}
* @memberof DocumentsDocumentListModel
*/
'updateDate'?: string;
/**
*
* @type {FoldersFolderInfoModel}
* @memberof DocumentsDocumentListModel
*/
'folder'?: FoldersFolderInfoModel;
/**
*
* @type {DocumentTypes}
* @memberof DocumentsDocumentListModel
*/
'type'?: DocumentTypes;
/**
*
* @type {Array}
* @memberof DocumentsDocumentListModel
*/
'tags'?: Array | null;
}
/**
*
* @export
* @interface DocumentsDocumentModel
*/
export interface DocumentsDocumentModel {
/**
* MD5 checksum of the document\'s file.
* @type {string}
* @memberof DocumentsDocumentModel
*/
'checksumMd5'?: string | null;
/**
* True if the document is deleted.
* @type {boolean}
* @memberof DocumentsDocumentModel
*/
'isDeleted'?: boolean;
/**
* Signers and approvers of the document.
* @type {Array}
* @memberof DocumentsDocumentModel
*/
'flowActions'?: Array | null;
/**
* Observers of the document.
* @type {Array}
* @memberof DocumentsDocumentModel
*/
'observers'?: Array | null;
/**
* Document attachments
* @type {Array}
* @memberof DocumentsDocumentModel
*/
'attachments'?: Array | null;
/**
*
* @type {DocumentsDocumentPermissionsModel}
* @memberof DocumentsDocumentModel
*/
'permissions'?: DocumentsDocumentPermissionsModel;
/**
*
* @type {Array}
* @memberof DocumentsDocumentModel
*/
'notifiedEmails'?: Array | null;
/**
*
* @type {string}
* @memberof DocumentsDocumentModel
*/
'key'?: string | null;
/**
*
* @type {boolean}
* @memberof DocumentsDocumentModel
*/
'hideDownloadOptionForPendingDocuments'?: boolean;
/**
*
* @type {string}
* @memberof DocumentsDocumentModel
*/
'id'?: string;
/**
*
* @type {string}
* @memberof DocumentsDocumentModel
*/
'name'?: string | null;
/**
* The document\'s file name.
* @type {string}
* @memberof DocumentsDocumentModel
*/
'filename'?: string | null;
/**
* The document\'s file size in bytes.
* @type {number}
* @memberof DocumentsDocumentModel
*/
'fileSize'?: number;
/**
* The document\'s file mime type.
* @type {string}
* @memberof DocumentsDocumentModel
*/
'mimeType'?: string | null;
/**
* True if the document was already signed once.
* @type {boolean}
* @memberof DocumentsDocumentModel
*/
'hasSignature'?: boolean;
/**
*
* @type {DocumentStatus}
* @memberof DocumentsDocumentModel
*/
'status'?: DocumentStatus;
/**
* [DEPRECATED] True if all actions requested in the document are concluded. Please use Lacuna.Signer.Api.Documents.DocumentInfoModel.Status instead.
* @type {boolean}
* @memberof DocumentsDocumentModel
*/
'isConcluded'?: boolean;
/**
*
* @type {FoldersFolderInfoModel}
* @memberof DocumentsDocumentModel
*/
'folder'?: FoldersFolderInfoModel;
/**
*
* @type {OrganizationsOrganizationInfoModel}
* @memberof DocumentsDocumentModel
*/
'organization'?: OrganizationsOrganizationInfoModel;
/**
* The date the document was created.
* @type {string}
* @memberof DocumentsDocumentModel
*/
'creationDate'?: string;
/**
* The date of the last update to the document. This includes the following actions: moving to folder, signing, approving, deleting and editing the flow.
* @type {string}
* @memberof DocumentsDocumentModel
*/
'updateDate'?: string;
/**
* The expiration date of the document in the default timezone.
* @type {string}
* @memberof DocumentsDocumentModel
*/
'expirationDate'?: string | null;
/**
* The expiration date without time: in yyyy-MM-dd format (useful for display purposes).
* @type {string}
* @memberof DocumentsDocumentModel
*/
'expirationDateWithoutTime'?: string | null;
/**
*
* @type {DocumentsCreatorModel}
* @memberof DocumentsDocumentModel
*/
'createdBy'?: DocumentsCreatorModel;
/**
*
* @type {string}
* @memberof DocumentsDocumentModel
*/
'description'?: string | null;
/**
*
* @type {boolean}
* @memberof DocumentsDocumentModel
*/
'forceCadesSignature'?: boolean;
/**
* True if the document source was a scanning process.
* @type {boolean}
* @memberof DocumentsDocumentModel
*/
'isScanned'?: boolean;
/**
* True if the document is an envelope (Lacuna.Signer.Api.Documents.CreateDocumentRequest.IsEnvelope).
* @type {boolean}
* @memberof DocumentsDocumentModel
*/
'isEnvelope'?: boolean;
/**
*
* @type {AgentsAgentModel}
* @memberof DocumentsDocumentModel
*/
'statusUpdatedBy'?: AgentsAgentModel;
/**
* The reason for the status update (see \"StatusUpdatedBy\" property).
* @type {string}
* @memberof DocumentsDocumentModel
*/
'statusUpdateReason'?: string | null;
/**
*
* @type {Array}
* @memberof DocumentsDocumentModel
*/
'tags'?: Array | null;
/**
*
* @type {SignatureTypes}
* @memberof DocumentsDocumentModel
*/
'signatureType'?: SignatureTypes;
/**
*
* @type {SecurityContextsSecurityContextSimpleModel}
* @memberof DocumentsDocumentModel
*/
'securityContext'?: SecurityContextsSecurityContextSimpleModel;
}
/**
*
* @export
* @interface DocumentsDocumentNotifiedEmailsEditRequest
*/
export interface DocumentsDocumentNotifiedEmailsEditRequest {
/**
* The emails to notify when the document is concluded.
* @type {Array}
* @memberof DocumentsDocumentNotifiedEmailsEditRequest
*/
'emails'?: Array | null;
}
/**
*
* @export
* @interface DocumentsDocumentPermissionsModel
*/
export interface DocumentsDocumentPermissionsModel {
/**
*
* @type {boolean}
* @memberof DocumentsDocumentPermissionsModel
*/
'move'?: boolean;
/**
*
* @type {boolean}
* @memberof DocumentsDocumentPermissionsModel
*/
'editFlow'?: boolean;
}
/**
*
* @export
* @interface DocumentsDocumentSignaturesInfoModel
*/
export interface DocumentsDocumentSignaturesInfoModel {
/**
*
* @type {string}
* @memberof DocumentsDocumentSignaturesInfoModel
*/
'id'?: string;
/**
*
* @type {string}
* @memberof DocumentsDocumentSignaturesInfoModel
*/
'name'?: string | null;
/**
*
* @type {string}
* @memberof DocumentsDocumentSignaturesInfoModel
*/
'filename'?: string | null;
/**
*
* @type {string}
* @memberof DocumentsDocumentSignaturesInfoModel
*/
'mimeType'?: string | null;
/**
*
* @type {DocumentsCreatorModel}
* @memberof DocumentsDocumentSignaturesInfoModel
*/
'createdBy'?: DocumentsCreatorModel;
/**
* True if all actions requested in the document are concluded.
* @type {boolean}
* @memberof DocumentsDocumentSignaturesInfoModel
*/
'isConcluded'?: boolean;
/**
*
* @type {boolean}
* @memberof DocumentsDocumentSignaturesInfoModel
*/
'isFile'?: boolean;
/**
*
* @type {boolean}
* @memberof DocumentsDocumentSignaturesInfoModel
*/
'isEnvelope'?: boolean;
/**
*
* @type {string}
* @memberof DocumentsDocumentSignaturesInfoModel
*/
'creationDate'?: string;
/**
*
* @type {string}
* @memberof DocumentsDocumentSignaturesInfoModel
*/
'updateDate'?: string;
/**
* List of who signed the document. Each element in the list contains a validation result.
* @type {Array}
* @memberof DocumentsDocumentSignaturesInfoModel
*/
'signers'?: Array | null;
/**
*
* @type {DocumentStatus}
* @memberof DocumentsDocumentSignaturesInfoModel
*/
'status'?: DocumentStatus;
/**
*
* @type {DocumentTypes}
* @memberof DocumentsDocumentSignaturesInfoModel
*/
'type'?: DocumentTypes;
/**
*
* @type {SignatureTypes}
* @memberof DocumentsDocumentSignaturesInfoModel
*/
'signatureType'?: SignatureTypes;
/**
*
* @type {SecurityContextsSecurityContextSimpleModel}
* @memberof DocumentsDocumentSignaturesInfoModel
*/
'securityContext'?: SecurityContextsSecurityContextSimpleModel;
}
/**
*
* @export
* @interface DocumentsDocumentTagData
*/
export interface DocumentsDocumentTagData {
/**
*
* @type {string}
* @memberof DocumentsDocumentTagData
*/
'value': string;
/**
*
* @type {string}
* @memberof DocumentsDocumentTagData
*/
'label'?: string | null;
}
/**
*
* @export
* @interface DocumentsDocumentTagModel
*/
export interface DocumentsDocumentTagModel {
/**
*
* @type {string}
* @memberof DocumentsDocumentTagModel
*/
'value': string;
/**
*
* @type {string}
* @memberof DocumentsDocumentTagModel
*/
'id'?: string;
/**
*
* @type {string}
* @memberof DocumentsDocumentTagModel
*/
'label'?: string | null;
}
/**
*
* @export
* @interface DocumentsEnvelopeAddVersionRequest
*/
export interface DocumentsEnvelopeAddVersionRequest {
/**
*
* @type {Array}
* @memberof DocumentsEnvelopeAddVersionRequest
*/
'files'?: Array | null;
/**
* If true the notifications of pending actions won\'t be sent to the participants of the first step.
* @type {boolean}
* @memberof DocumentsEnvelopeAddVersionRequest
*/
'disablePendingActionNotifications'?: boolean;
/**
*
* @type {DocumentsDocumentAdditionalInfoData}
* @memberof DocumentsEnvelopeAddVersionRequest
*/
'additionalInfo'?: DocumentsDocumentAdditionalInfoData;
/**
*
* @type {Array}
* @memberof DocumentsEnvelopeAddVersionRequest
*/
'prePositionedMarks'?: Array | null;
}
/**
*
* @export
* @interface DocumentsFlowActionPendingModel
*/
export interface DocumentsFlowActionPendingModel {
/**
*
* @type {string}
* @memberof DocumentsFlowActionPendingModel
*/
'signerId'?: string | null;
/**
*
* @type {string}
* @memberof DocumentsFlowActionPendingModel
*/
'approverId'?: string | null;
/**
*
* @type {string}
* @memberof DocumentsFlowActionPendingModel
*/
'signRuleId'?: string | null;
/**
*
* @type {string}
* @memberof DocumentsFlowActionPendingModel
*/
'approverRuleId'?: string | null;
}
/**
*
* @export
* @interface DocumentsMoveDocumentBatchRequest
*/
export interface DocumentsMoveDocumentBatchRequest {
/**
* The Ids of the documents that will be moved.
* @type {Array}
* @memberof DocumentsMoveDocumentBatchRequest
*/
'documents'?: Array | null;
/**
* The Id of the folder to which the document(s) will be moved. The folder Id can be null if you want to move the document(s) to no folder or if you want to create a new folder using Lacuna.Signer.Api.Documents.MoveDocumentRequest.NewFolderName.
* @type {string}
* @memberof DocumentsMoveDocumentBatchRequest
*/
'folderId'?: string | null;
/**
* The name of the folder to be created and the documents will be moved to. (If Lacuna.Signer.Api.Documents.MoveDocumentRequest.FolderId is null)
* @type {string}
* @memberof DocumentsMoveDocumentBatchRequest
*/
'newFolderName'?: string | null;
}
/**
*
* @export
* @interface DocumentsMoveDocumentRequest
*/
export interface DocumentsMoveDocumentRequest {
/**
* The Id of the folder to which the document(s) will be moved. The folder Id can be null if you want to move the document(s) to no folder or if you want to create a new folder using Lacuna.Signer.Api.Documents.MoveDocumentRequest.NewFolderName.
* @type {string}
* @memberof DocumentsMoveDocumentRequest
*/
'folderId'?: string | null;
/**
* The name of the folder to be created and the documents will be moved to. (If Lacuna.Signer.Api.Documents.MoveDocumentRequest.FolderId is null)
* @type {string}
* @memberof DocumentsMoveDocumentRequest
*/
'newFolderName'?: string | null;
}
/**
*
* @export
* @interface DocumentsPrePositionedMarkModel
*/
export interface DocumentsPrePositionedMarkModel {
/**
*
* @type {string}
* @memberof DocumentsPrePositionedMarkModel
*/
'flowActionId'?: string;
/**
*
* @type {Array}
* @memberof DocumentsPrePositionedMarkModel
*/
'prePositionedDocumentMarks'?: Array | null;
}
/**
*
* @export
* @interface ErrorModel
*/
export interface ErrorModel {
/**
*
* @type {string}
* @memberof ErrorModel
*/
'code'?: string | null;
/**
*
* @type {string}
* @memberof ErrorModel
*/
'message'?: string | null;
/**
*
* @type {{ [key: string]: string; }}
* @memberof ErrorModel
*/
'details'?: {
[key: string]: string;
} | null;
}
/**
*
* @export
* @interface FileModel
*/
export interface FileModel {
/**
*
* @type {string}
* @memberof FileModel
*/
'contentType': string;
/**
*
* @type {string}
* @memberof FileModel
*/
'location'?: string | null;
/**
*
* @type {string}
* @memberof FileModel
*/
'id'?: string;
/**
*
* @type {string}
* @memberof FileModel
*/
'name'?: string | null;
}
/**
*
* @export
* @interface FileUploadModel
*/
export interface FileUploadModel {
/**
* This is the name the document will display in the application.
* @type {string}
* @memberof FileUploadModel
*/
'displayName': string;
/**
* The upload Id as returned by the Upload API
* @type {string}
* @memberof FileUploadModel
*/
'id': string;
/**
* The file\'s original name.
* @type {string}
* @memberof FileUploadModel
*/
'name': string;
/**
* The file\'s mime type. Unless overridden, PDF mime types will be signed as PAdES and all other types as CAdES.
* @type {string}
* @memberof FileUploadModel
*/
'contentType': string;
}
/**
*
* @export
* @enum {string}
*/
export declare const FlowActionType: {
readonly Signer: "Signer";
readonly Approver: "Approver";
readonly SignRule: "SignRule";
readonly ApproverRule: "ApproverRule";
};
export type FlowActionType = typeof FlowActionType[keyof typeof FlowActionType];
/**
*
* @export
* @interface FlowActionsApprovalModel
*/
export interface FlowActionsApprovalModel {
/**
*
* @type {string}
* @memberof FlowActionsApprovalModel
*/
'flowActionId'?: string;
/**
*
* @type {string}
* @memberof FlowActionsApprovalModel
*/
'date'?: string;
/**
*
* @type {string}
* @memberof FlowActionsApprovalModel
*/
'userId'?: string;
/**
*
* @type {string}
* @memberof FlowActionsApprovalModel
*/
'name'?: string | null;
/**
*
* @type {string}
* @memberof FlowActionsApprovalModel
*/
'identifier'?: string | null;
/**
*
* @type {string}
* @memberof FlowActionsApprovalModel
*/
'emailAddress'?: string | null;
}
/**
*
* @export
* @interface FlowActionsDocumentFlowEditResponse
*/
export interface FlowActionsDocumentFlowEditResponse {
/**
*
* @type {Array}
* @memberof FlowActionsDocumentFlowEditResponse
*/
'rectifiedParticipants'?: Array | null;
}
/**
*
* @export
* @interface FlowActionsFlowActionCreateModel
*/
export interface FlowActionsFlowActionCreateModel {
/**
*
* @type {UsersParticipantUserModel}
* @memberof FlowActionsFlowActionCreateModel
*/
'user'?: UsersParticipantUserModel;
/**
* [DEPRECATED] Please use `RuleUsers` instead.
* @type {Array}
* @memberof FlowActionsFlowActionCreateModel
* @deprecated
*/
'signRuleUsers'?: Array | null;
/**
*
* @type {Array}
* @memberof FlowActionsFlowActionCreateModel
*/
'ruleUsers'?: Array | null;
/**
*
* @type {FlowActionType}
* @memberof FlowActionsFlowActionCreateModel
*/
'type'?: FlowActionType;
/**
* [DEPRECATED] Number of required signatures (if type is SignRule). Please use `NumberRequiredActions` instead.
* @type {number}
* @memberof FlowActionsFlowActionCreateModel
* @deprecated
*/
'numberRequiredSignatures'?: number | null;
/**
* Number of required action complete rule (if type is SignRule or ApproverRule).
* @type {number}
* @memberof FlowActionsFlowActionCreateModel
*/
'numberRequiredActions'?: number | null;
/**
* If true and the action is a Rule, allows the document flow to continue while there are enough users that can fulfill the rule.
* @type {boolean}
* @memberof FlowActionsFlowActionCreateModel
*/
'allowRuleFlowToContinueIfRefused'?: boolean | null;
/**
*
* @type {FlowActionsXadesOptionsModel}
* @memberof FlowActionsFlowActionCreateModel
*/
'xadesOptions'?: FlowActionsXadesOptionsModel;
/**
* The order in which this action should take place.
* @type {number}
* @memberof FlowActionsFlowActionCreateModel
*/
'step'?: number;
/**
* Name of the rule (if type is SignRule or ApproveRule)
* @type {string}
* @memberof FlowActionsFlowActionCreateModel
*/
'ruleName'?: string | null;
/**
* Title of the participant
* @type {string}
* @memberof FlowActionsFlowActionCreateModel
*/
'title'?: string | null;
/**
*
* @type {Array}
* @memberof FlowActionsFlowActionCreateModel
*/
'prePositionedMarks'?: Array | null;
/**
* Set to true if the electronic signature option should be available. (only if the type of the action is Signer or SignRule)
* @type {boolean}
* @memberof FlowActionsFlowActionCreateModel
*/
'allowElectronicSignature'?: boolean | null;
/**
* Requires the user to confirm a code sent to his phone to sign electronically. (If Lacuna.Signer.Api.FlowActions.BaseFlowActionData.AllowElectronicSignature is true)
* @type {boolean}
* @memberof FlowActionsFlowActionCreateModel
*/
'requireSmsAuthenticationToSignElectronically'?: boolean | null;
/**
* Requires the user to confirm a code sent to his Whatsapp number to sign electronically. (If Lacuna.Signer.Api.FlowActions.BaseFlowActionData.AllowElectronicSignature is true)
* @type {boolean}
* @memberof FlowActionsFlowActionCreateModel
*/
'requireWhatsappAuthenticationToSignElectronically'?: boolean | null;
/**
* Requires the user to enter a one-time password (OTP) to sign electronically. (If Lacuna.Signer.Api.FlowActions.BaseFlowActionData.AllowElectronicSignature is true)
* @type {boolean}
* @memberof FlowActionsFlowActionCreateModel
*/
'requireAuthenticatorAppToSignElectronically'?: boolean | null;
/**
* Requires the user to take a selfie to sign electronically. (If Lacuna.Signer.Api.FlowActions.BaseFlowActionData.AllowElectronicSignature is true)
* @type {boolean}
* @memberof FlowActionsFlowActionCreateModel
*/
'requireSelfieAuthenticationToSignElectronically'?: boolean | null;
/**
* Requires the user to take a selfie to sign electronically. This selfie will be validated by SERPRO\'s Datavalid. (If Lacuna.Signer.Api.FlowActions.BaseFlowActionData.AllowElectronicSignature is true)
* @type {boolean}
* @memberof FlowActionsFlowActionCreateModel
*/
'requireDatavalidAuthenticationToSignElectronically'?: boolean | null;
/**
* Requires the user to pay a Pix to sign electronically. (If Lacuna.Signer.Api.FlowActions.BaseFlowActionData.AllowElectronicSignature is true)
* @type {boolean}
* @memberof FlowActionsFlowActionCreateModel
*/
'requirePixAuthenticationToSignElectronically'?: boolean | null;
/**
* Requires the user to perform a liveness test to sign electronically. (If AllowElectronicSignature is true)
* @type {boolean}
* @memberof FlowActionsFlowActionCreateModel
*/
'requireLivenessAuthenticationToSignElectronically'?: boolean | null;
/**
* Requires the user to perform a photo id scan to sign electronically. (If AllowElectronicSignature is true)
* @type {boolean}
* @memberof FlowActionsFlowActionCreateModel
*/
'requireIdScanAuthenticationToSignElectronically'?: boolean | null;
/**
* Disables e-mail authentication to sign electronically. This option can only be used if SMS or Whatsapp authentication was required. (If Lacuna.Signer.Api.FlowActions.BaseFlowActionData.AllowElectronicSignature is true)
* @type {boolean}
* @memberof FlowActionsFlowActionCreateModel
*/
'disableEmailAuthenticationToSignElectronically'?: boolean | null;
/**
*
* @type {CertificateTypes}
* @memberof FlowActionsFlowActionCreateModel
*/
'requiredCertificateTypeToSign'?: CertificateTypes;
/**
* [DEPRECATED] Requires the user to sign the document with a company certificate (e.g. e-CNPJ). Please use RequiredCertificateHolderTypeToSign instead.
* @type {boolean}
* @memberof FlowActionsFlowActionCreateModel
*/
'requireCompanyCertificate'?: boolean | null;
/**
* Requires the user to sign the document with a company certificate (e.g. e-CNPJ) that has the provided company identifier.
* @type {string}
* @memberof FlowActionsFlowActionCreateModel
*/
'requiredCompanyIdentifier'?: string | null;
/**
*
* @type {CertificateHolderTypes}
* @memberof FlowActionsFlowActionCreateModel
*/
'requiredCertificateHolderTypeToSign'?: CertificateHolderTypes;
/**
*
* @type {SignatureInitialsModes}
* @memberof FlowActionsFlowActionCreateModel
*/
'signatureInitialsMode'?: SignatureInitialsModes;
/**
*
* @type {NotificationLanguage}
* @memberof FlowActionsFlowActionCreateModel
*/
'notificationLanguage'?: NotificationLanguage;
}
/**
*
* @export
* @interface FlowActionsFlowActionEditModel
*/
export interface FlowActionsFlowActionEditModel {
/**
* The Id of the flow action being modified.
* @type {string}
* @memberof FlowActionsFlowActionEditModel
*/
'flowActionId'?: string;
/**
* The new email address of the action\'s participant (if the type is Lacuna.Signer.Api.FlowActionType.Signer or Lacuna.Signer.Api.FlowActionType.Approver).
* @type {string}
* @memberof FlowActionsFlowActionEditModel
*/
'participantEmailAddress'?: string | null;
/**
* The new mobile phone number of the action\'s participant (if the type is Lacuna.Signer.Api.FlowActionType.Signer).
* @type {string}
* @memberof FlowActionsFlowActionEditModel
*/
'participantPhoneNumber'?: string | null;
/**
* [DEPRECATED] The rule users to be edited (if the type is Lacuna.Signer.Api.FlowActionType.SignRule). Please use `RuleUsers` instead.
* @type {Array}
* @memberof FlowActionsFlowActionEditModel
* @deprecated
*/
'signRuleUsers'?: Array | null;
/**
* The rule users to be edited (if the type is Lacuna.Signer.Api.FlowActionType.SignRule or Lacuna.Signer.Api.FlowActionType.ApproverRule).
* @type {Array}
* @memberof FlowActionsFlowActionEditModel
*/
'ruleUsers'?: Array | null;
/**
* The order in which this action should take place.
* @type {number}
* @memberof FlowActionsFlowActionEditModel
*/
'step'?: number;
/**
* Name of the rule (if type is SignRule or ApproveRule)
* @type {string}
* @memberof FlowActionsFlowActionEditModel
*/
'ruleName'?: string | null;
/**
* Title of the participant
* @type {string}
* @memberof FlowActionsFlowActionEditModel
*/
'title'?: string | null;
/**
*
* @type {Array}
* @memberof FlowActionsFlowActionEditModel
*/
'prePositionedMarks'?: Array | null;
/**
* Set to true if the electronic signature option should be available. (only if the type of the action is Signer or SignRule)
* @type {boolean}
* @memberof FlowActionsFlowActionEditModel
*/
'allowElectronicSignature'?: boolean | null;
/**
* Requires the user to confirm a code sent to his phone to sign electronically. (If Lacuna.Signer.Api.FlowActions.BaseFlowActionData.AllowElectronicSignature is true)
* @type {boolean}
* @memberof FlowActionsFlowActionEditModel
*/
'requireSmsAuthenticationToSignElectronically'?: boolean | null;
/**
* Requires the user to confirm a code sent to his Whatsapp number to sign electronically. (If Lacuna.Signer.Api.FlowActions.BaseFlowActionData.AllowElectronicSignature is true)
* @type {boolean}
* @memberof FlowActionsFlowActionEditModel
*/
'requireWhatsappAuthenticationToSignElectronically'?: boolean | null;
/**
* Requires the user to enter a one-time password (OTP) to sign electronically. (If Lacuna.Signer.Api.FlowActions.BaseFlowActionData.AllowElectronicSignature is true)
* @type {boolean}
* @memberof FlowActionsFlowActionEditModel
*/
'requireAuthenticatorAppToSignElectronically'?: boolean | null;
/**
* Requires the user to take a selfie to sign electronically. (If Lacuna.Signer.Api.FlowActions.BaseFlowActionData.AllowElectronicSignature is true)
* @type {boolean}
* @memberof FlowActionsFlowActionEditModel
*/
'requireSelfieAuthenticationToSignElectronically'?: boolean | null;
/**
* Requires the user to take a selfie to sign electronically. This selfie will be validated by SERPRO\'s Datavalid. (If Lacuna.Signer.Api.FlowActions.BaseFlowActionData.AllowElectronicSignature is true)
* @type {boolean}
* @memberof FlowActionsFlowActionEditModel
*/
'requireDatavalidAuthenticationToSignElectronically'?: boolean | null;
/**
* Requires the user to pay a Pix to sign electronically. (If Lacuna.Signer.Api.FlowActions.BaseFlowActionData.AllowElectronicSignature is true)
* @type {boolean}
* @memberof FlowActionsFlowActionEditModel
*/
'requirePixAuthenticationToSignElectronically'?: boolean | null;
/**
* Requires the user to perform a liveness test to sign electronically. (If AllowElectronicSignature is true)
* @type {boolean}
* @memberof FlowActionsFlowActionEditModel
*/
'requireLivenessAuthenticationToSignElectronically'?: boolean | null;
/**
* Requires the user to perform a photo id scan to sign electronically. (If AllowElectronicSignature is true)
* @type {boolean}
* @memberof FlowActionsFlowActionEditModel
*/
'requireIdScanAuthenticationToSignElectronically'?: boolean | null;
/**
* Disables e-mail authentication to sign electronically. This option can only be used if SMS or Whatsapp authentication was required. (If Lacuna.Signer.Api.FlowActions.BaseFlowActionData.AllowElectronicSignature is true)
* @type {boolean}
* @memberof FlowActionsFlowActionEditModel
*/
'disableEmailAuthenticationToSignElectronically'?: boolean | null;
/**
*
* @type {CertificateTypes}
* @memberof FlowActionsFlowActionEditModel
*/
'requiredCertificateTypeToSign'?: CertificateTypes;
/**
* [DEPRECATED] Requires the user to sign the document with a company certificate (e.g. e-CNPJ). Please use RequiredCertificateHolderTypeToSign instead.
* @type {boolean}
* @memberof FlowActionsFlowActionEditModel
*/
'requireCompanyCertificate'?: boolean | null;
/**
* Requires the user to sign the document with a company certificate (e.g. e-CNPJ) that has the provided company identifier.
* @type {string}
* @memberof FlowActionsFlowActionEditModel
*/
'requiredCompanyIdentifier'?: string | null;
/**
*
* @type {CertificateHolderTypes}
* @memberof FlowActionsFlowActionEditModel
*/
'requiredCertificateHolderTypeToSign'?: CertificateHolderTypes;
/**
*
* @type {SignatureInitialsModes}
* @memberof FlowActionsFlowActionEditModel
*/
'signatureInitialsMode'?: SignatureInitialsModes;
/**
*
* @type {NotificationLanguage}
* @memberof FlowActionsFlowActionEditModel
*/
'notificationLanguage'?: NotificationLanguage;
}
/**
*
* @export
* @interface FlowActionsFlowActionModel
*/
export interface FlowActionsFlowActionModel {
/**
*
* @type {string}
* @memberof FlowActionsFlowActionModel
*/
'id'?: string;
/**
*
* @type {string}
* @memberof FlowActionsFlowActionModel
*/
'creationDate'?: string;
/**
*
* @type {string}
* @memberof FlowActionsFlowActionModel
*/
'pendingDate'?: string | null;
/**
*
* @type {string}
* @memberof FlowActionsFlowActionModel
*/
'updateDate'?: string;
/**
*
* @type {UsersParticipantUserModel}
* @memberof FlowActionsFlowActionModel
*/
'user'?: UsersParticipantUserModel;
/**
* [DEPRECATED] Number of required signatures (if type is SignRule). Please use `NumberRequiredActions\"` instead.
* @type {number}
* @memberof FlowActionsFlowActionModel
* @deprecated
*/
'numberRequiredSignatures'?: number;
/**
* Number of required action complete rule (if type is SignRule or ApproverRule).
* @type {number}
* @memberof FlowActionsFlowActionModel
*/
'numberRequiredActions'?: number;
/**
* [DEPRECATED] Users that are allowed to sign if type is SignRule. Please use `RuleUsers` instead.
* @type {Array}
* @memberof FlowActionsFlowActionModel
* @deprecated
*/
'signRuleUsers'?: Array | null;
/**
* Users that are allowed to sign or approver (if type is SignRule or ApproverRule)
* @type {Array}
* @memberof FlowActionsFlowActionModel
*/
'ruleUsers'?: Array | null;
/**
*
* @type {Array}
* @memberof FlowActionsFlowActionModel
*/
'marks'?: Array | null;
/**
* True if the electronic signature option is available for this action (only if the type of the action is Signer or SignRule)
* @type {boolean}
* @memberof FlowActionsFlowActionModel
*/
'allowElectronicSignature'?: boolean;
/**
* Requires the user to confirm a code sent to his e-mail to sign electronically. (If Lacuna.Signer.Api.FlowActions.FlowActionModel.AllowElectronicSignature is true) This requirement is not enforced if the user is logged in or was authenticated by an application (embedded signature mode).
* @type {boolean}
* @memberof FlowActionsFlowActionModel
*/
'requireEmailAuthenticationToSignElectronically'?: boolean | null;
/**
* Requires the user to confirm a code sent to his phone to sign electronically. (If Lacuna.Signer.Api.FlowActions.FlowActionModel.AllowElectronicSignature is true)
* @type {boolean}
* @memberof FlowActionsFlowActionModel
*/
'requireSmsAuthenticationToSignElectronically'?: boolean | null;
/**
* Requires the user to confirm a code sent to his Whatsapp number to sign electronically. (If Lacuna.Signer.Api.FlowActions.FlowActionModel.AllowElectronicSignature is true)
* @type {boolean}
* @memberof FlowActionsFlowActionModel
*/
'requireWhatsappAuthenticationToSignElectronically'?: boolean | null;
/**
* Requires the user to enter a one-time password (OTP) to sign electronically. (If Lacuna.Signer.Api.FlowActions.FlowActionModel.AllowElectronicSignature is true)
* @type {boolean}
* @memberof FlowActionsFlowActionModel
*/
'requireAuthenticatorAppToSignElectronically'?: boolean | null;
/**
* Requires the user to take a selfie to sign electronically. (If Lacuna.Signer.Api.FlowActions.FlowActionModel.AllowElectronicSignature is true)
* @type {boolean}
* @memberof FlowActionsFlowActionModel
*/
'requireSelfieAuthenticationToSignElectronically'?: boolean | null;
/**
* Requires the user to take a selfie to sign electronically. This selfie will be validated by SERPRO\'s Datavalid. (If Lacuna.Signer.Api.FlowActions.FlowActionModel.AllowElectronicSignature is true)
* @type {boolean}
* @memberof FlowActionsFlowActionModel
*/
'requireDatavalidAuthenticationToSignElectronically'?: boolean | null;
/**
* Requires the user to pay a Pix to sign electronically. The payer\'s CPF must be the same as that of the user who will be signing. (If Lacuna.Signer.Api.FlowActions.FlowActionModel.AllowElectronicSignature is true)
* @type {boolean}
* @memberof FlowActionsFlowActionModel
*/
'requirePixAuthenticationToSignElectronically'?: boolean | null;
/**
* Requires the user to perform a liveness test to sign electronically. (If Lacuna.Signer.Api.FlowActions.FlowActionModel.AllowElectronicSignature is true)
* @type {boolean}
* @memberof FlowActionsFlowActionModel
*/
'requireLivenessAuthenticationToSignElectronically'?: boolean | null;
/**
* Requires the user to perform a photo id scan to sign electronically. (If Lacuna.Signer.Api.FlowActions.FlowActionModel.AllowElectronicSignature is true)
* @type {boolean}
* @memberof FlowActionsFlowActionModel
*/
'requireIdScanAuthenticationToSignElectronically'?: boolean | null;
/**
*
* @type {CertificateTypes}
* @memberof FlowActionsFlowActionModel
*/
'requiredCertificateTypeToSign'?: CertificateTypes;
/**
* [DEPRECATED] The user is required to sign the document with a company certificate (e.g. e-CNPJ). Please use Lacuna.Signer.Api.FlowActions.FlowActionModel.RequiredCertificateHolderTypeToSign instead.
* @type {boolean}
* @memberof FlowActionsFlowActionModel
*/
'requireCompanyCertificate'?: boolean | null;
/**
* The user is required to sign the document with a company certificate (e.g. e-CNPJ) that has the provided company identifier.
* @type {string}
* @memberof FlowActionsFlowActionModel
*/
'requiredCompanyIdentifier'?: string | null;
/**
*
* @type {CertificateHolderTypes}
* @memberof FlowActionsFlowActionModel
*/
'requiredCertificateHolderTypeToSign'?: CertificateHolderTypes;
/**
*
* @type {string}
* @memberof FlowActionsFlowActionModel
*/
'refusalReason'?: string | null;
/**
*
* @type {SignatureInitialsModes}
* @memberof FlowActionsFlowActionModel
*/
'signatureInitialsMode'?: SignatureInitialsModes;
/**
*
* @type {boolean}
* @memberof FlowActionsFlowActionModel
*/
'isElectronic'?: boolean | null;
/**
*
* @type {boolean}
* @memberof FlowActionsFlowActionModel
*/
'allowRuleFlowToContinueIfRefused'?: boolean;
/**
*
* @type {NotificationLanguage}
* @memberof FlowActionsFlowActionModel
*/
'notificationLanguage'?: NotificationLanguage;
/**
*
* @type {FlowActionType}
* @memberof FlowActionsFlowActionModel
*/
'type'?: FlowActionType;
/**
*
* @type {ActionStatus}
* @memberof FlowActionsFlowActionModel
*/
'status'?: ActionStatus;
/**
*
* @type {number}
* @memberof FlowActionsFlowActionModel
*/
'step'?: number;
/**
* Name of the rule if type is SignRule or ApproverRule
* @type {string}
* @memberof FlowActionsFlowActionModel
*/
'ruleName'?: string | null;
/**
* Title of the participant
* @type {string}
* @memberof FlowActionsFlowActionModel
*/
'title'?: string | null;
}
/**
* Contains the ids of the pending actions if there are any.
* @export
* @interface FlowActionsPendingActionModel
*/
export interface FlowActionsPendingActionModel {
/**
*
* @type {string}
* @memberof FlowActionsPendingActionModel
*/
'signerId'?: string | null;
/**
*
* @type {string}
* @memberof FlowActionsPendingActionModel
*/
'signRuleId'?: string | null;
/**
*
* @type {string}
* @memberof FlowActionsPendingActionModel
*/
'approverId'?: string | null;
/**
*
* @type {string}
* @memberof FlowActionsPendingActionModel
*/
'approverRuleId'?: string | null;
}
/**
*
* @export
* @interface FlowActionsRectifiedParticipantModel
*/
export interface FlowActionsRectifiedParticipantModel {
/**
*
* @type {string}
* @memberof FlowActionsRectifiedParticipantModel
*/
'userId'?: string;
/**
*
* @type {UsersParticipantUserModel}
* @memberof FlowActionsRectifiedParticipantModel
*/
'requested'?: UsersParticipantUserModel;
/**
*
* @type {UsersParticipantUserModel}
* @memberof FlowActionsRectifiedParticipantModel
*/
'rectified'?: UsersParticipantUserModel;
}
/**
*
* @export
* @interface FlowActionsRuleUserModel
*/
export interface FlowActionsRuleUserModel {
/**
*
* @type {string}
* @memberof FlowActionsRuleUserModel
*/
'id'?: string;
/**
*
* @type {string}
* @memberof FlowActionsRuleUserModel
*/
'name'?: string | null;
/**
* The user identifier (CPF in Brazil or Cédula de Identidad in Ecuador/Paraguay).
* @type {string}
* @memberof FlowActionsRuleUserModel
*/
'identifier'?: string | null;
/**
*
* @type {string}
* @memberof FlowActionsRuleUserModel
*/
'email'?: string | null;
/**
*
* @type {string}
* @memberof FlowActionsRuleUserModel
*/
'phone'?: string | null;
/**
*
* @type {string}
* @memberof FlowActionsRuleUserModel
*/
'completeActionDate'?: string | null;
/**
* Defined only if it is a signature rule
* @type {boolean}
* @memberof FlowActionsRuleUserModel
*/
'isElectronic'?: boolean | null;
/**
*
* @type {string}
* @memberof FlowActionsRuleUserModel
*/
'refusalDate'?: string | null;
/**
*
* @type {boolean}
* @memberof FlowActionsRuleUserModel
*/
'hasRefused'?: boolean;
/**
*
* @type {string}
* @memberof FlowActionsRuleUserModel
*/
'refusalReason'?: string | null;
}
/**
*
* @export
* @interface FlowActionsSignRuleUserEditModel
*/
export interface FlowActionsSignRuleUserEditModel {
/**
*
* @type {string}
* @memberof FlowActionsSignRuleUserEditModel
*/
'userId'?: string;
/**
*
* @type {string}
* @memberof FlowActionsSignRuleUserEditModel
*/
'emailAddress'?: string | null;
/**
*
* @type {string}
* @memberof FlowActionsSignRuleUserEditModel
*/
'phoneNumber'?: string | null;
}
/**
*
* @export
* @interface FlowActionsSignRuleUserModel
*/
export interface FlowActionsSignRuleUserModel {
/**
*
* @type {string}
* @memberof FlowActionsSignRuleUserModel
*/
'id'?: string;
/**
*
* @type {string}
* @memberof FlowActionsSignRuleUserModel
*/
'name'?: string | null;
/**
* The user identifier (CPF in Brazil or Cédula de Identidad in Ecuador/Paraguay).
* @type {string}
* @memberof FlowActionsSignRuleUserModel
*/
'identifier'?: string | null;
/**
*
* @type {string}
* @memberof FlowActionsSignRuleUserModel
*/
'email'?: string | null;
/**
*
* @type {string}
* @memberof FlowActionsSignRuleUserModel
*/
'phone'?: string | null;
/**
*
* @type {string}
* @memberof FlowActionsSignRuleUserModel
*/
'signatureDate'?: string | null;
/**
*
* @type {boolean}
* @memberof FlowActionsSignRuleUserModel
*/
'isElectronic'?: boolean | null;
/**
*
* @type {string}
* @memberof FlowActionsSignRuleUserModel
*/
'refusalDate'?: string | null;
/**
*
* @type {boolean}
* @memberof FlowActionsSignRuleUserModel
*/
'hasRefused'?: boolean;
/**
*
* @type {string}
* @memberof FlowActionsSignRuleUserModel
*/
'refusalReason'?: string | null;
}
/**
*
* @export
* @interface FlowActionsSignatureModel
*/
export interface FlowActionsSignatureModel {
/**
*
* @type {string}
* @memberof FlowActionsSignatureModel
*/
'flowActionId'?: string;
/**
*
* @type {string}
* @memberof FlowActionsSignatureModel
*/
'date'?: string;
/**
*
* @type {string}
* @memberof FlowActionsSignatureModel
*/
'userId'?: string;
/**
*
* @type {string}
* @memberof FlowActionsSignatureModel
*/
'name'?: string | null;
/**
*
* @type {string}
* @memberof FlowActionsSignatureModel
*/
'identifier'?: string | null;
/**
*
* @type {string}
* @memberof FlowActionsSignatureModel
*/
'emailAddress'?: string | null;
}
/**
*
* @export
* @interface FlowActionsXadesOptionsModel
*/
export interface FlowActionsXadesOptionsModel {
/**
*
* @type {XadesSignatureTypes}
* @memberof FlowActionsXadesOptionsModel
*/
'signatureType'?: XadesSignatureTypes;
/**
*
* @type {XadesElementIdentifierTypes}
* @memberof FlowActionsXadesOptionsModel
*/
'elementToSignIdentifierType'?: XadesElementIdentifierTypes;
/**
* A string used to identify the element that should be signed. If the Lacuna.Signer.Api.FlowActions.XadesOptionsModel.ElementToSignIdentifierType is Lacuna.Signer.Api.XadesElementIdentifierTypes.Id, this string is the Id of the element to be signed. If the Lacuna.Signer.Api.FlowActions.XadesOptionsModel.ElementToSignIdentifierType is Lacuna.Signer.Api.XadesElementIdentifierTypes.XPath, this string is the XPath to the element to be signed.
* @type {string}
* @memberof FlowActionsXadesOptionsModel
*/
'elementToSignIdentifier'?: string | null;
/**
*
* @type {XadesInsertionOptions}
* @memberof FlowActionsXadesOptionsModel
*/
'insertionOption'?: XadesInsertionOptions;
/**
* By default the XPath transformation is applied in all XAdES signatures. You can set a flow action to not apply the transformation by setting this option to true. WARNING: If you disable the XPath transformation the signatures might be considered invalid in some validators if the same XML element is signed multiple times.
* @type {boolean}
* @memberof FlowActionsXadesOptionsModel
*/
'disableXPathTransformation'?: boolean;
}
/**
*
* @export
* @enum {string}
*/
export declare const FolderType: {
readonly Normal: "Normal";
readonly WithoutFolder: "WithoutFolder";
};
export type FolderType = typeof FolderType[keyof typeof FolderType];
/**
*
* @export
* @interface FoldersFolderCreateRequest
*/
export interface FoldersFolderCreateRequest {
/**
*
* @type {string}
* @memberof FoldersFolderCreateRequest
*/
'name': string;
/**
* Id of the parent folder. Set as null to create the folder as root.
* @type {string}
* @memberof FoldersFolderCreateRequest
*/
'parentId'?: string | null;
}
/**
*
* @export
* @interface FoldersFolderDeleteRequest
*/
export interface FoldersFolderDeleteRequest {
/**
*
* @type {DeleteAction}
* @memberof FoldersFolderDeleteRequest
*/
'deleteAction'?: DeleteAction;
/**
* The folder to which the documents will be moved (if Lacuna.Signer.Api.Folders.FolderDeleteRequest.DeleteAction is Lacuna.Signer.Api.DeleteAction.MoveContent). This value can be null if you want to keep the documents with no folder.
* @type {string}
* @memberof FoldersFolderDeleteRequest
*/
'destinationFolderId'?: string | null;
}
/**
*
* @export
* @interface FoldersFolderInfoModel
*/
export interface FoldersFolderInfoModel {
/**
*
* @type {string}
* @memberof FoldersFolderInfoModel
*/
'id'?: string;
/**
*
* @type {string}
* @memberof FoldersFolderInfoModel
*/
'name'?: string | null;
/**
*
* @type {string}
* @memberof FoldersFolderInfoModel
*/
'parentId'?: string | null;
}
/**
*
* @export
* @interface FoldersFolderOrganizationModel
*/
export interface FoldersFolderOrganizationModel {
/**
*
* @type {OrganizationsOrganizationInfoModel}
* @memberof FoldersFolderOrganizationModel
*/
'organization'?: OrganizationsOrganizationInfoModel;
/**
*
* @type {string}
* @memberof FoldersFolderOrganizationModel
*/
'id'?: string;
/**
*
* @type {string}
* @memberof FoldersFolderOrganizationModel
*/
'name'?: string | null;
/**
*
* @type {string}
* @memberof FoldersFolderOrganizationModel
*/
'parentId'?: string | null;
}
/**
* This option is only valid for the following document types: Prescription, MedicalCertificate, ExamRequest, LabReport, DischargeSummary, ClinicalRecord, DrugDispensing, Vaccination and MedicalReport
* @export
* @interface HealthDocumentsHealthDocumentData
*/
export interface HealthDocumentsHealthDocumentData {
/**
*
* @type {HealthDocumentsHealthProfessionalModel}
* @memberof HealthDocumentsHealthDocumentData
*/
'professional': HealthDocumentsHealthProfessionalModel;
/**
* Additional strutctured information for health documents. Can be used to display medication information.
* @type {Array}
* @memberof HealthDocumentsHealthDocumentData
*/
'items'?: Array | null;
}
/**
*
* @export
* @interface HealthDocumentsHealthItemModel
*/
export interface HealthDocumentsHealthItemModel {
/**
*
* @type {string}
* @memberof HealthDocumentsHealthItemModel
*/
'name': string;
/**
*
* @type {string}
* @memberof HealthDocumentsHealthItemModel
*/
'description'?: string | null;
/**
*
* @type {string}
* @memberof HealthDocumentsHealthItemModel
*/
'description2'?: string | null;
}
/**
*
* @export
* @interface HealthDocumentsHealthProfessionalModel
*/
export interface HealthDocumentsHealthProfessionalModel {
/**
* The professional ID number (e.g CRM)
* @type {string}
* @memberof HealthDocumentsHealthProfessionalModel
*/
'id': string;
/**
* The professional ID region (a.k.a UF)
* @type {string}
* @memberof HealthDocumentsHealthProfessionalModel
*/
'region': string;
}
/**
*
* @export
* @interface InvoicesInvoiceTotalModel
*/
export interface InvoicesInvoiceTotalModel {
/**
*
* @type {TransactionTypes}
* @memberof InvoicesInvoiceTotalModel
*/
'transactionType'?: TransactionTypes;
/**
*
* @type {TransactionsTransactionPriceModel}
* @memberof InvoicesInvoiceTotalModel
*/
'price'?: TransactionsTransactionPriceModel;
/**
*
* @type {number}
* @memberof InvoicesInvoiceTotalModel
*/
'total'?: number;
/**
*
* @type {number}
* @memberof InvoicesInvoiceTotalModel
*/
'totalInTrialPeriod'?: number;
/**
*
* @type {number}
* @memberof InvoicesInvoiceTotalModel
*/
'value'?: number;
}
/**
*
* @export
* @interface InvoicesUpdateInvoicePaymentStatusRequest
*/
export interface InvoicesUpdateInvoicePaymentStatusRequest {
/**
*
* @type {boolean}
* @memberof InvoicesUpdateInvoicePaymentStatusRequest
*/
'isPaid'?: boolean;
}
/**
*
* @export
* @enum {string}
*/
export declare const NotarizationStatus: {
readonly Pending: "Pending";
readonly Notarized: "Notarized";
readonly Rejected: "Rejected";
};
export type NotarizationStatus = typeof NotarizationStatus[keyof typeof NotarizationStatus];
/**
* Members:
- Test: Notary configuration that doesn\'t require a specific PKI
* @export
* @enum {string}
*/
export declare const NotaryTypes: {
readonly Test: "Test";
readonly Cnb: "CNB";
readonly Cori: "CORI";
readonly Onr: "ONR";
};
export type NotaryTypes = typeof NotaryTypes[keyof typeof NotaryTypes];
/**
*
* @export
* @enum {string}
*/
export declare const NotificationLanguage: {
readonly Pt: "Pt";
readonly Es: "Es";
readonly En: "En";
};
export type NotificationLanguage = typeof NotificationLanguage[keyof typeof NotificationLanguage];
/**
*
* @export
* @interface NotificationsCreateFlowActionReminderRequest
*/
export interface NotificationsCreateFlowActionReminderRequest {
/**
*
* @type {string}
* @memberof NotificationsCreateFlowActionReminderRequest
*/
'documentId': string;
/**
*
* @type {string}
* @memberof NotificationsCreateFlowActionReminderRequest
*/
'flowActionId': string;
}
/**
*
* @export
* @interface NotificationsEmailListNotificationRequest
*/
export interface NotificationsEmailListNotificationRequest {
/**
*
* @type {Array}
* @memberof NotificationsEmailListNotificationRequest
*/
'emails': Array;
}
/**
*
* @export
* @interface ObserversObserverCreateModel
*/
export interface ObserversObserverCreateModel {
/**
*
* @type {UsersParticipantUserModel}
* @memberof ObserversObserverCreateModel
*/
'user': UsersParticipantUserModel;
/**
*
* @type {NotificationLanguage}
* @memberof ObserversObserverCreateModel
*/
'notificationLanguage'?: NotificationLanguage;
}
/**
*
* @export
* @interface ObserversObserverEditModel
*/
export interface ObserversObserverEditModel {
/**
* Id of the observer being modified.
* @type {string}
* @memberof ObserversObserverEditModel
*/
'observerId'?: string;
/**
* The new email of the observer.
* @type {string}
* @memberof ObserversObserverEditModel
*/
'emailAddress'?: string | null;
/**
*
* @type {NotificationLanguage}
* @memberof ObserversObserverEditModel
*/
'notificationLanguage'?: NotificationLanguage;
}
/**
*
* @export
* @interface ObserversObserverModel
*/
export interface ObserversObserverModel {
/**
*
* @type {string}
* @memberof ObserversObserverModel
*/
'id'?: string;
/**
*
* @type {UsersParticipantUserModel}
* @memberof ObserversObserverModel
*/
'user'?: UsersParticipantUserModel;
/**
*
* @type {NotificationLanguage}
* @memberof ObserversObserverModel
*/
'notificationLanguage'?: NotificationLanguage;
}
/**
*
* @export
* @enum {string}
*/
export declare const OrganizationType: {
readonly Normal: "Normal";
readonly Personal: "Personal";
readonly SharedWithMe: "SharedWithMe";
};
export type OrganizationType = typeof OrganizationType[keyof typeof OrganizationType];
/**
*
* @export
* @interface OrganizationsAccessProfileModel
*/
export interface OrganizationsAccessProfileModel {
/**
*
* @type {boolean}
* @memberof OrganizationsAccessProfileModel
*/
'administrator'?: boolean;
/**
*
* @type {boolean}
* @memberof OrganizationsAccessProfileModel
*/
'manager'?: boolean;
/**
*
* @type {boolean}
* @memberof OrganizationsAccessProfileModel
*/
'operator'?: boolean;
}
/**
*
* @export
* @interface OrganizationsOrganizationInfoModel
*/
export interface OrganizationsOrganizationInfoModel {
/**
*
* @type {string}
* @memberof OrganizationsOrganizationInfoModel
*/
'id'?: string;
/**
*
* @type {string}
* @memberof OrganizationsOrganizationInfoModel
*/
'name'?: string | null;
/**
* The organization identifier (CNPJ)
* @type {string}
* @memberof OrganizationsOrganizationInfoModel
*/
'identifier'?: string | null;
/**
*
* @type {OrganizationsOrganizationOwnerInfoModel}
* @memberof OrganizationsOrganizationInfoModel
*/
'owner'?: OrganizationsOrganizationOwnerInfoModel;
}
/**
*
* @export
* @interface OrganizationsOrganizationOwnerInfoModel
*/
export interface OrganizationsOrganizationOwnerInfoModel {
/**
*
* @type {string}
* @memberof OrganizationsOrganizationOwnerInfoModel
*/
'id'?: string;
/**
*
* @type {string}
* @memberof OrganizationsOrganizationOwnerInfoModel
*/
'name'?: string | null;
}
/**
*
* @export
* @interface OrganizationsOrganizationUserModel
*/
export interface OrganizationsOrganizationUserModel {
/**
*
* @type {string}
* @memberof OrganizationsOrganizationUserModel
*/
'id'?: string | null;
/**
*
* @type {string}
* @memberof OrganizationsOrganizationUserModel
*/
'name'?: string | null;
/**
*
* @type {string}
* @memberof OrganizationsOrganizationUserModel
*/
'email'?: string | null;
/**
*
* @type {string}
* @memberof OrganizationsOrganizationUserModel
*/
'identifier'?: string | null;
/**
*
* @type {OrganizationsAccessProfileModel}
* @memberof OrganizationsOrganizationUserModel
*/
'accessProfile'?: OrganizationsAccessProfileModel;
}
/**
*
* @export
* @interface OrganizationsOrganizationUserPostRequest
*/
export interface OrganizationsOrganizationUserPostRequest {
/**
*
* @type {OrganizationsAccessProfileModel}
* @memberof OrganizationsOrganizationUserPostRequest
*/
'accessProfile'?: OrganizationsAccessProfileModel;
/**
*
* @type {string}
* @memberof OrganizationsOrganizationUserPostRequest
*/
'id'?: string | null;
/**
*
* @type {string}
* @memberof OrganizationsOrganizationUserPostRequest
*/
'name'?: string | null;
/**
* The user identifier (CPF in Brazil and Cédula de Identidad in Ecuador/Paraguay).
* @type {string}
* @memberof OrganizationsOrganizationUserPostRequest
*/
'identifier'?: string | null;
/**
*
* @type {string}
* @memberof OrganizationsOrganizationUserPostRequest
*/
'email'?: string | null;
/**
* The user\'s mobile phone number. It will be set only if the user does not exist, i.e. it will not override existing user\'s phones. Must use iternational format, example: +55 11 91234-5678
* @type {string}
* @memberof OrganizationsOrganizationUserPostRequest
*/
'phone'?: string | null;
}
/**
*
* @export
* @interface PaginatedSearchResponseDocumentFlowsDocumentFlowModel
*/
export interface PaginatedSearchResponseDocumentFlowsDocumentFlowModel {
/**
*
* @type {Array}
* @memberof PaginatedSearchResponseDocumentFlowsDocumentFlowModel
*/
'items'?: Array | null;
/**
*
* @type {number}
* @memberof PaginatedSearchResponseDocumentFlowsDocumentFlowModel
*/
'totalCount'?: number;
/**
*
* @type {string}
* @memberof PaginatedSearchResponseDocumentFlowsDocumentFlowModel
*/
'nextCursor'?: string | null;
}
/**
*
* @export
* @interface PaginatedSearchResponseDocumentsDocumentListModel
*/
export interface PaginatedSearchResponseDocumentsDocumentListModel {
/**
*
* @type {Array}
* @memberof PaginatedSearchResponseDocumentsDocumentListModel
*/
'items'?: Array | null;
/**
*
* @type {number}
* @memberof PaginatedSearchResponseDocumentsDocumentListModel
*/
'totalCount'?: number;
/**
*
* @type {string}
* @memberof PaginatedSearchResponseDocumentsDocumentListModel
*/
'nextCursor'?: string | null;
}
/**
*
* @export
* @interface PaginatedSearchResponseFoldersFolderInfoModel
*/
export interface PaginatedSearchResponseFoldersFolderInfoModel {
/**
*
* @type {Array}
* @memberof PaginatedSearchResponseFoldersFolderInfoModel
*/
'items'?: Array | null;
/**
*
* @type {number}
* @memberof PaginatedSearchResponseFoldersFolderInfoModel
*/
'totalCount'?: number;
/**
*
* @type {string}
* @memberof PaginatedSearchResponseFoldersFolderInfoModel
*/
'nextCursor'?: string | null;
}
/**
*
* @export
* @interface PaginatedSearchResponseOrganizationsOrganizationUserModel
*/
export interface PaginatedSearchResponseOrganizationsOrganizationUserModel {
/**
*
* @type {Array}
* @memberof PaginatedSearchResponseOrganizationsOrganizationUserModel
*/
'items'?: Array | null;
/**
*
* @type {number}
* @memberof PaginatedSearchResponseOrganizationsOrganizationUserModel
*/
'totalCount'?: number;
/**
*
* @type {string}
* @memberof PaginatedSearchResponseOrganizationsOrganizationUserModel
*/
'nextCursor'?: string | null;
}
/**
*
* @export
* @enum {string}
*/
export declare const PaginationOrders: {
readonly Asc: "Asc";
readonly Desc: "Desc";
};
export type PaginationOrders = typeof PaginationOrders[keyof typeof PaginationOrders];
/**
*
* @export
* @enum {string}
*/
export declare const ParticipantQueryTypes: {
readonly Name: "Name";
readonly Identifier: "Identifier";
readonly Email: "Email";
readonly Phone: "Phone";
};
export type ParticipantQueryTypes = typeof ParticipantQueryTypes[keyof typeof ParticipantQueryTypes];
/**
*
* @export
* @enum {string}
*/
export declare const Probability: {
readonly VeryLow: "VeryLow";
readonly Low: "Low";
readonly High: "High";
readonly VeryHigh: "VeryHigh";
};
export type Probability = typeof Probability[keyof typeof Probability];
/**
*
* @export
* @interface RefusalRefusalModel
*/
export interface RefusalRefusalModel {
/**
*
* @type {string}
* @memberof RefusalRefusalModel
*/
'flowActionId'?: string | null;
/**
*
* @type {string}
* @memberof RefusalRefusalModel
*/
'reason'?: string | null;
/**
*
* @type {string}
* @memberof RefusalRefusalModel
*/
'date'?: string;
/**
*
* @type {string}
* @memberof RefusalRefusalModel
*/
'userId'?: string;
/**
*
* @type {string}
* @memberof RefusalRefusalModel
*/
'name'?: string | null;
/**
*
* @type {string}
* @memberof RefusalRefusalModel
*/
'identifier'?: string | null;
/**
*
* @type {string}
* @memberof RefusalRefusalModel
*/
'emailAddress'?: string | null;
}
/**
*
* @export
* @interface RefusalRefusalRequest
*/
export interface RefusalRefusalRequest {
/**
*
* @type {string}
* @memberof RefusalRefusalRequest
*/
'reason': string;
}
/**
*
* @export
* @interface SecurityContextsAuthenticationTypesModel
*/
export interface SecurityContextsAuthenticationTypesModel {
/**
*
* @type {boolean}
* @memberof SecurityContextsAuthenticationTypesModel
*/
'sms'?: boolean;
/**
*
* @type {boolean}
* @memberof SecurityContextsAuthenticationTypesModel
*/
'whatsapp'?: boolean;
/**
*
* @type {boolean}
* @memberof SecurityContextsAuthenticationTypesModel
*/
'otp'?: boolean;
/**
*
* @type {boolean}
* @memberof SecurityContextsAuthenticationTypesModel
*/
'selfie'?: boolean;
/**
*
* @type {boolean}
* @memberof SecurityContextsAuthenticationTypesModel
*/
'datavalid'?: boolean;
/**
*
* @type {boolean}
* @memberof SecurityContextsAuthenticationTypesModel
*/
'pix'?: boolean;
/**
*
* @type {boolean}
* @memberof SecurityContextsAuthenticationTypesModel
*/
'email'?: boolean;
/**
*
* @type {boolean}
* @memberof SecurityContextsAuthenticationTypesModel
*/
'liveness'?: boolean;
/**
*
* @type {boolean}
* @memberof SecurityContextsAuthenticationTypesModel
*/
'idScan'?: boolean;
}
/**
*
* @export
* @interface SecurityContextsSecurityContextSimpleModel
*/
export interface SecurityContextsSecurityContextSimpleModel {
/**
*
* @type {string}
* @memberof SecurityContextsSecurityContextSimpleModel
*/
'id'?: string;
/**
*
* @type {string}
* @memberof SecurityContextsSecurityContextSimpleModel
*/
'name'?: string | null;
/**
*
* @type {string}
* @memberof SecurityContextsSecurityContextSimpleModel
*/
'englishName'?: string | null;
/**
*
* @type {string}
* @memberof SecurityContextsSecurityContextSimpleModel
*/
'portugueseName'?: string | null;
/**
*
* @type {string}
* @memberof SecurityContextsSecurityContextSimpleModel
*/
'spanishName'?: string | null;
/**
*
* @type {boolean}
* @memberof SecurityContextsSecurityContextSimpleModel
*/
'allowDigitalSignature'?: boolean;
/**
*
* @type {SecurityContextsAuthenticationTypesModel}
* @memberof SecurityContextsSecurityContextSimpleModel
*/
'allowedElectronicTypes'?: SecurityContextsAuthenticationTypesModel;
/**
*
* @type {boolean}
* @memberof SecurityContextsSecurityContextSimpleModel
*/
'requireLivenessOnSelfieAuthentication'?: boolean;
/**
*
* @type {boolean}
* @memberof SecurityContextsSecurityContextSimpleModel
*/
'requireLivenessOnDatavalidAuthentication'?: boolean;
}
/**
*
* @export
* @interface SignatureDatavalidSelfieValidationResponse
*/
export interface SignatureDatavalidSelfieValidationResponse {
/**
*
* @type {boolean}
* @memberof SignatureDatavalidSelfieValidationResponse
*/
'available'?: boolean;
/**
*
* @type {Probability}
* @memberof SignatureDatavalidSelfieValidationResponse
*/
'probability'?: Probability;
/**
*
* @type {number}
* @memberof SignatureDatavalidSelfieValidationResponse
*/
'similarity'?: number | null;
}
/**
*
* @export
* @interface SignatureEvidencesModel
*/
export interface SignatureEvidencesModel {
/**
*
* @type {string}
* @memberof SignatureEvidencesModel
*/
'ipAddress'?: string | null;
/**
* A list containing the the authentication types used when signing the document.
* @type {Array}
* @memberof SignatureEvidencesModel
*/
'authenticationTypes'?: Array | null;
/**
* If the user was logged-in when he signed the document this is the verified email of his account. If Lacuna.Signer.Api.Signature.EvidencesModel.AuthenticationTypes doesn\'t contains Lacuna.Signer.Api.AuthenticationTypes.Login this will be null.
* @type {string}
* @memberof SignatureEvidencesModel
*/
'accountVerifiedEmail'?: string | null;
/**
* The email to which the notification to sign the document was sent. If Lacuna.Signer.Api.Signature.EvidencesModel.AuthenticationTypes doesn\'t contains Lacuna.Signer.Api.AuthenticationTypes.Email this will be null.
* @type {string}
* @memberof SignatureEvidencesModel
*/
'authenticatedEmail'?: string | null;
/**
* The last four digits of the phone number to which the SMS confirmation code was sent. If Lacuna.Signer.Api.Signature.EvidencesModel.AuthenticationTypes doesn\'t contains Lacuna.Signer.Api.AuthenticationTypes.SMS this will be null.
* @type {string}
* @memberof SignatureEvidencesModel
*/
'authenticatedPhoneNumberLastDigits'?: string | null;
/**
*
* @type {ApplicationsApplicationDisplayModel}
* @memberof SignatureEvidencesModel
*/
'authenticatedApplication'?: ApplicationsApplicationDisplayModel;
/**
*
* @type {SignatureSelfieModel}
* @memberof SignatureEvidencesModel
*/
'authenticatedSelfie'?: SignatureSelfieModel;
/**
*
* @type {SignaturePixAuthenticationModel}
* @memberof SignatureEvidencesModel
*/
'authenticatedPix'?: SignaturePixAuthenticationModel;
/**
*
* @type {SignatureLiveness3dAuthenticationModel}
* @memberof SignatureEvidencesModel
*/
'livenessData'?: SignatureLiveness3dAuthenticationModel;
/**
*
* @type {SignatureGeolocationModel}
* @memberof SignatureEvidencesModel
*/
'geolocation'?: SignatureGeolocationModel;
/**
*
* @type {string}
* @memberof SignatureEvidencesModel
*/
'timestamp'?: string;
/**
* SHA-256 Hash (Base64 encoded) of the evidences JSON file
* @type {string}
* @memberof SignatureEvidencesModel
*/
'evidencesSha256'?: string | null;
/**
* The phone number to which the SMS confirmation code was sent. If Lacuna.Signer.Api.Signature.EvidencesModel.AuthenticationTypes doesn\'t contains Lacuna.Signer.Api.AuthenticationTypes.SMS this will be null.
* @type {string}
* @memberof SignatureEvidencesModel
*/
'authenticatedPhoneNumber'?: string | null;
/**
* The evidences JSON file in bytes.
* @type {string}
* @memberof SignatureEvidencesModel
*/
'file'?: string | null;
/**
* Ticket to download the evidences JSON file.
* @type {string}
* @memberof SignatureEvidencesModel
*/
'fileTicket'?: string | null;
}
/**
*
* @export
* @interface SignatureGeolocationModel
*/
export interface SignatureGeolocationModel {
/**
*
* @type {number}
* @memberof SignatureGeolocationModel
*/
'latitude'?: number | null;
/**
*
* @type {number}
* @memberof SignatureGeolocationModel
*/
'longitude'?: number | null;
/**
*
* @type {number}
* @memberof SignatureGeolocationModel
*/
'accuracy'?: number | null;
}
/**
*
* @export
* @enum {string}
*/
export declare const SignatureInitialsModes: {
readonly None: "None";
readonly Optional: "Optional";
readonly Required: "Required";
};
export type SignatureInitialsModes = typeof SignatureInitialsModes[keyof typeof SignatureInitialsModes];
/**
*
* @export
* @interface SignatureLiveness3dAuthenticationModel
*/
export interface SignatureLiveness3dAuthenticationModel {
/**
*
* @type {string}
* @memberof SignatureLiveness3dAuthenticationModel
*/
'sessionId'?: string | null;
}
/**
*
* @export
* @interface SignaturePixAuthenticationModel
*/
export interface SignaturePixAuthenticationModel {
/**
*
* @type {string}
* @memberof SignaturePixAuthenticationModel
*/
'endToEndId'?: string | null;
/**
*
* @type {string}
* @memberof SignaturePixAuthenticationModel
*/
'pixKey'?: string | null;
/**
*
* @type {string}
* @memberof SignaturePixAuthenticationModel
*/
'paymentDate'?: string;
}
/**
*
* @export
* @interface SignatureSelfieModel
*/
export interface SignatureSelfieModel {
/**
*
* @type {string}
* @memberof SignatureSelfieModel
*/
'id'?: string;
/**
*
* @type {string}
* @memberof SignatureSelfieModel
*/
'contentB64'?: string | null;
/**
*
* @type {string}
* @memberof SignatureSelfieModel
*/
'mimeType'?: string | null;
/**
*
* @type {SignatureDatavalidSelfieValidationResponse}
* @memberof SignatureSelfieModel
*/
'validationResponse'?: SignatureDatavalidSelfieValidationResponse;
}
/**
*
* @export
* @interface SignatureSignaturesInfoRequest
*/
export interface SignatureSignaturesInfoRequest {
/**
* Id of the uploaded file.
* @type {string}
* @memberof SignatureSignaturesInfoRequest
*/
'fileId': string;
/**
*
* @type {string}
* @memberof SignatureSignaturesInfoRequest
*/
'mimeType': string;
/**
*
* @type {SignatureTypes}
* @memberof SignatureSignaturesInfoRequest
*/
'signatureType'?: SignatureTypes;
/**
*
* @type {string}
* @memberof SignatureSignaturesInfoRequest
*/
'securityContextId'?: string | null;
}
/**
*
* @export
* @enum {string}
*/
export declare const SignatureTypes: {
readonly None: "None";
readonly Simple: "Simple";
readonly Advanced: "Advanced";
readonly Qualified: "Qualified";
};
export type SignatureTypes = typeof SignatureTypes[keyof typeof SignatureTypes];
/**
*
* @export
* @interface SignerModel
*/
export interface SignerModel {
/**
*
* @type {string}
* @memberof SignerModel
*/
'subjectName'?: string | null;
/**
*
* @type {string}
* @memberof SignerModel
*/
'emailAddress'?: string | null;
/**
*
* @type {string}
* @memberof SignerModel
*/
'issuerName'?: string | null;
/**
*
* @type {string}
* @memberof SignerModel
*/
'identifier'?: string | null;
/**
*
* @type {string}
* @memberof SignerModel
*/
'companyName'?: string | null;
/**
*
* @type {string}
* @memberof SignerModel
*/
'companyIdentifier'?: string | null;
/**
*
* @type {boolean}
* @memberof SignerModel
*/
'isElectronic'?: boolean;
/**
*
* @type {boolean}
* @memberof SignerModel
*/
'isTimestamp'?: boolean;
/**
*
* @type {string}
* @memberof SignerModel
*/
'signingTime'?: string | null;
/**
*
* @type {string}
* @memberof SignerModel
*/
'certificateThumbprint'?: string | null;
/**
*
* @type {SignatureEvidencesModel}
* @memberof SignerModel
*/
'evidences'?: SignatureEvidencesModel;
/**
*
* @type {Array}
* @memberof SignerModel
*/
'attributeCertificates'?: Array | null;
/**
*
* @type {ValidationResultsModel}
* @memberof SignerModel
*/
'validationResults'?: ValidationResultsModel;
/**
*
* @type {string}
* @memberof SignerModel
*/
'validityStart'?: string;
/**
*
* @type {string}
* @memberof SignerModel
*/
'validityEnd'?: string;
/**
*
* @type {Array}
* @memberof SignerModel
*/
'signatureTimestamps'?: Array | null;
/**
*
* @type {Array}
* @memberof SignerModel
*/
'archiveTimestamps'?: Array | null;
}
/**
*
* @export
* @interface TicketModel
*/
export interface TicketModel {
/**
*
* @type {string}
* @memberof TicketModel
*/
'location'?: string | null;
}
/**
*
* @export
* @interface TimestampModel
*/
export interface TimestampModel {
/**
*
* @type {string}
* @memberof TimestampModel
*/
'displayName'?: string | null;
/**
*
* @type {string}
* @memberof TimestampModel
*/
'genTime'?: string;
/**
*
* @type {string}
* @memberof TimestampModel
*/
'validityStart'?: string;
/**
*
* @type {string}
* @memberof TimestampModel
*/
'validityEnd'?: string;
}
/**
*
* @export
* @enum {string}
*/
export declare const TransactionPricingTypes: {
readonly NoCharge: "NoCharge";
readonly Simple: "Simple";
readonly Range: "Range";
};
export type TransactionPricingTypes = typeof TransactionPricingTypes[keyof typeof TransactionPricingTypes];
/**
*
* @export
* @enum {string}
*/
export declare const TransactionTypes: {
readonly Document: "Document";
readonly Signature: "Signature";
readonly ElectronicSignature: "ElectronicSignature";
readonly Approval: "Approval";
readonly Notarization: "Notarization";
readonly Timestamper: "Timestamper";
readonly Sms: "Sms";
readonly Whatsapp: "Whatsapp";
readonly Datavalid: "Datavalid";
readonly PixAuthentication: "PixAuthentication";
readonly Envelope: "Envelope";
readonly Liveness: "Liveness";
readonly IdScan: "IdScan";
readonly IdScanSelfie: "IdScanSelfie";
};
export type TransactionTypes = typeof TransactionTypes[keyof typeof TransactionTypes];
/**
*
* @export
* @interface TransactionsPriceRangeModel
*/
export interface TransactionsPriceRangeModel {
/**
*
* @type {number}
* @memberof TransactionsPriceRangeModel
*/
'price': number;
/**
* The upper limit of the price range. If the limit is null, this is the price when the number of transactions exceed the limit of all the other ranges.
* @type {number}
* @memberof TransactionsPriceRangeModel
*/
'limit'?: number | null;
}
/**
*
* @export
* @interface TransactionsTransactionPriceModel
*/
export interface TransactionsTransactionPriceModel {
/**
*
* @type {TransactionTypes}
* @memberof TransactionsTransactionPriceModel
*/
'transactionType': TransactionTypes;
/**
*
* @type {TransactionPricingTypes}
* @memberof TransactionsTransactionPriceModel
*/
'pricingType': TransactionPricingTypes;
/**
* Price of the transaction type (if Lacuna.Signer.Api.Transactions.TransactionPriceModel.PricingType is Lacuna.Signer.Api.TransactionPricingTypes.Simple)
* @type {number}
* @memberof TransactionsTransactionPriceModel
*/
'price'?: number | null;
/**
* Price ranges of transaction type (if Lacuna.Signer.Api.Transactions.TransactionPriceModel.PricingType is Lacuna.Signer.Api.TransactionPricingTypes.Range)
* @type {Array}
* @memberof TransactionsTransactionPriceModel
*/
'priceRanges'?: Array | null;
/**
*
* @type {number}
* @memberof TransactionsTransactionPriceModel
*/
'limit'?: number | null;
}
/**
*
* @export
* @interface UploadModel
*/
export interface UploadModel {
/**
* The upload Id as returned by the Upload API
* @type {string}
* @memberof UploadModel
*/
'id': string;
/**
* The file\'s original name.
* @type {string}
* @memberof UploadModel
*/
'name': string;
/**
* The file\'s mime type. Unless overridden, PDF mime types will be signed as PAdES and all other types as CAdES.
* @type {string}
* @memberof UploadModel
*/
'contentType': string;
}
/**
*
* @export
* @interface UploadsUploadBytesModel
*/
export interface UploadsUploadBytesModel {
/**
* The ID of the uploaded file so it can be used to create documents.
* @type {string}
* @memberof UploadsUploadBytesModel
*/
'id'?: string | null;
/**
* The size in bytes of the received file.
* @type {number}
* @memberof UploadsUploadBytesModel
*/
'size'?: number;
/**
* The MD5 digest (hash) of the received file. Can be used for integrity checks.
* @type {string}
* @memberof UploadsUploadBytesModel
*/
'digest'?: string | null;
}
/**
*
* @export
* @interface UploadsUploadBytesRequest
*/
export interface UploadsUploadBytesRequest {
/**
* The file bytes encoded in Base 64 format.
* @type {string}
* @memberof UploadsUploadBytesRequest
*/
'bytes': string;
}
/**
*
* @export
* @interface UsersParticipantUserModel
*/
export interface UsersParticipantUserModel {
/**
*
* @type {string}
* @memberof UsersParticipantUserModel
*/
'id'?: string | null;
/**
*
* @type {string}
* @memberof UsersParticipantUserModel
*/
'name'?: string | null;
/**
* The user identifier (CPF in Brazil and Cédula de Identidad in Ecuador/Paraguay).
* @type {string}
* @memberof UsersParticipantUserModel
*/
'identifier'?: string | null;
/**
*
* @type {string}
* @memberof UsersParticipantUserModel
*/
'email'?: string | null;
/**
* The user\'s mobile phone number. It will be set only if the user does not exist, i.e. it will not override existing user\'s phones. Must use iternational format, example: +55 11 91234-5678
* @type {string}
* @memberof UsersParticipantUserModel
*/
'phone'?: string | null;
}
/**
*
* @export
* @interface ValidationItemModel
*/
export interface ValidationItemModel {
/**
*
* @type {string}
* @memberof ValidationItemModel
*/
'type'?: string | null;
/**
*
* @type {string}
* @memberof ValidationItemModel
*/
'message'?: string | null;
/**
*
* @type {string}
* @memberof ValidationItemModel
*/
'detail'?: string | null;
/**
*
* @type {ValidationResultsModel}
* @memberof ValidationItemModel
*/
'innerValidationResults'?: ValidationResultsModel;
}
/**
*
* @export
* @interface ValidationResultsModel
*/
export interface ValidationResultsModel {
/**
*
* @type {Array}
* @memberof ValidationResultsModel
*/
'passedChecks'?: Array | null;
/**
*
* @type {Array}
* @memberof ValidationResultsModel
*/
'errors'?: Array | null;
/**
*
* @type {Array}
* @memberof ValidationResultsModel
*/
'warnings'?: Array | null;
/**
*
* @type {Array}
* @memberof ValidationResultsModel
*/
'indeterminateItens'?: Array | null;
/**
*
* @type {boolean}
* @memberof ValidationResultsModel
*/
'isValid'?: boolean;
}
/**
*
* @export
* @enum {string}
*/
export declare const WebhookTypes: {
readonly DocumentConcluded: "DocumentConcluded";
readonly InvoiceClosed: "InvoiceClosed";
readonly DocumentRefused: "DocumentRefused";
readonly DocumentApproved: "DocumentApproved";
readonly DocumentSigned: "DocumentSigned";
readonly DocumentCanceled: "DocumentCanceled";
readonly DocumentExpired: "DocumentExpired";
readonly DocumentsCreated: "DocumentsCreated";
readonly DocumentDeleted: "DocumentDeleted";
};
export type WebhookTypes = typeof WebhookTypes[keyof typeof WebhookTypes];
/**
*
* @export
* @interface WebhooksDocumentApprovedModel
*/
export interface WebhooksDocumentApprovedModel {
/**
*
* @type {FlowActionsApprovalModel}
* @memberof WebhooksDocumentApprovedModel
*/
'approval'?: FlowActionsApprovalModel;
/**
* The document\'s id
* @type {string}
* @memberof WebhooksDocumentApprovedModel
*/
'id'?: string;
/**
* The document\'s name
* @type {string}
* @memberof WebhooksDocumentApprovedModel
*/
'name'?: string | null;
/**
* The date the document was created.
* @type {string}
* @memberof WebhooksDocumentApprovedModel
*/
'creationDate'?: string;
/**
* The date of the last update to the document.
* @type {string}
* @memberof WebhooksDocumentApprovedModel
*/
'updateDate'?: string;
/**
*
* @type {FoldersFolderInfoModel}
* @memberof WebhooksDocumentApprovedModel
*/
'folder'?: FoldersFolderInfoModel;
/**
*
* @type {OrganizationsOrganizationInfoModel}
* @memberof WebhooksDocumentApprovedModel
*/
'organization'?: OrganizationsOrganizationInfoModel;
/**
*
* @type {DocumentsCreatorModel}
* @memberof WebhooksDocumentApprovedModel
*/
'createdBy'?: DocumentsCreatorModel;
}
/**
*
* @export
* @interface WebhooksDocumentCanceledModel
*/
export interface WebhooksDocumentCanceledModel {
/**
*
* @type {AgentsAgentModel}
* @memberof WebhooksDocumentCanceledModel
*/
'canceledBy'?: AgentsAgentModel;
/**
*
* @type {string}
* @memberof WebhooksDocumentCanceledModel
*/
'reason'?: string | null;
/**
* The document\'s id
* @type {string}
* @memberof WebhooksDocumentCanceledModel
*/
'id'?: string;
/**
* The document\'s name
* @type {string}
* @memberof WebhooksDocumentCanceledModel
*/
'name'?: string | null;
/**
* The date the document was created.
* @type {string}
* @memberof WebhooksDocumentCanceledModel
*/
'creationDate'?: string;
/**
* The date of the last update to the document.
* @type {string}
* @memberof WebhooksDocumentCanceledModel
*/
'updateDate'?: string;
/**
*
* @type {FoldersFolderInfoModel}
* @memberof WebhooksDocumentCanceledModel
*/
'folder'?: FoldersFolderInfoModel;
/**
*
* @type {OrganizationsOrganizationInfoModel}
* @memberof WebhooksDocumentCanceledModel
*/
'organization'?: OrganizationsOrganizationInfoModel;
/**
*
* @type {DocumentsCreatorModel}
* @memberof WebhooksDocumentCanceledModel
*/
'createdBy'?: DocumentsCreatorModel;
}
/**
*
* @export
* @interface WebhooksDocumentConcludedModel
*/
export interface WebhooksDocumentConcludedModel {
/**
* The document\'s id
* @type {string}
* @memberof WebhooksDocumentConcludedModel
*/
'id'?: string;
/**
* The document\'s name
* @type {string}
* @memberof WebhooksDocumentConcludedModel
*/
'name'?: string | null;
/**
* The date the document was created.
* @type {string}
* @memberof WebhooksDocumentConcludedModel
*/
'creationDate'?: string;
/**
* The date of the last update to the document.
* @type {string}
* @memberof WebhooksDocumentConcludedModel
*/
'updateDate'?: string;
/**
*
* @type {FoldersFolderInfoModel}
* @memberof WebhooksDocumentConcludedModel
*/
'folder'?: FoldersFolderInfoModel;
/**
*
* @type {OrganizationsOrganizationInfoModel}
* @memberof WebhooksDocumentConcludedModel
*/
'organization'?: OrganizationsOrganizationInfoModel;
/**
*
* @type {DocumentsCreatorModel}
* @memberof WebhooksDocumentConcludedModel
*/
'createdBy'?: DocumentsCreatorModel;
}
/**
*
* @export
* @interface WebhooksDocumentExpiredModel
*/
export interface WebhooksDocumentExpiredModel {
/**
* The expiration date of the document in the default timezone.
* @type {string}
* @memberof WebhooksDocumentExpiredModel
*/
'expirationDate'?: string;
/**
* The expiration date without time: in yyyy-MM-dd format (useful for display purposes).
* @type {string}
* @memberof WebhooksDocumentExpiredModel
*/
'expirationDateWithoutTime'?: string | null;
/**
* The document\'s id
* @type {string}
* @memberof WebhooksDocumentExpiredModel
*/
'id'?: string;
/**
* The document\'s name
* @type {string}
* @memberof WebhooksDocumentExpiredModel
*/
'name'?: string | null;
/**
* The date the document was created.
* @type {string}
* @memberof WebhooksDocumentExpiredModel
*/
'creationDate'?: string;
/**
* The date of the last update to the document.
* @type {string}
* @memberof WebhooksDocumentExpiredModel
*/
'updateDate'?: string;
/**
*
* @type {FoldersFolderInfoModel}
* @memberof WebhooksDocumentExpiredModel
*/
'folder'?: FoldersFolderInfoModel;
/**
*
* @type {OrganizationsOrganizationInfoModel}
* @memberof WebhooksDocumentExpiredModel
*/
'organization'?: OrganizationsOrganizationInfoModel;
/**
*
* @type {DocumentsCreatorModel}
* @memberof WebhooksDocumentExpiredModel
*/
'createdBy'?: DocumentsCreatorModel;
}
/**
*
* @export
* @interface WebhooksDocumentInformationModel
*/
export interface WebhooksDocumentInformationModel {
/**
* The document\'s id
* @type {string}
* @memberof WebhooksDocumentInformationModel
*/
'id'?: string;
/**
* The document\'s name
* @type {string}
* @memberof WebhooksDocumentInformationModel
*/
'name'?: string | null;
/**
* The date the document was created.
* @type {string}
* @memberof WebhooksDocumentInformationModel
*/
'creationDate'?: string;
/**
* The date of the last update to the document.
* @type {string}
* @memberof WebhooksDocumentInformationModel
*/
'updateDate'?: string;
/**
*
* @type {FoldersFolderInfoModel}
* @memberof WebhooksDocumentInformationModel
*/
'folder'?: FoldersFolderInfoModel;
/**
*
* @type {OrganizationsOrganizationInfoModel}
* @memberof WebhooksDocumentInformationModel
*/
'organization'?: OrganizationsOrganizationInfoModel;
/**
*
* @type {DocumentsCreatorModel}
* @memberof WebhooksDocumentInformationModel
*/
'createdBy'?: DocumentsCreatorModel;
}
/**
*
* @export
* @interface WebhooksDocumentRefusedModel
*/
export interface WebhooksDocumentRefusedModel {
/**
*
* @type {RefusalRefusalModel}
* @memberof WebhooksDocumentRefusedModel
*/
'refusal'?: RefusalRefusalModel;
/**
* The document\'s id
* @type {string}
* @memberof WebhooksDocumentRefusedModel
*/
'id'?: string;
/**
* The document\'s name
* @type {string}
* @memberof WebhooksDocumentRefusedModel
*/
'name'?: string | null;
/**
* The date the document was created.
* @type {string}
* @memberof WebhooksDocumentRefusedModel
*/
'creationDate'?: string;
/**
* The date of the last update to the document.
* @type {string}
* @memberof WebhooksDocumentRefusedModel
*/
'updateDate'?: string;
/**
*
* @type {FoldersFolderInfoModel}
* @memberof WebhooksDocumentRefusedModel
*/
'folder'?: FoldersFolderInfoModel;
/**
*
* @type {OrganizationsOrganizationInfoModel}
* @memberof WebhooksDocumentRefusedModel
*/
'organization'?: OrganizationsOrganizationInfoModel;
/**
*
* @type {DocumentsCreatorModel}
* @memberof WebhooksDocumentRefusedModel
*/
'createdBy'?: DocumentsCreatorModel;
}
/**
*
* @export
* @interface WebhooksDocumentSignedModel
*/
export interface WebhooksDocumentSignedModel {
/**
*
* @type {FlowActionsSignatureModel}
* @memberof WebhooksDocumentSignedModel
*/
'signature'?: FlowActionsSignatureModel;
/**
* The document\'s id
* @type {string}
* @memberof WebhooksDocumentSignedModel
*/
'id'?: string;
/**
* The document\'s name
* @type {string}
* @memberof WebhooksDocumentSignedModel
*/
'name'?: string | null;
/**
* The date the document was created.
* @type {string}
* @memberof WebhooksDocumentSignedModel
*/
'creationDate'?: string;
/**
* The date of the last update to the document.
* @type {string}
* @memberof WebhooksDocumentSignedModel
*/
'updateDate'?: string;
/**
*
* @type {FoldersFolderInfoModel}
* @memberof WebhooksDocumentSignedModel
*/
'folder'?: FoldersFolderInfoModel;
/**
*
* @type {OrganizationsOrganizationInfoModel}
* @memberof WebhooksDocumentSignedModel
*/
'organization'?: OrganizationsOrganizationInfoModel;
/**
*
* @type {DocumentsCreatorModel}
* @memberof WebhooksDocumentSignedModel
*/
'createdBy'?: DocumentsCreatorModel;
}
/**
*
* @export
* @interface WebhooksDocumentsCreatedModel
*/
export interface WebhooksDocumentsCreatedModel {
/**
*
* @type {Array}
* @memberof WebhooksDocumentsCreatedModel
*/
'documents'?: Array | null;
}
/**
* Members:
- DeletedByOrganization: Documents were deleted as part of an organization wide deletion process. The DocumentDeletedModel.Documents list is limited to 100 documents.
- DeletedByFolder: Documents were deleted due to the deletion of a folder that contained them. The DocumentDeletedModel.Documents list is limited to 100 documents.
- DeletedByUserOrApplication: Documents were deleted by a user or application.
* @export
* @enum {string}
*/
export declare const WebhooksDocumentsDeletedAction: {
readonly DeletedByOrganization: "DeletedByOrganization";
readonly DeletedByFolder: "DeletedByFolder";
readonly DeletedByUserOrApplication: "DeletedByUserOrApplication";
};
export type WebhooksDocumentsDeletedAction = typeof WebhooksDocumentsDeletedAction[keyof typeof WebhooksDocumentsDeletedAction];
/**
*
* @export
* @interface WebhooksDocumentsDeletedModel
*/
export interface WebhooksDocumentsDeletedModel {
/**
*
* @type {WebhooksDocumentsDeletedAction}
* @memberof WebhooksDocumentsDeletedModel
*/
'action'?: WebhooksDocumentsDeletedAction;
/**
* The list of deleted document details. When Action is DocumentDeletedAction.DeletedByOrganization or DocumentDeletedAction.DeletedByFolder, this list is limited to 100 documents.
* @type {Array}
* @memberof WebhooksDocumentsDeletedModel
*/
'documents'?: Array | null;
}
/**
*
* @export
* @interface WebhooksInvoiceClosedModel
*/
export interface WebhooksInvoiceClosedModel {
/**
*
* @type {number}
* @memberof WebhooksInvoiceClosedModel
*/
'id'?: number;
/**
*
* @type {number}
* @memberof WebhooksInvoiceClosedModel
*/
'month'?: number;
/**
*
* @type {number}
* @memberof WebhooksInvoiceClosedModel
*/
'year'?: number;
/**
*
* @type {number}
* @memberof WebhooksInvoiceClosedModel
*/
'value'?: number;
/**
*
* @type {Array}
* @memberof WebhooksInvoiceClosedModel
*/
'invoiceTotals'?: Array | null;
/**
*
* @type {OrganizationsOrganizationInfoModel}
* @memberof WebhooksInvoiceClosedModel
*/
'organization'?: OrganizationsOrganizationInfoModel;
/**
*
* @type {BillingBillingInformationModel}
* @memberof WebhooksInvoiceClosedModel
*/
'billingInformation'?: BillingBillingInformationModel;
}
/**
*
* @export
* @interface WebhooksWebhookModel
*/
export interface WebhooksWebhookModel {
/**
*
* @type {WebhookTypes}
* @memberof WebhooksWebhookModel
*/
'type'?: WebhookTypes;
/**
* The type-specific data of this webhook event. Check the documentation to see the corresponding model for an event type.
* @type {any}
* @memberof WebhooksWebhookModel
*/
'data'?: any | null;
}
/**
*
* @export
* @enum {string}
*/
export declare const XadesElementIdentifierTypes: {
readonly Id: "Id";
readonly XPath: "XPath";
};
export type XadesElementIdentifierTypes = typeof XadesElementIdentifierTypes[keyof typeof XadesElementIdentifierTypes];
/**
*
* @export
* @enum {string}
*/
export declare const XadesInsertionOptions: {
readonly AppendChild: "AppendChild";
readonly PrependChild: "PrependChild";
readonly AppendSibling: "AppendSibling";
readonly PrependSibling: "PrependSibling";
};
export type XadesInsertionOptions = typeof XadesInsertionOptions[keyof typeof XadesInsertionOptions];
/**
*
* @export
* @enum {string}
*/
export declare const XadesSignatureTypes: {
readonly FullXml: "FullXml";
readonly XmlElement: "XmlElement";
readonly FullXmlAdRc: "FullXmlAdRc";
};
export type XadesSignatureTypes = typeof XadesSignatureTypes[keyof typeof XadesSignatureTypes];
/**
*
* @export
* @interface XmlNamespaceModel
*/
export interface XmlNamespaceModel {
/**
*
* @type {string}
* @memberof XmlNamespaceModel
*/
'prefix': string;
/**
*
* @type {string}
* @memberof XmlNamespaceModel
*/
'uri': string;
}
/**
* DocumentsApi - axios parameter creator
* @export
*/
export declare const DocumentsApiAxiosParamCreator: (configuration?: Configuration) => {
/**
*
* @summary Moves a batch of documents to a folder.
* @param {DocumentsMoveDocumentBatchRequest} [documentsMoveDocumentBatchRequest]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiDocumentsBatchFolderPost: (documentsMoveDocumentBatchRequest?: DocumentsMoveDocumentBatchRequest, options?: AxiosRequestConfig) => Promise;
/**
* You may filter the documents by folder and document type.
* @summary Retrieves the documents of the organization paginating the response.
* @param {boolean} [isConcluded] (DEPRECATED) Please use \"Status\" parameter instead. Set to true to list concluded documents, false to list pending documents.
* @param {DocumentFilterStatus} [status] Filters by document status. Will override the \"IsConcluded\" property.
* @param {string} [folderId]
* @param {FolderType} [folderType]
* @param {DocumentTypes} [documentType]
* @param {boolean} [filterByDocumentType] True if the documents should be filtered by type, use documentType to specify the document type. If you want to filter only documents without a type, set this parameter to true and the documentType to null.
* @param {boolean} [filterByPendingSignature] True if documents should be filtered only for those that have FlowAction of the type Signer or SignRule
* @param {DocumentQueryTypes} [queryType]
* @param {string} [participantQ] Query to filter by participant
* @param {ParticipantQueryTypes} [participantQueryType]
* @param {string} [tags] Label/value pairs are separated by \"|\" (optional) and Tags separated by \",\". Only the first 10 pairs will be considered. To search by tag value only, do not use the \"|\".
* @param {boolean} [isDeleted] Returns deleted documents that had the specified document status when deleted.
* @param {string} [q] Query to filter items.
* @param {number} [limit] Number of items to return.
* @param {number} [offset] The offset of the searched page (starting with 0).
* @param {PaginationOrders} [order]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiDocumentsGet: (isConcluded?: boolean, status?: DocumentFilterStatus, folderId?: string, folderType?: FolderType, documentType?: DocumentTypes, filterByDocumentType?: boolean, filterByPendingSignature?: boolean, queryType?: DocumentQueryTypes, participantQ?: string, participantQueryType?: ParticipantQueryTypes, tags?: string, isDeleted?: boolean, q?: string, limit?: number, offset?: number, order?: PaginationOrders, options?: AxiosRequestConfig) => Promise;
/**
* This API will return an URL that allows an user to sign or approve the document without having to wait to receive an email notification. If the document has multiple pending actions, this API will return the URL of the first pending action for the matched user. After the action has been completed, you may call this API again to retrieve the URL for the next action (if any). Please note that using the URL returned will be recorded in the evidences of the action as an Application Authentication.
* @summary Retrieves an URL to redirect the user to the first pending action of the document.
* @param {string} id Document Id
* @param {DocumentsActionUrlRequest} [documentsActionUrlRequest]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiDocumentsIdActionUrlPost: (id: string, documentsActionUrlRequest?: DocumentsActionUrlRequest, options?: AxiosRequestConfig) => Promise;
/**
* CAUTION: This action cannot be reverted.
* @summary Cancels the document by providing a reason for the cancellation.
* @param {string} id
* @param {DocumentsCancelDocumentRequest} [documentsCancelDocumentRequest]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiDocumentsIdCancellationPost: (id: string, documentsCancelDocumentRequest?: DocumentsCancelDocumentRequest, options?: AxiosRequestConfig) => Promise;
/**
*
* @summary Downloads a specific version type of the document encoding the bytes in Base 64 format.
* @param {string} id Document id
* @param {DocumentDownloadTypes} [type] The version type to download
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiDocumentsIdContentB64Get: (id: string, type?: DocumentDownloadTypes, options?: AxiosRequestConfig) => Promise;
/**
*
* @summary Downloads a specific version type of the document.
* @param {string} id Document id
* @param {DocumentDownloadTypes} [type] The version type to download
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiDocumentsIdContentGet: (id: string, type?: DocumentDownloadTypes, options?: AxiosRequestConfig) => Promise;
/**
*
* @summary Deletes a specific document using it\'s id.
* @param {string} id Document id
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiDocumentsIdDelete: (id: string, options?: AxiosRequestConfig) => Promise;
/**
* The flow of the document will be restarted.
* @summary Adds a new version for an envelope.
* @param {string} id
* @param {DocumentsEnvelopeAddVersionRequest} [documentsEnvelopeAddVersionRequest]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiDocumentsIdEnvelopeVersionsPost: (id: string, documentsEnvelopeAddVersionRequest?: DocumentsEnvelopeAddVersionRequest, options?: AxiosRequestConfig) => Promise;
/**
*
* @summary Updates the document\'s flow.
* @param {string} id Id of the document
* @param {DocumentsDocumentFlowEditRequest} [documentsDocumentFlowEditRequest]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiDocumentsIdFlowPost: (id: string, documentsDocumentFlowEditRequest?: DocumentsDocumentFlowEditRequest, options?: AxiosRequestConfig) => Promise;
/**
*
* @summary Moves a document to a folder.
* @param {string} id
* @param {DocumentsMoveDocumentRequest} [documentsMoveDocumentRequest]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiDocumentsIdFolderPost: (id: string, documentsMoveDocumentRequest?: DocumentsMoveDocumentRequest, options?: AxiosRequestConfig) => Promise;
/**
*
* @summary Retrieves the document\'s details.
* @param {string} id Document id
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiDocumentsIdGet: (id: string, options?: AxiosRequestConfig) => Promise;
/**
* The notified emails are the ones that will be notified after the document is concluded.
* @summary Updates the document\'s notified emails
* @param {string} id Id of the document
* @param {DocumentsDocumentNotifiedEmailsEditRequest} [documentsDocumentNotifiedEmailsEditRequest]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiDocumentsIdNotifiedEmailsPut: (id: string, documentsDocumentNotifiedEmailsEditRequest?: DocumentsDocumentNotifiedEmailsEditRequest, options?: AxiosRequestConfig) => Promise;
/**
* The document\'s flow will pause and can only be resumed by adding a new version of the document (see Add Version API).
* @summary Refuses a document by providing a reason for the refusal.
* @param {string} id
* @param {RefusalRefusalRequest} [refusalRefusalRequest]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiDocumentsIdRefusalPost: (id: string, refusalRefusalRequest?: RefusalRefusalRequest, options?: AxiosRequestConfig) => Promise;
/**
* This will perform the same validations as verifying the document signatures using the verification code.
* @summary Retrieves the details of the document\'s signatures.
* @param {string} id The Id of the document
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiDocumentsIdSignaturesDetailsGet: (id: string, options?: AxiosRequestConfig) => Promise;
/**
* The URL does not require authentication and will be available for 1 hour. - Original: the original file provided when the document was created.
- OriginalWithMarks: the original file with all marks added (for example when an user approves the document and includes its signature image).
- PrinterFriendlyVersion: if the original document is PDF, the version with marks and a appended signature manifest, otherwise a PDF file with the signature manifest.
- Signatures: if the original document is PDF, the signed PDF file, otherwise the .p7s file.
* @summary Generates a URL (ticket) to download a specific version type of the document.
* @param {string} id Document id
* @param {DocumentTicketType} [type] The version type to download
* @param {boolean} [preview] If true, when downloading the document, the response will not include the name of the file (useful when embedding the document inside a web page for previewing)
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiDocumentsIdTicketGet: (id: string, type?: DocumentTicketType, preview?: boolean, options?: AxiosRequestConfig) => Promise;
/**
* The flow of the document will be restarted. If the document was created as an envelope, please use the Add Envelope Version API
* @summary Adds a new version for the document.
* @param {string} id
* @param {DocumentsDocumentAddVersionRequest} [documentsDocumentAddVersionRequest]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiDocumentsIdVersionsPost: (id: string, documentsDocumentAddVersionRequest?: DocumentsDocumentAddVersionRequest, options?: AxiosRequestConfig) => Promise;
/**
*
* @summary Validates each signature in a document using the verification code
* @param {string} key The verification code presented in the document
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiDocumentsKeysKeySignaturesGet: (key: string, options?: AxiosRequestConfig) => Promise;
/**
* Before calling this API you need to upload the file(s) using the Upload API or the Upload Bytes API. When creating a big batch of documents, it is recommended to send multiple requests instead of one big request. For instance, if you want to create 100 documents, send 10 requests of 10 documents. In this case it is recommended to use the disablePendingActionNotifications option and, when all requests are finished, use the users/notify-pending API to notify participants. Returns a list of ids of each document created.
* @summary Creates one or multiple documents.
* @param {DocumentsCreateDocumentRequest} [documentsCreateDocumentRequest]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiDocumentsPost: (documentsCreateDocumentRequest?: DocumentsCreateDocumentRequest, options?: AxiosRequestConfig) => Promise;
/**
* Before calling this API you need to upload the file using the Upload API or the Upload Bytes API.
* @summary Validates each signature in the uploaded document
* @param {SignatureSignaturesInfoRequest} [signatureSignaturesInfoRequest]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiDocumentsValidateSignaturesPost: (signatureSignaturesInfoRequest?: SignatureSignaturesInfoRequest, options?: AxiosRequestConfig) => Promise;
};
/**
* DocumentsApi - functional programming interface
* @export
*/
export declare const DocumentsApiFp: (configuration?: Configuration) => {
/**
*
* @summary Moves a batch of documents to a folder.
* @param {DocumentsMoveDocumentBatchRequest} [documentsMoveDocumentBatchRequest]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiDocumentsBatchFolderPost(documentsMoveDocumentBatchRequest?: DocumentsMoveDocumentBatchRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>;
/**
* You may filter the documents by folder and document type.
* @summary Retrieves the documents of the organization paginating the response.
* @param {boolean} [isConcluded] (DEPRECATED) Please use \"Status\" parameter instead. Set to true to list concluded documents, false to list pending documents.
* @param {DocumentFilterStatus} [status] Filters by document status. Will override the \"IsConcluded\" property.
* @param {string} [folderId]
* @param {FolderType} [folderType]
* @param {DocumentTypes} [documentType]
* @param {boolean} [filterByDocumentType] True if the documents should be filtered by type, use documentType to specify the document type. If you want to filter only documents without a type, set this parameter to true and the documentType to null.
* @param {boolean} [filterByPendingSignature] True if documents should be filtered only for those that have FlowAction of the type Signer or SignRule
* @param {DocumentQueryTypes} [queryType]
* @param {string} [participantQ] Query to filter by participant
* @param {ParticipantQueryTypes} [participantQueryType]
* @param {string} [tags] Label/value pairs are separated by \"|\" (optional) and Tags separated by \",\". Only the first 10 pairs will be considered. To search by tag value only, do not use the \"|\".
* @param {boolean} [isDeleted] Returns deleted documents that had the specified document status when deleted.
* @param {string} [q] Query to filter items.
* @param {number} [limit] Number of items to return.
* @param {number} [offset] The offset of the searched page (starting with 0).
* @param {PaginationOrders} [order]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiDocumentsGet(isConcluded?: boolean, status?: DocumentFilterStatus, folderId?: string, folderType?: FolderType, documentType?: DocumentTypes, filterByDocumentType?: boolean, filterByPendingSignature?: boolean, queryType?: DocumentQueryTypes, participantQ?: string, participantQueryType?: ParticipantQueryTypes, tags?: string, isDeleted?: boolean, q?: string, limit?: number, offset?: number, order?: PaginationOrders, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* This API will return an URL that allows an user to sign or approve the document without having to wait to receive an email notification. If the document has multiple pending actions, this API will return the URL of the first pending action for the matched user. After the action has been completed, you may call this API again to retrieve the URL for the next action (if any). Please note that using the URL returned will be recorded in the evidences of the action as an Application Authentication.
* @summary Retrieves an URL to redirect the user to the first pending action of the document.
* @param {string} id Document Id
* @param {DocumentsActionUrlRequest} [documentsActionUrlRequest]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiDocumentsIdActionUrlPost(id: string, documentsActionUrlRequest?: DocumentsActionUrlRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* CAUTION: This action cannot be reverted.
* @summary Cancels the document by providing a reason for the cancellation.
* @param {string} id
* @param {DocumentsCancelDocumentRequest} [documentsCancelDocumentRequest]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiDocumentsIdCancellationPost(id: string, documentsCancelDocumentRequest?: DocumentsCancelDocumentRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
*
* @summary Downloads a specific version type of the document encoding the bytes in Base 64 format.
* @param {string} id Document id
* @param {DocumentDownloadTypes} [type] The version type to download
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiDocumentsIdContentB64Get(id: string, type?: DocumentDownloadTypes, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
*
* @summary Downloads a specific version type of the document.
* @param {string} id Document id
* @param {DocumentDownloadTypes} [type] The version type to download
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiDocumentsIdContentGet(id: string, type?: DocumentDownloadTypes, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
*
* @summary Deletes a specific document using it\'s id.
* @param {string} id Document id
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiDocumentsIdDelete(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* The flow of the document will be restarted.
* @summary Adds a new version for an envelope.
* @param {string} id
* @param {DocumentsEnvelopeAddVersionRequest} [documentsEnvelopeAddVersionRequest]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiDocumentsIdEnvelopeVersionsPost(id: string, documentsEnvelopeAddVersionRequest?: DocumentsEnvelopeAddVersionRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
*
* @summary Updates the document\'s flow.
* @param {string} id Id of the document
* @param {DocumentsDocumentFlowEditRequest} [documentsDocumentFlowEditRequest]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiDocumentsIdFlowPost(id: string, documentsDocumentFlowEditRequest?: DocumentsDocumentFlowEditRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
*
* @summary Moves a document to a folder.
* @param {string} id
* @param {DocumentsMoveDocumentRequest} [documentsMoveDocumentRequest]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiDocumentsIdFolderPost(id: string, documentsMoveDocumentRequest?: DocumentsMoveDocumentRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
*
* @summary Retrieves the document\'s details.
* @param {string} id Document id
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiDocumentsIdGet(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* The notified emails are the ones that will be notified after the document is concluded.
* @summary Updates the document\'s notified emails
* @param {string} id Id of the document
* @param {DocumentsDocumentNotifiedEmailsEditRequest} [documentsDocumentNotifiedEmailsEditRequest]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiDocumentsIdNotifiedEmailsPut(id: string, documentsDocumentNotifiedEmailsEditRequest?: DocumentsDocumentNotifiedEmailsEditRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* The document\'s flow will pause and can only be resumed by adding a new version of the document (see Add Version API).
* @summary Refuses a document by providing a reason for the refusal.
* @param {string} id
* @param {RefusalRefusalRequest} [refusalRefusalRequest]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiDocumentsIdRefusalPost(id: string, refusalRefusalRequest?: RefusalRefusalRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* This will perform the same validations as verifying the document signatures using the verification code.
* @summary Retrieves the details of the document\'s signatures.
* @param {string} id The Id of the document
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiDocumentsIdSignaturesDetailsGet(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* The URL does not require authentication and will be available for 1 hour. - Original: the original file provided when the document was created.
- OriginalWithMarks: the original file with all marks added (for example when an user approves the document and includes its signature image).
- PrinterFriendlyVersion: if the original document is PDF, the version with marks and a appended signature manifest, otherwise a PDF file with the signature manifest.
- Signatures: if the original document is PDF, the signed PDF file, otherwise the .p7s file.
* @summary Generates a URL (ticket) to download a specific version type of the document.
* @param {string} id Document id
* @param {DocumentTicketType} [type] The version type to download
* @param {boolean} [preview] If true, when downloading the document, the response will not include the name of the file (useful when embedding the document inside a web page for previewing)
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiDocumentsIdTicketGet(id: string, type?: DocumentTicketType, preview?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* The flow of the document will be restarted. If the document was created as an envelope, please use the Add Envelope Version API
* @summary Adds a new version for the document.
* @param {string} id
* @param {DocumentsDocumentAddVersionRequest} [documentsDocumentAddVersionRequest]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiDocumentsIdVersionsPost(id: string, documentsDocumentAddVersionRequest?: DocumentsDocumentAddVersionRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
*
* @summary Validates each signature in a document using the verification code
* @param {string} key The verification code presented in the document
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiDocumentsKeysKeySignaturesGet(key: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* Before calling this API you need to upload the file(s) using the Upload API or the Upload Bytes API. When creating a big batch of documents, it is recommended to send multiple requests instead of one big request. For instance, if you want to create 100 documents, send 10 requests of 10 documents. In this case it is recommended to use the disablePendingActionNotifications option and, when all requests are finished, use the users/notify-pending API to notify participants. Returns a list of ids of each document created.
* @summary Creates one or multiple documents.
* @param {DocumentsCreateDocumentRequest} [documentsCreateDocumentRequest]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiDocumentsPost(documentsCreateDocumentRequest?: DocumentsCreateDocumentRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>;
/**
* Before calling this API you need to upload the file using the Upload API or the Upload Bytes API.
* @summary Validates each signature in the uploaded document
* @param {SignatureSignaturesInfoRequest} [signatureSignaturesInfoRequest]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiDocumentsValidateSignaturesPost(signatureSignaturesInfoRequest?: SignatureSignaturesInfoRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>;
};
/**
* DocumentsApi - factory interface
* @export
*/
export declare const DocumentsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
*
* @summary Moves a batch of documents to a folder.
* @param {DocumentsMoveDocumentBatchRequest} [documentsMoveDocumentBatchRequest]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiDocumentsBatchFolderPost(documentsMoveDocumentBatchRequest?: DocumentsMoveDocumentBatchRequest, options?: any): AxiosPromise>;
/**
* You may filter the documents by folder and document type.
* @summary Retrieves the documents of the organization paginating the response.
* @param {boolean} [isConcluded] (DEPRECATED) Please use \"Status\" parameter instead. Set to true to list concluded documents, false to list pending documents.
* @param {DocumentFilterStatus} [status] Filters by document status. Will override the \"IsConcluded\" property.
* @param {string} [folderId]
* @param {FolderType} [folderType]
* @param {DocumentTypes} [documentType]
* @param {boolean} [filterByDocumentType] True if the documents should be filtered by type, use documentType to specify the document type. If you want to filter only documents without a type, set this parameter to true and the documentType to null.
* @param {boolean} [filterByPendingSignature] True if documents should be filtered only for those that have FlowAction of the type Signer or SignRule
* @param {DocumentQueryTypes} [queryType]
* @param {string} [participantQ] Query to filter by participant
* @param {ParticipantQueryTypes} [participantQueryType]
* @param {string} [tags] Label/value pairs are separated by \"|\" (optional) and Tags separated by \",\". Only the first 10 pairs will be considered. To search by tag value only, do not use the \"|\".
* @param {boolean} [isDeleted] Returns deleted documents that had the specified document status when deleted.
* @param {string} [q] Query to filter items.
* @param {number} [limit] Number of items to return.
* @param {number} [offset] The offset of the searched page (starting with 0).
* @param {PaginationOrders} [order]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiDocumentsGet(isConcluded?: boolean, status?: DocumentFilterStatus, folderId?: string, folderType?: FolderType, documentType?: DocumentTypes, filterByDocumentType?: boolean, filterByPendingSignature?: boolean, queryType?: DocumentQueryTypes, participantQ?: string, participantQueryType?: ParticipantQueryTypes, tags?: string, isDeleted?: boolean, q?: string, limit?: number, offset?: number, order?: PaginationOrders, options?: any): AxiosPromise;
/**
* This API will return an URL that allows an user to sign or approve the document without having to wait to receive an email notification. If the document has multiple pending actions, this API will return the URL of the first pending action for the matched user. After the action has been completed, you may call this API again to retrieve the URL for the next action (if any). Please note that using the URL returned will be recorded in the evidences of the action as an Application Authentication.
* @summary Retrieves an URL to redirect the user to the first pending action of the document.
* @param {string} id Document Id
* @param {DocumentsActionUrlRequest} [documentsActionUrlRequest]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiDocumentsIdActionUrlPost(id: string, documentsActionUrlRequest?: DocumentsActionUrlRequest, options?: any): AxiosPromise;
/**
* CAUTION: This action cannot be reverted.
* @summary Cancels the document by providing a reason for the cancellation.
* @param {string} id
* @param {DocumentsCancelDocumentRequest} [documentsCancelDocumentRequest]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiDocumentsIdCancellationPost(id: string, documentsCancelDocumentRequest?: DocumentsCancelDocumentRequest, options?: any): AxiosPromise;
/**
*
* @summary Downloads a specific version type of the document encoding the bytes in Base 64 format.
* @param {string} id Document id
* @param {DocumentDownloadTypes} [type] The version type to download
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiDocumentsIdContentB64Get(id: string, type?: DocumentDownloadTypes, options?: any): AxiosPromise;
/**
*
* @summary Downloads a specific version type of the document.
* @param {string} id Document id
* @param {DocumentDownloadTypes} [type] The version type to download
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiDocumentsIdContentGet(id: string, type?: DocumentDownloadTypes, options?: any): AxiosPromise;
/**
*
* @summary Deletes a specific document using it\'s id.
* @param {string} id Document id
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiDocumentsIdDelete(id: string, options?: any): AxiosPromise;
/**
* The flow of the document will be restarted.
* @summary Adds a new version for an envelope.
* @param {string} id
* @param {DocumentsEnvelopeAddVersionRequest} [documentsEnvelopeAddVersionRequest]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiDocumentsIdEnvelopeVersionsPost(id: string, documentsEnvelopeAddVersionRequest?: DocumentsEnvelopeAddVersionRequest, options?: any): AxiosPromise;
/**
*
* @summary Updates the document\'s flow.
* @param {string} id Id of the document
* @param {DocumentsDocumentFlowEditRequest} [documentsDocumentFlowEditRequest]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiDocumentsIdFlowPost(id: string, documentsDocumentFlowEditRequest?: DocumentsDocumentFlowEditRequest, options?: any): AxiosPromise;
/**
*
* @summary Moves a document to a folder.
* @param {string} id
* @param {DocumentsMoveDocumentRequest} [documentsMoveDocumentRequest]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiDocumentsIdFolderPost(id: string, documentsMoveDocumentRequest?: DocumentsMoveDocumentRequest, options?: any): AxiosPromise;
/**
*
* @summary Retrieves the document\'s details.
* @param {string} id Document id
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiDocumentsIdGet(id: string, options?: any): AxiosPromise;
/**
* The notified emails are the ones that will be notified after the document is concluded.
* @summary Updates the document\'s notified emails
* @param {string} id Id of the document
* @param {DocumentsDocumentNotifiedEmailsEditRequest} [documentsDocumentNotifiedEmailsEditRequest]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiDocumentsIdNotifiedEmailsPut(id: string, documentsDocumentNotifiedEmailsEditRequest?: DocumentsDocumentNotifiedEmailsEditRequest, options?: any): AxiosPromise;
/**
* The document\'s flow will pause and can only be resumed by adding a new version of the document (see Add Version API).
* @summary Refuses a document by providing a reason for the refusal.
* @param {string} id
* @param {RefusalRefusalRequest} [refusalRefusalRequest]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiDocumentsIdRefusalPost(id: string, refusalRefusalRequest?: RefusalRefusalRequest, options?: any): AxiosPromise;
/**
* This will perform the same validations as verifying the document signatures using the verification code.
* @summary Retrieves the details of the document\'s signatures.
* @param {string} id The Id of the document
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiDocumentsIdSignaturesDetailsGet(id: string, options?: any): AxiosPromise;
/**
* The URL does not require authentication and will be available for 1 hour. - Original: the original file provided when the document was created.
- OriginalWithMarks: the original file with all marks added (for example when an user approves the document and includes its signature image).
- PrinterFriendlyVersion: if the original document is PDF, the version with marks and a appended signature manifest, otherwise a PDF file with the signature manifest.
- Signatures: if the original document is PDF, the signed PDF file, otherwise the .p7s file.
* @summary Generates a URL (ticket) to download a specific version type of the document.
* @param {string} id Document id
* @param {DocumentTicketType} [type] The version type to download
* @param {boolean} [preview] If true, when downloading the document, the response will not include the name of the file (useful when embedding the document inside a web page for previewing)
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiDocumentsIdTicketGet(id: string, type?: DocumentTicketType, preview?: boolean, options?: any): AxiosPromise;
/**
* The flow of the document will be restarted. If the document was created as an envelope, please use the Add Envelope Version API
* @summary Adds a new version for the document.
* @param {string} id
* @param {DocumentsDocumentAddVersionRequest} [documentsDocumentAddVersionRequest]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiDocumentsIdVersionsPost(id: string, documentsDocumentAddVersionRequest?: DocumentsDocumentAddVersionRequest, options?: any): AxiosPromise;
/**
*
* @summary Validates each signature in a document using the verification code
* @param {string} key The verification code presented in the document
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiDocumentsKeysKeySignaturesGet(key: string, options?: any): AxiosPromise;
/**
* Before calling this API you need to upload the file(s) using the Upload API or the Upload Bytes API. When creating a big batch of documents, it is recommended to send multiple requests instead of one big request. For instance, if you want to create 100 documents, send 10 requests of 10 documents. In this case it is recommended to use the disablePendingActionNotifications option and, when all requests are finished, use the users/notify-pending API to notify participants. Returns a list of ids of each document created.
* @summary Creates one or multiple documents.
* @param {DocumentsCreateDocumentRequest} [documentsCreateDocumentRequest]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiDocumentsPost(documentsCreateDocumentRequest?: DocumentsCreateDocumentRequest, options?: any): AxiosPromise>;
/**
* Before calling this API you need to upload the file using the Upload API or the Upload Bytes API.
* @summary Validates each signature in the uploaded document
* @param {SignatureSignaturesInfoRequest} [signatureSignaturesInfoRequest]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiDocumentsValidateSignaturesPost(signatureSignaturesInfoRequest?: SignatureSignaturesInfoRequest, options?: any): AxiosPromise>;
};
/**
* DocumentsApi - object-oriented interface
* @export
* @class DocumentsApi
* @extends {BaseAPI}
*/
export declare class DocumentsApi extends BaseAPI {
/**
*
* @summary Moves a batch of documents to a folder.
* @param {DocumentsMoveDocumentBatchRequest} [documentsMoveDocumentBatchRequest]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof DocumentsApi
*/
apiDocumentsBatchFolderPost(documentsMoveDocumentBatchRequest?: DocumentsMoveDocumentBatchRequest, options?: AxiosRequestConfig): Promise>;
/**
* You may filter the documents by folder and document type.
* @summary Retrieves the documents of the organization paginating the response.
* @param {boolean} [isConcluded] (DEPRECATED) Please use \"Status\" parameter instead. Set to true to list concluded documents, false to list pending documents.
* @param {DocumentFilterStatus} [status] Filters by document status. Will override the \"IsConcluded\" property.
* @param {string} [folderId]
* @param {FolderType} [folderType]
* @param {DocumentTypes} [documentType]
* @param {boolean} [filterByDocumentType] True if the documents should be filtered by type, use documentType to specify the document type. If you want to filter only documents without a type, set this parameter to true and the documentType to null.
* @param {boolean} [filterByPendingSignature] True if documents should be filtered only for those that have FlowAction of the type Signer or SignRule
* @param {DocumentQueryTypes} [queryType]
* @param {string} [participantQ] Query to filter by participant
* @param {ParticipantQueryTypes} [participantQueryType]
* @param {string} [tags] Label/value pairs are separated by \"|\" (optional) and Tags separated by \",\". Only the first 10 pairs will be considered. To search by tag value only, do not use the \"|\".
* @param {boolean} [isDeleted] Returns deleted documents that had the specified document status when deleted.
* @param {string} [q] Query to filter items.
* @param {number} [limit] Number of items to return.
* @param {number} [offset] The offset of the searched page (starting with 0).
* @param {PaginationOrders} [order]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof DocumentsApi
*/
apiDocumentsGet(isConcluded?: boolean, status?: DocumentFilterStatus, folderId?: string, folderType?: FolderType, documentType?: DocumentTypes, filterByDocumentType?: boolean, filterByPendingSignature?: boolean, queryType?: DocumentQueryTypes, participantQ?: string, participantQueryType?: ParticipantQueryTypes, tags?: string, isDeleted?: boolean, q?: string, limit?: number, offset?: number, order?: PaginationOrders, options?: AxiosRequestConfig): Promise>;
/**
* This API will return an URL that allows an user to sign or approve the document without having to wait to receive an email notification. If the document has multiple pending actions, this API will return the URL of the first pending action for the matched user. After the action has been completed, you may call this API again to retrieve the URL for the next action (if any). Please note that using the URL returned will be recorded in the evidences of the action as an Application Authentication.
* @summary Retrieves an URL to redirect the user to the first pending action of the document.
* @param {string} id Document Id
* @param {DocumentsActionUrlRequest} [documentsActionUrlRequest]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof DocumentsApi
*/
apiDocumentsIdActionUrlPost(id: string, documentsActionUrlRequest?: DocumentsActionUrlRequest, options?: AxiosRequestConfig): Promise>;
/**
* CAUTION: This action cannot be reverted.
* @summary Cancels the document by providing a reason for the cancellation.
* @param {string} id
* @param {DocumentsCancelDocumentRequest} [documentsCancelDocumentRequest]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof DocumentsApi
*/
apiDocumentsIdCancellationPost(id: string, documentsCancelDocumentRequest?: DocumentsCancelDocumentRequest, options?: AxiosRequestConfig): Promise>;
/**
*
* @summary Downloads a specific version type of the document encoding the bytes in Base 64 format.
* @param {string} id Document id
* @param {DocumentDownloadTypes} [type] The version type to download
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof DocumentsApi
*/
apiDocumentsIdContentB64Get(id: string, type?: DocumentDownloadTypes, options?: AxiosRequestConfig): Promise>;
/**
*
* @summary Downloads a specific version type of the document.
* @param {string} id Document id
* @param {DocumentDownloadTypes} [type] The version type to download
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof DocumentsApi
*/
apiDocumentsIdContentGet(id: string, type?: DocumentDownloadTypes, options?: AxiosRequestConfig): Promise>;
/**
*
* @summary Deletes a specific document using it\'s id.
* @param {string} id Document id
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof DocumentsApi
*/
apiDocumentsIdDelete(id: string, options?: AxiosRequestConfig): Promise>;
/**
* The flow of the document will be restarted.
* @summary Adds a new version for an envelope.
* @param {string} id
* @param {DocumentsEnvelopeAddVersionRequest} [documentsEnvelopeAddVersionRequest]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof DocumentsApi
*/
apiDocumentsIdEnvelopeVersionsPost(id: string, documentsEnvelopeAddVersionRequest?: DocumentsEnvelopeAddVersionRequest, options?: AxiosRequestConfig): Promise>;
/**
*
* @summary Updates the document\'s flow.
* @param {string} id Id of the document
* @param {DocumentsDocumentFlowEditRequest} [documentsDocumentFlowEditRequest]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof DocumentsApi
*/
apiDocumentsIdFlowPost(id: string, documentsDocumentFlowEditRequest?: DocumentsDocumentFlowEditRequest, options?: AxiosRequestConfig): Promise>;
/**
*
* @summary Moves a document to a folder.
* @param {string} id
* @param {DocumentsMoveDocumentRequest} [documentsMoveDocumentRequest]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof DocumentsApi
*/
apiDocumentsIdFolderPost(id: string, documentsMoveDocumentRequest?: DocumentsMoveDocumentRequest, options?: AxiosRequestConfig): Promise>;
/**
*
* @summary Retrieves the document\'s details.
* @param {string} id Document id
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof DocumentsApi
*/
apiDocumentsIdGet(id: string, options?: AxiosRequestConfig): Promise>;
/**
* The notified emails are the ones that will be notified after the document is concluded.
* @summary Updates the document\'s notified emails
* @param {string} id Id of the document
* @param {DocumentsDocumentNotifiedEmailsEditRequest} [documentsDocumentNotifiedEmailsEditRequest]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof DocumentsApi
*/
apiDocumentsIdNotifiedEmailsPut(id: string, documentsDocumentNotifiedEmailsEditRequest?: DocumentsDocumentNotifiedEmailsEditRequest, options?: AxiosRequestConfig): Promise>;
/**
* The document\'s flow will pause and can only be resumed by adding a new version of the document (see Add Version API).
* @summary Refuses a document by providing a reason for the refusal.
* @param {string} id
* @param {RefusalRefusalRequest} [refusalRefusalRequest]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof DocumentsApi
*/
apiDocumentsIdRefusalPost(id: string, refusalRefusalRequest?: RefusalRefusalRequest, options?: AxiosRequestConfig): Promise>;
/**
* This will perform the same validations as verifying the document signatures using the verification code.
* @summary Retrieves the details of the document\'s signatures.
* @param {string} id The Id of the document
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof DocumentsApi
*/
apiDocumentsIdSignaturesDetailsGet(id: string, options?: AxiosRequestConfig): Promise>;
/**
* The URL does not require authentication and will be available for 1 hour. - Original: the original file provided when the document was created.
- OriginalWithMarks: the original file with all marks added (for example when an user approves the document and includes its signature image).
- PrinterFriendlyVersion: if the original document is PDF, the version with marks and a appended signature manifest, otherwise a PDF file with the signature manifest.
- Signatures: if the original document is PDF, the signed PDF file, otherwise the .p7s file.
* @summary Generates a URL (ticket) to download a specific version type of the document.
* @param {string} id Document id
* @param {DocumentTicketType} [type] The version type to download
* @param {boolean} [preview] If true, when downloading the document, the response will not include the name of the file (useful when embedding the document inside a web page for previewing)
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof DocumentsApi
*/
apiDocumentsIdTicketGet(id: string, type?: DocumentTicketType, preview?: boolean, options?: AxiosRequestConfig): Promise>;
/**
* The flow of the document will be restarted. If the document was created as an envelope, please use the Add Envelope Version API
* @summary Adds a new version for the document.
* @param {string} id
* @param {DocumentsDocumentAddVersionRequest} [documentsDocumentAddVersionRequest]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof DocumentsApi
*/
apiDocumentsIdVersionsPost(id: string, documentsDocumentAddVersionRequest?: DocumentsDocumentAddVersionRequest, options?: AxiosRequestConfig): Promise>;
/**
*
* @summary Validates each signature in a document using the verification code
* @param {string} key The verification code presented in the document
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof DocumentsApi
*/
apiDocumentsKeysKeySignaturesGet(key: string, options?: AxiosRequestConfig): Promise>;
/**
* Before calling this API you need to upload the file(s) using the Upload API or the Upload Bytes API. When creating a big batch of documents, it is recommended to send multiple requests instead of one big request. For instance, if you want to create 100 documents, send 10 requests of 10 documents. In this case it is recommended to use the disablePendingActionNotifications option and, when all requests are finished, use the users/notify-pending API to notify participants. Returns a list of ids of each document created.
* @summary Creates one or multiple documents.
* @param {DocumentsCreateDocumentRequest} [documentsCreateDocumentRequest]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof DocumentsApi
*/
apiDocumentsPost(documentsCreateDocumentRequest?: DocumentsCreateDocumentRequest, options?: AxiosRequestConfig): Promise>;
/**
* Before calling this API you need to upload the file using the Upload API or the Upload Bytes API.
* @summary Validates each signature in the uploaded document
* @param {SignatureSignaturesInfoRequest} [signatureSignaturesInfoRequest]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof DocumentsApi
*/
apiDocumentsValidateSignaturesPost(signatureSignaturesInfoRequest?: SignatureSignaturesInfoRequest, options?: AxiosRequestConfig): Promise>;
}
/**
* FlowsApi - axios parameter creator
* @export
*/
export declare const FlowsApiAxiosParamCreator: (configuration?: Configuration) => {
/**
*
* @summary List created flows.
* @param {string} [q] Query to filter items.
* @param {number} [limit] Number of items to return.
* @param {number} [offset] The offset of the searched page (starting with 0).
* @param {PaginationOrders} [order]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiDocumentFlowsGet: (q?: string, limit?: number, offset?: number, order?: PaginationOrders, options?: AxiosRequestConfig) => Promise;
/**
*
* @summary Deletes a flow.
* @param {string} id
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiDocumentFlowsIdDelete: (id: string, options?: AxiosRequestConfig) => Promise;
/**
*
* @summary Retrieves flow details
* @param {string} id
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiDocumentFlowsIdGet: (id: string, options?: AxiosRequestConfig) => Promise;
/**
*
* @summary Updates a flow.
* @param {string} id
* @param {DocumentFlowsDocumentFlowData} [documentFlowsDocumentFlowData]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiDocumentFlowsIdPut: (id: string, documentFlowsDocumentFlowData?: DocumentFlowsDocumentFlowData, options?: AxiosRequestConfig) => Promise;
/**
*
* @summary Creates a flow that can be used to create documents
* @param {DocumentFlowsDocumentFlowCreateRequest} [documentFlowsDocumentFlowCreateRequest]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiDocumentFlowsPost: (documentFlowsDocumentFlowCreateRequest?: DocumentFlowsDocumentFlowCreateRequest, options?: AxiosRequestConfig) => Promise;
};
/**
* FlowsApi - functional programming interface
* @export
*/
export declare const FlowsApiFp: (configuration?: Configuration) => {
/**
*
* @summary List created flows.
* @param {string} [q] Query to filter items.
* @param {number} [limit] Number of items to return.
* @param {number} [offset] The offset of the searched page (starting with 0).
* @param {PaginationOrders} [order]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiDocumentFlowsGet(q?: string, limit?: number, offset?: number, order?: PaginationOrders, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
*
* @summary Deletes a flow.
* @param {string} id
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiDocumentFlowsIdDelete(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
*
* @summary Retrieves flow details
* @param {string} id
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiDocumentFlowsIdGet(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
*
* @summary Updates a flow.
* @param {string} id
* @param {DocumentFlowsDocumentFlowData} [documentFlowsDocumentFlowData]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiDocumentFlowsIdPut(id: string, documentFlowsDocumentFlowData?: DocumentFlowsDocumentFlowData, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
*
* @summary Creates a flow that can be used to create documents
* @param {DocumentFlowsDocumentFlowCreateRequest} [documentFlowsDocumentFlowCreateRequest]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiDocumentFlowsPost(documentFlowsDocumentFlowCreateRequest?: DocumentFlowsDocumentFlowCreateRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
};
/**
* FlowsApi - factory interface
* @export
*/
export declare const FlowsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
*
* @summary List created flows.
* @param {string} [q] Query to filter items.
* @param {number} [limit] Number of items to return.
* @param {number} [offset] The offset of the searched page (starting with 0).
* @param {PaginationOrders} [order]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiDocumentFlowsGet(q?: string, limit?: number, offset?: number, order?: PaginationOrders, options?: any): AxiosPromise;
/**
*
* @summary Deletes a flow.
* @param {string} id
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiDocumentFlowsIdDelete(id: string, options?: any): AxiosPromise;
/**
*
* @summary Retrieves flow details
* @param {string} id
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiDocumentFlowsIdGet(id: string, options?: any): AxiosPromise;
/**
*
* @summary Updates a flow.
* @param {string} id
* @param {DocumentFlowsDocumentFlowData} [documentFlowsDocumentFlowData]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiDocumentFlowsIdPut(id: string, documentFlowsDocumentFlowData?: DocumentFlowsDocumentFlowData, options?: any): AxiosPromise;
/**
*
* @summary Creates a flow that can be used to create documents
* @param {DocumentFlowsDocumentFlowCreateRequest} [documentFlowsDocumentFlowCreateRequest]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiDocumentFlowsPost(documentFlowsDocumentFlowCreateRequest?: DocumentFlowsDocumentFlowCreateRequest, options?: any): AxiosPromise;
};
/**
* FlowsApi - object-oriented interface
* @export
* @class FlowsApi
* @extends {BaseAPI}
*/
export declare class FlowsApi extends BaseAPI {
/**
*
* @summary List created flows.
* @param {string} [q] Query to filter items.
* @param {number} [limit] Number of items to return.
* @param {number} [offset] The offset of the searched page (starting with 0).
* @param {PaginationOrders} [order]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof FlowsApi
*/
apiDocumentFlowsGet(q?: string, limit?: number, offset?: number, order?: PaginationOrders, options?: AxiosRequestConfig): Promise>;
/**
*
* @summary Deletes a flow.
* @param {string} id
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof FlowsApi
*/
apiDocumentFlowsIdDelete(id: string, options?: AxiosRequestConfig): Promise>;
/**
*
* @summary Retrieves flow details
* @param {string} id
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof FlowsApi
*/
apiDocumentFlowsIdGet(id: string, options?: AxiosRequestConfig): Promise>;
/**
*
* @summary Updates a flow.
* @param {string} id
* @param {DocumentFlowsDocumentFlowData} [documentFlowsDocumentFlowData]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof FlowsApi
*/
apiDocumentFlowsIdPut(id: string, documentFlowsDocumentFlowData?: DocumentFlowsDocumentFlowData, options?: AxiosRequestConfig): Promise>;
/**
*
* @summary Creates a flow that can be used to create documents
* @param {DocumentFlowsDocumentFlowCreateRequest} [documentFlowsDocumentFlowCreateRequest]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof FlowsApi
*/
apiDocumentFlowsPost(documentFlowsDocumentFlowCreateRequest?: DocumentFlowsDocumentFlowCreateRequest, options?: AxiosRequestConfig): Promise>;
}
/**
* FoldersApi - axios parameter creator
* @export
*/
export declare const FoldersApiAxiosParamCreator: (configuration?: Configuration) => {
/**
* The Q parameter allows you to filter by folder name.
* @summary Retrieves all folders paginating the response
* @param {string} [q] Query to filter items.
* @param {number} [limit] Number of items to return.
* @param {number} [offset] The offset of the searched page (starting with 0).
* @param {PaginationOrders} [order]
* @param {boolean} [filterByParent] if true filters by the parentId parameter
* @param {string} [parentId] Id of the parent folder
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiFoldersGet: (q?: string, limit?: number, offset?: number, order?: PaginationOrders, filterByParent?: boolean, parentId?: string, options?: AxiosRequestConfig) => Promise;
/**
*
* @summary Deletes a folder.
* @param {string} id Id of the folder to be deleted
* @param {FoldersFolderDeleteRequest} [foldersFolderDeleteRequest]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiFoldersIdDeletePost: (id: string, foldersFolderDeleteRequest?: FoldersFolderDeleteRequest, options?: AxiosRequestConfig) => Promise;
/**
*
* @summary Retrieves the folder\'s info.
* @param {string} id Folder id
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiFoldersIdGet: (id: string, options?: AxiosRequestConfig) => Promise;
/**
*
* @summary Creates a folder.
* @param {FoldersFolderCreateRequest} [foldersFolderCreateRequest]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiFoldersPost: (foldersFolderCreateRequest?: FoldersFolderCreateRequest, options?: AxiosRequestConfig) => Promise;
};
/**
* FoldersApi - functional programming interface
* @export
*/
export declare const FoldersApiFp: (configuration?: Configuration) => {
/**
* The Q parameter allows you to filter by folder name.
* @summary Retrieves all folders paginating the response
* @param {string} [q] Query to filter items.
* @param {number} [limit] Number of items to return.
* @param {number} [offset] The offset of the searched page (starting with 0).
* @param {PaginationOrders} [order]
* @param {boolean} [filterByParent] if true filters by the parentId parameter
* @param {string} [parentId] Id of the parent folder
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiFoldersGet(q?: string, limit?: number, offset?: number, order?: PaginationOrders, filterByParent?: boolean, parentId?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
*
* @summary Deletes a folder.
* @param {string} id Id of the folder to be deleted
* @param {FoldersFolderDeleteRequest} [foldersFolderDeleteRequest]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiFoldersIdDeletePost(id: string, foldersFolderDeleteRequest?: FoldersFolderDeleteRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
*
* @summary Retrieves the folder\'s info.
* @param {string} id Folder id
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiFoldersIdGet(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
*
* @summary Creates a folder.
* @param {FoldersFolderCreateRequest} [foldersFolderCreateRequest]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiFoldersPost(foldersFolderCreateRequest?: FoldersFolderCreateRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
};
/**
* FoldersApi - factory interface
* @export
*/
export declare const FoldersApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
* The Q parameter allows you to filter by folder name.
* @summary Retrieves all folders paginating the response
* @param {string} [q] Query to filter items.
* @param {number} [limit] Number of items to return.
* @param {number} [offset] The offset of the searched page (starting with 0).
* @param {PaginationOrders} [order]
* @param {boolean} [filterByParent] if true filters by the parentId parameter
* @param {string} [parentId] Id of the parent folder
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiFoldersGet(q?: string, limit?: number, offset?: number, order?: PaginationOrders, filterByParent?: boolean, parentId?: string, options?: any): AxiosPromise;
/**
*
* @summary Deletes a folder.
* @param {string} id Id of the folder to be deleted
* @param {FoldersFolderDeleteRequest} [foldersFolderDeleteRequest]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiFoldersIdDeletePost(id: string, foldersFolderDeleteRequest?: FoldersFolderDeleteRequest, options?: any): AxiosPromise;
/**
*
* @summary Retrieves the folder\'s info.
* @param {string} id Folder id
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiFoldersIdGet(id: string, options?: any): AxiosPromise;
/**
*
* @summary Creates a folder.
* @param {FoldersFolderCreateRequest} [foldersFolderCreateRequest]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiFoldersPost(foldersFolderCreateRequest?: FoldersFolderCreateRequest, options?: any): AxiosPromise;
};
/**
* FoldersApi - object-oriented interface
* @export
* @class FoldersApi
* @extends {BaseAPI}
*/
export declare class FoldersApi extends BaseAPI {
/**
* The Q parameter allows you to filter by folder name.
* @summary Retrieves all folders paginating the response
* @param {string} [q] Query to filter items.
* @param {number} [limit] Number of items to return.
* @param {number} [offset] The offset of the searched page (starting with 0).
* @param {PaginationOrders} [order]
* @param {boolean} [filterByParent] if true filters by the parentId parameter
* @param {string} [parentId] Id of the parent folder
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof FoldersApi
*/
apiFoldersGet(q?: string, limit?: number, offset?: number, order?: PaginationOrders, filterByParent?: boolean, parentId?: string, options?: AxiosRequestConfig): Promise>;
/**
*
* @summary Deletes a folder.
* @param {string} id Id of the folder to be deleted
* @param {FoldersFolderDeleteRequest} [foldersFolderDeleteRequest]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof FoldersApi
*/
apiFoldersIdDeletePost(id: string, foldersFolderDeleteRequest?: FoldersFolderDeleteRequest, options?: AxiosRequestConfig): Promise>;
/**
*
* @summary Retrieves the folder\'s info.
* @param {string} id Folder id
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof FoldersApi
*/
apiFoldersIdGet(id: string, options?: AxiosRequestConfig): Promise>;
/**
*
* @summary Creates a folder.
* @param {FoldersFolderCreateRequest} [foldersFolderCreateRequest]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof FoldersApi
*/
apiFoldersPost(foldersFolderCreateRequest?: FoldersFolderCreateRequest, options?: AxiosRequestConfig): Promise>;
}
/**
* MarksSessionsApi - axios parameter creator
* @export
*/
export declare const MarksSessionsApiAxiosParamCreator: (configuration?: Configuration) => {
/**
* The purpose of the positioning session is to allow users to visually position signer marks. The result of the session is the same request provided while creating it but with the flowAction\'s prePositioned marks attribute filled according to the positions selected for each action. Result will be available by iFrame event when embedding the positioning session or by retrieving the session information via the GET API.
* @summary Creates a mark positioning session from a Document create request.
* @param {DocumentsCreateDocumentRequest} [documentsCreateDocumentRequest]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiMarksSessionsDocumentsPost: (documentsCreateDocumentRequest?: DocumentsCreateDocumentRequest, options?: AxiosRequestConfig) => Promise;
/**
*
* @summary Retrieves session information.
* @param {string} id The session ID obtained when the session was created
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiMarksSessionsIdGet: (id: string, options?: AxiosRequestConfig) => Promise;
/**
* The purpose of the positioning session is to allow users to visually position signer marks. The result of the session is the same request provided while creating it but with the flowAction\'s prePositioned marks attribute filled according to the positions selected for each action. Result will be available by iFrame event when embedding the positioning session or by retrieving the session information via the GET API.
* @summary Creates a mark positioning session by requiring only the necessary data.
* @param {DocumentMarkMarksSessionCreateRequest} [documentMarkMarksSessionCreateRequest]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiMarksSessionsPost: (documentMarkMarksSessionCreateRequest?: DocumentMarkMarksSessionCreateRequest, options?: AxiosRequestConfig) => Promise;
};
/**
* MarksSessionsApi - functional programming interface
* @export
*/
export declare const MarksSessionsApiFp: (configuration?: Configuration) => {
/**
* The purpose of the positioning session is to allow users to visually position signer marks. The result of the session is the same request provided while creating it but with the flowAction\'s prePositioned marks attribute filled according to the positions selected for each action. Result will be available by iFrame event when embedding the positioning session or by retrieving the session information via the GET API.
* @summary Creates a mark positioning session from a Document create request.
* @param {DocumentsCreateDocumentRequest} [documentsCreateDocumentRequest]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiMarksSessionsDocumentsPost(documentsCreateDocumentRequest?: DocumentsCreateDocumentRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
*
* @summary Retrieves session information.
* @param {string} id The session ID obtained when the session was created
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiMarksSessionsIdGet(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* The purpose of the positioning session is to allow users to visually position signer marks. The result of the session is the same request provided while creating it but with the flowAction\'s prePositioned marks attribute filled according to the positions selected for each action. Result will be available by iFrame event when embedding the positioning session or by retrieving the session information via the GET API.
* @summary Creates a mark positioning session by requiring only the necessary data.
* @param {DocumentMarkMarksSessionCreateRequest} [documentMarkMarksSessionCreateRequest]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiMarksSessionsPost(documentMarkMarksSessionCreateRequest?: DocumentMarkMarksSessionCreateRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
};
/**
* MarksSessionsApi - factory interface
* @export
*/
export declare const MarksSessionsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
* The purpose of the positioning session is to allow users to visually position signer marks. The result of the session is the same request provided while creating it but with the flowAction\'s prePositioned marks attribute filled according to the positions selected for each action. Result will be available by iFrame event when embedding the positioning session or by retrieving the session information via the GET API.
* @summary Creates a mark positioning session from a Document create request.
* @param {DocumentsCreateDocumentRequest} [documentsCreateDocumentRequest]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiMarksSessionsDocumentsPost(documentsCreateDocumentRequest?: DocumentsCreateDocumentRequest, options?: any): AxiosPromise;
/**
*
* @summary Retrieves session information.
* @param {string} id The session ID obtained when the session was created
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiMarksSessionsIdGet(id: string, options?: any): AxiosPromise;
/**
* The purpose of the positioning session is to allow users to visually position signer marks. The result of the session is the same request provided while creating it but with the flowAction\'s prePositioned marks attribute filled according to the positions selected for each action. Result will be available by iFrame event when embedding the positioning session or by retrieving the session information via the GET API.
* @summary Creates a mark positioning session by requiring only the necessary data.
* @param {DocumentMarkMarksSessionCreateRequest} [documentMarkMarksSessionCreateRequest]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiMarksSessionsPost(documentMarkMarksSessionCreateRequest?: DocumentMarkMarksSessionCreateRequest, options?: any): AxiosPromise;
};
/**
* MarksSessionsApi - object-oriented interface
* @export
* @class MarksSessionsApi
* @extends {BaseAPI}
*/
export declare class MarksSessionsApi extends BaseAPI {
/**
* The purpose of the positioning session is to allow users to visually position signer marks. The result of the session is the same request provided while creating it but with the flowAction\'s prePositioned marks attribute filled according to the positions selected for each action. Result will be available by iFrame event when embedding the positioning session or by retrieving the session information via the GET API.
* @summary Creates a mark positioning session from a Document create request.
* @param {DocumentsCreateDocumentRequest} [documentsCreateDocumentRequest]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof MarksSessionsApi
*/
apiMarksSessionsDocumentsPost(documentsCreateDocumentRequest?: DocumentsCreateDocumentRequest, options?: AxiosRequestConfig): Promise>;
/**
*
* @summary Retrieves session information.
* @param {string} id The session ID obtained when the session was created
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof MarksSessionsApi
*/
apiMarksSessionsIdGet(id: string, options?: AxiosRequestConfig): Promise