dropbox-sign 1.1.0 → 1.1.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (32) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +2 -1
  3. data/README.md +4 -4
  4. data/VERSION +1 -1
  5. data/docs/SignatureRequestCreateEmbeddedRequest.md +2 -2
  6. data/docs/SignatureRequestSendRequest.md +1 -1
  7. data/docs/SubFormFieldsPerDocumentBase.md +1 -1
  8. data/docs/TemplateCreateEmbeddedDraftRequest.md +1 -1
  9. data/docs/TemplateResponseDocumentCustomFieldBase.md +0 -1
  10. data/docs/TemplateResponseDocumentFormFieldBase.md +0 -1
  11. data/docs/TemplateResponseDocumentStaticFieldBase.md +0 -1
  12. data/docs/UnclaimedDraftCreateEmbeddedRequest.md +1 -1
  13. data/docs/UnclaimedDraftCreateRequest.md +1 -1
  14. data/lib/dropbox-sign/configuration.rb +1 -1
  15. data/lib/dropbox-sign/models/signature_request_create_embedded_request.rb +2 -2
  16. data/lib/dropbox-sign/models/signature_request_send_request.rb +1 -1
  17. data/lib/dropbox-sign/models/sub_form_fields_per_document_base.rb +1 -1
  18. data/lib/dropbox-sign/models/template_create_embedded_draft_request.rb +1 -1
  19. data/lib/dropbox-sign/models/template_response_document_custom_field_base.rb +5 -16
  20. data/lib/dropbox-sign/models/template_response_document_form_field_base.rb +5 -16
  21. data/lib/dropbox-sign/models/template_response_document_static_field_base.rb +5 -16
  22. data/lib/dropbox-sign/models/unclaimed_draft_create_embedded_request.rb +1 -1
  23. data/lib/dropbox-sign/models/unclaimed_draft_create_request.rb +1 -1
  24. data/lib/dropbox-sign/version.rb +1 -1
  25. data/openapi-config.yaml +1 -1
  26. data/openapi-sdk.yaml +902 -962
  27. data/spec/configuration_spec.rb +5 -7
  28. data/templates/configuration.mustache +1 -1
  29. data/templates/configuration_spec.mustache +5 -7
  30. data/test_fixtures/TemplateGetResponse.json +22 -84
  31. data/test_fixtures/TemplateListResponse.json +9 -39
  32. metadata +8 -8
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
@@ -3487,7 +3487,6 @@ paths:
3487
3487
  schema:
3488
3488
  type: string
3489
3489
  example: 4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c
3490
- x-beta: closed
3491
3490
  requestBody:
3492
3491
  required: true
3493
3492
  content:
@@ -4067,7 +4066,6 @@ paths:
4067
4066
  label: cURL
4068
4067
  source:
4069
4068
  $ref: examples/TeamInfo.sh
4070
- x-beta: closed
4071
4069
  x-meta:
4072
4070
  seo:
4073
4071
  title: 'Get Team Info | Dropbox Sign for Developers'
@@ -4290,7 +4288,6 @@ paths:
4290
4288
  label: cURL
4291
4289
  source:
4292
4290
  $ref: examples/TeamMembers.sh
4293
- x-beta: closed
4294
4291
  x-meta:
4295
4292
  seo:
4296
4293
  title: 'List Team Members | Dropbox Sign for Developers'
@@ -4517,7 +4514,6 @@ paths:
4517
4514
  label: cURL
4518
4515
  source:
4519
4516
  $ref: examples/TeamSubTeams.sh
4520
- x-beta: closed
4521
4517
  x-meta:
4522
4518
  seo:
4523
4519
  title: 'List Sub Teams | Dropbox Sign for Developers'
@@ -6298,7 +6294,6 @@ components:
6298
6294
  - text-merge
6299
6295
  SubFormFieldsPerDocumentText:
6300
6296
  description: 'This class extends `SubFormFieldsPerDocumentBase`.'
6301
- type: object
6302
6297
  allOf:
6303
6298
  -
6304
6299
  $ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
@@ -6347,7 +6342,6 @@ components:
6347
6342
  type: object
6348
6343
  SubFormFieldsPerDocumentDropdown:
6349
6344
  description: 'This class extends `SubFormFieldsPerDocumentBase`.'
6350
- type: object
6351
6345
  allOf:
6352
6346
  -
6353
6347
  $ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
@@ -6372,7 +6366,6 @@ components:
6372
6366
  type: object
6373
6367
  SubFormFieldsPerDocumentHyperlink:
6374
6368
  description: 'This class extends `SubFormFieldsPerDocumentBase`.'
6375
- type: object
6376
6369
  allOf:
6377
6370
  -
6378
6371
  $ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
@@ -6395,7 +6388,6 @@ components:
6395
6388
  type: object
6396
6389
  SubFormFieldsPerDocumentCheckbox:
6397
6390
  description: 'This class extends `SubFormFieldsPerDocumentBase`.'
6398
- type: object
6399
6391
  allOf:
6400
6392
  -
6401
6393
  $ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
@@ -6417,7 +6409,6 @@ components:
6417
6409
  type: object
6418
6410
  SubFormFieldsPerDocumentRadio:
6419
6411
  description: 'This class extends `SubFormFieldsPerDocumentBase`.'
6420
- type: object
6421
6412
  allOf:
6422
6413
  -
6423
6414
  $ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
@@ -6440,7 +6431,6 @@ components:
6440
6431
  type: object
6441
6432
  SubFormFieldsPerDocumentSignature:
6442
6433
  description: 'This class extends `SubFormFieldsPerDocumentBase`.'
6443
- type: object
6444
6434
  allOf:
6445
6435
  -
6446
6436
  $ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
@@ -6455,7 +6445,6 @@ components:
6455
6445
  type: object
6456
6446
  SubFormFieldsPerDocumentDateSigned:
6457
6447
  description: 'This class extends `SubFormFieldsPerDocumentBase`.'
6458
- type: object
6459
6448
  allOf:
6460
6449
  -
6461
6450
  $ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
@@ -6470,7 +6459,6 @@ components:
6470
6459
  type: object
6471
6460
  SubFormFieldsPerDocumentInitials:
6472
6461
  description: 'This class extends `SubFormFieldsPerDocumentBase`.'
6473
- type: object
6474
6462
  allOf:
6475
6463
  -
6476
6464
  $ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
@@ -6485,7 +6473,6 @@ components:
6485
6473
  type: object
6486
6474
  SubFormFieldsPerDocumentTextMerge:
6487
6475
  description: 'This class extends `SubFormFieldsPerDocumentBase`.'
6488
- type: object
6489
6476
  allOf:
6490
6477
  -
6491
6478
  $ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
@@ -6500,7 +6487,6 @@ components:
6500
6487
  type: object
6501
6488
  SubFormFieldsPerDocumentCheckboxMerge:
6502
6489
  description: 'This class extends `SubFormFieldsPerDocumentBase`.'
6503
- type: object
6504
6490
  allOf:
6505
6491
  -
6506
6492
  $ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
@@ -6835,7 +6821,7 @@ components:
6835
6821
  $ref: '#/components/schemas/SubFormFieldRule'
6836
6822
  form_fields_per_document:
6837
6823
  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).)
6824
+ 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
6825
 
6840
6826
  **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
6827
 
@@ -6897,10 +6883,7 @@ components:
6897
6883
  type: boolean
6898
6884
  default: false
6899
6885
  expires_at:
6900
- description: |-
6901
- 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.
6902
-
6903
- **Note**: This does not correspond to the **expires_at** returned in the response.
6886
+ 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.'
6904
6887
  type: integer
6905
6888
  nullable: true
6906
6889
  x-beta: closed
@@ -7085,7 +7068,7 @@ components:
7085
7068
  $ref: '#/components/schemas/SubFormFieldRule'
7086
7069
  form_fields_per_document:
7087
7070
  description: |-
7088
- 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).)
7071
+ 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).)
7089
7072
 
7090
7073
  **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.
7091
7074
 
@@ -7543,7 +7526,7 @@ components:
7543
7526
  type: object
7544
7527
  SubFormFieldsPerDocumentBase:
7545
7528
  description: |-
7546
- 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).)
7529
+ The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)
7547
7530
 
7548
7531
  **NOTE**: Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.
7549
7532
 
@@ -7929,7 +7912,6 @@ components:
7929
7912
  - Developer
7930
7913
  - 'Team Manager'
7931
7914
  - Admin
7932
- x-beta: closed
7933
7915
  type: object
7934
7916
  TeamCreateRequest:
7935
7917
  properties:
@@ -7963,7 +7945,6 @@ components:
7963
7945
  new_team_id:
7964
7946
  description: 'Id of the new Team.'
7965
7947
  type: string
7966
- x-beta: closed
7967
7948
  new_role:
7968
7949
  description: |-
7969
7950
  A new role member will take in a new Team.
@@ -7975,7 +7956,6 @@ components:
7975
7956
  - Developer
7976
7957
  - 'Team Manager'
7977
7958
  - Admin
7978
- x-beta: closed
7979
7959
  type: object
7980
7960
  TeamUpdateRequest:
7981
7961
  properties:
@@ -8070,7 +8050,7 @@ components:
8070
8050
  $ref: '#/components/schemas/SubFormFieldRule'
8071
8051
  form_fields_per_document:
8072
8052
  description: |-
8073
- 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).)
8053
+ 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).)
8074
8054
 
8075
8055
  **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.
8076
8056
 
@@ -8252,7 +8232,7 @@ components:
8252
8232
  $ref: '#/components/schemas/SubFormFieldRule'
8253
8233
  form_fields_per_document:
8254
8234
  description: |-
8255
- 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).)
8235
+ 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).)
8256
8236
 
8257
8237
  **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.
8258
8238
 
@@ -8416,7 +8396,7 @@ components:
8416
8396
  $ref: '#/components/schemas/SubFormFieldRule'
8417
8397
  form_fields_per_document:
8418
8398
  description: |-
8419
- 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).)
8399
+ 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).)
8420
8400
 
8421
8401
  **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.
8422
8402
 
@@ -8706,43 +8686,6 @@ components:
8706
8686
  type: boolean
8707
8687
  default: false
8708
8688
  type: object
8709
- AccountResponse:
8710
- properties:
8711
- account_id:
8712
- description: 'The ID of the Account'
8713
- type: string
8714
- email_address:
8715
- description: 'The email address associated with the Account.'
8716
- type: string
8717
- is_locked:
8718
- description: 'Returns `true` if the user has been locked out of their account by a team admin.'
8719
- type: boolean
8720
- is_paid_hs:
8721
- description: 'Returns `true` if the user has a paid Dropbox Sign account.'
8722
- type: boolean
8723
- is_paid_hf:
8724
- description: 'Returns `true` if the user has a paid HelloFax account.'
8725
- type: boolean
8726
- quotas:
8727
- $ref: '#/components/schemas/AccountResponseQuotas'
8728
- callback_url:
8729
- description: 'The URL that Dropbox Sign events will `POST` to.'
8730
- type: string
8731
- nullable: true
8732
- role_code:
8733
- description: 'The membership role for the team.'
8734
- type: string
8735
- nullable: true
8736
- team_id:
8737
- description: 'The id of the team account belongs to.'
8738
- type: string
8739
- nullable: true
8740
- locale:
8741
- description: 'The locale used in this Account. Check out the list of [supported locales](/api/reference/constants/#supported-locales) to learn more about the possible values.'
8742
- type: string
8743
- nullable: true
8744
- type: object
8745
- x-internal: true
8746
8689
  AccountCreateResponse:
8747
8690
  properties:
8748
8691
  account:
@@ -8778,72 +8721,6 @@ components:
8778
8721
  $ref: '#/components/schemas/WarningResponse'
8779
8722
  type: object
8780
8723
  x-internal: true
