@stream-io/node-sdk 0.4.6 → 0.4.8

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.
@@ -560,6 +560,11 @@ export interface CallRejectedEvent {
560
560
  type: string;
561
561
  reason?: string;
562
562
  }
563
+ export interface CallReportResponse {
564
+ score: number;
565
+ ended_at?: Date;
566
+ started_at?: Date;
567
+ }
563
568
  export interface CallRequest {
564
569
  created_by_id?: string;
565
570
  starts_at?: Date;
@@ -674,6 +679,7 @@ export interface CallSettings {
674
679
  recording?: RecordSettings;
675
680
  ring?: RingSettings;
676
681
  screensharing?: ScreensharingSettings;
682
+ session?: SessionSettings;
677
683
  thumbnails?: ThumbnailsSettings;
678
684
  transcription?: TranscriptionSettings;
679
685
  video?: VideoSettings;
@@ -687,6 +693,7 @@ export interface CallSettingsRequest {
687
693
  recording?: RecordSettingsRequest;
688
694
  ring?: RingSettingsRequest;
689
695
  screensharing?: ScreensharingSettingsRequest;
696
+ session?: SessionSettingsRequest;
690
697
  thumbnails?: ThumbnailsSettingsRequest;
691
698
  transcription?: TranscriptionSettingsRequest;
692
699
  video?: VideoSettingsRequest;
@@ -700,6 +707,7 @@ export interface CallSettingsResponse {
700
707
  recording: RecordSettingsResponse;
701
708
  ring: RingSettingsResponse;
702
709
  screensharing: ScreensharingSettingsResponse;
710
+ session: SessionSettingsResponse;
703
711
  thumbnails: ThumbnailsSettingsResponse;
704
712
  transcription: TranscriptionSettingsResponse;
705
713
  video: VideoSettingsResponse;
@@ -2071,6 +2079,11 @@ export interface GetBlockedUsersResponse {
2071
2079
  duration: string;
2072
2080
  blocks: BlockedUserResponse[];
2073
2081
  }
2082
+ export interface GetCallReportResponse {
2083
+ duration: string;
2084
+ session_id: string;
2085
+ report: ReportResponse;
2086
+ }
2074
2087
  export interface GetCallResponse {
2075
2088
  duration: string;
2076
2089
  members: MemberResponse[];
@@ -3078,6 +3091,10 @@ export interface PaginationParams {
3078
3091
  limit?: number;
3079
3092
  offset?: number;
3080
3093
  }
3094
+ export interface ParticipantReportResponse {
3095
+ sum: number;
3096
+ unique: number;
3097
+ }
3081
3098
  export interface PendingMessageResponse {
3082
3099
  channel?: ChannelResponse;
3083
3100
  message?: MessageResponse;
@@ -3812,6 +3829,11 @@ export interface ReportByHistogramBucket {
3812
3829
  lower_bound?: Bound;
3813
3830
  upper_bound?: Bound;
3814
3831
  }
3832
+ export interface ReportResponse {
3833
+ call: CallReportResponse;
3834
+ participants: ParticipantReportResponse;
3835
+ user_ratings: UserRatingReportResponse;
3836
+ }
3815
3837
  export interface Response {
3816
3838
  duration: string;
3817
3839
  }
@@ -4065,6 +4087,15 @@ export interface SendReactionResponse {
4065
4087
  export interface SendUserCustomEventRequest {
4066
4088
  event: UserCustomEventRequest;
4067
4089
  }
4090
+ export interface SessionSettings {
4091
+ inactivity_timeout_seconds: number;
4092
+ }
4093
+ export interface SessionSettingsRequest {
4094
+ inactivity_timeout_seconds: number;
4095
+ }
4096
+ export interface SessionSettingsResponse {
4097
+ inactivity_timeout_seconds: number;
4098
+ }
4068
4099
  export interface ShowChannelRequest {
4069
4100
  user_id?: string;
4070
4101
  user?: UserRequest;
@@ -4860,6 +4891,10 @@ export interface UserMutedEvent {
4860
4891
  target_users?: string[];
4861
4892
  user?: User;
4862
4893
  }
4894
+ export interface UserRatingReportResponse {
4895
+ average: number;
4896
+ count: number;
4897
+ }
4863
4898
  export interface UserReactivatedEvent {
4864
4899
  created_at: Date;
4865
4900
  type: string;
@@ -1,6 +1,6 @@
1
1
  import { VideoApi } from './VideoApi';
2
2
  import { StreamResponse } from '../../types';
3
- import { BlockUserRequest, BlockUserResponse, CollectUserFeedbackRequest, CollectUserFeedbackResponse, DeleteCallRequest, DeleteCallResponse, DeleteRecordingResponse, DeleteTranscriptionResponse, EndCallResponse, GetCallResponse, GetCallStatsResponse, GetOrCreateCallRequest, GetOrCreateCallResponse, GoLiveRequest, GoLiveResponse, ListRecordingsResponse, ListTranscriptionsResponse, MuteUsersRequest, MuteUsersResponse, PinRequest, PinResponse, SendCallEventRequest, SendCallEventResponse, StartClosedCaptionsRequest, StartClosedCaptionsResponse, StartHLSBroadcastingResponse, StartRTMPBroadcastsRequest, StartRTMPBroadcastsResponse, StartRecordingRequest, StartRecordingResponse, StartTranscriptionRequest, StartTranscriptionResponse, StopAllRTMPBroadcastsResponse, StopClosedCaptionsRequest, StopClosedCaptionsResponse, StopHLSBroadcastingResponse, StopLiveRequest, StopLiveResponse, StopRTMPBroadcastsRequest, StopRTMPBroadcastsResponse, StopRecordingResponse, StopTranscriptionRequest, StopTranscriptionResponse, UnblockUserRequest, UnblockUserResponse, UnpinRequest, UnpinResponse, UpdateCallMembersRequest, UpdateCallMembersResponse, UpdateCallRequest, UpdateCallResponse, UpdateUserPermissionsRequest, UpdateUserPermissionsResponse } from '../models';
3
+ import { BlockUserRequest, BlockUserResponse, CollectUserFeedbackRequest, CollectUserFeedbackResponse, DeleteCallRequest, DeleteCallResponse, DeleteRecordingResponse, DeleteTranscriptionResponse, EndCallResponse, GetCallReportResponse, GetCallResponse, GetCallStatsResponse, GetOrCreateCallRequest, GetOrCreateCallResponse, GoLiveRequest, GoLiveResponse, ListRecordingsResponse, ListTranscriptionsResponse, MuteUsersRequest, MuteUsersResponse, PinRequest, PinResponse, SendCallEventRequest, SendCallEventResponse, StartClosedCaptionsRequest, StartClosedCaptionsResponse, StartHLSBroadcastingResponse, StartRTMPBroadcastsRequest, StartRTMPBroadcastsResponse, StartRecordingRequest, StartRecordingResponse, StartTranscriptionRequest, StartTranscriptionResponse, StopAllRTMPBroadcastsResponse, StopClosedCaptionsRequest, StopClosedCaptionsResponse, StopHLSBroadcastingResponse, StopLiveRequest, StopLiveResponse, StopRTMPBroadcastsRequest, StopRTMPBroadcastsResponse, StopRecordingResponse, StopTranscriptionRequest, StopTranscriptionResponse, UnblockUserRequest, UnblockUserResponse, UnpinRequest, UnpinResponse, UpdateCallMembersRequest, UpdateCallMembersResponse, UpdateCallRequest, UpdateCallResponse, UpdateUserPermissionsRequest, UpdateUserPermissionsResponse } from '../models';
4
4
  export declare class CallApi {
5
5
  protected videoApi: VideoApi;
6
6
  readonly type: string;
@@ -26,6 +26,9 @@ export declare class CallApi {
26
26
  muteUsers: (request?: MuteUsersRequest) => Promise<StreamResponse<MuteUsersResponse>>;
27
27
  videoPin: (request: PinRequest) => Promise<StreamResponse<PinResponse>>;
28
28
  listRecordings: () => Promise<StreamResponse<ListRecordingsResponse>>;
29
+ getCallReport: (request?: {
30
+ session_id?: string;
31
+ }) => Promise<StreamResponse<GetCallReportResponse>>;
29
32
  startRTMPBroadcasts: (request: StartRTMPBroadcastsRequest) => Promise<StreamResponse<StartRTMPBroadcastsResponse>>;
30
33
  stopAllRTMPBroadcasts: () => Promise<StreamResponse<StopAllRTMPBroadcastsResponse>>;
31
34
  stopRTMPBroadcast: (request: StopRTMPBroadcastsRequest & {
@@ -1,6 +1,6 @@
1
1
  import { BaseApi } from '../../BaseApi';
2
2
  import { StreamResponse } from '../../types';
3
- import { BlockUserRequest, BlockUserResponse, CollectUserFeedbackRequest, CollectUserFeedbackResponse, CreateCallTypeRequest, CreateCallTypeResponse, DeleteCallRequest, DeleteCallResponse, DeleteRecordingResponse, DeleteTranscriptionResponse, EndCallResponse, GetCallResponse, GetCallStatsResponse, GetCallTypeResponse, GetEdgesResponse, GetOrCreateCallRequest, GetOrCreateCallResponse, GoLiveRequest, GoLiveResponse, ListCallTypeResponse, ListRecordingsResponse, ListTranscriptionsResponse, MuteUsersRequest, MuteUsersResponse, PinRequest, PinResponse, QueryAggregateCallStatsRequest, QueryAggregateCallStatsResponse, QueryCallMembersRequest, QueryCallMembersResponse, QueryCallStatsRequest, QueryCallStatsResponse, QueryCallsRequest, QueryCallsResponse, Response, SendCallEventRequest, SendCallEventResponse, StartClosedCaptionsRequest, StartClosedCaptionsResponse, StartHLSBroadcastingResponse, StartRTMPBroadcastsRequest, StartRTMPBroadcastsResponse, StartRecordingRequest, StartRecordingResponse, StartTranscriptionRequest, StartTranscriptionResponse, StopAllRTMPBroadcastsResponse, StopClosedCaptionsRequest, StopClosedCaptionsResponse, StopHLSBroadcastingResponse, StopLiveRequest, StopLiveResponse, StopRTMPBroadcastsRequest, StopRTMPBroadcastsResponse, StopRecordingResponse, StopTranscriptionRequest, StopTranscriptionResponse, UnblockUserRequest, UnblockUserResponse, UnpinRequest, UnpinResponse, UpdateCallMembersRequest, UpdateCallMembersResponse, UpdateCallRequest, UpdateCallResponse, UpdateCallTypeRequest, UpdateCallTypeResponse, UpdateUserPermissionsRequest, UpdateUserPermissionsResponse } from '../models';
3
+ import { BlockUserRequest, BlockUserResponse, CollectUserFeedbackRequest, CollectUserFeedbackResponse, CreateCallTypeRequest, CreateCallTypeResponse, DeleteCallRequest, DeleteCallResponse, DeleteRecordingResponse, DeleteTranscriptionResponse, EndCallResponse, GetCallReportResponse, GetCallResponse, GetCallStatsResponse, GetCallTypeResponse, GetEdgesResponse, GetOrCreateCallRequest, GetOrCreateCallResponse, GoLiveRequest, GoLiveResponse, ListCallTypeResponse, ListRecordingsResponse, ListTranscriptionsResponse, MuteUsersRequest, MuteUsersResponse, PinRequest, PinResponse, QueryAggregateCallStatsRequest, QueryAggregateCallStatsResponse, QueryCallMembersRequest, QueryCallMembersResponse, QueryCallStatsRequest, QueryCallStatsResponse, QueryCallsRequest, QueryCallsResponse, Response, SendCallEventRequest, SendCallEventResponse, StartClosedCaptionsRequest, StartClosedCaptionsResponse, StartHLSBroadcastingResponse, StartRTMPBroadcastsRequest, StartRTMPBroadcastsResponse, StartRecordingRequest, StartRecordingResponse, StartTranscriptionRequest, StartTranscriptionResponse, StopAllRTMPBroadcastsResponse, StopClosedCaptionsRequest, StopClosedCaptionsResponse, StopHLSBroadcastingResponse, StopLiveRequest, StopLiveResponse, StopRTMPBroadcastsRequest, StopRTMPBroadcastsResponse, StopRecordingResponse, StopTranscriptionRequest, StopTranscriptionResponse, UnblockUserRequest, UnblockUserResponse, UnpinRequest, UnpinResponse, UpdateCallMembersRequest, UpdateCallMembersResponse, UpdateCallRequest, UpdateCallResponse, UpdateCallTypeRequest, UpdateCallTypeResponse, UpdateUserPermissionsRequest, UpdateUserPermissionsResponse } from '../models';
4
4
  export declare class VideoApi extends BaseApi {
5
5
  queryCallMembers: (request: QueryCallMembersRequest) => Promise<StreamResponse<QueryCallMembersResponse>>;
6
6
  queryCallStats: (request?: QueryCallStatsRequest) => Promise<StreamResponse<QueryCallStatsResponse>>;
@@ -61,6 +61,11 @@ export declare class VideoApi extends BaseApi {
61
61
  type: string;
62
62
  id: string;
63
63
  }) => Promise<StreamResponse<ListRecordingsResponse>>;
64
+ getCallReport: (request: {
65
+ type: string;
66
+ id: string;
67
+ session_id?: string;
68
+ }) => Promise<StreamResponse<GetCallReportResponse>>;
64
69
  startRTMPBroadcasts: (request: StartRTMPBroadcastsRequest & {
65
70
  type: string;
66
71
  id: string;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@stream-io/node-sdk",
3
- "version": "0.4.6",
3
+ "version": "0.4.8",
4
4
  "description": "",
5
5
  "exports": {
6
6
  ".": {
@@ -76,5 +76,6 @@
76
76
  },
77
77
  "engines": {
78
78
  "node": ">=18.0.0"
79
- }
79
+ },
80
+ "packageManager": "yarn@1.22.22+sha1.ac34549e6aa8e7ead463a7407e1c7390f61a6610"
80
81
  }
@@ -153,6 +153,15 @@ decoders.CallRecording = (input?: Record<string, any>) => {
153
153
  return decode(typeMappings, input);
154
154
  };
155
155
 
156
+ decoders.CallReportResponse = (input?: Record<string, any>) => {
157
+ const typeMappings: TypeMapping = {
158
+ ended_at: { type: 'DatetimeType', isSingle: true },
159
+
160
+ started_at: { type: 'DatetimeType', isSingle: true },
161
+ };
162
+ return decode(typeMappings, input);
163
+ };
164
+
156
165
  decoders.CallResponse = (input?: Record<string, any>) => {
157
166
  const typeMappings: TypeMapping = {
158
167
  created_at: { type: 'DatetimeType', isSingle: true },
@@ -988,6 +988,14 @@ export interface CallRejectedEvent {
988
988
  reason?: string;
989
989
  }
990
990
 
991
+ export interface CallReportResponse {
992
+ score: number;
993
+
994
+ ended_at?: Date;
995
+
996
+ started_at?: Date;
997
+ }
998
+
991
999
  export interface CallRequest {
992
1000
  created_by_id?: string;
993
1001
 
@@ -1193,6 +1201,8 @@ export interface CallSettings {
1193
1201
 
1194
1202
  screensharing?: ScreensharingSettings;
1195
1203
 
1204
+ session?: SessionSettings;
1205
+
1196
1206
  thumbnails?: ThumbnailsSettings;
1197
1207
 
1198
1208
  transcription?: TranscriptionSettings;
@@ -1217,6 +1227,8 @@ export interface CallSettingsRequest {
1217
1227
 
1218
1228
  screensharing?: ScreensharingSettingsRequest;
1219
1229
 
1230
+ session?: SessionSettingsRequest;
1231
+
1220
1232
  thumbnails?: ThumbnailsSettingsRequest;
1221
1233
 
1222
1234
  transcription?: TranscriptionSettingsRequest;
@@ -1241,6 +1253,8 @@ export interface CallSettingsResponse {
1241
1253
 
1242
1254
  screensharing: ScreensharingSettingsResponse;
1243
1255
 
1256
+ session: SessionSettingsResponse;
1257
+
1244
1258
  thumbnails: ThumbnailsSettingsResponse;
1245
1259
 
1246
1260
  transcription: TranscriptionSettingsResponse;
@@ -3609,6 +3623,14 @@ export interface GetBlockedUsersResponse {
3609
3623
  blocks: BlockedUserResponse[];
3610
3624
  }
3611
3625
 
3626
+ export interface GetCallReportResponse {
3627
+ duration: string;
3628
+
3629
+ session_id: string;
3630
+
3631
+ report: ReportResponse;
3632
+ }
3633
+
3612
3634
  export interface GetCallResponse {
3613
3635
  duration: string;
3614
3636
 
@@ -5361,6 +5383,12 @@ export interface PaginationParams {
5361
5383
  offset?: number;
5362
5384
  }
5363
5385
 
5386
+ export interface ParticipantReportResponse {
5387
+ sum: number;
5388
+
5389
+ unique: number;
5390
+ }
5391
+
5364
5392
  export interface PendingMessageResponse {
5365
5393
  channel?: ChannelResponse;
5366
5394
 
@@ -6657,6 +6685,14 @@ export interface ReportByHistogramBucket {
6657
6685
  upper_bound?: Bound;
6658
6686
  }
6659
6687
 
6688
+ export interface ReportResponse {
6689
+ call: CallReportResponse;
6690
+
6691
+ participants: ParticipantReportResponse;
6692
+
6693
+ user_ratings: UserRatingReportResponse;
6694
+ }
6695
+
6660
6696
  export interface Response {
6661
6697
  duration: string;
6662
6698
  }
@@ -7099,6 +7135,18 @@ export interface SendUserCustomEventRequest {
7099
7135
  event: UserCustomEventRequest;
7100
7136
  }
7101
7137
 
7138
+ export interface SessionSettings {
7139
+ inactivity_timeout_seconds: number;
7140
+ }
7141
+
7142
+ export interface SessionSettingsRequest {
7143
+ inactivity_timeout_seconds: number;
7144
+ }
7145
+
7146
+ export interface SessionSettingsResponse {
7147
+ inactivity_timeout_seconds: number;
7148
+ }
7149
+
7102
7150
  export interface ShowChannelRequest {
7103
7151
  user_id?: string;
7104
7152
 
@@ -8594,6 +8642,12 @@ export interface UserMutedEvent {
8594
8642
  user?: User;
8595
8643
  }
8596
8644
 
8645
+ export interface UserRatingReportResponse {
8646
+ average: number;
8647
+
8648
+ count: number;
8649
+ }
8650
+
8597
8651
  export interface UserReactivatedEvent {
8598
8652
  created_at: Date;
8599
8653
 
@@ -10,6 +10,7 @@ import {
10
10
  DeleteRecordingResponse,
11
11
  DeleteTranscriptionResponse,
12
12
  EndCallResponse,
13
+ GetCallReportResponse,
13
14
  GetCallResponse,
14
15
  GetCallStatsResponse,
15
16
  GetOrCreateCallRequest,
@@ -170,6 +171,16 @@ export class CallApi {
170
171
  return this.videoApi.listRecordings({ id: this.id, type: this.type });
171
172
  };
172
173
 
174
+ getCallReport = (request?: {
175
+ session_id?: string;
176
+ }): Promise<StreamResponse<GetCallReportResponse>> => {
177
+ return this.videoApi.getCallReport({
178
+ id: this.id,
179
+ type: this.type,
180
+ ...request,
181
+ });
182
+ };
183
+
173
184
  startRTMPBroadcasts = (
174
185
  request: StartRTMPBroadcastsRequest,
175
186
  ): Promise<StreamResponse<StartRTMPBroadcastsResponse>> => {
@@ -12,6 +12,7 @@ import {
12
12
  DeleteRecordingResponse,
13
13
  DeleteTranscriptionResponse,
14
14
  EndCallResponse,
15
+ GetCallReportResponse,
15
16
  GetCallResponse,
16
17
  GetCallStatsResponse,
17
18
  GetCallTypeResponse,
@@ -466,6 +467,28 @@ export class VideoApi extends BaseApi {
466
467
  return { ...response.body, metadata: response.metadata };
467
468
  };
468
469
 
470
+ getCallReport = async (request: {
471
+ type: string;
472
+ id: string;
473
+ session_id?: string;
474
+ }): Promise<StreamResponse<GetCallReportResponse>> => {
475
+ const queryParams = {
476
+ session_id: request?.session_id,
477
+ };
478
+ const pathParams = {
479
+ type: request?.type,
480
+ id: request?.id,
481
+ };
482
+
483
+ const response = await this.sendRequest<
484
+ StreamResponse<GetCallReportResponse>
485
+ >('GET', '/api/v2/video/call/{type}/{id}/report', pathParams, queryParams);
486
+
487
+ decoders.GetCallReportResponse?.(response.body);
488
+
489
+ return { ...response.body, metadata: response.metadata };
490
+ };
491
+
469
492
  startRTMPBroadcasts = async (
470
493
  request: StartRTMPBroadcastsRequest & { type: string; id: string },
471
494
  ): Promise<StreamResponse<StartRTMPBroadcastsResponse>> => {