dropbox-sign 1.1.1 → 1.2.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (65) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +3 -2
  3. data/README.md +9 -4
  4. data/VERSION +1 -1
  5. data/docs/OAuthApi.md +0 -16
  6. data/docs/SignatureRequestApi.md +1 -1
  7. data/docs/SignatureRequestCreateEmbeddedRequest.md +1 -1
  8. data/docs/SignatureRequestSendRequest.md +2 -1
  9. data/docs/SignatureRequestSendWithTemplateRequest.md +1 -0
  10. data/docs/SignatureRequestUpdateRequest.md +1 -1
  11. data/docs/SubFormFieldsPerDocumentBase.md +2 -2
  12. data/docs/SubFormFieldsPerDocumentDateSigned.md +2 -0
  13. data/docs/SubFormFieldsPerDocumentDropdown.md +2 -0
  14. data/docs/SubFormFieldsPerDocumentFontEnum.md +9 -0
  15. data/docs/SubFormFieldsPerDocumentHyperlink.md +2 -0
  16. data/docs/SubFormFieldsPerDocumentText.md +3 -0
  17. data/docs/SubFormFieldsPerDocumentTextMerge.md +2 -0
  18. data/docs/SubWhiteLabelingOptions.md +1 -1
  19. data/docs/TemplateApi.md +102 -0
  20. data/docs/TemplateCreateEmbeddedDraftRequest.md +1 -1
  21. data/docs/TemplateCreateRequest.md +27 -0
  22. data/docs/TemplateCreateResponse.md +11 -0
  23. data/docs/TemplateCreateResponseTemplate.md +10 -0
  24. data/docs/UnclaimedDraftCreateEmbeddedRequest.md +1 -1
  25. data/docs/UnclaimedDraftCreateRequest.md +1 -1
  26. data/examples/OauthTokenGenerate.rb +0 -8
  27. data/examples/OauthTokenRefresh.rb +0 -8
  28. data/examples/TemplateCreate.rb +49 -0
  29. data/lib/dropbox-sign/api/signature_request_api.rb +2 -2
  30. data/lib/dropbox-sign/api/template_api.rb +109 -0
  31. data/lib/dropbox-sign/configuration.rb +1 -1
  32. data/lib/dropbox-sign/models/signature_request_create_embedded_request.rb +1 -1
  33. data/lib/dropbox-sign/models/signature_request_send_request.rb +15 -2
  34. data/lib/dropbox-sign/models/signature_request_send_with_template_request.rb +14 -1
  35. data/lib/dropbox-sign/models/signature_request_update_request.rb +1 -1
  36. data/lib/dropbox-sign/models/sub_form_fields_per_document_base.rb +2 -2
  37. data/lib/dropbox-sign/models/sub_form_fields_per_document_date_signed.rb +60 -4
  38. data/lib/dropbox-sign/models/sub_form_fields_per_document_dropdown.rb +60 -4
  39. data/lib/dropbox-sign/models/sub_form_fields_per_document_font_enum.rb +54 -0
  40. data/lib/dropbox-sign/models/sub_form_fields_per_document_hyperlink.rb +60 -4
  41. data/lib/dropbox-sign/models/sub_form_fields_per_document_text.rb +49 -4
  42. data/lib/dropbox-sign/models/sub_form_fields_per_document_text_merge.rb +60 -4
  43. data/lib/dropbox-sign/models/sub_white_labeling_options.rb +1 -1
  44. data/lib/dropbox-sign/models/template_create_embedded_draft_request.rb +1 -1
  45. data/lib/dropbox-sign/models/template_create_request.rb +509 -0
  46. data/lib/dropbox-sign/models/template_create_response.rb +263 -0
  47. data/lib/dropbox-sign/models/template_create_response_template.rb +252 -0
  48. data/lib/dropbox-sign/models/unclaimed_draft_create_embedded_request.rb +1 -1
  49. data/lib/dropbox-sign/models/unclaimed_draft_create_request.rb +1 -1
  50. data/lib/dropbox-sign/version.rb +1 -1
  51. data/lib/dropbox-sign.rb +4 -0
  52. data/openapi-config.yaml +1 -1
  53. data/openapi-sdk.yaml +1673 -1261
  54. data/spec/configuration_spec.rb +5 -7
  55. data/templates/configuration.mustache +1 -1
  56. data/templates/configuration_spec.mustache +5 -7
  57. data/test_fixtures/SignatureRequestCreateEmbeddedRequest.json +6 -2
  58. data/test_fixtures/SignatureRequestSendRequest.json +8 -2
  59. data/test_fixtures/SignatureRequestSendWithTemplateRequest.json +1 -0
  60. data/test_fixtures/TemplateCreateEmbeddedDraftRequest.json +3 -1
  61. data/test_fixtures/TemplateCreateRequest.json +120 -0
  62. data/test_fixtures/TemplateCreateResponse.json +7 -0
  63. data/test_fixtures/UnclaimedDraftCreateEmbeddedRequest.json +3 -1
  64. data/test_fixtures/UnclaimedDraftCreateRequest.json +3 -1
  65. metadata +23 -12
data/openapi-sdk.yaml CHANGED
@@ -1487,11 +1487,11 @@ paths:
1487
1487
  label: cURL
1488
1488
  source:
1489
1489
  $ref: examples/OauthTokenGenerate.sh
1490
- x-hideTryItPanel: true
1491
1490
  x-meta:
1492
1491
  seo:
1493
1492
  title: 'Generate OAuth Token | Documentation | Dropbox Sign for Developers'
1494
1493
  description: 'The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to generate a new OAuth token with the API, click here.'
1494
+ x-hideTryItPanel: true
1495
1495
  '/oauth/token?refresh':
1496
1496
  post:
1497
1497
  tags:
@@ -1570,11 +1570,11 @@ paths:
1570
1570
  label: cURL
1571
1571
  source:
1572
1572
  $ref: examples/OauthTokenRefresh.sh
1573
- x-hideTryItPanel: true
1574
1573
  x-meta:
1575
1574
  seo:
1576
1575
  title: 'OAuth Token Refresh | Documentation | Dropbox Sign for Developers'
1577
1576
  description: 'The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to refresh your OAuth token with the API, click here.'
1577
+ x-hideTryItPanel: true
1578
1578
  /report/create:
1579
1579
  post:
1580
1580
  tags:
@@ -2304,8 +2304,8 @@ paths:
2304
2304
  api_key: []
2305
2305
  -
2306
2306
  oauth2:
2307
- - signature_request_access
2308
2307
  - request_signature
2308
+ - signature_request_access
2309
2309
  x-codeSamples:
2310
2310
  -
2311
2311
  lang: PHP
@@ -2417,8 +2417,8 @@ paths:
2417
2417
  api_key: []
2418
2418
  -
2419
2419
  oauth2:
2420
- - signature_request_access
2421
2420
  - request_signature
2421
+ - signature_request_access
2422
2422
  x-codeSamples:
2423
2423
  -
2424
2424
  lang: PHP
@@ -2530,8 +2530,8 @@ paths:
2530
2530
  api_key: []
2531
2531
  -
2532
2532
  oauth2:
2533
- - signature_request_access
2534
2533
  - request_signature
2534
+ - signature_request_access
2535
2535
  x-codeSamples:
2536
2536
  -
2537
2537
  lang: PHP
@@ -3364,6 +3364,8 @@ paths:
3364
3364
  description: |-
3365
3365
  Updates the email address and/or the name for a given signer on a signature request. You can listen for the `signature_request_email_bounce` event on your app or account to detect bounced emails, and respond with this method.
3366
3366
 
3367
+ Updating the email address of a signer will generate a new `signature_id` value.
3368
+
3367
3369
  **NOTE**: This action cannot be performed on a signature request with an appended signature page.
3368
3370
  operationId: signatureRequestUpdate
3369
3371
  parameters:
@@ -3487,7 +3489,6 @@ paths:
3487
3489
  schema:
3488
3490
  type: string
3489
3491
  example: 4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c
3490
- x-beta: closed
3491
3492
  requestBody:
3492
3493
  required: true
3493
3494
  content:
@@ -4067,7 +4068,6 @@ paths:
4067
4068
  label: cURL
4068
4069
  source:
4069
4070
  $ref: examples/TeamInfo.sh
4070
- x-beta: closed
4071
4071
  x-meta:
4072
4072
  seo:
4073
4073
  title: 'Get Team Info | Dropbox Sign for Developers'
@@ -4290,7 +4290,6 @@ paths:
4290
4290
  label: cURL
4291
4291
  source:
4292
4292
  $ref: examples/TeamMembers.sh
4293
- x-beta: closed
4294
4293
  x-meta:
4295
4294
  seo:
4296
4295
  title: 'List Team Members | Dropbox Sign for Developers'
@@ -4517,7 +4516,6 @@ paths:
4517
4516
  label: cURL
4518
4517
  source:
4519
4518
  $ref: examples/TeamSubTeams.sh
4520
- x-beta: closed
4521
4519
  x-meta:
4522
4520
  seo:
4523
4521
  title: 'List Sub Teams | Dropbox Sign for Developers'
@@ -4634,6 +4632,120 @@ paths:
4634
4632
  seo:
4635
4633
  title: 'Add User to Template | REST API | Dropbox Sign for Developers'
4636
4634
  description: 'The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to give an Account access to a Template, click here.'
4635
+ /template/create:
4636
+ post:
4637
+ tags:
4638
+ - Template
4639
+ summary: 'Create Template'
4640
+ description: 'Creates a template that can then be used.'
4641
+ operationId: templateCreate
4642
+ requestBody:
4643
+ required: true
4644
+ content:
4645
+ application/json:
4646
+ schema:
4647
+ $ref: '#/components/schemas/TemplateCreateRequest'
4648
+ examples:
4649
+ default_example:
4650
+ $ref: '#/components/examples/TemplateCreateRequestDefaultExample'
4651
+ form_fields_per_document:
4652
+ $ref: '#/components/examples/TemplateCreateRequestFormFieldsPerDocumentExample'
4653
+ form_field_groups:
4654
+ $ref: '#/components/examples/TemplateCreateRequestFormFieldGroupsExample'
4655
+ form_field_rules:
4656
+ $ref: '#/components/examples/TemplateCreateRequestFormFieldRulesExample'
4657
+ multipart/form-data:
4658
+ schema:
4659
+ $ref: '#/components/schemas/TemplateCreateRequest'
4660
+ responses:
4661
+ 200:
4662
+ description: 'successful operation'
4663
+ headers:
4664
+ X-RateLimit-Limit:
4665
+ $ref: '#/components/headers/X-RateLimit-Limit'
4666
+ X-RateLimit-Remaining:
4667
+ $ref: '#/components/headers/X-RateLimit-Remaining'
4668
+ X-Ratelimit-Reset:
4669
+ $ref: '#/components/headers/X-Ratelimit-Reset'
4670
+ content:
4671
+ application/json:
4672
+ schema:
4673
+ $ref: '#/components/schemas/TemplateCreateResponse'
4674
+ examples:
4675
+ default_example:
4676
+ $ref: '#/components/examples/TemplateCreateResponseExample'
4677
+ 4XX:
4678
+ description: failed_operation
4679
+ content:
4680
+ application/json:
4681
+ schema:
4682
+ $ref: '#/components/schemas/ErrorResponse'
4683
+ examples:
4684
+ 400_example:
4685
+ $ref: '#/components/examples/Error400ResponseExample'
4686
+ 401_example:
4687
+ $ref: '#/components/examples/Error401ResponseExample'
4688
+ 402_example:
4689
+ $ref: '#/components/examples/Error402ResponseExample'
4690
+ 403_example:
4691
+ $ref: '#/components/examples/Error403ResponseExample'
4692
+ 404_example:
4693
+ $ref: '#/components/examples/Error404ResponseExample'
4694
+ 409_example:
4695
+ $ref: '#/components/examples/Error409ResponseExample'
4696
+ 4XX_example:
4697
+ $ref: '#/components/examples/Error4XXResponseExample'
4698
+ security:
4699
+ -
4700
+ api_key: []
4701
+ -
4702
+ oauth2:
4703
+ - template_access
4704
+ x-codeSamples:
4705
+ -
4706
+ lang: PHP
4707
+ label: PHP
4708
+ source:
4709
+ $ref: examples/TemplateCreate.php
4710
+ -
4711
+ lang: 'C#'
4712
+ label: 'C#'
4713
+ source:
4714
+ $ref: examples/TemplateCreate.cs
4715
+ -
4716
+ lang: JavaScript
4717
+ label: JavaScript
4718
+ source:
4719
+ $ref: examples/TemplateCreate.js
4720
+ -
4721
+ lang: TypeScript
4722
+ label: TypeScript
4723
+ source:
4724
+ $ref: examples/TemplateCreate.ts
4725
+ -
4726
+ lang: Java
4727
+ label: Java
4728
+ source:
4729
+ $ref: examples/TemplateCreate.java
4730
+ -
4731
+ lang: Ruby
4732
+ label: Ruby
4733
+ source:
4734
+ $ref: examples/TemplateCreate.rb
4735
+ -
4736
+ lang: Python
4737
+ label: Python
4738
+ source:
4739
+ $ref: examples/TemplateCreate.py
4740
+ -
4741
+ lang: cURL
4742
+ label: cURL
4743
+ source:
4744
+ $ref: examples/TemplateCreate.sh
4745
+ x-meta:
4746
+ seo:
4747
+ title: 'Create Template | Dropbox Sign for Developers'
4748
+ description: 'The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to create an template, click here.'
4637
4749
  /template/create_embedded_draft:
4638
4750
  post:
4639
4751
  tags:
@@ -6283,296 +6395,66 @@ components:
6283
6395
  type: boolean
6284
6396
  default: false
6285
6397
  type: object
6286
- SubFormFieldsPerDocumentTypeEnum:
6287
- type: string
6288
- enum:
6289
- - checkbox
6290
- - checkbox-merge
6291
- - date_signed
6292
- - dropdown
6293
- - hyperlink
6294
- - initials
6295
- - signature
6296
- - radio
6297
- - text
6298
- - text-merge
6299
- SubFormFieldsPerDocumentText:
6300
- description: 'This class extends `SubFormFieldsPerDocumentBase`.'
6398
+ OAuthTokenGenerateRequest:
6399
+ required:
6400
+ - client_id
6401
+ - client_secret
6402
+ - code
6403
+ - state
6404
+ - grant_type
6405
+ properties:
6406
+ client_id:
6407
+ description: 'The client id of the app requesting authorization.'
6408
+ type: string
6409
+ client_secret:
6410
+ description: 'The secret token of your app.'
6411
+ type: string
6412
+ code:
6413
+ description: 'The code passed to your callback when the user granted access.'
6414
+ type: string
6415
+ grant_type:
6416
+ description: 'When generating a new token use `authorization_code`.'
6417
+ type: string
6418
+ default: authorization_code
6419
+ state:
6420
+ description: 'Same as the state you specified earlier.'
6421
+ type: string
6301
6422
  type: object
