/* tslint:disable */
/* eslint-disable */
/**
 * Dropsigner
 * <!--------------------------------------------------------------------------------------------------------------------->  <h2>Authentication</h2>  <p>  In order to call this APIs, you will need an <strong>API key</strong>. Set the API key in the header <span class=\"code\">X-Api-Key</span>: </p>  <pre>X-Api-Key: your-app|xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx</pre>  <!---------------------------------------------------------------------------------------------------------------------> <br />  <h2>HTTP Codes</h2>  <p>  The APIs will return the following HTTP codes: </p>  <table>  <thead>   <tr>    <th>Code</th>    <th>Description</th>   </tr>  </thead>  <tbody>   <tr>    <td><strong class=\"model-title\">200 (OK)</strong></td>    <td>Request processed successfully. The response is different for each API, please refer to the operation's documentation</td>   </tr>   <tr>    <td><strong class=\"model-title\">400 (Bad Request)</strong></td>    <td>Syntax error. For instance, when a required field was not provided</td>   </tr>   <tr>    <td><strong class=\"model-title\">401 (Unauthorized)</strong></td>    <td>API key not provided or invalid</td>   </tr>   <tr>    <td><strong class=\"model-title\">403 (Forbidden)</strong></td>    <td>API key is valid, but the application has insufficient permissions to complete the requested operation</td>   </tr>   <tr>    <td><strong class=\"model-title\">422 (Unprocessable Entity)</strong></td>    <td>API error. The response is as defined in <a href=\"#model-ErrorModel\">ErrorModel</a></td>   </tr>  </tbody> </table>  <br />  <h3>Error Codes</h3>  <p>Some of the error codes returned in a 422 response are provided bellow*:</p>  <ul>  <li>CertificateNotFound</li>  <li>DocumentNotFound</li>  <li>FolderNotFound</li>  <li>CpfMismatch</li>  <li>CpfNotExpected</li>  <li>InvalidFlowAction</li>  <li>DocumentInvalidKey</li> </ul>  <p style=\"font-size: 0.9em\">  *The codes shown above are the main error codes. Nonetheless, this list is not comprehensive. New codes may be added anytime without previous warning. </p>  <!--------------------------------------------------------------------------------------------------------------------->  <br />  <h2>Webhooks</h2>  <p>  It is recomended to subscribe to Webhook events <strong>instead</strong> 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. </p> <p>  All requests have the format described in <a href=\"#model-Webhooks.WebhookModel\">Webhooks.WebhookModel</a>.  The data field varies according to the webhook event type: </p>   <table>  <thead>   <tr>    <th>Event type</th>    <th>Description</th>    <th>Payload</th>   </tr>  </thead>  <tbody>   <tr>    <td><strong class=\"model-title\">DocumentSigned</strong></td>    <td>Triggered when a document is signed.</td>    <td><a href=\"#model-Webhooks.DocumentSignedModel\">Webhooks.DocumentSignedModel</a></td>   </tr>   <tr>    <td><strong class=\"model-title\">DocumentApproved</strong></td>    <td>Triggered when a document is approved.</td>    <td><a href=\"#model-Webhooks.DocumentApprovedModel\">Webhooks.DocumentApprovedModel</a></td>   </tr>   <tr>    <td><strong class=\"model-title\">DocumentRefused</strong></td>    <td>Triggered when a document is refused.</td>    <td><a href=\"#model-Webhooks.DocumentRefusedModel\">Webhooks.DocumentRefusedModel</a></td>   </tr>   <tr>    <td><strong class=\"model-title\">DocumentConcluded</strong></td>    <td>Triggered when the flow of a document is concluded.</td>    <td><a href=\"#model-Webhooks.DocumentConcludedModel\">Webhooks.DocumentConcludedModel</a></td>   </tr>   <tr>    <td><strong class=\"model-title\">DocumentCanceled</strong></td>    <td>Triggered when the document is canceled.</td>    <td><a href=\"#model-Webhooks.DocumentCanceledModel\">Webhooks.DocumentCanceledModel</a></td>   </tr>   <tr>    <td><strong class=\"model-title\">DocumentExpired (v1.33.0)</strong></td>    <td>Triggered when the document is expired.</td>    <td><a href=\"#model-Webhooks.DocumentExpiredModel\">Webhooks.DocumentExpiredModel</a></td>   </tr>   <tr>    <td><strong class=\"model-title\">DocumentsCreated (v1.50.0)</strong></td>    <td>Triggered when one or more documents are created.</td>    <td><a href=\"#model-Webhooks.DocumentsCreatedModel\">Webhooks.DocumentsCreatedModel</a></td>   </tr>   <tr>    <td><strong class=\"model-title\">DocumentsDeleted (v1.78.0)</strong></td>    <td>Triggered when one or more documents are deleted.</td>    <td><a href=\"#model-Webhooks.DocumentsDeletedModel\">Webhooks.DocumentsDeletedModel</a></td>   </tr>  </tbody> </table>  <p>  To register your application URL and enable Webhooks, access the integrations section in your <a href=\"/private/organizations\" target=\"_blank\">organization's details page</a>. </p> 
 *
 * OpenAPI spec version: 2.6.0
 * 
 *
 * NOTE: This class is auto generated by the swagger code generator program.
 * https://github.com/swagger-api/swagger-codegen.git
 * Do not edit the class manually.
 */
