Skip to content

Latest commit

 

History

History
52 lines (46 loc) · 10.2 KB

recipientcreatedocumentrecipientresponse.md

File metadata and controls

52 lines (46 loc) · 10.2 KB

RecipientCreateDocumentRecipientResponse

Successful response

Example Usage

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

let value: RecipientCreateDocumentRecipientResponse = {
  role: "APPROVER",
  readStatus: "NOT_OPENED",
  signingStatus: "NOT_SIGNED",
  sendStatus: "NOT_SENT",
  id: 8655.25,
  documentId: 8534.8,
  templateId: 8731.13,
  email: "[email protected]",
  name: "<value>",
  token: "<value>",
  documentDeletedAt: "<value>",
  expired: "<value>",
  signedAt: "<value>",
  authOptions: {
    accessAuth: "ACCOUNT",
    actionAuth: "ACCOUNT",
  },
  signingOrder: 1485.2,
  rejectionReason: "<value>",
};

Fields

Field Type Required Description
role operations.RecipientCreateDocumentRecipientRoleResponse ✔️ N/A
readStatus operations.RecipientCreateDocumentRecipientReadStatus ✔️ N/A
signingStatus operations.RecipientCreateDocumentRecipientSigningStatus ✔️ N/A
sendStatus operations.RecipientCreateDocumentRecipientSendStatus ✔️ 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.RecipientCreateDocumentRecipientAuthOptions ✔️ 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