6302
- allOf:
6303
- -
6304
- $ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
6305
- -
6306
- required:
6307
- - type
6308
- - options
6309
- properties:
6310
- type:
6311
- description: 'A text input field. Use the `SubFormFieldsPerDocumentText` class.'
6312
- type: string
6313
- default: text
6314
- placeholder:
6315
- description: 'Placeholder value for text field.'
6316
- type: string
6317
- auto_fill_type:
6318
- 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.'
6319
- type: string
6320
- link_id:
6321
- description: 'Link two or more text fields. Enter data into one linked text field, which automatically fill all other linked text fields.'
6322
- type: string
6323
- masked:
6324
- 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`.'
6325
- type: boolean
6326
- validation_type:
6327
- description: |-
6328
- 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.
6329
-
6330
- **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.
6331
- type: string
6332
- enum:
6333
- - numbers_only
6334
- - letters_only
6335
- - phone_number
6336
- - bank_routing_number
6337
- - bank_account_number
6338
- - email_address
6339
- - zip_code
6340
- - social_security_number
6341
- - employer_identification_number
6342
- - custom_regex
6343
- validation_custom_regex:
6344
- type: string
6345
- validation_custom_regex_format_label:
6346
- type: string
6347
- type: object
6348
- SubFormFieldsPerDocumentDropdown:
6349
- description: 'This class extends `SubFormFieldsPerDocumentBase`.'
6423
+ OAuthTokenRefreshRequest:
6424
+ required:
6425
+ - grant_type
6426
+ - refresh_token
6427
+ properties:
6428
+ grant_type:
6429
+ description: 'When refreshing an existing token use `refresh_token`.'
6430
+ type: string
6431
+ default: refresh_token
6432
+ refresh_token:
6433
+ description: 'The token provided when you got the expired access token.'
6434
+ type: string
6350
6435
  type: object
6351
- allOf:
6352
- -
6353
- $ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
6354
- -
6355
- required:
6356
- - type
6357
- - options
6358
- properties:
6359
- type:
6360
- description: 'An input field for dropdowns. Use the `SubFormFieldsPerDocumentDropdown` class.'
6361
- type: string
6362
- default: dropdown
6363
- options:
6364
- description: 'Array of string values representing dropdown values.'
6365
- type: array
6366
- items:
6367
- type: string
6368
- minItems: 1
6369
- content:
6370
- description: 'Selected value in `options` array. Value must exist in array.'
6371
- type: string
6372
- type: object
6373
- SubFormFieldsPerDocumentHyperlink:
6374
- description: 'This class extends `SubFormFieldsPerDocumentBase`.'
6375
- type: object
6376
- allOf:
6377
- -
6378
- $ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
6379
- -
6380
- required:
6381
- - type
6382
- - content
6383
- - content_url
6384
- properties:
6385
- type:
6386
- description: 'A hyperlink field. Use the `SubFormFieldsPerDocumentHyperlink` class.'
6387
- type: string
6388
- default: hyperlink
6389
- content:
6390
- description: 'Link Text.'
6391
- type: string
6392
- content_url:
6393
- description: 'Link URL.'
6394
- type: string
6395
- type: object
6396
- SubFormFieldsPerDocumentCheckbox:
6397
- description: 'This class extends `SubFormFieldsPerDocumentBase`.'
6398
- type: object
6399
- allOf:
6400
- -
6401
- $ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
6402
- -
6403
- required:
6404
- - type
6405
- - is_checked
6406
- properties:
6407
- type:
6408
- description: 'A yes/no checkbox. Use the `SubFormFieldsPerDocumentCheckbox` class.'
6409
- type: string
6410
- default: checkbox
6411
- group:
6412
- description: 'String referencing group defined in `form_field_groups` parameter.'
6413
- type: string
6414
- is_checked:
6415
- description: '`true` for checking the checkbox field by default, otherwise `false`.'
6416
- type: boolean
6417
- type: object
6418
- SubFormFieldsPerDocumentRadio:
6419
- description: 'This class extends `SubFormFieldsPerDocumentBase`.'
6420
- type: object
6421
- allOf:
6422
- -
6423
- $ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
6424
- -
6425
- required:
6426
- - type
6427
- - group
6428
- - is_checked
6429
- properties:
6430
- type:
6431
- description: 'An input field for radios. Use the `SubFormFieldsPerDocumentRadio` class.'
6432
- type: string
6433
- default: radio
6434
- group:
6435
- description: 'String referencing group defined in `form_field_groups` parameter.'
6436
- type: string
6437
- is_checked:
6438
- description: '`true` for checking the radio field by default, otherwise `false`. Only one radio field per group can be `true`.'
6439
- type: boolean
6440
- type: object
6441
- SubFormFieldsPerDocumentSignature:
6442
- description: 'This class extends `SubFormFieldsPerDocumentBase`.'
6443
- type: object
6444
- allOf:
6445
- -
6446
- $ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
6447
- -
6448
- required:
6449
- - type
6450
- properties:
6451
- type:
6452
- description: 'A signature input field. Use the `SubFormFieldsPerDocumentSignature` class.'
6453
- type: string
6454
- default: signature
6455
- type: object
6456
- SubFormFieldsPerDocumentDateSigned:
6457
- description: 'This class extends `SubFormFieldsPerDocumentBase`.'
6458
- type: object
6459
- allOf:
6460
- -
6461
- $ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
6462
- -
6463
- required:
6464
- - type
6465
- properties:
6466
- type:
6467
- description: 'A date. Use the `SubFormFieldsPerDocumentDateSigned` class.'
6468
- type: string
6469
- default: date_signed
6470
- type: object
6471
- SubFormFieldsPerDocumentInitials:
6472
- description: 'This class extends `SubFormFieldsPerDocumentBase`.'
6473
- type: object
6474
- allOf:
6475
- -
6476
- $ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
6477
- -
6478
- required:
6479
- - type
6480
- properties:
6481
- type:
6482
- description: 'An input field for initials. Use the `SubFormFieldsPerDocumentInitials` class.'
6483
- type: string
6484
- default: initials
6485
- type: object
6486
- SubFormFieldsPerDocumentTextMerge:
6487
- description: 'This class extends `SubFormFieldsPerDocumentBase`.'
6488
- type: object
6489
- allOf:
6490
- -
6491
- $ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
6492
- -
6493
- required:
6494
- - type
6495
- properties:
6496
- type:
6497
- description: 'A text field that has default text set using pre-filled data. Use the `SubFormFieldsPerDocumentTextMerge` class.'
6498
- type: string
6499
- default: text-merge
6500
- type: object
6501
- SubFormFieldsPerDocumentCheckboxMerge:
6502
- description: 'This class extends `SubFormFieldsPerDocumentBase`.'
6503
- type: object
6504
- allOf:
6505
- -
6506
- $ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
6507
- -
6508
- required:
6509
- - type
6510
- properties:
6511
- type:
6512
- description: 'A checkbox field that has default value set using pre-filled data. Use the `SubFormFieldsPerDocumentCheckboxMerge` class.'
6513
- type: string
6514
- default: checkbox-merge
6515
- type: object
6516
- OAuthTokenGenerateRequest:
6517
- required:
6518
- - client_id
6519
- - client_secret
6520
- - code
6521
- - state
6522
- - grant_type
6523
- properties:
6524
- client_id:
6525
- description: 'The client id of the app requesting authorization.'
6526
- type: string
6527
- client_secret:
6528
- description: 'The secret token of your app.'
6529
- type: string
6530
- code:
6531
- description: 'The code passed to your callback when the user granted access.'
6532
- type: string
6533
- grant_type:
6534
- description: 'When generating a new token use `authorization_code`.'
6535
- type: string
6536
- default: authorization_code
6537
- state:
6538
- description: 'Same as the state you specified earlier.'
6539
- type: string
6540
- type: object
6541
- OAuthTokenRefreshRequest:
6542
- required:
6543
- - grant_type
6544
- - refresh_token
6545
- properties:
6546
- grant_type:
6547
- description: 'When refreshing an existing token use `refresh_token`.'
6548
- type: string
6549
- default: refresh_token
6550
- refresh_token:
6551
- description: 'The token provided when you got the expired access token.'
6552
- type: string
6553
- type: object
6554
- ReportCreateRequest:
6555
- required:
6556
- - start_date
6557
- - end_date
6558
- - report_type
6559
- properties:
6560
- end_date:
6561
- description: 'The (inclusive) end date for the report data in `MM/DD/YYYY` format.'
6562
- type: string
6563
- report_type:
6564
- 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).'
6565
- type: array
6566
- items:
6567
- type: string
6568
- enum:
6569
- - user_activity
6570
- - document_status
6571
- maxItems: 2
6572
- minItems: 1
6573
- start_date:
6574
- description: 'The (inclusive) start date for the report data in `MM/DD/YYYY` format.'
6575
- type: string
6436
+ ReportCreateRequest:
6437
+ required:
6438
+ - start_date
6439
+ - end_date
6440
+ - report_type
6441
+ properties:
6442
+ end_date:
6443
+ description: 'The (inclusive) end date for the report data in `MM/DD/YYYY` format.'
6444
+ type: string
6445
+ report_type:
6446
+ 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).'
6447
+ type: array
6448
+ items:
6449
+ type: string
6450
+ enum:
6451
+ - user_activity
6452
+ - document_status
6453
+ maxItems: 2
6454
+ minItems: 1
6455
+ start_date:
6456
+ description: 'The (inclusive) start date for the report data in `MM/DD/YYYY` format.'
6457
+ type: string
6576
6458
  type: object
6577
6459
  SignatureRequestBulkCreateEmbeddedWithTemplateRequest:
6578
6460
  required:
@@ -6835,7 +6717,7 @@ components:
6835
6717
  $ref: '#/components/schemas/SubFormFieldRule'
6836
6718
  form_fields_per_document:
6837
6719
  description: |-
6838
- The fields that should appear on the document, expressed as an array of objects. (We're currently fixing a bug where this property only accepts a two-dimensional array. You can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)
6720
+ 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).)
6839
6721
 
6840
6722
  **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.
6841
6723
 
@@ -6900,7 +6782,6 @@ components:
6900
6782
  description: 'When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details.'
6901
6783
  type: integer
6902
6784
  nullable: true
6903
- x-beta: closed
6904
6785
  type: object
6905
6786
  SignatureRequestCreateEmbeddedWithTemplateRequest:
6906
6787
  required:
@@ -7082,7 +6963,7 @@ components:
7082
6963
  $ref: '#/components/schemas/SubFormFieldRule'
7083
6964
  form_fields_per_document:
7084
6965
  description: |-
7085
- The fields that should appear on the document, expressed as an array of objects. (We're currently fixing a bug where this property only accepts a two-dimensional array. You can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)
6966
+ 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).)
7086
6967
 
7087
6968
  **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.
7088
6969
 
@@ -7115,6 +6996,16 @@ components:
7115
6996
  Cannot be used in `test_mode`. Only works on requests with one signer.
7116
6997
  type: boolean
7117
6998
  default: false
6999
+ deprecated: true
7000
+ x-hideOn: doc
7001
+ is_eid:
7002
+ description: |-
7003
+ Send with a value of `true` if you wish to enable
7004
+ [electronic identification (eID)](https://www.hellosign.com/features/electronic-id),
7005
+ which requires the signer to verify their identity with an eID provider to sign a document.<br>
7006
+ **Note**: eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer.
7007
+ type: boolean
7008
+ default: false
7118
7009
  message:
7119
7010
  description: 'The custom message in the email that will be sent to the signers.'
7120
7011
  type: string
@@ -7152,7 +7043,6 @@ components:
7152
7043
  description: 'When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details.'
7153
7044
  type: integer
7154
7045
  nullable: true
7155
- x-beta: closed
7156
7046
  type: object
7157
7047
  SignatureRequestSendWithTemplateRequest:
7158
7048
  description: ''
@@ -7208,6 +7098,16 @@ components:
7208
7098
  Cannot be used in `test_mode`. Only works on requests with one signer.
7209
7099
  type: boolean
7210
7100
  default: false
7101
+ deprecated: true
7102
+ x-hideOn: doc
7103
+ is_eid:
7104
+ description: |-
7105
+ Send with a value of `true` if you wish to enable
7106
+ [electronic identification (eID)](https://www.hellosign.com/features/electronic-id),
7107
+ which requires the signer to verify their identity with an eID provider to sign a document.<br>
7108
+ **Note**: eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer.
7109
+ type: boolean
7110
+ default: false
7211
7111
  message:
7212
7112
  description: 'The custom message in the email that will be sent to the signers.'
7213
7113
  type: string
@@ -7251,6 +7151,8 @@ components:
7251
7151
  description: |-
7252
7152
  The new email address for the recipient.
7253
7153
 
7154
+ This will generate a new `signature_id` value.
7155
+
7254
7156
  **NOTE**: Optional if `name` is provided.
7255
7157
  type: string
7256
7158
  format: email
@@ -7267,7 +7169,6 @@ components:
7267
7169
  description: 'The new time when the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details.'
7268
7170
  type: integer
7269
7171
  nullable: true
7270
- x-beta: closed
7271
7172
  type: object
7272
7173
  SubAttachment:
7273
7174
  required:
@@ -7538,59 +7439,453 @@ components:
7538
7439
  items:
7539
7440
  type: string
7540
7441
  type: object
7541
- SubFormFieldsPerDocumentBase:
7542
- description: |-
7543
- The fields that should appear on the document, expressed as an array of objects. (We're currently fixing a bug where this property only accepts a two-dimensional array. You can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)
7544
-
7545
- **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.
7546
-
7547
- * Text Field use `SubFormFieldsPerDocumentText`
7548
- * Dropdown Field use `SubFormFieldsPerDocumentDropdown`
7549
- * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`
7550
- * Checkbox Field use `SubFormFieldsPerDocumentCheckbox`
7551
- * Radio Field use `SubFormFieldsPerDocumentRadio`
7552
- * Signature Field use `SubFormFieldsPerDocumentSignature`
7553
- * Date Signed Field use `SubFormFieldsPerDocumentDateSigned`
7554
- * Initials Field use `SubFormFieldsPerDocumentInitials`
7555
- * Text Merge Field use `SubFormFieldsPerDocumentTextMerge`
7556
- * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge`
7557
- required:
7558
- - document_index
7559
- - api_id
7560
- - type
7561
- - required
7562
- - signer
7563
- - width
7564
- - height
7565
- - x
7566
- - 'y'
7567
- properties:
7568
- document_index:
7569
- description: 'Represents the integer index of the `file` or `file_url` document the field should be attached to.'
7570
- type: integer
7571
- api_id:
7572
- description: 'An identifier for the field that is unique across all documents in the request.'
7573
- type: string
7574
- height:
7575
- description: 'Size of the field in pixels.'
7576
- type: integer
7577
- name:
7578
- description: 'Display name for the field.'
7579
- type: string
7580
- page:
7581
- description: |-
7582
- Page in the document where the field should be placed (requires documents be PDF files).
7583
-
7584
- - When the page number parameter is supplied, the API will use the new coordinate system.
7585
- - Check out the differences between both [coordinate systems](https://faq.hellosign.com/hc/en-us/articles/217115577) and how to use them.
7586
- type: integer
7587
- nullable: true
7588
- required:
7589
- description: 'Whether this field is required.'
7590
- type: boolean
7591
- signer:
7592
- description: |-
7593
- Signer index identified by the offset in the signers parameter (0-based indexing), indicating which signer should fill out the field.
7442
+ SubFormFieldsPerDocumentCheckbox:
7443
+ description: 'This class extends `SubFormFieldsPerDocumentBase`.'
7444
+ allOf:
7445
+ -
7446
+ $ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
7447
+ -
7448
+ required:
7449
+ - type
7450
+ - is_checked
7451
+ properties:
7452
+ type:
7453
+ description: 'A yes/no checkbox. Use the `SubFormFieldsPerDocumentCheckbox` class.'
7454
+ type: string
7455
+ default: checkbox
7456
+ group:
7457
+ description: 'String referencing group defined in `form_field_groups` parameter.'
7458
+ type: string
7459
+ is_checked:
7460
+ description: '`true` for checking the checkbox field by default, otherwise `false`.'
7461
+ type: boolean
7462
+ type: object
7463
+ -
7464
+ $ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
7465
+ SubFormFieldsPerDocumentCheckboxMerge:
7466
+ description: 'This class extends `SubFormFieldsPerDocumentBase`.'
7467
+ allOf:
7468
+ -
7469
+ $ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
7470
+ -
7471
+ required:
7472
+ - type
7473
+ properties:
7474
+ type:
7475
+ description: 'A checkbox field that has default value set using pre-filled data. Use the `SubFormFieldsPerDocumentCheckboxMerge` class.'
7476
+ type: string
7477
+ default: checkbox-merge
7478
+ type: object
7479
+ -
7480
+ $ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
7481
+ SubFormFieldsPerDocumentDateSigned:
7482
+ description: 'This class extends `SubFormFieldsPerDocumentBase`.'
7483
+ allOf:
7484
+ -
7485
+ $ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
7486
+ -
7487
+ required:
7488
+ - type
7489
+ properties:
7490
+ type:
7491
+ description: 'A date. Use the `SubFormFieldsPerDocumentDateSigned` class.'
7492
+ type: string
7493
+ default: date_signed
7494
+ font_family:
7495
+ description: 'Font family for the field.'
7496
+ type: string
7497
+ enum:
7498
+ - helvetica
7499
+ - arial
7500
+ - courier
7501
+ - calibri
7502
+ - cambria
7503
+ - georgia
7504
+ - times
7505
+ - trebuchet
7506
+ - verdana
7507
+ - roboto
7508
+ - robotoMono
7509
+ - notoSans
7510
+ - notoSerif
7511
+ - notoCJK-JP-Regular
7512
+ - notoHebrew-Regular
7513
+ - notoSanThaiMerged
7514
+ font_size:
7515
+ description: |-
7516
+ The initial px font size for the field contents. Can be any integer value between `7` and `49`.
7517
+
7518
+ **NOTE**: Font size may be reduced during processing in order to fit the contents within the dimensions of the field.
7519
+ type: integer
7520
+ type: object
7521
+ -
7522
+ $ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
7523
+ SubFormFieldsPerDocumentDropdown:
7524
+ description: 'This class extends `SubFormFieldsPerDocumentBase`.'
7525
+ allOf:
7526
+ -
7527
+ $ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
7528
+ -
7529
+ required:
7530
+ - type
7531
+ - options
7532
+ properties:
7533
+ type:
7534
+ description: 'An input field for dropdowns. Use the `SubFormFieldsPerDocumentDropdown` class.'
7535
+ type: string
7536
+ default: dropdown
7537
+ options:
7538
+ description: 'Array of string values representing dropdown values.'
7539
+ type: array
7540
+ items:
7541
+ type: string
7542
+ minItems: 1
7543
+ content:
7544
+ description: 'Selected value in `options` array. Value must exist in array.'
7545
+ type: string
7546
+ font_family:
7547
+ description: 'Font family for the field.'
7548
+ type: string
7549
+ enum:
7550
+ - helvetica
7551
+ - arial
7552
+ - courier
7553
+ - calibri
7554
+ - cambria
7555
+ - georgia
7556
+ - times
7557
+ - trebuchet
7558
+ - verdana
7559
+ - roboto
7560
+ - robotoMono
7561
+ - notoSans
7562
+ - notoSerif
7563
+ - notoCJK-JP-Regular
7564
+ - notoHebrew-Regular
7565
+ - notoSanThaiMerged
7566
+ font_size:
7567
+ description: |-
7568
+ The initial px font size for the field contents. Can be any integer value between `7` and `49`.
7569
+
7570
+ **NOTE**: Font size may be reduced during processing in order to fit the contents within the dimensions of the field.
7571
+ type: integer
7572
+ type: object
7573
+ -
7574
+ $ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
7575
+ SubFormFieldsPerDocumentHyperlink:
7576
+ description: 'This class extends `SubFormFieldsPerDocumentBase`.'
7577
+ allOf:
7578
+ -
7579
+ $ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
7580
+ -
7581
+ required:
7582
+ - type
7583
+ - content
7584
+ - content_url
7585
+ properties:
7586
+ type:
7587
+ description: 'A hyperlink field. Use the `SubFormFieldsPerDocumentHyperlink` class.'
7588
+ type: string
7589
+ default: hyperlink
7590
+ content:
7591
+ description: 'Link Text.'
7592
+ type: string
7593
+ content_url:
7594
+ description: 'Link URL.'
7595
+ type: string
7596
+ font_family:
7597
+ description: 'Font family for the field.'
7598
+ type: string
7599
+ enum:
7600
+ - helvetica
7601
+ - arial
7602
+ - courier
7603
+ - calibri
7604
+ - cambria
7605
+ - georgia
7606
+ - times
7607
+ - trebuchet
7608
+ - verdana
7609
+ - roboto
7610
+ - robotoMono
7611
+ - notoSans
7612
+ - notoSerif
7613
+ - notoCJK-JP-Regular
7614
+ - notoHebrew-Regular
7615
+ - notoSanThaiMerged
7616
+ font_size:
7617
+ description: |-
7618
+ The initial px font size for the field contents. Can be any integer value between `7` and `49`.
7619
+
7620
+ **NOTE**: Font size may be reduced during processing in order to fit the contents within the dimensions of the field.
7621
+ type: integer
7622
+ type: object
7623
+ -
7624
+ $ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
7625
+ SubFormFieldsPerDocumentInitials:
7626
+ description: 'This class extends `SubFormFieldsPerDocumentBase`.'
7627
+ allOf:
7628
+ -
7629
+ $ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
7630
+ -
7631
+ required:
7632
+ - type
7633
+ properties:
7634
+ type:
7635
+ description: 'An input field for initials. Use the `SubFormFieldsPerDocumentInitials` class.'
7636
+ type: string
7637
+ default: initials
7638
+ type: object
7639
+ -
7640
+ $ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
7641
+ SubFormFieldsPerDocumentRadio:
7642
+ description: 'This class extends `SubFormFieldsPerDocumentBase`.'
7643
+ allOf:
7644
+ -
7645
+ $ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
7646
+ -
7647
+ required:
7648
+ - type
7649
+ - group
7650
+ - is_checked
7651
+ properties:
7652
+ type:
7653
+ description: 'An input field for radios. Use the `SubFormFieldsPerDocumentRadio` class.'
7654
+ type: string
7655
+ default: radio
7656
+ group:
7657
+ description: 'String referencing group defined in `form_field_groups` parameter.'
7658
+ type: string
7659
+ is_checked:
7660
+ description: '`true` for checking the radio field by default, otherwise `false`. Only one radio field per group can be `true`.'
7661
+ type: boolean
7662
+ type: object
7663
+ -
7664
+ $ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
7665
+ SubFormFieldsPerDocumentSignature:
7666
+ description: 'This class extends `SubFormFieldsPerDocumentBase`.'
7667
+ allOf:
7668
+ -
7669
+ $ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
7670
+ -
7671
+ required:
7672
+ - type
7673
+ properties:
7674
+ type:
7675
+ description: 'A signature input field. Use the `SubFormFieldsPerDocumentSignature` class.'
7676
+ type: string
7677
+ default: signature
7678
+ type: object
7679
+ -
7680
+ $ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
7681
+ SubFormFieldsPerDocumentText:
7682
+ description: 'This class extends `SubFormFieldsPerDocumentBase`.'
7683
+ allOf:
7684
+ -
7685
+ $ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
7686
+ -
7687
+ required:
7688
+ - type
7689
+ - options
7690
+ properties:
7691
+ type:
7692
+ description: 'A text input field. Use the `SubFormFieldsPerDocumentText` class.'
7693
+ type: string
7694
+ default: text
7695
+ placeholder:
7696
+ description: 'Placeholder value for text field.'
7697
+ type: string
7698
+ auto_fill_type:
7699
+ description: 'Auto fill type for populating fields automatically. Check out the list of [auto fill types](/api/reference/constants/#auto-fill-types) to learn more about the possible values.'
7700
+ type: string
7701
+ link_id:
7702
+ description: 'Link two or more text fields. Enter data into one linked text field, which automatically fill all other linked text fields.'
7703
+ type: string
7704
+ masked:
7705
+ description: 'Masks entered data. For more information see [Masking sensitive information](https://faq.hellosign.com/hc/en-us/articles/360040742811-Masking-sensitive-information). `true` for masking the data in a text field, otherwise `false`.'
7706
+ type: boolean
7707
+ validation_type:
7708
+ description: |-
7709
+ Each text field may contain a `validation_type` parameter. Check out the list of [validation types](https://faq.hellosign.com/hc/en-us/articles/217115577) to learn more about the possible values.
7710
+
7711
+ **NOTE**: When using `custom_regex` you are required to pass a second parameter `validation_custom_regex` and you can optionally provide `validation_custom_regex_format_label` for the error message the user will see in case of an invalid value.
7712
+ type: string
7713
+ enum:
7714
+ - numbers_only
7715
+ - letters_only
7716
+ - phone_number
7717
+ - bank_routing_number
7718
+ - bank_account_number
7719
+ - email_address
7720
+ - zip_code
7721
+ - social_security_number
7722
+ - employer_identification_number
7723
+ - custom_regex
7724
+ validation_custom_regex:
7725
+ type: string
7726
+ validation_custom_regex_format_label:
7727
+ type: string
7728
+ content:
7729
+ description: 'Content of a `me_now` text field'
7730
+ type: string
7731
+ font_family:
7732
+ description: 'Font family for the field.'
7733
+ type: string
7734
+ enum:
7735
+ - helvetica
7736
+ - arial
7737
+ - courier
7738
+ - calibri
7739
+ - cambria
7740
+ - georgia
7741
+ - times
7742
+ - trebuchet
7743
+ - verdana
7744
+ - roboto
7745
+ - robotoMono
7746
+ - notoSans
7747
+ - notoSerif
7748
+ - notoCJK-JP-Regular
7749
+ - notoHebrew-Regular
7750
+ - notoSanThaiMerged
7751
+ font_size:
7752
+ description: |-
7753
+ The initial px font size for the field contents. Can be any integer value between `7` and `49`.
7754
+
7755
+ **NOTE**: Font size may be reduced during processing in order to fit the contents within the dimensions of the field.
7756
+ type: integer
7757
+ type: object
7758
+ -
7759
+ $ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
7760
+ SubFormFieldsPerDocumentTextMerge:
7761
+ description: 'This class extends `SubFormFieldsPerDocumentBase`.'
7762
+ allOf:
7763
+ -
7764
+ $ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
7765
+ -
7766
+ required:
7767
+ - type
7768
+ properties:
7769
+ type:
7770
+ description: 'A text field that has default text set using pre-filled data. Use the `SubFormFieldsPerDocumentTextMerge` class.'
7771
+ type: string
7772
+ default: text-merge
7773
+ font_family:
7774
+ description: 'Font family for the field.'
7775
+ type: string
7776
+ enum:
7777
+ - helvetica
7778
+ - arial
7779
+ - courier
7780
+ - calibri
7781
+ - cambria
7782
+ - georgia
7783
+ - times
7784
+ - trebuchet
7785
+ - verdana
7786
+ - roboto
7787
+ - robotoMono
7788
+ - notoSans
7789
+ - notoSerif
7790
+ - notoCJK-JP-Regular
7791
+ - notoHebrew-Regular
7792
+ - notoSanThaiMerged
7793
+ font_size:
7794
+ description: |-
7795
+ The initial px font size for the field contents. Can be any integer value between `7` and `49`.
7796
+
7797
+ **NOTE**: Font size may be reduced during processing in order to fit the contents within the dimensions of the field.
7798
+ type: integer
7799
+ type: object
7800
+ -
7801
+ $ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
7802
+ SubFormFieldsPerDocumentTypeEnum:
7803
+ type: string
7804
+ enum:
7805
+ - checkbox
7806
+ - checkbox-merge
7807
+ - date_signed
7808
+ - dropdown
7809
+ - hyperlink
7810
+ - initials
7811
+ - signature
7812
+ - radio
7813
+ - text
7814
+ - text-merge
7815
+ SubFormFieldsPerDocumentFontEnum:
7816
+ type: string
7817
+ enum:
7818
+ - helvetica
7819
+ - arial
7820
+ - courier
7821
+ - calibri
7822
+ - cambria
7823
+ - georgia
7824
+ - times
7825
+ - trebuchet
7826
+ - verdana
7827
+ - roboto
7828
+ - robotoMono
7829
+ - notoSans
7830
+ - notoSerif
7831
+ - notoCJK-JP-Regular
7832
+ - notoHebrew-Regular
7833
+ - notoSanThaiMerged
7834
+ SubFormFieldsPerDocumentBase:
7835
+ description: |-
7836
+ The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)
7837
+
7838
+ **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.
7839
+
7840
+ * Text Field use `SubFormFieldsPerDocumentText`
7841
+ * Dropdown Field use `SubFormFieldsPerDocumentDropdown`
7842
+ * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`
7843
+ * Checkbox Field use `SubFormFieldsPerDocumentCheckbox`
7844
+ * Radio Field use `SubFormFieldsPerDocumentRadio`
7845
+ * Signature Field use `SubFormFieldsPerDocumentSignature`
7846
+ * Date Signed Field use `SubFormFieldsPerDocumentDateSigned`
7847
+ * Initials Field use `SubFormFieldsPerDocumentInitials`
7848
+ * Text Merge Field use `SubFormFieldsPerDocumentTextMerge`
7849
+ * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge`
7850
+ required:
7851
+ - document_index
7852
+ - api_id
7853
+ - type
7854
+ - required
7855
+ - signer
7856
+ - width
7857
+ - height
7858
+ - x
7859
+ - 'y'
7860
+ properties:
7861
+ document_index:
7862
+ description: 'Represents the integer index of the `file` or `file_url` document the field should be attached to.'
7863
+ type: integer
7864
+ api_id:
7865
+ description: 'An identifier for the field that is unique across all documents in the request.'
7866
+ type: string
7867
+ height:
7868
+ description: 'Size of the field in pixels.'
7869
+ type: integer
7870
+ name:
7871
+ description: 'Display name for the field.'
7872
+ type: string
7873
+ page:
7874
+ description: |-
7875
+ Page in the document where the field should be placed (requires documents be PDF files).
7876
+
7877
+ - When the page number parameter is supplied, the API will use the new coordinate system.
7878
+ - Check out the differences between both [coordinate systems](https://faq.hellosign.com/hc/en-us/articles/217115577) and how to use them.
7879
+ type: integer
7880
+ nullable: true
7881
+ required:
7882
+ description: 'Whether this field is required.'
7883
+ type: boolean
7884
+ signer:
7885
+ description: |-
7886
+ Signer index identified by the offset in the signers parameter (0-based indexing), indicating which signer should fill out the field.
7887
+
7888
+ **NOTE**: To set the value of the field as the preparer you must set this to `me_now`
7594
7889
 
7595
7890
  **NOTE**: If type is `text-merge` or `checkbox-merge`, you must set this to sender in order to use pre-filled data.
7596
7891
  type: string
@@ -7849,7 +8144,7 @@ components:
7849
8144
  description: |-
7850
8145
  An array of elements and values serialized to a string, to be used to customize the app's signer page. (Only applies to some API plans)
7851
8146
 
7852
- Take a look at our [white labeling guide](/api/reference/white-labeling/) to learn more.
8147
+ Take a look at our [white labeling guide](https://developers.hellosign.com/api/reference/premium-branding/) to learn more.
7853
8148
  properties:
7854
8149
  header_background_color:
7855
8150
  type: string
@@ -7926,7 +8221,6 @@ components:
7926
8221
  - Developer
7927
8222
  - 'Team Manager'
7928
8223
  - Admin
7929
- x-beta: closed
7930
8224
  type: object
7931
8225
  TeamCreateRequest:
7932
8226
  properties:
@@ -7960,7 +8254,6 @@ components:
7960
8254
  new_team_id:
7961
8255
  description: 'Id of the new Team.'
7962
8256
  type: string
7963
- x-beta: closed
7964
8257
  new_role:
7965
8258
  description: |-
7966
8259
  A new role member will take in a new Team.
@@ -7972,7 +8265,6 @@ components:
7972
8265
  - Developer
7973
8266
  - 'Team Manager'
7974
8267
  - Admin
7975
- x-beta: closed
7976
8268
  type: object
7977
8269
  TeamUpdateRequest:
7978
8270
  properties:
@@ -7987,14 +8279,127 @@ components:
7987
8279
  The id of the Account to give access to the Template.
7988
8280
  <b>Note</b> The account id prevails if email address is also provided.
7989
8281
  type: string
7990
- email_address:
7991
- description: |-
7992
- The email address of the Account to give access to the Template.
7993
- <b>Note</b> The account id prevails if it is also provided.
8282
+ email_address:
8283
+ description: |-
8284
+ The email address of the Account to give access to the Template.
8285
+ <b>Note</b> The account id prevails if it is also provided.
8286
+ type: string
8287
+ format: email
8288
+ skip_notification:
8289
+ description: 'If set to `true`, the user does not receive an email notification when a template has been shared with them. Defaults to `false`.'
8290
+ type: boolean
8291
+ default: false
8292
+ type: object
8293
+ TemplateCreateRequest:
8294
+ required:
8295
+ - signer_roles
8296
+ - form_fields_per_document
8297
+ properties:
8298
+ files:
8299
+ description: |-
8300
+ Use `files[]` to indicate the uploaded file(s) to send for signature.
8301
+
8302
+ This endpoint requires either **files** or **file_urls[]**, but not both.
8303
+ type: array
8304
+ items:
8305
+ type: string
8306
+ format: binary
8307
+ file_urls:
8308
+ description: |-
8309
+ Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.
8310
+
8311
+ This endpoint requires either **files** or **file_urls[]**, but not both.
8312
+ type: array
8313
+ items:
8314
+ type: string
8315
+ allow_reassign:
8316
+ description: |-
8317
+ Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.
8318
+
8319
+ **Note**: Only available for Premium plan and higher.
8320
+ type: boolean
8321
+ default: false
8322
+ attachments:
8323
+ description: 'A list describing the attachments'
8324
+ type: array
8325
+ items:
8326
+ $ref: '#/components/schemas/SubAttachment'
8327
+ cc_roles:
8328
+ description: 'The CC roles that must be assigned when using the template to send a signature request'
8329
+ type: array
8330
+ items:
8331
+ type: string
8332
+ client_id:
8333
+ description: 'Client id of the app you''re using to create this draft. Used to apply the branding and callback url defined for the app.'
8334
+ type: string
8335
+ field_options:
8336
+ $ref: '#/components/schemas/SubFieldOptions'
8337
+ form_field_groups:
8338
+ description: 'Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`.'
8339
+ type: array
8340
+ items:
8341
+ $ref: '#/components/schemas/SubFormFieldGroup'
8342
+ form_field_rules:
8343
+ description: 'Conditional Logic rules for fields defined in `form_fields_per_document`.'
8344
+ type: array
8345
+ items:
8346
+ $ref: '#/components/schemas/SubFormFieldRule'
8347
+ form_fields_per_document:
8348
+ description: |-
8349
+ The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)
8350
+
8351
+ **NOTE**: Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.
8352
+
8353
+ * Text Field use `SubFormFieldsPerDocumentText`
8354
+ * Dropdown Field use `SubFormFieldsPerDocumentDropdown`
8355
+ * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`
8356
+ * Checkbox Field use `SubFormFieldsPerDocumentCheckbox`
8357
+ * Radio Field use `SubFormFieldsPerDocumentRadio`
8358
+ * Signature Field use `SubFormFieldsPerDocumentSignature`
8359
+ * Date Signed Field use `SubFormFieldsPerDocumentDateSigned`
8360
+ * Initials Field use `SubFormFieldsPerDocumentInitials`
8361
+ * Text Merge Field use `SubFormFieldsPerDocumentTextMerge`
8362
+ * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge`
8363
+ type: array
8364
+ items:
8365
+ $ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
8366
+ merge_fields:
8367
+ description: |-
8368
+ Add merge fields to the template. Merge fields are placed by the user creating the template and used to pre-fill data by passing values into signature requests with the `custom_fields` parameter.
8369
+ If the signature request using that template *does not* pass a value into a merge field, then an empty field remains in the document.
8370
+ type: array
8371
+ items:
8372
+ $ref: '#/components/schemas/SubMergeField'
8373
+ message:
8374
+ description: 'The default template email message.'
8375
+ type: string
8376
+ maxLength: 5000
8377
+ metadata:
8378
+ description: |-
8379
+ Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.
8380
+
8381
+ Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long.
8382
+ type: object
8383
+ maxItems: 10
8384
+ additionalProperties: {}
8385
+ signer_roles:
8386
+ description: 'An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template.'
8387
+ type: array
8388
+ items:
8389
+ $ref: '#/components/schemas/SubTemplateRole'
8390
+ subject:
8391
+ description: 'The template title (alias).'
8392
+ type: string
8393
+ maxLength: 200
8394
+ test_mode:
8395
+ description: 'Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`.'
8396
+ type: boolean
8397
+ default: false
8398
+ title:
8399
+ description: 'The title you want to assign to the SignatureRequest.'
7994
8400
  type: string