8781
- AccountVerifyResponseAccount:
8782
- properties:
8783
- email_address:
8784
- description: 'The email address associated with the Account.'
8785
- type: string
8786
- type: object
8787
- x-internal: true
8788
- AccountResponseQuotas:
8789
- description: 'Details concerning remaining monthly quotas.'
8790
- properties:
8791
- api_signature_requests_left:
8792
- description: 'API signature requests remaining.'
8793
- type: integer
8794
- nullable: true
8795
- documents_left:
8796
- description: 'Signature requests remaining.'
8797
- type: integer
8798
- nullable: true
8799
- templates_total:
8800
- description: 'Total API templates allowed.'
8801
- type: integer
8802
- nullable: true
8803
- templates_left:
8804
- description: 'API templates remaining.'
8805
- type: integer
8806
- nullable: true
8807
- sms_verifications_left:
8808
- description: 'SMS verifications remaining.'
8809
- type: integer
8810
- nullable: true
8811
- type: object
8812
- x-internal: true
8813
- ApiAppResponse:
8814
- description: 'Contains information about an API App.'
8815
- properties:
8816
- callback_url:
8817
- description: 'The app''s callback URL (for events)'
8818
- type: string
8819
- nullable: true
8820
- client_id:
8821
- description: 'The app''s client id'
8822
- type: string
8823
- created_at:
8824
- description: 'The time that the app was created'
8825
- type: integer
8826
- domains:
8827
- description: 'The domain name(s) associated with the app'
8828
- type: array
8829
- items:
8830
- type: string
8831
- name:
8832
- description: 'The name of the app'
8833
- type: string
8834
- is_approved:
8835
- description: 'Boolean to indicate if the app has been approved'
8836
- type: boolean
8837
- oauth:
8838
- $ref: '#/components/schemas/ApiAppResponseOAuth'
8839
- options:
8840
- $ref: '#/components/schemas/ApiAppResponseOptions'
8841
- owner_account:
8842
- $ref: '#/components/schemas/ApiAppResponseOwnerAccount'
8843
- white_labeling_options:
8844
- $ref: '#/components/schemas/ApiAppResponseWhiteLabelingOptions'
8845
- type: object
8846
- x-internal: true
8847
8724
  ApiAppGetResponse:
8848
8725
  properties:
8849
8726
  api_app:
@@ -8871,98 +8748,6 @@ components:
8871
8748
  $ref: '#/components/schemas/WarningResponse'
8872
8749
  type: object
8873
8750
  x-internal: true
8874
- ApiAppResponseOAuth:
8875
- description: 'An object describing the app''s OAuth properties, or null if OAuth is not configured for the app.'
8876
- properties:
8877
- callback_url:
8878
- description: 'The app''s OAuth callback URL.'
8879
- type: string
8880
- secret:
8881
- description: 'The app''s OAuth secret, or null if the app does not belong to user.'
8882
- type: string
8883
- scopes:
8884
- description: 'Array of OAuth scopes used by the app.'
8885
- type: array
8886
- items:
8887
- type: string
8888
- charges_users:
8889
- description: 'Boolean indicating whether the app owner or the account granting permission is billed for OAuth requests.'
8890
- type: boolean
8891
- type: object
8892
- nullable: true
8893
- x-internal: true
8894
- ApiAppResponseOptions:
8895
- description: 'An object with options that override account settings.'
8896
- properties:
8897
- can_insert_everywhere:
8898
- description: 'Boolean denoting if signers can "Insert Everywhere" in one click while signing a document'
8899
- type: boolean
8900
- type: object
8901
- nullable: true
8902
- x-internal: true
8903
- ApiAppResponseOwnerAccount:
8904
- description: 'An object describing the app''s owner'
8905
- properties:
8906
- account_id:
8907
- description: 'The owner account''s ID'
8908
- type: string
8909
- email_address:
8910
- description: 'The owner account''s email address'
8911
- type: string
8912
- type: object
8913
- x-internal: true
8914
- ApiAppResponseWhiteLabelingOptions:
8915
- description: 'An object with options to customize the app''s signer page'
8916
- properties:
8917
- header_background_color:
8918
- type: string
8919
- legal_version:
8920
- type: string
8921
- link_color:
8922
- type: string
8923
- page_background_color:
8924
- type: string
8925
- primary_button_color:
8926
- type: string
8927
- primary_button_color_hover:
8928
- type: string
8929
- primary_button_text_color:
8930
- type: string
8931
- primary_button_text_color_hover:
8932
- type: string
8933
- secondary_button_color:
8934
- type: string
8935
- secondary_button_color_hover:
8936
- type: string
8937
- secondary_button_text_color:
8938
- type: string
8939
- secondary_button_text_color_hover:
8940
- type: string
8941
- text_color1:
8942
- type: string
8943
- text_color2:
8944
- type: string
8945
- type: object
8946
- nullable: true
8947
- x-internal: true
8948
- BulkSendJobResponse:
8949
- description: 'Contains information about the BulkSendJob such as when it was created and how many signature requests are queued.'
8950
- properties:
8951
- bulk_send_job_id:
8952
- description: 'The id of the BulkSendJob.'
8953
- type: string
8954
- nullable: true
8955
- total:
8956
- description: 'The total amount of Signature Requests queued for sending.'
8957
- type: integer
8958
- is_creator:
8959
- description: 'True if you are the owner of this BulkSendJob, false if it''s been shared with you by a team member.'
8960
- type: boolean
8961
- created_at:
8962
- description: 'Time that the BulkSendJob was created.'
8963
- type: integer
8964
- type: object
8965
- x-internal: true
8966
8751
  BulkSendJobGetResponse:
8967
8752
  properties:
8968
8753
  bulk_send_job:
@@ -8981,18 +8766,6 @@ components:
8981
8766
  $ref: '#/components/schemas/WarningResponse'
8982
8767
  type: object
8983
8768
  x-internal: true
8984
- BulkSendJobGetResponseSignatureRequests:
8985
- title: BulkSendJobGetResponseSignatureRequests
8986
- type: object
8987
- allOf:
8988
- -
8989
- $ref: '#/components/schemas/SignatureRequestResponse'
8990
- -
8991
- properties:
8992
- bulk_send_job_id:
8993
- description: 'The id of the BulkSendJob.'
8994
- type: string
8995
- x-internal: true
8996
8769
  BulkSendJobListResponse:
8997
8770
  properties:
8998
8771
  bulk_send_jobs:
@@ -9031,17 +8804,6 @@ components:
9031
8804
  $ref: '#/components/schemas/WarningResponse'
9032
8805
  type: object
9033
8806
  x-internal: true
9034
- EmbeddedEditUrlResponseEmbedded:
9035
- description: 'An embedded template object.'
9036
- properties:
9037
- edit_url:
9038
- description: 'A template url that can be opened in an iFrame.'
9039
- type: string
9040
- expires_at:
9041
- description: 'The specific time that the the `edit_url` link expires, in epoch.'
9042
- type: integer
9043
- type: object
9044
- x-internal: true
9045
8807
  EmbeddedSignUrlResponse:
9046
8808
  properties:
9047
8809
  embedded:
@@ -9053,24 +8815,327 @@ components:
9053
8815
  $ref: '#/components/schemas/WarningResponse'
9054
8816
  type: object
9055
8817
  x-internal: true
9056
- EmbeddedSignUrlResponseEmbedded:
9057
- description: 'An object that contains necessary information to set up embedded signing.'
8818
+ ErrorResponse:
8819
+ required:
8820
+ - error
9058
8821
  properties:
9059
- sign_url:
9060
- description: 'A signature url that can be opened in an iFrame.'
9061
- type: string
9062
- expires_at:
9063
- description: 'The specific time that the the `sign_url` link expires, in epoch.'
8822
+ error:
8823
+ $ref: '#/components/schemas/ErrorResponseError'
8824
+ type: object
8825
+ EventCallbackRequest:
8826
+ title: EventCallbackRequest
8827
+ required:
8828
+ - event
8829
+ properties:
8830
+ event:
8831
+ $ref: '#/components/schemas/EventCallbackRequestEvent'
8832
+ account:
8833
+ $ref: '#/components/schemas/AccountResponse'
8834
+ signature_request:
8835
+ $ref: '#/components/schemas/SignatureRequestResponse'
8836
+ template:
8837
+ $ref: '#/components/schemas/TemplateResponse'
8838
+ type: object
8839
+ FileResponse:
8840
+ properties:
8841
+ file_url:
8842
+ description: 'URL to the file.'
8843
+ type: string
8844
+ expires_at:
8845
+ description: 'When the link expires.'
8846
+ type: integer
8847
+ type: object
8848
+ x-internal: true
8849
+ FileResponseDataUri:
8850
+ properties:
8851
+ data_uri:
8852
+ description: 'File as base64 encoded string.'
8853
+ type: string
8854
+ type: object
8855
+ x-internal: true
8856
+ ReportCreateResponse:
8857
+ properties:
8858
+ report:
8859
+ $ref: '#/components/schemas/ReportResponse'
8860
+ warnings:
8861
+ description: 'A list of warnings.'
8862
+ type: array
8863
+ items:
8864
+ $ref: '#/components/schemas/WarningResponse'
8865
+ type: object
8866
+ x-internal: true
8867
+ SignatureRequestGetResponse:
8868
+ properties:
8869
+ signature_request:
8870
+ $ref: '#/components/schemas/SignatureRequestResponse'
8871
+ warnings:
8872
+ description: 'A list of warnings.'
8873
+ type: array
8874
+ items:
8875
+ $ref: '#/components/schemas/WarningResponse'
8876
+ type: object
8877
+ x-internal: true
8878
+ SignatureRequestListResponse:
8879
+ properties:
8880
+ signature_requests:
8881
+ description: 'Contains information about signature requests.'
8882
+ type: array
8883
+ items:
8884
+ $ref: '#/components/schemas/SignatureRequestResponse'
8885
+ list_info:
8886
+ $ref: '#/components/schemas/ListInfoResponse'
8887
+ warnings:
8888
+ description: 'A list of warnings.'
8889
+ type: array
8890
+ items:
8891
+ $ref: '#/components/schemas/WarningResponse'
8892
+ type: object
8893
+ x-internal: true
8894
+ AccountResponse:
8895
+ properties:
8896
+ account_id:
8897
+ description: 'The ID of the Account'
8898
+ type: string
8899
+ email_address:
8900
+ description: 'The email address associated with the Account.'
8901
+ type: string
8902
+ is_locked:
8903
+ description: 'Returns `true` if the user has been locked out of their account by a team admin.'
8904
+ type: boolean
8905
+ is_paid_hs:
8906
+ description: 'Returns `true` if the user has a paid Dropbox Sign account.'
8907
+ type: boolean
8908
+ is_paid_hf:
8909
+ description: 'Returns `true` if the user has a paid HelloFax account.'
8910
+ type: boolean
8911
+ quotas:
8912
+ $ref: '#/components/schemas/AccountResponseQuotas'
8913
+ callback_url:
8914
+ description: 'The URL that Dropbox Sign events will `POST` to.'
8915
+ type: string
8916
+ nullable: true
8917
+ role_code:
8918
+ description: 'The membership role for the team.'
8919
+ type: string
8920
+ nullable: true
8921
+ team_id:
8922
+ description: 'The id of the team account belongs to.'
8923
+ type: string
8924
+ nullable: true
8925
+ locale:
8926
+ description: 'The locale used in this Account. Check out the list of [supported locales](/api/reference/constants/#supported-locales) to learn more about the possible values.'
8927
+ type: string
8928
+ nullable: true
8929
+ type: object
8930
+ x-internal: true
8931
+ OAuthTokenResponse:
8932
+ properties:
8933
+ access_token:
8934
+ type: string
8935
+ token_type:
8936
+ type: string
8937
+ refresh_token:
8938
+ type: string
8939
+ expires_in:
8940
+ description: 'Number of seconds until the `access_token` expires. Uses epoch time.'
8941
+ type: integer
8942
+ state:
8943
+ type: string
8944
+ nullable: true
8945
+ type: object
8946
+ x-internal: true
8947
+ AccountResponseQuotas:
8948
+ description: 'Details concerning remaining monthly quotas.'
8949
+ properties:
8950
+ api_signature_requests_left:
8951
+ description: 'API signature requests remaining.'
8952
+ type: integer
8953
+ nullable: true
8954
+ documents_left:
8955
+ description: 'Signature requests remaining.'
8956
+ type: integer
8957
+ nullable: true
8958
+ templates_total:
8959
+ description: 'Total API templates allowed.'
8960
+ type: integer
8961
+ nullable: true
8962
+ templates_left:
8963
+ description: 'API templates remaining.'
8964
+ type: integer
8965
+ nullable: true
8966
+ sms_verifications_left:
8967
+ description: 'SMS verifications remaining.'
8968
+ type: integer
8969
+ nullable: true
8970
+ type: object
8971
+ x-internal: true
8972
+ AccountVerifyResponseAccount:
8973
+ properties:
8974
+ email_address:
8975
+ description: 'The email address associated with the Account.'
8976
+ type: string
8977
+ type: object
8978
+ x-internal: true
8979
+ ApiAppResponse:
8980
+ description: 'Contains information about an API App.'
8981
+ properties:
8982
+ callback_url:
8983
+ description: 'The app''s callback URL (for events)'
8984
+ type: string
8985
+ nullable: true
8986
+ client_id:
8987
+ description: 'The app''s client id'
8988
+ type: string
8989
+ created_at:
8990
+ description: 'The time that the app was created'
8991
+ type: integer
8992
+ domains:
8993
+ description: 'The domain name(s) associated with the app'
8994
+ type: array
8995
+ items:
8996
+ type: string
8997
+ name:
8998
+ description: 'The name of the app'
8999
+ type: string
9000
+ is_approved:
9001
+ description: 'Boolean to indicate if the app has been approved'
9002
+ type: boolean
9003
+ oauth:
9004
+ $ref: '#/components/schemas/ApiAppResponseOAuth'
9005
+ options:
9006
+ $ref: '#/components/schemas/ApiAppResponseOptions'
9007
+ owner_account:
9008
+ $ref: '#/components/schemas/ApiAppResponseOwnerAccount'
9009
+ white_labeling_options:
9010
+ $ref: '#/components/schemas/ApiAppResponseWhiteLabelingOptions'
9011
+ type: object
9012
+ x-internal: true
9013
+ ApiAppResponseOAuth:
9014
+ description: 'An object describing the app''s OAuth properties, or null if OAuth is not configured for the app.'
9015
+ properties:
9016
+ callback_url:
9017
+ description: 'The app''s OAuth callback URL.'
9018
+ type: string
9019
+ secret:
9020
+ description: 'The app''s OAuth secret, or null if the app does not belong to user.'
9021
+ type: string
9022
+ scopes:
9023
+ description: 'Array of OAuth scopes used by the app.'
9024
+ type: array
9025
+ items:
9026
+ type: string
9027
+ charges_users:
9028
+ description: 'Boolean indicating whether the app owner or the account granting permission is billed for OAuth requests.'
9029
+ type: boolean
9030
+ type: object
9031
+ nullable: true
9032
+ x-internal: true
9033
+ ApiAppResponseOptions:
9034
+ description: 'An object with options that override account settings.'
9035
+ properties:
9036
+ can_insert_everywhere:
9037
+ description: 'Boolean denoting if signers can "Insert Everywhere" in one click while signing a document'
9038
+ type: boolean
9039
+ type: object
9040
+ nullable: true
9041
+ x-internal: true
9042
+ ApiAppResponseOwnerAccount:
9043
+ description: 'An object describing the app''s owner'
9044
+ properties:
9045
+ account_id:
9046
+ description: 'The owner account''s ID'
9047
+ type: string
9048
+ email_address:
9049
+ description: 'The owner account''s email address'
9050
+ type: string
9051
+ type: object
9052
+ x-internal: true
9053
+ ApiAppResponseWhiteLabelingOptions:
9054
+ description: 'An object with options to customize the app''s signer page'
9055
+ properties:
9056
+ header_background_color:
9057
+ type: string
9058
+ legal_version:
9059
+ type: string
9060
+ link_color:
9061
+ type: string
9062
+ page_background_color:
9063
+ type: string
9064
+ primary_button_color:
9065
+ type: string
9066
+ primary_button_color_hover:
9067
+ type: string
9068
+ primary_button_text_color:
9069
+ type: string
9070
+ primary_button_text_color_hover:
9071
+ type: string
9072
+ secondary_button_color:
9073
+ type: string
9074
+ secondary_button_color_hover:
9075
+ type: string
9076
+ secondary_button_text_color:
9077
+ type: string
9078
+ secondary_button_text_color_hover:
9079
+ type: string
9080
+ text_color1:
9081
+ type: string
9082
+ text_color2:
9083
+ type: string
9084
+ type: object
9085
+ nullable: true
9086
+ x-internal: true
9087
+ BulkSendJobResponse:
9088
+ description: 'Contains information about the BulkSendJob such as when it was created and how many signature requests are queued.'
9089
+ properties:
9090
+ bulk_send_job_id:
9091
+ description: 'The id of the BulkSendJob.'
9092
+ type: string
9093
+ nullable: true
9094
+ total:
9095
+ description: 'The total amount of Signature Requests queued for sending.'
9096
+ type: integer
9097
+ is_creator:
9098
+ description: 'True if you are the owner of this BulkSendJob, false if it''s been shared with you by a team member.'
9099
+ type: boolean
9100
+ created_at:
9101
+ description: 'Time that the BulkSendJob was created.'
9102
+ type: integer
9103
+ type: object
9104
+ x-internal: true
9105
+ BulkSendJobGetResponseSignatureRequests:
9106
+ title: BulkSendJobGetResponseSignatureRequests
9107
+ type: object
9108
+ allOf:
9109
+ -
9110
+ $ref: '#/components/schemas/SignatureRequestResponse'
9111
+ -
9112
+ properties:
9113
+ bulk_send_job_id:
9114
+ description: 'The id of the BulkSendJob.'
9115
+ type: string
9116
+ x-internal: true
9117
+ EmbeddedEditUrlResponseEmbedded:
9118
+ description: 'An embedded template object.'
9119
+ properties:
9120
+ edit_url:
9121
+ description: 'A template url that can be opened in an iFrame.'
9122
+ type: string
9123
+ expires_at:
9124
+ description: 'The specific time that the the `edit_url` link expires, in epoch.'
9064
9125
  type: integer
9065
9126
  type: object
9066
9127
  x-internal: true
9067
- ErrorResponse:
9068
- required:
9069
- - error
9128
+ EmbeddedSignUrlResponseEmbedded:
9129
+ description: 'An object that contains necessary information to set up embedded signing.'
9070
9130
  properties:
9071
- error:
9072
- $ref: '#/components/schemas/ErrorResponseError'
9131
+ sign_url:
9132
+ description: 'A signature url that can be opened in an iFrame.'
9133
+ type: string
9134
+ expires_at:
9135
+ description: 'The specific time that the the `sign_url` link expires, in epoch.'
9136
+ type: integer
9073
9137
  type: object
9138
+ x-internal: true
9074
9139
  ErrorResponseError:
9075
9140
  description: 'Contains information about an error that occurred.'
9076
9141
  required:
@@ -9087,20 +9152,6 @@ components:
9087
9152
  description: 'Name of the error.'
9088
9153
  type: string
9089
9154
  type: object
9090
- EventCallbackRequest:
9091
- title: EventCallbackRequest
9092
- required:
9093
- - event
9094
- properties:
9095
- event:
9096
- $ref: '#/components/schemas/EventCallbackRequestEvent'
9097
- account:
9098
- $ref: '#/components/schemas/AccountResponse'
9099
- signature_request:
9100
- $ref: '#/components/schemas/SignatureRequestResponse'
9101
- template:
9102
- $ref: '#/components/schemas/TemplateResponse'
9103
- type: object
9104
9155
  EventCallbackRequestEvent:
9105
9156
  description: 'Basic information about the event that occurred.'
9106
9157
  required:
@@ -9164,23 +9215,6 @@ components:
9164
9215
  type: string
9165
9216
  nullable: true
9166
9217
  type: object
9167
- FileResponse:
9168
- properties:
9169
- file_url:
9170
- description: 'URL to the file.'
9171
- type: string
9172
- expires_at:
9173
- description: 'When the link expires.'
9174
- type: integer
9175
- type: object
9176
- x-internal: true
9177
- FileResponseDataUri:
9178
- properties:
9179
- data_uri:
9180
- description: 'File as base64 encoded string.'
9181
- type: string
9182
- type: object
9183
- x-internal: true
9184
9218
  ListInfoResponse:
9185
9219
  description: 'Contains pagination information about the data returned.'
9186
9220
  properties:
@@ -9199,169 +9233,6 @@ components:
9199
9233
  type: integer
9200
9234
  type: object
9201
9235
  x-internal: true
9202
- SignatureRequestResponseDataTypeEnum:
9203
- type: string
9204
- enum:
9205
- - text
9206
- - checkbox
9207
- - date_signed
9208
- - dropdown
9209
- - initials
9210
- - radio
9211
- - signature
9212
- - text-merge
9213
- - checkbox-merge
9214
- SignatureRequestResponseDataValueText:
9215
- type: object
9216
- allOf:
9217
- -
9218
- $ref: '#/components/schemas/SignatureRequestResponseDataBase'
9219
- -
9220
- properties:
9221
- type:
9222
- description: 'A text input field'
9223
- type: string
9224
- default: text
9225
- value:
9226
- description: 'The value of the form field.'
9227
- type: string
9228
- type: object
9229
- SignatureRequestResponseDataValueDropdown:
9230
- type: object
9231
- allOf:
9232
- -
9233
- $ref: '#/components/schemas/SignatureRequestResponseDataBase'
9234
- -
9235
- properties:
9236
- type:
9237
- description: 'An input field for dropdowns'
9238
- type: string
9239
- default: dropdown
9240
- value:
9241
- description: 'The value of the form field.'
9242
- type: string
9243
- type: object
9244
- SignatureRequestResponseDataValueRadio:
9245
- type: object
9246
- allOf:
9247
- -
9248
- $ref: '#/components/schemas/SignatureRequestResponseDataBase'
9249
- -
9250
- properties:
9251
- type:
9252
- description: 'An input field for radios'
9253
- type: string
9254
- default: radio
9255
- value:
9256
- description: 'The value of the form field.'
9257
- type: boolean
9258
- type: object
9259
- SignatureRequestResponseDataValueDateSigned:
9260
- type: object
9261
- allOf:
9262
- -
9263
- $ref: '#/components/schemas/SignatureRequestResponseDataBase'
9264
- -
9265
- properties:
9266
- type:
9267
- description: 'A date'
9268
- type: string
9269
- default: date_signed
9270
- value:
9271
- description: 'The value of the form field.'
9272
- type: string
9273
- type: object
9274
- SignatureRequestResponseDataValueInitials:
9275
- type: object
9276
- allOf:
9277
- -
9278
- $ref: '#/components/schemas/SignatureRequestResponseDataBase'
9279
- -
9280
- properties:
9281
- type:
9282
- description: 'An input field for initials'
9283
- type: string
9284
- default: initials
9285
- value:
9286
- description: 'The value of the form field.'
9287
- type: string
9288
- type: object
9289
- SignatureRequestResponseDataValueCheckbox:
9290
- type: object
9291
- allOf:
9292
- -
9293
- $ref: '#/components/schemas/SignatureRequestResponseDataBase'
9294
- -
9295
- properties:
9296
- type:
9297
- description: 'A yes/no checkbox'
9298
- type: string
9299
- default: checkbox
9300
- value:
9301
- description: 'The value of the form field.'
9302
- type: boolean
9303
- type: object
9304
- SignatureRequestResponseDataValueSignature:
9305
- type: object
9306
- allOf:
9307
- -
9308
- $ref: '#/components/schemas/SignatureRequestResponseDataBase'
9309
- -
9310
- properties:
9311
- type:
9312
- description: 'A signature input field'
9313
- type: string
9314
- default: signature
9315
- value:
9316
- description: 'The value of the form field.'
9317
- type: string
9318
- type: object
9319
- SignatureRequestResponseDataValueTextMerge:
9320
- type: object
9321
- allOf:
9322
- -
9323
- $ref: '#/components/schemas/SignatureRequestResponseDataBase'
9324
- -
9325
- properties:
9326
- type:
9327
- description: 'A text field that has default text set by the api'
9328
- type: string
9329
- default: text-merge
9330
- value:
9331
- description: 'The value of the form field.'
9332
- type: string
9333
- type: object
9334
- SignatureRequestResponseDataValueCheckboxMerge:
9335
- type: object
9336
- allOf:
9337
- -
9338
- $ref: '#/components/schemas/SignatureRequestResponseDataBase'
9339
- -
9340
- properties:
9341
- type:
9342
- description: 'A checkbox field that has default value set by the api'
9343
- type: string
9344
- default: checkbox-merge
9345
- value:
9346
- description: 'The value of the form field.'
9347
- type: string
9348
- type: object
9349
- OAuthTokenResponse:
9350
- properties:
9351
- access_token:
9352
- type: string
9353
- token_type:
9354
- type: string
9355
- refresh_token:
9356
- type: string
9357
- expires_in:
9358
- description: 'Number of seconds until the `access_token` expires. Uses epoch time.'
9359
- type: integer
9360
- state:
9361
- type: string
9362
- nullable: true
9363
- type: object
9364
- x-internal: true
9365
9236
  ReportResponse:
9366
9237
  description: 'Contains information about the report request.'
9367
9238
  properties:
@@ -9383,17 +9254,6 @@ components:
9383
9254
  - document_status
9384
9255
  type: object
9385
9256
  x-internal: true
9386
- ReportCreateResponse:
9387
- properties:
9388
- report:
9389
- $ref: '#/components/schemas/ReportResponse'
9390
- warnings:
9391
- description: 'A list of warnings.'
9392
- type: array
9393
- items:
9394
- $ref: '#/components/schemas/WarningResponse'
9395
- type: object
9396
- x-internal: true
9397
9257
  SignatureRequestResponse:
9398
9258
  description: 'Contains information about a signature request.'
9399
9259
  properties:
@@ -9495,33 +9355,6 @@ components:
9495
9355
  $ref: '#/components/schemas/SignatureRequestResponseSignatures'
9496
9356
  type: object
9497
9357
  x-internal: true
9498
- SignatureRequestGetResponse:
9499
- properties:
9500
- signature_request:
9501
- $ref: '#/components/schemas/SignatureRequestResponse'
9502
- warnings:
9503
- description: 'A list of warnings.'
9504
- type: array
9505
- items:
9506
- $ref: '#/components/schemas/WarningResponse'
9507
- type: object
9508
- x-internal: true
9509
- SignatureRequestListResponse:
9510
- properties:
9511
- signature_requests:
9512
- description: 'Contains information about signature requests.'
9513
- type: array
9514
- items:
9515
- $ref: '#/components/schemas/SignatureRequestResponse'
9516
- list_info:
9517
- $ref: '#/components/schemas/ListInfoResponse'
9518
- warnings:
9519
- description: 'A list of warnings.'
9520
- type: array
9521
- items:
9522
- $ref: '#/components/schemas/WarningResponse'
9523
- type: object
9524
- x-internal: true
9525
9358
  SignatureRequestResponseAttachment:
9526
9359
  description: 'Signer attachments.'
9527
9360
  required:
@@ -9552,11 +9385,6 @@ components:
9552
9385
  nullable: true
9553
9386
  type: object
9554
9387
  x-internal: true
9555
- SignatureRequestResponseCustomFieldTypeEnum:
9556
- type: string
9557
- enum:
9558
- - text
9559
- - checkbox
9560
9388
  SignatureRequestResponseCustomFieldBase:
9561
9389
  description: |-
9562
9390
  An array of Custom Field objects containing the name and type of each custom field.
@@ -9590,44 +9418,45 @@ components:
9590
9418
  checkbox: '#/components/schemas/SignatureRequestResponseCustomFieldCheckbox'
9591
9419
  x-internal: true
9592
9420
  x-base-class: true
9593
- SignatureRequestResponseCustomFieldText:
9421
+ SignatureRequestResponseCustomFieldCheckbox:
9594
9422
  description: 'This class extends `SignatureRequestResponseCustomFieldBase`.'
9423
+ required:
9424
+ - type
9595
9425
  type: object
9596
9426
  allOf:
9597
9427
  -
9598
9428
  $ref: '#/components/schemas/SignatureRequestResponseCustomFieldBase'
9599
9429
  -
9600
- required:
9601
- - type
9602
- - options
9603
9430
  properties:
9604
9431
  type:
9605
9432
  description: 'The type of this Custom Field. Only ''text'' and ''checkbox'' are currently supported.'
9606
9433
  type: string
9607
- default: text
9434
+ default: checkbox
9608
9435
  value:
9609
- description: 'A text string for text fields'
9610
- type: string
9611
- type: object
9612
- SignatureRequestResponseCustomFieldCheckbox:
9436
+ description: 'A true/false for checkbox fields'
9437
+ type: boolean
9438
+ SignatureRequestResponseCustomFieldText:
9613
9439
  description: 'This class extends `SignatureRequestResponseCustomFieldBase`.'
9440
+ required:
9441
+ - type
9614
9442
  type: object
9615
9443
  allOf:
9616
9444
  -
9617
9445
  $ref: '#/components/schemas/SignatureRequestResponseCustomFieldBase'
9618
9446
  -
9619
- required:
9620
- - type
9621
- - options
9622
9447
  properties:
9623
9448
  type:
9624
9449
  description: 'The type of this Custom Field. Only ''text'' and ''checkbox'' are currently supported.'
9625
9450
  type: string
9626
- default: checkbox
9451
+ default: text
9627
9452
  value:
9628
- description: 'A true/false for checkbox fields'
9629
- type: boolean
9630
- type: object
9453
+ description: 'A text string for text fields'
9454
+ type: string
9455
+ SignatureRequestResponseCustomFieldTypeEnum:
9456
+ type: string
9457
+ enum:
9458
+ - text
9459
+ - checkbox
9631
9460
  SignatureRequestResponseDataBase:
9632
9461
  description: 'An array of form field objects containing the name, value, and type of each textbox or checkmark field filled in by the signers.'
9633
9462
  properties:
@@ -9660,6 +9489,144 @@ components:
9660
9489
  checkbox-merge: '#/components/schemas/SignatureRequestResponseDataValueCheckboxMerge'
9661
9490
  x-internal: true
9662
9491
  x-base-class: true
9492
+ SignatureRequestResponseDataTypeEnum:
9493
+ type: string
9494
+ enum:
9495
+ - text
9496
+ - checkbox
9497
+ - date_signed
9498
+ - dropdown
9499
+ - initials
9500
+ - radio
9501
+ - signature
9502
+ - text-merge
9503
+ - checkbox-merge
9504
+ SignatureRequestResponseDataValueCheckbox:
9505
+ type: object
9506
+ allOf:
9507
+ -
9508
+ $ref: '#/components/schemas/SignatureRequestResponseDataBase'
9509
+ -
9510
+ properties:
9511
+ type:
9512
+ description: 'A yes/no checkbox'
9513
+ type: string
9514
+ default: checkbox
9515
+ value:
9516
+ description: 'The value of the form field.'
9517
+ type: boolean
9518
+ SignatureRequestResponseDataValueCheckboxMerge:
9519
+ type: object
9520
+ allOf:
9521
+ -
9522
+ $ref: '#/components/schemas/SignatureRequestResponseDataBase'
9523
+ -
9524
+ properties:
9525
+ type:
9526
+ description: 'A checkbox field that has default value set by the api'
9527
+ type: string
9528
+ default: checkbox-merge
9529
+ value:
9530
+ description: 'The value of the form field.'
9531
+ type: string
9532
+ SignatureRequestResponseDataValueDateSigned:
9533
+ type: object
9534
+ allOf:
9535
+ -
9536
+ $ref: '#/components/schemas/SignatureRequestResponseDataBase'
9537
+ -
9538
+ properties:
9539
+ type:
9540
+ description: 'A date'
9541
+ type: string
9542
+ default: date_signed
9543
+ value:
9544
+ description: 'The value of the form field.'
9545
+ type: string
9546
+ SignatureRequestResponseDataValueDropdown:
9547
+ type: object
9548
+ allOf:
9549
+ -
9550
+ $ref: '#/components/schemas/SignatureRequestResponseDataBase'
9551
+ -
9552
+ properties:
9553
+ type:
9554
+ description: 'An input field for dropdowns'
9555
+ type: string
9556
+ default: dropdown
9557
+ value:
9558
+ description: 'The value of the form field.'
9559
+ type: string
9560
+ SignatureRequestResponseDataValueInitials:
9561
+ type: object
9562
+ allOf:
9563
+ -
9564
+ $ref: '#/components/schemas/SignatureRequestResponseDataBase'
9565
+ -
9566
+ properties:
9567
+ type:
9568
+ description: 'An input field for initials'
9569
+ type: string
9570
+ default: initials
9571
+ value:
9572
+ description: 'The value of the form field.'
9573
+ type: string
9574
+ SignatureRequestResponseDataValueRadio:
9575
+ type: object
9576
+ allOf:
9577
+ -
9578
+ $ref: '#/components/schemas/SignatureRequestResponseDataBase'
9579
+ -
9580
+ properties:
9581
+ type:
9582
+ description: 'An input field for radios'
9583
+ type: string
9584
+ default: radio
9585
+ value:
9586
+ description: 'The value of the form field.'
9587
+ type: boolean
9588
+ SignatureRequestResponseDataValueSignature:
9589
+ type: object
9590
+ allOf:
9591
+ -
9592
+ $ref: '#/components/schemas/SignatureRequestResponseDataBase'
9593
+ -
9594
+ properties:
9595
+ type:
9596
+ description: 'A signature input field'
9597
+ type: string
9598
+ default: signature
9599
+ value:
9600
+ description: 'The value of the form field.'
9601
+ type: string
9602
+ SignatureRequestResponseDataValueText:
9603
+ type: object
9604
+ allOf:
9605
+ -
9606
+ $ref: '#/components/schemas/SignatureRequestResponseDataBase'
9607
+ -
9608
+ properties:
9609
+ type:
9610
+ description: 'A text input field'
9611
+ type: string
9612
+ default: text
9613
+ value:
9614
+ description: 'The value of the form field.'
9615
+ type: string
9616
+ SignatureRequestResponseDataValueTextMerge:
9617
+ type: object
9618
+ allOf:
9619
+ -
9620
+ $ref: '#/components/schemas/SignatureRequestResponseDataBase'
9621
+ -
9622
+ properties:
9623
+ type:
9624
+ description: 'A text field that has default text set by the api'
9625
+ type: string
9626
+ default: text-merge
9627
+ value:
9628
+ description: 'The value of the form field.'
9629
+ type: string
9663
9630
  SignatureRequestResponseSignatures:
9664
9631
  description: 'An array of signature objects, 1 for each signer.'
9665
9632
  properties:
@@ -9759,18 +9726,6 @@ components:
9759
9726
  type: string
9760
9727
  type: object
9761
9728
  x-internal: true
9762
- TeamParentResponse:
9763
- description: 'Information about the parent team if a team has one, set to `null` otherwise.'
9764
- properties:
9765
- team_id:
9766
- description: 'The id of a team'
9767
- type: string
9768
- name:
9769
- description: 'The name of a team'
9770
- type: string
9771
- type: object
9772
- nullable: true
9773
- x-internal: true
9774
9729
  TeamInfoResponse:
9775
9730
  properties:
9776
9731
  team_id:
@@ -9789,30 +9744,6 @@ components:
9789
9744
  type: integer
9790
9745
  type: object
9791
9746
  x-internal: true
9792
- TeamGetInfoResponse:
9793
- properties:
9794
- team:
9795
- $ref: '#/components/schemas/TeamInfoResponse'
9796
- warnings:
9797
- description: 'A list of warnings.'
9798
- type: array
9799
- items:
9800
- $ref: '#/components/schemas/WarningResponse'
9801
- type: object
9802
- x-internal: true
9803
- TeamMemberResponse:
9804
- properties:
9805
- account_id:
9806
- description: 'Account id of the team member.'
9807
- type: string
9808
- email_address:
9809
- description: 'Email address of the team member.'
9810
- type: string
9811
- role:
9812
- description: 'The specific role a member has on the team.'
9813
- type: string
9814
- type: object
9815
- x-internal: true
9816
9747
  TeamInviteResponse:
