@connectedxm/admin-sdk 11.6.0 → 11.7.0

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: 11.6.0
+ * The version of the OpenAPI document: 11.7.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -8559,6 +8559,14 @@ export interface GetMeetingSessionParticipant200Response {
 export declare enum GetMeetingSessionParticipant200ResponseStatusEnum {
     Ok = "ok"
 }
+export interface GetMeetingSessionParticipantReport200Response {
+    'status': GetMeetingSessionParticipantReport200ResponseStatusEnum;
+    'message': string;
+    'data': MeetingSessionParticipantReport;
+}
+export declare enum GetMeetingSessionParticipantReport200ResponseStatusEnum {
+    Ok = "ok"
+}
 export interface GetMeetingSessionParticipants200Response {
     'status': GetMeetingSessionParticipants200ResponseStatusEnum;
     'message': string;
@@ -10121,84 +10129,234 @@ export interface MeetingSessionParticipant {
     'role': string;
     'preset_name': string;
     'account': BaseAccount | null;
-    'peer_stats'?: MeetingSessionParticipantAllOfPeerStats;
-    'quality_stats'?: Array<MeetingSessionParticipantAllOfQualityStats>;
-}
-export interface MeetingSessionParticipantAllOfAudioStats {
-    'timestamp': string;
-    'concealment_events'?: number;
-    'packets_lost'?: number;
-    'jitter'?: number;
-    'quality'?: number;
-}
-export interface MeetingSessionParticipantAllOfPeerStats {
-    'config'?: string;
-    'status'?: string;
-    'device_info'?: MeetingSessionParticipantAllOfPeerStatsDeviceInfo;
-    'events'?: Array<MeetingSessionParticipantAllOfPeerStatsEvents>;
-    'ip_information'?: MeetingSessionParticipantAllOfPeerStatsIpInformation;
-    'precall_network_information'?: MeetingSessionParticipantAllOfPeerStatsPrecallNetworkInformation;
-}
-export interface MeetingSessionParticipantAllOfPeerStatsDeviceInfo {
-    'browser'?: string;
-    'browser_version'?: string;
-    'cpus'?: number;
-    'engine'?: string;
-    'is_mobile'?: boolean;
-    'memory'?: number;
-    'os'?: string;
-    'os_version'?: string;
-    'sdk_name'?: string;
-    'sdk_version'?: string;
-    'user_agent'?: string;
-    'webgl_support'?: string;
-}
-export interface MeetingSessionParticipantAllOfPeerStatsEvents {
-    'timestamp': string;
-    'type': string;
 }
-export interface MeetingSessionParticipantAllOfPeerStatsIpInformation {
-    'city'?: string;
-    'country'?: string;
-    'ip_location'?: string;
-    'ipv4'?: string;
-    'org'?: string;
-    'portal'?: string;
-    'region'?: string;
-    'timezone'?: string;
+export interface MeetingSessionParticipantReport {
+    'participant': BaseMeetingSessionParticipant;
+    'summary': MeetingSessionReportSummary;
+    'series': MeetingSessionReportSeriesMap;
+    'events': Array<MeetingSessionReportEvent>;
+    'devices': Array<MeetingSessionReportDevice>;
+    'meta': MeetingSessionParticipantReportMeta;
+}
+export interface MeetingSessionParticipantReportMeta {
+    'fetched_at': string;
+    'truncated': boolean;
+    'peer_id': string;
+    'has_data': boolean;
 }
-export interface MeetingSessionParticipantAllOfPeerStatsPrecallNetworkInformation {
-    'backend_rtt'?: number;
-    'turn_connectivity'?: boolean;
-    'effective_networktype'?: string;
-    'throughtput'?: number;
-    'jitter'?: number;
-    'rtt'?: number;
-    'reflexive_connectivity'?: boolean;
-    'relay_connectivity'?: boolean;
-    'fractional_loss'?: number;
-}
-export interface MeetingSessionParticipantAllOfQualityStats {
+export interface MeetingSessionReportConnection {
     'peer_id': string;
-    'audio_bandwidth'?: number;
-    'video_bandwidth'?: number;
-    'average_quality'?: number;
-    'start'?: string;
-    'end'?: string;
-    'audio_packet_loss'?: number;
-    'video_packet_loss'?: number;
-    'audio_stats'?: Array<MeetingSessionParticipantAllOfAudioStats>;
-    'video_stats'?: Array<MeetingSessionParticipantAllOfVideoStats>;
-}
-export interface MeetingSessionParticipantAllOfVideoStats {
-    'timestamp': string;
-    'frame_width'?: number;
-    'frame_height'?: number;
-    'frames_dropped'?: number;
-    'frames_per_second'?: number;
-    'packets_lost'?: number;
-    'jitter'?: number;
-    'quality'?: number;
+    'joined_at': string | null;
+    'left_at': string | null;
+    'reconnects': number;
+}
+export interface MeetingSessionReportDevice {
+    't': string;
+    'kind': MeetingSessionReportDeviceKindEnum;
+    'action': MeetingSessionReportDeviceActionEnum;
+    'label': string | null;
+    'device_id': string | null;
+}
+export declare enum MeetingSessionReportDeviceKindEnum {
+    Audioinput = "audioinput",
+    Videoinput = "videoinput",
+    Audiooutput = "audiooutput",
+    Unknown = "unknown"
+}
+export declare enum MeetingSessionReportDeviceActionEnum {
+    Selected = "selected",
+    Added = "added",
+    Removed = "removed"
+}
+export interface MeetingSessionReportDistribution {
+    'avg': number | null;
+    'p50': number | null;
+    'p75': number | null;
+    'p90': number | null;
+}
+export interface MeetingSessionReportEvent {
+    't': string;
+    'kind': MeetingSessionReportEventKindEnum;
+    'name': string;
+    'detail': {
+        [key: string]: any;
+    };
+}
+export declare enum MeetingSessionReportEventKindEnum {
+    Join = "join",
+    Leave = "leave",
+    Reconnect = "reconnect",
+    Media = "media",
+    Network = "network",
+    Device = "device",
+    Other = "other"
+}
+export interface MeetingSessionReportIssue {
+    'code': MeetingSessionReportIssueCode;
+    'severity': MeetingSessionReportIssueSeverityEnum;
+    'stream'?: MeetingSessionStreamKey;
+    'value': number;
+    'label': string;
+}
+export declare enum MeetingSessionReportIssueSeverityEnum {
+    Warning = "warning",
+    Critical = "critical"
+}
+export declare enum MeetingSessionReportIssueCode {
+    LowMos = "low_mos",
+    HighPacketLoss = "high_packet_loss",
+    HighRtt = "high_rtt",
+    AudioGlitches = "audio_glitches",
+    BandwidthLimited = "bandwidth_limited",
+    CpuLimited = "cpu_limited",
+    NoVideo = "no_video",
+    PoorResolution = "poor_resolution",
+    Lag = "lag",
+    HighJitterBuffer = "high_jitter_buffer",
+    RelayOnly = "relay_only",
+    TurnUnreachable = "turn_unreachable"
+}
+export interface MeetingSessionReportLatency {
+    'avg': number | null;
+    'ge_100': number | null;
+    'ge_250': number | null;
+    'ge_500': number | null;
+}
+export interface MeetingSessionReportPacketLoss {
+    'avg': number | null;
+    'ge_5': number | null;
+    'ge_10': number | null;
+    'ge_25': number | null;
+    'ge_50': number | null;
+}
+export interface MeetingSessionReportPoint {
+    't': string;
+    'mos': number | null;
+    'packets_lost': number | null;
+    'jitter_ms': number | null;
+    'rtt_ms'?: number | null;
+    'jitter_buffer_ms'?: number | null;
+    'bitrate_kbps': number | null;
+    'fps'?: number | null;
+    'width'?: number | null;
+    'height'?: number | null;
+    'frames_dropped'?: number | null;
+    'limitation'?: string | null;
+}
+export interface MeetingSessionReportSeries {
+    'step_seconds': number;
+    'downsampled_from': number;
+    'points': Array<MeetingSessionReportPoint>;
+}
+export interface MeetingSessionReportSeriesMap {
+    'audio_out'?: MeetingSessionReportSeries;
+    'audio_in'?: MeetingSessionReportSeries;
+    'video_out'?: MeetingSessionReportSeries;
+    'video_in'?: MeetingSessionReportSeries;
+    'screenshare_audio_out'?: MeetingSessionReportSeries;
+    'screenshare_audio_in'?: MeetingSessionReportSeries;
+    'screenshare_video_out'?: MeetingSessionReportSeries;
+    'screenshare_video_in'?: MeetingSessionReportSeries;
+}
+export interface MeetingSessionReportStreams {
+    'audio_out'?: MeetingSessionStreamSummary;
+    'audio_in'?: MeetingSessionStreamSummary;
+    'video_out'?: MeetingSessionStreamSummary;
+    'video_in'?: MeetingSessionStreamSummary;
+    'screenshare_audio_out'?: MeetingSessionStreamSummary;
+    'screenshare_audio_in'?: MeetingSessionStreamSummary;
+    'screenshare_video_out'?: MeetingSessionStreamSummary;
+    'screenshare_video_in'?: MeetingSessionStreamSummary;
+}
+export interface MeetingSessionReportSummary {
+    'connections': Array<MeetingSessionReportConnection>;
+    'platform': MeetingSessionReportSummaryPlatform;
+    'device': MeetingSessionReportSummaryDevice;
+    'location': MeetingSessionReportSummaryLocation;
+    'connectivity': MeetingSessionReportSummaryConnectivity;
+    'streams': MeetingSessionReportStreams;
+    'issues': Array<MeetingSessionReportIssue>;
+}
+export interface MeetingSessionReportSummaryConnectivity {
+    'effective_network_type': string | null;
+    'reflexive': boolean | null;
+    'relay': boolean | null;
+    'turn': boolean | null;
+    'relay_only': boolean;
+    'transports': MeetingSessionReportSummaryConnectivityTransports;
+}
+export interface MeetingSessionReportSummaryConnectivityTransports {
+    'producing': MeetingSessionReportSummaryConnectivityTransportsProducingEnum | null;
+    'consuming': MeetingSessionReportSummaryConnectivityTransportsConsumingEnum | null;
+}
+export declare enum MeetingSessionReportSummaryConnectivityTransportsProducingEnum {
+    Host = "host",
+    Srflx = "srflx",
+    Relay = "relay"
+}
+export declare enum MeetingSessionReportSummaryConnectivityTransportsConsumingEnum {
+    Host = "host",
+    Srflx = "srflx",
+    Relay = "relay"
+}
+export interface MeetingSessionReportSummaryDevice {
+    'os': string | null;
+    'os_version': string | null;
+    'is_mobile': boolean | null;
+    'cpus': number | null;
+    'browser': string | null;
+    'browser_version': string | null;
+    'webgl_support': boolean | null;
+}
+export interface MeetingSessionReportSummaryLocation {
+    'city': string | null;
+    'region': string | null;
+    'country': string | null;
+    'org': string | null;
+}
+export interface MeetingSessionReportSummaryPlatform {
+    'sdk_name': string | null;
+    'sdk_type': string | null;
+    'sdk_version': string | null;
+    'room_view_type': string | null;
+}
+export declare enum MeetingSessionStreamKey {
+    AudioOut = "audio_out",
+    AudioIn = "audio_in",
+    VideoOut = "video_out",
+    VideoIn = "video_in",
+    ScreenshareAudioOut = "screenshare_audio_out",
+    ScreenshareAudioIn = "screenshare_audio_in",
+    ScreenshareVideoOut = "screenshare_video_out",
+    ScreenshareVideoIn = "screenshare_video_in"
+}
+export interface MeetingSessionStreamSummary {
+    'sample_count': number;
+    'mos': MeetingSessionReportDistribution;
+    'packet_loss': MeetingSessionReportPacketLoss;
+    'rtt'?: MeetingSessionReportLatency;
+    'jitter_buffer'?: MeetingSessionReportLatency;
+    'glitch_count'?: number;
+    'video'?: MeetingSessionStreamVideoSummary;
+}
+export interface MeetingSessionStreamVideoSummary {
+    'fps': MeetingSessionReportDistribution;
+    'width': MeetingSessionReportDistribution;
+    'limitation'?: MeetingSessionStreamVideoSummaryLimitation;
+    'issues': MeetingSessionStreamVideoSummaryIssues;
+}
+export interface MeetingSessionStreamVideoSummaryIssues {
+    'bandwidth_fraction': number | null;
+    'cpu_fraction': number | null;
+    'no_video_fraction': number | null;
+    'poor_resolution_fraction': number | null;
+    'lag_fraction': number | null;
+}
+export interface MeetingSessionStreamVideoSummaryLimitation {
+    'cpu': number;
+    'bandwidth': number;
+    'other': number;
+    'resolution_changes': number;
 }
 export interface MeetingSessionSummaryDownload {
     'sessionId': string;
@@ -66460,6 +66618,16 @@ export declare const MeetingsSessionsApiAxiosParamCreator: (configuration?: Conf
      * @throws {RequiredError}
      */
     getMeetingSessionParticipant: (sessionId: string, participantId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Returns the call-quality report for one of a participant\'s connections (peers) within a meeting session: device, browser, location and connectivity details, per-stream quality roll-ups (audio, video and screenshare, sent and received), a plain-language list of detected issues, downsampled time series for charting, and a timeline of connection and device events. A participant who reconnected owns several peers; the response lists them under summary.connections and defaults to the longest-lived one unless peerId is given. Requires the \"read\" permission on meetings.
+     * @summary Get a meeting session participant\'s call-quality report
+     * @param {string} sessionId The session identifier
+     * @param {string} participantId The participant identifier
+     * @param {string} [peerId] Filter by peerId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getMeetingSessionParticipantReport: (sessionId: string, participantId: string, peerId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Returns a paginated list of participants who joined the given meeting session, with each participant\'s linked account attached when they are a known user, supports search and requires the \"read\" permission on meetings.
      * @summary List a meeting session\'s participants
@@ -66538,6 +66706,16 @@ export declare const MeetingsSessionsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     getMeetingSessionParticipant(sessionId: string, participantId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetMeetingSessionParticipant200Response>>;
+    /**
+     * Returns the call-quality report for one of a participant\'s connections (peers) within a meeting session: device, browser, location and connectivity details, per-stream quality roll-ups (audio, video and screenshare, sent and received), a plain-language list of detected issues, downsampled time series for charting, and a timeline of connection and device events. A participant who reconnected owns several peers; the response lists them under summary.connections and defaults to the longest-lived one unless peerId is given. Requires the \"read\" permission on meetings.
+     * @summary Get a meeting session participant\'s call-quality report
+     * @param {string} sessionId The session identifier
+     * @param {string} participantId The participant identifier
+     * @param {string} [peerId] Filter by peerId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getMeetingSessionParticipantReport(sessionId: string, participantId: string, peerId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetMeetingSessionParticipantReport200Response>>;
     /**
      * Returns a paginated list of participants who joined the given meeting session, with each participant\'s linked account attached when they are a known user, supports search and requires the \"read\" permission on meetings.
      * @summary List a meeting session\'s participants
@@ -66615,6 +66793,14 @@ export declare const MeetingsSessionsApiFactory: (configuration?: Configuration,
      * @throws {RequiredError}
      */
     getMeetingSessionParticipant(requestParameters: MeetingsSessionsApiGetMeetingSessionParticipantRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetMeetingSessionParticipant200Response>;
+    /**
+     * Returns the call-quality report for one of a participant\'s connections (peers) within a meeting session: device, browser, location and connectivity details, per-stream quality roll-ups (audio, video and screenshare, sent and received), a plain-language list of detected issues, downsampled time series for charting, and a timeline of connection and device events. A participant who reconnected owns several peers; the response lists them under summary.connections and defaults to the longest-lived one unless peerId is given. Requires the \"read\" permission on meetings.
+     * @summary Get a meeting session participant\'s call-quality report
+     * @param {MeetingsSessionsApiGetMeetingSessionParticipantReportRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getMeetingSessionParticipantReport(requestParameters: MeetingsSessionsApiGetMeetingSessionParticipantReportRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetMeetingSessionParticipantReport200Response>;
     /**
      * Returns a paginated list of participants who joined the given meeting session, with each participant\'s linked account attached when they are a known user, supports search and requires the \"read\" permission on meetings.
      * @summary List a meeting session\'s participants
@@ -66688,6 +66874,23 @@ export interface MeetingsSessionsApiGetMeetingSessionParticipantRequest {
      */
     readonly participantId: string;
 }
+/**
+ * Request parameters for getMeetingSessionParticipantReport operation in MeetingsSessionsApi.
+ */
+export interface MeetingsSessionsApiGetMeetingSessionParticipantReportRequest {
+    /**
+     * The session identifier
+     */
+    readonly sessionId: string;
+    /**
+     * The participant identifier
+     */
+    readonly participantId: string;
+    /**
+     * Filter by peerId
+     */
+    readonly peerId?: string;
+}
 /**
  * Request parameters for getMeetingSessionParticipants operation in MeetingsSessionsApi.
  */
@@ -66792,6 +66995,14 @@ export declare class MeetingsSessionsApi extends BaseAPI {
      * @throws {RequiredError}
      */
     getMeetingSessionParticipant(requestParameters: MeetingsSessionsApiGetMeetingSessionParticipantRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetMeetingSessionParticipant200Response, any, {}, any>>;
+    /**
+     * Returns the call-quality report for one of a participant\'s connections (peers) within a meeting session: device, browser, location and connectivity details, per-stream quality roll-ups (audio, video and screenshare, sent and received), a plain-language list of detected issues, downsampled time series for charting, and a timeline of connection and device events. A participant who reconnected owns several peers; the response lists them under summary.connections and defaults to the longest-lived one unless peerId is given. Requires the \"read\" permission on meetings.
+     * @summary Get a meeting session participant\'s call-quality report
+     * @param {MeetingsSessionsApiGetMeetingSessionParticipantReportRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getMeetingSessionParticipantReport(requestParameters: MeetingsSessionsApiGetMeetingSessionParticipantReportRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetMeetingSessionParticipantReport200Response, any, {}, any>>;
     /**
      * Returns a paginated list of participants who joined the given meeting session, with each participant\'s linked account attached when they are a known user, supports search and requires the \"read\" permission on meetings.
      * @summary List a meeting session\'s participants