Skip to content

Latest commit

 

History

History
87 lines (82 loc) · 10.3 KB

documentfinddocumentsdata.md

File metadata and controls

87 lines (82 loc) · 10.3 KB

DocumentFindDocumentsData

Example Usage

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

let value: DocumentFindDocumentsData = {
  visibility: "EVERYONE",
  status: "DRAFT",
  source: "DOCUMENT",
  id: 5328.71,
  externalId: "<id>",
  userId: 1048.73,
  authOptions: {
    globalAccessAuth: "ACCOUNT",
    globalActionAuth: "TWO_FACTOR_AUTH",
  },
  formValues: {
    "key": false,
  },
  title: "<value>",
  documentDataId: "<id>",
  createdAt: "1714411546378",
  updatedAt: "1743987562539",
  completedAt: "<value>",
  deletedAt: "<value>",
  teamId: 9009.09,
  templateId: 7399.64,
  user: {
    id: 7230.88,
    name: "<value>",
    email: "[email protected]",
  },
  recipients: [
    {
      role: "ASSISTANT",
      readStatus: "NOT_OPENED",
      signingStatus: "REJECTED",
      sendStatus: "SENT",
      id: 2710.15,
      documentId: 2113.88,
      templateId: 2199.97,
      email: "[email protected]",
      name: "<value>",
      token: "<value>",
      documentDeletedAt: "<value>",
      expired: "<value>",
      signedAt: "<value>",
      authOptions: {
        accessAuth: "ACCOUNT",
        actionAuth: "ACCOUNT",
      },
      signingOrder: 7776.99,
      rejectionReason: "<value>",
    },
  ],
  team: {
    id: 4462.5,
    url: "https://clear-ruin.biz",
  },
};

Fields

Field Type Required Description
visibility operations.DocumentFindDocumentsVisibility ✔️ N/A
status operations.DataStatus ✔️ N/A
source operations.DataSource ✔️ 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.DocumentFindDocumentsAuthOptions ✔️ N/A
formValues Record<string, operations.DocumentFindDocumentsFormValues> ✔️ 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
user operations.DocumentFindDocumentsUser ✔️ N/A
recipients operations.DocumentFindDocumentsRecipient[] ✔️ N/A
team operations.DocumentFindDocumentsTeam ✔️ N/A