9817
9748
  properties:
9818
9749
  email_address:
@@ -9835,68 +9766,39 @@ components:
9835
9766
  type: integer
9836
9767
  type: object
9837
9768
  x-internal: true
9838
- TeamInvitesResponse:
9839
- properties:
9840
- team_invites:
9841
- description: 'Contains a list of team invites and their roles.'
9842
- type: array
9843
- items:
9844
- $ref: '#/components/schemas/TeamInviteResponse'
9845
- warnings:
9846
- type: array
9847
- items:
9848
- $ref: '#/components/schemas/WarningResponse'
9849
- type: object
9850
- x-internal: true
9851
- SubTeamResponse:
9769
+ TeamMemberResponse:
9852
9770
  properties:
9853
- team_id:
9854
- description: 'The id of a team'
9771
+ account_id:
9772
+ description: 'Account id of the team member.'
9855
9773
  type: string
9856
- name:
9857
- description: 'The name of a team'
9774
+ email_address:
9775
+ description: 'Email address of the team member.'
9776
+ type: string
9777
+ role:
9778
+ description: 'The specific role a member has on the team.'
9858
9779
  type: string
9859
9780
  type: object
9860
9781
  x-internal: true
9861
- TeamGetResponse:
9862
- properties:
9863
- team:
9864
- $ref: '#/components/schemas/TeamResponse'
9865
- warnings:
9866
- description: 'A list of warnings.'
9867
- type: array
9868
- items:
9869
- $ref: '#/components/schemas/WarningResponse'
9870
- type: object
9871
- x-internal: true
9872
- TeamMembersResponse:
9873
- properties:
9874
- team_members:
9875
- description: 'Contains a list of team members and their roles for a specific team.'
9876
- type: array
9877
- items:
9878
- $ref: '#/components/schemas/TeamMemberResponse'
9879
- list_info:
9880
- $ref: '#/components/schemas/ListInfoResponse'
9881
- warnings:
9882
- type: array
9883
- items:
9884
- $ref: '#/components/schemas/WarningResponse'
9782
+ TeamParentResponse:
9783
+ description: 'Information about the parent team if a team has one, set to `null` otherwise.'
9784
+ properties:
9785
+ team_id:
9786
+ description: 'The id of a team'
9787
+ type: string
9788
+ name:
9789
+ description: 'The name of a team'
9790
+ type: string
9885
9791
  type: object
9792
+ nullable: true
9886
9793
  x-internal: true
9887
- TeamSubTeamsResponse:
9794
+ SubTeamResponse:
9888
9795
  properties:
9889
- sub_teams:
9890
- description: 'Contains a list with sub teams.'
9891
- type: array
9892
- items:
9893
- $ref: '#/components/schemas/SubTeamResponse'
9894
- list_info:
9895
- $ref: '#/components/schemas/ListInfoResponse'
9896
- warnings:
9897
- type: array
9898
- items:
9899
- $ref: '#/components/schemas/WarningResponse'
9796
+ team_id:
9797
+ description: 'The id of a team'
9798
+ type: string
9799
+ name:
9800
+ description: 'The name of a team'
9801
+ type: string
9900
9802
  type: object
9901
9803
  x-internal: true
9902
9804
  TemplateResponse:
@@ -9973,88 +9875,6 @@ components:
9973
9875
  nullable: true
9974
9876
  type: object
9975
9877
  x-internal: true
9976
- TemplateCreateEmbeddedDraftResponse:
9977
- properties:
9978
- template:
9979
- $ref: '#/components/schemas/TemplateCreateEmbeddedDraftResponseTemplate'
9980
- warnings:
9981
- description: 'A list of warnings.'
9982
- type: array
9983
- items:
9984
- $ref: '#/components/schemas/WarningResponse'
9985
- type: object
9986
- x-internal: true
9987
- TemplateCreateEmbeddedDraftResponseTemplate:
9988
- description: 'Template object with parameters: `template_id`, `edit_url`, `expires_at`.'
9989
- properties:
9990
- template_id:
9991
- description: 'The id of the Template.'
9992
- type: string
9993
- edit_url:
9994
- description: 'Link to edit the template.'
9995
- type: string
9996
- expires_at:
9997
- description: 'When the link expires.'
9998
- type: integer
9999
- warnings:
10000
- description: 'A list of warnings.'
10001
- type: array
10002
- items:
10003
- $ref: '#/components/schemas/WarningResponse'
10004
- type: object
10005
- x-internal: true
10006
- TemplateUpdateFilesResponse:
10007
- properties:
10008
- template:
10009
- $ref: '#/components/schemas/TemplateUpdateFilesResponseTemplate'
10010
- type: object
10011
- x-internal: true
10012
- TemplateUpdateFilesResponseTemplate:
10013
- description: 'Contains template id'
10014
- properties:
10015
- template_id:
10016
- description: 'The id of the Template.'
10017
- type: string
10018
- warnings:
10019
- description: 'A list of warnings.'
10020
- type: array
10021
- items:
10022
- $ref: '#/components/schemas/WarningResponse'
10023
- type: object
10024
- x-internal: true
10025
- TemplateGetResponse:
10026
- properties:
10027
- template:
10028
- $ref: '#/components/schemas/TemplateResponse'
10029
- warnings:
10030
- description: 'A list of warnings.'
10031
- type: array
10032
- items:
10033
- $ref: '#/components/schemas/WarningResponse'
10034
- type: object
10035
- x-internal: true
10036
- TemplateListResponse:
10037
- properties:
10038
- templates:
10039
- description: 'List of templates that the API caller has access to.'
10040
- type: array
10041
- items:
10042
- $ref: '#/components/schemas/TemplateResponse'
10043
- list_info:
10044
- $ref: '#/components/schemas/ListInfoResponse'
10045
- warnings:
10046
- description: 'A list of warnings.'
10047
- type: array
10048
- items:
10049
- $ref: '#/components/schemas/WarningResponse'
10050
- type: object
10051
- x-internal: true
10052
- TemplateEditResponse:
10053
- properties:
10054
- template_id:
10055
- description: 'The id of the Template.'
10056
- type: string
10057
- type: object
10058
9878
  TemplateResponseAccount:
10059
9879
  properties:
10060
9880
  account_id:
@@ -10100,6 +9920,25 @@ components:
10100
9920
  type: string
10101
9921
  type: object
10102
9922
  x-internal: true
9923
+ TemplateCreateEmbeddedDraftResponseTemplate:
9924
+ description: 'Template object with parameters: `template_id`, `edit_url`, `expires_at`.'
9925
+ properties:
9926
+ template_id:
9927
+ description: 'The id of the Template.'
9928
+ type: string
9929
+ edit_url:
9930
+ description: 'Link to edit the template.'
9931
+ type: string
9932
+ expires_at:
9933
+ description: 'When the link expires.'
9934
+ type: integer
9935
+ warnings:
9936
+ description: 'A list of warnings.'
9937
+ type: array
9938
+ items:
9939
+ $ref: '#/components/schemas/WarningResponse'
9940
+ type: object
9941
+ x-internal: true
10103
9942
  TemplateResponseDocument:
10104
9943
  properties:
10105
9944
  name:
@@ -10167,9 +10006,6 @@ components:
10167
10006
  description: 'The name of the group this field is in. If this field is not a group, this defaults to `null`.'
10168
10007
  type: string
10169
10008
  nullable: true
10170
- fontSize:
10171
- description: 'Final font size used by this form field.'
10172
- type: integer
10173
10009
  type: object
10174
10010
  discriminator:
10175
10011
  propertyName: type
@@ -10178,15 +10014,15 @@ components:
10178
10014
  checkbox: '#/components/schemas/TemplateResponseDocumentCustomFieldCheckbox'
10179
10015
  x-internal: true
10180
10016
  x-base-class: true
10181
- TemplateResponseDocumentCustomFieldText:
10017
+ TemplateResponseDocumentCustomFieldCheckbox:
10182
10018
  description: 'This class extends `TemplateResponseDocumentCustomFieldBase`'
10019
+ required:
10020
+ - type
10183
10021
  type: object
10184
10022
  allOf:
10185
10023
  -
10186
10024
  $ref: '#/components/schemas/TemplateResponseDocumentCustomFieldBase'
10187
10025
  -
10188
- required:
10189
- - type
10190
10026
  properties:
10191
10027
  type:
10192
10028
  description: |-
@@ -10195,28 +10031,16 @@ components:
10195
10031
  * Text uses `TemplateResponseDocumentCustomFieldText`
10196
10032
  * Checkbox uses `TemplateResponseDocumentCustomFieldCheckbox`
10197
10033
  type: string
10198
- default: text
10199
- avg_text_length:
10200
- $ref: '#/components/schemas/TemplateResponseFieldAvgTextLength'
10201
- isMultiline:
10202
- description: 'Whether this form field is multiline text.'
10203
- type: boolean
10204
- originalFontSize:
10205
- description: 'Original font size used in this form field''s text.'
10206
- type: integer
10207
- fontFamily:
10208
- description: 'Font family used in this form field''s text.'
10209
- type: string
10210
- type: object
10211
- TemplateResponseDocumentCustomFieldCheckbox:
10034
+ default: checkbox
10035
+ TemplateResponseDocumentCustomFieldText:
10212
10036
  description: 'This class extends `TemplateResponseDocumentCustomFieldBase`'
10037
+ required:
10038
+ - type
10213
10039
  type: object
10214
10040
  allOf:
10215
10041
  -
10216
10042
  $ref: '#/components/schemas/TemplateResponseDocumentCustomFieldBase'
10217
10043
  -
10218
- required:
10219
- - type
10220
10044
  properties:
10221
10045
  type:
10222
10046
  description: |-
@@ -10225,8 +10049,18 @@ components:
10225
10049
  * Text uses `TemplateResponseDocumentCustomFieldText`
10226
10050
  * Checkbox uses `TemplateResponseDocumentCustomFieldCheckbox`
10227
10051
  type: string
10228
- default: checkbox
10229
- type: object
10052
+ default: text
10053
+ avg_text_length:
10054
+ $ref: '#/components/schemas/TemplateResponseFieldAvgTextLength'
10055
+ isMultiline:
10056
+ description: 'Whether this form field is multiline text.'
10057
+ type: boolean
10058
+ originalFontSize:
10059
+ description: 'Original font size used in this form field''s text.'
10060
+ type: integer
10061
+ fontFamily:
10062
+ description: 'Font family used in this form field''s text.'
10063
+ type: string
10230
10064
  TemplateResponseDocumentFieldGroup:
10231
10065
  properties:
10232
10066
  name:
@@ -10287,9 +10121,6 @@ components:
10287
10121
  description: 'The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.'
10288
10122
  type: string
10289
10123
  nullable: true
10290
- fontSize:
10291
- description: 'Final font size used by this form field.'
10292
- type: integer
10293
10124
  type: object
10294
10125
  discriminator:
10295
10126
  propertyName: type
@@ -10304,15 +10135,15 @@ components:
10304
10135
  initials: '#/components/schemas/TemplateResponseDocumentFormFieldInitials'
10305
10136
  x-internal: true
10306
10137
  x-base-class: true
10307
- TemplateResponseDocumentFormFieldText:
10138
+ TemplateResponseDocumentFormFieldCheckbox:
10308
10139
  description: 'This class extends `TemplateResponseDocumentFormFieldBase`'
10140
+ required:
10141
+ - type
10309
10142
  type: object
10310
10143
  allOf:
10311
10144
  -
10312
10145
  $ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase'
10313
10146
  -
10314
- required:
10315
- - type
10316
10147
  properties:
10317
10148
  type:
10318
10149
  description: |-
@@ -10327,43 +10158,16 @@ components:
10327
10158
  * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
10328
10159
  * Initials Field uses `TemplateResponseDocumentFormFieldInitials`
10329
10160
  type: string
