dropbox-sign 1.1.2 → 1.3.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (56) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +3 -3
  3. data/README.md +9 -4
  4. data/VERSION +1 -1
  5. data/docs/OAuthApi.md +0 -16
  6. data/docs/SignatureRequestApi.md +5 -4
  7. data/docs/SignatureRequestSendRequest.md +1 -0
  8. data/docs/SignatureRequestSendWithTemplateRequest.md +1 -0
  9. data/docs/SignatureRequestUpdateRequest.md +1 -1
  10. data/docs/SubFormFieldsPerDocumentBase.md +1 -1
  11. data/docs/SubFormFieldsPerDocumentDateSigned.md +2 -0
  12. data/docs/SubFormFieldsPerDocumentDropdown.md +2 -0
  13. data/docs/SubFormFieldsPerDocumentFontEnum.md +9 -0
  14. data/docs/SubFormFieldsPerDocumentHyperlink.md +2 -0
  15. data/docs/SubFormFieldsPerDocumentText.md +3 -0
  16. data/docs/SubFormFieldsPerDocumentTextMerge.md +2 -0
  17. data/docs/SubWhiteLabelingOptions.md +1 -1
  18. data/docs/TemplateApi.md +106 -3
  19. data/docs/TemplateCreateRequest.md +27 -0
  20. data/docs/TemplateCreateResponse.md +11 -0
  21. data/docs/TemplateCreateResponseTemplate.md +10 -0
  22. data/docs/UnclaimedDraftCreateEmbeddedWithTemplateRequest.md +1 -0
  23. data/examples/OauthTokenGenerate.rb +0 -8
  24. data/examples/OauthTokenRefresh.rb +0 -8
  25. data/examples/TemplateCreate.rb +49 -0
  26. data/lib/dropbox-sign/api/signature_request_api.rb +5 -2
  27. data/lib/dropbox-sign/api/template_api.rb +112 -0
  28. data/lib/dropbox-sign/models/signature_request_send_request.rb +14 -1
  29. data/lib/dropbox-sign/models/signature_request_send_with_template_request.rb +14 -1
  30. data/lib/dropbox-sign/models/signature_request_update_request.rb +1 -1
  31. data/lib/dropbox-sign/models/sub_form_fields_per_document_base.rb +1 -1
  32. data/lib/dropbox-sign/models/sub_form_fields_per_document_date_signed.rb +60 -4
  33. data/lib/dropbox-sign/models/sub_form_fields_per_document_dropdown.rb +60 -4
  34. data/lib/dropbox-sign/models/sub_form_fields_per_document_font_enum.rb +54 -0
  35. data/lib/dropbox-sign/models/sub_form_fields_per_document_hyperlink.rb +60 -4
  36. data/lib/dropbox-sign/models/sub_form_fields_per_document_text.rb +49 -4
  37. data/lib/dropbox-sign/models/sub_form_fields_per_document_text_merge.rb +60 -4
  38. data/lib/dropbox-sign/models/sub_white_labeling_options.rb +1 -1
  39. data/lib/dropbox-sign/models/template_create_request.rb +509 -0
  40. data/lib/dropbox-sign/models/template_create_response.rb +263 -0
  41. data/lib/dropbox-sign/models/template_create_response_template.rb +252 -0
  42. data/lib/dropbox-sign/models/unclaimed_draft_create_embedded_with_template_request.rb +17 -4
  43. data/lib/dropbox-sign/version.rb +1 -1
  44. data/lib/dropbox-sign.rb +4 -0
  45. data/openapi-config.yaml +1 -1
  46. data/openapi-sdk.yaml +912 -434
  47. data/test_fixtures/SignatureRequestCreateEmbeddedRequest.json +6 -2
  48. data/test_fixtures/SignatureRequestSendRequest.json +8 -2
  49. data/test_fixtures/SignatureRequestSendWithTemplateRequest.json +1 -0
  50. data/test_fixtures/TemplateCreateEmbeddedDraftRequest.json +3 -1
  51. data/test_fixtures/TemplateCreateRequest.json +120 -0
  52. data/test_fixtures/TemplateCreateResponse.json +7 -0
  53. data/test_fixtures/UnclaimedDraftCreateEmbeddedRequest.json +3 -1
  54. data/test_fixtures/UnclaimedDraftCreateEmbeddedWithTemplateRequest.json +2 -1
  55. data/test_fixtures/UnclaimedDraftCreateRequest.json +3 -1
  56. metadata +20 -9
data/openapi-sdk.yaml CHANGED
@@ -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'
@@ -3364,6 +3371,8 @@ 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
 
3374
+ Updating the email address of a signer will generate a new `signature_id` value.
3375
+
3367
3376
  **NOTE**: This action cannot be performed on a signature request with an appended signature page.
3368
3377
  operationId: signatureRequestUpdate
3369
3378
  parameters:
@@ -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'
@@ -6279,300 +6409,80 @@ components:
6279
6409
  type: boolean
6280
6410
  default: false
6281
6411
  type: object
