Skip to content

Latest commit

 

History

History
69 lines (63 loc) · 12.5 KB

recipientupdatedocumentrecipientresponsebody.md

File metadata and controls

69 lines (63 loc) · 12.5 KB

RecipientUpdateDocumentRecipientResponseBody

Successful response

Example Usage

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

let value: RecipientUpdateDocumentRecipientResponseBody = {
  role: "APPROVER",
  readStatus: "NOT_OPENED",
  signingStatus: "REJECTED",
  sendStatus: "SENT",
  id: 569287,
  documentId: 512081,
  templateId: 971764,
  email: "[email protected]",
  name: "<value>",
  token: "<value>",
  documentDeletedAt: "<value>",
  expired: "<value>",
  signedAt: "<value>",
  authOptions: {
    accessAuth: "ACCOUNT",
    actionAuth: "PASSKEY",
  },
  signingOrder: 7815.82,
  rejectionReason: "<value>",
  fields: [
    {
      type: "NUMBER",
      id: 916341,
      secondaryId: "<id>",
      documentId: 259377,
      templateId: 758194,
      recipientId: 459875,
      page: 5736.1,
      customText: "<value>",
      inserted: false,
      fieldMeta: {
        type: "dropdown",
      },
    },
  ],
};

Fields

Field Type Required Description
role operations.RecipientUpdateDocumentRecipientDocumentsRecipientsRole ✔️ N/A
readStatus operations.RecipientUpdateDocumentRecipientReadStatus ✔️ N/A
signingStatus operations.RecipientUpdateDocumentRecipientSigningStatus ✔️ N/A
sendStatus operations.RecipientUpdateDocumentRecipientSendStatus ✔️ 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.RecipientUpdateDocumentRecipientAuthOptions ✔️ 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.RecipientUpdateDocumentRecipientFields[] ✔️ N/A