Skip to content

Latest commit

 

History

History
121 lines (115 loc) · 14 KB

documentgetdocumentwithdetailsbyidresponse.md

File metadata and controls

121 lines (115 loc) · 14 KB

DocumentGetDocumentWithDetailsByIdResponse

Successful response

Example Usage

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

let value: DocumentGetDocumentWithDetailsByIdResponse = {
  visibility: "MANAGER_AND_ABOVE",
  status: "REJECTED",
  source: "DOCUMENT",
  id: 4005.96,
  externalId: "<id>",
  userId: 3837.66,
  authOptions: {
    globalAccessAuth: "ACCOUNT",
    globalActionAuth: "TWO_FACTOR_AUTH",
  },
  formValues: {
    "key": "<value>",
  },
  title: "<value>",
  documentDataId: "<id>",
  createdAt: "1715425741269",
  updatedAt: "1744043002525",
  completedAt: "<value>",
  deletedAt: "<value>",
  teamId: 9273.9,
  templateId: 5066.42,
  documentData: {
    type: "BYTES_64",
    id: "<id>",
    data: "<value>",
    initialData: "<value>",
  },
  documentMeta: {
    signingOrder: "PARALLEL",
    distributionMethod: "EMAIL",
    id: "<id>",
    subject: "<value>",
    message: "<value>",
    timezone: "Europe/Mariehamn",
    password: "WYPwINXZb01HWU6",
    dateFormat: "<value>",
    documentId: 2266.53,
    redirectUrl: "https://royal-membership.org/",
    typedSignatureEnabled: false,
    uploadSignatureEnabled: false,
    drawSignatureEnabled: false,
    allowDictateNextSigner: false,
    language: "<value>",
    emailSettings: {},
  },
  recipients: [
    {
      role: "CC",
      readStatus: "NOT_OPENED",
      signingStatus: "SIGNED",
      sendStatus: "SENT",
      id: 7265.62,
      documentId: 6614.32,
      templateId: 1154.9,
      email: "[email protected]",
      name: "<value>",
      token: "<value>",
      documentDeletedAt: "<value>",
      expired: "<value>",
      signedAt: "<value>",
      authOptions: {
        accessAuth: "ACCOUNT",
        actionAuth: "ACCOUNT",
      },
      signingOrder: 6847.27,
      rejectionReason: "<value>",
    },
  ],
  fields: [
    {
      type: "NUMBER",
      id: 7186.6,
      secondaryId: "<id>",
      documentId: 5366.86,
      templateId: 1978.18,
      recipientId: 4691.92,
      page: 2543.41,
      customText: "<value>",
      inserted: false,
      fieldMeta: {
        type: "name",
      },
    },
  ],
};

Fields

Field Type Required Description
visibility operations.DocumentGetDocumentWithDetailsByIdVisibility ✔️ N/A
status operations.DocumentGetDocumentWithDetailsByIdStatus ✔️ N/A
source operations.DocumentGetDocumentWithDetailsByIdSource ✔️ 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.DocumentGetDocumentWithDetailsByIdAuthOptions ✔️ N/A
formValues Record<string, operations.DocumentGetDocumentWithDetailsByIdFormValues> ✔️ 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.DocumentGetDocumentWithDetailsByIdDocumentData ✔️ N/A
documentMeta operations.DocumentGetDocumentWithDetailsByIdDocumentMeta ✔️ N/A
recipients operations.DocumentGetDocumentWithDetailsByIdRecipient[] ✔️ N/A
fields operations.DocumentGetDocumentWithDetailsByIdField[] ✔️ N/A