@connectedxm/admin-sdk 13.5.0 → 13.7.0

package/.openapi-generator/FILES

@@ -1124,6 +1124,7 @@ docs/GetStreamInputs200Response.md
 docs/GetStreamSessionById200Response.md
 docs/GetStreamSessionByIdChat200Response.md
 docs/GetStreamSessionByIdSubscriptions200Response.md
+docs/GetStreamSessionViewers200Response.md
 docs/GetStreamVideos200Response.md
 docs/GetSupportTicketActivity200Response.md
 docs/GetSupportTicketMessages200Response.md
@@ -1559,6 +1560,7 @@ docs/StreamSessionChatMessage.md
 docs/StreamSessionStatus.md
 docs/StreamSessionSubscription.md
 docs/StreamSessionUpdateInputs.md
+docs/StreamSessionViewer.md
 docs/StreamsApi.md
 docs/StreamsOutputsApi.md
 docs/StreamsSessionsApi.md

package/README.md

@@ -1,4 +1,4 @@
-## @connectedxm/admin-sdk@13.5.0
+## @connectedxm/admin-sdk@13.7.0
 
 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:
 
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
 _published:_
 
 ```
-npm install @connectedxm/admin-sdk@13.5.0 --save
+npm install @connectedxm/admin-sdk@13.7.0 --save
 ```
 
 _unPublished (not recommended):_

package/api.ts

@@ -4,7 +4,7 @@
  * Connected Admin API
  * The Admin API allows you to manage your Connected community programmatically.
  *
- * The version of the OpenAPI document: 13.5.0
+ * The version of the OpenAPI document: 13.7.0
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -10954,6 +10954,17 @@ export enum GetStreamSessionByIdSubscriptions200ResponseStatusEnum {
     Ok = 'ok'
 }
 
