@connectedxm/admin-sdk 15.5.0 → 15.7.0

package/.openapi-generator/FILES

@@ -500,6 +500,7 @@ docs/CreateSeriesQuestionChoice200Response.md
 docs/CreateSeriesRegistration200Response.md
 docs/CreateStreamInput200Response.md
 docs/CreateStreamInputOutput200Response.md
+docs/CreateStreamSessionChatMessage200Response.md
 docs/CreateSupportTicket200Response.md
 docs/CreateSupportTicketMessage200Response.md
 docs/CreateSurvey200Response.md
@@ -1472,6 +1473,8 @@ docs/ReorderSurveyQuestionChoices200Response.md
 docs/ReorderSurveyQuestionMatrixRows200Response.md
 docs/ReorderSurveyQuestionMatrixRowsRequest.md
 docs/ReorderSurveySectionQuestions200Response.md
+docs/ReorderTiers200Response.md
+docs/ReorderTiersRequest.md
 docs/ReportExport.md
 docs/ReportFilters.md
 docs/ReportType.md
@@ -1569,8 +1572,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/StreamSessionStatus.md
 docs/StreamSessionSubscription.md
 docs/StreamSessionUpdateInputs.md

package/README.md

@@ -1,4 +1,4 @@
-## @connectedxm/admin-sdk@15.5.0
+## @connectedxm/admin-sdk@15.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@15.5.0 --save
+npm install @connectedxm/admin-sdk@15.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: 15.5.0
+ * The version of the OpenAPI document: 15.7.0
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -3010,6 +3010,8 @@ export interface BaseStreamInput {
     'locale': string;
     'webRTC': boolean;
     'webRTCPlaybackUrl': string | null;
+    'dvrEnabled': boolean;
+    'connected': boolean;
 }
 export interface BaseStreamSession {
     'id': string;
@@ -3019,6 +3021,7 @@ export interface BaseStreamSession {
     'eventId': string | null;
     'eventSessionId': string | null;
     'status': StreamSessionStatus;
+    'slowModeSeconds': number;
     'startedAt': string | null;
     'endedAt': string | null;
     'createdAt': string;
@@ -5160,6 +5163,16 @@ export enum CreateStreamInputOutput200ResponseStatusEnum {
     Ok = 'ok'
 }
 
+export interface CreateStreamSessionChatMessage200Response {
+    'status': CreateStreamSessionChatMessage200ResponseStatusEnum;
+    'message': string;
+    'data': StreamSessionChatMessage;
+}
+
+export enum CreateStreamSessionChatMessage200ResponseStatusEnum {
+    Ok = 'ok'
+}
+
 export interface CreateSupportTicket200Response {
     'status': CreateSupportTicket200ResponseStatusEnum;
     'message': string;
@@ -14330,6 +14343,19 @@ export enum ReorderSurveySectionQuestions200ResponseStatusEnum {
     Ok = 'ok'
 }
 
+export interface ReorderTiers200Response {
+    'status': ReorderTiers200ResponseStatusEnum;
+    'message': string;
+    'data': Array<Tier>;
+}
+
+export enum ReorderTiers200ResponseStatusEnum {
+    Ok = 'ok'
+}
+
+export interface ReorderTiersRequest {
+    'tierIds': Array<string>;
+}
 export interface ReportExport {
     'id': string;
     'status': ExportStatus;
@@ -15140,6 +15166,8 @@ export interface StreamInput {
     'locale': string;
     'webRTC': boolean;
     'webRTCPlaybackUrl': string | null;
+    'dvrEnabled': boolean;
+    'connected': boolean;
     'event': BaseEvent | null;
     'session': BaseEventSession | null;
     'group': BaseGroup | null;
@@ -15165,6 +15193,7 @@ export interface StreamInputCreateInputs {
     'public'?: boolean;
     'locale'?: string | null;
     'webRTC'?: boolean;
+    'dvrEnabled'?: boolean;
 }
 export interface StreamInputDetails {
     'uid': string;
@@ -15233,12 +15262,21 @@ export interface StreamInputUpdateInputs {
     'public'?: boolean;
     'locale'?: string | null;
     'webRTC'?: boolean;
+    'dvrEnabled'?: boolean;
 }
 export interface StreamOutputCreateInputs {
     'enabled': boolean;
     'streamKey': string;
     'url': string;
 }
+
+export enum StreamReaction {
+    Love = 'love',
+    Applause = 'applause',
+    Agree = 'agree'
+}
+
+
 export interface StreamSession {
     'id': string;
     'organizationId': string;
@@ -15247,6 +15285,7 @@ export interface StreamSession {
     'eventId': string | null;
     'eventSessionId': string | null;
     'status': StreamSessionStatus;
+    'slowModeSeconds': number;
     'startedAt': string | null;
     'endedAt': string | null;
     'createdAt': string;
@@ -15255,6 +15294,7 @@ export interface StreamSession {
     'event': BaseEvent | null;
     'eventSession': BaseEventSession | null;
     'organization': BaseOrganization;
+    'reactions'?: { [key: string]: any; };
 }
 
 
@@ -15267,6 +15307,19 @@ export interface StreamSessionChatMessage {
     'connectionId': string;
     'message': string;
     'timestamp': number;
+    'videoTime': number | null;
+    'videoId': string | null;
+    'role': StreamSessionChatMessageRoleEnum | null;
+}
+
+export enum StreamSessionChatMessageRoleEnum {
+    Host = 'host',
+    Moderator = 'moderator'
+}
+
+export interface StreamSessionChatMessageCreateInputs {
+    'message': string;
+    'name'?: string;
 }
 
 export enum StreamSessionStatus {
@@ -15290,6 +15343,7 @@ export interface StreamSessionUpdateInputs {
     'name'?: string | null;
     'eventId'?: string | null;
     'eventSessionId'?: string | null;
+    'slowModeSeconds'?: number;
 }
 export interface StreamSessionViewer {
     'accountId': string | null;
@@ -16179,6 +16233,10 @@ export interface TierCreateInputs {
     'name': string;
     'slug'?: string | null;
     'iconName'?: string | null;
+    /**
+     * Ignored: new tiers are always added last. Use ReorderTiers to change the order.
+     * @deprecated
+     */
     'priority'?: number | null;
     'description'?: string | null;
     'imageId'?: string | null;
@@ -16191,6 +16249,10 @@ export interface TierUpdateInputs {
     'name'?: string | null;
     'slug'?: string | null;
     'iconName'?: string | null;
+    /**
+     * Use ReorderTiers to change the order of tiers.
+     * @deprecated
+     */
     'priority'?: number | null;
     'description'?: string | null;
     'imageId'?: string | null;
@@ -152547,6 +152609,51 @@ export const StreamsSessionsApiAxiosParamCreator = function (configuration?: Con
                 options: localVarRequestOptions,
             };
         },
+        /**
+         * Posts a chat message to an active stream session (sessionId) as the host, under the organization\'s name unless a name is given. Viewers see it with a host badge, and slow mode doesn\'t apply; requires the read and update permissions on streams.
+         * @summary Post a chat message as the host
+         * @param {string} sessionId The session identifier
+         * @param {StreamSessionChatMessageCreateInputs} streamSessionChatMessageCreateInputs 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        createStreamSessionChatMessage: async (sessionId: string, streamSessionChatMessageCreateInputs: StreamSessionChatMessageCreateInputs, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'sessionId' is not null or undefined
+            assertParamExists('createStreamSessionChatMessage', 'sessionId', sessionId)
+            // verify required parameter 'streamSessionChatMessageCreateInputs' is not null or undefined
+            assertParamExists('createStreamSessionChatMessage', 'streamSessionChatMessageCreateInputs', streamSessionChatMessageCreateInputs)
+            const localVarPath = `/streams/sessions/{sessionId}/chat`
+                .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: 'POST', ...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)
+
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+            localVarHeaderParameter['Accept'] = 'application/json';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+            localVarRequestOptions.data = serializeDataIfNeeded(streamSessionChatMessageCreateInputs, localVarRequestOptions, configuration)
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
         /**
          * 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.
          * @summary Delete a stream session chat message
@@ -153251,6 +153358,20 @@ export const StreamsSessionsApiFp = function(configuration?: Configuration) {
             const localVarOperationServerBasePath = operationServerMap['StreamsSessionsApi.closeStreamSession']?.[localVarOperationServerIndex]?.url;
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
+        /**
+         * Posts a chat message to an active stream session (sessionId) as the host, under the organization\'s name unless a name is given. Viewers see it with a host badge, and slow mode doesn\'t apply; requires the read and update permissions on streams.
+         * @summary Post a chat message as the host
+         * @param {string} sessionId The session identifier
+         * @param {StreamSessionChatMessageCreateInputs} streamSessionChatMessageCreateInputs 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async createStreamSessionChatMessage(sessionId: string, streamSessionChatMessageCreateInputs: StreamSessionChatMessageCreateInputs, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateStreamSessionChatMessage200Response>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.createStreamSessionChatMessage(sessionId, streamSessionChatMessageCreateInputs, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['StreamsSessionsApi.createStreamSessionChatMessage']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
         /**
          * 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.
          * @summary Delete a stream session chat message
@@ -153472,6 +153593,16 @@ export const StreamsSessionsApiFactory = function (configuration?: Configuration
         closeStreamSession(requestParameters: StreamsSessionsApiCloseStreamSessionRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateAccountInvitations200Response> {
             return localVarFp.closeStreamSession(requestParameters.streamId, requestParameters.sessionId, options).then((request) => request(axios, basePath));
         },
+        /**
+         * Posts a chat message to an active stream session (sessionId) as the host, under the organization\'s name unless a name is given. Viewers see it with a host badge, and slow mode doesn\'t apply; requires the read and update permissions on streams.
+         * @summary Post a chat message as the host
+         * @param {StreamsSessionsApiCreateStreamSessionChatMessageRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        createStreamSessionChatMessage(requestParameters: StreamsSessionsApiCreateStreamSessionChatMessageRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateStreamSessionChatMessage200Response> {
+            return localVarFp.createStreamSessionChatMessage(requestParameters.sessionId, requestParameters.streamSessionChatMessageCreateInputs, options).then((request) => request(axios, basePath));
+        },
         /**
          * 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.
          * @summary Delete a stream session chat message
@@ -153620,6 +153751,18 @@ export interface StreamsSessionsApiCloseStreamSessionRequest {
     readonly sessionId: string
 }
 
+/**
+ * Request parameters for createStreamSessionChatMessage operation in StreamsSessionsApi.
+ */
+export interface StreamsSessionsApiCreateStreamSessionChatMessageRequest {
+    /**
+     * The session identifier
+     */
+    readonly sessionId: string
+
+    readonly streamSessionChatMessageCreateInputs: StreamSessionChatMessageCreateInputs
+}
+
 /**
  * Request parameters for deleteStreamSessionChatMessage operation in StreamsSessionsApi.
  */
@@ -153927,6 +154070,17 @@ export class StreamsSessionsApi extends BaseAPI {
         return StreamsSessionsApiFp(this.configuration).closeStreamSession(requestParameters.streamId, requestParameters.sessionId, options).then((request) => request(this.axios, this.basePath));
     }
 
+    /**
+     * Posts a chat message to an active stream session (sessionId) as the host, under the organization\'s name unless a name is given. Viewers see it with a host badge, and slow mode doesn\'t apply; requires the read and update permissions on streams.
+     * @summary Post a chat message as the host
+     * @param {StreamsSessionsApiCreateStreamSessionChatMessageRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    public createStreamSessionChatMessage(requestParameters: StreamsSessionsApiCreateStreamSessionChatMessageRequest, options?: RawAxiosRequestConfig) {
+        return StreamsSessionsApiFp(this.configuration).createStreamSessionChatMessage(requestParameters.sessionId, requestParameters.streamSessionChatMessageCreateInputs, options).then((request) => request(this.axios, this.basePath));
+    }
+
     /**
      * 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.
      * @summary Delete a stream session chat message
@@ -166354,6 +166508,47 @@ export const TiersApiAxiosParamCreator = function (configuration?: Configuration
                 options: localVarRequestOptions,
             };
         },
+        /**
+         * Sets the priority of every account tier in the organization from a complete, ordered array of tier IDs (archived and internal tiers included); any missing or unknown tier ID rejects the request, and update permission on tiers is required.
+         * @summary Reorder account tiers
+         * @param {ReorderTiersRequest} reorderTiersRequest 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        reorderTiers: async (reorderTiersRequest: ReorderTiersRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'reorderTiersRequest' is not null or undefined
+            assertParamExists('reorderTiers', 'reorderTiersRequest', reorderTiersRequest)
+            const localVarPath = `/tiers/reorder`;
+            // 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: 'PUT', ...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)
+
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+            localVarHeaderParameter['Accept'] = 'application/json';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+            localVarRequestOptions.data = serializeDataIfNeeded(reorderTiersRequest, localVarRequestOptions, configuration)
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
         /**
          * Updates the fields of an existing account tier identified by tierId, requiring read and update permission on tiers.
          * @summary Update an account tier
@@ -166545,6 +166740,19 @@ export const TiersApiFp = function(configuration?: Configuration) {
             const localVarOperationServerBasePath = operationServerMap['TiersApi.removeTierAccounts']?.[localVarOperationServerIndex]?.url;
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
+        /**
+         * Sets the priority of every account tier in the organization from a complete, ordered array of tier IDs (archived and internal tiers included); any missing or unknown tier ID rejects the request, and update permission on tiers is required.
+         * @summary Reorder account tiers
+         * @param {ReorderTiersRequest} reorderTiersRequest 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async reorderTiers(reorderTiersRequest: ReorderTiersRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReorderTiers200Response>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.reorderTiers(reorderTiersRequest, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['TiersApi.reorderTiers']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
         /**
          * Updates the fields of an existing account tier identified by tierId, requiring read and update permission on tiers.
          * @summary Update an account tier
@@ -166658,6 +166866,16 @@ export const TiersApiFactory = function (configuration?: Configuration, basePath
         removeTierAccounts(requestParameters: TiersApiRemoveTierAccountsRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateTier200Response> {
             return localVarFp.removeTierAccounts(requestParameters.tierId, options).then((request) => request(axios, basePath));
         },
+        /**
+         * Sets the priority of every account tier in the organization from a complete, ordered array of tier IDs (archived and internal tiers included); any missing or unknown tier ID rejects the request, and update permission on tiers is required.
+         * @summary Reorder account tiers
+         * @param {TiersApiReorderTiersRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        reorderTiers(requestParameters: TiersApiReorderTiersRequest, options?: RawAxiosRequestConfig): AxiosPromise<ReorderTiers200Response> {
+            return localVarFp.reorderTiers(requestParameters.reorderTiersRequest, options).then((request) => request(axios, basePath));
+        },
         /**
          * Updates the fields of an existing account tier identified by tierId, requiring read and update permission on tiers.
          * @summary Update an account tier
@@ -166858,6 +167076,13 @@ export interface TiersApiRemoveTierAccountsRequest {
     readonly tierId: string
 }
 
+/**
+ * Request parameters for reorderTiers operation in TiersApi.
+ */
+export interface TiersApiReorderTiersRequest {
+    readonly reorderTiersRequest: ReorderTiersRequest
+}
+
 /**
  * Request parameters for updateTier operation in TiersApi.
  */
@@ -166973,6 +167198,17 @@ export class TiersApi extends BaseAPI {
         return TiersApiFp(this.configuration).removeTierAccounts(requestParameters.tierId, options).then((request) => request(this.axios, this.basePath));
     }
 
+    /**
+     * Sets the priority of every account tier in the organization from a complete, ordered array of tier IDs (archived and internal tiers included); any missing or unknown tier ID rejects the request, and update permission on tiers is required.
+     * @summary Reorder account tiers
+     * @param {TiersApiReorderTiersRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    public reorderTiers(requestParameters: TiersApiReorderTiersRequest, options?: RawAxiosRequestConfig) {
+        return TiersApiFp(this.configuration).reorderTiers(requestParameters.reorderTiersRequest, options).then((request) => request(this.axios, this.basePath));
+    }
+
     /**
      * Updates the fields of an existing account tier identified by tierId, requiring read and update permission on tiers.
      * @summary Update an account tier

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: 15.5.0
+ * The version of the OpenAPI document: 15.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: 15.5.0
+ * The version of the OpenAPI document: 15.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: 15.5.0
+ * The version of the OpenAPI document: 15.7.0
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).