7995
- format: email
7996
- skip_notification:
7997
- description: 'If set to `true`, the user does not receive an email notification when a template has been shared with them. Defaults to `false`.'
8401
+ use_preexisting_fields:
8402
+ description: 'Enable the detection of predefined PDF fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`).'
7998
8403
  type: boolean
7999
8404
  default: false
8000
8405
  type: object
@@ -8067,7 +8472,7 @@ components:
8067
8472
  $ref: '#/components/schemas/SubFormFieldRule'
8068
8473
  form_fields_per_document:
8069
8474
  description: |-
8070
- The fields that should appear on the document, expressed as an array of objects. (We're currently fixing a bug where this property only accepts a two-dimensional array. You can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)
8475
+ 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).)
8071
8476
 
8072
8477
  **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.
8073
8478
 
@@ -8249,7 +8654,7 @@ components:
8249
8654
  $ref: '#/components/schemas/SubFormFieldRule'
8250
8655
  form_fields_per_document:
8251
8656
  description: |-
8252
- The fields that should appear on the document, expressed as an array of objects. (We're currently fixing a bug where this property only accepts a two-dimensional array. You can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)
8657
+ 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).)
8253
8658
 
8254
8659
  **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.
8255
8660
 
@@ -8325,7 +8730,6 @@ components:
8325
8730
  **Note**: This does not correspond to the **expires_at** returned in the response.