10330
- default: text
10331
- avg_text_length:
10332
- $ref: '#/components/schemas/TemplateResponseFieldAvgTextLength'
10333
- isMultiline:
10334
- description: 'Whether this form field is multiline text.'
10335
- type: boolean
10336
- originalFontSize:
10337
- description: 'Original font size used in this form field''s text.'
10338
- type: integer
10339
- fontFamily:
10340
- description: 'Font family used in this form field''s text.'
10341
- type: string
10342
- validation_type:
10343
- 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.'
10344
- type: string
10345
- enum:
10346
- - numbers_only
10347
- - letters_only
10348
- - phone_number
10349
- - bank_routing_number
10350
- - bank_account_number
10351
- - email_address
10352
- - zip_code
10353
- - social_security_number
10354
- - employer_identification_number
10355
- - custom_regex
10356
- nullable: true
10357
- type: object
10358
- TemplateResponseDocumentFormFieldDropdown:
10161
+ default: checkbox
10162
+ TemplateResponseDocumentFormFieldDateSigned:
10359
10163
  description: 'This class extends `TemplateResponseDocumentFormFieldBase`'
10164
+ required:
10165
+ - type
10360
10166
  type: object
10361
10167
  allOf:
10362
10168
  -
10363
10169
  $ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase'
10364
10170
  -
10365
- required:
10366
- - type
10367
10171
  properties:
10368
10172
  type:
10369
10173
  description: |-
@@ -10378,17 +10182,16 @@ components:
10378
10182
  * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
10379
10183
  * Initials Field uses `TemplateResponseDocumentFormFieldInitials`
10380
10184
  type: string
10381
- default: dropdown
10382
- type: object
10383
- TemplateResponseDocumentFormFieldHyperlink:
10185
+ default: date_signed
10186
+ TemplateResponseDocumentFormFieldDropdown:
10384
10187
  description: 'This class extends `TemplateResponseDocumentFormFieldBase`'
10188
+ required:
10189
+ - type
10385
10190
  type: object
10386
10191
  allOf:
10387
10192
  -
10388
10193
  $ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase'
10389
10194
  -
10390
- required:
10391
- - type
10392
10195
  properties:
10393
10196
  type:
10394
10197
  description: |-
@@ -10403,28 +10206,16 @@ components:
10403
10206
  * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
10404
10207
  * Initials Field uses `TemplateResponseDocumentFormFieldInitials`
10405
10208
  type: string
10406
- default: hyperlink
10407
- avg_text_length:
10408
- $ref: '#/components/schemas/TemplateResponseFieldAvgTextLength'
10409
- isMultiline:
10410
- description: 'Whether this form field is multiline text.'
10411
- type: boolean
10412
- originalFontSize:
10413
- description: 'Original font size used in this form field''s text.'
10414
- type: integer
10415
- fontFamily:
10416
- description: 'Font family used in this form field''s text.'
10417
- type: string
10418
- type: object
10419
- TemplateResponseDocumentFormFieldCheckbox:
10209
+ default: dropdown
10210
+ TemplateResponseDocumentFormFieldHyperlink:
10420
10211
  description: 'This class extends `TemplateResponseDocumentFormFieldBase`'
10212
+ required:
10213
+ - type
10421
10214
  type: object
10422
10215
  allOf:
10423
10216
  -
10424
10217
  $ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase'
10425
10218
  -
10426
- required:
10427
- - type
10428
10219
  properties:
10429
10220
  type:
10430
10221
  description: |-
@@ -10439,18 +10230,27 @@ components:
10439
10230
  * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
10440
10231
  * Initials Field uses `TemplateResponseDocumentFormFieldInitials`
10441
10232
  type: string
10442
- default: checkbox
10443
- type: object
10444
- TemplateResponseDocumentFormFieldRadio:
10233
+ default: hyperlink
10234
+ avg_text_length:
10235
+ $ref: '#/components/schemas/TemplateResponseFieldAvgTextLength'
10236
+ isMultiline:
10237
+ description: 'Whether this form field is multiline text.'
10238
+ type: boolean
10239
+ originalFontSize:
10240
+ description: 'Original font size used in this form field''s text.'
10241
+ type: integer
10242
+ fontFamily:
10243
+ description: 'Font family used in this form field''s text.'
10244
+ type: string
10245
+ TemplateResponseDocumentFormFieldInitials:
10445
10246
  description: 'This class extends `TemplateResponseDocumentFormFieldBase`'
10247
+ required:
10248
+ - type
10446
10249
  type: object
10447
10250
  allOf:
10448
10251
  -
10449
10252
  $ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase'
10450
10253
  -
10451
- required:
10452
- - type
10453
- - group
10454
10254
  properties:
10455
10255
  type:
10456
10256
  description: |-
@@ -10465,17 +10265,17 @@ components:
10465
10265
  * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
10466
10266
  * Initials Field uses `TemplateResponseDocumentFormFieldInitials`
10467
10267
  type: string
10468
- default: radio
10469
- type: object
10470
- TemplateResponseDocumentFormFieldSignature:
10268
+ default: initials
10269
+ TemplateResponseDocumentFormFieldRadio:
10471
10270
  description: 'This class extends `TemplateResponseDocumentFormFieldBase`'
10271
+ required:
10272
+ - type
10273
+ - group
10472
10274
  type: object
10473
10275
  allOf:
10474
10276
  -
10475
10277
  $ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase'
10476
10278
  -
10477
- required:
10478
- - type
10479
10279
  properties:
10480
10280
  type:
10481
10281
  description: |-
@@ -10490,17 +10290,16 @@ components:
10490
10290
  * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
10491
10291
  * Initials Field uses `TemplateResponseDocumentFormFieldInitials`
10492
10292
  type: string
10493
- default: signature
10494
- type: object
10495
- TemplateResponseDocumentFormFieldDateSigned:
10293
+ default: radio
10294
+ TemplateResponseDocumentFormFieldSignature:
10496
10295
  description: 'This class extends `TemplateResponseDocumentFormFieldBase`'
10296
+ required:
10297
+ - type
10497
10298
  type: object
10498
10299
  allOf:
10499
10300
  -
10500
10301
  $ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase'
10501
10302
  -
10502
- required:
10503
- - type
10504
10303
  properties:
10505
10304
  type:
10506
10305
  description: |-
@@ -10515,17 +10314,16 @@ components:
10515
10314
  * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
10516
10315
  * Initials Field uses `TemplateResponseDocumentFormFieldInitials`
10517
10316
  type: string
10518
- default: date_signed
10519
- type: object
10520
- TemplateResponseDocumentFormFieldInitials:
10317
+ default: signature
10318
+ TemplateResponseDocumentFormFieldText:
10521
10319
  description: 'This class extends `TemplateResponseDocumentFormFieldBase`'
10320
+ required:
10321
+ - type
10522
10322
  type: object
10523
10323
  allOf:
10524
10324
  -
10525
10325
  $ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase'
10526
10326
  -
10527
- required:
10528
- - type
10529
10327
  properties:
10530
10328
  type:
10531
10329
  description: |-
@@ -10540,8 +10338,33 @@ components:
10540
10338
  * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
10541
10339
  * Initials Field uses `TemplateResponseDocumentFormFieldInitials`
10542
10340
  type: string
10543
- default: initials
10544
- type: object
10341
+ default: text
10342
+ avg_text_length:
10343
+ $ref: '#/components/schemas/TemplateResponseFieldAvgTextLength'
10344
+ isMultiline:
10345
+ description: 'Whether this form field is multiline text.'
10346
+ type: boolean
10347
+ originalFontSize:
10348
+ description: 'Original font size used in this form field''s text.'
10349
+ type: integer
10350
+ fontFamily:
10351
+ description: 'Font family used in this form field''s text.'
10352
+ type: string
10353
+ validation_type:
10354
+ 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.'
10355
+ type: string
10356
+ enum:
10357
+ - numbers_only
10358
+ - letters_only
10359
+ - phone_number
10360
+ - bank_routing_number
10361
+ - bank_account_number
10362
+ - email_address
10363
+ - zip_code
10364
+ - social_security_number
10365
+ - employer_identification_number
10366
+ - custom_regex
10367
+ nullable: true
10545
10368
  TemplateResponseDocumentStaticFieldBase:
10546
10369
  description: 'An array describing static overlay fields. **Note** only available for certain subscriptions.'
10547
10370
  required:
@@ -10578,9 +10401,6 @@ components:
10578
10401
  description: 'The name of the group this field is in. If this field is not a group, this defaults to `null`.'
10579
10402
  type: string
10580
10403
  nullable: true
10581
- fontSize:
10582
- description: 'Final font size used by this form field.'
10583
- type: integer
10584
10404
  type: object
10585
10405
  discriminator:
10586
10406
  propertyName: type
@@ -10595,15 +10415,15 @@ components:
10595
10415
  initials: '#/components/schemas/TemplateResponseDocumentStaticFieldInitials'
10596
10416
  x-internal: true
10597
10417
  x-base-class: true
10598
- TemplateResponseDocumentStaticFieldText:
10418
+ TemplateResponseDocumentStaticFieldCheckbox:
10599
10419
  description: 'This class extends `TemplateResponseDocumentStaticFieldBase`'
10420
+ required:
10421
+ - type
10600
10422
  type: object
10601
10423
  allOf:
10602
10424
  -
10603
10425
  $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase'
10604
10426
  -
10605
- required:
10606
- - type
10607
10427
  properties:
10608
10428
  type:
10609
10429
  description: |-
@@ -10618,17 +10438,16 @@ components:
10618
10438
  * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
10619
10439
  * Initials Field uses `TemplateResponseDocumentStaticFieldInitials`
10620
10440
  type: string
10621
- default: text
10622
- type: object
10623
- TemplateResponseDocumentStaticFieldDropdown:
10441
+ default: checkbox
10442
+ TemplateResponseDocumentStaticFieldDateSigned:
10624
10443
  description: 'This class extends `TemplateResponseDocumentStaticFieldBase`'
10444
+ required:
10445
+ - type
10625
10446
  type: object
10626
10447
  allOf:
10627
10448
  -
10628
10449
  $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase'
10629
10450
  -
10630
- required:
10631
- - type
10632
10451
  properties:
10633
10452
  type:
10634
10453
  description: |-
@@ -10643,17 +10462,16 @@ components:
10643
10462
  * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
10644
10463
  * Initials Field uses `TemplateResponseDocumentStaticFieldInitials`
10645
10464
  type: string
10646
- default: dropdown
10647
- type: object
10648
- TemplateResponseDocumentStaticFieldHyperlink:
10465
+ default: date_signed
10466
+ TemplateResponseDocumentStaticFieldDropdown:
10649
10467
  description: 'This class extends `TemplateResponseDocumentStaticFieldBase`'
10468
+ required:
10469
+ - type
10650
10470
  type: object
10651
10471
  allOf:
10652
10472
  -
10653
10473
  $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase'
10654
10474
  -
10655
- required:
10656
- - type
10657
10475
  properties:
10658
10476
  type:
10659
10477
  description: |-
@@ -10668,17 +10486,16 @@ components:
10668
10486
  * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
10669
10487
  * Initials Field uses `TemplateResponseDocumentStaticFieldInitials`
10670
10488
  type: string
10671
- default: hyperlink
10672
- type: object
10673
- TemplateResponseDocumentStaticFieldCheckbox:
10489
+ default: dropdown
10490
+ TemplateResponseDocumentStaticFieldHyperlink:
10674
10491
  description: 'This class extends `TemplateResponseDocumentStaticFieldBase`'
10492
+ required:
10493
+ - type
10675
10494
  type: object
10676
10495
  allOf:
10677
10496
  -
10678
10497
  $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase'
10679
10498
  -
10680
- required:
10681
- - type
10682
10499
  properties:
10683
10500
  type:
10684
10501
  description: |-
@@ -10693,17 +10510,16 @@ components:
10693
10510
  * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
10694
10511
  * Initials Field uses `TemplateResponseDocumentStaticFieldInitials`
10695
10512
  type: string
10696
- default: checkbox
10697
- type: object
10698
- TemplateResponseDocumentStaticFieldRadio:
10513
+ default: hyperlink
10514
+ TemplateResponseDocumentStaticFieldInitials:
10699
10515
  description: 'This class extends `TemplateResponseDocumentStaticFieldBase`'
