dropbox-sign 1.3.0 → 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.
Files changed (93) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +5 -2
  3. data/README.md +4 -4
  4. data/VERSION +1 -1
  5. data/docs/BulkSendJobGetResponseSignatureRequests.md +1 -0
  6. data/docs/EmbeddedEditUrlRequest.md +1 -1
  7. data/docs/EventCallbackRequestEvent.md +1 -1
  8. data/docs/SignatureRequestApi.md +7 -7
  9. data/docs/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.md +1 -1
  10. data/docs/SignatureRequestBulkSendWithTemplateRequest.md +1 -1
  11. data/docs/SignatureRequestCreateEmbeddedRequest.md +4 -4
  12. data/docs/SignatureRequestCreateEmbeddedWithTemplateRequest.md +1 -1
  13. data/docs/SignatureRequestResponse.md +2 -0
  14. data/docs/SignatureRequestSendRequest.md +5 -5
  15. data/docs/SignatureRequestSendWithTemplateRequest.md +2 -2
  16. data/docs/SignatureRequestUpdateRequest.md +2 -2
  17. data/docs/SubAttachment.md +1 -1
  18. data/docs/SubCustomField.md +1 -1
  19. data/docs/SubFieldOptions.md +1 -1
  20. data/docs/SubFormFieldsPerDocumentBase.md +2 -2
  21. data/docs/SubFormFieldsPerDocumentDateSigned.md +1 -1
  22. data/docs/SubFormFieldsPerDocumentDropdown.md +1 -1
  23. data/docs/SubFormFieldsPerDocumentHyperlink.md +1 -1
  24. data/docs/SubFormFieldsPerDocumentText.md +2 -2
  25. data/docs/SubFormFieldsPerDocumentTextMerge.md +1 -1
  26. data/docs/SubSignatureRequestGroupedSigners.md +1 -1
  27. data/docs/SubSignatureRequestSigner.md +1 -1
  28. data/docs/SubSignatureRequestTemplateSigner.md +1 -1
  29. data/docs/SubSigningOptions.md +1 -1
  30. data/docs/TeamAddMemberRequest.md +1 -1
  31. data/docs/TeamRemoveMemberRequest.md +2 -2
  32. data/docs/TemplateAddUserRequest.md +2 -2
  33. data/docs/TemplateCreateEmbeddedDraftRequest.md +2 -2
  34. data/docs/TemplateCreateRequest.md +2 -2
  35. data/docs/TemplateResponseDocument.md +1 -1
  36. data/docs/TemplateResponseDocumentStaticFieldBase.md +1 -1
  37. data/docs/UnclaimedDraftApi.md +3 -3
  38. data/docs/UnclaimedDraftCreateEmbeddedRequest.md +4 -4
  39. data/docs/UnclaimedDraftCreateEmbeddedWithTemplateRequest.md +3 -3
  40. data/docs/UnclaimedDraftCreateRequest.md +2 -2
  41. data/examples/SignatureRequestEdit.rb +58 -0
  42. data/examples/SignatureRequestEditEmbedded.rb +48 -0
  43. data/examples/SignatureRequestEditEmbeddedWithTemplate.rb +41 -0
  44. data/examples/SignatureRequestEditWithTemplate.rb +52 -0
  45. data/lib/dropbox-sign/api/api_app_api.rb +1 -1
  46. data/lib/dropbox-sign/api/signature_request_api.rb +14 -14
  47. data/lib/dropbox-sign/api/team_api.rb +1 -1
  48. data/lib/dropbox-sign/api/unclaimed_draft_api.rb +6 -6
  49. data/lib/dropbox-sign/event_callback_helper.rb +1 -1
  50. data/lib/dropbox-sign/models/bulk_send_job_get_response_signature_requests.rb +13 -1
  51. data/lib/dropbox-sign/models/embedded_edit_url_request.rb +1 -1
  52. data/lib/dropbox-sign/models/event_callback_request_event.rb +2 -7
  53. data/lib/dropbox-sign/models/signature_request_bulk_create_embedded_with_template_request.rb +1 -1
  54. data/lib/dropbox-sign/models/signature_request_bulk_send_with_template_request.rb +1 -1
  55. data/lib/dropbox-sign/models/signature_request_create_embedded_request.rb +4 -4
  56. data/lib/dropbox-sign/models/signature_request_create_embedded_with_template_request.rb +1 -1
  57. data/lib/dropbox-sign/models/signature_request_response.rb +28 -4
  58. data/lib/dropbox-sign/models/signature_request_send_request.rb +5 -5
  59. data/lib/dropbox-sign/models/signature_request_send_with_template_request.rb +2 -2
  60. data/lib/dropbox-sign/models/signature_request_update_request.rb +2 -2
  61. data/lib/dropbox-sign/models/sub_attachment.rb +1 -1
  62. data/lib/dropbox-sign/models/sub_custom_field.rb +1 -1
  63. data/lib/dropbox-sign/models/sub_field_options.rb +1 -1
  64. data/lib/dropbox-sign/models/sub_form_fields_per_document_base.rb +2 -2
  65. data/lib/dropbox-sign/models/sub_form_fields_per_document_date_signed.rb +3 -1
  66. data/lib/dropbox-sign/models/sub_form_fields_per_document_dropdown.rb +3 -1
  67. data/lib/dropbox-sign/models/sub_form_fields_per_document_hyperlink.rb +3 -1
  68. data/lib/dropbox-sign/models/sub_form_fields_per_document_text.rb +4 -2
  69. data/lib/dropbox-sign/models/sub_form_fields_per_document_text_merge.rb +3 -1
  70. data/lib/dropbox-sign/models/sub_signature_request_grouped_signers.rb +1 -1
  71. data/lib/dropbox-sign/models/sub_signature_request_signer.rb +1 -1
  72. data/lib/dropbox-sign/models/sub_signature_request_template_signer.rb +1 -1
  73. data/lib/dropbox-sign/models/sub_signing_options.rb +1 -1
  74. data/lib/dropbox-sign/models/team_add_member_request.rb +1 -1
  75. data/lib/dropbox-sign/models/team_remove_member_request.rb +2 -2
  76. data/lib/dropbox-sign/models/template_add_user_request.rb +2 -2
  77. data/lib/dropbox-sign/models/template_create_embedded_draft_request.rb +2 -2
  78. data/lib/dropbox-sign/models/template_create_request.rb +2 -2
  79. data/lib/dropbox-sign/models/template_response_document.rb +1 -1
  80. data/lib/dropbox-sign/models/template_response_document_static_field_base.rb +1 -1
  81. data/lib/dropbox-sign/models/unclaimed_draft_create_embedded_request.rb +4 -4
  82. data/lib/dropbox-sign/models/unclaimed_draft_create_embedded_with_template_request.rb +3 -3
  83. data/lib/dropbox-sign/models/unclaimed_draft_create_request.rb +2 -2
  84. data/lib/dropbox-sign/version.rb +1 -1
  85. data/openapi-config.yaml +1 -1
  86. data/openapi-sdk.yaml +154 -121
  87. data/spec/event_callback_helper_spec.rb +17 -3
  88. data/templates/event_callback_helper.mustache +1 -1
  89. data/test_fixtures/EventCallbackHelper_AccountCallbacks.json +82 -0
  90. data/test_fixtures/{EventCallbackHelper.json → EventCallbackHelper_AppCallbacks.json} +8 -4
  91. data/test_fixtures/SignatureRequestSendRequest.json +12 -6
  92. data/test_fixtures/SubFormFieldsPerDocument.json +8 -4
  93. metadata +14 -9