8326
8731
  type: integer
8327
8732
  nullable: true
8328
- x-beta: closed
8329
8733
  type: object
8330
8734
  UnclaimedDraftCreateEmbeddedRequest:
8331
8735
  description: ''
@@ -8413,7 +8817,7 @@ components:
8413
8817
  $ref: '#/components/schemas/SubFormFieldRule'
8414
8818
  form_fields_per_document:
8415
8819
  description: |-
8416
- The fields that should appear on the document, expressed as an array of objects. (We're currently fixing a bug where this property only accepts a two-dimensional array. You can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)
8820
+ 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).)
8417
8821
 
8418
8822
  **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.
8419
8823
 
@@ -8523,7 +8927,6 @@ components:
8523
8927
  **Note**: This does not correspond to the **expires_at** returned in the response.
8524
8928
  type: integer
8525
8929
  nullable: true
8526
- x-beta: closed
8527
8930
  type: object
8528
8931
  UnclaimedDraftCreateEmbeddedWithTemplateRequest:
8529
8932
  required:
@@ -8637,72 +9040,277 @@ components:
8637
9040
  description: 'Add Signers to your Templated-based Signature Request.'
8638
9041
  type: array
8639
9042
  items:
8640
- $ref: '#/components/schemas/SubUnclaimedDraftTemplateSigner'
8641
- signing_options:
8642
- $ref: '#/components/schemas/SubSigningOptions'
8643
- signing_redirect_url:
8644
- description: 'The URL you want signers redirected to after they successfully sign.'
8645
- type: string
8646
- skip_me_now:
8647
- description: 'Disables the "Me (Now)" option for the person preparing the document. Does not work with type `send_document`. Defaults to `false`.'
8648
- type: boolean
8649
- default: false
8650
- subject:
8651
- description: 'The subject in the email that will be sent to the signers.'
8652
- type: string
8653
- maxLength: 255
8654
- template_ids:
8655
- description: 'Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the templates will be used.'
9043
+ $ref: '#/components/schemas/SubUnclaimedDraftTemplateSigner'
9044
+ signing_options:
9045
+ $ref: '#/components/schemas/SubSigningOptions'
9046
+ signing_redirect_url:
9047
+ description: 'The URL you want signers redirected to after they successfully sign.'
9048
+ type: string
9049
+ skip_me_now:
9050
+ description: 'Disables the "Me (Now)" option for the person preparing the document. Does not work with type `send_document`. Defaults to `false`.'
9051
+ type: boolean
9052
+ default: false
9053
+ subject:
9054
+ description: 'The subject in the email that will be sent to the signers.'
9055
+ type: string
9056
+ maxLength: 255
9057
+ template_ids:
9058
+ description: 'Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the templates will be used.'
9059
+ type: array
9060
+ items:
9061
+ type: string
9062
+ test_mode:
9063
+ 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`.'
9064
+ type: boolean
9065
+ default: false
9066
+ title:
9067
+ description: 'The title you want to assign to the SignatureRequest.'
9068
+ type: string
9069
+ maxLength: 255
9070
+ populate_auto_fill_fields:
9071
+ description: |-
9072
+ 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.
9073
+
9074
+ ⚠️ **Note** ⚠️: Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature.
9075
+ type: boolean
9076
+ default: false
9077
+ type: object
9078
+ UnclaimedDraftEditAndResendRequest:
9079
+ required:
9080
+ - client_id
9081
+ properties:
9082
+ client_id:
9083
+ description: 'Client id of the app used to create the draft. Used to apply the branding and callback url defined for the app.'
9084
+ type: string
9085
+ editor_options:
9086
+ $ref: '#/components/schemas/SubEditorOptions'
9087
+ is_for_embedded_signing:
9088
+ description: 'The request created from this draft will also be signable in embedded mode if set to `true`.'
9089
+ type: boolean
9090
+ requester_email_address:
9091
+ description: 'The email address of the user that should be designated as the requester of this draft. If not set, original requester''s email address will be used.'
9092
+ type: string
9093
+ format: email
9094
+ requesting_redirect_url:
9095
+ description: 'The URL you want signers redirected to after they successfully request a signature.'
9096
+ type: string
9097
+ show_progress_stepper:
9098
+ description: 'When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden.'
9099
+ type: boolean
9100
+ default: true
9101
+ signing_redirect_url:
9102
+ description: 'The URL you want signers redirected to after they successfully sign.'
9103
+ type: string
9104
+ test_mode:
9105
+ 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`.'
9106
+ type: boolean
9107
+ default: false
9108
+ type: object
9109
+ AccountCreateResponse:
9110
+ properties:
9111
+ account:
9112
+ $ref: '#/components/schemas/AccountResponse'
9113
+ oauth_data:
9114
+ $ref: '#/components/schemas/OAuthTokenResponse'
9115
+ warnings:
9116
+ description: 'A list of warnings.'
9117
+ type: array
9118
+ items:
9119
+ $ref: '#/components/schemas/WarningResponse'
9120
+ type: object
9121
+ x-internal: true
9122
+ AccountGetResponse:
9123
+ properties:
9124
+ account:
9125
+ $ref: '#/components/schemas/AccountResponse'
9126
+ warnings:
9127
+ description: 'A list of warnings.'
9128
+ type: array
9129
+ items:
9130
+ $ref: '#/components/schemas/WarningResponse'
9131
+ type: object
9132
+ x-internal: true
9133
+ AccountVerifyResponse:
9134
+ properties:
9135
+ account:
9136
+ $ref: '#/components/schemas/AccountVerifyResponseAccount'
9137
+ warnings:
9138
+ description: 'A list of warnings.'
9139
+ type: array
9140
+ items:
9141
+ $ref: '#/components/schemas/WarningResponse'
9142
+ type: object
9143
+ x-internal: true
9144
+ ApiAppGetResponse:
9145
+ properties:
9146
+ api_app:
9147
+ $ref: '#/components/schemas/ApiAppResponse'
9148
+ warnings:
9149
+ description: 'A list of warnings.'
9150
+ type: array
9151
+ items:
9152
+ $ref: '#/components/schemas/WarningResponse'
9153
+ type: object
9154
+ x-internal: true
9155
+ ApiAppListResponse:
9156
+ properties:
9157
+ api_apps:
9158
+ description: 'Contains information about API Apps.'
9159
+ type: array
9160
+ items:
9161
+ $ref: '#/components/schemas/ApiAppResponse'
9162
+ list_info:
9163
+ $ref: '#/components/schemas/ListInfoResponse'
9164
+ warnings:
9165
+ description: 'A list of warnings.'
9166
+ type: array
9167
+ items:
9168
+ $ref: '#/components/schemas/WarningResponse'
9169
+ type: object
9170
+ x-internal: true
9171
+ BulkSendJobGetResponse:
9172
+ properties:
9173
+ bulk_send_job:
9174
+ $ref: '#/components/schemas/BulkSendJobResponse'
9175
+ list_info:
9176
+ $ref: '#/components/schemas/ListInfoResponse'
9177
+ signature_requests:
9178
+ description: 'Contains information about the Signature Requests sent in bulk.'
9179
+ type: array
9180
+ items:
9181
+ $ref: '#/components/schemas/BulkSendJobGetResponseSignatureRequests'
9182
+ warnings:
9183
+ description: 'A list of warnings.'
9184
+ type: array
9185
+ items:
9186
+ $ref: '#/components/schemas/WarningResponse'
9187
+ type: object
9188
+ x-internal: true
9189
+ BulkSendJobListResponse:
9190
+ properties:
9191
+ bulk_send_jobs:
9192
+ description: 'Contains a list of BulkSendJobs that the API caller has access to.'
9193
+ type: array
9194
+ items:
9195
+ $ref: '#/components/schemas/BulkSendJobResponse'
9196
+ list_info:
9197
+ $ref: '#/components/schemas/ListInfoResponse'
9198
+ warnings:
9199
+ description: 'A list of warnings.'
9200
+ type: array
9201
+ items:
9202
+ $ref: '#/components/schemas/WarningResponse'
9203
+ type: object
9204
+ x-internal: true
9205
+ BulkSendJobSendResponse:
9206
+ properties:
9207
+ bulk_send_job:
9208
+ $ref: '#/components/schemas/BulkSendJobResponse'
9209
+ warnings:
9210
+ description: 'A list of warnings.'
9211
+ type: array
9212
+ items:
9213
+ $ref: '#/components/schemas/WarningResponse'
9214
+ type: object
9215
+ x-internal: true
9216
+ EmbeddedEditUrlResponse:
9217
+ properties:
9218
+ embedded:
9219
+ $ref: '#/components/schemas/EmbeddedEditUrlResponseEmbedded'
9220
+ warnings:
9221
+ description: 'A list of warnings.'
9222
+ type: array
9223
+ items:
9224
+ $ref: '#/components/schemas/WarningResponse'
9225
+ type: object
9226
+ x-internal: true
9227
+ EmbeddedSignUrlResponse:
9228
+ properties:
9229
+ embedded:
9230
+ $ref: '#/components/schemas/EmbeddedSignUrlResponseEmbedded'
9231
+ warnings:
9232
+ description: 'A list of warnings.'
9233
+ type: array
9234
+ items:
9235
+ $ref: '#/components/schemas/WarningResponse'
9236
+ type: object
9237
+ x-internal: true
9238
+ ErrorResponse:
9239
+ required:
9240
+ - error
9241
+ properties:
9242
+ error:
9243
+ $ref: '#/components/schemas/ErrorResponseError'
9244
+ type: object
9245
+ EventCallbackRequest:
9246
+ title: EventCallbackRequest
9247
+ required:
9248
+ - event
9249
+ properties:
9250
+ event:
9251
+ $ref: '#/components/schemas/EventCallbackRequestEvent'
9252
+ account:
9253
+ $ref: '#/components/schemas/AccountResponse'
9254
+ signature_request:
9255
+ $ref: '#/components/schemas/SignatureRequestResponse'
9256
+ template:
9257
+ $ref: '#/components/schemas/TemplateResponse'
9258
+ type: object
9259
+ FileResponse:
9260
+ properties:
9261
+ file_url:
9262
+ description: 'URL to the file.'
9263
+ type: string
9264
+ expires_at:
9265
+ description: 'When the link expires.'
9266
+ type: integer
9267
+ type: object
9268
+ x-internal: true
9269
+ FileResponseDataUri:
9270
+ properties:
9271
+ data_uri:
9272
+ description: 'File as base64 encoded string.'
9273
+ type: string
9274
+ type: object
9275
+ x-internal: true
9276
+ ReportCreateResponse:
9277
+ properties:
9278
+ report:
9279
+ $ref: '#/components/schemas/ReportResponse'
9280
+ warnings:
9281
+ description: 'A list of warnings.'
9282
+ type: array
9283
+ items:
9284
+ $ref: '#/components/schemas/WarningResponse'
9285
+ type: object
9286
+ x-internal: true
9287
+ SignatureRequestGetResponse:
9288
+ properties:
9289
+ signature_request:
9290
+ $ref: '#/components/schemas/SignatureRequestResponse'
9291
+ warnings:
9292
+ description: 'A list of warnings.'
8656
9293
  type: array
8657
9294
  items:
8658
- type: string
8659
- test_mode:
8660
- 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`.'
8661
- type: boolean
8662
- default: false
8663
- title:
8664
- description: 'The title you want to assign to the SignatureRequest.'
8665
- type: string
8666
- maxLength: 255
8667
- populate_auto_fill_fields:
8668
- description: |-
8669
- 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.
8670
-
8671
- ⚠️ **Note** ⚠️: Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature.
8672
- type: boolean
8673
- default: false
9295
+ $ref: '#/components/schemas/WarningResponse'
8674
9296
  type: object
8675
- UnclaimedDraftEditAndResendRequest:
8676
- required:
8677
- - client_id
9297
+ x-internal: true
9298
+ SignatureRequestListResponse:
8678
9299
  properties:
8679
- client_id:
8680
- description: 'Client id of the app used to create the draft. Used to apply the branding and callback url defined for the app.'
8681
- type: string
8682
- editor_options:
8683
- $ref: '#/components/schemas/SubEditorOptions'
8684
- is_for_embedded_signing:
8685
- description: 'The request created from this draft will also be signable in embedded mode if set to `true`.'
8686
- type: boolean
8687
- requester_email_address:
8688
- description: 'The email address of the user that should be designated as the requester of this draft. If not set, original requester''s email address will be used.'
8689
- type: string
8690
- format: email
8691
- requesting_redirect_url:
8692
- description: 'The URL you want signers redirected to after they successfully request a signature.'
8693
- type: string
8694
- show_progress_stepper:
8695
- description: 'When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden.'
8696
- type: boolean
8697
- default: true
8698
- signing_redirect_url:
8699
- description: 'The URL you want signers redirected to after they successfully sign.'
8700
- type: string
8701
- test_mode:
8702
- 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`.'
8703
- type: boolean
8704
- default: false
9300
+ signature_requests:
9301
+ description: 'Contains information about signature requests.'
9302
+ type: array
9303
+ items:
9304
+ $ref: '#/components/schemas/SignatureRequestResponse'
9305
+ list_info:
9306
+ $ref: '#/components/schemas/ListInfoResponse'
9307
+ warnings:
9308
+ description: 'A list of warnings.'
9309
+ type: array
9310
+ items:
9311
+ $ref: '#/components/schemas/WarningResponse'
8705
9312
  type: object
9313
+ x-internal: true
8706
9314
  AccountResponse:
8707
9315
  properties:
8708
9316
  account_id:
@@ -8740,46 +9348,20 @@ components:
8740
9348
  nullable: true
8741
9349
  type: object
8742
9350
  x-internal: true
8743
- AccountCreateResponse:
8744
- properties:
8745
- account:
8746
- $ref: '#/components/schemas/AccountResponse'
8747
- oauth_data:
8748
- $ref: '#/components/schemas/OAuthTokenResponse'
8749
- warnings:
8750
- description: 'A list of warnings.'
8751
- type: array
8752
- items:
8753
- $ref: '#/components/schemas/WarningResponse'
8754
- type: object
8755
- x-internal: true
8756
- AccountGetResponse:
8757
- properties:
8758
- account:
8759
- $ref: '#/components/schemas/AccountResponse'
8760
- warnings:
8761
- description: 'A list of warnings.'
8762
- type: array
8763
- items:
8764
- $ref: '#/components/schemas/WarningResponse'
8765
- type: object
8766
- x-internal: true
8767
- AccountVerifyResponse:
8768
- properties:
8769
- account:
8770
- $ref: '#/components/schemas/AccountVerifyResponseAccount'
8771
- warnings:
8772
- description: 'A list of warnings.'
8773
- type: array
8774
- items:
8775
- $ref: '#/components/schemas/WarningResponse'
8776
- type: object
8777
- x-internal: true
8778
- AccountVerifyResponseAccount:
9351
+ OAuthTokenResponse:
8779
9352
  properties:
8780
- email_address:
8781
- description: 'The email address associated with the Account.'
9353
+ access_token:
9354
+ type: string
9355
+ token_type:
9356
+ type: string
9357
+ refresh_token:
9358
+ type: string
9359
+ expires_in:
9360
+ description: 'Number of seconds until the `access_token` expires. Uses epoch time.'
9361
+ type: integer
9362
+ state:
8782
9363
  type: string
9364
+ nullable: true
8783
9365
  type: object
8784
9366
  x-internal: true
8785
9367
  AccountResponseQuotas:
@@ -8807,6 +9389,13 @@ components:
8807
9389
  nullable: true
8808
9390
  type: object
8809
9391
  x-internal: true
9392
+ AccountVerifyResponseAccount:
9393
+ properties:
9394
+ email_address:
9395
+ description: 'The email address associated with the Account.'
9396
+ type: string
9397
+ type: object
9398
+ x-internal: true
8810
9399
  ApiAppResponse:
8811
9400
  description: 'Contains information about an API App.'
8812
9401
  properties:
@@ -8841,33 +9430,6 @@ components:
8841
9430
  $ref: '#/components/schemas/ApiAppResponseWhiteLabelingOptions'
8842
9431
  type: object
8843
9432
  x-internal: true
8844
- ApiAppGetResponse:
8845
- properties:
8846
- api_app:
8847
- $ref: '#/components/schemas/ApiAppResponse'
8848
- warnings:
8849
- description: 'A list of warnings.'
8850
- type: array
8851
- items:
8852
- $ref: '#/components/schemas/WarningResponse'
8853
- type: object
8854
- x-internal: true
8855
- ApiAppListResponse:
8856
- properties:
8857
- api_apps:
8858
- description: 'Contains information about API Apps.'
8859
- type: array
8860
- items:
8861
- $ref: '#/components/schemas/ApiAppResponse'
8862
- list_info:
8863
- $ref: '#/components/schemas/ListInfoResponse'
8864
- warnings:
8865
- description: 'A list of warnings.'
8866
- type: array
8867
- items:
8868
- $ref: '#/components/schemas/WarningResponse'
8869
- type: object
8870
- x-internal: true
8871
9433
  ApiAppResponseOAuth:
8872
9434
  description: 'An object describing the app''s OAuth properties, or null if OAuth is not configured for the app.'
8873
9435
  properties:
@@ -8960,24 +9522,6 @@ components:
8960
9522
  type: integer
8961
9523
  type: object
8962
9524
  x-internal: true