import { ActionStatus } from './action-status';
import { CertificateHolderTypes } from './certificate-holder-types';
import { CertificateTypes } from './certificate-types';
import { DocumentMarkDocumentMarkPositionModel } from './document-mark-document-mark-position-model';
import { FlowActionType } from './flow-action-type';
import { FlowActionsRuleUserModel } from './flow-actions-rule-user-model';
import { FlowActionsSignRuleUserModel } from './flow-actions-sign-rule-user-model';
import { NotificationLanguage } from './notification-language';
import { SignatureInitialsModes } from './signature-initials-modes';
import { UsersParticipantUserModel } from './users-participant-user-model';
/**
 * 
 * @export
 * @interface FlowActionsFlowActionModel
 */
export interface FlowActionsFlowActionModel {
    /**
     * 
     * @type {string}
     * @memberof FlowActionsFlowActionModel
     */
    id?: string;
    /**
     * 
     * @type {Date}
     * @memberof FlowActionsFlowActionModel
     */
    creationDate?: Date;
    /**
     * 
     * @type {Date}
     * @memberof FlowActionsFlowActionModel
     */
    pendingDate?: Date | null;
    /**
     * 
     * @type {Date}
     * @memberof FlowActionsFlowActionModel
     */
    updateDate?: Date;
    /**
     * 
     * @type {UsersParticipantUserModel}
     * @memberof FlowActionsFlowActionModel
     */
    user?: UsersParticipantUserModel;
    /**
     * [DEPRECATED] Number of required signatures (if type is SignRule). Please use `NumberRequiredActions\"` instead.
     * @type {number}
     * @memberof FlowActionsFlowActionModel
     */
    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<FlowActionsSignRuleUserModel>}
     * @memberof FlowActionsFlowActionModel
     */
    signRuleUsers?: Array<FlowActionsSignRuleUserModel> | null;
    /**
     * Users that are allowed to sign or approver (if type is SignRule or ApproverRule)
     * @type {Array<FlowActionsRuleUserModel>}
     * @memberof FlowActionsFlowActionModel
     */
    ruleUsers?: Array<FlowActionsRuleUserModel> | null;
    /**
     * 
     * @type {Array<DocumentMarkDocumentMarkPositionModel>}
     * @memberof FlowActionsFlowActionModel
     */
    marks?: Array<DocumentMarkDocumentMarkPositionModel> | 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;
}