dropbox-sign 1.1.1 → 1.1.2
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile.lock +2 -1
- data/README.md +4 -4
- data/VERSION +1 -1
- data/docs/SignatureRequestCreateEmbeddedRequest.md +1 -1
- data/docs/SignatureRequestSendRequest.md +1 -1
- data/docs/SubFormFieldsPerDocumentBase.md +1 -1
- data/docs/TemplateCreateEmbeddedDraftRequest.md +1 -1
- data/docs/UnclaimedDraftCreateEmbeddedRequest.md +1 -1
- data/docs/UnclaimedDraftCreateRequest.md +1 -1
- data/lib/dropbox-sign/configuration.rb +1 -1
- data/lib/dropbox-sign/models/signature_request_create_embedded_request.rb +1 -1
- data/lib/dropbox-sign/models/signature_request_send_request.rb +1 -1
- data/lib/dropbox-sign/models/sub_form_fields_per_document_base.rb +1 -1
- data/lib/dropbox-sign/models/template_create_embedded_draft_request.rb +1 -1
- data/lib/dropbox-sign/models/unclaimed_draft_create_embedded_request.rb +1 -1
- data/lib/dropbox-sign/models/unclaimed_draft_create_request.rb +1 -1
- data/lib/dropbox-sign/version.rb +1 -1
- data/openapi-config.yaml +1 -1
- data/openapi-sdk.yaml +905 -953
- data/spec/configuration_spec.rb +5 -7
- data/templates/configuration.mustache +1 -1
- data/templates/configuration_spec.mustache +5 -7
- metadata +7 -7
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. (
|
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
|
|
@@ -7082,7 +7068,7 @@ components:
|
|
7082
7068
|
$ref: '#/components/schemas/SubFormFieldRule'
|
7083
7069
|
form_fields_per_document:
|
7084
7070
|
description: |-
|
7085
|
-
The fields that should appear on the document, expressed as an array of objects. (
|
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).)
|
7086
7072
|
|
7087
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.
|
7088
7074
|
|
@@ -7540,7 +7526,7 @@ components:
|
|
7540
7526
|
type: object
|
7541
7527
|
SubFormFieldsPerDocumentBase:
|
7542
7528
|
description: |-
|
7543
|
-
The fields that should appear on the document, expressed as an array of objects. (
|
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).)
|
7544
7530
|
|
7545
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.
|
7546
7532
|
|
@@ -7926,7 +7912,6 @@ components:
|
|
7926
7912
|
- Developer
|
7927
7913
|
- 'Team Manager'
|
7928
7914
|
- Admin
|
7929
|
-
x-beta: closed
|
7930
7915
|
type: object
|
7931
7916
|
TeamCreateRequest:
|
7932
7917
|
properties:
|
@@ -7960,7 +7945,6 @@ components:
|
|
7960
7945
|
new_team_id:
|
7961
7946
|
description: 'Id of the new Team.'
|
7962
7947
|
type: string
|
7963
|
-
x-beta: closed
|
7964
7948
|
new_role:
|
7965
7949
|
description: |-
|
7966
7950
|
A new role member will take in a new Team.
|
@@ -7972,7 +7956,6 @@ components:
|
|
7972
7956
|
- Developer
|
7973
7957
|
- 'Team Manager'
|
7974
7958
|
- Admin
|
7975
|
-
x-beta: closed
|
7976
7959
|
type: object
|
7977
7960
|
TeamUpdateRequest:
|
7978
7961
|
properties:
|
@@ -8067,7 +8050,7 @@ components:
|
|
8067
8050
|
$ref: '#/components/schemas/SubFormFieldRule'
|
8068
8051
|
form_fields_per_document:
|
8069
8052
|
description: |-
|
8070
|
-
The fields that should appear on the document, expressed as an array of objects. (
|
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).)
|
8071
8054
|
|
8072
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.
|
8073
8056
|
|
@@ -8249,7 +8232,7 @@ components:
|
|
8249
8232
|
$ref: '#/components/schemas/SubFormFieldRule'
|
8250
8233
|
form_fields_per_document:
|
8251
8234
|
description: |-
|
8252
|
-
The fields that should appear on the document, expressed as an array of objects. (
|
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).)
|
8253
8236
|
|
8254
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.
|
8255
8238
|
|
@@ -8413,7 +8396,7 @@ components:
|
|
8413
8396
|
$ref: '#/components/schemas/SubFormFieldRule'
|
8414
8397
|
form_fields_per_document:
|
8415
8398
|
description: |-
|
8416
|
-
The fields that should appear on the document, expressed as an array of objects. (
|
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).)
|
8417
8400
|
|
8418
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.
|
8419
8402
|
|
@@ -8703,43 +8686,6 @@ components:
|
|
8703
8686
|
type: boolean
|
8704
8687
|
default: false
|
8705
8688
|
type: object
|
8706
|
-
AccountResponse:
|
8707
|
-
properties:
|
8708
|
-
account_id:
|
8709
|
-
description: 'The ID of the Account'
|
8710
|
-
type: string
|
8711
|
-
email_address:
|
8712
|
-
description: 'The email address associated with the Account.'
|
8713
|
-
type: string
|
8714
|
-
is_locked:
|
8715
|
-
description: 'Returns `true` if the user has been locked out of their account by a team admin.'
|
8716
|
-
type: boolean
|
8717
|
-
is_paid_hs:
|
8718
|
-
description: 'Returns `true` if the user has a paid Dropbox Sign account.'
|
8719
|
-
type: boolean
|
8720
|
-
is_paid_hf:
|
8721
|
-
description: 'Returns `true` if the user has a paid HelloFax account.'
|
8722
|
-
type: boolean
|
8723
|
-
quotas:
|
8724
|
-
$ref: '#/components/schemas/AccountResponseQuotas'
|
8725
|
-
callback_url:
|
8726
|
-
description: 'The URL that Dropbox Sign events will `POST` to.'
|
8727
|
-
type: string
|
8728
|
-
nullable: true
|
8729
|
-
role_code:
|
8730
|
-
description: 'The membership role for the team.'
|
8731
|
-
type: string
|
8732
|
-
nullable: true
|
8733
|
-
team_id:
|
8734
|
-
description: 'The id of the team account belongs to.'
|
8735
|
-
type: string
|
8736
|
-
nullable: true
|
8737
|
-
locale:
|
8738
|
-
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.'
|
8739
|
-
type: string
|
8740
|
-
nullable: true
|
8741
|
-
type: object
|
8742
|
-
x-internal: true
|
8743
8689
|
AccountCreateResponse:
|
8744
8690
|
properties:
|
8745
8691
|
account:
|
@@ -8775,72 +8721,6 @@ components:
|
|
8775
8721
|
$ref: '#/components/schemas/WarningResponse'
|
8776
8722
|
type: object
|
8777
8723
|
x-internal: true
|
8778
|
-
AccountVerifyResponseAccount:
|
8779
|
-
properties:
|
8780
|
-
email_address:
|
8781
|
-
description: 'The email address associated with the Account.'
|
8782
|
-
type: string
|
8783
|
-
type: object
|
8784
|
-
x-internal: true
|
8785
|
-
AccountResponseQuotas:
|
8786
|
-
description: 'Details concerning remaining monthly quotas.'
|
8787
|
-
properties:
|
8788
|
-
api_signature_requests_left:
|
8789
|
-
description: 'API signature requests remaining.'
|
8790
|
-
type: integer
|
8791
|
-
nullable: true
|
8792
|
-
documents_left:
|
8793
|
-
description: 'Signature requests remaining.'
|
8794
|
-
type: integer
|
8795
|
-
nullable: true
|
8796
|
-
templates_total:
|
8797
|
-
description: 'Total API templates allowed.'
|
8798
|
-
type: integer
|
8799
|
-
nullable: true
|
8800
|
-
templates_left:
|
8801
|
-
description: 'API templates remaining.'
|
8802
|
-
type: integer
|
8803
|
-
nullable: true
|
8804
|
-
sms_verifications_left:
|
8805
|
-
description: 'SMS verifications remaining.'
|
8806
|
-
type: integer
|
8807
|
-
nullable: true
|
8808
|
-
type: object
|
8809
|
-
x-internal: true
|
8810
|
-
ApiAppResponse:
|
8811
|
-
description: 'Contains information about an API App.'
|
8812
|
-
properties:
|
8813
|
-
callback_url:
|
8814
|
-
description: 'The app''s callback URL (for events)'
|
8815
|
-
type: string
|
8816
|
-
nullable: true
|
8817
|
-
client_id:
|
8818
|
-
description: 'The app''s client id'
|
8819
|
-
type: string
|
8820
|
-
created_at:
|
8821
|
-
description: 'The time that the app was created'
|
8822
|
-
type: integer
|
8823
|
-
domains:
|
8824
|
-
description: 'The domain name(s) associated with the app'
|
8825
|
-
type: array
|
8826
|
-
items:
|
8827
|
-
type: string
|
8828
|
-
name:
|
8829
|
-
description: 'The name of the app'
|
8830
|
-
type: string
|
8831
|
-
is_approved:
|
8832
|
-
description: 'Boolean to indicate if the app has been approved'
|
8833
|
-
type: boolean
|
8834
|
-
oauth:
|
8835
|
-
$ref: '#/components/schemas/ApiAppResponseOAuth'
|
8836
|
-
options:
|
8837
|
-
$ref: '#/components/schemas/ApiAppResponseOptions'
|
8838
|
-
owner_account:
|
8839
|
-
$ref: '#/components/schemas/ApiAppResponseOwnerAccount'
|
8840
|
-
white_labeling_options:
|
8841
|
-
$ref: '#/components/schemas/ApiAppResponseWhiteLabelingOptions'
|
8842
|
-
type: object
|
8843
|
-
x-internal: true
|
8844
8724
|
ApiAppGetResponse:
|
8845
8725
|
properties:
|
8846
8726
|
api_app:
|
@@ -8868,98 +8748,6 @@ components:
|
|
8868
8748
|
$ref: '#/components/schemas/WarningResponse'
|
8869
8749
|
type: object
|
8870
8750
|
x-internal: true
|
8871
|
-
ApiAppResponseOAuth:
|
8872
|
-
description: 'An object describing the app''s OAuth properties, or null if OAuth is not configured for the app.'
|
8873
|
-
properties:
|
8874
|
-
callback_url:
|
8875
|
-
description: 'The app''s OAuth callback URL.'
|
8876
|
-
type: string
|
8877
|
-
secret:
|
8878
|
-
description: 'The app''s OAuth secret, or null if the app does not belong to user.'
|
8879
|
-
type: string
|
8880
|
-
scopes:
|
8881
|
-
description: 'Array of OAuth scopes used by the app.'
|
8882
|
-
type: array
|
8883
|
-
items:
|
8884
|
-
type: string
|
8885
|
-
charges_users:
|
8886
|
-
description: 'Boolean indicating whether the app owner or the account granting permission is billed for OAuth requests.'
|
8887
|
-
type: boolean
|
8888
|
-
type: object
|
8889
|
-
nullable: true
|
8890
|
-
x-internal: true
|
8891
|
-
ApiAppResponseOptions:
|
8892
|
-
description: 'An object with options that override account settings.'
|
8893
|
-
properties:
|
8894
|
-
can_insert_everywhere:
|
8895
|
-
description: 'Boolean denoting if signers can "Insert Everywhere" in one click while signing a document'
|
8896
|
-
type: boolean
|
8897
|
-
type: object
|
8898
|
-
nullable: true
|
8899
|
-
x-internal: true
|
8900
|
-
ApiAppResponseOwnerAccount:
|
8901
|
-
description: 'An object describing the app''s owner'
|
8902
|
-
properties:
|
8903
|
-
account_id:
|
8904
|
-
description: 'The owner account''s ID'
|
8905
|
-
type: string
|
8906
|
-
email_address:
|
8907
|
-
description: 'The owner account''s email address'
|
8908
|
-
type: string
|
8909
|
-
type: object
|
8910
|
-
x-internal: true
|
8911
|
-
ApiAppResponseWhiteLabelingOptions:
|
8912
|
-
description: 'An object with options to customize the app''s signer page'
|
8913
|
-
properties:
|
8914
|
-
header_background_color:
|
8915
|
-
type: string
|
8916
|
-
legal_version:
|
8917
|
-
type: string
|
8918
|
-
link_color:
|
8919
|
-
type: string
|
8920
|
-
page_background_color:
|
8921
|
-
type: string
|
8922
|
-
primary_button_color:
|
8923
|
-
type: string
|
8924
|
-
primary_button_color_hover:
|
8925
|
-
type: string
|
8926
|
-
primary_button_text_color:
|
8927
|
-
type: string
|
8928
|
-
primary_button_text_color_hover:
|
8929
|
-
type: string
|
8930
|
-
secondary_button_color:
|
8931
|
-
type: string
|
8932
|
-
secondary_button_color_hover:
|
8933
|
-
type: string
|
8934
|
-
secondary_button_text_color:
|
8935
|
-
type: string
|
8936
|
-
secondary_button_text_color_hover:
|
8937
|
-
type: string
|
8938
|
-
text_color1:
|
8939
|
-
type: string
|
8940
|
-
text_color2:
|
8941
|
-
type: string
|
8942
|
-
type: object
|
8943
|
-
nullable: true
|
8944
|
-
x-internal: true
|
8945
|
-
BulkSendJobResponse:
|
8946
|
-
description: 'Contains information about the BulkSendJob such as when it was created and how many signature requests are queued.'
|
8947
|
-
properties:
|
8948
|
-
bulk_send_job_id:
|
8949
|
-
description: 'The id of the BulkSendJob.'
|
8950
|
-
type: string
|
8951
|
-
nullable: true
|
8952
|
-
total:
|
8953
|
-
description: 'The total amount of Signature Requests queued for sending.'
|
8954
|
-
type: integer
|
8955
|
-
is_creator:
|
8956
|
-
description: 'True if you are the owner of this BulkSendJob, false if it''s been shared with you by a team member.'
|
8957
|
-
type: boolean
|
8958
|
-
created_at:
|
8959
|
-
description: 'Time that the BulkSendJob was created.'
|
8960
|
-
type: integer
|
8961
|
-
type: object
|
8962
|
-
x-internal: true
|
8963
8751
|
BulkSendJobGetResponse:
|
8964
8752
|
properties:
|
8965
8753
|
bulk_send_job:
|
@@ -8978,18 +8766,6 @@ components:
|
|
8978
8766
|
$ref: '#/components/schemas/WarningResponse'
|
8979
8767
|
type: object
|
8980
8768
|
x-internal: true
|
8981
|
-
BulkSendJobGetResponseSignatureRequests:
|
8982
|
-
title: BulkSendJobGetResponseSignatureRequests
|
8983
|
-
type: object
|
8984
|
-
allOf:
|
8985
|
-
-
|
8986
|
-
$ref: '#/components/schemas/SignatureRequestResponse'
|
8987
|
-
-
|
8988
|
-
properties:
|
8989
|
-
bulk_send_job_id:
|
8990
|
-
description: 'The id of the BulkSendJob.'
|
8991
|
-
type: string
|
8992
|
-
x-internal: true
|
8993
8769
|
BulkSendJobListResponse:
|
8994
8770
|
properties:
|
8995
8771
|
bulk_send_jobs:
|
@@ -9028,17 +8804,6 @@ components:
|
|
9028
8804
|
$ref: '#/components/schemas/WarningResponse'
|
9029
8805
|
type: object
|
9030
8806
|
x-internal: true
|
9031
|
-
EmbeddedEditUrlResponseEmbedded:
|
9032
|
-
description: 'An embedded template object.'
|
9033
|
-
properties:
|
9034
|
-
edit_url:
|
9035
|
-
description: 'A template url that can be opened in an iFrame.'
|
9036
|
-
type: string
|
9037
|
-
expires_at:
|
9038
|
-
description: 'The specific time that the the `edit_url` link expires, in epoch.'
|
9039
|
-
type: integer
|
9040
|
-
type: object
|
9041
|
-
x-internal: true
|
9042
8807
|
EmbeddedSignUrlResponse:
|
9043
8808
|
properties:
|
9044
8809
|
embedded:
|
@@ -9050,17 +8815,6 @@ components:
|
|
9050
8815
|
$ref: '#/components/schemas/WarningResponse'
|
9051
8816
|
type: object
|
9052
8817
|
x-internal: true
|
9053
|
-
EmbeddedSignUrlResponseEmbedded:
|
9054
|
-
description: 'An object that contains necessary information to set up embedded signing.'
|
9055
|
-
properties:
|
9056
|
-
sign_url:
|
9057
|
-
description: 'A signature url that can be opened in an iFrame.'
|
9058
|
-
type: string
|
9059
|
-
expires_at:
|
9060
|
-
description: 'The specific time that the the `sign_url` link expires, in epoch.'
|
9061
|
-
type: integer
|
9062
|
-
type: object
|
9063
|
-
x-internal: true
|
9064
8818
|
ErrorResponse:
|
9065
8819
|
required:
|
9066
8820
|
- error
|
@@ -9068,9 +8822,323 @@ components:
|
|
9068
8822
|
error:
|
9069
8823
|
$ref: '#/components/schemas/ErrorResponseError'
|
9070
8824
|
type: object
|
9071
|
-
|
9072
|
-
|
9073
|
-
required:
|
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.'
|
9125
|
+
type: integer
|
9126
|
+
type: object
|
9127
|
+
x-internal: true
|
9128
|
+
EmbeddedSignUrlResponseEmbedded:
|
9129
|
+
description: 'An object that contains necessary information to set up embedded signing.'
|
9130
|
+
properties:
|
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
|
9137
|
+
type: object
|
9138
|
+
x-internal: true
|
9139
|
+
ErrorResponseError:
|
9140
|
+
description: 'Contains information about an error that occurred.'
|
9141
|
+
required:
|
9074
9142
|
- error_msg
|
9075
9143
|
- error_name
|
9076
9144
|
properties:
|
@@ -9084,20 +9152,6 @@ components:
|
|
9084
9152
|
description: 'Name of the error.'
|
9085
9153
|
type: string
|
9086
9154
|
type: object
|
9087
|
-
EventCallbackRequest:
|
9088
|
-
title: EventCallbackRequest
|
9089
|
-
required:
|
9090
|
-
- event
|
9091
|
-
properties:
|
9092
|
-
event:
|
9093
|
-
$ref: '#/components/schemas/EventCallbackRequestEvent'
|
9094
|
-
account:
|
9095
|
-
$ref: '#/components/schemas/AccountResponse'
|
9096
|
-
signature_request:
|
9097
|
-
$ref: '#/components/schemas/SignatureRequestResponse'
|
9098
|
-
template:
|
9099
|
-
$ref: '#/components/schemas/TemplateResponse'
|
9100
|
-
type: object
|
9101
9155
|
EventCallbackRequestEvent:
|
9102
9156
|
description: 'Basic information about the event that occurred.'
|
9103
9157
|
required:
|
@@ -9161,23 +9215,6 @@ components:
|
|
9161
9215
|
type: string
|
9162
9216
|
nullable: true
|
9163
9217
|
type: object
|
9164
|
-
FileResponse:
|
9165
|
-
properties:
|
9166
|
-
file_url:
|
9167
|
-
description: 'URL to the file.'
|
9168
|
-
type: string
|
9169
|
-
expires_at:
|
9170
|
-
description: 'When the link expires.'
|
9171
|
-
type: integer
|
9172
|
-
type: object
|
9173
|
-
x-internal: true
|
9174
|
-
FileResponseDataUri:
|
9175
|
-
properties:
|
9176
|
-
data_uri:
|
9177
|
-
description: 'File as base64 encoded string.'
|
9178
|
-
type: string
|
9179
|
-
type: object
|
9180
|
-
x-internal: true
|
9181
9218
|
ListInfoResponse:
|
9182
9219
|
description: 'Contains pagination information about the data returned.'
|
9183
9220
|
properties:
|
@@ -9196,169 +9233,6 @@ components:
|
|
9196
9233
|
type: integer
|
9197
9234
|
type: object
|
9198
9235
|
x-internal: true
|
9199
|
-
SignatureRequestResponseDataTypeEnum:
|
9200
|
-
type: string
|
9201
|
-
enum:
|
9202
|
-
- text
|
9203
|
-
- checkbox
|
9204
|
-
- date_signed
|
9205
|
-
- dropdown
|
9206
|
-
- initials
|
9207
|
-
- radio
|
9208
|
-
- signature
|
9209
|
-
- text-merge
|
9210
|
-
- checkbox-merge
|
9211
|
-
SignatureRequestResponseDataValueText:
|
9212
|
-
type: object
|
9213
|
-
allOf:
|
9214
|
-
-
|
9215
|
-
$ref: '#/components/schemas/SignatureRequestResponseDataBase'
|
9216
|
-
-
|
9217
|
-
properties:
|
9218
|
-
type:
|
9219
|
-
description: 'A text input field'
|
9220
|
-
type: string
|
9221
|
-
default: text
|
9222
|
-
value:
|
9223
|
-
description: 'The value of the form field.'
|
9224
|
-
type: string
|
9225
|
-
type: object
|
9226
|
-
SignatureRequestResponseDataValueDropdown:
|
9227
|
-
type: object
|
9228
|
-
allOf:
|
9229
|
-
-
|
9230
|
-
$ref: '#/components/schemas/SignatureRequestResponseDataBase'
|
9231
|
-
-
|
9232
|
-
properties:
|
9233
|
-
type:
|
9234
|
-
description: 'An input field for dropdowns'
|
9235
|
-
type: string
|
9236
|
-
default: dropdown
|
9237
|
-
value:
|
9238
|
-
description: 'The value of the form field.'
|
9239
|
-
type: string
|
9240
|
-
type: object
|
9241
|
-
SignatureRequestResponseDataValueRadio:
|
9242
|
-
type: object
|
9243
|
-
allOf:
|
9244
|
-
-
|
9245
|
-
$ref: '#/components/schemas/SignatureRequestResponseDataBase'
|
9246
|
-
-
|
9247
|
-
properties:
|
9248
|
-
type:
|
9249
|
-
description: 'An input field for radios'
|
9250
|
-
type: string
|
9251
|
-
default: radio
|
9252
|
-
value:
|
9253
|
-
description: 'The value of the form field.'
|
9254
|
-
type: boolean
|
9255
|
-
type: object
|
9256
|
-
SignatureRequestResponseDataValueDateSigned:
|
9257
|
-
type: object
|
9258
|
-
allOf:
|
9259
|
-
-
|
9260
|
-
$ref: '#/components/schemas/SignatureRequestResponseDataBase'
|
9261
|
-
-
|
9262
|
-
properties:
|
9263
|
-
type:
|
9264
|
-
description: 'A date'
|
9265
|
-
type: string
|
9266
|
-
default: date_signed
|
9267
|
-
value:
|
9268
|
-
description: 'The value of the form field.'
|
9269
|
-
type: string
|
9270
|
-
type: object
|
9271
|
-
SignatureRequestResponseDataValueInitials:
|
9272
|
-
type: object
|
9273
|
-
allOf:
|
9274
|
-
-
|
9275
|
-
$ref: '#/components/schemas/SignatureRequestResponseDataBase'
|
9276
|
-
-
|
9277
|
-
properties:
|
9278
|
-
type:
|
9279
|
-
description: 'An input field for initials'
|
9280
|
-
type: string
|
9281
|
-
default: initials
|
9282
|
-
value:
|
9283
|
-
description: 'The value of the form field.'
|
9284
|
-
type: string
|
9285
|
-
type: object
|
9286
|
-
SignatureRequestResponseDataValueCheckbox:
|
9287
|
-
type: object
|
9288
|
-
allOf:
|
9289
|
-
-
|
9290
|
-
$ref: '#/components/schemas/SignatureRequestResponseDataBase'
|
9291
|
-
-
|
9292
|
-
properties:
|
9293
|
-
type:
|
9294
|
-
description: 'A yes/no checkbox'
|
9295
|
-
type: string
|
9296
|
-
default: checkbox
|
9297
|
-
value:
|
9298
|
-
description: 'The value of the form field.'
|
9299
|
-
type: boolean
|
9300
|
-
type: object
|
9301
|
-
SignatureRequestResponseDataValueSignature:
|
9302
|
-
type: object
|
9303
|
-
allOf:
|
9304
|
-
-
|
9305
|
-
$ref: '#/components/schemas/SignatureRequestResponseDataBase'
|
9306
|
-
-
|
9307
|
-
properties:
|
9308
|
-
type:
|
9309
|
-
description: 'A signature input field'
|
9310
|
-
type: string
|
9311
|
-
default: signature
|
9312
|
-
value:
|
9313
|
-
description: 'The value of the form field.'
|
9314
|
-
type: string
|
9315
|
-
type: object
|
9316
|
-
SignatureRequestResponseDataValueTextMerge:
|
9317
|
-
type: object
|
9318
|
-
allOf:
|
9319
|
-
-
|
9320
|
-
$ref: '#/components/schemas/SignatureRequestResponseDataBase'
|
9321
|
-
-
|
9322
|
-
properties:
|
9323
|
-
type:
|
9324
|
-
description: 'A text field that has default text set by the api'
|
9325
|
-
type: string
|
9326
|
-
default: text-merge
|
9327
|
-
value:
|
9328
|
-
description: 'The value of the form field.'
|
9329
|
-
type: string
|
9330
|
-
type: object
|
9331
|
-
SignatureRequestResponseDataValueCheckboxMerge:
|
9332
|
-
type: object
|
9333
|
-
allOf:
|
9334
|
-
-
|
9335
|
-
$ref: '#/components/schemas/SignatureRequestResponseDataBase'
|
9336
|
-
-
|
9337
|
-
properties:
|
9338
|
-
type:
|
9339
|
-
description: 'A checkbox field that has default value set by the api'
|
9340
|
-
type: string
|
9341
|
-
default: checkbox-merge
|
9342
|
-
value:
|
9343
|
-
description: 'The value of the form field.'
|
9344
|
-
type: string
|
9345
|
-
type: object
|
9346
|
-
OAuthTokenResponse:
|
9347
|
-
properties:
|
9348
|
-
access_token:
|
9349
|
-
type: string
|
9350
|
-
token_type:
|
9351
|
-
type: string
|
9352
|
-
refresh_token:
|
9353
|
-
type: string
|
9354
|
-
expires_in:
|
9355
|
-
description: 'Number of seconds until the `access_token` expires. Uses epoch time.'
|
9356
|
-
type: integer
|
9357
|
-
state:
|
9358
|
-
type: string
|
9359
|
-
nullable: true
|
9360
|
-
type: object
|
9361
|
-
x-internal: true
|
9362
9236
|
ReportResponse:
|
9363
9237
|
description: 'Contains information about the report request.'
|
9364
9238
|
properties:
|
@@ -9380,17 +9254,6 @@ components:
|
|
9380
9254
|
- document_status
|
9381
9255
|
type: object
|
9382
9256
|
x-internal: true
|
9383
|
-
ReportCreateResponse:
|
9384
|
-
properties:
|
9385
|
-
report:
|
9386
|
-
$ref: '#/components/schemas/ReportResponse'
|
9387
|
-
warnings:
|
9388
|
-
description: 'A list of warnings.'
|
9389
|
-
type: array
|
9390
|
-
items:
|
9391
|
-
$ref: '#/components/schemas/WarningResponse'
|
9392
|
-
type: object
|
9393
|
-
x-internal: true
|
9394
9257
|
SignatureRequestResponse:
|
9395
9258
|
description: 'Contains information about a signature request.'
|
9396
9259
|
properties:
|
@@ -9492,33 +9355,6 @@ components:
|
|
9492
9355
|
$ref: '#/components/schemas/SignatureRequestResponseSignatures'
|
9493
9356
|
type: object
|
9494
9357
|
x-internal: true
|
9495
|
-
SignatureRequestGetResponse:
|
9496
|
-
properties:
|
9497
|
-
signature_request:
|
9498
|
-
$ref: '#/components/schemas/SignatureRequestResponse'
|
9499
|
-
warnings:
|
9500
|
-
description: 'A list of warnings.'
|
9501
|
-
type: array
|
9502
|
-
items:
|
9503
|
-
$ref: '#/components/schemas/WarningResponse'
|
9504
|
-
type: object
|
9505
|
-
x-internal: true
|
9506
|
-
SignatureRequestListResponse:
|
9507
|
-
properties:
|
9508
|
-
signature_requests:
|
9509
|
-
description: 'Contains information about signature requests.'
|
9510
|
-
type: array
|
9511
|
-
items:
|
9512
|
-
$ref: '#/components/schemas/SignatureRequestResponse'
|
9513
|
-
list_info:
|
9514
|
-
$ref: '#/components/schemas/ListInfoResponse'
|
9515
|
-
warnings:
|
9516
|
-
description: 'A list of warnings.'
|
9517
|
-
type: array
|
9518
|
-
items:
|
9519
|
-
$ref: '#/components/schemas/WarningResponse'
|
9520
|
-
type: object
|
9521
|
-
x-internal: true
|
9522
9358
|
SignatureRequestResponseAttachment:
|
9523
9359
|
description: 'Signer attachments.'
|
9524
9360
|
required:
|
@@ -9549,11 +9385,6 @@ components:
|
|
9549
9385
|
nullable: true
|
9550
9386
|
type: object
|
9551
9387
|
x-internal: true
|
9552
|
-
SignatureRequestResponseCustomFieldTypeEnum:
|
9553
|
-
type: string
|
9554
|
-
enum:
|
9555
|
-
- text
|
9556
|
-
- checkbox
|
9557
9388
|
SignatureRequestResponseCustomFieldBase:
|
9558
9389
|
description: |-
|
9559
9390
|
An array of Custom Field objects containing the name and type of each custom field.
|
@@ -9587,44 +9418,45 @@ components:
|
|
9587
9418
|
checkbox: '#/components/schemas/SignatureRequestResponseCustomFieldCheckbox'
|
9588
9419
|
x-internal: true
|
9589
9420
|
x-base-class: true
|
9590
|
-
|
9421
|
+
SignatureRequestResponseCustomFieldCheckbox:
|
9591
9422
|
description: 'This class extends `SignatureRequestResponseCustomFieldBase`.'
|
9423
|
+
required:
|
9424
|
+
- type
|
9592
9425
|
type: object
|
9593
9426
|
allOf:
|
9594
9427
|
-
|
9595
9428
|
$ref: '#/components/schemas/SignatureRequestResponseCustomFieldBase'
|
9596
9429
|
-
|
9597
|
-
required:
|
9598
|
-
- type
|
9599
|
-
- options
|
9600
9430
|
properties:
|
9601
9431
|
type:
|
9602
9432
|
description: 'The type of this Custom Field. Only ''text'' and ''checkbox'' are currently supported.'
|
9603
9433
|
type: string
|
9604
|
-
default:
|
9434
|
+
default: checkbox
|
9605
9435
|
value:
|
9606
|
-
description: 'A
|
9607
|
-
type:
|
9608
|
-
|
9609
|
-
SignatureRequestResponseCustomFieldCheckbox:
|
9436
|
+
description: 'A true/false for checkbox fields'
|
9437
|
+
type: boolean
|
9438
|
+
SignatureRequestResponseCustomFieldText:
|
9610
9439
|
description: 'This class extends `SignatureRequestResponseCustomFieldBase`.'
|
9440
|
+
required:
|
9441
|
+
- type
|
9611
9442
|
type: object
|
9612
9443
|
allOf:
|
9613
9444
|
-
|
9614
9445
|
$ref: '#/components/schemas/SignatureRequestResponseCustomFieldBase'
|
9615
9446
|
-
|
9616
|
-
required:
|
9617
|
-
- type
|
9618
|
-
- options
|
9619
9447
|
properties:
|
9620
9448
|
type:
|
9621
9449
|
description: 'The type of this Custom Field. Only ''text'' and ''checkbox'' are currently supported.'
|
9622
9450
|
type: string
|
9623
|
-
default:
|
9451
|
+
default: text
|
9624
9452
|
value:
|
9625
|
-
description: 'A
|
9626
|
-
type:
|
9627
|
-
|
9453
|
+
description: 'A text string for text fields'
|
9454
|
+
type: string
|
9455
|
+
SignatureRequestResponseCustomFieldTypeEnum:
|
9456
|
+
type: string
|
9457
|
+
enum:
|
9458
|
+
- text
|
9459
|
+
- checkbox
|
9628
9460
|
SignatureRequestResponseDataBase:
|
9629
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.'
|
9630
9462
|
properties:
|
@@ -9657,6 +9489,144 @@ components:
|
|
9657
9489
|
checkbox-merge: '#/components/schemas/SignatureRequestResponseDataValueCheckboxMerge'
|
9658
9490
|
x-internal: true
|
9659
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
|
9660
9630
|
SignatureRequestResponseSignatures:
|
9661
9631
|
description: 'An array of signature objects, 1 for each signer.'
|
9662
9632
|
properties:
|
@@ -9756,18 +9726,6 @@ components:
|
|
9756
9726
|
type: string
|
9757
9727
|
type: object
|
9758
9728
|
x-internal: true
|
9759
|
-
TeamParentResponse:
|
9760
|
-
description: 'Information about the parent team if a team has one, set to `null` otherwise.'
|
9761
|
-
properties:
|
9762
|
-
team_id:
|
9763
|
-
description: 'The id of a team'
|
9764
|
-
type: string
|
9765
|
-
name:
|
9766
|
-
description: 'The name of a team'
|
9767
|
-
type: string
|
9768
|
-
type: object
|
9769
|
-
nullable: true
|
9770
|
-
x-internal: true
|
9771
9729
|
TeamInfoResponse:
|
9772
9730
|
properties:
|
9773
9731
|
team_id:
|
@@ -9786,30 +9744,6 @@ components:
|
|
9786
9744
|
type: integer
|
9787
9745
|
type: object
|
9788
9746
|
x-internal: true
|
9789
|
-
TeamGetInfoResponse:
|
9790
|
-
properties:
|
9791
|
-
team:
|
9792
|
-
$ref: '#/components/schemas/TeamInfoResponse'
|
9793
|
-
warnings:
|
9794
|
-
description: 'A list of warnings.'
|
9795
|
-
type: array
|
9796
|
-
items:
|
9797
|
-
$ref: '#/components/schemas/WarningResponse'
|
9798
|
-
type: object
|
9799
|
-
x-internal: true
|
9800
|
-
TeamMemberResponse:
|
9801
|
-
properties:
|
9802
|
-
account_id:
|
9803
|
-
description: 'Account id of the team member.'
|
9804
|
-
type: string
|
9805
|
-
email_address:
|
9806
|
-
description: 'Email address of the team member.'
|
9807
|
-
type: string
|
9808
|
-
role:
|
9809
|
-
description: 'The specific role a member has on the team.'
|
9810
|
-
type: string
|
9811
|
-
type: object
|
9812
|
-
x-internal: true
|
9813
9747
|
TeamInviteResponse:
|
9814
9748
|
properties:
|
9815
9749
|
email_address:
|
@@ -9832,68 +9766,39 @@ components:
|
|
9832
9766
|
type: integer
|
9833
9767
|
type: object
|
9834
9768
|
x-internal: true
|
9835
|
-
|
9836
|
-
properties:
|
9837
|
-
team_invites:
|
9838
|
-
description: 'Contains a list of team invites and their roles.'
|
9839
|
-
type: array
|
9840
|
-
items:
|
9841
|
-
$ref: '#/components/schemas/TeamInviteResponse'
|
9842
|
-
warnings:
|
9843
|
-
type: array
|
9844
|
-
items:
|
9845
|
-
$ref: '#/components/schemas/WarningResponse'
|
9846
|
-
type: object
|
9847
|
-
x-internal: true
|
9848
|
-
SubTeamResponse:
|
9769
|
+
TeamMemberResponse:
|
9849
9770
|
properties:
|
9850
|
-
|
9851
|
-
description: '
|
9771
|
+
account_id:
|
9772
|
+
description: 'Account id of the team member.'
|
9852
9773
|
type: string
|
9853
|
-
|
9854
|
-
description: '
|
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.'
|
9855
9779
|
type: string
|
9856
9780
|
type: object
|
9857
9781
|
x-internal: true
|
9858
|
-
|
9859
|
-
|
9860
|
-
team:
|
9861
|
-
$ref: '#/components/schemas/TeamResponse'
|
9862
|
-
warnings:
|
9863
|
-
description: 'A list of warnings.'
|
9864
|
-
type: array
|
9865
|
-
items:
|
9866
|
-
$ref: '#/components/schemas/WarningResponse'
|
9867
|
-
type: object
|
9868
|
-
x-internal: true
|
9869
|
-
TeamMembersResponse:
|
9870
|
-
properties:
|
9871
|
-
team_members:
|
9872
|
-
description: 'Contains a list of team members and their roles for a specific team.'
|
9873
|
-
type: array
|
9874
|
-
items:
|
9875
|
-
$ref: '#/components/schemas/TeamMemberResponse'
|
9876
|
-
list_info:
|
9877
|
-
$ref: '#/components/schemas/ListInfoResponse'
|
9878
|
-
warnings:
|
9879
|
-
type: array
|
9880
|
-
items:
|
9881
|
-
$ref: '#/components/schemas/WarningResponse'
|
9882
|
-
type: object
|
9883
|
-
x-internal: true
|
9884
|
-
TeamSubTeamsResponse:
|
9782
|
+
TeamParentResponse:
|
9783
|
+
description: 'Information about the parent team if a team has one, set to `null` otherwise.'
|
9885
9784
|
properties:
|
9886
|
-
|
9887
|
-
description: '
|
9888
|
-
type:
|
9889
|
-
|
9890
|
-
|
9891
|
-
|
9892
|
-
|
9893
|
-
|
9894
|
-
|
9895
|
-
|
9896
|
-
|
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
|
9791
|
+
type: object
|
9792
|
+
nullable: true
|
9793
|
+
x-internal: true
|
9794
|
+
SubTeamResponse:
|
9795
|
+
properties:
|
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
|
9897
9802
|
type: object
|
9898
9803
|
x-internal: true
|
9899
9804
|
TemplateResponse:
|
@@ -9970,88 +9875,6 @@ components:
|
|
9970
9875
|
nullable: true
|
9971
9876
|
type: object
|
9972
9877
|
x-internal: true
|
9973
|
-
TemplateCreateEmbeddedDraftResponse:
|
9974
|
-
properties:
|
9975
|
-
template:
|
9976
|
-
$ref: '#/components/schemas/TemplateCreateEmbeddedDraftResponseTemplate'
|
9977
|
-
warnings:
|
9978
|
-
description: 'A list of warnings.'
|
9979
|
-
type: array
|
9980
|
-
items:
|
9981
|
-
$ref: '#/components/schemas/WarningResponse'
|
9982
|
-
type: object
|
9983
|
-
x-internal: true
|
9984
|
-
TemplateCreateEmbeddedDraftResponseTemplate:
|
9985
|
-
description: 'Template object with parameters: `template_id`, `edit_url`, `expires_at`.'
|
9986
|
-
properties:
|
9987
|
-
template_id:
|
9988
|
-
description: 'The id of the Template.'
|
9989
|
-
type: string
|
9990
|
-
edit_url:
|
9991
|
-
description: 'Link to edit the template.'
|
9992
|
-
type: string
|
9993
|
-
expires_at:
|
9994
|
-
description: 'When the link expires.'
|
9995
|
-
type: integer
|
9996
|
-
warnings:
|
9997
|
-
description: 'A list of warnings.'
|
9998
|
-
type: array
|
9999
|
-
items:
|
10000
|
-
$ref: '#/components/schemas/WarningResponse'
|
10001
|
-
type: object
|
10002
|
-
x-internal: true
|
10003
|
-
TemplateUpdateFilesResponse:
|
10004
|
-
properties:
|
10005
|
-
template:
|
10006
|
-
$ref: '#/components/schemas/TemplateUpdateFilesResponseTemplate'
|
10007
|
-
type: object
|
10008
|
-
x-internal: true
|
10009
|
-
TemplateUpdateFilesResponseTemplate:
|
10010
|
-
description: 'Contains template id'
|
10011
|
-
properties:
|
10012
|
-
template_id:
|
10013
|
-
description: 'The id of the Template.'
|
10014
|
-
type: string
|
10015
|
-
warnings:
|
10016
|
-
description: 'A list of warnings.'
|
10017
|
-
type: array
|
10018
|
-
items:
|
10019
|
-
$ref: '#/components/schemas/WarningResponse'
|
10020
|
-
type: object
|
10021
|
-
x-internal: true
|
10022
|
-
TemplateGetResponse:
|
10023
|
-
properties:
|
10024
|
-
template:
|
10025
|
-
$ref: '#/components/schemas/TemplateResponse'
|
10026
|
-
warnings:
|
10027
|
-
description: 'A list of warnings.'
|
10028
|
-
type: array
|
10029
|
-
items:
|
10030
|
-
$ref: '#/components/schemas/WarningResponse'
|
10031
|
-
type: object
|
10032
|
-
x-internal: true
|
10033
|
-
TemplateListResponse:
|
10034
|
-
properties:
|
10035
|
-
templates:
|
10036
|
-
description: 'List of templates that the API caller has access to.'
|
10037
|
-
type: array
|
10038
|
-
items:
|
10039
|
-
$ref: '#/components/schemas/TemplateResponse'
|
10040
|
-
list_info:
|
10041
|
-
$ref: '#/components/schemas/ListInfoResponse'
|
10042
|
-
warnings:
|
10043
|
-
description: 'A list of warnings.'
|
10044
|
-
type: array
|
10045
|
-
items:
|
10046
|
-
$ref: '#/components/schemas/WarningResponse'
|
10047
|
-
type: object
|
10048
|
-
x-internal: true
|
10049
|
-
TemplateEditResponse:
|
10050
|
-
properties:
|
10051
|
-
template_id:
|
10052
|
-
description: 'The id of the Template.'
|
10053
|
-
type: string
|
10054
|
-
type: object
|
10055
9878
|
TemplateResponseAccount:
|
10056
9879
|
properties:
|
10057
9880
|
account_id:
|
@@ -10097,6 +9920,25 @@ components:
|
|
10097
9920
|
type: string
|
10098
9921
|
type: object
|
10099
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
|
10100
9942
|
TemplateResponseDocument:
|
10101
9943
|
properties:
|
10102
9944
|
name:
|
@@ -10172,15 +10014,15 @@ components:
|
|
10172
10014
|
checkbox: '#/components/schemas/TemplateResponseDocumentCustomFieldCheckbox'
|
10173
10015
|
x-internal: true
|
10174
10016
|
x-base-class: true
|
10175
|
-
|
10017
|
+
TemplateResponseDocumentCustomFieldCheckbox:
|
10176
10018
|
description: 'This class extends `TemplateResponseDocumentCustomFieldBase`'
|
10019
|
+
required:
|
10020
|
+
- type
|
10177
10021
|
type: object
|
10178
10022
|
allOf:
|
10179
10023
|
-
|
10180
10024
|
$ref: '#/components/schemas/TemplateResponseDocumentCustomFieldBase'
|
10181
10025
|
-
|
10182
|
-
required:
|
10183
|
-
- type
|
10184
10026
|
properties:
|
10185
10027
|
type:
|
10186
10028
|
description: |-
|
@@ -10189,28 +10031,16 @@ components:
|
|
10189
10031
|
* Text uses `TemplateResponseDocumentCustomFieldText`
|
10190
10032
|
* Checkbox uses `TemplateResponseDocumentCustomFieldCheckbox`
|
10191
10033
|
type: string
|
10192
|
-
default:
|
10193
|
-
|
10194
|
-
$ref: '#/components/schemas/TemplateResponseFieldAvgTextLength'
|
10195
|
-
isMultiline:
|
10196
|
-
description: 'Whether this form field is multiline text.'
|
10197
|
-
type: boolean
|
10198
|
-
originalFontSize:
|
10199
|
-
description: 'Original font size used in this form field''s text.'
|
10200
|
-
type: integer
|
10201
|
-
fontFamily:
|
10202
|
-
description: 'Font family used in this form field''s text.'
|
10203
|
-
type: string
|
10204
|
-
type: object
|
10205
|
-
TemplateResponseDocumentCustomFieldCheckbox:
|
10034
|
+
default: checkbox
|
10035
|
+
TemplateResponseDocumentCustomFieldText:
|
10206
10036
|
description: 'This class extends `TemplateResponseDocumentCustomFieldBase`'
|
10037
|
+
required:
|
10038
|
+
- type
|
10207
10039
|
type: object
|
10208
10040
|
allOf:
|
10209
10041
|
-
|
10210
10042
|
$ref: '#/components/schemas/TemplateResponseDocumentCustomFieldBase'
|
10211
10043
|
-
|
10212
|
-
required:
|
10213
|
-
- type
|
10214
10044
|
properties:
|
10215
10045
|
type:
|
10216
10046
|
description: |-
|
@@ -10219,8 +10049,18 @@ components:
|
|
10219
10049
|
* Text uses `TemplateResponseDocumentCustomFieldText`
|
10220
10050
|
* Checkbox uses `TemplateResponseDocumentCustomFieldCheckbox`
|
10221
10051
|
type: string
|
10222
|
-
default:
|
10223
|
-
|
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
|
10224
10064
|
TemplateResponseDocumentFieldGroup:
|
10225
10065
|
properties:
|
10226
10066
|
name:
|
@@ -10295,15 +10135,15 @@ components:
|
|
10295
10135
|
initials: '#/components/schemas/TemplateResponseDocumentFormFieldInitials'
|
10296
10136
|
x-internal: true
|
10297
10137
|
x-base-class: true
|
10298
|
-
|
10138
|
+
TemplateResponseDocumentFormFieldCheckbox:
|
10299
10139
|
description: 'This class extends `TemplateResponseDocumentFormFieldBase`'
|
10140
|
+
required:
|
10141
|
+
- type
|
10300
10142
|
type: object
|
10301
10143
|
allOf:
|
10302
10144
|
-
|
10303
10145
|
$ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase'
|
10304
10146
|
-
|
10305
|
-
required:
|
10306
|
-
- type
|
10307
10147
|
properties:
|
10308
10148
|
type:
|
10309
10149
|
description: |-
|
@@ -10318,43 +10158,16 @@ components:
|
|
10318
10158
|
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
|
10319
10159
|
* Initials Field uses `TemplateResponseDocumentFormFieldInitials`
|
10320
10160
|
type: string
|
10321
|
-
default:
|
10322
|
-
|
10323
|
-
$ref: '#/components/schemas/TemplateResponseFieldAvgTextLength'
|
10324
|
-
isMultiline:
|
10325
|
-
description: 'Whether this form field is multiline text.'
|
10326
|
-
type: boolean
|
10327
|
-
originalFontSize:
|
10328
|
-
description: 'Original font size used in this form field''s text.'
|
10329
|
-
type: integer
|
10330
|
-
fontFamily:
|
10331
|
-
description: 'Font family used in this form field''s text.'
|
10332
|
-
type: string
|
10333
|
-
validation_type:
|
10334
|
-
description: 'Each text field may contain a `validation_type` parameter. Check out the list of [validation types](https://faq.hellosign.com/hc/en-us/articles/217115577) to learn more about the possible values.'
|
10335
|
-
type: string
|
10336
|
-
enum:
|
10337
|
-
- numbers_only
|
10338
|
-
- letters_only
|
10339
|
-
- phone_number
|
10340
|
-
- bank_routing_number
|
10341
|
-
- bank_account_number
|
10342
|
-
- email_address
|
10343
|
-
- zip_code
|
10344
|
-
- social_security_number
|
10345
|
-
- employer_identification_number
|
10346
|
-
- custom_regex
|
10347
|
-
nullable: true
|
10348
|
-
type: object
|
10349
|
-
TemplateResponseDocumentFormFieldDropdown:
|
10161
|
+
default: checkbox
|
10162
|
+
TemplateResponseDocumentFormFieldDateSigned:
|
10350
10163
|
description: 'This class extends `TemplateResponseDocumentFormFieldBase`'
|
10164
|
+
required:
|
10165
|
+
- type
|
10351
10166
|
type: object
|
10352
10167
|
allOf:
|
10353
10168
|
-
|
10354
10169
|
$ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase'
|
10355
10170
|
-
|
10356
|
-
required:
|
10357
|
-
- type
|
10358
10171
|
properties:
|
10359
10172
|
type:
|
10360
10173
|
description: |-
|
@@ -10369,17 +10182,16 @@ components:
|
|
10369
10182
|
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
|
10370
10183
|
* Initials Field uses `TemplateResponseDocumentFormFieldInitials`
|
10371
10184
|
type: string
|
10372
|
-
default:
|
10373
|
-
|
10374
|
-
TemplateResponseDocumentFormFieldHyperlink:
|
10185
|
+
default: date_signed
|
10186
|
+
TemplateResponseDocumentFormFieldDropdown:
|
10375
10187
|
description: 'This class extends `TemplateResponseDocumentFormFieldBase`'
|
10188
|
+
required:
|
10189
|
+
- type
|
10376
10190
|
type: object
|
10377
10191
|
allOf:
|
10378
10192
|
-
|
10379
10193
|
$ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase'
|
10380
10194
|
-
|
10381
|
-
required:
|
10382
|
-
- type
|
10383
10195
|
properties:
|
10384
10196
|
type:
|
10385
10197
|
description: |-
|
@@ -10394,28 +10206,16 @@ components:
|
|
10394
10206
|
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
|
10395
10207
|
* Initials Field uses `TemplateResponseDocumentFormFieldInitials`
|
10396
10208
|
type: string
|
10397
|
-
default:
|
10398
|
-
|
10399
|
-
$ref: '#/components/schemas/TemplateResponseFieldAvgTextLength'
|
10400
|
-
isMultiline:
|
10401
|
-
description: 'Whether this form field is multiline text.'
|
10402
|
-
type: boolean
|
10403
|
-
originalFontSize:
|
10404
|
-
description: 'Original font size used in this form field''s text.'
|
10405
|
-
type: integer
|
10406
|
-
fontFamily:
|
10407
|
-
description: 'Font family used in this form field''s text.'
|
10408
|
-
type: string
|
10409
|
-
type: object
|
10410
|
-
TemplateResponseDocumentFormFieldCheckbox:
|
10209
|
+
default: dropdown
|
10210
|
+
TemplateResponseDocumentFormFieldHyperlink:
|
10411
10211
|
description: 'This class extends `TemplateResponseDocumentFormFieldBase`'
|
10212
|
+
required:
|
10213
|
+
- type
|
10412
10214
|
type: object
|
10413
10215
|
allOf:
|
10414
10216
|
-
|
10415
10217
|
$ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase'
|
10416
10218
|
-
|
10417
|
-
required:
|
10418
|
-
- type
|
10419
10219
|
properties:
|
10420
10220
|
type:
|
10421
10221
|
description: |-
|
@@ -10430,18 +10230,27 @@ components:
|
|
10430
10230
|
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
|
10431
10231
|
* Initials Field uses `TemplateResponseDocumentFormFieldInitials`
|
10432
10232
|
type: string
|
10433
|
-
default:
|
10434
|
-
|
10435
|
-
|
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:
|
10436
10246
|
description: 'This class extends `TemplateResponseDocumentFormFieldBase`'
|
10247
|
+
required:
|
10248
|
+
- type
|
10437
10249
|
type: object
|
10438
10250
|
allOf:
|
10439
10251
|
-
|
10440
10252
|
$ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase'
|
10441
10253
|
-
|
10442
|
-
required:
|
10443
|
-
- type
|
10444
|
-
- group
|
10445
10254
|
properties:
|
10446
10255
|
type:
|
10447
10256
|
description: |-
|
@@ -10456,17 +10265,17 @@ components:
|
|
10456
10265
|
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
|
10457
10266
|
* Initials Field uses `TemplateResponseDocumentFormFieldInitials`
|
10458
10267
|
type: string
|
10459
|
-
default:
|
10460
|
-
|
10461
|
-
TemplateResponseDocumentFormFieldSignature:
|
10268
|
+
default: initials
|
10269
|
+
TemplateResponseDocumentFormFieldRadio:
|
10462
10270
|
description: 'This class extends `TemplateResponseDocumentFormFieldBase`'
|
10271
|
+
required:
|
10272
|
+
- type
|
10273
|
+
- group
|
10463
10274
|
type: object
|
10464
10275
|
allOf:
|
10465
10276
|
-
|
10466
10277
|
$ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase'
|
10467
10278
|
-
|
10468
|
-
required:
|
10469
|
-
- type
|
10470
10279
|
properties:
|
10471
10280
|
type:
|
10472
10281
|
description: |-
|
@@ -10481,17 +10290,16 @@ components:
|
|
10481
10290
|
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
|
10482
10291
|
* Initials Field uses `TemplateResponseDocumentFormFieldInitials`
|
10483
10292
|
type: string
|
10484
|
-
default:
|
10485
|
-
|
10486
|
-
TemplateResponseDocumentFormFieldDateSigned:
|
10293
|
+
default: radio
|
10294
|
+
TemplateResponseDocumentFormFieldSignature:
|
10487
10295
|
description: 'This class extends `TemplateResponseDocumentFormFieldBase`'
|
10296
|
+
required:
|
10297
|
+
- type
|
10488
10298
|
type: object
|
10489
10299
|
allOf:
|
10490
10300
|
-
|
10491
10301
|
$ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase'
|
10492
10302
|
-
|
10493
|
-
required:
|
10494
|
-
- type
|
10495
10303
|
properties:
|
10496
10304
|
type:
|
10497
10305
|
description: |-
|
@@ -10506,17 +10314,16 @@ components:
|
|
10506
10314
|
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
|
10507
10315
|
* Initials Field uses `TemplateResponseDocumentFormFieldInitials`
|
10508
10316
|
type: string
|
10509
|
-
default:
|
10510
|
-
|
10511
|
-
TemplateResponseDocumentFormFieldInitials:
|
10317
|
+
default: signature
|
10318
|
+
TemplateResponseDocumentFormFieldText:
|
10512
10319
|
description: 'This class extends `TemplateResponseDocumentFormFieldBase`'
|
10320
|
+
required:
|
10321
|
+
- type
|
10513
10322
|
type: object
|
10514
10323
|
allOf:
|
10515
10324
|
-
|
10516
10325
|
$ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase'
|
10517
10326
|
-
|
10518
|
-
required:
|
10519
|
-
- type
|
10520
10327
|
properties:
|
10521
10328
|
type:
|
10522
10329
|
description: |-
|
@@ -10531,8 +10338,33 @@ components:
|
|
10531
10338
|
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
|
10532
10339
|
* Initials Field uses `TemplateResponseDocumentFormFieldInitials`
|
10533
10340
|
type: string
|
10534
|
-
default:
|
10535
|
-
|
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
|
10536
10368
|
TemplateResponseDocumentStaticFieldBase:
|
10537
10369
|
description: 'An array describing static overlay fields. **Note** only available for certain subscriptions.'
|
10538
10370
|
required:
|
@@ -10583,15 +10415,15 @@ components:
|
|
10583
10415
|
initials: '#/components/schemas/TemplateResponseDocumentStaticFieldInitials'
|
10584
10416
|
x-internal: true
|
10585
10417
|
x-base-class: true
|
10586
|
-
|
10418
|
+
TemplateResponseDocumentStaticFieldCheckbox:
|
10587
10419
|
description: 'This class extends `TemplateResponseDocumentStaticFieldBase`'
|
10420
|
+
required:
|
10421
|
+
- type
|
10588
10422
|
type: object
|
10589
10423
|
allOf:
|
10590
10424
|
-
|
10591
10425
|
$ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase'
|
10592
10426
|
-
|
10593
|
-
required:
|
10594
|
-
- type
|
10595
10427
|
properties:
|
10596
10428
|
type:
|
10597
10429
|
description: |-
|
@@ -10606,17 +10438,16 @@ components:
|
|
10606
10438
|
* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
|
10607
10439
|
* Initials Field uses `TemplateResponseDocumentStaticFieldInitials`
|
10608
10440
|
type: string
|
10609
|
-
default:
|
10610
|
-
|
10611
|
-
TemplateResponseDocumentStaticFieldDropdown:
|
10441
|
+
default: checkbox
|
10442
|
+
TemplateResponseDocumentStaticFieldDateSigned:
|
10612
10443
|
description: 'This class extends `TemplateResponseDocumentStaticFieldBase`'
|
10444
|
+
required:
|
10445
|
+
- type
|
10613
10446
|
type: object
|
10614
10447
|
allOf:
|
10615
10448
|
-
|
10616
10449
|
$ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase'
|
10617
10450
|
-
|
10618
|
-
required:
|
10619
|
-
- type
|
10620
10451
|
properties:
|
10621
10452
|
type:
|
10622
10453
|
description: |-
|
@@ -10631,17 +10462,16 @@ components:
|
|
10631
10462
|
* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
|
10632
10463
|
* Initials Field uses `TemplateResponseDocumentStaticFieldInitials`
|
10633
10464
|
type: string
|
10634
|
-
default:
|
10635
|
-
|
10636
|
-
TemplateResponseDocumentStaticFieldHyperlink:
|
10465
|
+
default: date_signed
|
10466
|
+
TemplateResponseDocumentStaticFieldDropdown:
|
10637
10467
|
description: 'This class extends `TemplateResponseDocumentStaticFieldBase`'
|
10468
|
+
required:
|
10469
|
+
- type
|
10638
10470
|
type: object
|
10639
10471
|
allOf:
|
10640
10472
|
-
|
10641
10473
|
$ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase'
|
10642
10474
|
-
|
10643
|
-
required:
|
10644
|
-
- type
|
10645
10475
|
properties:
|
10646
10476
|
type:
|
10647
10477
|
description: |-
|
@@ -10656,17 +10486,16 @@ components:
|
|
10656
10486
|
* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
|
10657
10487
|
* Initials Field uses `TemplateResponseDocumentStaticFieldInitials`
|
10658
10488
|
type: string
|
10659
|
-
default:
|
10660
|
-
|
10661
|
-
TemplateResponseDocumentStaticFieldCheckbox:
|
10489
|
+
default: dropdown
|
10490
|
+
TemplateResponseDocumentStaticFieldHyperlink:
|
10662
10491
|
description: 'This class extends `TemplateResponseDocumentStaticFieldBase`'
|
10492
|
+
required:
|
10493
|
+
- type
|
10663
10494
|
type: object
|
10664
10495
|
allOf:
|
10665
10496
|
-
|
10666
10497
|
$ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase'
|
10667
10498
|
-
|
10668
|
-
required:
|
10669
|
-
- type
|
10670
10499
|
properties:
|
10671
10500
|
type:
|
10672
10501
|
description: |-
|
@@ -10681,17 +10510,16 @@ components:
|
|
10681
10510
|
* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
|
10682
10511
|
* Initials Field uses `TemplateResponseDocumentStaticFieldInitials`
|
10683
10512
|
type: string
|
10684
|
-
default:
|
10685
|
-
|
10686
|
-
TemplateResponseDocumentStaticFieldRadio:
|
10513
|
+
default: hyperlink
|
10514
|
+
TemplateResponseDocumentStaticFieldInitials:
|
10687
10515
|
description: 'This class extends `TemplateResponseDocumentStaticFieldBase`'
|
10516
|
+
required:
|
10517
|
+
- type
|
10688
10518
|
type: object
|
10689
10519
|
allOf:
|
10690
10520
|
-
|
10691
10521
|
$ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase'
|
10692
10522
|
-
|
10693
|
-
required:
|
10694
|
-
- type
|
10695
10523
|
properties:
|
10696
10524
|
type:
|
10697
10525
|
description: |-
|
@@ -10706,17 +10534,16 @@ components:
|
|
10706
10534
|
* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
|
10707
10535
|
* Initials Field uses `TemplateResponseDocumentStaticFieldInitials`
|
10708
10536
|
type: string
|
10709
|
-
default:
|
10710
|
-
|
10711
|
-
TemplateResponseDocumentStaticFieldSignature:
|
10537
|
+
default: initials
|
10538
|
+
TemplateResponseDocumentStaticFieldRadio:
|
10712
10539
|
description: 'This class extends `TemplateResponseDocumentStaticFieldBase`'
|
10540
|
+
required:
|
10541
|
+
- type
|
10713
10542
|
type: object
|
10714
10543
|
allOf:
|
10715
10544
|
-
|
10716
10545
|
$ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase'
|
10717
10546
|
-
|
10718
|
-
required:
|
10719
|
-
- type
|
10720
10547
|
properties:
|
10721
10548
|
type:
|
10722
10549
|
description: |-
|
@@ -10731,17 +10558,16 @@ components:
|
|
10731
10558
|
* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
|
10732
10559
|
* Initials Field uses `TemplateResponseDocumentStaticFieldInitials`
|
10733
10560
|
type: string
|
10734
|
-
default:
|
10735
|
-
|
10736
|
-
TemplateResponseDocumentStaticFieldDateSigned:
|
10561
|
+
default: radio
|
10562
|
+
TemplateResponseDocumentStaticFieldSignature:
|
10737
10563
|
description: 'This class extends `TemplateResponseDocumentStaticFieldBase`'
|
10564
|
+
required:
|
10565
|
+
- type
|
10738
10566
|
type: object
|
10739
10567
|
allOf:
|
10740
10568
|
-
|
10741
10569
|
$ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase'
|
10742
10570
|
-
|
10743
|
-
required:
|
10744
|
-
- type
|
10745
10571
|
properties:
|
10746
10572
|
type:
|
10747
10573
|
description: |-
|
@@ -10756,17 +10582,16 @@ components:
|
|
10756
10582
|
* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
|
10757
10583
|
* Initials Field uses `TemplateResponseDocumentStaticFieldInitials`
|
10758
10584
|
type: string
|
10759
|
-
default:
|
10760
|
-
|
10761
|
-
TemplateResponseDocumentStaticFieldInitials:
|
10585
|
+
default: signature
|
10586
|
+
TemplateResponseDocumentStaticFieldText:
|
10762
10587
|
description: 'This class extends `TemplateResponseDocumentStaticFieldBase`'
|
10588
|
+
required:
|
10589
|
+
- type
|
10763
10590
|
type: object
|
10764
10591
|
allOf:
|
10765
10592
|
-
|
10766
10593
|
$ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase'
|
10767
10594
|
-
|
10768
|
-
required:
|
10769
|
-
- type
|
10770
10595
|
properties:
|
10771
10596
|
type:
|
10772
10597
|
description: |-
|
@@ -10781,54 +10606,194 @@ components:
|
|
10781
10606
|
* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
|
10782
10607
|
* Initials Field uses `TemplateResponseDocumentStaticFieldInitials`
|
10783
10608
|
type: string
|
10784
|
-
default:
|
10785
|
-
type: object
|
10609
|
+
default: text
|
10786
10610
|
TemplateResponseFieldAvgTextLength:
|
10787
10611
|
description: 'Average text length in this field.'
|
10788
10612
|
properties:
|
10789
|
-
num_lines:
|
10790
|
-
description: 'Number of lines.'
|
10791
|
-
type: integer
|
10792
|
-
num_chars_per_line:
|
10793
|
-
description: 'Number of characters per line.'
|
10794
|
-
type: integer
|
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'
|
10795
10747
|
type: object
|
10796
10748
|
x-internal: true
|
10797
|
-
|
10749
|
+
TemplateCreateEmbeddedDraftResponse:
|
10798
10750
|
properties:
|
10799
|
-
|
10800
|
-
|
10801
|
-
|
10802
|
-
|
10803
|
-
|
10804
|
-
|
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'
|
10805
10758
|
type: object
|
10806
10759
|
x-internal: true
|
10807
|
-
|
10808
|
-
description: 'A group of documents that a user can take ownership of via the claim URL.'
|
10760
|
+
TemplateEditResponse:
|
10809
10761
|
properties:
|
10810
|
-
|
10811
|
-
description: 'The
|
10812
|
-
type: string
|
10813
|
-
nullable: true
|
10814
|
-
claim_url:
|
10815
|
-
description: 'The URL to be used to claim this UnclaimedDraft.'
|
10816
|
-
type: string
|
10817
|
-
signing_redirect_url:
|
10818
|
-
description: 'The URL you want signers redirected to after they successfully sign.'
|
10819
|
-
type: string
|
10820
|
-
nullable: true
|
10821
|
-
requesting_redirect_url:
|
10822
|
-
description: 'The URL you want signers redirected to after they successfully request a signature (Will only be returned in the response if it is applicable to the request.).'
|
10762
|
+
template_id:
|
10763
|
+
description: 'The id of the Template.'
|
10823
10764
|
type: string
|
10824
|
-
|
10825
|
-
|
10826
|
-
|
10827
|
-
|
10828
|
-
|
10829
|
-
|
10830
|
-
description: '
|
10831
|
-
type:
|
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'
|
10832
10797
|
type: object
|
10833
10798
|
x-internal: true
|
10834
10799
|
UnclaimedDraftCreateResponse:
|
@@ -10842,19 +10807,6 @@ components:
|
|
10842
10807
|
$ref: '#/components/schemas/WarningResponse'
|
10843
10808
|
type: object
|
10844
10809
|
x-internal: true
|
10845
|
-
WarningResponse:
|
10846
|
-
description: 'A list of warnings.'
|
10847
|
-
required:
|
10848
|
-
- warning_msg
|
10849
|
-
- warning_name
|
10850
|
-
properties:
|
10851
|
-
warning_msg:
|
10852
|
-
description: 'Warning message'
|
10853
|
-
type: string
|
10854
|
-
warning_name:
|
10855
|
-
description: 'Warning name'
|
10856
|
-
type: string
|
10857
|
-
type: object
|
10858
10810
|
responses:
|
10859
10811
|
EventCallbackResponse:
|
10860
10812
|
description: 'successful operation'
|
@@ -11036,10 +10988,6 @@ components:
|
|
11036
10988
|
summary: 'Default Example'
|
11037
10989
|
value:
|
11038
10990
|
$ref: examples/json/UnclaimedDraftEditAndResendRequestDefaultExample.json
|
11039
|
-
AccountGetResponseExample:
|
11040
|
-
summary: 'Account Get'
|
11041
|
-
value:
|
11042
|
-
$ref: examples/json/AccountGetResponseExample.json
|
11043
10991
|
AccountCreateResponseExample:
|
11044
10992
|
summary: 'Account Create'
|
11045
10993
|
value:
|
@@ -11048,10 +10996,10 @@ components:
|
|
11048
10996
|
summary: 'Account Create with OAuth Authorization'
|
11049
10997
|
value:
|
11050
10998
|
$ref: examples/json/AccountCreateOAuthResponseExample.json
|
11051
|
-
|
11052
|
-
summary: 'Account
|
10999
|
+
AccountGetResponseExample:
|
11000
|
+
summary: 'Account Get'
|
11053
11001
|
value:
|
11054
|
-
$ref: examples/json/
|
11002
|
+
$ref: examples/json/AccountGetResponseExample.json
|
11055
11003
|
AccountVerifyFoundResponseExample:
|
11056
11004
|
summary: 'Account Found'
|
11057
11005
|
value:
|
@@ -11060,10 +11008,6 @@ components:
|
|
11060
11008
|
summary: 'Account Not Found'
|
11061
11009
|
value:
|
11062
11010
|
$ref: examples/json/AccountVerifyNotFoundResponseExample.json
|
11063
|
-
ApiAppCreateResponseExample:
|
11064
|
-
summary: 'API App'
|
11065
|
-
value:
|
11066
|
-
$ref: examples/json/ApiAppCreateResponseExample.json
|
11067
11011
|
ApiAppGetResponseExample:
|
11068
11012
|
summary: 'API App'
|
11069
11013
|
value:
|
@@ -11072,10 +11016,6 @@ components:
|
|
11072
11016
|
summary: 'API App List'
|
11073
11017
|
value:
|
11074
11018
|
$ref: examples/json/ApiAppListResponseExample.json
|
11075
|
-
ApiAppUpdateResponseExample:
|
11076
|
-
summary: 'API App Update'
|
11077
|
-
value:
|
11078
|
-
$ref: examples/json/ApiAppUpdateResponseExample.json
|
11079
11019
|
BulkSendJobGetResponseExample:
|
11080
11020
|
summary: 'Bulk Send Job'
|
11081
11021
|
value:
|
@@ -11132,6 +11072,38 @@ components:
|
|
11132
11072
|
summary: 'Error 4XX failed_operation'
|
11133
11073
|
value:
|
11134
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
|
11135
11107
|
EventCallbackAccountSignatureRequestSentExample:
|
11136
11108
|
summary: 'Example: signature_request_sent'
|
11137
11109
|
value:
|
@@ -11152,18 +11124,6 @@ components:
|
|
11152
11124
|
summary: 'Example: template_created'
|
11153
11125
|
value:
|
11154
11126
|
$ref: examples/json/EventCallbackAppTemplateCreatedExample.json
|
11155
|
-
OAuthTokenGenerateResponseExample:
|
11156
|
-
summary: 'Retrieving the OAuth token'
|
11157
|
-
value:
|
11158
|
-
$ref: examples/json/OAuthTokenGenerateResponseExample.json
|
11159
|
-
OAuthTokenRefreshResponseExample:
|
11160
|
-
summary: 'Refresh an existing OAuth token'
|
11161
|
-
value:
|
11162
|
-
$ref: examples/json/OAuthTokenRefreshResponseExample.json
|
11163
|
-
ReportCreateResponseExample:
|
11164
|
-
summary: Report
|
11165
|
-
value:
|
11166
|
-
$ref: examples/json/ReportCreateResponseExample.json
|
11167
11127
|
SignatureRequestCreateEmbeddedResponseExample:
|
11168
11128
|
summary: 'Create Embedded Signature Request'
|
11169
11129
|
value:
|
@@ -11172,18 +11132,10 @@ components:
|
|
11172
11132
|
summary: 'Create Embedded Signature Request With Template'
|
11173
11133
|
value:
|
11174
11134
|
$ref: examples/json/SignatureRequestCreateEmbeddedWithTemplateResponseExample.json
|
11175
|
-
SignatureRequestGetResponseExample:
|
11176
|
-
summary: 'Get Signature Request'
|
11177
|
-
value:
|
11178
|
-
$ref: examples/json/SignatureRequestGetResponseExample.json
|
11179
11135
|
SignatureRequestFilesResponseExample:
|
11180
11136
|
summary: 'Signature Requests Files'
|
11181
11137
|
value:
|
11182
11138
|
$ref: examples/json/SignatureRequestFilesResponseExample.json
|
11183
|
-
SignatureRequestListResponseExample:
|
11184
|
-
summary: 'List Signature Requests'
|
11185
|
-
value:
|
11186
|
-
$ref: examples/json/SignatureRequestListResponseExample.json
|
11187
11139
|
SignatureRequestReleaseHoldResponseExample:
|
11188
11140
|
summary: 'Send Signature Release Hold'
|
11189
11141
|
value:
|
@@ -11212,34 +11164,14 @@ components:
|
|
11212
11164
|
summary: 'Bulk Send Create Embedded Signature Request With Template'
|
11213
11165
|
value:
|
11214
11166
|
$ref: examples/json/SignatureRequestBulkCreateEmbeddedWithTemplateResponseExample.json
|
11215
|
-
TeamAddMemberResponseExample:
|
11216
|
-
summary: 'Team Add Member'
|
11217
|
-
value:
|
11218
|
-
$ref: examples/json/TeamAddMemberResponseExample.json
|
11219
11167
|
TeamCreateResponseExample:
|
11220
11168
|
summary: 'Team Create'
|
11221
11169
|
value:
|
11222
11170
|
$ref: examples/json/TeamCreateResponseExample.json
|
11223
|
-
TeamGetResponseExample:
|
11224
|
-
summary: 'Team Get'
|
11225
|
-
value:
|
11226
|
-
$ref: examples/json/TeamGetResponseExample.json
|
11227
|
-
TeamGetInfoResponseExample:
|
11228
|
-
summary: 'Team Get Info'
|
11229
|
-
value:
|
11230
|
-
$ref: examples/json/TeamGetInfoResponseExample.json
|
11231
|
-
TeamInvitesResponseExample:
|
11232
|
-
summary: 'Team Invites'
|
11233
|
-
value:
|
11234
|
-
$ref: examples/json/TeamInvitesResponseExample.json
|
11235
11171
|
TeamMembersResponseExample:
|
11236
11172
|
summary: 'Team Members List'
|
11237
11173
|
value:
|
11238
11174
|
$ref: examples/json/TeamMembersResponseExample.json
|
11239
|
-
TeamSubTeamsResponseExample:
|
11240
|
-
summary: 'Team Sub Teams List'
|
11241
|
-
value:
|
11242
|
-
$ref: examples/json/TeamSubTeamsResponseExample.json
|
11243
11175
|
TeamRemoveMemberResponseExample:
|
11244
11176
|
summary: 'Team Remove Member'
|
11245
11177
|
value:
|
@@ -11256,34 +11188,14 @@ components:
|
|
11256
11188
|
summary: 'Add User to Template'
|
11257
11189
|
value:
|
11258
11190
|
$ref: examples/json/TemplateAddUserResponseExample.json
|
11259
|
-
TemplateCreateEmbeddedDraftResponseExample:
|
11260
|
-
summary: 'Create Embedded Draft Template'
|
11261
|
-
value:
|
11262
|
-
$ref: examples/json/TemplateCreateEmbeddedDraftResponseExample.json
|
11263
11191
|
TemplateFilesResponseExample:
|
11264
11192
|
summary: 'Template Files'
|
11265
11193
|
value:
|
11266
11194
|
$ref: examples/json/TemplateFilesResponseExample.json
|
11267
|
-
TemplateGetResponseExample:
|
11268
|
-
summary: 'Get Template'
|
11269
|
-
value:
|
11270
|
-
$ref: examples/json/TemplateGetResponseExample.json
|
11271
|
-
TemplateListResponseExample:
|
11272
|
-
summary: 'List Templates'
|
11273
|
-
value:
|
11274
|
-
$ref: examples/json/TemplateListResponseExample.json
|
11275
11195
|
TemplateRemoveUserResponseExample:
|
11276
11196
|
summary: 'Remove User from Template'
|
11277
11197
|
value:
|
11278
11198
|
$ref: examples/json/TemplateRemoveUserResponseExample.json
|
11279
|
-
TemplateUpdateFilesResponseExample:
|
11280
|
-
summary: 'Update Template Files'
|
11281
|
-
value:
|
11282
|
-
$ref: examples/json/TemplateUpdateFilesResponseExample.json
|
11283
|
-
UnclaimedDraftCreateResponseExample:
|
11284
|
-
summary: 'Unclaimed Draft Create'
|
11285
|
-
value:
|
11286
|
-
$ref: examples/json/UnclaimedDraftCreateResponseExample.json
|
11287
11199
|
UnclaimedDraftCreateEmbeddedResponseExample:
|
11288
11200
|
summary: 'Unclaimed Draft Create Embedded'
|
11289
11201
|
value:
|
@@ -11296,6 +11208,46 @@ components:
|
|
11296
11208
|
summary: 'Unclaimed Draft Edit and Resend'
|
11297
11209
|
value:
|
11298
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
|
11299
11251
|
requestBodies:
|
11300
11252
|
EventCallbackAccountRequest:
|
11301
11253
|
description: |-
|
@@ -11331,19 +11283,19 @@ components:
|
|
11331
11283
|
schema:
|
11332
11284
|
type: integer
|
11333
11285
|
format: int32
|
11334
|
-
|
11286
|
+
example: 100
|
11335
11287
|
X-RateLimit-Remaining:
|
11336
11288
|
description: 'The number of requests remaining in the current rate limit window.'
|
11337
11289
|
schema:
|
11338
11290
|
type: integer
|
11339
11291
|
format: int32
|
11340
|
-
|
11292
|
+
example: 99
|
11341
11293
|
X-Ratelimit-Reset:
|
11342
11294
|
description: 'The Unix time at which the rate limit will reset to its maximum.'
|
11343
11295
|
schema:
|
11344
11296
|
type: integer
|
11345
11297
|
format: int64
|
11346
|
-
|
11298
|
+
example: 1430170900
|
11347
11299
|
securitySchemes:
|
11348
11300
|
api_key:
|
11349
11301
|
type: http
|