Skip to content

Commit dcfc338

Browse files
evsazonovevsazonov
authored
Merge pull request #40 from PandaDoc/v6.2.0
v6.2.0
2 parents 5fab538 + c7740bf commit dcfc338

34 files changed

+1694
-27
lines changed

‎README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ Class | Method | HTTP request | Description
7474
*DocumentAttachmentsApi* | [**listDocumentAttachments**](docs/DocumentAttachmentsApi.md#listdocumentattachments) | **GET** /public/v1/documents/{id}/attachments | Document Attachment List
7575
*DocumentRecipientsApi* | [**addDocumentRecipient**](docs/DocumentRecipientsApi.md#adddocumentrecipient) | **POST** /public/v1/documents/{id}/recipients | Add Document Recipient
7676
*DocumentRecipientsApi* | [**deleteDocumentRecipient**](docs/DocumentRecipientsApi.md#deletedocumentrecipient) | **DELETE** /public/v1/documents/{id}/recipients/{recipient_id} | Delete Document Recipient
77-
*DocumentRecipientsApi* | [**editDocumentRecipient**](docs/DocumentRecipientsApi.md#editdocumentrecipient) | **PATCH** /public/v1/documents/{id}/recipients/{recipient_id} | Edit Document Recipient
77+
*DocumentRecipientsApi* | [**editDocumentRecipient**](docs/DocumentRecipientsApi.md#editdocumentrecipient) | **PATCH** /public/v1/documents/{id}/recipients/recipient/{recipient_id} | Edit Document Recipient
7878
*DocumentRecipientsApi* | [**reassignDocumentRecipient**](docs/DocumentRecipientsApi.md#reassigndocumentrecipient) | **POST** /public/v1/documents/{id}/recipients/{recipient_id}/reassign | Reassign Document Recipient
7979
*DocumentsApi* | [**changeDocumentStatus**](docs/DocumentsApi.md#changedocumentstatus) | **PATCH** /public/v1/documents/{id}/status | Document status change
8080
*DocumentsApi* | [**createDocument**](docs/DocumentsApi.md#createdocument) | **POST** /public/v1/documents | Create document
@@ -112,6 +112,9 @@ Class | Method | HTTP request | Description
112112
*TemplatesApi* | [**deleteTemplate**](docs/TemplatesApi.md#deletetemplate) | **DELETE** /public/v1/templates/{id} | Delete Template
113113
*TemplatesApi* | [**detailsTemplate**](docs/TemplatesApi.md#detailstemplate) | **GET** /public/v1/templates/{id}/details | Details Template
114114
*TemplatesApi* | [**listTemplates**](docs/TemplatesApi.md#listtemplates) | **GET** /public/v1/templates | List Templates
115+
*UserAndWorkspaceManagementApi* | [**addMember**](docs/UserAndWorkspaceManagementApi.md#addmember) | **POST** /public/v1/workspaces/{workspace_id}/members | Add member
116+
*UserAndWorkspaceManagementApi* | [**createUser**](docs/UserAndWorkspaceManagementApi.md#createuser) | **POST** /public/v1/users | Create User
117+
*UserAndWorkspaceManagementApi* | [**createWorkspace**](docs/UserAndWorkspaceManagementApi.md#createworkspace) | **POST** /public/v1/workspaces | Create Workspace
115118
*WebhookEventsApi* | [**detailsWebhookEvent**](docs/WebhookEventsApi.md#detailswebhookevent) | **GET** /public/v1/webhook-events/{id} | Get webhook event by uuid
116119
*WebhookEventsApi* | [**listWebhookEvent**](docs/WebhookEventsApi.md#listwebhookevent) | **GET** /public/v1/webhook-events | Get webhook event page
117120
*WebhookSubscriptionsApi* | [**createWebhookSubscription**](docs/WebhookSubscriptionsApi.md#createwebhooksubscription) | **POST** /public/v1/webhook-subscriptions | Create webhook subscription

‎docs/DocumentRecipientsApi.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Method | HTTP request | Description
66
------------- | ------------- | -------------
77
[**addDocumentRecipient**](DocumentRecipientsApi.md#addDocumentRecipient) | **POST** /public/v1/documents/{id}/recipients | Add Document Recipient
88
[**deleteDocumentRecipient**](DocumentRecipientsApi.md#deleteDocumentRecipient) | **DELETE** /public/v1/documents/{id}/recipients/{recipient_id} | Delete Document Recipient
9-
[**editDocumentRecipient**](DocumentRecipientsApi.md#editDocumentRecipient) | **PATCH** /public/v1/documents/{id}/recipients/{recipient_id} | Edit Document Recipient
9+
[**editDocumentRecipient**](DocumentRecipientsApi.md#editDocumentRecipient) | **PATCH** /public/v1/documents/{id}/recipients/recipient/{recipient_id} | Edit Document Recipient
1010
[**reassignDocumentRecipient**](DocumentRecipientsApi.md#reassignDocumentRecipient) | **POST** /public/v1/documents/{id}/recipients/{recipient_id}/reassign | Reassign Document Recipient
1111

1212

@@ -168,11 +168,15 @@ const body:pd_api.DocumentRecipientsApiEditDocumentRecipientRequest = {
168168
// DocumentRecipientEditRequest
169169
documentRecipientEditRequest: {
170170
email: "[email protected]",
171+
phone: "+14842634627",
172+
deliveryMethods: {
173+
email: true,
174+
sms: false,
175+
},
171176
firstName: "John",
172177
lastName: "Doe",
173178
company: "John Doe Inc.",
174179
jobTitle: "CTO",
175-
phone: "+14842634627",
176180
state: "Texas",
177181
streetAddress: "1313 Mockingbird Lane",
178182
city: "Austin",
@@ -186,6 +190,10 @@ const body:pd_api.DocumentRecipientsApiEditDocumentRecipientRequest = {
186190
phoneNumber: "+1234567890",
187191
},
188192
},
193+
redirect: {
194+
isEnabled: true,
195+
url: "https://example.com",
196+
},
189197
},
190198
};
191199

‎docs/DocumentsApi.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -121,10 +121,19 @@ const body:pd_api.DocumentsApiCreateDocumentRequest = {
121121
recipients: [
122122
{
123123
email: "[email protected]",
124+
phone: "+14842634627",
125+
deliveryMethods: {
126+
email: true,
127+
sms: false,
128+
},
124129
firstName: "Josh",
125130
lastName: "Ron",
126131
role: "user",
127132
signingOrder: 1,
133+
redirect: {
134+
isEnabled: true,
135+
url: "https://example.com",
136+
},
128137
},
129138
],
130139
tokens: [
@@ -202,10 +211,19 @@ const body:pd_api.DocumentsApiCreateDocumentRequest = {
202211
recipients: [
203212
{
204213
email: "[email protected]",
214+
phone: "+14842634627",
215+
deliveryMethods: {
216+
email: true,
217+
sms: false,
218+
},
205219
firstName: "Josh",
206220
lastName: "Ron",
207221
role: "user",
208222
signingOrder: 1,
223+
redirect: {
224+
isEnabled: true,
225+
url: "https://example.com",
226+
},
209227
},
210228
],
211229
},
@@ -1268,8 +1286,17 @@ const body:pd_api.DocumentsApiUpdateDocumentRequest = {
12681286
{
12691287
id: "id_example",
12701288
email: "[email protected]",
1289+
phone: "+14842634627",
12711290
firstName: "Josh",
12721291
lastName: "Ron",
1292+
deliveryMethods: {
1293+
email: true,
1294+
sms: false,
1295+
},
1296+
redirect: {
1297+
isEnabled: true,
1298+
url: "https://example.com",
1299+
},
12731300
},
12741301
],
12751302
fields: {},

‎docs/SectionsApi.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -225,10 +225,19 @@ const body:pd_api.SectionsApiUploadSectionRequest = {
225225
recipients: [
226226
{
227227
email: "[email protected]",
228+
phone: "+14842634627",
229+
deliveryMethods: {
230+
email: true,
231+
sms: false,
232+
},
228233
firstName: "Josh",
229234
lastName: "Ron",
230235
role: "user",
231236
signingOrder: 1,
237+
redirect: {
238+
isEnabled: true,
239+
url: "https://example.com",
240+
},
232241
},
233242
],
234243
tokens: [
@@ -299,10 +308,19 @@ const body:pd_api.SectionsApiUploadSectionRequest = {
299308
recipients: [
300309
{
301310
email: "[email protected]",
311+
phone: "+14842634627",
312+
deliveryMethods: {
313+
email: true,
314+
sms: false,
315+
},
302316
firstName: "Josh",
303317
lastName: "Ron",
304318
role: "user",
305319
signingOrder: 1,
320+
redirect: {
321+
isEnabled: true,
322+
url: "https://example.com",
323+
},
306324
},
307325
],
308326
},
@@ -312,6 +330,8 @@ const body:pd_api.SectionsApiUploadSectionRequest = {
312330
url: "https://s3.amazonaws.com/pd-static-content/public-docs/pandadoc-panda-bear.png",
313331
parseFormFields: true,
314332
},
333+
// 'document' | 'upload' | Determines how the fields are mapped when creating a section. * document: Default value. The fields of the entire document are updated. * upload: Only the fields from the created section are updated. The merge field is appended with the upload ID. (optional)
334+
mergeFieldScope: "document",
315335
};
316336

317337
apiInstance.uploadSection(body).then((data) => {
@@ -326,6 +346,7 @@ Name | Type | Description | Notes
326346
------------- | ------------- | ------------- | -------------
327347
**uploadSectionRequest** | **UploadSectionRequest**| Use a PandaDoc template or an existing PDF to upload a section. See the creation request examples [by template](/schemas/UploadSectionByTemplateRequest) and [by pdf](/schemas/UploadSectionByPdfRequest) |
328348
**documentId** | [**string**] | Document ID | defaults to undefined
349+
**mergeFieldScope** | [**&#39;document&#39; | &#39;upload&#39;**]**Array<&#39;document&#39; &#124; &#39;upload&#39;>** | Determines how the fields are mapped when creating a section. * document: Default value. The fields of the entire document are updated. * upload: Only the fields from the created section are updated. The merge field is appended with the upload ID. | (optional) defaults to undefined
329350

330351

331352
### Return type

‎docs/UserAndWorkspaceManagementApi.md

Lines changed: 227 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,227 @@
1+
# .UserAndWorkspaceManagementApi
2+
3+
All URIs are relative to *https://api.pandadoc.com*
4+
5+
Method | HTTP request | Description
6+
------------- | ------------- | -------------
7+
[**addMember**](UserAndWorkspaceManagementApi.md#addMember) | **POST** /public/v1/workspaces/{workspace_id}/members | Add member
8+
[**createUser**](UserAndWorkspaceManagementApi.md#createUser) | **POST** /public/v1/users | Create User
9+
[**createWorkspace**](UserAndWorkspaceManagementApi.md#createWorkspace) | **POST** /public/v1/workspaces | Create Workspace
10+
11+
12+
# **addMember**
13+
> AddMemberResponse addMember(addMemberRequest)
14+
15+
16+
### Example
17+
18+
19+
```typescript
20+
import * as pd_api from 'pandadoc-node-client';
21+
22+
// replace it with your API key
23+
const API_KEY = "YOUR_API_KEY";
24+
const configuration = pd_api.createConfiguration(
25+
{ authMethods: {apiKey: `API-Key ${API_KEY}`} }
26+
);
27+
const apiInstance = new pd_api.UserAndWorkspaceManagementApi(configuration);
28+
29+
const body:pd_api.UserAndWorkspaceManagementApiAddMemberRequest = {
30+
// string
31+
workspaceId: "BhVzRcxH9Z2LgfPPGXFUBa",
32+
// AddMemberRequest
33+
addMemberRequest: {
34+
userId: "2eWSKSvVqmuVCnuUK3iWwD",
35+
role: "Admin",
36+
},
37+
// boolean | Send a confirmation email to the user that was added to workspace(s). (optional)
38+
notifyUser: true,
39+
// boolean | Send a confirmation email to all workspace admins indicating that the user has been added to the workspace. (optional)
40+
notifyWsAdmins: true,
41+
};
42+
43+
apiInstance.addMember(body).then((data) => {
44+
console.log('API called successfully. Returned data: %o', data);
45+
}).catch((error) => console.error(error));
46+
```
47+
48+
49+
### Parameters
50+
51+
Name | Type | Description | Notes
52+
------------- | ------------- | ------------- | -------------
53+
**addMemberRequest** | **AddMemberRequest**| |
54+
**workspaceId** | [**string**] | | defaults to undefined
55+
**notifyUser** | [**boolean**] | Send a confirmation email to the user that was added to workspace(s). | (optional) defaults to undefined
56+
**notifyWsAdmins** | [**boolean**] | Send a confirmation email to all workspace admins indicating that the user has been added to the workspace. | (optional) defaults to undefined
57+
58+
59+
### Return type
60+
61+
**AddMemberResponse**
62+
63+
### Authorization
64+
65+
[apiKey](../README.md#apiKey), [oauth2](../README.md#oauth2)
66+
67+
### HTTP request headers
68+
69+
- **Content-Type**: application/json
70+
- **Accept**: application/json
71+
72+
73+
### HTTP response details
74+
| Status code | Description | Response headers |
75+
|-------------|-------------|------------------|
76+
**201** | OK | - |
77+
**400** | Bad Request | - |
78+
**401** | Authentication error | - |
79+
**403** | Permission error | - |
80+
**404** | Not found | - |
81+
**429** | Too Many Requests | - |
82+
83+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
84+
85+
# **createUser**
86+
> CreateUserResponse createUser(createUserRequest)
87+
88+
89+
### Example
90+
91+
92+
```typescript
93+
import * as pd_api from 'pandadoc-node-client';
94+
95+
// replace it with your API key
96+
const API_KEY = "YOUR_API_KEY";
97+
const configuration = pd_api.createConfiguration(
98+
{ authMethods: {apiKey: `API-Key ${API_KEY}`} }
99+
);
100+
const apiInstance = new pd_api.UserAndWorkspaceManagementApi(configuration);
101+
102+
const body:pd_api.UserAndWorkspaceManagementApiCreateUserRequest = {
103+
// CreateUserRequest
104+
createUserRequest: {
105+
user: {
106+
email: "[email protected]",
107+
firstName: "John",
108+
lastName: "Doe",
109+
phoneNumber: "+14842634627",
110+
},
111+
workspaces: [
112+
{
113+
workspaceId: "2eWSKSvVqmuVCnuUK3iWwD",
114+
role: "Admin",
115+
},
116+
],
117+
license: "Full",
118+
},
119+
// boolean | Send a confirmation email to the user that was added to workspace(s). (optional)
120+
notifyUser: true,
121+
// boolean | Send a confirmation email to all workspace admins indicating that the user has been added to the workspace. (optional)
122+
notifyWsAdmins: true,
123+
};
124+
125+
apiInstance.createUser(body).then((data) => {
126+
console.log('API called successfully. Returned data: %o', data);
127+
}).catch((error) => console.error(error));
128+
```
129+
130+
131+
### Parameters
132+
133+
Name | Type | Description | Notes
134+
------------- | ------------- | ------------- | -------------
135+
**createUserRequest** | **CreateUserRequest**| |
136+
**notifyUser** | [**boolean**] | Send a confirmation email to the user that was added to workspace(s). | (optional) defaults to undefined
137+
**notifyWsAdmins** | [**boolean**] | Send a confirmation email to all workspace admins indicating that the user has been added to the workspace. | (optional) defaults to undefined
138+
139+
140+
### Return type
141+
142+
**CreateUserResponse**
143+
144+
### Authorization
145+
146+
[apiKey](../README.md#apiKey), [oauth2](../README.md#oauth2)
147+
148+
### HTTP request headers
149+
150+
- **Content-Type**: application/json
151+
- **Accept**: application/json
152+
153+
154+
### HTTP response details
155+
| Status code | Description | Response headers |
156+
|-------------|-------------|------------------|
157+
**201** | OK | - |
158+
**400** | Bad Request | - |
159+
**401** | Authentication error | - |
160+
**403** | Permission error | - |
161+
**404** | Not found | - |
162+
**429** | Too Many Requests | - |
163+
164+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
165+
166+
# **createWorkspace**
167+
> CreateWorkspaceResponse createWorkspace(createWorkspaceRequest)
168+
169+
170+
### Example
171+
172+
173+
```typescript
174+
import * as pd_api from 'pandadoc-node-client';
175+
176+
// replace it with your API key
177+
const API_KEY = "YOUR_API_KEY";
178+
const configuration = pd_api.createConfiguration(
179+
{ authMethods: {apiKey: `API-Key ${API_KEY}`} }
180+
);
181+
const apiInstance = new pd_api.UserAndWorkspaceManagementApi(configuration);
182+
183+
const body:pd_api.UserAndWorkspaceManagementApiCreateWorkspaceRequest = {
184+
// CreateWorkspaceRequest
185+
createWorkspaceRequest: {
186+
name: "A new workspace",
187+
},
188+
};
189+
190+
apiInstance.createWorkspace(body).then((data) => {
191+
console.log('API called successfully. Returned data: %o', data);
192+
}).catch((error) => console.error(error));
193+
```
194+
195+
196+
### Parameters
197+
198+
Name | Type | Description | Notes
199+
------------- | ------------- | ------------- | -------------
200+
**createWorkspaceRequest** | **CreateWorkspaceRequest**| |
201+
202+
203+
### Return type
204+
205+
**CreateWorkspaceResponse**
206+
207+
### Authorization
208+
209+
[apiKey](../README.md#apiKey), [oauth2](../README.md#oauth2)
210+
211+
### HTTP request headers
212+
213+
- **Content-Type**: application/json
214+
- **Accept**: application/json
215+
216+
217+
### HTTP response details
218+
| Status code | Description | Response headers |
219+
|-------------|-------------|------------------|
220+
**201** | OK | - |
221+
**401** | Authentication error | - |
222+
**403** | Permission error | - |
223+
**404** | Not found | - |
224+
**429** | Too Many Requests | - |
225+
226+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
227+

0 commit comments

Comments
 (0)