@connectedxm/admin-sdk 13.7.0 → 14.0.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/README.md CHANGED
@@ -1,4 +1,4 @@
1
- ## @connectedxm/admin-sdk@13.7.0
1
+ ## @connectedxm/admin-sdk@14.0.0
2
2
 
3
3
  This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:
4
4
 
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
36
36
  _published:_
37
37
 
38
38
  ```
39
- npm install @connectedxm/admin-sdk@13.7.0 --save
39
+ npm install @connectedxm/admin-sdk@14.0.0 --save
40
40
  ```
41
41
 
42
42
  _unPublished (not recommended):_
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: 13.7.0
7
+ * The version of the OpenAPI document: 14.0.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -15167,8 +15167,12 @@ export interface StreamSessionUpdateInputs {
15167
15167
  export interface StreamSessionViewer {
15168
15168
  'accountId': string | null;
15169
15169
  'account': BaseAccount | null;
15170
+ 'active': boolean;
15170
15171
  'activeConnections': number;
15172
+ 'connections': number;
15171
15173
  'connectedAt': string;
15174
+ 'disconnectedAt': string | null;
15175
+ 'duration': number;
15172
15176
  }
15173
15177
  export interface StripeActivationFormParams {
15174
15178
  'clientPublicKey': string;
@@ -151898,6 +151902,50 @@ export const StreamsSessionsApiAxiosParamCreator = function (configuration?: Con
151898
151902
  options: localVarRequestOptions,
151899
151903
  };
151900
151904
  },
151905
+ /**
151906
+ * Permanently deletes a chat message (messageId) from the given stream session (sessionId), whether the session is active or ended and whether or not its stream input still exists; requires the read and update permissions on streams.
151907
+ * @summary Delete a stream session chat message
151908
+ * @param {string} sessionId The session identifier
151909
+ * @param {string} messageId The message identifier
151910
+ * @param {*} [options] Override http request option.
151911
+ * @throws {RequiredError}
151912
+ */
151913
+ deleteStreamSessionChatMessage: async (sessionId: string, messageId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
151914
+ // verify required parameter 'sessionId' is not null or undefined
151915
+ assertParamExists('deleteStreamSessionChatMessage', 'sessionId', sessionId)
151916
+ // verify required parameter 'messageId' is not null or undefined
151917
+ assertParamExists('deleteStreamSessionChatMessage', 'messageId', messageId)
151918
+ const localVarPath = `/streams/sessions/{sessionId}/chat/{messageId}`
151919
+ .replace('{sessionId}', encodeURIComponent(String(sessionId)))
151920
+ .replace('{messageId}', encodeURIComponent(String(messageId)));
151921
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
151922
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
151923
+ let baseOptions;
151924
+ if (configuration) {
151925
+ baseOptions = configuration.baseOptions;
151926
+ }
151927
+
151928
+ const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
151929
+ const localVarHeaderParameter = {} as any;
151930
+ const localVarQueryParameter = {} as any;
151931
+
151932
+ // authentication ApiKeyAuth required
151933
+ await setApiKeyToObject(localVarHeaderParameter, "api-key", configuration)
151934
+
151935
+ // authentication OrganizationId required
151936
+ await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
151937
+
151938
+ localVarHeaderParameter['Accept'] = 'application/json';
151939
+
151940
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
151941
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
151942
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
151943
+
151944
+ return {
151945
+ url: toPathString(localVarUrlObj),
151946
+ options: localVarRequestOptions,
151947
+ };
151948
+ },
151901
151949
  /**
151902
151950
  * Queues an asynchronous export job for the given stream session (sessionId), emailing the requesting user a download when the export completes; requires the read permission on streams.
151903
151951
  * @summary Request an export of a stream session
@@ -152361,9 +152409,10 @@ export const StreamsSessionsApiAxiosParamCreator = function (configuration?: Con
152361
152409
  };
152362
152410
  },
152363
152411
  /**
152364
- * Returns a paginated list of the accounts currently watching the given stream session, one row per account with how many active connections it holds and when its earliest one connected; the count is the number of people watching, where the subscriptions list counts connections. Requires read permission on streams.
152365
- * @summary List the people watching a stream session
152412
+ * Returns a paginated list of the accounts that watched the given stream session, one row per account: whether it is still watching, its active and total connection counts, first connect, last disconnect (null while watching) and watch time in milliseconds with overlapping connections counted once. active=true (the default) returns only people still watching, active=false only people who left; the count is people, where the subscriptions list counts connections. Requires read permission on streams.
152413
+ * @summary List the people who watched a stream session
152366
152414
  * @param {string} sessionId The session identifier
152415
+ * @param {boolean} [active] Filter by active
152367
152416
  * @param {number} [page] Page number
152368
152417
  * @param {number} [pageSize] Number of items per page
152369
152418
  * @param {string} [orderBy] Field to order by
@@ -152371,7 +152420,7 @@ export const StreamsSessionsApiAxiosParamCreator = function (configuration?: Con
152371
152420
  * @param {*} [options] Override http request option.
152372
152421
  * @throws {RequiredError}
152373
152422
  */
152374
- getStreamSessionViewers: async (sessionId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
152423
+ getStreamSessionViewers: async (sessionId: string, active?: boolean, page?: number, pageSize?: number, orderBy?: string, search?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
152375
152424
  // verify required parameter 'sessionId' is not null or undefined
152376
152425
  assertParamExists('getStreamSessionViewers', 'sessionId', sessionId)
152377
152426
  const localVarPath = `/streams/sessions/{sessionId}/viewers`
@@ -152393,6 +152442,10 @@ export const StreamsSessionsApiAxiosParamCreator = function (configuration?: Con
152393
152442
  // authentication OrganizationId required
152394
152443
  await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
152395
152444
 
152445
+ if (active !== undefined) {
152446
+ localVarQueryParameter['active'] = active;
152447
+ }
152448
+
152396
152449
  if (page !== undefined) {
152397
152450
  localVarQueryParameter['page'] = page;
152398
152451
  }
@@ -152553,6 +152606,20 @@ export const StreamsSessionsApiFp = function(configuration?: Configuration) {
152553
152606
  const localVarOperationServerBasePath = operationServerMap['StreamsSessionsApi.closeStreamSession']?.[localVarOperationServerIndex]?.url;
152554
152607
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
152555
152608
  },
152609
+ /**
152610
+ * Permanently deletes a chat message (messageId) from the given stream session (sessionId), whether the session is active or ended and whether or not its stream input still exists; requires the read and update permissions on streams.
152611
+ * @summary Delete a stream session chat message
152612
+ * @param {string} sessionId The session identifier
152613
+ * @param {string} messageId The message identifier
152614
+ * @param {*} [options] Override http request option.
152615
+ * @throws {RequiredError}
152616
+ */
152617
+ async deleteStreamSessionChatMessage(sessionId: string, messageId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAccountInvitations200Response>> {
152618
+ const localVarAxiosArgs = await localVarAxiosParamCreator.deleteStreamSessionChatMessage(sessionId, messageId, options);
152619
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
152620
+ const localVarOperationServerBasePath = operationServerMap['StreamsSessionsApi.deleteStreamSessionChatMessage']?.[localVarOperationServerIndex]?.url;
152621
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
152622
+ },
152556
152623
  /**
152557
152624
  * Queues an asynchronous export job for the given stream session (sessionId), emailing the requesting user a download when the export completes; requires the read permission on streams.
152558
152625
  * @summary Request an export of a stream session
@@ -152692,9 +152759,10 @@ export const StreamsSessionsApiFp = function(configuration?: Configuration) {
152692
152759
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
152693
152760
  },
152694
152761
  /**
152695
- * Returns a paginated list of the accounts currently watching the given stream session, one row per account with how many active connections it holds and when its earliest one connected; the count is the number of people watching, where the subscriptions list counts connections. Requires read permission on streams.
152696
- * @summary List the people watching a stream session
152762
+ * Returns a paginated list of the accounts that watched the given stream session, one row per account: whether it is still watching, its active and total connection counts, first connect, last disconnect (null while watching) and watch time in milliseconds with overlapping connections counted once. active=true (the default) returns only people still watching, active=false only people who left; the count is people, where the subscriptions list counts connections. Requires read permission on streams.
152763
+ * @summary List the people who watched a stream session
152697
152764
  * @param {string} sessionId The session identifier
152765
+ * @param {boolean} [active] Filter by active
152698
152766
  * @param {number} [page] Page number
152699
152767
  * @param {number} [pageSize] Number of items per page
152700
152768
  * @param {string} [orderBy] Field to order by
@@ -152702,8 +152770,8 @@ export const StreamsSessionsApiFp = function(configuration?: Configuration) {
152702
152770
  * @param {*} [options] Override http request option.
152703
152771
  * @throws {RequiredError}
152704
152772
  */
152705
- async getStreamSessionViewers(sessionId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetStreamSessionViewers200Response>> {
152706
- const localVarAxiosArgs = await localVarAxiosParamCreator.getStreamSessionViewers(sessionId, page, pageSize, orderBy, search, options);
152773
+ async getStreamSessionViewers(sessionId: string, active?: boolean, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetStreamSessionViewers200Response>> {
152774
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getStreamSessionViewers(sessionId, active, page, pageSize, orderBy, search, options);
152707
152775
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
152708
152776
  const localVarOperationServerBasePath = operationServerMap['StreamsSessionsApi.getStreamSessionViewers']?.[localVarOperationServerIndex]?.url;
152709
152777
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -152759,6 +152827,16 @@ export const StreamsSessionsApiFactory = function (configuration?: Configuration
152759
152827
  closeStreamSession(requestParameters: StreamsSessionsApiCloseStreamSessionRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateAccountInvitations200Response> {
152760
152828
  return localVarFp.closeStreamSession(requestParameters.streamId, requestParameters.sessionId, options).then((request) => request(axios, basePath));
152761
152829
  },
152830
+ /**
152831
+ * Permanently deletes a chat message (messageId) from the given stream session (sessionId), whether the session is active or ended and whether or not its stream input still exists; requires the read and update permissions on streams.
152832
+ * @summary Delete a stream session chat message
152833
+ * @param {StreamsSessionsApiDeleteStreamSessionChatMessageRequest} requestParameters Request parameters.
152834
+ * @param {*} [options] Override http request option.
152835
+ * @throws {RequiredError}
152836
+ */
152837
+ deleteStreamSessionChatMessage(requestParameters: StreamsSessionsApiDeleteStreamSessionChatMessageRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateAccountInvitations200Response> {
152838
+ return localVarFp.deleteStreamSessionChatMessage(requestParameters.sessionId, requestParameters.messageId, options).then((request) => request(axios, basePath));
152839
+ },
152762
152840
  /**
152763
152841
  * Queues an asynchronous export job for the given stream session (sessionId), emailing the requesting user a download when the export completes; requires the read permission on streams.
152764
152842
  * @summary Request an export of a stream session
@@ -152850,14 +152928,14 @@ export const StreamsSessionsApiFactory = function (configuration?: Configuration
152850
152928
  return localVarFp.getStreamSessionSubscriptions(requestParameters.streamId, requestParameters.sessionId, requestParameters.active, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
152851
152929
  },
152852
152930
  /**
152853
- * Returns a paginated list of the accounts currently watching the given stream session, one row per account with how many active connections it holds and when its earliest one connected; the count is the number of people watching, where the subscriptions list counts connections. Requires read permission on streams.
152854
- * @summary List the people watching a stream session
152931
+ * Returns a paginated list of the accounts that watched the given stream session, one row per account: whether it is still watching, its active and total connection counts, first connect, last disconnect (null while watching) and watch time in milliseconds with overlapping connections counted once. active=true (the default) returns only people still watching, active=false only people who left; the count is people, where the subscriptions list counts connections. Requires read permission on streams.
152932
+ * @summary List the people who watched a stream session
152855
152933
  * @param {StreamsSessionsApiGetStreamSessionViewersRequest} requestParameters Request parameters.
152856
152934
  * @param {*} [options] Override http request option.
152857
152935
  * @throws {RequiredError}
152858
152936
  */
152859
152937
  getStreamSessionViewers(requestParameters: StreamsSessionsApiGetStreamSessionViewersRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetStreamSessionViewers200Response> {
152860
- return localVarFp.getStreamSessionViewers(requestParameters.sessionId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
152938
+ return localVarFp.getStreamSessionViewers(requestParameters.sessionId, requestParameters.active, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
152861
152939
  },
152862
152940
  /**
152863
152941
  * Returns a paginated list of broadcast sessions for the given stream input, filterable by session status; requires read permission on streams.
@@ -152897,6 +152975,21 @@ export interface StreamsSessionsApiCloseStreamSessionRequest {
152897
152975
  readonly sessionId: string
152898
152976
  }
152899
152977
 
152978
+ /**
152979
+ * Request parameters for deleteStreamSessionChatMessage operation in StreamsSessionsApi.
152980
+ */
152981
+ export interface StreamsSessionsApiDeleteStreamSessionChatMessageRequest {
152982
+ /**
152983
+ * The session identifier
152984
+ */
152985
+ readonly sessionId: string
152986
+
152987
+ /**
152988
+ * The message identifier
152989
+ */
152990
+ readonly messageId: string
152991
+ }
152992
+
152900
152993
  /**
152901
152994
  * Request parameters for exportStreamSession operation in StreamsSessionsApi.
152902
152995
  */
@@ -153101,6 +153194,11 @@ export interface StreamsSessionsApiGetStreamSessionViewersRequest {
153101
153194
  */
153102
153195
  readonly sessionId: string
153103
153196
 
153197
+ /**
153198
+ * Filter by active
153199
+ */
153200
+ readonly active?: boolean
153201
+
153104
153202
  /**
153105
153203
  * Page number
153106
153204
  */
@@ -153184,6 +153282,17 @@ export class StreamsSessionsApi extends BaseAPI {
153184
153282
  return StreamsSessionsApiFp(this.configuration).closeStreamSession(requestParameters.streamId, requestParameters.sessionId, options).then((request) => request(this.axios, this.basePath));
153185
153283
  }
153186
153284
 
153285
+ /**
153286
+ * Permanently deletes a chat message (messageId) from the given stream session (sessionId), whether the session is active or ended and whether or not its stream input still exists; requires the read and update permissions on streams.
153287
+ * @summary Delete a stream session chat message
153288
+ * @param {StreamsSessionsApiDeleteStreamSessionChatMessageRequest} requestParameters Request parameters.
153289
+ * @param {*} [options] Override http request option.
153290
+ * @throws {RequiredError}
153291
+ */
153292
+ public deleteStreamSessionChatMessage(requestParameters: StreamsSessionsApiDeleteStreamSessionChatMessageRequest, options?: RawAxiosRequestConfig) {
153293
+ return StreamsSessionsApiFp(this.configuration).deleteStreamSessionChatMessage(requestParameters.sessionId, requestParameters.messageId, options).then((request) => request(this.axios, this.basePath));
153294
+ }
153295
+
153187
153296
  /**
153188
153297
  * Queues an asynchronous export job for the given stream session (sessionId), emailing the requesting user a download when the export completes; requires the read permission on streams.
153189
153298
  * @summary Request an export of a stream session
@@ -153284,14 +153393,14 @@ export class StreamsSessionsApi extends BaseAPI {
153284
153393
  }
153285
153394
 
153286
153395
  /**
153287
- * Returns a paginated list of the accounts currently watching the given stream session, one row per account with how many active connections it holds and when its earliest one connected; the count is the number of people watching, where the subscriptions list counts connections. Requires read permission on streams.
153288
- * @summary List the people watching a stream session
153396
+ * Returns a paginated list of the accounts that watched the given stream session, one row per account: whether it is still watching, its active and total connection counts, first connect, last disconnect (null while watching) and watch time in milliseconds with overlapping connections counted once. active=true (the default) returns only people still watching, active=false only people who left; the count is people, where the subscriptions list counts connections. Requires read permission on streams.
153397
+ * @summary List the people who watched a stream session
153289
153398
  * @param {StreamsSessionsApiGetStreamSessionViewersRequest} requestParameters Request parameters.
153290
153399
  * @param {*} [options] Override http request option.
153291
153400
  * @throws {RequiredError}
153292
153401
  */
153293
153402
  public getStreamSessionViewers(requestParameters: StreamsSessionsApiGetStreamSessionViewersRequest, options?: RawAxiosRequestConfig) {
153294
- return StreamsSessionsApiFp(this.configuration).getStreamSessionViewers(requestParameters.sessionId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
153403
+ return StreamsSessionsApiFp(this.configuration).getStreamSessionViewers(requestParameters.sessionId, requestParameters.active, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
153295
153404
  }
153296
153405
 
153297
153406
  /**
package/base.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: 13.7.0
7
+ * The version of the OpenAPI document: 14.0.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/common.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: 13.7.0
7
+ * The version of the OpenAPI document: 14.0.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/configuration.ts CHANGED
@@ -3,7 +3,7 @@
3
3
  * Connected Admin API
4
4
  * The Admin API allows you to manage your Connected community programmatically.
5
5
  *
6
- * The version of the OpenAPI document: 13.7.0
6
+ * The version of the OpenAPI document: 14.0.0
7
7
  *
8
8
  *
9
9
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/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.7.0
5
+ * The version of the OpenAPI document: 14.0.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -13497,8 +13497,12 @@ export interface StreamSessionUpdateInputs {
13497
13497
  export interface StreamSessionViewer {
13498
13498
  'accountId': string | null;
13499
13499
  'account': BaseAccount | null;
13500
+ 'active': boolean;
13500
13501
  'activeConnections': number;
13502
+ 'connections': number;
13501
13503
  'connectedAt': string;
13504
+ 'disconnectedAt': string | null;
13505
+ 'duration': number;
13502
13506
  }
13503
13507
  export interface StripeActivationFormParams {
13504
13508
  'clientPublicKey': string;
@@ -83082,6 +83086,15 @@ export declare const StreamsSessionsApiAxiosParamCreator: (configuration?: Confi
83082
83086
  * @throws {RequiredError}
83083
83087
  */
83084
83088
  closeStreamSession: (streamId: string, sessionId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
83089
+ /**
83090
+ * Permanently deletes a chat message (messageId) from the given stream session (sessionId), whether the session is active or ended and whether or not its stream input still exists; requires the read and update permissions on streams.
83091
+ * @summary Delete a stream session chat message
83092
+ * @param {string} sessionId The session identifier
83093
+ * @param {string} messageId The message identifier
83094
+ * @param {*} [options] Override http request option.
83095
+ * @throws {RequiredError}
83096
+ */
83097
+ deleteStreamSessionChatMessage: (sessionId: string, messageId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
83085
83098
  /**
83086
83099
  * Queues an asynchronous export job for the given stream session (sessionId), emailing the requesting user a download when the export completes; requires the read permission on streams.
83087
83100
  * @summary Request an export of a stream session
@@ -83176,9 +83189,10 @@ export declare const StreamsSessionsApiAxiosParamCreator: (configuration?: Confi
83176
83189
  */
83177
83190
  getStreamSessionSubscriptions: (streamId: string, sessionId: string, active?: boolean, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
83178
83191
  /**
83179
- * Returns a paginated list of the accounts currently watching the given stream session, one row per account with how many active connections it holds and when its earliest one connected; the count is the number of people watching, where the subscriptions list counts connections. Requires read permission on streams.
83180
- * @summary List the people watching a stream session
83192
+ * Returns a paginated list of the accounts that watched the given stream session, one row per account: whether it is still watching, its active and total connection counts, first connect, last disconnect (null while watching) and watch time in milliseconds with overlapping connections counted once. active=true (the default) returns only people still watching, active=false only people who left; the count is people, where the subscriptions list counts connections. Requires read permission on streams.
83193
+ * @summary List the people who watched a stream session
83181
83194
  * @param {string} sessionId The session identifier
83195
+ * @param {boolean} [active] Filter by active
83182
83196
  * @param {number} [page] Page number
83183
83197
  * @param {number} [pageSize] Number of items per page
83184
83198
  * @param {string} [orderBy] Field to order by
@@ -83186,7 +83200,7 @@ export declare const StreamsSessionsApiAxiosParamCreator: (configuration?: Confi
83186
83200
  * @param {*} [options] Override http request option.
83187
83201
  * @throws {RequiredError}
83188
83202
  */
83189
- getStreamSessionViewers: (sessionId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
83203
+ getStreamSessionViewers: (sessionId: string, active?: boolean, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
83190
83204
  /**
83191
83205
  * Returns a paginated list of broadcast sessions for the given stream input, filterable by session status; requires read permission on streams.
83192
83206
  * @summary List a stream\'s broadcast sessions
@@ -83223,6 +83237,15 @@ export declare const StreamsSessionsApiFp: (configuration?: Configuration) => {
83223
83237
  * @throws {RequiredError}
83224
83238
  */
83225
83239
  closeStreamSession(streamId: string, sessionId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAccountInvitations200Response>>;
83240
+ /**
83241
+ * Permanently deletes a chat message (messageId) from the given stream session (sessionId), whether the session is active or ended and whether or not its stream input still exists; requires the read and update permissions on streams.
83242
+ * @summary Delete a stream session chat message
83243
+ * @param {string} sessionId The session identifier
83244
+ * @param {string} messageId The message identifier
83245
+ * @param {*} [options] Override http request option.
83246
+ * @throws {RequiredError}
83247
+ */
83248
+ deleteStreamSessionChatMessage(sessionId: string, messageId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAccountInvitations200Response>>;
83226
83249
  /**
83227
83250
  * Queues an asynchronous export job for the given stream session (sessionId), emailing the requesting user a download when the export completes; requires the read permission on streams.
83228
83251
  * @summary Request an export of a stream session
@@ -83317,9 +83340,10 @@ export declare const StreamsSessionsApiFp: (configuration?: Configuration) => {
83317
83340
  */
83318
83341
  getStreamSessionSubscriptions(streamId: string, sessionId: string, active?: boolean, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetStreamSessionByIdSubscriptions200Response>>;
83319
83342
  /**
83320
- * Returns a paginated list of the accounts currently watching the given stream session, one row per account with how many active connections it holds and when its earliest one connected; the count is the number of people watching, where the subscriptions list counts connections. Requires read permission on streams.
83321
- * @summary List the people watching a stream session
83343
+ * Returns a paginated list of the accounts that watched the given stream session, one row per account: whether it is still watching, its active and total connection counts, first connect, last disconnect (null while watching) and watch time in milliseconds with overlapping connections counted once. active=true (the default) returns only people still watching, active=false only people who left; the count is people, where the subscriptions list counts connections. Requires read permission on streams.
83344
+ * @summary List the people who watched a stream session
83322
83345
  * @param {string} sessionId The session identifier
83346
+ * @param {boolean} [active] Filter by active
83323
83347
  * @param {number} [page] Page number
83324
83348
  * @param {number} [pageSize] Number of items per page
83325
83349
  * @param {string} [orderBy] Field to order by
@@ -83327,7 +83351,7 @@ export declare const StreamsSessionsApiFp: (configuration?: Configuration) => {
83327
83351
  * @param {*} [options] Override http request option.
83328
83352
  * @throws {RequiredError}
83329
83353
  */
83330
- getStreamSessionViewers(sessionId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetStreamSessionViewers200Response>>;
83354
+ getStreamSessionViewers(sessionId: string, active?: boolean, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetStreamSessionViewers200Response>>;
83331
83355
  /**
83332
83356
  * Returns a paginated list of broadcast sessions for the given stream input, filterable by session status; requires read permission on streams.
83333
83357
  * @summary List a stream\'s broadcast sessions
@@ -83363,6 +83387,14 @@ export declare const StreamsSessionsApiFactory: (configuration?: Configuration,
83363
83387
  * @throws {RequiredError}
83364
83388
  */
83365
83389
  closeStreamSession(requestParameters: StreamsSessionsApiCloseStreamSessionRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateAccountInvitations200Response>;
83390
+ /**
83391
+ * Permanently deletes a chat message (messageId) from the given stream session (sessionId), whether the session is active or ended and whether or not its stream input still exists; requires the read and update permissions on streams.
83392
+ * @summary Delete a stream session chat message
83393
+ * @param {StreamsSessionsApiDeleteStreamSessionChatMessageRequest} requestParameters Request parameters.
83394
+ * @param {*} [options] Override http request option.
83395
+ * @throws {RequiredError}
83396
+ */
83397
+ deleteStreamSessionChatMessage(requestParameters: StreamsSessionsApiDeleteStreamSessionChatMessageRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateAccountInvitations200Response>;
83366
83398
  /**
83367
83399
  * Queues an asynchronous export job for the given stream session (sessionId), emailing the requesting user a download when the export completes; requires the read permission on streams.
83368
83400
  * @summary Request an export of a stream session
@@ -83436,8 +83468,8 @@ export declare const StreamsSessionsApiFactory: (configuration?: Configuration,
83436
83468
  */
83437
83469
  getStreamSessionSubscriptions(requestParameters: StreamsSessionsApiGetStreamSessionSubscriptionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetStreamSessionByIdSubscriptions200Response>;
83438
83470
  /**
83439
- * Returns a paginated list of the accounts currently watching the given stream session, one row per account with how many active connections it holds and when its earliest one connected; the count is the number of people watching, where the subscriptions list counts connections. Requires read permission on streams.
83440
- * @summary List the people watching a stream session
83471
+ * Returns a paginated list of the accounts that watched the given stream session, one row per account: whether it is still watching, its active and total connection counts, first connect, last disconnect (null while watching) and watch time in milliseconds with overlapping connections counted once. active=true (the default) returns only people still watching, active=false only people who left; the count is people, where the subscriptions list counts connections. Requires read permission on streams.
83472
+ * @summary List the people who watched a stream session
83441
83473
  * @param {StreamsSessionsApiGetStreamSessionViewersRequest} requestParameters Request parameters.
83442
83474
  * @param {*} [options] Override http request option.
83443
83475
  * @throws {RequiredError}
@@ -83473,6 +83505,19 @@ export interface StreamsSessionsApiCloseStreamSessionRequest {
83473
83505
  */
83474
83506
  readonly sessionId: string;
83475
83507
  }
83508
+ /**
83509
+ * Request parameters for deleteStreamSessionChatMessage operation in StreamsSessionsApi.
83510
+ */
83511
+ export interface StreamsSessionsApiDeleteStreamSessionChatMessageRequest {
83512
+ /**
83513
+ * The session identifier
83514
+ */
83515
+ readonly sessionId: string;
83516
+ /**
83517
+ * The message identifier
83518
+ */
83519
+ readonly messageId: string;
83520
+ }
83476
83521
  /**
83477
83522
  * Request parameters for exportStreamSession operation in StreamsSessionsApi.
83478
83523
  */
@@ -83646,6 +83691,10 @@ export interface StreamsSessionsApiGetStreamSessionViewersRequest {
83646
83691
  * The session identifier
83647
83692
  */
83648
83693
  readonly sessionId: string;
83694
+ /**
83695
+ * Filter by active
83696
+ */
83697
+ readonly active?: boolean;
83649
83698
  /**
83650
83699
  * Page number
83651
83700
  */
@@ -83714,6 +83763,14 @@ export declare class StreamsSessionsApi extends BaseAPI {
83714
83763
  * @throws {RequiredError}
83715
83764
  */
83716
83765
  closeStreamSession(requestParameters: StreamsSessionsApiCloseStreamSessionRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateAccountInvitations200Response, any, {}, any>>;
83766
+ /**
83767
+ * Permanently deletes a chat message (messageId) from the given stream session (sessionId), whether the session is active or ended and whether or not its stream input still exists; requires the read and update permissions on streams.
83768
+ * @summary Delete a stream session chat message
83769
+ * @param {StreamsSessionsApiDeleteStreamSessionChatMessageRequest} requestParameters Request parameters.
83770
+ * @param {*} [options] Override http request option.
83771
+ * @throws {RequiredError}
83772
+ */
83773
+ deleteStreamSessionChatMessage(requestParameters: StreamsSessionsApiDeleteStreamSessionChatMessageRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateAccountInvitations200Response, any, {}, any>>;
83717
83774
  /**
83718
83775
  * Queues an asynchronous export job for the given stream session (sessionId), emailing the requesting user a download when the export completes; requires the read permission on streams.
83719
83776
  * @summary Request an export of a stream session
@@ -83787,8 +83844,8 @@ export declare class StreamsSessionsApi extends BaseAPI {
83787
83844
  */
83788
83845
  getStreamSessionSubscriptions(requestParameters: StreamsSessionsApiGetStreamSessionSubscriptionsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetStreamSessionByIdSubscriptions200Response, any, {}, any>>;
83789
83846
  /**
83790
- * Returns a paginated list of the accounts currently watching the given stream session, one row per account with how many active connections it holds and when its earliest one connected; the count is the number of people watching, where the subscriptions list counts connections. Requires read permission on streams.
83791
- * @summary List the people watching a stream session
83847
+ * Returns a paginated list of the accounts that watched the given stream session, one row per account: whether it is still watching, its active and total connection counts, first connect, last disconnect (null while watching) and watch time in milliseconds with overlapping connections counted once. active=true (the default) returns only people still watching, active=false only people who left; the count is people, where the subscriptions list counts connections. Requires read permission on streams.
83848
+ * @summary List the people who watched a stream session
83792
83849
  * @param {StreamsSessionsApiGetStreamSessionViewersRequest} requestParameters Request parameters.
83793
83850
  * @param {*} [options] Override http request option.
83794
83851
  * @throws {RequiredError}