Skip to content

Commit 05ab144

Browse files
Add edit&resend to OpenAPI docs, and note that it uses quota
1 parent f2e8a6c commit 05ab144

File tree

5 files changed

+35
-32
lines changed

5 files changed

+35
-32
lines changed

bin/check-clean-git-status

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,6 @@ if [[ $(git status --porcelain) != '' ]]; then
77
printf "\t./run-build\n"
88

99
git status
10-
git diff
1110

1211
exit 1
1312
else

docs/SignatureRequestApi.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -613,7 +613,7 @@ Edit Signature Request
613613
614614
Edits and sends a SignatureRequest with the submitted documents. If `form_fields_per_document` is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents.
615615
616-
**NOTE:** Edit and resend will not deduct your signature request quota.
616+
**NOTE:** Edit and resend *will* deduct your signature request quota.
617617
618618
### Example
619619
@@ -738,6 +738,8 @@ Edit Embedded Signature Request
738738
739739
Edits a SignatureRequest with the submitted documents to be signed in an embedded iFrame. If form_fields_per_document is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign.
740740
741+
**NOTE:** Edit and resend *will* deduct your signature request quota.
742+
741743
### Example
742744
743745
* Basic Authentication (api_key):
@@ -849,6 +851,8 @@ Edit Embedded Signature Request with Template
849851
850852
Edits a SignatureRequest based on the given Template(s) to be signed in an embedded iFrame. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign.
851853
854+
**NOTE:** Edit and resend *will* deduct your signature request quota.
855+
852856
### Example
853857
854858
* Basic Authentication (api_key):
@@ -952,7 +956,7 @@ Edit Signature Request With Template
952956
953957
Edits and sends a SignatureRequest based off of the Template(s) specified with the template_ids parameter.
954958
955-
**NOTE:** Edit and resend will not deduct your signature request quota.
959+
**NOTE:** Edit and resend *will* deduct your signature request quota.
956960
957961
### Example
958962