6282
- SubFormFieldsPerDocumentTypeEnum:
6283
- type: string
6284
- enum:
6285
- - checkbox
6286
- - checkbox-merge
6287
- - date_signed
6288
- - dropdown
6289
- - hyperlink
6290
- - initials
6291
- - signature
6292
- - radio
6293
- - text
6294
- - text-merge
6295
- SubFormFieldsPerDocumentText:
6296
- description: 'This class extends `SubFormFieldsPerDocumentBase`.'
6297
- allOf:
6298
- -
6299
- $ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
6300
- -
6301
- required:
6302
- - type
6303
- - options
6304
- properties:
6305
- type:
6306
- description: 'A text input field. Use the `SubFormFieldsPerDocumentText` class.'
6307
- type: string
6308
- default: text
6309
- placeholder:
6310
- description: 'Placeholder value for text field.'
6311
- type: string
6312
- auto_fill_type:
6313
- description: 'Auto fill type for populating fields automatically. Check out the list of [auto fill types](/api/reference/constants/#auto-fill-types) to learn more about the possible values.'
6314
- type: string
6315
- link_id:
6316
- description: 'Link two or more text fields. Enter data into one linked text field, which automatically fill all other linked text fields.'
6317
- type: string
6318
- masked:
6319
- description: 'Masks entered data. For more information see [Masking sensitive information](https://faq.hellosign.com/hc/en-us/articles/360040742811-Masking-sensitive-information). `true` for masking the data in a text field, otherwise `false`.'
6320
- type: boolean
6321
- validation_type:
6322
- description: |-
6323
- Each text field may contain a `validation_type` parameter. Check out the list of [validation types](https://faq.hellosign.com/hc/en-us/articles/217115577) to learn more about the possible values.
6324
-
6325
- **NOTE**: When using `custom_regex` you are required to pass a second parameter `validation_custom_regex` and you can optionally provide `validation_custom_regex_format_label` for the error message the user will see in case of an invalid value.
6326
- type: string
6327
- enum:
6328
- - numbers_only
6329
- - letters_only
6330
- - phone_number
6331
- - bank_routing_number
6332
- - bank_account_number
6333
- - email_address
6334
- - zip_code
6335
- - social_security_number
6336
- - employer_identification_number
6337
- - custom_regex
6338
- validation_custom_regex:
6339
- type: string
6340
- validation_custom_regex_format_label:
6341
- type: string
6342
- type: object
6343
- SubFormFieldsPerDocumentDropdown:
6344
- description: 'This class extends `SubFormFieldsPerDocumentBase`.'
6345
- allOf:
6346
- -
6347
- $ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
6348
- -
6349
- required:
6350
- - type
6351
- - options
6352
- properties:
6353
- type:
6354
- description: 'An input field for dropdowns. Use the `SubFormFieldsPerDocumentDropdown` class.'
6355
- type: string
6356
- default: dropdown
6357
- options:
6358
- description: 'Array of string values representing dropdown values.'
6359
- type: array
6360
- items:
6361
- type: string
6362
- minItems: 1
6363
- content:
6364
- description: 'Selected value in `options` array. Value must exist in array.'
6365
- type: string
6366
- type: object
6367
- SubFormFieldsPerDocumentHyperlink:
6368
- description: 'This class extends `SubFormFieldsPerDocumentBase`.'
6369
- allOf:
6370
- -
6371
- $ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
6372
- -
6373
- required:
6374
- - type
6375
- - content
6376
- - content_url
6377
- properties:
6378
- type:
6379
- description: 'A hyperlink field. Use the `SubFormFieldsPerDocumentHyperlink` class.'
6380
- type: string
6381
- default: hyperlink
6382
- content:
6383
- description: 'Link Text.'
6384
- type: string
6385
- content_url:
6386
- description: 'Link URL.'
6387
- type: string
6388
- type: object
6389
- SubFormFieldsPerDocumentCheckbox:
6390
- description: 'This class extends `SubFormFieldsPerDocumentBase`.'
6391
- allOf:
6392
- -
6393
- $ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
6394
- -
6395
- required:
6396
- - type
6397
- - is_checked
6398
- properties:
6399
- type:
6400
- description: 'A yes/no checkbox. Use the `SubFormFieldsPerDocumentCheckbox` class.'
6401
- type: string
6402
- default: checkbox
6403
- group:
6404
- description: 'String referencing group defined in `form_field_groups` parameter.'
6405
- type: string
6406
- is_checked:
6407
- description: '`true` for checking the checkbox field by default, otherwise `false`.'
6408
- type: boolean
6409
- type: object
6410
- SubFormFieldsPerDocumentRadio:
6411
- description: 'This class extends `SubFormFieldsPerDocumentBase`.'
6412
- allOf:
6413
- -
6414
- $ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
6415
- -
6416
- required:
6417
- - type
6418
- - group
6419
- - is_checked
6420
- properties:
6421
- type:
6422
- description: 'An input field for radios. Use the `SubFormFieldsPerDocumentRadio` class.'
6423
- type: string
6424
- default: radio
6425
- group:
6426
- description: 'String referencing group defined in `form_field_groups` parameter.'
6427
- type: string
6428
- is_checked:
6429
- description: '`true` for checking the radio field by default, otherwise `false`. Only one radio field per group can be `true`.'
6430
- type: boolean
6431
- type: object
6432
- SubFormFieldsPerDocumentSignature:
6433
- description: 'This class extends `SubFormFieldsPerDocumentBase`.'
6434
- allOf:
6435
- -
6436
- $ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
6437
- -
6438
- required:
6439
- - type
6440
- properties:
6441
- type:
6442
- description: 'A signature input field. Use the `SubFormFieldsPerDocumentSignature` class.'
6443
- type: string
6444
- default: signature
6445
- type: object
6446
- SubFormFieldsPerDocumentDateSigned:
6447
- description: 'This class extends `SubFormFieldsPerDocumentBase`.'
6448
- allOf:
6449
- -
6450
- $ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
6451
- -
6452
- required:
6453
- - type
6454
- properties:
6455
- type:
6456
- description: 'A date. Use the `SubFormFieldsPerDocumentDateSigned` class.'
6457
- type: string
6458
- default: date_signed
6459
- type: object
6460
- SubFormFieldsPerDocumentInitials:
6461
- description: 'This class extends `SubFormFieldsPerDocumentBase`.'
6462
- allOf:
6463
- -
6464
- $ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
6465
- -
6466
- required:
6467
- - type
6468
- properties:
6469
- type:
6470
- description: 'An input field for initials. Use the `SubFormFieldsPerDocumentInitials` class.'
6471
- type: string
6472
- default: initials
6473
- type: object
6474
- SubFormFieldsPerDocumentTextMerge:
6475
- description: 'This class extends `SubFormFieldsPerDocumentBase`.'
6476
- allOf:
6477
- -
6478
- $ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
6479
- -
6480
- required:
6481
- - type
6482
- properties:
6483
- type:
6484
- description: 'A text field that has default text set using pre-filled data. Use the `SubFormFieldsPerDocumentTextMerge` class.'
6485
- type: string
6486
- default: text-merge
6487
- type: object
6488
- SubFormFieldsPerDocumentCheckboxMerge:
6489
- description: 'This class extends `SubFormFieldsPerDocumentBase`.'
6490
- allOf:
6491
- -
6492
- $ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
6493
- -
6494
- required:
6495
- - type
6496
- properties:
6497
- type:
6498
- description: 'A checkbox field that has default value set using pre-filled data. Use the `SubFormFieldsPerDocumentCheckboxMerge` class.'
6499
- type: string
6500
- default: checkbox-merge
6501
- type: object
6502
- 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
@@ -6886,7 +6796,6 @@ components:
6886
6796
  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
6797
  type: integer
6888
6798
  nullable: true
6889
- x-beta: closed
6890
6799
  type: object
6891
6800
  SignatureRequestCreateEmbeddedWithTemplateRequest:
6892
6801
  required:
@@ -7101,6 +7010,16 @@ components:
7101
7010
  Cannot be used in `test_mode`. Only works on requests with one signer.
7102
7011
  type: boolean
7103
7012
  default: false
7013
+ deprecated: true
7014
+ x-hideOn: doc
7015
+ is_eid:
7016
+ description: |-
7017
+ Send with a value of `true` if you wish to enable
7018
+ [electronic identification (eID)](https://www.hellosign.com/features/electronic-id),
7019
+ 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.
7021
+ type: boolean
7022
+ default: false
7104
7023
  message:
7105
7024
  description: 'The custom message in the email that will be sent to the signers.'
7106
7025
  type: string
@@ -7138,7 +7057,6 @@ components:
7138
7057
  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
7058
  type: integer
7140
7059
  nullable: true
7141
- x-beta: closed
7142
7060
  type: object
7143
7061
  SignatureRequestSendWithTemplateRequest:
7144
7062
  description: ''
@@ -7194,6 +7112,16 @@ components:
7194
7112
  Cannot be used in `test_mode`. Only works on requests with one signer.
7195
7113
  type: boolean
7196
7114
  default: false
7115
+ deprecated: true
7116
+ x-hideOn: doc
7117
+ is_eid:
7118
+ description: |-
7119
+ Send with a value of `true` if you wish to enable
7120
+ [electronic identification (eID)](https://www.hellosign.com/features/electronic-id),
7121
+ 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.
7123
+ type: boolean
7124
+ default: false
7197
7125
  message:
7198
7126
  description: 'The custom message in the email that will be sent to the signers.'
7199
7127
  type: string
@@ -7237,6 +7165,8 @@ components:
7237
7165
  description: |-
7238
7166
  The new email address for the recipient.
7239
7167
 
7168
+ This will generate a new `signature_id` value.
7169
+
7240
7170
  **NOTE**: Optional if `name` is provided.
7241
7171
  type: string
7242
7172
  format: email
@@ -7253,7 +7183,6 @@ components:
7253
7183
  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
7184
  type: integer
7255
7185
  nullable: true
7256
- x-beta: closed
7257
7186
  type: object
7258
7187
  SubAttachment:
7259
7188
  required:
@@ -7524,36 +7453,428 @@ components:
7524
7453
  items:
7525
7454
  type: string
7526
7455
  type: object
7527
- SubFormFieldsPerDocumentBase:
7528
- description: |-
7529
- 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
-
7531
- **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
-
7533
- * Text Field use `SubFormFieldsPerDocumentText`
7534
- * Dropdown Field use `SubFormFieldsPerDocumentDropdown`
7535
- * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`
7536
- * Checkbox Field use `SubFormFieldsPerDocumentCheckbox`
7537
- * Radio Field use `SubFormFieldsPerDocumentRadio`
7538
- * Signature Field use `SubFormFieldsPerDocumentSignature`
7539
- * Date Signed Field use `SubFormFieldsPerDocumentDateSigned`
7540
- * Initials Field use `SubFormFieldsPerDocumentInitials`
7541
- * Text Merge Field use `SubFormFieldsPerDocumentTextMerge`
7542
- * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge`
7543
- required:
7544
- - document_index
7545
- - api_id
7546
- - type
7547
- - required
7548
- - signer
7549
- - width
7550
- - height
7551
- - x
7552
- - 'y'
7553
- properties:
7554
- document_index:
7555
- description: 'Represents the integer index of the `file` or `file_url` document the field should be attached to.'
7556
- type: integer
7456
+ SubFormFieldsPerDocumentCheckbox:
7457
+ description: 'This class extends `SubFormFieldsPerDocumentBase`.'
7458
+ allOf:
7459
+ -
7460
+ $ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
7461
+ -
7462
+ required:
7463
+ - type
7464
+ - is_checked
7465
+ properties:
7466
+ type:
7467
+ description: 'A yes/no checkbox. Use the `SubFormFieldsPerDocumentCheckbox` class.'
7468
+ type: string
7469
+ default: checkbox
7470
+ group:
7471
+ description: 'String referencing group defined in `form_field_groups` parameter.'
7472
+ type: string
7473
+ is_checked:
7474
+ description: '`true` for checking the checkbox field by default, otherwise `false`.'
7475
+ type: boolean
7476
+ type: object
7477
+ -
7478
+ $ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
7479
+ SubFormFieldsPerDocumentCheckboxMerge:
7480
+ description: 'This class extends `SubFormFieldsPerDocumentBase`.'
7481
+ allOf:
7482
+ -
7483
+ $ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
7484
+ -
7485
+ required:
7486
+ - type
7487
+ properties:
7488
+ type:
7489
+ description: 'A checkbox field that has default value set using pre-filled data. Use the `SubFormFieldsPerDocumentCheckboxMerge` class.'
7490
+ type: string
7491
+ default: checkbox-merge
7492
+ type: object
7493
+ -
7494
+ $ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
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
+ type: object
7535
+ -
7536
+ $ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
7537
+ SubFormFieldsPerDocumentDropdown:
7538
+ description: 'This class extends `SubFormFieldsPerDocumentBase`.'
7539
+ allOf:
7540
+ -
7541
+ $ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
7542
+ -
7543
+ required:
7544
+ - type
7545
+ - options
7546
+ properties:
7547
+ type:
7548
+ description: 'An input field for dropdowns. Use the `SubFormFieldsPerDocumentDropdown` class.'
7549
+ type: string
7550
+ default: dropdown
7551
+ options:
7552
+ description: 'Array of string values representing dropdown values.'
7553
+ type: array
7554
+ items:
7555
+ type: string
7556
+ minItems: 1
7557
+ content:
7558
+ description: 'Selected value in `options` array. Value must exist in array.'
7559
+ type: string
7560
+ font_family:
7561
+ description: 'Font family for the field.'
7562
+ type: string
7563
+ enum:
7564
+ - helvetica
7565
+ - arial
7566
+ - courier
7567
+ - calibri
7568
+ - cambria
7569
+ - georgia
7570
+ - times
7571
+ - trebuchet
7572
+ - verdana
7573
+ - roboto
7574
+ - robotoMono
7575
+ - notoSans
7576
+ - notoSerif
7577
+ - notoCJK-JP-Regular
7578
+ - notoHebrew-Regular
7579
+ - notoSanThaiMerged
7580
+ font_size:
7581
+ description: |-
7582
+ The initial px font size for the field contents. Can be any integer value between `7` and `49`.
7583
+
7584
+ **NOTE**: Font size may be reduced during processing in order to fit the contents within the dimensions of the field.
7585
+ type: integer
7586
+ type: object
7587
+ -
7588
+ $ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
7589
+ SubFormFieldsPerDocumentHyperlink:
7590
+ description: 'This class extends `SubFormFieldsPerDocumentBase`.'
7591
+ allOf:
7592
+ -
7593
+ $ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
7594
+ -
7595
+ required:
7596
+ - type
7597
+ - content
7598
+ - content_url
7599
+ properties:
7600
+ type:
7601
+ description: 'A hyperlink field. Use the `SubFormFieldsPerDocumentHyperlink` class.'
7602
+ type: string
7603
+ default: hyperlink
7604
+ content:
7605
+ description: 'Link Text.'
7606
+ type: string
7607
+ content_url:
7608
+ description: 'Link URL.'
7609
+ type: string
7610
+ font_family:
7611
+ description: 'Font family for the field.'
7612
+ type: string
7613
+ enum:
7614
+ - helvetica
7615
+ - arial
7616
+ - courier
7617
+ - calibri
7618
+ - cambria
7619
+ - georgia
7620
+ - times
7621
+ - trebuchet
7622
+ - verdana
7623
+ - roboto
7624
+ - robotoMono
7625
+ - notoSans
7626
+ - notoSerif
7627
+ - notoCJK-JP-Regular
7628
+ - notoHebrew-Regular
7629
+ - notoSanThaiMerged
7630
+ font_size:
7631
+ description: |-
7632
+ The initial px font size for the field contents. Can be any integer value between `7` and `49`.
7633
+
7634
+ **NOTE**: Font size may be reduced during processing in order to fit the contents within the dimensions of the field.
7635
+ type: integer
7636
+ type: object
7637
+ -
7638
+ $ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
7639
+ SubFormFieldsPerDocumentInitials:
7640
+ description: 'This class extends `SubFormFieldsPerDocumentBase`.'
7641
+ allOf:
7642
+ -
7643
+ $ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
7644
+ -
7645
+ required:
7646
+ - type
7647
+ properties:
7648
+ type:
7649
+ description: 'An input field for initials. Use the `SubFormFieldsPerDocumentInitials` class.'
7650
+ type: string
7651
+ default: initials
7652
+ type: object
7653
+ -
7654
+ $ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
7655
+ SubFormFieldsPerDocumentRadio:
7656
+ description: 'This class extends `SubFormFieldsPerDocumentBase`.'
7657
+ allOf:
7658
+ -
7659
+ $ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
7660
+ -
7661
+ required:
7662
+ - type
7663
+ - group
7664
+ - is_checked
7665
+ properties:
7666
+ type:
7667
+ description: 'An input field for radios. Use the `SubFormFieldsPerDocumentRadio` class.'
7668
+ type: string
7669
+ default: radio
7670
+ group:
7671
+ description: 'String referencing group defined in `form_field_groups` parameter.'
7672
+ type: string
7673
+ is_checked:
7674
+ description: '`true` for checking the radio field by default, otherwise `false`. Only one radio field per group can be `true`.'
7675
+ type: boolean
7676
+ type: object
7677
+ -
7678
+ $ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
7679
+ SubFormFieldsPerDocumentSignature:
7680
+ description: 'This class extends `SubFormFieldsPerDocumentBase`.'
7681
+ allOf:
7682
+ -
7683
+ $ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
7684
+ -
7685
+ required:
7686
+ - type
7687
+ properties:
7688
+ type:
7689
+ description: 'A signature input field. Use the `SubFormFieldsPerDocumentSignature` class.'
7690
+ type: string
7691
+ default: signature
7692
+ type: object
7693
+ -
7694
+ $ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
7695
+ SubFormFieldsPerDocumentText:
7696
+ description: 'This class extends `SubFormFieldsPerDocumentBase`.'
7697
+ allOf:
7698
+ -
7699
+ $ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
7700
+ -
7701
+ required:
7702
+ - type
7703
+ - options
7704
+ properties:
7705
+ type:
7706
+ description: 'A text input field. Use the `SubFormFieldsPerDocumentText` class.'
7707
+ type: string
7708
+ default: text
7709
+ placeholder:
7710
+ description: 'Placeholder value for text field.'
7711
+ type: string
7712
+ auto_fill_type:
7713
+ 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.'
7714
+ type: string
7715
+ link_id:
7716
+ description: 'Link two or more text fields. Enter data into one linked text field, which automatically fill all other linked text fields.'
7717
+ type: string
7718
+ masked:
7719
+ 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`.'
7720
+ type: boolean
7721
+ validation_type:
7722
+ description: |-
7723
+ 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
+
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.
7726
+ type: string
7727
+ enum:
7728
+ - numbers_only
7729
+ - letters_only
7730
+ - phone_number
7731
+ - bank_routing_number
7732
+ - bank_account_number
7733
+ - email_address
7734
+ - zip_code
7735
+ - social_security_number
7736
+ - employer_identification_number
7737
+ - custom_regex
7738
+ validation_custom_regex:
7739
+ type: string
7740
+ validation_custom_regex_format_label:
7741
+ type: string
7742
+ content:
7743
+ description: 'Content of a `me_now` text field'
7744
+ type: string
7745
+ font_family:
7746
+ description: 'Font family for the field.'
7747
+ type: string
7748
+ enum:
7749
+ - helvetica
7750
+ - arial
7751
+ - courier
7752
+ - calibri
7753
+ - cambria
7754
+ - georgia
7755
+ - times
7756
+ - trebuchet
7757
+ - verdana
7758
+ - roboto
7759
+ - robotoMono
7760
+ - notoSans
7761
+ - notoSerif
7762
+ - notoCJK-JP-Regular
7763
+ - notoHebrew-Regular
7764
+ - notoSanThaiMerged
7765
+ font_size:
7766
+ description: |-
7767
+ The initial px font size for the field contents. Can be any integer value between `7` and `49`.
7768
+
7769
+ **NOTE**: Font size may be reduced during processing in order to fit the contents within the dimensions of the field.
7770
+ type: integer
7771
+ type: object
7772
+ -
7773
+ $ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
7774
+ SubFormFieldsPerDocumentTextMerge:
7775
+ description: 'This class extends `SubFormFieldsPerDocumentBase`.'
7776
+ allOf:
7777
+ -
7778
+ $ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
7779
+ -
7780
+ required:
7781
+ - type
7782
+ properties:
7783
+ type:
7784
+ description: 'A text field that has default text set using pre-filled data. Use the `SubFormFieldsPerDocumentTextMerge` class.'
7785
+ type: string
7786
+ default: text-merge
7787
+ font_family:
7788
+ description: 'Font family for the field.'
7789
+ type: string
7790
+ enum:
7791
+ - helvetica
7792
+ - arial
7793
+ - courier
7794
+ - calibri
7795
+ - cambria
7796
+ - georgia
7797
+ - times
7798
+ - trebuchet
7799
+ - verdana
7800
+ - roboto
7801
+ - robotoMono
7802
+ - notoSans
7803
+ - notoSerif
7804
+ - notoCJK-JP-Regular
7805
+ - notoHebrew-Regular
7806
+ - notoSanThaiMerged
7807
+ font_size:
7808
+ description: |-
7809
+ The initial px font size for the field contents. Can be any integer value between `7` and `49`.
7810
+
7811
+ **NOTE**: Font size may be reduced during processing in order to fit the contents within the dimensions of the field.
7812
+ type: integer
7813
+ type: object
7814
+ -
7815
+ $ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
7816
+ SubFormFieldsPerDocumentTypeEnum:
7817
+ type: string
7818
+ enum:
7819
+ - checkbox
7820
+ - checkbox-merge
7821
+ - date_signed
7822
+ - dropdown
7823
+ - hyperlink
7824
+ - initials
7825
+ - signature
7826
+ - radio
7827
+ - text
7828
+ - text-merge
7829
+ SubFormFieldsPerDocumentFontEnum:
7830
+ type: string
7831
+ enum:
7832
+ - helvetica
7833
+ - arial
7834
+ - courier
7835
+ - calibri
7836
+ - cambria
7837
+ - georgia
7838
+ - times
7839
+ - trebuchet
7840
+ - verdana
7841
+ - roboto
7842
+ - robotoMono
7843
+ - notoSans
7844
+ - notoSerif
7845
+ - notoCJK-JP-Regular
7846
+ - notoHebrew-Regular
7847
+ - notoSanThaiMerged
7848
+ SubFormFieldsPerDocumentBase:
7849
+ description: |-
7850
+ 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
+
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.
7853
+
7854
+ * Text Field use `SubFormFieldsPerDocumentText`
7855
+ * Dropdown Field use `SubFormFieldsPerDocumentDropdown`
7856
+ * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`
7857
+ * Checkbox Field use `SubFormFieldsPerDocumentCheckbox`
7858
+ * Radio Field use `SubFormFieldsPerDocumentRadio`
7859
+ * Signature Field use `SubFormFieldsPerDocumentSignature`
7860
+ * Date Signed Field use `SubFormFieldsPerDocumentDateSigned`
7861
+ * Initials Field use `SubFormFieldsPerDocumentInitials`
7862
+ * Text Merge Field use `SubFormFieldsPerDocumentTextMerge`
7863
+ * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge`
7864
+ required:
7865
+ - document_index
7866
+ - api_id
7867
+ - type
7868
+ - required
7869
+ - signer
7870
+ - width
7871
+ - height
7872
+ - x
7873
+ - 'y'
7874
+ properties:
7875
+ document_index:
7876
+ description: 'Represents the integer index of the `file` or `file_url` document the field should be attached to.'
7877
+ type: integer
7557
7878
  api_id:
7558
7879
  description: 'An identifier for the field that is unique across all documents in the request.'
7559
7880
  type: string
@@ -7578,6 +7899,8 @@ components:
7578
7899
  description: |-
7579
7900
  Signer index identified by the offset in the signers parameter (0-based indexing), indicating which signer should fill out the field.
7580
7901
 
7902
+ **NOTE**: To set the value of the field as the preparer you must set this to `me_now`
7903
+
7581
7904
  **NOTE**: If type is `text-merge` or `checkbox-merge`, you must set this to sender in order to use pre-filled data.
7582
7905
  type: string
7583
7906
  x-int-or-string: true
@@ -7835,7 +8158,7 @@ components:
7835
8158
  description: |-
7836
8159
  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
8160
 
7838
- Take a look at our [white labeling guide](/api/reference/white-labeling/) to learn more.
8161
+ Take a look at our [white labeling guide](https://developers.hellosign.com/api/reference/premium-branding/) to learn more.
7839
8162
  properties:
7840
8163
  header_background_color:
7841
8164
  type: string
@@ -7970,14 +8293,127 @@ components:
7970
8293
  The id of the Account to give access to the Template.
7971
8294
  <b>Note</b> The account id prevails if email address is also provided.
7972
8295
  type: string
7973
- email_address:
8296
+ email_address:
8297
+ description: |-
8298
+ 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.
8300
+ type: string
8301
+ format: email
8302
+ skip_notification:
8303
+ description: 'If set to `true`, the user does not receive an email notification when a template has been shared with them. Defaults to `false`.'
8304
+ type: boolean
8305
+ default: false
8306
+ type: object
8307
+ TemplateCreateRequest:
8308
+ required:
8309
+ - signer_roles
8310
+ - form_fields_per_document
8311
+ properties:
8312
+ files:
8313
+ description: |-
8314
+ Use `files[]` to indicate the uploaded file(s) to send for signature.
8315
+
8316
+ This endpoint requires either **files** or **file_urls[]**, but not both.
8317
+ type: array
8318
+ items:
8319
+ type: string
8320
+ format: binary
8321
+ file_urls:
8322
+ description: |-
8323
+ Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.
8324
+
8325
+ This endpoint requires either **files** or **file_urls[]**, but not both.
8326
+ type: array
8327
+ items:
8328
+ type: string
8329
+ allow_reassign:
8330
+ description: |-
8331
+ Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.
8332
+
8333
+ **Note**: Only available for Premium plan and higher.
8334
+ type: boolean
8335
+ default: false
8336
+ attachments:
8337
+ description: 'A list describing the attachments'
8338
+ type: array
8339
+ items:
8340
+ $ref: '#/components/schemas/SubAttachment'
8341
+ cc_roles:
8342
+ description: 'The CC roles that must be assigned when using the template to send a signature request'
8343
+ type: array
8344
+ items:
8345
+ type: string
8346
+ client_id:
8347
+ 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.'
8348
+ type: string
8349
+ field_options:
8350
+ $ref: '#/components/schemas/SubFieldOptions'
8351
+ form_field_groups:
8352
+ 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`.'
8353
+ type: array
8354
+ items:
8355
+ $ref: '#/components/schemas/SubFormFieldGroup'
8356
+ form_field_rules:
8357
+ description: 'Conditional Logic rules for fields defined in `form_fields_per_document`.'
8358
+ type: array
8359
+ items:
8360
+ $ref: '#/components/schemas/SubFormFieldRule'
8361
+ form_fields_per_document:
8362
+ description: |-
8363
+ 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
+
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.
8366
+
8367
+ * Text Field use `SubFormFieldsPerDocumentText`
8368
+ * Dropdown Field use `SubFormFieldsPerDocumentDropdown`
8369
+ * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`
8370
+ * Checkbox Field use `SubFormFieldsPerDocumentCheckbox`
8371
+ * Radio Field use `SubFormFieldsPerDocumentRadio`
8372
+ * Signature Field use `SubFormFieldsPerDocumentSignature`
8373
+ * Date Signed Field use `SubFormFieldsPerDocumentDateSigned`
8374
+ * Initials Field use `SubFormFieldsPerDocumentInitials`
8375
+ * Text Merge Field use `SubFormFieldsPerDocumentTextMerge`
8376
+ * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge`
8377
+ type: array
8378
+ items:
8379
+ $ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
8380
+ merge_fields:
8381
+ description: |-
8382
+ 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.
8383
+ If the signature request using that template *does not* pass a value into a merge field, then an empty field remains in the document.
8384
+ type: array
8385
+ items:
8386
+ $ref: '#/components/schemas/SubMergeField'
8387
+ message:
8388
+ description: 'The default template email message.'
8389
+ type: string
8390
+ maxLength: 5000
8391
+ metadata:
7974
8392
  description: |-
7975
- The email address of the Account to give access to the Template.
7976
- <b>Note</b> The account id prevails if it is also provided.
8393
+ 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.
8394
+
8395
+ 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.
8396
+ type: object
8397
+ maxItems: 10
8398
+ additionalProperties: {}
8399
+ signer_roles:
8400
+ description: 'An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template.'
8401
+ type: array
8402
+ items:
8403
+ $ref: '#/components/schemas/SubTemplateRole'
8404
+ subject:
8405
+ description: 'The template title (alias).'
7977
8406
  type: string
7978
- format: email
7979
- skip_notification:
7980
- description: 'If set to `true`, the user does not receive an email notification when a template has been shared with them. Defaults to `false`.'
8407
+ maxLength: 200
8408
+ test_mode:
8409
+ 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`.'
8410
+ type: boolean
8411
+ default: false
8412
+ title:
8413
+ description: 'The title you want to assign to the SignatureRequest.'
8414
+ type: string
8415
+ use_preexisting_fields:
8416
+ description: 'Enable the detection of predefined PDF fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`).'
7981
8417
  type: boolean
7982
8418
  default: false
7983
8419
  type: object
@@ -8308,7 +8744,6 @@ components:
8308
8744
  **Note**: This does not correspond to the **expires_at** returned in the response.
8309
8745
  type: integer
8310
8746
  nullable: true
8311
- x-beta: closed
8312
8747
  type: object
8313
8748
  UnclaimedDraftCreateEmbeddedRequest:
8314
8749
  description: ''
@@ -8506,7 +8941,6 @@ components:
8506
8941
  **Note**: This does not correspond to the **expires_at** returned in the response.
8507
8942
  type: integer
8508
8943
  nullable: true
8509
- x-beta: closed
8510
8944
  type: object
8511
8945
  UnclaimedDraftCreateEmbeddedWithTemplateRequest:
8512
8946
  required:
@@ -8654,6 +9088,10 @@ components:
8654
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.
8655
9089
  type: boolean
8656
9090
  default: false
9091
+ allow_ccs:
9092
+ description: 'This allows the requester to specify whether the user is allowed to provide email addresses to CC when claiming the draft.'
9093
+ type: boolean
9094
+ default: false
8657
9095
  type: object
8658
9096
  UnclaimedDraftEditAndResendRequest:
8659
9097
  required:
@@ -8822,20 +9260,6 @@ components:
8822
9260
  error:
8823
9261
  $ref: '#/components/schemas/ErrorResponseError'
8824
9262
  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
9263
  FileResponse:
8840
9264
  properties:
8841
9265
  file_url:
@@ -9152,69 +9576,6 @@ components:
9152
9576
  description: 'Name of the error.'
9153
9577
  type: string
9154
9578
  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.'
9215
- type: string
9216
- nullable: true
9217
- type: object
9218
9579
  ListInfoResponse:
9219
9580
  description: 'Contains pagination information about the data returned.'
9220
9581
  properties:
@@ -9291,7 +9652,6 @@ components:
9291
9652
  expires_at:
9292
9653
  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
9654
  type: integer
9294
- x-beta: closed
9295
9655
  is_complete:
9296
9656
  description: 'Whether or not the SignatureRequest has been fully executed by all signers.'
9297
9657
  type: boolean
@@ -9937,6 +10297,15 @@ components:
9937
10297
  type: array
9938
10298
  items:
9939
10299
  $ref: '#/components/schemas/WarningResponse'
10300
+ deprecated: true
10301
+ type: object
10302
+ x-internal: true
10303
+ TemplateCreateResponseTemplate:
10304
+ description: 'Template object with parameters: `template_id`.'
10305
+ properties:
10306
+ template_id:
10307
+ description: 'The id of the Template.'
10308
+ type: string
9940
10309
  type: object
9941
10310
  x-internal: true
9942
10311
  TemplateResponseDocument:
@@ -10639,6 +11008,7 @@ components:
10639
11008
  type: array
10640
11009
  items:
10641
11010
  $ref: '#/components/schemas/WarningResponse'
11011
+ deprecated: true
10642
11012
  type: object
10643
11013
  x-internal: true
10644
11014
  UnclaimedDraftResponse:
@@ -10746,6 +11116,17 @@ components:
10746
11116
  $ref: '#/components/schemas/WarningResponse'
10747
11117
  type: object
10748
11118
  x-internal: true
11119
+ TemplateCreateResponse:
11120
+ properties:
11121
+ template:
11122
+ $ref: '#/components/schemas/TemplateCreateResponseTemplate'
11123
+ warnings:
11124
+ description: 'A list of warnings.'
11125
+ type: array
11126
+ items:
11127
+ $ref: '#/components/schemas/WarningResponse'
11128
+ type: object
11129
+ x-internal: true
10749
11130
  TemplateCreateEmbeddedDraftResponse:
10750
11131
  properties:
10751
11132
  template:
@@ -10807,6 +11188,83 @@ components:
10807
11188
  $ref: '#/components/schemas/WarningResponse'
10808
11189
  type: object
10809
11190
  x-internal: true
11191
+ EventCallbackRequest:
11192
+ title: EventCallbackRequest
11193
+ required:
11194
+ - event
11195
+ properties:
11196
+ event:
11197
+ $ref: '#/components/schemas/EventCallbackRequestEvent'
11198
+ account:
11199
+ $ref: '#/components/schemas/AccountResponse'
11200
+ signature_request:
11201
+ $ref: '#/components/schemas/SignatureRequestResponse'
11202
+ template:
11203
+ $ref: '#/components/schemas/TemplateResponse'
11204
+ type: object
11205
+ EventCallbackRequestEvent:
11206
+ description: 'Basic information about the event that occurred.'
11207
+ required:
11208
+ - event_time
11209
+ - event_type
11210
+ - event_hash
11211
+ - event_metadata
11212
+ properties:
11213
+ event_time:
11214
+ description: 'Time the event was created (using Unix time).'
11215
+ type: string
11216
+ event_type:
11217
+ description: 'Type of callback event that was triggered.'
11218
+ type: string
11219
+ enum:
11220
+ - account_confirmed
11221
+ - unknown_error
11222
+ - file_error
11223
+ - sign_url_invalid
11224
+ - signature_request_viewed
11225
+ - signature_request_signed
11226
+ - signature_request_sent
11227
+ - signature_request_all_signed
11228
+ - signature_request_email_bounce
11229
+ - signature_request_remind
11230
+ - signature_request_incomplete_qes
11231
+ - signature_request_destroyed
11232
+ - signature_request_canceled
11233
+ - signature_request_downloadable
11234
+ - signature_request_declined
11235
+ - signature_request_reassigned
11236
+ - signature_request_invalid
11237
+ - signature_request_prepared
11238
+ - signature_request_expired
11239
+ - template_created
11240
+ - template_error
11241
+ - callback_test
11242
+ event_hash:
11243
+ description: 'Generated hash used to verify source of event data.'
11244
+ type: string
11245
+ event_metadata:
11246
+ $ref: '#/components/schemas/EventCallbackRequestEventMetadata'
11247
+ type: object
11248
+ EventCallbackRequestEventMetadata:
11249
+ description: 'Specific metadata about the event.'
11250
+ properties:
11251
+ related_signature_id:
11252
+ description: 'Signature ID for a specific signer. Applicable to `signature_request_signed` and `signature_request_viewed` events.'
11253
+ type: string
11254
+ nullable: true
11255
+ reported_for_account_id:
11256
+ description: 'Account ID the event was reported for.'
11257
+ type: string
11258
+ nullable: true
11259
+ reported_for_app_id:
11260
+ description: 'App ID the event was reported for.'
11261
+ type: string
11262
+ nullable: true
11263
+ event_message:
11264
+ description: 'Message about a declined or failed (due to error) signature flow.'
11265
+ type: string
11266
+ nullable: true
11267
+ type: object
10810
11268
  responses:
10811
11269
  EventCallbackResponse:
10812
11270
  description: 'successful operation'
@@ -10924,6 +11382,22 @@ components:
10924
11382
  summary: 'Default Example'
10925
11383
  value:
10926
11384
  $ref: examples/json/TemplateAddUserRequestDefaultExample.json
11385
+ TemplateCreateRequestDefaultExample:
11386
+ summary: 'Default Example'
11387
+ value:
11388
+ $ref: examples/json/TemplateCreateRequestDefaultExample.json
11389
+ TemplateCreateRequestFormFieldsPerDocumentExample:
11390
+ summary: 'Form Fields Per Document Example'
11391
+ value:
11392
+ $ref: examples/json/TemplateCreateRequestFormFieldsPerDocumentExample.json
11393
+ TemplateCreateRequestFormFieldGroupsExample:
11394
+ summary: 'Form Fields Per Document and Groups Example'
11395
+ value:
11396
+ $ref: examples/json/TemplateCreateRequestFormFieldGroupsExample.json
11397
+ TemplateCreateRequestFormFieldRulesExample:
11398
+ summary: 'Form Fields Per Document and Rules Example'
11399
+ value:
11400
+ $ref: examples/json/TemplateCreateRequestFormFieldRulesExample.json
10927
11401
  TemplateCreateEmbeddedDraftRequestDefaultExample:
10928
11402
  summary: 'Default Example'
10929
11403
  value:
@@ -11104,26 +11578,6 @@ components:
11104
11578
  summary: 'API App Update'
11105
11579
  value:
11106
11580
  $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
11581
  SignatureRequestCreateEmbeddedResponseExample:
11128
11582
  summary: 'Create Embedded Signature Request'
11129
11583
  value:
@@ -11228,6 +11682,10 @@ components:
11228
11682
  summary: 'Team Sub Teams List'
11229
11683
  value:
11230
11684
  $ref: examples/json/TeamSubTeamsResponseExample.json
11685
+ TemplateCreateResponseExample:
11686
+ summary: 'Create Template'
11687
+ value:
11688
+ $ref: examples/json/TemplateCreateResponseExample.json
11231
11689
  TemplateCreateEmbeddedDraftResponseExample:
11232
11690
  summary: 'Create Embedded Draft Template'
11233
11691
  value:
@@ -11248,6 +11706,26 @@ components:
11248
11706
  summary: 'Unclaimed Draft Create'
11249
11707
  value:
11250
11708
  $ref: examples/json/UnclaimedDraftCreateResponseExample.json
11709
+ EventCallbackAccountSignatureRequestSentExample:
11710
+ summary: 'Example: signature_request_sent'
11711
+ value:
11712
+ $ref: examples/json/EventCallbackAccountSignatureRequestSentExample.json
11713
+ EventCallbackAccountTemplateCreatedExample:
11714
+ summary: 'Example: template_created'
11715
+ value:
11716
+ $ref: examples/json/EventCallbackAccountTemplateCreatedExample.json
11717
+ EventCallbackAppAccountConfirmedExample:
11718
+ summary: 'Example: account_confirmed'
11719
+ value:
11720
+ $ref: examples/json/EventCallbackAppAccountConfirmedExample.json
11721
+ EventCallbackAppSignatureRequestSentExample:
11722
+ summary: 'Example: signature_request_sent'
11723
+ value:
11724
+ $ref: examples/json/EventCallbackAppSignatureRequestSentExample.json
11725
+ EventCallbackAppTemplateCreatedExample:
11726
+ summary: 'Example: template_created'
11727
+ value:
11728
+ $ref: examples/json/EventCallbackAppTemplateCreatedExample.json
11251
11729
  requestBodies:
11252
11730
  EventCallbackAccountRequest:
11253
11731
  description: |-