Skip to content

Commit 0190abb

Browse files
bot-api-videobot-api-video
authored
Merge pull request #28 from apivideo/fix-documentation
Fix links in nodejs doc
2 parents 988e0cb + 5583fcd commit 0190abb

File tree

9 files changed

+20
-66
lines changed

9 files changed

+20
-66
lines changed

‎doc/api/AuthenticationApi.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,6 @@ Name | Type | Description | Notes
3838
**authenticatePayload** | [**AuthenticatePayload**](../model/AuthenticatePayload.md)| |
3939

4040
### Return type
41-
4241
[**AccessToken**](../model/AccessToken.md)
4342

4443
### HTTP request headers
@@ -82,7 +81,6 @@ Name | Type | Description | Notes
8281
**refreshTokenPayload** | [**RefreshTokenPayload**](../model/RefreshTokenPayload.md)| |
8382

8483
### Return type
85-
8684
[**AccessToken**](../model/AccessToken.md)
8785

8886
### HTTP request headers

‎doc/api/CaptionsApi.md

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,6 @@ Name | Type | Description | Notes
4141
**language** | **string**| A valid [BCP 47](https://github.com/libyal/libfwnt/wiki/Language-Code-identifiers) language representation. | [default to undefined]
4242

4343
### Return type
44-
4544
[**void**](../model/.md)
4645

4746
### HTTP request headers
@@ -69,7 +68,7 @@ Name | Type | Description | Notes
6968
const currentPage = '2'; // Choose the number of search results to return per page. Minimum value: 1
7069
const pageSize = '30'; // Results per page. Allowed values 1-100, default is 25.
7170

72-
// Page<Caption>
71+
// CaptionsListResponse
7372
const result = await client.captions.list({ videoId, currentPage, pageSize })
7473
console.log(result);
7574
} catch (e) {
@@ -87,8 +86,7 @@ Name | Type | Description | Notes
8786
**pageSize** | **number**| Results per page. Allowed values 1-100, default is 25. | [optional] [default to 25]
8887

8988
### Return type
90-
[**Page**](../model/pagination.md)<[**Caption**](../model/Caption.md)>
91-
89+
[**CaptionsListResponse**](../model/CaptionsListResponse.md)
9290

9391
### HTTP request headers
9492

@@ -131,7 +129,6 @@ Name | Type | Description | Notes
131129
**language** | **string**| A valid [BCP 47](https://github.com/libyal/libfwnt/wiki/Language-Code-identifiers) language representation | [default to undefined]
132130

133131
### Return type
134-
135132
[**Caption**](../model/Caption.md)
136133

137134
### HTTP request headers
@@ -179,7 +176,6 @@ Name | Type | Description | Notes
179176
**captionsUpdatePayload** | [**CaptionsUpdatePayload**](../model/CaptionsUpdatePayload.md)| |
180177

181178
### Return type
182-
183179
[**Caption**](../model/Caption.md)
184180

185181
### HTTP request headers
@@ -226,7 +222,6 @@ Name | Type | Description | Notes
226222
**file** | **string**| The video text track (VTT) you want to upload. | [default to undefined]
227223

228224
### Return type
229-
230225
[**Caption**](../model/Caption.md)
231226

232227
### HTTP request headers

‎doc/api/ChaptersApi.md

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,6 @@ Name | Type | Description | Notes
4040
**language** | **string**| A valid [BCP 47](https://github.com/libyal/libfwnt/wiki/Language-Code-identifiers) language representation. | [default to undefined]
4141

4242
### Return type
43-
4443
[**void**](../model/.md)
4544

4645
### HTTP request headers
@@ -68,7 +67,7 @@ Name | Type | Description | Notes
6867
const currentPage = '2'; // Choose the number of search results to return per page. Minimum value: 1
6968
const pageSize = '30'; // Results per page. Allowed values 1-100, default is 25.
7069

71-
// Page<Chapter>
70+
// ChaptersListResponse
7271
const result = await client.chapters.list({ videoId, currentPage, pageSize })
7372
console.log(result);
7473
} catch (e) {
@@ -86,8 +85,7 @@ Name | Type | Description | Notes
8685
**pageSize** | **number**| Results per page. Allowed values 1-100, default is 25. | [optional] [default to 25]
8786

8887
### Return type
89-
[**Page**](../model/pagination.md)<[**Chapter**](../model/Chapter.md)>
90-
88+
[**ChaptersListResponse**](../model/ChaptersListResponse.md)
9189

9290
### HTTP request headers
9391

@@ -130,7 +128,6 @@ Name | Type | Description | Notes
130128
**language** | **string**| A valid [BCP 47](https://github.com/libyal/libfwnt/wiki/Language-Code-identifiers) language representation. | [default to undefined]
131129

132130
### Return type
133-
134131
[**Chapter**](../model/Chapter.md)
135132

136133
### HTTP request headers
@@ -176,7 +173,6 @@ Name | Type | Description | Notes
176173
**file** | **string**| The VTT file describing the chapters you want to upload. | [default to undefined]
177174

178175
### Return type
179-
180176
[**Chapter**](../model/Chapter.md)
181177

182178
### HTTP request headers

‎doc/api/LiveStreamsApi.md

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,6 @@ Name | Type | Description | Notes
4141
**liveStreamId** | **string**| The unique ID for the live stream that you want to remove. | [default to undefined]
4242

4343
### Return type
44-
4544
[**void**](../model/.md)
4645

4746
### HTTP request headers
@@ -82,7 +81,6 @@ Name | Type | Description | Notes
8281
**liveStreamId** | **string**| The unique identifier for the live stream you want to delete. | [default to undefined]
8382

8483
### Return type
85-
8684
[**LiveStream**](../model/LiveStream.md)
8785

8886
### HTTP request headers
@@ -113,7 +111,7 @@ Name | Type | Description | Notes
113111
const currentPage = '2'; // Choose the number of search results to return per page. Minimum value: 1
114112
const pageSize = '30'; // Results per page. Allowed values 1-100, default is 25.
115113

116-
// Page<LiveStream>
114+
// LiveStreamListResponse
117115
const result = await client.liveStreams.list({ streamKey, name, sortBy, sortOrder, currentPage, pageSize })
118116
console.log(result);
119117
} catch (e) {
@@ -134,8 +132,7 @@ Name | Type | Description | Notes
134132
**pageSize** | **number**| Results per page. Allowed values 1-100, default is 25. | [optional] [default to 25]
135133

136134
### Return type
137-
[**Page**](../model/pagination.md)<[**LiveStream**](../model/LiveStream.md)>
138-
135+
[**LiveStreamListResponse**](../model/LiveStreamListResponse.md)
139136

140137
### HTTP request headers
141138

@@ -175,7 +172,6 @@ Name | Type | Description | Notes
175172
**liveStreamId** | **string**| The unique ID for the live stream you want to watch. | [default to undefined]
176173

177174
### Return type
178-
179175
[**LiveStream**](../model/LiveStream.md)
180176

181177
### HTTP request headers
@@ -223,7 +219,6 @@ Name | Type | Description | Notes
223219
**liveStreamUpdatePayload** | [**LiveStreamUpdatePayload**](../model/LiveStreamUpdatePayload.md)| |
224220

225221
### Return type
226-
227222
[**LiveStream**](../model/LiveStream.md)
228223

229224
### HTTP request headers
@@ -270,7 +265,6 @@ Name | Type | Description | Notes
270265
**liveStreamCreationPayload** | [**LiveStreamCreationPayload**](../model/LiveStreamCreationPayload.md)| |
271266

272267
### Return type
273-
274268
[**LiveStream**](../model/LiveStream.md)
275269

276270
### HTTP request headers
@@ -314,7 +308,6 @@ Name | Type | Description | Notes
314308
**file** | **string**| The image to be added as a thumbnail. | [default to undefined]
315309

316310
### Return type
317-
318311
[**LiveStream**](../model/LiveStream.md)
319312

320313
### HTTP request headers

‎doc/api/PlayerThemesApi.md

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,6 @@ Name | Type | Description | Notes
4141
**playerId** | **string**| The unique identifier for the player you want to delete. | [default to undefined]
4242

4343
### Return type
44-
4544
[**void**](../model/.md)
4645

4746
### HTTP request headers
@@ -83,7 +82,6 @@ Name | Type | Description | Notes
8382
**playerId** | **string**| The unique identifier for the player. | [default to undefined]
8483

8584
### Return type
86-
8785
[**void**](../model/.md)
8886

8987
### HTTP request headers
@@ -112,7 +110,7 @@ Name | Type | Description | Notes
112110
const currentPage = '2'; // Choose the number of search results to return per page. Minimum value: 1
113111
const pageSize = '30'; // Results per page. Allowed values 1-100, default is 25.
114112

115-
// Page<PlayerTheme>
113+
// PlayerThemesListResponse
116114
const result = await client.playerThemes.list({ sortBy, sortOrder, currentPage, pageSize })
117115
console.log(result);
118116
} catch (e) {
@@ -131,8 +129,7 @@ Name | Type | Description | Notes
131129
**pageSize** | **number**| Results per page. Allowed values 1-100, default is 25. | [optional] [default to 25]
132130

133131
### Return type
134-
[**Page**](../model/pagination.md)<[**PlayerTheme**](../model/PlayerTheme.md)>
135-
132+
[**PlayerThemesListResponse**](../model/PlayerThemesListResponse.md)
136133

137134
### HTTP request headers
138135

@@ -173,7 +170,6 @@ Name | Type | Description | Notes
173170
**playerId** | **string**| The unique identifier for the player you want to retrieve. | [default to undefined]
174171

175172
### Return type
176-
177173
[**PlayerTheme**](../model/PlayerTheme.md)
178174

179175
### HTTP request headers
@@ -232,7 +228,6 @@ Name | Type | Description | Notes
232228
**playerThemeUpdatePayload** | [**PlayerThemeUpdatePayload**](../model/PlayerThemeUpdatePayload.md)| |
233229

234230
### Return type
235-
236231
[**PlayerTheme**](../model/PlayerTheme.md)
237232

238233
### HTTP request headers
@@ -289,7 +284,6 @@ Name | Type | Description | Notes
289284
**playerThemeCreationPayload** | [**PlayerThemeCreationPayload**](../model/PlayerThemeCreationPayload.md)| |
290285

291286
### Return type
292-
293287
[**PlayerTheme**](../model/PlayerTheme.md)
294288

295289
### HTTP request headers
@@ -334,7 +328,6 @@ Name | Type | Description | Notes
334328
**link** | **string**| A public link that you want to advertise in your player. For example, you could add a link to your company. When a viewer clicks on your logo, they will be taken to this address. | [optional] [default to undefined]
335329

336330
### Return type
337-
338331
[**PlayerTheme**](../model/PlayerTheme.md)
339332

340333
### HTTP request headers

‎doc/api/RawStatisticsApi.md

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Method | HTTP request | Description
2424
const currentPage = '2'; // Choose the number of search results to return per page. Minimum value: 1
2525
const pageSize = '30'; // Results per page. Allowed values 1-100, default is 25.
2626

27-
// Page<LiveStreamSession>
27+
// RawStatisticsListLiveStreamAnalyticsResponse
2828
const result = await client.rawStatistics.listLiveStreamSessions({ liveStreamId, period, currentPage, pageSize })
2929
console.log(result);
3030
} catch (e) {
@@ -43,8 +43,7 @@ Name | Type | Description | Notes
4343
**pageSize** | **number**| Results per page. Allowed values 1-100, default is 25. | [optional] [default to 25]
4444

4545
### Return type
46-
[**Page**](../model/pagination.md)<[**LiveStreamSession**](../model/LiveStreamSession.md)>
47-
46+
[**RawStatisticsListLiveStreamAnalyticsResponse**](../model/RawStatisticsListLiveStreamAnalyticsResponse.md)
4847

4948
### HTTP request headers
5049

@@ -71,7 +70,7 @@ Name | Type | Description | Notes
7170
const currentPage = '2'; // Choose the number of search results to return per page. Minimum value: 1
7271
const pageSize = '30'; // Results per page. Allowed values 1-100, default is 25.
7372

74-
// Page<PlayerSessionEvent>
73+
// RawStatisticsListPlayerSessionEventsResponse
7574
const result = await client.rawStatistics.listSessionEvents({ sessionId, currentPage, pageSize })
7675
console.log(result);
7776
} catch (e) {
@@ -89,8 +88,7 @@ Name | Type | Description | Notes
8988
**pageSize** | **number**| Results per page. Allowed values 1-100, default is 25. | [optional] [default to 25]
9089

9190
### Return type
92-
[**Page**](../model/pagination.md)<[**PlayerSessionEvent**](../model/PlayerSessionEvent.md)>
93-
91+
[**RawStatisticsListPlayerSessionEventsResponse**](../model/RawStatisticsListPlayerSessionEventsResponse.md)
9492

9593
### HTTP request headers
9694

@@ -119,7 +117,7 @@ Name | Type | Description | Notes
119117
const currentPage = '2'; // Choose the number of search results to return per page. Minimum value: 1
120118
const pageSize = '30'; // Results per page. Allowed values 1-100, default is 25.
121119

122-
// Page<VideoSession>
120+
// RawStatisticsListSessionsResponse
123121
const result = await client.rawStatistics.listVideoSessions({ videoId, period, metadata, currentPage, pageSize })
124122
console.log(result);
125123
} catch (e) {
@@ -139,8 +137,7 @@ Name | Type | Description | Notes
139137
**pageSize** | **number**| Results per page. Allowed values 1-100, default is 25. | [optional] [default to 25]
140138

141139
### Return type
142-
[**Page**](../model/pagination.md)<[**VideoSession**](../model/VideoSession.md)>
143-
140+
[**RawStatisticsListSessionsResponse**](../model/RawStatisticsListSessionsResponse.md)
144141

145142
### HTTP request headers
146143

‎doc/api/UploadTokensApi.md

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,6 @@ Name | Type | Description | Notes
3838
**uploadToken** | **string**| The unique identifier for the upload token you want to delete. Deleting a token will make it so the token can no longer be used for authentication. | [default to undefined]
3939

4040
### Return type
41-
4241
[**void**](../model/.md)
4342

4443
### HTTP request headers
@@ -67,7 +66,7 @@ Name | Type | Description | Notes
6766
const currentPage = '2'; // Choose the number of search results to return per page. Minimum value: 1
6867
const pageSize = '30'; // Results per page. Allowed values 1-100, default is 25.
6968

70-
// Page<UploadToken>
69+
// TokenListResponse
7170
const result = await client.uploadTokens.list({ sortBy, sortOrder, currentPage, pageSize })
7271
console.log(result);
7372
} catch (e) {
@@ -86,8 +85,7 @@ Name | Type | Description | Notes
8685
**pageSize** | **number**| Results per page. Allowed values 1-100, default is 25. | [optional] [default to 25]
8786

8887
### Return type
89-
[**Page**](../model/pagination.md)<[**UploadToken**](../model/UploadToken.md)>
90-
88+
[**TokenListResponse**](../model/TokenListResponse.md)
9189

9290
### HTTP request headers
9391

@@ -127,7 +125,6 @@ Name | Type | Description | Notes
127125
**uploadToken** | **string**| The unique identifier for the token you want information about. | [default to undefined]
128126

129127
### Return type
130-
131128
[**UploadToken**](../model/UploadToken.md)
132129

133130
### HTTP request headers
@@ -171,7 +168,6 @@ Name | Type | Description | Notes
171168
**tokenCreationPayload** | [**TokenCreationPayload**](../model/TokenCreationPayload.md)| |
172169

173170
### Return type
174-
175171
[**UploadToken**](../model/UploadToken.md)
176172

177173
### HTTP request headers

0 commit comments

Comments
 (0)