dropbox-sign 1.0.1 → 1.1.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (76) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +1 -1
  3. data/README.md +26 -9
  4. data/VERSION +1 -1
  5. data/docs/BulkSendJobApi.md +5 -3
  6. data/docs/TeamResponse.md +1 -0
  7. data/docs/TemplateResponse.md +2 -2
  8. data/docs/TemplateResponseDocument.md +3 -3
  9. data/docs/{TemplateResponseCustomField.md → TemplateResponseDocumentCustomFieldBase.md} +6 -8
  10. data/docs/TemplateResponseDocumentCustomFieldCheckbox.md +10 -0
  11. data/docs/TemplateResponseDocumentCustomFieldText.md +14 -0
  12. data/docs/TemplateResponseDocumentFieldGroup.md +1 -1
  13. data/docs/TemplateResponseDocumentFieldGroupRule.md +11 -0
  14. data/docs/{TemplateResponseDocumentFormField.md → TemplateResponseDocumentFormFieldBase.md} +5 -8
  15. data/docs/TemplateResponseDocumentFormFieldCheckbox.md +10 -0
  16. data/docs/TemplateResponseDocumentFormFieldDateSigned.md +10 -0
  17. data/docs/TemplateResponseDocumentFormFieldDropdown.md +10 -0
  18. data/docs/TemplateResponseDocumentFormFieldHyperlink.md +14 -0
  19. data/docs/TemplateResponseDocumentFormFieldInitials.md +10 -0
  20. data/docs/TemplateResponseDocumentFormFieldRadio.md +10 -0
  21. data/docs/TemplateResponseDocumentFormFieldSignature.md +10 -0
  22. data/docs/TemplateResponseDocumentFormFieldText.md +15 -0
  23. data/docs/{TemplateResponseDocumentStaticField.md → TemplateResponseDocumentStaticFieldBase.md} +6 -5
  24. data/docs/TemplateResponseDocumentStaticFieldCheckbox.md +10 -0
  25. data/docs/TemplateResponseDocumentStaticFieldDateSigned.md +10 -0
  26. data/docs/TemplateResponseDocumentStaticFieldDropdown.md +10 -0
  27. data/docs/TemplateResponseDocumentStaticFieldHyperlink.md +10 -0
  28. data/docs/TemplateResponseDocumentStaticFieldInitials.md +10 -0
  29. data/docs/TemplateResponseDocumentStaticFieldRadio.md +10 -0
  30. data/docs/TemplateResponseDocumentStaticFieldSignature.md +10 -0
  31. data/docs/TemplateResponseDocumentStaticFieldText.md +10 -0
  32. data/docs/TemplateResponseFieldAvgTextLength.md +1 -1
  33. data/lib/dropbox-sign/api/bulk_send_job_api.rb +6 -0
  34. data/lib/dropbox-sign/models/team_response.rb +17 -4
  35. data/lib/dropbox-sign/models/template_response.rb +5 -5
  36. data/lib/dropbox-sign/models/template_response_document.rb +9 -9
  37. data/lib/dropbox-sign/models/{template_response_document_static_field.rb → template_response_document_custom_field_base.rb} +75 -43
  38. data/lib/dropbox-sign/models/template_response_document_custom_field_checkbox.rb +263 -0
  39. data/lib/dropbox-sign/models/template_response_document_custom_field_text.rb +306 -0
  40. data/lib/dropbox-sign/models/template_response_document_field_group.rb +2 -3
  41. data/lib/dropbox-sign/models/template_response_document_field_group_rule.rb +263 -0
  42. data/lib/dropbox-sign/models/{template_response_named_form_field.rb → template_response_document_form_field_base.rb} +82 -79
  43. data/lib/dropbox-sign/models/template_response_document_form_field_checkbox.rb +263 -0
  44. data/lib/dropbox-sign/models/template_response_document_form_field_date_signed.rb +263 -0
  45. data/lib/dropbox-sign/models/template_response_document_form_field_dropdown.rb +263 -0
  46. data/lib/dropbox-sign/models/template_response_document_form_field_hyperlink.rb +306 -0
  47. data/lib/dropbox-sign/models/template_response_document_form_field_initials.rb +263 -0
  48. data/lib/dropbox-sign/models/template_response_document_form_field_radio.rb +263 -0
  49. data/lib/dropbox-sign/models/template_response_document_form_field_signature.rb +263 -0
  50. data/lib/dropbox-sign/models/{template_response_document_form_field.rb → template_response_document_form_field_text.rb} +53 -132
  51. data/lib/dropbox-sign/models/{template_response_custom_field.rb → template_response_document_static_field_base.rb} +94 -112
  52. data/lib/dropbox-sign/models/template_response_document_static_field_checkbox.rb +263 -0
  53. data/lib/dropbox-sign/models/template_response_document_static_field_date_signed.rb +263 -0
  54. data/lib/dropbox-sign/models/template_response_document_static_field_dropdown.rb +263 -0
  55. data/lib/dropbox-sign/models/template_response_document_static_field_hyperlink.rb +263 -0
  56. data/lib/dropbox-sign/models/template_response_document_static_field_initials.rb +263 -0
  57. data/lib/dropbox-sign/models/template_response_document_static_field_radio.rb +263 -0
  58. data/lib/dropbox-sign/models/template_response_document_static_field_signature.rb +263 -0
  59. data/lib/dropbox-sign/models/template_response_document_static_field_text.rb +263 -0
  60. data/lib/dropbox-sign/models/template_response_field_avg_text_length.rb +1 -1
  61. data/lib/dropbox-sign/version.rb +1 -1
  62. data/lib/dropbox-sign.rb +22 -5
  63. data/openapi-config.yaml +1 -1
  64. data/openapi-sdk.yaml +592 -176
  65. data/test_fixtures/AccountCreateResponse.json +1 -0
  66. data/test_fixtures/ApiAppGetResponse.json +1 -0
  67. data/test_fixtures/ApiAppListResponse.json +1 -0
  68. data/test_fixtures/BulkSendJobGetResponse.json +8 -3
  69. data/test_fixtures/SignatureRequestGetResponse.json +65 -65
  70. data/test_fixtures/SignatureRequestListResponse.json +11 -4
  71. data/test_fixtures/TemplateGetResponse.json +1064 -41
  72. data/test_fixtures/TemplateListResponse.json +513 -44
  73. metadata +52 -18
  74. data/docs/TemplateResponseDocumentCustomField.md +0 -25
  75. data/docs/TemplateResponseNamedFormField.md +0 -23
  76. data/lib/dropbox-sign/models/template_response_document_custom_field.rb +0 -454
