@connectedxm/admin-sdk 11.5.2 → 11.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.
Files changed (59) hide show
  1. package/.openapi-generator/FILES +26 -8
  2. package/README.md +2 -2
  3. package/api.ts +353 -76
  4. package/base.ts +1 -1
  5. package/common.ts +1 -1
  6. package/configuration.ts +1 -1
  7. package/dist/api.d.ts +287 -76
  8. package/dist/api.js +173 -23
  9. package/dist/base.d.ts +1 -1
  10. package/dist/base.js +1 -1
  11. package/dist/common.d.ts +1 -1
  12. package/dist/common.js +1 -1
  13. package/dist/configuration.d.ts +1 -1
  14. package/dist/configuration.js +1 -1
  15. package/dist/esm/api.d.ts +287 -76
  16. package/dist/esm/api.js +151 -1
  17. package/dist/esm/base.d.ts +1 -1
  18. package/dist/esm/base.js +1 -1
  19. package/dist/esm/common.d.ts +1 -1
  20. package/dist/esm/common.js +1 -1
  21. package/dist/esm/configuration.d.ts +1 -1
  22. package/dist/esm/configuration.js +1 -1
  23. package/docs/GetMeetingSessionParticipantReport200Response.md +24 -0
  24. package/docs/MeetingSessionParticipant.md +0 -4
  25. package/docs/MeetingSessionParticipantReport.md +30 -0
  26. package/docs/MeetingSessionParticipantReportMeta.md +26 -0
  27. package/docs/MeetingSessionReportConnection.md +26 -0
  28. package/docs/MeetingSessionReportDevice.md +28 -0
  29. package/docs/MeetingSessionReportDistribution.md +26 -0
  30. package/docs/MeetingSessionReportEvent.md +26 -0
  31. package/docs/MeetingSessionReportIssue.md +28 -0
  32. package/docs/MeetingSessionReportIssueCode.md +30 -0
  33. package/docs/MeetingSessionReportLatency.md +26 -0
  34. package/docs/MeetingSessionReportPacketLoss.md +28 -0
  35. package/docs/MeetingSessionReportPoint.md +42 -0
  36. package/docs/MeetingSessionReportSeries.md +24 -0
  37. package/docs/MeetingSessionReportSeriesMap.md +34 -0
  38. package/docs/MeetingSessionReportStreams.md +34 -0
  39. package/docs/MeetingSessionReportSummary.md +32 -0
  40. package/docs/MeetingSessionReportSummaryConnectivity.md +30 -0
  41. package/docs/MeetingSessionReportSummaryConnectivityTransports.md +22 -0
  42. package/docs/MeetingSessionReportSummaryDevice.md +32 -0
  43. package/docs/MeetingSessionReportSummaryLocation.md +26 -0
  44. package/docs/MeetingSessionReportSummaryPlatform.md +26 -0
  45. package/docs/MeetingSessionStreamKey.md +22 -0
  46. package/docs/MeetingSessionStreamSummary.md +32 -0
  47. package/docs/MeetingSessionStreamVideoSummary.md +26 -0
  48. package/docs/MeetingSessionStreamVideoSummaryIssues.md +28 -0
  49. package/docs/MeetingSessionStreamVideoSummaryLimitation.md +26 -0
  50. package/docs/MeetingsSessionsApi.md +58 -0
  51. package/package.json +1 -1
  52. package/docs/MeetingSessionParticipantAllOfAudioStats.md +0 -28
  53. package/docs/MeetingSessionParticipantAllOfPeerStats.md +0 -30
  54. package/docs/MeetingSessionParticipantAllOfPeerStatsDeviceInfo.md +0 -42
  55. package/docs/MeetingSessionParticipantAllOfPeerStatsEvents.md +0 -22
  56. package/docs/MeetingSessionParticipantAllOfPeerStatsIpInformation.md +0 -34
  57. package/docs/MeetingSessionParticipantAllOfPeerStatsPrecallNetworkInformation.md +0 -36
  58. package/docs/MeetingSessionParticipantAllOfQualityStats.md +0 -38
  59. package/docs/MeetingSessionParticipantAllOfVideoStats.md +0 -34
