From e2e38284049e7267f45cc7958e0705fefe39fdeb Mon Sep 17 00:00:00 2001 From: Matvei Andrienko Date: Thu, 7 Nov 2024 14:07:10 +0100 Subject: [PATCH] update openapi types --- packages/client/src/Call.ts | 4 +- packages/client/src/gen/coordinator/index.ts | 1202 ++++++++++-------- 2 files changed, 688 insertions(+), 518 deletions(-) diff --git a/packages/client/src/Call.ts b/packages/client/src/Call.ts index 0ec119e44c..ba8b17145f 100644 --- a/packages/client/src/Call.ts +++ b/packages/client/src/Call.ts @@ -76,7 +76,7 @@ import type { UpdateCallResponse, UpdateUserPermissionsRequest, UpdateUserPermissionsResponse, - VideoResolution, + VideoDimension, } from './gen/coordinator'; import { OwnCapability } from './gen/coordinator'; import { @@ -2317,7 +2317,7 @@ export class Call { * preference has effect on. Affects all participants by default. */ setPreferredIncomingVideoResolution = ( - resolution: VideoResolution | undefined, + resolution: VideoDimension | undefined, sessionIds?: string[], ) => { this.dynascaleManager.setVideoTrackSubscriptionOverrides( diff --git a/packages/client/src/gen/coordinator/index.ts b/packages/client/src/gen/coordinator/index.ts index b90dc28010..57fa3ec743 100644 --- a/packages/client/src/gen/coordinator/index.ts +++ b/packages/client/src/gen/coordinator/index.ts @@ -620,6 +620,18 @@ export interface CallEndedEvent { * @interface CallEvent */ export interface CallEvent { + /** + * + * @type {string} + * @memberof CallEvent + */ + category?: string; + /** + * + * @type {string} + * @memberof CallEvent + */ + component?: string; /** * * @type {string} @@ -632,6 +644,24 @@ export interface CallEvent { * @memberof CallEvent */ end_timestamp: number; + /** + * + * @type {boolean} + * @memberof CallEvent + */ + internal: boolean; + /** + * + * @type {Array} + * @memberof CallEvent + */ + issue_tags?: Array; + /** + * + * @type {string} + * @memberof CallEvent + */ + kind: string; /** * * @type {number} @@ -2344,10 +2374,10 @@ export interface ChannelConfigWithInfo { partition_size?: number; /** * - * @type {number} + * @type {string} * @memberof ChannelConfigWithInfo */ - partition_ttl?: number; + partition_ttl?: string | null; /** * * @type {boolean} @@ -2396,6 +2426,12 @@ export interface ChannelConfigWithInfo { * @memberof ChannelConfigWithInfo */ search: boolean; + /** + * + * @type {boolean} + * @memberof ChannelConfigWithInfo + */ + skip_last_msg_update_for_system_msgs: boolean; /** * * @type {boolean} @@ -2462,29 +2498,41 @@ export type ChannelConfigWithInfoBlocklistBehaviorEnum = */ export interface ChannelMember { /** - * Expiration date of the ban + * + * @type {string} + * @memberof ChannelMember + */ + archived_at?: string; + /** + * * @type {string} * @memberof ChannelMember */ ban_expires?: string; /** - * Whether member is banned this channel or not + * * @type {boolean} * @memberof ChannelMember */ banned: boolean; /** - * Role of the member in the channel + * * @type {string} * @memberof ChannelMember */ channel_role: string; /** - * Date/time of creation + * * @type {string} * @memberof ChannelMember */ created_at: string; + /** + * + * @type {{ [key: string]: any; }} + * @memberof ChannelMember + */ + custom: { [key: string]: any }; /** * * @type {string} @@ -2492,25 +2540,25 @@ export interface ChannelMember { */ deleted_at?: string; /** - * Date when invite was accepted + * * @type {string} * @memberof ChannelMember */ invite_accepted_at?: string; /** - * Date when invite was rejected + * * @type {string} * @memberof ChannelMember */ invite_rejected_at?: string; /** - * Whether member was invited or not + * * @type {boolean} * @memberof ChannelMember */ invited?: boolean; /** - * Whether member is channel moderator or not + * * @type {boolean} * @memberof ChannelMember */ @@ -2522,7 +2570,13 @@ export interface ChannelMember { */ notifications_muted: boolean; /** - * Whether member is shadow banned in this channel or not + * + * @type {string} + * @memberof ChannelMember + */ + pinned_at?: string; + /** + * * @type {boolean} * @memberof ChannelMember */ @@ -2534,7 +2588,7 @@ export interface ChannelMember { */ status?: string; /** - * Date/time of the last update + * * @type {string} * @memberof ChannelMember */ @@ -2584,11 +2638,57 @@ export interface ChannelMute { updated_at: string; /** * - * @type {UserObject} + * @type {UserResponse} * @memberof ChannelMute */ - user?: UserObject; + user?: UserResponse; } + +/** + * All possibility of string to use + * @export + */ +export const ChannelOwnCapability = { + BAN_CHANNEL_MEMBERS: 'ban-channel-members', + CAST_POLL_VOTE: 'cast-poll-vote', + CONNECT_EVENTS: 'connect-events', + CREATE_ATTACHMENT: 'create-attachment', + CREATE_CALL: 'create-call', + DELETE_ANY_MESSAGE: 'delete-any-message', + DELETE_CHANNEL: 'delete-channel', + DELETE_OWN_MESSAGE: 'delete-own-message', + FLAG_MESSAGE: 'flag-message', + FREEZE_CHANNEL: 'freeze-channel', + JOIN_CALL: 'join-call', + JOIN_CHANNEL: 'join-channel', + LEAVE_CHANNEL: 'leave-channel', + MUTE_CHANNEL: 'mute-channel', + PIN_MESSAGE: 'pin-message', + QUERY_POLL_VOTES: 'query-poll-votes', + QUOTE_MESSAGE: 'quote-message', + READ_EVENTS: 'read-events', + SEARCH_MESSAGES: 'search-messages', + SEND_CUSTOM_EVENTS: 'send-custom-events', + SEND_LINKS: 'send-links', + SEND_MESSAGE: 'send-message', + SEND_POLL: 'send-poll', + SEND_REACTION: 'send-reaction', + SEND_REPLY: 'send-reply', + SEND_TYPING_EVENTS: 'send-typing-events', + SET_CHANNEL_COOLDOWN: 'set-channel-cooldown', + SKIP_SLOW_MODE: 'skip-slow-mode', + SLOW_MODE: 'slow-mode', + TYPING_EVENTS: 'typing-events', + UPDATE_ANY_MESSAGE: 'update-any-message', + UPDATE_CHANNEL: 'update-channel', + UPDATE_CHANNEL_MEMBERS: 'update-channel-members', + UPDATE_OWN_MESSAGE: 'update-own-message', + UPDATE_THREAD: 'update-thread', + UPLOAD_FILE: 'upload-file', +} as const; +export type ChannelOwnCapability = + (typeof ChannelOwnCapability)[keyof typeof ChannelOwnCapability]; + /** * Represents channel in chat * @export @@ -2607,6 +2707,12 @@ export interface ChannelResponse { * @memberof ChannelResponse */ auto_translation_language?: string; + /** + * Whether this channel is blocked by current user or not + * @type {boolean} + * @memberof ChannelResponse + */ + blocked?: boolean; /** * Channel CID (:) * @type {string} @@ -2633,12 +2739,12 @@ export interface ChannelResponse { created_at: string; /** * - * @type {UserObject} + * @type {UserResponse} * @memberof ChannelResponse */ - created_by?: UserObject; + created_by?: UserResponse; /** - * + * Custom data for this object * @type {{ [key: string]: any; }} * @memberof ChannelResponse */ @@ -2711,10 +2817,10 @@ export interface ChannelResponse { muted?: boolean; /** * List of channel capabilities of authenticated user - * @type {Array} + * @type {Array} * @memberof ChannelResponse */ - own_capabilities?: Array; + own_capabilities?: Array; /** * Team the channel belongs to (multi-tenant only) * @type {string} @@ -2729,10 +2835,10 @@ export interface ChannelResponse { truncated_at?: string; /** * - * @type {UserObject} + * @type {UserResponse} * @memberof ChannelResponse */ - truncated_by?: UserObject; + truncated_by?: UserResponse; /** * Type of the channel * @type {string} @@ -2821,7 +2927,7 @@ export interface CollectUserFeedbackRequest { user_session_id: string; } /** - * + * Basic response information * @export * @interface CollectUserFeedbackResponse */ @@ -2920,10 +3026,10 @@ export interface ConnectUserDetailsRequest { name?: string; /** * - * @type {PrivacySettings} + * @type {PrivacySettingsResponse} * @memberof ConnectUserDetailsRequest */ - privacy_settings?: PrivacySettings; + privacy_settings?: PrivacySettingsResponse; /** * * @type {PushNotificationSettingsInput} @@ -3013,7 +3119,7 @@ export interface Coordinates { longitude: number; } /** - * + * Create device request * @export * @interface CreateDeviceRequest */ @@ -3157,7 +3263,45 @@ export interface CustomVideoEvent { user: UserResponse; } /** - * + * DeleteCallRequest is the payload for deleting a call. + * @export + * @interface DeleteCallRequest + */ +export interface DeleteCallRequest { + /** + * if true the call will be hard deleted along with all related data + * @type {boolean} + * @memberof DeleteCallRequest + */ + hard?: boolean; +} +/** + * DeleteCallResponse is the payload for deleting a call. + * @export + * @interface DeleteCallResponse + */ +export interface DeleteCallResponse { + /** + * + * @type {CallResponse} + * @memberof DeleteCallResponse + */ + call: CallResponse; + /** + * + * @type {string} + * @memberof DeleteCallResponse + */ + duration: string; + /** + * + * @type {string} + * @memberof DeleteCallResponse + */ + task_id?: string; +} +/** + * Response for DeleteRecording * @export * @interface DeleteRecordingResponse */ @@ -3185,55 +3329,55 @@ export interface DeleteTranscriptionResponse { /** * Response for Device * @export - * @interface Device + * @interface DeviceResponse */ -export interface Device { +export interface DeviceResponse { /** * Date/time of creation * @type {string} - * @memberof Device + * @memberof DeviceResponse */ created_at: string; /** * Whether device is disabled or not * @type {boolean} - * @memberof Device + * @memberof DeviceResponse */ disabled?: boolean; /** * Reason explaining why device had been disabled * @type {string} - * @memberof Device + * @memberof DeviceResponse */ disabled_reason?: string; /** * Device ID * @type {string} - * @memberof Device + * @memberof DeviceResponse */ id: string; /** * Push provider * @type {string} - * @memberof Device + * @memberof DeviceResponse */ push_provider: string; /** * Push provider name * @type {string} - * @memberof Device + * @memberof DeviceResponse */ push_provider_name?: string; /** * User ID * @type {string} - * @memberof Device + * @memberof DeviceResponse */ user_id: string; /** * When true the token is for Apple VoIP push notifications * @type {boolean} - * @memberof Device + * @memberof DeviceResponse */ voip?: boolean; } @@ -3334,13 +3478,19 @@ export interface EgressRTMPResponse { * @type {string} * @memberof EgressRTMPResponse */ - stream_key: string; + started_at: string; /** * * @type {string} * @memberof EgressRTMPResponse */ - url: string; + stream_key?: string; + /** + * + * @type {string} + * @memberof EgressRTMPResponse + */ + stream_url?: string; } /** * @@ -3511,7 +3661,7 @@ export interface GetCallResponse { own_capabilities: Array; } /** - * + * Basic response information * @export * @interface GetCallStatsResponse */ @@ -3542,16 +3692,16 @@ export interface GetCallStatsResponse { duration: string; /** * - * @type {Stats} + * @type {TimeStats} * @memberof GetCallStatsResponse */ - jitter?: Stats; + jitter?: TimeStats; /** * - * @type {Stats} + * @type {TimeStats} * @memberof GetCallStatsResponse */ - latency?: Stats; + latency?: TimeStats; /** * * @type {number} @@ -3724,6 +3874,12 @@ export interface GoLiveRequest { * @memberof GoLiveRequest */ start_recording?: boolean; + /** + * + * @type {boolean} + * @memberof GoLiveRequest + */ + start_rtmp_broadcasts?: boolean; /** * * @type {boolean} @@ -3817,7 +3973,7 @@ export interface HealthCheckEvent { * @type {string} * @memberof HealthCheckEvent */ - cid: string; + cid?: string; /** * * @type {string} @@ -3835,7 +3991,13 @@ export interface HealthCheckEvent { * @type {OwnUserResponse} * @memberof HealthCheckEvent */ - me?: OwnUser; + me?: OwnUserResponse; + /** + * + * @type {string} + * @memberof HealthCheckEvent + */ + received_at?: string; /** * * @type {string} @@ -3985,13 +4147,13 @@ export interface JoinCallResponse { */ export interface LabelThresholds { /** - * Threshold for automatic message block + * * @type {number} * @memberof LabelThresholds */ block?: number; /** - * Threshold for automatic message flag + * * @type {number} * @memberof LabelThresholds */ @@ -4043,10 +4205,10 @@ export interface LimitsSettingsResponse { export interface ListDevicesResponse { /** * List of devices - * @type {Array} + * @type {Array} * @memberof ListDevicesResponse */ - devices: Array; + devices: Array; /** * * @type {string} @@ -4117,37 +4279,6 @@ export interface Location { */ subdivision_iso_code: string; } -/** - * - * @export - * @interface MOSStats - */ -export interface MOSStats { - /** - * - * @type {number} - * @memberof MOSStats - */ - average_score: number; - /** - * - * @type {Array} - * @memberof MOSStats - */ - histogram_duration_seconds: Array; - /** - * - * @type {number} - * @memberof MOSStats - */ - max_score: number; - /** - * - * @type {number} - * @memberof MOSStats - */ - min_score: number; -} /** * * @export @@ -4412,352 +4543,207 @@ export type OwnCapability = (typeof OwnCapability)[keyof typeof OwnCapability]; /** * * @export - * @interface OwnUser + * @interface OwnUserResponse */ -export interface OwnUser { +export interface OwnUserResponse { /** * * @type {boolean} - * @memberof OwnUser + * @memberof OwnUserResponse */ banned: boolean; /** * * @type {Array} - * @memberof OwnUser + * @memberof OwnUserResponse */ blocked_user_ids?: Array; /** * * @type {Array} - * @memberof OwnUser + * @memberof OwnUserResponse */ channel_mutes: Array; /** * * @type {string} - * @memberof OwnUser + * @memberof OwnUserResponse */ created_at: string; /** * * @type {{ [key: string]: any; }} - * @memberof OwnUser + * @memberof OwnUserResponse */ custom: { [key: string]: any }; /** * * @type {string} - * @memberof OwnUser + * @memberof OwnUserResponse */ deactivated_at?: string; /** * * @type {string} - * @memberof OwnUser + * @memberof OwnUserResponse */ deleted_at?: string; /** * - * @type {Array} - * @memberof OwnUser + * @type {Array} + * @memberof OwnUserResponse */ - devices: Array; + devices: Array; /** * * @type {string} - * @memberof OwnUser + * @memberof OwnUserResponse */ id: string; + /** + * + * @type {string} + * @memberof OwnUserResponse + */ + image?: string; /** * * @type {boolean} - * @memberof OwnUser + * @memberof OwnUserResponse */ - invisible?: boolean; + invisible: boolean; /** * * @type {string} - * @memberof OwnUser + * @memberof OwnUserResponse */ language: string; /** * * @type {string} - * @memberof OwnUser + * @memberof OwnUserResponse */ last_active?: string; /** * * @type {Array} - * @memberof OwnUser + * @memberof OwnUserResponse */ latest_hidden_channels?: Array; /** * - * @type {Array} - * @memberof OwnUser + * @type {Array} + * @memberof OwnUserResponse + */ + mutes: Array; + /** + * + * @type {string} + * @memberof OwnUserResponse */ - mutes: Array; + name?: string; /** * * @type {boolean} - * @memberof OwnUser + * @memberof OwnUserResponse */ online: boolean; /** * - * @type {PrivacySettings} - * @memberof OwnUser + * @type {PrivacySettingsResponse} + * @memberof OwnUserResponse */ - privacy_settings?: PrivacySettings; + privacy_settings?: PrivacySettingsResponse; /** * - * @type {PushNotificationSettings} - * @memberof OwnUser + * @type {PushNotificationSettingsResponse} + * @memberof OwnUserResponse */ - push_notifications?: PushNotificationSettings; + push_notifications?: PushNotificationSettingsResponse; + /** + * + * @type {string} + * @memberof OwnUserResponse + */ + revoke_tokens_issued_before?: string; /** * * @type {string} - * @memberof OwnUser + * @memberof OwnUserResponse */ role: string; /** * * @type {Array} - * @memberof OwnUser + * @memberof OwnUserResponse */ - teams?: Array; + teams: Array; /** * * @type {number} - * @memberof OwnUser + * @memberof OwnUserResponse */ total_unread_count: number; /** * * @type {number} - * @memberof OwnUser + * @memberof OwnUserResponse */ unread_channels: number; /** * * @type {number} - * @memberof OwnUser + * @memberof OwnUserResponse */ unread_count: number; /** * * @type {number} - * @memberof OwnUser + * @memberof OwnUserResponse */ unread_threads: number; /** * * @type {string} - * @memberof OwnUser + * @memberof OwnUserResponse */ updated_at: string; } /** - * + * This event is sent when a user requests access to a feature on a call, + * clients receiving this event should display a permission request to the user * @export - * @interface OwnUserResponse + * @interface PermissionRequestEvent */ -export interface OwnUserResponse { +export interface PermissionRequestEvent { /** * - * @type {boolean} - * @memberof OwnUserResponse + * @type {string} + * @memberof PermissionRequestEvent */ - banned: boolean; + call_cid: string; /** * - * @type {Array} - * @memberof OwnUserResponse + * @type {string} + * @memberof PermissionRequestEvent */ - blocked_user_ids?: Array; + created_at: string; /** - * - * @type {Array} - * @memberof OwnUserResponse + * The list of permissions requested by the user + * @type {Array} + * @memberof PermissionRequestEvent */ - channel_mutes: Array; + permissions: Array; /** - * + * The type of event: "call.permission_request" in this case * @type {string} - * @memberof OwnUserResponse + * @memberof PermissionRequestEvent */ - created_at: string; + type: string; /** * - * @type {{ [key: string]: any; }} - * @memberof OwnUserResponse - */ - custom: { [key: string]: any }; - /** - * - * @type {string} - * @memberof OwnUserResponse - */ - deactivated_at?: string; - /** - * - * @type {string} - * @memberof OwnUserResponse - */ - deleted_at?: string; - /** - * - * @type {Array} - * @memberof OwnUserResponse - */ - devices: Array; - /** - * - * @type {string} - * @memberof OwnUserResponse - */ - id: string; - /** - * - * @type {string} - * @memberof OwnUserResponse - */ - image?: string; - /** - * - * @type {boolean} - * @memberof OwnUserResponse - */ - invisible: boolean; - /** - * - * @type {string} - * @memberof OwnUserResponse - */ - language: string; - /** - * - * @type {string} - * @memberof OwnUserResponse - */ - last_active?: string; - /** - * - * @type {Array} - * @memberof OwnUserResponse - */ - latest_hidden_channels?: Array; - /** - * - * @type {Array} - * @memberof OwnUserResponse - */ - mutes: Array; - /** - * - * @type {string} - * @memberof OwnUserResponse - */ - name?: string; - /** - * - * @type {boolean} - * @memberof OwnUserResponse - */ - online: boolean; - /** - * - * @type {PrivacySettingsResponse} - * @memberof OwnUserResponse - */ - privacy_settings?: PrivacySettingsResponse; - /** - * - * @type {PushNotificationSettingsResponse} - * @memberof OwnUserResponse - */ - push_notifications?: PushNotificationSettingsResponse; - /** - * - * @type {string} - * @memberof OwnUserResponse - */ - revoke_tokens_issued_before?: string; - /** - * - * @type {string} - * @memberof OwnUserResponse - */ - role: string; - /** - * - * @type {Array} - * @memberof OwnUserResponse - */ - teams: Array; - /** - * - * @type {number} - * @memberof OwnUserResponse - */ - total_unread_count: number; - /** - * - * @type {number} - * @memberof OwnUserResponse - */ - unread_channels: number; - /** - * - * @type {number} - * @memberof OwnUserResponse - */ - unread_threads: number; - /** - * - * @type {string} - * @memberof OwnUserResponse - */ - updated_at: string; -} -/** - * This event is sent when a user requests access to a feature on a call, - * clients receiving this event should display a permission request to the user - * @export - * @interface PermissionRequestEvent - */ -export interface PermissionRequestEvent { - /** - * - * @type {string} - * @memberof PermissionRequestEvent - */ - call_cid: string; - /** - * - * @type {string} - * @memberof PermissionRequestEvent - */ - created_at: string; - /** - * The list of permissions requested by the user - * @type {Array} - * @memberof PermissionRequestEvent - */ - permissions: Array; - /** - * The type of event: "call.permission_request" in this case - * @type {string} - * @memberof PermissionRequestEvent - */ - type: string; - /** - * - * @type {UserResponse} - * @memberof PermissionRequestEvent + * @type {UserResponse} + * @memberof PermissionRequestEvent */ user: UserResponse; } @@ -4820,16 +4806,16 @@ export interface PrivacySettings { export interface PrivacySettingsResponse { /** * - * @type {ReadReceipts} + * @type {ReadReceiptsResponse} * @memberof PrivacySettingsResponse */ - read_receipts?: ReadReceipts; + read_receipts?: ReadReceiptsResponse; /** * - * @type {TypingIndicators} + * @type {TypingIndicatorsResponse} * @memberof PrivacySettingsResponse */ - typing_indicators?: TypingIndicators; + typing_indicators?: TypingIndicatorsResponse; } /** * @@ -5190,6 +5176,19 @@ export interface ReadReceipts { * @type {boolean} * @memberof ReadReceipts */ + enabled: boolean; +} +/** + * + * @export + * @interface ReadReceiptsResponse + */ +export interface ReadReceiptsResponse { + /** + * + * @type {boolean} + * @memberof ReadReceiptsResponse + */ enabled?: boolean; } /** @@ -5666,25 +5665,6 @@ export interface StartTranscriptionResponse { */ duration: string; } -/** - * - * @export - * @interface Stats - */ -export interface Stats { - /** - * - * @type {number} - * @memberof Stats - */ - average_seconds: number; - /** - * - * @type {number} - * @memberof Stats - */ - max_seconds: number; -} /** * * @export @@ -5699,7 +5679,7 @@ export interface StatsOptions { reporting_interval_ms: number; } /** - * + * Basic response information * @export * @interface StopClosedCaptionsResponse */ @@ -5744,7 +5724,7 @@ export interface StopLiveResponse { duration: string; } /** - * + * Basic response information * @export * @interface StopRecordingResponse */ @@ -5889,6 +5869,25 @@ export interface ThumbnailsSettingsResponse { */ enabled: boolean; } +/** + * + * @export + * @interface TimeStats + */ +export interface TimeStats { + /** + * + * @type {number} + * @memberof TimeStats + */ + average_seconds: number; + /** + * + * @type {number} + * @memberof TimeStats + */ + max_seconds: number; +} /** * * @export @@ -5996,6 +5995,19 @@ export interface TypingIndicators { * @type {boolean} * @memberof TypingIndicators */ + enabled: boolean; +} +/** + * + * @export + * @interface TypingIndicatorsResponse + */ +export interface TypingIndicatorsResponse { + /** + * + * @type {boolean} + * @memberof TypingIndicatorsResponse + */ enabled?: boolean; } /** @@ -6266,67 +6278,182 @@ export interface UpdatedCallPermissionsEvent { /** * * @export - * @interface UserBannedEvent + * @interface User */ -export interface UserBannedEvent { +export interface UserObject { /** * * @type {string} - * @memberof UserBannedEvent + * @memberof User */ - channel_id: string; + ban_expires?: string; /** * - * @type {string} - * @memberof UserBannedEvent + * @type {boolean} + * @memberof User */ - channel_type: string; + banned: boolean; /** * * @type {string} - * @memberof UserBannedEvent + * @memberof User */ - cid: string; + readonly created_at?: string; /** * - * @type {string} - * @memberof UserBannedEvent + * @type {{ [key: string]: any; }} + * @memberof User */ - created_at: string; + custom: { [key: string]: any }; /** * - * @type {UserObject} - * @memberof UserBannedEvent + * @type {string} + * @memberof User */ - created_by: UserObject; + readonly deactivated_at?: string; /** * * @type {string} - * @memberof UserBannedEvent + * @memberof User */ - expiration?: string; + readonly deleted_at?: string; /** * * @type {string} - * @memberof UserBannedEvent + * @memberof User */ - reason?: string; + id: string; /** * * @type {boolean} - * @memberof UserBannedEvent + * @memberof User */ - shadow: boolean; + invisible?: boolean; /** * * @type {string} - * @memberof UserBannedEvent + * @memberof User */ - team?: string; + language?: string; /** * * @type {string} - * @memberof UserBannedEvent + * @memberof User + */ + readonly last_active?: string; + /** + * + * @type {string} + * @memberof User + */ + readonly last_engaged_at?: string; + /** + * + * @type {boolean} + * @memberof User + */ + readonly online: boolean; + /** + * + * @type {PrivacySettings} + * @memberof User + */ + privacy_settings?: PrivacySettings; + /** + * + * @type {PushNotificationSettings} + * @memberof User + */ + push_notifications?: PushNotificationSettings; + /** + * + * @type {string} + * @memberof User + */ + revoke_tokens_issued_before?: string; + /** + * + * @type {string} + * @memberof User + */ + role: string; + /** + * + * @type {Array} + * @memberof User + */ + teams?: Array; + /** + * + * @type {string} + * @memberof User + */ + readonly updated_at?: string; +} +/** + * + * @export + * @interface UserBannedEvent + */ +export interface UserBannedEvent { + /** + * + * @type {string} + * @memberof UserBannedEvent + */ + channel_id: string; + /** + * + * @type {string} + * @memberof UserBannedEvent + */ + channel_type: string; + /** + * + * @type {string} + * @memberof UserBannedEvent + */ + cid: string; + /** + * + * @type {string} + * @memberof UserBannedEvent + */ + created_at: string; + /** + * + * @type {UserObject} + * @memberof UserBannedEvent + */ + created_by: UserObject; + /** + * + * @type {string} + * @memberof UserBannedEvent + */ + expiration?: string; + /** + * + * @type {string} + * @memberof UserBannedEvent + */ + reason?: string; + /** + * + * @type {boolean} + * @memberof UserBannedEvent + */ + shadow: boolean; + /** + * + * @type {string} + * @memberof UserBannedEvent + */ + team?: string; + /** + * + * @type {string} + * @memberof UserBannedEvent */ type: string; /** @@ -6413,259 +6540,265 @@ export interface UserDeletedEvent { /** * * @export - * @interface UserInfoResponse + * @interface UserEventPayload */ -export interface UserInfoResponse { +export interface UserEventPayload { + /** + * + * @type {boolean} + * @memberof UserEventPayload + */ + banned: boolean; + /** + * + * @type {Array} + * @memberof UserEventPayload + */ + blocked_user_ids: Array; + /** + * + * @type {string} + * @memberof UserEventPayload + */ + created_at: string; /** * * @type {{ [key: string]: any; }} - * @memberof UserInfoResponse + * @memberof UserEventPayload */ custom: { [key: string]: any }; /** * * @type {string} - * @memberof UserInfoResponse + * @memberof UserEventPayload */ - id: string; + deactivated_at?: string; /** * * @type {string} - * @memberof UserInfoResponse + * @memberof UserEventPayload */ - image: string; + deleted_at?: string; /** * * @type {string} - * @memberof UserInfoResponse + * @memberof UserEventPayload */ - name: string; + id: string; /** * - * @type {Array} - * @memberof UserInfoResponse + * @type {string} + * @memberof UserEventPayload */ - roles: Array; -} -/** - * - * @export - * @interface UserMute - */ -export interface UserMute { + image?: string; /** - * Date/time of creation - * @type {string} - * @memberof UserMute + * + * @type {boolean} + * @memberof UserEventPayload */ - created_at: string; + invisible?: boolean; /** - * Date/time of mute expiration + * * @type {string} - * @memberof UserMute + * @memberof UserEventPayload */ - expires?: string; + language: string; /** * - * @type {UserObject} - * @memberof UserMute + * @type {string} + * @memberof UserEventPayload */ - target?: UserObject; + last_active?: string; /** - * Date/time of the last update + * * @type {string} - * @memberof UserMute + * @memberof UserEventPayload */ - updated_at: string; + name?: string; /** * - * @type {UserObject} - * @memberof UserMute + * @type {boolean} + * @memberof UserEventPayload */ - user?: UserObject; -} -/** - * - * @export - * @interface UserMuteResponse - */ -export interface UserMuteResponse { + online: boolean; /** * - * @type {string} - * @memberof UserMuteResponse + * @type {PrivacySettingsResponse} + * @memberof UserEventPayload */ - created_at: string; + privacy_settings?: PrivacySettingsResponse; /** * * @type {string} - * @memberof UserMuteResponse + * @memberof UserEventPayload */ - expires?: string; + revoke_tokens_issued_before?: string; /** * - * @type {UserResponse} - * @memberof UserMuteResponse + * @type {string} + * @memberof UserEventPayload */ - target?: UserResponse; + role: string; /** * - * @type {string} - * @memberof UserMuteResponse + * @type {Array} + * @memberof UserEventPayload */ - updated_at: string; + teams: Array; /** * - * @type {UserResponse} - * @memberof UserMuteResponse + * @type {string} + * @memberof UserEventPayload */ - user?: UserResponse; + updated_at: string; } /** * * @export - * @interface UserMutedEvent + * @interface UserFlaggedEvent */ -export interface UserMutedEvent { +export interface UserFlaggedEvent { /** * * @type {string} - * @memberof UserMutedEvent + * @memberof UserFlaggedEvent */ created_at: string; /** * * @type {string} - * @memberof UserMutedEvent + * @memberof UserFlaggedEvent */ target_user?: string; /** * * @type {Array} - * @memberof UserMutedEvent + * @memberof UserFlaggedEvent */ target_users?: Array; /** * * @type {string} - * @memberof UserMutedEvent + * @memberof UserFlaggedEvent */ type: string; /** * * @type {UserObject} - * @memberof UserMutedEvent + * @memberof UserFlaggedEvent */ user?: UserObject; } /** - * Represents chat user + * * @export - * @interface UserObject + * @interface UserInfoResponse */ -export interface UserObject { - /** - * Expiration date of the ban - * @type {string} - * @memberof UserObject - */ - ban_expires?: string; - /** - * Whether a user is banned or not - * @type {boolean} - * @memberof UserObject - */ - banned: boolean; - /** - * Date/time of creation - * @type {string} - * @memberof UserObject - */ - readonly created_at?: string; +export interface UserInfoResponse { /** * * @type {{ [key: string]: any; }} - * @memberof UserObject + * @memberof UserInfoResponse */ custom: { [key: string]: any }; /** - * Date of deactivation + * * @type {string} - * @memberof UserObject + * @memberof UserInfoResponse */ - readonly deactivated_at?: string; + id: string; /** - * Date/time of deletion + * * @type {string} - * @memberof UserObject + * @memberof UserInfoResponse */ - readonly deleted_at?: string; + image: string; /** - * Unique user identifier + * * @type {string} - * @memberof UserObject + * @memberof UserInfoResponse */ - id: string; + name: string; /** * - * @type {boolean} - * @memberof UserObject + * @type {Array} + * @memberof UserInfoResponse */ - invisible?: boolean; + roles: Array; +} +/** + * + * @export + * @interface UserMuteResponse + */ +export interface UserMuteResponse { /** - * Preferred language of a user + * * @type {string} - * @memberof UserObject + * @memberof UserMuteResponse */ - language?: string; + created_at: string; /** - * Date of last activity + * * @type {string} - * @memberof UserObject + * @memberof UserMuteResponse */ - readonly last_active?: string; + expires?: string; /** - * Whether a user online or not - * @type {boolean} - * @memberof UserObject + * + * @type {UserResponse} + * @memberof UserMuteResponse */ - readonly online: boolean; + target?: UserResponse; /** * - * @type {PrivacySettings} - * @memberof UserObject + * @type {string} + * @memberof UserMuteResponse */ - privacy_settings?: PrivacySettings; + updated_at: string; /** * - * @type {PushNotificationSettings} - * @memberof UserObject + * @type {UserResponse} + * @memberof UserMuteResponse */ - push_notifications?: PushNotificationSettings; + user?: UserResponse; +} +/** + * + * @export + * @interface UserMutedEvent + */ +export interface UserMutedEvent { /** - * Revocation date for tokens + * * @type {string} - * @memberof UserObject + * @memberof UserMutedEvent */ - revoke_tokens_issued_before?: string; + created_at: string; /** - * Determines the set of user permissions + * * @type {string} - * @memberof UserObject + * @memberof UserMutedEvent */ - role: string; + target_user?: string; /** - * List of teams user is a part of + * * @type {Array} - * @memberof UserObject + * @memberof UserMutedEvent */ - teams?: Array; + target_users?: Array; /** - * Date/time of the last update + * * @type {string} - * @memberof UserObject + * @memberof UserMutedEvent */ - readonly updated_at?: string; + type: string; + /** + * + * @type {UserObject} + * @memberof UserMutedEvent + */ + user?: UserObject; } /** * @@ -6761,10 +6894,10 @@ export interface UserRequest { name?: string; /** * - * @type {PrivacySettings} + * @type {PrivacySettingsResponse} * @memberof UserRequest */ - privacy_settings?: PrivacySettings; + privacy_settings?: PrivacySettingsResponse; /** * * @type {PushNotificationSettingsInput} @@ -6937,16 +7070,22 @@ export interface UserSessionStats { geolocation?: GeolocationResult; /** * - * @type {Stats} + * @type {string} + * @memberof UserSessionStats + */ + group: string; + /** + * + * @type {TimeStats} * @memberof UserSessionStats */ - jitter?: Stats; + jitter?: TimeStats; /** * - * @type {Stats} + * @type {TimeStats} * @memberof UserSessionStats */ - latency?: Stats; + latency?: TimeStats; /** * * @type {number} @@ -6995,6 +7134,12 @@ export interface UserSessionStats { * @memberof UserSessionStats */ max_receiving_video_quality?: VideoQuality; + /** + * + * @type {number} + * @memberof UserSessionStats + */ + min_event_ts: number; /** * * @type {string} @@ -7027,22 +7172,16 @@ export interface UserSessionStats { published_tracks?: Array; /** * - * @type {MOSStats} - * @memberof UserSessionStats - */ - publisher_audio_mos?: MOSStats; - /** - * - * @type {Stats} + * @type {TimeStats} * @memberof UserSessionStats */ - publisher_jitter?: Stats; + publisher_jitter?: TimeStats; /** * - * @type {Stats} + * @type {TimeStats} * @memberof UserSessionStats */ - publisher_latency?: Stats; + publisher_latency?: TimeStats; /** * * @type {number} @@ -7131,22 +7270,16 @@ export interface UserSessionStats { session_id: string; /** * - * @type {MOSStats} - * @memberof UserSessionStats - */ - subscriber_audio_mos?: MOSStats; - /** - * - * @type {Stats} + * @type {TimeStats} * @memberof UserSessionStats */ - subscriber_jitter?: Stats; + subscriber_jitter?: TimeStats; /** * - * @type {Stats} + * @type {TimeStats} * @memberof UserSessionStats */ - subscriber_latency?: Stats; + subscriber_latency?: TimeStats; /** * * @type {number} @@ -7279,72 +7412,109 @@ export interface UserUnbannedEvent { /** * * @export - * @interface UserUpdatedEvent + * @interface UserUnmutedEvent */ -export interface UserUpdatedEvent { +export interface UserUnmutedEvent { /** * * @type {string} - * @memberof UserUpdatedEvent + * @memberof UserUnmutedEvent */ created_at: string; /** * * @type {string} - * @memberof UserUpdatedEvent + * @memberof UserUnmutedEvent */ - received_at?: string; + target_user?: string; + /** + * + * @type {Array} + * @memberof UserUnmutedEvent + */ + target_users?: Array; /** * * @type {string} - * @memberof UserUpdatedEvent + * @memberof UserUnmutedEvent */ type: string; /** * * @type {UserObject} - * @memberof UserUpdatedEvent + * @memberof UserUnmutedEvent */ user?: UserObject; } /** * * @export - * @interface VideoQuality + * @interface UserUpdatedEvent */ -export interface VideoQuality { +export interface UserUpdatedEvent { /** * - * @type {VideoResolution} - * @memberof VideoQuality + * @type {string} + * @memberof UserUpdatedEvent */ - resolution?: VideoResolution; + created_at: string; /** * * @type {string} - * @memberof VideoQuality + * @memberof UserUpdatedEvent */ - usage_type?: string; + received_at?: string; + /** + * + * @type {string} + * @memberof UserUpdatedEvent + */ + type: string; + /** + * + * @type {UserEventPayload} + * @memberof UserUpdatedEvent + */ + user: UserEventPayload; } /** * * @export - * @interface VideoResolution + * @interface VideoDimension */ -export interface VideoResolution { +export interface VideoDimension { /** * * @type {number} - * @memberof VideoResolution + * @memberof VideoDimension */ height: number; /** * * @type {number} - * @memberof VideoResolution + * @memberof VideoDimension */ width: number; } +/** + * + * @export + * @interface VideoQuality + */ +export interface VideoQuality { + /** + * + * @type {VideoDimension} + * @memberof VideoQuality + */ + resolution?: VideoDimension; + /** + * + * @type {string} + * @memberof VideoQuality + */ + usage_type?: string; +} /** * * @export