data/openapi-sdk.yaml CHANGED
@@ -982,6 +982,20 @@ paths:
982
982
  schema:
983
983
  type: string
984
984
  example: 6e683bc0369ba3d5b6f43c2c22a8031dbf6bd174
985
+ -
986
+ name: page
987
+ in: query
988
+ description: 'Which page number of the BulkSendJob list to return. Defaults to `1`.'
989
+ schema:
990
+ type: integer
991
+ default: 1
992
+ -
993
+ name: page_size
994
+ in: query
995
+ description: 'Number of objects to be returned per page. Must be between `1` and `100`. Default is 20.'
996
+ schema:
997
+ type: integer
998
+ default: 20
985
999
  responses:
986
1000
  200:
987
1001
  description: 'successful operation'
@@ -7717,7 +7731,6 @@ components:
7717
7731
  enum:
7718
7732
  - authentication
7719
7733
  - delivery
7720
- x-beta: closed
7721
7734
  type: object
7722
7735
  SubSignatureRequestTemplateSigner:
7723
7736
  required:
@@ -7757,7 +7770,6 @@ components:
7757
7770
  enum:
7758
7771
  - authentication
7759
7772
  - delivery
7760
- x-beta: closed
7761
7773
  type: object
7762
7774
  SubUnclaimedDraftSigner:
7763
7775
  required:
@@ -9740,6 +9752,11 @@ components:
9740
9752
  type: array
9741
9753
  items:
9742
9754
  $ref: '#/components/schemas/AccountResponse'
9755
+ invited_emails:
9756
+ description: 'A list of email addresses that have an outstanding invitation to join your Team and do not yet have a Dropbox Sign account.'
9757
+ type: array
9758
+ items:
9759
+ type: string
9743
9760
  type: object
9744
9761
  x-internal: true
9745
9762
  TeamParentResponse:
@@ -9935,16 +9952,17 @@ components:
9935
9952
  items:
9936
9953
  $ref: '#/components/schemas/TemplateResponseDocument'
9937
9954
  custom_fields:
9938
- description: 'An array of Custom Field objects.'
9955
+ 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.'
9939
9956
  type: array
9940
9957
  items:
9941
- $ref: '#/components/schemas/TemplateResponseCustomField'
9958
+ $ref: '#/components/schemas/TemplateResponseDocumentCustomFieldBase'
9942
9959
  nullable: true
9960
+ deprecated: true
9943
9961
  named_form_fields:
9944
9962
  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.'
9945
9963
  type: array
9946
9964
  items:
9947
- $ref: '#/components/schemas/TemplateResponseNamedFormField'
9965
+ $ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase'
9948
9966
  nullable: true
9949
9967
  deprecated: true
9950
9968
  accounts:
@@ -10082,55 +10100,6 @@ components:
10082
10100
  type: string
10083
10101
  type: object
10084
10102
  x-internal: true
10085
- TemplateResponseCustomField:
10086
- properties:
10087
- name:
10088
- description: 'The name of the Custom Field.'
10089
- type: string
10090
- type:
10091
- description: 'The type of this Custom Field. Only `text` and `checkbox` are currently supported.'
10092
- type: string
10093
- enum:
10094
- - text
10095
- - checkbox
10096
- x:
10097
- description: 'The horizontal offset in pixels for this form field.'
10098
- type: integer
10099
- 'y':
10100
- description: 'The vertical offset in pixels for this form field.'
10101
- type: integer
10102
- width:
10103
- description: 'The width in pixels of this form field.'
10104
- type: integer
10105
- height:
10106
- description: 'The height in pixels of this form field.'
10107
- type: integer
10108
- required:
10109
- description: 'Boolean showing whether or not this field is required.'
10110
- type: boolean
10111
- api_id:
10112
- description: 'The unique ID for this field.'
10113
- type: string
10114
- group:
10115
- description: 'The name of the group this field is in. If this field is not a group, this defaults to `null`.'
10116
- type: string
10117
- nullable: true
10118
- avg_text_length:
10119
- $ref: '#/components/schemas/TemplateResponseFieldAvgTextLength'
10120
- isMultiline:
10121
- description: 'Whether this form field is multiline text.'
10122
- type: boolean
10123
- nullable: true
10124
- originalFontSize:
10125
- description: 'Original font size used in this form field''s text.'
10126
- type: integer
10127
- nullable: true
10128
- fontFamily:
10129
- description: 'Font family used in this form field''s text.'
10130
- type: string
10131
- nullable: true
10132
- type: object
10133
- x-internal: true
10134
10103
  TemplateResponseDocument:
10135
10104
  properties:
10136
10105
  name:
@@ -10145,39 +10114,40 @@ components:
10145
10114
  items:
10146
10115
  $ref: '#/components/schemas/TemplateResponseDocumentFieldGroup'
10147
10116
  form_fields:
10148
- description: 'An array of Form Field objects containing the name and type of each named textbox and checkmark field.'
10117
+ description: 'An array of Form Field objects containing the name and type of each named field.'
10149
10118
  type: array
10150
10119
  items:
10151
- $ref: '#/components/schemas/TemplateResponseDocumentFormField'
10120
+ $ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase'
10152
10121
  custom_fields:
10153
- description: 'An array of Document Custom Field objects.'
10122
+ description: 'An array of Form Field objects containing the name and type of each named field.'
10154
10123
  type: array
10155
10124
  items:
10156
- $ref: '#/components/schemas/TemplateResponseDocumentCustomField'
10125
+ $ref: '#/components/schemas/TemplateResponseDocumentCustomFieldBase'
10157
10126
  static_fields:
10158
- description: |-
10159
- An array describing static overlay fields.
10160
- <b>Note</b> only available for certain subscriptions.
10127
+ description: 'An array describing static overlay fields. **Note** only available for certain subscriptions.'
10161
10128
  type: array
10162
10129
  items:
10163
- $ref: '#/components/schemas/TemplateResponseDocumentStaticField'
10130
+ $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase'
10164
10131
  nullable: true
10165
10132
  type: object
10166
10133
  x-internal: true
10167
- TemplateResponseDocumentCustomField:
10134
+ TemplateResponseDocumentCustomFieldBase:
10135
+ description: 'An array of Form Field objects containing the name and type of each named field.'
10136
+ required:
10137
+ - type
10168
10138
  properties:
10139
+ api_id:
10140
+ description: 'The unique ID for this field.'
10141
+ type: string
10169
10142
  name:
10170
10143
  description: 'The name of the Custom Field.'
10171
10144
  type: string
10172
10145
  type:
10173
- description: 'The type of this Custom Field. Only `text` and `checkbox` are currently supported.'
10174
10146
  type: string
10175
- enum:
10176
- - text
10177
- - checkbox
10178
10147
  signer:
10179
- description: 'The signer of the Custom Field.'
10148
+ description: 'The signer of the Custom Field. Can be `null` if field is a merge field (assigned to Sender).'
10180
10149
  type: string
10150
+ nullable: true
10181
10151
  x:
10182
10152
  description: 'The horizontal offset in pixels for this form field.'
10183
10153
  type: integer
@@ -10193,49 +10163,99 @@ components:
10193
10163
  required:
10194
10164
  description: 'Boolean showing whether or not this field is required.'
10195
10165
  type: boolean
10196
- api_id:
10197
- description: 'The unique ID for this field.'
10198
- type: string
10199
10166
  group:
10200
10167
  description: 'The name of the group this field is in. If this field is not a group, this defaults to `null`.'
10201
10168
  type: string
10202
10169
  nullable: true
10203
- avg_text_length:
10204
- $ref: '#/components/schemas/TemplateResponseFieldAvgTextLength'
10205
- isMultiline:
10206
- description: 'Whether this form field is multiline text.'
10207
- type: boolean
10208
- nullable: true
10209
- originalFontSize:
10210
- description: 'Original font size used in this form field''s text.'
10170
+ fontSize:
10171
+ description: 'Final font size used by this form field.'
10211
10172
  type: integer
10212
- nullable: true
10213
- fontFamily:
10214
- description: 'Font family used in this form field''s text.'
10215
- type: string
10216
- nullable: true
10217
- named_form_fields:
10218
- 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.'
10219
- type: object
10220
- nullable: true
10221
- deprecated: true
10222
- reusable_form_id:
10223
- type: string
10224
- nullable: true
10225
- deprecated: true
10226
10173
  type: object
10174
+ discriminator:
10175
+ propertyName: type
10176
+ mapping:
10177
+ text: '#/components/schemas/TemplateResponseDocumentCustomFieldText'
10178
+ checkbox: '#/components/schemas/TemplateResponseDocumentCustomFieldCheckbox'
10227
10179
  x-internal: true
