@connectedxm/admin-sdk 13.4.0 → 13.6.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/dist/esm/api.d.ts CHANGED
@@ -2,7 +2,7 @@
2
2
  * Connected Admin API
3
3
  * The Admin API allows you to manage your Connected community programmatically.
4
4
  *
5
- * The version of the OpenAPI document: 13.4.0
5
+ * The version of the OpenAPI document: 13.6.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -2781,8 +2781,11 @@ export interface BaseStreamInput {
2781
2781
  export interface BaseStreamSession {
2782
2782
  'id': string;
2783
2783
  'organizationId': string;
2784
- 'streamId': string;
2785
- 'status': string;
2784
+ 'streamId': string | null;
2785
+ 'name': string | null;
2786
+ 'eventId': string | null;
2787
+ 'eventSessionId': string | null;
2788
+ 'status': StreamSessionStatus;
2786
2789
  'startedAt': string | null;
2787
2790
  'endedAt': string | null;
2788
2791
  'createdAt': string;
@@ -7288,6 +7291,15 @@ export interface GetAllAccountMerges200Response {
7288
7291
  export declare enum GetAllAccountMerges200ResponseStatusEnum {
7289
7292
  Ok = "ok"
7290
7293
  }
7294
+ export interface GetAllStreamSessions200Response {
7295
+ 'status': GetAllStreamSessions200ResponseStatusEnum;
7296
+ 'message': string;
7297
+ 'data': Array<StreamSession>;
7298
+ 'count'?: number;
7299
+ }
7300
+ export declare enum GetAllStreamSessions200ResponseStatusEnum {
7301
+ Ok = "ok"
7302
+ }
7291
7303
  export interface GetAnnouncementAudienceAccounts200Response {
7292
7304
  'status': GetAnnouncementAudienceAccounts200ResponseStatusEnum;
7293
7305
  'message': string;
@@ -9660,38 +9672,29 @@ export interface GetStreamInputs200Response {
9660
9672
  export declare enum GetStreamInputs200ResponseStatusEnum {
9661
9673
  Ok = "ok"
9662
9674
  }
9663
- export interface GetStreamSession200Response {
9664
- 'status': GetStreamSession200ResponseStatusEnum;
9675
+ export interface GetStreamSessionById200Response {
9676
+ 'status': GetStreamSessionById200ResponseStatusEnum;
9665
9677
  'message': string;
9666
9678
  'data': StreamSession;
9667
9679
  }
9668
- export declare enum GetStreamSession200ResponseStatusEnum {
9680
+ export declare enum GetStreamSessionById200ResponseStatusEnum {
9669
9681
  Ok = "ok"
9670
9682
  }
9671
- export interface GetStreamSessionChat200Response {
9672
- 'status': GetStreamSessionChat200ResponseStatusEnum;
9683
+ export interface GetStreamSessionByIdChat200Response {
9684
+ 'status': GetStreamSessionByIdChat200ResponseStatusEnum;
9673
9685
  'message': string;
9674
9686
  'data': Array<StreamSessionChatMessage>;
9675
9687
  }
9676
- export declare enum GetStreamSessionChat200ResponseStatusEnum {
9688
+ export declare enum GetStreamSessionByIdChat200ResponseStatusEnum {
9677
9689
  Ok = "ok"
9678
9690
  }
9679
- export interface GetStreamSessionSubscriptions200Response {
9680
- 'status': GetStreamSessionSubscriptions200ResponseStatusEnum;
9691
+ export interface GetStreamSessionByIdSubscriptions200Response {
9692
+ 'status': GetStreamSessionByIdSubscriptions200ResponseStatusEnum;
9681
9693
  'message': string;
9682
9694
  'data': Array<StreamSessionSubscription>;
9683
9695
  'count'?: number;
9684
9696
  }
9685
- export declare enum GetStreamSessionSubscriptions200ResponseStatusEnum {
9686
- Ok = "ok"
9687
- }
9688
- export interface GetStreamSessions200Response {
9689
- 'status': GetStreamSessions200ResponseStatusEnum;
9690
- 'message': string;
9691
- 'data': Array<StreamSession>;
9692
- 'count'?: number;
9693
- }
9694
- export declare enum GetStreamSessions200ResponseStatusEnum {
9697
+ export declare enum GetStreamSessionByIdSubscriptions200ResponseStatusEnum {
9695
9698
  Ok = "ok"
9696
9699
  }
9697
9700
  export interface GetStreamVideos200Response {
@@ -13438,13 +13441,18 @@ export interface StreamOutputCreateInputs {
13438
13441
  export interface StreamSession {
13439
13442
  'id': string;
13440
13443
  'organizationId': string;
13441
- 'streamId': string;
13442
- 'status': string;
13444
+ 'streamId': string | null;
13445
+ 'name': string | null;
13446
+ 'eventId': string | null;
13447
+ 'eventSessionId': string | null;
13448
+ 'status': StreamSessionStatus;
13443
13449
  'startedAt': string | null;
13444
13450
  'endedAt': string | null;
13445
13451
  'createdAt': string;
13446
13452
  'updatedAt': string;
13447
- 'stream': BaseStreamInput;
13453
+ 'stream': BaseStreamInput | null;
13454
+ 'event': BaseEvent | null;
13455
+ 'eventSession': BaseEventSession | null;
13448
13456
  'organization': BaseOrganization;
13449
13457
  }
13450
13458
  export interface StreamSessionChatMessage {
@@ -13457,6 +13465,10 @@ export interface StreamSessionChatMessage {
13457
13465
  'message': string;
13458
13466
  'timestamp': number;
13459
13467
  }
13468
+ export declare enum StreamSessionStatus {
13469
+ Active = "ACTIVE",
13470
+ Ended = "ENDED"
13471
+ }
13460
13472
  export interface StreamSessionSubscription {
13461
13473
  'id': string;
13462
13474
  'organizationId': string;
@@ -13468,6 +13480,11 @@ export interface StreamSessionSubscription {
13468
13480
  'connection': BaseWebSocketConnection;
13469
13481
  'streamSession': BaseStreamSession;
13470
13482
  }
13483
+ export interface StreamSessionUpdateInputs {
13484
+ 'name'?: string | null;
13485
+ 'eventId'?: string | null;
13486
+ 'eventSessionId'?: string | null;
13487
+ }
13471
13488
  export interface StripeActivationFormParams {
13472
13489
  'clientPublicKey': string;
13473
13490
  'clientSecret': string;
@@ -82401,7 +82418,7 @@ export declare const StreamsApiAxiosParamCreator: (configuration?: Configuration
82401
82418
  */
82402
82419
  createStreamInput: (streamInputCreateInputs: StreamInputCreateInputs, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
82403
82420
  /**
82404
- * Permanently deletes the stream input (streamId) and its associated Cloudflare live input; requires the read and delete permissions on streams.
82421
+ * Permanently deletes the stream input (streamId) and its associated Cloudflare live input. Its sessions, their chat history and its recordings are kept, and any active session is ended; requires the read and delete permissions on streams.
82405
82422
  * @summary Delete a stream input
82406
82423
  * @param {string} streamId The stream identifier
82407
82424
  * @param {*} [options] Override http request option.
@@ -82475,7 +82492,7 @@ export declare const StreamsApiFp: (configuration?: Configuration) => {
82475
82492
  */
82476
82493
  createStreamInput(streamInputCreateInputs: StreamInputCreateInputs, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateStreamInput200Response>>;
82477
82494
  /**
82478
- * Permanently deletes the stream input (streamId) and its associated Cloudflare live input; requires the read and delete permissions on streams.
82495
+ * Permanently deletes the stream input (streamId) and its associated Cloudflare live input. Its sessions, their chat history and its recordings are kept, and any active session is ended; requires the read and delete permissions on streams.
82479
82496
  * @summary Delete a stream input
82480
82497
  * @param {string} streamId The stream identifier
82481
82498
  * @param {*} [options] Override http request option.
@@ -82549,7 +82566,7 @@ export declare const StreamsApiFactory: (configuration?: Configuration, basePath
82549
82566
  */
82550
82567
  createStreamInput(requestParameters: StreamsApiCreateStreamInputRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateStreamInput200Response>;
82551
82568
  /**
82552
- * Permanently deletes the stream input (streamId) and its associated Cloudflare live input; requires the read and delete permissions on streams.
82569
+ * Permanently deletes the stream input (streamId) and its associated Cloudflare live input. Its sessions, their chat history and its recordings are kept, and any active session is ended; requires the read and delete permissions on streams.
82553
82570
  * @summary Delete a stream input
82554
82571
  * @param {StreamsApiDeleteStreamInputRequest} requestParameters Request parameters.
82555
82572
  * @param {*} [options] Override http request option.
@@ -82716,7 +82733,7 @@ export declare class StreamsApi extends BaseAPI {
82716
82733
  */
82717
82734
  createStreamInput(requestParameters: StreamsApiCreateStreamInputRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateStreamInput200Response, any, {}, any>>;
82718
82735
  /**
82719
- * Permanently deletes the stream input (streamId) and its associated Cloudflare live input; requires the read and delete permissions on streams.
82736
+ * Permanently deletes the stream input (streamId) and its associated Cloudflare live input. Its sessions, their chat history and its recordings are kept, and any active session is ended; requires the read and delete permissions on streams.
82720
82737
  * @summary Delete a stream input
82721
82738
  * @param {StreamsApiDeleteStreamInputRequest} requestParameters Request parameters.
82722
82739
  * @param {*} [options] Override http request option.
@@ -83059,6 +83076,29 @@ export declare const StreamsSessionsApiAxiosParamCreator: (configuration?: Confi
83059
83076
  * @throws {RequiredError}
83060
83077
  */
83061
83078
  exportStreamSession: (streamId: string, sessionId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
83079
+ /**
83080
+ * Queues an asynchronous export job for the given stream session (sessionId), whether or not its stream input still exists, emailing the requesting user a download when the export completes; requires the read permission on streams.
83081
+ * @summary Request an export of a stream session by session id
83082
+ * @param {string} sessionId The session identifier
83083
+ * @param {*} [options] Override http request option.
83084
+ * @throws {RequiredError}
83085
+ */
83086
+ exportStreamSessionById: (sessionId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
83087
+ /**
83088
+ * Returns a paginated list of the organization\'s broadcast sessions across every stream input, including sessions whose input has been deleted, filterable by stream input, event, event session and status and searchable by session or input name; requires read permission on streams.
83089
+ * @summary List stream sessions across all stream inputs
83090
+ * @param {string} [streamId] Filter by streamId
83091
+ * @param {string} [eventId] Filter by eventId
83092
+ * @param {string} [eventSessionId] Filter by eventSessionId
83093
+ * @param {string} [status] Filter by status
83094
+ * @param {number} [page] Page number
83095
+ * @param {number} [pageSize] Number of items per page
83096
+ * @param {string} [orderBy] Field to order by
83097
+ * @param {string} [search] Search query
83098
+ * @param {*} [options] Override http request option.
83099
+ * @throws {RequiredError}
83100
+ */
83101
+ getAllStreamSessions: (streamId?: string, eventId?: string, eventSessionId?: string, status?: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
83062
83102
  /**
83063
83103
  * Returns details for one broadcast session of the given stream input, such as its status and timing information; requires read permission on streams.
83064
83104
  * @summary Get a single stream session
@@ -83068,6 +83108,35 @@ export declare const StreamsSessionsApiAxiosParamCreator: (configuration?: Confi
83068
83108
  * @throws {RequiredError}
83069
83109
  */
83070
83110
  getStreamSession: (streamId: string, sessionId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
83111
+ /**
83112
+ * Returns one broadcast session by its id alone, whether or not its stream input still exists, with its name, status, timing and the event and event session it belongs to; requires read permission on streams.
83113
+ * @summary Get a stream session by id
83114
+ * @param {string} sessionId The session identifier
83115
+ * @param {*} [options] Override http request option.
83116
+ * @throws {RequiredError}
83117
+ */
83118
+ getStreamSessionById: (sessionId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
83119
+ /**
83120
+ * Returns a cursor-paginated list of the most recent chat messages sent during the given stream session, whether or not its stream input still exists; requires read permission on streams.
83121
+ * @summary List a stream session\'s chat messages by session id
83122
+ * @param {string} sessionId The session identifier
83123
+ * @param {*} [options] Override http request option.
83124
+ * @throws {RequiredError}
83125
+ */
83126
+ getStreamSessionByIdChat: (sessionId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
83127
+ /**
83128
+ * Returns a paginated list of viewer WebSocket subscriptions for the given stream session, whether or not its stream input still exists, optionally filtered to only active (not yet disconnected) subscriptions; requires read permission on streams.
83129
+ * @summary List a stream session\'s viewer connections by session id
83130
+ * @param {string} sessionId The session identifier
83131
+ * @param {boolean} [active] Filter by active
83132
+ * @param {number} [page] Page number
83133
+ * @param {number} [pageSize] Number of items per page
83134
+ * @param {string} [orderBy] Field to order by
83135
+ * @param {string} [search] Search query
83136
+ * @param {*} [options] Override http request option.
83137
+ * @throws {RequiredError}
83138
+ */
83139
+ getStreamSessionByIdSubscriptions: (sessionId: string, active?: boolean, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
83071
83140
  /**
83072
83141
  * Returns a cursor-paginated list of the most recent chat messages sent during the given stream session, ordered for chronological display; requires read permission on streams.
83073
83142
  * @summary List a stream session\'s chat messages
@@ -83104,6 +83173,15 @@ export declare const StreamsSessionsApiAxiosParamCreator: (configuration?: Confi
83104
83173
  * @throws {RequiredError}
83105
83174
  */
83106
83175
  getStreamSessions: (streamId: string, status?: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
83176
+ /**
83177
+ * Renames a broadcast session (sessionId) or changes the event and event session it belongs to; eventSessionId requires eventId, and changing eventId without an eventSessionId clears the event session; requires the read and update permissions on streams.
83178
+ * @summary Update a stream session
83179
+ * @param {string} sessionId The session identifier
83180
+ * @param {StreamSessionUpdateInputs} streamSessionUpdateInputs
83181
+ * @param {*} [options] Override http request option.
83182
+ * @throws {RequiredError}
83183
+ */
83184
+ updateStreamSession: (sessionId: string, streamSessionUpdateInputs: StreamSessionUpdateInputs, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
83107
83185
  };
83108
83186
  /**
83109
83187
  * StreamsSessionsApi - functional programming interface
@@ -83127,6 +83205,29 @@ export declare const StreamsSessionsApiFp: (configuration?: Configuration) => {
83127
83205
  * @throws {RequiredError}
83128
83206
  */
83129
83207
  exportStreamSession(streamId: string, sessionId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAccountInvitations200Response>>;
83208
+ /**
83209
+ * Queues an asynchronous export job for the given stream session (sessionId), whether or not its stream input still exists, emailing the requesting user a download when the export completes; requires the read permission on streams.
83210
+ * @summary Request an export of a stream session by session id
83211
+ * @param {string} sessionId The session identifier
83212
+ * @param {*} [options] Override http request option.
83213
+ * @throws {RequiredError}
83214
+ */
83215
+ exportStreamSessionById(sessionId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAccountInvitations200Response>>;
83216
+ /**
83217
+ * Returns a paginated list of the organization\'s broadcast sessions across every stream input, including sessions whose input has been deleted, filterable by stream input, event, event session and status and searchable by session or input name; requires read permission on streams.
83218
+ * @summary List stream sessions across all stream inputs
83219
+ * @param {string} [streamId] Filter by streamId
83220
+ * @param {string} [eventId] Filter by eventId
83221
+ * @param {string} [eventSessionId] Filter by eventSessionId
83222
+ * @param {string} [status] Filter by status
83223
+ * @param {number} [page] Page number
83224
+ * @param {number} [pageSize] Number of items per page
83225
+ * @param {string} [orderBy] Field to order by
83226
+ * @param {string} [search] Search query
83227
+ * @param {*} [options] Override http request option.
83228
+ * @throws {RequiredError}
83229
+ */
83230
+ getAllStreamSessions(streamId?: string, eventId?: string, eventSessionId?: string, status?: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAllStreamSessions200Response>>;
83130
83231
  /**
83131
83232
  * Returns details for one broadcast session of the given stream input, such as its status and timing information; requires read permission on streams.
83132
83233
  * @summary Get a single stream session
@@ -83135,7 +83236,36 @@ export declare const StreamsSessionsApiFp: (configuration?: Configuration) => {
83135
83236
  * @param {*} [options] Override http request option.
83136
83237
  * @throws {RequiredError}
83137
83238
  */
83138
- getStreamSession(streamId: string, sessionId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetStreamSession200Response>>;
83239
+ getStreamSession(streamId: string, sessionId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetStreamSessionById200Response>>;
83240
+ /**
83241
+ * Returns one broadcast session by its id alone, whether or not its stream input still exists, with its name, status, timing and the event and event session it belongs to; requires read permission on streams.
83242
+ * @summary Get a stream session by id
83243
+ * @param {string} sessionId The session identifier
83244
+ * @param {*} [options] Override http request option.
83245
+ * @throws {RequiredError}
83246
+ */
83247
+ getStreamSessionById(sessionId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetStreamSessionById200Response>>;
83248
+ /**
83249
+ * Returns a cursor-paginated list of the most recent chat messages sent during the given stream session, whether or not its stream input still exists; requires read permission on streams.
83250
+ * @summary List a stream session\'s chat messages by session id
83251
+ * @param {string} sessionId The session identifier
83252
+ * @param {*} [options] Override http request option.
83253
+ * @throws {RequiredError}
83254
+ */
83255
+ getStreamSessionByIdChat(sessionId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetStreamSessionByIdChat200Response>>;
83256
+ /**
83257
+ * Returns a paginated list of viewer WebSocket subscriptions for the given stream session, whether or not its stream input still exists, optionally filtered to only active (not yet disconnected) subscriptions; requires read permission on streams.
83258
+ * @summary List a stream session\'s viewer connections by session id
83259
+ * @param {string} sessionId The session identifier
83260
+ * @param {boolean} [active] Filter by active
83261
+ * @param {number} [page] Page number
83262
+ * @param {number} [pageSize] Number of items per page
83263
+ * @param {string} [orderBy] Field to order by
83264
+ * @param {string} [search] Search query
83265
+ * @param {*} [options] Override http request option.
83266
+ * @throws {RequiredError}
83267
+ */
83268
+ getStreamSessionByIdSubscriptions(sessionId: string, active?: boolean, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetStreamSessionByIdSubscriptions200Response>>;
83139
83269
  /**
83140
83270
  * Returns a cursor-paginated list of the most recent chat messages sent during the given stream session, ordered for chronological display; requires read permission on streams.
83141
83271
  * @summary List a stream session\'s chat messages
@@ -83144,7 +83274,7 @@ export declare const StreamsSessionsApiFp: (configuration?: Configuration) => {
83144
83274
  * @param {*} [options] Override http request option.
83145
83275
  * @throws {RequiredError}
83146
83276
  */
83147
- getStreamSessionChat(streamId: string, sessionId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetStreamSessionChat200Response>>;
83277
+ getStreamSessionChat(streamId: string, sessionId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetStreamSessionByIdChat200Response>>;
83148
83278
  /**
83149
83279
  * Returns a paginated list of viewer WebSocket subscriptions for the given stream session, each with its connection details, optionally filtered to only active (not yet disconnected) subscriptions; requires read permission on streams.
83150
83280
  * @summary List a stream session\'s viewer connections
@@ -83158,7 +83288,7 @@ export declare const StreamsSessionsApiFp: (configuration?: Configuration) => {
83158
83288
  * @param {*} [options] Override http request option.
83159
83289
  * @throws {RequiredError}
83160
83290
  */
83161
- getStreamSessionSubscriptions(streamId: string, sessionId: string, active?: boolean, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetStreamSessionSubscriptions200Response>>;
83291
+ getStreamSessionSubscriptions(streamId: string, sessionId: string, active?: boolean, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetStreamSessionByIdSubscriptions200Response>>;
83162
83292
  /**
83163
83293
  * Returns a paginated list of broadcast sessions for the given stream input, filterable by session status; requires read permission on streams.
83164
83294
  * @summary List a stream\'s broadcast sessions
@@ -83171,7 +83301,16 @@ export declare const StreamsSessionsApiFp: (configuration?: Configuration) => {
83171
83301
  * @param {*} [options] Override http request option.
83172
83302
  * @throws {RequiredError}
83173
83303
  */
83174
- getStreamSessions(streamId: string, status?: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetStreamSessions200Response>>;
83304
+ getStreamSessions(streamId: string, status?: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAllStreamSessions200Response>>;
83305
+ /**
83306
+ * Renames a broadcast session (sessionId) or changes the event and event session it belongs to; eventSessionId requires eventId, and changing eventId without an eventSessionId clears the event session; requires the read and update permissions on streams.
83307
+ * @summary Update a stream session
83308
+ * @param {string} sessionId The session identifier
83309
+ * @param {StreamSessionUpdateInputs} streamSessionUpdateInputs
83310
+ * @param {*} [options] Override http request option.
83311
+ * @throws {RequiredError}
83312
+ */
83313
+ updateStreamSession(sessionId: string, streamSessionUpdateInputs: StreamSessionUpdateInputs, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetStreamSessionById200Response>>;
83175
83314
  };
83176
83315
  /**
83177
83316
  * StreamsSessionsApi - factory interface
@@ -83193,6 +83332,22 @@ export declare const StreamsSessionsApiFactory: (configuration?: Configuration,
83193
83332
  * @throws {RequiredError}
83194
83333
  */
83195
83334
  exportStreamSession(requestParameters: StreamsSessionsApiExportStreamSessionRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateAccountInvitations200Response>;
83335
+ /**
83336
+ * Queues an asynchronous export job for the given stream session (sessionId), whether or not its stream input still exists, emailing the requesting user a download when the export completes; requires the read permission on streams.
83337
+ * @summary Request an export of a stream session by session id
83338
+ * @param {StreamsSessionsApiExportStreamSessionByIdRequest} requestParameters Request parameters.
83339
+ * @param {*} [options] Override http request option.
83340
+ * @throws {RequiredError}
83341
+ */
83342
+ exportStreamSessionById(requestParameters: StreamsSessionsApiExportStreamSessionByIdRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateAccountInvitations200Response>;
83343
+ /**
83344
+ * Returns a paginated list of the organization\'s broadcast sessions across every stream input, including sessions whose input has been deleted, filterable by stream input, event, event session and status and searchable by session or input name; requires read permission on streams.
83345
+ * @summary List stream sessions across all stream inputs
83346
+ * @param {StreamsSessionsApiGetAllStreamSessionsRequest} requestParameters Request parameters.
83347
+ * @param {*} [options] Override http request option.
83348
+ * @throws {RequiredError}
83349
+ */
83350
+ getAllStreamSessions(requestParameters?: StreamsSessionsApiGetAllStreamSessionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetAllStreamSessions200Response>;
83196
83351
  /**
83197
83352
  * Returns details for one broadcast session of the given stream input, such as its status and timing information; requires read permission on streams.
83198
83353
  * @summary Get a single stream session
@@ -83200,7 +83355,31 @@ export declare const StreamsSessionsApiFactory: (configuration?: Configuration,
83200
83355
  * @param {*} [options] Override http request option.
83201
83356
  * @throws {RequiredError}
83202
83357
  */
83203
- getStreamSession(requestParameters: StreamsSessionsApiGetStreamSessionRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetStreamSession200Response>;
83358
+ getStreamSession(requestParameters: StreamsSessionsApiGetStreamSessionRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetStreamSessionById200Response>;
83359
+ /**
83360
+ * Returns one broadcast session by its id alone, whether or not its stream input still exists, with its name, status, timing and the event and event session it belongs to; requires read permission on streams.
83361
+ * @summary Get a stream session by id
83362
+ * @param {StreamsSessionsApiGetStreamSessionByIdRequest} requestParameters Request parameters.
83363
+ * @param {*} [options] Override http request option.
83364
+ * @throws {RequiredError}
83365
+ */
83366
+ getStreamSessionById(requestParameters: StreamsSessionsApiGetStreamSessionByIdRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetStreamSessionById200Response>;
83367
+ /**
83368
+ * Returns a cursor-paginated list of the most recent chat messages sent during the given stream session, whether or not its stream input still exists; requires read permission on streams.
83369
+ * @summary List a stream session\'s chat messages by session id
83370
+ * @param {StreamsSessionsApiGetStreamSessionByIdChatRequest} requestParameters Request parameters.
83371
+ * @param {*} [options] Override http request option.
83372
+ * @throws {RequiredError}
83373
+ */
83374
+ getStreamSessionByIdChat(requestParameters: StreamsSessionsApiGetStreamSessionByIdChatRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetStreamSessionByIdChat200Response>;
83375
+ /**
83376
+ * Returns a paginated list of viewer WebSocket subscriptions for the given stream session, whether or not its stream input still exists, optionally filtered to only active (not yet disconnected) subscriptions; requires read permission on streams.
83377
+ * @summary List a stream session\'s viewer connections by session id
83378
+ * @param {StreamsSessionsApiGetStreamSessionByIdSubscriptionsRequest} requestParameters Request parameters.
83379
+ * @param {*} [options] Override http request option.
83380
+ * @throws {RequiredError}
83381
+ */
83382
+ getStreamSessionByIdSubscriptions(requestParameters: StreamsSessionsApiGetStreamSessionByIdSubscriptionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetStreamSessionByIdSubscriptions200Response>;
83204
83383
  /**
83205
83384
  * Returns a cursor-paginated list of the most recent chat messages sent during the given stream session, ordered for chronological display; requires read permission on streams.
83206
83385
  * @summary List a stream session\'s chat messages
@@ -83208,7 +83387,7 @@ export declare const StreamsSessionsApiFactory: (configuration?: Configuration,
83208
83387
  * @param {*} [options] Override http request option.
83209
83388
  * @throws {RequiredError}
83210
83389
  */
83211
- getStreamSessionChat(requestParameters: StreamsSessionsApiGetStreamSessionChatRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetStreamSessionChat200Response>;
83390
+ getStreamSessionChat(requestParameters: StreamsSessionsApiGetStreamSessionChatRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetStreamSessionByIdChat200Response>;
83212
83391
  /**
83213
83392
  * Returns a paginated list of viewer WebSocket subscriptions for the given stream session, each with its connection details, optionally filtered to only active (not yet disconnected) subscriptions; requires read permission on streams.
83214
83393
  * @summary List a stream session\'s viewer connections
@@ -83216,7 +83395,7 @@ export declare const StreamsSessionsApiFactory: (configuration?: Configuration,
83216
83395
  * @param {*} [options] Override http request option.
83217
83396
  * @throws {RequiredError}
83218
83397
  */
83219
- getStreamSessionSubscriptions(requestParameters: StreamsSessionsApiGetStreamSessionSubscriptionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetStreamSessionSubscriptions200Response>;
83398
+ getStreamSessionSubscriptions(requestParameters: StreamsSessionsApiGetStreamSessionSubscriptionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetStreamSessionByIdSubscriptions200Response>;
83220
83399
  /**
83221
83400
  * Returns a paginated list of broadcast sessions for the given stream input, filterable by session status; requires read permission on streams.
83222
83401
  * @summary List a stream\'s broadcast sessions
@@ -83224,7 +83403,15 @@ export declare const StreamsSessionsApiFactory: (configuration?: Configuration,
83224
83403
  * @param {*} [options] Override http request option.
83225
83404
  * @throws {RequiredError}
83226
83405
  */
83227
- getStreamSessions(requestParameters: StreamsSessionsApiGetStreamSessionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetStreamSessions200Response>;
83406
+ getStreamSessions(requestParameters: StreamsSessionsApiGetStreamSessionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetAllStreamSessions200Response>;
83407
+ /**
83408
+ * Renames a broadcast session (sessionId) or changes the event and event session it belongs to; eventSessionId requires eventId, and changing eventId without an eventSessionId clears the event session; requires the read and update permissions on streams.
83409
+ * @summary Update a stream session
83410
+ * @param {StreamsSessionsApiUpdateStreamSessionRequest} requestParameters Request parameters.
83411
+ * @param {*} [options] Override http request option.
83412
+ * @throws {RequiredError}
83413
+ */
83414
+ updateStreamSession(requestParameters: StreamsSessionsApiUpdateStreamSessionRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetStreamSessionById200Response>;
83228
83415
  };
83229
83416
  /**
83230
83417
  * Request parameters for closeStreamSession operation in StreamsSessionsApi.
@@ -83252,6 +83439,52 @@ export interface StreamsSessionsApiExportStreamSessionRequest {
83252
83439
  */
83253
83440
  readonly sessionId: string;
83254
83441
  }
83442
+ /**
83443
+ * Request parameters for exportStreamSessionById operation in StreamsSessionsApi.
83444
+ */
83445
+ export interface StreamsSessionsApiExportStreamSessionByIdRequest {
83446
+ /**
83447
+ * The session identifier
83448
+ */
83449
+ readonly sessionId: string;
83450
+ }
83451
+ /**
83452
+ * Request parameters for getAllStreamSessions operation in StreamsSessionsApi.
83453
+ */
83454
+ export interface StreamsSessionsApiGetAllStreamSessionsRequest {
83455
+ /**
83456
+ * Filter by streamId
83457
+ */
83458
+ readonly streamId?: string;
83459
+ /**
83460
+ * Filter by eventId
83461
+ */
83462
+ readonly eventId?: string;
83463
+ /**
83464
+ * Filter by eventSessionId
83465
+ */
83466
+ readonly eventSessionId?: string;
83467
+ /**
83468
+ * Filter by status
83469
+ */
83470
+ readonly status?: string;
83471
+ /**
83472
+ * Page number
83473
+ */
83474
+ readonly page?: number;
83475
+ /**
83476
+ * Number of items per page
83477
+ */
83478
+ readonly pageSize?: number;
83479
+ /**
83480
+ * Field to order by
83481
+ */
83482
+ readonly orderBy?: string;
83483
+ /**
83484
+ * Search query
83485
+ */
83486
+ readonly search?: string;
83487
+ }
83255
83488
  /**
83256
83489
  * Request parameters for getStreamSession operation in StreamsSessionsApi.
83257
83490
  */
@@ -83265,6 +83498,53 @@ export interface StreamsSessionsApiGetStreamSessionRequest {
83265
83498
  */
83266
83499
  readonly sessionId: string;
83267
83500
  }
83501
+ /**
83502
+ * Request parameters for getStreamSessionById operation in StreamsSessionsApi.
83503
+ */
83504
+ export interface StreamsSessionsApiGetStreamSessionByIdRequest {
83505
+ /**
83506
+ * The session identifier
83507
+ */
83508
+ readonly sessionId: string;
83509
+ }
83510
+ /**
83511
+ * Request parameters for getStreamSessionByIdChat operation in StreamsSessionsApi.
83512
+ */
83513
+ export interface StreamsSessionsApiGetStreamSessionByIdChatRequest {
83514
+ /**
83515
+ * The session identifier
83516
+ */
83517
+ readonly sessionId: string;
83518
+ }
83519
+ /**
83520
+ * Request parameters for getStreamSessionByIdSubscriptions operation in StreamsSessionsApi.
83521
+ */
83522
+ export interface StreamsSessionsApiGetStreamSessionByIdSubscriptionsRequest {
83523
+ /**
83524
+ * The session identifier
83525
+ */
83526
+ readonly sessionId: string;
83527
+ /**
83528
+ * Filter by active
83529
+ */
83530
+ readonly active?: boolean;
83531
+ /**
83532
+ * Page number
83533
+ */
83534
+ readonly page?: number;
83535
+ /**
83536
+ * Number of items per page
83537
+ */
83538
+ readonly pageSize?: number;
83539
+ /**
83540
+ * Field to order by
83541
+ */
83542
+ readonly orderBy?: string;
83543
+ /**
83544
+ * Search query
83545
+ */
83546
+ readonly search?: string;
83547
+ }
83268
83548
  /**
83269
83549
  * Request parameters for getStreamSessionChat operation in StreamsSessionsApi.
83270
83550
  */
@@ -83340,6 +83620,16 @@ export interface StreamsSessionsApiGetStreamSessionsRequest {
83340
83620
  */
83341
83621
  readonly search?: string;
83342
83622
  }
83623
+ /**
83624
+ * Request parameters for updateStreamSession operation in StreamsSessionsApi.
83625
+ */
83626
+ export interface StreamsSessionsApiUpdateStreamSessionRequest {
83627
+ /**
83628
+ * The session identifier
83629
+ */
83630
+ readonly sessionId: string;
83631
+ readonly streamSessionUpdateInputs: StreamSessionUpdateInputs;
83632
+ }
83343
83633
  /**
83344
83634
  * StreamsSessionsApi - object-oriented interface
83345
83635
  */
@@ -83360,6 +83650,22 @@ export declare class StreamsSessionsApi extends BaseAPI {
83360
83650
  * @throws {RequiredError}
83361
83651
  */
83362
83652
  exportStreamSession(requestParameters: StreamsSessionsApiExportStreamSessionRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateAccountInvitations200Response, any, {}, any>>;
83653
+ /**
83654
+ * Queues an asynchronous export job for the given stream session (sessionId), whether or not its stream input still exists, emailing the requesting user a download when the export completes; requires the read permission on streams.
83655
+ * @summary Request an export of a stream session by session id
83656
+ * @param {StreamsSessionsApiExportStreamSessionByIdRequest} requestParameters Request parameters.
83657
+ * @param {*} [options] Override http request option.
83658
+ * @throws {RequiredError}
83659
+ */
83660
+ exportStreamSessionById(requestParameters: StreamsSessionsApiExportStreamSessionByIdRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateAccountInvitations200Response, any, {}, any>>;
83661
+ /**
83662
+ * Returns a paginated list of the organization\'s broadcast sessions across every stream input, including sessions whose input has been deleted, filterable by stream input, event, event session and status and searchable by session or input name; requires read permission on streams.
83663
+ * @summary List stream sessions across all stream inputs
83664
+ * @param {StreamsSessionsApiGetAllStreamSessionsRequest} requestParameters Request parameters.
83665
+ * @param {*} [options] Override http request option.
83666
+ * @throws {RequiredError}
83667
+ */
83668
+ getAllStreamSessions(requestParameters?: StreamsSessionsApiGetAllStreamSessionsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetAllStreamSessions200Response, any, {}, any>>;
83363
83669
  /**
83364
83670
  * Returns details for one broadcast session of the given stream input, such as its status and timing information; requires read permission on streams.
83365
83671
  * @summary Get a single stream session
@@ -83367,7 +83673,31 @@ export declare class StreamsSessionsApi extends BaseAPI {
83367
83673
  * @param {*} [options] Override http request option.
83368
83674
  * @throws {RequiredError}
83369
83675
  */
83370
- getStreamSession(requestParameters: StreamsSessionsApiGetStreamSessionRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetStreamSession200Response, any, {}, any>>;
83676
+ getStreamSession(requestParameters: StreamsSessionsApiGetStreamSessionRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetStreamSessionById200Response, any, {}, any>>;
83677
+ /**
83678
+ * Returns one broadcast session by its id alone, whether or not its stream input still exists, with its name, status, timing and the event and event session it belongs to; requires read permission on streams.
83679
+ * @summary Get a stream session by id
83680
+ * @param {StreamsSessionsApiGetStreamSessionByIdRequest} requestParameters Request parameters.
83681
+ * @param {*} [options] Override http request option.
83682
+ * @throws {RequiredError}
83683
+ */
83684
+ getStreamSessionById(requestParameters: StreamsSessionsApiGetStreamSessionByIdRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetStreamSessionById200Response, any, {}, any>>;
83685
+ /**
83686
+ * Returns a cursor-paginated list of the most recent chat messages sent during the given stream session, whether or not its stream input still exists; requires read permission on streams.
83687
+ * @summary List a stream session\'s chat messages by session id
83688
+ * @param {StreamsSessionsApiGetStreamSessionByIdChatRequest} requestParameters Request parameters.
83689
+ * @param {*} [options] Override http request option.
83690
+ * @throws {RequiredError}
83691
+ */
83692
+ getStreamSessionByIdChat(requestParameters: StreamsSessionsApiGetStreamSessionByIdChatRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetStreamSessionByIdChat200Response, any, {}, any>>;
83693
+ /**
83694
+ * Returns a paginated list of viewer WebSocket subscriptions for the given stream session, whether or not its stream input still exists, optionally filtered to only active (not yet disconnected) subscriptions; requires read permission on streams.
83695
+ * @summary List a stream session\'s viewer connections by session id
83696
+ * @param {StreamsSessionsApiGetStreamSessionByIdSubscriptionsRequest} requestParameters Request parameters.
83697
+ * @param {*} [options] Override http request option.
83698
+ * @throws {RequiredError}
83699
+ */
83700
+ getStreamSessionByIdSubscriptions(requestParameters: StreamsSessionsApiGetStreamSessionByIdSubscriptionsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetStreamSessionByIdSubscriptions200Response, any, {}, any>>;
83371
83701
  /**
83372
83702
  * Returns a cursor-paginated list of the most recent chat messages sent during the given stream session, ordered for chronological display; requires read permission on streams.
83373
83703
  * @summary List a stream session\'s chat messages
@@ -83375,7 +83705,7 @@ export declare class StreamsSessionsApi extends BaseAPI {
83375
83705
  * @param {*} [options] Override http request option.
83376
83706
  * @throws {RequiredError}
83377
83707
  */
83378
- getStreamSessionChat(requestParameters: StreamsSessionsApiGetStreamSessionChatRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetStreamSessionChat200Response, any, {}, any>>;
83708
+ getStreamSessionChat(requestParameters: StreamsSessionsApiGetStreamSessionChatRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetStreamSessionByIdChat200Response, any, {}, any>>;
83379
83709
  /**
83380
83710
  * Returns a paginated list of viewer WebSocket subscriptions for the given stream session, each with its connection details, optionally filtered to only active (not yet disconnected) subscriptions; requires read permission on streams.
83381
83711
  * @summary List a stream session\'s viewer connections
@@ -83383,7 +83713,7 @@ export declare class StreamsSessionsApi extends BaseAPI {
83383
83713
  * @param {*} [options] Override http request option.
83384
83714
  * @throws {RequiredError}
83385
83715
  */
83386
- getStreamSessionSubscriptions(requestParameters: StreamsSessionsApiGetStreamSessionSubscriptionsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetStreamSessionSubscriptions200Response, any, {}, any>>;
83716
+ getStreamSessionSubscriptions(requestParameters: StreamsSessionsApiGetStreamSessionSubscriptionsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetStreamSessionByIdSubscriptions200Response, any, {}, any>>;
83387
83717
  /**
83388
83718
  * Returns a paginated list of broadcast sessions for the given stream input, filterable by session status; requires read permission on streams.
83389
83719
  * @summary List a stream\'s broadcast sessions
@@ -83391,7 +83721,15 @@ export declare class StreamsSessionsApi extends BaseAPI {
83391
83721
  * @param {*} [options] Override http request option.
83392
83722
  * @throws {RequiredError}
83393
83723
  */
83394
- getStreamSessions(requestParameters: StreamsSessionsApiGetStreamSessionsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetStreamSessions200Response, any, {}, any>>;
83724
+ getStreamSessions(requestParameters: StreamsSessionsApiGetStreamSessionsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetAllStreamSessions200Response, any, {}, any>>;
83725
+ /**
83726
+ * Renames a broadcast session (sessionId) or changes the event and event session it belongs to; eventSessionId requires eventId, and changing eventId without an eventSessionId clears the event session; requires the read and update permissions on streams.
83727
+ * @summary Update a stream session
83728
+ * @param {StreamsSessionsApiUpdateStreamSessionRequest} requestParameters Request parameters.
83729
+ * @param {*} [options] Override http request option.
83730
+ * @throws {RequiredError}
83731
+ */
83732
+ updateStreamSession(requestParameters: StreamsSessionsApiUpdateStreamSessionRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetStreamSessionById200Response, any, {}, any>>;
83395
83733
  }
83396
83734
  /**
83397
83735
  * SupportApi - axios parameter creator