templatecreatedocumentfromtemplateresponsebody.md

TemplateCreateDocumentFromTemplateResponseBody

Successful response

Example Usage

import { TemplateCreateDocumentFromTemplateResponseBody } from "@documenso/sdk-typescript/models/operations";

let value: TemplateCreateDocumentFromTemplateResponseBody = {
  visibility: "EVERYONE",
  status: "PENDING",
  source: "TEMPLATE",
  id: 728474,
  externalId: "<id>",
  userId: 9006.76,
  authOptions: {
    globalAccessAuth: "ACCOUNT",
    globalActionAuth: "TWO_FACTOR_AUTH",
  },
  formValues: {
    "key": 329.45,
  },
  title: "<value>",
  documentDataId: "<id>",
  createdAt: "1715837994289",
  updatedAt: "1737549802270",
  completedAt: "<value>",
  deletedAt: "<value>",
  teamId: 415953,
  templateId: 231255,
  documentData: {
    type: "S3_PATH",
    id: "<id>",
    data: "<value>",
    initialData: "<value>",
  },
  documentMeta: {
    signingOrder: "SEQUENTIAL",
    distributionMethod: "EMAIL",
    id: "<id>",
    subject: "<value>",
    message: "<value>",
    timezone: "America/Monterrey",
    password: "q49u4lmy5g301NI",
    dateFormat: "<value>",
    documentId: 24548,
    redirectUrl: "https://burdensome-kettledrum.net/",
    typedSignatureEnabled: false,
    language: "<value>",
    emailSettings: {},
  },
  recipients: [
    {
      role: "APPROVER",
      readStatus: "NOT_OPENED",
      signingStatus: "SIGNED",
      sendStatus: "SENT",
      id: 237972,
      documentId: 761927,
      templateId: 890765,
      email: "[email protected]",
      name: "<value>",
      token: "<value>",
      documentDeletedAt: "<value>",
      expired: "<value>",
      signedAt: "<value>",
      authOptions: {
        accessAuth: "ACCOUNT",
        actionAuth: "TWO_FACTOR_AUTH",
      },
      signingOrder: 3530.75,
      rejectionReason: "<value>",
    },
  ],
  fields: [
    {
      type: "FREE_SIGNATURE",
      id: 312690,
      secondaryId: "<id>",
      documentId: 884325,
      templateId: 958533,
      recipientId: 207512,
      page: 7884.69,
      customText: "<value>",
      inserted: false,
      fieldMeta: {
        type: "email",
      },
    },
  ],
};

Fields

Field	Type	Required	Description
visibility	operations.TemplateCreateDocumentFromTemplateVisibility	✔️	N/A
status	operations.TemplateCreateDocumentFromTemplateStatus	✔️	N/A
source	operations.TemplateCreateDocumentFromTemplateSource	✔️	N/A
id	number	✔️	N/A
externalId	string	✔️	A custom external ID you can use to identify the document.
userId	number	✔️	The ID of the user that created this document.
authOptions	operations.TemplateCreateDocumentFromTemplateAuthOptions	✔️	N/A
formValues	Record<string, operations.TemplateCreateDocumentFromTemplateFormValues>	✔️	N/A
title	string	✔️	N/A
documentDataId	string	✔️	N/A
createdAt	string	✔️	N/A
updatedAt	string	✔️	N/A
completedAt	string	✔️	N/A
deletedAt	string	✔️	N/A
teamId	number	✔️	N/A
templateId	number	✔️	N/A
documentData	operations.TemplateCreateDocumentFromTemplateDocumentData	✔️	N/A
documentMeta	operations.TemplateCreateDocumentFromTemplateDocumentMeta	✔️	N/A
recipients	operations.TemplateCreateDocumentFromTemplateTemplatesRecipients[]	✔️	N/A
fields	operations.TemplateCreateDocumentFromTemplateFields[]	✔️	N/A