Successful response
import { FieldGetTemplateFieldResponseBody } from "@documenso/sdk-typescript/models/operations";
let value: FieldGetTemplateFieldResponseBody = {
type: "FREE_SIGNATURE",
id: 381654,
secondaryId: "<id>",
documentId: 885523,
templateId: 148038,
recipientId: 823990,
page: 149.76,
customText: "<value>",
inserted: false,
fieldMeta: {
type: "text",
},
};
Field | Type | Required | Description |
---|---|---|---|
type |
operations.FieldGetTemplateFieldType | ✔️ | N/A |
id |
number | ✔️ | N/A |
secondaryId |
string | ✔️ | N/A |
documentId |
number | ✔️ | N/A |
templateId |
number | ✔️ | N/A |
recipientId |
number | ✔️ | N/A |
page |
number | ✔️ | The page number of the field on the document. Starts from 1. |
positionX |
any | ➖ | N/A |
positionY |
any | ➖ | N/A |
width |
any | ➖ | N/A |
height |
any | ➖ | N/A |
customText |
string | ✔️ | N/A |
inserted |
boolean | ✔️ | N/A |
fieldMeta |
operations.FieldGetTemplateFieldFieldMeta | ✔️ | N/A |