@stream-io/video-client 1.5.1 → 1.5.2

package/dist/src/gen/coordinator/index.d.ts

@@ -189,7 +189,7 @@ export interface BackstageSettingsRequest {
      */
     enabled?: boolean;
     /**
-     * Optional: the number of seconds before the call starts that the user can join the call
+     *
      * @type {number}
      * @memberof BackstageSettingsRequest
      */
@@ -207,6 +207,12 @@ export interface BackstageSettingsResponse {
      * @memberof BackstageSettingsResponse
      */
     enabled: boolean;
+    /**
+     *
+     * @type {number}
+     * @memberof BackstageSettingsResponse
+     */
+    join_ahead_time_seconds?: number;
 }
 /**
  *
@@ -256,7 +262,7 @@ export interface BlockUserRequest {
  */
 export interface BlockUserResponse {
     /**
-     * Duration of the request in human-readable format
+     * Duration of the request in milliseconds
      * @type {string}
      * @memberof BlockUserResponse
      */
@@ -860,6 +866,12 @@ export interface CallMissedEvent {
      * @memberof CallMissedEvent
      */
     members: Array<MemberResponse>;
+    /**
+     *
+     * @type {boolean}
+     * @memberof CallMissedEvent
+     */
+    notify_user: boolean;
     /**
      * Call session ID
      * @type {string}
@@ -1208,6 +1220,12 @@ export interface CallRequest {
      * @memberof CallRequest
      */
     team?: string;
+    /**
+     *
+     * @type {boolean}
+     * @memberof CallRequest
+     */
+    video?: boolean;
 }
 /**
  * Represents a call
@@ -1283,6 +1301,12 @@ export interface CallResponse {
      * @memberof CallResponse
      */
     ingress: CallIngressResponse;
+    /**
+     *
+     * @type {number}
+     * @memberof CallResponse
+     */
+    join_ahead_time_seconds?: number;
     /**
      *
      * @type {boolean}
@@ -1386,6 +1410,12 @@ export interface CallRingEvent {
      * @memberof CallRingEvent
      */
     user: UserResponse;
+    /**
+     *
+     * @type {boolean}
+     * @memberof CallRingEvent
+     */
+    video: boolean;
 }
 /**
  * This event is sent when a call session ends
@@ -1424,6 +1454,51 @@ export interface CallSessionEndedEvent {
      */
     type: string;
 }
+/**
+ * This event is sent when the participant counts in a call session are updated
+ * @export
+ * @interface CallSessionParticipantCountsUpdatedEvent
+ */
+export interface CallSessionParticipantCountsUpdatedEvent {
+    /**
+     *
+     * @type {number}
+     * @memberof CallSessionParticipantCountsUpdatedEvent
+     */
+    anonymous_participant_count: number;
+    /**
+     *
+     * @type {string}
+     * @memberof CallSessionParticipantCountsUpdatedEvent
+     */
+    call_cid: string;
+    /**
+     *
+     * @type {string}
+     * @memberof CallSessionParticipantCountsUpdatedEvent
+     */
+    created_at: string;
+    /**
+     *
+     * @type {{ [key: string]: number; }}
+     * @memberof CallSessionParticipantCountsUpdatedEvent
+     */
+    participants_count_by_role: {
+        [key: string]: number;
+    };
+    /**
+     * Call session ID
+     * @type {string}
+     * @memberof CallSessionParticipantCountsUpdatedEvent
+     */
+    session_id: string;
+    /**
+     * The type of event: "call.session_participant_count_updated" in this case
+     * @type {string}
+     * @memberof CallSessionParticipantCountsUpdatedEvent
+     */
+    type: string;
+}
 /**
  * This event is sent when a participant joins a call session
  * @export
@@ -1512,6 +1587,12 @@ export interface CallSessionResponse {
     accepted_by: {
         [key: string]: string;
     };
+    /**
+     *
+     * @type {number}
+     * @memberof CallSessionResponse
+     */
+    anonymous_participant_count: number;
     /**
      *
      * @type {string}
@@ -2173,6 +2254,18 @@ export interface ChannelConfigWithInfo {
      * @memberof ChannelConfigWithInfo
      */
     name: string;
