Skip to content

Latest commit

 

History

History
69 lines (63 loc) · 10.6 KB

recipientgettemplaterecipientresponse.md

File metadata and controls

69 lines (63 loc) · 10.6 KB

RecipientGetTemplateRecipientResponse

Successful response

Example Usage

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

let value: RecipientGetTemplateRecipientResponse = {
  role: "APPROVER",
  readStatus: "NOT_OPENED",
  signingStatus: "NOT_SIGNED",
  sendStatus: "NOT_SENT",
  id: 3337.61,
  documentId: 5104.84,
  templateId: 7280.75,
  email: "Pierre.Gerlach@gmail.com",
  name: "<value>",
  token: "<value>",
  documentDeletedAt: "<value>",
  expired: "<value>",
  signedAt: "<value>",
  authOptions: {
    accessAuth: "ACCOUNT",
    actionAuth: "EXPLICIT_NONE",
  },
  signingOrder: 9896.57,
  rejectionReason: "<value>",
  fields: [
    {
      type: "EMAIL",
      id: 4547.02,
      secondaryId: "<id>",
      documentId: 1041.13,
      templateId: 405.35,
      recipientId: 3509.75,
      page: 8958.78,
      customText: "<value>",
      inserted: false,
      fieldMeta: {
        type: "name",
      },
    },
  ],
};

Fields

Field Type Required Description
role operations.RecipientGetTemplateRecipientRole ✔️ N/A
readStatus operations.RecipientGetTemplateRecipientReadStatus ✔️ N/A
signingStatus operations.RecipientGetTemplateRecipientSigningStatus ✔️ N/A
sendStatus operations.RecipientGetTemplateRecipientSendStatus ✔️ 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.RecipientGetTemplateRecipientAuthOptions ✔️ 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.RecipientGetTemplateRecipientField[] ✔️ N/A