10516
+ required:
10517
+ - type
10700
10518
  type: object
10701
10519
  allOf:
10702
10520
  -
10703
10521
  $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase'
10704
10522
  -
10705
- required:
10706
- - type
10707
10523
  properties:
10708
10524
  type:
10709
10525
  description: |-
@@ -10718,17 +10534,16 @@ components:
10718
10534
  * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
10719
10535
  * Initials Field uses `TemplateResponseDocumentStaticFieldInitials`
10720
10536
  type: string
10721
- default: radio
10722
- type: object
10723
- TemplateResponseDocumentStaticFieldSignature:
10537
+ default: initials
10538
+ TemplateResponseDocumentStaticFieldRadio:
10724
10539
  description: 'This class extends `TemplateResponseDocumentStaticFieldBase`'
10540
+ required:
10541
+ - type
10725
10542
  type: object
10726
10543
  allOf:
10727
10544
  -
10728
10545
  $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase'
10729
10546
  -
10730
- required:
10731
- - type
10732
10547
  properties:
10733
10548
  type:
10734
10549
  description: |-
@@ -10743,17 +10558,16 @@ components:
10743
10558
  * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
10744
10559
  * Initials Field uses `TemplateResponseDocumentStaticFieldInitials`
10745
10560
  type: string
10746
- default: signature
10747
- type: object
10748
- TemplateResponseDocumentStaticFieldDateSigned:
10561
+ default: radio
10562
+ TemplateResponseDocumentStaticFieldSignature:
10749
10563
  description: 'This class extends `TemplateResponseDocumentStaticFieldBase`'
10564
+ required:
10565
+ - type
10750
10566
  type: object
10751
10567
  allOf:
10752
10568
  -
10753
10569
  $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase'
10754
10570
  -
10755
- required:
10756
- - type
10757
10571
  properties:
10758
10572
  type:
10759
10573
  description: |-
@@ -10768,17 +10582,16 @@ components:
10768
10582
  * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
10769
10583
  * Initials Field uses `TemplateResponseDocumentStaticFieldInitials`
10770
10584
  type: string
10771
- default: date_signed
10772
- type: object
10773
- TemplateResponseDocumentStaticFieldInitials:
10585
+ default: signature
10586
+ TemplateResponseDocumentStaticFieldText:
10774
10587
  description: 'This class extends `TemplateResponseDocumentStaticFieldBase`'
10588
+ required:
10589
+ - type
10775
10590
  type: object
10776
10591
  allOf:
10777
10592
  -
10778
10593
  $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase'
10779
10594
  -
10780
- required:
10781
- - type
10782
10595
  properties:
10783
10596
  type:
10784
10597
  description: |-
@@ -10793,54 +10606,194 @@ components:
10793
10606
  * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
10794
10607
  * Initials Field uses `TemplateResponseDocumentStaticFieldInitials`
10795
10608
  type: string
10796
- default: initials
10797
- type: object
10609
+ default: text
10798
10610
  TemplateResponseFieldAvgTextLength:
10799
10611
  description: 'Average text length in this field.'
10800
10612
  properties:
10801
- num_lines:
10802
- description: 'Number of lines.'
10803
- type: integer
10804
- num_chars_per_line:
10805
- description: 'Number of characters per line.'
10806
- type: integer
10613
+ num_lines:
10614
+ description: 'Number of lines.'
10615
+ type: integer
10616
+ num_chars_per_line:
10617
+ description: 'Number of characters per line.'
10618
+ type: integer
10619
+ type: object
10620
+ x-internal: true
10621
+ TemplateResponseSignerRole:
10622
+ properties:
10623
+ name:
10624
+ description: 'The name of the Role.'
10625
+ type: string
10626
+ order:
10627
+ description: 'If signer order is assigned this is the 0-based index for this role.'
10628
+ type: integer
10629
+ type: object
10630
+ x-internal: true
10631
+ TemplateUpdateFilesResponseTemplate:
10632
+ description: 'Contains template id'
10633
+ properties:
10634
+ template_id:
10635
+ description: 'The id of the Template.'
10636
+ type: string
10637
+ warnings:
10638
+ description: 'A list of warnings.'
10639
+ type: array
10640
+ items:
10641
+ $ref: '#/components/schemas/WarningResponse'
10642
+ type: object
10643
+ x-internal: true
10644
+ UnclaimedDraftResponse:
10645
+ description: 'A group of documents that a user can take ownership of via the claim URL.'
10646
+ properties:
10647
+ signature_request_id:
10648
+ description: 'The ID of the signature request that is represented by this UnclaimedDraft.'
10649
+ type: string
10650
+ nullable: true
10651
+ claim_url:
10652
+ description: 'The URL to be used to claim this UnclaimedDraft.'
10653
+ type: string
10654
+ signing_redirect_url:
10655
+ description: 'The URL you want signers redirected to after they successfully sign.'
10656
+ type: string
10657
+ nullable: true
10658
+ requesting_redirect_url:
10659
+ 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.).'
10660
+ type: string
10661
+ nullable: true
10662
+ expires_at:
10663
+ description: 'When the link expires.'
10664
+ type: integer
10665
+ nullable: true
10666
+ test_mode:
10667
+ description: 'Whether this is a test draft. Signature requests made from test drafts have no legal value.'
10668
+ type: boolean
10669
+ type: object
10670
+ x-internal: true
10671
+ WarningResponse:
10672
+ description: 'A list of warnings.'
10673
+ required:
10674
+ - warning_msg
10675
+ - warning_name
10676
+ properties:
10677
+ warning_msg:
10678
+ description: 'Warning message'
10679
+ type: string
10680
+ warning_name:
10681
+ description: 'Warning name'
10682
+ type: string
10683
+ type: object
10684
+ TeamGetResponse:
10685
+ properties:
10686
+ team:
10687
+ $ref: '#/components/schemas/TeamResponse'
10688
+ warnings:
10689
+ description: 'A list of warnings.'
10690
+ type: array
10691
+ items:
10692
+ $ref: '#/components/schemas/WarningResponse'
10693
+ type: object
10694
+ x-internal: true
10695
+ TeamGetInfoResponse:
10696
+ properties:
10697
+ team:
10698
+ $ref: '#/components/schemas/TeamInfoResponse'
10699
+ warnings:
10700
+ description: 'A list of warnings.'
10701
+ type: array
10702
+ items:
10703
+ $ref: '#/components/schemas/WarningResponse'
10704
+ type: object
10705
+ x-internal: true
10706
+ TeamInvitesResponse:
10707
+ properties:
10708
+ team_invites:
10709
+ description: 'Contains a list of team invites and their roles.'
10710
+ type: array
10711
+ items:
10712
+ $ref: '#/components/schemas/TeamInviteResponse'
10713
+ warnings:
10714
+ type: array
10715
+ items:
10716
+ $ref: '#/components/schemas/WarningResponse'
10717
+ type: object
10718
+ x-internal: true
10719
+ TeamMembersResponse:
10720
+ properties:
10721
+ team_members:
10722
+ description: 'Contains a list of team members and their roles for a specific team.'
10723
+ type: array
10724
+ items:
10725
+ $ref: '#/components/schemas/TeamMemberResponse'
10726
+ list_info:
10727
+ $ref: '#/components/schemas/ListInfoResponse'
10728
+ warnings:
10729
+ type: array
10730
+ items:
10731
+ $ref: '#/components/schemas/WarningResponse'
10732
+ type: object
10733
+ x-internal: true
10734
+ TeamSubTeamsResponse:
10735
+ properties:
10736
+ sub_teams:
10737
+ description: 'Contains a list with sub teams.'
10738
+ type: array
10739
+ items:
10740
+ $ref: '#/components/schemas/SubTeamResponse'
10741
+ list_info:
10742
+ $ref: '#/components/schemas/ListInfoResponse'
10743
+ warnings:
10744
+ type: array
10745
+ items:
10746
+ $ref: '#/components/schemas/WarningResponse'
10807
10747
  type: object
10808
10748
  x-internal: true
10809
- TemplateResponseSignerRole:
10749
+ TemplateCreateEmbeddedDraftResponse:
10810
10750
  properties:
10811
- name:
10812
- description: 'The name of the Role.'
10813
- type: string
10814
- order:
10815
- description: 'If signer order is assigned this is the 0-based index for this role.'
10816
- type: integer
10751
+ template:
10752
+ $ref: '#/components/schemas/TemplateCreateEmbeddedDraftResponseTemplate'
10753
+ warnings:
10754
+ description: 'A list of warnings.'
10755
+ type: array
10756
+ items:
10757
+ $ref: '#/components/schemas/WarningResponse'
10817
10758
  type: object
10818
10759
  x-internal: true
10819
- UnclaimedDraftResponse:
10820
- description: 'A group of documents that a user can take ownership of via the claim URL.'
10760
+ TemplateEditResponse:
10821
10761
  properties:
10822
- signature_request_id:
10823
- description: 'The ID of the signature request that is represented by this UnclaimedDraft.'
10824
- type: string
10825
- nullable: true
10826
- claim_url:
10827
- description: 'The URL to be used to claim this UnclaimedDraft.'
10828
- type: string
10829
- signing_redirect_url:
10830
- description: 'The URL you want signers redirected to after they successfully sign.'
10831
- type: string
10832
- nullable: true
10833
- requesting_redirect_url:
10834
- 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.).'
10762
+ template_id:
10763
+ description: 'The id of the Template.'
10835
10764
  type: string
10836
- nullable: true
10837
- expires_at:
10838
- description: 'When the link expires.'
10839
- type: integer
10840
- nullable: true
10841
- test_mode:
10842
- description: 'Whether this is a test draft. Signature requests made from test drafts have no legal value.'
10843
- type: boolean
10765
+ type: object
10766
+ TemplateGetResponse:
10767
+ properties:
10768
+ template:
10769
+ $ref: '#/components/schemas/TemplateResponse'
10770
+ warnings:
10771
+ description: 'A list of warnings.'
10772
+ type: array
10773
+ items:
10774
+ $ref: '#/components/schemas/WarningResponse'
10775
+ type: object
10776
+ x-internal: true
10777
+ TemplateListResponse:
10778
+ properties:
10779
+ templates:
10780
+ description: 'List of templates that the API caller has access to.'
10781
+ type: array
10782
+ items:
10783
+ $ref: '#/components/schemas/TemplateResponse'
10784
+ list_info:
10785
+ $ref: '#/components/schemas/ListInfoResponse'
10786
+ warnings:
10787
+ description: 'A list of warnings.'
10788
+ type: array
10789
+ items:
10790
+ $ref: '#/components/schemas/WarningResponse'
10791
+ type: object
10792
+ x-internal: true
10793
+ TemplateUpdateFilesResponse:
10794
+ properties:
10795
+ template:
10796
+ $ref: '#/components/schemas/TemplateUpdateFilesResponseTemplate'
10844
10797
  type: object
10845
10798
  x-internal: true
10846
10799
  UnclaimedDraftCreateResponse:
@@ -10854,19 +10807,6 @@ components:
10854
10807
  $ref: '#/components/schemas/WarningResponse'
10855
10808
  type: object
10856
10809
  x-internal: true
10857
- WarningResponse:
10858
- description: 'A list of warnings.'
10859
- required:
10860
- - warning_msg
10861
- - warning_name
10862
- properties:
10863
- warning_msg:
10864
- description: 'Warning message'
10865
- type: string
10866
- warning_name:
10867
- description: 'Warning name'
10868
- type: string
10869
- type: object
10870
10810
  responses:
10871
10811
  EventCallbackResponse:
10872
10812
  description: 'successful operation'
@@ -11048,10 +10988,6 @@ components:
11048
10988
  summary: 'Default Example'
11049
10989
  value:
11050
10990
  $ref: examples/json/UnclaimedDraftEditAndResendRequestDefaultExample.json
11051
- AccountGetResponseExample:
11052
- summary: 'Account Get'
11053
- value:
11054
- $ref: examples/json/AccountGetResponseExample.json
11055
10991
  AccountCreateResponseExample:
