Skip to content

Commit 6be7c83

Browse files
authored
v6.0.0 (#23)
Changes: - Variables in Title: - was changed as the optional field for 'create document from template' payload - was added as the optional parameter; Set this parameter as true if you want to detect title variables in the document name - was added as a query parameter for the 'contact list' endpoint - field was added for the 'update document' endpoint - field was added for the recipient object in the document details response - field was added for document, template, content library item details responses - field was added to the pricing object for document, template, content library item details responses - type of webhook event was added Breaking changes: - Renamed to in the request payload for the 'add document recipient' and 'reassign document recipient' endpoints - Removed PricingTablesResponse model and PricingTablesResponse*
1 parent a576d67 commit 6be7c83

66 files changed

Lines changed: 3749 additions & 135 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

docs/ContactsApi.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -313,18 +313,25 @@ configuration.api_key_prefix['apiKey'] = 'API-Key'
313313
with pandadoc_client.ApiClient(configuration) as api_client:
314314
# Create an instance of the API class
315315
api_instance = contacts_api.ContactsApi(api_client)
316+
email = "josh@example.com" # str | Optional search parameter. Filter results by exact match. (optional)
316317

317-
# example, this endpoint has no required or optional parameters
318+
# example passing only required values which don't have defaults set
319+
# and optional values
318320
try:
319321
# List contacts
320-
api_response = api_instance.list_contacts()
322+
api_response = api_instance.list_contacts(
323+
email=email,
324+
)
321325
pprint(api_response)
322326
except pandadoc_client.ApiException as e:
323327
print("Exception when calling ContactsApi->list_contacts: %s\n" % e)
324328
```
325329

326330
### Parameters
327-
This endpoint does not need any parameter.
331+
332+
Name | Type | Description | Notes
333+
------------- | ------------- | ------------- | -------------
334+
**email** | **str**| Optional search parameter. Filter results by exact match. | [optional]
328335

329336
### Return type
330337

docs/ContentLibraryItemResponse.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,12 @@ Name | Type | Description | Notes
88
**name** | **str** | | [optional]
99
**date_created** | **str** | | [optional]
1010
**date_modified** | **str** | | [optional]
11+
**content_date_modified** | **str** | | [optional]
1112
**created_by** | [**ContentLibraryItemResponseCreatedBy**](ContentLibraryItemResponseCreatedBy.md) | | [optional]
1213
**metadata** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** | | [optional]
1314
**tokens** | **[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** | | [optional]
1415
**fields** | **[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** | | [optional]
15-
**pricing** | [**PricingTablesResponse**](PricingTablesResponse.md) | | [optional]
16+
**pricing** | [**PricingResponse**](PricingResponse.md) | | [optional]
1617
**tags** | **[str]** | | [optional]
1718
**roles** | **[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** | | [optional]
1819
**version** | **str** | | [optional]

docs/DocumentCreateByTemplateRequest.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,10 @@
44
## Properties
55
Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
7-
**name** | **str** | Name the document you are creating. |
87
**template_uuid** | **str** | The ID of a template you want to use. You can copy it from an in app template url such as `https://app.pandadoc.com/a/#/templates/{ID}/content`. A template ID is also obtained by listing templates. |
98
**recipients** | [**[DocumentCreateByTemplateRequestRecipients]**](DocumentCreateByTemplateRequestRecipients.md) | The list of recipients you're sending the document to. Every object must contain the email parameter. The `role`, `first_name` and `last_name` parameters are optional. If the `role` parameter passed, a person is assigned all fields matching their corresponding role. If not passed, a person will receive a read-only link to view the document. If the `first_name` and `last_name` not passed the system 1. creates a new contact, if none exists with the given `email`; or 2. gets the existing contact with the given `email` that already exists. |
9+
**name** | **str** | Name the document you are creating. If name is not passed, the template name is used. | [optional]
10+
**detect_title_variables** | **bool** | Set this parameter as true if you want to detect title variables in the document. | [optional]
1011
**folder_uuid** | **str** | | [optional]
1112
**tokens** | [**[DocumentCreateByTemplateRequestTokens]**](DocumentCreateByTemplateRequestTokens.md) | You can pass a list of tokens/values to pre-fill tokens used in a template. Name is a token name in a template. Value is a real value you would like to replace a token with. | [optional]
1213
**fields** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** | You can pass a list of fields/values to pre-fill fields used in a template. Note that the Signature field can't be pre-filled. | [optional]

docs/DocumentCreateRequest.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
77
**name** | **str** | Name the document you are creating. | [optional]
8+
**detect_title_variables** | **bool** | Set this parameter as true if you want to detect title variables in the document. | [optional]
89
**template_uuid** | **str** | ID of the template you want to use. You can copy it from an in-app template URL such as `https://app.pandadoc.com/a/#/templates/{ID}/content`. A template ID is also obtained by listing templates. | [optional]
910
**folder_uuid** | **str** | ID of the folder where the created document should be stored. | [optional]
1011
**owner** | **{str: (str,)}** | You can set an owner of a document as an `email` or `membership_id` | [optional]

docs/DocumentDetailsResponse.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,14 @@ Name | Type | Description | Notes
1010
**date_created** | **str** | | [optional]
1111
**date_modified** | **str** | | [optional]
1212
**date_completed** | **str, none_type** | | [optional]
13+
**content_date_modified** | **str** | | [optional]
1314
**created_by** | [**DocumentDetailsResponseCreatedBy**](DocumentDetailsResponseCreatedBy.md) | | [optional]
1415
**template** | [**DocumentDetailsResponseTemplate**](DocumentDetailsResponseTemplate.md) | | [optional]
1516
**expiration_date** | **bool, date, datetime, dict, float, int, list, str, none_type** | | [optional]
1617
**metadata** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** | | [optional]
1718
**tokens** | **[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** | | [optional]
1819
**fields** | **[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** | | [optional]
19-
**pricing** | [**PricingTablesResponse**](PricingTablesResponse.md) | | [optional]
20+
**pricing** | [**PricingResponse**](PricingResponse.md) | | [optional]
2021
**version** | **str** | | [optional]
2122
**tags** | **[str]** | | [optional]
2223
**sent_by** | **bool, date, datetime, dict, float, int, list, str, none_type** | | [optional]

docs/DocumentDetailsResponseRecipients.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ Name | Type | Description | Notes
1515
**email** | **str** | | [optional]
1616
**has_completed** | **bool** | | [optional]
1717
**shared_link** | **str** | | [optional]
18+
**signature_date** | **str, none_type** | | [optional]
1819
**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
1920

2021
[[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
# InlineResponse200
1+
# DocumentRecipientResponse
22

33

44
## Properties
55
Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
7-
**actor_id** | **str** | | [optional]
7+
**recipient_id** | **str** | | [optional]
88
**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
99

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

docs/DocumentRecipientsApi.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Method | HTTP request | Description
1111

1212

1313
# **add_document_recipient**
14-
> InlineResponse200 add_document_recipient(id, document_recipient_create_request)
14+
> DocumentRecipientResponse add_document_recipient(id, document_recipient_create_request)
1515
1616
Add Document Recipient
1717

@@ -26,7 +26,7 @@ Adds recipient as CC to document
2626
import pandadoc_client
2727
from pandadoc_client.api import document_recipients_api
2828
from pandadoc_client.model.document_recipient_create_request import DocumentRecipientCreateRequest
29-
from pandadoc_client.model.inline_response200 import InlineResponse200
29+
from pandadoc_client.model.document_recipient_response import DocumentRecipientResponse
3030
from pprint import pprint
3131

3232
# Defining the host is optional and defaults to https://api.pandadoc.com
@@ -78,7 +78,7 @@ Name | Type | Description | Notes
7878

7979
### Return type
8080

81-
[**InlineResponse200**](InlineResponse200.md)
81+
[**DocumentRecipientResponse**](DocumentRecipientResponse.md)
8282

8383
### Authorization
8484

@@ -291,7 +291,7 @@ void (empty response body)
291291
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
292292

293293
# **reassign_document_recipient**
294-
> ERRORUNKNOWN reassign_document_recipient(id, recipient_id, document_recipient_create_request)
294+
> DocumentRecipientResponse reassign_document_recipient(id, recipient_id, document_recipient_create_request)
295295
296296
Reassign Document Recipient
297297

@@ -306,7 +306,7 @@ Replace document recipient with another contact
306306
import pandadoc_client
307307
from pandadoc_client.api import document_recipients_api
308308
from pandadoc_client.model.document_recipient_create_request import DocumentRecipientCreateRequest
309-
from pandadoc_client.model.errorunknown import ERRORUNKNOWN
309+
from pandadoc_client.model.document_recipient_response import DocumentRecipientResponse
310310
from pprint import pprint
311311

312312
# Defining the host is optional and defaults to https://api.pandadoc.com
@@ -360,7 +360,7 @@ Name | Type | Description | Notes
360360

361361
### Return type
362362

363-
[**ERRORUNKNOWN**](ERRORUNKNOWN.md)
363+
[**DocumentRecipientResponse**](DocumentRecipientResponse.md)
364364

365365
### Authorization
366366

docs/DocumentUpdateRequest.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
## Properties
55
Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
7+
**name** | **str** | The name of the document. | [optional]
78
**recipients** | [**[DocumentUpdateRequestRecipients]**](DocumentUpdateRequestRecipients.md) | The list of recipients you're sending the document to. The ID or email are required. If the ID is passed, an existing recipient will be updated. If the email is passed, a new recipient will be added to CC. | [optional]
89
**fields** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** | You may pass a list of fields/values which exist in a document. Please use `Merge Field` property of the fields like the key. | [optional]
910
**tokens** | [**[DocumentCreateByTemplateRequestTokens]**](DocumentCreateByTemplateRequestTokens.md) | You can pass a list of tokens/values. If a token name exists in a document then the value will be updated. Otherwise, a new token will be added to the document. | [optional]

docs/DocumentsApi.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -157,6 +157,7 @@ with pandadoc_client.ApiClient(configuration) as api_client:
157157
api_instance = documents_api.DocumentsApi(api_client)
158158
document_create_request = DocumentCreateRequest(
159159
name="API Sample Document from PandaDoc Template",
160+
detect_title_variables=True,
160161
template_uuid="hryJY9mqYZHjQCYQuSjRQg",
161162
folder_uuid="QMDSzwabfFzTgjW4kUijqQ",
162163
owner={
@@ -1692,6 +1693,7 @@ with pandadoc_client.ApiClient(configuration) as api_client:
16921693
api_instance = documents_api.DocumentsApi(api_client)
16931694
id = "BhVzRcxH9Z2LgfPPGXFUBa" # str | Document ID
16941695
document_update_request = DocumentUpdateRequest(
1696+
name="Contract",
16951697
recipients=[
16961698
DocumentUpdateRequestRecipients(
16971699
id="id_example",

0 commit comments

Comments
 (0)