8963
- BulkSendJobGetResponse:
8964
- properties:
8965
- bulk_send_job:
8966
- $ref: '#/components/schemas/BulkSendJobResponse'
8967
- list_info:
8968
- $ref: '#/components/schemas/ListInfoResponse'
8969
- signature_requests:
8970
- description: 'Contains information about the Signature Requests sent in bulk.'
8971
- type: array
8972
- items:
8973
- $ref: '#/components/schemas/BulkSendJobGetResponseSignatureRequests'
8974
- warnings:
8975
- description: 'A list of warnings.'
8976
- type: array
8977
- items:
8978
- $ref: '#/components/schemas/WarningResponse'
8979
- type: object
8980
- x-internal: true
8981
9525
  BulkSendJobGetResponseSignatureRequests:
8982
9526
  title: BulkSendJobGetResponseSignatureRequests
8983
9527
  type: object
@@ -8990,44 +9534,6 @@ components:
8990
9534
  description: 'The id of the BulkSendJob.'
8991
9535
  type: string
8992
9536
  x-internal: true
8993
- BulkSendJobListResponse:
8994
- properties:
8995
- bulk_send_jobs:
8996
- description: 'Contains a list of BulkSendJobs that the API caller has access to.'
8997
- type: array
8998
- items:
8999
- $ref: '#/components/schemas/BulkSendJobResponse'
9000
- list_info:
9001
- $ref: '#/components/schemas/ListInfoResponse'
9002
- warnings:
9003
- description: 'A list of warnings.'
9004
- type: array
9005
- items:
9006
- $ref: '#/components/schemas/WarningResponse'
9007
- type: object
9008
- x-internal: true
9009
- BulkSendJobSendResponse:
9010
- properties:
9011
- bulk_send_job:
9012
- $ref: '#/components/schemas/BulkSendJobResponse'
9013
- warnings:
9014
- description: 'A list of warnings.'
9015
- type: array
9016
- items:
9017
- $ref: '#/components/schemas/WarningResponse'
9018
- type: object
9019
- x-internal: true
9020
- EmbeddedEditUrlResponse:
9021
- properties:
9022
- embedded:
9023
- $ref: '#/components/schemas/EmbeddedEditUrlResponseEmbedded'
9024
- warnings:
9025
- description: 'A list of warnings.'
9026
- type: array
9027
- items:
9028
- $ref: '#/components/schemas/WarningResponse'
9029
- type: object
9030
- x-internal: true
9031
9537
  EmbeddedEditUrlResponseEmbedded:
9032
9538
  description: 'An embedded template object.'
9033
9539
  properties:
@@ -9039,17 +9545,6 @@ components:
9039
9545
  type: integer
9040
9546
  type: object
9041
9547
  x-internal: true
9042
- EmbeddedSignUrlResponse:
9043
- properties:
9044
- embedded:
9045
- $ref: '#/components/schemas/EmbeddedSignUrlResponseEmbedded'
9046
- warnings:
9047
- description: 'A list of warnings.'
9048
- type: array
9049
- items:
9050
- $ref: '#/components/schemas/WarningResponse'
9051
- type: object
9052
- x-internal: true
9053
9548
  EmbeddedSignUrlResponseEmbedded:
9054
9549
  description: 'An object that contains necessary information to set up embedded signing.'
9055
9550
  properties:
@@ -9058,16 +9553,9 @@ components:
9058
9553
  type: string
9059
9554
  expires_at:
9060
9555
  description: 'The specific time that the the `sign_url` link expires, in epoch.'
9061
- type: integer
9062
- type: object
9063
- x-internal: true
9064
- ErrorResponse:
9065
- required:
9066
- - error
9067
- properties:
9068
- error:
9069
- $ref: '#/components/schemas/ErrorResponseError'
9556
+ type: integer
9070
9557
  type: object
9558
+ x-internal: true
9071
9559
  ErrorResponseError:
9072
9560
  description: 'Contains information about an error that occurred.'
9073
9561
  required:
@@ -9084,20 +9572,6 @@ components:
9084
9572
  description: 'Name of the error.'
9085
9573
  type: string
9086
9574
  type: object
9087
- EventCallbackRequest:
9088
- title: EventCallbackRequest
9089
- required:
9090
- - event
9091
- properties:
9092
- event:
9093
- $ref: '#/components/schemas/EventCallbackRequestEvent'
9094
- account:
9095
- $ref: '#/components/schemas/AccountResponse'
9096
- signature_request:
9097
- $ref: '#/components/schemas/SignatureRequestResponse'
9098
- template:
9099
- $ref: '#/components/schemas/TemplateResponse'
9100
- type: object
9101
9575
  EventCallbackRequestEvent:
9102
9576
  description: 'Basic information about the event that occurred.'
9103
9577
  required:
@@ -9161,23 +9635,6 @@ components:
9161
9635
  type: string
9162
9636
  nullable: true
9163
9637
  type: object
9164
- FileResponse:
9165
- properties:
9166
- file_url:
9167
- description: 'URL to the file.'
9168
- type: string
9169
- expires_at:
9170
- description: 'When the link expires.'
9171
- type: integer
9172
- type: object
9173
- x-internal: true
9174
- FileResponseDataUri:
9175
- properties:
9176
- data_uri:
9177
- description: 'File as base64 encoded string.'
9178
- type: string
9179
- type: object
9180
- x-internal: true
9181
9638
  ListInfoResponse:
9182
9639
  description: 'Contains pagination information about the data returned.'
9183
9640
  properties:
@@ -9196,169 +9653,6 @@ components:
9196
9653
  type: integer
9197
9654
  type: object
9198
9655
  x-internal: true
9199
- SignatureRequestResponseDataTypeEnum:
9200
- type: string
9201
- enum:
9202
- - text
9203
- - checkbox
9204
- - date_signed
9205
- - dropdown
9206
- - initials
9207
- - radio
9208
- - signature
9209
- - text-merge
9210
- - checkbox-merge
9211
- SignatureRequestResponseDataValueText:
9212
- type: object
9213
- allOf:
9214
- -
9215
- $ref: '#/components/schemas/SignatureRequestResponseDataBase'
9216
- -
9217
- properties:
9218
- type:
9219
- description: 'A text input field'
9220
- type: string
9221
- default: text
9222
- value:
9223
- description: 'The value of the form field.'
9224
- type: string
9225
- type: object
9226
- SignatureRequestResponseDataValueDropdown:
9227
- type: object
9228
- allOf:
9229
- -
9230
- $ref: '#/components/schemas/SignatureRequestResponseDataBase'
9231
- -
9232
- properties:
9233
- type:
9234
- description: 'An input field for dropdowns'
9235
- type: string
9236
- default: dropdown
9237
- value:
9238
- description: 'The value of the form field.'
9239
- type: string
9240
- type: object
9241
- SignatureRequestResponseDataValueRadio:
9242
- type: object
9243
- allOf:
9244
- -
9245
- $ref: '#/components/schemas/SignatureRequestResponseDataBase'
9246
- -
9247
- properties:
9248
- type:
9249
- description: 'An input field for radios'
9250
- type: string
9251
- default: radio
9252
- value:
9253
- description: 'The value of the form field.'
9254
- type: boolean
9255
- type: object
9256
- SignatureRequestResponseDataValueDateSigned:
9257
- type: object
9258
- allOf:
9259
- -
9260
- $ref: '#/components/schemas/SignatureRequestResponseDataBase'
9261
- -
9262
- properties:
9263
- type:
9264
- description: 'A date'
9265
- type: string
9266
- default: date_signed
9267
- value:
9268
- description: 'The value of the form field.'
9269
- type: string
9270
- type: object
9271
- SignatureRequestResponseDataValueInitials:
9272
- type: object
9273
- allOf:
9274
- -
9275
- $ref: '#/components/schemas/SignatureRequestResponseDataBase'
9276
- -
9277
- properties:
9278
- type:
9279
- description: 'An input field for initials'
9280
- type: string
9281
- default: initials
9282
- value:
9283
- description: 'The value of the form field.'
9284
- type: string
9285
- type: object
9286
- SignatureRequestResponseDataValueCheckbox:
9287
- type: object
9288
- allOf:
9289
- -
9290
- $ref: '#/components/schemas/SignatureRequestResponseDataBase'
9291
- -
9292
- properties:
9293
- type:
9294
- description: 'A yes/no checkbox'
9295
- type: string
9296
- default: checkbox
9297
- value:
9298
- description: 'The value of the form field.'
9299
- type: boolean
9300
- type: object
9301
- SignatureRequestResponseDataValueSignature:
9302
- type: object
9303
- allOf:
9304
- -
9305
- $ref: '#/components/schemas/SignatureRequestResponseDataBase'
9306
- -
9307
- properties:
9308
- type:
9309
- description: 'A signature input field'
9310
- type: string
9311
- default: signature
9312
- value:
9313
- description: 'The value of the form field.'
9314
- type: string
9315
- type: object
9316
- SignatureRequestResponseDataValueTextMerge:
9317
- type: object
9318
- allOf:
9319
- -
9320
- $ref: '#/components/schemas/SignatureRequestResponseDataBase'
9321
- -
9322
- properties:
9323
- type:
9324
- description: 'A text field that has default text set by the api'
9325
- type: string
9326
- default: text-merge
9327
- value:
9328
- description: 'The value of the form field.'
9329
- type: string
9330
- type: object
9331
- SignatureRequestResponseDataValueCheckboxMerge:
9332
- type: object
9333
- allOf:
9334
- -
9335
- $ref: '#/components/schemas/SignatureRequestResponseDataBase'
9336
- -
9337
- properties:
9338
- type:
9339
- description: 'A checkbox field that has default value set by the api'
9340
- type: string
9341
- default: checkbox-merge
9342
- value:
9343
- description: 'The value of the form field.'
9344
- type: string
9345
- type: object
9346
- OAuthTokenResponse:
9347
- properties:
9348
- access_token:
9349
- type: string
9350
- token_type:
9351
- type: string
9352
- refresh_token:
9353
- type: string
9354
- expires_in:
9355
- description: 'Number of seconds until the `access_token` expires. Uses epoch time.'
9356
- type: integer
9357
- state:
9358
- type: string
9359
- nullable: true
9360
- type: object
9361
- x-internal: true
9362
9656
  ReportResponse:
9363
9657
  description: 'Contains information about the report request.'
9364
9658
  properties:
@@ -9380,17 +9674,6 @@ components:
9380
9674
  - document_status
9381
9675
  type: object
9382
9676
  x-internal: true
9383
- ReportCreateResponse:
9384
- properties:
9385
- report:
9386
- $ref: '#/components/schemas/ReportResponse'
9387
- warnings:
9388
- description: 'A list of warnings.'
9389
- type: array
9390
- items:
9391
- $ref: '#/components/schemas/WarningResponse'
9392
- type: object
9393
- x-internal: true
9394
9677
  SignatureRequestResponse:
9395
9678
  description: 'Contains information about a signature request.'
9396
9679
  properties:
@@ -9428,7 +9711,6 @@ components:
9428
9711
  expires_at:
9429
9712
  description: 'The time when the signature request will expire unsigned signatures. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details.'
9430
9713
  type: integer
9431
- x-beta: closed
9432
9714
  is_complete:
9433
9715
  description: 'Whether or not the SignatureRequest has been fully executed by all signers.'
9434
9716
  type: boolean
@@ -9492,33 +9774,6 @@ components:
9492
9774
  $ref: '#/components/schemas/SignatureRequestResponseSignatures'
9493
9775
  type: object
9494
9776
  x-internal: true
9495
- SignatureRequestGetResponse:
9496
- properties:
9497
- signature_request:
9498
- $ref: '#/components/schemas/SignatureRequestResponse'
9499
- warnings:
9500
- description: 'A list of warnings.'
9501
- type: array
9502
- items:
9503
- $ref: '#/components/schemas/WarningResponse'
9504
- type: object
9505
- x-internal: true
9506
- SignatureRequestListResponse:
9507
- properties:
9508
- signature_requests:
9509
- description: 'Contains information about signature requests.'
9510
- type: array
9511
- items:
9512
- $ref: '#/components/schemas/SignatureRequestResponse'
9513
- list_info:
9514
- $ref: '#/components/schemas/ListInfoResponse'
9515
- warnings:
9516
- description: 'A list of warnings.'
9517
- type: array
9518
- items:
9519
- $ref: '#/components/schemas/WarningResponse'
9520
- type: object
9521
- x-internal: true
9522
9777
  SignatureRequestResponseAttachment:
9523
9778
  description: 'Signer attachments.'
9524
9779
  required:
@@ -9549,11 +9804,6 @@ components:
9549
9804
  nullable: true
9550
9805
  type: object
9551
9806
  x-internal: true
9552
- SignatureRequestResponseCustomFieldTypeEnum:
9553
- type: string
9554
- enum:
9555
- - text
9556
- - checkbox
9557
9807
  SignatureRequestResponseCustomFieldBase:
9558
9808
  description: |-
9559
9809
  An array of Custom Field objects containing the name and type of each custom field.
@@ -9587,44 +9837,45 @@ components:
9587
9837
  checkbox: '#/components/schemas/SignatureRequestResponseCustomFieldCheckbox'
9588
9838
  x-internal: true
9589
9839
  x-base-class: true
9590
- SignatureRequestResponseCustomFieldText:
9840
+ SignatureRequestResponseCustomFieldCheckbox:
9591
9841
  description: 'This class extends `SignatureRequestResponseCustomFieldBase`.'
9842
+ required:
9843
+ - type
9592
9844
  type: object
9593
9845
  allOf:
9594
9846
  -
9595
9847
  $ref: '#/components/schemas/SignatureRequestResponseCustomFieldBase'
9596
9848
  -
9597
- required:
9598
- - type
9599
- - options
9600
9849
  properties:
9601
9850
  type:
9602
9851
  description: 'The type of this Custom Field. Only ''text'' and ''checkbox'' are currently supported.'
9603
9852
  type: string
9604
- default: text
9853
+ default: checkbox
9605
9854
  value:
9606
- description: 'A text string for text fields'
9607
- type: string
9608
- type: object
9609
- SignatureRequestResponseCustomFieldCheckbox:
9855
+ description: 'A true/false for checkbox fields'
9856
+ type: boolean
9857
+ SignatureRequestResponseCustomFieldText:
9610
9858
  description: 'This class extends `SignatureRequestResponseCustomFieldBase`.'
9859
+ required:
9860
+ - type
9611
9861
  type: object
9612
9862
  allOf:
9613
9863
  -
9614
9864
  $ref: '#/components/schemas/SignatureRequestResponseCustomFieldBase'
9615
9865
  -
9616
- required:
9617
- - type
9618
- - options
9619
9866
  properties:
9620
9867
  type:
9621
9868
  description: 'The type of this Custom Field. Only ''text'' and ''checkbox'' are currently supported.'
9622
9869
  type: string
9623
- default: checkbox
9870
+ default: text
9624
9871
  value:
9625
- description: 'A true/false for checkbox fields'
9626
- type: boolean
9627
- type: object
9872
+ description: 'A text string for text fields'
9873
+ type: string
9874
+ SignatureRequestResponseCustomFieldTypeEnum:
9875
+ type: string
9876
+ enum:
9877
+ - text
9878
+ - checkbox
9628
9879
  SignatureRequestResponseDataBase:
9629
9880
  description: 'An array of form field objects containing the name, value, and type of each textbox or checkmark field filled in by the signers.'
9630
9881
  properties:
@@ -9657,6 +9908,144 @@ components:
9657
9908
  checkbox-merge: '#/components/schemas/SignatureRequestResponseDataValueCheckboxMerge'
9658
9909
  x-internal: true
9659
9910
  x-base-class: true
9911
+ SignatureRequestResponseDataTypeEnum:
9912
+ type: string
9913
+ enum:
9914
+ - text
9915
+ - checkbox
9916
+ - date_signed
9917
+ - dropdown
9918
+ - initials
9919
+ - radio
9920
+ - signature
9921
+ - text-merge
9922
+ - checkbox-merge
9923
+ SignatureRequestResponseDataValueCheckbox:
9924
+ type: object
9925
+ allOf:
9926
+ -
9927
+ $ref: '#/components/schemas/SignatureRequestResponseDataBase'
9928
+ -
9929
+ properties:
9930
+ type:
9931
+ description: 'A yes/no checkbox'
9932
+ type: string
9933
+ default: checkbox
9934
+ value:
9935
+ description: 'The value of the form field.'
9936
+ type: boolean
9937
+ SignatureRequestResponseDataValueCheckboxMerge:
9938
+ type: object
9939
+ allOf:
9940
+ -
9941
+ $ref: '#/components/schemas/SignatureRequestResponseDataBase'
9942
+ -
9943
+ properties:
9944
+ type:
9945
+ description: 'A checkbox field that has default value set by the api'
9946
+ type: string
9947
+ default: checkbox-merge
9948
+ value:
9949
+ description: 'The value of the form field.'
9950
+ type: string
9951
+ SignatureRequestResponseDataValueDateSigned:
9952
+ type: object
9953
+ allOf:
9954
+ -
9955
+ $ref: '#/components/schemas/SignatureRequestResponseDataBase'
9956
+ -
9957
+ properties:
9958
+ type:
9959
+ description: 'A date'
9960
+ type: string
9961
+ default: date_signed
9962
+ value:
9963
+ description: 'The value of the form field.'
9964
+ type: string
9965
+ SignatureRequestResponseDataValueDropdown:
9966
+ type: object
9967
+ allOf:
9968
+ -
9969
+ $ref: '#/components/schemas/SignatureRequestResponseDataBase'
9970
+ -
9971
+ properties:
9972
+ type:
9973
+ description: 'An input field for dropdowns'
9974
+ type: string
9975
+ default: dropdown
9976
+ value:
9977
+ description: 'The value of the form field.'
9978
+ type: string
9979
+ SignatureRequestResponseDataValueInitials:
9980
+ type: object
9981
+ allOf:
9982
+ -
9983
+ $ref: '#/components/schemas/SignatureRequestResponseDataBase'
9984
+ -
9985
+ properties:
9986
+ type:
9987
+ description: 'An input field for initials'
9988
+ type: string
9989
+ default: initials
9990
+ value:
9991
+ description: 'The value of the form field.'
9992
+ type: string
9993
+ SignatureRequestResponseDataValueRadio:
9994
+ type: object
9995
+ allOf:
9996
+ -
9997
+ $ref: '#/components/schemas/SignatureRequestResponseDataBase'
9998
+ -
9999
+ properties:
10000
+ type:
10001
+ description: 'An input field for radios'
10002
+ type: string
10003
+ default: radio
10004
+ value:
10005
+ description: 'The value of the form field.'
10006
+ type: boolean
10007
+ SignatureRequestResponseDataValueSignature:
10008
+ type: object
10009
+ allOf:
10010
+ -
10011
+ $ref: '#/components/schemas/SignatureRequestResponseDataBase'
10012
+ -
10013
+ properties:
10014
+ type:
10015
+ description: 'A signature input field'
10016
+ type: string
10017
+ default: signature
10018
+ value:
10019
+ description: 'The value of the form field.'
10020
+ type: string
10021
+ SignatureRequestResponseDataValueText:
10022
+ type: object
10023
+ allOf:
10024
+ -
10025
+ $ref: '#/components/schemas/SignatureRequestResponseDataBase'
10026
+ -
10027
+ properties:
10028
+ type:
10029
+ description: 'A text input field'
10030
+ type: string
10031
+ default: text
10032
+ value:
10033
+ description: 'The value of the form field.'
10034
+ type: string
10035
+ SignatureRequestResponseDataValueTextMerge:
10036
+ type: object
10037
+ allOf:
10038
+ -
10039
+ $ref: '#/components/schemas/SignatureRequestResponseDataBase'
10040
+ -
10041
+ properties:
10042
+ type:
10043
+ description: 'A text field that has default text set by the api'
10044
+ type: string
10045
+ default: text-merge
10046
+ value:
10047
+ description: 'The value of the form field.'
10048
+ type: string
9660
10049
  SignatureRequestResponseSignatures:
9661
10050
  description: 'An array of signature objects, 1 for each signer.'
9662
10051
  properties:
@@ -9756,18 +10145,6 @@ components:
9756
10145
  type: string
9757
10146
  type: object
9758
10147
  x-internal: true
9759
- TeamParentResponse:
9760
- description: 'Information about the parent team if a team has one, set to `null` otherwise.'
9761
- properties:
9762
- team_id:
9763
- description: 'The id of a team'
9764
- type: string
9765
- name:
9766
- description: 'The name of a team'
9767
- type: string
9768
- type: object
9769
- nullable: true
9770
- x-internal: true
9771
10148
  TeamInfoResponse:
9772
10149
  properties:
9773
10150
  team_id:
@@ -9786,30 +10163,6 @@ components:
9786
10163
  type: integer
9787
10164
  type: object
9788
10165
  x-internal: true
9789
- TeamGetInfoResponse:
9790
- properties:
9791
- team:
9792
- $ref: '#/components/schemas/TeamInfoResponse'
9793
- warnings:
9794
- description: 'A list of warnings.'
9795
- type: array
9796
- items:
9797
- $ref: '#/components/schemas/WarningResponse'
9798
- type: object
9799
- x-internal: true
9800
- TeamMemberResponse:
9801
- properties:
9802
- account_id:
9803
- description: 'Account id of the team member.'
9804
- type: string
9805
- email_address:
9806
- description: 'Email address of the team member.'
9807
- type: string
9808
- role:
9809
- description: 'The specific role a member has on the team.'
9810
- type: string
9811
- type: object
9812
- x-internal: true
9813
10166
  TeamInviteResponse:
9814
10167
  properties:
9815
10168
  email_address:
@@ -9832,20 +10185,21 @@ components:
9832
10185
  type: integer
9833
10186
  type: object
9834
10187
  x-internal: true
9835
- TeamInvitesResponse:
10188
+ TeamMemberResponse:
9836
10189
  properties:
9837
- team_invites:
9838
- description: 'Contains a list of team invites and their roles.'
9839
- type: array
9840
- items:
9841
- $ref: '#/components/schemas/TeamInviteResponse'
9842
- warnings:
9843
- type: array
9844
- items:
9845
- $ref: '#/components/schemas/WarningResponse'
10190
+ account_id:
10191
+ description: 'Account id of the team member.'
10192
+ type: string
10193
+ email_address:
10194
+ description: 'Email address of the team member.'
10195
+ type: string
10196
+ role:
10197
+ description: 'The specific role a member has on the team.'
10198
+ type: string
9846
10199
  type: object
9847
10200
  x-internal: true
9848
- SubTeamResponse:
10201
+ TeamParentResponse:
10202
+ description: 'Information about the parent team if a team has one, set to `null` otherwise.'
9849
10203
  properties:
9850
10204
  team_id:
9851
10205
  description: 'The id of a team'
@@ -9854,46 +10208,16 @@ components:
9854
10208
  description: 'The name of a team'
9855
10209
  type: string
9856
10210
  type: object
10211
+ nullable: true
9857
10212
  x-internal: true
9858
- TeamGetResponse:
9859
- properties:
9860
- team:
9861
- $ref: '#/components/schemas/TeamResponse'
9862
- warnings:
9863
- description: 'A list of warnings.'
9864
- type: array
9865
- items:
9866
- $ref: '#/components/schemas/WarningResponse'
9867
- type: object
9868
- x-internal: true
9869
- TeamMembersResponse:
9870
- properties:
9871
- team_members:
9872
- description: 'Contains a list of team members and their roles for a specific team.'
9873
- type: array
9874
- items:
9875
- $ref: '#/components/schemas/TeamMemberResponse'
9876
- list_info:
9877
- $ref: '#/components/schemas/ListInfoResponse'
9878
- warnings:
9879
- type: array
9880
- items:
9881
- $ref: '#/components/schemas/WarningResponse'
9882
- type: object
9883
- x-internal: true
9884
- TeamSubTeamsResponse:
10213
+ SubTeamResponse:
9885
10214
  properties:
9886
- sub_teams:
9887
- description: 'Contains a list with sub teams.'
9888
- type: array
9889
- items:
9890
- $ref: '#/components/schemas/SubTeamResponse'
9891
- list_info:
9892
- $ref: '#/components/schemas/ListInfoResponse'
9893
- warnings:
9894
- type: array
9895
- items:
9896
- $ref: '#/components/schemas/WarningResponse'
10215
+ team_id:
10216
+ description: 'The id of a team'
10217
+ type: string
10218
+ name:
10219
+ description: 'The name of a team'
10220
+ type: string
9897
10221
  type: object
9898
10222
  x-internal: true
9899
10223
  TemplateResponse:
@@ -9970,88 +10294,6 @@ components:
9970
10294
  nullable: true
9971
10295
  type: object
9972
10296
  x-internal: true
9973
- TemplateCreateEmbeddedDraftResponse:
9974
- properties:
9975
- template:
9976
- $ref: '#/components/schemas/TemplateCreateEmbeddedDraftResponseTemplate'
9977
- warnings:
9978
- description: 'A list of warnings.'
9979
- type: array
9980
- items:
9981
- $ref: '#/components/schemas/WarningResponse'
9982
- type: object
9983
- x-internal: true
9984
- TemplateCreateEmbeddedDraftResponseTemplate:
9985
- description: 'Template object with parameters: `template_id`, `edit_url`, `expires_at`.'
9986
- properties:
9987
- template_id:
9988
- description: 'The id of the Template.'
9989
- type: string
9990
- edit_url:
9991
- description: 'Link to edit the template.'
9992
- type: string
9993
- expires_at:
9994
- description: 'When the link expires.'
9995
- type: integer
9996
- warnings:
9997
- description: 'A list of warnings.'
9998
- type: array
9999
- items:
10000
- $ref: '#/components/schemas/WarningResponse'
10001
- type: object
10002
- x-internal: true
10003
- TemplateUpdateFilesResponse:
10004
- properties:
10005
- template:
10006
- $ref: '#/components/schemas/TemplateUpdateFilesResponseTemplate'
10007
- type: object
10008
- x-internal: true
10009
- TemplateUpdateFilesResponseTemplate:
10010
- description: 'Contains template id'
10011
- properties:
10012
- template_id:
10013
- description: 'The id of the Template.'
10014
- type: string
10015
- warnings:
10016
- description: 'A list of warnings.'
10017
- type: array
10018
- items:
10019
- $ref: '#/components/schemas/WarningResponse'
10020
- type: object
10021
- x-internal: true
10022
- TemplateGetResponse:
10023
- properties:
10024
- template:
10025
- $ref: '#/components/schemas/TemplateResponse'
10026
- warnings:
10027
- description: 'A list of warnings.'
10028
- type: array
10029
- items:
10030
- $ref: '#/components/schemas/WarningResponse'
10031
- type: object
10032
- x-internal: true
10033
- TemplateListResponse:
10034
- properties:
10035
- templates:
10036
- description: 'List of templates that the API caller has access to.'
10037
- type: array
10038
- items:
10039
- $ref: '#/components/schemas/TemplateResponse'
10040
- list_info:
10041
- $ref: '#/components/schemas/ListInfoResponse'
10042
- warnings:
10043
- description: 'A list of warnings.'
10044
- type: array
10045
- items:
10046
- $ref: '#/components/schemas/WarningResponse'
10047
- type: object
10048
- x-internal: true
10049
- TemplateEditResponse:
10050
- properties:
10051
- template_id:
10052
- description: 'The id of the Template.'
10053
- type: string
10054
- type: object
10055
10297
  TemplateResponseAccount:
10056
10298
  properties:
10057
10299
  account_id:
@@ -10097,6 +10339,34 @@ components:
10097
10339
  type: string
10098
10340
  type: object
10099
10341
  x-internal: true
10342
+ TemplateCreateEmbeddedDraftResponseTemplate:
10343
+ description: 'Template object with parameters: `template_id`, `edit_url`, `expires_at`.'
10344
+ properties:
10345
+ template_id:
10346
+ description: 'The id of the Template.'
10347
+ type: string
10348
+ edit_url:
10349
+ description: 'Link to edit the template.'
10350
+ type: string
10351
+ expires_at:
10352
+ description: 'When the link expires.'
10353
+ type: integer
10354
+ warnings:
10355
+ description: 'A list of warnings.'
10356
+ type: array
10357
+ items:
10358
+ $ref: '#/components/schemas/WarningResponse'
10359
+ deprecated: true
10360
+ type: object
10361
+ x-internal: true
10362
+ TemplateCreateResponseTemplate:
10363
+ description: 'Template object with parameters: `template_id`.'
10364
+ properties:
10365
+ template_id:
10366
+ description: 'The id of the Template.'
10367
+ type: string
10368
+ type: object
10369
+ x-internal: true
10100
10370
  TemplateResponseDocument:
10101
10371
  properties:
10102
10372
  name:
@@ -10172,15 +10442,15 @@ components:
10172
10442
  checkbox: '#/components/schemas/TemplateResponseDocumentCustomFieldCheckbox'
10173
10443
  x-internal: true
10174
10444
  x-base-class: true
10175
- TemplateResponseDocumentCustomFieldText:
10445
+ TemplateResponseDocumentCustomFieldCheckbox:
10176
10446
  description: 'This class extends `TemplateResponseDocumentCustomFieldBase`'
10447
+ required:
10448
+ - type
10177
10449
  type: object
10178
10450
  allOf:
10179
10451
  -
10180
10452
  $ref: '#/components/schemas/TemplateResponseDocumentCustomFieldBase'
10181
10453
  -
10182
- required:
10183
- - type
10184
10454
  properties:
10185
10455
  type:
10186
10456
  description: |-
@@ -10189,28 +10459,16 @@ components:
10189
10459
  * Text uses `TemplateResponseDocumentCustomFieldText`
10190
10460
  * Checkbox uses `TemplateResponseDocumentCustomFieldCheckbox`
10191
10461
  type: string
10192
- default: text
10193
- avg_text_length:
10194
- $ref: '#/components/schemas/TemplateResponseFieldAvgTextLength'
10195
- isMultiline:
10196
- description: 'Whether this form field is multiline text.'
10197
- type: boolean
10198
- originalFontSize:
10199
- description: 'Original font size used in this form field''s text.'
10200
- type: integer
10201
- fontFamily:
10202
- description: 'Font family used in this form field''s text.'
10203
- type: string
10204
- type: object
10205
- TemplateResponseDocumentCustomFieldCheckbox:
10462
+ default: checkbox
10463
+ TemplateResponseDocumentCustomFieldText:
10206
10464
  description: 'This class extends `TemplateResponseDocumentCustomFieldBase`'
10465
+ required:
10466
+ - type
10207
10467
  type: object
10208
10468
  allOf:
10209
10469
  -
10210
10470
  $ref: '#/components/schemas/TemplateResponseDocumentCustomFieldBase'
10211
10471
  -
10212
- required:
10213
- - type
10214
10472
  properties:
10215
10473
  type:
10216
10474
  description: |-
@@ -10219,8 +10477,18 @@ components:
10219
10477
  * Text uses `TemplateResponseDocumentCustomFieldText`
10220
10478
  * Checkbox uses `TemplateResponseDocumentCustomFieldCheckbox`
10221
10479
  type: string
10222
- default: checkbox
10223
- type: object
10480
+ default: text
10481
+ avg_text_length:
10482
+ $ref: '#/components/schemas/TemplateResponseFieldAvgTextLength'
10483
+ isMultiline:
10484
+ description: 'Whether this form field is multiline text.'
10485
+ type: boolean
10486
+ originalFontSize:
10487
+ description: 'Original font size used in this form field''s text.'
10488
+ type: integer
10489
+ fontFamily:
10490
+ description: 'Font family used in this form field''s text.'
10491
+ type: string
10224
10492
  TemplateResponseDocumentFieldGroup:
10225
10493
  properties:
10226
10494
  name:
@@ -10295,15 +10563,15 @@ components:
10295
10563
  initials: '#/components/schemas/TemplateResponseDocumentFormFieldInitials'
10296
10564
  x-internal: true
10297
10565
  x-base-class: true
10298
- TemplateResponseDocumentFormFieldText:
10566
+ TemplateResponseDocumentFormFieldCheckbox:
10299
10567
  description: 'This class extends `TemplateResponseDocumentFormFieldBase`'
10568
+ required:
10569
+ - type
10300
10570
  type: object
10301
10571
  allOf:
10302
10572
  -
10303
10573
  $ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase'
10304
10574
  -
10305
- required:
10306
- - type
10307
10575
  properties:
10308
10576
  type:
10309
10577
  description: |-
@@ -10318,43 +10586,16 @@ components:
10318
10586
  * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
10319
10587
  * Initials Field uses `TemplateResponseDocumentFormFieldInitials`
10320
10588
  type: string
10321
- default: text
10322
- avg_text_length:
10323
- $ref: '#/components/schemas/TemplateResponseFieldAvgTextLength'
10324
- isMultiline:
10325
- description: 'Whether this form field is multiline text.'
10326
- type: boolean
10327
- originalFontSize:
10328
- description: 'Original font size used in this form field''s text.'
10329
- type: integer
10330
- fontFamily:
10331
- description: 'Font family used in this form field''s text.'
10332
- type: string
10333
- validation_type:
10334
- description: 'Each text field may contain a `validation_type` parameter. Check out the list of [validation types](https://faq.hellosign.com/hc/en-us/articles/217115577) to learn more about the possible values.'
10335
- type: string
10336
- enum:
10337
- - numbers_only
10338
- - letters_only
10339
- - phone_number
10340
- - bank_routing_number
10341
- - bank_account_number
10342
- - email_address
10343
- - zip_code
10344
- - social_security_number
10345
- - employer_identification_number
10346
- - custom_regex
10347
- nullable: true
10348
- type: object
10349
- TemplateResponseDocumentFormFieldDropdown:
10589
+ default: checkbox
10590
+ TemplateResponseDocumentFormFieldDateSigned:
10350
10591
  description: 'This class extends `TemplateResponseDocumentFormFieldBase`'
10592
+ required:
10593
+ - type
10351
10594
  type: object
10352
10595
  allOf:
10353
10596
  -
10354
10597
  $ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase'
10355
10598
  -
10356
- required:
10357
- - type
10358
10599
  properties:
10359
10600
  type:
10360
10601
  description: |-
@@ -10369,17 +10610,16 @@ components:
10369
10610
  * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
10370
10611
  * Initials Field uses `TemplateResponseDocumentFormFieldInitials`
10371
10612
  type: string
10372
- default: dropdown
10373
- type: object
10374
- TemplateResponseDocumentFormFieldHyperlink:
10613
+ default: date_signed
10614
+ TemplateResponseDocumentFormFieldDropdown:
10375
10615
  description: 'This class extends `TemplateResponseDocumentFormFieldBase`'
10616
+ required:
10617
+ - type
10376
10618
  type: object
10377
10619
  allOf:
10378
10620
  -
10379
10621
  $ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase'
10380
10622
  -
10381
- required:
10382
- - type
10383
10623
  properties:
10384
10624
  type:
10385
10625
  description: |-
@@ -10394,28 +10634,16 @@ components:
10394
10634
  * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
10395
10635
  * Initials Field uses `TemplateResponseDocumentFormFieldInitials`
10396
10636
  type: string
