@connectedxm/admin-sdk 16.0.0 → 16.2.0

package/.openapi-generator/FILES

@@ -1129,6 +1129,7 @@ docs/GetStreamInputOutputs200Response.md
 docs/GetStreamInputs200Response.md
 docs/GetStreamSessionById200Response.md
 docs/GetStreamSessionByIdChat200Response.md
+docs/GetStreamSessionByIdReactions200Response.md
 docs/GetStreamSessionByIdSubscriptions200Response.md
 docs/GetStreamSessionViewers200Response.md
 docs/GetStreamVideos200Response.md
@@ -1570,10 +1571,10 @@ docs/StreamInputOutputCreateInputs.md
 docs/StreamInputOutputUpdateInputs.md
 docs/StreamInputUpdateInputs.md
 docs/StreamOutputCreateInputs.md
-docs/StreamReaction.md
 docs/StreamSession.md
 docs/StreamSessionChatMessage.md
 docs/StreamSessionChatMessageCreateInputs.md
+docs/StreamSessionRecentReaction.md
 docs/StreamSessionStatus.md
 docs/StreamSessionSubscription.md
 docs/StreamSessionUpdateInputs.md

package/README.md

@@ -1,4 +1,4 @@
-## @connectedxm/admin-sdk@16.0.0
+## @connectedxm/admin-sdk@16.2.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@16.0.0 --save
+npm install @connectedxm/admin-sdk@16.2.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: 16.0.0
+ * The version of the OpenAPI document: 16.2.0
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -3115,7 +3115,6 @@ export interface BaseSurveyQuestion {
     'validationMessage': string | null;
     'locationOption': LocationQuestionOption | null;
     'sortOrder': number;
-    'featured': boolean;
     'choices': Array<BaseSurveyQuestionChoice>;
 }
 
@@ -10977,6 +10976,16 @@ export enum GetStreamSessionByIdChat200ResponseStatusEnum {
     Ok = 'ok'
 }
 
