fieldgetdocumentfieldresponse.md

FieldGetDocumentFieldResponse

Successful response

Example Usage

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

let value: FieldGetDocumentFieldResponse = {
  type: "INITIALS",
  id: 4256.77,
  secondaryId: "<id>",
  documentId: 7400.94,
  templateId: 6822.42,
  recipientId: 6278.08,
  page: 8991.32,
  customText: "<value>",
  inserted: false,
  fieldMeta: {
    type: "email",
  },
};

Fields

Field	Type	Required	Description
type	operations.FieldGetDocumentFieldType	✔️	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.FieldGetDocumentFieldFieldMetaUnion	✔️	N/A