@connectedxm/admin-sdk 15.5.0 → 15.7.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/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: 15.5.0
5
+ * The version of the OpenAPI document: 15.7.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -2781,6 +2781,8 @@ export interface BaseStreamInput {
2781
2781
  'locale': string;
2782
2782
  'webRTC': boolean;
2783
2783
  'webRTCPlaybackUrl': string | null;
2784
+ 'dvrEnabled': boolean;
2785
+ 'connected': boolean;
2784
2786
  }
2785
2787
  export interface BaseStreamSession {
2786
2788
  'id': string;
@@ -2790,6 +2792,7 @@ export interface BaseStreamSession {
2790
2792
  'eventId': string | null;
2791
2793
  'eventSessionId': string | null;
2792
2794
  'status': StreamSessionStatus;
2795
+ 'slowModeSeconds': number;
2793
2796
  'startedAt': string | null;
2794
2797
  'endedAt': string | null;
2795
2798
  'createdAt': string;
@@ -4689,6 +4692,14 @@ export interface CreateStreamInputOutput200Response {
4689
4692
  export declare enum CreateStreamInputOutput200ResponseStatusEnum {
4690
4693
  Ok = "ok"
4691
4694
  }
4695
+ export interface CreateStreamSessionChatMessage200Response {
4696
+ 'status': CreateStreamSessionChatMessage200ResponseStatusEnum;
4697
+ 'message': string;
4698
+ 'data': StreamSessionChatMessage;
4699
+ }
4700
+ export declare enum CreateStreamSessionChatMessage200ResponseStatusEnum {
4701
+ Ok = "ok"
4702
+ }
4692
4703
  export interface CreateSupportTicket200Response {
4693
4704
  'status': CreateSupportTicket200ResponseStatusEnum;
4694
4705
  'message': string;
@@ -12715,6 +12726,17 @@ export interface ReorderSurveySectionQuestions200Response {
12715
12726
  export declare enum ReorderSurveySectionQuestions200ResponseStatusEnum {
12716
12727
  Ok = "ok"
12717
12728
  }
12729
+ export interface ReorderTiers200Response {
12730
+ 'status': ReorderTiers200ResponseStatusEnum;
12731
+ 'message': string;
12732
+ 'data': Array<Tier>;
12733
+ }
12734
+ export declare enum ReorderTiers200ResponseStatusEnum {
12735
+ Ok = "ok"
12736
+ }
12737
+ export interface ReorderTiersRequest {
12738
+ 'tierIds': Array<string>;
12739
+ }
12718
12740
  export interface ReportExport {
12719
12741
  'id': string;
12720
12742
  'status': ExportStatus;
@@ -13457,6 +13479,8 @@ export interface StreamInput {
13457
13479
  'locale': string;
13458
13480
  'webRTC': boolean;
13459
13481
  'webRTCPlaybackUrl': string | null;
13482
+ 'dvrEnabled': boolean;
13483
+ 'connected': boolean;
13460
13484
  'event': BaseEvent | null;
13461
13485
  'session': BaseEventSession | null;
13462
13486
  'group': BaseGroup | null;
@@ -13482,6 +13506,7 @@ export interface StreamInputCreateInputs {
13482
13506
  'public'?: boolean;
13483
13507
  'locale'?: string | null;
13484
13508
  'webRTC'?: boolean;
13509
+ 'dvrEnabled'?: boolean;
13485
13510
  }
13486
13511
  export interface StreamInputDetails {
13487
13512
  'uid': string;
@@ -13550,12 +13575,18 @@ export interface StreamInputUpdateInputs {
13550
13575
  'public'?: boolean;
13551
13576
  'locale'?: string | null;
13552
13577
  'webRTC'?: boolean;
13578
+ 'dvrEnabled'?: boolean;
13553
13579
  }
13554
13580
  export interface StreamOutputCreateInputs {
13555
13581
  'enabled': boolean;
13556
13582
  'streamKey': string;
13557
13583
  'url': string;
13558
13584
  }
13585
+ export declare enum StreamReaction {
13586
+ Love = "love",
13587
+ Applause = "applause",
13588
+ Agree = "agree"
13589
+ }
13559
13590
  export interface StreamSession {
13560
13591
  'id': string;
13561
13592
  'organizationId': string;
@@ -13564,6 +13595,7 @@ export interface StreamSession {
13564
13595
  'eventId': string | null;
13565
13596
  'eventSessionId': string | null;
13566
13597
  'status': StreamSessionStatus;
13598
+ 'slowModeSeconds': number;
13567
13599
  'startedAt': string | null;
13568
13600
  'endedAt': string | null;
13569
13601
  'createdAt': string;
@@ -13572,6 +13604,9 @@ export interface StreamSession {
13572
13604
  'event': BaseEvent | null;
13573
13605
  'eventSession': BaseEventSession | null;
13574
13606
  'organization': BaseOrganization;
13607
+ 'reactions'?: {
13608
+ [key: string]: any;
13609
+ };
13575
13610
  }
13576
13611
  export interface StreamSessionChatMessage {
13577
13612
  'messageId': string;
@@ -13582,6 +13617,17 @@ export interface StreamSessionChatMessage {
13582
13617
  'connectionId': string;
13583
13618
  'message': string;
13584
13619
  'timestamp': number;
13620
+ 'videoTime': number | null;
13621
+ 'videoId': string | null;
13622
+ 'role': StreamSessionChatMessageRoleEnum | null;
13623
+ }
13624
+ export declare enum StreamSessionChatMessageRoleEnum {
13625
+ Host = "host",
13626
+ Moderator = "moderator"
13627
+ }
13628
+ export interface StreamSessionChatMessageCreateInputs {
13629
+ 'message': string;
13630
+ 'name'?: string;
13585
13631
  }
13586
13632
  export declare enum StreamSessionStatus {
13587
13633
  Active = "ACTIVE",
@@ -13602,6 +13648,7 @@ export interface StreamSessionUpdateInputs {
13602
13648
  'name'?: string | null;
13603
13649
  'eventId'?: string | null;
13604
13650
  'eventSessionId'?: string | null;
13651
+ 'slowModeSeconds'?: number;
13605
13652
  }
13606
13653
  export interface StreamSessionViewer {
13607
13654
  'accountId': string | null;
@@ -14412,6 +14459,10 @@ export interface TierCreateInputs {
14412
14459
  'name': string;
14413
14460
  'slug'?: string | null;
14414
14461
  'iconName'?: string | null;
14462
+ /**
14463
+ * Ignored: new tiers are always added last. Use ReorderTiers to change the order.
14464
+ * @deprecated
14465
+ */
14415
14466
  'priority'?: number | null;
14416
14467
  'description'?: string | null;
14417
14468
  'imageId'?: string | null;
@@ -14424,6 +14475,10 @@ export interface TierUpdateInputs {
14424
14475
  'name'?: string | null;
14425
14476
  'slug'?: string | null;
14426
14477
  'iconName'?: string | null;
14478
+ /**
14479
+ * Use ReorderTiers to change the order of tiers.
14480
+ * @deprecated
14481
+ */
14427
14482
  'priority'?: number | null;
14428
14483
  'description'?: string | null;
14429
14484
  'imageId'?: string | null;
@@ -83463,6 +83518,15 @@ export declare const StreamsSessionsApiAxiosParamCreator: (configuration?: Confi
83463
83518
  * @throws {RequiredError}
83464
83519
  */
83465
83520
  closeStreamSession: (streamId: string, sessionId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
83521
+ /**
83522
+ * 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.
83523
+ * @summary Post a chat message as the host
83524
+ * @param {string} sessionId The session identifier
83525
+ * @param {StreamSessionChatMessageCreateInputs} streamSessionChatMessageCreateInputs
83526
+ * @param {*} [options] Override http request option.
83527
+ * @throws {RequiredError}
83528
+ */
83529
+ createStreamSessionChatMessage: (sessionId: string, streamSessionChatMessageCreateInputs: StreamSessionChatMessageCreateInputs, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
83466
83530
  /**
83467
83531
  * 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.
83468
83532
  * @summary Delete a stream session chat message
@@ -83614,6 +83678,15 @@ export declare const StreamsSessionsApiFp: (configuration?: Configuration) => {
83614
83678
  * @throws {RequiredError}
83615
83679
  */
83616
83680
  closeStreamSession(streamId: string, sessionId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAccountInvitations200Response>>;
83681
+ /**
83682
+ * 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.
83683
+ * @summary Post a chat message as the host
83684
+ * @param {string} sessionId The session identifier
83685
+ * @param {StreamSessionChatMessageCreateInputs} streamSessionChatMessageCreateInputs
83686
+ * @param {*} [options] Override http request option.
83687
+ * @throws {RequiredError}
83688
+ */
83689
+ createStreamSessionChatMessage(sessionId: string, streamSessionChatMessageCreateInputs: StreamSessionChatMessageCreateInputs, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateStreamSessionChatMessage200Response>>;
83617
83690
  /**
83618
83691
  * 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.
83619
83692
  * @summary Delete a stream session chat message
@@ -83764,6 +83837,14 @@ export declare const StreamsSessionsApiFactory: (configuration?: Configuration,
83764
83837
  * @throws {RequiredError}
83765
83838
  */
83766
83839
  closeStreamSession(requestParameters: StreamsSessionsApiCloseStreamSessionRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateAccountInvitations200Response>;
83840
+ /**
83841
+ * 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.
83842
+ * @summary Post a chat message as the host
83843
+ * @param {StreamsSessionsApiCreateStreamSessionChatMessageRequest} requestParameters Request parameters.
83844
+ * @param {*} [options] Override http request option.
83845
+ * @throws {RequiredError}
83846
+ */
83847
+ createStreamSessionChatMessage(requestParameters: StreamsSessionsApiCreateStreamSessionChatMessageRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateStreamSessionChatMessage200Response>;
83767
83848
  /**
83768
83849
  * 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.
83769
83850
  * @summary Delete a stream session chat message
@@ -83882,6 +83963,16 @@ export interface StreamsSessionsApiCloseStreamSessionRequest {
83882
83963
  */
83883
83964
  readonly sessionId: string;
83884
83965
  }
83966
+ /**
83967
+ * Request parameters for createStreamSessionChatMessage operation in StreamsSessionsApi.
83968
+ */
83969
+ export interface StreamsSessionsApiCreateStreamSessionChatMessageRequest {
83970
+ /**
83971
+ * The session identifier
83972
+ */
83973
+ readonly sessionId: string;
83974
+ readonly streamSessionChatMessageCreateInputs: StreamSessionChatMessageCreateInputs;
83975
+ }
83885
83976
  /**
83886
83977
  * Request parameters for deleteStreamSessionChatMessage operation in StreamsSessionsApi.
83887
83978
  */
@@ -84140,6 +84231,14 @@ export declare class StreamsSessionsApi extends BaseAPI {
84140
84231
  * @throws {RequiredError}
84141
84232
  */
84142
84233
  closeStreamSession(requestParameters: StreamsSessionsApiCloseStreamSessionRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateAccountInvitations200Response, any, {}, any>>;
84234
+ /**
84235
+ * 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.
84236
+ * @summary Post a chat message as the host
84237
+ * @param {StreamsSessionsApiCreateStreamSessionChatMessageRequest} requestParameters Request parameters.
84238
+ * @param {*} [options] Override http request option.
84239
+ * @throws {RequiredError}
84240
+ */
84241
+ createStreamSessionChatMessage(requestParameters: StreamsSessionsApiCreateStreamSessionChatMessageRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateStreamSessionChatMessage200Response, any, {}, any>>;
84143
84242
  /**
84144
84243
  * 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.
84145
84244
  * @summary Delete a stream session chat message
@@ -90333,6 +90432,14 @@ export declare const TiersApiAxiosParamCreator: (configuration?: Configuration)
90333
90432
  * @throws {RequiredError}
90334
90433
  */
90335
90434
  removeTierAccounts: (tierId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
90435
+ /**
90436
+ * 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.
90437
+ * @summary Reorder account tiers
90438
+ * @param {ReorderTiersRequest} reorderTiersRequest
90439
+ * @param {*} [options] Override http request option.
90440
+ * @throws {RequiredError}
90441
+ */
90442
+ reorderTiers: (reorderTiersRequest: ReorderTiersRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
90336
90443
  /**
90337
90444
  * Updates the fields of an existing account tier identified by tierId, requiring read and update permission on tiers.
90338
90445
  * @summary Update an account tier
@@ -90439,6 +90546,14 @@ export declare const TiersApiFp: (configuration?: Configuration) => {
90439
90546
  * @throws {RequiredError}
90440
90547
  */
90441
90548
  removeTierAccounts(tierId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateTier200Response>>;
90549
+ /**
90550
+ * 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.
90551
+ * @summary Reorder account tiers
90552
+ * @param {ReorderTiersRequest} reorderTiersRequest
90553
+ * @param {*} [options] Override http request option.
90554
+ * @throws {RequiredError}
90555
+ */
90556
+ reorderTiers(reorderTiersRequest: ReorderTiersRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReorderTiers200Response>>;
90442
90557
  /**
90443
90558
  * Updates the fields of an existing account tier identified by tierId, requiring read and update permission on tiers.
90444
90559
  * @summary Update an account tier
@@ -90525,6 +90640,14 @@ export declare const TiersApiFactory: (configuration?: Configuration, basePath?:
90525
90640
  * @throws {RequiredError}
90526
90641
  */
90527
90642
  removeTierAccounts(requestParameters: TiersApiRemoveTierAccountsRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateTier200Response>;
90643
+ /**
90644
+ * 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.
90645
+ * @summary Reorder account tiers
90646
+ * @param {TiersApiReorderTiersRequest} requestParameters Request parameters.
90647
+ * @param {*} [options] Override http request option.
90648
+ * @throws {RequiredError}
90649
+ */
90650
+ reorderTiers(requestParameters: TiersApiReorderTiersRequest, options?: RawAxiosRequestConfig): AxiosPromise<ReorderTiers200Response>;
90528
90651
  /**
90529
90652
  * Updates the fields of an existing account tier identified by tierId, requiring read and update permission on tiers.
90530
90653
  * @summary Update an account tier
@@ -90692,6 +90815,12 @@ export interface TiersApiRemoveTierAccountsRequest {
90692
90815
  */
90693
90816
  readonly tierId: string;
90694
90817
  }
90818
+ /**
90819
+ * Request parameters for reorderTiers operation in TiersApi.
90820
+ */
90821
+ export interface TiersApiReorderTiersRequest {
90822
+ readonly reorderTiersRequest: ReorderTiersRequest;
90823
+ }
90695
90824
  /**
90696
90825
  * Request parameters for updateTier operation in TiersApi.
90697
90826
  */
@@ -90778,6 +90907,14 @@ export declare class TiersApi extends BaseAPI {
90778
90907
  * @throws {RequiredError}
90779
90908
  */
90780
90909
  removeTierAccounts(requestParameters: TiersApiRemoveTierAccountsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateTier200Response, any, {}, any>>;
90910
+ /**
90911
+ * 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.
90912
+ * @summary Reorder account tiers
90913
+ * @param {TiersApiReorderTiersRequest} requestParameters Request parameters.
90914
+ * @param {*} [options] Override http request option.
90915
+ * @throws {RequiredError}
90916
+ */
90917
+ reorderTiers(requestParameters: TiersApiReorderTiersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ReorderTiers200Response, any, {}, any>>;
90781
90918
  /**
90782
90919
  * Updates the fields of an existing account tier identified by tierId, requiring read and update permission on tiers.
90783
90920
  * @summary Update an account tier