dropbox_sign/api/signature_request_api.py

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1476,7 +1476,7 @@ def signature_request_edit(
14761476
) -> SignatureRequestGetResponse:
14771477
"""Edit Signature Request
14781478
1479-
Edits and sends a SignatureRequest with the submitted documents. If `form_fields_per_document` is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. **NOTE:** Edit and resend will not deduct your signature request quota.
1479+
Edits and sends a SignatureRequest with the submitted documents. If `form_fields_per_document` is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. **NOTE:** Edit and resend *will* deduct your signature request quota.
14801480
14811481
:param signature_request_id: The id of the SignatureRequest to edit. (required)
14821482
:type signature_request_id: str
@@ -1547,7 +1547,7 @@ def signature_request_edit_with_http_info(
15471547
) -> ApiResponse[SignatureRequestGetResponse]:
15481548
"""Edit Signature Request
15491549
1550-
Edits and sends a SignatureRequest with the submitted documents. If `form_fields_per_document` is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. **NOTE:** Edit and resend will not deduct your signature request quota.
1550+
Edits and sends a SignatureRequest with the submitted documents. If `form_fields_per_document` is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. **NOTE:** Edit and resend *will* deduct your signature request quota.
15511551
15521552
:param signature_request_id: The id of the SignatureRequest to edit. (required)
15531553
:type signature_request_id: str
@@ -1618,7 +1618,7 @@ def signature_request_edit_without_preload_content(
16181618
) -> RESTResponseType:
16191619
"""Edit Signature Request
16201620
1621-
Edits and sends a SignatureRequest with the submitted documents. If `form_fields_per_document` is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. **NOTE:** Edit and resend will not deduct your signature request quota.
1621+
Edits and sends a SignatureRequest with the submitted documents. If `form_fields_per_document` is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. **NOTE:** Edit and resend *will* deduct your signature request quota.
16221622
16231623
:param signature_request_id: The id of the SignatureRequest to edit. (required)
16241624
:type signature_request_id: str
@@ -1774,7 +1774,7 @@ def signature_request_edit_embedded(
17741774
) -> SignatureRequestGetResponse:
17751775
"""Edit Embedded Signature Request
17761776
1777-
Edits a SignatureRequest with the submitted documents to be signed in an embedded iFrame. If form_fields_per_document is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign.
1777+
Edits a SignatureRequest with the submitted documents to be signed in an embedded iFrame. If form_fields_per_document is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. **NOTE:** Edit and resend *will* deduct your signature request quota.
17781778
17791779
:param signature_request_id: The id of the SignatureRequest to edit. (required)
17801780
:type signature_request_id: str
@@ -1845,7 +1845,7 @@ def signature_request_edit_embedded_with_http_info(
18451845
) -> ApiResponse[SignatureRequestGetResponse]:
18461846
"""Edit Embedded Signature Request
18471847
1848-
Edits a SignatureRequest with the submitted documents to be signed in an embedded iFrame. If form_fields_per_document is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign.
1848+
Edits a SignatureRequest with the submitted documents to be signed in an embedded iFrame. If form_fields_per_document is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. **NOTE:** Edit and resend *will* deduct your signature request quota.
18491849
18501850
:param signature_request_id: The id of the SignatureRequest to edit. (required)
18511851
:type signature_request_id: str
@@ -1916,7 +1916,7 @@ def signature_request_edit_embedded_without_preload_content(
19161916
) -> RESTResponseType:
19171917
"""Edit Embedded Signature Request
19181918
1919-
Edits a SignatureRequest with the submitted documents to be signed in an embedded iFrame. If form_fields_per_document is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign.
1919+
Edits a SignatureRequest with the submitted documents to be signed in an embedded iFrame. If form_fields_per_document is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. **NOTE:** Edit and resend *will* deduct your signature request quota.
19201920
19211921
:param signature_request_id: The id of the SignatureRequest to edit. (required)
19221922
:type signature_request_id: str
@@ -2072,7 +2072,7 @@ def signature_request_edit_embedded_with_template(
20722072
) -> SignatureRequestGetResponse:
20732073
"""Edit Embedded Signature Request with Template
20742074
2075-
Edits a SignatureRequest based on the given Template(s) to be signed in an embedded iFrame. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign.
2075+
Edits a SignatureRequest based on the given Template(s) to be signed in an embedded iFrame. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. **NOTE:** Edit and resend *will* deduct your signature request quota.
20762076
20772077
:param signature_request_id: The id of the SignatureRequest to edit. (required)
20782078
:type signature_request_id: str
@@ -2143,7 +2143,7 @@ def signature_request_edit_embedded_with_template_with_http_info(
21432143
) -> ApiResponse[SignatureRequestGetResponse]:
21442144
"""Edit Embedded Signature Request with Template
21452145
2146-
Edits a SignatureRequest based on the given Template(s) to be signed in an embedded iFrame. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign.
2146+
Edits a SignatureRequest based on the given Template(s) to be signed in an embedded iFrame. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. **NOTE:** Edit and resend *will* deduct your signature request quota.
21472147
21482148
:param signature_request_id: The id of the SignatureRequest to edit. (required)
21492149
:type signature_request_id: str
@@ -2214,7 +2214,7 @@ def signature_request_edit_embedded_with_template_without_preload_content(
22142214
) -> RESTResponseType:
22152215
"""Edit Embedded Signature Request with Template
22162216
2217-
Edits a SignatureRequest based on the given Template(s) to be signed in an embedded iFrame. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign.
2217+
Edits a SignatureRequest based on the given Template(s) to be signed in an embedded iFrame. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. **NOTE:** Edit and resend *will* deduct your signature request quota.
22182218
22192219
:param signature_request_id: The id of the SignatureRequest to edit. (required)
22202220
:type signature_request_id: str
@@ -2373,7 +2373,7 @@ def signature_request_edit_with_template(
23732373
) -> SignatureRequestGetResponse:
23742374
"""Edit Signature Request With Template
23752375
2376-
Edits and sends a SignatureRequest based off of the Template(s) specified with the template_ids parameter. **NOTE:** Edit and resend will not deduct your signature request quota.
2376+
Edits and sends a SignatureRequest based off of the Template(s) specified with the template_ids parameter. **NOTE:** Edit and resend *will* deduct your signature request quota.
23772377
23782378
:param signature_request_id: The id of the SignatureRequest to edit. (required)
23792379
:type signature_request_id: str
@@ -2444,7 +2444,7 @@ def signature_request_edit_with_template_with_http_info(
24442444
) -> ApiResponse[SignatureRequestGetResponse]:
24452445
"""Edit Signature Request With Template
24462446
2447-
Edits and sends a SignatureRequest based off of the Template(s) specified with the template_ids parameter. **NOTE:** Edit and resend will not deduct your signature request quota.
2447+
Edits and sends a SignatureRequest based off of the Template(s) specified with the template_ids parameter. **NOTE:** Edit and resend *will* deduct your signature request quota.
24482448
24492449
:param signature_request_id: The id of the SignatureRequest to edit. (required)
24502450
:type signature_request_id: str
@@ -2515,7 +2515,7 @@ def signature_request_edit_with_template_without_preload_content(
25152515
) -> RESTResponseType:
25162516
"""Edit Signature Request With Template
25172517
2518-
Edits and sends a SignatureRequest based off of the Template(s) specified with the template_ids parameter. **NOTE:** Edit and resend will not deduct your signature request quota.
2518+
Edits and sends a SignatureRequest based off of the Template(s) specified with the template_ids parameter. **NOTE:** Edit and resend *will* deduct your signature request quota.
25192519
25202520
:param signature_request_id: The id of the SignatureRequest to edit. (required)
25212521
:type signature_request_id: str

