Skip to content

Commit 52c7b65

Browse files
ddumenkoddumenko
authored
Fix links in docs
1 parent a84f655 commit 52c7b65

13 files changed

+283
-311
lines changed

‎README.md‎

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -8,16 +8,14 @@ PandaDoc SDK spans a broad range of functionality to help you build incredible d
88
Node >= 12
99

1010
## Installation
11-
#### npm install
12-
If the package is hosted on a repository, you can install directly using:
11+
From package manager:
1312
```sh
14-
npm install git+https://github.com/PandaDoc/pandadoc-api-node-client.git
13+
npm install pandadoc-node-client
1514
```
16-
(you may need to run `npm` with root permission: `sudo npm install git+https://github.com/PandaDoc/pandadoc-api-node-client.git`)
1715

18-
Then import the package:
19-
```typescript
20-
import * as pd_client from "pandadoc-node-client";
16+
Or directly from the repository:
17+
```sh
18+
npm install git+https://github.com/PandaDoc/pandadoc-api-node-client.git
2119
```
2220

2321
## Getting Started
@@ -52,8 +50,8 @@ apiInstance.listTemplates({ deleted: false, tag: ["doe-inc-proposals"] }).then((
5250
- **read+write**: default
5351

5452
## Examples
55-
- [Create and send document from a template](examples/createDocumentFromPandadocTemplateAndSend.ts)
56-
- [Create and send document from the pdf url](examples/createDocumentFromPdfUrlAndSend.ts)
53+
- [Create and send document from a template](https://github.com/PandaDoc/pandadoc-api-node-client/blob/main/examples/createDocumentFromPandadocTemplateAndSend.ts)
54+
- [Create and send document from the pdf url](https://github.com/PandaDoc/pandadoc-api-node-client/blob/main/examples/createDocumentFromPdfUrlAndSend.ts)
5755

5856
### Documentation for API Endpoints
5957
All URIs are relative to *https://api.pandadoc.com*
@@ -106,4 +104,4 @@ Class | Method | HTTP request | Description
106104

107105

108106
## License
109-
SDK is licensed under the following [License](LICENSE).
107+
SDK is licensed under the [MIT License](https://github.com/PandaDoc/pandadoc-api-node-client/blob/main/LICENSE).

‎docs/APILogsApi.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ Name | Type | Description | Notes
6666
**404** | Not found | - |
6767
**429** | Too Many Requests | - |
6868

69-
[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md)
69+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
7070

7171
# **listApiLogs**
7272
> APILogListResponse listApiLogs()
@@ -147,5 +147,5 @@ Name | Type | Description | Notes
147147
**401** | Authentication error | - |
148148
**429** | Too Many Requests | - |
149149

150-
[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md)
150+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
151151

‎docs/ContactsApi.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ Name | Type | Description | Notes
7979
**401** | Authentication error | - |
8080
**429** | Too Many Requests | - |
8181

82-
[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md)
82+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
8383

8484
# **contactDelete**
8585
> void contactDelete()
@@ -139,7 +139,7 @@ Name | Type | Description | Notes
139139
**403** | Authentication error | - |
140140
**429** | Too Many Requests | - |
141141

142-
[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md)
142+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
143143

144144
# **contactDetails**
145145
> ContactDetailsResponse contactDetails()
@@ -199,7 +199,7 @@ Name | Type | Description | Notes
199199
**403** | Authentication error | - |
200200
**429** | Too Many Requests | - |
201201

202-
[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md)
202+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
203203

204204
# **contactList**
205205
> Array<ContactDetailsResponse> contactList()
@@ -253,7 +253,7 @@ This endpoint does not need any parameter.
253253
**403** | Authentication error | - |
254254
**429** | Too Many Requests | - |
255255

256-
[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md)
256+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
257257

258258
# **contactUpdate**
259259
> ContactDetailsResponse contactUpdate(contactUpdateRequest)
@@ -326,5 +326,5 @@ Name | Type | Description | Notes
326326
**401** | Authentication error | - |
327327
**429** | Too Many Requests | - |
328328

329-
[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md)
329+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
330330

‎docs/ContentLibraryItemsApi.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ Name | Type | Description | Notes
6767
**404** | Not found | - |
6868
**429** | Too Many Requests | - |
6969

70-
[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md)
70+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
7171

7272
# **listContentLibraryItems**
7373
> ContentLibraryItemListResponse listContentLibraryItems()
@@ -145,5 +145,5 @@ Name | Type | Description | Notes
145145
**401** | Authentication error | - |
146146
**429** | Too Many Requests | - |
147147

148-
[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md)
148+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
149149

‎docs/DocumentAttachmentsApi.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ Name | Type | Description | Notes
7979
**404** | Not found | - |
8080
**429** | Too Many Requests | - |
8181

82-
[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md)
82+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
8383

8484
# **documentAttachmentDelete**
8585
> void documentAttachmentDelete()
@@ -142,7 +142,7 @@ Name | Type | Description | Notes
142142
**404** | Not found | - |
143143
**429** | Too Many Requests | - |
144144

145-
[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md)
145+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
146146

147147
# **documentAttachmentDetails**
148148
> DocumentAttachmentResponse documentAttachmentDetails()
@@ -205,7 +205,7 @@ Name | Type | Description | Notes
205205
**404** | Not found | - |
206206
**429** | Too Many Requests | - |
207207

208-
[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md)
208+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
209209

210210
# **documentAttachmentDownload**
211211
> HttpFile documentAttachmentDownload()
@@ -268,7 +268,7 @@ Name | Type | Description | Notes
268268
**404** | Not found | - |
269269
**429** | Too Many Requests | - |
270270

271-
[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md)
271+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
272272

273273
# **documentAttachmentsList**
274274
> Array<DocumentAttachmentResponse> documentAttachmentsList()
@@ -328,5 +328,5 @@ Name | Type | Description | Notes
328328
**404** | Not found | - |
329329
**429** | Too Many Requests | - |
330330

331-
[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md)
331+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
332332

‎docs/DocumentsApi.md‎

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ Name | Type | Description | Notes
7676
**204** | No content | - |
7777
**404** | Not found | - |
7878

79-
[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md)
79+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
8080

8181
# **documentCreate**
8282
> DocumentCreateResponse documentCreate(documentCreateRequest)
@@ -310,7 +310,7 @@ Name | Type | Description | Notes
310310
**401** | Authentication error | - |
311311
**429** | Too Many Requests | - |
312312

313-
[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md)
313+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
314314

315315
# **documentCreateLink**
316316
> DocumentCreateLinkResponse documentCreateLink(documentCreateLinkRequest)
@@ -377,7 +377,7 @@ Name | Type | Description | Notes
377377
**404** | Not found | - |
378378
**429** | Too Many Requests | - |
379379

380-
[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md)
380+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
381381

382382
# **documentDetails**
383383
> DocumentDetailsResponse documentDetails()
@@ -437,7 +437,7 @@ Name | Type | Description | Notes
437437
**404** | Not found | - |
438438
**429** | Too Many Requests | - |
439439

440-
[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md)
440+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
441441

442442
# **documentList**
443443
> DocumentListResponse documentList()
@@ -557,7 +557,7 @@ Name | Type | Description | Notes
557557
**403** | Authentication error | - |
558558
**429** | Too Many Requests | - |
559559

560-
[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md)
560+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
561561

562562
# **documentStatus**
563563
> DocumentStatusResponse documentStatus()
@@ -617,7 +617,7 @@ Name | Type | Description | Notes
617617
**404** | Not found | - |
618618
**429** | Too Many Requests | - |
619619

620-
[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md)
620+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
621621

622622
# **documentStatusChange**
623623
> void documentStatusChange(documentStatusChangeRequest)
@@ -684,7 +684,7 @@ Name | Type | Description | Notes
684684
**404** | Not found | - |
685685
**429** | Too Many Requests | - |
686686

687-
[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md)
687+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
688688

689689
# **downloadDocument**
690690
> HttpFile downloadDocument()
@@ -757,7 +757,7 @@ Name | Type | Description | Notes
757757
**404** | Not found | - |
758758
**429** | Too Many Requests | - |
759759

760-
[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md)
760+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
761761

762762
# **downloadProtectedDocument**
763763
> HttpFile downloadProtectedDocument()
@@ -818,7 +818,7 @@ Name | Type | Description | Notes
818818
**404** | Not found | - |
819819
**429** | Too Many Requests | - |
820820

821-
[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md)
821+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
822822

823823
# **linkedObjectDelete**
824824
> void linkedObjectDelete()
@@ -881,7 +881,7 @@ Name | Type | Description | Notes
881881
**404** | Not found | - |
882882
**429** | Too Many Requests | - |
883883

884-
[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md)
884+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
885885

886886
# **linkedObjectList**
887887
> LinkedObjectListResponse linkedObjectList()
@@ -941,7 +941,7 @@ Name | Type | Description | Notes
941941
**404** | Not found | - |
942942
**429** | Too Many Requests | - |
943943

944-
[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md)
944+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
945945

946946
# **linkedObjectsCreate**
947947
> LinkedObjectCreateResponse linkedObjectsCreate(linkedObjectCreateRequest)
@@ -1009,7 +1009,7 @@ Name | Type | Description | Notes
10091009
**404** | Not found | - |
10101010
**429** | Too Many Requests | - |
10111011

1012-
[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md)
1012+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
10131013

10141014
# **sendDocument**
10151015
> DocumentSendResponse sendDocument(documentSendRequest)
@@ -1076,7 +1076,7 @@ Name | Type | Description | Notes
10761076
**404** | Not found | - |
10771077
**429** | Too Many Requests | - |
10781078

1079-
[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md)
1079+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
10801080

10811081
# **transferAllDocumentsOwnership**
10821082
> void transferAllDocumentsOwnership(documentTransferAllOwnershipRequest)
@@ -1139,7 +1139,7 @@ Name | Type | Description | Notes
11391139
**404** | Not found | - |
11401140
**429** | Too Many Requests | - |
11411141

1142-
[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md)
1142+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
11431143

11441144
# **transferDocumentOwnership**
11451145
> void transferDocumentOwnership(documentTransferOwnershipRequest)
@@ -1204,5 +1204,5 @@ Name | Type | Description | Notes
12041204
**404** | Not found | - |
12051205
**429** | Too Many Requests | - |
12061206

1207-
[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md)
1207+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12081208

‎docs/FoldersAPIApi.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ Name | Type | Description | Notes
7373
**401** | Authentication error | - |
7474
**429** | Too Many Requests | - |
7575

76-
[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md)
76+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
7777

7878
# **createTemplateFolder**
7979
> TemplatesFolderCreateResponse createTemplateFolder(templatesFolderCreateRequest)
@@ -136,7 +136,7 @@ Name | Type | Description | Notes
136136
**401** | Authentication error | - |
137137
**429** | Too Many Requests | - |
138138

139-
[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md)
139+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
140140

141141
# **listDocumentFolders**
142142
> DocumentsFolderListResponse listDocumentFolders()
@@ -202,7 +202,7 @@ Name | Type | Description | Notes
202202
**401** | Authentication error | - |
203203
**429** | Too Many Requests | - |
204204

205-
[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md)
205+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
206206

207207
# **listTemplateFolders**
208208
> TemplatesFolderListResponse listTemplateFolders()
@@ -268,7 +268,7 @@ Name | Type | Description | Notes
268268
**401** | Authentication error | - |
269269
**429** | Too Many Requests | - |
270270

271-
[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md)
271+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
272272

273273
# **renameDocumentFolder**
274274
> DocumentsFolderRenameResponse renameDocumentFolder(documentsFolderRenameRequest)
@@ -334,7 +334,7 @@ Name | Type | Description | Notes
334334
**404** | Not found | - |
335335
**429** | Too Many Requests | - |
336336

337-
[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md)
337+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
338338

339339
# **renameTemplateFolder**
340340
> TemplatesFolderRenameResponse renameTemplateFolder(templatesFolderRenameRequest)
@@ -400,5 +400,5 @@ Name | Type | Description | Notes
400400
**404** | Not found | - |
401401
**429** | Too Many Requests | - |
402402

403-
[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md)
403+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
404404

‎docs/FormsApi.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,5 +82,5 @@ Name | Type | Description | Notes
8282
**401** | Authentication error | - |
8383
**429** | Too Many Requests | - |
8484

85-
[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md)
85+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
8686

0 commit comments

Comments
 (0)