dropbox-sign 1.0.0 → 1.1.0

data/openapi-sdk.yaml

@@ -982,6 +982,20 @@ paths:
           schema:
             type: string
           example: 6e683bc0369ba3d5b6f43c2c22a8031dbf6bd174
+        -
+          name: page
+          in: query
+          description: 'Which page number of the BulkSendJob list to return. Defaults to `1`.'
+          schema:
+            type: integer
+            default: 1
+        -
+          name: page_size
+          in: query
+          description: 'Number of objects to be returned per page. Must be between `1` and `100`. Default is 20.'
+          schema:
+            type: integer
+            default: 20
       responses:
         200:
           description: 'successful operation'
@@ -6821,7 +6835,7 @@ components:
             $ref: '#/components/schemas/SubFormFieldRule'
         form_fields_per_document:
           description: |-
-            The fields that should appear on the document, expressed as an array of objects. (We're currently fixing a bug where this property only accepts a two-dimensional array. You can read about it here: <a href="/docs/openapi/form-fields-per-document" target="_blank">Using Form Fields per Document</a>.)
+            The fields that should appear on the document, expressed as an array of objects. (We're currently fixing a bug where this property only accepts a two-dimensional array. You can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)
 
             **NOTE**: Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.
 
@@ -6882,7 +6896,6 @@ components:
             ⚠️ **Note** ⚠️: Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature.
           type: boolean
           default: false
-          x-beta: closed
         expires_at:
           description: |-
             When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details.
@@ -6975,7 +6988,6 @@ components:
             ⚠️ **Note** ⚠️: Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature.
           type: boolean
           default: false
-          x-beta: closed
       type: object
     SignatureRequestRemindRequest:
       required:
@@ -7073,7 +7085,7 @@ components:
             $ref: '#/components/schemas/SubFormFieldRule'
         form_fields_per_document:
           description: |-
-            The fields that should appear on the document, expressed as an array of objects. (We're currently fixing a bug where this property only accepts a two-dimensional array. You can read about it here: <a href="/docs/openapi/form-fields-per-document" target="_blank">Using Form Fields per Document</a>.)
+            The fields that should appear on the document, expressed as an array of objects. (We're currently fixing a bug where this property only accepts a two-dimensional array. You can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)
 
             **NOTE**: Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.
 
@@ -7531,7 +7543,7 @@ components:
       type: object
     SubFormFieldsPerDocumentBase:
       description: |-
-        The fields that should appear on the document, expressed as an array of objects. (We're currently fixing a bug where this property only accepts a two-dimensional array. You can read about it here: <a href="/docs/openapi/form-fields-per-document" target="_blank">Using Form Fields per Document</a>.)
+        The fields that should appear on the document, expressed as an array of objects. (We're currently fixing a bug where this property only accepts a two-dimensional array. You can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)
 
         **NOTE**: Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.
 
@@ -7719,7 +7731,6 @@ components:
           enum:
             - authentication
             - delivery
-          x-beta: closed
       type: object
     SubSignatureRequestTemplateSigner:
       required:
@@ -7759,7 +7770,6 @@ components:
           enum:
             - authentication
             - delivery
-          x-beta: closed
       type: object
     SubUnclaimedDraftSigner:
       required:
@@ -8060,7 +8070,7 @@ components:
             $ref: '#/components/schemas/SubFormFieldRule'
         form_fields_per_document:
           description: |-
-            The fields that should appear on the document, expressed as an array of objects. (We're currently fixing a bug where this property only accepts a two-dimensional array. You can read about it here: <a href="/docs/openapi/form-fields-per-document" target="_blank">Using Form Fields per Document</a>.)
+            The fields that should appear on the document, expressed as an array of objects. (We're currently fixing a bug where this property only accepts a two-dimensional array. You can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)
 
             **NOTE**: Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.
 
@@ -8242,7 +8252,7 @@ components:
             $ref: '#/components/schemas/SubFormFieldRule'
         form_fields_per_document:
           description: |-
-            The fields that should appear on the document, expressed as an array of objects. (We're currently fixing a bug where this property only accepts a two-dimensional array. You can read about it here: <a href="/docs/openapi/form-fields-per-document" target="_blank">Using Form Fields per Document</a>.)
+            The fields that should appear on the document, expressed as an array of objects. (We're currently fixing a bug where this property only accepts a two-dimensional array. You can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)
 
             **NOTE**: Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.
 
@@ -8406,7 +8416,7 @@ components:
             $ref: '#/components/schemas/SubFormFieldRule'
         form_fields_per_document:
           description: |-
-            The fields that should appear on the document, expressed as an array of objects. (We're currently fixing a bug where this property only accepts a two-dimensional array. You can read about it here: <a href="/docs/openapi/form-fields-per-document" target="_blank">Using Form Fields per Document</a>.)
+            The fields that should appear on the document, expressed as an array of objects. (We're currently fixing a bug where this property only accepts a two-dimensional array. You can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)
 
             **NOTE**: Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.
 
@@ -8509,7 +8519,6 @@ components:
             ⚠️ **Note** ⚠️: Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature.
           type: boolean
           default: false
-          x-beta: closed
         expires_at:
           description: |-
             When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details.
@@ -8665,7 +8674,6 @@ components:
             ⚠️ **Note** ⚠️: Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature.
           type: boolean
           default: false
-          x-beta: closed
       type: object
     UnclaimedDraftEditAndResendRequest:
       required:
@@ -9744,6 +9752,11 @@ components:
           type: array
           items:
             $ref: '#/components/schemas/AccountResponse'
+        invited_emails:
+          description: 'A list of email addresses that have an outstanding invitation to join your Team and do not yet have a Dropbox Sign account.'
+          type: array
+          items:
+            type: string
       type: object
       x-internal: true
     TeamParentResponse:
@@ -9939,16 +9952,17 @@ components:
           items:
             $ref: '#/components/schemas/TemplateResponseDocument'
         custom_fields:
-          description: 'An array of Custom Field objects.'
+          description: 'Deprecated. Use `custom_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead.'
           type: array
           items:
-            $ref: '#/components/schemas/TemplateResponseCustomField'
+            $ref: '#/components/schemas/TemplateResponseDocumentCustomFieldBase'
           nullable: true
+          deprecated: true
         named_form_fields:
           description: 'Deprecated. Use `form_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead.'
           type: array
           items:
-            $ref: '#/components/schemas/TemplateResponseNamedFormField'
+            $ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase'
           nullable: true
           deprecated: true
         accounts:
@@ -10086,55 +10100,6 @@ components:
           type: string
       type: object
       x-internal: true
-    TemplateResponseCustomField:
-      properties:
-        name:
-          description: 'The name of the Custom Field.'
-          type: string
-        type:
-          description: 'The type of this Custom Field. Only `text` and `checkbox` are currently supported.'
-          type: string
-          enum:
-            - text
-            - checkbox
-        x:
-          description: 'The horizontal offset in pixels for this form field.'
-          type: integer
-        'y':
-          description: 'The vertical offset in pixels for this form field.'
-          type: integer
-        width:
-          description: 'The width in pixels of this form field.'
-          type: integer
-        height:
-          description: 'The height in pixels of this form field.'
-          type: integer
-        required:
-          description: 'Boolean showing whether or not this field is required.'
-          type: boolean
-        api_id:
-          description: 'The unique ID for this field.'
-          type: string
-        group:
-          description: 'The name of the group this field is in. If this field is not a group, this defaults to `null`.'
-          type: string
-          nullable: true
-        avg_text_length:
-          $ref: '#/components/schemas/TemplateResponseFieldAvgTextLength'
-        isMultiline:
-          description: 'Whether this form field is multiline text.'
-          type: boolean
-          nullable: true
-        originalFontSize:
-          description: 'Original font size used in this form field''s text.'
-          type: integer
-          nullable: true
-        fontFamily:
-          description: 'Font family used in this form field''s text.'
-          type: string
-          nullable: true
-      type: object
-      x-internal: true
     TemplateResponseDocument:
       properties:
         name:
@@ -10149,39 +10114,40 @@ components:
           items:
             $ref: '#/components/schemas/TemplateResponseDocumentFieldGroup'
         form_fields:
-          description: 'An array of Form Field objects containing the name and type of each named textbox and checkmark field.'
+          description: 'An array of Form Field objects containing the name and type of each named field.'
           type: array
           items:
-            $ref: '#/components/schemas/TemplateResponseDocumentFormField'
+            $ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase'
         custom_fields:
-          description: 'An array of Document Custom Field objects.'
+          description: 'An array of Form Field objects containing the name and type of each named field.'
           type: array
           items:
-            $ref: '#/components/schemas/TemplateResponseDocumentCustomField'
+            $ref: '#/components/schemas/TemplateResponseDocumentCustomFieldBase'
         static_fields:
-          description: |-
-            An array describing static overlay fields.
-            <b>Note</b> only available for certain subscriptions.
+          description: 'An array describing static overlay fields. **Note** only available for certain subscriptions.'
           type: array
           items:
-            $ref: '#/components/schemas/TemplateResponseDocumentStaticField'
+            $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase'
           nullable: true
       type: object
       x-internal: true
-    TemplateResponseDocumentCustomField:
+    TemplateResponseDocumentCustomFieldBase:
+      description: 'An array of Form Field objects containing the name and type of each named field.'
+      required:
+        - type
       properties:
+        api_id:
+          description: 'The unique ID for this field.'
+          type: string
         name:
           description: 'The name of the Custom Field.'
           type: string
         type:
-          description: 'The type of this Custom Field. Only `text` and `checkbox` are currently supported.'
           type: string
-          enum:
-            - text
-            - checkbox
         signer:
-          description: 'The signer of the Custom Field.'
+          description: 'The signer of the Custom Field. Can be `null` if field is a merge field (assigned to Sender).'
           type: string
+          nullable: true
         x:
           description: 'The horizontal offset in pixels for this form field.'
           type: integer
@@ -10197,49 +10163,99 @@ components:
         required:
           description: 'Boolean showing whether or not this field is required.'
           type: boolean
-        api_id:
-          description: 'The unique ID for this field.'
-          type: string
         group:
           description: 'The name of the group this field is in. If this field is not a group, this defaults to `null`.'
           type: string
           nullable: true
-        avg_text_length:
-          $ref: '#/components/schemas/TemplateResponseFieldAvgTextLength'
-        isMultiline:
-          description: 'Whether this form field is multiline text.'
-          type: boolean
-          nullable: true
-        originalFontSize:
-          description: 'Original font size used in this form field''s text.'
+        fontSize:
+          description: 'Final font size used by this form field.'
           type: integer
-          nullable: true
-        fontFamily:
-          description: 'Font family used in this form field''s text.'
-          type: string
-          nullable: true
-        named_form_fields:
-          description: 'Deprecated. Use `form_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead.'
-          type: object
-          nullable: true
-          deprecated: true
-        reusable_form_id:
-          type: string
-          nullable: true
-          deprecated: true
       type: object
+      discriminator:
+        propertyName: type
+        mapping:
+          text: '#/components/schemas/TemplateResponseDocumentCustomFieldText'
+          checkbox: '#/components/schemas/TemplateResponseDocumentCustomFieldCheckbox'
       x-internal: true
+      x-base-class: true
+    TemplateResponseDocumentCustomFieldText:
+      description: 'This class extends `TemplateResponseDocumentCustomFieldBase`'
+      type: object
+      allOf:
+        -
+          $ref: '#/components/schemas/TemplateResponseDocumentCustomFieldBase'
+        -
+          required:
+            - type
+          properties:
+            type:
+              description: |-
+                The type of this Custom Field. Only `text` and `checkbox` are currently supported.
+
+                * Text uses `TemplateResponseDocumentCustomFieldText`
+                * Checkbox uses `TemplateResponseDocumentCustomFieldCheckbox`
+              type: string
+              default: text
+            avg_text_length:
+              $ref: '#/components/schemas/TemplateResponseFieldAvgTextLength'
+            isMultiline:
+              description: 'Whether this form field is multiline text.'
+              type: boolean
+            originalFontSize:
+              description: 'Original font size used in this form field''s text.'
+              type: integer
+            fontFamily:
+              description: 'Font family used in this form field''s text.'
+              type: string
+          type: object
+    TemplateResponseDocumentCustomFieldCheckbox:
+      description: 'This class extends `TemplateResponseDocumentCustomFieldBase`'
+      type: object
+      allOf:
+        -
+          $ref: '#/components/schemas/TemplateResponseDocumentCustomFieldBase'
+        -
+          required:
+            - type
+          properties:
+            type:
+              description: |-
+                The type of this Custom Field. Only `text` and `checkbox` are currently supported.
+
+                * Text uses `TemplateResponseDocumentCustomFieldText`
+                * Checkbox uses `TemplateResponseDocumentCustomFieldCheckbox`
+              type: string
+              default: checkbox
+          type: object
     TemplateResponseDocumentFieldGroup:
       properties:
         name:
           description: 'The name of the form field group.'
           type: string
         rule:
-          description: 'The rule used to validate checkboxes in the form field group. See [checkbox field grouping](/api/reference/constants/#checkbox-field-grouping).'
+          $ref: '#/components/schemas/TemplateResponseDocumentFieldGroupRule'
+      type: object
+      x-internal: true
+    TemplateResponseDocumentFieldGroupRule:
+      description: 'The rule used to validate checkboxes in the form field group. See [checkbox field grouping](/api/reference/constants/#checkbox-field-grouping).'
+      properties:
+        requirement:
+          description: |-
+            Examples: `require_0-1` `require_1` `require_1-ormore`
+
+            - Check out the list of [acceptable `requirement` checkbox type values](/api/reference/constants/#checkbox-field-grouping).
+            - Check out the list of [acceptable `requirement` radio type fields](/api/reference/constants/#radio-field-grouping).
+            - Radio groups require **at least** two fields per group.
+          type: string
+        groupLabel:
+          description: 'Name of the group'
           type: string
       type: object
       x-internal: true
-    TemplateResponseDocumentFormField:
+    TemplateResponseDocumentFormFieldBase:
+      description: 'An array of Form Field objects containing the name and type of each named field.'
+      required:
+        - type
       properties:
         api_id:
           description: 'A unique id for the form field.'
@@ -10248,19 +10264,7 @@ components:
           description: 'The name of the form field.'
           type: string
         type:
-          description: 'The type of this form field. See [field types](/api/reference/constants/#field-types).'
           type: string
-          enum:
-            - checkbox
-            - checkbox-merge
-            - date_signed
-            - dropdown
-            - hyperlink
-            - initials
-            - signature
-            - radio
-            - text
-            - text-merge
         signer:
           description: 'The signer of the Form Field.'
           type: string
@@ -10280,36 +10284,281 @@ components:
           description: 'Boolean showing whether or not this field is required.'
           type: boolean
         group:
-          description: 'The name of the group this field is in. If this field is not a group, this defaults to `null`.'
+          description: 'The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.'
           type: string
           nullable: true
-        avg_text_length:
-          $ref: '#/components/schemas/TemplateResponseFieldAvgTextLength'
-        isMultiline:
-          description: 'Whether this form field is multiline text.'
-          type: boolean
-          nullable: true
-        originalFontSize:
-          description: 'Original font size used in this form field''s text.'
+        fontSize:
+          description: 'Final font size used by this form field.'
           type: integer
-          nullable: true
-        fontFamily:
-          description: 'Font family used in this form field''s text.'
-          type: string
-          nullable: true
       type: object
+      discriminator:
+        propertyName: type
+        mapping:
+          text: '#/components/schemas/TemplateResponseDocumentFormFieldText'
+          dropdown: '#/components/schemas/TemplateResponseDocumentFormFieldDropdown'
+          hyperlink: '#/components/schemas/TemplateResponseDocumentFormFieldHyperlink'
+          checkbox: '#/components/schemas/TemplateResponseDocumentFormFieldCheckbox'
+          radio: '#/components/schemas/TemplateResponseDocumentFormFieldRadio'
+          signature: '#/components/schemas/TemplateResponseDocumentFormFieldSignature'
+          date_signed: '#/components/schemas/TemplateResponseDocumentFormFieldDateSigned'
+          initials: '#/components/schemas/TemplateResponseDocumentFormFieldInitials'
       x-internal: true
-    TemplateResponseDocumentStaticField:
+      x-base-class: true
+    TemplateResponseDocumentFormFieldText:
+      description: 'This class extends `TemplateResponseDocumentFormFieldBase`'
+      type: object
+      allOf:
+        -
+          $ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase'
+        -
+          required:
+            - type
+          properties:
+            type:
+              description: |-
+                The type of this form field. See [field types](/api/reference/constants/#field-types).
+
+                * Text Field uses `TemplateResponseDocumentFormFieldText`
+                * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
+                * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
+                * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
+                * Radio Field uses `TemplateResponseDocumentFormFieldRadio`
+                * Signature Field uses `TemplateResponseDocumentFormFieldSignature`
+                * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
+                * Initials Field uses `TemplateResponseDocumentFormFieldInitials`
+              type: string
+              default: text
+            avg_text_length:
+              $ref: '#/components/schemas/TemplateResponseFieldAvgTextLength'
+            isMultiline:
+              description: 'Whether this form field is multiline text.'
+              type: boolean
+            originalFontSize:
+              description: 'Original font size used in this form field''s text.'
+              type: integer
+            fontFamily:
+              description: 'Font family used in this form field''s text.'
+              type: string
+            validation_type:
+              description: 'Each text field may contain a `validation_type` parameter. Check out the list of [validation types](https://faq.hellosign.com/hc/en-us/articles/217115577) to learn more about the possible values.'
+              type: string
+              enum:
+                - numbers_only
+                - letters_only
+                - phone_number
+                - bank_routing_number
+                - bank_account_number
+                - email_address
+                - zip_code
+                - social_security_number
+                - employer_identification_number
+                - custom_regex
+              nullable: true
+          type: object
+    TemplateResponseDocumentFormFieldDropdown:
+      description: 'This class extends `TemplateResponseDocumentFormFieldBase`'
+      type: object
+      allOf:
+        -
+          $ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase'
+        -
+          required:
+            - type
+          properties:
+            type:
+              description: |-
+                The type of this form field. See [field types](/api/reference/constants/#field-types).
+
+                * Text Field uses `TemplateResponseDocumentFormFieldText`
+                * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
+                * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
+                * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
+                * Radio Field uses `TemplateResponseDocumentFormFieldRadio`
+                * Signature Field uses `TemplateResponseDocumentFormFieldSignature`
+                * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
+                * Initials Field uses `TemplateResponseDocumentFormFieldInitials`
+              type: string
+              default: dropdown
+          type: object
+    TemplateResponseDocumentFormFieldHyperlink:
+      description: 'This class extends `TemplateResponseDocumentFormFieldBase`'
+      type: object
+      allOf:
+        -
+          $ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase'
+        -
+          required:
+            - type
+          properties:
+            type:
+              description: |-
+                The type of this form field. See [field types](/api/reference/constants/#field-types).
+
+                * Text Field uses `TemplateResponseDocumentFormFieldText`
+                * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
+                * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
+                * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
+                * Radio Field uses `TemplateResponseDocumentFormFieldRadio`
+                * Signature Field uses `TemplateResponseDocumentFormFieldSignature`
+                * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
+                * Initials Field uses `TemplateResponseDocumentFormFieldInitials`
+              type: string
+              default: hyperlink
+            avg_text_length:
+              $ref: '#/components/schemas/TemplateResponseFieldAvgTextLength'
+            isMultiline:
+              description: 'Whether this form field is multiline text.'
+              type: boolean
+            originalFontSize:
+              description: 'Original font size used in this form field''s text.'
+              type: integer
+            fontFamily:
+              description: 'Font family used in this form field''s text.'
+              type: string
+          type: object
+    TemplateResponseDocumentFormFieldCheckbox:
+      description: 'This class extends `TemplateResponseDocumentFormFieldBase`'
+      type: object
+      allOf:
+        -
+          $ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase'
+        -
+          required:
+            - type
+          properties:
+            type:
+              description: |-
+                The type of this form field. See [field types](/api/reference/constants/#field-types).
+
+                * Text Field uses `TemplateResponseDocumentFormFieldText`
+                * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
+                * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
+                * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
+                * Radio Field uses `TemplateResponseDocumentFormFieldRadio`
+                * Signature Field uses `TemplateResponseDocumentFormFieldSignature`
+                * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
+                * Initials Field uses `TemplateResponseDocumentFormFieldInitials`
+              type: string
+              default: checkbox
+          type: object
+    TemplateResponseDocumentFormFieldRadio:
+      description: 'This class extends `TemplateResponseDocumentFormFieldBase`'
+      type: object
+      allOf:
+        -
+          $ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase'
+        -
+          required:
+            - type
+            - group
+          properties:
+            type:
+              description: |-
+                The type of this form field. See [field types](/api/reference/constants/#field-types).
+
+                * Text Field uses `TemplateResponseDocumentFormFieldText`
+                * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
+                * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
+                * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
+                * Radio Field uses `TemplateResponseDocumentFormFieldRadio`
+                * Signature Field uses `TemplateResponseDocumentFormFieldSignature`
+                * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
+                * Initials Field uses `TemplateResponseDocumentFormFieldInitials`
+              type: string
+              default: radio
+          type: object
+    TemplateResponseDocumentFormFieldSignature:
+      description: 'This class extends `TemplateResponseDocumentFormFieldBase`'
+      type: object
+      allOf:
+        -
+          $ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase'
+        -
+          required:
+            - type
+          properties:
+            type:
+              description: |-
+                The type of this form field. See [field types](/api/reference/constants/#field-types).
+
+                * Text Field uses `TemplateResponseDocumentFormFieldText`
+                * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
+                * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
+                * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
+                * Radio Field uses `TemplateResponseDocumentFormFieldRadio`
+                * Signature Field uses `TemplateResponseDocumentFormFieldSignature`
+                * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
+                * Initials Field uses `TemplateResponseDocumentFormFieldInitials`
+              type: string
+              default: signature
+          type: object
+    TemplateResponseDocumentFormFieldDateSigned:
+      description: 'This class extends `TemplateResponseDocumentFormFieldBase`'
+      type: object
+      allOf:
+        -
+          $ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase'
+        -
+          required:
+            - type
+          properties:
+            type:
+              description: |-
+                The type of this form field. See [field types](/api/reference/constants/#field-types).
+
+                * Text Field uses `TemplateResponseDocumentFormFieldText`
+                * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
+                * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
+                * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
+                * Radio Field uses `TemplateResponseDocumentFormFieldRadio`
+                * Signature Field uses `TemplateResponseDocumentFormFieldSignature`
+                * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
+                * Initials Field uses `TemplateResponseDocumentFormFieldInitials`
+              type: string
+              default: date_signed
+          type: object
+    TemplateResponseDocumentFormFieldInitials:
+      description: 'This class extends `TemplateResponseDocumentFormFieldBase`'
+      type: object
+      allOf:
+        -
+          $ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase'
+        -
+          required:
+            - type
+          properties:
+            type:
+              description: |-
+                The type of this form field. See [field types](/api/reference/constants/#field-types).
+
+                * Text Field uses `TemplateResponseDocumentFormFieldText`
+                * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
+                * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
+                * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
+                * Radio Field uses `TemplateResponseDocumentFormFieldRadio`
+                * Signature Field uses `TemplateResponseDocumentFormFieldSignature`
+                * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
+                * Initials Field uses `TemplateResponseDocumentFormFieldInitials`
+              type: string
+              default: initials
+          type: object
+    TemplateResponseDocumentStaticFieldBase:
+      description: 'An array describing static overlay fields. **Note** only available for certain subscriptions.'
+      required:
+        - type
       properties:
+        api_id:
+          description: 'A unique id for the static field.'
+          type: string
         name:
           description: 'The name of the static field.'
           type: string
         type:
-          description: 'The type of this static field. See [field types](/api/reference/constants/#field-types).'
           type: string
         signer:
           description: 'The signer of the Static Field.'
           type: string
+          default: me_now
         x:
           description: 'The horizontal offset in pixels for this static field.'
           type: integer
@@ -10325,15 +10574,227 @@ components:
         required:
           description: 'Boolean showing whether or not this field is required.'
           type: boolean
-        api_id:
-          description: 'A unique id for the static field.'
-          type: string
         group:
           description: 'The name of the group this field is in. If this field is not a group, this defaults to `null`.'
           type: string
           nullable: true
+        fontSize:
+          description: 'Final font size used by this form field.'
+          type: integer
       type: object
+      discriminator:
+        propertyName: type
+        mapping:
+          text: '#/components/schemas/TemplateResponseDocumentStaticFieldText'
+          dropdown: '#/components/schemas/TemplateResponseDocumentStaticFieldDropdown'
+          hyperlink: '#/components/schemas/TemplateResponseDocumentStaticFieldHyperlink'
+          checkbox: '#/components/schemas/TemplateResponseDocumentStaticFieldCheckbox'
+          radio: '#/components/schemas/TemplateResponseDocumentStaticFieldRadio'
+          signature: '#/components/schemas/TemplateResponseDocumentStaticFieldSignature'
+          date_signed: '#/components/schemas/TemplateResponseDocumentStaticFieldDateSigned'
+          initials: '#/components/schemas/TemplateResponseDocumentStaticFieldInitials'
       x-internal: true
+      x-base-class: true
+    TemplateResponseDocumentStaticFieldText:
+      description: 'This class extends `TemplateResponseDocumentStaticFieldBase`'
+      type: object
+      allOf:
+        -
+          $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase'
+        -
+          required:
+            - type
+          properties:
+            type:
+              description: |-
+                The type of this static field. See [field types](/api/reference/constants/#field-types).
+
+                * Text Field uses `TemplateResponseDocumentStaticFieldText`
+                * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`
+                * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`
+                * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`
+                * Radio Field uses `TemplateResponseDocumentStaticFieldRadio`
+                * Signature Field uses `TemplateResponseDocumentStaticFieldSignature`
+                * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
+                * Initials Field uses `TemplateResponseDocumentStaticFieldInitials`
+              type: string
+              default: text
+          type: object
+    TemplateResponseDocumentStaticFieldDropdown:
+      description: 'This class extends `TemplateResponseDocumentStaticFieldBase`'
+      type: object
+      allOf:
+        -
+          $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase'
+        -
+          required:
+            - type
+          properties:
+            type:
+              description: |-
+                The type of this static field. See [field types](/api/reference/constants/#field-types).
+
+                * Text Field uses `TemplateResponseDocumentStaticFieldText`
+                * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`
+                * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`
+                * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`
+                * Radio Field uses `TemplateResponseDocumentStaticFieldRadio`
+                * Signature Field uses `TemplateResponseDocumentStaticFieldSignature`
+                * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
+                * Initials Field uses `TemplateResponseDocumentStaticFieldInitials`
+              type: string
+              default: dropdown
+          type: object
+    TemplateResponseDocumentStaticFieldHyperlink:
+      description: 'This class extends `TemplateResponseDocumentStaticFieldBase`'
+      type: object
+      allOf:
+        -
+          $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase'
+        -
+          required:
+            - type
+          properties:
+            type:
+              description: |-
+                The type of this static field. See [field types](/api/reference/constants/#field-types).
+
+                * Text Field uses `TemplateResponseDocumentStaticFieldText`
+                * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`
+                * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`
+                * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`
+                * Radio Field uses `TemplateResponseDocumentStaticFieldRadio`
+                * Signature Field uses `TemplateResponseDocumentStaticFieldSignature`
+                * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
+                * Initials Field uses `TemplateResponseDocumentStaticFieldInitials`
+              type: string
+              default: hyperlink
+          type: object
+    TemplateResponseDocumentStaticFieldCheckbox:
+      description: 'This class extends `TemplateResponseDocumentStaticFieldBase`'
+      type: object
+      allOf:
+        -
+          $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase'
+        -
+          required:
+            - type
+          properties:
+            type:
+              description: |-
+                The type of this static field. See [field types](/api/reference/constants/#field-types).
+
+                * Text Field uses `TemplateResponseDocumentStaticFieldText`
+                * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`
+                * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`
+                * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`
+                * Radio Field uses `TemplateResponseDocumentStaticFieldRadio`
+                * Signature Field uses `TemplateResponseDocumentStaticFieldSignature`
+                * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
+                * Initials Field uses `TemplateResponseDocumentStaticFieldInitials`
+              type: string
+              default: checkbox
+          type: object
+    TemplateResponseDocumentStaticFieldRadio:
+      description: 'This class extends `TemplateResponseDocumentStaticFieldBase`'
+      type: object
+      allOf:
+        -
+          $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase'
+        -
+          required:
+            - type
+          properties:
+            type:
+              description: |-
+                The type of this static field. See [field types](/api/reference/constants/#field-types).
+
+                * Text Field uses `TemplateResponseDocumentStaticFieldText`
+                * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`
+                * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`
+                * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`
+                * Radio Field uses `TemplateResponseDocumentStaticFieldRadio`
+                * Signature Field uses `TemplateResponseDocumentStaticFieldSignature`
+                * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
+                * Initials Field uses `TemplateResponseDocumentStaticFieldInitials`
+              type: string
+              default: radio
+          type: object
+    TemplateResponseDocumentStaticFieldSignature:
+      description: 'This class extends `TemplateResponseDocumentStaticFieldBase`'
+      type: object
+      allOf:
+        -
+          $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase'
+        -
+          required:
+            - type
+          properties:
+            type:
+              description: |-
+                The type of this static field. See [field types](/api/reference/constants/#field-types).
+
+                * Text Field uses `TemplateResponseDocumentStaticFieldText`
+                * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`
+                * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`
+                * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`
+                * Radio Field uses `TemplateResponseDocumentStaticFieldRadio`
+                * Signature Field uses `TemplateResponseDocumentStaticFieldSignature`
+                * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
+                * Initials Field uses `TemplateResponseDocumentStaticFieldInitials`
+              type: string
+              default: signature
+          type: object
+    TemplateResponseDocumentStaticFieldDateSigned:
+      description: 'This class extends `TemplateResponseDocumentStaticFieldBase`'
+      type: object
+      allOf:
+        -
+          $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase'
+        -
+          required:
+            - type
+          properties:
+            type:
+              description: |-
+                The type of this static field. See [field types](/api/reference/constants/#field-types).
+
+                * Text Field uses `TemplateResponseDocumentStaticFieldText`
+                * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`
+                * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`
+                * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`
+                * Radio Field uses `TemplateResponseDocumentStaticFieldRadio`
+                * Signature Field uses `TemplateResponseDocumentStaticFieldSignature`
+                * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
+                * Initials Field uses `TemplateResponseDocumentStaticFieldInitials`
+              type: string
+              default: date_signed
+          type: object
+    TemplateResponseDocumentStaticFieldInitials:
+      description: 'This class extends `TemplateResponseDocumentStaticFieldBase`'
+      type: object
+      allOf:
+        -
+          $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase'
+        -
+          required:
+            - type
+          properties:
+            type:
+              description: |-
+                The type of this static field. See [field types](/api/reference/constants/#field-types).
+
+                * Text Field uses `TemplateResponseDocumentStaticFieldText`
+                * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`
+                * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`
+                * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`
+                * Radio Field uses `TemplateResponseDocumentStaticFieldRadio`
+                * Signature Field uses `TemplateResponseDocumentStaticFieldSignature`
+                * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
+                * Initials Field uses `TemplateResponseDocumentStaticFieldInitials`
+              type: string
+              default: initials
+          type: object
     TemplateResponseFieldAvgTextLength:
       description: 'Average text length in this field.'
       properties:
@@ -10341,57 +10802,8 @@ components:
           description: 'Number of lines.'
           type: integer
         num_chars_per_line:
-          description: 'Number of character per line.'
-          type: integer
-      type: object
-      x-internal: true
-    TemplateResponseNamedFormField:
-      properties:
-        name:
-          description: 'The name of the Named Form Field.'
-          type: string
-        type:
-          description: 'The type of this Named Form Field. Only `text` and `checkbox` are currently supported.'
-          type: string
-        signer:
-          description: 'The signer of the Named Form Field.'
-          type: string
-        x:
-          description: 'The horizontal offset in pixels for this form field.'
+          description: 'Number of characters per line.'
           type: integer
-        'y':
-          description: 'The vertical offset in pixels for this form field.'
-          type: integer
-        width:
-          description: 'The width in pixels of this form field.'
-          type: integer
-        height:
-          description: 'The height in pixels of this form field.'
-          type: integer
-        required:
-          description: 'Boolean showing whether or not this field is required.'
-          type: boolean
-        api_id:
-          description: 'The unique ID for this field.'
-          type: string
-        group:
-          description: 'The name of the group this field is in. If this field is not a group, this defaults to `null`.'
-          type: string
-          nullable: true
-        avg_text_length:
-          $ref: '#/components/schemas/TemplateResponseFieldAvgTextLength'
-        isMultiline:
-          description: 'Whether this form field is multiline text.'
-          type: boolean
-          nullable: true
-        originalFontSize:
-          description: 'Original font size used in this form field''s text.'
-          type: integer
-          nullable: true
-        fontFamily:
-          description: 'Font family used in this form field''s text.'
-          type: string
-          nullable: true
       type: object
       x-internal: true
     TemplateResponseSignerRole: