Skip to content

Latest commit

 

History

History
124 lines (118 loc) · 11.5 KB

templategettemplatebyidresponsebody.md

File metadata and controls

124 lines (118 loc) · 11.5 KB

TemplateGetTemplateByIdResponseBody

Successful response

Example Usage

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

let value: TemplateGetTemplateByIdResponseBody = {
  type: "PRIVATE",
  visibility: "MANAGER_AND_ABOVE",
  id: 880998,
  externalId: "<id>",
  title: "<value>",
  userId: 555938,
  teamId: 741603,
  authOptions: {
    globalAccessAuth: "ACCOUNT",
    globalActionAuth: "TWO_FACTOR_AUTH",
  },
  templateDocumentDataId: "<id>",
  createdAt: "1734698189077",
  updatedAt: "1737518259165",
  publicTitle: "<value>",
  publicDescription: "<value>",
  templateDocumentData: {
    type: "BYTES",
    id: "<id>",
    data: "<value>",
    initialData: "<value>",
  },
  templateMeta: {
    id: "<id>",
    subject: "<value>",
    message: "<value>",
    timezone: "America/St_Barthelemy",
    dateFormat: "<value>",
    signingOrder: "SEQUENTIAL",
    typedSignatureEnabled: false,
    distributionMethod: "EMAIL",
    templateId: 982574,
    redirectUrl: "https://blind-jungle.net",
    language: "<value>",
    emailSettings: {},
  },
  directLink: {
    id: "<id>",
    templateId: 738152,
    token: "<value>",
    createdAt: "1734642866933",
    enabled: false,
    directTemplateRecipientId: 799866,
  },
  user: {
    id: 310930,
    name: "<value>",
    email: "[email protected]",
  },
  recipients: [
    {
      role: "VIEWER",
      readStatus: "NOT_OPENED",
      signingStatus: "REJECTED",
      sendStatus: "SENT",
      id: 998355,
      documentId: 847308,
      templateId: 414456,
      email: "[email protected]",
      name: "<value>",
      token: "<value>",
      documentDeletedAt: "<value>",
      expired: "<value>",
      signedAt: "<value>",
      authOptions: {
        accessAuth: "ACCOUNT",
        actionAuth: "TWO_FACTOR_AUTH",
      },
      signingOrder: 424.54,
      rejectionReason: "<value>",
    },
  ],
  fields: [
    {
      type: "DATE",
      id: 546868,
      secondaryId: "<id>",
      documentId: 340101,
      templateId: 68596,
      recipientId: 228907,
      page: 3579.84,
      customText: "<value>",
      inserted: false,
      fieldMeta: {
        type: "date",
      },
    },
  ],
};

Fields

Field Type Required Description
type operations.TemplateGetTemplateByIdType ✔️ N/A
visibility operations.TemplateGetTemplateByIdVisibility ✔️ N/A
id number ✔️ N/A
externalId string ✔️ N/A
title string ✔️ N/A
userId number ✔️ N/A
teamId number ✔️ N/A
authOptions operations.TemplateGetTemplateByIdAuthOptions ✔️ N/A
templateDocumentDataId string ✔️ N/A
createdAt string ✔️ N/A
updatedAt string ✔️ N/A
publicTitle string ✔️ N/A
publicDescription string ✔️ N/A
templateDocumentData operations.TemplateDocumentData ✔️ N/A
templateMeta operations.TemplateMeta ✔️ N/A
directLink operations.DirectLink ✔️ N/A
user operations.User ✔️ N/A
recipients operations.TemplateGetTemplateByIdRecipients[] ✔️ N/A
fields operations.TemplateGetTemplateByIdFields[] ✔️ N/A