dropbox-sign 1.1.2 → 1.4.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/Gemfile.lock +6 -3
- data/README.md +9 -4
- data/VERSION +1 -1
- data/docs/BulkSendJobGetResponseSignatureRequests.md +1 -0
- data/docs/EmbeddedEditUrlRequest.md +1 -1
- data/docs/EventCallbackRequestEvent.md +1 -1
- data/docs/OAuthApi.md +0 -16
- data/docs/SignatureRequestApi.md +11 -10
- data/docs/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.md +1 -1
- data/docs/SignatureRequestBulkSendWithTemplateRequest.md +1 -1
- data/docs/SignatureRequestCreateEmbeddedRequest.md +4 -4
- data/docs/SignatureRequestCreateEmbeddedWithTemplateRequest.md +1 -1
- data/docs/SignatureRequestResponse.md +2 -0
- data/docs/SignatureRequestSendRequest.md +5 -4
- data/docs/SignatureRequestSendWithTemplateRequest.md +2 -1
- data/docs/SignatureRequestUpdateRequest.md +2 -2
- data/docs/SubAttachment.md +1 -1
- data/docs/SubCustomField.md +1 -1
- data/docs/SubFieldOptions.md +1 -1
- data/docs/SubFormFieldsPerDocumentBase.md +2 -2
- 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 +4 -1
- data/docs/SubFormFieldsPerDocumentTextMerge.md +2 -0
- data/docs/SubSignatureRequestGroupedSigners.md +1 -1
- data/docs/SubSignatureRequestSigner.md +1 -1
- data/docs/SubSignatureRequestTemplateSigner.md +1 -1
- data/docs/SubSigningOptions.md +1 -1
- data/docs/SubWhiteLabelingOptions.md +1 -1
- data/docs/TeamAddMemberRequest.md +1 -1
- data/docs/TeamRemoveMemberRequest.md +2 -2
- data/docs/TemplateAddUserRequest.md +2 -2
- data/docs/TemplateApi.md +106 -3
- data/docs/TemplateCreateEmbeddedDraftRequest.md +2 -2
- data/docs/TemplateCreateRequest.md +27 -0
- data/docs/TemplateCreateResponse.md +11 -0
- data/docs/TemplateCreateResponseTemplate.md +10 -0
- data/docs/TemplateResponseDocument.md +1 -1
- data/docs/TemplateResponseDocumentStaticFieldBase.md +1 -1
- data/docs/UnclaimedDraftApi.md +3 -3
- data/docs/UnclaimedDraftCreateEmbeddedRequest.md +4 -4
- data/docs/UnclaimedDraftCreateEmbeddedWithTemplateRequest.md +4 -3
- data/docs/UnclaimedDraftCreateRequest.md +2 -2
- data/examples/OauthTokenGenerate.rb +0 -8
- data/examples/OauthTokenRefresh.rb +0 -8
- data/examples/SignatureRequestEdit.rb +58 -0
- data/examples/SignatureRequestEditEmbedded.rb +48 -0
- data/examples/SignatureRequestEditEmbeddedWithTemplate.rb +41 -0
- data/examples/SignatureRequestEditWithTemplate.rb +52 -0
- data/examples/TemplateCreate.rb +49 -0
- data/lib/dropbox-sign/api/api_app_api.rb +1 -1
- data/lib/dropbox-sign/api/signature_request_api.rb +17 -14
- data/lib/dropbox-sign/api/team_api.rb +1 -1
- data/lib/dropbox-sign/api/template_api.rb +112 -0
- data/lib/dropbox-sign/api/unclaimed_draft_api.rb +6 -6
- data/lib/dropbox-sign/event_callback_helper.rb +1 -1
- data/lib/dropbox-sign/models/bulk_send_job_get_response_signature_requests.rb +13 -1
- data/lib/dropbox-sign/models/embedded_edit_url_request.rb +1 -1
- data/lib/dropbox-sign/models/event_callback_request_event.rb +2 -7
- data/lib/dropbox-sign/models/signature_request_bulk_create_embedded_with_template_request.rb +1 -1
- data/lib/dropbox-sign/models/signature_request_bulk_send_with_template_request.rb +1 -1
- data/lib/dropbox-sign/models/signature_request_create_embedded_request.rb +4 -4
- data/lib/dropbox-sign/models/signature_request_create_embedded_with_template_request.rb +1 -1
- data/lib/dropbox-sign/models/signature_request_response.rb +28 -4
- data/lib/dropbox-sign/models/signature_request_send_request.rb +18 -5
- data/lib/dropbox-sign/models/signature_request_send_with_template_request.rb +15 -2
- data/lib/dropbox-sign/models/signature_request_update_request.rb +2 -2
- data/lib/dropbox-sign/models/sub_attachment.rb +1 -1
- data/lib/dropbox-sign/models/sub_custom_field.rb +1 -1
- data/lib/dropbox-sign/models/sub_field_options.rb +1 -1
- data/lib/dropbox-sign/models/sub_form_fields_per_document_base.rb +2 -2
- data/lib/dropbox-sign/models/sub_form_fields_per_document_date_signed.rb +62 -4
- data/lib/dropbox-sign/models/sub_form_fields_per_document_dropdown.rb +62 -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 +62 -4
- data/lib/dropbox-sign/models/sub_form_fields_per_document_text.rb +52 -5
- data/lib/dropbox-sign/models/sub_form_fields_per_document_text_merge.rb +62 -4
- data/lib/dropbox-sign/models/sub_signature_request_grouped_signers.rb +1 -1
- data/lib/dropbox-sign/models/sub_signature_request_signer.rb +1 -1
- data/lib/dropbox-sign/models/sub_signature_request_template_signer.rb +1 -1
- data/lib/dropbox-sign/models/sub_signing_options.rb +1 -1
- data/lib/dropbox-sign/models/sub_white_labeling_options.rb +1 -1
- data/lib/dropbox-sign/models/team_add_member_request.rb +1 -1
- data/lib/dropbox-sign/models/team_remove_member_request.rb +2 -2
- data/lib/dropbox-sign/models/template_add_user_request.rb +2 -2
- data/lib/dropbox-sign/models/template_create_embedded_draft_request.rb +2 -2
- 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/models/template_response_document.rb +1 -1
- data/lib/dropbox-sign/models/template_response_document_static_field_base.rb +1 -1
- data/lib/dropbox-sign/models/unclaimed_draft_create_embedded_request.rb +4 -4
- data/lib/dropbox-sign/models/unclaimed_draft_create_embedded_with_template_request.rb +20 -7
- data/lib/dropbox-sign/models/unclaimed_draft_create_request.rb +2 -2
- 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 +1010 -499
- data/spec/event_callback_helper_spec.rb +17 -3
- data/templates/event_callback_helper.mustache +1 -1
- data/test_fixtures/EventCallbackHelper_AccountCallbacks.json +82 -0
- data/test_fixtures/{EventCallbackHelper.json → EventCallbackHelper_AppCallbacks.json} +8 -4
- data/test_fixtures/SignatureRequestCreateEmbeddedRequest.json +6 -2
- data/test_fixtures/SignatureRequestSendRequest.json +20 -8
- data/test_fixtures/SignatureRequestSendWithTemplateRequest.json +1 -0
- data/test_fixtures/SubFormFieldsPerDocument.json +8 -4
- 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/UnclaimedDraftCreateEmbeddedWithTemplateRequest.json +2 -1
- data/test_fixtures/UnclaimedDraftCreateRequest.json +3 -1
- metadata +27 -11
data/openapi-sdk.yaml
CHANGED
@@ -457,7 +457,7 @@ paths:
|
|
457
457
|
schema:
|
458
458
|
$ref: '#/components/schemas/ApiAppCreateRequest'
|
459
459
|
responses:
|
460
|
-
|
460
|
+
201:
|
461
461
|
description: 'successful operation'
|
462
462
|
headers:
|
463
463
|
X-RateLimit-Limit:
|
@@ -1684,7 +1684,7 @@ paths:
|
|
1684
1684
|
description: |-
|
1685
1685
|
Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter to be signed in an embedded iFrame. These embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign.
|
1686
1686
|
|
1687
|
-
**NOTE
|
1687
|
+
**NOTE:** Only available for Standard plan and higher.
|
1688
1688
|
operationId: signatureRequestBulkCreateEmbeddedWithTemplate
|
1689
1689
|
requestBody:
|
1690
1690
|
required: true
|
@@ -1794,7 +1794,7 @@ paths:
|
|
1794
1794
|
description: |-
|
1795
1795
|
Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter.
|
1796
1796
|
|
1797
|
-
**NOTE
|
1797
|
+
**NOTE:** Only available for Standard plan and higher.
|
1798
1798
|
operationId: signatureRequestBulkSendWithTemplate
|
1799
1799
|
requestBody:
|
1800
1800
|
required: true
|
@@ -1910,7 +1910,7 @@ paths:
|
|
1910
1910
|
|
1911
1911
|
To be eligible for cancelation, a signature request must have been sent successfully, must not yet have been signed by all signers, and you must either be the sender or own the API app under which it was sent. A partially signed signature request can be canceled.
|
1912
1912
|
|
1913
|
-
**NOTE
|
1913
|
+
**NOTE:** To remove your access to a completed signature request, use the endpoint: `POST /signature_request/remove/[:signature_request_id]`.
|
1914
1914
|
operationId: signatureRequestCancel
|
1915
1915
|
parameters:
|
1916
1916
|
-
|
@@ -2013,7 +2013,7 @@ paths:
|
|
2013
2013
|
tags:
|
2014
2014
|
- 'Signature Request'
|
2015
2015
|
summary: 'Create Embedded Signature Request'
|
2016
|
-
description: 'Creates a new SignatureRequest with the submitted documents to be signed in an embedded iFrame. If form_fields_per_document is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents.
|
2016
|
+
description: 'Creates a new SignatureRequest with the submitted documents to be signed in an embedded iFrame. If form_fields_per_document is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign.'
|
2017
2017
|
operationId: signatureRequestCreateEmbedded
|
2018
2018
|
requestBody:
|
2019
2019
|
required: true
|
@@ -2123,7 +2123,7 @@ paths:
|
|
2123
2123
|
tags:
|
2124
2124
|
- 'Signature Request'
|
2125
2125
|
summary: 'Create Embedded Signature Request with Template'
|
2126
|
-
description: 'Creates a new SignatureRequest based on the given Template(s) to be signed in an embedded iFrame.
|
2126
|
+
description: 'Creates a new SignatureRequest based on the given Template(s) to be signed in an embedded iFrame. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign.'
|
2127
2127
|
operationId: signatureRequestCreateEmbeddedWithTemplate
|
2128
2128
|
requestBody:
|
2129
2129
|
required: true
|
@@ -2483,6 +2483,13 @@ paths:
|
|
2483
2483
|
schema:
|
2484
2484
|
type: string
|
2485
2485
|
example: fa5c8a0b0f492d768749333ad6fcc214c111e967
|
2486
|
+
-
|
2487
|
+
name: force_download
|
2488
|
+
in: query
|
2489
|
+
description: 'By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser.'
|
2490
|
+
schema:
|
2491
|
+
type: integer
|
2492
|
+
default: 1
|
2486
2493
|
responses:
|
2487
2494
|
200:
|
2488
2495
|
description: 'successful operation'
|
@@ -2920,7 +2927,7 @@ paths:
|
|
2920
2927
|
description: |-
|
2921
2928
|
Sends an email to the signer reminding them to sign the signature request. You cannot send a reminder within 1 hour of the last reminder that was sent. This includes manual AND automatic reminders.
|
2922
2929
|
|
2923
|
-
**NOTE
|
2930
|
+
**NOTE:** This action can **not** be used with embedded signature requests.
|
2924
2931
|
operationId: signatureRequestRemind
|
2925
2932
|
parameters:
|
2926
2933
|
-
|
@@ -3364,7 +3371,9 @@ paths:
|
|
3364
3371
|
description: |-
|
3365
3372
|
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
3373
|
|
3367
|
-
|
3374
|
+
Updating the email address of a signer will generate a new `signature_id` value.
|
3375
|
+
|
3376
|
+
**NOTE:** This action cannot be performed on a signature request with an appended signature page.
|
3368
3377
|
operationId: signatureRequestUpdate
|
3369
3378
|
parameters:
|
3370
3379
|
-
|
@@ -4311,7 +4320,7 @@ paths:
|
|
4311
4320
|
account_id:
|
4312
4321
|
$ref: '#/components/examples/TeamRemoveMemberRequestAccountIdExample'
|
4313
4322
|
responses:
|
4314
|
-
|
4323
|
+
201:
|
4315
4324
|
description: 'successful operation'
|
4316
4325
|
headers:
|
4317
4326
|
X-RateLimit-Limit:
|
@@ -4630,6 +4639,120 @@ paths:
|
|
4630
4639
|
seo:
|
4631
4640
|
title: 'Add User to Template | REST API | Dropbox Sign for Developers'
|
4632
4641
|
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.'
|
4642
|
+
/template/create:
|
4643
|
+
post:
|
4644
|
+
tags:
|
4645
|
+
- Template
|
4646
|
+
summary: 'Create Template'
|
4647
|
+
description: 'Creates a template that can then be used.'
|
4648
|
+
operationId: templateCreate
|
4649
|
+
requestBody:
|
4650
|
+
required: true
|
4651
|
+
content:
|
4652
|
+
application/json:
|
4653
|
+
schema:
|
4654
|
+
$ref: '#/components/schemas/TemplateCreateRequest'
|
4655
|
+
examples:
|
4656
|
+
default_example:
|
4657
|
+
$ref: '#/components/examples/TemplateCreateRequestDefaultExample'
|
4658
|
+
form_fields_per_document:
|
4659
|
+
$ref: '#/components/examples/TemplateCreateRequestFormFieldsPerDocumentExample'
|
4660
|
+
form_field_groups:
|
4661
|
+
$ref: '#/components/examples/TemplateCreateRequestFormFieldGroupsExample'
|
4662
|
+
form_field_rules:
|
4663
|
+
$ref: '#/components/examples/TemplateCreateRequestFormFieldRulesExample'
|
4664
|
+
multipart/form-data:
|
4665
|
+
schema:
|
4666
|
+
$ref: '#/components/schemas/TemplateCreateRequest'
|
4667
|
+
responses:
|
4668
|
+
200:
|
4669
|
+
description: 'successful operation'
|
4670
|
+
headers:
|
4671
|
+
X-RateLimit-Limit:
|
4672
|
+
$ref: '#/components/headers/X-RateLimit-Limit'
|
4673
|
+
X-RateLimit-Remaining:
|
4674
|
+
$ref: '#/components/headers/X-RateLimit-Remaining'
|
4675
|
+
X-Ratelimit-Reset:
|
4676
|
+
$ref: '#/components/headers/X-Ratelimit-Reset'
|
4677
|
+
content:
|
4678
|
+
application/json:
|
4679
|
+
schema:
|
4680
|
+
$ref: '#/components/schemas/TemplateCreateResponse'
|
4681
|
+
examples:
|
4682
|
+
default_example:
|
4683
|
+
$ref: '#/components/examples/TemplateCreateResponseExample'
|
4684
|
+
4XX:
|
4685
|
+
description: failed_operation
|
4686
|
+
content:
|
4687
|
+
application/json:
|
4688
|
+
schema:
|
4689
|
+
$ref: '#/components/schemas/ErrorResponse'
|
4690
|
+
examples:
|
4691
|
+
400_example:
|
4692
|
+
$ref: '#/components/examples/Error400ResponseExample'
|
4693
|
+
401_example:
|
4694
|
+
$ref: '#/components/examples/Error401ResponseExample'
|
4695
|
+
402_example:
|
4696
|
+
$ref: '#/components/examples/Error402ResponseExample'
|
4697
|
+
403_example:
|
4698
|
+
$ref: '#/components/examples/Error403ResponseExample'
|
4699
|
+
404_example:
|
4700
|
+
$ref: '#/components/examples/Error404ResponseExample'
|
4701
|
+
409_example:
|
4702
|
+
$ref: '#/components/examples/Error409ResponseExample'
|
4703
|
+
4XX_example:
|
4704
|
+
$ref: '#/components/examples/Error4XXResponseExample'
|
4705
|
+
security:
|
4706
|
+
-
|
4707
|
+
api_key: []
|
4708
|
+
-
|
4709
|
+
oauth2:
|
4710
|
+
- template_access
|
4711
|
+
x-codeSamples:
|
4712
|
+
-
|
4713
|
+
lang: PHP
|
4714
|
+
label: PHP
|
4715
|
+
source:
|
4716
|
+
$ref: examples/TemplateCreate.php
|
4717
|
+
-
|
4718
|
+
lang: 'C#'
|
4719
|
+
label: 'C#'
|
4720
|
+
source:
|
4721
|
+
$ref: examples/TemplateCreate.cs
|
4722
|
+
-
|
4723
|
+
lang: JavaScript
|
4724
|
+
label: JavaScript
|
4725
|
+
source:
|
4726
|
+
$ref: examples/TemplateCreate.js
|
4727
|
+
-
|
4728
|
+
lang: TypeScript
|
4729
|
+
label: TypeScript
|
4730
|
+
source:
|
4731
|
+
$ref: examples/TemplateCreate.ts
|
4732
|
+
-
|
4733
|
+
lang: Java
|
4734
|
+
label: Java
|
4735
|
+
source:
|
4736
|
+
$ref: examples/TemplateCreate.java
|
4737
|
+
-
|
4738
|
+
lang: Ruby
|
4739
|
+
label: Ruby
|
4740
|
+
source:
|
4741
|
+
$ref: examples/TemplateCreate.rb
|
4742
|
+
-
|
4743
|
+
lang: Python
|
4744
|
+
label: Python
|
4745
|
+
source:
|
4746
|
+
$ref: examples/TemplateCreate.py
|
4747
|
+
-
|
4748
|
+
lang: cURL
|
4749
|
+
label: cURL
|
4750
|
+
source:
|
4751
|
+
$ref: examples/TemplateCreate.sh
|
4752
|
+
x-meta:
|
4753
|
+
seo:
|
4754
|
+
title: 'Create Template | Dropbox Sign for Developers'
|
4755
|
+
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
4756
|
/template/create_embedded_draft:
|
4634
4757
|
post:
|
4635
4758
|
tags:
|
@@ -5098,6 +5221,13 @@ paths:
|
|
5098
5221
|
schema:
|
5099
5222
|
type: string
|
5100
5223
|
example: f57db65d3f933b5316d398057a36176831451a35
|
5224
|
+
-
|
5225
|
+
name: force_download
|
5226
|
+
in: query
|
5227
|
+
description: 'By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser.'
|
5228
|
+
schema:
|
5229
|
+
type: integer
|
5230
|
+
default: 1
|
5101
5231
|
responses:
|
5102
5232
|
200:
|
5103
5233
|
description: 'successful operation'
|
@@ -5785,7 +5915,7 @@ paths:
|
|
5785
5915
|
description: |-
|
5786
5916
|
Creates a new Draft that can be claimed and used in an embedded iFrame. The first authenticated user to access the URL will claim the Draft and will be shown the "Request signature" page with the Draft loaded. Subsequent access to the claim URL will result in a `404`. For this embedded endpoint the `requester_email_address` parameter is required.
|
5787
5917
|
|
5788
|
-
**NOTE
|
5918
|
+
**NOTE:** Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign.
|
5789
5919
|
operationId: unclaimedDraftCreateEmbedded
|
5790
5920
|
requestBody:
|
5791
5921
|
required: true
|
@@ -5903,7 +6033,7 @@ paths:
|
|
5903
6033
|
description: |-
|
5904
6034
|
Creates a new Draft with a previously saved template(s) that can be claimed and used in an embedded iFrame. The first authenticated user to access the URL will claim the Draft and will be shown the "Request signature" page with the Draft loaded. Subsequent access to the claim URL will result in a `404`. For this embedded endpoint the `requester_email_address` parameter is required.
|
5905
6035
|
|
5906
|
-
**NOTE
|
6036
|
+
**NOTE:** Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign.
|
5907
6037
|
operationId: unclaimedDraftCreateEmbeddedWithTemplate
|
5908
6038
|
requestBody:
|
5909
6039
|
required: true
|
@@ -6016,7 +6146,7 @@ paths:
|
|
6016
6146
|
description: |-
|
6017
6147
|
Creates a new signature request from an embedded request that can be edited prior to being sent to the recipients. Parameter `test_mode` can be edited prior to request. Signers can be edited in embedded editor. Requester's email address will remain unchanged if `requester_email_address` parameter is not set.
|
6018
6148
|
|
6019
|
-
**NOTE
|
6149
|
+
**NOTE:** Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign.
|
6020
6150
|
operationId: unclaimedDraftEditAndResend
|
6021
6151
|
parameters:
|
6022
6152
|
-
|
@@ -6263,7 +6393,7 @@ components:
|
|
6263
6393
|
description: |-
|
6264
6394
|
This allows the requester to enable the preview experience (i.e. does not allow the requester's end user to add any additional fields via the editor).
|
6265
6395
|
|
6266
|
-
**
|
6396
|
+
**NOTE:** This parameter overwrites `show_preview=true` (if set).
|
6267
6397
|
type: boolean
|
6268
6398
|
default: false
|
6269
6399
|
show_preview:
|
@@ -6279,307 +6409,89 @@ components:
|
|
6279
6409
|
type: boolean
|
6280
6410
|
default: false
|
6281
6411
|
type: object
|
6282
|
-
|
6283
|
-
|
6284
|
-
|
6285
|
-
-
|
6286
|
-
-
|
6287
|
-
-
|
6288
|
-
-
|
6289
|
-
|
6290
|
-
|
6291
|
-
|
6292
|
-
|
6293
|
-
|
6294
|
-
|
6295
|
-
|
6296
|
-
|
6297
|
-
|
6298
|
-
|
6299
|
-
|
6300
|
-
|
6301
|
-
|
6302
|
-
|
6303
|
-
|
6304
|
-
|
6305
|
-
|
6306
|
-
|
6307
|
-
|
6308
|
-
|
6309
|
-
|
6310
|
-
|
6311
|
-
|
6312
|
-
|
6313
|
-
|
6314
|
-
|
6315
|
-
|
6316
|
-
|
6317
|
-
|
6318
|
-
|
6319
|
-
|
6320
|
-
|
6321
|
-
|
6322
|
-
|
6323
|
-
|
6324
|
-
|
6325
|
-
|
6326
|
-
|
6327
|
-
|
6328
|
-
|
6329
|
-
|
6330
|
-
|
6331
|
-
|
6332
|
-
|
6333
|
-
|
6334
|
-
|
6335
|
-
|
6336
|
-
|
6337
|
-
|
6338
|
-
|
6339
|
-
|
6340
|
-
|
6341
|
-
|
6342
|
-
|
6343
|
-
|
6344
|
-
|
6345
|
-
|
6346
|
-
-
|
6347
|
-
|
6348
|
-
|
6349
|
-
|
6350
|
-
|
6351
|
-
|
6352
|
-
|
6353
|
-
|
6354
|
-
|
6355
|
-
|
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
|
-
OAuthTokenGenerateRequest:
|
6503
|
-
required:
|
6504
|
-
- client_id
|
6505
|
-
- client_secret
|
6506
|
-
- code
|
6507
|
-
- state
|
6508
|
-
- grant_type
|
6509
|
-
properties:
|
6510
|
-
client_id:
|
6511
|
-
description: 'The client id of the app requesting authorization.'
|
6512
|
-
type: string
|
6513
|
-
client_secret:
|
6514
|
-
description: 'The secret token of your app.'
|
6515
|
-
type: string
|
6516
|
-
code:
|
6517
|
-
description: 'The code passed to your callback when the user granted access.'
|
6518
|
-
type: string
|
6519
|
-
grant_type:
|
6520
|
-
description: 'When generating a new token use `authorization_code`.'
|
6521
|
-
type: string
|
6522
|
-
default: authorization_code
|
6523
|
-
state:
|
6524
|
-
description: 'Same as the state you specified earlier.'
|
6525
|
-
type: string
|
6526
|
-
type: object
|
6527
|
-
OAuthTokenRefreshRequest:
|
6528
|
-
required:
|
6529
|
-
- grant_type
|
6530
|
-
- refresh_token
|
6531
|
-
properties:
|
6532
|
-
grant_type:
|
6533
|
-
description: 'When refreshing an existing token use `refresh_token`.'
|
6534
|
-
type: string
|
6535
|
-
default: refresh_token
|
6536
|
-
refresh_token:
|
6537
|
-
description: 'The token provided when you got the expired access token.'
|
6538
|
-
type: string
|
6539
|
-
type: object
|
6540
|
-
ReportCreateRequest:
|
6541
|
-
required:
|
6542
|
-
- start_date
|
6543
|
-
- end_date
|
6544
|
-
- report_type
|
6545
|
-
properties:
|
6546
|
-
end_date:
|
6547
|
-
description: 'The (inclusive) end date for the report data in `MM/DD/YYYY` format.'
|
6548
|
-
type: string
|
6549
|
-
report_type:
|
6550
|
-
description: 'The type(s) of the report you are requesting. Allowed values are `user_activity` and `document_status`. User activity reports contain list of all users and their activity during the specified date range. Document status report contain a list of signature requests created in the specified time range (and their status).'
|
6551
|
-
type: array
|
6552
|
-
items:
|
6553
|
-
type: string
|
6554
|
-
enum:
|
6555
|
-
- user_activity
|
6556
|
-
- document_status
|
6557
|
-
maxItems: 2
|
6558
|
-
minItems: 1
|
6559
|
-
start_date:
|
6560
|
-
description: 'The (inclusive) start date for the report data in `MM/DD/YYYY` format.'
|
6561
|
-
type: string
|
6562
|
-
type: object
|
6563
|
-
SignatureRequestBulkCreateEmbeddedWithTemplateRequest:
|
6564
|
-
required:
|
6565
|
-
- client_id
|
6566
|
-
- template_ids
|
6567
|
-
properties:
|
6568
|
-
template_ids:
|
6569
|
-
description: 'Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used.'
|
6570
|
-
type: array
|
6571
|
-
items:
|
6572
|
-
type: string
|
6573
|
-
signer_file:
|
6574
|
-
description: |-
|
6575
|
-
`signer_file` is a CSV file defining values and options for signer fields. Required unless a `signer_list` is used, you may not use both. The CSV can have the following columns:
|
6412
|
+
OAuthTokenGenerateRequest:
|
6413
|
+
required:
|
6414
|
+
- client_id
|
6415
|
+
- client_secret
|
6416
|
+
- code
|
6417
|
+
- state
|
6418
|
+
- grant_type
|
6419
|
+
properties:
|
6420
|
+
client_id:
|
6421
|
+
description: 'The client id of the app requesting authorization.'
|
6422
|
+
type: string
|
6423
|
+
client_secret:
|
6424
|
+
description: 'The secret token of your app.'
|
6425
|
+
type: string
|
6426
|
+
code:
|
6427
|
+
description: 'The code passed to your callback when the user granted access.'
|
6428
|
+
type: string
|
6429
|
+
grant_type:
|
6430
|
+
description: 'When generating a new token use `authorization_code`.'
|
6431
|
+
type: string
|
6432
|
+
default: authorization_code
|
6433
|
+
state:
|
6434
|
+
description: 'Same as the state you specified earlier.'
|
6435
|
+
type: string
|
6436
|
+
type: object
|
6437
|
+
OAuthTokenRefreshRequest:
|
6438
|
+
required:
|
6439
|
+
- grant_type
|
6440
|
+
- refresh_token
|
6441
|
+
properties:
|
6442
|
+
grant_type:
|
6443
|
+
description: 'When refreshing an existing token use `refresh_token`.'
|
6444
|
+
type: string
|
6445
|
+
default: refresh_token
|
6446
|
+
refresh_token:
|
6447
|
+
description: 'The token provided when you got the expired access token.'
|
6448
|
+
type: string
|
6449
|
+
type: object
|
6450
|
+
ReportCreateRequest:
|
6451
|
+
required:
|
6452
|
+
- start_date
|
6453
|
+
- end_date
|
6454
|
+
- report_type
|
6455
|
+
properties:
|
6456
|
+
end_date:
|
6457
|
+
description: 'The (inclusive) end date for the report data in `MM/DD/YYYY` format.'
|
6458
|
+
type: string
|
6459
|
+
report_type:
|
6460
|
+
description: 'The type(s) of the report you are requesting. Allowed values are `user_activity` and `document_status`. User activity reports contain list of all users and their activity during the specified date range. Document status report contain a list of signature requests created in the specified time range (and their status).'
|
6461
|
+
type: array
|
6462
|
+
items:
|
6463
|
+
type: string
|
6464
|
+
enum:
|
6465
|
+
- user_activity
|
6466
|
+
- document_status
|
6467
|
+
maxItems: 2
|
6468
|
+
minItems: 1
|
6469
|
+
start_date:
|
6470
|
+
description: 'The (inclusive) start date for the report data in `MM/DD/YYYY` format.'
|
6471
|
+
type: string
|
6472
|
+
type: object
|
6473
|
+
SignatureRequestBulkCreateEmbeddedWithTemplateRequest:
|
6474
|
+
required:
|
6475
|
+
- client_id
|
6476
|
+
- template_ids
|
6477
|
+
properties:
|
6478
|
+
template_ids:
|
6479
|
+
description: 'Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used.'
|
6480
|
+
type: array
|
6481
|
+
items:
|
6482
|
+
type: string
|
6483
|
+
signer_file:
|
6484
|
+
description: |-
|
6485
|
+
`signer_file` is a CSV file defining values and options for signer fields. Required unless a `signer_list` is used, you may not use both. The CSV can have the following columns:
|
6576
6486
|
|
6577
6487
|
- `name`: the name of the signer filling the role of RoleName
|
6578
6488
|
- `email_address`: email address of the signer filling the role of RoleName
|
6579
6489
|
- `pin`: the 4- to 12-character access code that will secure this signer's signature page (optional)
|
6580
6490
|
- `sms_phone_number`: An E.164 formatted phone number that will receive a code via SMS to access this signer's signature page. (optional)
|
6581
6491
|
|
6582
|
-
|
6492
|
+
By using the feature, you agree you are responsible for obtaining a signer's consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. [Learn more](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on).
|
6493
|
+
|
6494
|
+
**NOTE:** Not available in test mode and requires a Standard plan or higher.
|
6583
6495
|
- `*_field`: any column with a _field" suffix will be treated as a custom field (optional)
|
6584
6496
|
|
6585
6497
|
You may only specify field values here, any other options should be set in the custom_fields request parameter.
|
@@ -6666,7 +6578,9 @@ components:
|
|
6666
6578
|
- `pin`: the 4- to 12-character access code that will secure this signer's signature page (optional)
|
6667
6579
|
- `sms_phone_number`: An E.164 formatted phone number that will receive a code via SMS to access this signer's signature page. (optional)
|
6668
6580
|
|
6669
|
-
|
6581
|
+
By using the feature, you agree you are responsible for obtaining a signer's consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. [Learn more](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on).
|
6582
|
+
|
6583
|
+
**NOTE:** Not available in test mode and requires a Standard plan or higher.
|
6670
6584
|
- `*_field`: any column with a _field" suffix will be treated as a custom field (optional)
|
6671
6585
|
|
6672
6586
|
You may only specify field values here, any other options should be set in the custom_fields request parameter.
|
@@ -6780,7 +6694,7 @@ components:
|
|
6780
6694
|
description: |-
|
6781
6695
|
Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.
|
6782
6696
|
|
6783
|
-
**
|
6697
|
+
**NOTE:** Only available for Premium plan.
|
6784
6698
|
type: boolean
|
6785
6699
|
default: false
|
6786
6700
|
attachments:
|
@@ -6823,7 +6737,7 @@ components:
|
|
6823
6737
|
description: |-
|
6824
6738
|
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).)
|
6825
6739
|
|
6826
|
-
**NOTE
|
6740
|
+
**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.
|
6827
6741
|
|
6828
6742
|
* Text Field use `SubFormFieldsPerDocumentText`
|
6829
6743
|
* Dropdown Field use `SubFormFieldsPerDocumentDropdown`
|
@@ -6842,7 +6756,7 @@ components:
|
|
6842
6756
|
description: |-
|
6843
6757
|
Enables automatic Text Tag removal when set to true.
|
6844
6758
|
|
6845
|
-
**NOTE
|
6759
|
+
**NOTE:** Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information.
|
6846
6760
|
type: boolean
|
6847
6761
|
default: false
|
6848
6762
|
message:
|
@@ -6879,14 +6793,13 @@ components:
|
|
6879
6793
|
description: |-
|
6880
6794
|
Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.
|
6881
6795
|
|
6882
|
-
|
6796
|
+
**NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature.
|
6883
6797
|
type: boolean
|
6884
6798
|
default: false
|
6885
6799
|
expires_at:
|
6886
6800
|
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
6801
|
type: integer
|
6888
6802
|
nullable: true
|
6889
|
-
x-beta: closed
|
6890
6803
|
type: object
|
6891
6804
|
SignatureRequestCreateEmbeddedWithTemplateRequest:
|
6892
6805
|
required:
|
@@ -6968,7 +6881,7 @@ components:
|
|
6968
6881
|
description: |-
|
6969
6882
|
Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.
|
6970
6883
|
|
6971
|
-
|
6884
|
+
**NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature.
|
6972
6885
|
type: boolean
|
6973
6886
|
default: false
|
6974
6887
|
type: object
|
@@ -7027,7 +6940,7 @@ components:
|
|
7027
6940
|
description: |-
|
7028
6941
|
Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.
|
7029
6942
|
|
7030
|
-
**
|
6943
|
+
**NOTE:** Only available for Premium plan and higher.
|
7031
6944
|
type: boolean
|
7032
6945
|
default: false
|
7033
6946
|
attachments:
|
@@ -7070,7 +6983,7 @@ components:
|
|
7070
6983
|
description: |-
|
7071
6984
|
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).)
|
7072
6985
|
|
7073
|
-
**NOTE
|
6986
|
+
**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.
|
7074
6987
|
|
7075
6988
|
* Text Field use `SubFormFieldsPerDocumentText`
|
7076
6989
|
* Dropdown Field use `SubFormFieldsPerDocumentDropdown`
|
@@ -7089,7 +7002,7 @@ components:
|
|
7089
7002
|
description: |-
|
7090
7003
|
Enables automatic Text Tag removal when set to true.
|
7091
7004
|
|
7092
|
-
**NOTE
|
7005
|
+
**NOTE:** Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information.
|
7093
7006
|
type: boolean
|
7094
7007
|
default: false
|
7095
7008
|
is_qualified_signature:
|
@@ -7097,10 +7010,20 @@ components:
|
|
7097
7010
|
Send with a value of `true` if you wish to enable
|
7098
7011
|
[Qualified Electronic Signatures](https://www.hellosign.com/features/qualified-electronic-signatures) (QES),
|
7099
7012
|
which requires a face-to-face call to verify the signer's identity.<br>
|
7100
|
-
**
|
7013
|
+
**NOTE:** QES is only available on the Premium API plan as an add-on purchase.
|
7101
7014
|
Cannot be used in `test_mode`. Only works on requests with one signer.
|
7102
7015
|
type: boolean
|
7103
7016
|
default: false
|
7017
|
+
deprecated: true
|
7018
|
+
x-hideOn: doc
|
7019
|
+
is_eid:
|
7020
|
+
description: |-
|
7021
|
+
Send with a value of `true` if you wish to enable
|
7022
|
+
[electronic identification (eID)](https://www.hellosign.com/features/electronic-id),
|
7023
|
+
which requires the signer to verify their identity with an eID provider to sign a document.<br>
|
7024
|
+
**NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer.
|
7025
|
+
type: boolean
|
7026
|
+
default: false
|
7104
7027
|
message:
|
7105
7028
|
description: 'The custom message in the email that will be sent to the signers.'
|
7106
7029
|
type: string
|
@@ -7138,7 +7061,6 @@ components:
|
|
7138
7061
|
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
7062
|
type: integer
|
7140
7063
|
nullable: true
|
7141
|
-
x-beta: closed
|
7142
7064
|
type: object
|
7143
7065
|
SignatureRequestSendWithTemplateRequest:
|
7144
7066
|
description: ''
|
@@ -7190,10 +7112,20 @@ components:
|
|
7190
7112
|
Send with a value of `true` if you wish to enable
|
7191
7113
|
[Qualified Electronic Signatures](https://www.hellosign.com/features/qualified-electronic-signatures) (QES),
|
7192
7114
|
which requires a face-to-face call to verify the signer's identity.<br>
|
7193
|
-
**
|
7115
|
+
**NOTE:** QES is only available on the Premium API plan as an add-on purchase.
|
7194
7116
|
Cannot be used in `test_mode`. Only works on requests with one signer.
|
7195
7117
|
type: boolean
|
7196
7118
|
default: false
|
7119
|
+
deprecated: true
|
7120
|
+
x-hideOn: doc
|
7121
|
+
is_eid:
|
7122
|
+
description: |-
|
7123
|
+
Send with a value of `true` if you wish to enable
|
7124
|
+
[electronic identification (eID)](https://www.hellosign.com/features/electronic-id),
|
7125
|
+
which requires the signer to verify their identity with an eID provider to sign a document.<br>
|
7126
|
+
**NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer.
|
7127
|
+
type: boolean
|
7128
|
+
default: false
|
7197
7129
|
message:
|
7198
7130
|
description: 'The custom message in the email that will be sent to the signers.'
|
7199
7131
|
type: string
|
@@ -7237,14 +7169,16 @@ components:
|
|
7237
7169
|
description: |-
|
7238
7170
|
The new email address for the recipient.
|
7239
7171
|
|
7240
|
-
|
7172
|
+
This will generate a new `signature_id` value.
|
7173
|
+
|
7174
|
+
**NOTE:** Optional if `name` is provided.
|
7241
7175
|
type: string
|
7242
7176
|
format: email
|
7243
7177
|
name:
|
7244
7178
|
description: |-
|
7245
7179
|
The new name for the recipient.
|
7246
7180
|
|
7247
|
-
**NOTE
|
7181
|
+
**NOTE:** Optional if `email_address` is provided.
|
7248
7182
|
type: string
|
7249
7183
|
signature_id:
|
7250
7184
|
description: 'The signature ID for the recipient.'
|
@@ -7253,7 +7187,6 @@ components:
|
|
7253
7187
|
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
7188
|
type: integer
|
7255
7189
|
nullable: true
|
7256
|
-
x-beta: closed
|
7257
7190
|
type: object
|
7258
7191
|
SubAttachment:
|
7259
7192
|
required:
|
@@ -7274,7 +7207,7 @@ components:
|
|
7274
7207
|
description: |-
|
7275
7208
|
The signer's index in the `signers` parameter (0-based indexing).
|
7276
7209
|
|
7277
|
-
**NOTE
|
7210
|
+
**NOTE:** Only one signer can be assigned per attachment.
|
7278
7211
|
type: integer
|
7279
7212
|
type: object
|
7280
7213
|
SubBulkSignerList:
|
@@ -7332,7 +7265,7 @@ components:
|
|
7332
7265
|
description: |-
|
7333
7266
|
Used to create editable merge fields. When the value matches a role passed in with `signers`, that role can edit the data that was pre-filled to that field. This field is optional, but required when this custom field object is set to `required = true`.
|
7334
7267
|
|
7335
|
-
**
|
7268
|
+
**NOTE:** Editable merge fields are only supported for single signer requests (or the first signer in ordered signature requests). If used when there are multiple signers in an unordered signature request, the editor value is ignored and the field won't be editable.
|
7336
7269
|
type: string
|
7337
7270
|
name:
|
7338
7271
|
description: 'The name of a custom field. When working with pre-filled data, the custom field''s name must have a matching merge field name or the field will remain empty on the document during signing.'
|
@@ -7366,7 +7299,7 @@ components:
|
|
7366
7299
|
description: |-
|
7367
7300
|
Allows requester to specify the date format (see list of allowed [formats](/api/reference/constants/#date-formats))
|
7368
7301
|
|
7369
|
-
**
|
7302
|
+
**NOTE:** Only available for Premium and higher.
|
7370
7303
|
type: string
|
7371
7304
|
enum:
|
7372
7305
|
- 'MM / DD / YYYY'
|
@@ -7516,19 +7449,396 @@ components:
|
|
7516
7449
|
description: |-
|
7517
7450
|
**values** or **value** is required, but not both.
|
7518
7451
|
|
7519
|
-
The values to match against **operator** when it is one of the following:
|
7452
|
+
The values to match against **operator** when it is one of the following:
|
7453
|
+
|
7454
|
+
- `any`
|
7455
|
+
- `none`
|
7456
|
+
type: array
|
7457
|
+
items:
|
7458
|
+
type: string
|
7459
|
+
type: object
|
7460
|
+
SubFormFieldsPerDocumentCheckbox:
|
7461
|
+
description: 'This class extends `SubFormFieldsPerDocumentBase`.'
|
7462
|
+
allOf:
|
7463
|
+
-
|
7464
|
+
$ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
|
7465
|
+
-
|
7466
|
+
required:
|
7467
|
+
- type
|
7468
|
+
- is_checked
|
7469
|
+
properties:
|
7470
|
+
type:
|
7471
|
+
description: 'A yes/no checkbox. Use the `SubFormFieldsPerDocumentCheckbox` class.'
|
7472
|
+
type: string
|
7473
|
+
default: checkbox
|
7474
|
+
group:
|
7475
|
+
description: 'String referencing group defined in `form_field_groups` parameter.'
|
7476
|
+
type: string
|
7477
|
+
is_checked:
|
7478
|
+
description: '`true` for checking the checkbox field by default, otherwise `false`.'
|
7479
|
+
type: boolean
|
7480
|
+
type: object
|
7481
|
+
SubFormFieldsPerDocumentCheckboxMerge:
|
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 checkbox field that has default value set using pre-filled data. Use the `SubFormFieldsPerDocumentCheckboxMerge` class.'
|
7492
|
+
type: string
|
7493
|
+
default: checkbox-merge
|
7494
|
+
type: object
|
7495
|
+
SubFormFieldsPerDocumentDateSigned:
|
7496
|
+
description: 'This class extends `SubFormFieldsPerDocumentBase`.'
|
7497
|
+
allOf:
|
7498
|
+
-
|
7499
|
+
$ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
|
7500
|
+
-
|
7501
|
+
required:
|
7502
|
+
- type
|
7503
|
+
properties:
|
7504
|
+
type:
|
7505
|
+
description: 'A date. Use the `SubFormFieldsPerDocumentDateSigned` class.'
|
7506
|
+
type: string
|
7507
|
+
default: date_signed
|
7508
|
+
font_family:
|
7509
|
+
description: 'Font family for the field.'
|
7510
|
+
type: string
|
7511
|
+
enum:
|
7512
|
+
- helvetica
|
7513
|
+
- arial
|
7514
|
+
- courier
|
7515
|
+
- calibri
|
7516
|
+
- cambria
|
7517
|
+
- georgia
|
7518
|
+
- times
|
7519
|
+
- trebuchet
|
7520
|
+
- verdana
|
7521
|
+
- roboto
|
7522
|
+
- robotoMono
|
7523
|
+
- notoSans
|
7524
|
+
- notoSerif
|
7525
|
+
- notoCJK-JP-Regular
|
7526
|
+
- notoHebrew-Regular
|
7527
|
+
- notoSanThaiMerged
|
7528
|
+
font_size:
|
7529
|
+
description: |-
|
7530
|
+
The initial px font size for the field contents. Can be any integer value between `7` and `49`.
|
7531
|
+
|
7532
|
+
**NOTE:** Font size may be reduced during processing in order to fit the contents within the dimensions of the field.
|
7533
|
+
type: integer
|
7534
|
+
default: 12
|
7535
|
+
type: object
|
7536
|
+
SubFormFieldsPerDocumentDropdown:
|
7537
|
+
description: 'This class extends `SubFormFieldsPerDocumentBase`.'
|
7538
|
+
allOf:
|
7539
|
+
-
|
7540
|
+
$ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
|
7541
|
+
-
|
7542
|
+
required:
|
7543
|
+
- type
|
7544
|
+
- options
|
7545
|
+
properties:
|
7546
|
+
type:
|
7547
|
+
description: 'An input field for dropdowns. Use the `SubFormFieldsPerDocumentDropdown` class.'
|
7548
|
+
type: string
|
7549
|
+
default: dropdown
|
7550
|
+
options:
|
7551
|
+
description: 'Array of string values representing dropdown values.'
|
7552
|
+
type: array
|
7553
|
+
items:
|
7554
|
+
type: string
|
7555
|
+
minItems: 1
|
7556
|
+
content:
|
7557
|
+
description: 'Selected value in `options` array. Value must exist in array.'
|
7558
|
+
type: string
|
7559
|
+
font_family:
|
7560
|
+
description: 'Font family for the field.'
|
7561
|
+
type: string
|
7562
|
+
enum:
|
7563
|
+
- helvetica
|
7564
|
+
- arial
|
7565
|
+
- courier
|
7566
|
+
- calibri
|
7567
|
+
- cambria
|
7568
|
+
- georgia
|
7569
|
+
- times
|
7570
|
+
- trebuchet
|
7571
|
+
- verdana
|
7572
|
+
- roboto
|
7573
|
+
- robotoMono
|
7574
|
+
- notoSans
|
7575
|
+
- notoSerif
|
7576
|
+
- notoCJK-JP-Regular
|
7577
|
+
- notoHebrew-Regular
|
7578
|
+
- notoSanThaiMerged
|
7579
|
+
font_size:
|
7580
|
+
description: |-
|
7581
|
+
The initial px font size for the field contents. Can be any integer value between `7` and `49`.
|
7582
|
+
|
7583
|
+
**NOTE:** Font size may be reduced during processing in order to fit the contents within the dimensions of the field.
|
7584
|
+
type: integer
|
7585
|
+
default: 12
|
7586
|
+
type: object
|
7587
|
+
SubFormFieldsPerDocumentHyperlink:
|
7588
|
+
description: 'This class extends `SubFormFieldsPerDocumentBase`.'
|
7589
|
+
allOf:
|
7590
|
+
-
|
7591
|
+
$ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
|
7592
|
+
-
|
7593
|
+
required:
|
7594
|
+
- type
|
7595
|
+
- content
|
7596
|
+
- content_url
|
7597
|
+
properties:
|
7598
|
+
type:
|
7599
|
+
description: 'A hyperlink field. Use the `SubFormFieldsPerDocumentHyperlink` class.'
|
7600
|
+
type: string
|
7601
|
+
default: hyperlink
|
7602
|
+
content:
|
7603
|
+
description: 'Link Text.'
|
7604
|
+
type: string
|
7605
|
+
content_url:
|
7606
|
+
description: 'Link URL.'
|
7607
|
+
type: string
|
7608
|
+
font_family:
|
7609
|
+
description: 'Font family for the field.'
|
7610
|
+
type: string
|
7611
|
+
enum:
|
7612
|
+
- helvetica
|
7613
|
+
- arial
|
7614
|
+
- courier
|
7615
|
+
- calibri
|
7616
|
+
- cambria
|
7617
|
+
- georgia
|
7618
|
+
- times
|
7619
|
+
- trebuchet
|
7620
|
+
- verdana
|
7621
|
+
- roboto
|
7622
|
+
- robotoMono
|
7623
|
+
- notoSans
|
7624
|
+
- notoSerif
|
7625
|
+
- notoCJK-JP-Regular
|
7626
|
+
- notoHebrew-Regular
|
7627
|
+
- notoSanThaiMerged
|
7628
|
+
font_size:
|
7629
|
+
description: |-
|
7630
|
+
The initial px font size for the field contents. Can be any integer value between `7` and `49`.
|
7631
|
+
|
7632
|
+
**NOTE:** Font size may be reduced during processing in order to fit the contents within the dimensions of the field.
|
7633
|
+
type: integer
|
7634
|
+
default: 12
|
7635
|
+
type: object
|
7636
|
+
SubFormFieldsPerDocumentInitials:
|
7637
|
+
description: 'This class extends `SubFormFieldsPerDocumentBase`.'
|
7638
|
+
allOf:
|
7639
|
+
-
|
7640
|
+
$ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
|
7641
|
+
-
|
7642
|
+
required:
|
7643
|
+
- type
|
7644
|
+
properties:
|
7645
|
+
type:
|
7646
|
+
description: 'An input field for initials. Use the `SubFormFieldsPerDocumentInitials` class.'
|
7647
|
+
type: string
|
7648
|
+
default: initials
|
7649
|
+
type: object
|
7650
|
+
SubFormFieldsPerDocumentRadio:
|
7651
|
+
description: 'This class extends `SubFormFieldsPerDocumentBase`.'
|
7652
|
+
allOf:
|
7653
|
+
-
|
7654
|
+
$ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
|
7655
|
+
-
|
7656
|
+
required:
|
7657
|
+
- type
|
7658
|
+
- group
|
7659
|
+
- is_checked
|
7660
|
+
properties:
|
7661
|
+
type:
|
7662
|
+
description: 'An input field for radios. Use the `SubFormFieldsPerDocumentRadio` class.'
|
7663
|
+
type: string
|
7664
|
+
default: radio
|
7665
|
+
group:
|
7666
|
+
description: 'String referencing group defined in `form_field_groups` parameter.'
|
7667
|
+
type: string
|
7668
|
+
is_checked:
|
7669
|
+
description: '`true` for checking the radio field by default, otherwise `false`. Only one radio field per group can be `true`.'
|
7670
|
+
type: boolean
|
7671
|
+
type: object
|
7672
|
+
SubFormFieldsPerDocumentSignature:
|
7673
|
+
description: 'This class extends `SubFormFieldsPerDocumentBase`.'
|
7674
|
+
allOf:
|
7675
|
+
-
|
7676
|
+
$ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
|
7677
|
+
-
|
7678
|
+
required:
|
7679
|
+
- type
|
7680
|
+
properties:
|
7681
|
+
type:
|
7682
|
+
description: 'A signature input field. Use the `SubFormFieldsPerDocumentSignature` class.'
|
7683
|
+
type: string
|
7684
|
+
default: signature
|
7685
|
+
type: object
|
7686
|
+
SubFormFieldsPerDocumentText:
|
7687
|
+
description: 'This class extends `SubFormFieldsPerDocumentBase`.'
|
7688
|
+
allOf:
|
7689
|
+
-
|
7690
|
+
$ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
|
7691
|
+
-
|
7692
|
+
required:
|
7693
|
+
- type
|
7694
|
+
- options
|
7695
|
+
properties:
|
7696
|
+
type:
|
7697
|
+
description: 'A text input field. Use the `SubFormFieldsPerDocumentText` class.'
|
7698
|
+
type: string
|
7699
|
+
default: text
|
7700
|
+
placeholder:
|
7701
|
+
description: 'Placeholder value for text field.'
|
7702
|
+
type: string
|
7703
|
+
auto_fill_type:
|
7704
|
+
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.'
|
7705
|
+
type: string
|
7706
|
+
link_id:
|
7707
|
+
description: 'Link two or more text fields. Enter data into one linked text field, which automatically fill all other linked text fields.'
|
7708
|
+
type: string
|
7709
|
+
masked:
|
7710
|
+
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`.'
|
7711
|
+
type: boolean
|
7712
|
+
validation_type:
|
7713
|
+
description: |-
|
7714
|
+
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.
|
7715
|
+
|
7716
|
+
**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.
|
7717
|
+
type: string
|
7718
|
+
enum:
|
7719
|
+
- numbers_only
|
7720
|
+
- letters_only
|
7721
|
+
- phone_number
|
7722
|
+
- bank_routing_number
|
7723
|
+
- bank_account_number
|
7724
|
+
- email_address
|
7725
|
+
- zip_code
|
7726
|
+
- social_security_number
|
7727
|
+
- employer_identification_number
|
7728
|
+
- custom_regex
|
7729
|
+
validation_custom_regex:
|
7730
|
+
type: string
|
7731
|
+
validation_custom_regex_format_label:
|
7732
|
+
type: string
|
7733
|
+
content:
|
7734
|
+
description: 'Content of a `me_now` text field'
|
7735
|
+
type: string
|
7736
|
+
font_family:
|
7737
|
+
description: 'Font family for the field.'
|
7738
|
+
type: string
|
7739
|
+
enum:
|
7740
|
+
- helvetica
|
7741
|
+
- arial
|
7742
|
+
- courier
|
7743
|
+
- calibri
|
7744
|
+
- cambria
|
7745
|
+
- georgia
|
7746
|
+
- times
|
7747
|
+
- trebuchet
|
7748
|
+
- verdana
|
7749
|
+
- roboto
|
7750
|
+
- robotoMono
|
7751
|
+
- notoSans
|
7752
|
+
- notoSerif
|
7753
|
+
- notoCJK-JP-Regular
|
7754
|
+
- notoHebrew-Regular
|
7755
|
+
- notoSanThaiMerged
|
7756
|
+
font_size:
|
7757
|
+
description: |-
|
7758
|
+
The initial px font size for the field contents. Can be any integer value between `7` and `49`.
|
7520
7759
|
|
7521
|
-
|
7522
|
-
|
7523
|
-
|
7524
|
-
|
7525
|
-
|
7526
|
-
|
7760
|
+
**NOTE:** Font size may be reduced during processing in order to fit the contents within the dimensions of the field.
|
7761
|
+
type: integer
|
7762
|
+
default: 12
|
7763
|
+
type: object
|
7764
|
+
SubFormFieldsPerDocumentTextMerge:
|
7765
|
+
description: 'This class extends `SubFormFieldsPerDocumentBase`.'
|
7766
|
+
allOf:
|
7767
|
+
-
|
7768
|
+
$ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
|
7769
|
+
-
|
7770
|
+
required:
|
7771
|
+
- type
|
7772
|
+
properties:
|
7773
|
+
type:
|
7774
|
+
description: 'A text field that has default text set using pre-filled data. Use the `SubFormFieldsPerDocumentTextMerge` class.'
|
7775
|
+
type: string
|
7776
|
+
default: text-merge
|
7777
|
+
font_family:
|
7778
|
+
description: 'Font family for the field.'
|
7779
|
+
type: string
|
7780
|
+
enum:
|
7781
|
+
- helvetica
|
7782
|
+
- arial
|
7783
|
+
- courier
|
7784
|
+
- calibri
|
7785
|
+
- cambria
|
7786
|
+
- georgia
|
7787
|
+
- times
|
7788
|
+
- trebuchet
|
7789
|
+
- verdana
|
7790
|
+
- roboto
|
7791
|
+
- robotoMono
|
7792
|
+
- notoSans
|
7793
|
+
- notoSerif
|
7794
|
+
- notoCJK-JP-Regular
|
7795
|
+
- notoHebrew-Regular
|
7796
|
+
- notoSanThaiMerged
|
7797
|
+
font_size:
|
7798
|
+
description: |-
|
7799
|
+
The initial px font size for the field contents. Can be any integer value between `7` and `49`.
|
7800
|
+
|
7801
|
+
**NOTE:** Font size may be reduced during processing in order to fit the contents within the dimensions of the field.
|
7802
|
+
type: integer
|
7803
|
+
default: 12
|
7804
|
+
type: object
|
7805
|
+
SubFormFieldsPerDocumentTypeEnum:
|
7806
|
+
type: string
|
7807
|
+
enum:
|
7808
|
+
- checkbox
|
7809
|
+
- checkbox-merge
|
7810
|
+
- date_signed
|
7811
|
+
- dropdown
|
7812
|
+
- hyperlink
|
7813
|
+
- initials
|
7814
|
+
- signature
|
7815
|
+
- radio
|
7816
|
+
- text
|
7817
|
+
- text-merge
|
7818
|
+
SubFormFieldsPerDocumentFontEnum:
|
7819
|
+
type: string
|
7820
|
+
enum:
|
7821
|
+
- helvetica
|
7822
|
+
- arial
|
7823
|
+
- courier
|
7824
|
+
- calibri
|
7825
|
+
- cambria
|
7826
|
+
- georgia
|
7827
|
+
- times
|
7828
|
+
- trebuchet
|
7829
|
+
- verdana
|
7830
|
+
- roboto
|
7831
|
+
- robotoMono
|
7832
|
+
- notoSans
|
7833
|
+
- notoSerif
|
7834
|
+
- notoCJK-JP-Regular
|
7835
|
+
- notoHebrew-Regular
|
7836
|
+
- notoSanThaiMerged
|
7527
7837
|
SubFormFieldsPerDocumentBase:
|
7528
7838
|
description: |-
|
7529
7839
|
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).)
|
7530
7840
|
|
7531
|
-
**NOTE
|
7841
|
+
**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.
|
7532
7842
|
|
7533
7843
|
* Text Field use `SubFormFieldsPerDocumentText`
|
7534
7844
|
* Dropdown Field use `SubFormFieldsPerDocumentDropdown`
|
@@ -7578,7 +7888,9 @@ components:
|
|
7578
7888
|
description: |-
|
7579
7889
|
Signer index identified by the offset in the signers parameter (0-based indexing), indicating which signer should fill out the field.
|
7580
7890
|
|
7581
|
-
**NOTE
|
7891
|
+
**NOTE:** To set the value of the field as the preparer you must set this to `me_now`
|
7892
|
+
|
7893
|
+
**NOTE:** If type is `text-merge` or `checkbox-merge`, you must set this to sender in order to use pre-filled data.
|
7582
7894
|
type: string
|
7583
7895
|
x-int-or-string: true
|
7584
7896
|
type:
|
@@ -7624,7 +7936,7 @@ components:
|
|
7624
7936
|
description: |-
|
7625
7937
|
Signers belonging to this Group.
|
7626
7938
|
|
7627
|
-
**NOTE
|
7939
|
+
**NOTE:** Only `name`, `email_address`, and `pin` are available to Grouped Signers. We will ignore all other properties, even though they are listed below.
|
7628
7940
|
type: array
|
7629
7941
|
items:
|
7630
7942
|
$ref: '#/components/schemas/SubSignatureRequestSigner'
|
@@ -7701,7 +8013,9 @@ components:
|
|
7701
8013
|
description: |-
|
7702
8014
|
An E.164 formatted phone number.
|
7703
8015
|
|
7704
|
-
|
8016
|
+
By using the feature, you agree you are responsible for obtaining a signer's consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. [Learn more](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on).
|
8017
|
+
|
8018
|
+
**NOTE:** Not available in test mode and requires a Standard plan or higher.
|
7705
8019
|
type: string
|
7706
8020
|
sms_phone_number_type:
|
7707
8021
|
description: |-
|
@@ -7740,7 +8054,9 @@ components:
|
|
7740
8054
|
description: |-
|
7741
8055
|
An E.164 formatted phone number.
|
7742
8056
|
|
7743
|
-
|
8057
|
+
By using the feature, you agree you are responsible for obtaining a signer's consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. [Learn more](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on).
|
8058
|
+
|
8059
|
+
**NOTE:** Not available in test mode and requires a Standard plan or higher.
|
7744
8060
|
type: string
|
7745
8061
|
sms_phone_number_type:
|
7746
8062
|
description: |-
|
@@ -7802,7 +8118,7 @@ components:
|
|
7802
8118
|
description: |-
|
7803
8119
|
This allows the requester to specify the types allowed for creating a signature.
|
7804
8120
|
|
7805
|
-
**
|
8121
|
+
**NOTE:** If `signing_options` are not defined in the request, the allowed types will default to those specified in the account settings.
|
7806
8122
|
required:
|
7807
8123
|
- default_type
|
7808
8124
|
properties:
|
@@ -7835,7 +8151,7 @@ components:
|
|
7835
8151
|
description: |-
|
7836
8152
|
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
8153
|
|
7838
|
-
Take a look at our [white labeling guide](/api/reference/
|
8154
|
+
Take a look at our [white labeling guide](https://developers.hellosign.com/api/reference/premium-branding/) to learn more.
|
7839
8155
|
properties:
|
7840
8156
|
header_background_color:
|
7841
8157
|
type: string
|
@@ -7905,7 +8221,7 @@ components:
|
|
7905
8221
|
description: |-
|
7906
8222
|
A role member will take in a new Team.
|
7907
8223
|
|
7908
|
-
**
|
8224
|
+
**NOTE:** This parameter is used only if `team_id` is provided.
|
7909
8225
|
type: string
|
7910
8226
|
enum:
|
7911
8227
|
- Member
|
@@ -7939,7 +8255,7 @@ components:
|
|
7939
8255
|
description: |-
|
7940
8256
|
The email address of an Account on this Team to receive all documents, templates, and API apps (if applicable) from the removed Account. If not provided, and on an Enterprise plan, this data will remain with the removed Account.
|
7941
8257
|
|
7942
|
-
**
|
8258
|
+
**NOTE:** Only available for Enterprise plans.
|
7943
8259
|
type: string
|
7944
8260
|
format: email
|
7945
8261
|
new_team_id:
|
@@ -7949,7 +8265,7 @@ components:
|
|
7949
8265
|
description: |-
|
7950
8266
|
A new role member will take in a new Team.
|
7951
8267
|
|
7952
|
-
**
|
8268
|
+
**NOTE:** This parameter is used only if `new_team_id` is provided.
|
7953
8269
|
type: string
|
7954
8270
|
enum:
|
7955
8271
|
- Member
|
@@ -7968,12 +8284,12 @@ components:
|
|
7968
8284
|
account_id:
|
7969
8285
|
description: |-
|
7970
8286
|
The id of the Account to give access to the Template.
|
7971
|
-
|
8287
|
+
**NOTE:** The account id prevails if email address is also provided.
|
7972
8288
|
type: string
|
7973
8289
|
email_address:
|
7974
8290
|
description: |-
|
7975
8291
|
The email address of the Account to give access to the Template.
|
7976
|
-
|
8292
|
+
**NOTE:** The account id prevails if it is also provided.
|
7977
8293
|
type: string
|
7978
8294
|
format: email
|
7979
8295
|
skip_notification:
|
@@ -7981,6 +8297,119 @@ components:
|
|
7981
8297
|
type: boolean
|
7982
8298
|
default: false
|
7983
8299
|
type: object
|
8300
|
+
TemplateCreateRequest:
|
8301
|
+
required:
|
8302
|
+
- signer_roles
|
8303
|
+
- form_fields_per_document
|
8304
|
+
properties:
|
8305
|
+
files:
|
8306
|
+
description: |-
|
8307
|
+
Use `files[]` to indicate the uploaded file(s) to send for signature.
|
8308
|
+
|
8309
|
+
This endpoint requires either **files** or **file_urls[]**, but not both.
|
8310
|
+
type: array
|
8311
|
+
items:
|
8312
|
+
type: string
|
8313
|
+
format: binary
|
8314
|
+
file_urls:
|
8315
|
+
description: |-
|
8316
|
+
Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.
|
8317
|
+
|
8318
|
+
This endpoint requires either **files** or **file_urls[]**, but not both.
|
8319
|
+
type: array
|
8320
|
+
items:
|
8321
|
+
type: string
|
8322
|
+
allow_reassign:
|
8323
|
+
description: |-
|
8324
|
+
Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.
|
8325
|
+
|
8326
|
+
**NOTE:** Only available for Premium plan and higher.
|
8327
|
+
type: boolean
|
8328
|
+
default: false
|
8329
|
+
attachments:
|
8330
|
+
description: 'A list describing the attachments'
|
8331
|
+
type: array
|
8332
|
+
items:
|
8333
|
+
$ref: '#/components/schemas/SubAttachment'
|
8334
|
+
cc_roles:
|
8335
|
+
description: 'The CC roles that must be assigned when using the template to send a signature request'
|
8336
|
+
type: array
|
8337
|
+
items:
|
8338
|
+
type: string
|
8339
|
+
client_id:
|
8340
|
+
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.'
|
8341
|
+
type: string
|
8342
|
+
field_options:
|
8343
|
+
$ref: '#/components/schemas/SubFieldOptions'
|
8344
|
+
form_field_groups:
|
8345
|
+
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`.'
|
8346
|
+
type: array
|
8347
|
+
items:
|
8348
|
+
$ref: '#/components/schemas/SubFormFieldGroup'
|
8349
|
+
form_field_rules:
|
8350
|
+
description: 'Conditional Logic rules for fields defined in `form_fields_per_document`.'
|
8351
|
+
type: array
|
8352
|
+
items:
|
8353
|
+
$ref: '#/components/schemas/SubFormFieldRule'
|
8354
|
+
form_fields_per_document:
|
8355
|
+
description: |-
|
8356
|
+
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).)
|
8357
|
+
|
8358
|
+
**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.
|
8359
|
+
|
8360
|
+
* Text Field use `SubFormFieldsPerDocumentText`
|
8361
|
+
* Dropdown Field use `SubFormFieldsPerDocumentDropdown`
|
8362
|
+
* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`
|
8363
|
+
* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`
|
8364
|
+
* Radio Field use `SubFormFieldsPerDocumentRadio`
|
8365
|
+
* Signature Field use `SubFormFieldsPerDocumentSignature`
|
8366
|
+
* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`
|
8367
|
+
* Initials Field use `SubFormFieldsPerDocumentInitials`
|
8368
|
+
* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`
|
8369
|
+
* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge`
|
8370
|
+
type: array
|
8371
|
+
items:
|
8372
|
+
$ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
|
8373
|
+
merge_fields:
|
8374
|
+
description: |-
|
8375
|
+
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.
|
8376
|
+
If the signature request using that template *does not* pass a value into a merge field, then an empty field remains in the document.
|
8377
|
+
type: array
|
8378
|
+
items:
|
8379
|
+
$ref: '#/components/schemas/SubMergeField'
|
8380
|
+
message:
|
8381
|
+
description: 'The default template email message.'
|
8382
|
+
type: string
|
8383
|
+
maxLength: 5000
|
8384
|
+
metadata:
|
8385
|
+
description: |-
|
8386
|
+
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.
|
8387
|
+
|
8388
|
+
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.
|
8389
|
+
type: object
|
8390
|
+
maxItems: 10
|
8391
|
+
additionalProperties: {}
|
8392
|
+
signer_roles:
|
8393
|
+
description: 'An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template.'
|
8394
|
+
type: array
|
8395
|
+
items:
|
8396
|
+
$ref: '#/components/schemas/SubTemplateRole'
|
8397
|
+
subject:
|
8398
|
+
description: 'The template title (alias).'
|
8399
|
+
type: string
|
8400
|
+
maxLength: 200
|
8401
|
+
test_mode:
|
8402
|
+
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`.'
|
8403
|
+
type: boolean
|
8404
|
+
default: false
|
8405
|
+
title:
|
8406
|
+
description: 'The title you want to assign to the SignatureRequest.'
|
8407
|
+
type: string
|
8408
|
+
use_preexisting_fields:
|
8409
|
+
description: 'Enable the detection of predefined PDF fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`).'
|
8410
|
+
type: boolean
|
8411
|
+
default: false
|
8412
|
+
type: object
|
7984
8413
|
TemplateCreateEmbeddedDraftRequest:
|
7985
8414
|
required:
|
7986
8415
|
- client_id
|
@@ -8010,7 +8439,7 @@ components:
|
|
8010
8439
|
description: |-
|
8011
8440
|
Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.
|
8012
8441
|
|
8013
|
-
**
|
8442
|
+
**NOTE:** Only available for Premium plan and higher.
|
8014
8443
|
type: boolean
|
8015
8444
|
default: false
|
8016
8445
|
attachments:
|
@@ -8052,7 +8481,7 @@ components:
|
|
8052
8481
|
description: |-
|
8053
8482
|
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).)
|
8054
8483
|
|
8055
|
-
**NOTE
|
8484
|
+
**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.
|
8056
8485
|
|
8057
8486
|
* Text Field use `SubFormFieldsPerDocumentText`
|
8058
8487
|
* Dropdown Field use `SubFormFieldsPerDocumentDropdown`
|
@@ -8234,7 +8663,7 @@ components:
|
|
8234
8663
|
description: |-
|
8235
8664
|
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).)
|
8236
8665
|
|
8237
|
-
**NOTE
|
8666
|
+
**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.
|
8238
8667
|
|
8239
8668
|
* Text Field use `SubFormFieldsPerDocumentText`
|
8240
8669
|
* Dropdown Field use `SubFormFieldsPerDocumentDropdown`
|
@@ -8305,10 +8734,9 @@ components:
|
|
8305
8734
|
description: |-
|
8306
8735
|
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.
|
8307
8736
|
|
8308
|
-
**
|
8737
|
+
**NOTE:** This does not correspond to the **expires_at** returned in the response.
|
8309
8738
|
type: integer
|
8310
8739
|
nullable: true
|
8311
|
-
x-beta: closed
|
8312
8740
|
type: object
|
8313
8741
|
UnclaimedDraftCreateEmbeddedRequest:
|
8314
8742
|
description: ''
|
@@ -8345,7 +8773,7 @@ components:
|
|
8345
8773
|
description: |-
|
8346
8774
|
Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.
|
8347
8775
|
|
8348
|
-
**
|
8776
|
+
**NOTE:** Only available for Premium plan and higher.
|
8349
8777
|
type: boolean
|
8350
8778
|
default: false
|
8351
8779
|
attachments:
|
@@ -8398,7 +8826,7 @@ components:
|
|
8398
8826
|
description: |-
|
8399
8827
|
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).)
|
8400
8828
|
|
8401
|
-
**NOTE
|
8829
|
+
**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.
|
8402
8830
|
|
8403
8831
|
* Text Field use `SubFormFieldsPerDocumentText`
|
8404
8832
|
* Dropdown Field use `SubFormFieldsPerDocumentDropdown`
|
@@ -8496,17 +8924,16 @@ components:
|
|
8496
8924
|
description: |-
|
8497
8925
|
Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.
|
8498
8926
|
|
8499
|
-
|
8927
|
+
**NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature.
|
8500
8928
|
type: boolean
|
8501
8929
|
default: false
|
8502
8930
|
expires_at:
|
8503
8931
|
description: |-
|
8504
8932
|
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.
|
8505
8933
|
|
8506
|
-
**
|
8934
|
+
**NOTE:** This does not correspond to the **expires_at** returned in the response.
|
8507
8935
|
type: integer
|
8508
8936
|
nullable: true
|
8509
|
-
x-beta: closed
|
8510
8937
|
type: object
|
8511
8938
|
UnclaimedDraftCreateEmbeddedWithTemplateRequest:
|
8512
8939
|
required:
|
@@ -8522,7 +8949,7 @@ components:
|
|
8522
8949
|
description: |-
|
8523
8950
|
Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.
|
8524
8951
|
|
8525
|
-
**
|
8952
|
+
**NOTE:** Only available for Premium plan and higher.
|
8526
8953
|
type: boolean
|
8527
8954
|
default: false
|
8528
8955
|
ccs:
|
@@ -8594,7 +9021,7 @@ components:
|
|
8594
9021
|
- `preview_only=true`: Allows requesters to enable the preview only experience.
|
8595
9022
|
- `preview_only=false`: Allows requesters to disable the preview only experience.
|
8596
9023
|
|
8597
|
-
**
|
9024
|
+
**NOTE:** This parameter overwrites `show_preview=1` (if set).
|
8598
9025
|
type: boolean
|
8599
9026
|
default: false
|
8600
9027
|
requester_email_address:
|
@@ -8651,7 +9078,11 @@ components:
|
|
8651
9078
|
description: |-
|
8652
9079
|
Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.
|
8653
9080
|
|
8654
|
-
|
9081
|
+
**NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature.
|
9082
|
+
type: boolean
|
9083
|
+
default: false
|
9084
|
+
allow_ccs:
|
9085
|
+
description: 'This allows the requester to specify whether the user is allowed to provide email addresses to CC when claiming the draft.'
|
8655
9086
|
type: boolean
|
8656
9087
|
default: false
|
8657
9088
|
type: object
|
@@ -8822,20 +9253,6 @@ components:
|
|
8822
9253
|
error:
|
8823
9254
|
$ref: '#/components/schemas/ErrorResponseError'
|
8824
9255
|
type: object
|
8825
|
-
EventCallbackRequest:
|
8826
|
-
title: EventCallbackRequest
|
8827
|
-
required:
|
8828
|
-
- event
|
8829
|
-
properties:
|
8830
|
-
event:
|
8831
|
-
$ref: '#/components/schemas/EventCallbackRequestEvent'
|
8832
|
-
account:
|
8833
|
-
$ref: '#/components/schemas/AccountResponse'
|
8834
|
-
signature_request:
|
8835
|
-
$ref: '#/components/schemas/SignatureRequestResponse'
|
8836
|
-
template:
|
8837
|
-
$ref: '#/components/schemas/TemplateResponse'
|
8838
|
-
type: object
|
8839
9256
|
FileResponse:
|
8840
9257
|
properties:
|
8841
9258
|
file_url:
|
@@ -9145,75 +9562,12 @@ components:
|
|
9145
9562
|
error_msg:
|
9146
9563
|
description: 'Message describing an error.'
|
9147
9564
|
type: string
|
9148
|
-
error_path:
|
9149
|
-
description: 'Path at which an error occurred.'
|
9150
|
-
type: string
|
9151
|
-
error_name:
|
9152
|
-
description: 'Name of the error.'
|
9153
|
-
type: string
|
9154
|
-
type: object
|
9155
|
-
EventCallbackRequestEvent:
|
9156
|
-
description: 'Basic information about the event that occurred.'
|
9157
|
-
required:
|
9158
|
-
- event_time
|
9159
|
-
- event_type
|
9160
|
-
- event_hash
|
9161
|
-
- event_metadata
|
9162
|
-
properties:
|
9163
|
-
event_time:
|
9164
|
-
description: 'Time the event was created (using Unix time).'
|
9165
|
-
type: string
|
9166
|
-
event_type:
|
9167
|
-
description: 'Type of callback event that was triggered.'
|
9168
|
-
type: string
|
9169
|
-
enum:
|
9170
|
-
- account_confirmed
|
9171
|
-
- unknown_error
|
9172
|
-
- file_error
|
9173
|
-
- sign_url_invalid
|
9174
|
-
- signature_request_viewed
|
9175
|
-
- signature_request_signed
|
9176
|
-
- signature_request_sent
|
9177
|
-
- signature_request_all_signed
|
9178
|
-
- signature_request_email_bounce
|
9179
|
-
- signature_request_remind
|
9180
|
-
- signature_request_incomplete_qes
|
9181
|
-
- signature_request_destroyed
|
9182
|
-
- signature_request_canceled
|
9183
|
-
- signature_request_downloadable
|
9184
|
-
- signature_request_declined
|
9185
|
-
- signature_request_reassigned
|
9186
|
-
- signature_request_invalid
|
9187
|
-
- signature_request_prepared
|
9188
|
-
- signature_request_expired
|
9189
|
-
- template_created
|
9190
|
-
- template_error
|
9191
|
-
- callback_test
|
9192
|
-
event_hash:
|
9193
|
-
description: 'Generated hash used to verify source of event data.'
|
9194
|
-
type: string
|
9195
|
-
event_metadata:
|
9196
|
-
$ref: '#/components/schemas/EventCallbackRequestEventMetadata'
|
9197
|
-
type: object
|
9198
|
-
EventCallbackRequestEventMetadata:
|
9199
|
-
description: 'Specific metadata about the event.'
|
9200
|
-
properties:
|
9201
|
-
related_signature_id:
|
9202
|
-
description: 'Signature ID for a specific signer. Applicable to `signature_request_signed` and `signature_request_viewed` events.'
|
9203
|
-
type: string
|
9204
|
-
nullable: true
|
9205
|
-
reported_for_account_id:
|
9206
|
-
description: 'Account ID the event was reported for.'
|
9207
|
-
type: string
|
9208
|
-
nullable: true
|
9209
|
-
reported_for_app_id:
|
9210
|
-
description: 'App ID the event was reported for.'
|
9211
|
-
type: string
|
9212
|
-
nullable: true
|
9213
|
-
event_message:
|
9214
|
-
description: 'Message about a declined or failed (due to error) signature flow.'
|
9565
|
+
error_path:
|
9566
|
+
description: 'Path at which an error occurred.'
|
9567
|
+
type: string
|
9568
|
+
error_name:
|
9569
|
+
description: 'Name of the error.'
|
9215
9570
|
type: string
|
9216
|
-
nullable: true
|
9217
9571
|
type: object
|
9218
9572
|
ListInfoResponse:
|
9219
9573
|
description: 'Contains pagination information about the data returned.'
|
@@ -9291,7 +9645,6 @@ components:
|
|
9291
9645
|
expires_at:
|
9292
9646
|
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
9647
|
type: integer
|
9294
|
-
x-beta: closed
|
9295
9648
|
is_complete:
|
9296
9649
|
description: 'Whether or not the SignatureRequest has been fully executed by all signers.'
|
9297
9650
|
type: boolean
|
@@ -9320,6 +9673,10 @@ components:
|
|
9320
9673
|
description: 'The URL you want the signer redirected to after they successfully sign.'
|
9321
9674
|
type: string
|
9322
9675
|
nullable: true
|
9676
|
+
final_copy_uri:
|
9677
|
+
description: 'The path where the completed document can be downloaded'
|
9678
|
+
type: string
|
9679
|
+
nullable: true
|
9323
9680
|
template_ids:
|
9324
9681
|
description: 'Templates IDs used in this SignatureRequest (if any).'
|
9325
9682
|
type: array
|
@@ -9353,6 +9710,10 @@ components:
|
|
9353
9710
|
type: array
|
9354
9711
|
items:
|
9355
9712
|
$ref: '#/components/schemas/SignatureRequestResponseSignatures'
|
9713
|
+
bulk_send_job_id:
|
9714
|
+
description: 'The ID of the Bulk Send job which sent the signature request, if applicable.'
|
9715
|
+
type: string
|
9716
|
+
nullable: true
|
9356
9717
|
type: object
|
9357
9718
|
x-internal: true
|
9358
9719
|
SignatureRequestResponseAttachment:
|
@@ -9420,13 +9781,13 @@ components:
|
|
9420
9781
|
x-base-class: true
|
9421
9782
|
SignatureRequestResponseCustomFieldCheckbox:
|
9422
9783
|
description: 'This class extends `SignatureRequestResponseCustomFieldBase`.'
|
9423
|
-
required:
|
9424
|
-
- type
|
9425
|
-
type: object
|
9426
9784
|
allOf:
|
9427
9785
|
-
|
9428
9786
|
$ref: '#/components/schemas/SignatureRequestResponseCustomFieldBase'
|
9429
9787
|
-
|
9788
|
+
required:
|
9789
|
+
- name
|
9790
|
+
- type
|
9430
9791
|
properties:
|
9431
9792
|
type:
|
9432
9793
|
description: 'The type of this Custom Field. Only ''text'' and ''checkbox'' are currently supported.'
|
@@ -9435,15 +9796,16 @@ components:
|
|
9435
9796
|
value:
|
9436
9797
|
description: 'A true/false for checkbox fields'
|
9437
9798
|
type: boolean
|
9799
|
+
type: object
|
9438
9800
|
SignatureRequestResponseCustomFieldText:
|
9439
9801
|
description: 'This class extends `SignatureRequestResponseCustomFieldBase`.'
|
9440
|
-
required:
|
9441
|
-
- type
|
9442
|
-
type: object
|
9443
9802
|
allOf:
|
9444
9803
|
-
|
9445
9804
|
$ref: '#/components/schemas/SignatureRequestResponseCustomFieldBase'
|
9446
9805
|
-
|
9806
|
+
required:
|
9807
|
+
- name
|
9808
|
+
- type
|
9447
9809
|
properties:
|
9448
9810
|
type:
|
9449
9811
|
description: 'The type of this Custom Field. Only ''text'' and ''checkbox'' are currently supported.'
|
@@ -9452,6 +9814,7 @@ components:
|
|
9452
9814
|
value:
|
9453
9815
|
description: 'A text string for text fields'
|
9454
9816
|
type: string
|
9817
|
+
type: object
|
9455
9818
|
SignatureRequestResponseCustomFieldTypeEnum:
|
9456
9819
|
type: string
|
9457
9820
|
enum:
|
@@ -9502,7 +9865,6 @@ components:
|
|
9502
9865
|
- text-merge
|
9503
9866
|
- checkbox-merge
|
9504
9867
|
SignatureRequestResponseDataValueCheckbox:
|
9505
|
-
type: object
|
9506
9868
|
allOf:
|
9507
9869
|
-
|
9508
9870
|
$ref: '#/components/schemas/SignatureRequestResponseDataBase'
|
@@ -9515,8 +9877,8 @@ components:
|
|
9515
9877
|
value:
|
9516
9878
|
description: 'The value of the form field.'
|
9517
9879
|
type: boolean
|
9880
|
+
type: object
|
9518
9881
|
SignatureRequestResponseDataValueCheckboxMerge:
|
9519
|
-
type: object
|
9520
9882
|
allOf:
|
9521
9883
|
-
|
9522
9884
|
$ref: '#/components/schemas/SignatureRequestResponseDataBase'
|
@@ -9529,8 +9891,8 @@ components:
|
|
9529
9891
|
value:
|
9530
9892
|
description: 'The value of the form field.'
|
9531
9893
|
type: string
|
9894
|
+
type: object
|
9532
9895
|
SignatureRequestResponseDataValueDateSigned:
|
9533
|
-
type: object
|
9534
9896
|
allOf:
|
9535
9897
|
-
|
9536
9898
|
$ref: '#/components/schemas/SignatureRequestResponseDataBase'
|
@@ -9543,8 +9905,8 @@ components:
|
|
9543
9905
|
value:
|
9544
9906
|
description: 'The value of the form field.'
|
9545
9907
|
type: string
|
9908
|
+
type: object
|
9546
9909
|
SignatureRequestResponseDataValueDropdown:
|
9547
|
-
type: object
|
9548
9910
|
allOf:
|
9549
9911
|
-
|
9550
9912
|
$ref: '#/components/schemas/SignatureRequestResponseDataBase'
|
@@ -9557,8 +9919,8 @@ components:
|
|
9557
9919
|
value:
|
9558
9920
|
description: 'The value of the form field.'
|
9559
9921
|
type: string
|
9922
|
+
type: object
|
9560
9923
|
SignatureRequestResponseDataValueInitials:
|
9561
|
-
type: object
|
9562
9924
|
allOf:
|
9563
9925
|
-
|
9564
9926
|
$ref: '#/components/schemas/SignatureRequestResponseDataBase'
|
@@ -9571,8 +9933,8 @@ components:
|
|
9571
9933
|
value:
|
9572
9934
|
description: 'The value of the form field.'
|
9573
9935
|
type: string
|
9936
|
+
type: object
|
9574
9937
|
SignatureRequestResponseDataValueRadio:
|
9575
|
-
type: object
|
9576
9938
|
allOf:
|
9577
9939
|
-
|
9578
9940
|
$ref: '#/components/schemas/SignatureRequestResponseDataBase'
|
@@ -9585,8 +9947,8 @@ components:
|
|
9585
9947
|
value:
|
9586
9948
|
description: 'The value of the form field.'
|
9587
9949
|
type: boolean
|
9950
|
+
type: object
|
9588
9951
|
SignatureRequestResponseDataValueSignature:
|
9589
|
-
type: object
|
9590
9952
|
allOf:
|
9591
9953
|
-
|
9592
9954
|
$ref: '#/components/schemas/SignatureRequestResponseDataBase'
|
@@ -9599,8 +9961,8 @@ components:
|
|
9599
9961
|
value:
|
9600
9962
|
description: 'The value of the form field.'
|
9601
9963
|
type: string
|
9964
|
+
type: object
|
9602
9965
|
SignatureRequestResponseDataValueText:
|
9603
|
-
type: object
|
9604
9966
|
allOf:
|
9605
9967
|
-
|
9606
9968
|
$ref: '#/components/schemas/SignatureRequestResponseDataBase'
|
@@ -9613,8 +9975,8 @@ components:
|
|
9613
9975
|
value:
|
9614
9976
|
description: 'The value of the form field.'
|
9615
9977
|
type: string
|
9978
|
+
type: object
|
9616
9979
|
SignatureRequestResponseDataValueTextMerge:
|
9617
|
-
type: object
|
9618
9980
|
allOf:
|
9619
9981
|
-
|
9620
9982
|
$ref: '#/components/schemas/SignatureRequestResponseDataBase'
|
@@ -9627,6 +9989,7 @@ components:
|
|
9627
9989
|
value:
|
9628
9990
|
description: 'The value of the form field.'
|
9629
9991
|
type: string
|
9992
|
+
type: object
|
9630
9993
|
SignatureRequestResponseSignatures:
|
9631
9994
|
description: 'An array of signature objects, 1 for each signer.'
|
9632
9995
|
properties:
|
@@ -9937,6 +10300,15 @@ components:
|
|
9937
10300
|
type: array
|
9938
10301
|
items:
|
9939
10302
|
$ref: '#/components/schemas/WarningResponse'
|
10303
|
+
deprecated: true
|
10304
|
+
type: object
|
10305
|
+
x-internal: true
|
10306
|
+
TemplateCreateResponseTemplate:
|
10307
|
+
description: 'Template object with parameters: `template_id`.'
|
10308
|
+
properties:
|
10309
|
+
template_id:
|
10310
|
+
description: 'The id of the Template.'
|
10311
|
+
type: string
|
9940
10312
|
type: object
|
9941
10313
|
x-internal: true
|
9942
10314
|
TemplateResponseDocument:
|
@@ -9963,7 +10335,7 @@ components:
|
|
9963
10335
|
items:
|
9964
10336
|
$ref: '#/components/schemas/TemplateResponseDocumentCustomFieldBase'
|
9965
10337
|
static_fields:
|
9966
|
-
description: 'An array describing static overlay fields. **
|
10338
|
+
description: 'An array describing static overlay fields. **NOTE:** Only available for certain subscriptions.'
|
9967
10339
|
type: array
|
9968
10340
|
items:
|
9969
10341
|
$ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase'
|
@@ -10018,7 +10390,6 @@ components:
|
|
10018
10390
|
description: 'This class extends `TemplateResponseDocumentCustomFieldBase`'
|
10019
10391
|
required:
|
10020
10392
|
- type
|
10021
|
-
type: object
|
10022
10393
|
allOf:
|
10023
10394
|
-
|
10024
10395
|
$ref: '#/components/schemas/TemplateResponseDocumentCustomFieldBase'
|
@@ -10032,11 +10403,11 @@ components:
|
|
10032
10403
|
* Checkbox uses `TemplateResponseDocumentCustomFieldCheckbox`
|
10033
10404
|
type: string
|
10034
10405
|
default: checkbox
|
10406
|
+
type: object
|
10035
10407
|
TemplateResponseDocumentCustomFieldText:
|
10036
10408
|
description: 'This class extends `TemplateResponseDocumentCustomFieldBase`'
|
10037
10409
|
required:
|
10038
10410
|
- type
|
10039
|
-
type: object
|
10040
10411
|
allOf:
|
10041
10412
|
-
|
10042
10413
|
$ref: '#/components/schemas/TemplateResponseDocumentCustomFieldBase'
|
@@ -10061,6 +10432,7 @@ components:
|
|
10061
10432
|
fontFamily:
|
10062
10433
|
description: 'Font family used in this form field''s text.'
|
10063
10434
|
type: string
|
10435
|
+
type: object
|
10064
10436
|
TemplateResponseDocumentFieldGroup:
|
10065
10437
|
properties:
|
10066
10438
|
name:
|
@@ -10137,13 +10509,12 @@ components:
|
|
10137
10509
|
x-base-class: true
|
10138
10510
|
TemplateResponseDocumentFormFieldCheckbox:
|
10139
10511
|
description: 'This class extends `TemplateResponseDocumentFormFieldBase`'
|
10140
|
-
required:
|
10141
|
-
- type
|
10142
|
-
type: object
|
10143
10512
|
allOf:
|
10144
10513
|
-
|
10145
10514
|
$ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase'
|
10146
10515
|
-
|
10516
|
+
required:
|
10517
|
+
- type
|
10147
10518
|
properties:
|
10148
10519
|
type:
|
10149
10520
|
description: |-
|
@@ -10159,15 +10530,17 @@ components:
|
|
10159
10530
|
* Initials Field uses `TemplateResponseDocumentFormFieldInitials`
|
10160
10531
|
type: string
|
10161
10532
|
default: checkbox
|
10533
|
+
type: object
|
10162
10534
|
TemplateResponseDocumentFormFieldDateSigned:
|
10163
10535
|
description: 'This class extends `TemplateResponseDocumentFormFieldBase`'
|
10164
10536
|
required:
|
10165
10537
|
- type
|
10166
|
-
type: object
|
10167
10538
|
allOf:
|
10168
10539
|
-
|
10169
10540
|
$ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase'
|
10170
10541
|
-
|
10542
|
+
required:
|
10543
|
+
- type
|
10171
10544
|
properties:
|
10172
10545
|
type:
|
10173
10546
|
description: |-
|
@@ -10183,15 +10556,17 @@ components:
|
|
10183
10556
|
* Initials Field uses `TemplateResponseDocumentFormFieldInitials`
|
10184
10557
|
type: string
|
10185
10558
|
default: date_signed
|
10559
|
+
type: object
|
10186
10560
|
TemplateResponseDocumentFormFieldDropdown:
|
10187
10561
|
description: 'This class extends `TemplateResponseDocumentFormFieldBase`'
|
10188
10562
|
required:
|
10189
10563
|
- type
|
10190
|
-
type: object
|
10191
10564
|
allOf:
|
10192
10565
|
-
|
10193
10566
|
$ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase'
|
10194
10567
|
-
|
10568
|
+
required:
|
10569
|
+
- type
|
10195
10570
|
properties:
|
10196
10571
|
type:
|
10197
10572
|
description: |-
|
@@ -10207,15 +10582,17 @@ components:
|
|
10207
10582
|
* Initials Field uses `TemplateResponseDocumentFormFieldInitials`
|
10208
10583
|
type: string
|
10209
10584
|
default: dropdown
|
10585
|
+
type: object
|
10210
10586
|
TemplateResponseDocumentFormFieldHyperlink:
|
10211
10587
|
description: 'This class extends `TemplateResponseDocumentFormFieldBase`'
|
10212
10588
|
required:
|
10213
10589
|
- type
|
10214
|
-
type: object
|
10215
10590
|
allOf:
|
10216
10591
|
-
|
10217
10592
|
$ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase'
|
10218
10593
|
-
|
10594
|
+
required:
|
10595
|
+
- type
|
10219
10596
|
properties:
|
10220
10597
|
type:
|
10221
10598
|
description: |-
|
@@ -10242,15 +10619,17 @@ components:
|
|
10242
10619
|
fontFamily:
|
10243
10620
|
description: 'Font family used in this form field''s text.'
|
10244
10621
|
type: string
|
10622
|
+
type: object
|
10245
10623
|
TemplateResponseDocumentFormFieldInitials:
|
10246
10624
|
description: 'This class extends `TemplateResponseDocumentFormFieldBase`'
|
10247
10625
|
required:
|
10248
10626
|
- type
|
10249
|
-
type: object
|
10250
10627
|
allOf:
|
10251
10628
|
-
|
10252
10629
|
$ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase'
|
10253
10630
|
-
|
10631
|
+
required:
|
10632
|
+
- type
|
10254
10633
|
properties:
|
10255
10634
|
type:
|
10256
10635
|
description: |-
|
@@ -10266,16 +10645,18 @@ components:
|
|
10266
10645
|
* Initials Field uses `TemplateResponseDocumentFormFieldInitials`
|
10267
10646
|
type: string
|
10268
10647
|
default: initials
|
10648
|
+
type: object
|
10269
10649
|
TemplateResponseDocumentFormFieldRadio:
|
10270
10650
|
description: 'This class extends `TemplateResponseDocumentFormFieldBase`'
|
10271
10651
|
required:
|
10272
10652
|
- type
|
10273
10653
|
- group
|
10274
|
-
type: object
|
10275
10654
|
allOf:
|
10276
10655
|
-
|
10277
10656
|
$ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase'
|
10278
10657
|
-
|
10658
|
+
required:
|
10659
|
+
- type
|
10279
10660
|
properties:
|
10280
10661
|
type:
|
10281
10662
|
description: |-
|
@@ -10291,15 +10672,17 @@ components:
|
|
10291
10672
|
* Initials Field uses `TemplateResponseDocumentFormFieldInitials`
|
10292
10673
|
type: string
|
10293
10674
|
default: radio
|
10675
|
+
type: object
|
10294
10676
|
TemplateResponseDocumentFormFieldSignature:
|
10295
10677
|
description: 'This class extends `TemplateResponseDocumentFormFieldBase`'
|
10296
10678
|
required:
|
10297
10679
|
- type
|
10298
|
-
type: object
|
10299
10680
|
allOf:
|
10300
10681
|
-
|
10301
10682
|
$ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase'
|
10302
10683
|
-
|
10684
|
+
required:
|
10685
|
+
- type
|
10303
10686
|
properties:
|
10304
10687
|
type:
|
10305
10688
|
description: |-
|
@@ -10315,15 +10698,17 @@ components:
|
|
10315
10698
|
* Initials Field uses `TemplateResponseDocumentFormFieldInitials`
|
10316
10699
|
type: string
|
10317
10700
|
default: signature
|
10701
|
+
type: object
|
10318
10702
|
TemplateResponseDocumentFormFieldText:
|
10319
10703
|
description: 'This class extends `TemplateResponseDocumentFormFieldBase`'
|
10320
10704
|
required:
|
10321
10705
|
- type
|
10322
|
-
type: object
|
10323
10706
|
allOf:
|
10324
10707
|
-
|
10325
10708
|
$ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase'
|
10326
10709
|
-
|
10710
|
+
required:
|
10711
|
+
- type
|
10327
10712
|
properties:
|
10328
10713
|
type:
|
10329
10714
|
description: |-
|
@@ -10365,8 +10750,9 @@ components:
|
|
10365
10750
|
- employer_identification_number
|
10366
10751
|
- custom_regex
|
10367
10752
|
nullable: true
|
10753
|
+
type: object
|
10368
10754
|
TemplateResponseDocumentStaticFieldBase:
|
10369
|
-
description: 'An array describing static overlay fields. **
|
10755
|
+
description: 'An array describing static overlay fields. **NOTE:** Only available for certain subscriptions.'
|
10370
10756
|
required:
|
10371
10757
|
- type
|
10372
10758
|
properties:
|
@@ -10419,11 +10805,12 @@ components:
|
|
10419
10805
|
description: 'This class extends `TemplateResponseDocumentStaticFieldBase`'
|
10420
10806
|
required:
|
10421
10807
|
- type
|
10422
|
-
type: object
|
10423
10808
|
allOf:
|
10424
10809
|
-
|
10425
10810
|
$ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase'
|
10426
10811
|
-
|
10812
|
+
required:
|
10813
|
+
- type
|
10427
10814
|
properties:
|
10428
10815
|
type:
|
10429
10816
|
description: |-
|
@@ -10439,15 +10826,17 @@ components:
|
|
10439
10826
|
* Initials Field uses `TemplateResponseDocumentStaticFieldInitials`
|
10440
10827
|
type: string
|
10441
10828
|
default: checkbox
|
10829
|
+
type: object
|
10442
10830
|
TemplateResponseDocumentStaticFieldDateSigned:
|
10443
10831
|
description: 'This class extends `TemplateResponseDocumentStaticFieldBase`'
|
10444
10832
|
required:
|
10445
10833
|
- type
|
10446
|
-
type: object
|
10447
10834
|
allOf:
|
10448
10835
|
-
|
10449
10836
|
$ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase'
|
10450
10837
|
-
|
10838
|
+
required:
|
10839
|
+
- type
|
10451
10840
|
properties:
|
10452
10841
|
type:
|
10453
10842
|
description: |-
|
@@ -10463,15 +10852,17 @@ components:
|
|
10463
10852
|
* Initials Field uses `TemplateResponseDocumentStaticFieldInitials`
|
10464
10853
|
type: string
|
10465
10854
|
default: date_signed
|
10855
|
+
type: object
|
10466
10856
|
TemplateResponseDocumentStaticFieldDropdown:
|
10467
10857
|
description: 'This class extends `TemplateResponseDocumentStaticFieldBase`'
|
10468
10858
|
required:
|
10469
10859
|
- type
|
10470
|
-
type: object
|
10471
10860
|
allOf:
|
10472
10861
|
-
|
10473
10862
|
$ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase'
|
10474
10863
|
-
|
10864
|
+
required:
|
10865
|
+
- type
|
10475
10866
|
properties:
|
10476
10867
|
type:
|
10477
10868
|
description: |-
|
@@ -10487,15 +10878,17 @@ components:
|
|
10487
10878
|
* Initials Field uses `TemplateResponseDocumentStaticFieldInitials`
|
10488
10879
|
type: string
|
10489
10880
|
default: dropdown
|
10881
|
+
type: object
|
10490
10882
|
TemplateResponseDocumentStaticFieldHyperlink:
|
10491
10883
|
description: 'This class extends `TemplateResponseDocumentStaticFieldBase`'
|
10492
10884
|
required:
|
10493
10885
|
- type
|
10494
|
-
type: object
|
10495
10886
|
allOf:
|
10496
10887
|
-
|
10497
10888
|
$ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase'
|
10498
10889
|
-
|
10890
|
+
required:
|
10891
|
+
- type
|
10499
10892
|
properties:
|
10500
10893
|
type:
|
10501
10894
|
description: |-
|
@@ -10511,15 +10904,17 @@ components:
|
|
10511
10904
|
* Initials Field uses `TemplateResponseDocumentStaticFieldInitials`
|
10512
10905
|
type: string
|
10513
10906
|
default: hyperlink
|
10907
|
+
type: object
|
10514
10908
|
TemplateResponseDocumentStaticFieldInitials:
|
10515
10909
|
description: 'This class extends `TemplateResponseDocumentStaticFieldBase`'
|
10516
10910
|
required:
|
10517
10911
|
- type
|
10518
|
-
type: object
|
10519
10912
|
allOf:
|
10520
10913
|
-
|
10521
10914
|
$ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase'
|
10522
10915
|
-
|
10916
|
+
required:
|
10917
|
+
- type
|
10523
10918
|
properties:
|
10524
10919
|
type:
|
10525
10920
|
description: |-
|
@@ -10535,15 +10930,17 @@ components:
|
|
10535
10930
|
* Initials Field uses `TemplateResponseDocumentStaticFieldInitials`
|
10536
10931
|
type: string
|
10537
10932
|
default: initials
|
10933
|
+
type: object
|
10538
10934
|
TemplateResponseDocumentStaticFieldRadio:
|
10539
10935
|
description: 'This class extends `TemplateResponseDocumentStaticFieldBase`'
|
10540
10936
|
required:
|
10541
10937
|
- type
|
10542
|
-
type: object
|
10543
10938
|
allOf:
|
10544
10939
|
-
|
10545
10940
|
$ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase'
|
10546
10941
|
-
|
10942
|
+
required:
|
10943
|
+
- type
|
10547
10944
|
properties:
|
10548
10945
|
type:
|
10549
10946
|
description: |-
|
@@ -10559,15 +10956,17 @@ components:
|
|
10559
10956
|
* Initials Field uses `TemplateResponseDocumentStaticFieldInitials`
|
10560
10957
|
type: string
|
10561
10958
|
default: radio
|
10959
|
+
type: object
|
10562
10960
|
TemplateResponseDocumentStaticFieldSignature:
|
10563
10961
|
description: 'This class extends `TemplateResponseDocumentStaticFieldBase`'
|
10564
10962
|
required:
|
10565
10963
|
- type
|
10566
|
-
type: object
|
10567
10964
|
allOf:
|
10568
10965
|
-
|
10569
10966
|
$ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase'
|
10570
10967
|
-
|
10968
|
+
required:
|
10969
|
+
- type
|
10571
10970
|
properties:
|
10572
10971
|
type:
|
10573
10972
|
description: |-
|
@@ -10583,15 +10982,17 @@ components:
|
|
10583
10982
|
* Initials Field uses `TemplateResponseDocumentStaticFieldInitials`
|
10584
10983
|
type: string
|
10585
10984
|
default: signature
|
10985
|
+
type: object
|
10586
10986
|
TemplateResponseDocumentStaticFieldText:
|
10587
10987
|
description: 'This class extends `TemplateResponseDocumentStaticFieldBase`'
|
10588
10988
|
required:
|
10589
10989
|
- type
|
10590
|
-
type: object
|
10591
10990
|
allOf:
|
10592
10991
|
-
|
10593
10992
|
$ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase'
|
10594
10993
|
-
|
10994
|
+
required:
|
10995
|
+
- type
|
10595
10996
|
properties:
|
10596
10997
|
type:
|
10597
10998
|
description: |-
|
@@ -10607,6 +11008,7 @@ components:
|
|
10607
11008
|
* Initials Field uses `TemplateResponseDocumentStaticFieldInitials`
|
10608
11009
|
type: string
|
10609
11010
|
default: text
|
11011
|
+
type: object
|
10610
11012
|
TemplateResponseFieldAvgTextLength:
|
10611
11013
|
description: 'Average text length in this field.'
|
10612
11014
|
properties:
|
@@ -10639,6 +11041,7 @@ components:
|
|
10639
11041
|
type: array
|
10640
11042
|
items:
|
10641
11043
|
$ref: '#/components/schemas/WarningResponse'
|
11044
|
+
deprecated: true
|
10642
11045
|
type: object
|
10643
11046
|
x-internal: true
|
10644
11047
|
UnclaimedDraftResponse:
|
@@ -10746,6 +11149,17 @@ components:
|
|
10746
11149
|
$ref: '#/components/schemas/WarningResponse'
|
10747
11150
|
type: object
|
10748
11151
|
x-internal: true
|
11152
|
+
TemplateCreateResponse:
|
11153
|
+
properties:
|
11154
|
+
template:
|
11155
|
+
$ref: '#/components/schemas/TemplateCreateResponseTemplate'
|
11156
|
+
warnings:
|
11157
|
+
description: 'A list of warnings.'
|
11158
|
+
type: array
|
11159
|
+
items:
|
11160
|
+
$ref: '#/components/schemas/WarningResponse'
|
11161
|
+
type: object
|
11162
|
+
x-internal: true
|
10749
11163
|
TemplateCreateEmbeddedDraftResponse:
|
10750
11164
|
properties:
|
10751
11165
|
template:
|
@@ -10807,6 +11221,83 @@ components:
|
|
10807
11221
|
$ref: '#/components/schemas/WarningResponse'
|
10808
11222
|
type: object
|
10809
11223
|
x-internal: true
|
11224
|
+
EventCallbackRequest:
|
11225
|
+
title: EventCallbackRequest
|
11226
|
+
required:
|
11227
|
+
- event
|
11228
|
+
properties:
|
11229
|
+
event:
|
11230
|
+
$ref: '#/components/schemas/EventCallbackRequestEvent'
|
11231
|
+
account:
|
11232
|
+
$ref: '#/components/schemas/AccountResponse'
|
11233
|
+
signature_request:
|
11234
|
+
$ref: '#/components/schemas/SignatureRequestResponse'
|
11235
|
+
template:
|
11236
|
+
$ref: '#/components/schemas/TemplateResponse'
|
11237
|
+
type: object
|
11238
|
+
EventCallbackRequestEvent:
|
11239
|
+
description: 'Basic information about the event that occurred.'
|
11240
|
+
required:
|
11241
|
+
- event_time
|
11242
|
+
- event_type
|
11243
|
+
- event_hash
|
11244
|
+
properties:
|
11245
|
+
event_time:
|
11246
|
+
description: 'Time the event was created (using Unix time).'
|
11247
|
+
type: string
|
11248
|
+
event_type:
|
11249
|
+
description: 'Type of callback event that was triggered.'
|
11250
|
+
type: string
|
11251
|
+
enum:
|
11252
|
+
- account_confirmed
|
11253
|
+
- unknown_error
|
11254
|
+
- file_error
|
11255
|
+
- sign_url_invalid
|
11256
|
+
- signature_request_viewed
|
11257
|
+
- signature_request_signed
|
11258
|
+
- signature_request_sent
|
11259
|
+
- signature_request_all_signed
|
11260
|
+
- signature_request_email_bounce
|
11261
|
+
- signature_request_remind
|
11262
|
+
- signature_request_incomplete_qes
|
11263
|
+
- signature_request_destroyed
|
11264
|
+
- signature_request_canceled
|
11265
|
+
- signature_request_downloadable
|
11266
|
+
- signature_request_declined
|
11267
|
+
- signature_request_reassigned
|
11268
|
+
- signature_request_invalid
|
11269
|
+
- signature_request_prepared
|
11270
|
+
- signature_request_expired
|
11271
|
+
- template_created
|
11272
|
+
- template_error
|
11273
|
+
- callback_test
|
11274
|
+
- signature_request_signer_removed
|
11275
|
+
event_hash:
|
11276
|
+
description: 'Generated hash used to verify source of event data.'
|
11277
|
+
type: string
|
11278
|
+
event_metadata:
|
11279
|
+
$ref: '#/components/schemas/EventCallbackRequestEventMetadata'
|
11280
|
+
type: object
|
11281
|
+
EventCallbackRequestEventMetadata:
|
11282
|
+
description: 'Specific metadata about the event.'
|
11283
|
+
properties:
|
11284
|
+
related_signature_id:
|
11285
|
+
description: 'Signature ID for a specific signer. Applicable to `signature_request_signed` and `signature_request_viewed` events.'
|
11286
|
+
type: string
|
11287
|
+
nullable: true
|
11288
|
+
reported_for_account_id:
|
11289
|
+
description: 'Account ID the event was reported for.'
|
11290
|
+
type: string
|
11291
|
+
nullable: true
|
11292
|
+
reported_for_app_id:
|
11293
|
+
description: 'App ID the event was reported for.'
|
11294
|
+
type: string
|
11295
|
+
nullable: true
|
11296
|
+
event_message:
|
11297
|
+
description: 'Message about a declined or failed (due to error) signature flow.'
|
11298
|
+
type: string
|
11299
|
+
nullable: true
|
11300
|
+
type: object
|
10810
11301
|
responses:
|
10811
11302
|
EventCallbackResponse:
|
10812
11303
|
description: 'successful operation'
|
@@ -10924,6 +11415,22 @@ components:
|
|
10924
11415
|
summary: 'Default Example'
|
10925
11416
|
value:
|
10926
11417
|
$ref: examples/json/TemplateAddUserRequestDefaultExample.json
|
11418
|
+
TemplateCreateRequestDefaultExample:
|
11419
|
+
summary: 'Default Example'
|
11420
|
+
value:
|
11421
|
+
$ref: examples/json/TemplateCreateRequestDefaultExample.json
|
11422
|
+
TemplateCreateRequestFormFieldsPerDocumentExample:
|
11423
|
+
summary: 'Form Fields Per Document Example'
|
11424
|
+
value:
|
11425
|
+
$ref: examples/json/TemplateCreateRequestFormFieldsPerDocumentExample.json
|
11426
|
+
TemplateCreateRequestFormFieldGroupsExample:
|
11427
|
+
summary: 'Form Fields Per Document and Groups Example'
|
11428
|
+
value:
|
11429
|
+
$ref: examples/json/TemplateCreateRequestFormFieldGroupsExample.json
|
11430
|
+
TemplateCreateRequestFormFieldRulesExample:
|
11431
|
+
summary: 'Form Fields Per Document and Rules Example'
|
11432
|
+
value:
|
11433
|
+
$ref: examples/json/TemplateCreateRequestFormFieldRulesExample.json
|
10927
11434
|
TemplateCreateEmbeddedDraftRequestDefaultExample:
|
10928
11435
|
summary: 'Default Example'
|
10929
11436
|
value:
|
@@ -11104,26 +11611,6 @@ components:
|
|
11104
11611
|
summary: 'API App Update'
|
11105
11612
|
value:
|
11106
11613
|
$ref: examples/json/ApiAppUpdateResponseExample.json
|
11107
|
-
EventCallbackAccountSignatureRequestSentExample:
|
11108
|
-
summary: 'Example: signature_request_sent'
|
11109
|
-
value:
|
11110
|
-
$ref: examples/json/EventCallbackAccountSignatureRequestSentExample.json
|
11111
|
-
EventCallbackAccountTemplateCreatedExample:
|
11112
|
-
summary: 'Example: template_created'
|
11113
|
-
value:
|
11114
|
-
$ref: examples/json/EventCallbackAccountTemplateCreatedExample.json
|
11115
|
-
EventCallbackAppAccountConfirmedExample:
|
11116
|
-
summary: 'Example: account_confirmed'
|
11117
|
-
value:
|
11118
|
-
$ref: examples/json/EventCallbackAppAccountConfirmedExample.json
|
11119
|
-
EventCallbackAppSignatureRequestSentExample:
|
11120
|
-
summary: 'Example: signature_request_sent'
|
11121
|
-
value:
|
11122
|
-
$ref: examples/json/EventCallbackAppSignatureRequestSentExample.json
|
11123
|
-
EventCallbackAppTemplateCreatedExample:
|
11124
|
-
summary: 'Example: template_created'
|
11125
|
-
value:
|
11126
|
-
$ref: examples/json/EventCallbackAppTemplateCreatedExample.json
|
11127
11614
|
SignatureRequestCreateEmbeddedResponseExample:
|
11128
11615
|
summary: 'Create Embedded Signature Request'
|
11129
11616
|
value:
|
@@ -11228,6 +11715,10 @@ components:
|
|
11228
11715
|
summary: 'Team Sub Teams List'
|
11229
11716
|
value:
|
11230
11717
|
$ref: examples/json/TeamSubTeamsResponseExample.json
|
11718
|
+
TemplateCreateResponseExample:
|
11719
|
+
summary: 'Create Template'
|
11720
|
+
value:
|
11721
|
+
$ref: examples/json/TemplateCreateResponseExample.json
|
11231
11722
|
TemplateCreateEmbeddedDraftResponseExample:
|
11232
11723
|
summary: 'Create Embedded Draft Template'
|
11233
11724
|
value:
|
@@ -11248,6 +11739,26 @@ components:
|
|
11248
11739
|
summary: 'Unclaimed Draft Create'
|
11249
11740
|
value:
|
11250
11741
|
$ref: examples/json/UnclaimedDraftCreateResponseExample.json
|
11742
|
+
EventCallbackAccountSignatureRequestSentExample:
|
11743
|
+
summary: 'Example: signature_request_sent'
|
11744
|
+
value:
|
11745
|
+
$ref: examples/json/EventCallbackAccountSignatureRequestSentExample.json
|
11746
|
+
EventCallbackAccountTemplateCreatedExample:
|
11747
|
+
summary: 'Example: template_created'
|
11748
|
+
value:
|
11749
|
+
$ref: examples/json/EventCallbackAccountTemplateCreatedExample.json
|
11750
|
+
EventCallbackAppAccountConfirmedExample:
|
11751
|
+
summary: 'Example: account_confirmed'
|
11752
|
+
value:
|
11753
|
+
$ref: examples/json/EventCallbackAppAccountConfirmedExample.json
|
11754
|
+
EventCallbackAppSignatureRequestSentExample:
|
11755
|
+
summary: 'Example: signature_request_sent'
|
11756
|
+
value:
|
11757
|
+
$ref: examples/json/EventCallbackAppSignatureRequestSentExample.json
|
11758
|
+
EventCallbackAppTemplateCreatedExample:
|
11759
|
+
summary: 'Example: template_created'
|
11760
|
+
value:
|
11761
|
+
$ref: examples/json/EventCallbackAppTemplateCreatedExample.json
|
11251
11762
|
requestBodies:
|
11252
11763
|
EventCallbackAccountRequest:
|
11253
11764
|
description: |-
|