Skip to content

Commit 2b07a52

Browse files
ddumenkoddumenko
authored
Add authorization section to README
1 parent 9150ed9 commit 2b07a52

File tree

8 files changed

+40
-27
lines changed

8 files changed

+40
-27
lines changed

‎README.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,19 @@ apiInstance.listTemplates({ deleted: false, tag: ["doe-inc-proposals"] }).then((
3838
}).catch((error) => console.error(error));
3939
```
4040

41+
## Authorization
42+
### apiKey
43+
- **Type**: API key
44+
- **API key parameter name**: Authorization
45+
- **Location**: HTTP header
46+
47+
### oauth2
48+
- **Type**: OAuth
49+
- **Flow**: accessCode
50+
- **Authorization URL**: https://app.pandadoc.com/oauth2/authorize
51+
- **Scopes**:
52+
- **read+write**: default
53+
4154
## Examples
4255
- [Create and send document from a template](examples/createDocumentFromPandadocTemplateAndSend.ts)
4356
- [Create and send document from the pdf url](examples/createDocumentFromPdfUrlAndSend.ts)

‎docs/APILogsApi.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ Name | Type | Description | Notes
5050

5151
### Authorization
5252

53-
[apiKey](README.md#apiKey), [oauth2](README.md#oauth2)
53+
[apiKey](../README.md#apikey), [oauth2](../README.md#oauth2)
5454

5555
### HTTP request headers
5656

@@ -135,7 +135,7 @@ Name | Type | Description | Notes
135135

136136
### Authorization
137137

138-
[apiKey](README.md#apiKey), [oauth2](README.md#oauth2)
138+
[apiKey](../README.md#apiKey), [oauth2](../README.md#oauth2)
139139

140140
### HTTP request headers
141141

‎docs/ContentLibraryItemsApi.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ Name | Type | Description | Notes
5050

5151
### Authorization
5252

53-
[apiKey](README.md#apiKey), [oauth2](README.md#oauth2)
53+
[apiKey](../README.md#apiKey), [oauth2](../README.md#oauth2)
5454

5555
### HTTP request headers
5656

@@ -129,7 +129,7 @@ Name | Type | Description | Notes
129129

130130
### Authorization
131131

132-
[apiKey](README.md#apiKey), [oauth2](README.md#oauth2)
132+
[apiKey](../README.md#apiKey), [oauth2](../README.md#oauth2)
133133

134134
### HTTP request headers
135135

‎docs/DocumentsApi.md‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ Name | Type | Description | Notes
5959

6060
### Authorization
6161

62-
[apiKey](README.md#apiKey), [oauth2](README.md#oauth2)
62+
[apiKey](../README.md#apiKey), [oauth2](../README.md#oauth2)
6363

6464
### HTTP request headers
6565

@@ -289,7 +289,7 @@ Name | Type | Description | Notes
289289

290290
### Authorization
291291

292-
[apiKey](README.md#apiKey), [oauth2](README.md#oauth2)
292+
[apiKey](../README.md#apiKey), [oauth2](../README.md#oauth2)
293293

294294
### HTTP request headers
295295

@@ -351,7 +351,7 @@ Name | Type | Description | Notes
351351

352352
### Authorization
353353

354-
[apiKey](README.md#apiKey), [oauth2](README.md#oauth2)
354+
[apiKey](../README.md#apiKey), [oauth2](../README.md#oauth2)
355355

356356
### HTTP request headers
357357

@@ -412,7 +412,7 @@ Name | Type | Description | Notes
412412

413413
### Authorization
414414

415-
[apiKey](README.md#apiKey), [oauth2](README.md#oauth2)
415+
[apiKey](../README.md#apiKey), [oauth2](../README.md#oauth2)
416416

417417
### HTTP request headers
418418

@@ -526,7 +526,7 @@ Name | Type | Description | Notes
526526

527527
### Authorization
528528

529-
[apiKey](README.md#apiKey), [oauth2](README.md#oauth2)
529+
[apiKey](../README.md#apiKey), [oauth2](../README.md#oauth2)
530530

531531
### HTTP request headers
532532

@@ -586,7 +586,7 @@ Name | Type | Description | Notes
586586

587587
### Authorization
588588

589-
[apiKey](README.md#apiKey), [oauth2](README.md#oauth2)
589+
[apiKey](../README.md#apiKey), [oauth2](../README.md#oauth2)
590590

591591
### HTTP request headers
592592

@@ -658,7 +658,7 @@ Name | Type | Description | Notes
658658

659659
### Authorization
660660

661-
[apiKey](README.md#apiKey), [oauth2](README.md#oauth2)
661+
[apiKey](../README.md#apiKey), [oauth2](../README.md#oauth2)
662662

663663
### HTTP request headers
664664

@@ -720,7 +720,7 @@ Name | Type | Description | Notes
720720

721721
### Authorization
722722

723-
[apiKey](README.md#apiKey), [oauth2](README.md#oauth2)
723+
[apiKey](../README.md#apiKey), [oauth2](../README.md#oauth2)
724724

725725
### HTTP request headers
726726

@@ -783,7 +783,7 @@ Name | Type | Description | Notes
783783

784784
### Authorization
785785

786-
[apiKey](README.md#apiKey), [oauth2](README.md#oauth2)
786+
[apiKey](../README.md#apiKey), [oauth2](../README.md#oauth2)
787787

788788
### HTTP request headers
789789

@@ -843,7 +843,7 @@ Name | Type | Description | Notes
843843

844844
### Authorization
845845

846-
[apiKey](README.md#apiKey), [oauth2](README.md#oauth2)
846+
[apiKey](../README.md#apiKey), [oauth2](../README.md#oauth2)
847847

848848
### HTTP request headers
849849

@@ -906,7 +906,7 @@ Name | Type | Description | Notes
906906

907907
### Authorization
908908

909-
[apiKey](README.md#apiKey), [oauth2](README.md#oauth2)
909+
[apiKey](../README.md#apiKey), [oauth2](../README.md#oauth2)
910910

911911
### HTTP request headers
912912

@@ -970,7 +970,7 @@ Name | Type | Description | Notes
970970

971971
### Authorization
972972

973-
[apiKey](README.md#apiKey), [oauth2](README.md#oauth2)
973+
[apiKey](../README.md#apiKey), [oauth2](../README.md#oauth2)
974974

975975
### HTTP request headers
976976

‎docs/FoldersAPIApi.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ Name | Type | Description | Notes
5757

5858
### Authorization
5959

60-
[apiKey](README.md#apiKey), [oauth2](README.md#oauth2)
60+
[apiKey](../README.md#apiKey), [oauth2](../README.md#oauth2)
6161

6262
### HTTP request headers
6363

@@ -120,7 +120,7 @@ Name | Type | Description | Notes
120120

121121
### Authorization
122122

123-
[apiKey](README.md#apiKey), [oauth2](README.md#oauth2)
123+
[apiKey](../README.md#apiKey), [oauth2](../README.md#oauth2)
124124

125125
### HTTP request headers
126126

@@ -186,7 +186,7 @@ Name | Type | Description | Notes
186186

187187
### Authorization
188188

189-
[apiKey](README.md#apiKey), [oauth2](README.md#oauth2)
189+
[apiKey](../README.md#apiKey), [oauth2](../README.md#oauth2)
190190

191191
### HTTP request headers
192192

@@ -252,7 +252,7 @@ Name | Type | Description | Notes
252252

253253
### Authorization
254254

255-
[apiKey](README.md#apiKey), [oauth2](README.md#oauth2)
255+
[apiKey](../README.md#apiKey), [oauth2](../README.md#oauth2)
256256

257257
### HTTP request headers
258258

@@ -317,7 +317,7 @@ Name | Type | Description | Notes
317317

318318
### Authorization
319319

320-
[apiKey](README.md#apiKey), [oauth2](README.md#oauth2)
320+
[apiKey](../README.md#apiKey), [oauth2](../README.md#oauth2)
321321

322322
### HTTP request headers
323323

@@ -383,7 +383,7 @@ Name | Type | Description | Notes
383383

384384
### Authorization
385385

386-
[apiKey](README.md#apiKey), [oauth2](README.md#oauth2)
386+
[apiKey](../README.md#apiKey), [oauth2](../README.md#oauth2)
387387

388388
### HTTP request headers
389389

‎docs/FormsApi.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ Name | Type | Description | Notes
6666

6767
### Authorization
6868

69-
[apiKey](README.md#apiKey), [oauth2](README.md#oauth2)
69+
[apiKey](../README.md#apiKey), [oauth2](../README.md#oauth2)
7070

7171
### HTTP request headers
7272

‎docs/OAuth20AuthenticationApi.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ Name | Type | Description | Notes
6363

6464
### Authorization
6565

66-
[apiKey](README.md#apiKey), [oauth2](README.md#oauth2)
66+
[apiKey](../README.md#apiKey), [oauth2](../README.md#oauth2)
6767

6868
### HTTP request headers
6969

‎docs/TemplatesApi.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ Name | Type | Description | Notes
5151

5252
### Authorization
5353

54-
[apiKey](README.md#apiKey), [oauth2](README.md#oauth2)
54+
[apiKey](../README.md#apiKey), [oauth2](../README.md#oauth2)
5555

5656
### HTTP request headers
5757

@@ -113,7 +113,7 @@ Name | Type | Description | Notes
113113

114114
### Authorization
115115

116-
[apiKey](README.md#apiKey), [oauth2](README.md#oauth2)
116+
[apiKey](../README.md#apiKey), [oauth2](../README.md#oauth2)
117117

118118
### HTTP request headers
119119

@@ -197,7 +197,7 @@ Name | Type | Description | Notes
197197

198198
### Authorization
199199

200-
[apiKey](README.md#apiKey), [oauth2](README.md#oauth2)
200+
[apiKey](../README.md#apiKey), [oauth2](../README.md#oauth2)
201201

202202
### HTTP request headers
203203

0 commit comments

Comments
 (0)