Skip to content

Latest commit

 

History

History
127 lines (121 loc) · 11.8 KB

templategettemplatebyidresponse.md

File metadata and controls

127 lines (121 loc) · 11.8 KB

TemplateGetTemplateByIdResponse

Successful response

Example Usage

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

let value: TemplateGetTemplateByIdResponse = {
  type: "PRIVATE",
  visibility: "MANAGER_AND_ABOVE",
  id: 483.1,
  externalId: "<id>",
  title: "<value>",
  userId: 4992.92,
  teamId: 2772.42,
  authOptions: {
    globalAccessAuth: "ACCOUNT",
    globalActionAuth: "PASSKEY",
  },
  templateDocumentDataId: "<id>",
  createdAt: "1730997561685",
  updatedAt: "1744069972056",
  publicTitle: "<value>",
  publicDescription: "<value>",
  templateDocumentData: {
    type: "BYTES",
    id: "<id>",
    data: "<value>",
    initialData: "<value>",
  },
  templateMeta: {
    id: "<id>",
    subject: "<value>",
    message: "<value>",
    timezone: "Antarctica/Casey",
    dateFormat: "<value>",
    signingOrder: "SEQUENTIAL",
    typedSignatureEnabled: false,
    uploadSignatureEnabled: false,
    drawSignatureEnabled: false,
    allowDictateNextSigner: false,
    distributionMethod: "EMAIL",
    templateId: 5821.94,
    redirectUrl: "https://mixed-stool.com",
    language: "<value>",
    emailSettings: {},
  },
  directLink: {
    id: "<id>",
    templateId: 6831.82,
    token: "<value>",
    createdAt: "1725890596089",
    enabled: false,
    directTemplateRecipientId: 5013.71,
  },
  user: {
    id: 3834.62,
    name: "<value>",
    email: "[email protected]",
  },
  recipients: [
    {
      role: "SIGNER",
      readStatus: "NOT_OPENED",
      signingStatus: "NOT_SIGNED",
      sendStatus: "NOT_SENT",
      id: 1440.48,
      documentId: 6456.18,
      templateId: 1409.25,
      email: "[email protected]",
      name: "<value>",
      token: "<value>",
      documentDeletedAt: "<value>",
      expired: "<value>",
      signedAt: "<value>",
      authOptions: {
        accessAuth: "ACCOUNT",
        actionAuth: "EXPLICIT_NONE",
      },
      signingOrder: 1222.15,
      rejectionReason: "<value>",
    },
  ],
  fields: [
    {
      type: "DROPDOWN",
      id: 7713.22,
      secondaryId: "<id>",
      documentId: 4598.21,
      templateId: 8276.07,
      recipientId: 8394.95,
      page: 1896.3,
      customText: "<value>",
      inserted: false,
      fieldMeta: {
        type: "dropdown",
      },
    },
  ],
};

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.TemplateGetTemplateByIdTemplateMeta ✔️ N/A
directLink operations.TemplateGetTemplateByIdDirectLink ✔️ N/A
user operations.TemplateGetTemplateByIdUser ✔️ N/A
recipients operations.TemplateGetTemplateByIdRecipient[] ✔️ N/A
fields operations.TemplateGetTemplateByIdField[] ✔️ N/A