@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/api.ts
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Connected Admin API
|
|
5
5
|
* The Admin API allows you to manage your Connected community programmatically.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 16.
|
|
7
|
+
* The version of the OpenAPI document: 16.15.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -2858,6 +2858,23 @@ export interface BaseRegistrationSectionQuestion {
|
|
|
2858
2858
|
'question': BaseRegistrationQuestion;
|
|
2859
2859
|
'sortOrder': number;
|
|
2860
2860
|
}
|
|
2861
|
+
export interface BaseReplay {
|
|
2862
|
+
'id': string;
|
|
2863
|
+
'videoId': string;
|
|
2864
|
+
'sessionId': string | null;
|
|
2865
|
+
'eventId': string | null;
|
|
2866
|
+
'groupId': string | null;
|
|
2867
|
+
'session': BaseReplaySession | null;
|
|
2868
|
+
'event': VideoAllOfStream | null;
|
|
2869
|
+
'group': VideoAllOfStream | null;
|
|
2870
|
+
'createdAt': string;
|
|
2871
|
+
'updatedAt': string;
|
|
2872
|
+
}
|
|
2873
|
+
export interface BaseReplaySession {
|
|
2874
|
+
'id': string;
|
|
2875
|
+
'name': string;
|
|
2876
|
+
'eventId': string;
|
|
2877
|
+
}
|
|
2861
2878
|
export interface BaseReportExport {
|
|
2862
2879
|
'id': string;
|
|
2863
2880
|
'status': ExportStatus;
|
|
@@ -3017,6 +3034,7 @@ export interface BaseStreamInput {
|
|
|
3017
3034
|
'webRTC': boolean;
|
|
3018
3035
|
'webRTCPlaybackUrl': string | null;
|
|
3019
3036
|
'dvrEnabled': boolean;
|
|
3037
|
+
'allowReplays': boolean;
|
|
3020
3038
|
'connected': boolean;
|
|
3021
3039
|
}
|
|
3022
3040
|
export interface BaseStreamSession {
|
|
@@ -3304,6 +3322,8 @@ export interface BaseVideo {
|
|
|
3304
3322
|
'previewUrl': string | null;
|
|
3305
3323
|
'readyToStream': boolean;
|
|
3306
3324
|
'duration': number | null;
|
|
3325
|
+
'streamId': string | null;
|
|
3326
|
+
'streamSessionId': string | null;
|
|
3307
3327
|
'createdAt': string;
|
|
3308
3328
|
}
|
|
3309
3329
|
|
|
@@ -5054,6 +5074,16 @@ export enum CreatePreset200ResponseStatusEnum {
|
|
|
5054
5074
|
Ok = 'ok'
|
|
5055
5075
|
}
|
|
5056
5076
|
|
|
5077
|
+
export interface CreateReplay200Response {
|
|
5078
|
+
'status': CreateReplay200ResponseStatusEnum;
|
|
5079
|
+
'message': string;
|
|
5080
|
+
'data': Replay;
|
|
5081
|
+
}
|
|
5082
|
+
|
|
5083
|
+
export enum CreateReplay200ResponseStatusEnum {
|
|
5084
|
+
Ok = 'ok'
|
|
5085
|
+
}
|
|
5086
|
+
|
|
5057
5087
|
export interface CreateRoom200Response {
|
|
5058
5088
|
'status': CreateRoom200ResponseStatusEnum;
|
|
5059
5089
|
'message': string;
|
|
@@ -6800,6 +6830,8 @@ export interface EventSession {
|
|
|
6800
6830
|
'allowedTiers': Array<BaseTier>;
|
|
6801
6831
|
'continuousScanning': boolean;
|
|
6802
6832
|
'scanType': OnSiteScanType;
|
|
6833
|
+
'livestreamed': boolean;
|
|
6834
|
+
'_count'?: EventSessionAllOfCount;
|
|
6803
6835
|
}
|
|
6804
6836
|
|
|
6805
6837
|
|
|
@@ -6821,6 +6853,9 @@ export interface EventSessionAccessUpdateInputs {
|
|
|
6821
6853
|
}
|
|
6822
6854
|
|
|
6823
6855
|
|
|
6856
|
+
export interface EventSessionAllOfCount {
|
|
6857
|
+
'replays': number;
|
|
6858
|
+
}
|
|
6824
6859
|
export interface EventSessionCloneOptions {
|
|
6825
6860
|
'name'?: string;
|
|
6826
6861
|
'startTime'?: string;
|
|
@@ -6839,6 +6874,7 @@ export interface EventSessionCreateInputs {
|
|
|
6839
6874
|
'featured'?: boolean;
|
|
6840
6875
|
'sortOrder'?: number | null;
|
|
6841
6876
|
'registrationEnabled'?: boolean;
|
|
6877
|
+
'livestreamed'?: boolean;
|
|
6842
6878
|
'onsiteRegistration'?: boolean;
|
|
6843
6879
|
'skipOnsiteValidations'?: boolean;
|
|
6844
6880
|
'allowQuickRegister'?: boolean;
|
|
@@ -7214,6 +7250,7 @@ export interface EventSessionUpdateInputs {
|
|
|
7214
7250
|
'featured'?: boolean;
|
|
7215
7251
|
'sortOrder'?: number | null;
|
|
7216
7252
|
'registrationEnabled'?: boolean;
|
|
7253
|
+
'livestreamed'?: boolean;
|
|
7217
7254
|
'onsiteRegistration'?: boolean;
|
|
7218
7255
|
'skipOnsiteValidations'?: boolean;
|
|
7219
7256
|
'allowQuickRegister'?: boolean;
|
|
@@ -10788,6 +10825,17 @@ export enum GetPushDevice200ResponseStatusEnum {
|
|
|
10788
10825
|
Ok = 'ok'
|
|
10789
10826
|
}
|
|
10790
10827
|
|
|
10828
|
+
export interface GetReplays200Response {
|
|
10829
|
+
'status': GetReplays200ResponseStatusEnum;
|
|
10830
|
+
'message': string;
|
|
10831
|
+
'data': Array<Replay>;
|
|
10832
|
+
'count'?: number;
|
|
10833
|
+
}
|
|
10834
|
+
|
|
10835
|
+
export enum GetReplays200ResponseStatusEnum {
|
|
10836
|
+
Ok = 'ok'
|
|
10837
|
+
}
|
|
10838
|
+
|
|
10791
10839
|
export interface GetReport200Response {
|
|
10792
10840
|
'status': GetReport200ResponseStatusEnum;
|
|
10793
10841
|
'message': string;
|
|
@@ -14373,6 +14421,50 @@ export enum ReorderTiers200ResponseStatusEnum {
|
|
|
14373
14421
|
export interface ReorderTiersRequest {
|
|
14374
14422
|
'tierIds': Array<string>;
|
|
14375
14423
|
}
|
|
14424
|
+
export interface Replay {
|
|
14425
|
+
'id': string;
|
|
14426
|
+
'videoId': string;
|
|
14427
|
+
'sessionId': string | null;
|
|
14428
|
+
'eventId': string | null;
|
|
14429
|
+
'groupId': string | null;
|
|
14430
|
+
'session': BaseReplaySession | null;
|
|
14431
|
+
'event': VideoAllOfStream | null;
|
|
14432
|
+
'group': VideoAllOfStream | null;
|
|
14433
|
+
'createdAt': string;
|
|
14434
|
+
'updatedAt': string;
|
|
14435
|
+
'video': ReplayVideo;
|
|
14436
|
+
}
|
|
14437
|
+
export interface ReplayCreateInputs {
|
|
14438
|
+
'videoId': string;
|
|
14439
|
+
'sessionId'?: string;
|
|
14440
|
+
'eventId'?: string;
|
|
14441
|
+
'groupId'?: string;
|
|
14442
|
+
}
|
|
14443
|
+
export interface ReplayUpdateInputs {
|
|
14444
|
+
'sessionId'?: string;
|
|
14445
|
+
'eventId'?: string;
|
|
14446
|
+
'groupId'?: string;
|
|
14447
|
+
}
|
|
14448
|
+
export interface ReplayVideo {
|
|
14449
|
+
'id': string;
|
|
14450
|
+
'name': string;
|
|
14451
|
+
'status': string;
|
|
14452
|
+
'source': VideoSource;
|
|
14453
|
+
'width': number;
|
|
14454
|
+
'height': number;
|
|
14455
|
+
'thumbnailUrl': string | null;
|
|
14456
|
+
'previewUrl': string | null;
|
|
14457
|
+
'readyToStream': boolean;
|
|
14458
|
+
'duration': number | null;
|
|
14459
|
+
'streamId': string | null;
|
|
14460
|
+
'streamSessionId': string | null;
|
|
14461
|
+
'createdAt': string;
|
|
14462
|
+
'hlsUrl': string | null;
|
|
14463
|
+
'stream': VideoAllOfStream | null;
|
|
14464
|
+
'streamSession': VideoAllOfStreamSession | null;
|
|
14465
|
+
}
|
|
14466
|
+
|
|
14467
|
+
|
|
14376
14468
|
export interface ReportExport {
|
|
14377
14469
|
'id': string;
|
|
14378
14470
|
'status': ExportStatus;
|
|
@@ -15199,17 +15291,21 @@ export interface StreamInput {
|
|
|
15199
15291
|
'webRTC': boolean;
|
|
15200
15292
|
'webRTCPlaybackUrl': string | null;
|
|
15201
15293
|
'dvrEnabled': boolean;
|
|
15294
|
+
'allowReplays': boolean;
|
|
15202
15295
|
'connected': boolean;
|
|
15203
15296
|
'event': BaseEvent | null;
|
|
15204
15297
|
'session': BaseEventSession | null;
|
|
15205
15298
|
'group': BaseGroup | null;
|
|
15206
15299
|
'meetingId': string | null;
|
|
15207
15300
|
'meeting': BaseMeeting | null;
|
|
15301
|
+
'activityId': string | null;
|
|
15302
|
+
'activity': BaseActivity | null;
|
|
15208
15303
|
'streamInputId': string | null;
|
|
15209
15304
|
'streamInput': BaseStreamInput | null;
|
|
15210
15305
|
'details'?: StreamInputDetails;
|
|
15211
15306
|
'sortOrder': number;
|
|
15212
15307
|
'createdAt': string;
|
|
15308
|
+
'lastStreamSessionStartedAt'?: string | null;
|
|
15213
15309
|
}
|
|
15214
15310
|
export interface StreamInputCreateInputs {
|
|
15215
15311
|
'name': string;
|
|
@@ -15226,6 +15322,7 @@ export interface StreamInputCreateInputs {
|
|
|
15226
15322
|
'locale'?: string | null;
|
|
15227
15323
|
'webRTC'?: boolean;
|
|
15228
15324
|
'dvrEnabled'?: boolean;
|
|
15325
|
+
'allowReplays'?: boolean;
|
|
15229
15326
|
}
|
|
15230
15327
|
export interface StreamInputDetails {
|
|
15231
15328
|
'uid': string;
|
|
@@ -15295,6 +15392,7 @@ export interface StreamInputUpdateInputs {
|
|
|
15295
15392
|
'locale'?: string | null;
|
|
15296
15393
|
'webRTC'?: boolean;
|
|
15297
15394
|
'dvrEnabled'?: boolean;
|
|
15395
|
+
'allowReplays'?: boolean;
|
|
15298
15396
|
}
|
|
15299
15397
|
export interface StreamOutputCreateInputs {
|
|
15300
15398
|
'enabled': boolean;
|
|
@@ -16646,14 +16744,27 @@ export interface Video {
|
|
|
16646
16744
|
'previewUrl': string | null;
|
|
16647
16745
|
'readyToStream': boolean;
|
|
16648
16746
|
'duration': number | null;
|
|
16747
|
+
'streamId': string | null;
|
|
16748
|
+
'streamSessionId': string | null;
|
|
16649
16749
|
'createdAt': string;
|
|
16650
16750
|
'downloadUrl': string | null;
|
|
16651
16751
|
'hlsUrl': string | null;
|
|
16652
16752
|
'dashUrl': string | null;
|
|
16653
16753
|
'thumbnailPct': number | null;
|
|
16754
|
+
'stream': VideoAllOfStream | null;
|
|
16755
|
+
'streamSession': VideoAllOfStreamSession | null;
|
|
16756
|
+
'replays': Array<BaseReplay>;
|
|
16654
16757
|
}
|
|
16655
16758
|
|
|
16656
16759
|
|
|
16760
|
+
export interface VideoAllOfStream {
|
|
16761
|
+
'id': string;
|
|
16762
|
+
'name': string;
|
|
16763
|
+
}
|
|
16764
|
+
export interface VideoAllOfStreamSession {
|
|
16765
|
+
'id': string;
|
|
16766
|
+
'startedAt': string;
|
|
16767
|
+
}
|
|
16657
16768
|
export interface VideoCaption {
|
|
16658
16769
|
'language': string;
|
|
16659
16770
|
'label': string;
|
|
@@ -43091,34 +43202,30 @@ export enum GetContentsTypeEnum {
|
|
|
43091
43202
|
|
|
43092
43203
|
|
|
43093
43204
|
/**
|
|
43094
|
-
*
|
|
43205
|
+
* ChannelsInterestsApi - axios parameter creator
|
|
43095
43206
|
*/
|
|
43096
|
-
export const
|
|
43207
|
+
export const ChannelsInterestsApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
43097
43208
|
return {
|
|
43098
43209
|
/**
|
|
43099
|
-
*
|
|
43100
|
-
* @summary
|
|
43210
|
+
* 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.
|
|
43211
|
+
* @summary Add an interest to a content item
|
|
43101
43212
|
* @param {string} channelId The channel identifier
|
|
43102
43213
|
* @param {string} contentId The content identifier
|
|
43103
|
-
* @param {string}
|
|
43104
|
-
* @param {string} locale The locale identifier
|
|
43214
|
+
* @param {string} interestId The interest identifier
|
|
43105
43215
|
* @param {*} [options] Override http request option.
|
|
43106
43216
|
* @throws {RequiredError}
|
|
43107
43217
|
*/
|
|
43108
|
-
|
|
43218
|
+
addChannelContentInterest: async (channelId: string, contentId: string, interestId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
43109
43219
|
// verify required parameter 'channelId' is not null or undefined
|
|
43110
|
-
assertParamExists('
|
|
43220
|
+
assertParamExists('addChannelContentInterest', 'channelId', channelId)
|
|
43111
43221
|
// verify required parameter 'contentId' is not null or undefined
|
|
43112
|
-
assertParamExists('
|
|
43113
|
-
// verify required parameter '
|
|
43114
|
-
assertParamExists('
|
|
43115
|
-
|
|
43116
|
-
assertParamExists('deleteChannelContentGuestTranslation', 'locale', locale)
|
|
43117
|
-
const localVarPath = `/channels/{channelId}/contents/{contentId}/guests/{guestId}/translations/{locale}`
|
|
43222
|
+
assertParamExists('addChannelContentInterest', 'contentId', contentId)
|
|
43223
|
+
// verify required parameter 'interestId' is not null or undefined
|
|
43224
|
+
assertParamExists('addChannelContentInterest', 'interestId', interestId)
|
|
43225
|
+
const localVarPath = `/channels/{channelId}/contents/{contentId}/interests/{interestId}`
|
|
43118
43226
|
.replace('{channelId}', encodeURIComponent(String(channelId)))
|
|
43119
43227
|
.replace('{contentId}', encodeURIComponent(String(contentId)))
|
|
43120
|
-
.replace('{
|
|
43121
|
-
.replace('{locale}', encodeURIComponent(String(locale)));
|
|
43228
|
+
.replace('{interestId}', encodeURIComponent(String(interestId)));
|
|
43122
43229
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
43123
43230
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
43124
43231
|
let baseOptions;
|
|
@@ -43126,7 +43233,7 @@ export const ChannelsTranslationsApiAxiosParamCreator = function (configuration?
|
|
|
43126
43233
|
baseOptions = configuration.baseOptions;
|
|
43127
43234
|
}
|
|
43128
43235
|
|
|
43129
|
-
const localVarRequestOptions = { method: '
|
|
43236
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
43130
43237
|
const localVarHeaderParameter = {} as any;
|
|
43131
43238
|
const localVarQueryParameter = {} as any;
|
|
43132
43239
|
|
|
@@ -43148,25 +43255,193 @@ export const ChannelsTranslationsApiAxiosParamCreator = function (configuration?
|
|
|
43148
43255
|
};
|
|
43149
43256
|
},
|
|
43150
43257
|
/**
|
|
43151
|
-
*
|
|
43152
|
-
* @summary
|
|
43258
|
+
* 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.
|
|
43259
|
+
* @summary Add an interest to a channel
|
|
43260
|
+
* @param {string} channelId The channel identifier
|
|
43261
|
+
* @param {string} interestId The interest identifier
|
|
43262
|
+
* @param {*} [options] Override http request option.
|
|
43263
|
+
* @throws {RequiredError}
|
|
43264
|
+
*/
|
|
43265
|
+
addChannelInterest: async (channelId: string, interestId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
43266
|
+
// verify required parameter 'channelId' is not null or undefined
|
|
43267
|
+
assertParamExists('addChannelInterest', 'channelId', channelId)
|
|
43268
|
+
// verify required parameter 'interestId' is not null or undefined
|
|
43269
|
+
assertParamExists('addChannelInterest', 'interestId', interestId)
|
|
43270
|
+
const localVarPath = `/channels/{channelId}/interests/{interestId}`
|
|
43271
|
+
.replace('{channelId}', encodeURIComponent(String(channelId)))
|
|
43272
|
+
.replace('{interestId}', encodeURIComponent(String(interestId)));
|
|
43273
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
43274
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
43275
|
+
let baseOptions;
|
|
43276
|
+
if (configuration) {
|
|
43277
|
+
baseOptions = configuration.baseOptions;
|
|
43278
|
+
}
|
|
43279
|
+
|
|
43280
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
43281
|
+
const localVarHeaderParameter = {} as any;
|
|
43282
|
+
const localVarQueryParameter = {} as any;
|
|
43283
|
+
|
|
43284
|
+
// authentication ApiKeyAuth required
|
|
43285
|
+
await setApiKeyToObject(localVarHeaderParameter, "api-key", configuration)
|
|
43286
|
+
|
|
43287
|
+
// authentication OrganizationId required
|
|
43288
|
+
await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
|
|
43289
|
+
|
|
43290
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
43291
|
+
|
|
43292
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
43293
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
43294
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
43295
|
+
|
|
43296
|
+
return {
|
|
43297
|
+
url: toPathString(localVarUrlObj),
|
|
43298
|
+
options: localVarRequestOptions,
|
|
43299
|
+
};
|
|
43300
|
+
},
|
|
43301
|
+
/**
|
|
43302
|
+
* 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.
|
|
43303
|
+
* @summary List a content item\'s interests
|
|
43153
43304
|
* @param {string} channelId The channel identifier
|
|
43154
43305
|
* @param {string} contentId The content identifier
|
|
43155
|
-
* @param {
|
|
43306
|
+
* @param {number} [page] Page number
|
|
43307
|
+
* @param {number} [pageSize] Number of items per page
|
|
43308
|
+
* @param {string} [orderBy] Field to order by
|
|
43309
|
+
* @param {string} [search] Search query
|
|
43156
43310
|
* @param {*} [options] Override http request option.
|
|
43157
43311
|
* @throws {RequiredError}
|
|
43158
43312
|
*/
|
|
43159
|
-
|
|
43313
|
+
getChannelContentInterests: async (channelId: string, contentId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
43160
43314
|
// verify required parameter 'channelId' is not null or undefined
|
|
43161
|
-
assertParamExists('
|
|
43315
|
+
assertParamExists('getChannelContentInterests', 'channelId', channelId)
|
|
43162
43316
|
// verify required parameter 'contentId' is not null or undefined
|
|
43163
|
-
assertParamExists('
|
|
43164
|
-
|
|
43165
|
-
|
|
43166
|
-
|
|
43317
|
+
assertParamExists('getChannelContentInterests', 'contentId', contentId)
|
|
43318
|
+
const localVarPath = `/channels/{channelId}/contents/{contentId}/interests`
|
|
43319
|
+
.replace('{channelId}', encodeURIComponent(String(channelId)))
|
|
43320
|
+
.replace('{contentId}', encodeURIComponent(String(contentId)));
|
|
43321
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
43322
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
43323
|
+
let baseOptions;
|
|
43324
|
+
if (configuration) {
|
|
43325
|
+
baseOptions = configuration.baseOptions;
|
|
43326
|
+
}
|
|
43327
|
+
|
|
43328
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
43329
|
+
const localVarHeaderParameter = {} as any;
|
|
43330
|
+
const localVarQueryParameter = {} as any;
|
|
43331
|
+
|
|
43332
|
+
// authentication ApiKeyAuth required
|
|
43333
|
+
await setApiKeyToObject(localVarHeaderParameter, "api-key", configuration)
|
|
43334
|
+
|
|
43335
|
+
// authentication OrganizationId required
|
|
43336
|
+
await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
|
|
43337
|
+
|
|
43338
|
+
if (page !== undefined) {
|
|
43339
|
+
localVarQueryParameter['page'] = page;
|
|
43340
|
+
}
|
|
43341
|
+
|
|
43342
|
+
if (pageSize !== undefined) {
|
|
43343
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
43344
|
+
}
|
|
43345
|
+
|
|
43346
|
+
if (orderBy !== undefined) {
|
|
43347
|
+
localVarQueryParameter['orderBy'] = orderBy;
|
|
43348
|
+
}
|
|
43349
|
+
|
|
43350
|
+
if (search !== undefined) {
|
|
43351
|
+
localVarQueryParameter['search'] = search;
|
|
43352
|
+
}
|
|
43353
|
+
|
|
43354
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
43355
|
+
|
|
43356
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
43357
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
43358
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
43359
|
+
|
|
43360
|
+
return {
|
|
43361
|
+
url: toPathString(localVarUrlObj),
|
|
43362
|
+
options: localVarRequestOptions,
|
|
43363
|
+
};
|
|
43364
|
+
},
|
|
43365
|
+
/**
|
|
43366
|
+
* 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.
|
|
43367
|
+
* @summary List a channel\'s interests
|
|
43368
|
+
* @param {string} channelId The channel identifier
|
|
43369
|
+
* @param {number} [page] Page number
|
|
43370
|
+
* @param {number} [pageSize] Number of items per page
|
|
43371
|
+
* @param {string} [orderBy] Field to order by
|
|
43372
|
+
* @param {string} [search] Search query
|
|
43373
|
+
* @param {*} [options] Override http request option.
|
|
43374
|
+
* @throws {RequiredError}
|
|
43375
|
+
*/
|
|
43376
|
+
getChannelInterests: async (channelId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
43377
|
+
// verify required parameter 'channelId' is not null or undefined
|
|
43378
|
+
assertParamExists('getChannelInterests', 'channelId', channelId)
|
|
43379
|
+
const localVarPath = `/channels/{channelId}/interests`
|
|
43380
|
+
.replace('{channelId}', encodeURIComponent(String(channelId)));
|
|
43381
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
43382
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
43383
|
+
let baseOptions;
|
|
43384
|
+
if (configuration) {
|
|
43385
|
+
baseOptions = configuration.baseOptions;
|
|
43386
|
+
}
|
|
43387
|
+
|
|
43388
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
43389
|
+
const localVarHeaderParameter = {} as any;
|
|
43390
|
+
const localVarQueryParameter = {} as any;
|
|
43391
|
+
|
|
43392
|
+
// authentication ApiKeyAuth required
|
|
43393
|
+
await setApiKeyToObject(localVarHeaderParameter, "api-key", configuration)
|
|
43394
|
+
|
|
43395
|
+
// authentication OrganizationId required
|
|
43396
|
+
await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
|
|
43397
|
+
|
|
43398
|
+
if (page !== undefined) {
|
|
43399
|
+
localVarQueryParameter['page'] = page;
|
|
43400
|
+
}
|
|
43401
|
+
|
|
43402
|
+
if (pageSize !== undefined) {
|
|
43403
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
43404
|
+
}
|
|
43405
|
+
|
|
43406
|
+
if (orderBy !== undefined) {
|
|
43407
|
+
localVarQueryParameter['orderBy'] = orderBy;
|
|
43408
|
+
}
|
|
43409
|
+
|
|
43410
|
+
if (search !== undefined) {
|
|
43411
|
+
localVarQueryParameter['search'] = search;
|
|
43412
|
+
}
|
|
43413
|
+
|
|
43414
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
43415
|
+
|
|
43416
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
43417
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
43418
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
43419
|
+
|
|
43420
|
+
return {
|
|
43421
|
+
url: toPathString(localVarUrlObj),
|
|
43422
|
+
options: localVarRequestOptions,
|
|
43423
|
+
};
|
|
43424
|
+
},
|
|
43425
|
+
/**
|
|
43426
|
+
* 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.
|
|
43427
|
+
* @summary Remove an interest from a content item
|
|
43428
|
+
* @param {string} channelId The channel identifier
|
|
43429
|
+
* @param {string} contentId The content identifier
|
|
43430
|
+
* @param {string} interestId The interest identifier
|
|
43431
|
+
* @param {*} [options] Override http request option.
|
|
43432
|
+
* @throws {RequiredError}
|
|
43433
|
+
*/
|
|
43434
|
+
removeChannelContentInterest: async (channelId: string, contentId: string, interestId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
43435
|
+
// verify required parameter 'channelId' is not null or undefined
|
|
43436
|
+
assertParamExists('removeChannelContentInterest', 'channelId', channelId)
|
|
43437
|
+
// verify required parameter 'contentId' is not null or undefined
|
|
43438
|
+
assertParamExists('removeChannelContentInterest', 'contentId', contentId)
|
|
43439
|
+
// verify required parameter 'interestId' is not null or undefined
|
|
43440
|
+
assertParamExists('removeChannelContentInterest', 'interestId', interestId)
|
|
43441
|
+
const localVarPath = `/channels/{channelId}/contents/{contentId}/interests/{interestId}`
|
|
43167
43442
|
.replace('{channelId}', encodeURIComponent(String(channelId)))
|
|
43168
43443
|
.replace('{contentId}', encodeURIComponent(String(contentId)))
|
|
43169
|
-
.replace('{
|
|
43444
|
+
.replace('{interestId}', encodeURIComponent(String(interestId)));
|
|
43170
43445
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
43171
43446
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
43172
43447
|
let baseOptions;
|
|
@@ -43196,21 +43471,552 @@ export const ChannelsTranslationsApiAxiosParamCreator = function (configuration?
|
|
|
43196
43471
|
};
|
|
43197
43472
|
},
|
|
43198
43473
|
/**
|
|
43199
|
-
* Removes
|
|
43200
|
-
* @summary
|
|
43474
|
+
* 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.
|
|
43475
|
+
* @summary Remove an interest from a channel
|
|
43201
43476
|
* @param {string} channelId The channel identifier
|
|
43202
|
-
* @param {string}
|
|
43477
|
+
* @param {string} interestId The interest identifier
|
|
43203
43478
|
* @param {*} [options] Override http request option.
|
|
43204
43479
|
* @throws {RequiredError}
|
|
43205
43480
|
*/
|
|
43206
|
-
|
|
43481
|
+
removeChannelInterest: async (channelId: string, interestId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
43207
43482
|
// verify required parameter 'channelId' is not null or undefined
|
|
43208
|
-
assertParamExists('
|
|
43209
|
-
// verify required parameter '
|
|
43210
|
-
assertParamExists('
|
|
43211
|
-
const localVarPath = `/channels/{channelId}/
|
|
43483
|
+
assertParamExists('removeChannelInterest', 'channelId', channelId)
|
|
43484
|
+
// verify required parameter 'interestId' is not null or undefined
|
|
43485
|
+
assertParamExists('removeChannelInterest', 'interestId', interestId)
|
|
43486
|
+
const localVarPath = `/channels/{channelId}/interests/{interestId}`
|
|
43212
43487
|
.replace('{channelId}', encodeURIComponent(String(channelId)))
|
|
43213
|
-
.replace('{
|
|
43488
|
+
.replace('{interestId}', encodeURIComponent(String(interestId)));
|
|
43489
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
43490
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
43491
|
+
let baseOptions;
|
|
43492
|
+
if (configuration) {
|
|
43493
|
+
baseOptions = configuration.baseOptions;
|
|
43494
|
+
}
|
|
43495
|
+
|
|
43496
|
+
const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
|
|
43497
|
+
const localVarHeaderParameter = {} as any;
|
|
43498
|
+
const localVarQueryParameter = {} as any;
|
|
43499
|
+
|
|
43500
|
+
// authentication ApiKeyAuth required
|
|
43501
|
+
await setApiKeyToObject(localVarHeaderParameter, "api-key", configuration)
|
|
43502
|
+
|
|
43503
|
+
// authentication OrganizationId required
|
|
43504
|
+
await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
|
|
43505
|
+
|
|
43506
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
43507
|
+
|
|
43508
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
43509
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
43510
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
43511
|
+
|
|
43512
|
+
return {
|
|
43513
|
+
url: toPathString(localVarUrlObj),
|
|
43514
|
+
options: localVarRequestOptions,
|
|
43515
|
+
};
|
|
43516
|
+
},
|
|
43517
|
+
}
|
|
43518
|
+
};
|
|
43519
|
+
|
|
43520
|
+
/**
|
|
43521
|
+
* ChannelsInterestsApi - functional programming interface
|
|
43522
|
+
*/
|
|
43523
|
+
export const ChannelsInterestsApiFp = function(configuration?: Configuration) {
|
|
43524
|
+
const localVarAxiosParamCreator = ChannelsInterestsApiAxiosParamCreator(configuration)
|
|
43525
|
+
return {
|
|
43526
|
+
/**
|
|
43527
|
+
* 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.
|
|
43528
|
+
* @summary Add an interest to a content item
|
|
43529
|
+
* @param {string} channelId The channel identifier
|
|
43530
|
+
* @param {string} contentId The content identifier
|
|
43531
|
+
* @param {string} interestId The interest identifier
|
|
43532
|
+
* @param {*} [options] Override http request option.
|
|
43533
|
+
* @throws {RequiredError}
|
|
43534
|
+
*/
|
|
43535
|
+
async addChannelContentInterest(channelId: string, contentId: string, interestId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateChannelContent200Response>> {
|
|
43536
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.addChannelContentInterest(channelId, contentId, interestId, options);
|
|
43537
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
43538
|
+
const localVarOperationServerBasePath = operationServerMap['ChannelsInterestsApi.addChannelContentInterest']?.[localVarOperationServerIndex]?.url;
|
|
43539
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
43540
|
+
},
|
|
43541
|
+
/**
|
|
43542
|
+
* 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.
|
|
43543
|
+
* @summary Add an interest to a channel
|
|
43544
|
+
* @param {string} channelId The channel identifier
|
|
43545
|
+
* @param {string} interestId The interest identifier
|
|
43546
|
+
* @param {*} [options] Override http request option.
|
|
43547
|
+
* @throws {RequiredError}
|
|
43548
|
+
*/
|
|
43549
|
+
async addChannelInterest(channelId: string, interestId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateChannel200Response>> {
|
|
43550
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.addChannelInterest(channelId, interestId, options);
|
|
43551
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
43552
|
+
const localVarOperationServerBasePath = operationServerMap['ChannelsInterestsApi.addChannelInterest']?.[localVarOperationServerIndex]?.url;
|
|
43553
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
43554
|
+
},
|
|
43555
|
+
/**
|
|
43556
|
+
* 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.
|
|
43557
|
+
* @summary List a content item\'s interests
|
|
43558
|
+
* @param {string} channelId The channel identifier
|
|
43559
|
+
* @param {string} contentId The content identifier
|
|
43560
|
+
* @param {number} [page] Page number
|
|
43561
|
+
* @param {number} [pageSize] Number of items per page
|
|
43562
|
+
* @param {string} [orderBy] Field to order by
|
|
43563
|
+
* @param {string} [search] Search query
|
|
43564
|
+
* @param {*} [options] Override http request option.
|
|
43565
|
+
* @throws {RequiredError}
|
|
43566
|
+
*/
|
|
43567
|
+
async getChannelContentInterests(channelId: string, contentId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAccountInterests200Response>> {
|
|
43568
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getChannelContentInterests(channelId, contentId, page, pageSize, orderBy, search, options);
|
|
43569
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
43570
|
+
const localVarOperationServerBasePath = operationServerMap['ChannelsInterestsApi.getChannelContentInterests']?.[localVarOperationServerIndex]?.url;
|
|
43571
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
43572
|
+
},
|
|
43573
|
+
/**
|
|
43574
|
+
* 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.
|
|
43575
|
+
* @summary List a channel\'s interests
|
|
43576
|
+
* @param {string} channelId The channel identifier
|
|
43577
|
+
* @param {number} [page] Page number
|
|
43578
|
+
* @param {number} [pageSize] Number of items per page
|
|
43579
|
+
* @param {string} [orderBy] Field to order by
|
|
43580
|
+
* @param {string} [search] Search query
|
|
43581
|
+
* @param {*} [options] Override http request option.
|
|
43582
|
+
* @throws {RequiredError}
|
|
43583
|
+
*/
|
|
43584
|
+
async getChannelInterests(channelId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAccountInterests200Response>> {
|
|
43585
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getChannelInterests(channelId, page, pageSize, orderBy, search, options);
|
|
43586
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
43587
|
+
const localVarOperationServerBasePath = operationServerMap['ChannelsInterestsApi.getChannelInterests']?.[localVarOperationServerIndex]?.url;
|
|
43588
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
43589
|
+
},
|
|
43590
|
+
/**
|
|
43591
|
+
* 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.
|
|
43592
|
+
* @summary Remove an interest from a content item
|
|
43593
|
+
* @param {string} channelId The channel identifier
|
|
43594
|
+
* @param {string} contentId The content identifier
|
|
43595
|
+
* @param {string} interestId The interest identifier
|
|
43596
|
+
* @param {*} [options] Override http request option.
|
|
43597
|
+
* @throws {RequiredError}
|
|
43598
|
+
*/
|
|
43599
|
+
async removeChannelContentInterest(channelId: string, contentId: string, interestId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateChannelContent200Response>> {
|
|
43600
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.removeChannelContentInterest(channelId, contentId, interestId, options);
|
|
43601
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
43602
|
+
const localVarOperationServerBasePath = operationServerMap['ChannelsInterestsApi.removeChannelContentInterest']?.[localVarOperationServerIndex]?.url;
|
|
43603
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
43604
|
+
},
|
|
43605
|
+
/**
|
|
43606
|
+
* 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.
|
|
43607
|
+
* @summary Remove an interest from a channel
|
|
43608
|
+
* @param {string} channelId The channel identifier
|
|
43609
|
+
* @param {string} interestId The interest identifier
|
|
43610
|
+
* @param {*} [options] Override http request option.
|
|
43611
|
+
* @throws {RequiredError}
|
|
43612
|
+
*/
|
|
43613
|
+
async removeChannelInterest(channelId: string, interestId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateChannel200Response>> {
|
|
43614
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.removeChannelInterest(channelId, interestId, options);
|
|
43615
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
43616
|
+
const localVarOperationServerBasePath = operationServerMap['ChannelsInterestsApi.removeChannelInterest']?.[localVarOperationServerIndex]?.url;
|
|
43617
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
43618
|
+
},
|
|
43619
|
+
}
|
|
43620
|
+
};
|
|
43621
|
+
|
|
43622
|
+
/**
|
|
43623
|
+
* ChannelsInterestsApi - factory interface
|
|
43624
|
+
*/
|
|
43625
|
+
export const ChannelsInterestsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
43626
|
+
const localVarFp = ChannelsInterestsApiFp(configuration)
|
|
43627
|
+
return {
|
|
43628
|
+
/**
|
|
43629
|
+
* 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.
|
|
43630
|
+
* @summary Add an interest to a content item
|
|
43631
|
+
* @param {ChannelsInterestsApiAddChannelContentInterestRequest} requestParameters Request parameters.
|
|
43632
|
+
* @param {*} [options] Override http request option.
|
|
43633
|
+
* @throws {RequiredError}
|
|
43634
|
+
*/
|
|
43635
|
+
addChannelContentInterest(requestParameters: ChannelsInterestsApiAddChannelContentInterestRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateChannelContent200Response> {
|
|
43636
|
+
return localVarFp.addChannelContentInterest(requestParameters.channelId, requestParameters.contentId, requestParameters.interestId, options).then((request) => request(axios, basePath));
|
|
43637
|
+
},
|
|
43638
|
+
/**
|
|
43639
|
+
* 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.
|
|
43640
|
+
* @summary Add an interest to a channel
|
|
43641
|
+
* @param {ChannelsInterestsApiAddChannelInterestRequest} requestParameters Request parameters.
|
|
43642
|
+
* @param {*} [options] Override http request option.
|
|
43643
|
+
* @throws {RequiredError}
|
|
43644
|
+
*/
|
|
43645
|
+
addChannelInterest(requestParameters: ChannelsInterestsApiAddChannelInterestRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateChannel200Response> {
|
|
43646
|
+
return localVarFp.addChannelInterest(requestParameters.channelId, requestParameters.interestId, options).then((request) => request(axios, basePath));
|
|
43647
|
+
},
|
|
43648
|
+
/**
|
|
43649
|
+
* 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.
|
|
43650
|
+
* @summary List a content item\'s interests
|
|
43651
|
+
* @param {ChannelsInterestsApiGetChannelContentInterestsRequest} requestParameters Request parameters.
|
|
43652
|
+
* @param {*} [options] Override http request option.
|
|
43653
|
+
* @throws {RequiredError}
|
|
43654
|
+
*/
|
|
43655
|
+
getChannelContentInterests(requestParameters: ChannelsInterestsApiGetChannelContentInterestsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetAccountInterests200Response> {
|
|
43656
|
+
return localVarFp.getChannelContentInterests(requestParameters.channelId, requestParameters.contentId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
43657
|
+
},
|
|
43658
|
+
/**
|
|
43659
|
+
* 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.
|
|
43660
|
+
* @summary List a channel\'s interests
|
|
43661
|
+
* @param {ChannelsInterestsApiGetChannelInterestsRequest} requestParameters Request parameters.
|
|
43662
|
+
* @param {*} [options] Override http request option.
|
|
43663
|
+
* @throws {RequiredError}
|
|
43664
|
+
*/
|
|
43665
|
+
getChannelInterests(requestParameters: ChannelsInterestsApiGetChannelInterestsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetAccountInterests200Response> {
|
|
43666
|
+
return localVarFp.getChannelInterests(requestParameters.channelId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
43667
|
+
},
|
|
43668
|
+
/**
|
|
43669
|
+
* 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.
|
|
43670
|
+
* @summary Remove an interest from a content item
|
|
43671
|
+
* @param {ChannelsInterestsApiRemoveChannelContentInterestRequest} requestParameters Request parameters.
|
|
43672
|
+
* @param {*} [options] Override http request option.
|
|
43673
|
+
* @throws {RequiredError}
|
|
43674
|
+
*/
|
|
43675
|
+
removeChannelContentInterest(requestParameters: ChannelsInterestsApiRemoveChannelContentInterestRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateChannelContent200Response> {
|
|
43676
|
+
return localVarFp.removeChannelContentInterest(requestParameters.channelId, requestParameters.contentId, requestParameters.interestId, options).then((request) => request(axios, basePath));
|
|
43677
|
+
},
|
|
43678
|
+
/**
|
|
43679
|
+
* 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.
|
|
43680
|
+
* @summary Remove an interest from a channel
|
|
43681
|
+
* @param {ChannelsInterestsApiRemoveChannelInterestRequest} requestParameters Request parameters.
|
|
43682
|
+
* @param {*} [options] Override http request option.
|
|
43683
|
+
* @throws {RequiredError}
|
|
43684
|
+
*/
|
|
43685
|
+
removeChannelInterest(requestParameters: ChannelsInterestsApiRemoveChannelInterestRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateChannel200Response> {
|
|
43686
|
+
return localVarFp.removeChannelInterest(requestParameters.channelId, requestParameters.interestId, options).then((request) => request(axios, basePath));
|
|
43687
|
+
},
|
|
43688
|
+
};
|
|
43689
|
+
};
|
|
43690
|
+
|
|
43691
|
+
/**
|
|
43692
|
+
* Request parameters for addChannelContentInterest operation in ChannelsInterestsApi.
|
|
43693
|
+
*/
|
|
43694
|
+
export interface ChannelsInterestsApiAddChannelContentInterestRequest {
|
|
43695
|
+
/**
|
|
43696
|
+
* The channel identifier
|
|
43697
|
+
*/
|
|
43698
|
+
readonly channelId: string
|
|
43699
|
+
|
|
43700
|
+
/**
|
|
43701
|
+
* The content identifier
|
|
43702
|
+
*/
|
|
43703
|
+
readonly contentId: string
|
|
43704
|
+
|
|
43705
|
+
/**
|
|
43706
|
+
* The interest identifier
|
|
43707
|
+
*/
|
|
43708
|
+
readonly interestId: string
|
|
43709
|
+
}
|
|
43710
|
+
|
|
43711
|
+
/**
|
|
43712
|
+
* Request parameters for addChannelInterest operation in ChannelsInterestsApi.
|
|
43713
|
+
*/
|
|
43714
|
+
export interface ChannelsInterestsApiAddChannelInterestRequest {
|
|
43715
|
+
/**
|
|
43716
|
+
* The channel identifier
|
|
43717
|
+
*/
|
|
43718
|
+
readonly channelId: string
|
|
43719
|
+
|
|
43720
|
+
/**
|
|
43721
|
+
* The interest identifier
|
|
43722
|
+
*/
|
|
43723
|
+
readonly interestId: string
|
|
43724
|
+
}
|
|
43725
|
+
|
|
43726
|
+
/**
|
|
43727
|
+
* Request parameters for getChannelContentInterests operation in ChannelsInterestsApi.
|
|
43728
|
+
*/
|
|
43729
|
+
export interface ChannelsInterestsApiGetChannelContentInterestsRequest {
|
|
43730
|
+
/**
|
|
43731
|
+
* The channel identifier
|
|
43732
|
+
*/
|
|
43733
|
+
readonly channelId: string
|
|
43734
|
+
|
|
43735
|
+
/**
|
|
43736
|
+
* The content identifier
|
|
43737
|
+
*/
|
|
43738
|
+
readonly contentId: string
|
|
43739
|
+
|
|
43740
|
+
/**
|
|
43741
|
+
* Page number
|
|
43742
|
+
*/
|
|
43743
|
+
readonly page?: number
|
|
43744
|
+
|
|
43745
|
+
/**
|
|
43746
|
+
* Number of items per page
|
|
43747
|
+
*/
|
|
43748
|
+
readonly pageSize?: number
|
|
43749
|
+
|
|
43750
|
+
/**
|
|
43751
|
+
* Field to order by
|
|
43752
|
+
*/
|
|
43753
|
+
readonly orderBy?: string
|
|
43754
|
+
|
|
43755
|
+
/**
|
|
43756
|
+
* Search query
|
|
43757
|
+
*/
|
|
43758
|
+
readonly search?: string
|
|
43759
|
+
}
|
|
43760
|
+
|
|
43761
|
+
/**
|
|
43762
|
+
* Request parameters for getChannelInterests operation in ChannelsInterestsApi.
|
|
43763
|
+
*/
|
|
43764
|
+
export interface ChannelsInterestsApiGetChannelInterestsRequest {
|
|
43765
|
+
/**
|
|
43766
|
+
* The channel identifier
|
|
43767
|
+
*/
|
|
43768
|
+
readonly channelId: string
|
|
43769
|
+
|
|
43770
|
+
/**
|
|
43771
|
+
* Page number
|
|
43772
|
+
*/
|
|
43773
|
+
readonly page?: number
|
|
43774
|
+
|
|
43775
|
+
/**
|
|
43776
|
+
* Number of items per page
|
|
43777
|
+
*/
|
|
43778
|
+
readonly pageSize?: number
|
|
43779
|
+
|
|
43780
|
+
/**
|
|
43781
|
+
* Field to order by
|
|
43782
|
+
*/
|
|
43783
|
+
readonly orderBy?: string
|
|
43784
|
+
|
|
43785
|
+
/**
|
|
43786
|
+
* Search query
|
|
43787
|
+
*/
|
|
43788
|
+
readonly search?: string
|
|
43789
|
+
}
|
|
43790
|
+
|
|
43791
|
+
/**
|
|
43792
|
+
* Request parameters for removeChannelContentInterest operation in ChannelsInterestsApi.
|
|
43793
|
+
*/
|
|
43794
|
+
export interface ChannelsInterestsApiRemoveChannelContentInterestRequest {
|
|
43795
|
+
/**
|
|
43796
|
+
* The channel identifier
|
|
43797
|
+
*/
|
|
43798
|
+
readonly channelId: string
|
|
43799
|
+
|
|
43800
|
+
/**
|
|
43801
|
+
* The content identifier
|
|
43802
|
+
*/
|
|
43803
|
+
readonly contentId: string
|
|
43804
|
+
|
|
43805
|
+
/**
|
|
43806
|
+
* The interest identifier
|
|
43807
|
+
*/
|
|
43808
|
+
readonly interestId: string
|
|
43809
|
+
}
|
|
43810
|
+
|
|
43811
|
+
/**
|
|
43812
|
+
* Request parameters for removeChannelInterest operation in ChannelsInterestsApi.
|
|
43813
|
+
*/
|
|
43814
|
+
export interface ChannelsInterestsApiRemoveChannelInterestRequest {
|
|
43815
|
+
/**
|
|
43816
|
+
* The channel identifier
|
|
43817
|
+
*/
|
|
43818
|
+
readonly channelId: string
|
|
43819
|
+
|
|
43820
|
+
/**
|
|
43821
|
+
* The interest identifier
|
|
43822
|
+
*/
|
|
43823
|
+
readonly interestId: string
|
|
43824
|
+
}
|
|
43825
|
+
|
|
43826
|
+
/**
|
|
43827
|
+
* ChannelsInterestsApi - object-oriented interface
|
|
43828
|
+
*/
|
|
43829
|
+
export class ChannelsInterestsApi extends BaseAPI {
|
|
43830
|
+
/**
|
|
43831
|
+
* 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.
|
|
43832
|
+
* @summary Add an interest to a content item
|
|
43833
|
+
* @param {ChannelsInterestsApiAddChannelContentInterestRequest} requestParameters Request parameters.
|
|
43834
|
+
* @param {*} [options] Override http request option.
|
|
43835
|
+
* @throws {RequiredError}
|
|
43836
|
+
*/
|
|
43837
|
+
public addChannelContentInterest(requestParameters: ChannelsInterestsApiAddChannelContentInterestRequest, options?: RawAxiosRequestConfig) {
|
|
43838
|
+
return ChannelsInterestsApiFp(this.configuration).addChannelContentInterest(requestParameters.channelId, requestParameters.contentId, requestParameters.interestId, options).then((request) => request(this.axios, this.basePath));
|
|
43839
|
+
}
|
|
43840
|
+
|
|
43841
|
+
/**
|
|
43842
|
+
* 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.
|
|
43843
|
+
* @summary Add an interest to a channel
|
|
43844
|
+
* @param {ChannelsInterestsApiAddChannelInterestRequest} requestParameters Request parameters.
|
|
43845
|
+
* @param {*} [options] Override http request option.
|
|
43846
|
+
* @throws {RequiredError}
|
|
43847
|
+
*/
|
|
43848
|
+
public addChannelInterest(requestParameters: ChannelsInterestsApiAddChannelInterestRequest, options?: RawAxiosRequestConfig) {
|
|
43849
|
+
return ChannelsInterestsApiFp(this.configuration).addChannelInterest(requestParameters.channelId, requestParameters.interestId, options).then((request) => request(this.axios, this.basePath));
|
|
43850
|
+
}
|
|
43851
|
+
|
|
43852
|
+
/**
|
|
43853
|
+
* 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.
|
|
43854
|
+
* @summary List a content item\'s interests
|
|
43855
|
+
* @param {ChannelsInterestsApiGetChannelContentInterestsRequest} requestParameters Request parameters.
|
|
43856
|
+
* @param {*} [options] Override http request option.
|
|
43857
|
+
* @throws {RequiredError}
|
|
43858
|
+
*/
|
|
43859
|
+
public getChannelContentInterests(requestParameters: ChannelsInterestsApiGetChannelContentInterestsRequest, options?: RawAxiosRequestConfig) {
|
|
43860
|
+
return ChannelsInterestsApiFp(this.configuration).getChannelContentInterests(requestParameters.channelId, requestParameters.contentId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
|
|
43861
|
+
}
|
|
43862
|
+
|
|
43863
|
+
/**
|
|
43864
|
+
* 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.
|
|
43865
|
+
* @summary List a channel\'s interests
|
|
43866
|
+
* @param {ChannelsInterestsApiGetChannelInterestsRequest} requestParameters Request parameters.
|
|
43867
|
+
* @param {*} [options] Override http request option.
|
|
43868
|
+
* @throws {RequiredError}
|
|
43869
|
+
*/
|
|
43870
|
+
public getChannelInterests(requestParameters: ChannelsInterestsApiGetChannelInterestsRequest, options?: RawAxiosRequestConfig) {
|
|
43871
|
+
return ChannelsInterestsApiFp(this.configuration).getChannelInterests(requestParameters.channelId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
|
|
43872
|
+
}
|
|
43873
|
+
|
|
43874
|
+
/**
|
|
43875
|
+
* 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.
|
|
43876
|
+
* @summary Remove an interest from a content item
|
|
43877
|
+
* @param {ChannelsInterestsApiRemoveChannelContentInterestRequest} requestParameters Request parameters.
|
|
43878
|
+
* @param {*} [options] Override http request option.
|
|
43879
|
+
* @throws {RequiredError}
|
|
43880
|
+
*/
|
|
43881
|
+
public removeChannelContentInterest(requestParameters: ChannelsInterestsApiRemoveChannelContentInterestRequest, options?: RawAxiosRequestConfig) {
|
|
43882
|
+
return ChannelsInterestsApiFp(this.configuration).removeChannelContentInterest(requestParameters.channelId, requestParameters.contentId, requestParameters.interestId, options).then((request) => request(this.axios, this.basePath));
|
|
43883
|
+
}
|
|
43884
|
+
|
|
43885
|
+
/**
|
|
43886
|
+
* 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.
|
|
43887
|
+
* @summary Remove an interest from a channel
|
|
43888
|
+
* @param {ChannelsInterestsApiRemoveChannelInterestRequest} requestParameters Request parameters.
|
|
43889
|
+
* @param {*} [options] Override http request option.
|
|
43890
|
+
* @throws {RequiredError}
|
|
43891
|
+
*/
|
|
43892
|
+
public removeChannelInterest(requestParameters: ChannelsInterestsApiRemoveChannelInterestRequest, options?: RawAxiosRequestConfig) {
|
|
43893
|
+
return ChannelsInterestsApiFp(this.configuration).removeChannelInterest(requestParameters.channelId, requestParameters.interestId, options).then((request) => request(this.axios, this.basePath));
|
|
43894
|
+
}
|
|
43895
|
+
}
|
|
43896
|
+
|
|
43897
|
+
|
|
43898
|
+
|
|
43899
|
+
/**
|
|
43900
|
+
* ChannelsTranslationsApi - axios parameter creator
|
|
43901
|
+
*/
|
|
43902
|
+
export const ChannelsTranslationsApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
43903
|
+
return {
|
|
43904
|
+
/**
|
|
43905
|
+
* Removes the translation for a specific locale on a channel content item\'s guest speaker/author, requiring update permission on contents.
|
|
43906
|
+
* @summary Delete a channel content guest translation
|
|
43907
|
+
* @param {string} channelId The channel identifier
|
|
43908
|
+
* @param {string} contentId The content identifier
|
|
43909
|
+
* @param {string} guestId The guest identifier
|
|
43910
|
+
* @param {string} locale The locale identifier
|
|
43911
|
+
* @param {*} [options] Override http request option.
|
|
43912
|
+
* @throws {RequiredError}
|
|
43913
|
+
*/
|
|
43914
|
+
deleteChannelContentGuestTranslation: async (channelId: string, contentId: string, guestId: string, locale: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
43915
|
+
// verify required parameter 'channelId' is not null or undefined
|
|
43916
|
+
assertParamExists('deleteChannelContentGuestTranslation', 'channelId', channelId)
|
|
43917
|
+
// verify required parameter 'contentId' is not null or undefined
|
|
43918
|
+
assertParamExists('deleteChannelContentGuestTranslation', 'contentId', contentId)
|
|
43919
|
+
// verify required parameter 'guestId' is not null or undefined
|
|
43920
|
+
assertParamExists('deleteChannelContentGuestTranslation', 'guestId', guestId)
|
|
43921
|
+
// verify required parameter 'locale' is not null or undefined
|
|
43922
|
+
assertParamExists('deleteChannelContentGuestTranslation', 'locale', locale)
|
|
43923
|
+
const localVarPath = `/channels/{channelId}/contents/{contentId}/guests/{guestId}/translations/{locale}`
|
|
43924
|
+
.replace('{channelId}', encodeURIComponent(String(channelId)))
|
|
43925
|
+
.replace('{contentId}', encodeURIComponent(String(contentId)))
|
|
43926
|
+
.replace('{guestId}', encodeURIComponent(String(guestId)))
|
|
43927
|
+
.replace('{locale}', encodeURIComponent(String(locale)));
|
|
43928
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
43929
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
43930
|
+
let baseOptions;
|
|
43931
|
+
if (configuration) {
|
|
43932
|
+
baseOptions = configuration.baseOptions;
|
|
43933
|
+
}
|
|
43934
|
+
|
|
43935
|
+
const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
|
|
43936
|
+
const localVarHeaderParameter = {} as any;
|
|
43937
|
+
const localVarQueryParameter = {} as any;
|
|
43938
|
+
|
|
43939
|
+
// authentication ApiKeyAuth required
|
|
43940
|
+
await setApiKeyToObject(localVarHeaderParameter, "api-key", configuration)
|
|
43941
|
+
|
|
43942
|
+
// authentication OrganizationId required
|
|
43943
|
+
await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
|
|
43944
|
+
|
|
43945
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
43946
|
+
|
|
43947
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
43948
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
43949
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
43950
|
+
|
|
43951
|
+
return {
|
|
43952
|
+
url: toPathString(localVarUrlObj),
|
|
43953
|
+
options: localVarRequestOptions,
|
|
43954
|
+
};
|
|
43955
|
+
},
|
|
43956
|
+
/**
|
|
43957
|
+
* Removes the translation for a specific locale on a piece of channel content, requiring update permission on contents.
|
|
43958
|
+
* @summary Delete a channel content translation
|
|
43959
|
+
* @param {string} channelId The channel identifier
|
|
43960
|
+
* @param {string} contentId The content identifier
|
|
43961
|
+
* @param {string} locale The locale identifier
|
|
43962
|
+
* @param {*} [options] Override http request option.
|
|
43963
|
+
* @throws {RequiredError}
|
|
43964
|
+
*/
|
|
43965
|
+
deleteChannelContentTranslation: async (channelId: string, contentId: string, locale: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
43966
|
+
// verify required parameter 'channelId' is not null or undefined
|
|
43967
|
+
assertParamExists('deleteChannelContentTranslation', 'channelId', channelId)
|
|
43968
|
+
// verify required parameter 'contentId' is not null or undefined
|
|
43969
|
+
assertParamExists('deleteChannelContentTranslation', 'contentId', contentId)
|
|
43970
|
+
// verify required parameter 'locale' is not null or undefined
|
|
43971
|
+
assertParamExists('deleteChannelContentTranslation', 'locale', locale)
|
|
43972
|
+
const localVarPath = `/channels/{channelId}/contents/{contentId}/translations/{locale}`
|
|
43973
|
+
.replace('{channelId}', encodeURIComponent(String(channelId)))
|
|
43974
|
+
.replace('{contentId}', encodeURIComponent(String(contentId)))
|
|
43975
|
+
.replace('{locale}', encodeURIComponent(String(locale)));
|
|
43976
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
43977
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
43978
|
+
let baseOptions;
|
|
43979
|
+
if (configuration) {
|
|
43980
|
+
baseOptions = configuration.baseOptions;
|
|
43981
|
+
}
|
|
43982
|
+
|
|
43983
|
+
const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
|
|
43984
|
+
const localVarHeaderParameter = {} as any;
|
|
43985
|
+
const localVarQueryParameter = {} as any;
|
|
43986
|
+
|
|
43987
|
+
// authentication ApiKeyAuth required
|
|
43988
|
+
await setApiKeyToObject(localVarHeaderParameter, "api-key", configuration)
|
|
43989
|
+
|
|
43990
|
+
// authentication OrganizationId required
|
|
43991
|
+
await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
|
|
43992
|
+
|
|
43993
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
43994
|
+
|
|
43995
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
43996
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
43997
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
43998
|
+
|
|
43999
|
+
return {
|
|
44000
|
+
url: toPathString(localVarUrlObj),
|
|
44001
|
+
options: localVarRequestOptions,
|
|
44002
|
+
};
|
|
44003
|
+
},
|
|
44004
|
+
/**
|
|
44005
|
+
* Removes the translation for a specific locale on a channel\'s name/description, requiring update permission on channels.
|
|
44006
|
+
* @summary Delete a channel translation
|
|
44007
|
+
* @param {string} channelId The channel identifier
|
|
44008
|
+
* @param {string} locale The locale identifier
|
|
44009
|
+
* @param {*} [options] Override http request option.
|
|
44010
|
+
* @throws {RequiredError}
|
|
44011
|
+
*/
|
|
44012
|
+
deleteChannelTranslation: async (channelId: string, locale: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
44013
|
+
// verify required parameter 'channelId' is not null or undefined
|
|
44014
|
+
assertParamExists('deleteChannelTranslation', 'channelId', channelId)
|
|
44015
|
+
// verify required parameter 'locale' is not null or undefined
|
|
44016
|
+
assertParamExists('deleteChannelTranslation', 'locale', locale)
|
|
44017
|
+
const localVarPath = `/channels/{channelId}/translations/{locale}`
|
|
44018
|
+
.replace('{channelId}', encodeURIComponent(String(channelId)))
|
|
44019
|
+
.replace('{locale}', encodeURIComponent(String(locale)));
|
|
43214
44020
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
43215
44021
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
43216
44022
|
let baseOptions;
|
|
@@ -61294,6 +62100,355 @@ export class EventsGroupcouponreminderApi extends BaseAPI {
|
|
|
61294
62100
|
|
|
61295
62101
|
|
|
61296
62102
|
|
|
62103
|
+
/**
|
|
62104
|
+
* EventsInterestsApi - axios parameter creator
|
|
62105
|
+
*/
|
|
62106
|
+
export const EventsInterestsApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
62107
|
+
return {
|
|
62108
|
+
/**
|
|
62109
|
+
* 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.
|
|
62110
|
+
* @summary Add an interest to an event
|
|
62111
|
+
* @param {string} eventId The event identifier
|
|
62112
|
+
* @param {string} interestId The interest identifier
|
|
62113
|
+
* @param {*} [options] Override http request option.
|
|
62114
|
+
* @throws {RequiredError}
|
|
62115
|
+
*/
|
|
62116
|
+
addEventInterest: async (eventId: string, interestId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
62117
|
+
// verify required parameter 'eventId' is not null or undefined
|
|
62118
|
+
assertParamExists('addEventInterest', 'eventId', eventId)
|
|
62119
|
+
// verify required parameter 'interestId' is not null or undefined
|
|
62120
|
+
assertParamExists('addEventInterest', 'interestId', interestId)
|
|
62121
|
+
const localVarPath = `/events/{eventId}/interests/{interestId}`
|
|
62122
|
+
.replace('{eventId}', encodeURIComponent(String(eventId)))
|
|
62123
|
+
.replace('{interestId}', encodeURIComponent(String(interestId)));
|
|
62124
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
62125
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
62126
|
+
let baseOptions;
|
|
62127
|
+
if (configuration) {
|
|
62128
|
+
baseOptions = configuration.baseOptions;
|
|
62129
|
+
}
|
|
62130
|
+
|
|
62131
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
62132
|
+
const localVarHeaderParameter = {} as any;
|
|
62133
|
+
const localVarQueryParameter = {} as any;
|
|
62134
|
+
|
|
62135
|
+
// authentication ApiKeyAuth required
|
|
62136
|
+
await setApiKeyToObject(localVarHeaderParameter, "api-key", configuration)
|
|
62137
|
+
|
|
62138
|
+
// authentication OrganizationId required
|
|
62139
|
+
await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
|
|
62140
|
+
|
|
62141
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
62142
|
+
|
|
62143
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
62144
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
62145
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
62146
|
+
|
|
62147
|
+
return {
|
|
62148
|
+
url: toPathString(localVarUrlObj),
|
|
62149
|
+
options: localVarRequestOptions,
|
|
62150
|
+
};
|
|
62151
|
+
},
|
|
62152
|
+
/**
|
|
62153
|
+
* 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.
|
|
62154
|
+
* @summary List an event\'s interests
|
|
62155
|
+
* @param {string} eventId The event identifier
|
|
62156
|
+
* @param {number} [page] Page number
|
|
62157
|
+
* @param {number} [pageSize] Number of items per page
|
|
62158
|
+
* @param {string} [orderBy] Field to order by
|
|
62159
|
+
* @param {string} [search] Search query
|
|
62160
|
+
* @param {*} [options] Override http request option.
|
|
62161
|
+
* @throws {RequiredError}
|
|
62162
|
+
*/
|
|
62163
|
+
getEventInterests: async (eventId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
62164
|
+
// verify required parameter 'eventId' is not null or undefined
|
|
62165
|
+
assertParamExists('getEventInterests', 'eventId', eventId)
|
|
62166
|
+
const localVarPath = `/events/{eventId}/interests`
|
|
62167
|
+
.replace('{eventId}', encodeURIComponent(String(eventId)));
|
|
62168
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
62169
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
62170
|
+
let baseOptions;
|
|
62171
|
+
if (configuration) {
|
|
62172
|
+
baseOptions = configuration.baseOptions;
|
|
62173
|
+
}
|
|
62174
|
+
|
|
62175
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
62176
|
+
const localVarHeaderParameter = {} as any;
|
|
62177
|
+
const localVarQueryParameter = {} as any;
|
|
62178
|
+
|
|
62179
|
+
// authentication ApiKeyAuth required
|
|
62180
|
+
await setApiKeyToObject(localVarHeaderParameter, "api-key", configuration)
|
|
62181
|
+
|
|
62182
|
+
// authentication OrganizationId required
|
|
62183
|
+
await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
|
|
62184
|
+
|
|
62185
|
+
if (page !== undefined) {
|
|
62186
|
+
localVarQueryParameter['page'] = page;
|
|
62187
|
+
}
|
|
62188
|
+
|
|
62189
|
+
if (pageSize !== undefined) {
|
|
62190
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
62191
|
+
}
|
|
62192
|
+
|
|
62193
|
+
if (orderBy !== undefined) {
|
|
62194
|
+
localVarQueryParameter['orderBy'] = orderBy;
|
|
62195
|
+
}
|
|
62196
|
+
|
|
62197
|
+
if (search !== undefined) {
|
|
62198
|
+
localVarQueryParameter['search'] = search;
|
|
62199
|
+
}
|
|
62200
|
+
|
|
62201
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
62202
|
+
|
|
62203
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
62204
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
62205
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
62206
|
+
|
|
62207
|
+
return {
|
|
62208
|
+
url: toPathString(localVarUrlObj),
|
|
62209
|
+
options: localVarRequestOptions,
|
|
62210
|
+
};
|
|
62211
|
+
},
|
|
62212
|
+
/**
|
|
62213
|
+
* 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.
|
|
62214
|
+
* @summary Remove an interest from an event
|
|
62215
|
+
* @param {string} eventId The event identifier
|
|
62216
|
+
* @param {string} interestId The interest identifier
|
|
62217
|
+
* @param {*} [options] Override http request option.
|
|
62218
|
+
* @throws {RequiredError}
|
|
62219
|
+
*/
|
|
62220
|
+
removeEventInterest: async (eventId: string, interestId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
62221
|
+
// verify required parameter 'eventId' is not null or undefined
|
|
62222
|
+
assertParamExists('removeEventInterest', 'eventId', eventId)
|
|
62223
|
+
// verify required parameter 'interestId' is not null or undefined
|
|
62224
|
+
assertParamExists('removeEventInterest', 'interestId', interestId)
|
|
62225
|
+
const localVarPath = `/events/{eventId}/interests/{interestId}`
|
|
62226
|
+
.replace('{eventId}', encodeURIComponent(String(eventId)))
|
|
62227
|
+
.replace('{interestId}', encodeURIComponent(String(interestId)));
|
|
62228
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
62229
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
62230
|
+
let baseOptions;
|
|
62231
|
+
if (configuration) {
|
|
62232
|
+
baseOptions = configuration.baseOptions;
|
|
62233
|
+
}
|
|
62234
|
+
|
|
62235
|
+
const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
|
|
62236
|
+
const localVarHeaderParameter = {} as any;
|
|
62237
|
+
const localVarQueryParameter = {} as any;
|
|
62238
|
+
|
|
62239
|
+
// authentication ApiKeyAuth required
|
|
62240
|
+
await setApiKeyToObject(localVarHeaderParameter, "api-key", configuration)
|
|
62241
|
+
|
|
62242
|
+
// authentication OrganizationId required
|
|
62243
|
+
await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
|
|
62244
|
+
|
|
62245
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
62246
|
+
|
|
62247
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
62248
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
62249
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
62250
|
+
|
|
62251
|
+
return {
|
|
62252
|
+
url: toPathString(localVarUrlObj),
|
|
62253
|
+
options: localVarRequestOptions,
|
|
62254
|
+
};
|
|
62255
|
+
},
|
|
62256
|
+
}
|
|
62257
|
+
};
|
|
62258
|
+
|
|
62259
|
+
/**
|
|
62260
|
+
* EventsInterestsApi - functional programming interface
|
|
62261
|
+
*/
|
|
62262
|
+
export const EventsInterestsApiFp = function(configuration?: Configuration) {
|
|
62263
|
+
const localVarAxiosParamCreator = EventsInterestsApiAxiosParamCreator(configuration)
|
|
62264
|
+
return {
|
|
62265
|
+
/**
|
|
62266
|
+
* 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.
|
|
62267
|
+
* @summary Add an interest to an event
|
|
62268
|
+
* @param {string} eventId The event identifier
|
|
62269
|
+
* @param {string} interestId The interest identifier
|
|
62270
|
+
* @param {*} [options] Override http request option.
|
|
62271
|
+
* @throws {RequiredError}
|
|
62272
|
+
*/
|
|
62273
|
+
async addEventInterest(eventId: string, interestId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateEvent200Response>> {
|
|
62274
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.addEventInterest(eventId, interestId, options);
|
|
62275
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
62276
|
+
const localVarOperationServerBasePath = operationServerMap['EventsInterestsApi.addEventInterest']?.[localVarOperationServerIndex]?.url;
|
|
62277
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
62278
|
+
},
|
|
62279
|
+
/**
|
|
62280
|
+
* 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.
|
|
62281
|
+
* @summary List an event\'s interests
|
|
62282
|
+
* @param {string} eventId The event identifier
|
|
62283
|
+
* @param {number} [page] Page number
|
|
62284
|
+
* @param {number} [pageSize] Number of items per page
|
|
62285
|
+
* @param {string} [orderBy] Field to order by
|
|
62286
|
+
* @param {string} [search] Search query
|
|
62287
|
+
* @param {*} [options] Override http request option.
|
|
62288
|
+
* @throws {RequiredError}
|
|
62289
|
+
*/
|
|
62290
|
+
async getEventInterests(eventId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAccountInterests200Response>> {
|
|
62291
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getEventInterests(eventId, page, pageSize, orderBy, search, options);
|
|
62292
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
62293
|
+
const localVarOperationServerBasePath = operationServerMap['EventsInterestsApi.getEventInterests']?.[localVarOperationServerIndex]?.url;
|
|
62294
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
62295
|
+
},
|
|
62296
|
+
/**
|
|
62297
|
+
* 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.
|
|
62298
|
+
* @summary Remove an interest from an event
|
|
62299
|
+
* @param {string} eventId The event identifier
|
|
62300
|
+
* @param {string} interestId The interest identifier
|
|
62301
|
+
* @param {*} [options] Override http request option.
|
|
62302
|
+
* @throws {RequiredError}
|
|
62303
|
+
*/
|
|
62304
|
+
async removeEventInterest(eventId: string, interestId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateEvent200Response>> {
|
|
62305
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.removeEventInterest(eventId, interestId, options);
|
|
62306
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
62307
|
+
const localVarOperationServerBasePath = operationServerMap['EventsInterestsApi.removeEventInterest']?.[localVarOperationServerIndex]?.url;
|
|
62308
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
62309
|
+
},
|
|
62310
|
+
}
|
|
62311
|
+
};
|
|
62312
|
+
|
|
62313
|
+
/**
|
|
62314
|
+
* EventsInterestsApi - factory interface
|
|
62315
|
+
*/
|
|
62316
|
+
export const EventsInterestsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
62317
|
+
const localVarFp = EventsInterestsApiFp(configuration)
|
|
62318
|
+
return {
|
|
62319
|
+
/**
|
|
62320
|
+
* 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.
|
|
62321
|
+
* @summary Add an interest to an event
|
|
62322
|
+
* @param {EventsInterestsApiAddEventInterestRequest} requestParameters Request parameters.
|
|
62323
|
+
* @param {*} [options] Override http request option.
|
|
62324
|
+
* @throws {RequiredError}
|
|
62325
|
+
*/
|
|
62326
|
+
addEventInterest(requestParameters: EventsInterestsApiAddEventInterestRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateEvent200Response> {
|
|
62327
|
+
return localVarFp.addEventInterest(requestParameters.eventId, requestParameters.interestId, options).then((request) => request(axios, basePath));
|
|
62328
|
+
},
|
|
62329
|
+
/**
|
|
62330
|
+
* 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.
|
|
62331
|
+
* @summary List an event\'s interests
|
|
62332
|
+
* @param {EventsInterestsApiGetEventInterestsRequest} requestParameters Request parameters.
|
|
62333
|
+
* @param {*} [options] Override http request option.
|
|
62334
|
+
* @throws {RequiredError}
|
|
62335
|
+
*/
|
|
62336
|
+
getEventInterests(requestParameters: EventsInterestsApiGetEventInterestsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetAccountInterests200Response> {
|
|
62337
|
+
return localVarFp.getEventInterests(requestParameters.eventId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
62338
|
+
},
|
|
62339
|
+
/**
|
|
62340
|
+
* 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.
|
|
62341
|
+
* @summary Remove an interest from an event
|
|
62342
|
+
* @param {EventsInterestsApiRemoveEventInterestRequest} requestParameters Request parameters.
|
|
62343
|
+
* @param {*} [options] Override http request option.
|
|
62344
|
+
* @throws {RequiredError}
|
|
62345
|
+
*/
|
|
62346
|
+
removeEventInterest(requestParameters: EventsInterestsApiRemoveEventInterestRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateEvent200Response> {
|
|
62347
|
+
return localVarFp.removeEventInterest(requestParameters.eventId, requestParameters.interestId, options).then((request) => request(axios, basePath));
|
|
62348
|
+
},
|
|
62349
|
+
};
|
|
62350
|
+
};
|
|
62351
|
+
|
|
62352
|
+
/**
|
|
62353
|
+
* Request parameters for addEventInterest operation in EventsInterestsApi.
|
|
62354
|
+
*/
|
|
62355
|
+
export interface EventsInterestsApiAddEventInterestRequest {
|
|
62356
|
+
/**
|
|
62357
|
+
* The event identifier
|
|
62358
|
+
*/
|
|
62359
|
+
readonly eventId: string
|
|
62360
|
+
|
|
62361
|
+
/**
|
|
62362
|
+
* The interest identifier
|
|
62363
|
+
*/
|
|
62364
|
+
readonly interestId: string
|
|
62365
|
+
}
|
|
62366
|
+
|
|
62367
|
+
/**
|
|
62368
|
+
* Request parameters for getEventInterests operation in EventsInterestsApi.
|
|
62369
|
+
*/
|
|
62370
|
+
export interface EventsInterestsApiGetEventInterestsRequest {
|
|
62371
|
+
/**
|
|
62372
|
+
* The event identifier
|
|
62373
|
+
*/
|
|
62374
|
+
readonly eventId: string
|
|
62375
|
+
|
|
62376
|
+
/**
|
|
62377
|
+
* Page number
|
|
62378
|
+
*/
|
|
62379
|
+
readonly page?: number
|
|
62380
|
+
|
|
62381
|
+
/**
|
|
62382
|
+
* Number of items per page
|
|
62383
|
+
*/
|
|
62384
|
+
readonly pageSize?: number
|
|
62385
|
+
|
|
62386
|
+
/**
|
|
62387
|
+
* Field to order by
|
|
62388
|
+
*/
|
|
62389
|
+
readonly orderBy?: string
|
|
62390
|
+
|
|
62391
|
+
/**
|
|
62392
|
+
* Search query
|
|
62393
|
+
*/
|
|
62394
|
+
readonly search?: string
|
|
62395
|
+
}
|
|
62396
|
+
|
|
62397
|
+
/**
|
|
62398
|
+
* Request parameters for removeEventInterest operation in EventsInterestsApi.
|
|
62399
|
+
*/
|
|
62400
|
+
export interface EventsInterestsApiRemoveEventInterestRequest {
|
|
62401
|
+
/**
|
|
62402
|
+
* The event identifier
|
|
62403
|
+
*/
|
|
62404
|
+
readonly eventId: string
|
|
62405
|
+
|
|
62406
|
+
/**
|
|
62407
|
+
* The interest identifier
|
|
62408
|
+
*/
|
|
62409
|
+
readonly interestId: string
|
|
62410
|
+
}
|
|
62411
|
+
|
|
62412
|
+
/**
|
|
62413
|
+
* EventsInterestsApi - object-oriented interface
|
|
62414
|
+
*/
|
|
62415
|
+
export class EventsInterestsApi extends BaseAPI {
|
|
62416
|
+
/**
|
|
62417
|
+
* 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.
|
|
62418
|
+
* @summary Add an interest to an event
|
|
62419
|
+
* @param {EventsInterestsApiAddEventInterestRequest} requestParameters Request parameters.
|
|
62420
|
+
* @param {*} [options] Override http request option.
|
|
62421
|
+
* @throws {RequiredError}
|
|
62422
|
+
*/
|
|
62423
|
+
public addEventInterest(requestParameters: EventsInterestsApiAddEventInterestRequest, options?: RawAxiosRequestConfig) {
|
|
62424
|
+
return EventsInterestsApiFp(this.configuration).addEventInterest(requestParameters.eventId, requestParameters.interestId, options).then((request) => request(this.axios, this.basePath));
|
|
62425
|
+
}
|
|
62426
|
+
|
|
62427
|
+
/**
|
|
62428
|
+
* 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.
|
|
62429
|
+
* @summary List an event\'s interests
|
|
62430
|
+
* @param {EventsInterestsApiGetEventInterestsRequest} requestParameters Request parameters.
|
|
62431
|
+
* @param {*} [options] Override http request option.
|
|
62432
|
+
* @throws {RequiredError}
|
|
62433
|
+
*/
|
|
62434
|
+
public getEventInterests(requestParameters: EventsInterestsApiGetEventInterestsRequest, options?: RawAxiosRequestConfig) {
|
|
62435
|
+
return EventsInterestsApiFp(this.configuration).getEventInterests(requestParameters.eventId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
|
|
62436
|
+
}
|
|
62437
|
+
|
|
62438
|
+
/**
|
|
62439
|
+
* 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.
|
|
62440
|
+
* @summary Remove an interest from an event
|
|
62441
|
+
* @param {EventsInterestsApiRemoveEventInterestRequest} requestParameters Request parameters.
|
|
62442
|
+
* @param {*} [options] Override http request option.
|
|
62443
|
+
* @throws {RequiredError}
|
|
62444
|
+
*/
|
|
62445
|
+
public removeEventInterest(requestParameters: EventsInterestsApiRemoveEventInterestRequest, options?: RawAxiosRequestConfig) {
|
|
62446
|
+
return EventsInterestsApiFp(this.configuration).removeEventInterest(requestParameters.eventId, requestParameters.interestId, options).then((request) => request(this.axios, this.basePath));
|
|
62447
|
+
}
|
|
62448
|
+
}
|
|
62449
|
+
|
|
62450
|
+
|
|
62451
|
+
|
|
61297
62452
|
/**
|
|
61298
62453
|
* EventsMatchesApi - axios parameter creator
|
|
61299
62454
|
*/
|
|
@@ -117105,7 +118260,7 @@ export class GroupsEventsApi extends BaseAPI {
|
|
|
117105
118260
|
export const GroupsInterestsApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
117106
118261
|
return {
|
|
117107
118262
|
/**
|
|
117108
|
-
* 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
|
|
118263
|
+
* 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.
|
|
117109
118264
|
* @summary Add an interest to a group
|
|
117110
118265
|
* @param {string} groupId The group identifier
|
|
117111
118266
|
* @param {string} interestId The interest identifier
|
|
@@ -117209,7 +118364,7 @@ export const GroupsInterestsApiAxiosParamCreator = function (configuration?: Con
|
|
|
117209
118364
|
};
|
|
117210
118365
|
},
|
|
117211
118366
|
/**
|
|
117212
|
-
* 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
|
|
118367
|
+
* 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.
|
|
117213
118368
|
* @summary Remove an interest from a group
|
|
117214
118369
|
* @param {string} groupId The group identifier
|
|
117215
118370
|
* @param {string} accountId The account identifier
|
|
@@ -117262,7 +118417,7 @@ export const GroupsInterestsApiFp = function(configuration?: Configuration) {
|
|
|
117262
118417
|
const localVarAxiosParamCreator = GroupsInterestsApiAxiosParamCreator(configuration)
|
|
117263
118418
|
return {
|
|
117264
118419
|
/**
|
|
117265
|
-
* 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
|
|
118420
|
+
* 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.
|
|
117266
118421
|
* @summary Add an interest to a group
|
|
117267
118422
|
* @param {string} groupId The group identifier
|
|
117268
118423
|
* @param {string} interestId The interest identifier
|
|
@@ -117293,7 +118448,7 @@ export const GroupsInterestsApiFp = function(configuration?: Configuration) {
|
|
|
117293
118448
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
117294
118449
|
},
|
|
117295
118450
|
/**
|
|
117296
|
-
* 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
|
|
118451
|
+
* 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.
|
|
117297
118452
|
* @summary Remove an interest from a group
|
|
117298
118453
|
* @param {string} groupId The group identifier
|
|
117299
118454
|
* @param {string} accountId The account identifier
|
|
@@ -117316,7 +118471,7 @@ export const GroupsInterestsApiFactory = function (configuration?: Configuration
|
|
|
117316
118471
|
const localVarFp = GroupsInterestsApiFp(configuration)
|
|
117317
118472
|
return {
|
|
117318
118473
|
/**
|
|
117319
|
-
* 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
|
|
118474
|
+
* 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.
|
|
117320
118475
|
* @summary Add an interest to a group
|
|
117321
118476
|
* @param {GroupsInterestsApiAddGroupInterestRequest} requestParameters Request parameters.
|
|
117322
118477
|
* @param {*} [options] Override http request option.
|
|
@@ -117336,7 +118491,7 @@ export const GroupsInterestsApiFactory = function (configuration?: Configuration
|
|
|
117336
118491
|
return localVarFp.getGroupInterests(requestParameters.groupId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
117337
118492
|
},
|
|
117338
118493
|
/**
|
|
117339
|
-
* 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
|
|
118494
|
+
* 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.
|
|
117340
118495
|
* @summary Remove an interest from a group
|
|
117341
118496
|
* @param {GroupsInterestsApiRemoveGroupInterestRequest} requestParameters Request parameters.
|
|
117342
118497
|
* @param {*} [options] Override http request option.
|
|
@@ -117413,7 +118568,7 @@ export interface GroupsInterestsApiRemoveGroupInterestRequest {
|
|
|
117413
118568
|
*/
|
|
117414
118569
|
export class GroupsInterestsApi extends BaseAPI {
|
|
117415
118570
|
/**
|
|
117416
|
-
* 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
|
|
118571
|
+
* 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.
|
|
117417
118572
|
* @summary Add an interest to a group
|
|
117418
118573
|
* @param {GroupsInterestsApiAddGroupInterestRequest} requestParameters Request parameters.
|
|
117419
118574
|
* @param {*} [options] Override http request option.
|
|
@@ -117435,7 +118590,7 @@ export class GroupsInterestsApi extends BaseAPI {
|
|
|
117435
118590
|
}
|
|
117436
118591
|
|
|
117437
118592
|
/**
|
|
117438
|
-
* 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
|
|
118593
|
+
* 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.
|
|
117439
118594
|
* @summary Remove an interest from a group
|
|
117440
118595
|
* @param {GroupsInterestsApiRemoveGroupInterestRequest} requestParameters Request parameters.
|
|
117441
118596
|
* @param {*} [options] Override http request option.
|
|
@@ -152096,12 +153251,14 @@ export const StreamsApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
152096
153251
|
};
|
|
152097
153252
|
},
|
|
152098
153253
|
/**
|
|
152099
|
-
* 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.
|
|
153254
|
+
* 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.
|
|
152100
153255
|
* @summary List an organization\'s stream inputs
|
|
152101
153256
|
* @param {string} [eventId] Filter by eventId
|
|
152102
153257
|
* @param {string} [sessionId] Filter by sessionId
|
|
152103
153258
|
* @param {string} [groupId] Filter by groupId
|
|
152104
153259
|
* @param {string} [meetingId] Filter by meetingId
|
|
153260
|
+
* @param {boolean} [connected] Filter by connected
|
|
153261
|
+
* @param {boolean} [attached] Filter by attached
|
|
152105
153262
|
* @param {number} [page] Page number
|
|
152106
153263
|
* @param {number} [pageSize] Number of items per page
|
|
152107
153264
|
* @param {string} [orderBy] Field to order by
|
|
@@ -152109,7 +153266,7 @@ export const StreamsApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
152109
153266
|
* @param {*} [options] Override http request option.
|
|
152110
153267
|
* @throws {RequiredError}
|
|
152111
153268
|
*/
|
|
152112
|
-
getStreamInputs: async (eventId?: string, sessionId?: string, groupId?: string, meetingId?: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
153269
|
+
getStreamInputs: async (eventId?: string, sessionId?: string, groupId?: string, meetingId?: string, connected?: boolean, attached?: boolean, page?: number, pageSize?: number, orderBy?: string, search?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
152113
153270
|
const localVarPath = `/streams`;
|
|
152114
153271
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
152115
153272
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -152144,6 +153301,14 @@ export const StreamsApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
152144
153301
|
localVarQueryParameter['meetingId'] = meetingId;
|
|
152145
153302
|
}
|
|
152146
153303
|
|
|
153304
|
+
if (connected !== undefined) {
|
|
153305
|
+
localVarQueryParameter['connected'] = connected;
|
|
153306
|
+
}
|
|
153307
|
+
|
|
153308
|
+
if (attached !== undefined) {
|
|
153309
|
+
localVarQueryParameter['attached'] = attached;
|
|
153310
|
+
}
|
|
153311
|
+
|
|
152147
153312
|
if (page !== undefined) {
|
|
152148
153313
|
localVarQueryParameter['page'] = page;
|
|
152149
153314
|
}
|
|
@@ -152370,12 +153535,14 @@ export const StreamsApiFp = function(configuration?: Configuration) {
|
|
|
152370
153535
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
152371
153536
|
},
|
|
152372
153537
|
/**
|
|
152373
|
-
* 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.
|
|
153538
|
+
* 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.
|
|
152374
153539
|
* @summary List an organization\'s stream inputs
|
|
152375
153540
|
* @param {string} [eventId] Filter by eventId
|
|
152376
153541
|
* @param {string} [sessionId] Filter by sessionId
|
|
152377
153542
|
* @param {string} [groupId] Filter by groupId
|
|
152378
153543
|
* @param {string} [meetingId] Filter by meetingId
|
|
153544
|
+
* @param {boolean} [connected] Filter by connected
|
|
153545
|
+
* @param {boolean} [attached] Filter by attached
|
|
152379
153546
|
* @param {number} [page] Page number
|
|
152380
153547
|
* @param {number} [pageSize] Number of items per page
|
|
152381
153548
|
* @param {string} [orderBy] Field to order by
|
|
@@ -152383,8 +153550,8 @@ export const StreamsApiFp = function(configuration?: Configuration) {
|
|
|
152383
153550
|
* @param {*} [options] Override http request option.
|
|
152384
153551
|
* @throws {RequiredError}
|
|
152385
153552
|
*/
|
|
152386
|
-
async 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>> {
|
|
152387
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.getStreamInputs(eventId, sessionId, groupId, meetingId, page, pageSize, orderBy, search, options);
|
|
153553
|
+
async 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>> {
|
|
153554
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getStreamInputs(eventId, sessionId, groupId, meetingId, connected, attached, page, pageSize, orderBy, search, options);
|
|
152388
153555
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
152389
153556
|
const localVarOperationServerBasePath = operationServerMap['StreamsApi.getStreamInputs']?.[localVarOperationServerIndex]?.url;
|
|
152390
153557
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -152474,14 +153641,14 @@ export const StreamsApiFactory = function (configuration?: Configuration, basePa
|
|
|
152474
153641
|
return localVarFp.getStreamInput(requestParameters.streamId, options).then((request) => request(axios, basePath));
|
|
152475
153642
|
},
|
|
152476
153643
|
/**
|
|
152477
|
-
* 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.
|
|
153644
|
+
* 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.
|
|
152478
153645
|
* @summary List an organization\'s stream inputs
|
|
152479
153646
|
* @param {StreamsApiGetStreamInputsRequest} requestParameters Request parameters.
|
|
152480
153647
|
* @param {*} [options] Override http request option.
|
|
152481
153648
|
* @throws {RequiredError}
|
|
152482
153649
|
*/
|
|
152483
153650
|
getStreamInputs(requestParameters: StreamsApiGetStreamInputsRequest = {}, options?: RawAxiosRequestConfig): AxiosPromise<GetStreamInputs200Response> {
|
|
152484
|
-
return localVarFp.getStreamInputs(requestParameters.eventId, requestParameters.sessionId, requestParameters.groupId, requestParameters.meetingId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
153651
|
+
return localVarFp.getStreamInputs(requestParameters.eventId, requestParameters.sessionId, requestParameters.groupId, requestParameters.meetingId, requestParameters.connected, requestParameters.attached, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
152485
153652
|
},
|
|
152486
153653
|
/**
|
|
152487
153654
|
* 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.
|
|
@@ -152567,6 +153734,16 @@ export interface StreamsApiGetStreamInputsRequest {
|
|
|
152567
153734
|
*/
|
|
152568
153735
|
readonly meetingId?: string
|
|
152569
153736
|
|
|
153737
|
+
/**
|
|
153738
|
+
* Filter by connected
|
|
153739
|
+
*/
|
|
153740
|
+
readonly connected?: boolean
|
|
153741
|
+
|
|
153742
|
+
/**
|
|
153743
|
+
* Filter by attached
|
|
153744
|
+
*/
|
|
153745
|
+
readonly attached?: boolean
|
|
153746
|
+
|
|
152570
153747
|
/**
|
|
152571
153748
|
* Page number
|
|
152572
153749
|
*/
|
|
@@ -152680,14 +153857,14 @@ export class StreamsApi extends BaseAPI {
|
|
|
152680
153857
|
}
|
|
152681
153858
|
|
|
152682
153859
|
/**
|
|
152683
|
-
* 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.
|
|
153860
|
+
* 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.
|
|
152684
153861
|
* @summary List an organization\'s stream inputs
|
|
152685
153862
|
* @param {StreamsApiGetStreamInputsRequest} requestParameters Request parameters.
|
|
152686
153863
|
* @param {*} [options] Override http request option.
|
|
152687
153864
|
* @throws {RequiredError}
|
|
152688
153865
|
*/
|
|
152689
153866
|
public getStreamInputs(requestParameters: StreamsApiGetStreamInputsRequest = {}, options?: RawAxiosRequestConfig) {
|
|
152690
|
-
return StreamsApiFp(this.configuration).getStreamInputs(requestParameters.eventId, requestParameters.sessionId, requestParameters.groupId, requestParameters.meetingId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
|
|
153867
|
+
return StreamsApiFp(this.configuration).getStreamInputs(requestParameters.eventId, requestParameters.sessionId, requestParameters.groupId, requestParameters.meetingId, requestParameters.connected, requestParameters.attached, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
|
|
152691
153868
|
}
|
|
152692
153869
|
|
|
152693
153870
|
/**
|
|
@@ -153269,6 +154446,543 @@ export class StreamsOutputsApi extends BaseAPI {
|
|
|
153269
154446
|
|
|
153270
154447
|
|
|
153271
154448
|
|
|
154449
|
+
/**
|
|
154450
|
+
* StreamsReplaysApi - axios parameter creator
|
|
154451
|
+
*/
|
|
154452
|
+
export const StreamsReplaysApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
154453
|
+
return {
|
|
154454
|
+
/**
|
|
154455
|
+
* 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.
|
|
154456
|
+
* @summary Add a video as a replay
|
|
154457
|
+
* @param {ReplayCreateInputs} replayCreateInputs
|
|
154458
|
+
* @param {*} [options] Override http request option.
|
|
154459
|
+
* @throws {RequiredError}
|
|
154460
|
+
*/
|
|
154461
|
+
createReplay: async (replayCreateInputs: ReplayCreateInputs, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
154462
|
+
// verify required parameter 'replayCreateInputs' is not null or undefined
|
|
154463
|
+
assertParamExists('createReplay', 'replayCreateInputs', replayCreateInputs)
|
|
154464
|
+
const localVarPath = `/replays`;
|
|
154465
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
154466
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
154467
|
+
let baseOptions;
|
|
154468
|
+
if (configuration) {
|
|
154469
|
+
baseOptions = configuration.baseOptions;
|
|
154470
|
+
}
|
|
154471
|
+
|
|
154472
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
154473
|
+
const localVarHeaderParameter = {} as any;
|
|
154474
|
+
const localVarQueryParameter = {} as any;
|
|
154475
|
+
|
|
154476
|
+
// authentication ApiKeyAuth required
|
|
154477
|
+
await setApiKeyToObject(localVarHeaderParameter, "api-key", configuration)
|
|
154478
|
+
|
|
154479
|
+
// authentication OrganizationId required
|
|
154480
|
+
await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
|
|
154481
|
+
|
|
154482
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
154483
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
154484
|
+
|
|
154485
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
154486
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
154487
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
154488
|
+
localVarRequestOptions.data = serializeDataIfNeeded(replayCreateInputs, localVarRequestOptions, configuration)
|
|
154489
|
+
|
|
154490
|
+
return {
|
|
154491
|
+
url: toPathString(localVarUrlObj),
|
|
154492
|
+
options: localVarRequestOptions,
|
|
154493
|
+
};
|
|
154494
|
+
},
|
|
154495
|
+
/**
|
|
154496
|
+
* Detaches a replay from its session, event or group; the video stays in storage. Requires delete permission on streams.
|
|
154497
|
+
* @summary Remove a replay
|
|
154498
|
+
* @param {string} replayId The replay identifier
|
|
154499
|
+
* @param {*} [options] Override http request option.
|
|
154500
|
+
* @throws {RequiredError}
|
|
154501
|
+
*/
|
|
154502
|
+
deleteReplay: async (replayId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
154503
|
+
// verify required parameter 'replayId' is not null or undefined
|
|
154504
|
+
assertParamExists('deleteReplay', 'replayId', replayId)
|
|
154505
|
+
const localVarPath = `/replays/{replayId}`
|
|
154506
|
+
.replace('{replayId}', encodeURIComponent(String(replayId)));
|
|
154507
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
154508
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
154509
|
+
let baseOptions;
|
|
154510
|
+
if (configuration) {
|
|
154511
|
+
baseOptions = configuration.baseOptions;
|
|
154512
|
+
}
|
|
154513
|
+
|
|
154514
|
+
const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
|
|
154515
|
+
const localVarHeaderParameter = {} as any;
|
|
154516
|
+
const localVarQueryParameter = {} as any;
|
|
154517
|
+
|
|
154518
|
+
// authentication ApiKeyAuth required
|
|
154519
|
+
await setApiKeyToObject(localVarHeaderParameter, "api-key", configuration)
|
|
154520
|
+
|
|
154521
|
+
// authentication OrganizationId required
|
|
154522
|
+
await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
|
|
154523
|
+
|
|
154524
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
154525
|
+
|
|
154526
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
154527
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
154528
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
154529
|
+
|
|
154530
|
+
return {
|
|
154531
|
+
url: toPathString(localVarUrlObj),
|
|
154532
|
+
options: localVarRequestOptions,
|
|
154533
|
+
};
|
|
154534
|
+
},
|
|
154535
|
+
/**
|
|
154536
|
+
* 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.
|
|
154537
|
+
* @summary Get a replay
|
|
154538
|
+
* @param {string} replayId The replay identifier
|
|
154539
|
+
* @param {*} [options] Override http request option.
|
|
154540
|
+
* @throws {RequiredError}
|
|
154541
|
+
*/
|
|
154542
|
+
getReplay: async (replayId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
154543
|
+
// verify required parameter 'replayId' is not null or undefined
|
|
154544
|
+
assertParamExists('getReplay', 'replayId', replayId)
|
|
154545
|
+
const localVarPath = `/replays/{replayId}`
|
|
154546
|
+
.replace('{replayId}', encodeURIComponent(String(replayId)));
|
|
154547
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
154548
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
154549
|
+
let baseOptions;
|
|
154550
|
+
if (configuration) {
|
|
154551
|
+
baseOptions = configuration.baseOptions;
|
|
154552
|
+
}
|
|
154553
|
+
|
|
154554
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
154555
|
+
const localVarHeaderParameter = {} as any;
|
|
154556
|
+
const localVarQueryParameter = {} as any;
|
|
154557
|
+
|
|
154558
|
+
// authentication ApiKeyAuth required
|
|
154559
|
+
await setApiKeyToObject(localVarHeaderParameter, "api-key", configuration)
|
|
154560
|
+
|
|
154561
|
+
// authentication OrganizationId required
|
|
154562
|
+
await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
|
|
154563
|
+
|
|
154564
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
154565
|
+
|
|
154566
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
154567
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
154568
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
154569
|
+
|
|
154570
|
+
return {
|
|
154571
|
+
url: toPathString(localVarUrlObj),
|
|
154572
|
+
options: localVarRequestOptions,
|
|
154573
|
+
};
|
|
154574
|
+
},
|
|
154575
|
+
/**
|
|
154576
|
+
* 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.
|
|
154577
|
+
* @summary List replays
|
|
154578
|
+
* @param {string} [sessionId] Filter by sessionId
|
|
154579
|
+
* @param {string} [eventId] Filter by eventId
|
|
154580
|
+
* @param {string} [groupId] Filter by groupId
|
|
154581
|
+
* @param {string} [videoId] Filter by videoId
|
|
154582
|
+
* @param {number} [page] Page number
|
|
154583
|
+
* @param {number} [pageSize] Number of items per page
|
|
154584
|
+
* @param {string} [orderBy] Field to order by
|
|
154585
|
+
* @param {string} [search] Search query
|
|
154586
|
+
* @param {*} [options] Override http request option.
|
|
154587
|
+
* @throws {RequiredError}
|
|
154588
|
+
*/
|
|
154589
|
+
getReplays: async (sessionId?: string, eventId?: string, groupId?: string, videoId?: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
154590
|
+
const localVarPath = `/replays`;
|
|
154591
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
154592
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
154593
|
+
let baseOptions;
|
|
154594
|
+
if (configuration) {
|
|
154595
|
+
baseOptions = configuration.baseOptions;
|
|
154596
|
+
}
|
|
154597
|
+
|
|
154598
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
154599
|
+
const localVarHeaderParameter = {} as any;
|
|
154600
|
+
const localVarQueryParameter = {} as any;
|
|
154601
|
+
|
|
154602
|
+
// authentication ApiKeyAuth required
|
|
154603
|
+
await setApiKeyToObject(localVarHeaderParameter, "api-key", configuration)
|
|
154604
|
+
|
|
154605
|
+
// authentication OrganizationId required
|
|
154606
|
+
await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
|
|
154607
|
+
|
|
154608
|
+
if (sessionId !== undefined) {
|
|
154609
|
+
localVarQueryParameter['sessionId'] = sessionId;
|
|
154610
|
+
}
|
|
154611
|
+
|
|
154612
|
+
if (eventId !== undefined) {
|
|
154613
|
+
localVarQueryParameter['eventId'] = eventId;
|
|
154614
|
+
}
|
|
154615
|
+
|
|
154616
|
+
if (groupId !== undefined) {
|
|
154617
|
+
localVarQueryParameter['groupId'] = groupId;
|
|
154618
|
+
}
|
|
154619
|
+
|
|
154620
|
+
if (videoId !== undefined) {
|
|
154621
|
+
localVarQueryParameter['videoId'] = videoId;
|
|
154622
|
+
}
|
|
154623
|
+
|
|
154624
|
+
if (page !== undefined) {
|
|
154625
|
+
localVarQueryParameter['page'] = page;
|
|
154626
|
+
}
|
|
154627
|
+
|
|
154628
|
+
if (pageSize !== undefined) {
|
|
154629
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
154630
|
+
}
|
|
154631
|
+
|
|
154632
|
+
if (orderBy !== undefined) {
|
|
154633
|
+
localVarQueryParameter['orderBy'] = orderBy;
|
|
154634
|
+
}
|
|
154635
|
+
|
|
154636
|
+
if (search !== undefined) {
|
|
154637
|
+
localVarQueryParameter['search'] = search;
|
|
154638
|
+
}
|
|
154639
|
+
|
|
154640
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
154641
|
+
|
|
154642
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
154643
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
154644
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
154645
|
+
|
|
154646
|
+
return {
|
|
154647
|
+
url: toPathString(localVarUrlObj),
|
|
154648
|
+
options: localVarRequestOptions,
|
|
154649
|
+
};
|
|
154650
|
+
},
|
|
154651
|
+
/**
|
|
154652
|
+
* Moves a replay to exactly one other session, event or group in the organization; the video itself is unchanged. Requires update permission on streams.
|
|
154653
|
+
* @summary Move a replay
|
|
154654
|
+
* @param {string} replayId The replay identifier
|
|
154655
|
+
* @param {ReplayUpdateInputs} replayUpdateInputs
|
|
154656
|
+
* @param {*} [options] Override http request option.
|
|
154657
|
+
* @throws {RequiredError}
|
|
154658
|
+
*/
|
|
154659
|
+
updateReplay: async (replayId: string, replayUpdateInputs: ReplayUpdateInputs, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
154660
|
+
// verify required parameter 'replayId' is not null or undefined
|
|
154661
|
+
assertParamExists('updateReplay', 'replayId', replayId)
|
|
154662
|
+
// verify required parameter 'replayUpdateInputs' is not null or undefined
|
|
154663
|
+
assertParamExists('updateReplay', 'replayUpdateInputs', replayUpdateInputs)
|
|
154664
|
+
const localVarPath = `/replays/{replayId}`
|
|
154665
|
+
.replace('{replayId}', encodeURIComponent(String(replayId)));
|
|
154666
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
154667
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
154668
|
+
let baseOptions;
|
|
154669
|
+
if (configuration) {
|
|
154670
|
+
baseOptions = configuration.baseOptions;
|
|
154671
|
+
}
|
|
154672
|
+
|
|
154673
|
+
const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
|
|
154674
|
+
const localVarHeaderParameter = {} as any;
|
|
154675
|
+
const localVarQueryParameter = {} as any;
|
|
154676
|
+
|
|
154677
|
+
// authentication ApiKeyAuth required
|
|
154678
|
+
await setApiKeyToObject(localVarHeaderParameter, "api-key", configuration)
|
|
154679
|
+
|
|
154680
|
+
// authentication OrganizationId required
|
|
154681
|
+
await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
|
|
154682
|
+
|
|
154683
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
154684
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
154685
|
+
|
|
154686
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
154687
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
154688
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
154689
|
+
localVarRequestOptions.data = serializeDataIfNeeded(replayUpdateInputs, localVarRequestOptions, configuration)
|
|
154690
|
+
|
|
154691
|
+
return {
|
|
154692
|
+
url: toPathString(localVarUrlObj),
|
|
154693
|
+
options: localVarRequestOptions,
|
|
154694
|
+
};
|
|
154695
|
+
},
|
|
154696
|
+
}
|
|
154697
|
+
};
|
|
154698
|
+
|
|
154699
|
+
/**
|
|
154700
|
+
* StreamsReplaysApi - functional programming interface
|
|
154701
|
+
*/
|
|
154702
|
+
export const StreamsReplaysApiFp = function(configuration?: Configuration) {
|
|
154703
|
+
const localVarAxiosParamCreator = StreamsReplaysApiAxiosParamCreator(configuration)
|
|
154704
|
+
return {
|
|
154705
|
+
/**
|
|
154706
|
+
* 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.
|
|
154707
|
+
* @summary Add a video as a replay
|
|
154708
|
+
* @param {ReplayCreateInputs} replayCreateInputs
|
|
154709
|
+
* @param {*} [options] Override http request option.
|
|
154710
|
+
* @throws {RequiredError}
|
|
154711
|
+
*/
|
|
154712
|
+
async createReplay(replayCreateInputs: ReplayCreateInputs, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateReplay200Response>> {
|
|
154713
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.createReplay(replayCreateInputs, options);
|
|
154714
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
154715
|
+
const localVarOperationServerBasePath = operationServerMap['StreamsReplaysApi.createReplay']?.[localVarOperationServerIndex]?.url;
|
|
154716
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
154717
|
+
},
|
|
154718
|
+
/**
|
|
154719
|
+
* Detaches a replay from its session, event or group; the video stays in storage. Requires delete permission on streams.
|
|
154720
|
+
* @summary Remove a replay
|
|
154721
|
+
* @param {string} replayId The replay identifier
|
|
154722
|
+
* @param {*} [options] Override http request option.
|
|
154723
|
+
* @throws {RequiredError}
|
|
154724
|
+
*/
|
|
154725
|
+
async deleteReplay(replayId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAccountInvitations200Response>> {
|
|
154726
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.deleteReplay(replayId, options);
|
|
154727
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
154728
|
+
const localVarOperationServerBasePath = operationServerMap['StreamsReplaysApi.deleteReplay']?.[localVarOperationServerIndex]?.url;
|
|
154729
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
154730
|
+
},
|
|
154731
|
+
/**
|
|
154732
|
+
* 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.
|
|
154733
|
+
* @summary Get a replay
|
|
154734
|
+
* @param {string} replayId The replay identifier
|
|
154735
|
+
* @param {*} [options] Override http request option.
|
|
154736
|
+
* @throws {RequiredError}
|
|
154737
|
+
*/
|
|
154738
|
+
async getReplay(replayId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateReplay200Response>> {
|
|
154739
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getReplay(replayId, options);
|
|
154740
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
154741
|
+
const localVarOperationServerBasePath = operationServerMap['StreamsReplaysApi.getReplay']?.[localVarOperationServerIndex]?.url;
|
|
154742
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
154743
|
+
},
|
|
154744
|
+
/**
|
|
154745
|
+
* 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.
|
|
154746
|
+
* @summary List replays
|
|
154747
|
+
* @param {string} [sessionId] Filter by sessionId
|
|
154748
|
+
* @param {string} [eventId] Filter by eventId
|
|
154749
|
+
* @param {string} [groupId] Filter by groupId
|
|
154750
|
+
* @param {string} [videoId] Filter by videoId
|
|
154751
|
+
* @param {number} [page] Page number
|
|
154752
|
+
* @param {number} [pageSize] Number of items per page
|
|
154753
|
+
* @param {string} [orderBy] Field to order by
|
|
154754
|
+
* @param {string} [search] Search query
|
|
154755
|
+
* @param {*} [options] Override http request option.
|
|
154756
|
+
* @throws {RequiredError}
|
|
154757
|
+
*/
|
|
154758
|
+
async 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>> {
|
|
154759
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getReplays(sessionId, eventId, groupId, videoId, page, pageSize, orderBy, search, options);
|
|
154760
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
154761
|
+
const localVarOperationServerBasePath = operationServerMap['StreamsReplaysApi.getReplays']?.[localVarOperationServerIndex]?.url;
|
|
154762
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
154763
|
+
},
|
|
154764
|
+
/**
|
|
154765
|
+
* Moves a replay to exactly one other session, event or group in the organization; the video itself is unchanged. Requires update permission on streams.
|
|
154766
|
+
* @summary Move a replay
|
|
154767
|
+
* @param {string} replayId The replay identifier
|
|
154768
|
+
* @param {ReplayUpdateInputs} replayUpdateInputs
|
|
154769
|
+
* @param {*} [options] Override http request option.
|
|
154770
|
+
* @throws {RequiredError}
|
|
154771
|
+
*/
|
|
154772
|
+
async updateReplay(replayId: string, replayUpdateInputs: ReplayUpdateInputs, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateReplay200Response>> {
|
|
154773
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.updateReplay(replayId, replayUpdateInputs, options);
|
|
154774
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
154775
|
+
const localVarOperationServerBasePath = operationServerMap['StreamsReplaysApi.updateReplay']?.[localVarOperationServerIndex]?.url;
|
|
154776
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
154777
|
+
},
|
|
154778
|
+
}
|
|
154779
|
+
};
|
|
154780
|
+
|
|
154781
|
+
/**
|
|
154782
|
+
* StreamsReplaysApi - factory interface
|
|
154783
|
+
*/
|
|
154784
|
+
export const StreamsReplaysApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
154785
|
+
const localVarFp = StreamsReplaysApiFp(configuration)
|
|
154786
|
+
return {
|
|
154787
|
+
/**
|
|
154788
|
+
* 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.
|
|
154789
|
+
* @summary Add a video as a replay
|
|
154790
|
+
* @param {StreamsReplaysApiCreateReplayRequest} requestParameters Request parameters.
|
|
154791
|
+
* @param {*} [options] Override http request option.
|
|
154792
|
+
* @throws {RequiredError}
|
|
154793
|
+
*/
|
|
154794
|
+
createReplay(requestParameters: StreamsReplaysApiCreateReplayRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateReplay200Response> {
|
|
154795
|
+
return localVarFp.createReplay(requestParameters.replayCreateInputs, options).then((request) => request(axios, basePath));
|
|
154796
|
+
},
|
|
154797
|
+
/**
|
|
154798
|
+
* Detaches a replay from its session, event or group; the video stays in storage. Requires delete permission on streams.
|
|
154799
|
+
* @summary Remove a replay
|
|
154800
|
+
* @param {StreamsReplaysApiDeleteReplayRequest} requestParameters Request parameters.
|
|
154801
|
+
* @param {*} [options] Override http request option.
|
|
154802
|
+
* @throws {RequiredError}
|
|
154803
|
+
*/
|
|
154804
|
+
deleteReplay(requestParameters: StreamsReplaysApiDeleteReplayRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateAccountInvitations200Response> {
|
|
154805
|
+
return localVarFp.deleteReplay(requestParameters.replayId, options).then((request) => request(axios, basePath));
|
|
154806
|
+
},
|
|
154807
|
+
/**
|
|
154808
|
+
* 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.
|
|
154809
|
+
* @summary Get a replay
|
|
154810
|
+
* @param {StreamsReplaysApiGetReplayRequest} requestParameters Request parameters.
|
|
154811
|
+
* @param {*} [options] Override http request option.
|
|
154812
|
+
* @throws {RequiredError}
|
|
154813
|
+
*/
|
|
154814
|
+
getReplay(requestParameters: StreamsReplaysApiGetReplayRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateReplay200Response> {
|
|
154815
|
+
return localVarFp.getReplay(requestParameters.replayId, options).then((request) => request(axios, basePath));
|
|
154816
|
+
},
|
|
154817
|
+
/**
|
|
154818
|
+
* 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.
|
|
154819
|
+
* @summary List replays
|
|
154820
|
+
* @param {StreamsReplaysApiGetReplaysRequest} requestParameters Request parameters.
|
|
154821
|
+
* @param {*} [options] Override http request option.
|
|
154822
|
+
* @throws {RequiredError}
|
|
154823
|
+
*/
|
|
154824
|
+
getReplays(requestParameters: StreamsReplaysApiGetReplaysRequest = {}, options?: RawAxiosRequestConfig): AxiosPromise<GetReplays200Response> {
|
|
154825
|
+
return localVarFp.getReplays(requestParameters.sessionId, requestParameters.eventId, requestParameters.groupId, requestParameters.videoId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
154826
|
+
},
|
|
154827
|
+
/**
|
|
154828
|
+
* Moves a replay to exactly one other session, event or group in the organization; the video itself is unchanged. Requires update permission on streams.
|
|
154829
|
+
* @summary Move a replay
|
|
154830
|
+
* @param {StreamsReplaysApiUpdateReplayRequest} requestParameters Request parameters.
|
|
154831
|
+
* @param {*} [options] Override http request option.
|
|
154832
|
+
* @throws {RequiredError}
|
|
154833
|
+
*/
|
|
154834
|
+
updateReplay(requestParameters: StreamsReplaysApiUpdateReplayRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateReplay200Response> {
|
|
154835
|
+
return localVarFp.updateReplay(requestParameters.replayId, requestParameters.replayUpdateInputs, options).then((request) => request(axios, basePath));
|
|
154836
|
+
},
|
|
154837
|
+
};
|
|
154838
|
+
};
|
|
154839
|
+
|
|
154840
|
+
/**
|
|
154841
|
+
* Request parameters for createReplay operation in StreamsReplaysApi.
|
|
154842
|
+
*/
|
|
154843
|
+
export interface StreamsReplaysApiCreateReplayRequest {
|
|
154844
|
+
readonly replayCreateInputs: ReplayCreateInputs
|
|
154845
|
+
}
|
|
154846
|
+
|
|
154847
|
+
/**
|
|
154848
|
+
* Request parameters for deleteReplay operation in StreamsReplaysApi.
|
|
154849
|
+
*/
|
|
154850
|
+
export interface StreamsReplaysApiDeleteReplayRequest {
|
|
154851
|
+
/**
|
|
154852
|
+
* The replay identifier
|
|
154853
|
+
*/
|
|
154854
|
+
readonly replayId: string
|
|
154855
|
+
}
|
|
154856
|
+
|
|
154857
|
+
/**
|
|
154858
|
+
* Request parameters for getReplay operation in StreamsReplaysApi.
|
|
154859
|
+
*/
|
|
154860
|
+
export interface StreamsReplaysApiGetReplayRequest {
|
|
154861
|
+
/**
|
|
154862
|
+
* The replay identifier
|
|
154863
|
+
*/
|
|
154864
|
+
readonly replayId: string
|
|
154865
|
+
}
|
|
154866
|
+
|
|
154867
|
+
/**
|
|
154868
|
+
* Request parameters for getReplays operation in StreamsReplaysApi.
|
|
154869
|
+
*/
|
|
154870
|
+
export interface StreamsReplaysApiGetReplaysRequest {
|
|
154871
|
+
/**
|
|
154872
|
+
* Filter by sessionId
|
|
154873
|
+
*/
|
|
154874
|
+
readonly sessionId?: string
|
|
154875
|
+
|
|
154876
|
+
/**
|
|
154877
|
+
* Filter by eventId
|
|
154878
|
+
*/
|
|
154879
|
+
readonly eventId?: string
|
|
154880
|
+
|
|
154881
|
+
/**
|
|
154882
|
+
* Filter by groupId
|
|
154883
|
+
*/
|
|
154884
|
+
readonly groupId?: string
|
|
154885
|
+
|
|
154886
|
+
/**
|
|
154887
|
+
* Filter by videoId
|
|
154888
|
+
*/
|
|
154889
|
+
readonly videoId?: string
|
|
154890
|
+
|
|
154891
|
+
/**
|
|
154892
|
+
* Page number
|
|
154893
|
+
*/
|
|
154894
|
+
readonly page?: number
|
|
154895
|
+
|
|
154896
|
+
/**
|
|
154897
|
+
* Number of items per page
|
|
154898
|
+
*/
|
|
154899
|
+
readonly pageSize?: number
|
|
154900
|
+
|
|
154901
|
+
/**
|
|
154902
|
+
* Field to order by
|
|
154903
|
+
*/
|
|
154904
|
+
readonly orderBy?: string
|
|
154905
|
+
|
|
154906
|
+
/**
|
|
154907
|
+
* Search query
|
|
154908
|
+
*/
|
|
154909
|
+
readonly search?: string
|
|
154910
|
+
}
|
|
154911
|
+
|
|
154912
|
+
/**
|
|
154913
|
+
* Request parameters for updateReplay operation in StreamsReplaysApi.
|
|
154914
|
+
*/
|
|
154915
|
+
export interface StreamsReplaysApiUpdateReplayRequest {
|
|
154916
|
+
/**
|
|
154917
|
+
* The replay identifier
|
|
154918
|
+
*/
|
|
154919
|
+
readonly replayId: string
|
|
154920
|
+
|
|
154921
|
+
readonly replayUpdateInputs: ReplayUpdateInputs
|
|
154922
|
+
}
|
|
154923
|
+
|
|
154924
|
+
/**
|
|
154925
|
+
* StreamsReplaysApi - object-oriented interface
|
|
154926
|
+
*/
|
|
154927
|
+
export class StreamsReplaysApi extends BaseAPI {
|
|
154928
|
+
/**
|
|
154929
|
+
* 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.
|
|
154930
|
+
* @summary Add a video as a replay
|
|
154931
|
+
* @param {StreamsReplaysApiCreateReplayRequest} requestParameters Request parameters.
|
|
154932
|
+
* @param {*} [options] Override http request option.
|
|
154933
|
+
* @throws {RequiredError}
|
|
154934
|
+
*/
|
|
154935
|
+
public createReplay(requestParameters: StreamsReplaysApiCreateReplayRequest, options?: RawAxiosRequestConfig) {
|
|
154936
|
+
return StreamsReplaysApiFp(this.configuration).createReplay(requestParameters.replayCreateInputs, options).then((request) => request(this.axios, this.basePath));
|
|
154937
|
+
}
|
|
154938
|
+
|
|
154939
|
+
/**
|
|
154940
|
+
* Detaches a replay from its session, event or group; the video stays in storage. Requires delete permission on streams.
|
|
154941
|
+
* @summary Remove a replay
|
|
154942
|
+
* @param {StreamsReplaysApiDeleteReplayRequest} requestParameters Request parameters.
|
|
154943
|
+
* @param {*} [options] Override http request option.
|
|
154944
|
+
* @throws {RequiredError}
|
|
154945
|
+
*/
|
|
154946
|
+
public deleteReplay(requestParameters: StreamsReplaysApiDeleteReplayRequest, options?: RawAxiosRequestConfig) {
|
|
154947
|
+
return StreamsReplaysApiFp(this.configuration).deleteReplay(requestParameters.replayId, options).then((request) => request(this.axios, this.basePath));
|
|
154948
|
+
}
|
|
154949
|
+
|
|
154950
|
+
/**
|
|
154951
|
+
* 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.
|
|
154952
|
+
* @summary Get a replay
|
|
154953
|
+
* @param {StreamsReplaysApiGetReplayRequest} requestParameters Request parameters.
|
|
154954
|
+
* @param {*} [options] Override http request option.
|
|
154955
|
+
* @throws {RequiredError}
|
|
154956
|
+
*/
|
|
154957
|
+
public getReplay(requestParameters: StreamsReplaysApiGetReplayRequest, options?: RawAxiosRequestConfig) {
|
|
154958
|
+
return StreamsReplaysApiFp(this.configuration).getReplay(requestParameters.replayId, options).then((request) => request(this.axios, this.basePath));
|
|
154959
|
+
}
|
|
154960
|
+
|
|
154961
|
+
/**
|
|
154962
|
+
* 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.
|
|
154963
|
+
* @summary List replays
|
|
154964
|
+
* @param {StreamsReplaysApiGetReplaysRequest} requestParameters Request parameters.
|
|
154965
|
+
* @param {*} [options] Override http request option.
|
|
154966
|
+
* @throws {RequiredError}
|
|
154967
|
+
*/
|
|
154968
|
+
public getReplays(requestParameters: StreamsReplaysApiGetReplaysRequest = {}, options?: RawAxiosRequestConfig) {
|
|
154969
|
+
return StreamsReplaysApiFp(this.configuration).getReplays(requestParameters.sessionId, requestParameters.eventId, requestParameters.groupId, requestParameters.videoId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
|
|
154970
|
+
}
|
|
154971
|
+
|
|
154972
|
+
/**
|
|
154973
|
+
* Moves a replay to exactly one other session, event or group in the organization; the video itself is unchanged. Requires update permission on streams.
|
|
154974
|
+
* @summary Move a replay
|
|
154975
|
+
* @param {StreamsReplaysApiUpdateReplayRequest} requestParameters Request parameters.
|
|
154976
|
+
* @param {*} [options] Override http request option.
|
|
154977
|
+
* @throws {RequiredError}
|
|
154978
|
+
*/
|
|
154979
|
+
public updateReplay(requestParameters: StreamsReplaysApiUpdateReplayRequest, options?: RawAxiosRequestConfig) {
|
|
154980
|
+
return StreamsReplaysApiFp(this.configuration).updateReplay(requestParameters.replayId, requestParameters.replayUpdateInputs, options).then((request) => request(this.axios, this.basePath));
|
|
154981
|
+
}
|
|
154982
|
+
}
|
|
154983
|
+
|
|
154984
|
+
|
|
154985
|
+
|
|
153272
154986
|
/**
|
|
153273
154987
|
* StreamsSessionsApi - axios parameter creator
|
|
153274
154988
|
*/
|