@stream-io/node-sdk 0.4.13 → 0.4.15

package/dist/src/BaseApi.d.ts

@@ -1,6 +1,6 @@
 import { ApiConfig, RequestMetadata } from './types';
 export declare class BaseApi {
-    private readonly apiConfig;
+    protected readonly apiConfig: ApiConfig;
     constructor(apiConfig: ApiConfig);
     protected sendRequest: <T>(method: string, url: string, pathParams?: Record<string, string>, queryParams?: Record<string, any>, body?: any) => Promise<{
         body: T;

package/dist/src/StreamVideoClient.d.ts

@@ -1,5 +1,18 @@
 import { VideoApi } from './gen/video/VideoApi';
 import { StreamCall } from './StreamCall';
+import type { StreamClient } from './StreamClient';
+import type { ApiConfig } from './types';
+import type { RealtimeClient } from '@stream-io/openai-realtime-api';
 export declare class StreamVideoClient extends VideoApi {
+    private readonly streamClient;
+    constructor({ streamClient, ...apiConfig }: ApiConfig & {
+        streamClient: StreamClient;
+    });
     call: (type: string, id: string) => StreamCall;
+    connectOpenAi: (options: {
+        call: StreamCall;
+        agentUserId: string;
+        openAiApiKey: string;
+        validityInSeconds: number;
+    }) => Promise<RealtimeClient>;
 }

package/dist/src/gen/chat/ChatApi.d.ts

@@ -1,6 +1,6 @@
 import { BaseApi } from '../../BaseApi';
 import { StreamResponse } from '../../types';
-import { CampaignResponse, CastPollVoteRequest, ChannelGetOrCreateRequest, ChannelStateResponse, CommitMessageRequest, CreateChannelTypeRequest, CreateChannelTypeResponse, CreateCommandRequest, CreateCommandResponse, CreatePollOptionRequest, CreatePollRequest, DeleteChannelResponse, DeleteChannelsRequest, DeleteChannelsResponse, DeleteCommandResponse, DeleteMessageResponse, DeleteReactionResponse, DeleteSegmentTargetsRequest, EventResponse, ExportChannelsRequest, ExportChannelsResponse, FileUploadRequest, FileUploadResponse, GetCampaignResponse, GetChannelTypeResponse, GetCommandResponse, GetExportChannelsStatusResponse, GetManyMessagesResponse, GetMessageResponse, GetReactionsResponse, GetRepliesResponse, GetSegmentResponse, GetThreadResponse, HideChannelRequest, HideChannelResponse, ImageUploadRequest, ImageUploadResponse, ListChannelTypesResponse, ListCommandsResponse, MarkChannelsReadRequest, MarkReadRequest, MarkReadResponse, MarkUnreadRequest, MembersResponse, MessageActionRequest, MessageResponse, MuteChannelRequest, MuteChannelResponse, PollOptionResponse, PollResponse, PollVoteResponse, PollVotesResponse, QueryBannedUsersPayload, QueryBannedUsersResponse, QueryCampaignsRequest, QueryCampaignsResponse, QueryChannelsRequest, QueryChannelsResponse, QueryMembersPayload, QueryMessageFlagsPayload, QueryMessageFlagsResponse, QueryMessageHistoryRequest, QueryMessageHistoryResponse, QueryPollVotesRequest, QueryPollsRequest, QueryPollsResponse, QueryReactionsRequest, QueryReactionsResponse, QuerySegmentTargetsRequest, QuerySegmentTargetsResponse, QuerySegmentsRequest, QuerySegmentsResponse, QueryThreadsRequest, QueryThreadsResponse, Response, SearchPayload, SearchResponse, SendEventRequest, SendMessageRequest, SendMessageResponse, SendReactionRequest, SendReactionResponse, SendUserCustomEventRequest, ShowChannelRequest, ShowChannelResponse, SortParamRequest, StartCampaignRequest, StartCampaignResponse, StopCampaignRequest, TranslateMessageRequest, TruncateChannelRequest, TruncateChannelResponse, UnmuteChannelRequest, UnmuteResponse, UnreadCountsBatchRequest, UnreadCountsBatchResponse, UpdateChannelPartialRequest, UpdateChannelPartialResponse, UpdateChannelRequest, UpdateChannelResponse, UpdateChannelTypeRequest, UpdateChannelTypeResponse, UpdateCommandRequest, UpdateCommandResponse, UpdateMemberPartialRequest, UpdateMemberPartialResponse, UpdateMessagePartialRequest, UpdateMessagePartialResponse, UpdateMessageRequest, UpdateMessageResponse, UpdatePollOptionRequest, UpdatePollPartialRequest, UpdatePollRequest, UpdateThreadPartialRequest, UpdateThreadPartialResponse, UpsertPushPreferencesRequest, UpsertPushPreferencesResponse, WrappedUnreadCountsResponse } from '../models';
+import { CampaignResponse, CastPollVoteRequest, ChannelGetOrCreateRequest, ChannelStateResponse, CommitMessageRequest, CreateChannelTypeRequest, CreateChannelTypeResponse, CreateCommandRequest, CreateCommandResponse, CreatePollOptionRequest, CreatePollRequest, DeleteChannelResponse, DeleteChannelsRequest, DeleteChannelsResponse, DeleteCommandResponse, DeleteMessageResponse, DeleteReactionResponse, DeleteSegmentTargetsRequest, EventResponse, ExportChannelsRequest, ExportChannelsResponse, FileUploadRequest, FileUploadResponse, GetCampaignResponse, GetChannelTypeResponse, GetCommandResponse, GetManyMessagesResponse, GetMessageResponse, GetReactionsResponse, GetRepliesResponse, GetSegmentResponse, GetThreadResponse, HideChannelRequest, HideChannelResponse, ImageUploadRequest, ImageUploadResponse, ListChannelTypesResponse, ListCommandsResponse, MarkChannelsReadRequest, MarkReadRequest, MarkReadResponse, MarkUnreadRequest, MembersResponse, MessageActionRequest, MessageResponse, MuteChannelRequest, MuteChannelResponse, PollOptionResponse, PollResponse, PollVoteResponse, PollVotesResponse, QueryBannedUsersPayload, QueryBannedUsersResponse, QueryCampaignsRequest, QueryCampaignsResponse, QueryChannelsRequest, QueryChannelsResponse, QueryMembersPayload, QueryMessageFlagsPayload, QueryMessageFlagsResponse, QueryMessageHistoryRequest, QueryMessageHistoryResponse, QueryPollVotesRequest, QueryPollsRequest, QueryPollsResponse, QueryReactionsRequest, QueryReactionsResponse, QuerySegmentTargetsRequest, QuerySegmentTargetsResponse, QuerySegmentsRequest, QuerySegmentsResponse, QueryThreadsRequest, QueryThreadsResponse, Response, SearchPayload, SearchResponse, SendEventRequest, SendMessageRequest, SendMessageResponse, SendReactionRequest, SendReactionResponse, SendUserCustomEventRequest, ShowChannelRequest, ShowChannelResponse, SortParamRequest, StartCampaignRequest, StartCampaignResponse, StopCampaignRequest, TranslateMessageRequest, TruncateChannelRequest, TruncateChannelResponse, UnmuteChannelRequest, UnmuteResponse, UnreadCountsBatchRequest, UnreadCountsBatchResponse, UpdateChannelPartialRequest, UpdateChannelPartialResponse, UpdateChannelRequest, UpdateChannelResponse, UpdateChannelTypeRequest, UpdateChannelTypeResponse, UpdateCommandRequest, UpdateCommandResponse, UpdateMemberPartialRequest, UpdateMemberPartialResponse, UpdateMessagePartialRequest, UpdateMessagePartialResponse, UpdateMessageRequest, UpdateMessageResponse, UpdatePollOptionRequest, UpdatePollPartialRequest, UpdatePollRequest, UpdateThreadPartialRequest, UpdateThreadPartialResponse, UpsertPushPreferencesRequest, UpsertPushPreferencesResponse, WrappedUnreadCountsResponse } from '../models';
 export declare class ChatApi extends BaseApi {
     queryCampaigns: (request?: QueryCampaignsRequest) => Promise<StreamResponse<QueryCampaignsResponse>>;
     getCampaign: (request: {
@@ -114,9 +114,6 @@ export declare class ChatApi extends BaseApi {
         name: string;
     }) => Promise<StreamResponse<UpdateCommandResponse>>;
     exportChannels: (request: ExportChannelsRequest) => Promise<StreamResponse<ExportChannelsResponse>>;
-    getExportChannelsStatus: (request: {
-        id: string;
-    }) => Promise<StreamResponse<GetExportChannelsStatusResponse>>;
     queryMembers: (request?: {
         payload?: QueryMembersPayload;
     }) => Promise<StreamResponse<MembersResponse>>;

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

@@ -142,6 +142,36 @@ export interface AppResponseFields {
     image_moderation_labels?: string[];
     datadog_info?: DataDogInfo;
 }
+export interface AsyncExportChannelsEvent {
+    created_at: Date;
+    finished_at: Date;
+    started_at: Date;
+    task_id: string;
+    url: string;
+    custom: Record<string, any>;
+    type: string;
+    received_at?: Date;
+}
+export interface AsyncExportErrorEvent {
+    created_at: Date;
+    error: string;
+    finished_at: Date;
+    started_at: Date;
+    task_id: string;
+    custom: Record<string, any>;
+    type: string;
+    received_at?: Date;
+}
+export interface AsyncExportUsersEvent {
+    created_at: Date;
+    finished_at: Date;
+    started_at: Date;
+    task_id: string;
+    url: string;
+    custom: Record<string, any>;
+    type: string;
+    received_at?: Date;
+}
 export interface AsyncModerationCallbackConfig {
     mode?: 'CALLBACK_MODE_NONE' | 'CALLBACK_MODE_REST' | 'CALLBACK_MODE_TWIRP';
     server_url?: string;
@@ -569,6 +599,7 @@ export interface CallReactionEvent {
 export interface CallRecording {
     end_time: Date;
     filename: string;
+    session_id: string;
     start_time: Date;
     url: string;
 }
@@ -1882,6 +1913,7 @@ export interface EntityCreatorResponse {
     banned: boolean;
     created_at: Date;
     deleted_content_count: number;
+    flagged_count: number;
     id: string;
     invisible: boolean;
     language: string;
@@ -1935,11 +1967,6 @@ export interface ExportChannelsResponse {
     duration: string;
     task_id: string;
 }
-export interface ExportChannelsResult {
-    url: string;
-    path?: string;
-    s3_bucket_name?: string;
-}
 export interface ExportUserResponse {
     duration: string;
     messages?: MessageResponse[];
@@ -1959,6 +1986,11 @@ export interface ExternalStorageResponse {
     path: string;
     type: 's3' | 'gcs' | 'abs';
 }
+export interface FPSStats {
+    average_fps: number;
+    harmonic_fps: number;
+    tracked: number;
+}
 export interface FeedsModerationTemplateConfig {
     config_key: string;
     data_types: Record<string, string>;
@@ -2272,15 +2304,6 @@ export interface GetEdgesResponse {
     duration: string;
     edges: EdgeResponse[];
 }
-export interface GetExportChannelsStatusResponse {
-    created_at: Date;
-    duration: string;
-    status: 'waiting' | 'pending' | 'running' | 'completed' | 'failed' | 'canceled';
-    task_id: string;
-    updated_at: Date;
-    error?: ErrorResult;
-    result?: ExportChannelsResult;
-}
 export interface GetImportResponse {
     duration: string;
     import_task?: ImportTask;
@@ -2392,7 +2415,6 @@ export interface GoLiveRequest {
     start_closed_caption?: boolean;
     start_hls?: boolean;
     start_recording?: boolean;
-    start_rtmp_broadcasts?: boolean;
     start_transcription?: boolean;
     transcription_storage_name?: string;
 }
@@ -2821,7 +2843,7 @@ export interface MessageRequest {
     show_in_channel?: boolean;
     silent?: boolean;
     text?: string;
-    type?: "''regular" | 'system';
+    type?: "''" | 'regular' | 'system';
     user_id?: string;
     attachments?: Attachment[];
     mentioned_users?: string[];
@@ -2966,7 +2988,6 @@ export interface ModerationAnalytics {
     moderator_productivity: Array<Record<string, any>>;
     semantic_filter_top_matches: Array<Record<string, any>>;
     sla_metrics: Array<Record<string, any>>;
-    usage_metrics: Array<Record<string, any>>;
     action_distribution_over_time: Record<string, Record<string, any>>;
     detection_by_engine_over_time: Record<string, Record<string, any>>;
 }
@@ -4235,6 +4256,8 @@ export interface SessionSettingsRequest {
 export interface SessionSettingsResponse {
     inactivity_timeout_seconds: number;
 }
+export interface ShadowBlockActionRequest {
+}
 export interface ShowChannelRequest {
     user_id?: string;
     user?: UserRequest;
@@ -4345,7 +4368,7 @@ export interface StopTranscriptionResponse {
     duration: string;
 }
 export interface SubmitActionRequest {
-    action_type: 'mark_reviewed' | 'delete_message' | 'delete_activity' | 'delete_reaction' | 'ban' | 'custom' | 'unban' | 'restore' | 'delete_user' | 'unblock';
+    action_type: 'mark_reviewed' | 'delete_message' | 'delete_activity' | 'delete_reaction' | 'ban' | 'custom' | 'unban' | 'restore' | 'delete_user' | 'unblock' | 'shadow_block';
     item_id: string;
     user_id?: string;
     ban?: BanActionRequest;
@@ -5168,6 +5191,7 @@ export interface UserSessionStats {
     webrtc_version?: string;
     published_tracks?: PublishedTrackInfo[];
     subsessions?: Subsession[];
+    fps?: FPSStats;
     geolocation?: GeolocationResult;
     jitter?: TimeStats;
     latency?: TimeStats;
@@ -5219,6 +5243,7 @@ export interface UserUpdatedEvent {
 }
 export interface VelocityFilterConfig {
     cascading_actions: boolean;
+    cids_per_user: number;
     enabled: boolean;
     first_message_only: boolean;
     rules: VelocityFilterConfigRule[];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stream-io/node-sdk",
-  "version": "0.4.13",
+  "version": "0.4.15",
   "description": "",
   "exports": {
     ".": {
@@ -49,6 +49,7 @@
     "@openapitools/openapi-generator-cli": "^2.7.0",
     "@rollup/plugin-replace": "^5.0.2",
     "@rollup/plugin-typescript": "^11.1.4",
+    "@stream-io/openai-realtime-api": "prerelease",
     "@types/uuid": "^9.0.4",
     "@typescript-eslint/eslint-plugin": "^6.4.0",
     "dotenv": "^16.3.1",
@@ -74,6 +75,14 @@
     "jsonwebtoken": "^9.0.2",
     "uuid": "^9.0.1"
   },
+  "peerDependencies": {
+    "@stream-io/openai-realtime-api": "prerelease"
+  },
+  "peerDependenciesMeta": {
+    "@stream-io/openai-realtime-api": {
+      "optional": true
+    }
+  },
   "engines": {
     "node": ">=18.0.0"
   },

package/src/BaseApi.ts

@@ -4,7 +4,7 @@ import { APIError } from './gen/models';
 import { getRateLimitFromResponseHeader } from './utils/rate-limit';
 
 export class BaseApi {
-  constructor(private readonly apiConfig: ApiConfig) {}
+  constructor(protected readonly apiConfig: ApiConfig) {}
 
   protected sendRequest = async <T>(
     method: string,

package/src/StreamClient.ts

@@ -38,6 +38,7 @@ export class StreamClient extends CommonApi {
     super({ apiKey, token, timeout, baseUrl: chatBaseUrl });
 
     this.video = new StreamVideoClient({
+      streamClient: this,
       apiKey,
       token,
       timeout,

package/src/StreamVideoClient.ts

@@ -1,8 +1,63 @@
 import { VideoApi } from './gen/video/VideoApi';
 import { StreamCall } from './StreamCall';
+import type { StreamClient } from './StreamClient';
+import type { ApiConfig } from './types';
+import type {
+  RealtimeClient,
+  createRealtimeClient,
+} from '@stream-io/openai-realtime-api';
 
 export class StreamVideoClient extends VideoApi {
+  private readonly streamClient: StreamClient;
+
+  constructor({
+    streamClient,
+    ...apiConfig
+  }: ApiConfig & { streamClient: StreamClient }) {
+    super(apiConfig);
+    this.streamClient = streamClient;
+  }
+
   call = (type: string, id: string) => {
     return new StreamCall(this, type, id);
   };
+
+  connectOpenAi = async (options: {
+    call: StreamCall;
+    agentUserId: string;
+    openAiApiKey: string;
+    validityInSeconds: number;
+  }): Promise<RealtimeClient> => {
+    let doCreateRealtimeClient: typeof createRealtimeClient;
+
+    try {
+      doCreateRealtimeClient = (await import('@stream-io/openai-realtime-api'))
+        .createRealtimeClient;
+    } catch {
+      throw new Error(
+        'Cannot create Realtime API client. Is @stream-io/openai-realtime-api installed?',
+      );
+    }
+
+    if (!options.agentUserId) {
+      throw new Error('"agentUserId" must by specified in options');
+    }
+
+    const token = this.streamClient.generateCallToken({
+      user_id: options.agentUserId,
+      call_cids: [options.call.cid],
+      validity_in_seconds: options.validityInSeconds,
+    });
+
+    const realtimeClient = doCreateRealtimeClient({
+      baseUrl: this.apiConfig.baseUrl,
+      call: options.call,
+      streamApiKey: this.apiConfig.apiKey,
+      streamUserToken: token,
+      openAiApiKey: options.openAiApiKey,
+    });
+
+    await realtimeClient.connect();
+    return realtimeClient;
+  };
 }

package/src/gen/chat/ChatApi.ts

@@ -27,7 +27,6 @@ import {
   GetCampaignResponse,
   GetChannelTypeResponse,
   GetCommandResponse,
-  GetExportChannelsStatusResponse,
   GetManyMessagesResponse,
   GetMessageResponse,
   GetReactionsResponse,
@@ -1013,22 +1012,6 @@ export class ChatApi extends BaseApi {
     return { ...response.body, metadata: response.metadata };
   };
 
-  getExportChannelsStatus = async (request: {
-    id: string;
-  }): Promise<StreamResponse<GetExportChannelsStatusResponse>> => {
-    const pathParams = {
-      id: request?.id,
-    };
-
-    const response = await this.sendRequest<
-      StreamResponse<GetExportChannelsStatusResponse>
-    >('GET', '/api/v2/chat/export_channels/{id}', pathParams, undefined);
-
-    decoders.GetExportChannelsStatusResponse?.(response.body);
-
-    return { ...response.body, metadata: response.metadata };
-  };
-
   queryMembers = async (request?: {
     payload?: QueryMembersPayload;
   }): Promise<StreamResponse<MembersResponse>> => {

package/src/gen/model-decoders/index.ts

@@ -820,15 +820,6 @@ decoders.GetConfigResponse = (input?: Record<string, any>) => {
   return decode(typeMappings, input);
 };
 
-decoders.GetExportChannelsStatusResponse = (input?: Record<string, any>) => {
-  const typeMappings: TypeMapping = {
-    created_at: { type: 'DatetimeType', isSingle: true },
-
-    updated_at: { type: 'DatetimeType', isSingle: true },
-  };
-  return decode(typeMappings, input);
-};
-
 decoders.GetImportResponse = (input?: Record<string, any>) => {
   const typeMappings: TypeMapping = {
     import_task: { type: 'ImportTask', isSingle: true },

package/src/gen/models/index.ts

@@ -264,6 +264,60 @@ export interface AppResponseFields {
   datadog_info?: DataDogInfo;
 }
 
+export interface AsyncExportChannelsEvent {
+  created_at: Date;
+
+  finished_at: Date;
+
+  started_at: Date;
+
+  task_id: string;
+
+  url: string;
+
+  custom: Record<string, any>;
+
+  type: string;
+
+  received_at?: Date;
+}
+
+export interface AsyncExportErrorEvent {
+  created_at: Date;
+
+  error: string;
+
+  finished_at: Date;
+
+  started_at: Date;
+
+  task_id: string;
+
+  custom: Record<string, any>;
+
+  type: string;
+
+  received_at?: Date;
+}
+
+export interface AsyncExportUsersEvent {
+  created_at: Date;
+
+  finished_at: Date;
+
+  started_at: Date;
+
+  task_id: string;
+
+  url: string;
+
+  custom: Record<string, any>;
+
+  type: string;
+
+  received_at?: Date;
+}
+
 export interface AsyncModerationCallbackConfig {
   mode?: 'CALLBACK_MODE_NONE' | 'CALLBACK_MODE_REST' | 'CALLBACK_MODE_TWIRP';
 
@@ -1007,6 +1061,8 @@ export interface CallRecording {
 
   filename: string;
 
+  session_id: string;
+
   start_time: Date;
 
   url: string;
@@ -3283,6 +3339,8 @@ export interface EntityCreatorResponse {
 
   deleted_content_count: number;
 
+  flagged_count: number;
+
   id: string;
 
   invisible: boolean;
@@ -3376,14 +3434,6 @@ export interface ExportChannelsResponse {
   task_id: string;
 }
 
-export interface ExportChannelsResult {
-  url: string;
-
-  path?: string;
-
-  s3_bucket_name?: string;
-}
-
 export interface ExportUserResponse {
   duration: string;
 
@@ -3414,6 +3464,14 @@ export interface ExternalStorageResponse {
   type: 's3' | 'gcs' | 'abs';
 }
 
+export interface FPSStats {
+  average_fps: number;
+
+  harmonic_fps: number;
+
+  tracked: number;
+}
+
 export interface FeedsModerationTemplateConfig {
   config_key: string;
 
@@ -3962,28 +4020,6 @@ export interface GetEdgesResponse {
   edges: EdgeResponse[];
 }
 
-export interface GetExportChannelsStatusResponse {
-  created_at: Date;
-
-  duration: string;
-
-  status:
-    | 'waiting'
-    | 'pending'
-    | 'running'
-    | 'completed'
-    | 'failed'
-    | 'canceled';
-
-  task_id: string;
-
-  updated_at: Date;
-
-  error?: ErrorResult;
-
-  result?: ExportChannelsResult;
-}
-
 export interface GetImportResponse {
   duration: string;
 
@@ -4173,8 +4209,6 @@ export interface GoLiveRequest {
 
   start_recording?: boolean;
 
-  start_rtmp_broadcasts?: boolean;
-
   start_transcription?: boolean;
 
   transcription_storage_name?: string;
@@ -4907,7 +4941,7 @@ export interface MessageRequest {
 
   text?: string;
 
-  type?: "''regular" | 'system';
+  type?: "''" | 'regular' | 'system';
 
   user_id?: string;
 
@@ -5181,8 +5215,6 @@ export interface ModerationAnalytics {
 
   sla_metrics: Array<Record<string, any>>;
 
-  usage_metrics: Array<Record<string, any>>;
-
   action_distribution_over_time: Record<string, Record<string, any>>;
 
   detection_by_engine_over_time: Record<string, Record<string, any>>;
@@ -7388,6 +7420,8 @@ export interface SessionSettingsResponse {
   inactivity_timeout_seconds: number;
 }
 
+export interface ShadowBlockActionRequest {}
+
 export interface ShowChannelRequest {
   user_id?: string;
 
@@ -7549,7 +7583,8 @@ export interface SubmitActionRequest {
     | 'unban'
     | 'restore'
     | 'delete_user'
-    | 'unblock';
+    | 'unblock'
+    | 'shadow_block';
 
   item_id: string;
 
@@ -9135,6 +9170,8 @@ export interface UserSessionStats {
 
   subsessions?: Subsession[];
 
+  fps?: FPSStats;
+
   geolocation?: GeolocationResult;
 
   jitter?: TimeStats;
@@ -9225,6 +9262,8 @@ export interface UserUpdatedEvent {
 export interface VelocityFilterConfig {
   cascading_actions: boolean;
 
+  cids_per_user: number;
+
   enabled: boolean;
 
   first_message_only: boolean;

package/src/gen/video/VideoApi.ts

@@ -345,7 +345,6 @@ export class VideoApi extends BaseApi {
       start_closed_caption: request?.start_closed_caption,
       start_hls: request?.start_hls,
       start_recording: request?.start_recording,
-      start_rtmp_broadcasts: request?.start_rtmp_broadcasts,
       start_transcription: request?.start_transcription,
       transcription_storage_name: request?.transcription_storage_name,
     };