@@ -250,23 +250,23 @@ if __name__ == "__main__":
250
250
* [ redistribute] ( docs/sdks/documents/README.md#redistribute ) - Redistribute document
251
251
* [ duplicate] ( docs/sdks/documents/README.md#duplicate ) - Duplicate document
252
252
253
- #### [ documents.fields] ( docs/sdks/fields /README.md )
253
+ #### [ documents.fields] ( docs/sdks/documentsfields /README.md )
254
254
255
- * [ get] ( docs/sdks/fields /README.md#get ) - Get document field
256
- * [ create] ( docs/sdks/fields /README.md#create ) - Create document field
257
- * [ create_many] ( docs/sdks/fields /README.md#create_many ) - Create document fields
258
- * [ update] ( docs/sdks/fields /README.md#update ) - Update document field
259
- * [ update_many] ( docs/sdks/fields /README.md#update_many ) - Update document fields
260
- * [ delete] ( docs/sdks/fields /README.md#delete ) - Delete document field
255
+ * [ get] ( docs/sdks/documentsfields /README.md#get ) - Get document field
256
+ * [ create] ( docs/sdks/documentsfields /README.md#create ) - Create document field
257
+ * [ create_many] ( docs/sdks/documentsfields /README.md#create_many ) - Create document fields
258
+ * [ update] ( docs/sdks/documentsfields /README.md#update ) - Update document field
259
+ * [ update_many] ( docs/sdks/documentsfields /README.md#update_many ) - Update document fields
260
+ * [ delete] ( docs/sdks/documentsfields /README.md#delete ) - Delete document field
261
261
262
- #### [ documents.recipients] ( docs/sdks/recipients /README.md )
262
+ #### [ documents.recipients] ( docs/sdks/documentsrecipients /README.md )
263
263
264
- * [ get] ( docs/sdks/recipients /README.md#get ) - Get document recipient
265
- * [ create] ( docs/sdks/recipients /README.md#create ) - Create document recipient
266
- * [ create_many] ( docs/sdks/recipients /README.md#create_many ) - Create document recipients
267
- * [ update] ( docs/sdks/recipients /README.md#update ) - Update document recipient
268
- * [ update_many] ( docs/sdks/recipients /README.md#update_many ) - Update document recipients
269
- * [ delete] ( docs/sdks/recipients /README.md#delete ) - Delete document recipient
264
+ * [ get] ( docs/sdks/documentsrecipients /README.md#get ) - Get document recipient
265
+ * [ create] ( docs/sdks/documentsrecipients /README.md#create ) - Create document recipient
266
+ * [ create_many] ( docs/sdks/documentsrecipients /README.md#create_many ) - Create document recipients
267
+ * [ update] ( docs/sdks/documentsrecipients /README.md#update ) - Update document recipient
268
+ * [ update_many] ( docs/sdks/documentsrecipients /README.md#update_many ) - Update document recipients
269
+ * [ delete] ( docs/sdks/documentsrecipients /README.md#delete ) - Delete document recipient
270
270
271
271
### [ templates] ( docs/sdks/templates/README.md )
272
272
@@ -278,29 +278,29 @@ if __name__ == "__main__":
278
278
* [ use] ( docs/sdks/templates/README.md#use ) - Use template
279
279
* [ move_to_team] ( docs/sdks/templates/README.md#move_to_team ) - Move template
280
280
281
- #### [ templates.direct_link] ( docs/sdks/directlink /README.md )
281
+ #### [ templates.direct_link] ( docs/sdks/directlinksdk /README.md )
282
282
283
- * [ create] ( docs/sdks/directlink /README.md#create ) - Create direct link
284
- * [ delete] ( docs/sdks/directlink /README.md#delete ) - Delete direct link
285
- * [ toggle] ( docs/sdks/directlink /README.md#toggle ) - Toggle direct link
283
+ * [ create] ( docs/sdks/directlinksdk /README.md#create ) - Create direct link
284
+ * [ delete] ( docs/sdks/directlinksdk /README.md#delete ) - Delete direct link
285
+ * [ toggle] ( docs/sdks/directlinksdk /README.md#toggle ) - Toggle direct link
286
286
287
- #### [ templates.fields] ( docs/sdks/documensofields /README.md )
287
+ #### [ templates.fields] ( docs/sdks/templatesfields /README.md )
288
288
289
- * [ create] ( docs/sdks/documensofields /README.md#create ) - Create template field
290
- * [ get] ( docs/sdks/documensofields /README.md#get ) - Get template field
291
- * [ create_many] ( docs/sdks/documensofields /README.md#create_many ) - Create template fields
292
- * [ update] ( docs/sdks/documensofields /README.md#update ) - Update template field
293
- * [ update_many] ( docs/sdks/documensofields /README.md#update_many ) - Update template fields
294
- * [ delete] ( docs/sdks/documensofields /README.md#delete ) - Delete template field
289
+ * [ create] ( docs/sdks/templatesfields /README.md#create ) - Create template field
290
+ * [ get] ( docs/sdks/templatesfields /README.md#get ) - Get template field
291
+ * [ create_many] ( docs/sdks/templatesfields /README.md#create_many ) - Create template fields
292
+ * [ update] ( docs/sdks/templatesfields /README.md#update ) - Update template field
293
+ * [ update_many] ( docs/sdks/templatesfields /README.md#update_many ) - Update template fields
294
+ * [ delete] ( docs/sdks/templatesfields /README.md#delete ) - Delete template field
295
295
296
- #### [ templates.recipients] ( docs/sdks/documensorecipients /README.md )
296
+ #### [ templates.recipients] ( docs/sdks/templatesrecipients /README.md )
297
297
298
- * [ get] ( docs/sdks/documensorecipients /README.md#get ) - Get template recipient
299
- * [ create] ( docs/sdks/documensorecipients /README.md#create ) - Create template recipient
300
- * [ create_many] ( docs/sdks/documensorecipients /README.md#create_many ) - Create template recipients
301
- * [ update] ( docs/sdks/documensorecipients /README.md#update ) - Update template recipient
302
- * [ update_many] ( docs/sdks/documensorecipients /README.md#update_many ) - Update template recipients
303
- * [ delete] ( docs/sdks/documensorecipients /README.md#delete ) - Delete template recipient
298
+ * [ get] ( docs/sdks/templatesrecipients /README.md#get ) - Get template recipient
299
+ * [ create] ( docs/sdks/templatesrecipients /README.md#create ) - Create template recipient
300
+ * [ create_many] ( docs/sdks/templatesrecipients /README.md#create_many ) - Create template recipients
301
+ * [ update] ( docs/sdks/templatesrecipients /README.md#update ) - Update template recipient
302
+ * [ update_many] ( docs/sdks/templatesrecipients /README.md#update_many ) - Update template recipients
303
+ * [ delete] ( docs/sdks/templatesrecipients /README.md#delete ) - Delete template recipient
304
304
305
305
</details >
306
306
<!-- End Available Resources and Operations [operations] -->
@@ -316,6 +316,7 @@ from documenso_sdk import Documenso
316
316
from documenso_sdk.utils import BackoffStrategy, RetryConfig
317
317
import os
318
318
319
+
319
320
with Documenso(
320
321
api_key = os.getenv(" DOCUMENSO_API_KEY" , " " ),
321
322
) as documenso:
@@ -334,6 +335,7 @@ from documenso_sdk import Documenso
334
335
from documenso_sdk.utils import BackoffStrategy, RetryConfig
335
336
import os
336
337
338
+
337
339
with Documenso(
338
340
retry_config = RetryConfig(" backoff" , BackoffStrategy(1 , 50 , 1.1 , 100 ), False ),
339
341
api_key = os.getenv(" DOCUMENSO_API_KEY" , " " ),
@@ -363,19 +365,20 @@ By default, an API error will raise a models.APIError exception, which has the f
363
365
364
366
When custom error responses are specified for an operation, the SDK may also raise their associated exceptions. You can refer to respective * Errors* tables in SDK docs for more details on possible exception types for each operation. For example, the ` find_async ` method may raise the following exceptions:
365
367
366
- | Error Type | Status Code | Content Type |
367
- | ------------------------------------------------------------ | ----------- | ---------------- |
368
- | models.DocumentFindDocumentsDocumentsResponseBody | 400 | application/json |
369
- | models.DocumentFindDocumentsDocumentsResponseResponseBody | 404 | application/json |
370
- | models.DocumentFindDocumentsDocumentsResponse500ResponseBody | 500 | application/json |
371
- | models.APIError | 4XX, 5XX | \* /\* |
368
+ | Error Type | Status Code | Content Type |
369
+ | ----------------------------------------------- | ----------- | ---------------- |
370
+ | models.DocumentFindDocumentsBadRequestError | 400 | application/json |
371
+ | models.DocumentFindDocumentsNotFoundError | 404 | application/json |
372
+ | models.DocumentFindDocumentsInternalServerError | 500 | application/json |
373
+ | models.APIError | 4XX, 5XX | \* /\* |
372
374
373
375
### Example
374
376
375
377
``` python
376
378
from documenso_sdk import Documenso, models
377
379
import os
378
380
381
+
379
382
with Documenso(
380
383
api_key = os.getenv(" DOCUMENSO_API_KEY" , " " ),
381
384
) as documenso:
@@ -387,14 +390,14 @@ with Documenso(
387
390
# Handle response
388
391
print (res)
389
392
390
- except models.DocumentFindDocumentsDocumentsResponseBody as e:
391
- # handle e.data: models.DocumentFindDocumentsDocumentsResponseBodyData
393
+ except models.DocumentFindDocumentsBadRequestError as e:
394
+ # handle e.data: models.DocumentFindDocumentsBadRequestErrorData
392
395
raise (e)
393
- except models.DocumentFindDocumentsDocumentsResponseResponseBody as e:
394
- # handle e.data: models.DocumentFindDocumentsDocumentsResponseResponseBodyData
396
+ except models.DocumentFindDocumentsNotFoundError as e:
397
+ # handle e.data: models.DocumentFindDocumentsNotFoundErrorData
395
398
raise (e)
396
- except models.DocumentFindDocumentsDocumentsResponse500ResponseBody as e:
397
- # handle e.data: models.DocumentFindDocumentsDocumentsResponse500ResponseBodyData
399
+ except models.DocumentFindDocumentsInternalServerError as e:
400
+ # handle e.data: models.DocumentFindDocumentsInternalServerErrorData
398
401
raise (e)
399
402
except models.APIError as e:
400
403
# handle exception
@@ -404,19 +407,25 @@ with Documenso(
404
407
405
408
<!-- Start Server Selection [server] -->
406
409
## Server Selection
410
+
407
411
### Override Server URL Per-Client
408
- The default server can also be overridden globally by passing a URL to the ` server_url: str ` optional parameter when initializing the SDK client instance. For example:
412
+
413
+ The default server can be overridden globally by passing a URL to the ` server_url: str ` optional parameter when initializing the SDK client instance. For example:
409
414
``` python
410
- import documenso_sdk
411
415
from documenso_sdk import Documenso
412
416
import os
417
+
418
+
413
419
with Documenso(
414
420
server_url = " https://app.documenso.com/api/v2-beta" ,
415
421
api_key = os.getenv(" DOCUMENSO_API_KEY" , " " ),
416
422
) as documenso:
417
- res = documenso.documents.find(order_by_direction = documenso_sdk.OrderByDirection.DESC )
423
+
424
+ res = documenso.documents.find()
425
+
418
426
# Handle response
419
427
print (res)
428
+
420
429
```
421
430
<!-- End Server Selection [server] -->
422
431
@@ -433,6 +442,7 @@ The `Documenso` class implements the context manager protocol and registers a fi
433
442
from documenso_sdk import Documenso
434
443
import os
435
444
def main ():
445
+
436
446
with Documenso(
437
447
api_key = os.getenv(" DOCUMENSO_API_KEY" , " " ),
438
448
) as documenso:
@@ -441,6 +451,7 @@ def main():
441
451
442
452
# Or when using async:
443
453
async def amain ():
454
+
444
455
async with Documenso(
445
456
api_key = os.getenv(" DOCUMENSO_API_KEY" , " " ),
446
457
) as documenso:
0 commit comments