+export interface GetStreamSessionViewers200Response {
+    'status': GetStreamSessionViewers200ResponseStatusEnum;
+    'message': string;
+    'data': Array<StreamSessionViewer>;
+    'count'?: number;
+}
+
+export enum GetStreamSessionViewers200ResponseStatusEnum {
+    Ok = 'ok'
+}
+
 export interface GetStreamVideos200Response {
     'status': GetStreamVideos200ResponseStatusEnum;
     'message': string;
@@ -15153,6 +15164,12 @@ export interface StreamSessionUpdateInputs {
     'eventId'?: string | null;
     'eventSessionId'?: string | null;
 }
+export interface StreamSessionViewer {
+    'accountId': string | null;
+    'account': BaseAccount | null;
+    'activeConnections': number;
+    'connectedAt': string;
+}
 export interface StripeActivationFormParams {
     'clientPublicKey': string;
     'clientSecret': string;
@@ -152343,6 +152360,66 @@ export const StreamsSessionsApiAxiosParamCreator = function (configuration?: Con
                 options: localVarRequestOptions,
             };
         },
+        /**
+         * 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.
+         * @summary List the people watching a stream session
+         * @param {string} sessionId The session identifier
+         * @param {number} [page] Page number
+         * @param {number} [pageSize] Number of items per page
+         * @param {string} [orderBy] Field to order by
+         * @param {string} [search] Search query
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getStreamSessionViewers: async (sessionId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'sessionId' is not null or undefined
+            assertParamExists('getStreamSessionViewers', 'sessionId', sessionId)
+            const localVarPath = `/streams/sessions/{sessionId}/viewers`
+                .replace('{sessionId}', encodeURIComponent(String(sessionId)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication ApiKeyAuth required
+            await setApiKeyToObject(localVarHeaderParameter, "api-key", configuration)
+
+            // authentication OrganizationId required
+            await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
+
+            if (page !== undefined) {
+                localVarQueryParameter['page'] = page;
+            }
+
+            if (pageSize !== undefined) {
+                localVarQueryParameter['pageSize'] = pageSize;
+            }
+
+            if (orderBy !== undefined) {
+                localVarQueryParameter['orderBy'] = orderBy;
+            }
+
+            if (search !== undefined) {
+                localVarQueryParameter['search'] = search;
+            }
+
+            localVarHeaderParameter['Accept'] = 'application/json';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
         /**
          * Returns a paginated list of broadcast sessions for the given stream input, filterable by session status; requires read permission on streams.
          * @summary List a stream\'s broadcast sessions
@@ -152614,6 +152691,23 @@ export const StreamsSessionsApiFp = function(configuration?: Configuration) {
             const localVarOperationServerBasePath = operationServerMap['StreamsSessionsApi.getStreamSessionSubscriptions']?.[localVarOperationServerIndex]?.url;
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
+        /**
+         * 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.
+         * @summary List the people watching a stream session
+         * @param {string} sessionId The session identifier
+         * @param {number} [page] Page number
+         * @param {number} [pageSize] Number of items per page
+         * @param {string} [orderBy] Field to order by
+         * @param {string} [search] Search query
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async getStreamSessionViewers(sessionId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetStreamSessionViewers200Response>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getStreamSessionViewers(sessionId, page, pageSize, orderBy, search, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['StreamsSessionsApi.getStreamSessionViewers']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
         /**
          * Returns a paginated list of broadcast sessions for the given stream input, filterable by session status; requires read permission on streams.
          * @summary List a stream\'s broadcast sessions
@@ -152755,6 +152849,16 @@ export const StreamsSessionsApiFactory = function (configuration?: Configuration
         getStreamSessionSubscriptions(requestParameters: StreamsSessionsApiGetStreamSessionSubscriptionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetStreamSessionByIdSubscriptions200Response> {
             return localVarFp.getStreamSessionSubscriptions(requestParameters.streamId, requestParameters.sessionId, requestParameters.active, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
         },
+        /**
+         * 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.
+         * @summary List the people watching a stream session
+         * @param {StreamsSessionsApiGetStreamSessionViewersRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getStreamSessionViewers(requestParameters: StreamsSessionsApiGetStreamSessionViewersRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetStreamSessionViewers200Response> {
+            return localVarFp.getStreamSessionViewers(requestParameters.sessionId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
+        },
         /**
          * Returns a paginated list of broadcast sessions for the given stream input, filterable by session status; requires read permission on streams.
          * @summary List a stream\'s broadcast sessions
@@ -152988,6 +153092,36 @@ export interface StreamsSessionsApiGetStreamSessionSubscriptionsRequest {
     readonly search?: string
 }
 
+/**
+ * Request parameters for getStreamSessionViewers operation in StreamsSessionsApi.
+ */
+export interface StreamsSessionsApiGetStreamSessionViewersRequest {
+    /**
+     * The session identifier
+     */
+    readonly sessionId: string
+
+    /**
+     * Page number
+     */
+    readonly page?: number
+
+    /**
+     * Number of items per page
+     */
+    readonly pageSize?: number
+
+    /**
+     * Field to order by
+     */
+    readonly orderBy?: string
+
+    /**
+     * Search query
+     */
+    readonly search?: string
+}
+
 /**
  * Request parameters for getStreamSessions operation in StreamsSessionsApi.
  */
@@ -153149,6 +153283,17 @@ export class StreamsSessionsApi extends BaseAPI {
         return StreamsSessionsApiFp(this.configuration).getStreamSessionSubscriptions(requestParameters.streamId, requestParameters.sessionId, requestParameters.active, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
     }
 
+    /**
+     * 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.
+     * @summary List the people watching a stream session
+     * @param {StreamsSessionsApiGetStreamSessionViewersRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    public getStreamSessionViewers(requestParameters: StreamsSessionsApiGetStreamSessionViewersRequest, options?: RawAxiosRequestConfig) {
+        return StreamsSessionsApiFp(this.configuration).getStreamSessionViewers(requestParameters.sessionId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
+    }
+
     /**
      * Returns a paginated list of broadcast sessions for the given stream input, filterable by session status; requires read permission on streams.
      * @summary List a stream\'s broadcast sessions

package/base.ts

@@ -4,7 +4,7 @@
  * Connected Admin API
  * The Admin API allows you to manage your Connected community programmatically.
  *
- * The version of the OpenAPI document: 13.5.0
+ * The version of the OpenAPI document: 13.7.0
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/common.ts

@@ -4,7 +4,7 @@
  * Connected Admin API
  * The Admin API allows you to manage your Connected community programmatically.
  *
- * The version of the OpenAPI document: 13.5.0
+ * The version of the OpenAPI document: 13.7.0
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/configuration.ts

@@ -3,7 +3,7 @@
  * Connected Admin API
  * The Admin API allows you to manage your Connected community programmatically.
  *
- * The version of the OpenAPI document: 13.5.0
+ * The version of the OpenAPI document: 13.7.0
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/api.d.ts

@@ -2,7 +2,7 @@
  * Connected Admin API
  * The Admin API allows you to manage your Connected community programmatically.
  *
- * The version of the OpenAPI document: 13.5.0
+ * The version of the OpenAPI document: 13.7.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -9697,6 +9697,15 @@ export interface GetStreamSessionByIdSubscriptions200Response {
 export declare enum GetStreamSessionByIdSubscriptions200ResponseStatusEnum {
     Ok = "ok"
 }
+export interface GetStreamSessionViewers200Response {
+    'status': GetStreamSessionViewers200ResponseStatusEnum;
+    'message': string;
+    'data': Array<StreamSessionViewer>;
+    'count'?: number;
+}
+export declare enum GetStreamSessionViewers200ResponseStatusEnum {
+    Ok = "ok"
+}
 export interface GetStreamVideos200Response {
     'status': GetStreamVideos200ResponseStatusEnum;
     'message': string;
@@ -13485,6 +13494,12 @@ export interface StreamSessionUpdateInputs {
     'eventId'?: string | null;
     'eventSessionId'?: string | null;
 }
+export interface StreamSessionViewer {
+    'accountId': string | null;
+    'account': BaseAccount | null;
+    'activeConnections': number;
+    'connectedAt': string;
+}
 export interface StripeActivationFormParams {
     'clientPublicKey': string;
     'clientSecret': string;
@@ -83160,6 +83175,18 @@ export declare const StreamsSessionsApiAxiosParamCreator: (configuration?: Confi
      * @throws {RequiredError}
      */
     getStreamSessionSubscriptions: (streamId: string, sessionId: string, active?: boolean, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * 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.
+     * @summary List the people watching a stream session
+     * @param {string} sessionId The session identifier
+     * @param {number} [page] Page number
+     * @param {number} [pageSize] Number of items per page
+     * @param {string} [orderBy] Field to order by
+     * @param {string} [search] Search query
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getStreamSessionViewers: (sessionId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Returns a paginated list of broadcast sessions for the given stream input, filterable by session status; requires read permission on streams.
      * @summary List a stream\'s broadcast sessions
@@ -83289,6 +83316,18 @@ export declare const StreamsSessionsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     getStreamSessionSubscriptions(streamId: string, sessionId: string, active?: boolean, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetStreamSessionByIdSubscriptions200Response>>;
+    /**
+     * 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.
+     * @summary List the people watching a stream session
+     * @param {string} sessionId The session identifier
+     * @param {number} [page] Page number
+     * @param {number} [pageSize] Number of items per page
+     * @param {string} [orderBy] Field to order by
+     * @param {string} [search] Search query
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getStreamSessionViewers(sessionId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetStreamSessionViewers200Response>>;
     /**
      * Returns a paginated list of broadcast sessions for the given stream input, filterable by session status; requires read permission on streams.
      * @summary List a stream\'s broadcast sessions
@@ -83396,6 +83435,14 @@ export declare const StreamsSessionsApiFactory: (configuration?: Configuration,
      * @throws {RequiredError}
      */
     getStreamSessionSubscriptions(requestParameters: StreamsSessionsApiGetStreamSessionSubscriptionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetStreamSessionByIdSubscriptions200Response>;
+    /**
+     * 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.
+     * @summary List the people watching a stream session
+     * @param {StreamsSessionsApiGetStreamSessionViewersRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getStreamSessionViewers(requestParameters: StreamsSessionsApiGetStreamSessionViewersRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetStreamSessionViewers200Response>;
     /**
      * Returns a paginated list of broadcast sessions for the given stream input, filterable by session status; requires read permission on streams.
      * @summary List a stream\'s broadcast sessions
@@ -83591,6 +83638,31 @@ export interface StreamsSessionsApiGetStreamSessionSubscriptionsRequest {
      */
     readonly search?: string;
 }
+/**
+ * Request parameters for getStreamSessionViewers operation in StreamsSessionsApi.
+ */
+export interface StreamsSessionsApiGetStreamSessionViewersRequest {
+    /**
+     * The session identifier
+     */
+    readonly sessionId: string;
+    /**
+     * Page number
+     */
+    readonly page?: number;
+    /**
+     * Number of items per page
+     */
+    readonly pageSize?: number;
+    /**
+     * Field to order by
+     */
+    readonly orderBy?: string;
+    /**
+     * Search query
+     */
+    readonly search?: string;
+}
 /**
  * Request parameters for getStreamSessions operation in StreamsSessionsApi.
  */
@@ -83714,6 +83786,14 @@ export declare class StreamsSessionsApi extends BaseAPI {
      * @throws {RequiredError}
      */
     getStreamSessionSubscriptions(requestParameters: StreamsSessionsApiGetStreamSessionSubscriptionsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetStreamSessionByIdSubscriptions200Response, any, {}, any>>;
+    /**
+     * 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.
+     * @summary List the people watching a stream session
+     * @param {StreamsSessionsApiGetStreamSessionViewersRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getStreamSessionViewers(requestParameters: StreamsSessionsApiGetStreamSessionViewersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetStreamSessionViewers200Response, any, {}, any>>;
     /**
      * Returns a paginated list of broadcast sessions for the given stream input, filterable by session status; requires read permission on streams.
      * @summary List a stream\'s broadcast sessions