Skip to content

Latest commit

 

History

History
69 lines (63 loc) · 10.3 KB

recipientgetdocumentrecipientresponsebody.md

File metadata and controls

69 lines (63 loc) · 10.3 KB

RecipientGetDocumentRecipientResponseBody

Successful response

Example Usage

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

let value: RecipientGetDocumentRecipientResponseBody = {
  role: "SIGNER",
  readStatus: "OPENED",
  signingStatus: "NOT_SIGNED",
  sendStatus: "SENT",
  id: 985109,
  documentId: 783397,
  templateId: 518990,
  email: "[email protected]",
  name: "<value>",
  token: "<value>",
  documentDeletedAt: "<value>",
  expired: "<value>",
  signedAt: "<value>",
  authOptions: {
    accessAuth: "ACCOUNT",
    actionAuth: "PASSKEY",
  },
  signingOrder: 2628,
  rejectionReason: "<value>",
  fields: [
    {
      type: "DATE",
      id: 35160,
      secondaryId: "<id>",
      documentId: 906232,
      templateId: 816365,
      recipientId: 552581,
      page: 8518.09,
      customText: "<value>",
      inserted: false,
      fieldMeta: {
        type: "dropdown",
      },
    },
  ],
};

Fields

Field Type Required Description
role operations.RecipientGetDocumentRecipientRole ✔️ N/A
readStatus operations.ReadStatus ✔️ N/A
signingStatus operations.SigningStatus ✔️ N/A
sendStatus operations.SendStatus ✔️ N/A
id number ✔️ N/A
documentId number ✔️ N/A
templateId number ✔️ N/A
email string ✔️ N/A
name string ✔️ N/A
token string ✔️ N/A
documentDeletedAt string ✔️ N/A
expired string ✔️ N/A
signedAt string ✔️ N/A
authOptions operations.RecipientGetDocumentRecipientAuthOptions ✔️ N/A
signingOrder number ✔️ The order in which the recipient should sign the document. Only works if the document is set to sequential signing.
rejectionReason string ✔️ N/A
fields operations.RecipientGetDocumentRecipientFields[] ✔️ N/A