@connectedxm/admin-sdk 16.13.0 → 16.15.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +14 -0
- package/AdminApi.ts +9 -0
- package/README.md +2 -2
- package/api.ts +1768 -54
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/AdminApi.d.ts +4 -1
- package/dist/AdminApi.js +3 -0
- package/dist/api.d.ts +934 -15
- package/dist/api.js +1288 -47
- package/dist/base.d.ts +1 -1
- package/dist/base.js +1 -1
- package/dist/common.d.ts +1 -1
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +1 -1
- package/dist/esm/AdminApi.d.ts +4 -1
- package/dist/esm/AdminApi.js +4 -1
- package/dist/esm/api.d.ts +934 -15
- package/dist/esm/api.js +1247 -18
- package/dist/esm/base.d.ts +1 -1
- package/dist/esm/base.js +1 -1
- package/dist/esm/common.d.ts +1 -1
- package/dist/esm/common.js +1 -1
- package/dist/esm/configuration.d.ts +1 -1
- package/dist/esm/configuration.js +1 -1
- package/docs/BaseReplay.md +38 -0
- package/docs/BaseReplaySession.md +24 -0
- package/docs/BaseStreamInput.md +2 -0
- package/docs/BaseVideo.md +4 -0
- package/docs/ChannelsInterestsApi.md +364 -0
- package/docs/CreateReplay200Response.md +24 -0
- package/docs/EventSession.md +4 -0
- package/docs/EventSessionAllOfCount.md +20 -0
- package/docs/EventSessionCreateInputs.md +2 -0
- package/docs/EventSessionUpdateInputs.md +2 -0
- package/docs/EventsInterestsApi.md +181 -0
- package/docs/GetReplays200Response.md +26 -0
- package/docs/GroupsInterestsApi.md +2 -2
- package/docs/Replay.md +40 -0
- package/docs/ReplayCreateInputs.md +26 -0
- package/docs/ReplayUpdateInputs.md +24 -0
- package/docs/ReplayVideo.md +50 -0
- package/docs/StreamInput.md +8 -0
- package/docs/StreamInputCreateInputs.md +2 -0
- package/docs/StreamInputUpdateInputs.md +2 -0
- package/docs/StreamsApi.md +7 -1
- package/docs/StreamsReplaysApi.md +293 -0
- package/docs/Video.md +10 -0
- package/docs/VideoAllOfStream.md +22 -0
- package/docs/VideoAllOfStreamSession.md +22 -0
- package/package.json +1 -1
package/dist/esm/api.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Connected Admin API
|
|
3
3
|
* The Admin API allows you to manage your Connected community programmatically.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 16.
|
|
5
|
+
* The version of the OpenAPI document: 16.15.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -2636,6 +2636,23 @@ export interface BaseRegistrationSectionQuestion {
|
|
|
2636
2636
|
'question': BaseRegistrationQuestion;
|
|
2637
2637
|
'sortOrder': number;
|
|
2638
2638
|
}
|
|
2639
|
+
export interface BaseReplay {
|
|
2640
|
+
'id': string;
|
|
2641
|
+
'videoId': string;
|
|
2642
|
+
'sessionId': string | null;
|
|
2643
|
+
'eventId': string | null;
|
|
2644
|
+
'groupId': string | null;
|
|
2645
|
+
'session': BaseReplaySession | null;
|
|
2646
|
+
'event': VideoAllOfStream | null;
|
|
2647
|
+
'group': VideoAllOfStream | null;
|
|
2648
|
+
'createdAt': string;
|
|
2649
|
+
'updatedAt': string;
|
|
2650
|
+
}
|
|
2651
|
+
export interface BaseReplaySession {
|
|
2652
|
+
'id': string;
|
|
2653
|
+
'name': string;
|
|
2654
|
+
'eventId': string;
|
|
2655
|
+
}
|
|
2639
2656
|
export interface BaseReportExport {
|
|
2640
2657
|
'id': string;
|
|
2641
2658
|
'status': ExportStatus;
|
|
@@ -2787,6 +2804,7 @@ export interface BaseStreamInput {
|
|
|
2787
2804
|
'webRTC': boolean;
|
|
2788
2805
|
'webRTCPlaybackUrl': string | null;
|
|
2789
2806
|
'dvrEnabled': boolean;
|
|
2807
|
+
'allowReplays': boolean;
|
|
2790
2808
|
'connected': boolean;
|
|
2791
2809
|
}
|
|
2792
2810
|
export interface BaseStreamSession {
|
|
@@ -3057,6 +3075,8 @@ export interface BaseVideo {
|
|
|
3057
3075
|
'previewUrl': string | null;
|
|
3058
3076
|
'readyToStream': boolean;
|
|
3059
3077
|
'duration': number | null;
|
|
3078
|
+
'streamId': string | null;
|
|
3079
|
+
'streamSessionId': string | null;
|
|
3060
3080
|
'createdAt': string;
|
|
3061
3081
|
}
|
|
3062
3082
|
export interface BaseWebSocketConnection {
|
|
@@ -4602,6 +4622,14 @@ export interface CreatePreset200Response {
|
|
|
4602
4622
|
export declare enum CreatePreset200ResponseStatusEnum {
|
|
4603
4623
|
Ok = "ok"
|
|
4604
4624
|
}
|
|
4625
|
+
export interface CreateReplay200Response {
|
|
4626
|
+
'status': CreateReplay200ResponseStatusEnum;
|
|
4627
|
+
'message': string;
|
|
4628
|
+
'data': Replay;
|
|
4629
|
+
}
|
|
4630
|
+
export declare enum CreateReplay200ResponseStatusEnum {
|
|
4631
|
+
Ok = "ok"
|
|
4632
|
+
}
|
|
4605
4633
|
export interface CreateRoom200Response {
|
|
4606
4634
|
'status': CreateRoom200ResponseStatusEnum;
|
|
4607
4635
|
'message': string;
|
|
@@ -6202,6 +6230,8 @@ export interface EventSession {
|
|
|
6202
6230
|
'allowedTiers': Array<BaseTier>;
|
|
6203
6231
|
'continuousScanning': boolean;
|
|
6204
6232
|
'scanType': OnSiteScanType;
|
|
6233
|
+
'livestreamed': boolean;
|
|
6234
|
+
'_count'?: EventSessionAllOfCount;
|
|
6205
6235
|
}
|
|
6206
6236
|
export interface EventSessionAccess {
|
|
6207
6237
|
'id': string;
|
|
@@ -6217,6 +6247,9 @@ export interface EventSessionAccess {
|
|
|
6217
6247
|
export interface EventSessionAccessUpdateInputs {
|
|
6218
6248
|
'status'?: PurchaseStatus;
|
|
6219
6249
|
}
|
|
6250
|
+
export interface EventSessionAllOfCount {
|
|
6251
|
+
'replays': number;
|
|
6252
|
+
}
|
|
6220
6253
|
export interface EventSessionCloneOptions {
|
|
6221
6254
|
'name'?: string;
|
|
6222
6255
|
'startTime'?: string;
|
|
@@ -6235,6 +6268,7 @@ export interface EventSessionCreateInputs {
|
|
|
6235
6268
|
'featured'?: boolean;
|
|
6236
6269
|
'sortOrder'?: number | null;
|
|
6237
6270
|
'registrationEnabled'?: boolean;
|
|
6271
|
+
'livestreamed'?: boolean;
|
|
6238
6272
|
'onsiteRegistration'?: boolean;
|
|
6239
6273
|
'skipOnsiteValidations'?: boolean;
|
|
6240
6274
|
'allowQuickRegister'?: boolean;
|
|
@@ -6599,6 +6633,7 @@ export interface EventSessionUpdateInputs {
|
|
|
6599
6633
|
'featured'?: boolean;
|
|
6600
6634
|
'sortOrder'?: number | null;
|
|
6601
6635
|
'registrationEnabled'?: boolean;
|
|
6636
|
+
'livestreamed'?: boolean;
|
|
6602
6637
|
'onsiteRegistration'?: boolean;
|
|
6603
6638
|
'skipOnsiteValidations'?: boolean;
|
|
6604
6639
|
'allowQuickRegister'?: boolean;
|
|
@@ -9565,6 +9600,15 @@ export interface GetPushDevice200Response {
|
|
|
9565
9600
|
export declare enum GetPushDevice200ResponseStatusEnum {
|
|
9566
9601
|
Ok = "ok"
|
|
9567
9602
|
}
|
|
9603
|
+
export interface GetReplays200Response {
|
|
9604
|
+
'status': GetReplays200ResponseStatusEnum;
|
|
9605
|
+
'message': string;
|
|
9606
|
+
'data': Array<Replay>;
|
|
9607
|
+
'count'?: number;
|
|
9608
|
+
}
|
|
9609
|
+
export declare enum GetReplays200ResponseStatusEnum {
|
|
9610
|
+
Ok = "ok"
|
|
9611
|
+
}
|
|
9568
9612
|
export interface GetReport200Response {
|
|
9569
9613
|
'status': GetReport200ResponseStatusEnum;
|
|
9570
9614
|
'message': string;
|
|
@@ -12743,6 +12787,48 @@ export declare enum ReorderTiers200ResponseStatusEnum {
|
|
|
12743
12787
|
export interface ReorderTiersRequest {
|
|
12744
12788
|
'tierIds': Array<string>;
|
|
12745
12789
|
}
|
|
12790
|
+
export interface Replay {
|
|
12791
|
+
'id': string;
|
|
12792
|
+
'videoId': string;
|
|
12793
|
+
'sessionId': string | null;
|
|
12794
|
+
'eventId': string | null;
|
|
12795
|
+
'groupId': string | null;
|
|
12796
|
+
'session': BaseReplaySession | null;
|
|
12797
|
+
'event': VideoAllOfStream | null;
|
|
12798
|
+
'group': VideoAllOfStream | null;
|
|
12799
|
+
'createdAt': string;
|
|
12800
|
+
'updatedAt': string;
|
|
12801
|
+
'video': ReplayVideo;
|
|
12802
|
+
}
|
|
12803
|
+
export interface ReplayCreateInputs {
|
|
12804
|
+
'videoId': string;
|
|
12805
|
+
'sessionId'?: string;
|
|
12806
|
+
'eventId'?: string;
|
|
12807
|
+
'groupId'?: string;
|
|
12808
|
+
}
|
|
12809
|
+
export interface ReplayUpdateInputs {
|
|
12810
|
+
'sessionId'?: string;
|
|
12811
|
+
'eventId'?: string;
|
|
12812
|
+
'groupId'?: string;
|
|
12813
|
+
}
|
|
12814
|
+
export interface ReplayVideo {
|
|
12815
|
+
'id': string;
|
|
12816
|
+
'name': string;
|
|
12817
|
+
'status': string;
|
|
12818
|
+
'source': VideoSource;
|
|
12819
|
+
'width': number;
|
|
12820
|
+
'height': number;
|
|
12821
|
+
'thumbnailUrl': string | null;
|
|
12822
|
+
'previewUrl': string | null;
|
|
12823
|
+
'readyToStream': boolean;
|
|
12824
|
+
'duration': number | null;
|
|
12825
|
+
'streamId': string | null;
|
|
12826
|
+
'streamSessionId': string | null;
|
|
12827
|
+
'createdAt': string;
|
|
12828
|
+
'hlsUrl': string | null;
|
|
12829
|
+
'stream': VideoAllOfStream | null;
|
|
12830
|
+
'streamSession': VideoAllOfStreamSession | null;
|
|
12831
|
+
}
|
|
12746
12832
|
export interface ReportExport {
|
|
12747
12833
|
'id': string;
|
|
12748
12834
|
'status': ExportStatus;
|
|
@@ -13497,17 +13583,21 @@ export interface StreamInput {
|
|
|
13497
13583
|
'webRTC': boolean;
|
|
13498
13584
|
'webRTCPlaybackUrl': string | null;
|
|
13499
13585
|
'dvrEnabled': boolean;
|
|
13586
|
+
'allowReplays': boolean;
|
|
13500
13587
|
'connected': boolean;
|
|
13501
13588
|
'event': BaseEvent | null;
|
|
13502
13589
|
'session': BaseEventSession | null;
|
|
13503
13590
|
'group': BaseGroup | null;
|
|
13504
13591
|
'meetingId': string | null;
|
|
13505
13592
|
'meeting': BaseMeeting | null;
|
|
13593
|
+
'activityId': string | null;
|
|
13594
|
+
'activity': BaseActivity | null;
|
|
13506
13595
|
'streamInputId': string | null;
|
|
13507
13596
|
'streamInput': BaseStreamInput | null;
|
|
13508
13597
|
'details'?: StreamInputDetails;
|
|
13509
13598
|
'sortOrder': number;
|
|
13510
13599
|
'createdAt': string;
|
|
13600
|
+
'lastStreamSessionStartedAt'?: string | null;
|
|
13511
13601
|
}
|
|
13512
13602
|
export interface StreamInputCreateInputs {
|
|
13513
13603
|
'name': string;
|
|
@@ -13524,6 +13614,7 @@ export interface StreamInputCreateInputs {
|
|
|
13524
13614
|
'locale'?: string | null;
|
|
13525
13615
|
'webRTC'?: boolean;
|
|
13526
13616
|
'dvrEnabled'?: boolean;
|
|
13617
|
+
'allowReplays'?: boolean;
|
|
13527
13618
|
}
|
|
13528
13619
|
export interface StreamInputDetails {
|
|
13529
13620
|
'uid': string;
|
|
@@ -13593,6 +13684,7 @@ export interface StreamInputUpdateInputs {
|
|
|
13593
13684
|
'locale'?: string | null;
|
|
13594
13685
|
'webRTC'?: boolean;
|
|
13595
13686
|
'dvrEnabled'?: boolean;
|
|
13687
|
+
'allowReplays'?: boolean;
|
|
13596
13688
|
}
|
|
13597
13689
|
export interface StreamOutputCreateInputs {
|
|
13598
13690
|
'enabled': boolean;
|
|
@@ -14805,11 +14897,24 @@ export interface Video {
|
|
|
14805
14897
|
'previewUrl': string | null;
|
|
14806
14898
|
'readyToStream': boolean;
|
|
14807
14899
|
'duration': number | null;
|
|
14900
|
+
'streamId': string | null;
|
|
14901
|
+
'streamSessionId': string | null;
|
|
14808
14902
|
'createdAt': string;
|
|
14809
14903
|
'downloadUrl': string | null;
|
|
14810
14904
|
'hlsUrl': string | null;
|
|
14811
14905
|
'dashUrl': string | null;
|
|
14812
14906
|
'thumbnailPct': number | null;
|
|
14907
|
+
'stream': VideoAllOfStream | null;
|
|
14908
|
+
'streamSession': VideoAllOfStreamSession | null;
|
|
14909
|
+
'replays': Array<BaseReplay>;
|
|
14910
|
+
}
|
|
14911
|
+
export interface VideoAllOfStream {
|
|
14912
|
+
'id': string;
|
|
14913
|
+
'name': string;
|
|
14914
|
+
}
|
|
14915
|
+
export interface VideoAllOfStreamSession {
|
|
14916
|
+
'id': string;
|
|
14917
|
+
'startedAt': string;
|
|
14813
14918
|
}
|
|
14814
14919
|
export interface VideoCaption {
|
|
14815
14920
|
'language': string;
|
|
@@ -28145,6 +28250,362 @@ export declare enum GetContentsTypeEnum {
|
|
|
28145
28250
|
Audio = "audio",
|
|
28146
28251
|
Article = "article"
|
|
28147
28252
|
}
|
|
28253
|
+
/**
|
|
28254
|
+
* ChannelsInterestsApi - axios parameter creator
|
|
28255
|
+
*/
|
|
28256
|
+
export declare const ChannelsInterestsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
28257
|
+
/**
|
|
28258
|
+
* Associates an existing interest with a content item within a channel, requiring read permission on channels and update permission on both contents and interests; the content\'s cached data is refreshed and its interests list and the interest\'s cached detail and lists are invalidated.
|
|
28259
|
+
* @summary Add an interest to a content item
|
|
28260
|
+
* @param {string} channelId The channel identifier
|
|
28261
|
+
* @param {string} contentId The content identifier
|
|
28262
|
+
* @param {string} interestId The interest identifier
|
|
28263
|
+
* @param {*} [options] Override http request option.
|
|
28264
|
+
* @throws {RequiredError}
|
|
28265
|
+
*/
|
|
28266
|
+
addChannelContentInterest: (channelId: string, contentId: string, interestId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
28267
|
+
/**
|
|
28268
|
+
* Associates an existing interest with a channel, requiring update permission on both channels and interests; the channel\'s cached data is refreshed and its interests list and the interest\'s cached detail and lists are invalidated.
|
|
28269
|
+
* @summary Add an interest to a channel
|
|
28270
|
+
* @param {string} channelId The channel identifier
|
|
28271
|
+
* @param {string} interestId The interest identifier
|
|
28272
|
+
* @param {*} [options] Override http request option.
|
|
28273
|
+
* @throws {RequiredError}
|
|
28274
|
+
*/
|
|
28275
|
+
addChannelInterest: (channelId: string, interestId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
28276
|
+
/**
|
|
28277
|
+
* Returns a paginated list of interest tags associated with the given content item, optionally filtered by a search term on the interest name and sorted via orderBy; requires \"read\" permission on channels, contents and interests.
|
|
28278
|
+
* @summary List a content item\'s interests
|
|
28279
|
+
* @param {string} channelId The channel identifier
|
|
28280
|
+
* @param {string} contentId The content identifier
|
|
28281
|
+
* @param {number} [page] Page number
|
|
28282
|
+
* @param {number} [pageSize] Number of items per page
|
|
28283
|
+
* @param {string} [orderBy] Field to order by
|
|
28284
|
+
* @param {string} [search] Search query
|
|
28285
|
+
* @param {*} [options] Override http request option.
|
|
28286
|
+
* @throws {RequiredError}
|
|
28287
|
+
*/
|
|
28288
|
+
getChannelContentInterests: (channelId: string, contentId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
28289
|
+
/**
|
|
28290
|
+
* Returns a paginated list of interest tags associated with the given channel, optionally filtered by a search term on the interest name and sorted via orderBy; requires \"read\" permission on channels and interests.
|
|
28291
|
+
* @summary List a channel\'s interests
|
|
28292
|
+
* @param {string} channelId The channel identifier
|
|
28293
|
+
* @param {number} [page] Page number
|
|
28294
|
+
* @param {number} [pageSize] Number of items per page
|
|
28295
|
+
* @param {string} [orderBy] Field to order by
|
|
28296
|
+
* @param {string} [search] Search query
|
|
28297
|
+
* @param {*} [options] Override http request option.
|
|
28298
|
+
* @throws {RequiredError}
|
|
28299
|
+
*/
|
|
28300
|
+
getChannelInterests: (channelId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
28301
|
+
/**
|
|
28302
|
+
* Removes an interest from a content item within a channel, requiring read permission on channels and update permission on both contents and interests; the content\'s cached data is refreshed and its interests list and the interest\'s cached detail and lists are invalidated.
|
|
28303
|
+
* @summary Remove an interest from a content item
|
|
28304
|
+
* @param {string} channelId The channel identifier
|
|
28305
|
+
* @param {string} contentId The content identifier
|
|
28306
|
+
* @param {string} interestId The interest identifier
|
|
28307
|
+
* @param {*} [options] Override http request option.
|
|
28308
|
+
* @throws {RequiredError}
|
|
28309
|
+
*/
|
|
28310
|
+
removeChannelContentInterest: (channelId: string, contentId: string, interestId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
28311
|
+
/**
|
|
28312
|
+
* Removes an interest from a channel, requiring update permission on both channels and interests; the channel\'s cached data is refreshed and its interests list and the interest\'s cached detail and lists are invalidated.
|
|
28313
|
+
* @summary Remove an interest from a channel
|
|
28314
|
+
* @param {string} channelId The channel identifier
|
|
28315
|
+
* @param {string} interestId The interest identifier
|
|
28316
|
+
* @param {*} [options] Override http request option.
|
|
28317
|
+
* @throws {RequiredError}
|
|
28318
|
+
*/
|
|
28319
|
+
removeChannelInterest: (channelId: string, interestId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
28320
|
+
};
|
|
28321
|
+
/**
|
|
28322
|
+
* ChannelsInterestsApi - functional programming interface
|
|
28323
|
+
*/
|
|
28324
|
+
export declare const ChannelsInterestsApiFp: (configuration?: Configuration) => {
|
|
28325
|
+
/**
|
|
28326
|
+
* Associates an existing interest with a content item within a channel, requiring read permission on channels and update permission on both contents and interests; the content\'s cached data is refreshed and its interests list and the interest\'s cached detail and lists are invalidated.
|
|
28327
|
+
* @summary Add an interest to a content item
|
|
28328
|
+
* @param {string} channelId The channel identifier
|
|
28329
|
+
* @param {string} contentId The content identifier
|
|
28330
|
+
* @param {string} interestId The interest identifier
|
|
28331
|
+
* @param {*} [options] Override http request option.
|
|
28332
|
+
* @throws {RequiredError}
|
|
28333
|
+
*/
|
|
28334
|
+
addChannelContentInterest(channelId: string, contentId: string, interestId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateChannelContent200Response>>;
|
|
28335
|
+
/**
|
|
28336
|
+
* Associates an existing interest with a channel, requiring update permission on both channels and interests; the channel\'s cached data is refreshed and its interests list and the interest\'s cached detail and lists are invalidated.
|
|
28337
|
+
* @summary Add an interest to a channel
|
|
28338
|
+
* @param {string} channelId The channel identifier
|
|
28339
|
+
* @param {string} interestId The interest identifier
|
|
28340
|
+
* @param {*} [options] Override http request option.
|
|
28341
|
+
* @throws {RequiredError}
|
|
28342
|
+
*/
|
|
28343
|
+
addChannelInterest(channelId: string, interestId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateChannel200Response>>;
|
|
28344
|
+
/**
|
|
28345
|
+
* Returns a paginated list of interest tags associated with the given content item, optionally filtered by a search term on the interest name and sorted via orderBy; requires \"read\" permission on channels, contents and interests.
|
|
28346
|
+
* @summary List a content item\'s interests
|
|
28347
|
+
* @param {string} channelId The channel identifier
|
|
28348
|
+
* @param {string} contentId The content identifier
|
|
28349
|
+
* @param {number} [page] Page number
|
|
28350
|
+
* @param {number} [pageSize] Number of items per page
|
|
28351
|
+
* @param {string} [orderBy] Field to order by
|
|
28352
|
+
* @param {string} [search] Search query
|
|
28353
|
+
* @param {*} [options] Override http request option.
|
|
28354
|
+
* @throws {RequiredError}
|
|
28355
|
+
*/
|
|
28356
|
+
getChannelContentInterests(channelId: string, contentId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAccountInterests200Response>>;
|
|
28357
|
+
/**
|
|
28358
|
+
* Returns a paginated list of interest tags associated with the given channel, optionally filtered by a search term on the interest name and sorted via orderBy; requires \"read\" permission on channels and interests.
|
|
28359
|
+
* @summary List a channel\'s interests
|
|
28360
|
+
* @param {string} channelId The channel identifier
|
|
28361
|
+
* @param {number} [page] Page number
|
|
28362
|
+
* @param {number} [pageSize] Number of items per page
|
|
28363
|
+
* @param {string} [orderBy] Field to order by
|
|
28364
|
+
* @param {string} [search] Search query
|
|
28365
|
+
* @param {*} [options] Override http request option.
|
|
28366
|
+
* @throws {RequiredError}
|
|
28367
|
+
*/
|
|
28368
|
+
getChannelInterests(channelId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAccountInterests200Response>>;
|
|
28369
|
+
/**
|
|
28370
|
+
* Removes an interest from a content item within a channel, requiring read permission on channels and update permission on both contents and interests; the content\'s cached data is refreshed and its interests list and the interest\'s cached detail and lists are invalidated.
|
|
28371
|
+
* @summary Remove an interest from a content item
|
|
28372
|
+
* @param {string} channelId The channel identifier
|
|
28373
|
+
* @param {string} contentId The content identifier
|
|
28374
|
+
* @param {string} interestId The interest identifier
|
|
28375
|
+
* @param {*} [options] Override http request option.
|
|
28376
|
+
* @throws {RequiredError}
|
|
28377
|
+
*/
|
|
28378
|
+
removeChannelContentInterest(channelId: string, contentId: string, interestId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateChannelContent200Response>>;
|
|
28379
|
+
/**
|
|
28380
|
+
* Removes an interest from a channel, requiring update permission on both channels and interests; the channel\'s cached data is refreshed and its interests list and the interest\'s cached detail and lists are invalidated.
|
|
28381
|
+
* @summary Remove an interest from a channel
|
|
28382
|
+
* @param {string} channelId The channel identifier
|
|
28383
|
+
* @param {string} interestId The interest identifier
|
|
28384
|
+
* @param {*} [options] Override http request option.
|
|
28385
|
+
* @throws {RequiredError}
|
|
28386
|
+
*/
|
|
28387
|
+
removeChannelInterest(channelId: string, interestId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateChannel200Response>>;
|
|
28388
|
+
};
|
|
28389
|
+
/**
|
|
28390
|
+
* ChannelsInterestsApi - factory interface
|
|
28391
|
+
*/
|
|
28392
|
+
export declare const ChannelsInterestsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
28393
|
+
/**
|
|
28394
|
+
* Associates an existing interest with a content item within a channel, requiring read permission on channels and update permission on both contents and interests; the content\'s cached data is refreshed and its interests list and the interest\'s cached detail and lists are invalidated.
|
|
28395
|
+
* @summary Add an interest to a content item
|
|
28396
|
+
* @param {ChannelsInterestsApiAddChannelContentInterestRequest} requestParameters Request parameters.
|
|
28397
|
+
* @param {*} [options] Override http request option.
|
|
28398
|
+
* @throws {RequiredError}
|
|
28399
|
+
*/
|
|
28400
|
+
addChannelContentInterest(requestParameters: ChannelsInterestsApiAddChannelContentInterestRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateChannelContent200Response>;
|
|
28401
|
+
/**
|
|
28402
|
+
* Associates an existing interest with a channel, requiring update permission on both channels and interests; the channel\'s cached data is refreshed and its interests list and the interest\'s cached detail and lists are invalidated.
|
|
28403
|
+
* @summary Add an interest to a channel
|
|
28404
|
+
* @param {ChannelsInterestsApiAddChannelInterestRequest} requestParameters Request parameters.
|
|
28405
|
+
* @param {*} [options] Override http request option.
|
|
28406
|
+
* @throws {RequiredError}
|
|
28407
|
+
*/
|
|
28408
|
+
addChannelInterest(requestParameters: ChannelsInterestsApiAddChannelInterestRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateChannel200Response>;
|
|
28409
|
+
/**
|
|
28410
|
+
* Returns a paginated list of interest tags associated with the given content item, optionally filtered by a search term on the interest name and sorted via orderBy; requires \"read\" permission on channels, contents and interests.
|
|
28411
|
+
* @summary List a content item\'s interests
|
|
28412
|
+
* @param {ChannelsInterestsApiGetChannelContentInterestsRequest} requestParameters Request parameters.
|
|
28413
|
+
* @param {*} [options] Override http request option.
|
|
28414
|
+
* @throws {RequiredError}
|
|
28415
|
+
*/
|
|
28416
|
+
getChannelContentInterests(requestParameters: ChannelsInterestsApiGetChannelContentInterestsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetAccountInterests200Response>;
|
|
28417
|
+
/**
|
|
28418
|
+
* Returns a paginated list of interest tags associated with the given channel, optionally filtered by a search term on the interest name and sorted via orderBy; requires \"read\" permission on channels and interests.
|
|
28419
|
+
* @summary List a channel\'s interests
|
|
28420
|
+
* @param {ChannelsInterestsApiGetChannelInterestsRequest} requestParameters Request parameters.
|
|
28421
|
+
* @param {*} [options] Override http request option.
|
|
28422
|
+
* @throws {RequiredError}
|
|
28423
|
+
*/
|
|
28424
|
+
getChannelInterests(requestParameters: ChannelsInterestsApiGetChannelInterestsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetAccountInterests200Response>;
|
|
28425
|
+
/**
|
|
28426
|
+
* Removes an interest from a content item within a channel, requiring read permission on channels and update permission on both contents and interests; the content\'s cached data is refreshed and its interests list and the interest\'s cached detail and lists are invalidated.
|
|
28427
|
+
* @summary Remove an interest from a content item
|
|
28428
|
+
* @param {ChannelsInterestsApiRemoveChannelContentInterestRequest} requestParameters Request parameters.
|
|
28429
|
+
* @param {*} [options] Override http request option.
|
|
28430
|
+
* @throws {RequiredError}
|
|
28431
|
+
*/
|
|
28432
|
+
removeChannelContentInterest(requestParameters: ChannelsInterestsApiRemoveChannelContentInterestRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateChannelContent200Response>;
|
|
28433
|
+
/**
|
|
28434
|
+
* Removes an interest from a channel, requiring update permission on both channels and interests; the channel\'s cached data is refreshed and its interests list and the interest\'s cached detail and lists are invalidated.
|
|
28435
|
+
* @summary Remove an interest from a channel
|
|
28436
|
+
* @param {ChannelsInterestsApiRemoveChannelInterestRequest} requestParameters Request parameters.
|
|
28437
|
+
* @param {*} [options] Override http request option.
|
|
28438
|
+
* @throws {RequiredError}
|
|
28439
|
+
*/
|
|
28440
|
+
removeChannelInterest(requestParameters: ChannelsInterestsApiRemoveChannelInterestRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateChannel200Response>;
|
|
28441
|
+
};
|
|
28442
|
+
/**
|
|
28443
|
+
* Request parameters for addChannelContentInterest operation in ChannelsInterestsApi.
|
|
28444
|
+
*/
|
|
28445
|
+
export interface ChannelsInterestsApiAddChannelContentInterestRequest {
|
|
28446
|
+
/**
|
|
28447
|
+
* The channel identifier
|
|
28448
|
+
*/
|
|
28449
|
+
readonly channelId: string;
|
|
28450
|
+
/**
|
|
28451
|
+
* The content identifier
|
|
28452
|
+
*/
|
|
28453
|
+
readonly contentId: string;
|
|
28454
|
+
/**
|
|
28455
|
+
* The interest identifier
|
|
28456
|
+
*/
|
|
28457
|
+
readonly interestId: string;
|
|
28458
|
+
}
|
|
28459
|
+
/**
|
|
28460
|
+
* Request parameters for addChannelInterest operation in ChannelsInterestsApi.
|
|
28461
|
+
*/
|
|
28462
|
+
export interface ChannelsInterestsApiAddChannelInterestRequest {
|
|
28463
|
+
/**
|
|
28464
|
+
* The channel identifier
|
|
28465
|
+
*/
|
|
28466
|
+
readonly channelId: string;
|
|
28467
|
+
/**
|
|
28468
|
+
* The interest identifier
|
|
28469
|
+
*/
|
|
28470
|
+
readonly interestId: string;
|
|
28471
|
+
}
|
|
28472
|
+
/**
|
|
28473
|
+
* Request parameters for getChannelContentInterests operation in ChannelsInterestsApi.
|
|
28474
|
+
*/
|
|
28475
|
+
export interface ChannelsInterestsApiGetChannelContentInterestsRequest {
|
|
28476
|
+
/**
|
|
28477
|
+
* The channel identifier
|
|
28478
|
+
*/
|
|
28479
|
+
readonly channelId: string;
|
|
28480
|
+
/**
|
|
28481
|
+
* The content identifier
|
|
28482
|
+
*/
|
|
28483
|
+
readonly contentId: string;
|
|
28484
|
+
/**
|
|
28485
|
+
* Page number
|
|
28486
|
+
*/
|
|
28487
|
+
readonly page?: number;
|
|
28488
|
+
/**
|
|
28489
|
+
* Number of items per page
|
|
28490
|
+
*/
|
|
28491
|
+
readonly pageSize?: number;
|
|
28492
|
+
/**
|
|
28493
|
+
* Field to order by
|
|
28494
|
+
*/
|
|
28495
|
+
readonly orderBy?: string;
|
|
28496
|
+
/**
|
|
28497
|
+
* Search query
|
|
28498
|
+
*/
|
|
28499
|
+
readonly search?: string;
|
|
28500
|
+
}
|
|
28501
|
+
/**
|
|
28502
|
+
* Request parameters for getChannelInterests operation in ChannelsInterestsApi.
|
|
28503
|
+
*/
|
|
28504
|
+
export interface ChannelsInterestsApiGetChannelInterestsRequest {
|
|
28505
|
+
/**
|
|
28506
|
+
* The channel identifier
|
|
28507
|
+
*/
|
|
28508
|
+
readonly channelId: string;
|
|
28509
|
+
/**
|
|
28510
|
+
* Page number
|
|
28511
|
+
*/
|
|
28512
|
+
readonly page?: number;
|
|
28513
|
+
/**
|
|
28514
|
+
* Number of items per page
|
|
28515
|
+
*/
|
|
28516
|
+
readonly pageSize?: number;
|
|
28517
|
+
/**
|
|
28518
|
+
* Field to order by
|
|
28519
|
+
*/
|
|
28520
|
+
readonly orderBy?: string;
|
|
28521
|
+
/**
|
|
28522
|
+
* Search query
|
|
28523
|
+
*/
|
|
28524
|
+
readonly search?: string;
|
|
28525
|
+
}
|
|
28526
|
+
/**
|
|
28527
|
+
* Request parameters for removeChannelContentInterest operation in ChannelsInterestsApi.
|
|
28528
|
+
*/
|
|
28529
|
+
export interface ChannelsInterestsApiRemoveChannelContentInterestRequest {
|
|
28530
|
+
/**
|
|
28531
|
+
* The channel identifier
|
|
28532
|
+
*/
|
|
28533
|
+
readonly channelId: string;
|
|
28534
|
+
/**
|
|
28535
|
+
* The content identifier
|
|
28536
|
+
*/
|
|
28537
|
+
readonly contentId: string;
|
|
28538
|
+
/**
|
|
28539
|
+
* The interest identifier
|
|
28540
|
+
*/
|
|
28541
|
+
readonly interestId: string;
|
|
28542
|
+
}
|
|
28543
|
+
/**
|
|
28544
|
+
* Request parameters for removeChannelInterest operation in ChannelsInterestsApi.
|
|
28545
|
+
*/
|
|
28546
|
+
export interface ChannelsInterestsApiRemoveChannelInterestRequest {
|
|
28547
|
+
/**
|
|
28548
|
+
* The channel identifier
|
|
28549
|
+
*/
|
|
28550
|
+
readonly channelId: string;
|
|
28551
|
+
/**
|
|
28552
|
+
* The interest identifier
|
|
28553
|
+
*/
|
|
28554
|
+
readonly interestId: string;
|
|
28555
|
+
}
|
|
28556
|
+
/**
|
|
28557
|
+
* ChannelsInterestsApi - object-oriented interface
|
|
28558
|
+
*/
|
|
28559
|
+
export declare class ChannelsInterestsApi extends BaseAPI {
|
|
28560
|
+
/**
|
|
28561
|
+
* Associates an existing interest with a content item within a channel, requiring read permission on channels and update permission on both contents and interests; the content\'s cached data is refreshed and its interests list and the interest\'s cached detail and lists are invalidated.
|
|
28562
|
+
* @summary Add an interest to a content item
|
|
28563
|
+
* @param {ChannelsInterestsApiAddChannelContentInterestRequest} requestParameters Request parameters.
|
|
28564
|
+
* @param {*} [options] Override http request option.
|
|
28565
|
+
* @throws {RequiredError}
|
|
28566
|
+
*/
|
|
28567
|
+
addChannelContentInterest(requestParameters: ChannelsInterestsApiAddChannelContentInterestRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateChannelContent200Response, any, {}, any>>;
|
|
28568
|
+
/**
|
|
28569
|
+
* Associates an existing interest with a channel, requiring update permission on both channels and interests; the channel\'s cached data is refreshed and its interests list and the interest\'s cached detail and lists are invalidated.
|
|
28570
|
+
* @summary Add an interest to a channel
|
|
28571
|
+
* @param {ChannelsInterestsApiAddChannelInterestRequest} requestParameters Request parameters.
|
|
28572
|
+
* @param {*} [options] Override http request option.
|
|
28573
|
+
* @throws {RequiredError}
|
|
28574
|
+
*/
|
|
28575
|
+
addChannelInterest(requestParameters: ChannelsInterestsApiAddChannelInterestRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateChannel200Response, any, {}, any>>;
|
|
28576
|
+
/**
|
|
28577
|
+
* Returns a paginated list of interest tags associated with the given content item, optionally filtered by a search term on the interest name and sorted via orderBy; requires \"read\" permission on channels, contents and interests.
|
|
28578
|
+
* @summary List a content item\'s interests
|
|
28579
|
+
* @param {ChannelsInterestsApiGetChannelContentInterestsRequest} requestParameters Request parameters.
|
|
28580
|
+
* @param {*} [options] Override http request option.
|
|
28581
|
+
* @throws {RequiredError}
|
|
28582
|
+
*/
|
|
28583
|
+
getChannelContentInterests(requestParameters: ChannelsInterestsApiGetChannelContentInterestsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetAccountInterests200Response, any, {}, any>>;
|
|
28584
|
+
/**
|
|
28585
|
+
* Returns a paginated list of interest tags associated with the given channel, optionally filtered by a search term on the interest name and sorted via orderBy; requires \"read\" permission on channels and interests.
|
|
28586
|
+
* @summary List a channel\'s interests
|
|
28587
|
+
* @param {ChannelsInterestsApiGetChannelInterestsRequest} requestParameters Request parameters.
|
|
28588
|
+
* @param {*} [options] Override http request option.
|
|
28589
|
+
* @throws {RequiredError}
|
|
28590
|
+
*/
|
|
28591
|
+
getChannelInterests(requestParameters: ChannelsInterestsApiGetChannelInterestsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetAccountInterests200Response, any, {}, any>>;
|
|
28592
|
+
/**
|
|
28593
|
+
* Removes an interest from a content item within a channel, requiring read permission on channels and update permission on both contents and interests; the content\'s cached data is refreshed and its interests list and the interest\'s cached detail and lists are invalidated.
|
|
28594
|
+
* @summary Remove an interest from a content item
|
|
28595
|
+
* @param {ChannelsInterestsApiRemoveChannelContentInterestRequest} requestParameters Request parameters.
|
|
28596
|
+
* @param {*} [options] Override http request option.
|
|
28597
|
+
* @throws {RequiredError}
|
|
28598
|
+
*/
|
|
28599
|
+
removeChannelContentInterest(requestParameters: ChannelsInterestsApiRemoveChannelContentInterestRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateChannelContent200Response, any, {}, any>>;
|
|
28600
|
+
/**
|
|
28601
|
+
* Removes an interest from a channel, requiring update permission on both channels and interests; the channel\'s cached data is refreshed and its interests list and the interest\'s cached detail and lists are invalidated.
|
|
28602
|
+
* @summary Remove an interest from a channel
|
|
28603
|
+
* @param {ChannelsInterestsApiRemoveChannelInterestRequest} requestParameters Request parameters.
|
|
28604
|
+
* @param {*} [options] Override http request option.
|
|
28605
|
+
* @throws {RequiredError}
|
|
28606
|
+
*/
|
|
28607
|
+
removeChannelInterest(requestParameters: ChannelsInterestsApiRemoveChannelInterestRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateChannel200Response, any, {}, any>>;
|
|
28608
|
+
}
|
|
28148
28609
|
/**
|
|
28149
28610
|
* ChannelsTranslationsApi - axios parameter creator
|
|
28150
28611
|
*/
|
|
@@ -37369,6 +37830,185 @@ export declare class EventsGroupcouponreminderApi extends BaseAPI {
|
|
|
37369
37830
|
*/
|
|
37370
37831
|
updateEventGroupCouponReminder(requestParameters: EventsGroupcouponreminderApiUpdateEventGroupCouponReminderRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetEventGroupCouponReminder200Response, any, {}, any>>;
|
|
37371
37832
|
}
|
|
37833
|
+
/**
|
|
37834
|
+
* EventsInterestsApi - axios parameter creator
|
|
37835
|
+
*/
|
|
37836
|
+
export declare const EventsInterestsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
37837
|
+
/**
|
|
37838
|
+
* Associates an existing interest with an event, requiring update permission on both events and interests; the event\'s cached data is refreshed and its interests list and the interest\'s cached detail and lists are invalidated.
|
|
37839
|
+
* @summary Add an interest to an event
|
|
37840
|
+
* @param {string} eventId The event identifier
|
|
37841
|
+
* @param {string} interestId The interest identifier
|
|
37842
|
+
* @param {*} [options] Override http request option.
|
|
37843
|
+
* @throws {RequiredError}
|
|
37844
|
+
*/
|
|
37845
|
+
addEventInterest: (eventId: string, interestId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
37846
|
+
/**
|
|
37847
|
+
* Returns a paginated list of interest tags associated with the given event, optionally filtered by a search term on the interest name and sorted via orderBy; requires \"read\" permission on events and interests.
|
|
37848
|
+
* @summary List an event\'s interests
|
|
37849
|
+
* @param {string} eventId The event identifier
|
|
37850
|
+
* @param {number} [page] Page number
|
|
37851
|
+
* @param {number} [pageSize] Number of items per page
|
|
37852
|
+
* @param {string} [orderBy] Field to order by
|
|
37853
|
+
* @param {string} [search] Search query
|
|
37854
|
+
* @param {*} [options] Override http request option.
|
|
37855
|
+
* @throws {RequiredError}
|
|
37856
|
+
*/
|
|
37857
|
+
getEventInterests: (eventId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
37858
|
+
/**
|
|
37859
|
+
* Removes an interest from an event, requiring update permission on both events and interests; the event\'s cached data is refreshed and its interests list and the interest\'s cached detail and lists are invalidated.
|
|
37860
|
+
* @summary Remove an interest from an event
|
|
37861
|
+
* @param {string} eventId The event identifier
|
|
37862
|
+
* @param {string} interestId The interest identifier
|
|
37863
|
+
* @param {*} [options] Override http request option.
|
|
37864
|
+
* @throws {RequiredError}
|
|
37865
|
+
*/
|
|
37866
|
+
removeEventInterest: (eventId: string, interestId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
37867
|
+
};
|
|
37868
|
+
/**
|
|
37869
|
+
* EventsInterestsApi - functional programming interface
|
|
37870
|
+
*/
|
|
37871
|
+
export declare const EventsInterestsApiFp: (configuration?: Configuration) => {
|
|
37872
|
+
/**
|
|
37873
|
+
* Associates an existing interest with an event, requiring update permission on both events and interests; the event\'s cached data is refreshed and its interests list and the interest\'s cached detail and lists are invalidated.
|
|
37874
|
+
* @summary Add an interest to an event
|
|
37875
|
+
* @param {string} eventId The event identifier
|
|
37876
|
+
* @param {string} interestId The interest identifier
|
|
37877
|
+
* @param {*} [options] Override http request option.
|
|
37878
|
+
* @throws {RequiredError}
|
|
37879
|
+
*/
|
|
37880
|
+
addEventInterest(eventId: string, interestId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateEvent200Response>>;
|
|
37881
|
+
/**
|
|
37882
|
+
* Returns a paginated list of interest tags associated with the given event, optionally filtered by a search term on the interest name and sorted via orderBy; requires \"read\" permission on events and interests.
|
|
37883
|
+
* @summary List an event\'s interests
|
|
37884
|
+
* @param {string} eventId The event identifier
|
|
37885
|
+
* @param {number} [page] Page number
|
|
37886
|
+
* @param {number} [pageSize] Number of items per page
|
|
37887
|
+
* @param {string} [orderBy] Field to order by
|
|
37888
|
+
* @param {string} [search] Search query
|
|
37889
|
+
* @param {*} [options] Override http request option.
|
|
37890
|
+
* @throws {RequiredError}
|
|
37891
|
+
*/
|
|
37892
|
+
getEventInterests(eventId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAccountInterests200Response>>;
|
|
37893
|
+
/**
|
|
37894
|
+
* Removes an interest from an event, requiring update permission on both events and interests; the event\'s cached data is refreshed and its interests list and the interest\'s cached detail and lists are invalidated.
|
|
37895
|
+
* @summary Remove an interest from an event
|
|
37896
|
+
* @param {string} eventId The event identifier
|
|
37897
|
+
* @param {string} interestId The interest identifier
|
|
37898
|
+
* @param {*} [options] Override http request option.
|
|
37899
|
+
* @throws {RequiredError}
|
|
37900
|
+
*/
|
|
37901
|
+
removeEventInterest(eventId: string, interestId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateEvent200Response>>;
|
|
37902
|
+
};
|
|
37903
|
+
/**
|
|
37904
|
+
* EventsInterestsApi - factory interface
|
|
37905
|
+
*/
|
|
37906
|
+
export declare const EventsInterestsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
37907
|
+
/**
|
|
37908
|
+
* Associates an existing interest with an event, requiring update permission on both events and interests; the event\'s cached data is refreshed and its interests list and the interest\'s cached detail and lists are invalidated.
|
|
37909
|
+
* @summary Add an interest to an event
|
|
37910
|
+
* @param {EventsInterestsApiAddEventInterestRequest} requestParameters Request parameters.
|
|
37911
|
+
* @param {*} [options] Override http request option.
|
|
37912
|
+
* @throws {RequiredError}
|
|
37913
|
+
*/
|
|
37914
|
+
addEventInterest(requestParameters: EventsInterestsApiAddEventInterestRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateEvent200Response>;
|
|
37915
|
+
/**
|
|
37916
|
+
* Returns a paginated list of interest tags associated with the given event, optionally filtered by a search term on the interest name and sorted via orderBy; requires \"read\" permission on events and interests.
|
|
37917
|
+
* @summary List an event\'s interests
|
|
37918
|
+
* @param {EventsInterestsApiGetEventInterestsRequest} requestParameters Request parameters.
|
|
37919
|
+
* @param {*} [options] Override http request option.
|
|
37920
|
+
* @throws {RequiredError}
|
|
37921
|
+
*/
|
|
37922
|
+
getEventInterests(requestParameters: EventsInterestsApiGetEventInterestsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetAccountInterests200Response>;
|
|
37923
|
+
/**
|
|
37924
|
+
* Removes an interest from an event, requiring update permission on both events and interests; the event\'s cached data is refreshed and its interests list and the interest\'s cached detail and lists are invalidated.
|
|
37925
|
+
* @summary Remove an interest from an event
|
|
37926
|
+
* @param {EventsInterestsApiRemoveEventInterestRequest} requestParameters Request parameters.
|
|
37927
|
+
* @param {*} [options] Override http request option.
|
|
37928
|
+
* @throws {RequiredError}
|
|
37929
|
+
*/
|
|
37930
|
+
removeEventInterest(requestParameters: EventsInterestsApiRemoveEventInterestRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateEvent200Response>;
|
|
37931
|
+
};
|
|
37932
|
+
/**
|
|
37933
|
+
* Request parameters for addEventInterest operation in EventsInterestsApi.
|
|
37934
|
+
*/
|
|
37935
|
+
export interface EventsInterestsApiAddEventInterestRequest {
|
|
37936
|
+
/**
|
|
37937
|
+
* The event identifier
|
|
37938
|
+
*/
|
|
37939
|
+
readonly eventId: string;
|
|
37940
|
+
/**
|
|
37941
|
+
* The interest identifier
|
|
37942
|
+
*/
|
|
37943
|
+
readonly interestId: string;
|
|
37944
|
+
}
|
|
37945
|
+
/**
|
|
37946
|
+
* Request parameters for getEventInterests operation in EventsInterestsApi.
|
|
37947
|
+
*/
|
|
37948
|
+
export interface EventsInterestsApiGetEventInterestsRequest {
|
|
37949
|
+
/**
|
|
37950
|
+
* The event identifier
|
|
37951
|
+
*/
|
|
37952
|
+
readonly eventId: string;
|
|
37953
|
+
/**
|
|
37954
|
+
* Page number
|
|
37955
|
+
*/
|
|
37956
|
+
readonly page?: number;
|
|
37957
|
+
/**
|
|
37958
|
+
* Number of items per page
|
|
37959
|
+
*/
|
|
37960
|
+
readonly pageSize?: number;
|
|
37961
|
+
/**
|
|
37962
|
+
* Field to order by
|
|
37963
|
+
*/
|
|
37964
|
+
readonly orderBy?: string;
|
|
37965
|
+
/**
|
|
37966
|
+
* Search query
|
|
37967
|
+
*/
|
|
37968
|
+
readonly search?: string;
|
|
37969
|
+
}
|
|
37970
|
+
/**
|
|
37971
|
+
* Request parameters for removeEventInterest operation in EventsInterestsApi.
|
|
37972
|
+
*/
|
|
37973
|
+
export interface EventsInterestsApiRemoveEventInterestRequest {
|
|
37974
|
+
/**
|
|
37975
|
+
* The event identifier
|
|
37976
|
+
*/
|
|
37977
|
+
readonly eventId: string;
|
|
37978
|
+
/**
|
|
37979
|
+
* The interest identifier
|
|
37980
|
+
*/
|
|
37981
|
+
readonly interestId: string;
|
|
37982
|
+
}
|
|
37983
|
+
/**
|
|
37984
|
+
* EventsInterestsApi - object-oriented interface
|
|
37985
|
+
*/
|
|
37986
|
+
export declare class EventsInterestsApi extends BaseAPI {
|
|
37987
|
+
/**
|
|
37988
|
+
* Associates an existing interest with an event, requiring update permission on both events and interests; the event\'s cached data is refreshed and its interests list and the interest\'s cached detail and lists are invalidated.
|
|
37989
|
+
* @summary Add an interest to an event
|
|
37990
|
+
* @param {EventsInterestsApiAddEventInterestRequest} requestParameters Request parameters.
|
|
37991
|
+
* @param {*} [options] Override http request option.
|
|
37992
|
+
* @throws {RequiredError}
|
|
37993
|
+
*/
|
|
37994
|
+
addEventInterest(requestParameters: EventsInterestsApiAddEventInterestRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateEvent200Response, any, {}, any>>;
|
|
37995
|
+
/**
|
|
37996
|
+
* Returns a paginated list of interest tags associated with the given event, optionally filtered by a search term on the interest name and sorted via orderBy; requires \"read\" permission on events and interests.
|
|
37997
|
+
* @summary List an event\'s interests
|
|
37998
|
+
* @param {EventsInterestsApiGetEventInterestsRequest} requestParameters Request parameters.
|
|
37999
|
+
* @param {*} [options] Override http request option.
|
|
38000
|
+
* @throws {RequiredError}
|
|
38001
|
+
*/
|
|
38002
|
+
getEventInterests(requestParameters: EventsInterestsApiGetEventInterestsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetAccountInterests200Response, any, {}, any>>;
|
|
38003
|
+
/**
|
|
38004
|
+
* Removes an interest from an event, requiring update permission on both events and interests; the event\'s cached data is refreshed and its interests list and the interest\'s cached detail and lists are invalidated.
|
|
38005
|
+
* @summary Remove an interest from an event
|
|
38006
|
+
* @param {EventsInterestsApiRemoveEventInterestRequest} requestParameters Request parameters.
|
|
38007
|
+
* @param {*} [options] Override http request option.
|
|
38008
|
+
* @throws {RequiredError}
|
|
38009
|
+
*/
|
|
38010
|
+
removeEventInterest(requestParameters: EventsInterestsApiRemoveEventInterestRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateEvent200Response, any, {}, any>>;
|
|
38011
|
+
}
|
|
37372
38012
|
/**
|
|
37373
38013
|
* EventsMatchesApi - axios parameter creator
|
|
37374
38014
|
*/
|
|
@@ -65853,7 +66493,7 @@ export declare class GroupsEventsApi extends BaseAPI {
|
|
|
65853
66493
|
*/
|
|
65854
66494
|
export declare const GroupsInterestsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
65855
66495
|
/**
|
|
65856
|
-
* Associates an existing interest with a group, requiring update permission on both groups and interests; the group\'s cached data is refreshed and its interests list
|
|
66496
|
+
* Associates an existing interest with a group, requiring update permission on both groups and interests; the group\'s cached data is refreshed and its interests list and the interest\'s cached detail and lists are invalidated.
|
|
65857
66497
|
* @summary Add an interest to a group
|
|
65858
66498
|
* @param {string} groupId The group identifier
|
|
65859
66499
|
* @param {string} interestId The interest identifier
|
|
@@ -65874,7 +66514,7 @@ export declare const GroupsInterestsApiAxiosParamCreator: (configuration?: Confi
|
|
|
65874
66514
|
*/
|
|
65875
66515
|
getGroupInterests: (groupId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
65876
66516
|
/**
|
|
65877
|
-
* Disassociates an interest from a group, requiring update permission on both groups and interests; the group\'s cached data is refreshed and its interests list
|
|
66517
|
+
* Disassociates an interest from a group, requiring update permission on both groups and interests; the group\'s cached data is refreshed and its interests list and the interest\'s cached detail and lists are invalidated.
|
|
65878
66518
|
* @summary Remove an interest from a group
|
|
65879
66519
|
* @param {string} groupId The group identifier
|
|
65880
66520
|
* @param {string} accountId The account identifier
|
|
@@ -65888,7 +66528,7 @@ export declare const GroupsInterestsApiAxiosParamCreator: (configuration?: Confi
|
|
|
65888
66528
|
*/
|
|
65889
66529
|
export declare const GroupsInterestsApiFp: (configuration?: Configuration) => {
|
|
65890
66530
|
/**
|
|
65891
|
-
* Associates an existing interest with a group, requiring update permission on both groups and interests; the group\'s cached data is refreshed and its interests list
|
|
66531
|
+
* Associates an existing interest with a group, requiring update permission on both groups and interests; the group\'s cached data is refreshed and its interests list and the interest\'s cached detail and lists are invalidated.
|
|
65892
66532
|
* @summary Add an interest to a group
|
|
65893
66533
|
* @param {string} groupId The group identifier
|
|
65894
66534
|
* @param {string} interestId The interest identifier
|
|
@@ -65909,7 +66549,7 @@ export declare const GroupsInterestsApiFp: (configuration?: Configuration) => {
|
|
|
65909
66549
|
*/
|
|
65910
66550
|
getGroupInterests(groupId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAccountInterests200Response>>;
|
|
65911
66551
|
/**
|
|
65912
|
-
* Disassociates an interest from a group, requiring update permission on both groups and interests; the group\'s cached data is refreshed and its interests list
|
|
66552
|
+
* Disassociates an interest from a group, requiring update permission on both groups and interests; the group\'s cached data is refreshed and its interests list and the interest\'s cached detail and lists are invalidated.
|
|
65913
66553
|
* @summary Remove an interest from a group
|
|
65914
66554
|
* @param {string} groupId The group identifier
|
|
65915
66555
|
* @param {string} accountId The account identifier
|
|
@@ -65923,7 +66563,7 @@ export declare const GroupsInterestsApiFp: (configuration?: Configuration) => {
|
|
|
65923
66563
|
*/
|
|
65924
66564
|
export declare const GroupsInterestsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
65925
66565
|
/**
|
|
65926
|
-
* Associates an existing interest with a group, requiring update permission on both groups and interests; the group\'s cached data is refreshed and its interests list
|
|
66566
|
+
* Associates an existing interest with a group, requiring update permission on both groups and interests; the group\'s cached data is refreshed and its interests list and the interest\'s cached detail and lists are invalidated.
|
|
65927
66567
|
* @summary Add an interest to a group
|
|
65928
66568
|
* @param {GroupsInterestsApiAddGroupInterestRequest} requestParameters Request parameters.
|
|
65929
66569
|
* @param {*} [options] Override http request option.
|
|
@@ -65939,7 +66579,7 @@ export declare const GroupsInterestsApiFactory: (configuration?: Configuration,
|
|
|
65939
66579
|
*/
|
|
65940
66580
|
getGroupInterests(requestParameters: GroupsInterestsApiGetGroupInterestsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetAccountInterests200Response>;
|
|
65941
66581
|
/**
|
|
65942
|
-
* Disassociates an interest from a group, requiring update permission on both groups and interests; the group\'s cached data is refreshed and its interests list
|
|
66582
|
+
* Disassociates an interest from a group, requiring update permission on both groups and interests; the group\'s cached data is refreshed and its interests list and the interest\'s cached detail and lists are invalidated.
|
|
65943
66583
|
* @summary Remove an interest from a group
|
|
65944
66584
|
* @param {GroupsInterestsApiRemoveGroupInterestRequest} requestParameters Request parameters.
|
|
65945
66585
|
* @param {*} [options] Override http request option.
|
|
@@ -66003,7 +66643,7 @@ export interface GroupsInterestsApiRemoveGroupInterestRequest {
|
|
|
66003
66643
|
*/
|
|
66004
66644
|
export declare class GroupsInterestsApi extends BaseAPI {
|
|
66005
66645
|
/**
|
|
66006
|
-
* Associates an existing interest with a group, requiring update permission on both groups and interests; the group\'s cached data is refreshed and its interests list
|
|
66646
|
+
* Associates an existing interest with a group, requiring update permission on both groups and interests; the group\'s cached data is refreshed and its interests list and the interest\'s cached detail and lists are invalidated.
|
|
66007
66647
|
* @summary Add an interest to a group
|
|
66008
66648
|
* @param {GroupsInterestsApiAddGroupInterestRequest} requestParameters Request parameters.
|
|
66009
66649
|
* @param {*} [options] Override http request option.
|
|
@@ -66019,7 +66659,7 @@ export declare class GroupsInterestsApi extends BaseAPI {
|
|
|
66019
66659
|
*/
|
|
66020
66660
|
getGroupInterests(requestParameters: GroupsInterestsApiGetGroupInterestsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetAccountInterests200Response, any, {}, any>>;
|
|
66021
66661
|
/**
|
|
66022
|
-
* Disassociates an interest from a group, requiring update permission on both groups and interests; the group\'s cached data is refreshed and its interests list
|
|
66662
|
+
* Disassociates an interest from a group, requiring update permission on both groups and interests; the group\'s cached data is refreshed and its interests list and the interest\'s cached detail and lists are invalidated.
|
|
66023
66663
|
* @summary Remove an interest from a group
|
|
66024
66664
|
* @param {GroupsInterestsApiRemoveGroupInterestRequest} requestParameters Request parameters.
|
|
66025
66665
|
* @param {*} [options] Override http request option.
|
|
@@ -83244,12 +83884,14 @@ export declare const StreamsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
83244
83884
|
*/
|
|
83245
83885
|
getStreamInput: (streamId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
83246
83886
|
/**
|
|
83247
|
-
* Returns a paginated list of stream inputs for the organization, filterable by associated event, session, group, or meeting, and by free-text search; requires read permission on streams.
|
|
83887
|
+
* Returns a paginated list of stream inputs for the organization, filterable by associated event, session, group, or meeting, by whether an encoder is connected, by whether the input is attached to an event, session, group or activity (a meeting-only input counts as not attached), and by free-text search; each item includes when its latest broadcast started; requires read permission on streams.
|
|
83248
83888
|
* @summary List an organization\'s stream inputs
|
|
83249
83889
|
* @param {string} [eventId] Filter by eventId
|
|
83250
83890
|
* @param {string} [sessionId] Filter by sessionId
|
|
83251
83891
|
* @param {string} [groupId] Filter by groupId
|
|
83252
83892
|
* @param {string} [meetingId] Filter by meetingId
|
|
83893
|
+
* @param {boolean} [connected] Filter by connected
|
|
83894
|
+
* @param {boolean} [attached] Filter by attached
|
|
83253
83895
|
* @param {number} [page] Page number
|
|
83254
83896
|
* @param {number} [pageSize] Number of items per page
|
|
83255
83897
|
* @param {string} [orderBy] Field to order by
|
|
@@ -83257,7 +83899,7 @@ export declare const StreamsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
83257
83899
|
* @param {*} [options] Override http request option.
|
|
83258
83900
|
* @throws {RequiredError}
|
|
83259
83901
|
*/
|
|
83260
|
-
getStreamInputs: (eventId?: string, sessionId?: string, groupId?: string, meetingId?: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
83902
|
+
getStreamInputs: (eventId?: string, sessionId?: string, groupId?: string, meetingId?: string, connected?: boolean, attached?: boolean, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
83261
83903
|
/**
|
|
83262
83904
|
* Returns a paginated list of recorded videos associated with the given stream, with optional search and ordering, and requires \"read\" permission on both streams and storage.
|
|
83263
83905
|
* @summary List a stream\'s recorded videos
|
|
@@ -83318,12 +83960,14 @@ export declare const StreamsApiFp: (configuration?: Configuration) => {
|
|
|
83318
83960
|
*/
|
|
83319
83961
|
getStreamInput(streamId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateStreamInput200Response>>;
|
|
83320
83962
|
/**
|
|
83321
|
-
* Returns a paginated list of stream inputs for the organization, filterable by associated event, session, group, or meeting, and by free-text search; requires read permission on streams.
|
|
83963
|
+
* Returns a paginated list of stream inputs for the organization, filterable by associated event, session, group, or meeting, by whether an encoder is connected, by whether the input is attached to an event, session, group or activity (a meeting-only input counts as not attached), and by free-text search; each item includes when its latest broadcast started; requires read permission on streams.
|
|
83322
83964
|
* @summary List an organization\'s stream inputs
|
|
83323
83965
|
* @param {string} [eventId] Filter by eventId
|
|
83324
83966
|
* @param {string} [sessionId] Filter by sessionId
|
|
83325
83967
|
* @param {string} [groupId] Filter by groupId
|
|
83326
83968
|
* @param {string} [meetingId] Filter by meetingId
|
|
83969
|
+
* @param {boolean} [connected] Filter by connected
|
|
83970
|
+
* @param {boolean} [attached] Filter by attached
|
|
83327
83971
|
* @param {number} [page] Page number
|
|
83328
83972
|
* @param {number} [pageSize] Number of items per page
|
|
83329
83973
|
* @param {string} [orderBy] Field to order by
|
|
@@ -83331,7 +83975,7 @@ export declare const StreamsApiFp: (configuration?: Configuration) => {
|
|
|
83331
83975
|
* @param {*} [options] Override http request option.
|
|
83332
83976
|
* @throws {RequiredError}
|
|
83333
83977
|
*/
|
|
83334
|
-
getStreamInputs(eventId?: string, sessionId?: string, groupId?: string, meetingId?: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetStreamInputs200Response>>;
|
|
83978
|
+
getStreamInputs(eventId?: string, sessionId?: string, groupId?: string, meetingId?: string, connected?: boolean, attached?: boolean, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetStreamInputs200Response>>;
|
|
83335
83979
|
/**
|
|
83336
83980
|
* Returns a paginated list of recorded videos associated with the given stream, with optional search and ordering, and requires \"read\" permission on both streams and storage.
|
|
83337
83981
|
* @summary List a stream\'s recorded videos
|
|
@@ -83392,7 +84036,7 @@ export declare const StreamsApiFactory: (configuration?: Configuration, basePath
|
|
|
83392
84036
|
*/
|
|
83393
84037
|
getStreamInput(requestParameters: StreamsApiGetStreamInputRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateStreamInput200Response>;
|
|
83394
84038
|
/**
|
|
83395
|
-
* Returns a paginated list of stream inputs for the organization, filterable by associated event, session, group, or meeting, and by free-text search; requires read permission on streams.
|
|
84039
|
+
* Returns a paginated list of stream inputs for the organization, filterable by associated event, session, group, or meeting, by whether an encoder is connected, by whether the input is attached to an event, session, group or activity (a meeting-only input counts as not attached), and by free-text search; each item includes when its latest broadcast started; requires read permission on streams.
|
|
83396
84040
|
* @summary List an organization\'s stream inputs
|
|
83397
84041
|
* @param {StreamsApiGetStreamInputsRequest} requestParameters Request parameters.
|
|
83398
84042
|
* @param {*} [options] Override http request option.
|
|
@@ -83468,6 +84112,14 @@ export interface StreamsApiGetStreamInputsRequest {
|
|
|
83468
84112
|
* Filter by meetingId
|
|
83469
84113
|
*/
|
|
83470
84114
|
readonly meetingId?: string;
|
|
84115
|
+
/**
|
|
84116
|
+
* Filter by connected
|
|
84117
|
+
*/
|
|
84118
|
+
readonly connected?: boolean;
|
|
84119
|
+
/**
|
|
84120
|
+
* Filter by attached
|
|
84121
|
+
*/
|
|
84122
|
+
readonly attached?: boolean;
|
|
83471
84123
|
/**
|
|
83472
84124
|
* Page number
|
|
83473
84125
|
*/
|
|
@@ -83559,7 +84211,7 @@ export declare class StreamsApi extends BaseAPI {
|
|
|
83559
84211
|
*/
|
|
83560
84212
|
getStreamInput(requestParameters: StreamsApiGetStreamInputRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateStreamInput200Response, any, {}, any>>;
|
|
83561
84213
|
/**
|
|
83562
|
-
* Returns a paginated list of stream inputs for the organization, filterable by associated event, session, group, or meeting, and by free-text search; requires read permission on streams.
|
|
84214
|
+
* Returns a paginated list of stream inputs for the organization, filterable by associated event, session, group, or meeting, by whether an encoder is connected, by whether the input is attached to an event, session, group or activity (a meeting-only input counts as not attached), and by free-text search; each item includes when its latest broadcast started; requires read permission on streams.
|
|
83563
84215
|
* @summary List an organization\'s stream inputs
|
|
83564
84216
|
* @param {StreamsApiGetStreamInputsRequest} requestParameters Request parameters.
|
|
83565
84217
|
* @param {*} [options] Override http request option.
|
|
@@ -83864,6 +84516,273 @@ export declare class StreamsOutputsApi extends BaseAPI {
|
|
|
83864
84516
|
*/
|
|
83865
84517
|
updateStreamInputOutput(requestParameters: StreamsOutputsApiUpdateStreamInputOutputRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateStreamInputOutput200Response, any, {}, any>>;
|
|
83866
84518
|
}
|
|
84519
|
+
/**
|
|
84520
|
+
* StreamsReplaysApi - axios parameter creator
|
|
84521
|
+
*/
|
|
84522
|
+
export declare const StreamsReplaysApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
84523
|
+
/**
|
|
84524
|
+
* Attaches a video from storage as a replay to exactly one session, event or group; a video can be a replay on several targets, but only once on each (a repeat returns 400 \"Replay already exists\"). Requires create permission on streams.
|
|
84525
|
+
* @summary Add a video as a replay
|
|
84526
|
+
* @param {ReplayCreateInputs} replayCreateInputs
|
|
84527
|
+
* @param {*} [options] Override http request option.
|
|
84528
|
+
* @throws {RequiredError}
|
|
84529
|
+
*/
|
|
84530
|
+
createReplay: (replayCreateInputs: ReplayCreateInputs, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
84531
|
+
/**
|
|
84532
|
+
* Detaches a replay from its session, event or group; the video stays in storage. Requires delete permission on streams.
|
|
84533
|
+
* @summary Remove a replay
|
|
84534
|
+
* @param {string} replayId The replay identifier
|
|
84535
|
+
* @param {*} [options] Override http request option.
|
|
84536
|
+
* @throws {RequiredError}
|
|
84537
|
+
*/
|
|
84538
|
+
deleteReplay: (replayId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
84539
|
+
/**
|
|
84540
|
+
* Returns a single replay with its video and the name of the session, event or group it is attached to; requires read permission on streams.
|
|
84541
|
+
* @summary Get a replay
|
|
84542
|
+
* @param {string} replayId The replay identifier
|
|
84543
|
+
* @param {*} [options] Override http request option.
|
|
84544
|
+
* @throws {RequiredError}
|
|
84545
|
+
*/
|
|
84546
|
+
getReplay: (replayId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
84547
|
+
/**
|
|
84548
|
+
* Returns a paginated list of the organization\'s replays, newest first, each with its video and the name of the session, event or group it is attached to, filterable by session, event, group or video; requires read permission on streams.
|
|
84549
|
+
* @summary List replays
|
|
84550
|
+
* @param {string} [sessionId] Filter by sessionId
|
|
84551
|
+
* @param {string} [eventId] Filter by eventId
|
|
84552
|
+
* @param {string} [groupId] Filter by groupId
|
|
84553
|
+
* @param {string} [videoId] Filter by videoId
|
|
84554
|
+
* @param {number} [page] Page number
|
|
84555
|
+
* @param {number} [pageSize] Number of items per page
|
|
84556
|
+
* @param {string} [orderBy] Field to order by
|
|
84557
|
+
* @param {string} [search] Search query
|
|
84558
|
+
* @param {*} [options] Override http request option.
|
|
84559
|
+
* @throws {RequiredError}
|
|
84560
|
+
*/
|
|
84561
|
+
getReplays: (sessionId?: string, eventId?: string, groupId?: string, videoId?: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
84562
|
+
/**
|
|
84563
|
+
* Moves a replay to exactly one other session, event or group in the organization; the video itself is unchanged. Requires update permission on streams.
|
|
84564
|
+
* @summary Move a replay
|
|
84565
|
+
* @param {string} replayId The replay identifier
|
|
84566
|
+
* @param {ReplayUpdateInputs} replayUpdateInputs
|
|
84567
|
+
* @param {*} [options] Override http request option.
|
|
84568
|
+
* @throws {RequiredError}
|
|
84569
|
+
*/
|
|
84570
|
+
updateReplay: (replayId: string, replayUpdateInputs: ReplayUpdateInputs, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
84571
|
+
};
|
|
84572
|
+
/**
|
|
84573
|
+
* StreamsReplaysApi - functional programming interface
|
|
84574
|
+
*/
|
|
84575
|
+
export declare const StreamsReplaysApiFp: (configuration?: Configuration) => {
|
|
84576
|
+
/**
|
|
84577
|
+
* Attaches a video from storage as a replay to exactly one session, event or group; a video can be a replay on several targets, but only once on each (a repeat returns 400 \"Replay already exists\"). Requires create permission on streams.
|
|
84578
|
+
* @summary Add a video as a replay
|
|
84579
|
+
* @param {ReplayCreateInputs} replayCreateInputs
|
|
84580
|
+
* @param {*} [options] Override http request option.
|
|
84581
|
+
* @throws {RequiredError}
|
|
84582
|
+
*/
|
|
84583
|
+
createReplay(replayCreateInputs: ReplayCreateInputs, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateReplay200Response>>;
|
|
84584
|
+
/**
|
|
84585
|
+
* Detaches a replay from its session, event or group; the video stays in storage. Requires delete permission on streams.
|
|
84586
|
+
* @summary Remove a replay
|
|
84587
|
+
* @param {string} replayId The replay identifier
|
|
84588
|
+
* @param {*} [options] Override http request option.
|
|
84589
|
+
* @throws {RequiredError}
|
|
84590
|
+
*/
|
|
84591
|
+
deleteReplay(replayId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAccountInvitations200Response>>;
|
|
84592
|
+
/**
|
|
84593
|
+
* Returns a single replay with its video and the name of the session, event or group it is attached to; requires read permission on streams.
|
|
84594
|
+
* @summary Get a replay
|
|
84595
|
+
* @param {string} replayId The replay identifier
|
|
84596
|
+
* @param {*} [options] Override http request option.
|
|
84597
|
+
* @throws {RequiredError}
|
|
84598
|
+
*/
|
|
84599
|
+
getReplay(replayId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateReplay200Response>>;
|
|
84600
|
+
/**
|
|
84601
|
+
* Returns a paginated list of the organization\'s replays, newest first, each with its video and the name of the session, event or group it is attached to, filterable by session, event, group or video; requires read permission on streams.
|
|
84602
|
+
* @summary List replays
|
|
84603
|
+
* @param {string} [sessionId] Filter by sessionId
|
|
84604
|
+
* @param {string} [eventId] Filter by eventId
|
|
84605
|
+
* @param {string} [groupId] Filter by groupId
|
|
84606
|
+
* @param {string} [videoId] Filter by videoId
|
|
84607
|
+
* @param {number} [page] Page number
|
|
84608
|
+
* @param {number} [pageSize] Number of items per page
|
|
84609
|
+
* @param {string} [orderBy] Field to order by
|
|
84610
|
+
* @param {string} [search] Search query
|
|
84611
|
+
* @param {*} [options] Override http request option.
|
|
84612
|
+
* @throws {RequiredError}
|
|
84613
|
+
*/
|
|
84614
|
+
getReplays(sessionId?: string, eventId?: string, groupId?: string, videoId?: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetReplays200Response>>;
|
|
84615
|
+
/**
|
|
84616
|
+
* Moves a replay to exactly one other session, event or group in the organization; the video itself is unchanged. Requires update permission on streams.
|
|
84617
|
+
* @summary Move a replay
|
|
84618
|
+
* @param {string} replayId The replay identifier
|
|
84619
|
+
* @param {ReplayUpdateInputs} replayUpdateInputs
|
|
84620
|
+
* @param {*} [options] Override http request option.
|
|
84621
|
+
* @throws {RequiredError}
|
|
84622
|
+
*/
|
|
84623
|
+
updateReplay(replayId: string, replayUpdateInputs: ReplayUpdateInputs, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateReplay200Response>>;
|
|
84624
|
+
};
|
|
84625
|
+
/**
|
|
84626
|
+
* StreamsReplaysApi - factory interface
|
|
84627
|
+
*/
|
|
84628
|
+
export declare const StreamsReplaysApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
84629
|
+
/**
|
|
84630
|
+
* Attaches a video from storage as a replay to exactly one session, event or group; a video can be a replay on several targets, but only once on each (a repeat returns 400 \"Replay already exists\"). Requires create permission on streams.
|
|
84631
|
+
* @summary Add a video as a replay
|
|
84632
|
+
* @param {StreamsReplaysApiCreateReplayRequest} requestParameters Request parameters.
|
|
84633
|
+
* @param {*} [options] Override http request option.
|
|
84634
|
+
* @throws {RequiredError}
|
|
84635
|
+
*/
|
|
84636
|
+
createReplay(requestParameters: StreamsReplaysApiCreateReplayRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateReplay200Response>;
|
|
84637
|
+
/**
|
|
84638
|
+
* Detaches a replay from its session, event or group; the video stays in storage. Requires delete permission on streams.
|
|
84639
|
+
* @summary Remove a replay
|
|
84640
|
+
* @param {StreamsReplaysApiDeleteReplayRequest} requestParameters Request parameters.
|
|
84641
|
+
* @param {*} [options] Override http request option.
|
|
84642
|
+
* @throws {RequiredError}
|
|
84643
|
+
*/
|
|
84644
|
+
deleteReplay(requestParameters: StreamsReplaysApiDeleteReplayRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateAccountInvitations200Response>;
|
|
84645
|
+
/**
|
|
84646
|
+
* Returns a single replay with its video and the name of the session, event or group it is attached to; requires read permission on streams.
|
|
84647
|
+
* @summary Get a replay
|
|
84648
|
+
* @param {StreamsReplaysApiGetReplayRequest} requestParameters Request parameters.
|
|
84649
|
+
* @param {*} [options] Override http request option.
|
|
84650
|
+
* @throws {RequiredError}
|
|
84651
|
+
*/
|
|
84652
|
+
getReplay(requestParameters: StreamsReplaysApiGetReplayRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateReplay200Response>;
|
|
84653
|
+
/**
|
|
84654
|
+
* Returns a paginated list of the organization\'s replays, newest first, each with its video and the name of the session, event or group it is attached to, filterable by session, event, group or video; requires read permission on streams.
|
|
84655
|
+
* @summary List replays
|
|
84656
|
+
* @param {StreamsReplaysApiGetReplaysRequest} requestParameters Request parameters.
|
|
84657
|
+
* @param {*} [options] Override http request option.
|
|
84658
|
+
* @throws {RequiredError}
|
|
84659
|
+
*/
|
|
84660
|
+
getReplays(requestParameters?: StreamsReplaysApiGetReplaysRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetReplays200Response>;
|
|
84661
|
+
/**
|
|
84662
|
+
* Moves a replay to exactly one other session, event or group in the organization; the video itself is unchanged. Requires update permission on streams.
|
|
84663
|
+
* @summary Move a replay
|
|
84664
|
+
* @param {StreamsReplaysApiUpdateReplayRequest} requestParameters Request parameters.
|
|
84665
|
+
* @param {*} [options] Override http request option.
|
|
84666
|
+
* @throws {RequiredError}
|
|
84667
|
+
*/
|
|
84668
|
+
updateReplay(requestParameters: StreamsReplaysApiUpdateReplayRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateReplay200Response>;
|
|
84669
|
+
};
|
|
84670
|
+
/**
|
|
84671
|
+
* Request parameters for createReplay operation in StreamsReplaysApi.
|
|
84672
|
+
*/
|
|
84673
|
+
export interface StreamsReplaysApiCreateReplayRequest {
|
|
84674
|
+
readonly replayCreateInputs: ReplayCreateInputs;
|
|
84675
|
+
}
|
|
84676
|
+
/**
|
|
84677
|
+
* Request parameters for deleteReplay operation in StreamsReplaysApi.
|
|
84678
|
+
*/
|
|
84679
|
+
export interface StreamsReplaysApiDeleteReplayRequest {
|
|
84680
|
+
/**
|
|
84681
|
+
* The replay identifier
|
|
84682
|
+
*/
|
|
84683
|
+
readonly replayId: string;
|
|
84684
|
+
}
|
|
84685
|
+
/**
|
|
84686
|
+
* Request parameters for getReplay operation in StreamsReplaysApi.
|
|
84687
|
+
*/
|
|
84688
|
+
export interface StreamsReplaysApiGetReplayRequest {
|
|
84689
|
+
/**
|
|
84690
|
+
* The replay identifier
|
|
84691
|
+
*/
|
|
84692
|
+
readonly replayId: string;
|
|
84693
|
+
}
|
|
84694
|
+
/**
|
|
84695
|
+
* Request parameters for getReplays operation in StreamsReplaysApi.
|
|
84696
|
+
*/
|
|
84697
|
+
export interface StreamsReplaysApiGetReplaysRequest {
|
|
84698
|
+
/**
|
|
84699
|
+
* Filter by sessionId
|
|
84700
|
+
*/
|
|
84701
|
+
readonly sessionId?: string;
|
|
84702
|
+
/**
|
|
84703
|
+
* Filter by eventId
|
|
84704
|
+
*/
|
|
84705
|
+
readonly eventId?: string;
|
|
84706
|
+
/**
|
|
84707
|
+
* Filter by groupId
|
|
84708
|
+
*/
|
|
84709
|
+
readonly groupId?: string;
|
|
84710
|
+
/**
|
|
84711
|
+
* Filter by videoId
|
|
84712
|
+
*/
|
|
84713
|
+
readonly videoId?: string;
|
|
84714
|
+
/**
|
|
84715
|
+
* Page number
|
|
84716
|
+
*/
|
|
84717
|
+
readonly page?: number;
|
|
84718
|
+
/**
|
|
84719
|
+
* Number of items per page
|
|
84720
|
+
*/
|
|
84721
|
+
readonly pageSize?: number;
|
|
84722
|
+
/**
|
|
84723
|
+
* Field to order by
|
|
84724
|
+
*/
|
|
84725
|
+
readonly orderBy?: string;
|
|
84726
|
+
/**
|
|
84727
|
+
* Search query
|
|
84728
|
+
*/
|
|
84729
|
+
readonly search?: string;
|
|
84730
|
+
}
|
|
84731
|
+
/**
|
|
84732
|
+
* Request parameters for updateReplay operation in StreamsReplaysApi.
|
|
84733
|
+
*/
|
|
84734
|
+
export interface StreamsReplaysApiUpdateReplayRequest {
|
|
84735
|
+
/**
|
|
84736
|
+
* The replay identifier
|
|
84737
|
+
*/
|
|
84738
|
+
readonly replayId: string;
|
|
84739
|
+
readonly replayUpdateInputs: ReplayUpdateInputs;
|
|
84740
|
+
}
|
|
84741
|
+
/**
|
|
84742
|
+
* StreamsReplaysApi - object-oriented interface
|
|
84743
|
+
*/
|
|
84744
|
+
export declare class StreamsReplaysApi extends BaseAPI {
|
|
84745
|
+
/**
|
|
84746
|
+
* Attaches a video from storage as a replay to exactly one session, event or group; a video can be a replay on several targets, but only once on each (a repeat returns 400 \"Replay already exists\"). Requires create permission on streams.
|
|
84747
|
+
* @summary Add a video as a replay
|
|
84748
|
+
* @param {StreamsReplaysApiCreateReplayRequest} requestParameters Request parameters.
|
|
84749
|
+
* @param {*} [options] Override http request option.
|
|
84750
|
+
* @throws {RequiredError}
|
|
84751
|
+
*/
|
|
84752
|
+
createReplay(requestParameters: StreamsReplaysApiCreateReplayRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateReplay200Response, any, {}, any>>;
|
|
84753
|
+
/**
|
|
84754
|
+
* Detaches a replay from its session, event or group; the video stays in storage. Requires delete permission on streams.
|
|
84755
|
+
* @summary Remove a replay
|
|
84756
|
+
* @param {StreamsReplaysApiDeleteReplayRequest} requestParameters Request parameters.
|
|
84757
|
+
* @param {*} [options] Override http request option.
|
|
84758
|
+
* @throws {RequiredError}
|
|
84759
|
+
*/
|
|
84760
|
+
deleteReplay(requestParameters: StreamsReplaysApiDeleteReplayRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateAccountInvitations200Response, any, {}, any>>;
|
|
84761
|
+
/**
|
|
84762
|
+
* Returns a single replay with its video and the name of the session, event or group it is attached to; requires read permission on streams.
|
|
84763
|
+
* @summary Get a replay
|
|
84764
|
+
* @param {StreamsReplaysApiGetReplayRequest} requestParameters Request parameters.
|
|
84765
|
+
* @param {*} [options] Override http request option.
|
|
84766
|
+
* @throws {RequiredError}
|
|
84767
|
+
*/
|
|
84768
|
+
getReplay(requestParameters: StreamsReplaysApiGetReplayRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateReplay200Response, any, {}, any>>;
|
|
84769
|
+
/**
|
|
84770
|
+
* Returns a paginated list of the organization\'s replays, newest first, each with its video and the name of the session, event or group it is attached to, filterable by session, event, group or video; requires read permission on streams.
|
|
84771
|
+
* @summary List replays
|
|
84772
|
+
* @param {StreamsReplaysApiGetReplaysRequest} requestParameters Request parameters.
|
|
84773
|
+
* @param {*} [options] Override http request option.
|
|
84774
|
+
* @throws {RequiredError}
|
|
84775
|
+
*/
|
|
84776
|
+
getReplays(requestParameters?: StreamsReplaysApiGetReplaysRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetReplays200Response, any, {}, any>>;
|
|
84777
|
+
/**
|
|
84778
|
+
* Moves a replay to exactly one other session, event or group in the organization; the video itself is unchanged. Requires update permission on streams.
|
|
84779
|
+
* @summary Move a replay
|
|
84780
|
+
* @param {StreamsReplaysApiUpdateReplayRequest} requestParameters Request parameters.
|
|
84781
|
+
* @param {*} [options] Override http request option.
|
|
84782
|
+
* @throws {RequiredError}
|
|
84783
|
+
*/
|
|
84784
|
+
updateReplay(requestParameters: StreamsReplaysApiUpdateReplayRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateReplay200Response, any, {}, any>>;
|
|
84785
|
+
}
|
|
83867
84786
|
/**
|
|
83868
84787
|
* StreamsSessionsApi - axios parameter creator
|
|
83869
84788
|
*/
|