+    /**
+     *
+     * @type {number}
+     * @memberof ChannelConfigWithInfo
+     */
+    partition_size?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof ChannelConfigWithInfo
+     */
+    partition_ttl?: number;
     /**
      *
      * @type {boolean}
@@ -2649,7 +2742,7 @@ export interface CollectUserFeedbackRequest {
  */
 export interface CollectUserFeedbackResponse {
     /**
-     * Duration of the request in human-readable format
+     * Duration of the request in milliseconds
      * @type {string}
      * @memberof CollectUserFeedbackResponse
      */
@@ -2843,25 +2936,25 @@ export interface Coordinates {
  */
 export interface CreateDeviceRequest {
     /**
-     *
+     * Device ID
      * @type {string}
      * @memberof CreateDeviceRequest
      */
     id: string;
     /**
-     *
+     * Push provider
      * @type {string}
      * @memberof CreateDeviceRequest
      */
     push_provider: CreateDeviceRequestPushProviderEnum;
     /**
-     *
+     * Push provider name
      * @type {string}
      * @memberof CreateDeviceRequest
      */
     push_provider_name?: string;
     /**
-     *
+     * When true the token is for Apple VoIP push notifications
      * @type {boolean}
      * @memberof CreateDeviceRequest
      */
@@ -2903,7 +2996,7 @@ export interface CreateGuestResponse {
      */
     access_token: string;
     /**
-     *
+     * Duration of the request in milliseconds
      * @type {string}
      * @memberof CreateGuestResponse
      */
@@ -3030,23 +3123,29 @@ export interface Device {
      */
     disabled_reason?: string;
     /**
-     *
+     * Device ID
      * @type {string}
      * @memberof Device
      */
     id: string;
     /**
-     *
+     * Push provider
      * @type {string}
      * @memberof Device
      */
     push_provider: string;
     /**
-     *
+     * Push provider name
      * @type {string}
      * @memberof Device
      */
     push_provider_name?: string;
+    /**
+     * User ID
+     * @type {string}
+     * @memberof Device
+     */
+    user_id: string;
     /**
      * When true the token is for Apple VoIP push notifications
      * @type {boolean}
@@ -3352,7 +3451,7 @@ export interface GetCallStatsResponse {
      */
     call_timeline?: CallTimeline;
     /**
-     * Duration of the request in human-readable format
+     * Duration of the request in milliseconds
      * @type {string}
      * @memberof GetCallStatsResponse
      */
@@ -3425,7 +3524,7 @@ export interface GetCallStatsResponse {
  */
 export interface GetEdgesResponse {
     /**
-     * Duration of the request in human-readable format
+     * Duration of the request in milliseconds
      * @type {string}
      * @memberof GetEdgesResponse
      */
@@ -3467,6 +3566,12 @@ export interface GetOrCreateCallRequest {
      * @memberof GetOrCreateCallRequest
      */
     ring?: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof GetOrCreateCallRequest
+     */
+    video?: boolean;
 }
 /**
  *
@@ -3561,7 +3666,7 @@ export interface GoLiveResponse {
      */
     call: CallResponse;
     /**
-     * Duration of the request in human-readable format
+     * Duration of the request in milliseconds
      * @type {string}
      * @memberof GoLiveResponse
      */
@@ -3727,6 +3832,12 @@ export interface JoinCallRequest {
      * @memberof JoinCallRequest
      */
     ring?: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof JoinCallRequest
+     */
+    video?: boolean;
 }
 /**
  *
@@ -4112,7 +4223,7 @@ export interface MuteUsersRequest {
  */
 export interface MuteUsersResponse {
     /**
-     * Duration of the request in human-readable format
+     * Duration of the request in milliseconds
      * @type {string}
      * @memberof MuteUsersResponse
      */
@@ -4223,6 +4334,12 @@ export interface OwnUser {
      * @memberof OwnUser
      */
     banned: boolean;
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof OwnUser
+     */
+    blocked_user_ids?: Array<string>;
     /**
      *
      * @type {Array<ChannelMute>}
@@ -4370,6 +4487,12 @@ export interface OwnUserResponse {
      * @memberof OwnUserResponse
      */
     banned: boolean;
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof OwnUserResponse
+     */
+    blocked_user_ids?: Array<string>;
     /**
      *
      * @type {Array<ChannelMute>}
@@ -4446,10 +4569,10 @@ export interface OwnUserResponse {
     latest_hidden_channels?: Array<string>;
     /**
      *
-     * @type {Array<UserMute>}
+     * @type {Array<UserMuteResponse>}
      * @memberof OwnUserResponse
      */
-    mutes: Array<UserMute>;
+    mutes: Array<UserMuteResponse>;
     /**
      *
      * @type {string}
@@ -4464,16 +4587,16 @@ export interface OwnUserResponse {
     online: boolean;
     /**
      *
-     * @type {PrivacySettings}
+     * @type {PrivacySettingsResponse}
      * @memberof OwnUserResponse
      */
-    privacy_settings?: PrivacySettings;
+    privacy_settings?: PrivacySettingsResponse;
     /**
      *
-     * @type {PushNotificationSettings}
+     * @type {PushNotificationSettingsResponse}
      * @memberof OwnUserResponse
      */
-    push_notifications?: PushNotificationSettings;
+    push_notifications?: PushNotificationSettingsResponse;
     /**
      *
      * @type {string}
@@ -4562,13 +4685,13 @@ export interface PermissionRequestEvent {
  */
 export interface PinRequest {
     /**
-     *
+     * the session ID of the user who pinned the message
      * @type {string}
      * @memberof PinRequest
      */
     session_id: string;
     /**
-     *
+     * the user ID of the user who pinned the message
      * @type {string}
      * @memberof PinRequest
      */
@@ -4581,7 +4704,7 @@ export interface PinRequest {
  */
 export interface PinResponse {
     /**
-     * Duration of the request in human-readable format
+     * Duration of the request in milliseconds
      * @type {string}
      * @memberof PinResponse
      */
@@ -4606,6 +4729,25 @@ export interface PrivacySettings {
      */
     typing_indicators?: TypingIndicators;
 }
+/**
+ *
+ * @export
+ * @interface PrivacySettingsResponse
+ */
+export interface PrivacySettingsResponse {
+    /**
+     *
+     * @type {ReadReceipts}
+     * @memberof PrivacySettingsResponse
+     */
+    read_receipts?: ReadReceipts;
+    /**
+     *
+     * @type {TypingIndicators}
+     * @memberof PrivacySettingsResponse
+     */
+    typing_indicators?: TypingIndicators;
+}
 /**
  *
  * @export
@@ -4669,6 +4811,25 @@ export interface PushNotificationSettingsInput {
      */
     disabled_until?: NullTime;
 }
+/**
+ *
+ * @export
+ * @interface PushNotificationSettingsResponse
+ */
+export interface PushNotificationSettingsResponse {
+    /**
+     *
+     * @type {boolean}
+     * @memberof PushNotificationSettingsResponse
+     */
+    disabled?: boolean;
+    /**
+     *
+     * @type {string}
+     * @memberof PushNotificationSettingsResponse
+     */
+    disabled_until?: string;
+}
 /**
  *
  * @export
@@ -4709,10 +4870,10 @@ export interface QueryCallMembersRequest {
     prev?: string;
     /**
      *
-     * @type {Array<SortParam>}
+     * @type {Array<SortParamRequest>}
      * @memberof QueryCallMembersRequest
      */
-    sort?: Array<SortParam>;
+    sort?: Array<SortParamRequest>;
     /**
      *
      * @type {string}
@@ -4727,7 +4888,7 @@ export interface QueryCallMembersRequest {
  */
 export interface QueryCallMembersResponse {
     /**
-     * Duration of the request in human-readable format
+     * Duration of the request in milliseconds
      * @type {string}
      * @memberof QueryCallMembersResponse
      */
@@ -4785,10 +4946,10 @@ export interface QueryCallStatsRequest {
     prev?: string;
     /**
      *
-     * @type {Array<SortParam>}
+     * @type {Array<SortParamRequest>}
      * @memberof QueryCallStatsRequest
      */
-    sort?: Array<SortParam>;
+    sort?: Array<SortParamRequest>;
 }
 /**
  *
@@ -4797,7 +4958,7 @@ export interface QueryCallStatsRequest {
  */
 export interface QueryCallStatsResponse {
     /**
-     * Duration of the request in human-readable format
+     * Duration of the request in milliseconds
      * @type {string}
      * @memberof QueryCallStatsResponse
      */
@@ -4855,10 +5016,10 @@ export interface QueryCallsRequest {
     prev?: string;
     /**
      *
-     * @type {Array<SortParam>}
+     * @type {Array<SortParamRequest>}
      * @memberof QueryCallsRequest
      */
-    sort?: Array<SortParam>;
+    sort?: Array<SortParamRequest>;
     /**
      *
      * @type {boolean}
@@ -4879,7 +5040,7 @@ export interface QueryCallsResponse {
      */
     calls: Array<CallStateResponseFields>;
     /**
-     *
+     * Duration of the request in milliseconds
      * @type {string}
      * @memberof QueryCallsResponse
      */
@@ -5090,7 +5251,7 @@ export interface RequestPermissionResponse {
  */
 export interface Response {
     /**
-     * Duration of the request in human-readable format
+     * Duration of the request in milliseconds
      * @type {string}
      * @memberof Response
      */
@@ -5314,7 +5475,7 @@ export interface SendReactionRequest {
  */
 export interface SendReactionResponse {
     /**
-     * Duration of the request in human-readable format
+     * Duration of the request in milliseconds
      * @type {string}
      * @memberof SendReactionResponse
      */
@@ -5329,19 +5490,19 @@ export interface SendReactionResponse {
 /**
  *
  * @export
- * @interface SortParam
+ * @interface SortParamRequest
  */
-export interface SortParam {
+export interface SortParamRequest {
     /**
-     * Direction of sorting, -1 for descending, 1 for ascending
+     * Direction of sorting, 1 for Ascending, -1 for Descending, default is 1
      * @type {number}
-     * @memberof SortParam
+     * @memberof SortParamRequest
      */
     direction?: number;
     /**
      * Name of field to sort by
      * @type {string}
-     * @memberof SortParam
+     * @memberof SortParamRequest
      */
     field?: string;
 }
@@ -5352,7 +5513,7 @@ export interface SortParam {
  */
 export interface StartHLSBroadcastingResponse {
     /**
-     * Duration of the request in human-readable format
+     * Duration of the request in milliseconds
      * @type {string}
      * @memberof StartHLSBroadcastingResponse
      */
@@ -5455,7 +5616,7 @@ export interface StatsOptions {
  */
 export interface StopHLSBroadcastingResponse {
     /**
-     * Duration of the request in human-readable format
+     * Duration of the request in milliseconds
      * @type {string}
      * @memberof StopHLSBroadcastingResponse
      */
@@ -5474,7 +5635,7 @@ export interface StopLiveResponse {
      */
     call: CallResponse;
     /**
-     * Duration of the request in human-readable format
+     * Duration of the request in milliseconds
      * @type {string}
      * @memberof StopLiveResponse
      */
@@ -5487,7 +5648,7 @@ export interface StopLiveResponse {
  */
 export interface StopRecordingResponse {
     /**
-     * Duration of the request in human-readable format
+     * Duration of the request in milliseconds
      * @type {string}
      * @memberof StopRecordingResponse
      */
@@ -5500,7 +5661,7 @@ export interface StopRecordingResponse {
  */
 export interface StopTranscriptionResponse {
     /**
-     * Duration of the request in human-readable format
+     * Duration of the request in milliseconds
      * @type {string}
      * @memberof StopTranscriptionResponse
      */
@@ -5727,7 +5888,7 @@ export interface UnblockUserRequest {
  */
 export interface UnblockUserResponse {
     /**
-     * Duration of the request in human-readable format
+     * Duration of the request in milliseconds
      * @type {string}
      * @memberof UnblockUserResponse
      */
@@ -5772,13 +5933,13 @@ export interface UnblockedUserEvent {
  */
 export interface UnpinRequest {
     /**
-     *
+     * the session ID of the user who pinned the message
      * @type {string}
      * @memberof UnpinRequest
      */
     session_id: string;
     /**
-     *
+     * the user ID of the user who pinned the message
      * @type {string}
      * @memberof UnpinRequest
      */
@@ -5791,7 +5952,7 @@ export interface UnpinRequest {
  */
 export interface UnpinResponse {
     /**
-     * Duration of the request in human-readable format
+     * Duration of the request in milliseconds
      * @type {string}
      * @memberof UnpinResponse
      */
@@ -5823,7 +5984,7 @@ export interface UpdateCallMembersRequest {
  */
 export interface UpdateCallMembersResponse {
     /**
-     * Duration of the request in human-readable format
+     * Duration of the request in milliseconds
      * @type {string}
      * @memberof UpdateCallMembersResponse
      */
@@ -5931,7 +6092,7 @@ export interface UpdateUserPermissionsRequest {
  */
 export interface UpdateUserPermissionsResponse {
     /**
-     * Duration of the request in human-readable format
+     * Duration of the request in milliseconds
      * @type {string}
      * @memberof UpdateUserPermissionsResponse
      */
@@ -6191,6 +6352,43 @@ export interface UserMute {
      */
     user?: UserObject;
 }
+/**
+ *
+ * @export
+ * @interface UserMuteResponse
+ */
+export interface UserMuteResponse {
+    /**
+     *
+     * @type {string}
+     * @memberof UserMuteResponse
+     */
+    created_at: string;
+    /**
+     *
+     * @type {string}
+     * @memberof UserMuteResponse
+     */
+    expires?: string;
+    /**
+     *
+     * @type {UserResponse}
+     * @memberof UserMuteResponse
+     */
+    target?: UserResponse;
+    /**
+     *
+     * @type {string}
+     * @memberof UserMuteResponse
+     */
+    updated_at: string;
+    /**
+     *
+     * @type {UserResponse}
+     * @memberof UserMuteResponse
+     */
+    user?: UserResponse;
+}
 /**
  *
  * @export
@@ -6453,11 +6651,17 @@ export interface UserRequest {
  */
 export interface UserResponse {
     /**
-     *
+     * Whether a user is banned or not
      * @type {boolean}
      * @memberof UserResponse
      */
     banned: boolean;
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof UserResponse
+     */
+    blocked_user_ids: Array<string>;
     /**
      * Date/time of creation
      * @type {string}
@@ -6465,7 +6669,7 @@ export interface UserResponse {
      */
     created_at: string;
     /**
-     *
+     * Custom data for this object
      * @type {{ [key: string]: any; }}
      * @memberof UserResponse
      */
@@ -6473,7 +6677,7 @@ export interface UserResponse {
         [key: string]: any;
     };
     /**
-     *
+     * Date of deactivation
      * @type {string}
      * @memberof UserResponse
      */
@@ -6485,7 +6689,7 @@ export interface UserResponse {
      */
     deleted_at?: string;
     /**
-     *
+     * Unique user identifier
      * @type {string}
      * @memberof UserResponse
      */
@@ -6497,43 +6701,43 @@ export interface UserResponse {
      */
     image?: string;
     /**
-     *
+     * Preferred language of a user
      * @type {string}
      * @memberof UserResponse
      */
     language: string;
     /**
-     *
+     * Date of last activity
      * @type {string}
      * @memberof UserResponse
      */
     last_active?: string;
     /**
-     *
+     * Optional name of user
      * @type {string}
      * @memberof UserResponse
      */
     name?: string;
     /**
-     *
+     * Whether a user online or not
      * @type {boolean}
      * @memberof UserResponse
      */
     online: boolean;
     /**
-     *
+     * Revocation date for tokens
      * @type {string}
      * @memberof UserResponse
      */
     revoke_tokens_issued_before?: string;
     /**
-     *
+     * Determines the set of user permissions
      * @type {string}
      * @memberof UserResponse
      */
     role: string;
     /**
-     *
+     * List of teams user is a part of
      * @type {Array<string>}
      * @memberof UserResponse
      */
@@ -6847,6 +7051,12 @@ export interface UserSessionStats {
      * @memberof UserSessionStats
      */
     total_pixels_out: number;
+    /**
+     *
+     * @type {boolean}
+     * @memberof UserSessionStats
+     */
+    truncated?: boolean;
     /**
      *
      * @type {string}
@@ -6952,6 +7162,12 @@ export interface UserUpdatedEvent {
      * @memberof UserUpdatedEvent
      */
     created_at: string;
+    /**
+     *
+     * @type {string}
+     * @memberof UserUpdatedEvent
+     */
+    received_at?: string;
     /**
      *
      * @type {string}
@@ -7178,6 +7394,8 @@ export type WSEvent = ({
 } & CallRingEvent) | ({
     type: 'call.session_ended';
 } & CallSessionEndedEvent) | ({
+    type: 'call.session_participant_count_updated';
+} & CallSessionParticipantCountsUpdatedEvent) | ({
     type: 'call.session_participant_joined';
 } & CallSessionParticipantJoinedEvent) | ({
     type: 'call.session_participant_left';