Skip to content

Latest commit

 

History

History
69 lines (63 loc) · 11 KB

recipientupdatetemplaterecipientresponse.md

File metadata and controls

69 lines (63 loc) · 11 KB

RecipientUpdateTemplateRecipientResponse

Successful response

Example Usage

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

let value: RecipientUpdateTemplateRecipientResponse = {
  role: "CC",
  readStatus: "OPENED",
  signingStatus: "REJECTED",
  sendStatus: "SENT",
  id: 7508,
  documentId: 2937.02,
  templateId: 6708.46,
  email: "[email protected]",
  name: "<value>",
  token: "<value>",
  documentDeletedAt: "<value>",
  expired: "<value>",
  signedAt: "<value>",
  authOptions: {
    accessAuth: "ACCOUNT",
    actionAuth: "ACCOUNT",
  },
  signingOrder: 4355.91,
  rejectionReason: "<value>",
  fields: [
    {
      type: "EMAIL",
      id: 6422.52,
      secondaryId: "<id>",
      documentId: 9720.03,
      templateId: 9069.27,
      recipientId: 334.66,
      page: 9689.06,
      customText: "<value>",
      inserted: false,
      fieldMeta: {
        type: "number",
      },
    },
  ],
};

Fields

Field Type Required Description
role operations.RecipientUpdateTemplateRecipientRoleResponse ✔️ N/A
readStatus operations.RecipientUpdateTemplateRecipientReadStatus ✔️ N/A
signingStatus operations.RecipientUpdateTemplateRecipientSigningStatus ✔️ N/A
sendStatus operations.RecipientUpdateTemplateRecipientSendStatus ✔️ 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.RecipientUpdateTemplateRecipientAuthOptions ✔️ 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.RecipientUpdateTemplateRecipientField[] ✔️ N/A