dropbox_sign/configuration.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -546,7 +546,9 @@ def to_debug_report(self) -> str:
546546
"OS: {env}\n"
547547
"Python Version: {pyversion}\n"
548548
"Version of the API: 3.0.0\n"
549-
"SDK Package Version: 1.9.0".format(env=sys.platform, pyversion=sys.version)
549+
"SDK Package Version: 1.9.0".format(
550+
env=sys.platform, pyversion=sys.version
551+
)
550552
)
551553

552554
def get_host_settings(self) -> List[HostSetting]:

openapi-sdk.yaml

Lines changed: 14 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -3414,7 +3414,7 @@ paths:
34143414
description: |-
34153415
Edits and sends a SignatureRequest with the submitted documents. If `form_fields_per_document` is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents.
34163416

3417-
**NOTE:** Edit and resend will not deduct your signature request quota.
3417+
**NOTE:** Edit and resend *will* deduct your signature request quota.
34183418
operationId: signatureRequestEdit
34193419
parameters:
34203420
-
@@ -3455,7 +3455,7 @@ paths:
34553455
$ref: '#/components/schemas/SignatureRequestGetResponse'
34563456
examples:
34573457
example:
3458-
$ref: '#/components/examples/SignatureRequestEditResponse'
3458+
$ref: '#/components/examples/SignatureRequestSendResponse'
34593459
'4XX':
34603460
description: failed_operation
34613461
content:
@@ -3526,14 +3526,15 @@ paths:
35263526
seo:
35273527
title: 'Edit Signature Request | REST API | Dropbox Sign for Developers'
35283528
description: 'Dropbox Sign API allows you to build custom integrations. To find out how to edit a SignatureRequest with the submitted documents, click here.'
3529-
x-hideOn: doc
3530-
x-beta: closed
35313529
'/signature_request/edit_embedded/{signature_request_id}':
35323530
put:
35333531
tags:
35343532
- 'Signature Request'
35353533
summary: 'Edit Embedded Signature Request'
3536-
description: 'Edits a SignatureRequest with the submitted documents to be signed in an embedded iFrame. If form_fields_per_document is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign.'
3534+
description: |-
3535+
Edits a SignatureRequest with the submitted documents to be signed in an embedded iFrame. If form_fields_per_document is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign.
3536+
3537+
**NOTE:** Edit and resend *will* deduct your signature request quota.
35373538
operationId: signatureRequestEditEmbedded
35383539
parameters:
35393540
-
@@ -3574,7 +3575,7 @@ paths:
35743575
$ref: '#/components/schemas/SignatureRequestGetResponse'
35753576
examples:
35763577
example:
3577-
$ref: '#/components/examples/SignatureRequestEditEmbeddedResponse'
3578+
$ref: '#/components/examples/SignatureRequestCreateEmbeddedResponse'
35783579
'4XX':
35793580
description: failed_operation
35803581
content:
@@ -3644,14 +3645,15 @@ paths:
36443645
seo:
36453646
title: 'Edit Embedded Signature Request | Dropbox Sign for Developers'
36463647
description: 'The RESTful Dropbox Sign API easily allows you to build custom integrations. To find out how to edit a SignatureRequest in an iFrame, click here.'
3647-
x-hideOn: doc
3648-
x-beta: closed
36493648
'/signature_request/edit_embedded_with_template/{signature_request_id}':
36503649
put:
36513650
tags:
36523651
- 'Signature Request'
36533652
summary: 'Edit Embedded Signature Request with Template'
3654-
description: 'Edits a SignatureRequest based on the given Template(s) to be signed in an embedded iFrame. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign.'
3653+
description: |-
3654+
Edits a SignatureRequest based on the given Template(s) to be signed in an embedded iFrame. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign.
3655+
3656+
**NOTE:** Edit and resend *will* deduct your signature request quota.
36553657
operationId: signatureRequestEditEmbeddedWithTemplate
36563658
parameters:
36573659
-
@@ -3690,7 +3692,7 @@ paths:
36903692
$ref: '#/components/schemas/SignatureRequestGetResponse'
36913693
examples:
36923694
example:
3693-
$ref: '#/components/examples/SignatureRequestEditEmbeddedWithTemplateResponse'
3695+
$ref: '#/components/examples/SignatureRequestCreateEmbeddedWithTemplateResponse'
36943696
'4XX':
36953697
description: failed_operation
36963698
content:
@@ -3760,8 +3762,6 @@ paths:
37603762
seo:
37613763
title: 'Signature Request with Template | Dropbox Sign for Developers'
37623764
description: 'The Dropbox Sign API allows you to build custom integrations. To find out how to edit a SignatureRequest based on the given Template, click here.'
3763-
x-hideOn: doc
3764-
x-beta: closed
37653765
'/signature_request/edit_with_template/{signature_request_id}':
37663766
put:
37673767
tags:
@@ -3770,7 +3770,7 @@ paths:
37703770
description: |-
37713771
Edits and sends a SignatureRequest based off of the Template(s) specified with the template_ids parameter.
37723772

3773-
**NOTE:** Edit and resend will not deduct your signature request quota.
3773+
**NOTE:** Edit and resend *will* deduct your signature request quota.
37743774
operationId: signatureRequestEditWithTemplate
37753775
parameters:
37763776
-
@@ -3809,7 +3809,7 @@ paths:
38093809
$ref: '#/components/schemas/SignatureRequestGetResponse'
38103810
examples:
38113811
example:
3812-
$ref: '#/components/examples/SignatureRequestEditWithTemplateResponse'
3812+
$ref: '#/components/examples/SignatureRequestSendWithTemplateResponse'
38133813
'4XX':
38143814
description: failed_operation
38153815
content:
@@ -3880,8 +3880,6 @@ paths:
38803880
seo:
38813881
title: 'Edit Signature Request with Template | API Documentation | Dropbox Sign for Developers'
38823882
description: 'Dropbox Sign API allows you to build custom integrations. To find out how to edit a SignatureRequest based off of the Template, click here.'
3883-
x-hideOn: doc
3884-
x-beta: closed
38853883
'/signature_request/files/{signature_request_id}':
38863884
get:
38873885
tags:

0 commit comments

Comments
 (0)