data/openapi-sdk.yaml CHANGED
@@ -457,7 +457,7 @@ paths:
457
457
  schema:
458
458
  $ref: '#/components/schemas/ApiAppCreateRequest'
459
459
  responses:
460
- 200:
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**: Only available for Standard plan and higher.
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**: Only available for Standard plan and higher.
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**: To remove your access to a completed signature request, use the endpoint: `POST /signature_request/remove/[:signature_request_id]`.
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. <u>Note</u> that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign.'
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. <u>Note</u> that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign.'
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
@@ -2927,7 +2927,7 @@ paths:
2927
2927
  description: |-
2928
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.
2929
2929
 
2930
- **NOTE**: This action can **not** be used with embedded signature requests.
2930
+ **NOTE:** This action can **not** be used with embedded signature requests.
2931
2931
  operationId: signatureRequestRemind
2932
2932
  parameters:
2933
2933
  -
@@ -3373,7 +3373,7 @@ paths:
3373
3373
 
3374
3374
  Updating the email address of a signer will generate a new `signature_id` value.
3375
3375
 
3376
- **NOTE**: This action cannot be performed on a signature request with an appended signature page.
3376
+ **NOTE:** This action cannot be performed on a signature request with an appended signature page.
3377
3377
  operationId: signatureRequestUpdate
3378
3378
  parameters:
3379
3379
  -
@@ -4320,7 +4320,7 @@ paths:
4320
4320
  account_id:
4321
4321
  $ref: '#/components/examples/TeamRemoveMemberRequestAccountIdExample'
4322
4322
  responses:
4323
- 200:
4323
+ 201:
4324
4324
  description: 'successful operation'
4325
4325
  headers:
4326
4326
  X-RateLimit-Limit:
@@ -5915,7 +5915,7 @@ paths:
5915
5915
  description: |-
5916
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.
5917
5917
 
5918
- **NOTE**: Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign.
5918
+ **NOTE:** Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign.
5919
5919
  operationId: unclaimedDraftCreateEmbedded
5920
5920
  requestBody:
5921
5921
  required: true
@@ -6033,7 +6033,7 @@ paths:
6033
6033
  description: |-
6034
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.
6035
6035
 
6036
- **NOTE**: Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign.
6036
+ **NOTE:** Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign.
6037
6037
  operationId: unclaimedDraftCreateEmbeddedWithTemplate
6038
6038
  requestBody:
6039
6039
  required: true
@@ -6146,7 +6146,7 @@ paths:
6146
6146
  description: |-
6147
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.
6148
6148
 
6149
- **NOTE**: Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign.
6149
+ **NOTE:** Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign.
6150
6150
  operationId: unclaimedDraftEditAndResend
6151
6151
  parameters:
6152
6152
  -
@@ -6393,7 +6393,7 @@ components:
6393
6393
  description: |-
6394
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).
6395
6395
 
6396
- **Note**: This parameter overwrites `show_preview=true` (if set).
6396
+ **NOTE:** This parameter overwrites `show_preview=true` (if set).
6397
6397
  type: boolean
6398
6398
  default: false
6399
6399
  show_preview:
@@ -6489,7 +6489,9 @@ components:
6489
6489
  - `pin`: the 4- to 12-character access code that will secure this signer's signature page (optional)
6490
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)
6491
6491
 
6492
- **Note**: Not available in test mode and requires a Standard plan or higher.
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.
6493
6495
  - `*_field`: any column with a _field" suffix will be treated as a custom field (optional)
6494
6496
 
6495
6497
  You may only specify field values here, any other options should be set in the custom_fields request parameter.
@@ -6576,7 +6578,9 @@ components:
6576
6578
  - `pin`: the 4- to 12-character access code that will secure this signer's signature page (optional)
6577
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)
6578
6580
 
6579
- **Note**: Not available in test mode and requires a Standard plan or higher.
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.
6580
6584
  - `*_field`: any column with a _field" suffix will be treated as a custom field (optional)
6581
6585
 
6582
6586
  You may only specify field values here, any other options should be set in the custom_fields request parameter.
@@ -6690,7 +6694,7 @@ components:
6690
6694
  description: |-
6691
6695
  Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.
6692
6696
 
6693
- **Note**: Only available for Premium plan.
6697
+ **NOTE:** Only available for Premium plan.
6694
6698
  type: boolean
6695
6699
  default: false
6696
6700
  attachments:
@@ -6733,7 +6737,7 @@ components:
6733
6737
  description: |-
6734
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).)
6735
6739
 
6736
- **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.
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.
6737
6741
 
6738
6742
  * Text Field use `SubFormFieldsPerDocumentText`
6739
6743
  * Dropdown Field use `SubFormFieldsPerDocumentDropdown`
@@ -6752,7 +6756,7 @@ components:
6752
6756
  description: |-
6753
6757
  Enables automatic Text Tag removal when set to true.
6754
6758
 
6755
- **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.
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.
6756
6760
  type: boolean
6757
6761
  default: false
6758
6762
  message:
@@ -6789,7 +6793,7 @@ components:
6789
6793
  description: |-
6790
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.
6791
6795
 
6792
- ⚠️ **Note** ⚠️: Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature.
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.
6793
6797
  type: boolean
6794
6798
  default: false
6795
6799
  expires_at:
@@ -6877,7 +6881,7 @@ components:
6877
6881
  description: |-
6878
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.
6879
6883
 
6880
- ⚠️ **Note** ⚠️: Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature.
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.
6881
6885
  type: boolean
6882
6886
  default: false
6883
6887
  type: object
@@ -6936,7 +6940,7 @@ components:
6936
6940
  description: |-
6937
6941
  Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.
6938
6942
 
