dropbox-sign 1.1.2 → 1.2.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile.lock +2 -2
- data/README.md +9 -4
- data/VERSION +1 -1
- data/docs/OAuthApi.md +0 -16
- data/docs/SignatureRequestApi.md +1 -1
- data/docs/SignatureRequestSendRequest.md +1 -0
- data/docs/SignatureRequestSendWithTemplateRequest.md +1 -0
- data/docs/SignatureRequestUpdateRequest.md +1 -1
- data/docs/SubFormFieldsPerDocumentBase.md +1 -1
- data/docs/SubFormFieldsPerDocumentDateSigned.md +2 -0
- data/docs/SubFormFieldsPerDocumentDropdown.md +2 -0
- data/docs/SubFormFieldsPerDocumentFontEnum.md +9 -0
- data/docs/SubFormFieldsPerDocumentHyperlink.md +2 -0
- data/docs/SubFormFieldsPerDocumentText.md +3 -0
- data/docs/SubFormFieldsPerDocumentTextMerge.md +2 -0
- data/docs/SubWhiteLabelingOptions.md +1 -1
- data/docs/TemplateApi.md +102 -0
- data/docs/TemplateCreateRequest.md +27 -0
- data/docs/TemplateCreateResponse.md +11 -0
- data/docs/TemplateCreateResponseTemplate.md +10 -0
- data/examples/OauthTokenGenerate.rb +0 -8
- data/examples/OauthTokenRefresh.rb +0 -8
- data/examples/TemplateCreate.rb +49 -0
- data/lib/dropbox-sign/api/signature_request_api.rb +2 -2
- data/lib/dropbox-sign/api/template_api.rb +109 -0
- data/lib/dropbox-sign/models/signature_request_send_request.rb +14 -1
- data/lib/dropbox-sign/models/signature_request_send_with_template_request.rb +14 -1
- data/lib/dropbox-sign/models/signature_request_update_request.rb +1 -1
- data/lib/dropbox-sign/models/sub_form_fields_per_document_base.rb +1 -1
- data/lib/dropbox-sign/models/sub_form_fields_per_document_date_signed.rb +60 -4
- data/lib/dropbox-sign/models/sub_form_fields_per_document_dropdown.rb +60 -4
- data/lib/dropbox-sign/models/sub_form_fields_per_document_font_enum.rb +54 -0
- data/lib/dropbox-sign/models/sub_form_fields_per_document_hyperlink.rb +60 -4
- data/lib/dropbox-sign/models/sub_form_fields_per_document_text.rb +49 -4
- data/lib/dropbox-sign/models/sub_form_fields_per_document_text_merge.rb +60 -4
- data/lib/dropbox-sign/models/sub_white_labeling_options.rb +1 -1
- data/lib/dropbox-sign/models/template_create_request.rb +509 -0
- data/lib/dropbox-sign/models/template_create_response.rb +263 -0
- data/lib/dropbox-sign/models/template_create_response_template.rb +252 -0
- data/lib/dropbox-sign/version.rb +1 -1
- data/lib/dropbox-sign.rb +4 -0
- data/openapi-config.yaml +1 -1
- data/openapi-sdk.yaml +701 -241
- data/test_fixtures/SignatureRequestCreateEmbeddedRequest.json +6 -2
- data/test_fixtures/SignatureRequestSendRequest.json +8 -2
- data/test_fixtures/SignatureRequestSendWithTemplateRequest.json +1 -0
- data/test_fixtures/TemplateCreateEmbeddedDraftRequest.json +3 -1
- data/test_fixtures/TemplateCreateRequest.json +120 -0
- data/test_fixtures/TemplateCreateResponse.json +7 -0
- data/test_fixtures/UnclaimedDraftCreateEmbeddedRequest.json +3 -1
- data/test_fixtures/UnclaimedDraftCreateRequest.json +3 -1
- metadata +21 -10
data/openapi-sdk.yaml
CHANGED
@@ -3364,6 +3364,8 @@ paths:
|
|
3364
3364
|
description: |-
|
3365
3365
|
Updates the email address and/or the name for a given signer on a signature request. You can listen for the `signature_request_email_bounce` event on your app or account to detect bounced emails, and respond with this method.
|
3366
3366
|
|
3367
|
+
Updating the email address of a signer will generate a new `signature_id` value.
|
3368
|
+
|
3367
3369
|
**NOTE**: This action cannot be performed on a signature request with an appended signature page.
|
3368
3370
|
operationId: signatureRequestUpdate
|
3369
3371
|
parameters:
|
@@ -4630,6 +4632,120 @@ paths:
|
|
4630
4632
|
seo:
|
4631
4633
|
title: 'Add User to Template | REST API | Dropbox Sign for Developers'
|
4632
4634
|
description: 'The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to give an Account access to a Template, click here.'
|
4635
|
+
/template/create:
|
4636
|
+
post:
|
4637
|
+
tags:
|
4638
|
+
- Template
|
4639
|
+
summary: 'Create Template'
|
4640
|
+
description: 'Creates a template that can then be used.'
|
4641
|
+
operationId: templateCreate
|
4642
|
+
requestBody:
|
4643
|
+
required: true
|
4644
|
+
content:
|
4645
|
+
application/json:
|
4646
|
+
schema:
|
4647
|
+
$ref: '#/components/schemas/TemplateCreateRequest'
|
4648
|
+
examples:
|
4649
|
+
default_example:
|
4650
|
+
$ref: '#/components/examples/TemplateCreateRequestDefaultExample'
|
4651
|
+
form_fields_per_document:
|
4652
|
+
$ref: '#/components/examples/TemplateCreateRequestFormFieldsPerDocumentExample'
|
4653
|
+
form_field_groups:
|
4654
|
+
$ref: '#/components/examples/TemplateCreateRequestFormFieldGroupsExample'
|
4655
|
+
form_field_rules:
|
4656
|
+
$ref: '#/components/examples/TemplateCreateRequestFormFieldRulesExample'
|
4657
|
+
multipart/form-data:
|
4658
|
+
schema:
|
4659
|
+
$ref: '#/components/schemas/TemplateCreateRequest'
|
4660
|
+
responses:
|
4661
|
+
200:
|
4662
|
+
description: 'successful operation'
|
4663
|
+
headers:
|
4664
|
+
X-RateLimit-Limit:
|
4665
|
+
$ref: '#/components/headers/X-RateLimit-Limit'
|
4666
|
+
X-RateLimit-Remaining:
|
4667
|
+
$ref: '#/components/headers/X-RateLimit-Remaining'
|
4668
|
+
X-Ratelimit-Reset:
|
4669
|
+
$ref: '#/components/headers/X-Ratelimit-Reset'
|
4670
|
+
content:
|
4671
|
+
application/json:
|
4672
|
+
schema:
|
4673
|
+
$ref: '#/components/schemas/TemplateCreateResponse'
|
4674
|
+
examples:
|
4675
|
+
default_example:
|
4676
|
+
$ref: '#/components/examples/TemplateCreateResponseExample'
|
4677
|
+
4XX:
|
4678
|
+
description: failed_operation
|
4679
|
+
content:
|
4680
|
+
application/json:
|
4681
|
+
schema:
|
4682
|
+
$ref: '#/components/schemas/ErrorResponse'
|
4683
|
+
examples:
|
4684
|
+
400_example:
|
4685
|
+
$ref: '#/components/examples/Error400ResponseExample'
|
4686
|
+
401_example:
|
4687
|
+
$ref: '#/components/examples/Error401ResponseExample'
|
4688
|
+
402_example:
|
4689
|
+
$ref: '#/components/examples/Error402ResponseExample'
|
4690
|
+
403_example:
|
4691
|
+
$ref: '#/components/examples/Error403ResponseExample'
|
4692
|
+
404_example:
|
4693
|
+
$ref: '#/components/examples/Error404ResponseExample'
|
4694
|
+
409_example:
|
4695
|
+
$ref: '#/components/examples/Error409ResponseExample'
|
4696
|
+
4XX_example:
|
4697
|
+
$ref: '#/components/examples/Error4XXResponseExample'
|
4698
|
+
security:
|
4699
|
+
-
|
4700
|
+
api_key: []
|
4701
|
+
-
|
4702
|
+
oauth2:
|
4703
|
+
- template_access
|
4704
|
+
x-codeSamples:
|
4705
|
+
-
|
4706
|
+
lang: PHP
|
4707
|
+
label: PHP
|
4708
|
+
source:
|
4709
|
+
$ref: examples/TemplateCreate.php
|
4710
|
+
-
|
4711
|
+
lang: 'C#'
|
4712
|
+
label: 'C#'
|
4713
|
+
source:
|
4714
|
+
$ref: examples/TemplateCreate.cs
|
4715
|
+
-
|
4716
|
+
lang: JavaScript
|
4717
|
+
label: JavaScript
|
4718
|
+
source:
|
4719
|
+
$ref: examples/TemplateCreate.js
|
4720
|
+
-
|
4721
|
+
lang: TypeScript
|
4722
|
+
label: TypeScript
|
4723
|
+
source:
|
4724
|
+
$ref: examples/TemplateCreate.ts
|
4725
|
+
-
|
4726
|
+
lang: Java
|
4727
|
+
label: Java
|
4728
|
+
source:
|
4729
|
+
$ref: examples/TemplateCreate.java
|
4730
|
+
-
|
4731
|
+
lang: Ruby
|
4732
|
+
label: Ruby
|
4733
|
+
source:
|
4734
|
+
$ref: examples/TemplateCreate.rb
|
4735
|
+
-
|
4736
|
+
lang: Python
|
4737
|
+
label: Python
|
4738
|
+
source:
|
4739
|
+
$ref: examples/TemplateCreate.py
|
4740
|
+
-
|
4741
|
+
lang: cURL
|
4742
|
+
label: cURL
|
4743
|
+
source:
|
4744
|
+
$ref: examples/TemplateCreate.sh
|
4745
|
+
x-meta:
|
4746
|
+
seo:
|
4747
|
+
title: 'Create Template | Dropbox Sign for Developers'
|
4748
|
+
description: 'The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to create an template, click here.'
|
4633
4749
|
/template/create_embedded_draft:
|
4634
4750
|
post:
|
4635
4751
|
tags:
|
@@ -6279,226 +6395,6 @@ components:
|
|
6279
6395
|
type: boolean
|
6280
6396
|
default: false
|
6281
6397
|
type: object
|
6282
|
-
SubFormFieldsPerDocumentTypeEnum:
|
6283
|
-
type: string
|
6284
|
-
enum:
|
6285
|
-
- checkbox
|
6286
|
-
- checkbox-merge
|
6287
|
-
- date_signed
|
6288
|
-
- dropdown
|
6289
|
-
- hyperlink
|
6290
|
-
- initials
|
6291
|
-
- signature
|
6292
|
-
- radio
|
6293
|
-
- text
|
6294
|
-
- text-merge
|
6295
|
-
SubFormFieldsPerDocumentText:
|
6296
|
-
description: 'This class extends `SubFormFieldsPerDocumentBase`.'
|
6297
|
-
allOf:
|
6298
|
-
-
|
6299
|
-
$ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
|
6300
|
-
-
|
6301
|
-
required:
|
6302
|
-
- type
|
6303
|
-
- options
|
6304
|
-
properties:
|
6305
|
-
type:
|
6306
|
-
description: 'A text input field. Use the `SubFormFieldsPerDocumentText` class.'
|
6307
|
-
type: string
|
6308
|
-
default: text
|
6309
|
-
placeholder:
|
6310
|
-
description: 'Placeholder value for text field.'
|
6311
|
-
type: string
|
6312
|
-
auto_fill_type:
|
6313
|
-
description: 'Auto fill type for populating fields automatically. Check out the list of [auto fill types](/api/reference/constants/#auto-fill-types) to learn more about the possible values.'
|
6314
|
-
type: string
|
6315
|
-
link_id:
|
6316
|
-
description: 'Link two or more text fields. Enter data into one linked text field, which automatically fill all other linked text fields.'
|
6317
|
-
type: string
|
6318
|
-
masked:
|
6319
|
-
description: 'Masks entered data. For more information see [Masking sensitive information](https://faq.hellosign.com/hc/en-us/articles/360040742811-Masking-sensitive-information). `true` for masking the data in a text field, otherwise `false`.'
|
6320
|
-
type: boolean
|
6321
|
-
validation_type:
|
6322
|
-
description: |-
|
6323
|
-
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.
|
6324
|
-
|
6325
|
-
**NOTE**: When using `custom_regex` you are required to pass a second parameter `validation_custom_regex` and you can optionally provide `validation_custom_regex_format_label` for the error message the user will see in case of an invalid value.
|
6326
|
-
type: string
|
6327
|
-
enum:
|
6328
|
-
- numbers_only
|
6329
|
-
- letters_only
|
6330
|
-
- phone_number
|
6331
|
-
- bank_routing_number
|
6332
|
-
- bank_account_number
|
6333
|
-
- email_address
|
6334
|
-
- zip_code
|
6335
|
-
- social_security_number
|
6336
|
-
- employer_identification_number
|
6337
|
-
- custom_regex
|
6338
|
-
validation_custom_regex:
|
6339
|
-
type: string
|
6340
|
-
validation_custom_regex_format_label:
|
6341
|
-
type: string
|
6342
|
-
type: object
|
6343
|
-
SubFormFieldsPerDocumentDropdown:
|
6344
|
-
description: 'This class extends `SubFormFieldsPerDocumentBase`.'
|
6345
|
-
allOf:
|
6346
|
-
-
|
6347
|
-
$ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
|
6348
|
-
-
|
6349
|
-
required:
|
6350
|
-
- type
|
6351
|
-
- options
|
6352
|
-
properties:
|
6353
|
-
type:
|
6354
|
-
description: 'An input field for dropdowns. Use the `SubFormFieldsPerDocumentDropdown` class.'
|
6355
|
-
type: string
|
6356
|
-
default: dropdown
|
6357
|
-
options:
|
6358
|
-
description: 'Array of string values representing dropdown values.'
|
6359
|
-
type: array
|
6360
|
-
items:
|
6361
|
-
type: string
|
6362
|
-
minItems: 1
|
6363
|
-
content:
|
6364
|
-
description: 'Selected value in `options` array. Value must exist in array.'
|
6365
|
-
type: string
|
6366
|
-
type: object
|
6367
|
-
SubFormFieldsPerDocumentHyperlink:
|
6368
|
-
description: 'This class extends `SubFormFieldsPerDocumentBase`.'
|
6369
|
-
allOf:
|
6370
|
-
-
|
6371
|
-
$ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
|
6372
|
-
-
|
6373
|
-
required:
|
6374
|
-
- type
|
6375
|
-
- content
|
6376
|
-
- content_url
|
6377
|
-
properties:
|
6378
|
-
type:
|
6379
|
-
description: 'A hyperlink field. Use the `SubFormFieldsPerDocumentHyperlink` class.'
|
6380
|
-
type: string
|
6381
|
-
default: hyperlink
|
6382
|
-
content:
|
6383
|
-
description: 'Link Text.'
|
6384
|
-
type: string
|
6385
|
-
content_url:
|
6386
|
-
description: 'Link URL.'
|
6387
|
-
type: string
|
6388
|
-
type: object
|
6389
|
-
SubFormFieldsPerDocumentCheckbox:
|
6390
|
-
description: 'This class extends `SubFormFieldsPerDocumentBase`.'
|
6391
|
-
allOf:
|
6392
|
-
-
|
6393
|
-
$ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
|
6394
|
-
-
|
6395
|
-
required:
|
6396
|
-
- type
|
6397
|
-
- is_checked
|
6398
|
-
properties:
|
6399
|
-
type:
|
6400
|
-
description: 'A yes/no checkbox. Use the `SubFormFieldsPerDocumentCheckbox` class.'
|
6401
|
-
type: string
|
6402
|
-
default: checkbox
|
6403
|
-
group:
|
6404
|
-
description: 'String referencing group defined in `form_field_groups` parameter.'
|
6405
|
-
type: string
|
6406
|
-
is_checked:
|
6407
|
-
description: '`true` for checking the checkbox field by default, otherwise `false`.'
|
6408
|
-
type: boolean
|
6409
|
-
type: object
|
6410
|
-
SubFormFieldsPerDocumentRadio:
|
6411
|
-
description: 'This class extends `SubFormFieldsPerDocumentBase`.'
|
6412
|
-
allOf:
|
6413
|
-
-
|
6414
|
-
$ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
|
6415
|
-
-
|
6416
|
-
required:
|
6417
|
-
- type
|
6418
|
-
- group
|
6419
|
-
- is_checked
|
6420
|
-
properties:
|
6421
|
-
type:
|
6422
|
-
description: 'An input field for radios. Use the `SubFormFieldsPerDocumentRadio` class.'
|
6423
|
-
type: string
|
6424
|
-
default: radio
|
6425
|
-
group:
|
6426
|
-
description: 'String referencing group defined in `form_field_groups` parameter.'
|
6427
|
-
type: string
|
6428
|
-
is_checked:
|
6429
|
-
description: '`true` for checking the radio field by default, otherwise `false`. Only one radio field per group can be `true`.'
|
6430
|
-
type: boolean
|
6431
|
-
type: object
|
6432
|
-
SubFormFieldsPerDocumentSignature:
|
6433
|
-
description: 'This class extends `SubFormFieldsPerDocumentBase`.'
|
6434
|
-
allOf:
|
6435
|
-
-
|
6436
|
-
$ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
|
6437
|
-
-
|
6438
|
-
required:
|
6439
|
-
- type
|
6440
|
-
properties:
|
6441
|
-
type:
|
6442
|
-
description: 'A signature input field. Use the `SubFormFieldsPerDocumentSignature` class.'
|
6443
|
-
type: string
|
6444
|
-
default: signature
|
6445
|
-
type: object
|
6446
|
-
SubFormFieldsPerDocumentDateSigned:
|
6447
|
-
description: 'This class extends `SubFormFieldsPerDocumentBase`.'
|
6448
|
-
allOf:
|
6449
|
-
-
|
6450
|
-
$ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
|
6451
|
-
-
|
6452
|
-
required:
|
6453
|
-
- type
|
6454
|
-
properties:
|
6455
|
-
type:
|
6456
|
-
description: 'A date. Use the `SubFormFieldsPerDocumentDateSigned` class.'
|
6457
|
-
type: string
|
6458
|
-
default: date_signed
|
6459
|
-
type: object
|
6460
|
-
SubFormFieldsPerDocumentInitials:
|
6461
|
-
description: 'This class extends `SubFormFieldsPerDocumentBase`.'
|
6462
|
-
allOf:
|
6463
|
-
-
|
6464
|
-
$ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
|
6465
|
-
-
|
6466
|
-
required:
|
6467
|
-
- type
|
6468
|
-
properties:
|
6469
|
-
type:
|
6470
|
-
description: 'An input field for initials. Use the `SubFormFieldsPerDocumentInitials` class.'
|
6471
|
-
type: string
|
6472
|
-
default: initials
|
6473
|
-
type: object
|
6474
|
-
SubFormFieldsPerDocumentTextMerge:
|
6475
|
-
description: 'This class extends `SubFormFieldsPerDocumentBase`.'
|
6476
|
-
allOf:
|
6477
|
-
-
|
6478
|
-
$ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
|
6479
|
-
-
|
6480
|
-
required:
|
6481
|
-
- type
|
6482
|
-
properties:
|
6483
|
-
type:
|
6484
|
-
description: 'A text field that has default text set using pre-filled data. Use the `SubFormFieldsPerDocumentTextMerge` class.'
|
6485
|
-
type: string
|
6486
|
-
default: text-merge
|
6487
|
-
type: object
|
6488
|
-
SubFormFieldsPerDocumentCheckboxMerge:
|
6489
|
-
description: 'This class extends `SubFormFieldsPerDocumentBase`.'
|
6490
|
-
allOf:
|
6491
|
-
-
|
6492
|
-
$ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
|
6493
|
-
-
|
6494
|
-
required:
|
6495
|
-
- type
|
6496
|
-
properties:
|
6497
|
-
type:
|
6498
|
-
description: 'A checkbox field that has default value set using pre-filled data. Use the `SubFormFieldsPerDocumentCheckboxMerge` class.'
|
6499
|
-
type: string
|
6500
|
-
default: checkbox-merge
|
6501
|
-
type: object
|
6502
6398
|
OAuthTokenGenerateRequest:
|
6503
6399
|
required:
|
6504
6400
|
- client_id
|
@@ -6886,7 +6782,6 @@ components:
|
|
6886
6782
|
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.'
|
6887
6783
|
type: integer
|
6888
6784
|
nullable: true
|
6889
|
-
x-beta: closed
|
6890
6785
|
type: object
|
6891
6786
|
SignatureRequestCreateEmbeddedWithTemplateRequest:
|
6892
6787
|
required:
|
@@ -7101,6 +6996,16 @@ components:
|
|
7101
6996
|
Cannot be used in `test_mode`. Only works on requests with one signer.
|
7102
6997
|
type: boolean
|
7103
6998
|
default: false
|
6999
|
+
deprecated: true
|
7000
|
+
x-hideOn: doc
|
7001
|
+
is_eid:
|
7002
|
+
description: |-
|
7003
|
+
Send with a value of `true` if you wish to enable
|
7004
|
+
[electronic identification (eID)](https://www.hellosign.com/features/electronic-id),
|
7005
|
+
which requires the signer to verify their identity with an eID provider to sign a document.<br>
|
7006
|
+
**Note**: eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer.
|
7007
|
+
type: boolean
|
7008
|
+
default: false
|
7104
7009
|
message:
|
7105
7010
|
description: 'The custom message in the email that will be sent to the signers.'
|
7106
7011
|
type: string
|
@@ -7138,7 +7043,6 @@ components:
|
|
7138
7043
|
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.'
|
7139
7044
|
type: integer
|
7140
7045
|
nullable: true
|
7141
|
-
x-beta: closed
|
7142
7046
|
type: object
|
7143
7047
|
SignatureRequestSendWithTemplateRequest:
|
7144
7048
|
description: ''
|
@@ -7194,6 +7098,16 @@ components:
|
|
7194
7098
|
Cannot be used in `test_mode`. Only works on requests with one signer.
|
7195
7099
|
type: boolean
|
7196
7100
|
default: false
|
7101
|
+
deprecated: true
|
7102
|
+
x-hideOn: doc
|
7103
|
+
is_eid:
|
7104
|
+
description: |-
|
7105
|
+
Send with a value of `true` if you wish to enable
|
7106
|
+
[electronic identification (eID)](https://www.hellosign.com/features/electronic-id),
|
7107
|
+
which requires the signer to verify their identity with an eID provider to sign a document.<br>
|
7108
|
+
**Note**: eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer.
|
7109
|
+
type: boolean
|
7110
|
+
default: false
|
7197
7111
|
message:
|
7198
7112
|
description: 'The custom message in the email that will be sent to the signers.'
|
7199
7113
|
type: string
|
@@ -7237,6 +7151,8 @@ components:
|
|
7237
7151
|
description: |-
|
7238
7152
|
The new email address for the recipient.
|
7239
7153
|
|
7154
|
+
This will generate a new `signature_id` value.
|
7155
|
+
|
7240
7156
|
**NOTE**: Optional if `name` is provided.
|
7241
7157
|
type: string
|
7242
7158
|
format: email
|
@@ -7253,7 +7169,6 @@ components:
|
|
7253
7169
|
description: 'The new time 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.'
|
7254
7170
|
type: integer
|
7255
7171
|
nullable: true
|
7256
|
-
x-beta: closed
|
7257
7172
|
type: object
|
7258
7173
|
SubAttachment:
|
7259
7174
|
required:
|
@@ -7508,22 +7423,414 @@ components:
|
|
7508
7423
|
- `not`
|
7509
7424
|
- `match`
|
7510
7425
|
|
7511
|
-
Otherwise,
|
7512
|
-
- **checkbox**: When **type** of trigger is **checkbox**, **value** must be `0` or `1`
|
7513
|
-
- **radio**: When **type** of trigger is **radio**, **value** must be `1`
|
7514
|
-
type: string
|
7515
|
-
values:
|
7516
|
-
description: |-
|
7517
|
-
**values** or **value** is required, but not both.
|
7426
|
+
Otherwise,
|
7427
|
+
- **checkbox**: When **type** of trigger is **checkbox**, **value** must be `0` or `1`
|
7428
|
+
- **radio**: When **type** of trigger is **radio**, **value** must be `1`
|
7429
|
+
type: string
|
7430
|
+
values:
|
7431
|
+
description: |-
|
7432
|
+
**values** or **value** is required, but not both.
|
7433
|
+
|
7434
|
+
The values to match against **operator** when it is one of the following:
|
7435
|
+
|
7436
|
+
- `any`
|
7437
|
+
- `none`
|
7438
|
+
type: array
|
7439
|
+
items:
|
7440
|
+
type: string
|
7441
|
+
type: object
|
7442
|
+
SubFormFieldsPerDocumentCheckbox:
|
7443
|
+
description: 'This class extends `SubFormFieldsPerDocumentBase`.'
|
7444
|
+
allOf:
|
7445
|
+
-
|
7446
|
+
$ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
|
7447
|
+
-
|
7448
|
+
required:
|
7449
|
+
- type
|
7450
|
+
- is_checked
|
7451
|
+
properties:
|
7452
|
+
type:
|
7453
|
+
description: 'A yes/no checkbox. Use the `SubFormFieldsPerDocumentCheckbox` class.'
|
7454
|
+
type: string
|
7455
|
+
default: checkbox
|
7456
|
+
group:
|
7457
|
+
description: 'String referencing group defined in `form_field_groups` parameter.'
|
7458
|
+
type: string
|
7459
|
+
is_checked:
|
7460
|
+
description: '`true` for checking the checkbox field by default, otherwise `false`.'
|
7461
|
+
type: boolean
|
7462
|
+
type: object
|
7463
|
+
-
|
7464
|
+
$ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
|
7465
|
+
SubFormFieldsPerDocumentCheckboxMerge:
|
7466
|
+
description: 'This class extends `SubFormFieldsPerDocumentBase`.'
|
7467
|
+
allOf:
|
7468
|
+
-
|
7469
|
+
$ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
|
7470
|
+
-
|
7471
|
+
required:
|
7472
|
+
- type
|
7473
|
+
properties:
|
7474
|
+
type:
|
7475
|
+
description: 'A checkbox field that has default value set using pre-filled data. Use the `SubFormFieldsPerDocumentCheckboxMerge` class.'
|
7476
|
+
type: string
|
7477
|
+
default: checkbox-merge
|
7478
|
+
type: object
|
7479
|
+
-
|
7480
|
+
$ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
|
7481
|
+
SubFormFieldsPerDocumentDateSigned:
|
7482
|
+
description: 'This class extends `SubFormFieldsPerDocumentBase`.'
|
7483
|
+
allOf:
|
7484
|
+
-
|
7485
|
+
$ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
|
7486
|
+
-
|
7487
|
+
required:
|
7488
|
+
- type
|
7489
|
+
properties:
|
7490
|
+
type:
|
7491
|
+
description: 'A date. Use the `SubFormFieldsPerDocumentDateSigned` class.'
|
7492
|
+
type: string
|
7493
|
+
default: date_signed
|
7494
|
+
font_family:
|
7495
|
+
description: 'Font family for the field.'
|
7496
|
+
type: string
|
7497
|
+
enum:
|
7498
|
+
- helvetica
|
7499
|
+
- arial
|
7500
|
+
- courier
|
7501
|
+
- calibri
|
7502
|
+
- cambria
|
7503
|
+
- georgia
|
7504
|
+
- times
|
7505
|
+
- trebuchet
|
7506
|
+
- verdana
|
7507
|
+
- roboto
|
7508
|
+
- robotoMono
|
7509
|
+
- notoSans
|
7510
|
+
- notoSerif
|
7511
|
+
- notoCJK-JP-Regular
|
7512
|
+
- notoHebrew-Regular
|
7513
|
+
- notoSanThaiMerged
|
7514
|
+
font_size:
|
7515
|
+
description: |-
|
7516
|
+
The initial px font size for the field contents. Can be any integer value between `7` and `49`.
|
7517
|
+
|
7518
|
+
**NOTE**: Font size may be reduced during processing in order to fit the contents within the dimensions of the field.
|
7519
|
+
type: integer
|
7520
|
+
type: object
|
7521
|
+
-
|
7522
|
+
$ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
|
7523
|
+
SubFormFieldsPerDocumentDropdown:
|
7524
|
+
description: 'This class extends `SubFormFieldsPerDocumentBase`.'
|
7525
|
+
allOf:
|
7526
|
+
-
|
7527
|
+
$ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
|
7528
|
+
-
|
7529
|
+
required:
|
7530
|
+
- type
|
7531
|
+
- options
|
7532
|
+
properties:
|
7533
|
+
type:
|
7534
|
+
description: 'An input field for dropdowns. Use the `SubFormFieldsPerDocumentDropdown` class.'
|
7535
|
+
type: string
|
7536
|
+
default: dropdown
|
7537
|
+
options:
|
7538
|
+
description: 'Array of string values representing dropdown values.'
|
7539
|
+
type: array
|
7540
|
+
items:
|
7541
|
+
type: string
|
7542
|
+
minItems: 1
|
7543
|
+
content:
|
7544
|
+
description: 'Selected value in `options` array. Value must exist in array.'
|
7545
|
+
type: string
|
7546
|
+
font_family:
|
7547
|
+
description: 'Font family for the field.'
|
7548
|
+
type: string
|
7549
|
+
enum:
|
7550
|
+
- helvetica
|
7551
|
+
- arial
|
7552
|
+
- courier
|
7553
|
+
- calibri
|
7554
|
+
- cambria
|
7555
|
+
- georgia
|
7556
|
+
- times
|
7557
|
+
- trebuchet
|
7558
|
+
- verdana
|
7559
|
+
- roboto
|
7560
|
+
- robotoMono
|
7561
|
+
- notoSans
|
7562
|
+
- notoSerif
|
7563
|
+
- notoCJK-JP-Regular
|
7564
|
+
- notoHebrew-Regular
|
7565
|
+
- notoSanThaiMerged
|
7566
|
+
font_size:
|
7567
|
+
description: |-
|
7568
|
+
The initial px font size for the field contents. Can be any integer value between `7` and `49`.
|
7569
|
+
|
7570
|
+
**NOTE**: Font size may be reduced during processing in order to fit the contents within the dimensions of the field.
|
7571
|
+
type: integer
|
7572
|
+
type: object
|
7573
|
+
-
|
7574
|
+
$ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
|
7575
|
+
SubFormFieldsPerDocumentHyperlink:
|
7576
|
+
description: 'This class extends `SubFormFieldsPerDocumentBase`.'
|
7577
|
+
allOf:
|
7578
|
+
-
|
7579
|
+
$ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
|
7580
|
+
-
|
7581
|
+
required:
|
7582
|
+
- type
|
7583
|
+
- content
|
7584
|
+
- content_url
|
7585
|
+
properties:
|
7586
|
+
type:
|
7587
|
+
description: 'A hyperlink field. Use the `SubFormFieldsPerDocumentHyperlink` class.'
|
7588
|
+
type: string
|
7589
|
+
default: hyperlink
|
7590
|
+
content:
|
7591
|
+
description: 'Link Text.'
|
7592
|
+
type: string
|
7593
|
+
content_url:
|
7594
|
+
description: 'Link URL.'
|
7595
|
+
type: string
|
7596
|
+
font_family:
|
7597
|
+
description: 'Font family for the field.'
|
7598
|
+
type: string
|
7599
|
+
enum:
|
7600
|
+
- helvetica
|
7601
|
+
- arial
|
7602
|
+
- courier
|
7603
|
+
- calibri
|
7604
|
+
- cambria
|
7605
|
+
- georgia
|
7606
|
+
- times
|
7607
|
+
- trebuchet
|
7608
|
+
- verdana
|
7609
|
+
- roboto
|
7610
|
+
- robotoMono
|
7611
|
+
- notoSans
|
7612
|
+
- notoSerif
|
7613
|
+
- notoCJK-JP-Regular
|
7614
|
+
- notoHebrew-Regular
|
7615
|
+
- notoSanThaiMerged
|
7616
|
+
font_size:
|
7617
|
+
description: |-
|
7618
|
+
The initial px font size for the field contents. Can be any integer value between `7` and `49`.
|
7619
|
+
|
7620
|
+
**NOTE**: Font size may be reduced during processing in order to fit the contents within the dimensions of the field.
|
7621
|
+
type: integer
|
7622
|
+
type: object
|
7623
|
+
-
|
7624
|
+
$ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
|
7625
|
+
SubFormFieldsPerDocumentInitials:
|
7626
|
+
description: 'This class extends `SubFormFieldsPerDocumentBase`.'
|
7627
|
+
allOf:
|
7628
|
+
-
|
7629
|
+
$ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
|
7630
|
+
-
|
7631
|
+
required:
|
7632
|
+
- type
|
7633
|
+
properties:
|
7634
|
+
type:
|
7635
|
+
description: 'An input field for initials. Use the `SubFormFieldsPerDocumentInitials` class.'
|
7636
|
+
type: string
|
7637
|
+
default: initials
|
7638
|
+
type: object
|
7639
|
+
-
|
7640
|
+
$ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
|
7641
|
+
SubFormFieldsPerDocumentRadio:
|
7642
|
+
description: 'This class extends `SubFormFieldsPerDocumentBase`.'
|
7643
|
+
allOf:
|
7644
|
+
-
|
7645
|
+
$ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
|
7646
|
+
-
|
7647
|
+
required:
|
7648
|
+
- type
|
7649
|
+
- group
|
7650
|
+
- is_checked
|
7651
|
+
properties:
|
7652
|
+
type:
|
7653
|
+
description: 'An input field for radios. Use the `SubFormFieldsPerDocumentRadio` class.'
|
7654
|
+
type: string
|
7655
|
+
default: radio
|
7656
|
+
group:
|
7657
|
+
description: 'String referencing group defined in `form_field_groups` parameter.'
|
7658
|
+
type: string
|
7659
|
+
is_checked:
|
7660
|
+
description: '`true` for checking the radio field by default, otherwise `false`. Only one radio field per group can be `true`.'
|
7661
|
+
type: boolean
|
7662
|
+
type: object
|
7663
|
+
-
|
7664
|
+
$ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
|
7665
|
+
SubFormFieldsPerDocumentSignature:
|
7666
|
+
description: 'This class extends `SubFormFieldsPerDocumentBase`.'
|
7667
|
+
allOf:
|
7668
|
+
-
|
7669
|
+
$ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
|
7670
|
+
-
|
7671
|
+
required:
|
7672
|
+
- type
|
7673
|
+
properties:
|
7674
|
+
type:
|
7675
|
+
description: 'A signature input field. Use the `SubFormFieldsPerDocumentSignature` class.'
|
7676
|
+
type: string
|
7677
|
+
default: signature
|
7678
|
+
type: object
|
7679
|
+
-
|
7680
|
+
$ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
|
7681
|
+
SubFormFieldsPerDocumentText:
|
7682
|
+
description: 'This class extends `SubFormFieldsPerDocumentBase`.'
|
7683
|
+
allOf:
|
7684
|
+
-
|
7685
|
+
$ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
|
7686
|
+
-
|
7687
|
+
required:
|
7688
|
+
- type
|
7689
|
+
- options
|
7690
|
+
properties:
|
7691
|
+
type:
|
7692
|
+
description: 'A text input field. Use the `SubFormFieldsPerDocumentText` class.'
|
7693
|
+
type: string
|
7694
|
+
default: text
|
7695
|
+
placeholder:
|
7696
|
+
description: 'Placeholder value for text field.'
|
7697
|
+
type: string
|
7698
|
+
auto_fill_type:
|
7699
|
+
description: 'Auto fill type for populating fields automatically. Check out the list of [auto fill types](/api/reference/constants/#auto-fill-types) to learn more about the possible values.'
|
7700
|
+
type: string
|
7701
|
+
link_id:
|
7702
|
+
description: 'Link two or more text fields. Enter data into one linked text field, which automatically fill all other linked text fields.'
|
7703
|
+
type: string
|
7704
|
+
masked:
|
7705
|
+
description: 'Masks entered data. For more information see [Masking sensitive information](https://faq.hellosign.com/hc/en-us/articles/360040742811-Masking-sensitive-information). `true` for masking the data in a text field, otherwise `false`.'
|
7706
|
+
type: boolean
|
7707
|
+
validation_type:
|
7708
|
+
description: |-
|
7709
|
+
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.
|
7710
|
+
|
7711
|
+
**NOTE**: When using `custom_regex` you are required to pass a second parameter `validation_custom_regex` and you can optionally provide `validation_custom_regex_format_label` for the error message the user will see in case of an invalid value.
|
7712
|
+
type: string
|
7713
|
+
enum:
|
7714
|
+
- numbers_only
|
7715
|
+
- letters_only
|
7716
|
+
- phone_number
|
7717
|
+
- bank_routing_number
|
7718
|
+
- bank_account_number
|
7719
|
+
- email_address
|
7720
|
+
- zip_code
|
7721
|
+
- social_security_number
|
7722
|
+
- employer_identification_number
|
7723
|
+
- custom_regex
|
7724
|
+
validation_custom_regex:
|
7725
|
+
type: string
|
7726
|
+
validation_custom_regex_format_label:
|
7727
|
+
type: string
|
7728
|
+
content:
|
7729
|
+
description: 'Content of a `me_now` text field'
|
7730
|
+
type: string
|
7731
|
+
font_family:
|
7732
|
+
description: 'Font family for the field.'
|
7733
|
+
type: string
|
7734
|
+
enum:
|
7735
|
+
- helvetica
|
7736
|
+
- arial
|
7737
|
+
- courier
|
7738
|
+
- calibri
|
7739
|
+
- cambria
|
7740
|
+
- georgia
|
7741
|
+
- times
|
7742
|
+
- trebuchet
|
7743
|
+
- verdana
|
7744
|
+
- roboto
|
7745
|
+
- robotoMono
|
7746
|
+
- notoSans
|
7747
|
+
- notoSerif
|
7748
|
+
- notoCJK-JP-Regular
|
7749
|
+
- notoHebrew-Regular
|
7750
|
+
- notoSanThaiMerged
|
7751
|
+
font_size:
|
7752
|
+
description: |-
|
7753
|
+
The initial px font size for the field contents. Can be any integer value between `7` and `49`.
|
7518
7754
|
|
7519
|
-
|
7755
|
+
**NOTE**: Font size may be reduced during processing in order to fit the contents within the dimensions of the field.
|
7756
|
+
type: integer
|
7757
|
+
type: object
|
7758
|
+
-
|
7759
|
+
$ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
|
7760
|
+
SubFormFieldsPerDocumentTextMerge:
|
7761
|
+
description: 'This class extends `SubFormFieldsPerDocumentBase`.'
|
7762
|
+
allOf:
|
7763
|
+
-
|
7764
|
+
$ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
|
7765
|
+
-
|
7766
|
+
required:
|
7767
|
+
- type
|
7768
|
+
properties:
|
7769
|
+
type:
|
7770
|
+
description: 'A text field that has default text set using pre-filled data. Use the `SubFormFieldsPerDocumentTextMerge` class.'
|
7771
|
+
type: string
|
7772
|
+
default: text-merge
|
7773
|
+
font_family:
|
7774
|
+
description: 'Font family for the field.'
|
7775
|
+
type: string
|
7776
|
+
enum:
|
7777
|
+
- helvetica
|
7778
|
+
- arial
|
7779
|
+
- courier
|
7780
|
+
- calibri
|
7781
|
+
- cambria
|
7782
|
+
- georgia
|
7783
|
+
- times
|
7784
|
+
- trebuchet
|
7785
|
+
- verdana
|
7786
|
+
- roboto
|
7787
|
+
- robotoMono
|
7788
|
+
- notoSans
|
7789
|
+
- notoSerif
|
7790
|
+
- notoCJK-JP-Regular
|
7791
|
+
- notoHebrew-Regular
|
7792
|
+
- notoSanThaiMerged
|
7793
|
+
font_size:
|
7794
|
+
description: |-
|
7795
|
+
The initial px font size for the field contents. Can be any integer value between `7` and `49`.
|
7520
7796
|
|
7521
|
-
|
7522
|
-
|
7523
|
-
type:
|
7524
|
-
|
7525
|
-
|
7526
|
-
|
7797
|
+
**NOTE**: Font size may be reduced during processing in order to fit the contents within the dimensions of the field.
|
7798
|
+
type: integer
|
7799
|
+
type: object
|
7800
|
+
-
|
7801
|
+
$ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
|
7802
|
+
SubFormFieldsPerDocumentTypeEnum:
|
7803
|
+
type: string
|
7804
|
+
enum:
|
7805
|
+
- checkbox
|
7806
|
+
- checkbox-merge
|
7807
|
+
- date_signed
|
7808
|
+
- dropdown
|
7809
|
+
- hyperlink
|
7810
|
+
- initials
|
7811
|
+
- signature
|
7812
|
+
- radio
|
7813
|
+
- text
|
7814
|
+
- text-merge
|
7815
|
+
SubFormFieldsPerDocumentFontEnum:
|
7816
|
+
type: string
|
7817
|
+
enum:
|
7818
|
+
- helvetica
|
7819
|
+
- arial
|
7820
|
+
- courier
|
7821
|
+
- calibri
|
7822
|
+
- cambria
|
7823
|
+
- georgia
|
7824
|
+
- times
|
7825
|
+
- trebuchet
|
7826
|
+
- verdana
|
7827
|
+
- roboto
|
7828
|
+
- robotoMono
|
7829
|
+
- notoSans
|
7830
|
+
- notoSerif
|
7831
|
+
- notoCJK-JP-Regular
|
7832
|
+
- notoHebrew-Regular
|
7833
|
+
- notoSanThaiMerged
|
7527
7834
|
SubFormFieldsPerDocumentBase:
|
7528
7835
|
description: |-
|
7529
7836
|
The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)
|
@@ -7578,6 +7885,8 @@ components:
|
|
7578
7885
|
description: |-
|
7579
7886
|
Signer index identified by the offset in the signers parameter (0-based indexing), indicating which signer should fill out the field.
|
7580
7887
|
|
7888
|
+
**NOTE**: To set the value of the field as the preparer you must set this to `me_now`
|
7889
|
+
|
7581
7890
|
**NOTE**: If type is `text-merge` or `checkbox-merge`, you must set this to sender in order to use pre-filled data.
|
7582
7891
|
type: string
|
7583
7892
|
x-int-or-string: true
|
@@ -7835,7 +8144,7 @@ components:
|
|
7835
8144
|
description: |-
|
7836
8145
|
An array of elements and values serialized to a string, to be used to customize the app's signer page. (Only applies to some API plans)
|
7837
8146
|
|
7838
|
-
Take a look at our [white labeling guide](/api/reference/
|
8147
|
+
Take a look at our [white labeling guide](https://developers.hellosign.com/api/reference/premium-branding/) to learn more.
|
7839
8148
|
properties:
|
7840
8149
|
header_background_color:
|
7841
8150
|
type: string
|
@@ -7981,6 +8290,119 @@ components:
|
|
7981
8290
|
type: boolean
|
7982
8291
|
default: false
|
7983
8292
|
type: object
|
8293
|
+
TemplateCreateRequest:
|
8294
|
+
required:
|
8295
|
+
- signer_roles
|
8296
|
+
- form_fields_per_document
|
8297
|
+
properties:
|
8298
|
+
files:
|
8299
|
+
description: |-
|
8300
|
+
Use `files[]` to indicate the uploaded file(s) to send for signature.
|
8301
|
+
|
8302
|
+
This endpoint requires either **files** or **file_urls[]**, but not both.
|
8303
|
+
type: array
|
8304
|
+
items:
|
8305
|
+
type: string
|
8306
|
+
format: binary
|
8307
|
+
file_urls:
|
8308
|
+
description: |-
|
8309
|
+
Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.
|
8310
|
+
|
8311
|
+
This endpoint requires either **files** or **file_urls[]**, but not both.
|
8312
|
+
type: array
|
8313
|
+
items:
|
8314
|
+
type: string
|
8315
|
+
allow_reassign:
|
8316
|
+
description: |-
|
8317
|
+
Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.
|
8318
|
+
|
8319
|
+
**Note**: Only available for Premium plan and higher.
|
8320
|
+
type: boolean
|
8321
|
+
default: false
|
8322
|
+
attachments:
|
8323
|
+
description: 'A list describing the attachments'
|
8324
|
+
type: array
|
8325
|
+
items:
|
8326
|
+
$ref: '#/components/schemas/SubAttachment'
|
8327
|
+
cc_roles:
|
8328
|
+
description: 'The CC roles that must be assigned when using the template to send a signature request'
|
8329
|
+
type: array
|
8330
|
+
items:
|
8331
|
+
type: string
|
8332
|
+
client_id:
|
8333
|
+
description: 'Client id of the app you''re using to create this draft. Used to apply the branding and callback url defined for the app.'
|
8334
|
+
type: string
|
8335
|
+
field_options:
|
8336
|
+
$ref: '#/components/schemas/SubFieldOptions'
|
8337
|
+
form_field_groups:
|
8338
|
+
description: 'Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`.'
|
8339
|
+
type: array
|
8340
|
+
items:
|
8341
|
+
$ref: '#/components/schemas/SubFormFieldGroup'
|
8342
|
+
form_field_rules:
|
8343
|
+
description: 'Conditional Logic rules for fields defined in `form_fields_per_document`.'
|
8344
|
+
type: array
|
8345
|
+
items:
|
8346
|
+
$ref: '#/components/schemas/SubFormFieldRule'
|
8347
|
+
form_fields_per_document:
|
8348
|
+
description: |-
|
8349
|
+
The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)
|
8350
|
+
|
8351
|
+
**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.
|
8352
|
+
|
8353
|
+
* Text Field use `SubFormFieldsPerDocumentText`
|
8354
|
+
* Dropdown Field use `SubFormFieldsPerDocumentDropdown`
|
8355
|
+
* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`
|
8356
|
+
* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`
|
8357
|
+
* Radio Field use `SubFormFieldsPerDocumentRadio`
|
8358
|
+
* Signature Field use `SubFormFieldsPerDocumentSignature`
|
8359
|
+
* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`
|
8360
|
+
* Initials Field use `SubFormFieldsPerDocumentInitials`
|
8361
|
+
* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`
|
8362
|
+
* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge`
|
8363
|
+
type: array
|
8364
|
+
items:
|
8365
|
+
$ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
|
8366
|
+
merge_fields:
|
8367
|
+
description: |-
|
8368
|
+
Add merge fields to the template. Merge fields are placed by the user creating the template and used to pre-fill data by passing values into signature requests with the `custom_fields` parameter.
|
8369
|
+
If the signature request using that template *does not* pass a value into a merge field, then an empty field remains in the document.
|
8370
|
+
type: array
|
8371
|
+
items:
|
8372
|
+
$ref: '#/components/schemas/SubMergeField'
|
8373
|
+
message:
|
8374
|
+
description: 'The default template email message.'
|
8375
|
+
type: string
|
8376
|
+
maxLength: 5000
|
8377
|
+
metadata:
|
8378
|
+
description: |-
|
8379
|
+
Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.
|
8380
|
+
|
8381
|
+
Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long.
|
8382
|
+
type: object
|
8383
|
+
maxItems: 10
|
8384
|
+
additionalProperties: {}
|
8385
|
+
signer_roles:
|
8386
|
+
description: 'An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template.'
|
8387
|
+
type: array
|
8388
|
+
items:
|
8389
|
+
$ref: '#/components/schemas/SubTemplateRole'
|
8390
|
+
subject:
|
8391
|
+
description: 'The template title (alias).'
|
8392
|
+
type: string
|
8393
|
+
maxLength: 200
|
8394
|
+
test_mode:
|
8395
|
+
description: 'Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`.'
|
8396
|
+
type: boolean
|
8397
|
+
default: false
|
8398
|
+
title:
|
8399
|
+
description: 'The title you want to assign to the SignatureRequest.'
|
8400
|
+
type: string
|
8401
|
+
use_preexisting_fields:
|
8402
|
+
description: 'Enable the detection of predefined PDF fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`).'
|
8403
|
+
type: boolean
|
8404
|
+
default: false
|
8405
|
+
type: object
|
7984
8406
|
TemplateCreateEmbeddedDraftRequest:
|
7985
8407
|
required:
|
7986
8408
|
- client_id
|
@@ -8308,7 +8730,6 @@ components:
|
|
8308
8730
|
**Note**: This does not correspond to the **expires_at** returned in the response.
|
8309
8731
|
type: integer
|
8310
8732
|
nullable: true
|
8311
|
-
x-beta: closed
|
8312
8733
|
type: object
|
8313
8734
|
UnclaimedDraftCreateEmbeddedRequest:
|
8314
8735
|
description: ''
|
@@ -8506,7 +8927,6 @@ components:
|
|
8506
8927
|
**Note**: This does not correspond to the **expires_at** returned in the response.
|
8507
8928
|
type: integer
|
8508
8929
|
nullable: true
|
8509
|
-
x-beta: closed
|
8510
8930
|
type: object
|
8511
8931
|
UnclaimedDraftCreateEmbeddedWithTemplateRequest:
|
8512
8932
|
required:
|
@@ -9291,7 +9711,6 @@ components:
|
|
9291
9711
|
expires_at:
|
9292
9712
|
description: 'The time when the signature request will expire unsigned signatures. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details.'
|
9293
9713
|
type: integer
|
9294
|
-
x-beta: closed
|
9295
9714
|
is_complete:
|
9296
9715
|
description: 'Whether or not the SignatureRequest has been fully executed by all signers.'
|
9297
9716
|
type: boolean
|
@@ -9937,6 +10356,15 @@ components:
|
|
9937
10356
|
type: array
|
9938
10357
|
items:
|
9939
10358
|
$ref: '#/components/schemas/WarningResponse'
|
10359
|
+
deprecated: true
|
10360
|
+
type: object
|
10361
|
+
x-internal: true
|
10362
|
+
TemplateCreateResponseTemplate:
|
10363
|
+
description: 'Template object with parameters: `template_id`.'
|
10364
|
+
properties:
|
10365
|
+
template_id:
|
10366
|
+
description: 'The id of the Template.'
|
10367
|
+
type: string
|
9940
10368
|
type: object
|
9941
10369
|
x-internal: true
|
9942
10370
|
TemplateResponseDocument:
|
@@ -10639,6 +11067,7 @@ components:
|
|
10639
11067
|
type: array
|
10640
11068
|
items:
|
10641
11069
|
$ref: '#/components/schemas/WarningResponse'
|
11070
|
+
deprecated: true
|
10642
11071
|
type: object
|
10643
11072
|
x-internal: true
|
10644
11073
|
UnclaimedDraftResponse:
|
@@ -10746,6 +11175,17 @@ components:
|
|
10746
11175
|
$ref: '#/components/schemas/WarningResponse'
|
10747
11176
|
type: object
|
10748
11177
|
x-internal: true
|
11178
|
+
TemplateCreateResponse:
|
11179
|
+
properties:
|
11180
|
+
template:
|
11181
|
+
$ref: '#/components/schemas/TemplateCreateResponse'
|
11182
|
+
warnings:
|
11183
|
+
description: 'A list of warnings.'
|
11184
|
+
type: array
|
11185
|
+
items:
|
11186
|
+
$ref: '#/components/schemas/WarningResponse'
|
11187
|
+
type: object
|
11188
|
+
x-internal: true
|
10749
11189
|
TemplateCreateEmbeddedDraftResponse:
|
10750
11190
|
properties:
|
10751
11191
|
template:
|
@@ -10924,6 +11364,22 @@ components:
|
|
10924
11364
|
summary: 'Default Example'
|
10925
11365
|
value:
|
10926
11366
|
$ref: examples/json/TemplateAddUserRequestDefaultExample.json
|
11367
|
+
TemplateCreateRequestDefaultExample:
|
11368
|
+
summary: 'Default Example'
|
11369
|
+
value:
|
11370
|
+
$ref: examples/json/TemplateCreateRequestDefaultExample.json
|
11371
|
+
TemplateCreateRequestFormFieldsPerDocumentExample:
|
11372
|
+
summary: 'Form Fields Per Document Example'
|
11373
|
+
value:
|
11374
|
+
$ref: examples/json/TemplateCreateRequestFormFieldsPerDocumentExample.json
|
11375
|
+
TemplateCreateRequestFormFieldGroupsExample:
|
11376
|
+
summary: 'Form Fields Per Document and Groups Example'
|
11377
|
+
value:
|
11378
|
+
$ref: examples/json/TemplateCreateRequestFormFieldGroupsExample.json
|
11379
|
+
TemplateCreateRequestFormFieldRulesExample:
|
11380
|
+
summary: 'Form Fields Per Document and Rules Example'
|
11381
|
+
value:
|
11382
|
+
$ref: examples/json/TemplateCreateRequestFormFieldRulesExample.json
|
10927
11383
|
TemplateCreateEmbeddedDraftRequestDefaultExample:
|
10928
11384
|
summary: 'Default Example'
|
10929
11385
|
value:
|
@@ -11228,6 +11684,10 @@ components:
|
|
11228
11684
|
summary: 'Team Sub Teams List'
|
11229
11685
|
value:
|
11230
11686
|
$ref: examples/json/TeamSubTeamsResponseExample.json
|
11687
|
+
TemplateCreateResponseExample:
|
11688
|
+
summary: 'Create Template'
|
11689
|
+
value:
|
11690
|
+
$ref: examples/json/TemplateCreateResponseExample.json
|
11231
11691
|
TemplateCreateEmbeddedDraftResponseExample:
|
11232
11692
|
summary: 'Create Embedded Draft Template'
|
11233
11693
|
value:
|