11056
10992
  summary: 'Account Create'
11057
10993
  value:
@@ -11060,10 +10996,10 @@ components:
11060
10996
  summary: 'Account Create with OAuth Authorization'
11061
10997
  value:
11062
10998
  $ref: examples/json/AccountCreateOAuthResponseExample.json
11063
- AccountUpdateResponseExample:
11064
- summary: 'Account Update'
10999
+ AccountGetResponseExample:
11000
+ summary: 'Account Get'
11065
11001
  value:
11066
- $ref: examples/json/AccountUpdateResponseExample.json
11002
+ $ref: examples/json/AccountGetResponseExample.json
11067
11003
  AccountVerifyFoundResponseExample:
11068
11004
  summary: 'Account Found'
11069
11005
  value:
@@ -11072,10 +11008,6 @@ components:
11072
11008
  summary: 'Account Not Found'
11073
11009
  value:
11074
11010
  $ref: examples/json/AccountVerifyNotFoundResponseExample.json
11075
- ApiAppCreateResponseExample:
11076
- summary: 'API App'
11077
- value:
11078
- $ref: examples/json/ApiAppCreateResponseExample.json
11079
11011
  ApiAppGetResponseExample:
11080
11012
  summary: 'API App'
11081
11013
  value:
@@ -11084,10 +11016,6 @@ components:
11084
11016
  summary: 'API App List'
11085
11017
  value:
11086
11018
  $ref: examples/json/ApiAppListResponseExample.json
11087
- ApiAppUpdateResponseExample:
11088
- summary: 'API App Update'
11089
- value:
11090
- $ref: examples/json/ApiAppUpdateResponseExample.json
11091
11019
  BulkSendJobGetResponseExample:
11092
11020
  summary: 'Bulk Send Job'
11093
11021
  value:
@@ -11144,6 +11072,38 @@ components:
11144
11072
  summary: 'Error 4XX failed_operation'
11145
11073
  value:
11146
11074
  $ref: examples/json/Error4XXResponseExample.json
11075
+ ReportCreateResponseExample:
11076
+ summary: Report
11077
+ value:
11078
+ $ref: examples/json/ReportCreateResponseExample.json
11079
+ SignatureRequestGetResponseExample:
11080
+ summary: 'Get Signature Request'
11081
+ value:
11082
+ $ref: examples/json/SignatureRequestGetResponseExample.json
11083
+ SignatureRequestListResponseExample:
11084
+ summary: 'List Signature Requests'
11085
+ value:
11086
+ $ref: examples/json/SignatureRequestListResponseExample.json
11087
+ AccountUpdateResponseExample:
11088
+ summary: 'Account Update'
11089
+ value:
11090
+ $ref: examples/json/AccountUpdateResponseExample.json
11091
+ OAuthTokenGenerateResponseExample:
11092
+ summary: 'Retrieving the OAuth token'
11093
+ value:
11094
+ $ref: examples/json/OAuthTokenGenerateResponseExample.json
11095
+ OAuthTokenRefreshResponseExample:
11096
+ summary: 'Refresh an existing OAuth token'
11097
+ value:
11098
+ $ref: examples/json/OAuthTokenRefreshResponseExample.json
11099
+ ApiAppCreateResponseExample:
11100
+ summary: 'API App'
11101
+ value:
11102
+ $ref: examples/json/ApiAppCreateResponseExample.json
11103
+ ApiAppUpdateResponseExample:
11104
+ summary: 'API App Update'
11105
+ value:
11106
+ $ref: examples/json/ApiAppUpdateResponseExample.json
11147
11107
  EventCallbackAccountSignatureRequestSentExample:
11148
11108
  summary: 'Example: signature_request_sent'
11149
11109
  value:
@@ -11164,18 +11124,6 @@ components:
11164
11124
  summary: 'Example: template_created'
11165
11125
  value:
11166
11126
  $ref: examples/json/EventCallbackAppTemplateCreatedExample.json
11167
- OAuthTokenGenerateResponseExample:
11168
- summary: 'Retrieving the OAuth token'
11169
- value:
11170
- $ref: examples/json/OAuthTokenGenerateResponseExample.json
11171
- OAuthTokenRefreshResponseExample:
11172
- summary: 'Refresh an existing OAuth token'
11173
- value:
11174
- $ref: examples/json/OAuthTokenRefreshResponseExample.json
11175
- ReportCreateResponseExample:
11176
- summary: Report
11177
- value:
11178
- $ref: examples/json/ReportCreateResponseExample.json
11179
11127
  SignatureRequestCreateEmbeddedResponseExample:
11180
11128
  summary: 'Create Embedded Signature Request'
11181
11129
  value:
@@ -11184,18 +11132,10 @@ components:
11184
11132
  summary: 'Create Embedded Signature Request With Template'
11185
11133
  value:
11186
11134
  $ref: examples/json/SignatureRequestCreateEmbeddedWithTemplateResponseExample.json
11187
- SignatureRequestGetResponseExample:
11188
- summary: 'Get Signature Request'
11189
- value:
11190
- $ref: examples/json/SignatureRequestGetResponseExample.json
11191
11135
  SignatureRequestFilesResponseExample:
11192
11136
  summary: 'Signature Requests Files'
11193
11137
  value:
11194
11138
  $ref: examples/json/SignatureRequestFilesResponseExample.json
11195
- SignatureRequestListResponseExample:
11196
- summary: 'List Signature Requests'
11197
- value:
11198
- $ref: examples/json/SignatureRequestListResponseExample.json
11199
11139
  SignatureRequestReleaseHoldResponseExample:
11200
11140
  summary: 'Send Signature Release Hold'
11201
11141
  value:
@@ -11224,34 +11164,14 @@ components:
11224
11164
  summary: 'Bulk Send Create Embedded Signature Request With Template'
11225
11165
  value:
11226
11166
  $ref: examples/json/SignatureRequestBulkCreateEmbeddedWithTemplateResponseExample.json
11227
- TeamAddMemberResponseExample:
11228
- summary: 'Team Add Member'
11229
- value:
11230
- $ref: examples/json/TeamAddMemberResponseExample.json
11231
11167
  TeamCreateResponseExample:
11232
11168
  summary: 'Team Create'
11233
11169
  value:
11234
11170
  $ref: examples/json/TeamCreateResponseExample.json
11235
- TeamGetResponseExample:
11236
- summary: 'Team Get'
11237
- value:
11238
- $ref: examples/json/TeamGetResponseExample.json
11239
- TeamGetInfoResponseExample:
11240
- summary: 'Team Get Info'
11241
- value:
11242
- $ref: examples/json/TeamGetInfoResponseExample.json
11243
- TeamInvitesResponseExample:
11244
- summary: 'Team Invites'
11245
- value:
11246
- $ref: examples/json/TeamInvitesResponseExample.json
11247
11171
  TeamMembersResponseExample:
11248
11172
  summary: 'Team Members List'
11249
11173
  value:
11250
11174
  $ref: examples/json/TeamMembersResponseExample.json
11251
- TeamSubTeamsResponseExample:
11252
- summary: 'Team Sub Teams List'
11253
- value:
11254
- $ref: examples/json/TeamSubTeamsResponseExample.json
11255
11175
  TeamRemoveMemberResponseExample:
11256
11176
  summary: 'Team Remove Member'
11257
11177
  value:
@@ -11268,34 +11188,14 @@ components:
11268
11188
  summary: 'Add User to Template'
11269
11189
  value:
11270
11190
  $ref: examples/json/TemplateAddUserResponseExample.json
11271
- TemplateCreateEmbeddedDraftResponseExample:
11272
- summary: 'Create Embedded Draft Template'
11273
- value:
11274
- $ref: examples/json/TemplateCreateEmbeddedDraftResponseExample.json
11275
11191
  TemplateFilesResponseExample:
11276
11192
  summary: 'Template Files'
11277
11193
  value:
11278
11194
  $ref: examples/json/TemplateFilesResponseExample.json
11279
- TemplateGetResponseExample:
11280
- summary: 'Get Template'
11281
- value:
11282
- $ref: examples/json/TemplateGetResponseExample.json
11283
- TemplateListResponseExample:
11284
- summary: 'List Templates'
11285
- value:
11286
- $ref: examples/json/TemplateListResponseExample.json
11287
11195
  TemplateRemoveUserResponseExample:
11288
11196
  summary: 'Remove User from Template'
11289
11197
  value:
11290
11198
  $ref: examples/json/TemplateRemoveUserResponseExample.json
11291
- TemplateUpdateFilesResponseExample:
11292
- summary: 'Update Template Files'
11293
- value:
11294
- $ref: examples/json/TemplateUpdateFilesResponseExample.json
11295
- UnclaimedDraftCreateResponseExample:
11296
- summary: 'Unclaimed Draft Create'
11297
- value:
11298
- $ref: examples/json/UnclaimedDraftCreateResponseExample.json
11299
11199
  UnclaimedDraftCreateEmbeddedResponseExample:
11300
11200
  summary: 'Unclaimed Draft Create Embedded'
11301
11201
  value:
@@ -11308,6 +11208,46 @@ components:
11308
11208
  summary: 'Unclaimed Draft Edit and Resend'
11309
11209
  value:
11310
11210
  $ref: examples/json/UnclaimedDraftEditAndResendExample.json
11211
+ TeamGetResponseExample:
11212
+ summary: 'Team Get'
11213
+ value:
11214
+ $ref: examples/json/TeamGetResponseExample.json
11215
+ TeamGetInfoResponseExample:
11216
+ summary: 'Team Get Info'
11217
+ value:
11218
+ $ref: examples/json/TeamGetInfoResponseExample.json
11219
+ TeamInvitesResponseExample:
11220
+ summary: 'Team Invites'
11221
+ value:
11222
+ $ref: examples/json/TeamInvitesResponseExample.json
11223
+ TeamAddMemberResponseExample:
11224
+ summary: 'Team Add Member'
11225
+ value:
11226
+ $ref: examples/json/TeamAddMemberResponseExample.json
11227
+ TeamSubTeamsResponseExample:
11228
+ summary: 'Team Sub Teams List'
11229
+ value:
11230
+ $ref: examples/json/TeamSubTeamsResponseExample.json
11231
+ TemplateCreateEmbeddedDraftResponseExample:
11232
+ summary: 'Create Embedded Draft Template'
11233
+ value:
11234
+ $ref: examples/json/TemplateCreateEmbeddedDraftResponseExample.json
11235
+ TemplateGetResponseExample:
11236
+ summary: 'Get Template'
11237
+ value:
11238
+ $ref: examples/json/TemplateGetResponseExample.json
11239
+ TemplateListResponseExample:
11240
+ summary: 'List Templates'
11241
+ value:
11242
+ $ref: examples/json/TemplateListResponseExample.json
11243
+ TemplateUpdateFilesResponseExample:
11244
+ summary: 'Update Template Files'
11245
+ value:
11246
+ $ref: examples/json/TemplateUpdateFilesResponseExample.json
11247
+ UnclaimedDraftCreateResponseExample:
11248
+ summary: 'Unclaimed Draft Create'
11249
+ value:
11250
+ $ref: examples/json/UnclaimedDraftCreateResponseExample.json
11311
11251
  requestBodies:
11312
11252
  EventCallbackAccountRequest:
11313
11253
  description: |-
@@ -11343,19 +11283,19 @@ components:
11343
11283
  schema:
11344
11284
  type: integer
11345
11285
  format: int32
11346
- example: 100
11286
+ example: 100
11347
11287
  X-RateLimit-Remaining:
11348
11288
  description: 'The number of requests remaining in the current rate limit window.'
11349
11289
  schema:
11350
11290
  type: integer
11351
11291
  format: int32
11352
- example: 99
11292
+ example: 99
11353
11293
  X-Ratelimit-Reset:
11354
11294
  description: 'The Unix time at which the rate limit will reset to its maximum.'
11355
11295
  schema:
11356
11296
  type: integer
11357
11297
  format: int64
11358
- example: 1430170900
11298
+ example: 1430170900
11359
11299
  securitySchemes:
11360
11300
  api_key:
11361
11301
  type: http