6939
- **Note**: Only available for Premium plan and higher.
6943
+ **NOTE:** Only available for Premium plan and higher.
6940
6944
  type: boolean
6941
6945
  default: false
6942
6946
  attachments:
@@ -6979,7 +6983,7 @@ components:
6979
6983
  description: |-
6980
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).)
6981
6985
 
6982
- **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.
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.
6983
6987
 
6984
6988
  * Text Field use `SubFormFieldsPerDocumentText`
6985
6989
  * Dropdown Field use `SubFormFieldsPerDocumentDropdown`
@@ -6998,7 +7002,7 @@ components:
6998
7002
  description: |-
6999
7003
  Enables automatic Text Tag removal when set to true.
7000
7004
 
7001
- **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.
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.
7002
7006
  type: boolean
7003
7007
  default: false
7004
7008
  is_qualified_signature:
@@ -7006,7 +7010,7 @@ components:
7006
7010
  Send with a value of `true` if you wish to enable
7007
7011
  [Qualified Electronic Signatures](https://www.hellosign.com/features/qualified-electronic-signatures) (QES),
7008
7012
  which requires a face-to-face call to verify the signer's identity.<br>
7009
- **Note**: QES is only available on the Premium API plan as an add-on purchase.
7013
+ **NOTE:** QES is only available on the Premium API plan as an add-on purchase.
7010
7014
  Cannot be used in `test_mode`. Only works on requests with one signer.
7011
7015
  type: boolean
7012
7016
  default: false
@@ -7017,7 +7021,7 @@ components:
7017
7021
  Send with a value of `true` if you wish to enable
7018
7022
  [electronic identification (eID)](https://www.hellosign.com/features/electronic-id),
7019
7023
  which requires the signer to verify their identity with an eID provider to sign a document.<br>
7020
- **Note**: eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer.
7024
+ **NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer.
7021
7025
  type: boolean
7022
7026
  default: false
7023
7027
  message:
@@ -7108,7 +7112,7 @@ components:
7108
7112
  Send with a value of `true` if you wish to enable
7109
7113
  [Qualified Electronic Signatures](https://www.hellosign.com/features/qualified-electronic-signatures) (QES),
7110
7114
  which requires a face-to-face call to verify the signer's identity.<br>
7111
- **Note**: QES is only available on the Premium API plan as an add-on purchase.
7115
+ **NOTE:** QES is only available on the Premium API plan as an add-on purchase.
7112
7116
  Cannot be used in `test_mode`. Only works on requests with one signer.
7113
7117
  type: boolean
7114
7118
  default: false
@@ -7119,7 +7123,7 @@ components:
7119
7123
  Send with a value of `true` if you wish to enable
7120
7124
  [electronic identification (eID)](https://www.hellosign.com/features/electronic-id),
7121
7125
  which requires the signer to verify their identity with an eID provider to sign a document.<br>
7122
- **Note**: eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer.
7126
+ **NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer.
7123
7127
  type: boolean
7124
7128
  default: false
7125
7129
  message:
@@ -7167,14 +7171,14 @@ components:
7167
7171
 
7168
7172
  This will generate a new `signature_id` value.
7169
7173
 
7170
- **NOTE**: Optional if `name` is provided.
7174
+ **NOTE:** Optional if `name` is provided.
7171
7175
  type: string
7172
7176
  format: email
7173
7177
  name:
7174
7178
  description: |-
7175
7179
  The new name for the recipient.
7176
7180
 
7177
- **NOTE**: Optional if `email_address` is provided.
7181
+ **NOTE:** Optional if `email_address` is provided.
7178
7182
  type: string
7179
7183
  signature_id:
7180
7184
  description: 'The signature ID for the recipient.'
@@ -7203,7 +7207,7 @@ components:
7203
7207
  description: |-
7204
7208
  The signer's index in the `signers` parameter (0-based indexing).
7205
7209
 
7206
- **NOTE**: Only one signer can be assigned per attachment.
7210
+ **NOTE:** Only one signer can be assigned per attachment.
7207
7211
  type: integer
7208
7212
  type: object
7209
7213
  SubBulkSignerList:
@@ -7261,7 +7265,7 @@ components:
7261
7265
  description: |-
7262
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`.
7263
7267
 
7264
- **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.
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.
7265
7269
  type: string
7266
7270
  name:
7267
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.'
@@ -7295,7 +7299,7 @@ components:
7295
7299
  description: |-
7296
7300
  Allows requester to specify the date format (see list of allowed [formats](/api/reference/constants/#date-formats))
7297
7301
 
7298
- **Note**: Only available for Premium and higher.
7302
+ **NOTE:** Only available for Premium and higher.
7299
7303
  type: string
7300
7304
  enum:
7301
7305
  - 'MM / DD / YYYY'
@@ -7474,8 +7478,6 @@ components:
7474
7478
  description: '`true` for checking the checkbox field by default, otherwise `false`.'
7475
7479
  type: boolean
7476
7480
  type: object
7477
- -
7478
- $ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
7479
7481
  SubFormFieldsPerDocumentCheckboxMerge:
7480
7482
  description: 'This class extends `SubFormFieldsPerDocumentBase`.'
7481
7483
  allOf:
@@ -7490,8 +7492,6 @@ components:
7490
7492
  type: string
7491
7493
  default: checkbox-merge
7492
7494
  type: object
7493
- -
7494
- $ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
7495
7495
  SubFormFieldsPerDocumentDateSigned:
7496
7496
  description: 'This class extends `SubFormFieldsPerDocumentBase`.'
7497
7497
  allOf:
@@ -7529,11 +7529,10 @@ components:
7529
7529
  description: |-
7530
7530
  The initial px font size for the field contents. Can be any integer value between `7` and `49`.
7531
7531
 
7532
- **NOTE**: Font size may be reduced during processing in order to fit the contents within the dimensions of the field.
7532
+ **NOTE:** Font size may be reduced during processing in order to fit the contents within the dimensions of the field.
7533
7533
  type: integer
7534
+ default: 12
7534
7535
  type: object
7535
- -
7536
- $ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
7537
7536
  SubFormFieldsPerDocumentDropdown:
7538
7537
  description: 'This class extends `SubFormFieldsPerDocumentBase`.'
7539
7538
  allOf:
@@ -7581,11 +7580,10 @@ components:
7581
7580
  description: |-
7582
7581
  The initial px font size for the field contents. Can be any integer value between `7` and `49`.
7583
7582
 
7584
- **NOTE**: Font size may be reduced during processing in order to fit the contents within the dimensions of the field.
7583
+ **NOTE:** Font size may be reduced during processing in order to fit the contents within the dimensions of the field.
7585
7584
  type: integer
7585
+ default: 12
7586
7586
  type: object
7587
- -
7588
- $ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
7589
7587
  SubFormFieldsPerDocumentHyperlink:
7590
7588
  description: 'This class extends `SubFormFieldsPerDocumentBase`.'
7591
7589
  allOf:
@@ -7631,11 +7629,10 @@ components:
7631
7629
  description: |-
7632
7630
  The initial px font size for the field contents. Can be any integer value between `7` and `49`.
7633
7631
 
7634
- **NOTE**: Font size may be reduced during processing in order to fit the contents within the dimensions of the field.
7632
+ **NOTE:** Font size may be reduced during processing in order to fit the contents within the dimensions of the field.
7635
7633
  type: integer
7634
+ default: 12
7636
7635
  type: object
7637
- -
7638
- $ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
7639
7636
  SubFormFieldsPerDocumentInitials:
7640
7637
  description: 'This class extends `SubFormFieldsPerDocumentBase`.'
7641
7638
  allOf:
@@ -7650,8 +7647,6 @@ components:
7650
7647
  type: string
7651
7648
  default: initials
7652
7649
  type: object
7653
- -
7654
- $ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
7655
7650
  SubFormFieldsPerDocumentRadio:
7656
7651
  description: 'This class extends `SubFormFieldsPerDocumentBase`.'
7657
7652
  allOf:
@@ -7674,8 +7669,6 @@ components:
7674
7669
  description: '`true` for checking the radio field by default, otherwise `false`. Only one radio field per group can be `true`.'
7675
7670
  type: boolean
7676
7671
  type: object
7677
- -
7678
- $ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
7679
7672
  SubFormFieldsPerDocumentSignature:
7680
7673
  description: 'This class extends `SubFormFieldsPerDocumentBase`.'
7681
7674
  allOf:
@@ -7690,8 +7683,6 @@ components:
7690
7683
  type: string
7691
7684
  default: signature
7692
7685
  type: object
7693
- -
7694
- $ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
7695
7686
  SubFormFieldsPerDocumentText:
7696
7687
  description: 'This class extends `SubFormFieldsPerDocumentBase`.'
7697
7688
  allOf:
@@ -7722,7 +7713,7 @@ components:
7722
7713
  description: |-
7723
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.
7724
7715
 
7725
- **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.
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.
7726
7717
  type: string
7727
7718
  enum:
7728
7719
  - numbers_only
@@ -7766,11 +7757,10 @@ components:
7766
7757
  description: |-
7767
7758
  The initial px font size for the field contents. Can be any integer value between `7` and `49`.
7768
7759
 
7769
- **NOTE**: Font size may be reduced during processing in order to fit the contents within the dimensions of the field.
7760
+ **NOTE:** Font size may be reduced during processing in order to fit the contents within the dimensions of the field.
7770
7761
  type: integer
7762
+ default: 12
7771
7763
  type: object
7772
- -
7773
- $ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
7774
7764
  SubFormFieldsPerDocumentTextMerge:
7775
7765
  description: 'This class extends `SubFormFieldsPerDocumentBase`.'
7776
7766
  allOf:
@@ -7808,11 +7798,10 @@ components:
7808
7798
  description: |-
7809
7799
  The initial px font size for the field contents. Can be any integer value between `7` and `49`.
7810
7800
 
7811
- **NOTE**: Font size may be reduced during processing in order to fit the contents within the dimensions of the field.
7801
+ **NOTE:** Font size may be reduced during processing in order to fit the contents within the dimensions of the field.
7812
7802
  type: integer
7803
+ default: 12
7813
7804
  type: object
7814
- -
7815
- $ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
7816
7805
  SubFormFieldsPerDocumentTypeEnum:
7817
7806
  type: string
7818
7807
  enum:
@@ -7849,7 +7838,7 @@ components:
7849
7838
  description: |-
7850
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).)
7851
7840
 
7852
- **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.
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.
7853
7842
 
7854
7843
  * Text Field use `SubFormFieldsPerDocumentText`
7855
7844
  * Dropdown Field use `SubFormFieldsPerDocumentDropdown`
@@ -7899,9 +7888,9 @@ components:
7899
7888
  description: |-
7900
7889
  Signer index identified by the offset in the signers parameter (0-based indexing), indicating which signer should fill out the field.
7901
7890
 
7902
- **NOTE**: To set the value of the field as the preparer you must set this to `me_now`
7891
+ **NOTE:** To set the value of the field as the preparer you must set this to `me_now`
7903
7892
 
7904
- **NOTE**: If type is `text-merge` or `checkbox-merge`, you must set this to sender in order to use pre-filled data.
7893
+ **NOTE:** If type is `text-merge` or `checkbox-merge`, you must set this to sender in order to use pre-filled data.
7905
7894
  type: string
7906
7895
  x-int-or-string: true
7907
7896
  type:
@@ -7947,7 +7936,7 @@ components:
7947
7936
  description: |-
7948
7937
  Signers belonging to this Group.
7949
7938
 
7950
- **NOTE**: Only `name`, `email_address`, and `pin` are available to Grouped Signers. We will ignore all other properties, even though they are listed below.
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.
7951
7940
  type: array
7952
7941
  items:
7953
7942
  $ref: '#/components/schemas/SubSignatureRequestSigner'
@@ -8024,7 +8013,9 @@ components:
8024
8013
  description: |-
8025
8014
  An E.164 formatted phone number.
8026
8015
 
8027
- **Note**: Not available in test mode and requires a Standard plan or higher.
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.
8028
8019
  type: string
8029
8020
  sms_phone_number_type:
8030
8021
  description: |-
@@ -8063,7 +8054,9 @@ components:
8063
8054
  description: |-
8064
8055
  An E.164 formatted phone number.
8065
8056
 
8066
- **Note**: Not available in test mode and requires a Standard plan or higher.
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.
8067
8060
  type: string
8068
8061
  sms_phone_number_type:
8069
8062
  description: |-
@@ -8125,7 +8118,7 @@ components:
8125
8118
  description: |-
8126
8119
  This allows the requester to specify the types allowed for creating a signature.
8127
8120
 
8128
- **Note**: If `signing_options` are not defined in the request, the allowed types will default to those specified in the account settings.
8121
+ **NOTE:** If `signing_options` are not defined in the request, the allowed types will default to those specified in the account settings.
8129
8122
  required:
8130
8123
  - default_type
8131
8124
  properties:
@@ -8228,7 +8221,7 @@ components:
8228
8221
  description: |-
8229
8222
  A role member will take in a new Team.
8230
8223
 
8231
- **Note**: This parameter is used only if `team_id` is provided.
8224
+ **NOTE:** This parameter is used only if `team_id` is provided.
8232
8225
  type: string
8233
8226
  enum:
8234
8227
  - Member
@@ -8262,7 +8255,7 @@ components:
8262
8255
  description: |-
8263
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.
8264
8257
 
8265
- **Note**: Only available for Enterprise plans.
8258
+ **NOTE:** Only available for Enterprise plans.
8266
8259
  type: string
8267
8260
  format: email
8268
8261
  new_team_id:
@@ -8272,7 +8265,7 @@ components:
8272
8265
  description: |-
8273
8266
  A new role member will take in a new Team.
8274
8267
 
8275
- **Note**: This parameter is used only if `new_team_id` is provided.
8268
+ **NOTE:** This parameter is used only if `new_team_id` is provided.
8276
8269
  type: string
8277
8270
  enum:
8278
8271
  - Member
@@ -8291,12 +8284,12 @@ components:
8291
8284
  account_id:
8292
8285
  description: |-
8293
8286
  The id of the Account to give access to the Template.
8294
- <b>Note</b> The account id prevails if email address is also provided.
8287
+ **NOTE:** The account id prevails if email address is also provided.
8295
8288
  type: string
8296
8289
  email_address:
8297
8290
  description: |-
8298
8291
  The email address of the Account to give access to the Template.
8299
- <b>Note</b> The account id prevails if it is also provided.
8292
+ **NOTE:** The account id prevails if it is also provided.
8300
8293
  type: string
8301
8294
  format: email
8302
8295
  skip_notification:
@@ -8330,7 +8323,7 @@ components:
8330
8323
  description: |-
8331
8324
  Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.
8332
8325
 
8333
- **Note**: Only available for Premium plan and higher.
8326
+ **NOTE:** Only available for Premium plan and higher.
8334
8327
  type: boolean
8335
8328
  default: false
8336
8329
  attachments:
@@ -8362,7 +8355,7 @@ components:
8362
8355
  description: |-
8363
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).)
8364
8357
 
8365
- **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.
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.
8366
8359
 
8367
8360
  * Text Field use `SubFormFieldsPerDocumentText`
8368
8361
  * Dropdown Field use `SubFormFieldsPerDocumentDropdown`
@@ -8446,7 +8439,7 @@ components:
8446
8439
  description: |-
8447
8440
  Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.
8448
8441
 
8449
- **Note**: Only available for Premium plan and higher.
8442
+ **NOTE:** Only available for Premium plan and higher.
8450
8443
  type: boolean
8451
8444
  default: false
8452
8445
  attachments:
@@ -8488,7 +8481,7 @@ components:
8488
8481
  description: |-
8489
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).)
8490
8483
 
8491
- **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.
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.
8492
8485
 
8493
8486
  * Text Field use `SubFormFieldsPerDocumentText`
8494
8487
  * Dropdown Field use `SubFormFieldsPerDocumentDropdown`
@@ -8670,7 +8663,7 @@ components:
8670
8663
  description: |-
8671
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).)
8672
8665
 
8673
- **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.
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.
8674
8667
 
8675
8668
  * Text Field use `SubFormFieldsPerDocumentText`
8676
8669
  * Dropdown Field use `SubFormFieldsPerDocumentDropdown`
@@ -8741,7 +8734,7 @@ components:
8741
8734
  description: |-
8742
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.
8743
8736
 
8744
- **Note**: This does not correspond to the **expires_at** returned in the response.
8737
+ **NOTE:** This does not correspond to the **expires_at** returned in the response.
8745
8738
  type: integer
8746
8739
  nullable: true
8747
8740
  type: object
@@ -8780,7 +8773,7 @@ components:
8780
8773
  description: |-
8781
8774
  Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.
8782
8775
 
8783
- **Note**: Only available for Premium plan and higher.
8776
+ **NOTE:** Only available for Premium plan and higher.
8784
8777
  type: boolean
8785
8778
  default: false
8786
8779
  attachments:
@@ -8833,7 +8826,7 @@ components:
8833
8826
  description: |-
8834
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).)
8835
8828
 
8836
- **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.
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.
8837
8830
 
8838
8831
  * Text Field use `SubFormFieldsPerDocumentText`
8839
8832
  * Dropdown Field use `SubFormFieldsPerDocumentDropdown`
@@ -8931,14 +8924,14 @@ components:
8931
8924
  description: |-
8932
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.
8933
8926
 
8934
- ⚠️ **Note** ⚠️: Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature.
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.
8935
8928
  type: boolean
8936
8929
  default: false
8937
8930
  expires_at:
8938
8931
  description: |-
8939
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.
8940
8933
 
8941
- **Note**: This does not correspond to the **expires_at** returned in the response.
8934
+ **NOTE:** This does not correspond to the **expires_at** returned in the response.
8942
8935
  type: integer
8943
8936
  nullable: true
8944
8937
  type: object
@@ -8956,7 +8949,7 @@ components:
8956
8949
  description: |-
8957
8950
  Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.
8958
8951
 
8959
- **Note**: Only available for Premium plan and higher.
8952
+ **NOTE:** Only available for Premium plan and higher.
8960
8953
  type: boolean
8961
8954
  default: false
8962
8955
  ccs:
@@ -9028,7 +9021,7 @@ components:
9028
9021
  - `preview_only=true`: Allows requesters to enable the preview only experience.
9029
9022
  - `preview_only=false`: Allows requesters to disable the preview only experience.
9030
9023
 
9031
- **Note**: This parameter overwrites `show_preview=1` (if set).
9024
+ **NOTE:** This parameter overwrites `show_preview=1` (if set).
9032
9025
  type: boolean
9033
9026
  default: false
9034
9027
  requester_email_address:
@@ -9085,7 +9078,7 @@ components:
9085
9078
  description: |-
9086
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.
9087
9080
 
9088
- ⚠️ **Note** ⚠️: Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature.
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.
9089
9082
  type: boolean
9090
9083
  default: false
9091
9084
  allow_ccs:
@@ -9680,6 +9673,10 @@ components:
9680
9673
  description: 'The URL you want the signer redirected to after they successfully sign.'
9681
9674
  type: string
9682
9675
  nullable: true
9676
+ final_copy_uri:
9677
+ description: 'The path where the completed document can be downloaded'
9678
+ type: string
9679
+ nullable: true
9683
9680
  template_ids:
9684
9681
  description: 'Templates IDs used in this SignatureRequest (if any).'
9685
9682
  type: array
@@ -9713,6 +9710,10 @@ components:
9713
9710
  type: array
9714
9711
  items:
9715
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
9716
9717
  type: object
9717
9718
  x-internal: true
9718
9719
  SignatureRequestResponseAttachment:
@@ -9780,13 +9781,13 @@ components:
9780
9781
  x-base-class: true
9781
9782
  SignatureRequestResponseCustomFieldCheckbox:
9782
9783
  description: 'This class extends `SignatureRequestResponseCustomFieldBase`.'
9783
- required:
9784
- - type
9785
- type: object
9786
9784
  allOf:
9787
9785
  -
9788
9786
  $ref: '#/components/schemas/SignatureRequestResponseCustomFieldBase'
9789
9787
  -
9788
+ required:
9789
+ - name
9790
+ - type
9790
9791
  properties:
9791
9792
  type:
9792
9793
  description: 'The type of this Custom Field. Only ''text'' and ''checkbox'' are currently supported.'
@@ -9795,15 +9796,16 @@ components:
9795
9796
  value:
9796
9797
  description: 'A true/false for checkbox fields'
9797
9798
  type: boolean
9799
+ type: object
9798
9800
  SignatureRequestResponseCustomFieldText:
9799
9801
  description: 'This class extends `SignatureRequestResponseCustomFieldBase`.'
9800
- required:
9801
- - type
9802
- type: object
9803
9802
  allOf:
9804
9803
  -
9805
9804
  $ref: '#/components/schemas/SignatureRequestResponseCustomFieldBase'
9806
9805
  -
9806
+ required:
9807
+ - name
9808
+ - type
9807
9809
  properties:
9808
9810
  type:
9809
9811
  description: 'The type of this Custom Field. Only ''text'' and ''checkbox'' are currently supported.'
@@ -9812,6 +9814,7 @@ components:
9812
9814
  value:
9813
9815
  description: 'A text string for text fields'
9814
9816
  type: string
9817
+ type: object
9815
9818
  SignatureRequestResponseCustomFieldTypeEnum:
9816
9819
  type: string
9817
9820
  enum:
@@ -9862,7 +9865,6 @@ components:
9862
9865
  - text-merge
9863
9866
  - checkbox-merge
9864
9867
  SignatureRequestResponseDataValueCheckbox:
9865
- type: object
9866
9868
  allOf:
9867
9869
  -
9868
9870
  $ref: '#/components/schemas/SignatureRequestResponseDataBase'
@@ -9875,8 +9877,8 @@ components:
9875
9877
  value:
9876
9878
  description: 'The value of the form field.'
9877
9879
  type: boolean
9880
+ type: object
9878
9881
  SignatureRequestResponseDataValueCheckboxMerge:
9879
- type: object
9880
9882
  allOf:
9881
9883
  -
9882
9884
  $ref: '#/components/schemas/SignatureRequestResponseDataBase'
@@ -9889,8 +9891,8 @@ components:
9889
9891
  value:
9890
9892
  description: 'The value of the form field.'
9891
9893
  type: string
9894
+ type: object
9892
9895
  SignatureRequestResponseDataValueDateSigned:
9893
- type: object
9894
9896
  allOf:
9895
9897
  -
9896
9898
  $ref: '#/components/schemas/SignatureRequestResponseDataBase'
@@ -9903,8 +9905,8 @@ components:
9903
9905
  value:
9904
9906
  description: 'The value of the form field.'
9905
9907
  type: string
9908
+ type: object
9906
9909
  SignatureRequestResponseDataValueDropdown:
9907
- type: object
9908
9910
  allOf:
9909
9911
  -
9910
9912
  $ref: '#/components/schemas/SignatureRequestResponseDataBase'
@@ -9917,8 +9919,8 @@ components:
9917
9919
  value:
9918
9920
  description: 'The value of the form field.'
9919
9921
  type: string
9922
+ type: object
9920
9923
  SignatureRequestResponseDataValueInitials:
9921
- type: object
9922
9924
  allOf:
9923
9925
  -
9924
9926
  $ref: '#/components/schemas/SignatureRequestResponseDataBase'
@@ -9931,8 +9933,8 @@ components:
9931
9933
  value:
9932
9934
  description: 'The value of the form field.'
9933
9935
  type: string
9936
+ type: object
9934
9937
  SignatureRequestResponseDataValueRadio:
9935
- type: object
9936
9938
  allOf:
9937
9939
  -
9938
9940
  $ref: '#/components/schemas/SignatureRequestResponseDataBase'
@@ -9945,8 +9947,8 @@ components:
9945
9947
  value:
9946
9948
  description: 'The value of the form field.'
9947
9949
  type: boolean
9950
+ type: object
9948
9951
  SignatureRequestResponseDataValueSignature:
9949
- type: object
9950
9952
  allOf:
9951
9953
  -
9952
9954
  $ref: '#/components/schemas/SignatureRequestResponseDataBase'
@@ -9959,8 +9961,8 @@ components:
9959
9961
  value:
9960
9962
  description: 'The value of the form field.'
9961
9963
  type: string
9964
+ type: object
9962
9965
  SignatureRequestResponseDataValueText:
9963
- type: object
9964
9966
  allOf:
9965
9967
  -
9966
9968
  $ref: '#/components/schemas/SignatureRequestResponseDataBase'
@@ -9973,8 +9975,8 @@ components:
9973
9975
  value:
9974
9976
  description: 'The value of the form field.'
9975
9977
  type: string
9978
+ type: object
9976
9979
  SignatureRequestResponseDataValueTextMerge:
9977
- type: object
9978
9980
  allOf:
9979
9981
  -
9980
9982
  $ref: '#/components/schemas/SignatureRequestResponseDataBase'
@@ -9987,6 +9989,7 @@ components:
9987
9989
  value:
9988
9990
  description: 'The value of the form field.'
9989
9991
  type: string
9992
+ type: object
9990
9993
  SignatureRequestResponseSignatures:
9991
9994
  description: 'An array of signature objects, 1 for each signer.'
9992
9995
  properties:
@@ -10332,7 +10335,7 @@ components:
10332
10335
  items:
10333
10336
  $ref: '#/components/schemas/TemplateResponseDocumentCustomFieldBase'
10334
10337
  static_fields:
10335
- description: 'An array describing static overlay fields. **Note** only available for certain subscriptions.'
10338
+ description: 'An array describing static overlay fields. **NOTE:** Only available for certain subscriptions.'
10336
10339
  type: array
10337
10340
  items:
10338
10341
  $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase'
@@ -10387,7 +10390,6 @@ components:
10387
10390
  description: 'This class extends `TemplateResponseDocumentCustomFieldBase`'
10388
10391
  required:
10389
10392
  - type
10390
- type: object
10391
10393
  allOf:
10392
10394
  -
10393
10395
  $ref: '#/components/schemas/TemplateResponseDocumentCustomFieldBase'
@@ -10401,11 +10403,11 @@ components:
10401
10403
  * Checkbox uses `TemplateResponseDocumentCustomFieldCheckbox`
10402
10404
  type: string
10403
10405
  default: checkbox
10406
+ type: object
10404
10407
  TemplateResponseDocumentCustomFieldText:
10405
10408
  description: 'This class extends `TemplateResponseDocumentCustomFieldBase`'
10406
10409
  required:
10407
10410
  - type
10408
- type: object
10409
10411
  allOf:
10410
10412
  -
10411
10413
  $ref: '#/components/schemas/TemplateResponseDocumentCustomFieldBase'
@@ -10430,6 +10432,7 @@ components:
10430
10432
  fontFamily:
10431
10433
  description: 'Font family used in this form field''s text.'
10432
10434
  type: string
10435
+ type: object
10433
10436
  TemplateResponseDocumentFieldGroup:
10434
10437
  properties:
10435
10438
  name:
@@ -10506,13 +10509,12 @@ components:
10506
10509
  x-base-class: true
10507
10510
  TemplateResponseDocumentFormFieldCheckbox:
10508
10511
  description: 'This class extends `TemplateResponseDocumentFormFieldBase`'
10509
- required:
10510
- - type
10511
- type: object
10512
10512
  allOf:
10513
10513
  -
10514
10514
  $ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase'
10515
10515
  -
10516
+ required:
10517
+ - type
10516
10518
  properties:
10517
10519
  type:
10518
10520
  description: |-
@@ -10528,15 +10530,17 @@ components:
10528
10530
  * Initials Field uses `TemplateResponseDocumentFormFieldInitials`
10529
10531
  type: string
10530
10532
  default: checkbox
10533
+ type: object
10531
10534
  TemplateResponseDocumentFormFieldDateSigned:
10532
10535
  description: 'This class extends `TemplateResponseDocumentFormFieldBase`'
10533
10536
  required:
10534
10537
  - type
10535
- type: object
10536
10538
  allOf:
10537
10539
  -
10538
10540
  $ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase'
10539
10541
  -
10542
+ required:
10543
+ - type
10540
10544
  properties:
10541
10545
  type:
10542
10546
  description: |-
@@ -10552,15 +10556,17 @@ components:
10552
10556
  * Initials Field uses `TemplateResponseDocumentFormFieldInitials`
10553
10557
  type: string
10554
10558
  default: date_signed
10559
+ type: object
10555
10560
  TemplateResponseDocumentFormFieldDropdown:
10556
10561
  description: 'This class extends `TemplateResponseDocumentFormFieldBase`'
10557
10562
  required:
10558
10563
  - type
10559
- type: object
10560
10564
  allOf:
10561
10565
  -
10562
10566
  $ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase'
10563
10567
  -
10568
+ required:
10569
+ - type
10564
10570
  properties:
10565
10571
  type:
10566
10572
  description: |-
@@ -10576,15 +10582,17 @@ components:
10576
10582
  * Initials Field uses `TemplateResponseDocumentFormFieldInitials`
10577
10583
  type: string
10578
10584
  default: dropdown
10585
+ type: object
10579
10586
  TemplateResponseDocumentFormFieldHyperlink:
10580
10587
  description: 'This class extends `TemplateResponseDocumentFormFieldBase`'
10581
10588
  required:
10582
10589
  - type
10583
- type: object
10584
10590
  allOf:
10585
10591
  -
10586
10592
  $ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase'
10587
10593
  -
10594
+ required:
10595
+ - type
10588
10596
  properties:
10589
10597
  type:
10590
10598
  description: |-
@@ -10611,15 +10619,17 @@ components:
10611
10619
  fontFamily:
10612
10620
  description: 'Font family used in this form field''s text.'
10613
10621
  type: string
10622
+ type: object
10614
10623
  TemplateResponseDocumentFormFieldInitials:
10615
10624
  description: 'This class extends `TemplateResponseDocumentFormFieldBase`'
10616
10625
  required:
10617
10626
  - type
10618
- type: object
10619
10627
  allOf:
10620
10628
  -
10621
10629
  $ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase'
10622
10630
  -
10631
+ required:
10632
+ - type
10623
10633
  properties:
10624
10634
  type:
10625
10635
  description: |-
@@ -10635,16 +10645,18 @@ components:
10635
10645
  * Initials Field uses `TemplateResponseDocumentFormFieldInitials`
10636
10646
  type: string
10637
10647
  default: initials
10648
+ type: object
10638
10649
  TemplateResponseDocumentFormFieldRadio:
10639
10650
  description: 'This class extends `TemplateResponseDocumentFormFieldBase`'
10640
10651
  required:
10641
10652
  - type
10642
10653
  - group
10643
- type: object
10644
10654
  allOf:
10645
10655
  -
10646
10656
  $ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase'
10647
10657
  -
10658
+ required:
10659
+ - type
10648
10660
  properties:
10649
10661
  type:
10650
10662
  description: |-
@@ -10660,15 +10672,17 @@ components:
10660
10672
  * Initials Field uses `TemplateResponseDocumentFormFieldInitials`
10661
10673
  type: string
10662
10674
  default: radio
10675
+ type: object
10663
10676
  TemplateResponseDocumentFormFieldSignature:
10664
10677
  description: 'This class extends `TemplateResponseDocumentFormFieldBase`'
10665
10678
  required:
10666
10679
  - type
10667
- type: object
10668
10680
  allOf:
10669
10681
  -
10670
10682
  $ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase'
10671
10683
  -
10684
+ required:
10685
+ - type
10672
10686
  properties:
10673
10687
  type:
10674
10688
  description: |-
@@ -10684,15 +10698,17 @@ components:
10684
10698
  * Initials Field uses `TemplateResponseDocumentFormFieldInitials`
10685
10699
  type: string
10686
10700
  default: signature
10701
+ type: object
10687
10702
  TemplateResponseDocumentFormFieldText:
10688
10703
  description: 'This class extends `TemplateResponseDocumentFormFieldBase`'
10689
10704
  required:
10690
10705
  - type
10691
- type: object
10692
10706
  allOf:
10693
10707
  -
10694
10708
  $ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase'
10695
10709
  -
10710
+ required:
10711
+ - type
10696
10712
  properties:
10697
10713
  type:
10698
10714
  description: |-
@@ -10734,8 +10750,9 @@ components:
10734
10750
  - employer_identification_number
10735
10751
  - custom_regex
10736
10752
  nullable: true
10753
+ type: object
10737
10754
  TemplateResponseDocumentStaticFieldBase:
10738
- description: 'An array describing static overlay fields. **Note** only available for certain subscriptions.'
10755
+ description: 'An array describing static overlay fields. **NOTE:** Only available for certain subscriptions.'
10739
10756
  required:
10740
10757
  - type
10741
10758
  properties:
@@ -10788,11 +10805,12 @@ components:
10788
10805
  description: 'This class extends `TemplateResponseDocumentStaticFieldBase`'
10789
10806
  required:
10790
10807
  - type
10791
- type: object
10792
10808
  allOf:
10793
10809
  -
10794
10810
  $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase'
10795
10811
  -
10812
+ required:
10813
+ - type
10796
10814
  properties:
10797
10815
  type:
10798
10816
  description: |-
@@ -10808,15 +10826,17 @@ components:
10808
10826
  * Initials Field uses `TemplateResponseDocumentStaticFieldInitials`
10809
10827
  type: string
10810
10828
  default: checkbox
10829
+ type: object
10811
10830
  TemplateResponseDocumentStaticFieldDateSigned:
10812
10831
  description: 'This class extends `TemplateResponseDocumentStaticFieldBase`'
10813
10832
  required:
10814
10833
  - type
10815
- type: object
10816
10834
  allOf:
10817
10835
  -
10818
10836
  $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase'
10819
10837
  -
10838
+ required:
10839
+ - type
10820
10840
  properties:
10821
10841
  type:
10822
10842
  description: |-
@@ -10832,15 +10852,17 @@ components:
10832
10852
  * Initials Field uses `TemplateResponseDocumentStaticFieldInitials`
10833
10853
  type: string
10834
10854
  default: date_signed
10855
+ type: object
10835
10856
  TemplateResponseDocumentStaticFieldDropdown:
10836
10857
  description: 'This class extends `TemplateResponseDocumentStaticFieldBase`'
10837
10858
  required:
10838
10859
  - type
10839
- type: object
10840
10860
  allOf:
10841
10861
  -
10842
10862
  $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase'
10843
10863
  -
10864
+ required:
10865
+ - type
10844
10866
  properties:
10845
10867
  type:
10846
10868
  description: |-
@@ -10856,15 +10878,17 @@ components:
10856
10878
  * Initials Field uses `TemplateResponseDocumentStaticFieldInitials`
10857
10879
  type: string
10858
10880
  default: dropdown
10881
+ type: object
10859
10882
  TemplateResponseDocumentStaticFieldHyperlink:
10860
10883
  description: 'This class extends `TemplateResponseDocumentStaticFieldBase`'
10861
10884
  required:
10862
10885
  - type
10863
- type: object
10864
10886
  allOf:
10865
10887
  -
10866
10888
  $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase'
10867
10889
  -
10890
+ required:
10891
+ - type
10868
10892
  properties:
10869
10893
  type:
10870
10894
  description: |-
@@ -10880,15 +10904,17 @@ components:
10880
10904
  * Initials Field uses `TemplateResponseDocumentStaticFieldInitials`
10881
10905
  type: string
10882
10906
  default: hyperlink
10907
+ type: object
10883
10908
  TemplateResponseDocumentStaticFieldInitials:
10884
10909
  description: 'This class extends `TemplateResponseDocumentStaticFieldBase`'
10885
10910
  required:
10886
10911
  - type
10887
- type: object
10888
10912
  allOf:
10889
10913
  -
10890
10914
  $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase'
10891
10915
  -
10916
+ required:
10917
+ - type
10892
10918
  properties:
10893
10919
  type:
10894
10920
  description: |-
@@ -10904,15 +10930,17 @@ components:
10904
10930
  * Initials Field uses `TemplateResponseDocumentStaticFieldInitials`
10905
10931
  type: string
10906
10932
  default: initials
10933
+ type: object
10907
10934
  TemplateResponseDocumentStaticFieldRadio:
10908
10935
  description: 'This class extends `TemplateResponseDocumentStaticFieldBase`'
10909
10936
  required:
10910
10937
  - type
10911
- type: object
10912
10938
  allOf:
10913
10939
  -
10914
10940
  $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase'
10915
10941
  -
10942
+ required:
10943
+ - type
10916
10944
  properties:
10917
10945
  type:
10918
10946
  description: |-
@@ -10928,15 +10956,17 @@ components:
10928
10956
  * Initials Field uses `TemplateResponseDocumentStaticFieldInitials`
10929
10957
  type: string
10930
10958
  default: radio
10959
+ type: object
10931
10960
  TemplateResponseDocumentStaticFieldSignature:
10932
10961
  description: 'This class extends `TemplateResponseDocumentStaticFieldBase`'
10933
10962
  required:
10934
10963
  - type
10935
- type: object
10936
10964
  allOf:
10937
10965
  -
10938
10966
  $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase'
10939
10967
  -
10968
+ required:
10969
+ - type
10940
10970
  properties:
10941
10971
  type:
10942
10972
  description: |-
@@ -10952,15 +10982,17 @@ components:
10952
10982
  * Initials Field uses `TemplateResponseDocumentStaticFieldInitials`
10953
10983
  type: string
10954
10984
  default: signature
10985
+ type: object
10955
10986
  TemplateResponseDocumentStaticFieldText:
10956
10987
  description: 'This class extends `TemplateResponseDocumentStaticFieldBase`'
10957
10988
  required:
10958
10989
  - type
10959
- type: object
10960
10990
  allOf:
10961
10991
  -
10962
10992
  $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase'
10963
10993
  -
10994
+ required:
10995
+ - type
10964
10996
  properties:
10965
10997
  type:
10966
10998
  description: |-
@@ -10976,6 +11008,7 @@ components:
10976
11008
  * Initials Field uses `TemplateResponseDocumentStaticFieldInitials`
10977
11009
  type: string
10978
11010
  default: text
11011
+ type: object
10979
11012
  TemplateResponseFieldAvgTextLength:
10980
11013
  description: 'Average text length in this field.'
10981
11014
  properties:
@@ -11208,7 +11241,6 @@ components:
11208
11241
  - event_time
11209
11242
  - event_type
11210
11243
  - event_hash
11211
- - event_metadata
11212
11244
  properties:
11213
11245
  event_time:
11214
11246
  description: 'Time the event was created (using Unix time).'
@@ -11239,6 +11271,7 @@ components:
11239
11271
  - template_created
11240
11272
  - template_error
11241
11273
  - callback_test
11274
+ - signature_request_signer_removed
11242
11275
  event_hash:
11243
11276
  description: 'Generated hash used to verify source of event data.'
11244
11277
  type: string