Package ai.extend.types

Class EditJson.Builder

  • Enclosing class:
    EditJson
    public static final class EditJson.Builder
extends java.lang.Object

    • Method Detail

      • type

        public EditJson.Builder type​(java.util.Optional<java.lang.Object> type)

        The JSON schema type of the field. Can be:

        • A string: "array" or "object"
        • A nullable tuple array: ["string", "null"], ["number", "null"], ["integer", "null"], ["boolean", "null"]
        • Omitted for enum fields (use enum property instead)

      • description

        public EditJson.Builder description​(java.util.Optional<java.lang.String> description)

        Description of the field

      • description

        public EditJson.Builder description​(java.lang.String description)

      • extendEditFieldType

        public EditJson.Builder extendEditFieldType​(java.util.Optional<EditJsonExtendEditFieldType> extendEditFieldType)

        The PDF field type to edit. Allowed values depend on the schema type:

        • ["string", "null"] → text, signature
        • ["number", "null"] → text
        • ["integer", "null"] → text
        • ["boolean", "null"] → checkbox, radio
        • "array" → text, table
        • "object" → signature
        • enum fields (no type) → radio, optionList, dropdown

      • extendEditBboxes

        public EditJson.Builder extendEditBboxes​(java.util.Optional<java.util.List<EditBoundingBox>> extendEditBboxes)

        Array of bounding boxes for radio enums. Enum at index i corresponds to bbox at index i.

      • extendEditPageIndex

        public EditJson.Builder extendEditPageIndex​(java.util.Optional<java.lang.Integer> extendEditPageIndex)

        Zero-based page index where the field should be placed

      • extendEditPageIndex

        public EditJson.Builder extendEditPageIndex​(java.lang.Integer extendEditPageIndex)

      • extendEditColumnWidth

        public EditJson.Builder extendEditColumnWidth​(java.util.Optional<java.lang.Double> extendEditColumnWidth)

        Width of the column as a percentage (for table fields)

      • extendEditColumnWidth

        public EditJson.Builder extendEditColumnWidth​(java.lang.Double extendEditColumnWidth)

      • extendEditValue

        public EditJson.Builder extendEditValue​(java.util.Optional<java.lang.Object> extendEditValue)

        The value to fill into this field. Can be any type. This will force the value at this field to be filled with this value. If a value is not provided, we will attempt to generate or infer one based on the instructions.

      • extendEditValue

        public EditJson.Builder extendEditValue​(java.lang.Object extendEditValue)

      • extendEditImage

        public EditJson.Builder extendEditImage​(java.util.Optional<EditJsonExtendEditImage> extendEditImage)

        Image fill for signature fields. Only PNG and JPEG image URLs are supported.

      • extendEditRowHeights

        public EditJson.Builder extendEditRowHeights​(java.util.Optional<java.util.List<java.lang.Double>> extendEditRowHeights)

        Array of row height percentages for array/table fields (e.g. [0.25, 0.50, 0.25])

      • extendEditRowHeights

        public EditJson.Builder extendEditRowHeights​(java.util.List<java.lang.Double> extendEditRowHeights)

      • items

        public EditJson.Builder items​(java.util.Optional<EditObjectJson> items)

        Schema for array items (when type is "array"). Must be an EditObjectJSON.

      • properties

        public EditJson.Builder properties​(java.util.Optional<java.util.Map<java.lang.String,​EditJson>> properties)

        Nested properties for object types. Each property follows the EditJSON structure.

      • enum_

        public EditJson.Builder enum_​(java.util.Optional<java.util.List<java.lang.String>> enum_)

        Allowed values for enum/dropdown/radio fields

      • enum_

        public EditJson.Builder enum_​(java.util.List<java.lang.String> enum_)

      • maxItems

        public EditJson.Builder maxItems​(java.util.Optional<java.lang.Integer> maxItems)

        Maximum number of rows for array/table fields

      • required

        public EditJson.Builder required​(java.util.Optional<java.util.List<java.lang.String>> required)

        List of required property names (for object types)

      • required

        public EditJson.Builder required​(java.util.List<java.lang.String> required)

      • additionalProperties

        public EditJson.Builder additionalProperties​(java.util.Optional<java.lang.Boolean> additionalProperties)

        Whether additional properties are allowed (for object types)

      • additionalProperties

        public EditJson.Builder additionalProperties​(java.lang.Boolean additionalProperties)