+export interface GetStreamSessionByIdReactions200Response {
+    'status': GetStreamSessionByIdReactions200ResponseStatusEnum;
+    'message': string;
+    'data': Array<StreamSessionRecentReaction>;
+}
+
+export enum GetStreamSessionByIdReactions200ResponseStatusEnum {
+    Ok = 'ok'
+}
+
 export interface GetStreamSessionByIdSubscriptions200Response {
     'status': GetStreamSessionByIdSubscriptions200ResponseStatusEnum;
     'message': string;
@@ -15199,14 +15208,6 @@ export interface StreamOutputCreateInputs {
     'streamKey': string;
     'url': string;
 }
-
-export enum StreamReaction {
-    Love = 'love',
-    Applause = 'applause',
-    Agree = 'agree'
-}
-
-
 export interface StreamSession {
     'id': string;
     'organizationId': string;
@@ -15226,7 +15227,7 @@ export interface StreamSession {
     'event': BaseEvent | null;
     'eventSession': BaseEventSession | null;
     'organization': BaseOrganization;
-    'reactions'?: { [key: string]: any; };
+    'watching'?: number | null;
 }
 
 
@@ -15242,6 +15243,7 @@ export interface StreamSessionChatMessage {
     'videoTime': number | null;
     'videoId': string | null;
     'role': StreamSessionChatMessageRoleEnum | null;
+    'imageUri': string | null;
 }
 
 export enum StreamSessionChatMessageRoleEnum {
@@ -15253,6 +15255,10 @@ export interface StreamSessionChatMessageCreateInputs {
     'message': string;
     'name'?: string;
 }
+export interface StreamSessionRecentReaction {
+    'at': number;
+    'reactions': { [key: string]: any; };
+}
 
 export enum StreamSessionStatus {
     Active = 'ACTIVE',
@@ -15574,7 +15580,6 @@ export interface SurveyQuestion {
     'validationMessage': string | null;
     'locationOption': LocationQuestionOption | null;
     'sortOrder': number;
-    'featured': boolean;
     'choices': Array<BaseSurveyQuestionChoice>;
     'sections': Array<BaseSurveySectionQuestion>;
     'subQuestionOf': Array<SurveyQuestionChoiceSubQuestion>;
@@ -152901,6 +152906,53 @@ export const StreamsSessionsApiAxiosParamCreator = function (configuration?: Con
                 options: localVarRequestOptions,
             };
         },
+        /**
+         * Returns the reaction counts each one-second tick sent viewers after since (ms), oldest first, from the last minute only; reactions are not kept beyond that. For animating reactions live; requires read permission on streams.
+         * @summary List a stream session\'s recent reactions by session id
+         * @param {string} sessionId The session identifier
+         * @param {number} since Filter by since
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getStreamSessionByIdReactions: async (sessionId: string, since: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'sessionId' is not null or undefined
+            assertParamExists('getStreamSessionByIdReactions', 'sessionId', sessionId)
+            // verify required parameter 'since' is not null or undefined
+            assertParamExists('getStreamSessionByIdReactions', 'since', since)
+            const localVarPath = `/streams/sessions/{sessionId}/reactions`
+                .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 (since !== undefined) {
+                localVarQueryParameter['since'] = since;
+            }
+
+            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 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, and searchable by the account\'s name, username, email, internal ref or id; requires read permission on streams.
          * @summary List a stream session\'s viewer connections by session id
@@ -153392,6 +153444,20 @@ export const StreamsSessionsApiFp = function(configuration?: Configuration) {
             const localVarOperationServerBasePath = operationServerMap['StreamsSessionsApi.getStreamSessionByIdChat']?.[localVarOperationServerIndex]?.url;
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
+        /**
+         * Returns the reaction counts each one-second tick sent viewers after since (ms), oldest first, from the last minute only; reactions are not kept beyond that. For animating reactions live; requires read permission on streams.
+         * @summary List a stream session\'s recent reactions by session id
+         * @param {string} sessionId The session identifier
+         * @param {number} since Filter by since
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async getStreamSessionByIdReactions(sessionId: string, since: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetStreamSessionByIdReactions200Response>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getStreamSessionByIdReactions(sessionId, since, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['StreamsSessionsApi.getStreamSessionByIdReactions']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
         /**
          * 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, and searchable by the account\'s name, username, email, internal ref or id; requires read permission on streams.
          * @summary List a stream session\'s viewer connections by session id
@@ -153592,6 +153658,16 @@ export const StreamsSessionsApiFactory = function (configuration?: Configuration
         getStreamSessionByIdChat(requestParameters: StreamsSessionsApiGetStreamSessionByIdChatRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetStreamSessionByIdChat200Response> {
             return localVarFp.getStreamSessionByIdChat(requestParameters.sessionId, options).then((request) => request(axios, basePath));
         },
+        /**
+         * Returns the reaction counts each one-second tick sent viewers after since (ms), oldest first, from the last minute only; reactions are not kept beyond that. For animating reactions live; requires read permission on streams.
+         * @summary List a stream session\'s recent reactions by session id
+         * @param {StreamsSessionsApiGetStreamSessionByIdReactionsRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getStreamSessionByIdReactions(requestParameters: StreamsSessionsApiGetStreamSessionByIdReactionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetStreamSessionByIdReactions200Response> {
+            return localVarFp.getStreamSessionByIdReactions(requestParameters.sessionId, requestParameters.since, options).then((request) => request(axios, basePath));
+        },
         /**
          * 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, and searchable by the account\'s name, username, email, internal ref or id; requires read permission on streams.
          * @summary List a stream session\'s viewer connections by session id
@@ -153802,6 +153878,21 @@ export interface StreamsSessionsApiGetStreamSessionByIdChatRequest {
     readonly sessionId: string
 }
 
+/**
+ * Request parameters for getStreamSessionByIdReactions operation in StreamsSessionsApi.
+ */
+export interface StreamsSessionsApiGetStreamSessionByIdReactionsRequest {
+    /**
+     * The session identifier
+     */
+    readonly sessionId: string
+
+    /**
+     * Filter by since
+     */
+    readonly since: number
+}
+
 /**
  * Request parameters for getStreamSessionByIdSubscriptions operation in StreamsSessionsApi.
  */
@@ -154077,6 +154168,17 @@ export class StreamsSessionsApi extends BaseAPI {
         return StreamsSessionsApiFp(this.configuration).getStreamSessionByIdChat(requestParameters.sessionId, options).then((request) => request(this.axios, this.basePath));
     }
 
+    /**
+     * Returns the reaction counts each one-second tick sent viewers after since (ms), oldest first, from the last minute only; reactions are not kept beyond that. For animating reactions live; requires read permission on streams.
+     * @summary List a stream session\'s recent reactions by session id
+     * @param {StreamsSessionsApiGetStreamSessionByIdReactionsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    public getStreamSessionByIdReactions(requestParameters: StreamsSessionsApiGetStreamSessionByIdReactionsRequest, options?: RawAxiosRequestConfig) {
+        return StreamsSessionsApiFp(this.configuration).getStreamSessionByIdReactions(requestParameters.sessionId, requestParameters.since, options).then((request) => request(this.axios, this.basePath));
+    }
+
     /**
      * 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, and searchable by the account\'s name, username, email, internal ref or id; requires read permission on streams.
      * @summary List a stream session\'s viewer connections by session id

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: 16.0.0
+ * The version of the OpenAPI document: 16.2.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: 16.0.0
+ * The version of the OpenAPI document: 16.2.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: 16.0.0
+ * The version of the OpenAPI document: 16.2.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: 16.0.0
+ * The version of the OpenAPI document: 16.2.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -2881,7 +2881,6 @@ export interface BaseSurveyQuestion {
     'validationMessage': string | null;
     'locationOption': LocationQuestionOption | null;
     'sortOrder': number;
-    'featured': boolean;
     'choices': Array<BaseSurveyQuestionChoice>;
 }
 export interface BaseSurveyQuestionChoice {
@@ -9720,6 +9719,14 @@ export interface GetStreamSessionByIdChat200Response {
 export declare enum GetStreamSessionByIdChat200ResponseStatusEnum {
     Ok = "ok"
 }
+export interface GetStreamSessionByIdReactions200Response {
+    'status': GetStreamSessionByIdReactions200ResponseStatusEnum;
+    'message': string;
+    'data': Array<StreamSessionRecentReaction>;
+}
+export declare enum GetStreamSessionByIdReactions200ResponseStatusEnum {
+    Ok = "ok"
+}
 export interface GetStreamSessionByIdSubscriptions200Response {
     'status': GetStreamSessionByIdSubscriptions200ResponseStatusEnum;
     'message': string;
@@ -13518,11 +13525,6 @@ export interface StreamOutputCreateInputs {
     'streamKey': string;
     'url': string;
 }
-export declare enum StreamReaction {
-    Love = "love",
-    Applause = "applause",
-    Agree = "agree"
-}
 export interface StreamSession {
     'id': string;
     'organizationId': string;
@@ -13542,9 +13544,7 @@ export interface StreamSession {
     'event': BaseEvent | null;
     'eventSession': BaseEventSession | null;
     'organization': BaseOrganization;
-    'reactions'?: {
-        [key: string]: any;
-    };
+    'watching'?: number | null;
 }
 export interface StreamSessionChatMessage {
     'messageId': string;
@@ -13558,6 +13558,7 @@ export interface StreamSessionChatMessage {
     'videoTime': number | null;
     'videoId': string | null;
     'role': StreamSessionChatMessageRoleEnum | null;
+    'imageUri': string | null;
 }
 export declare enum StreamSessionChatMessageRoleEnum {
     Host = "host",
@@ -13567,6 +13568,12 @@ export interface StreamSessionChatMessageCreateInputs {
     'message': string;
     'name'?: string;
 }
+export interface StreamSessionRecentReaction {
+    'at': number;
+    'reactions': {
+        [key: string]: any;
+    };
+}
 export declare enum StreamSessionStatus {
     Active = "ACTIVE",
     Ended = "ENDED"
@@ -13854,7 +13861,6 @@ export interface SurveyQuestion {
     'validationMessage': string | null;
     'locationOption': LocationQuestionOption | null;
     'sortOrder': number;
-    'featured': boolean;
     'choices': Array<BaseSurveyQuestionChoice>;
     'sections': Array<BaseSurveySectionQuestion>;
     'subQuestionOf': Array<SurveyQuestionChoiceSubQuestion>;
@@ -83518,6 +83524,15 @@ export declare const StreamsSessionsApiAxiosParamCreator: (configuration?: Confi
      * @throws {RequiredError}
      */
     getStreamSessionByIdChat: (sessionId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Returns the reaction counts each one-second tick sent viewers after since (ms), oldest first, from the last minute only; reactions are not kept beyond that. For animating reactions live; requires read permission on streams.
+     * @summary List a stream session\'s recent reactions by session id
+     * @param {string} sessionId The session identifier
+     * @param {number} since Filter by since
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getStreamSessionByIdReactions: (sessionId: string, since: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * 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, and searchable by the account\'s name, username, email, internal ref or id; requires read permission on streams.
      * @summary List a stream session\'s viewer connections by session id
@@ -83678,6 +83693,15 @@ export declare const StreamsSessionsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     getStreamSessionByIdChat(sessionId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetStreamSessionByIdChat200Response>>;
+    /**
+     * Returns the reaction counts each one-second tick sent viewers after since (ms), oldest first, from the last minute only; reactions are not kept beyond that. For animating reactions live; requires read permission on streams.
+     * @summary List a stream session\'s recent reactions by session id
+     * @param {string} sessionId The session identifier
+     * @param {number} since Filter by since
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getStreamSessionByIdReactions(sessionId: string, since: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetStreamSessionByIdReactions200Response>>;
     /**
      * 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, and searchable by the account\'s name, username, email, internal ref or id; requires read permission on streams.
      * @summary List a stream session\'s viewer connections by session id
@@ -83826,6 +83850,14 @@ export declare const StreamsSessionsApiFactory: (configuration?: Configuration,
      * @throws {RequiredError}
      */
     getStreamSessionByIdChat(requestParameters: StreamsSessionsApiGetStreamSessionByIdChatRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetStreamSessionByIdChat200Response>;
+    /**
+     * Returns the reaction counts each one-second tick sent viewers after since (ms), oldest first, from the last minute only; reactions are not kept beyond that. For animating reactions live; requires read permission on streams.
+     * @summary List a stream session\'s recent reactions by session id
+     * @param {StreamsSessionsApiGetStreamSessionByIdReactionsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getStreamSessionByIdReactions(requestParameters: StreamsSessionsApiGetStreamSessionByIdReactionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetStreamSessionByIdReactions200Response>;
     /**
      * 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, and searchable by the account\'s name, username, email, internal ref or id; requires read permission on streams.
      * @summary List a stream session\'s viewer connections by session id
@@ -84001,6 +84033,19 @@ export interface StreamsSessionsApiGetStreamSessionByIdChatRequest {
      */
     readonly sessionId: string;
 }
+/**
+ * Request parameters for getStreamSessionByIdReactions operation in StreamsSessionsApi.
+ */
+export interface StreamsSessionsApiGetStreamSessionByIdReactionsRequest {
+    /**
+     * The session identifier
+     */
+    readonly sessionId: string;
+    /**
+     * Filter by since
+     */
+    readonly since: number;
+}
 /**
  * Request parameters for getStreamSessionByIdSubscriptions operation in StreamsSessionsApi.
  */
@@ -84220,6 +84265,14 @@ export declare class StreamsSessionsApi extends BaseAPI {
      * @throws {RequiredError}
      */
     getStreamSessionByIdChat(requestParameters: StreamsSessionsApiGetStreamSessionByIdChatRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetStreamSessionByIdChat200Response, any, {}, any>>;
+    /**
+     * Returns the reaction counts each one-second tick sent viewers after since (ms), oldest first, from the last minute only; reactions are not kept beyond that. For animating reactions live; requires read permission on streams.
+     * @summary List a stream session\'s recent reactions by session id
+     * @param {StreamsSessionsApiGetStreamSessionByIdReactionsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getStreamSessionByIdReactions(requestParameters: StreamsSessionsApiGetStreamSessionByIdReactionsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetStreamSessionByIdReactions200Response, any, {}, any>>;
     /**
      * 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, and searchable by the account\'s name, username, email, internal ref or id; requires read permission on streams.
      * @summary List a stream session\'s viewer connections by session id