package/dist/esm/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: 11.5.2
5
+ * The version of the OpenAPI document: 11.7.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -8559,6 +8559,14 @@ export interface GetMeetingSessionParticipant200Response {
8559
8559
  export declare enum GetMeetingSessionParticipant200ResponseStatusEnum {
8560
8560
  Ok = "ok"
8561
8561
  }
8562
+ export interface GetMeetingSessionParticipantReport200Response {
8563
+ 'status': GetMeetingSessionParticipantReport200ResponseStatusEnum;
8564
+ 'message': string;
8565
+ 'data': MeetingSessionParticipantReport;
8566
+ }
8567
+ export declare enum GetMeetingSessionParticipantReport200ResponseStatusEnum {
8568
+ Ok = "ok"
8569
+ }
8562
8570
  export interface GetMeetingSessionParticipants200Response {
8563
8571
  'status': GetMeetingSessionParticipants200ResponseStatusEnum;
8564
8572
  'message': string;
@@ -10121,84 +10129,234 @@ export interface MeetingSessionParticipant {
10121
10129
  'role': string;
10122
10130
  'preset_name': string;
10123
10131
  'account': BaseAccount | null;
10124
- 'peer_stats'?: MeetingSessionParticipantAllOfPeerStats;
10125
- 'quality_stats'?: Array<MeetingSessionParticipantAllOfQualityStats>;
10126
- }
10127
- export interface MeetingSessionParticipantAllOfAudioStats {
10128
- 'timestamp': string;
10129
- 'concealment_events'?: number;
10130
- 'packets_lost'?: number;
10131
- 'jitter'?: number;
10132
- 'quality'?: number;
10133
- }
10134
- export interface MeetingSessionParticipantAllOfPeerStats {
10135
- 'config'?: string;
10136
- 'status'?: string;
10137
- 'device_info'?: MeetingSessionParticipantAllOfPeerStatsDeviceInfo;
10138
- 'events'?: Array<MeetingSessionParticipantAllOfPeerStatsEvents>;
10139
- 'ip_information'?: MeetingSessionParticipantAllOfPeerStatsIpInformation;
10140
- 'precall_network_information'?: MeetingSessionParticipantAllOfPeerStatsPrecallNetworkInformation;
10141
- }
10142
- export interface MeetingSessionParticipantAllOfPeerStatsDeviceInfo {
10143
- 'browser'?: string;
10144
- 'browser_version'?: string;
10145
- 'cpus'?: number;
10146
- 'engine'?: string;
10147
- 'is_mobile'?: boolean;
10148
- 'memory'?: number;
10149
- 'os'?: string;
10150
- 'os_version'?: string;
10151
- 'sdk_name'?: string;
10152
- 'sdk_version'?: string;
10153
- 'user_agent'?: string;
10154
- 'webgl_support'?: string;
10155
- }
10156
- export interface MeetingSessionParticipantAllOfPeerStatsEvents {
10157
- 'timestamp': string;
10158
- 'type': string;
10159
10132
  }
10160
- export interface MeetingSessionParticipantAllOfPeerStatsIpInformation {
10161
- 'city'?: string;
10162
- 'country'?: string;
10163
- 'ip_location'?: string;
10164
- 'ipv4'?: string;
10165
- 'org'?: string;
10166
- 'portal'?: string;
10167
- 'region'?: string;
10168
- 'timezone'?: string;
10133
+ export interface MeetingSessionParticipantReport {
10134
+ 'participant': BaseMeetingSessionParticipant;
10135
+ 'summary': MeetingSessionReportSummary;
10136
+ 'series': MeetingSessionReportSeriesMap;
10137
+ 'events': Array<MeetingSessionReportEvent>;
10138
+ 'devices': Array<MeetingSessionReportDevice>;
10139
+ 'meta': MeetingSessionParticipantReportMeta;
10140
+ }
10141
+ export interface MeetingSessionParticipantReportMeta {
10142
+ 'fetched_at': string;
10143
+ 'truncated': boolean;
10144
+ 'peer_id': string;
10145
+ 'has_data': boolean;
10169
10146
  }
10170
- export interface MeetingSessionParticipantAllOfPeerStatsPrecallNetworkInformation {
10171
- 'backend_rtt'?: number;
10172
- 'turn_connectivity'?: boolean;
10173
- 'effective_networktype'?: string;
10174
- 'throughtput'?: number;
10175
- 'jitter'?: number;
10176
- 'rtt'?: number;
10177
- 'reflexive_connectivity'?: boolean;
10178
- 'relay_connectivity'?: boolean;
10179
- 'fractional_loss'?: number;
10180
- }
10181
- export interface MeetingSessionParticipantAllOfQualityStats {
10147
+ export interface MeetingSessionReportConnection {
10182
10148
  'peer_id': string;
10183
- 'audio_bandwidth'?: number;
10184
- 'video_bandwidth'?: number;
10185
- 'average_quality'?: number;
10186
- 'start'?: string;
10187
- 'end'?: string;
10188
- 'audio_packet_loss'?: number;
10189
- 'video_packet_loss'?: number;
10190
- 'audio_stats'?: Array<MeetingSessionParticipantAllOfAudioStats>;
10191
- 'video_stats'?: Array<MeetingSessionParticipantAllOfVideoStats>;
10192
- }
10193
- export interface MeetingSessionParticipantAllOfVideoStats {
10194
- 'timestamp': string;
10195
- 'frame_width'?: number;
10196
- 'frame_height'?: number;
10197
- 'frames_dropped'?: number;
10198
- 'frames_per_second'?: number;
10199
- 'packets_lost'?: number;
10200
- 'jitter'?: number;
10201
- 'quality'?: number;
10149
+ 'joined_at': string | null;
10150
+ 'left_at': string | null;
10151
+ 'reconnects': number;
10152
+ }
10153
+ export interface MeetingSessionReportDevice {
10154
+ 't': string;
10155
+ 'kind': MeetingSessionReportDeviceKindEnum;
10156
+ 'action': MeetingSessionReportDeviceActionEnum;
10157
+ 'label': string | null;
10158
+ 'device_id': string | null;
10159
+ }
10160
+ export declare enum MeetingSessionReportDeviceKindEnum {
10161
+ Audioinput = "audioinput",
10162
+ Videoinput = "videoinput",
10163
+ Audiooutput = "audiooutput",
10164
+ Unknown = "unknown"
10165
+ }
10166
+ export declare enum MeetingSessionReportDeviceActionEnum {
10167
+ Selected = "selected",
10168
+ Added = "added",
10169
+ Removed = "removed"
10170
+ }
10171
+ export interface MeetingSessionReportDistribution {
10172
+ 'avg': number | null;
10173
+ 'p50': number | null;
10174
+ 'p75': number | null;
10175
+ 'p90': number | null;
10176
+ }
10177
+ export interface MeetingSessionReportEvent {
10178
+ 't': string;
10179
+ 'kind': MeetingSessionReportEventKindEnum;
10180
+ 'name': string;
10181
+ 'detail': {
10182
+ [key: string]: any;
10183
+ };
10184
+ }
10185
+ export declare enum MeetingSessionReportEventKindEnum {
10186
+ Join = "join",
10187
+ Leave = "leave",
10188
+ Reconnect = "reconnect",
10189
+ Media = "media",
10190
+ Network = "network",
10191
+ Device = "device",
10192
+ Other = "other"
10193
+ }
10194
+ export interface MeetingSessionReportIssue {
10195
+ 'code': MeetingSessionReportIssueCode;
10196
+ 'severity': MeetingSessionReportIssueSeverityEnum;
10197
+ 'stream'?: MeetingSessionStreamKey;
10198
+ 'value': number;
10199
+ 'label': string;
10200
+ }
10201
+ export declare enum MeetingSessionReportIssueSeverityEnum {
10202
+ Warning = "warning",
10203
+ Critical = "critical"
10204
+ }
10205
+ export declare enum MeetingSessionReportIssueCode {
10206
+ LowMos = "low_mos",
10207
+ HighPacketLoss = "high_packet_loss",
10208
+ HighRtt = "high_rtt",
10209
+ AudioGlitches = "audio_glitches",
10210
+ BandwidthLimited = "bandwidth_limited",
10211
+ CpuLimited = "cpu_limited",
10212
+ NoVideo = "no_video",
10213
+ PoorResolution = "poor_resolution",
10214
+ Lag = "lag",
10215
+ HighJitterBuffer = "high_jitter_buffer",
10216
+ RelayOnly = "relay_only",
10217
+ TurnUnreachable = "turn_unreachable"
10218
+ }
10219
+ export interface MeetingSessionReportLatency {
10220
+ 'avg': number | null;
10221
+ 'ge_100': number | null;
10222
+ 'ge_250': number | null;
10223
+ 'ge_500': number | null;
10224
+ }
10225
+ export interface MeetingSessionReportPacketLoss {
10226
+ 'avg': number | null;
10227
+ 'ge_5': number | null;
10228
+ 'ge_10': number | null;
10229
+ 'ge_25': number | null;
10230
+ 'ge_50': number | null;
10231
+ }
10232
+ export interface MeetingSessionReportPoint {
10233
+ 't': string;
10234
+ 'mos': number | null;
10235
+ 'packets_lost': number | null;
10236
+ 'jitter_ms': number | null;
10237
+ 'rtt_ms'?: number | null;
10238
+ 'jitter_buffer_ms'?: number | null;
10239
+ 'bitrate_kbps': number | null;
10240
+ 'fps'?: number | null;
10241
+ 'width'?: number | null;
10242
+ 'height'?: number | null;
10243
+ 'frames_dropped'?: number | null;
10244
+ 'limitation'?: string | null;
10245
+ }
10246
+ export interface MeetingSessionReportSeries {
10247
+ 'step_seconds': number;
10248
+ 'downsampled_from': number;
10249
+ 'points': Array<MeetingSessionReportPoint>;
10250
+ }
10251
+ export interface MeetingSessionReportSeriesMap {
10252
+ 'audio_out'?: MeetingSessionReportSeries;
10253
+ 'audio_in'?: MeetingSessionReportSeries;
10254
+ 'video_out'?: MeetingSessionReportSeries;
10255
+ 'video_in'?: MeetingSessionReportSeries;
10256
+ 'screenshare_audio_out'?: MeetingSessionReportSeries;
10257
+ 'screenshare_audio_in'?: MeetingSessionReportSeries;
10258
+ 'screenshare_video_out'?: MeetingSessionReportSeries;
10259
+ 'screenshare_video_in'?: MeetingSessionReportSeries;
10260
+ }
10261
+ export interface MeetingSessionReportStreams {
10262
+ 'audio_out'?: MeetingSessionStreamSummary;
10263
+ 'audio_in'?: MeetingSessionStreamSummary;
10264
+ 'video_out'?: MeetingSessionStreamSummary;
10265
+ 'video_in'?: MeetingSessionStreamSummary;
10266
+ 'screenshare_audio_out'?: MeetingSessionStreamSummary;
10267
+ 'screenshare_audio_in'?: MeetingSessionStreamSummary;
10268
+ 'screenshare_video_out'?: MeetingSessionStreamSummary;
10269
+ 'screenshare_video_in'?: MeetingSessionStreamSummary;
10270
+ }
10271
+ export interface MeetingSessionReportSummary {
10272
+ 'connections': Array<MeetingSessionReportConnection>;
10273
+ 'platform': MeetingSessionReportSummaryPlatform;
10274
+ 'device': MeetingSessionReportSummaryDevice;
10275
+ 'location': MeetingSessionReportSummaryLocation;
10276
+ 'connectivity': MeetingSessionReportSummaryConnectivity;
10277
+ 'streams': MeetingSessionReportStreams;
10278
+ 'issues': Array<MeetingSessionReportIssue>;
10279
+ }
10280
+ export interface MeetingSessionReportSummaryConnectivity {
10281
+ 'effective_network_type': string | null;
10282
+ 'reflexive': boolean | null;
10283
+ 'relay': boolean | null;
10284
+ 'turn': boolean | null;
10285
+ 'relay_only': boolean;
10286
+ 'transports': MeetingSessionReportSummaryConnectivityTransports;
10287
+ }
10288
+ export interface MeetingSessionReportSummaryConnectivityTransports {
10289
+ 'producing': MeetingSessionReportSummaryConnectivityTransportsProducingEnum | null;
10290
+ 'consuming': MeetingSessionReportSummaryConnectivityTransportsConsumingEnum | null;
10291
+ }
10292
+ export declare enum MeetingSessionReportSummaryConnectivityTransportsProducingEnum {
10293
+ Host = "host",
10294
+ Srflx = "srflx",
10295
+ Relay = "relay"
10296
+ }
10297
+ export declare enum MeetingSessionReportSummaryConnectivityTransportsConsumingEnum {
10298
+ Host = "host",
10299
+ Srflx = "srflx",
10300
+ Relay = "relay"
10301
+ }
10302
+ export interface MeetingSessionReportSummaryDevice {
10303
+ 'os': string | null;
10304
+ 'os_version': string | null;
10305
+ 'is_mobile': boolean | null;
10306
+ 'cpus': number | null;
10307
+ 'browser': string | null;
10308
+ 'browser_version': string | null;
10309
+ 'webgl_support': boolean | null;
10310
+ }
10311
+ export interface MeetingSessionReportSummaryLocation {
10312
+ 'city': string | null;
10313
+ 'region': string | null;
10314
+ 'country': string | null;
10315
+ 'org': string | null;
10316
+ }
10317
+ export interface MeetingSessionReportSummaryPlatform {
10318
+ 'sdk_name': string | null;
10319
+ 'sdk_type': string | null;
10320
+ 'sdk_version': string | null;
10321
+ 'room_view_type': string | null;
10322
+ }
10323
+ export declare enum MeetingSessionStreamKey {
10324
+ AudioOut = "audio_out",
10325
+ AudioIn = "audio_in",
10326
+ VideoOut = "video_out",
10327
+ VideoIn = "video_in",
10328
+ ScreenshareAudioOut = "screenshare_audio_out",
10329
+ ScreenshareAudioIn = "screenshare_audio_in",
10330
+ ScreenshareVideoOut = "screenshare_video_out",
10331
+ ScreenshareVideoIn = "screenshare_video_in"
10332
+ }
10333
+ export interface MeetingSessionStreamSummary {
10334
+ 'sample_count': number;
10335
+ 'mos': MeetingSessionReportDistribution;
10336
+ 'packet_loss': MeetingSessionReportPacketLoss;
10337
+ 'rtt'?: MeetingSessionReportLatency;
10338
+ 'jitter_buffer'?: MeetingSessionReportLatency;
10339
+ 'glitch_count'?: number;
10340
+ 'video'?: MeetingSessionStreamVideoSummary;
10341
+ }
10342
+ export interface MeetingSessionStreamVideoSummary {
10343
+ 'fps': MeetingSessionReportDistribution;
10344
+ 'width': MeetingSessionReportDistribution;
10345
+ 'limitation'?: MeetingSessionStreamVideoSummaryLimitation;
10346
+ 'issues': MeetingSessionStreamVideoSummaryIssues;
10347
+ }
10348
+ export interface MeetingSessionStreamVideoSummaryIssues {
10349
+ 'bandwidth_fraction': number | null;
10350
+ 'cpu_fraction': number | null;
10351
+ 'no_video_fraction': number | null;
10352
+ 'poor_resolution_fraction': number | null;
10353
+ 'lag_fraction': number | null;
10354
+ }
10355
+ export interface MeetingSessionStreamVideoSummaryLimitation {
10356
+ 'cpu': number;
10357
+ 'bandwidth': number;
10358
+ 'other': number;
10359
+ 'resolution_changes': number;
10202
10360
  }
10203
10361
  export interface MeetingSessionSummaryDownload {
10204
10362
  'sessionId': string;
@@ -66460,6 +66618,16 @@ export declare const MeetingsSessionsApiAxiosParamCreator: (configuration?: Conf
66460
66618
  * @throws {RequiredError}
66461
66619
  */
66462
66620
  getMeetingSessionParticipant: (sessionId: string, participantId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
66621
+ /**
66622
+ * 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.
66623
+ * @summary Get a meeting session participant\'s call-quality report
66624
+ * @param {string} sessionId The session identifier
66625
+ * @param {string} participantId The participant identifier
66626
+ * @param {string} [peerId] Filter by peerId
66627
+ * @param {*} [options] Override http request option.
66628
+ * @throws {RequiredError}
66629
+ */
66630
+ getMeetingSessionParticipantReport: (sessionId: string, participantId: string, peerId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
66463
66631
  /**
66464
66632
  * 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.
66465
66633
  * @summary List a meeting session\'s participants
@@ -66538,6 +66706,16 @@ export declare const MeetingsSessionsApiFp: (configuration?: Configuration) => {
66538
66706
  * @throws {RequiredError}
66539
66707
  */
66540
66708
  getMeetingSessionParticipant(sessionId: string, participantId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetMeetingSessionParticipant200Response>>;
66709
+ /**
66710
+ * 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.
66711
+ * @summary Get a meeting session participant\'s call-quality report
66712
+ * @param {string} sessionId The session identifier
66713
+ * @param {string} participantId The participant identifier
66714
+ * @param {string} [peerId] Filter by peerId
66715
+ * @param {*} [options] Override http request option.
66716
+ * @throws {RequiredError}
66717
+ */
66718
+ getMeetingSessionParticipantReport(sessionId: string, participantId: string, peerId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetMeetingSessionParticipantReport200Response>>;
66541
66719
  /**
66542
66720
  * 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.
66543
66721
  * @summary List a meeting session\'s participants
@@ -66615,6 +66793,14 @@ export declare const MeetingsSessionsApiFactory: (configuration?: Configuration,
66615
66793
  * @throws {RequiredError}
66616
66794
  */
66617
66795
  getMeetingSessionParticipant(requestParameters: MeetingsSessionsApiGetMeetingSessionParticipantRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetMeetingSessionParticipant200Response>;
66796
+ /**
66797
+ * 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.
66798
+ * @summary Get a meeting session participant\'s call-quality report
66799
+ * @param {MeetingsSessionsApiGetMeetingSessionParticipantReportRequest} requestParameters Request parameters.
66800
+ * @param {*} [options] Override http request option.
66801
+ * @throws {RequiredError}
66802
+ */
66803
+ getMeetingSessionParticipantReport(requestParameters: MeetingsSessionsApiGetMeetingSessionParticipantReportRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetMeetingSessionParticipantReport200Response>;
66618
66804
  /**
66619
66805
  * 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.
66620
66806
  * @summary List a meeting session\'s participants
@@ -66688,6 +66874,23 @@ export interface MeetingsSessionsApiGetMeetingSessionParticipantRequest {
66688
66874
  */
66689
66875
  readonly participantId: string;
66690
66876
  }
66877
+ /**
66878
+ * Request parameters for getMeetingSessionParticipantReport operation in MeetingsSessionsApi.
66879
+ */
66880
+ export interface MeetingsSessionsApiGetMeetingSessionParticipantReportRequest {
66881
+ /**
66882
+ * The session identifier
66883
+ */
66884
+ readonly sessionId: string;
66885
+ /**
66886
+ * The participant identifier
66887
+ */
66888
+ readonly participantId: string;
66889
+ /**
66890
+ * Filter by peerId
66891
+ */
66892
+ readonly peerId?: string;
66893
+ }
66691
66894
  /**
66692
66895
  * Request parameters for getMeetingSessionParticipants operation in MeetingsSessionsApi.
66693
66896
  */
@@ -66792,6 +66995,14 @@ export declare class MeetingsSessionsApi extends BaseAPI {
66792
66995
  * @throws {RequiredError}
66793
66996
  */
66794
66997
  getMeetingSessionParticipant(requestParameters: MeetingsSessionsApiGetMeetingSessionParticipantRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetMeetingSessionParticipant200Response, any, {}, any>>;
66998
+ /**
66999
+ * 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.
67000
+ * @summary Get a meeting session participant\'s call-quality report
67001
+ * @param {MeetingsSessionsApiGetMeetingSessionParticipantReportRequest} requestParameters Request parameters.
67002
+ * @param {*} [options] Override http request option.
67003
+ * @throws {RequiredError}
67004
+ */
67005
+ getMeetingSessionParticipantReport(requestParameters: MeetingsSessionsApiGetMeetingSessionParticipantReportRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetMeetingSessionParticipantReport200Response, any, {}, any>>;
66795
67006
  /**
66796
67007
  * 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.
66797
67008
  * @summary List a meeting session\'s participants
package/dist/esm/api.js CHANGED
@@ -4,7 +4,7 @@
4
4
  * Connected Admin API
5
5
  * The Admin API allows you to manage your Connected community programmatically.
6
6
  *
7
- * The version of the OpenAPI document: 11.5.2
7
+ * The version of the OpenAPI document: 11.7.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -1636,6 +1636,10 @@ export var GetMeetingSessionParticipant200ResponseStatusEnum;
1636
1636
  (function (GetMeetingSessionParticipant200ResponseStatusEnum) {
1637
1637
  GetMeetingSessionParticipant200ResponseStatusEnum["Ok"] = "ok";
1638
1638
  })(GetMeetingSessionParticipant200ResponseStatusEnum || (GetMeetingSessionParticipant200ResponseStatusEnum = {}));
1639
+ export var GetMeetingSessionParticipantReport200ResponseStatusEnum;
1640
+ (function (GetMeetingSessionParticipantReport200ResponseStatusEnum) {
1641
+ GetMeetingSessionParticipantReport200ResponseStatusEnum["Ok"] = "ok";
1642
+ })(GetMeetingSessionParticipantReport200ResponseStatusEnum || (GetMeetingSessionParticipantReport200ResponseStatusEnum = {}));
1639
1643
  export var GetMeetingSessionParticipants200ResponseStatusEnum;
1640
1644
  (function (GetMeetingSessionParticipants200ResponseStatusEnum) {
1641
1645
  GetMeetingSessionParticipants200ResponseStatusEnum["Ok"] = "ok";
@@ -2161,6 +2165,72 @@ export var MeetingSessionStatusEnum;
2161
2165
  MeetingSessionStatusEnum["Live"] = "LIVE";
2162
2166
  MeetingSessionStatusEnum["Ended"] = "ENDED";
2163
2167
  })(MeetingSessionStatusEnum || (MeetingSessionStatusEnum = {}));
2168
+ export var MeetingSessionReportDeviceKindEnum;
2169
+ (function (MeetingSessionReportDeviceKindEnum) {
2170
+ MeetingSessionReportDeviceKindEnum["Audioinput"] = "audioinput";
2171
+ MeetingSessionReportDeviceKindEnum["Videoinput"] = "videoinput";
2172
+ MeetingSessionReportDeviceKindEnum["Audiooutput"] = "audiooutput";
2173
+ MeetingSessionReportDeviceKindEnum["Unknown"] = "unknown";
2174
+ })(MeetingSessionReportDeviceKindEnum || (MeetingSessionReportDeviceKindEnum = {}));
2175
+ export var MeetingSessionReportDeviceActionEnum;
2176
+ (function (MeetingSessionReportDeviceActionEnum) {
2177
+ MeetingSessionReportDeviceActionEnum["Selected"] = "selected";
2178
+ MeetingSessionReportDeviceActionEnum["Added"] = "added";
2179
+ MeetingSessionReportDeviceActionEnum["Removed"] = "removed";
2180
+ })(MeetingSessionReportDeviceActionEnum || (MeetingSessionReportDeviceActionEnum = {}));
2181
+ export var MeetingSessionReportEventKindEnum;
2182
+ (function (MeetingSessionReportEventKindEnum) {
2183
+ MeetingSessionReportEventKindEnum["Join"] = "join";
2184
+ MeetingSessionReportEventKindEnum["Leave"] = "leave";
2185
+ MeetingSessionReportEventKindEnum["Reconnect"] = "reconnect";
2186
+ MeetingSessionReportEventKindEnum["Media"] = "media";
2187
+ MeetingSessionReportEventKindEnum["Network"] = "network";
2188
+ MeetingSessionReportEventKindEnum["Device"] = "device";
2189
+ MeetingSessionReportEventKindEnum["Other"] = "other";
2190
+ })(MeetingSessionReportEventKindEnum || (MeetingSessionReportEventKindEnum = {}));
2191
+ export var MeetingSessionReportIssueSeverityEnum;
2192
+ (function (MeetingSessionReportIssueSeverityEnum) {
2193
+ MeetingSessionReportIssueSeverityEnum["Warning"] = "warning";
2194
+ MeetingSessionReportIssueSeverityEnum["Critical"] = "critical";
2195
+ })(MeetingSessionReportIssueSeverityEnum || (MeetingSessionReportIssueSeverityEnum = {}));
2196
+ export var MeetingSessionReportIssueCode;
2197
+ (function (MeetingSessionReportIssueCode) {
2198
+ MeetingSessionReportIssueCode["LowMos"] = "low_mos";
2199
+ MeetingSessionReportIssueCode["HighPacketLoss"] = "high_packet_loss";
2200
+ MeetingSessionReportIssueCode["HighRtt"] = "high_rtt";
2201
+ MeetingSessionReportIssueCode["AudioGlitches"] = "audio_glitches";
2202
+ MeetingSessionReportIssueCode["BandwidthLimited"] = "bandwidth_limited";
2203
+ MeetingSessionReportIssueCode["CpuLimited"] = "cpu_limited";
2204
+ MeetingSessionReportIssueCode["NoVideo"] = "no_video";
2205
+ MeetingSessionReportIssueCode["PoorResolution"] = "poor_resolution";
2206
+ MeetingSessionReportIssueCode["Lag"] = "lag";
2207
+ MeetingSessionReportIssueCode["HighJitterBuffer"] = "high_jitter_buffer";
2208
+ MeetingSessionReportIssueCode["RelayOnly"] = "relay_only";
2209
+ MeetingSessionReportIssueCode["TurnUnreachable"] = "turn_unreachable";
2210
+ })(MeetingSessionReportIssueCode || (MeetingSessionReportIssueCode = {}));
2211
+ export var MeetingSessionReportSummaryConnectivityTransportsProducingEnum;
2212
+ (function (MeetingSessionReportSummaryConnectivityTransportsProducingEnum) {
2213
+ MeetingSessionReportSummaryConnectivityTransportsProducingEnum["Host"] = "host";
2214
+ MeetingSessionReportSummaryConnectivityTransportsProducingEnum["Srflx"] = "srflx";
2215
+ MeetingSessionReportSummaryConnectivityTransportsProducingEnum["Relay"] = "relay";
2216
+ })(MeetingSessionReportSummaryConnectivityTransportsProducingEnum || (MeetingSessionReportSummaryConnectivityTransportsProducingEnum = {}));
2217
+ export var MeetingSessionReportSummaryConnectivityTransportsConsumingEnum;
2218
+ (function (MeetingSessionReportSummaryConnectivityTransportsConsumingEnum) {
2219
+ MeetingSessionReportSummaryConnectivityTransportsConsumingEnum["Host"] = "host";
2220
+ MeetingSessionReportSummaryConnectivityTransportsConsumingEnum["Srflx"] = "srflx";
2221
+ MeetingSessionReportSummaryConnectivityTransportsConsumingEnum["Relay"] = "relay";
2222
+ })(MeetingSessionReportSummaryConnectivityTransportsConsumingEnum || (MeetingSessionReportSummaryConnectivityTransportsConsumingEnum = {}));
2223
+ export var MeetingSessionStreamKey;
2224
+ (function (MeetingSessionStreamKey) {
2225
+ MeetingSessionStreamKey["AudioOut"] = "audio_out";
2226
+ MeetingSessionStreamKey["AudioIn"] = "audio_in";
2227
+ MeetingSessionStreamKey["VideoOut"] = "video_out";
2228
+ MeetingSessionStreamKey["VideoIn"] = "video_in";
2229
+ MeetingSessionStreamKey["ScreenshareAudioOut"] = "screenshare_audio_out";
2230
+ MeetingSessionStreamKey["ScreenshareAudioIn"] = "screenshare_audio_in";
2231
+ MeetingSessionStreamKey["ScreenshareVideoOut"] = "screenshare_video_out";
2232
+ MeetingSessionStreamKey["ScreenshareVideoIn"] = "screenshare_video_in";
2233
+ })(MeetingSessionStreamKey || (MeetingSessionStreamKey = {}));
2164
2234
  export var MeetingType;
2165
2235
  (function (MeetingType) {
2166
2236
  MeetingType["GroupCall"] = "GROUP_CALL";
@@ -81939,6 +82009,48 @@ export const MeetingsSessionsApiAxiosParamCreator = function (configuration) {
81939
82009
  options: localVarRequestOptions,
81940
82010
  };
81941
82011
  }),
82012
+ /**
82013
+ * 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.
82014
+ * @summary Get a meeting session participant\'s call-quality report
82015
+ * @param {string} sessionId The session identifier
82016
+ * @param {string} participantId The participant identifier
82017
+ * @param {string} [peerId] Filter by peerId
82018
+ * @param {*} [options] Override http request option.
82019
+ * @throws {RequiredError}
82020
+ */
82021
+ getMeetingSessionParticipantReport: (sessionId_1, participantId_1, peerId_1, ...args_1) => __awaiter(this, [sessionId_1, participantId_1, peerId_1, ...args_1], void 0, function* (sessionId, participantId, peerId, options = {}) {
82022
+ // verify required parameter 'sessionId' is not null or undefined
82023
+ assertParamExists('getMeetingSessionParticipantReport', 'sessionId', sessionId);
82024
+ // verify required parameter 'participantId' is not null or undefined
82025
+ assertParamExists('getMeetingSessionParticipantReport', 'participantId', participantId);
82026
+ const localVarPath = `/meetings/sessions/{sessionId}/participants/{participantId}/report`
82027
+ .replace('{sessionId}', encodeURIComponent(String(sessionId)))
82028
+ .replace('{participantId}', encodeURIComponent(String(participantId)));
82029
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
82030
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
82031
+ let baseOptions;
82032
+ if (configuration) {
82033
+ baseOptions = configuration.baseOptions;
82034
+ }
82035
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
82036
+ const localVarHeaderParameter = {};
82037
+ const localVarQueryParameter = {};
82038
+ // authentication ApiKeyAuth required
82039
+ yield setApiKeyToObject(localVarHeaderParameter, "api-key", configuration);
82040
+ // authentication OrganizationId required
82041
+ yield setApiKeyToObject(localVarHeaderParameter, "organization", configuration);
82042
+ if (peerId !== undefined) {
82043
+ localVarQueryParameter['peerId'] = peerId;
82044
+ }
82045
+ localVarHeaderParameter['Accept'] = 'application/json';
82046
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
82047
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
82048
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
82049
+ return {
82050
+ url: toPathString(localVarUrlObj),
82051
+ options: localVarRequestOptions,
82052
+ };
82053
+ }),
81942
82054
  /**
81943
82055
  * 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.
81944
82056
  * @summary List a meeting session\'s participants
@@ -82180,6 +82292,24 @@ export const MeetingsSessionsApiFp = function (configuration) {
82180
82292
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
82181
82293
  });
82182
82294
  },
82295
+ /**
82296
+ * 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.
82297
+ * @summary Get a meeting session participant\'s call-quality report
82298
+ * @param {string} sessionId The session identifier
82299
+ * @param {string} participantId The participant identifier
82300
+ * @param {string} [peerId] Filter by peerId
82301
+ * @param {*} [options] Override http request option.
82302
+ * @throws {RequiredError}
82303
+ */
82304
+ getMeetingSessionParticipantReport(sessionId, participantId, peerId, options) {
82305
+ return __awaiter(this, void 0, void 0, function* () {
82306
+ var _a, _b, _c;
82307
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.getMeetingSessionParticipantReport(sessionId, participantId, peerId, options);
82308
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
82309
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['MeetingsSessionsApi.getMeetingSessionParticipantReport']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
82310
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
82311
+ });
82312
+ },
82183
82313
  /**
82184
82314
  * 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.
82185
82315
  * @summary List a meeting session\'s participants
@@ -82300,6 +82430,16 @@ export const MeetingsSessionsApiFactory = function (configuration, basePath, axi
82300
82430
  getMeetingSessionParticipant(requestParameters, options) {
82301
82431
  return localVarFp.getMeetingSessionParticipant(requestParameters.sessionId, requestParameters.participantId, options).then((request) => request(axios, basePath));
82302
82432
  },
82433
+ /**
82434
+ * 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.
82435
+ * @summary Get a meeting session participant\'s call-quality report
82436
+ * @param {MeetingsSessionsApiGetMeetingSessionParticipantReportRequest} requestParameters Request parameters.
82437
+ * @param {*} [options] Override http request option.
82438
+ * @throws {RequiredError}
82439
+ */
82440
+ getMeetingSessionParticipantReport(requestParameters, options) {
82441
+ return localVarFp.getMeetingSessionParticipantReport(requestParameters.sessionId, requestParameters.participantId, requestParameters.peerId, options).then((request) => request(axios, basePath));
82442
+ },
82303
82443
  /**
82304
82444
  * 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.
82305
82445
  * @summary List a meeting session\'s participants
@@ -82386,6 +82526,16 @@ export class MeetingsSessionsApi extends BaseAPI {
82386
82526
  getMeetingSessionParticipant(requestParameters, options) {
82387
82527
  return MeetingsSessionsApiFp(this.configuration).getMeetingSessionParticipant(requestParameters.sessionId, requestParameters.participantId, options).then((request) => request(this.axios, this.basePath));
82388
82528
  }
82529
+ /**
82530
+ * 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.
82531
+ * @summary Get a meeting session participant\'s call-quality report
82532
+ * @param {MeetingsSessionsApiGetMeetingSessionParticipantReportRequest} requestParameters Request parameters.
82533
+ * @param {*} [options] Override http request option.
82534
+ * @throws {RequiredError}
82535
+ */
82536
+ getMeetingSessionParticipantReport(requestParameters, options) {
82537
+ return MeetingsSessionsApiFp(this.configuration).getMeetingSessionParticipantReport(requestParameters.sessionId, requestParameters.participantId, requestParameters.peerId, options).then((request) => request(this.axios, this.basePath));
82538
+ }
82389
82539
  /**
82390
82540
  * 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.
82391
82541
  * @summary List a meeting session\'s participants
@@ -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: 11.5.2
5
+ * The version of the OpenAPI document: 11.7.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/esm/base.js CHANGED
@@ -4,7 +4,7 @@
4
4
  * Connected Admin API
5
5
  * The Admin API allows you to manage your Connected community programmatically.
6
6
  *
7
- * The version of the OpenAPI document: 11.5.2
7
+ * The version of the OpenAPI document: 11.7.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -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: 11.5.2
5
+ * The version of the OpenAPI document: 11.7.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).