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