10397
- default: hyperlink
10398
- avg_text_length:
10399
- $ref: '#/components/schemas/TemplateResponseFieldAvgTextLength'
10400
- isMultiline:
10401
- description: 'Whether this form field is multiline text.'
10402
- type: boolean
10403
- originalFontSize:
10404
- description: 'Original font size used in this form field''s text.'
10405
- type: integer
10406
- fontFamily:
10407
- description: 'Font family used in this form field''s text.'
10408
- type: string
10409
- type: object
10410
- TemplateResponseDocumentFormFieldCheckbox:
10637
+ default: dropdown
10638
+ TemplateResponseDocumentFormFieldHyperlink:
10411
10639
  description: 'This class extends `TemplateResponseDocumentFormFieldBase`'
10640
+ required:
10641
+ - type
10412
10642
  type: object
10413
10643
  allOf:
10414
10644
  -
10415
10645
  $ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase'
10416
10646
  -
10417
- required:
10418
- - type
10419
10647
  properties:
10420
10648
  type:
10421
10649
  description: |-
@@ -10430,18 +10658,27 @@ components:
10430
10658
  * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
10431
10659
  * Initials Field uses `TemplateResponseDocumentFormFieldInitials`
10432
10660
  type: string
10433
- default: checkbox
10434
- type: object
10435
- TemplateResponseDocumentFormFieldRadio:
10661
+ default: hyperlink
10662
+ avg_text_length:
10663
+ $ref: '#/components/schemas/TemplateResponseFieldAvgTextLength'
10664
+ isMultiline:
10665
+ description: 'Whether this form field is multiline text.'
10666
+ type: boolean
10667
+ originalFontSize:
10668
+ description: 'Original font size used in this form field''s text.'
10669
+ type: integer
10670
+ fontFamily:
10671
+ description: 'Font family used in this form field''s text.'
10672
+ type: string
10673
+ TemplateResponseDocumentFormFieldInitials:
10436
10674
  description: 'This class extends `TemplateResponseDocumentFormFieldBase`'
10675
+ required:
10676
+ - type
10437
10677
  type: object
10438
10678
  allOf:
10439
10679
  -
10440
10680
  $ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase'
10441
10681
  -
10442
- required:
10443
- - type
10444
- - group
10445
10682
  properties:
10446
10683
  type:
10447
10684
  description: |-
@@ -10456,17 +10693,17 @@ components:
10456
10693
  * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
10457
10694
  * Initials Field uses `TemplateResponseDocumentFormFieldInitials`
10458
10695
  type: string
10459
- default: radio
10460
- type: object
10461
- TemplateResponseDocumentFormFieldSignature:
10696
+ default: initials
10697
+ TemplateResponseDocumentFormFieldRadio:
10462
10698
  description: 'This class extends `TemplateResponseDocumentFormFieldBase`'
10699
+ required:
10700
+ - type
10701
+ - group
10463
10702
  type: object
10464
10703
  allOf:
10465
10704
  -
10466
10705
  $ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase'
10467
10706
  -
10468
- required:
10469
- - type
10470
10707
  properties:
10471
10708
  type:
10472
10709
  description: |-
@@ -10480,18 +10717,17 @@ components:
10480
10717
  * Signature Field uses `TemplateResponseDocumentFormFieldSignature`
10481
10718
  * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
10482
10719
  * Initials Field uses `TemplateResponseDocumentFormFieldInitials`
10483
- type: string
10484
- default: signature
10485
- type: object
10486
- TemplateResponseDocumentFormFieldDateSigned:
10720
+ type: string
10721
+ default: radio
10722
+ TemplateResponseDocumentFormFieldSignature:
10487
10723
  description: 'This class extends `TemplateResponseDocumentFormFieldBase`'
10724
+ required:
10725
+ - type
10488
10726
  type: object
10489
10727
  allOf:
10490
10728
  -
10491
10729
  $ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase'
10492
10730
  -
10493
- required:
10494
- - type
10495
10731
  properties:
10496
10732
  type:
10497
10733
  description: |-
@@ -10506,17 +10742,16 @@ components:
10506
10742
  * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
10507
10743
  * Initials Field uses `TemplateResponseDocumentFormFieldInitials`
10508
10744
  type: string
10509
- default: date_signed
10510
- type: object
10511
- TemplateResponseDocumentFormFieldInitials:
10745
+ default: signature
10746
+ TemplateResponseDocumentFormFieldText:
10512
10747
  description: 'This class extends `TemplateResponseDocumentFormFieldBase`'
10748
+ required:
10749
+ - type
10513
10750
  type: object
10514
10751
  allOf:
10515
10752
  -
10516
10753
  $ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase'
10517
10754
  -
10518
- required:
10519
- - type
10520
10755
  properties:
10521
10756
  type:
10522
10757
  description: |-
@@ -10531,8 +10766,33 @@ components:
10531
10766
  * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
10532
10767
  * Initials Field uses `TemplateResponseDocumentFormFieldInitials`
10533
10768
  type: string
10534
- default: initials
10535
- type: object
10769
+ default: text
10770
+ avg_text_length:
10771
+ $ref: '#/components/schemas/TemplateResponseFieldAvgTextLength'
10772
+ isMultiline:
10773
+ description: 'Whether this form field is multiline text.'
10774
+ type: boolean
10775
+ originalFontSize:
10776
+ description: 'Original font size used in this form field''s text.'
10777
+ type: integer
10778
+ fontFamily:
10779
+ description: 'Font family used in this form field''s text.'
10780
+ type: string
10781
+ validation_type:
10782
+ description: 'Each text field may contain a `validation_type` parameter. Check out the list of [validation types](https://faq.hellosign.com/hc/en-us/articles/217115577) to learn more about the possible values.'
10783
+ type: string
10784
+ enum:
10785
+ - numbers_only
10786
+ - letters_only
10787
+ - phone_number
10788
+ - bank_routing_number
10789
+ - bank_account_number
10790
+ - email_address
10791
+ - zip_code
10792
+ - social_security_number
10793
+ - employer_identification_number
10794
+ - custom_regex
10795
+ nullable: true
10536
10796
  TemplateResponseDocumentStaticFieldBase:
10537
10797
  description: 'An array describing static overlay fields. **Note** only available for certain subscriptions.'
10538
10798
  required:
@@ -10583,15 +10843,15 @@ components:
10583
10843
  initials: '#/components/schemas/TemplateResponseDocumentStaticFieldInitials'
10584
10844
  x-internal: true
10585
10845
  x-base-class: true
10586
- TemplateResponseDocumentStaticFieldText:
10846
+ TemplateResponseDocumentStaticFieldCheckbox:
10587
10847
  description: 'This class extends `TemplateResponseDocumentStaticFieldBase`'
10848
+ required:
10849
+ - type
10588
10850
  type: object
10589
10851
  allOf:
10590
10852
  -
10591
10853
  $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase'
10592
10854
  -
10593
- required:
10594
- - type
10595
10855
  properties:
10596
10856
  type:
10597
10857
  description: |-
@@ -10606,17 +10866,16 @@ components:
10606
10866
  * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
10607
10867
  * Initials Field uses `TemplateResponseDocumentStaticFieldInitials`
10608
10868
  type: string
10609
- default: text
10610
- type: object
10611
- TemplateResponseDocumentStaticFieldDropdown:
10869
+ default: checkbox
10870
+ TemplateResponseDocumentStaticFieldDateSigned:
10612
10871
  description: 'This class extends `TemplateResponseDocumentStaticFieldBase`'
10872
+ required:
10873
+ - type
10613
10874
  type: object
10614
10875
  allOf:
10615
10876
  -
10616
10877
  $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase'
10617
10878
  -
10618
- required:
10619
- - type
10620
10879
  properties:
10621
10880
  type:
10622
10881
  description: |-
@@ -10631,17 +10890,16 @@ components:
10631
10890
  * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
10632
10891
  * Initials Field uses `TemplateResponseDocumentStaticFieldInitials`
10633
10892
  type: string
10634
- default: dropdown
10635
- type: object
10636
- TemplateResponseDocumentStaticFieldHyperlink:
10893
+ default: date_signed
10894
+ TemplateResponseDocumentStaticFieldDropdown:
10637
10895
  description: 'This class extends `TemplateResponseDocumentStaticFieldBase`'
10896
+ required:
10897
+ - type
10638
10898
  type: object
10639
10899
  allOf:
10640
10900
  -
10641
10901
  $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase'
10642
10902
  -
10643
- required:
10644
- - type
10645
10903
  properties:
10646
10904
  type:
10647
10905
  description: |-
@@ -10656,17 +10914,16 @@ components:
10656
10914
  * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
10657
10915
  * Initials Field uses `TemplateResponseDocumentStaticFieldInitials`
10658
10916
  type: string
10659
- default: hyperlink
10660
- type: object
10661
- TemplateResponseDocumentStaticFieldCheckbox:
10917
+ default: dropdown
10918
+ TemplateResponseDocumentStaticFieldHyperlink:
10662
10919
  description: 'This class extends `TemplateResponseDocumentStaticFieldBase`'
10920
+ required:
10921
+ - type
10663
10922
  type: object
10664
10923
  allOf:
10665
10924
  -
10666
10925
  $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase'
10667
10926
  -
10668
- required:
10669
- - type
10670
10927
  properties:
10671
10928
  type:
10672
10929
  description: |-
@@ -10681,17 +10938,16 @@ components:
10681
10938
  * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
10682
10939
  * Initials Field uses `TemplateResponseDocumentStaticFieldInitials`
10683
10940
  type: string
10684
- default: checkbox
10685
- type: object
10686
- TemplateResponseDocumentStaticFieldRadio:
10941
+ default: hyperlink
10942
+ TemplateResponseDocumentStaticFieldInitials:
10687
10943
  description: 'This class extends `TemplateResponseDocumentStaticFieldBase`'
10944
+ required:
10945
+ - type
10688
10946
  type: object
10689
10947
  allOf:
10690
10948
  -
10691
10949
  $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase'
10692
10950
  -
10693
- required:
10694
- - type
10695
10951
  properties:
10696
10952
  type:
10697
10953
  description: |-
@@ -10706,17 +10962,16 @@ components:
10706
10962
  * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
10707
10963
  * Initials Field uses `TemplateResponseDocumentStaticFieldInitials`
10708
10964
  type: string
10709
- default: radio
10710
- type: object
10711
- TemplateResponseDocumentStaticFieldSignature:
10965
+ default: initials
10966
+ TemplateResponseDocumentStaticFieldRadio:
10712
10967
  description: 'This class extends `TemplateResponseDocumentStaticFieldBase`'
10968
+ required:
10969
+ - type
10713
10970
  type: object
10714
10971
  allOf:
10715
10972
  -
10716
10973
  $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase'
10717
10974
  -
10718
- required:
10719
- - type
10720
10975
  properties:
10721
10976
  type:
10722
10977
  description: |-
@@ -10731,17 +10986,16 @@ components:
10731
10986
  * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
10732
10987
  * Initials Field uses `TemplateResponseDocumentStaticFieldInitials`
10733
10988
  type: string
10734
- default: signature
10735
- type: object
10736
- TemplateResponseDocumentStaticFieldDateSigned:
10989
+ default: radio
10990
+ TemplateResponseDocumentStaticFieldSignature:
10737
10991
  description: 'This class extends `TemplateResponseDocumentStaticFieldBase`'
10992
+ required:
10993
+ - type
10738
10994
  type: object
10739
10995
  allOf:
10740
10996
  -
10741
10997
  $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase'
10742
10998
  -
10743
- required:
10744
- - type
10745
10999
  properties:
10746
11000
  type:
10747
11001
  description: |-
@@ -10756,17 +11010,16 @@ components:
10756
11010
  * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
10757
11011
  * Initials Field uses `TemplateResponseDocumentStaticFieldInitials`
10758
11012
  type: string
10759
- default: date_signed
10760
- type: object
10761
- TemplateResponseDocumentStaticFieldInitials:
11013
+ default: signature
11014
+ TemplateResponseDocumentStaticFieldText:
10762
11015
  description: 'This class extends `TemplateResponseDocumentStaticFieldBase`'
11016
+ required:
11017
+ - type
10763
11018
  type: object
10764
11019
  allOf:
10765
11020
  -
10766
11021
  $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase'
10767
11022
  -
10768
- required:
10769
- - type
10770
11023
  properties:
10771
11024
  type:
10772
11025
  description: |-
@@ -10781,54 +11034,206 @@ components:
10781
11034
  * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
10782
11035
  * Initials Field uses `TemplateResponseDocumentStaticFieldInitials`
10783
11036
  type: string
10784
- default: initials
10785
- type: object
11037
+ default: text
10786
11038
  TemplateResponseFieldAvgTextLength:
10787
11039
  description: 'Average text length in this field.'
10788
11040
  properties:
10789
- num_lines:
10790
- description: 'Number of lines.'
10791
- type: integer
10792
- num_chars_per_line:
10793
- description: 'Number of characters per line.'
10794
- type: integer
11041
+ num_lines:
11042
+ description: 'Number of lines.'
11043
+ type: integer
11044
+ num_chars_per_line:
11045
+ description: 'Number of characters per line.'
11046
+ type: integer
11047
+ type: object
11048
+ x-internal: true
11049
+ TemplateResponseSignerRole:
11050
+ properties:
11051
+ name:
11052
+ description: 'The name of the Role.'
11053
+ type: string
11054
+ order:
11055
+ description: 'If signer order is assigned this is the 0-based index for this role.'
11056
+ type: integer
11057
+ type: object
11058
+ x-internal: true
11059
+ TemplateUpdateFilesResponseTemplate:
11060
+ description: 'Contains template id'
11061
+ properties:
11062
+ template_id:
11063
+ description: 'The id of the Template.'
11064
+ type: string
11065
+ warnings:
11066
+ description: 'A list of warnings.'
11067
+ type: array
11068
+ items:
11069
+ $ref: '#/components/schemas/WarningResponse'
11070
+ deprecated: true
11071
+ type: object
11072
+ x-internal: true
11073
+ UnclaimedDraftResponse:
11074
+ description: 'A group of documents that a user can take ownership of via the claim URL.'
11075
+ properties:
11076
+ signature_request_id:
11077
+ description: 'The ID of the signature request that is represented by this UnclaimedDraft.'
11078
+ type: string
11079
+ nullable: true
11080
+ claim_url:
11081
+ description: 'The URL to be used to claim this UnclaimedDraft.'
11082
+ type: string
11083
+ signing_redirect_url:
11084
+ description: 'The URL you want signers redirected to after they successfully sign.'
11085
+ type: string
11086
+ nullable: true
11087
+ requesting_redirect_url:
11088
+ description: 'The URL you want signers redirected to after they successfully request a signature (Will only be returned in the response if it is applicable to the request.).'
11089
+ type: string
11090
+ nullable: true
11091
+ expires_at:
11092
+ description: 'When the link expires.'
11093
+ type: integer
11094
+ nullable: true
11095
+ test_mode:
11096
+ description: 'Whether this is a test draft. Signature requests made from test drafts have no legal value.'
11097
+ type: boolean
11098
+ type: object
11099
+ x-internal: true
11100
+ WarningResponse:
11101
+ description: 'A list of warnings.'
11102
+ required:
11103
+ - warning_msg
11104
+ - warning_name
11105
+ properties:
11106
+ warning_msg:
11107
+ description: 'Warning message'
11108
+ type: string
11109
+ warning_name:
11110
+ description: 'Warning name'
11111
+ type: string
11112
+ type: object
11113
+ TeamGetResponse:
11114
+ properties:
11115
+ team:
11116
+ $ref: '#/components/schemas/TeamResponse'
11117
+ warnings:
11118
+ description: 'A list of warnings.'
11119
+ type: array
11120
+ items:
11121
+ $ref: '#/components/schemas/WarningResponse'
11122
+ type: object
11123
+ x-internal: true
11124
+ TeamGetInfoResponse:
11125
+ properties:
11126
+ team:
11127
+ $ref: '#/components/schemas/TeamInfoResponse'
11128
+ warnings:
11129
+ description: 'A list of warnings.'
11130
+ type: array
11131
+ items:
11132
+ $ref: '#/components/schemas/WarningResponse'
11133
+ type: object
11134
+ x-internal: true
11135
+ TeamInvitesResponse:
11136
+ properties:
11137
+ team_invites:
11138
+ description: 'Contains a list of team invites and their roles.'
11139
+ type: array
11140
+ items:
11141
+ $ref: '#/components/schemas/TeamInviteResponse'
11142
+ warnings:
11143
+ type: array
11144
+ items:
11145
+ $ref: '#/components/schemas/WarningResponse'
11146
+ type: object
11147
+ x-internal: true
11148
+ TeamMembersResponse:
11149
+ properties:
11150
+ team_members:
11151
+ description: 'Contains a list of team members and their roles for a specific team.'
11152
+ type: array
11153
+ items:
11154
+ $ref: '#/components/schemas/TeamMemberResponse'
11155
+ list_info:
11156
+ $ref: '#/components/schemas/ListInfoResponse'
11157
+ warnings:
11158
+ type: array
11159
+ items:
11160
+ $ref: '#/components/schemas/WarningResponse'
11161
+ type: object
11162
+ x-internal: true
11163
+ TeamSubTeamsResponse:
11164
+ properties:
11165
+ sub_teams:
11166
+ description: 'Contains a list with sub teams.'
11167
+ type: array
11168
+ items:
11169
+ $ref: '#/components/schemas/SubTeamResponse'
11170
+ list_info:
11171
+ $ref: '#/components/schemas/ListInfoResponse'
11172
+ warnings:
11173
+ type: array
11174
+ items:
11175
+ $ref: '#/components/schemas/WarningResponse'
11176
+ type: object
11177
+ x-internal: true
11178
+ TemplateCreateResponse:
11179
+ properties:
11180
+ template:
11181
+ $ref: '#/components/schemas/TemplateCreateResponse'
11182
+ warnings:
11183
+ description: 'A list of warnings.'
11184
+ type: array
11185
+ items:
11186
+ $ref: '#/components/schemas/WarningResponse'
11187
+ type: object
11188
+ x-internal: true
11189
+ TemplateCreateEmbeddedDraftResponse:
11190
+ properties:
11191
+ template:
11192
+ $ref: '#/components/schemas/TemplateCreateEmbeddedDraftResponseTemplate'
11193
+ warnings:
11194
+ description: 'A list of warnings.'
11195
+ type: array
11196
+ items:
11197
+ $ref: '#/components/schemas/WarningResponse'
10795
11198
  type: object
