/* 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 { AttachmentsAttachmentUploadModel } from './attachments-attachment-upload-model';
import { DocumentsDocumentAdditionalInfoData } from './documents-document-additional-info-data';
import { DocumentsDocumentTagData } from './documents-document-tag-data';
import { FileUploadModel } from './file-upload-model';
import { FlowActionsFlowActionCreateModel } from './flow-actions-flow-action-create-model';
import { ObserversObserverCreateModel } from './observers-observer-create-model';
import { SignatureTypes } from './signature-types';
import { UploadModel } from './upload-model';
import { XmlNamespaceModel } from './xml-namespace-model';
/**
 * 
 * @export
 * @interface DocumentsCreateDocumentRequest
 */
export interface DocumentsCreateDocumentRequest {
    /**
     * The files to submit. Each file will create a document.
     * @type {Array<FileUploadModel>}
     * @memberof DocumentsCreateDocumentRequest
     */
    files: Array<FileUploadModel>;
    /**
     * The attachments to submit. Each document will have the same attachments.
     * @type {Array<AttachmentsAttachmentUploadModel>}
     * @memberof DocumentsCreateDocumentRequest
     */
    attachments?: Array<AttachmentsAttachmentUploadModel> | null;
    /**
     * Optional parameter for XML documents. This namespace will be used by all files in Lacuna.Signer.Api.Documents.CreateDocumentRequest.Files.
     * @type {Array<XmlNamespaceModel>}
     * @memberof DocumentsCreateDocumentRequest
     */
    xmlNamespaces?: Array<XmlNamespaceModel> | 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;
    /**
     * The list of actions (signers and approvers) that will be in the document.
     * @type {Array<FlowActionsFlowActionCreateModel>}
     * @memberof DocumentsCreateDocumentRequest
     */
    flowActions: Array<FlowActionsFlowActionCreateModel>;
    /**
     * 
     * @type {Array<ObserversObserverCreateModel>}
     * @memberof DocumentsCreateDocumentRequest
     */
    observers?: Array<ObserversObserverCreateModel> | 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<string>}
     * @memberof DocumentsCreateDocumentRequest
     */
    notifiedEmails?: Array<string> | null;
    /**
     * 
     * @type {DocumentsDocumentAdditionalInfoData}
     * @memberof DocumentsCreateDocumentRequest
     */
    additionalInfo?: DocumentsDocumentAdditionalInfoData;
    /**
     * 
     * @type {Array<DocumentsDocumentTagData>}
     * @memberof DocumentsCreateDocumentRequest
     */
    tags?: Array<DocumentsDocumentTagData> | 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 {Date}
     * @memberof DocumentsCreateDocumentRequest
     */
    expirationDate?: Date | null;
}