Skip to content

Commit 1d9bced

Browse files
committed
- Add roles to document details response
- Add `EXTERNAL_REVIEW` document status
1 parent f1ffa41 commit 1d9bced

22 files changed

+345
-31
lines changed

docs/DocumentDetailsResponseRecipients.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
77
**recipient_type** | **str** | | [optional]
88
**role** | **str** | | [optional]
9+
**roles** | **[str]** | | [optional]
910
**last_name** | **str** | | [optional]
1011
**signing_order** | **bool, date, datetime, dict, float, int, list, str, none_type** | | [optional]
1112
**id** | **str** | | [optional]

docs/DocumentStatusEnum.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
## Properties
55
Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
7-
**value** | **str** | | must be one of ["document.draft", "document.sent", "document.completed", "document.uploaded", "document.error", "document.viewed", "document.waiting_approval", "document.approved", "document.rejected", "document.waiting_pay", "document.paid", "document.voided", "document.declined", ]
7+
**value** | **str** | | must be one of ["document.draft", "document.sent", "document.completed", "document.uploaded", "document.error", "document.viewed", "document.waiting_approval", "document.approved", "document.rejected", "document.waiting_pay", "document.paid", "document.voided", "document.declined", "document.external_review", ]
88

99
[[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
1010

docs/DocumentStatusRequestEnum.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
## Properties
55
Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
7-
**value** | **int** | | must be one of [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, ]
7+
**value** | **int** | | must be one of [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, ]
88

99
[[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
1010

docs/DocumentsApi.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -325,7 +325,7 @@ with pandadoc_client.ApiClient(configuration) as api_client:
325325
],
326326
url="https://s3.amazonaws.com/pd-static-content/public-docs/pandadoc-panda-bear.png",
327327
parse_form_fields=True,
328-
) # DocumentCreateRequest | Use a PandaDoc template or an existing PDF to create a document. See the creation request examples [by template](#/schemas/DocumentCreateByTemplateRequest) and [by pdf](#/schemas/DocumentCreateByPdfRequest)
328+
) # DocumentCreateRequest | Use a PandaDoc template or an existing PDF to create a document. See the creation request examples [by template](/schemas/DocumentCreateByTemplateRequest) and [by pdf](/schemas/DocumentCreateByPdfRequest)
329329
editor_ver = "ev2" # str | Set this parameter as `ev1` if you want to create a document from PDF with Classic Editor when both editors are enabled for the workspace. (optional)
330330

331331
# example passing only required values which don't have defaults set
@@ -353,7 +353,7 @@ with pandadoc_client.ApiClient(configuration) as api_client:
353353

354354
Name | Type | Description | Notes
355355
------------- | ------------- | ------------- | -------------
356-
**document_create_request** | [**DocumentCreateRequest**](DocumentCreateRequest.md)| Use a PandaDoc template or an existing PDF to create a document. See the creation request examples [by template](#/schemas/DocumentCreateByTemplateRequest) and [by pdf](#/schemas/DocumentCreateByPdfRequest) |
356+
**document_create_request** | [**DocumentCreateRequest**](DocumentCreateRequest.md)| Use a PandaDoc template or an existing PDF to create a document. See the creation request examples [by template](/schemas/DocumentCreateByTemplateRequest) and [by pdf](/schemas/DocumentCreateByPdfRequest) |
357357
**editor_ver** | **str**| Set this parameter as `ev1` if you want to create a document from PDF with Classic Editor when both editors are enabled for the workspace. | [optional]
358358

359359
### Return type
@@ -1067,8 +1067,8 @@ with pandadoc_client.ApiClient(configuration) as api_client:
10671067
order_by = DocumentOrderingFieldsEnum("name") # DocumentOrderingFieldsEnum | Specify the order of documents to return. Use `value` (for example, `date_created`) for ASC and `-value` (for example, `-date_created`) for DESC. (optional)
10681068
page = 1 # int | Specify which page of the dataset to return. (optional)
10691069
q = "Sample Document" # str | Search query. Filter by document reference number (this token is stored on the template level) or name. (optional)
1070-
status = DocumentStatusRequestEnum(12) # DocumentStatusRequestEnum | Specify the status of documents to return. * 0: document.draft * 1: document.sent * 2: document.completed * 3: document.uploaded * 4: document.error * 5: document.viewed * 6: document.waiting_approval * 7: document.approved * 8: document.rejected * 9: document.waiting_pay * 10: document.paid * 11: document.voided * 12: document.declined (optional)
1071-
status__ne = DocumentStatusRequestEnum(12) # DocumentStatusRequestEnum | Specify the status of documents to return (exclude). * 0: document.draft * 1: document.sent * 2: document.completed * 3: document.uploaded * 4: document.error * 5: document.viewed * 6: document.waiting_approval * 7: document.approved * 8: document.rejected * 9: document.waiting_pay * 10: document.paid * 11: document.voided * 12: document.declined (optional)
1070+
status = DocumentStatusRequestEnum(12) # DocumentStatusRequestEnum | Specify the status of documents to return. * 0: document.draft * 1: document.sent * 2: document.completed * 3: document.uploaded * 4: document.error * 5: document.viewed * 6: document.waiting_approval * 7: document.approved * 8: document.rejected * 9: document.waiting_pay * 10: document.paid * 11: document.voided * 12: document.declined * 13: document.external_review (optional)
1071+
status__ne = DocumentStatusRequestEnum(12) # DocumentStatusRequestEnum | Specify the status of documents to return (exclude). * 0: document.draft * 1: document.sent * 2: document.completed * 3: document.uploaded * 4: document.error * 5: document.viewed * 6: document.waiting_approval * 7: document.approved * 8: document.rejected * 9: document.waiting_pay * 10: document.paid * 11: document.voided * 12: document.declined * 13: document.external_review (optional)
10721072
tag = "tag_1" # str | Search tag. Filter by document tag. (optional)
10731073
template_id = "BhVzRcxH9Z2LgfPPGXFUBa" # str | Specify the template used for documents creation. Parameter can't be used with form_id. (optional)
10741074

@@ -1125,8 +1125,8 @@ Name | Type | Description | Notes
11251125
**order_by** | **DocumentOrderingFieldsEnum**| Specify the order of documents to return. Use `value` (for example, `date_created`) for ASC and `-value` (for example, `-date_created`) for DESC. | [optional]
11261126
**page** | **int**| Specify which page of the dataset to return. | [optional]
11271127
**q** | **str**| Search query. Filter by document reference number (this token is stored on the template level) or name. | [optional]
1128-
**status** | **DocumentStatusRequestEnum**| Specify the status of documents to return. * 0: document.draft * 1: document.sent * 2: document.completed * 3: document.uploaded * 4: document.error * 5: document.viewed * 6: document.waiting_approval * 7: document.approved * 8: document.rejected * 9: document.waiting_pay * 10: document.paid * 11: document.voided * 12: document.declined | [optional]
1129-
**status__ne** | **DocumentStatusRequestEnum**| Specify the status of documents to return (exclude). * 0: document.draft * 1: document.sent * 2: document.completed * 3: document.uploaded * 4: document.error * 5: document.viewed * 6: document.waiting_approval * 7: document.approved * 8: document.rejected * 9: document.waiting_pay * 10: document.paid * 11: document.voided * 12: document.declined | [optional]
1128+
**status** | **DocumentStatusRequestEnum**| Specify the status of documents to return. * 0: document.draft * 1: document.sent * 2: document.completed * 3: document.uploaded * 4: document.error * 5: document.viewed * 6: document.waiting_approval * 7: document.approved * 8: document.rejected * 9: document.waiting_pay * 10: document.paid * 11: document.voided * 12: document.declined * 13: document.external_review | [optional]
1129+
**status__ne** | **DocumentStatusRequestEnum**| Specify the status of documents to return (exclude). * 0: document.draft * 1: document.sent * 2: document.completed * 3: document.uploaded * 4: document.error * 5: document.viewed * 6: document.waiting_approval * 7: document.approved * 8: document.rejected * 9: document.waiting_pay * 10: document.paid * 11: document.voided * 12: document.declined * 13: document.external_review | [optional]
11301130
**tag** | **str**| Search tag. Filter by document tag. | [optional]
11311131
**template_id** | **str**| Specify the template used for documents creation. Parameter can't be used with form_id. | [optional]
11321132

pandadoc_client/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
"""
1010

1111

12-
__version__ = "4.2.0"
12+
__version__ = "4.3.0"
1313

1414
# import ApiClient
1515
from pandadoc_client.api_client import ApiClient

pandadoc_client/api/api_logs_api.py

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -242,6 +242,10 @@ def details_log(
242242
_check_return_type (bool): specifies if type checking
243243
should be done one the data received from the server.
244244
Default is True.
245+
_spec_property_naming (bool): True if the variable names in the input data
246+
are serialized names, as specified in the OpenAPI document.
247+
False if the variable names in the input data
248+
are pythonic names, e.g. snake case (default)
245249
_content_type (str/None): force body content-type.
246250
Default is None and content-type will be predicted by allowed
247251
content-types and body.
@@ -273,6 +277,9 @@ def details_log(
273277
kwargs['_check_return_type'] = kwargs.get(
274278
'_check_return_type', True
275279
)
280+
kwargs['_spec_property_naming'] = kwargs.get(
281+
'_spec_property_naming', False
282+
)
276283
kwargs['_content_type'] = kwargs.get(
277284
'_content_type')
278285
kwargs['_host_index'] = kwargs.get('_host_index')
@@ -318,6 +325,10 @@ def list_logs(
318325
_check_return_type (bool): specifies if type checking
319326
should be done one the data received from the server.
320327
Default is True.
328+
_spec_property_naming (bool): True if the variable names in the input data
329+
are serialized names, as specified in the OpenAPI document.
330+
False if the variable names in the input data
331+
are pythonic names, e.g. snake case (default)
321332
_content_type (str/None): force body content-type.
322333
Default is None and content-type will be predicted by allowed
323334
content-types and body.
@@ -349,6 +360,9 @@ def list_logs(
349360
kwargs['_check_return_type'] = kwargs.get(
350361
'_check_return_type', True
351362
)
363+
kwargs['_spec_property_naming'] = kwargs.get(
364+
'_spec_property_naming', False
365+
)
352366
kwargs['_content_type'] = kwargs.get(
353367
'_content_type')
354368
kwargs['_host_index'] = kwargs.get('_host_index')

pandadoc_client/api/contacts_api.py

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -331,6 +331,10 @@ def create_contact(
331331
_check_return_type (bool): specifies if type checking
332332
should be done one the data received from the server.
333333
Default is True.
334+
_spec_property_naming (bool): True if the variable names in the input data
335+
are serialized names, as specified in the OpenAPI document.
336+
False if the variable names in the input data
337+
are pythonic names, e.g. snake case (default)
334338
_content_type (str/None): force body content-type.
335339
Default is None and content-type will be predicted by allowed
336340
content-types and body.
@@ -362,6 +366,9 @@ def create_contact(
362366
kwargs['_check_return_type'] = kwargs.get(
363367
'_check_return_type', True
364368
)
369+
kwargs['_spec_property_naming'] = kwargs.get(
370+
'_spec_property_naming', False
371+
)
365372
kwargs['_content_type'] = kwargs.get(
366373
'_content_type')
367374
kwargs['_host_index'] = kwargs.get('_host_index')
@@ -401,6 +408,10 @@ def delete_contact(
401408
_check_return_type (bool): specifies if type checking
402409
should be done one the data received from the server.
403410
Default is True.
411+
_spec_property_naming (bool): True if the variable names in the input data
412+
are serialized names, as specified in the OpenAPI document.
413+
False if the variable names in the input data
414+
are pythonic names, e.g. snake case (default)
404415
_content_type (str/None): force body content-type.
405416
Default is None and content-type will be predicted by allowed
406417
content-types and body.
@@ -432,6 +443,9 @@ def delete_contact(
432443
kwargs['_check_return_type'] = kwargs.get(
433444
'_check_return_type', True
434445
)
446+
kwargs['_spec_property_naming'] = kwargs.get(
447+
'_spec_property_naming', False
448+
)
435449
kwargs['_content_type'] = kwargs.get(
436450
'_content_type')
437451
kwargs['_host_index'] = kwargs.get('_host_index')
@@ -471,6 +485,10 @@ def details_contact(
471485
_check_return_type (bool): specifies if type checking
472486
should be done one the data received from the server.
473487
Default is True.
488+
_spec_property_naming (bool): True if the variable names in the input data
489+
are serialized names, as specified in the OpenAPI document.
490+
False if the variable names in the input data
491+
are pythonic names, e.g. snake case (default)
474492
_content_type (str/None): force body content-type.
475493
Default is None and content-type will be predicted by allowed
476494
content-types and body.
@@ -502,6 +520,9 @@ def details_contact(
502520
kwargs['_check_return_type'] = kwargs.get(
503521
'_check_return_type', True
504522
)
523+
kwargs['_spec_property_naming'] = kwargs.get(
524+
'_spec_property_naming', False
525+
)
505526
kwargs['_content_type'] = kwargs.get(
506527
'_content_type')
507528
kwargs['_host_index'] = kwargs.get('_host_index')
@@ -538,6 +559,10 @@ def list_contacts(
538559
_check_return_type (bool): specifies if type checking
539560
should be done one the data received from the server.
540561
Default is True.
562+
_spec_property_naming (bool): True if the variable names in the input data
563+
are serialized names, as specified in the OpenAPI document.
564+
False if the variable names in the input data
565+
are pythonic names, e.g. snake case (default)
541566
_content_type (str/None): force body content-type.
542567
Default is None and content-type will be predicted by allowed
543568
content-types and body.
@@ -569,6 +594,9 @@ def list_contacts(
569594
kwargs['_check_return_type'] = kwargs.get(
570595
'_check_return_type', True
571596
)
597+
kwargs['_spec_property_naming'] = kwargs.get(
598+
'_spec_property_naming', False
599+
)
572600
kwargs['_content_type'] = kwargs.get(
573601
'_content_type')
574602
kwargs['_host_index'] = kwargs.get('_host_index')
@@ -608,6 +636,10 @@ def update_contact(
608636
_check_return_type (bool): specifies if type checking
609637
should be done one the data received from the server.
610638
Default is True.
639+
_spec_property_naming (bool): True if the variable names in the input data
640+
are serialized names, as specified in the OpenAPI document.
641+
False if the variable names in the input data
642+
are pythonic names, e.g. snake case (default)
611643
_content_type (str/None): force body content-type.
612644
Default is None and content-type will be predicted by allowed
613645
content-types and body.
@@ -639,6 +671,9 @@ def update_contact(
639671
kwargs['_check_return_type'] = kwargs.get(
640672
'_check_return_type', True
641673
)
674+
kwargs['_spec_property_naming'] = kwargs.get(
675+
'_spec_property_naming', False
676+
)
642677
kwargs['_content_type'] = kwargs.get(
643678
'_content_type')
644679
kwargs['_host_index'] = kwargs.get('_host_index')

pandadoc_client/api/content_library_items_api.py

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -211,6 +211,10 @@ def details_content_library_item(
211211
_check_return_type (bool): specifies if type checking
212212
should be done one the data received from the server.
213213
Default is True.
214+
_spec_property_naming (bool): True if the variable names in the input data
215+
are serialized names, as specified in the OpenAPI document.
216+
False if the variable names in the input data
217+
are pythonic names, e.g. snake case (default)
214218
_content_type (str/None): force body content-type.
215219
Default is None and content-type will be predicted by allowed
216220
content-types and body.
@@ -242,6 +246,9 @@ def details_content_library_item(
242246
kwargs['_check_return_type'] = kwargs.get(
243247
'_check_return_type', True
244248
)
249+
kwargs['_spec_property_naming'] = kwargs.get(
250+
'_spec_property_naming', False
251+
)
245252
kwargs['_content_type'] = kwargs.get(
246253
'_content_type')
247254
kwargs['_host_index'] = kwargs.get('_host_index')
@@ -286,6 +293,10 @@ def list_content_library_items(
286293
_check_return_type (bool): specifies if type checking
287294
should be done one the data received from the server.
288295
Default is True.
296+
_spec_property_naming (bool): True if the variable names in the input data
297+
are serialized names, as specified in the OpenAPI document.
298+
False if the variable names in the input data
299+
are pythonic names, e.g. snake case (default)
289300
_content_type (str/None): force body content-type.
290301
Default is None and content-type will be predicted by allowed
291302
content-types and body.
@@ -317,6 +328,9 @@ def list_content_library_items(
317328
kwargs['_check_return_type'] = kwargs.get(
318329
'_check_return_type', True
319330
)
331+
kwargs['_spec_property_naming'] = kwargs.get(
332+
'_spec_property_naming', False
333+
)
320334
kwargs['_content_type'] = kwargs.get(
321335
'_content_type')
322336
kwargs['_host_index'] = kwargs.get('_host_index')

0 commit comments

Comments
 (0)