10796
11199
  x-internal: true
10797
- TemplateResponseSignerRole:
11200
+ TemplateEditResponse:
10798
11201
  properties:
10799
- name:
10800
- description: 'The name of the Role.'
11202
+ template_id:
11203
+ description: 'The id of the Template.'
10801
11204
  type: string
10802
- order:
10803
- description: 'If signer order is assigned this is the 0-based index for this role.'
10804
- type: integer
11205
+ type: object
11206
+ TemplateGetResponse:
11207
+ properties:
11208
+ template:
11209
+ $ref: '#/components/schemas/TemplateResponse'
11210
+ warnings:
11211
+ description: 'A list of warnings.'
11212
+ type: array
11213
+ items:
11214
+ $ref: '#/components/schemas/WarningResponse'
10805
11215
  type: object
10806
11216
  x-internal: true
10807
- UnclaimedDraftResponse:
10808
- description: 'A group of documents that a user can take ownership of via the claim URL.'
11217
+ TemplateListResponse:
10809
11218
  properties:
10810
- signature_request_id:
10811
- description: 'The ID of the signature request that is represented by this UnclaimedDraft.'
10812
- type: string
10813
- nullable: true
10814
- claim_url:
10815
- description: 'The URL to be used to claim this UnclaimedDraft.'
10816
- type: string
10817
- signing_redirect_url:
10818
- description: 'The URL you want signers redirected to after they successfully sign.'
10819
- type: string
10820
- nullable: true
10821
- requesting_redirect_url:
10822
- description: 'The URL you want signers redirected to after they successfully request a signature (Will only be returned in the response if it is applicable to the request.).'
10823
- type: string
10824
- nullable: true
10825
- expires_at:
10826
- description: 'When the link expires.'
10827
- type: integer
10828
- nullable: true
10829
- test_mode:
10830
- description: 'Whether this is a test draft. Signature requests made from test drafts have no legal value.'
10831
- type: boolean
11219
+ templates:
11220
+ description: 'List of templates that the API caller has access to.'
11221
+ type: array
11222
+ items:
11223
+ $ref: '#/components/schemas/TemplateResponse'
11224
+ list_info:
11225
+ $ref: '#/components/schemas/ListInfoResponse'
11226
+ warnings:
11227
+ description: 'A list of warnings.'
11228
+ type: array
11229
+ items:
11230
+ $ref: '#/components/schemas/WarningResponse'
11231
+ type: object
11232
+ x-internal: true
11233
+ TemplateUpdateFilesResponse:
11234
+ properties:
11235
+ template:
11236
+ $ref: '#/components/schemas/TemplateUpdateFilesResponseTemplate'
10832
11237
  type: object
10833
11238
  x-internal: true
10834
11239
  UnclaimedDraftCreateResponse:
@@ -10842,19 +11247,6 @@ components:
10842
11247
  $ref: '#/components/schemas/WarningResponse'
10843
11248
  type: object
10844
11249
  x-internal: true
10845
- WarningResponse:
10846
- description: 'A list of warnings.'
10847
- required:
10848
- - warning_msg
10849
- - warning_name
10850
- properties:
10851
- warning_msg:
10852
- description: 'Warning message'
10853
- type: string
10854
- warning_name:
10855
- description: 'Warning name'
10856
- type: string
10857
- type: object
10858
11250
  responses:
10859
11251
  EventCallbackResponse:
10860
11252
  description: 'successful operation'
@@ -10972,6 +11364,22 @@ components:
10972
11364
  summary: 'Default Example'
10973
11365
  value:
10974
11366
  $ref: examples/json/TemplateAddUserRequestDefaultExample.json
11367
+ TemplateCreateRequestDefaultExample:
11368
+ summary: 'Default Example'
11369
+ value:
11370
+ $ref: examples/json/TemplateCreateRequestDefaultExample.json
11371
+ TemplateCreateRequestFormFieldsPerDocumentExample:
11372
+ summary: 'Form Fields Per Document Example'
11373
+ value:
11374
+ $ref: examples/json/TemplateCreateRequestFormFieldsPerDocumentExample.json
11375
+ TemplateCreateRequestFormFieldGroupsExample:
11376
+ summary: 'Form Fields Per Document and Groups Example'
11377
+ value:
11378
+ $ref: examples/json/TemplateCreateRequestFormFieldGroupsExample.json
11379
+ TemplateCreateRequestFormFieldRulesExample:
11380
+ summary: 'Form Fields Per Document and Rules Example'
11381
+ value:
11382
+ $ref: examples/json/TemplateCreateRequestFormFieldRulesExample.json
10975
11383
  TemplateCreateEmbeddedDraftRequestDefaultExample:
10976
11384
  summary: 'Default Example'
10977
11385
  value:
@@ -11036,10 +11444,6 @@ components:
11036
11444
  summary: 'Default Example'
11037
11445
  value:
11038
11446
  $ref: examples/json/UnclaimedDraftEditAndResendRequestDefaultExample.json
11039
- AccountGetResponseExample:
11040
- summary: 'Account Get'
11041
- value:
11042
- $ref: examples/json/AccountGetResponseExample.json
11043
11447
  AccountCreateResponseExample:
11044
11448
  summary: 'Account Create'
11045
11449
  value:
@@ -11048,10 +11452,10 @@ components:
11048
11452
  summary: 'Account Create with OAuth Authorization'
11049
11453
  value:
11050
11454
  $ref: examples/json/AccountCreateOAuthResponseExample.json
11051
- AccountUpdateResponseExample:
11052
- summary: 'Account Update'
11455
+ AccountGetResponseExample:
11456
+ summary: 'Account Get'
11053
11457
  value:
11054
- $ref: examples/json/AccountUpdateResponseExample.json
11458
+ $ref: examples/json/AccountGetResponseExample.json
11055
11459
  AccountVerifyFoundResponseExample:
11056
11460
  summary: 'Account Found'
11057
11461
  value:
@@ -11060,10 +11464,6 @@ components:
11060
11464
  summary: 'Account Not Found'
11061
11465
  value:
11062
11466
  $ref: examples/json/AccountVerifyNotFoundResponseExample.json
11063
- ApiAppCreateResponseExample:
11064
- summary: 'API App'
11065
- value:
11066
- $ref: examples/json/ApiAppCreateResponseExample.json
11067
11467
  ApiAppGetResponseExample:
11068
11468
  summary: 'API App'
11069
11469
  value:
@@ -11072,10 +11472,6 @@ components:
11072
11472
  summary: 'API App List'
11073
11473
  value:
11074
11474
  $ref: examples/json/ApiAppListResponseExample.json
11075
- ApiAppUpdateResponseExample:
11076
- summary: 'API App Update'
11077
- value:
11078
- $ref: examples/json/ApiAppUpdateResponseExample.json
11079
11475
  BulkSendJobGetResponseExample:
11080
11476
  summary: 'Bulk Send Job'
11081
11477
  value:
@@ -11132,6 +11528,38 @@ components:
11132
11528
  summary: 'Error 4XX failed_operation'
11133
11529
  value:
11134
11530
  $ref: examples/json/Error4XXResponseExample.json
11531
+ ReportCreateResponseExample:
11532
+ summary: Report
11533
+ value:
11534
+ $ref: examples/json/ReportCreateResponseExample.json
11535
+ SignatureRequestGetResponseExample:
11536
+ summary: 'Get Signature Request'
11537
+ value:
11538
+ $ref: examples/json/SignatureRequestGetResponseExample.json
11539
+ SignatureRequestListResponseExample:
11540
+ summary: 'List Signature Requests'
11541
+ value:
11542
+ $ref: examples/json/SignatureRequestListResponseExample.json
11543
+ AccountUpdateResponseExample:
11544
+ summary: 'Account Update'
11545
+ value:
11546
+ $ref: examples/json/AccountUpdateResponseExample.json
11547
+ OAuthTokenGenerateResponseExample:
11548
+ summary: 'Retrieving the OAuth token'
11549
+ value:
11550
+ $ref: examples/json/OAuthTokenGenerateResponseExample.json
11551
+ OAuthTokenRefreshResponseExample:
11552
+ summary: 'Refresh an existing OAuth token'
11553
+ value:
11554
+ $ref: examples/json/OAuthTokenRefreshResponseExample.json
11555
+ ApiAppCreateResponseExample:
11556
+ summary: 'API App'
11557
+ value:
11558
+ $ref: examples/json/ApiAppCreateResponseExample.json
11559
+ ApiAppUpdateResponseExample:
11560
+ summary: 'API App Update'
11561
+ value:
11562
+ $ref: examples/json/ApiAppUpdateResponseExample.json
11135
11563
  EventCallbackAccountSignatureRequestSentExample:
11136
11564
  summary: 'Example: signature_request_sent'
11137
11565
  value:
@@ -11152,18 +11580,6 @@ components:
11152
11580
  summary: 'Example: template_created'
11153
11581
  value:
11154
11582
  $ref: examples/json/EventCallbackAppTemplateCreatedExample.json
11155
- OAuthTokenGenerateResponseExample:
11156
- summary: 'Retrieving the OAuth token'
11157
- value:
11158
- $ref: examples/json/OAuthTokenGenerateResponseExample.json
11159
- OAuthTokenRefreshResponseExample:
11160
- summary: 'Refresh an existing OAuth token'
11161
- value:
11162
- $ref: examples/json/OAuthTokenRefreshResponseExample.json
11163
- ReportCreateResponseExample:
11164
- summary: Report
11165
- value:
11166
- $ref: examples/json/ReportCreateResponseExample.json
11167
11583
  SignatureRequestCreateEmbeddedResponseExample:
11168
11584
  summary: 'Create Embedded Signature Request'
11169
11585
  value:
@@ -11172,18 +11588,10 @@ components:
11172
11588
  summary: 'Create Embedded Signature Request With Template'
11173
11589
  value:
11174
11590
  $ref: examples/json/SignatureRequestCreateEmbeddedWithTemplateResponseExample.json
11175
- SignatureRequestGetResponseExample:
11176
- summary: 'Get Signature Request'
11177
- value:
11178
- $ref: examples/json/SignatureRequestGetResponseExample.json
11179
11591
  SignatureRequestFilesResponseExample:
11180
11592
  summary: 'Signature Requests Files'
11181
11593
  value:
11182
11594
  $ref: examples/json/SignatureRequestFilesResponseExample.json
11183
- SignatureRequestListResponseExample:
11184
- summary: 'List Signature Requests'
11185
- value:
11186
- $ref: examples/json/SignatureRequestListResponseExample.json
11187
11595
  SignatureRequestReleaseHoldResponseExample:
11188
11596
  summary: 'Send Signature Release Hold'
11189
11597
  value:
@@ -11212,34 +11620,14 @@ components:
11212
11620
  summary: 'Bulk Send Create Embedded Signature Request With Template'
11213
11621
  value:
11214
11622
  $ref: examples/json/SignatureRequestBulkCreateEmbeddedWithTemplateResponseExample.json
11215
- TeamAddMemberResponseExample:
11216
- summary: 'Team Add Member'
11217
- value:
11218
- $ref: examples/json/TeamAddMemberResponseExample.json
11219
11623
  TeamCreateResponseExample:
11220
11624
  summary: 'Team Create'
11221
11625
  value:
11222
11626
  $ref: examples/json/TeamCreateResponseExample.json
11223
- TeamGetResponseExample:
11224
- summary: 'Team Get'
11225
- value:
11226
- $ref: examples/json/TeamGetResponseExample.json
11227
- TeamGetInfoResponseExample:
11228
- summary: 'Team Get Info'
11229
- value:
11230
- $ref: examples/json/TeamGetInfoResponseExample.json
11231
- TeamInvitesResponseExample:
11232
- summary: 'Team Invites'
11233
- value:
11234
- $ref: examples/json/TeamInvitesResponseExample.json
11235
11627
  TeamMembersResponseExample:
11236
11628
  summary: 'Team Members List'
11237
11629
  value:
11238
11630
  $ref: examples/json/TeamMembersResponseExample.json
11239
- TeamSubTeamsResponseExample:
11240
- summary: 'Team Sub Teams List'
11241
- value:
11242
- $ref: examples/json/TeamSubTeamsResponseExample.json
11243
11631
  TeamRemoveMemberResponseExample:
11244
11632
  summary: 'Team Remove Member'
11245
11633
  value:
@@ -11256,34 +11644,14 @@ components:
11256
11644
  summary: 'Add User to Template'
11257
11645
  value:
11258
11646
  $ref: examples/json/TemplateAddUserResponseExample.json
11259
- TemplateCreateEmbeddedDraftResponseExample:
11260
- summary: 'Create Embedded Draft Template'
11261
- value:
11262
- $ref: examples/json/TemplateCreateEmbeddedDraftResponseExample.json
11263
11647
  TemplateFilesResponseExample:
11264
11648
  summary: 'Template Files'
11265
11649
  value:
11266
11650
  $ref: examples/json/TemplateFilesResponseExample.json
11267
- TemplateGetResponseExample:
11268
- summary: 'Get Template'
11269
- value:
11270
- $ref: examples/json/TemplateGetResponseExample.json
11271
- TemplateListResponseExample:
11272
- summary: 'List Templates'
11273
- value:
11274
- $ref: examples/json/TemplateListResponseExample.json
11275
11651
  TemplateRemoveUserResponseExample:
11276
11652
  summary: 'Remove User from Template'
11277
11653
  value:
11278
11654
  $ref: examples/json/TemplateRemoveUserResponseExample.json
11279
- TemplateUpdateFilesResponseExample:
11280
- summary: 'Update Template Files'
11281
- value:
11282
- $ref: examples/json/TemplateUpdateFilesResponseExample.json
11283
- UnclaimedDraftCreateResponseExample:
11284
- summary: 'Unclaimed Draft Create'
11285
- value:
11286
- $ref: examples/json/UnclaimedDraftCreateResponseExample.json
11287
11655
  UnclaimedDraftCreateEmbeddedResponseExample:
11288
11656
  summary: 'Unclaimed Draft Create Embedded'
11289
11657
  value:
@@ -11296,6 +11664,50 @@ components:
11296
11664
  summary: 'Unclaimed Draft Edit and Resend'
11297
11665
  value:
11298
11666
  $ref: examples/json/UnclaimedDraftEditAndResendExample.json
11667
+ TeamGetResponseExample:
11668
+ summary: 'Team Get'
11669
+ value:
11670
+ $ref: examples/json/TeamGetResponseExample.json
11671
+ TeamGetInfoResponseExample:
11672
+ summary: 'Team Get Info'
11673
+ value:
11674
+ $ref: examples/json/TeamGetInfoResponseExample.json
11675
+ TeamInvitesResponseExample:
11676
+ summary: 'Team Invites'
11677
+ value:
11678
+ $ref: examples/json/TeamInvitesResponseExample.json
11679
+ TeamAddMemberResponseExample:
11680
+ summary: 'Team Add Member'
11681
+ value:
11682
+ $ref: examples/json/TeamAddMemberResponseExample.json
11683
+ TeamSubTeamsResponseExample:
11684
+ summary: 'Team Sub Teams List'
11685
+ value:
11686
+ $ref: examples/json/TeamSubTeamsResponseExample.json
11687
+ TemplateCreateResponseExample:
11688
+ summary: 'Create Template'
11689
+ value:
11690
+ $ref: examples/json/TemplateCreateResponseExample.json
11691
+ TemplateCreateEmbeddedDraftResponseExample:
11692
+ summary: 'Create Embedded Draft Template'
11693
+ value:
11694
+ $ref: examples/json/TemplateCreateEmbeddedDraftResponseExample.json
11695
+ TemplateGetResponseExample:
11696
+ summary: 'Get Template'
11697
+ value:
11698
+ $ref: examples/json/TemplateGetResponseExample.json
11699
+ TemplateListResponseExample:
11700
+ summary: 'List Templates'
11701
+ value:
11702
+ $ref: examples/json/TemplateListResponseExample.json
11703
+ TemplateUpdateFilesResponseExample:
11704
+ summary: 'Update Template Files'
11705
+ value:
11706
+ $ref: examples/json/TemplateUpdateFilesResponseExample.json
11707
+ UnclaimedDraftCreateResponseExample:
11708
+ summary: 'Unclaimed Draft Create'
11709
+ value:
11710
+ $ref: examples/json/UnclaimedDraftCreateResponseExample.json
11299
11711
  requestBodies:
11300
11712
  EventCallbackAccountRequest:
11301
11713
  description: |-
@@ -11331,19 +11743,19 @@ components:
11331
11743
  schema:
11332
11744
  type: integer
11333
11745
  format: int32
11334
- example: 100
11746
+ example: 100
11335
11747
  X-RateLimit-Remaining:
11336
11748
  description: 'The number of requests remaining in the current rate limit window.'
11337
11749
  schema:
11338
11750
  type: integer
11339
11751
  format: int32
11340
- example: 99
11752
+ example: 99
11341
11753
  X-Ratelimit-Reset:
11342
11754
  description: 'The Unix time at which the rate limit will reset to its maximum.'
11343
11755
  schema:
11344
11756
  type: integer
11345
11757
  format: int64
11346
- example: 1430170900
11758
+ example: 1430170900
11347
11759
  securitySchemes:
11348
11760
  api_key:
11349
11761
  type: http