10180
+ x-base-class: true
10181
+ TemplateResponseDocumentCustomFieldText:
10182
+ description: 'This class extends `TemplateResponseDocumentCustomFieldBase`'
10183
+ type: object
10184
+ allOf:
10185
+ -
10186
+ $ref: '#/components/schemas/TemplateResponseDocumentCustomFieldBase'
10187
+ -
10188
+ required:
10189
+ - type
10190
+ properties:
10191
+ type:
10192
+ description: |-
10193
+ The type of this Custom Field. Only `text` and `checkbox` are currently supported.
10194
+
10195
+ * Text uses `TemplateResponseDocumentCustomFieldText`
10196
+ * Checkbox uses `TemplateResponseDocumentCustomFieldCheckbox`
10197
+ type: string
10198
+ default: text
10199
+ avg_text_length:
10200
+ $ref: '#/components/schemas/TemplateResponseFieldAvgTextLength'
10201
+ isMultiline:
10202
+ description: 'Whether this form field is multiline text.'
10203
+ type: boolean
10204
+ originalFontSize:
10205
+ description: 'Original font size used in this form field''s text.'
10206
+ type: integer
10207
+ fontFamily:
10208
+ description: 'Font family used in this form field''s text.'
10209
+ type: string
10210
+ type: object
10211
+ TemplateResponseDocumentCustomFieldCheckbox:
10212
+ description: 'This class extends `TemplateResponseDocumentCustomFieldBase`'
10213
+ type: object
10214
+ allOf:
10215
+ -
10216
+ $ref: '#/components/schemas/TemplateResponseDocumentCustomFieldBase'
10217
+ -
10218
+ required:
10219
+ - type
10220
+ properties:
10221
+ type:
10222
+ description: |-
10223
+ The type of this Custom Field. Only `text` and `checkbox` are currently supported.
10224
+
10225
+ * Text uses `TemplateResponseDocumentCustomFieldText`
10226
+ * Checkbox uses `TemplateResponseDocumentCustomFieldCheckbox`
10227
+ type: string
10228
+ default: checkbox
10229
+ type: object
10228
10230
  TemplateResponseDocumentFieldGroup:
10229
10231
  properties:
10230
10232
  name:
10231
10233
  description: 'The name of the form field group.'
10232
10234
  type: string
10233
10235
  rule:
10234
- description: 'The rule used to validate checkboxes in the form field group. See [checkbox field grouping](/api/reference/constants/#checkbox-field-grouping).'
10236
+ $ref: '#/components/schemas/TemplateResponseDocumentFieldGroupRule'
10237
+ type: object
10238
+ x-internal: true
10239
+ TemplateResponseDocumentFieldGroupRule:
10240
+ description: 'The rule used to validate checkboxes in the form field group. See [checkbox field grouping](/api/reference/constants/#checkbox-field-grouping).'
10241
+ properties:
10242
+ requirement:
10243
+ description: |-
10244
+ Examples: `require_0-1` `require_1` `require_1-ormore`
10245
+
10246
+ - Check out the list of [acceptable `requirement` checkbox type values](/api/reference/constants/#checkbox-field-grouping).
10247
+ - Check out the list of [acceptable `requirement` radio type fields](/api/reference/constants/#radio-field-grouping).
10248
+ - Radio groups require **at least** two fields per group.
10249
+ type: string
10250
+ groupLabel:
10251
+ description: 'Name of the group'
10235
10252
  type: string
10236
10253
  type: object
10237
10254
  x-internal: true
10238
- TemplateResponseDocumentFormField:
10255
+ TemplateResponseDocumentFormFieldBase:
10256
+ description: 'An array of Form Field objects containing the name and type of each named field.'
10257
+ required:
10258
+ - type
10239
10259
  properties:
10240
10260
  api_id:
10241
10261
  description: 'A unique id for the form field.'
@@ -10244,19 +10264,7 @@ components:
10244
10264
  description: 'The name of the form field.'
10245
10265
  type: string
10246
10266
  type:
10247
- description: 'The type of this form field. See [field types](/api/reference/constants/#field-types).'
10248
10267
  type: string
10249
- enum:
10250
- - checkbox
10251
- - checkbox-merge
10252
- - date_signed
10253
- - dropdown
10254
- - hyperlink
10255
- - initials
10256
- - signature
10257
- - radio
10258
- - text
10259
- - text-merge
10260
10268
  signer:
10261
10269
  description: 'The signer of the Form Field.'
10262
10270
  type: string
@@ -10276,36 +10284,281 @@ components:
10276
10284
  description: 'Boolean showing whether or not this field is required.'
10277
10285
  type: boolean
10278
10286
  group:
10279
- description: 'The name of the group this field is in. If this field is not a group, this defaults to `null`.'
10287
+ 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.'
10280
10288
  type: string
10281
10289
  nullable: true
10282
- avg_text_length:
10283
- $ref: '#/components/schemas/TemplateResponseFieldAvgTextLength'
10284
- isMultiline:
10285
- description: 'Whether this form field is multiline text.'
10286
- type: boolean
10287
- nullable: true
10288
- originalFontSize:
10289
- description: 'Original font size used in this form field''s text.'
10290
+ fontSize:
10291
+ description: 'Final font size used by this form field.'
10290
10292
  type: integer
10291
- nullable: true
10292
- fontFamily:
10293
- description: 'Font family used in this form field''s text.'
10294
- type: string
10295
- nullable: true
10296
10293
  type: object
10294
+ discriminator:
10295
+ propertyName: type
10296
+ mapping:
10297
+ text: '#/components/schemas/TemplateResponseDocumentFormFieldText'
10298
+ dropdown: '#/components/schemas/TemplateResponseDocumentFormFieldDropdown'
10299
+ hyperlink: '#/components/schemas/TemplateResponseDocumentFormFieldHyperlink'
10300
+ checkbox: '#/components/schemas/TemplateResponseDocumentFormFieldCheckbox'
10301
+ radio: '#/components/schemas/TemplateResponseDocumentFormFieldRadio'
10302
+ signature: '#/components/schemas/TemplateResponseDocumentFormFieldSignature'
10303
+ date_signed: '#/components/schemas/TemplateResponseDocumentFormFieldDateSigned'
10304
+ initials: '#/components/schemas/TemplateResponseDocumentFormFieldInitials'
10297
10305
  x-internal: true
10298
- TemplateResponseDocumentStaticField:
10306
+ x-base-class: true
10307
+ TemplateResponseDocumentFormFieldText:
10308
+ description: 'This class extends `TemplateResponseDocumentFormFieldBase`'
10309
+ type: object
10310
+ allOf:
10311
+ -
10312
+ $ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase'
10313
+ -
10314
+ required:
10315
+ - type
10316
+ properties:
10317
+ type:
10318
+ description: |-
10319
+ The type of this form field. See [field types](/api/reference/constants/#field-types).
10320
+
10321
+ * Text Field uses `TemplateResponseDocumentFormFieldText`
10322
+ * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
10323
+ * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
10324
+ * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
10325
+ * Radio Field uses `TemplateResponseDocumentFormFieldRadio`
10326
+ * Signature Field uses `TemplateResponseDocumentFormFieldSignature`
10327
+ * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
10328
+ * Initials Field uses `TemplateResponseDocumentFormFieldInitials`
10329
+ type: string
10330
+ default: text
10331
+ avg_text_length:
10332
+ $ref: '#/components/schemas/TemplateResponseFieldAvgTextLength'
10333
+ isMultiline:
10334
+ description: 'Whether this form field is multiline text.'
10335
+ type: boolean
10336
+ originalFontSize:
10337
+ description: 'Original font size used in this form field''s text.'
10338
+ type: integer
10339
+ fontFamily:
10340
+ description: 'Font family used in this form field''s text.'
10341
+ type: string
10342
+ validation_type:
10343
+ 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.'
10344
+ type: string
10345
+ enum:
10346
+ - numbers_only
10347
+ - letters_only
10348
+ - phone_number
10349
+ - bank_routing_number
10350
+ - bank_account_number
10351
+ - email_address
10352
+ - zip_code
10353
+ - social_security_number
10354
+ - employer_identification_number
10355
+ - custom_regex
10356
+ nullable: true
10357
+ type: object
10358
+ TemplateResponseDocumentFormFieldDropdown:
10359
+ description: 'This class extends `TemplateResponseDocumentFormFieldBase`'
10360
+ type: object
10361
+ allOf:
10362
+ -
10363
+ $ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase'
10364
+ -
10365
+ required:
10366
+ - type
10367
+ properties:
10368
+ type:
10369
+ description: |-
10370
+ The type of this form field. See [field types](/api/reference/constants/#field-types).
10371
+
10372
+ * Text Field uses `TemplateResponseDocumentFormFieldText`
10373
+ * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
10374
+ * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
10375
+ * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
10376
+ * Radio Field uses `TemplateResponseDocumentFormFieldRadio`
10377
+ * Signature Field uses `TemplateResponseDocumentFormFieldSignature`
10378
+ * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
10379
+ * Initials Field uses `TemplateResponseDocumentFormFieldInitials`
10380
+ type: string
10381
+ default: dropdown
10382
+ type: object
10383
+ TemplateResponseDocumentFormFieldHyperlink:
10384
+ description: 'This class extends `TemplateResponseDocumentFormFieldBase`'
10385
+ type: object
10386
+ allOf:
10387
+ -
10388
+ $ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase'
10389
+ -
10390
+ required:
10391
+ - type
10392
+ properties:
10393
+ type:
10394
+ description: |-
10395
+ The type of this form field. See [field types](/api/reference/constants/#field-types).
10396
+
10397
+ * Text Field uses `TemplateResponseDocumentFormFieldText`
10398
+ * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
10399
+ * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
10400
+ * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
10401
+ * Radio Field uses `TemplateResponseDocumentFormFieldRadio`
10402
+ * Signature Field uses `TemplateResponseDocumentFormFieldSignature`
10403
+ * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
10404
+ * Initials Field uses `TemplateResponseDocumentFormFieldInitials`
10405
+ type: string
10406
+ default: hyperlink
10407
+ avg_text_length:
10408
+ $ref: '#/components/schemas/TemplateResponseFieldAvgTextLength'
10409
+ isMultiline:
10410
+ description: 'Whether this form field is multiline text.'
10411
+ type: boolean
10412
+ originalFontSize:
10413
+ description: 'Original font size used in this form field''s text.'
10414
+ type: integer
10415
+ fontFamily:
10416
+ description: 'Font family used in this form field''s text.'
10417
+ type: string
10418
+ type: object
10419
+ TemplateResponseDocumentFormFieldCheckbox:
10420
+ description: 'This class extends `TemplateResponseDocumentFormFieldBase`'
10421
+ type: object
10422
+ allOf:
10423
+ -
10424
+ $ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase'
10425
+ -
10426
+ required:
10427
+ - type
10428
+ properties:
10429
+ type:
10430
+ description: |-
10431
+ The type of this form field. See [field types](/api/reference/constants/#field-types).
10432
+
10433
+ * Text Field uses `TemplateResponseDocumentFormFieldText`
10434
+ * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
10435
+ * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
10436
+ * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
10437
+ * Radio Field uses `TemplateResponseDocumentFormFieldRadio`
10438
+ * Signature Field uses `TemplateResponseDocumentFormFieldSignature`
10439
+ * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
10440
+ * Initials Field uses `TemplateResponseDocumentFormFieldInitials`
10441
+ type: string
10442
+ default: checkbox
10443
+ type: object
10444
+ TemplateResponseDocumentFormFieldRadio:
10445
+ description: 'This class extends `TemplateResponseDocumentFormFieldBase`'
10446
+ type: object
10447
+ allOf:
10448
+ -
10449
+ $ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase'
10450
+ -
10451
+ required:
10452
+ - type
10453
+ - group
10454
+ properties:
10455
+ type:
10456
+ description: |-
10457
+ The type of this form field. See [field types](/api/reference/constants/#field-types).
10458
+
10459
+ * Text Field uses `TemplateResponseDocumentFormFieldText`
10460
+ * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
10461
+ * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
10462
+ * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
10463
+ * Radio Field uses `TemplateResponseDocumentFormFieldRadio`
10464
+ * Signature Field uses `TemplateResponseDocumentFormFieldSignature`
10465
+ * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
10466
+ * Initials Field uses `TemplateResponseDocumentFormFieldInitials`
10467
+ type: string
10468
+ default: radio
10469
+ type: object
10470
+ TemplateResponseDocumentFormFieldSignature:
10471
+ description: 'This class extends `TemplateResponseDocumentFormFieldBase`'
10472
+ type: object
10473
+ allOf:
10474
+ -
10475
+ $ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase'
10476
+ -
10477
+ required:
10478
+ - type
10479
+ properties:
10480
+ type:
10481
+ description: |-
10482
+ The type of this form field. See [field types](/api/reference/constants/#field-types).
10483
+
10484
+ * Text Field uses `TemplateResponseDocumentFormFieldText`
10485
+ * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
10486
+ * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
10487
+ * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
10488
+ * Radio Field uses `TemplateResponseDocumentFormFieldRadio`
10489
+ * Signature Field uses `TemplateResponseDocumentFormFieldSignature`
10490
+ * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
10491
+ * Initials Field uses `TemplateResponseDocumentFormFieldInitials`
10492
+ type: string
10493
+ default: signature
10494
+ type: object
10495
+ TemplateResponseDocumentFormFieldDateSigned:
10496
+ description: 'This class extends `TemplateResponseDocumentFormFieldBase`'
10497
+ type: object
10498
+ allOf:
10499
+ -
10500
+ $ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase'
10501
+ -
10502
+ required:
10503
+ - type
10504
+ properties:
10505
+ type:
10506
+ description: |-
10507
+ The type of this form field. See [field types](/api/reference/constants/#field-types).
10508
+
10509
+ * Text Field uses `TemplateResponseDocumentFormFieldText`
10510
+ * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
10511
+ * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
10512
+ * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
10513
+ * Radio Field uses `TemplateResponseDocumentFormFieldRadio`
10514
+ * Signature Field uses `TemplateResponseDocumentFormFieldSignature`
10515
+ * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
10516
+ * Initials Field uses `TemplateResponseDocumentFormFieldInitials`
10517
+ type: string
10518
+ default: date_signed
10519
+ type: object
10520
+ TemplateResponseDocumentFormFieldInitials:
10521
+ description: 'This class extends `TemplateResponseDocumentFormFieldBase`'
10522
+ type: object
10523
+ allOf:
10524
+ -
10525
+ $ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase'
10526
+ -
10527
+ required:
10528
+ - type
10529
+ properties:
10530
+ type:
10531
+ description: |-
10532
+ The type of this form field. See [field types](/api/reference/constants/#field-types).
10533
+
10534
+ * Text Field uses `TemplateResponseDocumentFormFieldText`
10535
+ * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
10536
+ * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
10537
+ * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
10538
+ * Radio Field uses `TemplateResponseDocumentFormFieldRadio`
10539
+ * Signature Field uses `TemplateResponseDocumentFormFieldSignature`
10540
+ * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
10541
+ * Initials Field uses `TemplateResponseDocumentFormFieldInitials`
10542
+ type: string
10543
+ default: initials
10544
+ type: object
10545
+ TemplateResponseDocumentStaticFieldBase:
10546
+ description: 'An array describing static overlay fields. **Note** only available for certain subscriptions.'
10547
+ required:
10548
+ - type
10299
10549
  properties:
10550
+ api_id:
10551
+ description: 'A unique id for the static field.'
10552
+ type: string
10300
10553
  name:
10301
10554
  description: 'The name of the static field.'
10302
10555
  type: string
10303
10556
  type:
10304
- description: 'The type of this static field. See [field types](/api/reference/constants/#field-types).'
10305
10557
  type: string
10306
10558
  signer:
10307
10559
  description: 'The signer of the Static Field.'
10308
10560
  type: string
10561
+ default: me_now
10309
10562
  x:
10310
10563
  description: 'The horizontal offset in pixels for this static field.'
10311
10564
  type: integer
@@ -10321,15 +10574,227 @@ components:
10321
10574
  required:
10322
10575
  description: 'Boolean showing whether or not this field is required.'
10323
10576
  type: boolean
10324
- api_id:
10325
- description: 'A unique id for the static field.'
10326
- type: string
10327
10577
  group:
10328
10578
  description: 'The name of the group this field is in. If this field is not a group, this defaults to `null`.'
10329
10579
  type: string
10330
10580
  nullable: true
10581
+ fontSize:
10582
+ description: 'Final font size used by this form field.'
10583
+ type: integer
10331
10584
  type: object
10585
+ discriminator:
10586
+ propertyName: type
10587
+ mapping:
10588
+ text: '#/components/schemas/TemplateResponseDocumentStaticFieldText'
10589
+ dropdown: '#/components/schemas/TemplateResponseDocumentStaticFieldDropdown'
10590
+ hyperlink: '#/components/schemas/TemplateResponseDocumentStaticFieldHyperlink'
10591
+ checkbox: '#/components/schemas/TemplateResponseDocumentStaticFieldCheckbox'
10592
+ radio: '#/components/schemas/TemplateResponseDocumentStaticFieldRadio'
10593
+ signature: '#/components/schemas/TemplateResponseDocumentStaticFieldSignature'
10594
+ date_signed: '#/components/schemas/TemplateResponseDocumentStaticFieldDateSigned'
10595
+ initials: '#/components/schemas/TemplateResponseDocumentStaticFieldInitials'
10332
10596
  x-internal: true
10597
+ x-base-class: true
10598
+ TemplateResponseDocumentStaticFieldText:
10599
+ description: 'This class extends `TemplateResponseDocumentStaticFieldBase`'
10600
+ type: object
10601
+ allOf:
10602
+ -
10603
+ $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase'
10604
+ -
10605
+ required:
10606
+ - type
10607
+ properties:
10608
+ type:
10609
+ description: |-
10610
+ The type of this static field. See [field types](/api/reference/constants/#field-types).
10611
+
10612
+ * Text Field uses `TemplateResponseDocumentStaticFieldText`
10613
+ * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`
10614
+ * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`
10615
+ * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`
10616
+ * Radio Field uses `TemplateResponseDocumentStaticFieldRadio`
10617
+ * Signature Field uses `TemplateResponseDocumentStaticFieldSignature`
10618
+ * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
10619
+ * Initials Field uses `TemplateResponseDocumentStaticFieldInitials`
10620
+ type: string
10621
+ default: text
10622
+ type: object
10623
+ TemplateResponseDocumentStaticFieldDropdown:
10624
+ description: 'This class extends `TemplateResponseDocumentStaticFieldBase`'
10625
+ type: object
10626
+ allOf:
10627
+ -
10628
+ $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase'
10629
+ -
10630
+ required:
10631
+ - type
10632
+ properties:
10633
+ type:
10634
+ description: |-
10635
+ The type of this static field. See [field types](/api/reference/constants/#field-types).
10636
+
10637
+ * Text Field uses `TemplateResponseDocumentStaticFieldText`
10638
+ * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`
10639
+ * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`
10640
+ * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`
10641
+ * Radio Field uses `TemplateResponseDocumentStaticFieldRadio`
10642
+ * Signature Field uses `TemplateResponseDocumentStaticFieldSignature`
10643
+ * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
10644
+ * Initials Field uses `TemplateResponseDocumentStaticFieldInitials`
10645
+ type: string
10646
+ default: dropdown
10647
+ type: object
10648
+ TemplateResponseDocumentStaticFieldHyperlink:
10649
+ description: 'This class extends `TemplateResponseDocumentStaticFieldBase`'
10650
+ type: object
10651
+ allOf:
10652
+ -
10653
+ $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase'
10654
+ -
10655
+ required:
10656
+ - type
10657
+ properties:
10658
+ type:
10659
+ description: |-
10660
+ The type of this static field. See [field types](/api/reference/constants/#field-types).
10661
+
10662
+ * Text Field uses `TemplateResponseDocumentStaticFieldText`
10663
+ * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`
10664
+ * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`
10665
+ * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`
10666
+ * Radio Field uses `TemplateResponseDocumentStaticFieldRadio`
10667
+ * Signature Field uses `TemplateResponseDocumentStaticFieldSignature`
10668
+ * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
10669
+ * Initials Field uses `TemplateResponseDocumentStaticFieldInitials`
10670
+ type: string
10671
+ default: hyperlink
10672
+ type: object
10673
+ TemplateResponseDocumentStaticFieldCheckbox:
10674
+ description: 'This class extends `TemplateResponseDocumentStaticFieldBase`'
10675
+ type: object
10676
+ allOf:
10677
+ -
10678
+ $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase'
10679
+ -
10680
+ required:
10681
+ - type
10682
+ properties:
10683
+ type:
10684
+ description: |-
10685
+ The type of this static field. See [field types](/api/reference/constants/#field-types).
10686
+
10687
+ * Text Field uses `TemplateResponseDocumentStaticFieldText`
10688
+ * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`
10689
+ * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`
10690
+ * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`
10691
+ * Radio Field uses `TemplateResponseDocumentStaticFieldRadio`
10692
+ * Signature Field uses `TemplateResponseDocumentStaticFieldSignature`
10693
+ * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
10694
+ * Initials Field uses `TemplateResponseDocumentStaticFieldInitials`
10695
+ type: string
10696
+ default: checkbox
10697
+ type: object
10698
+ TemplateResponseDocumentStaticFieldRadio:
10699
+ description: 'This class extends `TemplateResponseDocumentStaticFieldBase`'
10700
+ type: object
10701
+ allOf:
10702
+ -
10703
+ $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase'
10704
+ -
10705
+ required:
10706
+ - type
10707
+ properties:
10708
+ type:
10709
+ description: |-
10710
+ The type of this static field. See [field types](/api/reference/constants/#field-types).
10711
+
10712
+ * Text Field uses `TemplateResponseDocumentStaticFieldText`
10713
+ * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`
10714
+ * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`
10715
+ * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`
10716
+ * Radio Field uses `TemplateResponseDocumentStaticFieldRadio`
10717
+ * Signature Field uses `TemplateResponseDocumentStaticFieldSignature`
10718
+ * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
10719
+ * Initials Field uses `TemplateResponseDocumentStaticFieldInitials`
10720
+ type: string
10721
+ default: radio
10722
+ type: object
10723
+ TemplateResponseDocumentStaticFieldSignature:
10724
+ description: 'This class extends `TemplateResponseDocumentStaticFieldBase`'
10725
+ type: object
10726
+ allOf:
10727
+ -
10728
+ $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase'
10729
+ -
10730
+ required:
10731
+ - type
10732
+ properties:
10733
+ type:
10734
+ description: |-
10735
+ The type of this static field. See [field types](/api/reference/constants/#field-types).
10736
+
10737
+ * Text Field uses `TemplateResponseDocumentStaticFieldText`
10738
+ * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`
10739
+ * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`
10740
+ * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`
10741
+ * Radio Field uses `TemplateResponseDocumentStaticFieldRadio`
10742
+ * Signature Field uses `TemplateResponseDocumentStaticFieldSignature`
10743
+ * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
10744
+ * Initials Field uses `TemplateResponseDocumentStaticFieldInitials`
10745
+ type: string
10746
+ default: signature
10747
+ type: object
10748
+ TemplateResponseDocumentStaticFieldDateSigned:
10749
+ description: 'This class extends `TemplateResponseDocumentStaticFieldBase`'
10750
+ type: object
10751
+ allOf:
10752
+ -
10753
+ $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase'
10754
+ -
10755
+ required:
10756
+ - type
10757
+ properties:
10758
+ type:
10759
+ description: |-
10760
+ The type of this static field. See [field types](/api/reference/constants/#field-types).
10761
+
10762
+ * Text Field uses `TemplateResponseDocumentStaticFieldText`
10763
+ * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`
10764
+ * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`
10765
+ * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`
10766
+ * Radio Field uses `TemplateResponseDocumentStaticFieldRadio`
10767
+ * Signature Field uses `TemplateResponseDocumentStaticFieldSignature`
10768
+ * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
10769
+ * Initials Field uses `TemplateResponseDocumentStaticFieldInitials`
10770
+ type: string
10771
+ default: date_signed
10772
+ type: object
10773
+ TemplateResponseDocumentStaticFieldInitials:
10774
+ description: 'This class extends `TemplateResponseDocumentStaticFieldBase`'
10775
+ type: object
10776
+ allOf:
10777
+ -
10778
+ $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase'
10779
+ -
10780
+ required:
10781
+ - type
10782
+ properties:
10783
+ type:
10784
+ description: |-
10785
+ The type of this static field. See [field types](/api/reference/constants/#field-types).
10786
+
10787
+ * Text Field uses `TemplateResponseDocumentStaticFieldText`
10788
+ * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`
10789
+ * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`
10790
+ * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`
10791
+ * Radio Field uses `TemplateResponseDocumentStaticFieldRadio`
10792
+ * Signature Field uses `TemplateResponseDocumentStaticFieldSignature`
10793
+ * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
10794
+ * Initials Field uses `TemplateResponseDocumentStaticFieldInitials`
10795
+ type: string
10796
+ default: initials
10797
+ type: object
10333
10798
  TemplateResponseFieldAvgTextLength:
10334
10799
  description: 'Average text length in this field.'
10335
10800
  properties:
@@ -10337,57 +10802,8 @@ components:
10337
10802
  description: 'Number of lines.'
10338
10803
  type: integer
10339
10804
  num_chars_per_line:
10340
- description: 'Number of character per line.'
10341
- type: integer
10342
- type: object
10343
- x-internal: true
10344
- TemplateResponseNamedFormField:
10345
- properties:
10346
- name:
10347
- description: 'The name of the Named Form Field.'
10348
- type: string
10349
- type:
10350
- description: 'The type of this Named Form Field. Only `text` and `checkbox` are currently supported.'
10351
- type: string
10352
- signer:
10353
- description: 'The signer of the Named Form Field.'
10354
- type: string
10355
- x:
10356
- description: 'The horizontal offset in pixels for this form field.'
10805
+ description: 'Number of characters per line.'
10357
10806
  type: integer
10358
- 'y':
10359
- description: 'The vertical offset in pixels for this form field.'
10360
- type: integer
10361
- width:
10362
- description: 'The width in pixels of this form field.'
10363
- type: integer
10364
- height:
10365
- description: 'The height in pixels of this form field.'
10366
- type: integer
10367
- required:
10368
- description: 'Boolean showing whether or not this field is required.'
10369
- type: boolean
10370
- api_id:
10371
- description: 'The unique ID for this field.'
10372
- type: string
10373
- group:
10374
- description: 'The name of the group this field is in. If this field is not a group, this defaults to `null`.'
10375
- type: string
10376
- nullable: true
10377
- avg_text_length:
10378
- $ref: '#/components/schemas/TemplateResponseFieldAvgTextLength'
10379
- isMultiline:
10380
- description: 'Whether this form field is multiline text.'
10381
- type: boolean
10382
- nullable: true
10383
- originalFontSize:
10384
- description: 'Original font size used in this form field''s text.'
10385
- type: integer
10386
- nullable: true
10387
- fontFamily:
10388
- description: 'Font family used in this form field''s text.'
10389
- type: string
10390
- nullable: true
10391
10807
  type: object
10392
10808
  x-internal: true
10393
10809
  TemplateResponseSignerRole: